lib/Analysis/DIBuilder.cpp

   1 //===--- DIBuilder.cpp - Debug Information Builder ------------------------===//
   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 implements the DIBuilder.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Analysis/DIBuilder.h"
  15 #include "llvm/Analysis/DebugInfo.h"
  16 #include "llvm/Constants.h"
  17 #include "llvm/IntrinsicInst.h"
  18 #include "llvm/Module.h"
  19 #include "llvm/ADT/STLExtras.h"
  20 #include "llvm/Support/Dwarf.h"
  21
  22 using namespace llvm;
  23 using namespace llvm::dwarf;
  24
  25 static Constant *GetTagConstant(LLVMContext &VMContext, unsigned Tag) {
  26   assert((Tag & LLVMDebugVersionMask) == 0 &&
  27          "Tag too large for debug encoding!");
  28   return ConstantInt::get(Type::getInt32Ty(VMContext), Tag | LLVMDebugVersion);
  29 }
  30
  31 DIBuilder::DIBuilder(Module &m)
  32   : M(m), VMContext(M.getContext()), TheCU(0), DeclareFn(0), ValueFn(0) {}
  33
  34 /// CreateCompileUnit - A CompileUnit provides an anchor for all debugging
  35 /// information generated during this instance of compilation.
  36 void DIBuilder::CreateCompileUnit(unsigned Lang, StringRef Filename,
  37                                   StringRef Directory, StringRef Producer,
  38                                   bool isOptimized, StringRef Flags,
  39                                   unsigned RunTimeVer) {
  40   Value *Elts[] = {
  41     GetTagConstant(VMContext, dwarf::DW_TAG_compile_unit),
  42     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
  43     ConstantInt::get(Type::getInt32Ty(VMContext), Lang),
  44     MDString::get(VMContext, Filename),
  45     MDString::get(VMContext, Directory),
  46     MDString::get(VMContext, Producer),
  47     // Deprecate isMain field.
  48     ConstantInt::get(Type::getInt1Ty(VMContext), true), // isMain
  49     ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
  50     MDString::get(VMContext, Flags),
  51     ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeVer)
  52   };
  53   TheCU = DICompileUnit(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
  54 }
  55
  56 /// CreateFile - Create a file descriptor to hold debugging information
  57 /// for a file.
  58 DIFile DIBuilder::CreateFile(StringRef Filename, StringRef Directory) {
  59   assert(TheCU && "Unable to create DW_TAG_file_type without CompileUnit");
  60   Value *Elts[] = {
  61     GetTagConstant(VMContext, dwarf::DW_TAG_file_type),
  62     MDString::get(VMContext, Filename),
  63     MDString::get(VMContext, Directory),
  64     TheCU
  65   };
  66   return DIFile(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
  67 }
  68
  69 /// CreateEnumerator - Create a single enumerator value.
  70 DIEnumerator DIBuilder::CreateEnumerator(StringRef Name, uint64_t Val) {
  71   Value *Elts[] = {
  72     GetTagConstant(VMContext, dwarf::DW_TAG_enumerator),
  73     MDString::get(VMContext, Name),
  74     ConstantInt::get(Type::getInt64Ty(VMContext), Val)
  75   };
  76   return DIEnumerator(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
  77 }
  78
  79 /// CreateBasicType - Create debugging information entry for a basic
  80 /// type, e.g 'char'.
  81 DIType DIBuilder::CreateBasicType(StringRef Name, uint64_t SizeInBits,
  82                                   uint64_t AlignInBits,
  83                                   unsigned Encoding) {
  84   // Basic types are encoded in DIBasicType format. Line number, filename,
  85   // offset and flags are always empty here.
  86   Value *Elts[] = {
  87     GetTagConstant(VMContext, dwarf::DW_TAG_base_type),
  88     TheCU,
  89     MDString::get(VMContext, Name),
  90     NULL, // Filename
  91     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
  92     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
  93     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
  94     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
  95     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags;
  96     ConstantInt::get(Type::getInt32Ty(VMContext), Encoding)
  97   };
  98   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
  99 }
 100
 101 /// CreateQaulifiedType - Create debugging information entry for a qualified
 102 /// type, e.g. 'const int'.
 103 DIType DIBuilder::CreateQualifiedType(unsigned Tag, DIType FromTy) {
 104   // Qualified types are encoded in DIDerivedType format.
 105   Value *Elts[] = {
 106     GetTagConstant(VMContext, Tag),
 107     TheCU,
 108     MDString::get(VMContext, StringRef()), // Empty name.
 109     NULL, // Filename
 110     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
 111     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
 112     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
 113     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
 114     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
 115     FromTy
 116   };
 117   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 118 }
 119
 120 /// CreatePointerType - Create debugging information entry for a pointer.
 121 DIType DIBuilder::CreatePointerType(DIType PointeeTy, uint64_t SizeInBits,
 122                                     uint64_t AlignInBits, StringRef Name) {
 123   // Pointer types are encoded in DIDerivedType format.
 124   Value *Elts[] = {
 125     GetTagConstant(VMContext, dwarf::DW_TAG_pointer_type),
 126     TheCU,
 127     MDString::get(VMContext, Name),
 128     NULL, // Filename
 129     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
 130     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 131     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 132     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
 133     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
 134     PointeeTy
 135   };
 136   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 137 }
 138
 139 /// CreateReferenceType - Create debugging information entry for a reference.
 140 DIType DIBuilder::CreateReferenceType(DIType RTy) {
 141   // References are encoded in DIDerivedType format.
 142   Value *Elts[] = {
 143     GetTagConstant(VMContext, dwarf::DW_TAG_reference_type),
 144     TheCU,
 145     NULL, // Name
 146     NULL, // Filename
 147     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
 148     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
 149     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
 150     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
 151     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
 152     RTy
 153   };
 154   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 155 }
 156
 157 /// CreateTypedef - Create debugging information entry for a typedef.
 158 DIType DIBuilder::CreateTypedef(DIType Ty, StringRef Name, DIFile File,
 159                                 unsigned LineNo) {
 160   // typedefs are encoded in DIDerivedType format.
 161   assert(Ty.Verify() && "Invalid typedef type!");
 162   Value *Elts[] = {
 163     GetTagConstant(VMContext, dwarf::DW_TAG_typedef),
 164     Ty.getContext(),
 165     MDString::get(VMContext, Name),
 166     File,
 167     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 168     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
 169     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
 170     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
 171     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
 172     Ty
 173   };
 174   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 175 }
 176
 177 /// CreateFriend - Create debugging information entry for a 'friend'.
 178 DIType DIBuilder::CreateFriend(DIType Ty, DIType FriendTy) {
 179   // typedefs are encoded in DIDerivedType format.
 180   assert(Ty.Verify() && "Invalid type!");
 181   assert(FriendTy.Verify() && "Invalid friend type!");
 182   Value *Elts[] = {
 183     GetTagConstant(VMContext, dwarf::DW_TAG_friend),
 184     Ty,
 185     NULL, // Name
 186     Ty.getFile(),
 187     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
 188     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
 189     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
 190     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Offset
 191     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Flags
 192     FriendTy
 193   };
 194   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 195 }
 196
 197 /// CreateInheritance - Create debugging information entry to establish
 198 /// inheritnace relationship between two types.
 199 DIType DIBuilder::CreateInheritance(DIType Ty, DIType BaseTy,
 200                                     uint64_t BaseOffset, unsigned Flags) {
 201   // TAG_inheritance is encoded in DIDerivedType format.
 202   Value *Elts[] = {
 203     GetTagConstant(VMContext, dwarf::DW_TAG_inheritance),
 204     Ty,
 205     NULL, // Name
 206     Ty.getFile(),
 207     ConstantInt::get(Type::getInt32Ty(VMContext), 0), // Line
 208     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Size
 209     ConstantInt::get(Type::getInt64Ty(VMContext), 0), // Align
 210     ConstantInt::get(Type::getInt64Ty(VMContext), BaseOffset),
 211     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 212     BaseTy
 213   };
 214   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 215 }
 216
 217 /// CreateMemberType - Create debugging information entry for a member.
 218 DIType DIBuilder::CreateMemberType(StringRef Name,
 219                                    DIFile File, unsigned LineNumber,
 220                                    uint64_t SizeInBits, uint64_t AlignInBits,
 221                                    uint64_t OffsetInBits, unsigned Flags,
 222                                    DIType Ty) {
 223   // TAG_member is encoded in DIDerivedType format.
 224   Value *Elts[] = {
 225     GetTagConstant(VMContext, dwarf::DW_TAG_member),
 226     File, // Or TheCU ? Ty ?
 227     MDString::get(VMContext, Name),
 228     File,
 229     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 230     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 231     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 232     ConstantInt::get(Type::getInt64Ty(VMContext), OffsetInBits),
 233     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 234     Ty
 235   };
 236   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 237 }
 238
 239 /// CreateClassType - Create debugging information entry for a class.
 240 DIType DIBuilder::CreateClassType(DIDescriptor Context, StringRef Name,
 241                                   DIFile File, unsigned LineNumber,
 242                                   uint64_t SizeInBits, uint64_t AlignInBits,
 243                                   uint64_t OffsetInBits, unsigned Flags,
 244                                   DIType DerivedFrom, DIArray Elements,
 245                                   MDNode *VTableHoder, MDNode *TemplateParams) {
 246  // TAG_class_type is encoded in DICompositeType format.
 247   Value *Elts[] = {
 248     GetTagConstant(VMContext, dwarf::DW_TAG_class_type),
 249     Context,
 250     MDString::get(VMContext, Name),
 251     File,
 252     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 253     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 254     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 255     ConstantInt::get(Type::getInt32Ty(VMContext), OffsetInBits),
 256     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 257     DerivedFrom,
 258     Elements,
 259     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 260     VTableHoder,
 261     TemplateParams
 262   };
 263   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 264 }
 265
 266 /// CreateTemplateTypeParameter - Create debugging information for template
 267 /// type parameter.
 268 DITemplateTypeParameter
 269 DIBuilder::CreateTemplateTypeParameter(DIDescriptor Context, StringRef Name,
 270                                        DIType Ty, MDNode *File, unsigned LineNo,
 271                                        unsigned ColumnNo) {
 272   Value *Elts[] = {
 273     GetTagConstant(VMContext, dwarf::DW_TAG_template_type_parameter),
 274     Context,
 275     MDString::get(VMContext, Name),
 276     Ty,
 277     File,
 278     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 279     ConstantInt::get(Type::getInt32Ty(VMContext), ColumnNo)
 280   };
 281   return DITemplateTypeParameter(MDNode::get(VMContext, &Elts[0],
 282                                              array_lengthof(Elts)));
 283 }
 284
 285 /// CreateStructType - Create debugging information entry for a struct.
 286 DIType DIBuilder::CreateStructType(DIDescriptor Context, StringRef Name,
 287                                    DIFile File, unsigned LineNumber,
 288                                    uint64_t SizeInBits, uint64_t AlignInBits,
 289                                    unsigned Flags, DIArray Elements,
 290                                    unsigned RunTimeLang) {
 291  // TAG_structure_type is encoded in DICompositeType format.
 292   Value *Elts[] = {
 293     GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
 294     Context,
 295     MDString::get(VMContext, Name),
 296     File,
 297     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 298     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 299     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 300     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 301     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 302     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 303     Elements,
 304     ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
 305     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 306   };
 307   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 308 }
 309
 310 /// CreateUnionType - Create debugging information entry for an union.
 311 DIType DIBuilder::CreateUnionType(DIDescriptor Scope, StringRef Name,
 312                                   DIFile File,
 313                                   unsigned LineNumber, uint64_t SizeInBits,
 314                                   uint64_t AlignInBits, unsigned Flags,
 315                                   DIArray Elements, unsigned RunTimeLang) {
 316   // TAG_union_type is encoded in DICompositeType format.
 317   Value *Elts[] = {
 318     GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
 319     Scope,
 320     MDString::get(VMContext, Name),
 321     File,
 322     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 323     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 324     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 325     ConstantInt::get(Type::getInt64Ty(VMContext), 0),
 326     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 327     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 328     Elements,
 329     ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
 330     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 331   };
 332   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 333 }
 334
 335 /// CreateSubroutineType - Create subroutine type.
 336 DIType DIBuilder::CreateSubroutineType(DIFile File, DIArray ParameterTypes) {
 337   // TAG_subroutine_type is encoded in DICompositeType format.
 338   Value *Elts[] = {
 339     GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
 340     File,
 341     MDString::get(VMContext, ""),
 342     File,
 343     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 344     ConstantInt::get(Type::getInt64Ty(VMContext), 0),
 345     ConstantInt::get(Type::getInt64Ty(VMContext), 0),
 346     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 347     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 348     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 349     ParameterTypes,
 350     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 351     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 352   };
 353   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 354 }
 355
 356 /// CreateEnumerationType - Create debugging information entry for an
 357 /// enumeration.
 358 DIType DIBuilder::CreateEnumerationType(DIDescriptor Scope, StringRef Name,
 359                                         DIFile File, unsigned LineNumber,
 360                                         uint64_t SizeInBits,
 361                                         uint64_t AlignInBits, DIArray Elements) {
 362   // TAG_enumeration_type is encoded in DICompositeType format.
 363   Value *Elts[] = {
 364     GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
 365     Scope,
 366     MDString::get(VMContext, Name),
 367     File,
 368     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 369     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 370     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 371     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 372     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 373     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 374     Elements,
 375     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 376     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 377   };
 378   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 379   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.enum");
 380   NMD->addOperand(Node);
 381   return DIType(Node);
 382 }
 383
 384 /// CreateArrayType - Create debugging information entry for an array.
 385 DIType DIBuilder::CreateArrayType(uint64_t Size, uint64_t AlignInBits,
 386                                   DIType Ty, DIArray Subscripts) {
 387   // TAG_array_type is encoded in DICompositeType format.
 388   Value *Elts[] = {
 389     GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
 390     TheCU,
 391     MDString::get(VMContext, ""),
 392     TheCU,
 393     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 394     ConstantInt::get(Type::getInt64Ty(VMContext), Size),
 395     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 396     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 397     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 398     Ty,
 399     Subscripts,
 400     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 401     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 402   };
 403   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 404 }
 405
 406 /// CreateVectorType - Create debugging information entry for a vector.
 407 DIType DIBuilder::CreateVectorType(uint64_t Size, uint64_t AlignInBits,
 408                                    DIType Ty, DIArray Subscripts) {
 409   // TAG_vector_type is encoded in DICompositeType format.
 410   Value *Elts[] = {
 411     GetTagConstant(VMContext, dwarf::DW_TAG_vector_type),
 412     TheCU,
 413     MDString::get(VMContext, ""),
 414     TheCU,
 415     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 416     ConstantInt::get(Type::getInt64Ty(VMContext), Size),
 417     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 418     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 419     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 420     Ty,
 421     Subscripts,
 422     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 423     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 424   };
 425   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 426 }
 427
 428 /// CreateArtificialType - Create a new DIType with "artificial" flag set.
 429 DIType DIBuilder::CreateArtificialType(DIType Ty) {
 430   if (Ty.isArtificial())
 431     return Ty;
 432
 433   SmallVector<Value *, 9> Elts;
 434   MDNode *N = Ty;
 435   assert (N && "Unexpected input DIType!");
 436   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 437     if (Value *V = N->getOperand(i))
 438       Elts.push_back(V);
 439     else
 440       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
 441   }
 442
 443   unsigned CurFlags = Ty.getFlags();
 444   CurFlags = CurFlags | DIType::FlagArtificial;
 445
 446   // Flags are stored at this slot.
 447   Elts[8] =  ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
 448
 449   return DIType(MDNode::get(VMContext, Elts.data(), Elts.size()));
 450 }
 451
 452 /// RetainType - Retain DIType in a module even if it is not referenced
 453 /// through debug info anchors.
 454 void DIBuilder::RetainType(DIType T) {
 455   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.ty");
 456   NMD->addOperand(T);
 457 }
 458
 459 /// CreateUnspecifiedParameter - Create unspeicified type descriptor
 460 /// for the subroutine type.
 461 DIDescriptor DIBuilder::CreateUnspecifiedParameter() {
 462   Value *Elts[] = {
 463     GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
 464   };
 465   return DIDescriptor(MDNode::get(VMContext, &Elts[0], 1));
 466 }
 467
 468 /// CreateTemporaryType - Create a temporary forward-declared type.
 469 DIType DIBuilder::CreateTemporaryType() {
 470   // Give the temporary MDNode a tag. It doesn't matter what tag we
 471   // use here as long as DIType accepts it.
 472   Value *Elts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
 473   MDNode *Node = MDNode::getTemporary(VMContext, Elts, array_lengthof(Elts));
 474   return DIType(Node);
 475 }
 476
 477 /// CreateTemporaryType - Create a temporary forward-declared type.
 478 DIType DIBuilder::CreateTemporaryType(DIFile F) {
 479   // Give the temporary MDNode a tag. It doesn't matter what tag we
 480   // use here as long as DIType accepts it.
 481   Value *Elts[] = {
 482     GetTagConstant(VMContext, DW_TAG_base_type),
 483     F.getCompileUnit(),
 484     NULL,
 485     F
 486   };
 487   MDNode *Node = MDNode::getTemporary(VMContext, Elts, array_lengthof(Elts));
 488   return DIType(Node);
 489 }
 490
 491 /// GetOrCreateArray - Get a DIArray, create one if required.
 492 DIArray DIBuilder::GetOrCreateArray(Value *const *Elements, unsigned NumElements) {
 493   if (NumElements == 0) {
 494     Value *Null = llvm::Constant::getNullValue(Type::getInt32Ty(VMContext));
 495     return DIArray(MDNode::get(VMContext, &Null, 1));
 496   }
 497   return DIArray(MDNode::get(VMContext, Elements, NumElements));
 498 }
 499
 500 /// GetOrCreateSubrange - Create a descriptor for a value range.  This
 501 /// implicitly uniques the values returned.
 502 DISubrange DIBuilder::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
 503   Value *Elts[] = {
 504     GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
 505     ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
 506     ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
 507   };
 508
 509   return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
 510 }
 511
 512 /// CreateGlobalVariable - Create a new descriptor for the specified global.
 513 DIGlobalVariable DIBuilder::
 514 CreateGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
 515                      DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
 516   Value *Elts[] = {
 517     GetTagConstant(VMContext, dwarf::DW_TAG_variable),
 518     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 519     TheCU,
 520     MDString::get(VMContext, Name),
 521     MDString::get(VMContext, Name),
 522     MDString::get(VMContext, Name),
 523     F,
 524     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 525     Ty,
 526     ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
 527     ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
 528     Val
 529   };
 530   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 531   // Create a named metadata so that we do not lose this mdnode.
 532   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
 533   NMD->addOperand(Node);
 534   return DIGlobalVariable(Node);
 535 }
 536
 537 /// CreateStaticVariable - Create a new descriptor for the specified static
 538 /// variable.
 539 DIGlobalVariable DIBuilder::
 540 CreateStaticVariable(DIDescriptor Context, StringRef Name,
 541                      StringRef LinkageName, DIFile F, unsigned LineNumber,
 542                      DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
 543   Value *Elts[] = {
 544     GetTagConstant(VMContext, dwarf::DW_TAG_variable),
 545     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 546     Context,
 547     MDString::get(VMContext, Name),
 548     MDString::get(VMContext, Name),
 549     MDString::get(VMContext, LinkageName),
 550     F,
 551     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 552     Ty,
 553     ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
 554     ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
 555     Val
 556   };
 557   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 558   // Create a named metadata so that we do not lose this mdnode.
 559   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
 560   NMD->addOperand(Node);
 561   return DIGlobalVariable(Node);
 562 }
 563
 564 /// CreateVariable - Create a new descriptor for the specified variable.
 565 DIVariable DIBuilder::CreateLocalVariable(unsigned Tag, DIDescriptor Scope,
 566                                           StringRef Name, DIFile File,
 567                                           unsigned LineNo, DIType Ty,
 568                                           bool AlwaysPreserve, unsigned Flags) {
 569   Value *Elts[] = {
 570     GetTagConstant(VMContext, Tag),
 571     Scope,
 572     MDString::get(VMContext, Name),
 573     File,
 574     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 575     Ty,
 576     ConstantInt::get(Type::getInt32Ty(VMContext), Flags)
 577   };
 578   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 579   if (AlwaysPreserve) {
 580     // The optimizer may remove local variable. If there is an interest
 581     // to preserve variable info in such situation then stash it in a
 582     // named mdnode.
 583     DISubprogram Fn(getDISubprogram(Scope));
 584     StringRef FName = "fn";
 585     if (Fn.getFunction())
 586       FName = Fn.getFunction()->getName();
 587     char One = '\1';
 588     if (FName.startswith(StringRef(&One, 1)))
 589       FName = FName.substr(1);
 590     NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, FName);
 591     FnLocals->addOperand(Node);
 592   }
 593   return DIVariable(Node);
 594 }
 595
 596 /// CreateComplexVariable - Create a new descriptor for the specified variable
 597 /// which has a complex address expression for its address.
 598 DIVariable DIBuilder::CreateComplexVariable(unsigned Tag, DIDescriptor Scope,
 599                                             StringRef Name, DIFile F,
 600                                             unsigned LineNo,
 601                                             DIType Ty, Value *const *Addr,
 602                                             unsigned NumAddr) {
 603   SmallVector<Value *, 15> Elts;
 604   Elts.push_back(GetTagConstant(VMContext, Tag));
 605   Elts.push_back(Scope);
 606   Elts.push_back(MDString::get(VMContext, Name));
 607   Elts.push_back(F);
 608   Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), LineNo));
 609   Elts.push_back(Ty);
 610   Elts.append(Addr, Addr+NumAddr);
 611
 612   return DIVariable(MDNode::get(VMContext, Elts.data(), Elts.size()));
 613 }
 614
 615 /// CreateFunction - Create a new descriptor for the specified function.
 616 DISubprogram DIBuilder::CreateFunction(DIDescriptor Context,
 617                                        StringRef Name,
 618                                        StringRef LinkageName,
 619                                        DIFile File, unsigned LineNo,
 620                                        DIType Ty,
 621                                        bool isLocalToUnit, bool isDefinition,
 622                                        unsigned Flags, bool isOptimized,
 623                                        Function *Fn) {
 624
 625   Value *Elts[] = {
 626     GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
 627     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 628     Context,
 629     MDString::get(VMContext, Name),
 630     MDString::get(VMContext, Name),
 631     MDString::get(VMContext, LinkageName),
 632     File,
 633     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 634     Ty,
 635     ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
 636     ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
 637     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 638     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 639     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 640     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 641     ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
 642     Fn
 643   };
 644   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 645
 646   // Create a named metadata so that we do not lose this mdnode.
 647   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
 648   NMD->addOperand(Node);
 649   return DISubprogram(Node);
 650 }
 651
 652 /// CreateMethod - Create a new descriptor for the specified C++ method.
 653 DISubprogram DIBuilder::CreateMethod(DIDescriptor Context,
 654                                      StringRef Name,
 655                                      StringRef LinkageName,
 656                                      DIFile F,
 657                                      unsigned LineNo, DIType Ty,
 658                                      bool isLocalToUnit,
 659                                      bool isDefinition,
 660                                      unsigned VK, unsigned VIndex,
 661                                      MDNode *VTableHolder,
 662                                      unsigned Flags,
 663                                      bool isOptimized,
 664                                      Function *Fn) {
 665   Value *Elts[] = {
 666     GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
 667     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 668     Context,
 669     MDString::get(VMContext, Name),
 670     MDString::get(VMContext, Name),
 671     MDString::get(VMContext, LinkageName),
 672     F,
 673     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 674     Ty,
 675     ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
 676     ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
 677     ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
 678     ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
 679     VTableHolder,
 680     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 681     ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
 682     Fn
 683   };
 684   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 685
 686   // Create a named metadata so that we do not lose this mdnode.
 687   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
 688   NMD->addOperand(Node);
 689   return DISubprogram(Node);
 690 }
 691
 692 /// CreateNameSpace - This creates new descriptor for a namespace
 693 /// with the specified parent scope.
 694 DINameSpace DIBuilder::CreateNameSpace(DIDescriptor Scope, StringRef Name,
 695                                        DIFile File, unsigned LineNo) {
 696   Value *Elts[] = {
 697     GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
 698     Scope,
 699     MDString::get(VMContext, Name),
 700     File,
 701     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
 702   };
 703   return DINameSpace(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 704 }
 705
 706 DILexicalBlock DIBuilder::CreateLexicalBlock(DIDescriptor Scope, DIFile File,
 707                                              unsigned Line, unsigned Col) {
 708   // Defeat MDNode uniqing for lexical blocks by using unique id.
 709   static unsigned int unique_id = 0;
 710   Value *Elts[] = {
 711     GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
 712     Scope,
 713     ConstantInt::get(Type::getInt32Ty(VMContext), Line),
 714     ConstantInt::get(Type::getInt32Ty(VMContext), Col),
 715     File,
 716     ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
 717   };
 718   return DILexicalBlock(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 719 }
 720
 721 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
 722 Instruction *DIBuilder::InsertDeclare(Value *Storage, DIVariable VarInfo,
 723                                       Instruction *InsertBefore) {
 724   assert(Storage && "no storage passed to dbg.declare");
 725   assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
 726   if (!DeclareFn)
 727     DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
 728
 729   Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1), VarInfo };
 730   return CallInst::Create(DeclareFn, Args, Args+2, "", InsertBefore);
 731 }
 732
 733 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
 734 Instruction *DIBuilder::InsertDeclare(Value *Storage, DIVariable VarInfo,
 735                                       BasicBlock *InsertAtEnd) {
 736   assert(Storage && "no storage passed to dbg.declare");
 737   assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
 738   if (!DeclareFn)
 739     DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
 740
 741   Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1), VarInfo };
 742
 743   // If this block already has a terminator then insert this intrinsic
 744   // before the terminator.
 745   if (TerminatorInst *T = InsertAtEnd->getTerminator())
 746     return CallInst::Create(DeclareFn, Args, Args+2, "", T);
 747   else
 748     return CallInst::Create(DeclareFn, Args, Args+2, "", InsertAtEnd);
 749 }
 750
 751 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
 752 Instruction *DIBuilder::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
 753                                                 DIVariable VarInfo,
 754                                                 Instruction *InsertBefore) {
 755   assert(V && "no value passed to dbg.value");
 756   assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
 757   if (!ValueFn)
 758     ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
 759
 760   Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
 761                     ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
 762                     VarInfo };
 763   return CallInst::Create(ValueFn, Args, Args+3, "", InsertBefore);
 764 }
 765
 766 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
 767 Instruction *DIBuilder::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
 768                                                 DIVariable VarInfo,
 769                                                 BasicBlock *InsertAtEnd) {
 770   assert(V && "no value passed to dbg.value");
 771   assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
 772   if (!ValueFn)
 773     ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
 774
 775   Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
 776                     ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
 777                     VarInfo };
 778   return CallInst::Create(ValueFn, Args, Args+3, "", InsertAtEnd);
 779 }
 780