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