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 26 namespace llvm { 27 28 class MachineLocation; 29 class MachineOperand; 30 class ConstantInt; 31 class ConstantFP; 32 class DbgVariable; 33 34 //===----------------------------------------------------------------------===// 35 /// CompileUnit - This dwarf writer support class manages information associated 36 /// with a source file. 37 class 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 96 public: 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 /// addLabelAddress - Add a dwarf label attribute data and value using 213 /// either DW_FORM_addr or DW_FORM_GNU_addr_index. 214 /// 215 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label); 216 217 /// addOpAddress - Add a dwarf op address data and value using the 218 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index. 219 /// 220 void addOpAddress(DIEBlock *Die, const MCSymbol *Label); 221 222 /// addDelta - Add a label delta attribute data and value. 223 /// 224 void addDelta(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form, const MCSymbol *Hi, 225 const MCSymbol *Lo); 226 227 /// addDIEEntry - Add a DIE attribute data and value. 228 /// 229 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry); 230 231 /// addDIEEntry - Add a DIE attribute data and value. 232 /// 233 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry); 234 235 /// addBlock - Add block data. 236 /// 237 void addBlock(DIE *Die, dwarf::Attribute Attribute, DIEBlock *Block); 238 239 /// addSourceLine - Add location information to specified debug information 240 /// entry. 241 void addSourceLine(DIE *Die, DIVariable V); 242 void addSourceLine(DIE *Die, DIGlobalVariable G); 243 void addSourceLine(DIE *Die, DISubprogram SP); 244 void addSourceLine(DIE *Die, DIType Ty); 245 void addSourceLine(DIE *Die, DINameSpace NS); 246 void addSourceLine(DIE *Die, DIObjCProperty Ty); 247 248 /// addAddress - Add an address attribute to a die based on the location 249 /// provided. 250 void addAddress(DIE *Die, dwarf::Attribute Attribute, const MachineLocation &Location, 251 bool Indirect = false); 252 253 /// addConstantValue - Add constant value entry in variable DIE. 254 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty); 255 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned); 256 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned); 257 258 /// addConstantFPValue - Add constant value entry in variable DIE. 259 void addConstantFPValue(DIE *Die, const MachineOperand &MO); 260 void addConstantFPValue(DIE *Die, const ConstantFP *CFP); 261 262 /// addTemplateParams - Add template parameters in buffer. 263 void addTemplateParams(DIE &Buffer, DIArray TParams); 264 265 /// addRegisterOp - Add register operand. 266 void addRegisterOp(DIEBlock *TheDie, unsigned Reg); 267 268 /// addRegisterOffset - Add register offset. 269 void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset); 270 271 /// addComplexAddress - Start with the address based on the location provided, 272 /// and generate the DWARF information necessary to find the actual variable 273 /// (navigating the extra location information encoded in the type) based on 274 /// the starting location. Add the DWARF information to the die. 275 /// 276 void addComplexAddress(const DbgVariable &DV, DIE *Die, dwarf::Attribute Attribute, 277 const MachineLocation &Location); 278 279 // FIXME: Should be reformulated in terms of addComplexAddress. 280 /// addBlockByrefAddress - Start with the address based on the location 281 /// provided, and generate the DWARF information necessary to find the 282 /// actual Block variable (navigating the Block struct) based on the 283 /// starting location. Add the DWARF information to the die. Obsolete, 284 /// please use addComplexAddress instead. 285 /// 286 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die, dwarf::Attribute Attribute, 287 const MachineLocation &Location); 288 289 /// addVariableAddress - Add DW_AT_location attribute for a 290 /// DbgVariable based on provided MachineLocation. 291 void addVariableAddress(const DbgVariable &DV, DIE *Die, 292 MachineLocation Location); 293 294 /// addType - Add a new type attribute to the specified entity. This takes 295 /// and attribute parameter because DW_AT_friend attributes are also 296 /// type references. 297 void addType(DIE *Entity, DIType Ty, dwarf::Attribute Attribute = dwarf::DW_AT_type); 298 299 /// getOrCreateNameSpace - Create a DIE for DINameSpace. 300 DIE *getOrCreateNameSpace(DINameSpace NS); 301 302 /// getOrCreateSubprogramDIE - Create new DIE using SP. 303 DIE *getOrCreateSubprogramDIE(DISubprogram SP); 304 305 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the 306 /// given DIType. 307 DIE *getOrCreateTypeDIE(const MDNode *N); 308 309 /// getOrCreateContextDIE - Get context owner's DIE. 310 DIE *getOrCreateContextDIE(DIScope Context); 311 312 /// createGlobalVariableDIE - create global variable DIE. 313 void createGlobalVariableDIE(DIGlobalVariable GV); 314 315 /// constructContainingTypeDIEs - Construct DIEs for types that contain 316 /// vtables. 317 void constructContainingTypeDIEs(); 318 319 /// constructVariableDIE - Construct a DIE for the given DbgVariable. 320 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract); 321 322 /// Create a DIE with the given Tag, add the DIE to its parent, and 323 /// call insertDIE if MD is not null. 324 DIE *createAndAddDIE(unsigned Tag, DIE &Parent, DIDescriptor N = DIDescriptor()); 325 326 /// Compute the size of a header for this unit, not including the initial 327 /// length field. 328 unsigned getHeaderSize() const { 329 return sizeof(int16_t) + // DWARF version number 330 sizeof(int32_t) + // Offset Into Abbrev. Section 331 sizeof(int8_t); // Pointer Size (in bytes) 332 } 333 334 /// Emit the header for this unit, not including the initial length field. 335 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym); 336 337 private: 338 /// constructTypeDIE - Construct basic type die from DIBasicType. 339 void constructTypeDIE(DIE &Buffer, DIBasicType BTy); 340 341 /// constructTypeDIE - Construct derived type die from DIDerivedType. 342 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy); 343 344 /// constructTypeDIE - Construct type DIE from DICompositeType. 345 void constructTypeDIE(DIE &Buffer, DICompositeType CTy); 346 347 /// constructSubrangeDIE - Construct subrange DIE from DISubrange. 348 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy); 349 350 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType. 351 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy); 352 353 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator. 354 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy); 355 356 /// constructMemberDIE - Construct member DIE from DIDerivedType. 357 void constructMemberDIE(DIE &Buffer, DIDerivedType DT); 358 359 /// constructTemplateTypeParameterDIE - Construct new DIE for the given 360 /// DITemplateTypeParameter. 361 void constructTemplateTypeParameterDIE(DIE &Buffer, 362 DITemplateTypeParameter TP); 363 364 /// constructTemplateValueParameterDIE - Construct new DIE for the given 365 /// DITemplateValueParameter. 366 void constructTemplateValueParameterDIE(DIE &Buffer, 367 DITemplateValueParameter TVP); 368 369 /// getOrCreateStaticMemberDIE - Create new static data member DIE. 370 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT); 371 372 /// Offset of the CUDie from beginning of debug info section. 373 unsigned DebugInfoOffset; 374 375 /// getLowerBoundDefault - Return the default lower bound for an array. If the 376 /// DWARF version doesn't handle the language, return -1. 377 int64_t getDefaultLowerBound() const; 378 379 /// getDIEEntry - Returns the debug information entry for the specified 380 /// debug variable. 381 DIEEntry *getDIEEntry(const MDNode *N) const { 382 return MDNodeToDIEEntryMap.lookup(N); 383 } 384 385 /// insertDIEEntry - Insert debug information entry into the map. 386 void insertDIEEntry(const MDNode *N, DIEEntry *E) { 387 MDNodeToDIEEntryMap.insert(std::make_pair(N, E)); 388 } 389 390 // getIndexTyDie - Get an anonymous type for index type. 391 DIE *getIndexTyDie() { return IndexTyDie; } 392 393 // setIndexTyDie - Set D as anonymous type for index which can be reused 394 // later. 395 void setIndexTyDie(DIE *D) { IndexTyDie = D; } 396 397 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug 398 /// information entry. 399 DIEEntry *createDIEEntry(DIE *Entry); 400 401 /// resolve - Look in the DwarfDebug map for the MDNode that 402 /// corresponds to the reference. 403 template <typename T> T resolve(DIRef<T> Ref) const { 404 return DD->resolve(Ref); 405 } 406 }; 407 408 } // end llvm namespace 409 #endif 410