include/llvm/IR/DIBuilder.h

   1 //===- 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_IR_DIBUILDER_H
  16 #define LLVM_IR_DIBUILDER_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/IR/DebugInfo.h"
  21 #include "llvm/IR/TrackingMDRef.h"
  22 #include "llvm/IR/ValueHandle.h"
  23 #include "llvm/Support/DataTypes.h"
  24
  25 namespace llvm {
  26   class BasicBlock;
  27   class Instruction;
  28   class Function;
  29   class Module;
  30   class Value;
  31   class Constant;
  32   class LLVMContext;
  33   class StringRef;
  34
  35   class DIBuilder {
  36     Module &M;
  37     LLVMContext &VMContext;
  38
  39     DICompileUnit *CUNode;   ///< The one compile unit created by this DIBuiler.
  40     Function *DeclareFn;     ///< llvm.dbg.declare
  41     Function *ValueFn;       ///< llvm.dbg.value
  42
  43     SmallVector<Metadata *, 4> AllEnumTypes;
  44     /// Track the RetainTypes, since they can be updated later on.
  45     SmallVector<TrackingMDNodeRef, 4> AllRetainTypes;
  46     SmallVector<Metadata *, 4> AllSubprograms;
  47     SmallVector<Metadata *, 4> AllGVs;
  48     SmallVector<TrackingMDNodeRef, 4> AllImportedModules;
  49
  50     /// Track nodes that may be unresolved.
  51     SmallVector<TrackingMDNodeRef, 4> UnresolvedNodes;
  52     bool AllowUnresolvedNodes;
  53
  54     /// Each subprogram's preserved local variables.
  55     DenseMap<MDNode *, std::vector<TrackingMDNodeRef>> PreservedVariables;
  56
  57     DIBuilder(const DIBuilder &) = delete;
  58     void operator=(const DIBuilder &) = delete;
  59
  60     /// Create a temporary.
  61     ///
  62     /// Create an \a temporary node and track it in \a UnresolvedNodes.
  63     void trackIfUnresolved(MDNode *N);
  64
  65   public:
  66     /// Construct a builder for a module.
  67     ///
  68     /// If \c AllowUnresolved, collect unresolved nodes attached to the module
  69     /// in order to resolve cycles during \a finalize().
  70     explicit DIBuilder(Module &M, bool AllowUnresolved = true);
  71     enum DebugEmissionKind { FullDebug=1, LineTablesOnly };
  72
  73     /// Construct any deferred debug info descriptors.
  74     void finalize();
  75
  76     /// A CompileUnit provides an anchor for all debugging
  77     /// information generated during this instance of compilation.
  78     /// \param Lang          Source programming language, eg. dwarf::DW_LANG_C99
  79     /// \param File          File name
  80     /// \param Dir           Directory
  81     /// \param Producer      Identify the producer of debugging information
  82     ///                      and code.  Usually this is a compiler
  83     ///                      version string.
  84     /// \param isOptimized   A boolean flag which indicates whether optimization
  85     ///                      is enabled or not.
  86     /// \param Flags         This string lists command line options. This
  87     ///                      string is directly embedded in debug info
  88     ///                      output which may be used by a tool
  89     ///                      analyzing generated debugging information.
  90     /// \param RV            This indicates runtime version for languages like
  91     ///                      Objective-C.
  92     /// \param SplitName     The name of the file that we'll split debug info
  93     ///                      out into.
  94     /// \param Kind          The kind of debug information to generate.
  95     /// \param DWOId         The DWOId if this is a split skeleton compile unit.
  96     /// \param EmitDebugInfo A boolean flag which indicates whether
  97     ///                      debug information should be written to
  98     ///                      the final output or not. When this is
  99     ///                      false, debug information annotations will
 100     ///                      be present in the IL but they are not
 101     ///                      written to the final assembly or object
 102     ///                      file. This supports tracking source
 103     ///                      location information in the back end
 104     ///                      without actually changing the output
 105     ///                      (e.g., when using optimization remarks).
 106     DICompileUnit *
 107     createCompileUnit(unsigned Lang, StringRef File, StringRef Dir,
 108                       StringRef Producer, bool isOptimized, StringRef Flags,
 109                       unsigned RV, StringRef SplitName = StringRef(),
 110                       DebugEmissionKind Kind = FullDebug, uint64_t DWOId = 0,
 111                       bool EmitDebugInfo = true);
 112
 113     /// Create a file descriptor to hold debugging information
 114     /// for a file.
 115     DIFile *createFile(StringRef Filename, StringRef Directory);
 116
 117     /// Create a single enumerator value.
 118     DIEnumerator *createEnumerator(StringRef Name, int64_t Val);
 119
 120     /// Create a DWARF unspecified type.
 121     DIBasicType *createUnspecifiedType(StringRef Name);
 122
 123     /// Create C++11 nullptr type.
 124     DIBasicType *createNullPtrType();
 125
 126     /// Create debugging information entry for a basic
 127     /// type.
 128     /// \param Name        Type name.
 129     /// \param SizeInBits  Size of the type.
 130     /// \param AlignInBits Type alignment.
 131     /// \param Encoding    DWARF encoding code, e.g. dwarf::DW_ATE_float.
 132     DIBasicType *createBasicType(StringRef Name, uint64_t SizeInBits,
 133                                  uint64_t AlignInBits, unsigned Encoding);
 134
 135     /// Create debugging information entry for a qualified
 136     /// type, e.g. 'const int'.
 137     /// \param Tag         Tag identifing type, e.g. dwarf::TAG_volatile_type
 138     /// \param FromTy      Base Type.
 139     DIDerivedType *createQualifiedType(unsigned Tag, DIType *FromTy);
 140
 141     /// Create debugging information entry for a pointer.
 142     /// \param PointeeTy   Type pointed by this pointer.
 143     /// \param SizeInBits  Size.
 144     /// \param AlignInBits Alignment. (optional)
 145     /// \param Name        Pointer type name. (optional)
 146     DIDerivedType *createPointerType(DIType *PointeeTy, uint64_t SizeInBits,
 147                                      uint64_t AlignInBits = 0,
 148                                      StringRef Name = "");
 149
 150     /// Create debugging information entry for a pointer to member.
 151     /// \param PointeeTy Type pointed to by this pointer.
 152     /// \param SizeInBits  Size.
 153     /// \param AlignInBits Alignment. (optional)
 154     /// \param Class Type for which this pointer points to members of.
 155     DIDerivedType *createMemberPointerType(DIType *PointeeTy, DIType *Class,
 156                                            uint64_t SizeInBits,
 157                                            uint64_t AlignInBits = 0);
 158
 159     /// Create debugging information entry for a c++
 160     /// style reference or rvalue reference type.
 161     DIDerivedType *createReferenceType(unsigned Tag, DIType *RTy);
 162
 163     /// Create debugging information entry for a typedef.
 164     /// \param Ty          Original type.
 165     /// \param Name        Typedef name.
 166     /// \param File        File where this type is defined.
 167     /// \param LineNo      Line number.
 168     /// \param Context     The surrounding context for the typedef.
 169     DIDerivedType *createTypedef(DIType *Ty, StringRef Name, DIFile *File,
 170                                  unsigned LineNo, DIScope *Context);
 171
 172     /// Create debugging information entry for a 'friend'.
 173     DIDerivedType *createFriend(DIType *Ty, DIType *FriendTy);
 174
 175     /// Create debugging information entry to establish
 176     /// inheritance relationship between two types.
 177     /// \param Ty           Original type.
 178     /// \param BaseTy       Base type. Ty is inherits from base.
 179     /// \param BaseOffset   Base offset.
 180     /// \param Flags        Flags to describe inheritance attribute,
 181     ///                     e.g. private
 182     DIDerivedType *createInheritance(DIType *Ty, DIType *BaseTy,
 183                                      uint64_t BaseOffset, unsigned Flags);
 184
 185     /// Create debugging information entry for a member.
 186     /// \param Scope        Member scope.
 187     /// \param Name         Member name.
 188     /// \param File         File where this member is defined.
 189     /// \param LineNo       Line number.
 190     /// \param SizeInBits   Member size.
 191     /// \param AlignInBits  Member alignment.
 192     /// \param OffsetInBits Member offset.
 193     /// \param Flags        Flags to encode member attribute, e.g. private
 194     /// \param Ty           Parent type.
 195     DIDerivedType *createMemberType(DIScope *Scope, StringRef Name,
 196                                     DIFile *File, unsigned LineNo,
 197                                     uint64_t SizeInBits, uint64_t AlignInBits,
 198                                     uint64_t OffsetInBits, unsigned Flags,
 199                                     DIType *Ty);
 200
 201     /// Create debugging information entry for a
 202     /// C++ static data member.
 203     /// \param Scope      Member scope.
 204     /// \param Name       Member name.
 205     /// \param File       File where this member is declared.
 206     /// \param LineNo     Line number.
 207     /// \param Ty         Type of the static member.
 208     /// \param Flags      Flags to encode member attribute, e.g. private.
 209     /// \param Val        Const initializer of the member.
 210     DIDerivedType *createStaticMemberType(DIScope *Scope, StringRef Name,
 211                                           DIFile *File, unsigned LineNo,
 212                                           DIType *Ty, unsigned Flags,
 213                                           llvm::Constant *Val);
 214
 215     /// Create debugging information entry for Objective-C
 216     /// instance variable.
 217     /// \param Name         Member name.
 218     /// \param File         File where this member is defined.
 219     /// \param LineNo       Line number.
 220     /// \param SizeInBits   Member size.
 221     /// \param AlignInBits  Member alignment.
 222     /// \param OffsetInBits Member offset.
 223     /// \param Flags        Flags to encode member attribute, e.g. private
 224     /// \param Ty           Parent type.
 225     /// \param PropertyNode Property associated with this ivar.
 226     DIDerivedType *createObjCIVar(StringRef Name, DIFile *File, unsigned LineNo,
 227                                   uint64_t SizeInBits, uint64_t AlignInBits,
 228                                   uint64_t OffsetInBits, unsigned Flags,
 229                                   DIType *Ty, MDNode *PropertyNode);
 230
 231     /// Create debugging information entry for Objective-C
 232     /// property.
 233     /// \param Name         Property name.
 234     /// \param File         File where this property is defined.
 235     /// \param LineNumber   Line number.
 236     /// \param GetterName   Name of the Objective C property getter selector.
 237     /// \param SetterName   Name of the Objective C property setter selector.
 238     /// \param PropertyAttributes Objective C property attributes.
 239     /// \param Ty           Type.
 240     DIObjCProperty *createObjCProperty(StringRef Name, DIFile *File,
 241                                        unsigned LineNumber,
 242                                        StringRef GetterName,
 243                                        StringRef SetterName,
 244                                        unsigned PropertyAttributes, DIType *Ty);
 245
 246     /// Create debugging information entry for a class.
 247     /// \param Scope        Scope in which this class is defined.
 248     /// \param Name         class name.
 249     /// \param File         File where this member is defined.
 250     /// \param LineNumber   Line number.
 251     /// \param SizeInBits   Member size.
 252     /// \param AlignInBits  Member alignment.
 253     /// \param OffsetInBits Member offset.
 254     /// \param Flags        Flags to encode member attribute, e.g. private
 255     /// \param Elements     class members.
 256     /// \param VTableHolder Debug info of the base class that contains vtable
 257     ///                     for this type. This is used in
 258     ///                     DW_AT_containing_type. See DWARF documentation
 259     ///                     for more info.
 260     /// \param TemplateParms Template type parameters.
 261     /// \param UniqueIdentifier A unique identifier for the class.
 262     DICompositeType *createClassType(DIScope *Scope, StringRef Name,
 263                                      DIFile *File, unsigned LineNumber,
 264                                      uint64_t SizeInBits, uint64_t AlignInBits,
 265                                      uint64_t OffsetInBits, unsigned Flags,
 266                                      DIType *DerivedFrom, DINodeArray Elements,
 267                                      DIType *VTableHolder = nullptr,
 268                                      MDNode *TemplateParms = nullptr,
 269                                      StringRef UniqueIdentifier = "");
 270
 271     /// Create debugging information entry for a struct.
 272     /// \param Scope        Scope in which this struct is defined.
 273     /// \param Name         Struct name.
 274     /// \param File         File where this member is defined.
 275     /// \param LineNumber   Line number.
 276     /// \param SizeInBits   Member size.
 277     /// \param AlignInBits  Member alignment.
 278     /// \param Flags        Flags to encode member attribute, e.g. private
 279     /// \param Elements     Struct elements.
 280     /// \param RunTimeLang  Optional parameter, Objective-C runtime version.
 281     /// \param UniqueIdentifier A unique identifier for the struct.
 282     DICompositeType *createStructType(
 283         DIScope *Scope, StringRef Name, DIFile *File, unsigned LineNumber,
 284         uint64_t SizeInBits, uint64_t AlignInBits, unsigned Flags,
 285         DIType *DerivedFrom, DINodeArray Elements, unsigned RunTimeLang = 0,
 286         DIType *VTableHolder = nullptr, StringRef UniqueIdentifier = "");
 287
 288     /// Create debugging information entry for an union.
 289     /// \param Scope        Scope in which this union is defined.
 290     /// \param Name         Union name.
 291     /// \param File         File where this member is defined.
 292     /// \param LineNumber   Line number.
 293     /// \param SizeInBits   Member size.
 294     /// \param AlignInBits  Member alignment.
 295     /// \param Flags        Flags to encode member attribute, e.g. private
 296     /// \param Elements     Union elements.
 297     /// \param RunTimeLang  Optional parameter, Objective-C runtime version.
 298     /// \param UniqueIdentifier A unique identifier for the union.
 299     DICompositeType *createUnionType(DIScope *Scope, StringRef Name,
 300                                      DIFile *File, unsigned LineNumber,
 301                                      uint64_t SizeInBits, uint64_t AlignInBits,
 302                                      unsigned Flags, DINodeArray Elements,
 303                                      unsigned RunTimeLang = 0,
 304                                      StringRef UniqueIdentifier = "");
 305
 306     /// Create debugging information for template
 307     /// type parameter.
 308     /// \param Scope        Scope in which this type is defined.
 309     /// \param Name         Type parameter name.
 310     /// \param Ty           Parameter type.
 311     DITemplateTypeParameter *
 312     createTemplateTypeParameter(DIScope *Scope, StringRef Name, DIType *Ty);
 313
 314     /// Create debugging information for template
 315     /// value parameter.
 316     /// \param Scope        Scope in which this type is defined.
 317     /// \param Name         Value parameter name.
 318     /// \param Ty           Parameter type.
 319     /// \param Val          Constant parameter value.
 320     DITemplateValueParameter *createTemplateValueParameter(DIScope *Scope,
 321                                                            StringRef Name,
 322                                                            DIType *Ty,
 323                                                            Constant *Val);
 324
 325     /// Create debugging information for a template template parameter.
 326     /// \param Scope        Scope in which this type is defined.
 327     /// \param Name         Value parameter name.
 328     /// \param Ty           Parameter type.
 329     /// \param Val          The fully qualified name of the template.
 330     DITemplateValueParameter *createTemplateTemplateParameter(DIScope *Scope,
 331                                                               StringRef Name,
 332                                                               DIType *Ty,
 333                                                               StringRef Val);
 334
 335     /// Create debugging information for a template parameter pack.
 336     /// \param Scope        Scope in which this type is defined.
 337     /// \param Name         Value parameter name.
 338     /// \param Ty           Parameter type.
 339     /// \param Val          An array of types in the pack.
 340     DITemplateValueParameter *createTemplateParameterPack(DIScope *Scope,
 341                                                           StringRef Name,
 342                                                           DIType *Ty,
 343                                                           DINodeArray Val);
 344
 345     /// Create debugging information entry for an array.
 346     /// \param Size         Array size.
 347     /// \param AlignInBits  Alignment.
 348     /// \param Ty           Element type.
 349     /// \param Subscripts   Subscripts.
 350     DICompositeType *createArrayType(uint64_t Size, uint64_t AlignInBits,
 351                                      DIType *Ty, DINodeArray Subscripts);
 352
 353     /// Create debugging information entry for a vector type.
 354     /// \param Size         Array size.
 355     /// \param AlignInBits  Alignment.
 356     /// \param Ty           Element type.
 357     /// \param Subscripts   Subscripts.
 358     DICompositeType *createVectorType(uint64_t Size, uint64_t AlignInBits,
 359                                       DIType *Ty, DINodeArray Subscripts);
 360
 361     /// Create debugging information entry for an
 362     /// enumeration.
 363     /// \param Scope          Scope in which this enumeration is defined.
 364     /// \param Name           Union name.
 365     /// \param File           File where this member is defined.
 366     /// \param LineNumber     Line number.
 367     /// \param SizeInBits     Member size.
 368     /// \param AlignInBits    Member alignment.
 369     /// \param Elements       Enumeration elements.
 370     /// \param UnderlyingType Underlying type of a C++11/ObjC fixed enum.
 371     /// \param UniqueIdentifier A unique identifier for the enum.
 372     DICompositeType *createEnumerationType(
 373         DIScope *Scope, StringRef Name, DIFile *File, unsigned LineNumber,
 374         uint64_t SizeInBits, uint64_t AlignInBits, DINodeArray Elements,
 375         DIType *UnderlyingType, StringRef UniqueIdentifier = "");
 376
 377     /// Create subroutine type.
 378     /// \param File            File in which this subroutine is defined.
 379     /// \param ParameterTypes  An array of subroutine parameter types. This
 380     ///                        includes return type at 0th index.
 381     /// \param Flags           E.g.: LValueReference.
 382     ///                        These flags are used to emit dwarf attributes.
 383     DISubroutineType *createSubroutineType(DIFile *File,
 384                                            DITypeRefArray ParameterTypes,
 385                                            unsigned Flags = 0);
 386
 387     /// Create an external type reference.
 388     /// \param Tag              Dwarf TAG.
 389     /// \param File             File in which the type is defined.
 390     /// \param UniqueIdentifier A unique identifier for the type.
 391     DICompositeType *createExternalTypeRef(unsigned Tag, DIFile *File,
 392                                            StringRef UniqueIdentifier);
 393
 394     /// Create a new DIType* with "artificial" flag set.
 395     DIType *createArtificialType(DIType *Ty);
 396
 397     /// Create a new DIType* with the "object pointer"
 398     /// flag set.
 399     DIType *createObjectPointerType(DIType *Ty);
 400
 401     /// Create a permanent forward-declared type.
 402     DICompositeType *createForwardDecl(unsigned Tag, StringRef Name,
 403                                        DIScope *Scope, DIFile *F, unsigned Line,
 404                                        unsigned RuntimeLang = 0,
 405                                        uint64_t SizeInBits = 0,
 406                                        uint64_t AlignInBits = 0,
 407                                        StringRef UniqueIdentifier = "");
 408
 409     /// Create a temporary forward-declared type.
 410     DICompositeType *createReplaceableCompositeType(
 411         unsigned Tag, StringRef Name, DIScope *Scope, DIFile *F, unsigned Line,
 412         unsigned RuntimeLang = 0, uint64_t SizeInBits = 0,
 413         uint64_t AlignInBits = 0, unsigned Flags = DINode::FlagFwdDecl,
 414         StringRef UniqueIdentifier = "");
 415
 416     /// Retain DIType* in a module even if it is not referenced
 417     /// through debug info anchors.
 418     void retainType(DIType *T);
 419
 420     /// Create unspecified parameter type
 421     /// for a subroutine type.
 422     DIBasicType *createUnspecifiedParameter();
 423
 424     /// Get a DINodeArray, create one if required.
 425     DINodeArray getOrCreateArray(ArrayRef<Metadata *> Elements);
 426
 427     /// Get a DITypeRefArray, create one if required.
 428     DITypeRefArray getOrCreateTypeArray(ArrayRef<Metadata *> Elements);
 429
 430     /// Create a descriptor for a value range.  This
 431     /// implicitly uniques the values returned.
 432     DISubrange *getOrCreateSubrange(int64_t Lo, int64_t Count);
 433
 434     /// Create a new descriptor for the specified
 435     /// variable.
 436     /// \param Context     Variable scope.
 437     /// \param Name        Name of the variable.
 438     /// \param LinkageName Mangled  name of the variable.
 439     /// \param File        File where this variable is defined.
 440     /// \param LineNo      Line number.
 441     /// \param Ty          Variable Type.
 442     /// \param isLocalToUnit Boolean flag indicate whether this variable is
 443     ///                      externally visible or not.
 444     /// \param Val         llvm::Value of the variable.
 445     /// \param Decl        Reference to the corresponding declaration.
 446     DIGlobalVariable *createGlobalVariable(DIScope *Context, StringRef Name,
 447                                            StringRef LinkageName, DIFile *File,
 448                                            unsigned LineNo, DIType *Ty,
 449                                            bool isLocalToUnit,
 450                                            llvm::Constant *Val,
 451                                            MDNode *Decl = nullptr);
 452
 453     /// Identical to createGlobalVariable
 454     /// except that the resulting DbgNode is temporary and meant to be RAUWed.
 455     DIGlobalVariable *createTempGlobalVariableFwdDecl(
 456         DIScope *Context, StringRef Name, StringRef LinkageName, DIFile *File,
 457         unsigned LineNo, DIType *Ty, bool isLocalToUnit, llvm::Constant *Val,
 458         MDNode *Decl = nullptr);
 459
 460     /// Create a new descriptor for the specified
 461     /// local variable.
 462     /// \param Tag         Dwarf TAG. Usually DW_TAG_auto_variable or
 463     ///                    DW_TAG_arg_variable.
 464     /// \param Scope       Variable scope.
 465     /// \param Name        Variable name.
 466     /// \param File        File where this variable is defined.
 467     /// \param LineNo      Line number.
 468     /// \param Ty          Variable Type
 469     /// \param AlwaysPreserve Boolean. Set to true if debug info for this
 470     ///                       variable should be preserved in optimized build.
 471     /// \param Flags       Flags, e.g. artificial variable.
 472     /// \param ArgNo       If this variable is an argument then this argument's
 473     ///                    number. 1 indicates 1st argument.
 474     DILocalVariable *createLocalVariable(unsigned Tag, DIScope *Scope,
 475                                          StringRef Name, DIFile *File,
 476                                          unsigned LineNo, DIType *Ty,
 477                                          bool AlwaysPreserve = false,
 478                                          unsigned Flags = 0,
 479                                          unsigned ArgNo = 0);
 480
 481     /// Create a new descriptor for the specified
 482     /// variable which has a complex address expression for its address.
 483     /// \param Addr        An array of complex address operations.
 484     DIExpression *createExpression(ArrayRef<uint64_t> Addr = None);
 485     DIExpression *createExpression(ArrayRef<int64_t> Addr);
 486
 487     /// Create a descriptor to describe one part
 488     /// of aggregate variable that is fragmented across multiple Values.
 489     ///
 490     /// \param OffsetInBits Offset of the piece in bits.
 491     /// \param SizeInBits   Size of the piece in bits.
 492     DIExpression *createBitPieceExpression(unsigned OffsetInBits,
 493                                            unsigned SizeInBits);
 494
 495     /// Create a new descriptor for the specified subprogram.
 496     /// See comments in DISubprogram* for descriptions of these fields.
 497     /// \param Scope         Function scope.
 498     /// \param Name          Function name.
 499     /// \param LinkageName   Mangled function name.
 500     /// \param File          File where this variable is defined.
 501     /// \param LineNo        Line number.
 502     /// \param Ty            Function type.
 503     /// \param isLocalToUnit True if this function is not externally visible.
 504     /// \param isDefinition  True if this is a function definition.
 505     /// \param ScopeLine     Set to the beginning of the scope this starts
 506     /// \param Flags         e.g. is this function prototyped or not.
 507     ///                      These flags are used to emit dwarf attributes.
 508     /// \param isOptimized   True if optimization is ON.
 509     /// \param Fn            llvm::Function pointer.
 510     /// \param TParam        Function template parameters.
 511     DISubprogram *
 512     createFunction(DIScope *Scope, StringRef Name, StringRef LinkageName,
 513                    DIFile *File, unsigned LineNo, DISubroutineType *Ty,
 514                    bool isLocalToUnit, bool isDefinition, unsigned ScopeLine,
 515                    unsigned Flags = 0, bool isOptimized = false,
 516                    Function *Fn = nullptr, MDNode *TParam = nullptr,
 517                    MDNode *Decl = nullptr);
 518
 519     /// Identical to createFunction,
 520     /// except that the resulting DbgNode is meant to be RAUWed.
 521     DISubprogram *createTempFunctionFwdDecl(
 522         DIScope *Scope, StringRef Name, StringRef LinkageName, DIFile *File,
 523         unsigned LineNo, DISubroutineType *Ty, bool isLocalToUnit,
 524         bool isDefinition, unsigned ScopeLine, unsigned Flags = 0,
 525         bool isOptimized = false, Function *Fn = nullptr,
 526         MDNode *TParam = nullptr, MDNode *Decl = nullptr);
 527
 528     /// FIXME: this is added for dragonegg. Once we update dragonegg
 529     /// to call resolve function, this will be removed.
 530     DISubprogram *
 531     createFunction(DIScopeRef Scope, StringRef Name, StringRef LinkageName,
 532                    DIFile *File, unsigned LineNo, DISubroutineType *Ty,
 533                    bool isLocalToUnit, bool isDefinition, unsigned ScopeLine,
 534                    unsigned Flags = 0, bool isOptimized = false,
 535                    Function *Fn = nullptr, MDNode *TParam = nullptr,
 536                    MDNode *Decl = nullptr);
 537
 538     /// Create a new descriptor for the specified C++ method.
 539     /// See comments in \a DISubprogram* for descriptions of these fields.
 540     /// \param Scope         Function scope.
 541     /// \param Name          Function name.
 542     /// \param LinkageName   Mangled function name.
 543     /// \param File          File where this variable is defined.
 544     /// \param LineNo        Line number.
 545     /// \param Ty            Function type.
 546     /// \param isLocalToUnit True if this function is not externally visible..
 547     /// \param isDefinition  True if this is a function definition.
 548     /// \param Virtuality    Attributes describing virtualness. e.g. pure
 549     ///                      virtual function.
 550     /// \param VTableIndex   Index no of this method in virtual table.
 551     /// \param VTableHolder  Type that holds vtable.
 552     /// \param Flags         e.g. is this function prototyped or not.
 553     ///                      This flags are used to emit dwarf attributes.
 554     /// \param isOptimized   True if optimization is ON.
 555     /// \param Fn            llvm::Function pointer.
 556     /// \param TParam        Function template parameters.
 557     DISubprogram *
 558     createMethod(DIScope *Scope, StringRef Name, StringRef LinkageName,
 559                  DIFile *File, unsigned LineNo, DISubroutineType *Ty,
 560                  bool isLocalToUnit, bool isDefinition, unsigned Virtuality = 0,
 561                  unsigned VTableIndex = 0, DIType *VTableHolder = nullptr,
 562                  unsigned Flags = 0, bool isOptimized = false,
 563                  Function *Fn = nullptr, MDNode *TParam = nullptr);
 564
 565     /// This creates new descriptor for a namespace with the specified
 566     /// parent scope.
 567     /// \param Scope       Namespace scope
 568     /// \param Name        Name of this namespace
 569     /// \param File        Source file
 570     /// \param LineNo      Line number
 571     DINamespace *createNameSpace(DIScope *Scope, StringRef Name, DIFile *File,
 572                                  unsigned LineNo);
 573
 574     /// This creates new descriptor for a module with the specified
 575     /// parent scope.
 576     /// \param Scope       Parent scope
 577     /// \param Name        Name of this module
 578     /// \param ConfigurationMacros
 579     ///                    A space-separated shell-quoted list of -D macro
 580     ///                    definitions as they would appear on a command line.
 581     /// \param IncludePath The path to the module map file.
 582     /// \param ISysRoot    The clang system root (value of -isysroot).
 583     DIModule *createModule(DIScope *Scope, StringRef Name,
 584                            StringRef ConfigurationMacros,
 585                            StringRef IncludePath,
 586                            StringRef ISysRoot);
 587
 588     /// This creates a descriptor for a lexical block with a new file
 589     /// attached. This merely extends the existing
 590     /// lexical block as it crosses a file.
 591     /// \param Scope       Lexical block.
 592     /// \param File        Source file.
 593     /// \param Discriminator DWARF path discriminator value.
 594     DILexicalBlockFile *createLexicalBlockFile(DIScope *Scope, DIFile *File,
 595                                                unsigned Discriminator = 0);
 596
 597     /// This creates a descriptor for a lexical block with the
 598     /// specified parent context.
 599     /// \param Scope         Parent lexical scope.
 600     /// \param File          Source file.
 601     /// \param Line          Line number.
 602     /// \param Col           Column number.
 603     DILexicalBlock *createLexicalBlock(DIScope *Scope, DIFile *File,
 604                                        unsigned Line, unsigned Col);
 605
 606     /// Create a descriptor for an imported module.
 607     /// \param Context The scope this module is imported into
 608     /// \param NS The namespace being imported here
 609     /// \param Line Line number
 610     DIImportedEntity *createImportedModule(DIScope *Context, DINamespace *NS,
 611                                            unsigned Line);
 612
 613     /// Create a descriptor for an imported module.
 614     /// \param Context The scope this module is imported into
 615     /// \param NS An aliased namespace
 616     /// \param Line Line number
 617     DIImportedEntity *createImportedModule(DIScope *Context,
 618                                            DIImportedEntity *NS, unsigned Line);
 619
 620     /// Create a descriptor for an imported module.
 621     /// \param Context The scope this module is imported into
 622     /// \param M The module being imported here
 623     /// \param Line Line number
 624     DIImportedEntity *createImportedModule(DIScope *Context, DIModule *M,
 625                                            unsigned Line);
 626
 627     /// Create a descriptor for an imported function.
 628     /// \param Context The scope this module is imported into
 629     /// \param Decl The declaration (or definition) of a function, type, or
 630     ///             variable
 631     /// \param Line Line number
 632     DIImportedEntity *createImportedDeclaration(DIScope *Context, DINode *Decl,
 633                                                 unsigned Line,
 634                                                 StringRef Name = "");
 635
 636     /// Insert a new llvm.dbg.declare intrinsic call.
 637     /// \param Storage     llvm::Value of the variable
 638     /// \param VarInfo     Variable's debug info descriptor.
 639     /// \param Expr        A complex location expression.
 640     /// \param DL          Debug info location.
 641     /// \param InsertAtEnd Location for the new intrinsic.
 642     Instruction *insertDeclare(llvm::Value *Storage, DILocalVariable *VarInfo,
 643                                DIExpression *Expr, const DILocation *DL,
 644                                BasicBlock *InsertAtEnd);
 645
 646     /// Insert a new llvm.dbg.declare intrinsic call.
 647     /// \param Storage      llvm::Value of the variable
 648     /// \param VarInfo      Variable's debug info descriptor.
 649     /// \param Expr         A complex location expression.
 650     /// \param DL           Debug info location.
 651     /// \param InsertBefore Location for the new intrinsic.
 652     Instruction *insertDeclare(llvm::Value *Storage, DILocalVariable *VarInfo,
 653                                DIExpression *Expr, const DILocation *DL,
 654                                Instruction *InsertBefore);
 655
 656     /// Insert a new llvm.dbg.value intrinsic call.
 657     /// \param Val          llvm::Value of the variable
 658     /// \param Offset       Offset
 659     /// \param VarInfo      Variable's debug info descriptor.
 660     /// \param Expr         A complex location expression.
 661     /// \param DL           Debug info location.
 662     /// \param InsertAtEnd Location for the new intrinsic.
 663     Instruction *insertDbgValueIntrinsic(llvm::Value *Val, uint64_t Offset,
 664                                          DILocalVariable *VarInfo,
 665                                          DIExpression *Expr,
 666                                          const DILocation *DL,
 667                                          BasicBlock *InsertAtEnd);
 668
 669     /// Insert a new llvm.dbg.value intrinsic call.
 670     /// \param Val          llvm::Value of the variable
 671     /// \param Offset       Offset
 672     /// \param VarInfo      Variable's debug info descriptor.
 673     /// \param Expr         A complex location expression.
 674     /// \param DL           Debug info location.
 675     /// \param InsertBefore Location for the new intrinsic.
 676     Instruction *insertDbgValueIntrinsic(llvm::Value *Val, uint64_t Offset,
 677                                          DILocalVariable *VarInfo,
 678                                          DIExpression *Expr,
 679                                          const DILocation *DL,
 680                                          Instruction *InsertBefore);
 681
 682     /// Replace the vtable holder in the given composite type.
 683     ///
 684     /// If this creates a self reference, it may orphan some unresolved cycles
 685     /// in the operands of \c T, so \a DIBuilder needs to track that.
 686     void replaceVTableHolder(DICompositeType *&T,
 687                              DICompositeType *VTableHolder);
 688
 689     /// Replace arrays on a composite type.
 690     ///
 691     /// If \c T is resolved, but the arrays aren't -- which can happen if \c T
 692     /// has a self-reference -- \a DIBuilder needs to track the array to
 693     /// resolve cycles.
 694     void replaceArrays(DICompositeType *&T, DINodeArray Elements,
 695                        DINodeArray TParems = DINodeArray());
 696
 697     /// Replace a temporary node.
 698     ///
 699     /// Call \a MDNode::replaceAllUsesWith() on \c N, replacing it with \c
 700     /// Replacement.
 701     ///
 702     /// If \c Replacement is the same as \c N.get(), instead call \a
 703     /// MDNode::replaceWithUniqued().  In this case, the uniqued node could
 704     /// have a different address, so we return the final address.
 705     template <class NodeTy>
 706     NodeTy *replaceTemporary(TempMDNode &&N, NodeTy *Replacement) {
 707       if (N.get() == Replacement)
 708         return cast<NodeTy>(MDNode::replaceWithUniqued(std::move(N)));
 709
 710       N->replaceAllUsesWith(Replacement);
 711       return Replacement;
 712     }
 713   };
 714 } // end namespace llvm
 715
 716 #endif