1//===-- llvm/CodeGen/DwarfCompileUnit.h - Dwarf Compile Unit ---*- C++ -*--===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file contains support for writing dwarf compile unit. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H 15#define CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H 16 17#include "DIE.h" 18#include "DwarfDebug.h" 19#include "llvm/ADT/DenseMap.h" 20#include "llvm/ADT/Optional.h" 21#include "llvm/ADT/OwningPtr.h" 22#include "llvm/ADT/StringMap.h" 23#include "llvm/DebugInfo.h" 24#include "llvm/MC/MCExpr.h" 25 26namespace llvm { 27 28class MachineLocation; 29class MachineOperand; 30class ConstantInt; 31class ConstantFP; 32class DbgVariable; 33 34//===----------------------------------------------------------------------===// 35/// CompileUnit - This dwarf writer support class manages information associated 36/// with a source file. 37class CompileUnit { 38 /// UniqueID - a numeric ID unique among all CUs in the module 39 /// 40 unsigned UniqueID; 41 42 /// Node - MDNode for the compile unit. 43 DICompileUnit Node; 44 45 /// CUDie - Compile unit debug information entry. 46 /// 47 const OwningPtr<DIE> CUDie; 48 49 /// Asm - Target of Dwarf emission. 50 AsmPrinter *Asm; 51 52 // Holders for some common dwarf information. 53 DwarfDebug *DD; 54 DwarfUnits *DU; 55 56 /// IndexTyDie - An anonymous type for index type. Owned by CUDie. 57 DIE *IndexTyDie; 58 59 /// MDNodeToDieMap - Tracks the mapping of unit level debug information 60 /// variables to debug information entries. 61 DenseMap<const MDNode *, DIE *> MDNodeToDieMap; 62 63 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information 64 /// descriptors to debug information entries using a DIEEntry proxy. 65 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap; 66 67 /// GlobalNames - A map of globally visible named entities for this unit. 68 /// 69 StringMap<DIE *> GlobalNames; 70 71 /// GlobalTypes - A map of globally visible types for this unit. 72 /// 73 StringMap<DIE *> GlobalTypes; 74 75 /// AccelNames - A map of names for the name accelerator table. 76 /// 77 StringMap<std::vector<DIE *> > AccelNames; 78 StringMap<std::vector<DIE *> > AccelObjC; 79 StringMap<std::vector<DIE *> > AccelNamespace; 80 StringMap<std::vector<std::pair<DIE *, unsigned> > > AccelTypes; 81 82 /// DIEBlocks - A list of all the DIEBlocks in use. 83 std::vector<DIEBlock *> DIEBlocks; 84 85 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that 86 /// need DW_AT_containing_type attribute. This attribute points to a DIE that 87 /// corresponds to the MDNode mapped with the subprogram DIE. 88 DenseMap<DIE *, const MDNode *> ContainingTypeMap; 89 90 // DIEValueAllocator - All DIEValues are allocated through this allocator. 91 BumpPtrAllocator DIEValueAllocator; 92 93 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently. 94 DIEInteger *DIEIntegerOne; 95 96public: 97 CompileUnit(unsigned UID, DIE *D, DICompileUnit CU, AsmPrinter *A, 98 DwarfDebug *DW, DwarfUnits *DWU); 99 ~CompileUnit(); 100 101 // Accessors. 102 unsigned getUniqueID() const { return UniqueID; } 103 uint16_t getLanguage() const { return Node.getLanguage(); } 104 DICompileUnit getNode() const { return Node; } 105 DIE *getCUDie() const { return CUDie.get(); } 106 const StringMap<DIE *> &getGlobalNames() const { return GlobalNames; } 107 const StringMap<DIE *> &getGlobalTypes() const { return GlobalTypes; } 108 109 const StringMap<std::vector<DIE *> > &getAccelNames() const { 110 return AccelNames; 111 } 112 const StringMap<std::vector<DIE *> > &getAccelObjC() const { 113 return AccelObjC; 114 } 115 const StringMap<std::vector<DIE *> > &getAccelNamespace() const { 116 return AccelNamespace; 117 } 118 const StringMap<std::vector<std::pair<DIE *, unsigned> > > & 119 getAccelTypes() const { 120 return AccelTypes; 121 } 122 123 unsigned getDebugInfoOffset() const { return DebugInfoOffset; } 124 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; } 125 126 /// hasContent - Return true if this compile unit has something to write out. 127 /// 128 bool hasContent() const { return !CUDie->getChildren().empty(); } 129 130 /// getParentContextString - Get a string containing the language specific 131 /// context for a global name. 132 std::string getParentContextString(DIScope Context) const; 133 134 /// addGlobalName - Add a new global entity to the compile unit. 135 /// 136 void addGlobalName(StringRef Name, DIE *Die, DIScope Context); 137 138 /// addGlobalType - Add a new global type to the compile unit. 139 /// 140 void addGlobalType(DIType Ty); 141 142 /// addPubTypes - Add a set of types from the subprogram to the global types. 143 void addPubTypes(DISubprogram SP); 144 145 /// addAccelName - Add a new name to the name accelerator table. 146 void addAccelName(StringRef Name, DIE *Die); 147 148 /// addAccelObjC - Add a new name to the ObjC accelerator table. 149 void addAccelObjC(StringRef Name, DIE *Die); 150 151 /// addAccelNamespace - Add a new name to the namespace accelerator table. 152 void addAccelNamespace(StringRef Name, DIE *Die); 153 154 /// addAccelType - Add a new type to the type accelerator table. 155 void addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die); 156 157 /// getDIE - Returns the debug information entry map slot for the 158 /// specified debug variable. We delegate the request to DwarfDebug 159 /// when the MDNode can be part of the type system, since DIEs for 160 /// the type system can be shared across CUs and the mappings are 161 /// kept in DwarfDebug. 162 DIE *getDIE(DIDescriptor D) const; 163 164 DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); } 165 166 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug 167 /// when the MDNode can be part of the type system, since DIEs for 168 /// the type system can be shared across CUs and the mappings are 169 /// kept in DwarfDebug. 170 void insertDIE(DIDescriptor Desc, DIE *D); 171 172 /// addDie - Adds or interns the DIE to the compile unit. 173 /// 174 void addDie(DIE *Buffer) { CUDie->addChild(Buffer); } 175 176 /// addFlag - Add a flag that is true to the DIE. 177 void addFlag(DIE *Die, dwarf::Attribute Attribute); 178 179 /// addUInt - Add an unsigned integer attribute data and value. 180 /// 181 void addUInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form, 182 uint64_t Integer); 183 184 void addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer); 185 186 /// addSInt - Add an signed integer attribute data and value. 187 /// 188 void addSInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form, 189 int64_t Integer); 190 191 void addSInt(DIEBlock *Die, Optional<dwarf::Form> Form, int64_t Integer); 192 193 /// addString - Add a string attribute data and value. 194 /// 195 void addString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str); 196 197 /// addLocalString - Add a string attribute data and value. 198 /// 199 void addLocalString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str); 200 201 /// addExpr - Add a Dwarf expression attribute data and value. 202 /// 203 void addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr); 204 205 /// addLabel - Add a Dwarf label attribute data and value. 206 /// 207 void addLabel(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form, 208 const MCSymbol *Label); 209 210 void addLabel(DIEBlock *Die, dwarf::Form Form, const MCSymbol *Label); 211 212 /// addSectionLabel - Add a Dwarf section label attribute data and value. 213 /// 214 void addSectionLabel(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Label); 215 216 /// addSectionOffset - Add an offset into a section attribute data and value. 217 /// 218 void addSectionOffset(DIE *Die, dwarf::Attribute Attribute, uint64_t Integer); 219 220 /// addLabelAddress - Add a dwarf label attribute data and value using 221 /// either DW_FORM_addr or DW_FORM_GNU_addr_index. 222 /// 223 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label); 224 225 /// addOpAddress - Add a dwarf op address data and value using the 226 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index. 227 /// 228 void addOpAddress(DIEBlock *Die, const MCSymbol *Label); 229 230 /// addSectionDelta - Add a label delta attribute data and value. 231 void addSectionDelta(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Hi, 232 const MCSymbol *Lo); 233 234 /// addDIEEntry - Add a DIE attribute data and value. 235 /// 236 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry); 237 238 /// addDIEEntry - Add a DIE attribute data and value. 239 /// 240 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry); 241 242 /// addBlock - Add block data. 243 /// 244 void addBlock(DIE *Die, dwarf::Attribute Attribute, DIEBlock *Block); 245 246 /// addSourceLine - Add location information to specified debug information 247 /// entry. 248 void addSourceLine(DIE *Die, DIVariable V); 249 void addSourceLine(DIE *Die, DIGlobalVariable G); 250 void addSourceLine(DIE *Die, DISubprogram SP); 251 void addSourceLine(DIE *Die, DIType Ty); 252 void addSourceLine(DIE *Die, DINameSpace NS); 253 void addSourceLine(DIE *Die, DIObjCProperty Ty); 254 255 /// addAddress - Add an address attribute to a die based on the location 256 /// provided. 257 void addAddress(DIE *Die, dwarf::Attribute Attribute, const MachineLocation &Location, 258 bool Indirect = false); 259 260 /// addConstantValue - Add constant value entry in variable DIE. 261 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty); 262 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned); 263 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned); 264 265 /// addConstantFPValue - Add constant value entry in variable DIE. 266 void addConstantFPValue(DIE *Die, const MachineOperand &MO); 267 void addConstantFPValue(DIE *Die, const ConstantFP *CFP); 268 269 /// addTemplateParams - Add template parameters in buffer. 270 void addTemplateParams(DIE &Buffer, DIArray TParams); 271 272 /// addRegisterOp - Add register operand. 273 void addRegisterOp(DIEBlock *TheDie, unsigned Reg); 274 275 /// addRegisterOffset - Add register offset. 276 void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset); 277 278 /// addComplexAddress - Start with the address based on the location provided, 279 /// and generate the DWARF information necessary to find the actual variable 280 /// (navigating the extra location information encoded in the type) based on 281 /// the starting location. Add the DWARF information to the die. 282 /// 283 void addComplexAddress(const DbgVariable &DV, DIE *Die, dwarf::Attribute Attribute, 284 const MachineLocation &Location); 285 286 // FIXME: Should be reformulated in terms of addComplexAddress. 287 /// addBlockByrefAddress - Start with the address based on the location 288 /// provided, and generate the DWARF information necessary to find the 289 /// actual Block variable (navigating the Block struct) based on the 290 /// starting location. Add the DWARF information to the die. Obsolete, 291 /// please use addComplexAddress instead. 292 /// 293 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die, dwarf::Attribute Attribute, 294 const MachineLocation &Location); 295 296 /// addVariableAddress - Add DW_AT_location attribute for a 297 /// DbgVariable based on provided MachineLocation. 298 void addVariableAddress(const DbgVariable &DV, DIE *Die, 299 MachineLocation Location); 300 301 /// addType - Add a new type attribute to the specified entity. This takes 302 /// and attribute parameter because DW_AT_friend attributes are also 303 /// type references. 304 void addType(DIE *Entity, DIType Ty, dwarf::Attribute Attribute = dwarf::DW_AT_type); 305 306 /// getOrCreateNameSpace - Create a DIE for DINameSpace. 307 DIE *getOrCreateNameSpace(DINameSpace NS); 308 309 /// getOrCreateSubprogramDIE - Create new DIE using SP. 310 DIE *getOrCreateSubprogramDIE(DISubprogram SP); 311 312 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the 313 /// given DIType. 314 DIE *getOrCreateTypeDIE(const MDNode *N); 315 316 /// getOrCreateContextDIE - Get context owner's DIE. 317 DIE *getOrCreateContextDIE(DIScope Context); 318 319 /// createGlobalVariableDIE - create global variable DIE. 320 void createGlobalVariableDIE(DIGlobalVariable GV); 321 322 /// constructContainingTypeDIEs - Construct DIEs for types that contain 323 /// vtables. 324 void constructContainingTypeDIEs(); 325 326 /// constructVariableDIE - Construct a DIE for the given DbgVariable. 327 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract); 328 329 /// Create a DIE with the given Tag, add the DIE to its parent, and 330 /// call insertDIE if MD is not null. 331 DIE *createAndAddDIE(unsigned Tag, DIE &Parent, DIDescriptor N = DIDescriptor()); 332 333 /// Compute the size of a header for this unit, not including the initial 334 /// length field. 335 unsigned getHeaderSize() const { 336 return sizeof(int16_t) + // DWARF version number 337 sizeof(int32_t) + // Offset Into Abbrev. Section 338 sizeof(int8_t); // Pointer Size (in bytes) 339 } 340 341 /// Emit the header for this unit, not including the initial length field. 342 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym); 343 344private: 345 /// constructSubprogramArguments - Construct function argument DIEs. 346 void constructSubprogramArguments(DIE &Buffer, DIArray Args); 347 348 /// constructTypeDIE - Construct basic type die from DIBasicType. 349 void constructTypeDIE(DIE &Buffer, DIBasicType BTy); 350 351 /// constructTypeDIE - Construct derived type die from DIDerivedType. 352 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy); 353 354 /// constructTypeDIE - Construct type DIE from DICompositeType. 355 void constructTypeDIE(DIE &Buffer, DICompositeType CTy); 356 357 /// constructSubrangeDIE - Construct subrange DIE from DISubrange. 358 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy); 359 360 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType. 361 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy); 362 363 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator. 364 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy); 365 366 /// constructMemberDIE - Construct member DIE from DIDerivedType. 367 void constructMemberDIE(DIE &Buffer, DIDerivedType DT); 368 369 /// constructTemplateTypeParameterDIE - Construct new DIE for the given 370 /// DITemplateTypeParameter. 371 void constructTemplateTypeParameterDIE(DIE &Buffer, 372 DITemplateTypeParameter TP); 373 374 /// constructTemplateValueParameterDIE - Construct new DIE for the given 375 /// DITemplateValueParameter. 376 void constructTemplateValueParameterDIE(DIE &Buffer, 377 DITemplateValueParameter TVP); 378 379 /// getOrCreateStaticMemberDIE - Create new static data member DIE. 380 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT); 381 382 /// Offset of the CUDie from beginning of debug info section. 383 unsigned DebugInfoOffset; 384 385 /// getLowerBoundDefault - Return the default lower bound for an array. If the 386 /// DWARF version doesn't handle the language, return -1. 387 int64_t getDefaultLowerBound() const; 388 389 /// getDIEEntry - Returns the debug information entry for the specified 390 /// debug variable. 391 DIEEntry *getDIEEntry(const MDNode *N) const { 392 return MDNodeToDIEEntryMap.lookup(N); 393 } 394 395 /// insertDIEEntry - Insert debug information entry into the map. 396 void insertDIEEntry(const MDNode *N, DIEEntry *E) { 397 MDNodeToDIEEntryMap.insert(std::make_pair(N, E)); 398 } 399 400 // getIndexTyDie - Get an anonymous type for index type. 401 DIE *getIndexTyDie() { return IndexTyDie; } 402 403 // setIndexTyDie - Set D as anonymous type for index which can be reused 404 // later. 405 void setIndexTyDie(DIE *D) { IndexTyDie = D; } 406 407 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug 408 /// information entry. 409 DIEEntry *createDIEEntry(DIE *Entry); 410 411 /// resolve - Look in the DwarfDebug map for the MDNode that 412 /// corresponds to the reference. 413 template <typename T> T resolve(DIRef<T> Ref) const { 414 return DD->resolve(Ref); 415 } 416}; 417 418} // end llvm namespace 419#endif 420