1//===--- llvm/DIBuilder.h - Debug Information Builder -----------*- 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 defines a DIBuilder that is useful for creating debugging 11// information entries in LLVM IR form. 12// 13//===----------------------------------------------------------------------===// 14 15#ifndef LLVM_ANALYSIS_DIBUILDER_H 16#define LLVM_ANALYSIS_DIBUILDER_H 17 18#include "llvm/Support/DataTypes.h" 19#include "llvm/ADT/ArrayRef.h" 20#include "llvm/ADT/StringRef.h" 21 22namespace llvm { 23 class BasicBlock; 24 class Instruction; 25 class Function; 26 class Module; 27 class Value; 28 class LLVMContext; 29 class MDNode; 30 class StringRef; 31 class DIDescriptor; 32 class DIFile; 33 class DIEnumerator; 34 class DIType; 35 class DIArray; 36 class DIGlobalVariable; 37 class DINameSpace; 38 class DIVariable; 39 class DISubrange; 40 class DILexicalBlockFile; 41 class DILexicalBlock; 42 class DISubprogram; 43 class DITemplateTypeParameter; 44 class DITemplateValueParameter; 45 class DIObjCProperty; 46 47 class DIBuilder { 48 private: 49 Module &M; 50 LLVMContext & VMContext; 51 MDNode *TheCU; 52 53 MDNode *TempEnumTypes; 54 MDNode *TempRetainTypes; 55 MDNode *TempSubprograms; 56 MDNode *TempGVs; 57 58 Function *DeclareFn; // llvm.dbg.declare 59 Function *ValueFn; // llvm.dbg.value 60 61 SmallVector<Value *, 4> AllEnumTypes; 62 SmallVector<Value *, 4> AllRetainTypes; 63 SmallVector<Value *, 4> AllSubprograms; 64 SmallVector<Value *, 4> AllGVs; 65 66 DIBuilder(const DIBuilder &) LLVM_DELETED_FUNCTION; 67 void operator=(const DIBuilder &) LLVM_DELETED_FUNCTION; 68 69 public: 70 explicit DIBuilder(Module &M); 71 const MDNode *getCU() { return TheCU; } 72 enum ComplexAddrKind { OpPlus=1, OpDeref }; 73 74 /// finalize - Construct any deferred debug info descriptors. 75 void finalize(); 76 77 /// createCompileUnit - A CompileUnit provides an anchor for all debugging 78 /// information generated during this instance of compilation. 79 /// @param Lang Source programming language, eg. dwarf::DW_LANG_C99 80 /// @param File File name 81 /// @param Dir Directory 82 /// @param Producer String identify producer of debugging information. 83 /// Usuall this is a compiler version string. 84 /// @param isOptimized A boolean flag which indicates whether optimization 85 /// is ON or not. 86 /// @param Flags This string lists command line options. This string is 87 /// directly embedded in debug info output which may be used 88 /// by a tool analyzing generated debugging information. 89 /// @param RV This indicates runtime version for languages like 90 /// Objective-C. 91 void createCompileUnit(unsigned Lang, StringRef File, StringRef Dir, 92 StringRef Producer, 93 bool isOptimized, StringRef Flags, unsigned RV); 94 95 /// createFile - Create a file descriptor to hold debugging information 96 /// for a file. 97 DIFile createFile(StringRef Filename, StringRef Directory); 98 99 /// createEnumerator - Create a single enumerator value. 100 DIEnumerator createEnumerator(StringRef Name, uint64_t Val); 101 102 /// createNullPtrType - Create C++0x nullptr type. 103 DIType createNullPtrType(StringRef Name); 104 105 /// createBasicType - Create debugging information entry for a basic 106 /// type. 107 /// @param Name Type name. 108 /// @param SizeInBits Size of the type. 109 /// @param AlignInBits Type alignment. 110 /// @param Encoding DWARF encoding code, e.g. dwarf::DW_ATE_float. 111 DIType createBasicType(StringRef Name, uint64_t SizeInBits, 112 uint64_t AlignInBits, unsigned Encoding); 113 114 /// createQualifiedType - Create debugging information entry for a qualified 115 /// type, e.g. 'const int'. 116 /// @param Tag Tag identifing type, e.g. dwarf::TAG_volatile_type 117 /// @param FromTy Base Type. 118 DIType createQualifiedType(unsigned Tag, DIType FromTy); 119 120 /// createPointerType - Create debugging information entry for a pointer. 121 /// @param PointeeTy Type pointed by this pointer. 122 /// @param SizeInBits Size. 123 /// @param AlignInBits Alignment. (optional) 124 /// @param Name Pointer type name. (optional) 125 DIType createPointerType(DIType PointeeTy, uint64_t SizeInBits, 126 uint64_t AlignInBits = 0, 127 StringRef Name = StringRef()); 128 129 /// createReferenceType - Create debugging information entry for a c++ 130 /// style reference or rvalue reference type. 131 DIType createReferenceType(unsigned Tag, DIType RTy); 132 133 /// createTypedef - Create debugging information entry for a typedef. 134 /// @param Ty Original type. 135 /// @param Name Typedef name. 136 /// @param File File where this type is defined. 137 /// @param LineNo Line number. 138 /// @param Context The surrounding context for the typedef. 139 DIType createTypedef(DIType Ty, StringRef Name, DIFile File, 140 unsigned LineNo, DIDescriptor Context); 141 142 /// createFriend - Create debugging information entry for a 'friend'. 143 DIType createFriend(DIType Ty, DIType FriendTy); 144 145 /// createInheritance - Create debugging information entry to establish 146 /// inheritance relationship between two types. 147 /// @param Ty Original type. 148 /// @param BaseTy Base type. Ty is inherits from base. 149 /// @param BaseOffset Base offset. 150 /// @param Flags Flags to describe inheritance attribute, 151 /// e.g. private 152 DIType createInheritance(DIType Ty, DIType BaseTy, uint64_t BaseOffset, 153 unsigned Flags); 154 155 /// createMemberType - Create debugging information entry for a member. 156 /// @param Scope Member scope. 157 /// @param Name Member name. 158 /// @param File File where this member is defined. 159 /// @param LineNo Line number. 160 /// @param SizeInBits Member size. 161 /// @param AlignInBits Member alignment. 162 /// @param OffsetInBits Member offset. 163 /// @param Flags Flags to encode member attribute, e.g. private 164 /// @param Ty Parent type. 165 DIType createMemberType(DIDescriptor Scope, StringRef Name, DIFile File, 166 unsigned LineNo, uint64_t SizeInBits, 167 uint64_t AlignInBits, uint64_t OffsetInBits, 168 unsigned Flags, DIType Ty); 169 170 /// createObjCIVar - Create debugging information entry for Objective-C 171 /// instance variable. 172 /// @param Name Member name. 173 /// @param File File where this member is defined. 174 /// @param LineNo Line number. 175 /// @param SizeInBits Member size. 176 /// @param AlignInBits Member alignment. 177 /// @param OffsetInBits Member offset. 178 /// @param Flags Flags to encode member attribute, e.g. private 179 /// @param Ty Parent type. 180 /// @param PropertyName Name of the Objective C property associated with 181 /// this ivar. 182 /// @param PropertyGetterName Name of the Objective C property getter 183 /// selector. 184 /// @param PropertySetterName Name of the Objective C property setter 185 /// selector. 186 /// @param PropertyAttributes Objective C property attributes. 187 DIType createObjCIVar(StringRef Name, DIFile File, 188 unsigned LineNo, uint64_t SizeInBits, 189 uint64_t AlignInBits, uint64_t OffsetInBits, 190 unsigned Flags, DIType Ty, 191 StringRef PropertyName = StringRef(), 192 StringRef PropertyGetterName = StringRef(), 193 StringRef PropertySetterName = StringRef(), 194 unsigned PropertyAttributes = 0); 195 196 /// createObjCIVar - Create debugging information entry for Objective-C 197 /// instance variable. 198 /// @param Name Member name. 199 /// @param File File where this member is defined. 200 /// @param LineNo Line number. 201 /// @param SizeInBits Member size. 202 /// @param AlignInBits Member alignment. 203 /// @param OffsetInBits Member offset. 204 /// @param Flags Flags to encode member attribute, e.g. private 205 /// @param Ty Parent type. 206 /// @param PropertyNode Property associated with this ivar. 207 DIType createObjCIVar(StringRef Name, DIFile File, 208 unsigned LineNo, uint64_t SizeInBits, 209 uint64_t AlignInBits, uint64_t OffsetInBits, 210 unsigned Flags, DIType Ty, 211 MDNode *PropertyNode); 212 213 /// createObjCProperty - Create debugging information entry for Objective-C 214 /// property. 215 /// @param Name Property name. 216 /// @param File File where this property is defined. 217 /// @param LineNumber Line number. 218 /// @param GetterName Name of the Objective C property getter selector. 219 /// @param SetterName Name of the Objective C property setter selector. 220 /// @param PropertyAttributes Objective C property attributes. 221 /// @param Ty Type. 222 DIObjCProperty createObjCProperty(StringRef Name, 223 DIFile File, unsigned LineNumber, 224 StringRef GetterName, 225 StringRef SetterName, 226 unsigned PropertyAttributes, 227 DIType Ty); 228 229 /// createClassType - Create debugging information entry for a class. 230 /// @param Scope Scope in which this class is defined. 231 /// @param Name class name. 232 /// @param File File where this member is defined. 233 /// @param LineNumber Line number. 234 /// @param SizeInBits Member size. 235 /// @param AlignInBits Member alignment. 236 /// @param OffsetInBits Member offset. 237 /// @param Flags Flags to encode member attribute, e.g. private 238 /// @param Elements class members. 239 /// @param VTableHolder Debug info of the base class that contains vtable 240 /// for this type. This is used in 241 /// DW_AT_containing_type. See DWARF documentation 242 /// for more info. 243 /// @param TemplateParms Template type parameters. 244 DIType createClassType(DIDescriptor Scope, StringRef Name, DIFile File, 245 unsigned LineNumber, uint64_t SizeInBits, 246 uint64_t AlignInBits, uint64_t OffsetInBits, 247 unsigned Flags, DIType DerivedFrom, 248 DIArray Elements, MDNode *VTableHolder = 0, 249 MDNode *TemplateParms = 0); 250 251 /// createStructType - Create debugging information entry for a struct. 252 /// @param Scope Scope in which this struct is defined. 253 /// @param Name Struct name. 254 /// @param File File where this member is defined. 255 /// @param LineNumber Line number. 256 /// @param SizeInBits Member size. 257 /// @param AlignInBits Member alignment. 258 /// @param Flags Flags to encode member attribute, e.g. private 259 /// @param Elements Struct elements. 260 /// @param RunTimeLang Optional parameter, Objective-C runtime version. 261 DIType createStructType(DIDescriptor Scope, StringRef Name, DIFile File, 262 unsigned LineNumber, uint64_t SizeInBits, 263 uint64_t AlignInBits, unsigned Flags, 264 DIArray Elements, unsigned RunTimeLang = 0); 265 266 /// createUnionType - Create debugging information entry for an union. 267 /// @param Scope Scope in which this union is defined. 268 /// @param Name Union name. 269 /// @param File File where this member is defined. 270 /// @param LineNumber Line number. 271 /// @param SizeInBits Member size. 272 /// @param AlignInBits Member alignment. 273 /// @param Flags Flags to encode member attribute, e.g. private 274 /// @param Elements Union elements. 275 /// @param RunTimeLang Optional parameter, Objective-C runtime version. 276 DIType createUnionType(DIDescriptor Scope, StringRef Name, DIFile File, 277 unsigned LineNumber, uint64_t SizeInBits, 278 uint64_t AlignInBits, unsigned Flags, 279 DIArray Elements, unsigned RunTimeLang = 0); 280 281 /// createTemplateTypeParameter - Create debugging information for template 282 /// type parameter. 283 /// @param Scope Scope in which this type is defined. 284 /// @param Name Type parameter name. 285 /// @param Ty Parameter type. 286 /// @param File File where this type parameter is defined. 287 /// @param LineNo Line number. 288 /// @param ColumnNo Column Number. 289 DITemplateTypeParameter 290 createTemplateTypeParameter(DIDescriptor Scope, StringRef Name, DIType Ty, 291 MDNode *File = 0, unsigned LineNo = 0, 292 unsigned ColumnNo = 0); 293 294 /// createTemplateValueParameter - Create debugging information for template 295 /// value parameter. 296 /// @param Scope Scope in which this type is defined. 297 /// @param Name Value parameter name. 298 /// @param Ty Parameter type. 299 /// @param Value Constant parameter value. 300 /// @param File File where this type parameter is defined. 301 /// @param LineNo Line number. 302 /// @param ColumnNo Column Number. 303 DITemplateValueParameter 304 createTemplateValueParameter(DIDescriptor Scope, StringRef Name, DIType Ty, 305 uint64_t Value, 306 MDNode *File = 0, unsigned LineNo = 0, 307 unsigned ColumnNo = 0); 308 309 /// createArrayType - Create debugging information entry for an array. 310 /// @param Size Array size. 311 /// @param AlignInBits Alignment. 312 /// @param Ty Element type. 313 /// @param Subscripts Subscripts. 314 DIType createArrayType(uint64_t Size, uint64_t AlignInBits, 315 DIType Ty, DIArray Subscripts); 316 317 /// createVectorType - Create debugging information entry for a vector type. 318 /// @param Size Array size. 319 /// @param AlignInBits Alignment. 320 /// @param Ty Element type. 321 /// @param Subscripts Subscripts. 322 DIType createVectorType(uint64_t Size, uint64_t AlignInBits, 323 DIType Ty, DIArray Subscripts); 324 325 /// createEnumerationType - Create debugging information entry for an 326 /// enumeration. 327 /// @param Scope Scope in which this enumeration is defined. 328 /// @param Name Union name. 329 /// @param File File where this member is defined. 330 /// @param LineNumber Line number. 331 /// @param SizeInBits Member size. 332 /// @param AlignInBits Member alignment. 333 /// @param Elements Enumeration elements. 334 DIType createEnumerationType(DIDescriptor Scope, StringRef Name, 335 DIFile File, unsigned LineNumber, 336 uint64_t SizeInBits, uint64_t AlignInBits, 337 DIArray Elements, DIType ClassType); 338 339 /// createSubroutineType - Create subroutine type. 340 /// @param File File in which this subroutine is defined. 341 /// @param ParameterTypes An array of subroutine parameter types. This 342 /// includes return type at 0th index. 343 DIType createSubroutineType(DIFile File, DIArray ParameterTypes); 344 345 /// createArtificialType - Create a new DIType with "artificial" flag set. 346 DIType createArtificialType(DIType Ty); 347 348 /// createObjectPointerType - Create a new DIType with the "object pointer" 349 /// flag set. 350 DIType createObjectPointerType(DIType Ty); 351 352 /// createTemporaryType - Create a temporary forward-declared type. 353 DIType createTemporaryType(); 354 DIType createTemporaryType(DIFile F); 355 356 /// createForwardDecl - Create a temporary forward-declared type. 357 DIType createForwardDecl(unsigned Tag, StringRef Name, DIDescriptor Scope, 358 DIFile F, unsigned Line, unsigned RuntimeLang = 0, 359 uint64_t SizeInBits = 0, uint64_t AlignInBits = 0); 360 361 /// retainType - Retain DIType in a module even if it is not referenced 362 /// through debug info anchors. 363 void retainType(DIType T); 364 365 /// createUnspecifiedParameter - Create unspeicified type descriptor 366 /// for a subroutine type. 367 DIDescriptor createUnspecifiedParameter(); 368 369 /// getOrCreateArray - Get a DIArray, create one if required. 370 DIArray getOrCreateArray(ArrayRef<Value *> Elements); 371 372 /// getOrCreateSubrange - Create a descriptor for a value range. This 373 /// implicitly uniques the values returned. 374 DISubrange getOrCreateSubrange(int64_t Lo, int64_t Hi); 375 376 /// createGlobalVariable - Create a new descriptor for the specified global. 377 /// @param Name Name of the variable. 378 /// @param File File where this variable is defined. 379 /// @param LineNo Line number. 380 /// @param Ty Variable Type. 381 /// @param isLocalToUnit Boolean flag indicate whether this variable is 382 /// externally visible or not. 383 /// @param Val llvm::Value of the variable. 384 DIGlobalVariable 385 createGlobalVariable(StringRef Name, DIFile File, unsigned LineNo, 386 DIType Ty, bool isLocalToUnit, llvm::Value *Val); 387 388 389 /// createStaticVariable - Create a new descriptor for the specified 390 /// variable. 391 /// @param Context Variable scope. 392 /// @param Name Name of the variable. 393 /// @param LinkageName Mangled name of the variable. 394 /// @param File File where this variable is defined. 395 /// @param LineNo Line number. 396 /// @param Ty Variable Type. 397 /// @param isLocalToUnit Boolean flag indicate whether this variable is 398 /// externally visible or not. 399 /// @param Val llvm::Value of the variable. 400 DIGlobalVariable 401 createStaticVariable(DIDescriptor Context, StringRef Name, 402 StringRef LinkageName, DIFile File, unsigned LineNo, 403 DIType Ty, bool isLocalToUnit, llvm::Value *Val); 404 405 406 /// createLocalVariable - Create a new descriptor for the specified 407 /// local variable. 408 /// @param Tag Dwarf TAG. Usually DW_TAG_auto_variable or 409 /// DW_TAG_arg_variable. 410 /// @param Scope Variable scope. 411 /// @param Name Variable name. 412 /// @param File File where this variable is defined. 413 /// @param LineNo Line number. 414 /// @param Ty Variable Type 415 /// @param AlwaysPreserve Boolean. Set to true if debug info for this 416 /// variable should be preserved in optimized build. 417 /// @param Flags Flags, e.g. artificial variable. 418 /// @param ArgNo If this variable is an arugment then this argument's 419 /// number. 1 indicates 1st argument. 420 DIVariable createLocalVariable(unsigned Tag, DIDescriptor Scope, 421 StringRef Name, 422 DIFile File, unsigned LineNo, 423 DIType Ty, bool AlwaysPreserve = false, 424 unsigned Flags = 0, 425 unsigned ArgNo = 0); 426 427 428 /// createComplexVariable - Create a new descriptor for the specified 429 /// variable which has a complex address expression for its address. 430 /// @param Tag Dwarf TAG. Usually DW_TAG_auto_variable or 431 /// DW_TAG_arg_variable. 432 /// @param Scope Variable scope. 433 /// @param Name Variable name. 434 /// @param F File where this variable is defined. 435 /// @param LineNo Line number. 436 /// @param Ty Variable Type 437 /// @param Addr An array of complex address operations. 438 /// @param ArgNo If this variable is an arugment then this argument's 439 /// number. 1 indicates 1st argument. 440 DIVariable createComplexVariable(unsigned Tag, DIDescriptor Scope, 441 StringRef Name, DIFile F, unsigned LineNo, 442 DIType Ty, ArrayRef<Value *> Addr, 443 unsigned ArgNo = 0); 444 445 /// createFunction - Create a new descriptor for the specified subprogram. 446 /// See comments in DISubprogram for descriptions of these fields. 447 /// @param Scope Function scope. 448 /// @param Name Function name. 449 /// @param LinkageName Mangled function name. 450 /// @param File File where this variable is defined. 451 /// @param LineNo Line number. 452 /// @param Ty Function type. 453 /// @param isLocalToUnit True if this function is not externally visible.. 454 /// @param isDefinition True if this is a function definition. 455 /// @param ScopeLine Set to the beginning of the scope this starts 456 /// @param Flags e.g. is this function prototyped or not. 457 /// This flags are used to emit dwarf attributes. 458 /// @param isOptimized True if optimization is ON. 459 /// @param Fn llvm::Function pointer. 460 /// @param TParam Function template parameters. 461 DISubprogram createFunction(DIDescriptor Scope, StringRef Name, 462 StringRef LinkageName, 463 DIFile File, unsigned LineNo, 464 DIType Ty, bool isLocalToUnit, 465 bool isDefinition, 466 unsigned ScopeLine, 467 unsigned Flags = 0, 468 bool isOptimized = false, 469 Function *Fn = 0, 470 MDNode *TParam = 0, 471 MDNode *Decl = 0); 472 473 /// createMethod - Create a new descriptor for the specified C++ method. 474 /// See comments in DISubprogram for descriptions of these fields. 475 /// @param Scope Function scope. 476 /// @param Name Function name. 477 /// @param LinkageName Mangled function name. 478 /// @param File File where this variable is defined. 479 /// @param LineNo Line number. 480 /// @param Ty Function type. 481 /// @param isLocalToUnit True if this function is not externally visible.. 482 /// @param isDefinition True if this is a function definition. 483 /// @param Virtuality Attributes describing virtualness. e.g. pure 484 /// virtual function. 485 /// @param VTableIndex Index no of this method in virtual table. 486 /// @param VTableHolder Type that holds vtable. 487 /// @param Flags e.g. is this function prototyped or not. 488 /// This flags are used to emit dwarf attributes. 489 /// @param isOptimized True if optimization is ON. 490 /// @param Fn llvm::Function pointer. 491 /// @param TParam Function template parameters. 492 DISubprogram createMethod(DIDescriptor Scope, StringRef Name, 493 StringRef LinkageName, 494 DIFile File, unsigned LineNo, 495 DIType Ty, bool isLocalToUnit, 496 bool isDefinition, 497 unsigned Virtuality = 0, unsigned VTableIndex = 0, 498 MDNode *VTableHolder = 0, 499 unsigned Flags = 0, 500 bool isOptimized = false, 501 Function *Fn = 0, 502 MDNode *TParam = 0); 503 504 /// createNameSpace - This creates new descriptor for a namespace 505 /// with the specified parent scope. 506 /// @param Scope Namespace scope 507 /// @param Name Name of this namespace 508 /// @param File Source file 509 /// @param LineNo Line number 510 DINameSpace createNameSpace(DIDescriptor Scope, StringRef Name, 511 DIFile File, unsigned LineNo); 512 513 514 /// createLexicalBlockFile - This creates a descriptor for a lexical 515 /// block with a new file attached. This merely extends the existing 516 /// lexical block as it crosses a file. 517 /// @param Scope Lexical block. 518 /// @param File Source file. 519 DILexicalBlockFile createLexicalBlockFile(DIDescriptor Scope, 520 DIFile File); 521 522 /// createLexicalBlock - This creates a descriptor for a lexical block 523 /// with the specified parent context. 524 /// @param Scope Parent lexical scope. 525 /// @param File Source file 526 /// @param Line Line number 527 /// @param Col Column number 528 DILexicalBlock createLexicalBlock(DIDescriptor Scope, DIFile File, 529 unsigned Line, unsigned Col); 530 531 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call. 532 /// @param Storage llvm::Value of the variable 533 /// @param VarInfo Variable's debug info descriptor. 534 /// @param InsertAtEnd Location for the new intrinsic. 535 Instruction *insertDeclare(llvm::Value *Storage, DIVariable VarInfo, 536 BasicBlock *InsertAtEnd); 537 538 /// insertDeclare - Insert a new llvm.dbg.declare intrinsic call. 539 /// @param Storage llvm::Value of the variable 540 /// @param VarInfo Variable's debug info descriptor. 541 /// @param InsertBefore Location for the new intrinsic. 542 Instruction *insertDeclare(llvm::Value *Storage, DIVariable VarInfo, 543 Instruction *InsertBefore); 544 545 546 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call. 547 /// @param Val llvm::Value of the variable 548 /// @param Offset Offset 549 /// @param VarInfo Variable's debug info descriptor. 550 /// @param InsertAtEnd Location for the new intrinsic. 551 Instruction *insertDbgValueIntrinsic(llvm::Value *Val, uint64_t Offset, 552 DIVariable VarInfo, 553 BasicBlock *InsertAtEnd); 554 555 /// insertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call. 556 /// @param Val llvm::Value of the variable 557 /// @param Offset Offset 558 /// @param VarInfo Variable's debug info descriptor. 559 /// @param InsertBefore Location for the new intrinsic. 560 Instruction *insertDbgValueIntrinsic(llvm::Value *Val, uint64_t Offset, 561 DIVariable VarInfo, 562 Instruction *InsertBefore); 563 564 }; 565} // end namespace llvm 566 567#endif 568