1 //===-- llvm/lib/CodeGen/AsmPrinter/CodeViewDebug.h ----*- 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 // This file contains support for writing Microsoft CodeView debug info.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_CODEVIEWDEBUG_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_CODEVIEWDEBUG_H
17 #include "DebugHandlerBase.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/CodeGen/AsmPrinter.h"
21 #include "llvm/CodeGen/MachineFunction.h"
22 #include "llvm/CodeGen/MachineModuleInfo.h"
23 #include "llvm/DebugInfo/CodeView/TypeIndex.h"
24 #include "llvm/DebugInfo/CodeView/TypeTableBuilder.h"
25 #include "llvm/IR/DebugInfo.h"
26 #include "llvm/IR/DebugLoc.h"
27 #include "llvm/MC/MCStreamer.h"
28 #include "llvm/Target/TargetLoweringObjectFile.h"
36 /// \brief Collects and handles line tables information in a CodeView format.
37 class LLVM_LIBRARY_VISIBILITY CodeViewDebug : public DebugHandlerBase {
39 llvm::BumpPtrAllocator Allocator;
40 codeview::TypeTableBuilder TypeTable;
42 /// Represents the most general definition range.
43 struct LocalVarDefRange {
44 /// Indicates that variable data is stored in memory relative to the
45 /// specified register.
48 /// Offset of variable data in memory.
51 /// Non-zero if this is a piece of an aggregate.
52 uint16_t IsSubfield : 1;
54 /// Offset into aggregate.
55 uint16_t StructOffset : 15;
57 /// Register containing the data or the register base of the memory
58 /// location containing the data.
61 /// Compares all location fields. This includes all fields except the label
63 bool isDifferentLocation(LocalVarDefRange &O) {
64 return InMemory != O.InMemory || DataOffset != O.DataOffset ||
65 IsSubfield != O.IsSubfield || StructOffset != O.StructOffset ||
66 CVRegister != O.CVRegister;
69 SmallVector<std::pair<const MCSymbol *, const MCSymbol *>, 1> Ranges;
72 static LocalVarDefRange createDefRangeMem(uint16_t CVRegister, int Offset);
73 static LocalVarDefRange createDefRangeGeneral(uint16_t CVRegister,
74 bool InMemory, int Offset,
76 uint16_t StructOffset);
78 /// Similar to DbgVariable in DwarfDebug, but not dwarf-specific.
79 struct LocalVariable {
80 const DILocalVariable *DIVar = nullptr;
81 SmallVector<LocalVarDefRange, 1> DefRanges;
85 SmallVector<LocalVariable, 1> InlinedLocals;
86 SmallVector<const DILocation *, 1> ChildSites;
87 const DISubprogram *Inlinee = nullptr;
89 /// The ID of the inline site or function used with .cv_loc. Not a type
91 unsigned SiteFuncId = 0;
94 // For each function, store a vector of labels to its instructions, as well as
95 // to the end of the function.
97 /// Map from inlined call site to inlined instructions and child inlined
98 /// call sites. Listed in program order.
99 std::unordered_map<const DILocation *, InlineSite> InlineSites;
101 /// Ordered list of top-level inlined call sites.
102 SmallVector<const DILocation *, 1> ChildSites;
104 SmallVector<LocalVariable, 1> Locals;
107 const MCSymbol *Begin = nullptr;
108 const MCSymbol *End = nullptr;
110 unsigned LastFileId = 0;
111 bool HaveLineInfo = false;
115 /// The set of comdat .debug$S sections that we've seen so far. Each section
116 /// must start with a magic version number that must only be emitted once.
117 /// This set tracks which sections we've already opened.
118 DenseSet<MCSectionCOFF *> ComdatDebugSections;
120 /// Switch to the appropriate .debug$S section for GVSym. If GVSym, the symbol
121 /// of an emitted global value, is in a comdat COFF section, this will switch
122 /// to a new .debug$S section in that comdat. This method ensures that the
123 /// section starts with the magic version number on first use. If GVSym is
124 /// null, uses the main .debug$S section.
125 void switchToDebugSectionForSymbol(const MCSymbol *GVSym);
127 /// The next available function index for use with our .cv_* directives. Not
128 /// to be confused with type indices for LF_FUNC_ID records.
129 unsigned NextFuncId = 0;
131 InlineSite &getInlineSite(const DILocation *InlinedAt,
132 const DISubprogram *Inlinee);
134 codeview::TypeIndex getFuncIdForSubprogram(const DISubprogram *SP);
136 static void collectInlineSiteChildren(SmallVectorImpl<unsigned> &Children,
137 const FunctionInfo &FI,
138 const InlineSite &Site);
140 /// Remember some debug info about each function. Keep it in a stable order to
141 /// emit at the end of the TU.
142 MapVector<const Function *, FunctionInfo> FnDebugInfo;
144 /// Map from DIFile to .cv_file id.
145 DenseMap<const DIFile *, unsigned> FileIdMap;
147 /// All inlined subprograms in the order they should be emitted.
148 SmallSetVector<const DISubprogram *, 4> InlinedSubprograms;
150 /// Map from a pair of DI metadata nodes and its DI type (or scope) that can
151 /// be nullptr, to CodeView type indices. Primarily indexed by
152 /// {DIType*, DIType*} and {DISubprogram*, DIType*}.
154 /// The second entry in the key is needed for methods as DISubroutineType
155 /// representing static method type are shared with non-method function type.
156 DenseMap<std::pair<const DINode *, const DIType *>, codeview::TypeIndex>
159 /// Map from DICompositeType* to complete type index. Non-record types are
160 /// always looked up in the normal TypeIndices map.
161 DenseMap<const DICompositeType *, codeview::TypeIndex> CompleteTypeIndices;
163 /// Complete record types to emit after all active type lowerings are
165 SmallVector<const DICompositeType *, 4> DeferredCompleteTypes;
167 /// Number of type lowering frames active on the stack.
168 unsigned TypeEmissionLevel = 0;
170 codeview::TypeIndex VBPType;
172 const DISubprogram *CurrentSubprogram = nullptr;
174 // The UDTs we have seen while processing types; each entry is a pair of type
175 // index and type name.
176 std::vector<std::pair<std::string, codeview::TypeIndex>> LocalUDTs,
179 typedef std::map<const DIFile *, std::string> FileToFilepathMapTy;
180 FileToFilepathMapTy FileToFilepathMap;
181 StringRef getFullFilepath(const DIFile *S);
183 unsigned maybeRecordFile(const DIFile *F);
185 void maybeRecordLocation(const DebugLoc &DL, const MachineFunction *MF);
189 void setCurrentSubprogram(const DISubprogram *SP) {
190 CurrentSubprogram = SP;
194 /// Emit the magic version number at the start of a CodeView type or symbol
195 /// section. Appears at the front of every .debug$S or .debug$T section.
196 void emitCodeViewMagicVersion();
198 void emitTypeInformation();
200 void emitCompilerInformation();
202 void emitInlineeLinesSubsection();
204 void emitDebugInfoForFunction(const Function *GV, FunctionInfo &FI);
206 void emitDebugInfoForGlobals();
208 void emitDebugInfoForRetainedTypes();
210 void emitDebugInfoForUDTs(
211 ArrayRef<std::pair<std::string, codeview::TypeIndex>> UDTs);
213 void emitDebugInfoForGlobal(const DIGlobalVariable *DIGV,
214 const GlobalVariable *GV, MCSymbol *GVSym);
216 /// Opens a subsection of the given kind in a .debug$S codeview section.
217 /// Returns an end label for use with endCVSubsection when the subsection is
219 MCSymbol *beginCVSubsection(codeview::ModuleSubstreamKind Kind);
221 void endCVSubsection(MCSymbol *EndLabel);
223 void emitInlinedCallSite(const FunctionInfo &FI, const DILocation *InlinedAt,
224 const InlineSite &Site);
226 typedef DbgValueHistoryMap::InlinedVariable InlinedVariable;
228 void collectVariableInfo(const DISubprogram *SP);
230 void collectVariableInfoFromMFTable(DenseSet<InlinedVariable> &Processed);
232 /// Records information about a local variable in the appropriate scope. In
233 /// particular, locals from inlined code live inside the inlining site.
234 void recordLocalVariable(LocalVariable &&Var, const DILocation *Loc);
236 /// Emits local variables in the appropriate order.
237 void emitLocalVariableList(ArrayRef<LocalVariable> Locals);
239 /// Emits an S_LOCAL record and its associated defined ranges.
240 void emitLocalVariable(const LocalVariable &Var);
242 /// Translates the DIType to codeview if necessary and returns a type index
244 codeview::TypeIndex getTypeIndex(DITypeRef TypeRef,
245 DITypeRef ClassTyRef = DITypeRef());
247 codeview::TypeIndex getMemberFunctionType(const DISubprogram *SP,
248 const DICompositeType *Class);
250 codeview::TypeIndex getScopeIndex(const DIScope *Scope);
252 codeview::TypeIndex getVBPTypeIndex();
254 void addToUDTs(const DIType *Ty, codeview::TypeIndex TI);
256 codeview::TypeIndex lowerType(const DIType *Ty, const DIType *ClassTy);
257 codeview::TypeIndex lowerTypeAlias(const DIDerivedType *Ty);
258 codeview::TypeIndex lowerTypeArray(const DICompositeType *Ty);
259 codeview::TypeIndex lowerTypeBasic(const DIBasicType *Ty);
260 codeview::TypeIndex lowerTypePointer(const DIDerivedType *Ty);
261 codeview::TypeIndex lowerTypeMemberPointer(const DIDerivedType *Ty);
262 codeview::TypeIndex lowerTypeModifier(const DIDerivedType *Ty);
263 codeview::TypeIndex lowerTypeFunction(const DISubroutineType *Ty);
264 codeview::TypeIndex lowerTypeVFTableShape(const DIDerivedType *Ty);
265 codeview::TypeIndex lowerTypeMemberFunction(const DISubroutineType *Ty,
266 const DIType *ClassTy,
268 codeview::TypeIndex lowerTypeEnum(const DICompositeType *Ty);
269 codeview::TypeIndex lowerTypeClass(const DICompositeType *Ty);
270 codeview::TypeIndex lowerTypeUnion(const DICompositeType *Ty);
272 /// Symbol records should point to complete types, but type records should
273 /// always point to incomplete types to avoid cycles in the type graph. Only
274 /// use this entry point when generating symbol records. The complete and
275 /// incomplete type indices only differ for record types. All other types use
277 codeview::TypeIndex getCompleteTypeIndex(DITypeRef TypeRef);
279 codeview::TypeIndex lowerCompleteTypeClass(const DICompositeType *Ty);
280 codeview::TypeIndex lowerCompleteTypeUnion(const DICompositeType *Ty);
282 struct TypeLoweringScope;
284 void emitDeferredCompleteTypes();
286 void collectMemberInfo(ClassInfo &Info, const DIDerivedType *DDTy);
287 ClassInfo collectClassInfo(const DICompositeType *Ty);
289 /// Common record member lowering functionality for record types, which are
290 /// structs, classes, and unions. Returns the field list index and the member
292 std::tuple<codeview::TypeIndex, codeview::TypeIndex, unsigned, bool>
293 lowerRecordFieldList(const DICompositeType *Ty);
295 /// Inserts {{Node, ClassTy}, TI} into TypeIndices and checks for duplicates.
296 codeview::TypeIndex recordTypeIndexForDINode(const DINode *Node,
297 codeview::TypeIndex TI,
298 const DIType *ClassTy = nullptr);
300 unsigned getPointerSizeInBytes();
303 CodeViewDebug(AsmPrinter *Asm);
305 void setSymbolSize(const llvm::MCSymbol *, uint64_t) override {}
307 /// \brief Emit the COFF section that holds the line table information.
308 void endModule() override;
310 /// \brief Gather pre-function debug information.
311 void beginFunction(const MachineFunction *MF) override;
313 /// \brief Gather post-function debug information.
314 void endFunction(const MachineFunction *) override;
316 /// \brief Process beginning of an instruction.
317 void beginInstruction(const MachineInstr *MI) override;
319 } // End of namespace llvm