1 //===- DbiModuleDescriptorBuilder.h - PDB module information ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_DEBUGINFO_PDB_RAW_DBIMODULEDESCRIPTORBUILDER_H
11 #define LLVM_DEBUGINFO_PDB_RAW_DBIMODULEDESCRIPTORBUILDER_H
13 #include "llvm/ADT/StringRef.h"
14 #include "llvm/DebugInfo/CodeView/DebugChecksumsSubsection.h"
15 #include "llvm/DebugInfo/CodeView/DebugInlineeLinesSubsection.h"
16 #include "llvm/DebugInfo/CodeView/DebugLinesSubsection.h"
17 #include "llvm/DebugInfo/CodeView/DebugSubsectionRecord.h"
18 #include "llvm/DebugInfo/CodeView/SymbolRecord.h"
19 #include "llvm/DebugInfo/PDB/Native/RawTypes.h"
20 #include "llvm/Support/Error.h"
26 class BinaryStreamWriter;
29 class DebugSubsectionRecordBuilder;
38 class DbiModuleDescriptorBuilder {
39 friend class DbiStreamBuilder;
42 DbiModuleDescriptorBuilder(StringRef ModuleName, uint32_t ModIndex,
43 msf::MSFBuilder &Msf);
44 ~DbiModuleDescriptorBuilder();
46 DbiModuleDescriptorBuilder(const DbiModuleDescriptorBuilder &) = delete;
47 DbiModuleDescriptorBuilder &
48 operator=(const DbiModuleDescriptorBuilder &) = delete;
50 void setPdbFilePathNI(uint32_t NI);
51 void setObjFileName(StringRef Name);
52 void setFirstSectionContrib(const SectionContrib &SC);
53 void addSymbol(codeview::CVSymbol Symbol);
56 addDebugSubsection(std::shared_ptr<codeview::DebugSubsection> Subsection);
59 addDebugSubsection(const codeview::DebugSubsectionRecord &SubsectionContents);
61 uint16_t getStreamIndex() const;
62 StringRef getModuleName() const { return ModuleName; }
63 StringRef getObjFileName() const { return ObjFileName; }
65 unsigned getModuleIndex() const { return Layout.Mod; }
67 ArrayRef<std::string> source_files() const {
68 return makeArrayRef(SourceFiles);
71 uint32_t calculateSerializedLength() const;
73 /// Return the offset within the module symbol stream of the next symbol
74 /// record passed to addSymbol. Add four to account for the signature.
75 uint32_t getNextSymbolOffset() const { return SymbolByteSize + 4; }
78 Error finalizeMsfLayout();
80 Error commit(BinaryStreamWriter &ModiWriter, const msf::MSFLayout &MsfLayout,
81 WritableBinaryStreamRef MsfBuffer);
84 uint32_t calculateC13DebugInfoSize() const;
86 void addSourceFile(StringRef Path);
89 uint32_t SymbolByteSize = 0;
90 uint32_t PdbFilePathNI = 0;
91 std::string ModuleName;
92 std::string ObjFileName;
93 std::vector<std::string> SourceFiles;
94 std::vector<codeview::CVSymbol> Symbols;
96 std::vector<std::unique_ptr<codeview::DebugSubsectionRecordBuilder>>
99 ModuleInfoHeader Layout;
102 } // end namespace pdb
104 } // end namespace llvm
106 #endif // LLVM_DEBUGINFO_PDB_RAW_DBIMODULEDESCRIPTORBUILDER_H