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) {
 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   };
 262   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 263 }
 264
 265 /// CreateStructType - Create debugging information entry for a struct.
 266 DIType DIBuilder::CreateStructType(DIDescriptor Context, StringRef Name,
 267                                    DIFile File, unsigned LineNumber,
 268                                    uint64_t SizeInBits, uint64_t AlignInBits,
 269                                    unsigned Flags, DIArray Elements,
 270                                    unsigned RunTimeLang) {
 271  // TAG_structure_type is encoded in DICompositeType format.
 272   Value *Elts[] = {
 273     GetTagConstant(VMContext, dwarf::DW_TAG_structure_type),
 274     Context,
 275     MDString::get(VMContext, Name),
 276     File,
 277     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 278     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 279     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 280     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 281     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 282     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 283     Elements,
 284     ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
 285     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 286   };
 287   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 288 }
 289
 290 /// CreateUnionType - Create debugging information entry for an union.
 291 DIType DIBuilder::CreateUnionType(DIDescriptor Scope, StringRef Name,
 292                                   DIFile File,
 293                                   unsigned LineNumber, uint64_t SizeInBits,
 294                                   uint64_t AlignInBits, unsigned Flags,
 295                                   DIArray Elements, unsigned RunTimeLang) {
 296   // TAG_union_type is encoded in DICompositeType format.
 297   Value *Elts[] = {
 298     GetTagConstant(VMContext, dwarf::DW_TAG_union_type),
 299     Scope,
 300     MDString::get(VMContext, Name),
 301     File,
 302     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 303     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 304     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 305     ConstantInt::get(Type::getInt64Ty(VMContext), 0),
 306     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 307     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 308     Elements,
 309     ConstantInt::get(Type::getInt32Ty(VMContext), RunTimeLang),
 310     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 311   };
 312   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 313 }
 314
 315 /// CreateSubroutineType - Create subroutine type.
 316 DIType DIBuilder::CreateSubroutineType(DIFile File, DIArray ParameterTypes) {
 317   // TAG_subroutine_type is encoded in DICompositeType format.
 318   Value *Elts[] = {
 319     GetTagConstant(VMContext, dwarf::DW_TAG_subroutine_type),
 320     File,
 321     MDString::get(VMContext, ""),
 322     File,
 323     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 324     ConstantInt::get(Type::getInt64Ty(VMContext), 0),
 325     ConstantInt::get(Type::getInt64Ty(VMContext), 0),
 326     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 327     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 328     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 329     ParameterTypes,
 330     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 331     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 332   };
 333   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 334 }
 335
 336 /// CreateEnumerationType - Create debugging information entry for an
 337 /// enumeration.
 338 DIType DIBuilder::CreateEnumerationType(DIDescriptor Scope, StringRef Name,
 339                                         DIFile File, unsigned LineNumber,
 340                                         uint64_t SizeInBits,
 341                                         uint64_t AlignInBits, DIArray Elements) {
 342   // TAG_enumeration_type is encoded in DICompositeType format.
 343   Value *Elts[] = {
 344     GetTagConstant(VMContext, dwarf::DW_TAG_enumeration_type),
 345     Scope,
 346     MDString::get(VMContext, Name),
 347     File,
 348     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 349     ConstantInt::get(Type::getInt64Ty(VMContext), SizeInBits),
 350     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 351     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 352     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 353     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 354     Elements,
 355     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 356     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 357   };
 358   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 359   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.enum");
 360   NMD->addOperand(Node);
 361   return DIType(Node);
 362 }
 363
 364 /// CreateArrayType - Create debugging information entry for an array.
 365 DIType DIBuilder::CreateArrayType(uint64_t Size, uint64_t AlignInBits,
 366                                   DIType Ty, DIArray Subscripts) {
 367   // TAG_array_type is encoded in DICompositeType format.
 368   Value *Elts[] = {
 369     GetTagConstant(VMContext, dwarf::DW_TAG_array_type),
 370     TheCU,
 371     MDString::get(VMContext, ""),
 372     TheCU,
 373     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 374     ConstantInt::get(Type::getInt64Ty(VMContext), Size),
 375     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 376     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 377     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 378     Ty,
 379     Subscripts,
 380     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 381     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 382   };
 383   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 384 }
 385
 386 /// CreateVectorType - Create debugging information entry for a vector.
 387 DIType DIBuilder::CreateVectorType(uint64_t Size, uint64_t AlignInBits,
 388                                    DIType Ty, DIArray Subscripts) {
 389   // TAG_vector_type is encoded in DICompositeType format.
 390   Value *Elts[] = {
 391     GetTagConstant(VMContext, dwarf::DW_TAG_vector_type),
 392     TheCU,
 393     MDString::get(VMContext, ""),
 394     TheCU,
 395     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 396     ConstantInt::get(Type::getInt64Ty(VMContext), Size),
 397     ConstantInt::get(Type::getInt64Ty(VMContext), AlignInBits),
 398     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 399     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 400     Ty,
 401     Subscripts,
 402     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 403     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 404   };
 405   return DIType(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 406 }
 407
 408 /// CreateArtificialType - Create a new DIType with "artificial" flag set.
 409 DIType DIBuilder::CreateArtificialType(DIType Ty) {
 410   if (Ty.isArtificial())
 411     return Ty;
 412
 413   SmallVector<Value *, 9> Elts;
 414   MDNode *N = Ty;
 415   assert (N && "Unexpected input DIType!");
 416   for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
 417     if (Value *V = N->getOperand(i))
 418       Elts.push_back(V);
 419     else
 420       Elts.push_back(Constant::getNullValue(Type::getInt32Ty(VMContext)));
 421   }
 422
 423   unsigned CurFlags = Ty.getFlags();
 424   CurFlags = CurFlags | DIType::FlagArtificial;
 425
 426   // Flags are stored at this slot.
 427   Elts[8] =  ConstantInt::get(Type::getInt32Ty(VMContext), CurFlags);
 428
 429   return DIType(MDNode::get(VMContext, Elts.data(), Elts.size()));
 430 }
 431
 432 /// RetainType - Retain DIType in a module even if it is not referenced
 433 /// through debug info anchors.
 434 void DIBuilder::RetainType(DIType T) {
 435   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.ty");
 436   NMD->addOperand(T);
 437 }
 438
 439 /// CreateUnspecifiedParameter - Create unspeicified type descriptor
 440 /// for the subroutine type.
 441 DIDescriptor DIBuilder::CreateUnspecifiedParameter() {
 442   Value *Elts[] = {
 443     GetTagConstant(VMContext, dwarf::DW_TAG_unspecified_parameters)
 444   };
 445   return DIDescriptor(MDNode::get(VMContext, &Elts[0], 1));
 446 }
 447
 448 /// CreateTemporaryType - Create a temporary forward-declared type.
 449 DIType DIBuilder::CreateTemporaryType() {
 450   // Give the temporary MDNode a tag. It doesn't matter what tag we
 451   // use here as long as DIType accepts it.
 452   Value *Elts[] = { GetTagConstant(VMContext, DW_TAG_base_type) };
 453   MDNode *Node = MDNode::getTemporary(VMContext, Elts, array_lengthof(Elts));
 454   return DIType(Node);
 455 }
 456
 457 /// CreateTemporaryType - Create a temporary forward-declared type.
 458 DIType DIBuilder::CreateTemporaryType(DIFile F) {
 459   // Give the temporary MDNode a tag. It doesn't matter what tag we
 460   // use here as long as DIType accepts it.
 461   Value *Elts[] = {
 462     GetTagConstant(VMContext, DW_TAG_base_type),
 463     F.getCompileUnit(),
 464     NULL,
 465     F
 466   };
 467   MDNode *Node = MDNode::getTemporary(VMContext, Elts, array_lengthof(Elts));
 468   return DIType(Node);
 469 }
 470
 471 /// GetOrCreateArray - Get a DIArray, create one if required.
 472 DIArray DIBuilder::GetOrCreateArray(Value *const *Elements, unsigned NumElements) {
 473   if (NumElements == 0) {
 474     Value *Null = llvm::Constant::getNullValue(Type::getInt32Ty(VMContext));
 475     return DIArray(MDNode::get(VMContext, &Null, 1));
 476   }
 477   return DIArray(MDNode::get(VMContext, Elements, NumElements));
 478 }
 479
 480 /// GetOrCreateSubrange - Create a descriptor for a value range.  This
 481 /// implicitly uniques the values returned.
 482 DISubrange DIBuilder::GetOrCreateSubrange(int64_t Lo, int64_t Hi) {
 483   Value *Elts[] = {
 484     GetTagConstant(VMContext, dwarf::DW_TAG_subrange_type),
 485     ConstantInt::get(Type::getInt64Ty(VMContext), Lo),
 486     ConstantInt::get(Type::getInt64Ty(VMContext), Hi)
 487   };
 488
 489   return DISubrange(MDNode::get(VMContext, &Elts[0], 3));
 490 }
 491
 492 /// CreateGlobalVariable - Create a new descriptor for the specified global.
 493 DIGlobalVariable DIBuilder::
 494 CreateGlobalVariable(StringRef Name, DIFile F, unsigned LineNumber,
 495                      DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
 496   Value *Elts[] = {
 497     GetTagConstant(VMContext, dwarf::DW_TAG_variable),
 498     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 499     TheCU,
 500     MDString::get(VMContext, Name),
 501     MDString::get(VMContext, Name),
 502     MDString::get(VMContext, Name),
 503     F,
 504     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 505     Ty,
 506     ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
 507     ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
 508     Val
 509   };
 510   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 511   // Create a named metadata so that we do not lose this mdnode.
 512   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
 513   NMD->addOperand(Node);
 514   return DIGlobalVariable(Node);
 515 }
 516
 517 /// CreateStaticVariable - Create a new descriptor for the specified static
 518 /// variable.
 519 DIGlobalVariable DIBuilder::
 520 CreateStaticVariable(DIDescriptor Context, StringRef Name,
 521                      StringRef LinkageName, DIFile F, unsigned LineNumber,
 522                      DIType Ty, bool isLocalToUnit, llvm::Value *Val) {
 523   Value *Elts[] = {
 524     GetTagConstant(VMContext, dwarf::DW_TAG_variable),
 525     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 526     Context,
 527     MDString::get(VMContext, Name),
 528     MDString::get(VMContext, Name),
 529     MDString::get(VMContext, LinkageName),
 530     F,
 531     ConstantInt::get(Type::getInt32Ty(VMContext), LineNumber),
 532     Ty,
 533     ConstantInt::get(Type::getInt32Ty(VMContext), isLocalToUnit),
 534     ConstantInt::get(Type::getInt32Ty(VMContext), 1), /* isDefinition*/
 535     Val
 536   };
 537   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 538   // Create a named metadata so that we do not lose this mdnode.
 539   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.gv");
 540   NMD->addOperand(Node);
 541   return DIGlobalVariable(Node);
 542 }
 543
 544 /// CreateVariable - Create a new descriptor for the specified variable.
 545 DIVariable DIBuilder::CreateLocalVariable(unsigned Tag, DIDescriptor Scope,
 546                                           StringRef Name, DIFile File,
 547                                           unsigned LineNo, DIType Ty,
 548                                           bool AlwaysPreserve, unsigned Flags) {
 549   Value *Elts[] = {
 550     GetTagConstant(VMContext, Tag),
 551     Scope,
 552     MDString::get(VMContext, Name),
 553     File,
 554     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 555     Ty,
 556     ConstantInt::get(Type::getInt32Ty(VMContext), Flags)
 557   };
 558   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 559   if (AlwaysPreserve) {
 560     // The optimizer may remove local variable. If there is an interest
 561     // to preserve variable info in such situation then stash it in a
 562     // named mdnode.
 563     DISubprogram Fn(getDISubprogram(Scope));
 564     StringRef FName = "fn";
 565     if (Fn.getFunction())
 566       FName = Fn.getFunction()->getName();
 567     char One = '\1';
 568     if (FName.startswith(StringRef(&One, 1)))
 569       FName = FName.substr(1);
 570     NamedMDNode *FnLocals = getOrInsertFnSpecificMDNode(M, FName);
 571     FnLocals->addOperand(Node);
 572   }
 573   return DIVariable(Node);
 574 }
 575
 576 /// CreateComplexVariable - Create a new descriptor for the specified variable
 577 /// which has a complex address expression for its address.
 578 DIVariable DIBuilder::CreateComplexVariable(unsigned Tag, DIDescriptor Scope,
 579                                             StringRef Name, DIFile F,
 580                                             unsigned LineNo,
 581                                             DIType Ty, Value *const *Addr,
 582                                             unsigned NumAddr) {
 583   SmallVector<Value *, 15> Elts;
 584   Elts.push_back(GetTagConstant(VMContext, Tag));
 585   Elts.push_back(Scope);
 586   Elts.push_back(MDString::get(VMContext, Name));
 587   Elts.push_back(F);
 588   Elts.push_back(ConstantInt::get(Type::getInt32Ty(VMContext), LineNo));
 589   Elts.push_back(Ty);
 590   Elts.append(Addr, Addr+NumAddr);
 591
 592   return DIVariable(MDNode::get(VMContext, Elts.data(), Elts.size()));
 593 }
 594
 595 /// CreateFunction - Create a new descriptor for the specified function.
 596 DISubprogram DIBuilder::CreateFunction(DIDescriptor Context,
 597                                        StringRef Name,
 598                                        StringRef LinkageName,
 599                                        DIFile File, unsigned LineNo,
 600                                        DIType Ty,
 601                                        bool isLocalToUnit, bool isDefinition,
 602                                        unsigned Flags, bool isOptimized,
 603                                        Function *Fn) {
 604
 605   Value *Elts[] = {
 606     GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
 607     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 608     Context,
 609     MDString::get(VMContext, Name),
 610     MDString::get(VMContext, Name),
 611     MDString::get(VMContext, LinkageName),
 612     File,
 613     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 614     Ty,
 615     ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
 616     ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
 617     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 618     ConstantInt::get(Type::getInt32Ty(VMContext), 0),
 619     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 620     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 621     ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
 622     Fn
 623   };
 624   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 625
 626   // Create a named metadata so that we do not lose this mdnode.
 627   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
 628   NMD->addOperand(Node);
 629   return DISubprogram(Node);
 630 }
 631
 632 /// CreateMethod - Create a new descriptor for the specified C++ method.
 633 DISubprogram DIBuilder::CreateMethod(DIDescriptor Context,
 634                                      StringRef Name,
 635                                      StringRef LinkageName,
 636                                      DIFile F,
 637                                      unsigned LineNo, DIType Ty,
 638                                      bool isLocalToUnit,
 639                                      bool isDefinition,
 640                                      unsigned VK, unsigned VIndex,
 641                                      MDNode *VTableHolder,
 642                                      unsigned Flags,
 643                                      bool isOptimized,
 644                                      Function *Fn) {
 645   Value *Elts[] = {
 646     GetTagConstant(VMContext, dwarf::DW_TAG_subprogram),
 647     llvm::Constant::getNullValue(Type::getInt32Ty(VMContext)),
 648     Context,
 649     MDString::get(VMContext, Name),
 650     MDString::get(VMContext, Name),
 651     MDString::get(VMContext, LinkageName),
 652     F,
 653     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo),
 654     Ty,
 655     ConstantInt::get(Type::getInt1Ty(VMContext), isLocalToUnit),
 656     ConstantInt::get(Type::getInt1Ty(VMContext), isDefinition),
 657     ConstantInt::get(Type::getInt32Ty(VMContext), (unsigned)VK),
 658     ConstantInt::get(Type::getInt32Ty(VMContext), VIndex),
 659     VTableHolder,
 660     ConstantInt::get(Type::getInt32Ty(VMContext), Flags),
 661     ConstantInt::get(Type::getInt1Ty(VMContext), isOptimized),
 662     Fn
 663   };
 664   MDNode *Node = MDNode::get(VMContext, &Elts[0], array_lengthof(Elts));
 665
 666   // Create a named metadata so that we do not lose this mdnode.
 667   NamedMDNode *NMD = M.getOrInsertNamedMetadata("llvm.dbg.sp");
 668   NMD->addOperand(Node);
 669   return DISubprogram(Node);
 670 }
 671
 672 /// CreateNameSpace - This creates new descriptor for a namespace
 673 /// with the specified parent scope.
 674 DINameSpace DIBuilder::CreateNameSpace(DIDescriptor Scope, StringRef Name,
 675                                        DIFile File, unsigned LineNo) {
 676   Value *Elts[] = {
 677     GetTagConstant(VMContext, dwarf::DW_TAG_namespace),
 678     Scope,
 679     MDString::get(VMContext, Name),
 680     File,
 681     ConstantInt::get(Type::getInt32Ty(VMContext), LineNo)
 682   };
 683   return DINameSpace(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 684 }
 685
 686 DILexicalBlock DIBuilder::CreateLexicalBlock(DIDescriptor Scope, DIFile File,
 687                                              unsigned Line, unsigned Col) {
 688   // Defeat MDNode uniqing for lexical blocks by using unique id.
 689   static unsigned int unique_id = 0;
 690   Value *Elts[] = {
 691     GetTagConstant(VMContext, dwarf::DW_TAG_lexical_block),
 692     Scope,
 693     ConstantInt::get(Type::getInt32Ty(VMContext), Line),
 694     ConstantInt::get(Type::getInt32Ty(VMContext), Col),
 695     File,
 696     ConstantInt::get(Type::getInt32Ty(VMContext), unique_id++)
 697   };
 698   return DILexicalBlock(MDNode::get(VMContext, &Elts[0], array_lengthof(Elts)));
 699 }
 700
 701 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
 702 Instruction *DIBuilder::InsertDeclare(Value *Storage, DIVariable VarInfo,
 703                                       Instruction *InsertBefore) {
 704   assert(Storage && "no storage passed to dbg.declare");
 705   assert(VarInfo.Verify() && "empty DIVariable passed to dbg.declare");
 706   if (!DeclareFn)
 707     DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
 708
 709   Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1), VarInfo };
 710   return CallInst::Create(DeclareFn, Args, Args+2, "", InsertBefore);
 711 }
 712
 713 /// InsertDeclare - Insert a new llvm.dbg.declare intrinsic call.
 714 Instruction *DIBuilder::InsertDeclare(Value *Storage, DIVariable VarInfo,
 715                                       BasicBlock *InsertAtEnd) {
 716   assert(Storage && "no storage passed to dbg.declare");
 717   assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.declare");
 718   if (!DeclareFn)
 719     DeclareFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_declare);
 720
 721   Value *Args[] = { MDNode::get(Storage->getContext(), &Storage, 1), VarInfo };
 722
 723   // If this block already has a terminator then insert this intrinsic
 724   // before the terminator.
 725   if (TerminatorInst *T = InsertAtEnd->getTerminator())
 726     return CallInst::Create(DeclareFn, Args, Args+2, "", T);
 727   else
 728     return CallInst::Create(DeclareFn, Args, Args+2, "", InsertAtEnd);
 729 }
 730
 731 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
 732 Instruction *DIBuilder::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
 733                                                 DIVariable VarInfo,
 734                                                 Instruction *InsertBefore) {
 735   assert(V && "no value passed to dbg.value");
 736   assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
 737   if (!ValueFn)
 738     ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
 739
 740   Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
 741                     ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
 742                     VarInfo };
 743   return CallInst::Create(ValueFn, Args, Args+3, "", InsertBefore);
 744 }
 745
 746 /// InsertDbgValueIntrinsic - Insert a new llvm.dbg.value intrinsic call.
 747 Instruction *DIBuilder::InsertDbgValueIntrinsic(Value *V, uint64_t Offset,
 748                                                 DIVariable VarInfo,
 749                                                 BasicBlock *InsertAtEnd) {
 750   assert(V && "no value passed to dbg.value");
 751   assert(VarInfo.Verify() && "invalid DIVariable passed to dbg.value");
 752   if (!ValueFn)
 753     ValueFn = Intrinsic::getDeclaration(&M, Intrinsic::dbg_value);
 754
 755   Value *Args[] = { MDNode::get(V->getContext(), &V, 1),
 756                     ConstantInt::get(Type::getInt64Ty(V->getContext()), Offset),
 757                     VarInfo };
 758   return CallInst::Create(ValueFn, Args, Args+3, "", InsertAtEnd);
 759 }
 760