lib/CodeGen/AsmPrinter/DwarfCompileUnit.cpp

   1 //===-- llvm/CodeGen/DwarfCompileUnit.cpp - Dwarf Compile Unit ------------===//
   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 contains support for constructing a dwarf compile unit.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "dwarfdebug"
  15
  16 #include "DwarfCompileUnit.h"
  17 #include "DwarfAccelTable.h"
  18 #include "DwarfDebug.h"
  19 #include "llvm/ADT/APFloat.h"
  20 #include "llvm/DIBuilder.h"
  21 #include "llvm/IR/Constants.h"
  22 #include "llvm/IR/DataLayout.h"
  23 #include "llvm/IR/GlobalVariable.h"
  24 #include "llvm/IR/Instructions.h"
  25 #include "llvm/Target/Mangler.h"
  26 #include "llvm/Target/TargetFrameLowering.h"
  27 #include "llvm/Target/TargetMachine.h"
  28 #include "llvm/Target/TargetLoweringObjectFile.h"
  29 #include "llvm/Target/TargetRegisterInfo.h"
  30
  31 using namespace llvm;
  32
  33 /// CompileUnit - Compile unit constructor.
  34 CompileUnit::CompileUnit(unsigned UID, DIE *D, const MDNode *N, AsmPrinter *A,
  35                          DwarfDebug *DW, DwarfUnits *DWU)
  36     : UniqueID(UID), Node(N), CUDie(D), Asm(A), DD(DW), DU(DWU), IndexTyDie(0) {
  37   DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
  38   insertDIE(N, D);
  39 }
  40
  41 /// ~CompileUnit - Destructor for compile unit.
  42 CompileUnit::~CompileUnit() {
  43   for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
  44     DIEBlocks[j]->~DIEBlock();
  45 }
  46
  47 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
  48 /// information entry.
  49 DIEEntry *CompileUnit::createDIEEntry(DIE *Entry) {
  50   DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
  51   return Value;
  52 }
  53
  54 /// getDefaultLowerBound - Return the default lower bound for an array. If the
  55 /// DWARF version doesn't handle the language, return -1.
  56 int64_t CompileUnit::getDefaultLowerBound() const {
  57   switch (DICompileUnit(Node).getLanguage()) {
  58   default:
  59     break;
  60
  61   case dwarf::DW_LANG_C89:
  62   case dwarf::DW_LANG_C99:
  63   case dwarf::DW_LANG_C:
  64   case dwarf::DW_LANG_C_plus_plus:
  65   case dwarf::DW_LANG_ObjC:
  66   case dwarf::DW_LANG_ObjC_plus_plus:
  67     return 0;
  68
  69   case dwarf::DW_LANG_Fortran77:
  70   case dwarf::DW_LANG_Fortran90:
  71   case dwarf::DW_LANG_Fortran95:
  72     return 1;
  73
  74   // The languages below have valid values only if the DWARF version >= 4.
  75   case dwarf::DW_LANG_Java:
  76   case dwarf::DW_LANG_Python:
  77   case dwarf::DW_LANG_UPC:
  78   case dwarf::DW_LANG_D:
  79     if (dwarf::DWARF_VERSION >= 4)
  80       return 0;
  81     break;
  82
  83   case dwarf::DW_LANG_Ada83:
  84   case dwarf::DW_LANG_Ada95:
  85   case dwarf::DW_LANG_Cobol74:
  86   case dwarf::DW_LANG_Cobol85:
  87   case dwarf::DW_LANG_Modula2:
  88   case dwarf::DW_LANG_Pascal83:
  89   case dwarf::DW_LANG_PLI:
  90     if (dwarf::DWARF_VERSION >= 4)
  91       return 1;
  92     break;
  93   }
  94
  95   return -1;
  96 }
  97
  98 /// addFlag - Add a flag that is true.
  99 void CompileUnit::addFlag(DIE *Die, uint16_t Attribute) {
 100   if (DD->getDwarfVersion() >= 4)
 101     Die->addValue(Attribute, dwarf::DW_FORM_flag_present, DIEIntegerOne);
 102   else
 103     Die->addValue(Attribute, dwarf::DW_FORM_flag, DIEIntegerOne);
 104 }
 105
 106 /// addUInt - Add an unsigned integer attribute data and value.
 107 ///
 108 void CompileUnit::addUInt(DIE *Die, uint16_t Attribute,
 109                           uint16_t Form, uint64_t Integer) {
 110   if (!Form) Form = DIEInteger::BestForm(false, Integer);
 111   DIEValue *Value = Integer == 1 ?
 112     DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
 113   Die->addValue(Attribute, Form, Value);
 114 }
 115
 116 /// addSInt - Add an signed integer attribute data and value.
 117 ///
 118 void CompileUnit::addSInt(DIE *Die, uint16_t Attribute,
 119                           uint16_t Form, int64_t Integer) {
 120   if (!Form) Form = DIEInteger::BestForm(true, Integer);
 121   DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
 122   Die->addValue(Attribute, Form, Value);
 123 }
 124
 125 /// addString - Add a string attribute data and value. We always emit a
 126 /// reference to the string pool instead of immediate strings so that DIEs have
 127 /// more predictable sizes. In the case of split dwarf we emit an index
 128 /// into another table which gets us the static offset into the string
 129 /// table.
 130 void CompileUnit::addString(DIE *Die, uint16_t Attribute, StringRef String) {
 131   DIEValue *Value;
 132   uint16_t Form;
 133   if (!DD->useSplitDwarf()) {
 134     MCSymbol *Symb = DU->getStringPoolEntry(String);
 135     if (Asm->needsRelocationsForDwarfStringPool())
 136       Value = new (DIEValueAllocator) DIELabel(Symb);
 137     else {
 138       MCSymbol *StringPool = DU->getStringPoolSym();
 139       Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
 140     }
 141     Form = dwarf::DW_FORM_strp;
 142   } else {
 143     unsigned idx = DU->getStringPoolIndex(String);
 144     Value = new (DIEValueAllocator) DIEInteger(idx);
 145     Form = dwarf::DW_FORM_GNU_str_index;
 146   }
 147   DIEValue *Str = new (DIEValueAllocator) DIEString(Value, String);
 148   Die->addValue(Attribute, Form, Str);
 149 }
 150
 151 /// addLocalString - Add a string attribute data and value. This is guaranteed
 152 /// to be in the local string pool instead of indirected.
 153 void CompileUnit::addLocalString(DIE *Die, uint16_t Attribute,
 154                                  StringRef String) {
 155   MCSymbol *Symb = DU->getStringPoolEntry(String);
 156   DIEValue *Value;
 157   if (Asm->needsRelocationsForDwarfStringPool())
 158     Value = new (DIEValueAllocator) DIELabel(Symb);
 159   else {
 160     MCSymbol *StringPool = DU->getStringPoolSym();
 161     Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
 162   }
 163   Die->addValue(Attribute, dwarf::DW_FORM_strp, Value);
 164 }
 165
 166 /// addExpr - Add a Dwarf expression attribute data and value.
 167 ///
 168 void CompileUnit::addExpr(DIE *Die, uint16_t Attribute, uint16_t Form,
 169                           const MCExpr *Expr) {
 170   DIEValue *Value = new (DIEValueAllocator) DIEExpr(Expr);
 171   Die->addValue(Attribute, Form, Value);
 172 }
 173
 174 /// addLabel - Add a Dwarf label attribute data and value.
 175 ///
 176 void CompileUnit::addLabel(DIE *Die, uint16_t Attribute, uint16_t Form,
 177                            const MCSymbol *Label) {
 178   DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
 179   Die->addValue(Attribute, Form, Value);
 180 }
 181
 182 /// addLabelAddress - Add a dwarf label attribute data and value using
 183 /// DW_FORM_addr or DW_FORM_GNU_addr_index.
 184 ///
 185 void CompileUnit::addLabelAddress(DIE *Die, uint16_t Attribute,
 186                                   MCSymbol *Label) {
 187   if (Label)
 188     DD->addArangeLabel(SymbolCU(this, Label));
 189
 190   if (!DD->useSplitDwarf()) {
 191     if (Label != NULL) {
 192       DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
 193       Die->addValue(Attribute, dwarf::DW_FORM_addr, Value);
 194     } else {
 195       DIEValue *Value = new (DIEValueAllocator) DIEInteger(0);
 196       Die->addValue(Attribute, dwarf::DW_FORM_addr, Value);
 197     }
 198   } else {
 199     unsigned idx = DU->getAddrPoolIndex(Label);
 200     DIEValue *Value = new (DIEValueAllocator) DIEInteger(idx);
 201     Die->addValue(Attribute, dwarf::DW_FORM_GNU_addr_index, Value);
 202   }
 203 }
 204
 205 /// addOpAddress - Add a dwarf op address data and value using the
 206 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
 207 ///
 208 void CompileUnit::addOpAddress(DIE *Die, const MCSymbol *Sym) {
 209   DD->addArangeLabel(SymbolCU(this, Sym));
 210   if (!DD->useSplitDwarf()) {
 211     addUInt(Die, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
 212     addLabel(Die, 0, dwarf::DW_FORM_udata, Sym);
 213   } else {
 214     addUInt(Die, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_addr_index);
 215     addUInt(Die, 0, dwarf::DW_FORM_GNU_addr_index, DU->getAddrPoolIndex(Sym));
 216   }
 217 }
 218
 219 /// addDelta - Add a label delta attribute data and value.
 220 ///
 221 void CompileUnit::addDelta(DIE *Die, uint16_t Attribute, uint16_t Form,
 222                            const MCSymbol *Hi, const MCSymbol *Lo) {
 223   DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
 224   Die->addValue(Attribute, Form, Value);
 225 }
 226
 227 /// addDIEEntry - Add a DIE attribute data and value.
 228 ///
 229 void CompileUnit::addDIEEntry(DIE *Die, uint16_t Attribute, uint16_t Form,
 230                               DIE *Entry) {
 231   Die->addValue(Attribute, Form, createDIEEntry(Entry));
 232 }
 233
 234 /// addBlock - Add block data.
 235 ///
 236 void CompileUnit::addBlock(DIE *Die, uint16_t Attribute, uint16_t Form,
 237                            DIEBlock *Block) {
 238   Block->ComputeSize(Asm);
 239   DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
 240   Die->addValue(Attribute, Block->BestForm(), Block);
 241 }
 242
 243 /// addSourceLine - Add location information to specified debug information
 244 /// entry.
 245 void CompileUnit::addSourceLine(DIE *Die, DIVariable V) {
 246   // Verify variable.
 247   if (!V.isVariable())
 248     return;
 249
 250   unsigned Line = V.getLineNumber();
 251   if (Line == 0)
 252     return;
 253   unsigned FileID = DD->getOrCreateSourceID(V.getContext().getFilename(),
 254                                             V.getContext().getDirectory(),
 255                                             getUniqueID());
 256   assert(FileID && "Invalid file id");
 257   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 258   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 259 }
 260
 261 /// addSourceLine - Add location information to specified debug information
 262 /// entry.
 263 void CompileUnit::addSourceLine(DIE *Die, DIGlobalVariable G) {
 264   // Verify global variable.
 265   if (!G.isGlobalVariable())
 266     return;
 267
 268   unsigned Line = G.getLineNumber();
 269   if (Line == 0)
 270     return;
 271   unsigned FileID = DD->getOrCreateSourceID(G.getFilename(), G.getDirectory(),
 272                                             getUniqueID());
 273   assert(FileID && "Invalid file id");
 274   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 275   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 276 }
 277
 278 /// addSourceLine - Add location information to specified debug information
 279 /// entry.
 280 void CompileUnit::addSourceLine(DIE *Die, DISubprogram SP) {
 281   // Verify subprogram.
 282   if (!SP.isSubprogram())
 283     return;
 284
 285   // If the line number is 0, don't add it.
 286   unsigned Line = SP.getLineNumber();
 287   if (Line == 0)
 288     return;
 289
 290   unsigned FileID = DD->getOrCreateSourceID(SP.getFilename(),
 291                                             SP.getDirectory(), getUniqueID());
 292   assert(FileID && "Invalid file id");
 293   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 294   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 295 }
 296
 297 /// addSourceLine - Add location information to specified debug information
 298 /// entry.
 299 void CompileUnit::addSourceLine(DIE *Die, DIType Ty) {
 300   // Verify type.
 301   if (!Ty.isType())
 302     return;
 303
 304   unsigned Line = Ty.getLineNumber();
 305   if (Line == 0)
 306     return;
 307   unsigned FileID = DD->getOrCreateSourceID(Ty.getFilename(),
 308                                             Ty.getDirectory(), getUniqueID());
 309   assert(FileID && "Invalid file id");
 310   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 311   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 312 }
 313
 314 /// addSourceLine - Add location information to specified debug information
 315 /// entry.
 316 void CompileUnit::addSourceLine(DIE *Die, DIObjCProperty Ty) {
 317   // Verify type.
 318   if (!Ty.isObjCProperty())
 319     return;
 320
 321   unsigned Line = Ty.getLineNumber();
 322   if (Line == 0)
 323     return;
 324   DIFile File = Ty.getFile();
 325   unsigned FileID = DD->getOrCreateSourceID(File.getFilename(),
 326                                             File.getDirectory(), getUniqueID());
 327   assert(FileID && "Invalid file id");
 328   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 329   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 330 }
 331
 332 /// addSourceLine - Add location information to specified debug information
 333 /// entry.
 334 void CompileUnit::addSourceLine(DIE *Die, DINameSpace NS) {
 335   // Verify namespace.
 336   if (!NS.Verify())
 337     return;
 338
 339   unsigned Line = NS.getLineNumber();
 340   if (Line == 0)
 341     return;
 342   StringRef FN = NS.getFilename();
 343
 344   unsigned FileID = DD->getOrCreateSourceID(FN, NS.getDirectory(),
 345                                             getUniqueID());
 346   assert(FileID && "Invalid file id");
 347   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 348   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 349 }
 350
 351 /// addVariableAddress - Add DW_AT_location attribute for a
 352 /// DbgVariable based on provided MachineLocation.
 353 void CompileUnit::addVariableAddress(const DbgVariable &DV, DIE *Die,
 354                                      MachineLocation Location) {
 355   if (DV.variableHasComplexAddress())
 356     addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
 357   else if (DV.isBlockByrefVariable())
 358     addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
 359   else
 360     addAddress(Die, dwarf::DW_AT_location, Location,
 361                DV.getVariable().isIndirect());
 362 }
 363
 364 /// addRegisterOp - Add register operand.
 365 void CompileUnit::addRegisterOp(DIE *TheDie, unsigned Reg) {
 366   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
 367   unsigned DWReg = RI->getDwarfRegNum(Reg, false);
 368   if (DWReg < 32)
 369     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + DWReg);
 370   else {
 371     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
 372     addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
 373   }
 374 }
 375
 376 /// addRegisterOffset - Add register offset.
 377 void CompileUnit::addRegisterOffset(DIE *TheDie, unsigned Reg,
 378                                     int64_t Offset) {
 379   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
 380   unsigned DWReg = RI->getDwarfRegNum(Reg, false);
 381   const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
 382   if (Reg == TRI->getFrameRegister(*Asm->MF))
 383     // If variable offset is based in frame register then use fbreg.
 384     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
 385   else if (DWReg < 32)
 386     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + DWReg);
 387   else {
 388     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
 389     addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
 390   }
 391   addSInt(TheDie, 0, dwarf::DW_FORM_sdata, Offset);
 392 }
 393
 394 /// addAddress - Add an address attribute to a die based on the location
 395 /// provided.
 396 void CompileUnit::addAddress(DIE *Die, uint16_t Attribute,
 397                              const MachineLocation &Location, bool Indirect) {
 398   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 399
 400   if (Location.isReg() && !Indirect)
 401     addRegisterOp(Block, Location.getReg());
 402   else {
 403     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
 404     if (Indirect && !Location.isReg()) {
 405       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
 406     }
 407   }
 408
 409   // Now attach the location information to the DIE.
 410   addBlock(Die, Attribute, 0, Block);
 411 }
 412
 413 /// addComplexAddress - Start with the address based on the location provided,
 414 /// and generate the DWARF information necessary to find the actual variable
 415 /// given the extra address information encoded in the DIVariable, starting from
 416 /// the starting location.  Add the DWARF information to the die.
 417 ///
 418 void CompileUnit::addComplexAddress(const DbgVariable &DV, DIE *Die,
 419                                     uint16_t Attribute,
 420                                     const MachineLocation &Location) {
 421   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 422   unsigned N = DV.getNumAddrElements();
 423   unsigned i = 0;
 424   if (Location.isReg()) {
 425     if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
 426       // If first address element is OpPlus then emit
 427       // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
 428       addRegisterOffset(Block, Location.getReg(), DV.getAddrElement(1));
 429       i = 2;
 430     } else
 431       addRegisterOp(Block, Location.getReg());
 432   }
 433   else
 434     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
 435
 436   for (;i < N; ++i) {
 437     uint64_t Element = DV.getAddrElement(i);
 438     if (Element == DIBuilder::OpPlus) {
 439       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
 440       addUInt(Block, 0, dwarf::DW_FORM_udata, DV.getAddrElement(++i));
 441     } else if (Element == DIBuilder::OpDeref) {
 442       if (!Location.isReg())
 443         addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
 444     } else llvm_unreachable("unknown DIBuilder Opcode");
 445   }
 446
 447   // Now attach the location information to the DIE.
 448   addBlock(Die, Attribute, 0, Block);
 449 }
 450
 451 /* Byref variables, in Blocks, are declared by the programmer as "SomeType
 452    VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
 453    gives the variable VarName either the struct, or a pointer to the struct, as
 454    its type.  This is necessary for various behind-the-scenes things the
 455    compiler needs to do with by-reference variables in Blocks.
 456
 457    However, as far as the original *programmer* is concerned, the variable
 458    should still have type 'SomeType', as originally declared.
 459
 460    The function getBlockByrefType dives into the __Block_byref_x_VarName
 461    struct to find the original type of the variable, which is then assigned to
 462    the variable's Debug Information Entry as its real type.  So far, so good.
 463    However now the debugger will expect the variable VarName to have the type
 464    SomeType.  So we need the location attribute for the variable to be an
 465    expression that explains to the debugger how to navigate through the
 466    pointers and struct to find the actual variable of type SomeType.
 467
 468    The following function does just that.  We start by getting
 469    the "normal" location for the variable. This will be the location
 470    of either the struct __Block_byref_x_VarName or the pointer to the
 471    struct __Block_byref_x_VarName.
 472
 473    The struct will look something like:
 474
 475    struct __Block_byref_x_VarName {
 476      ... <various fields>
 477      struct __Block_byref_x_VarName *forwarding;
 478      ... <various other fields>
 479      SomeType VarName;
 480      ... <maybe more fields>
 481    };
 482
 483    If we are given the struct directly (as our starting point) we
 484    need to tell the debugger to:
 485
 486    1).  Add the offset of the forwarding field.
 487
 488    2).  Follow that pointer to get the real __Block_byref_x_VarName
 489    struct to use (the real one may have been copied onto the heap).
 490
 491    3).  Add the offset for the field VarName, to find the actual variable.
 492
 493    If we started with a pointer to the struct, then we need to
 494    dereference that pointer first, before the other steps.
 495    Translating this into DWARF ops, we will need to append the following
 496    to the current location description for the variable:
 497
 498    DW_OP_deref                    -- optional, if we start with a pointer
 499    DW_OP_plus_uconst <forward_fld_offset>
 500    DW_OP_deref
 501    DW_OP_plus_uconst <varName_fld_offset>
 502
 503    That is what this function does.  */
 504
 505 /// addBlockByrefAddress - Start with the address based on the location
 506 /// provided, and generate the DWARF information necessary to find the
 507 /// actual Block variable (navigating the Block struct) based on the
 508 /// starting location.  Add the DWARF information to the die.  For
 509 /// more information, read large comment just above here.
 510 ///
 511 void CompileUnit::addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
 512                                        uint16_t Attribute,
 513                                        const MachineLocation &Location) {
 514   DIType Ty = DV.getType();
 515   DIType TmpTy = Ty;
 516   uint16_t Tag = Ty.getTag();
 517   bool isPointer = false;
 518
 519   StringRef varName = DV.getName();
 520
 521   if (Tag == dwarf::DW_TAG_pointer_type) {
 522     DIDerivedType DTy = DIDerivedType(Ty);
 523     TmpTy = resolve(DTy.getTypeDerivedFrom());
 524     isPointer = true;
 525   }
 526
 527   DICompositeType blockStruct = DICompositeType(TmpTy);
 528
 529   // Find the __forwarding field and the variable field in the __Block_byref
 530   // struct.
 531   DIArray Fields = blockStruct.getTypeArray();
 532   DIDescriptor varField = DIDescriptor();
 533   DIDescriptor forwardingField = DIDescriptor();
 534
 535   for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
 536     DIDescriptor Element = Fields.getElement(i);
 537     DIDerivedType DT = DIDerivedType(Element);
 538     StringRef fieldName = DT.getName();
 539     if (fieldName == "__forwarding")
 540       forwardingField = Element;
 541     else if (fieldName == varName)
 542       varField = Element;
 543   }
 544
 545   // Get the offsets for the forwarding field and the variable field.
 546   unsigned forwardingFieldOffset =
 547     DIDerivedType(forwardingField).getOffsetInBits() >> 3;
 548   unsigned varFieldOffset =
 549     DIDerivedType(varField).getOffsetInBits() >> 3;
 550
 551   // Decode the original location, and use that as the start of the byref
 552   // variable's location.
 553   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 554
 555   if (Location.isReg())
 556     addRegisterOp(Block, Location.getReg());
 557   else
 558     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
 559
 560   // If we started with a pointer to the __Block_byref... struct, then
 561   // the first thing we need to do is dereference the pointer (DW_OP_deref).
 562   if (isPointer)
 563     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
 564
 565   // Next add the offset for the '__forwarding' field:
 566   // DW_OP_plus_uconst ForwardingFieldOffset.  Note there's no point in
 567   // adding the offset if it's 0.
 568   if (forwardingFieldOffset > 0) {
 569     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
 570     addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
 571   }
 572
 573   // Now dereference the __forwarding field to get to the real __Block_byref
 574   // struct:  DW_OP_deref.
 575   addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
 576
 577   // Now that we've got the real __Block_byref... struct, add the offset
 578   // for the variable's field to get to the location of the actual variable:
 579   // DW_OP_plus_uconst varFieldOffset.  Again, don't add if it's 0.
 580   if (varFieldOffset > 0) {
 581     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
 582     addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
 583   }
 584
 585   // Now attach the location information to the DIE.
 586   addBlock(Die, Attribute, 0, Block);
 587 }
 588
 589 /// isTypeSigned - Return true if the type is signed.
 590 static bool isTypeSigned(DwarfDebug *DD, DIType Ty, int *SizeInBits) {
 591   if (Ty.isDerivedType())
 592     return isTypeSigned(DD, DD->resolve(DIDerivedType(Ty).getTypeDerivedFrom()),
 593                         SizeInBits);
 594   if (Ty.isBasicType())
 595     if (DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed
 596         || DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed_char) {
 597       *SizeInBits = Ty.getSizeInBits();
 598       return true;
 599     }
 600   return false;
 601 }
 602
 603 /// Return true if type encoding is unsigned.
 604 static bool isUnsignedDIType(DwarfDebug *DD, DIType Ty) {
 605   DIDerivedType DTy(Ty);
 606   if (DTy.isDerivedType())
 607     return isUnsignedDIType(DD, DD->resolve(DTy.getTypeDerivedFrom()));
 608
 609   DIBasicType BTy(Ty);
 610   if (BTy.isBasicType()) {
 611     unsigned Encoding = BTy.getEncoding();
 612     if (Encoding == dwarf::DW_ATE_unsigned ||
 613         Encoding == dwarf::DW_ATE_unsigned_char ||
 614         Encoding == dwarf::DW_ATE_boolean)
 615       return true;
 616   }
 617   return false;
 618 }
 619
 620 /// If this type is derived from a base type then return base type size.
 621 static uint64_t getBaseTypeSize(DwarfDebug *DD, DIDerivedType Ty) {
 622   unsigned Tag = Ty.getTag();
 623
 624   if (Tag != dwarf::DW_TAG_member && Tag != dwarf::DW_TAG_typedef &&
 625       Tag != dwarf::DW_TAG_const_type && Tag != dwarf::DW_TAG_volatile_type &&
 626       Tag != dwarf::DW_TAG_restrict_type)
 627     return Ty.getSizeInBits();
 628
 629   DIType BaseType = DD->resolve(Ty.getTypeDerivedFrom());
 630
 631   // If this type is not derived from any type then take conservative approach.
 632   if (!BaseType.isValid())
 633     return Ty.getSizeInBits();
 634
 635   // If this is a derived type, go ahead and get the base type, unless it's a
 636   // reference then it's just the size of the field. Pointer types have no need
 637   // of this since they're a different type of qualification on the type.
 638   if (BaseType.getTag() == dwarf::DW_TAG_reference_type ||
 639       BaseType.getTag() == dwarf::DW_TAG_rvalue_reference_type)
 640     return Ty.getSizeInBits();
 641
 642   if (BaseType.isDerivedType())
 643     return getBaseTypeSize(DD, DIDerivedType(BaseType));
 644
 645   return BaseType.getSizeInBits();
 646 }
 647
 648 /// addConstantValue - Add constant value entry in variable DIE.
 649 void CompileUnit::addConstantValue(DIE *Die, const MachineOperand &MO,
 650                                    DIType Ty) {
 651   // FIXME: This is a bit conservative/simple - it emits negative values at
 652   // their maximum bit width which is a bit unfortunate (& doesn't prefer
 653   // udata/sdata over dataN as suggested by the DWARF spec)
 654   assert(MO.isImm() && "Invalid machine operand!");
 655   int SizeInBits = -1;
 656   bool SignedConstant = isTypeSigned(DD, Ty, &SizeInBits);
 657   uint16_t Form;
 658
 659   // If we're a signed constant definitely use sdata.
 660   if (SignedConstant) {
 661     addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, MO.getImm());
 662     return;
 663   }
 664
 665   // Else use data for now unless it's larger than we can deal with.
 666   switch (SizeInBits) {
 667   case 8:
 668     Form = dwarf::DW_FORM_data1;
 669     break;
 670   case 16:
 671     Form = dwarf::DW_FORM_data2;
 672     break;
 673   case 32:
 674     Form = dwarf::DW_FORM_data4;
 675     break;
 676   case 64:
 677     Form = dwarf::DW_FORM_data8;
 678     break;
 679   default:
 680     Form = dwarf::DW_FORM_udata;
 681     addUInt(Die, dwarf::DW_AT_const_value, Form, MO.getImm());
 682     return;
 683   }
 684   addUInt(Die, dwarf::DW_AT_const_value, Form, MO.getImm());
 685 }
 686
 687 /// addConstantFPValue - Add constant value entry in variable DIE.
 688 void CompileUnit::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
 689   assert (MO.isFPImm() && "Invalid machine operand!");
 690   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 691   APFloat FPImm = MO.getFPImm()->getValueAPF();
 692
 693   // Get the raw data form of the floating point.
 694   const APInt FltVal = FPImm.bitcastToAPInt();
 695   const char *FltPtr = (const char*)FltVal.getRawData();
 696
 697   int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
 698   bool LittleEndian = Asm->getDataLayout().isLittleEndian();
 699   int Incr = (LittleEndian ? 1 : -1);
 700   int Start = (LittleEndian ? 0 : NumBytes - 1);
 701   int Stop = (LittleEndian ? NumBytes : -1);
 702
 703   // Output the constant to DWARF one byte at a time.
 704   for (; Start != Stop; Start += Incr)
 705     addUInt(Block, 0, dwarf::DW_FORM_data1,
 706             (unsigned char)0xFF & FltPtr[Start]);
 707
 708   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
 709 }
 710
 711 /// addConstantFPValue - Add constant value entry in variable DIE.
 712 void CompileUnit::addConstantFPValue(DIE *Die, const ConstantFP *CFP) {
 713   // Pass this down to addConstantValue as an unsigned bag of bits.
 714   addConstantValue(Die, CFP->getValueAPF().bitcastToAPInt(), true);
 715 }
 716
 717 /// addConstantValue - Add constant value entry in variable DIE.
 718 void CompileUnit::addConstantValue(DIE *Die, const ConstantInt *CI,
 719                                    bool Unsigned) {
 720   addConstantValue(Die, CI->getValue(), Unsigned);
 721 }
 722
 723 // addConstantValue - Add constant value entry in variable DIE.
 724 void CompileUnit::addConstantValue(DIE *Die, const APInt &Val, bool Unsigned) {
 725   unsigned CIBitWidth = Val.getBitWidth();
 726   if (CIBitWidth <= 64) {
 727     // If we're a signed constant definitely use sdata.
 728     if (!Unsigned) {
 729       addSInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata,
 730               Val.getSExtValue());
 731       return;
 732     }
 733
 734     // Else use data for now unless it's larger than we can deal with.
 735     uint16_t Form;
 736     switch (CIBitWidth) {
 737     case 8:
 738       Form = dwarf::DW_FORM_data1;
 739       break;
 740     case 16:
 741       Form = dwarf::DW_FORM_data2;
 742       break;
 743     case 32:
 744       Form = dwarf::DW_FORM_data4;
 745       break;
 746     case 64:
 747       Form = dwarf::DW_FORM_data8;
 748       break;
 749     default:
 750       addUInt(Die, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
 751               Val.getZExtValue());
 752       return;
 753     }
 754     addUInt(Die, dwarf::DW_AT_const_value, Form, Val.getZExtValue());
 755     return;
 756   }
 757
 758   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 759
 760   // Get the raw data form of the large APInt.
 761   const uint64_t *Ptr64 = Val.getRawData();
 762
 763   int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
 764   bool LittleEndian = Asm->getDataLayout().isLittleEndian();
 765
 766   // Output the constant to DWARF one byte at a time.
 767   for (int i = 0; i < NumBytes; i++) {
 768     uint8_t c;
 769     if (LittleEndian)
 770       c = Ptr64[i / 8] >> (8 * (i & 7));
 771     else
 772       c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
 773     addUInt(Block, 0, dwarf::DW_FORM_data1, c);
 774   }
 775
 776   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
 777 }
 778
 779 /// addTemplateParams - Add template parameters into buffer.
 780 void CompileUnit::addTemplateParams(DIE &Buffer, DIArray TParams) {
 781   // Add template parameters.
 782   for (unsigned i = 0, e = TParams.getNumElements(); i != e; ++i) {
 783     DIDescriptor Element = TParams.getElement(i);
 784     if (Element.isTemplateTypeParameter())
 785       Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
 786                         DITemplateTypeParameter(Element)));
 787     else if (Element.isTemplateValueParameter())
 788       Buffer.addChild(getOrCreateTemplateValueParameterDIE(
 789                         DITemplateValueParameter(Element)));
 790   }
 791 }
 792
 793 /// getOrCreateContextDIE - Get context owner's DIE.
 794 DIE *CompileUnit::getOrCreateContextDIE(DIScope Context) {
 795   if (Context.isType())
 796     return getOrCreateTypeDIE(DIType(Context));
 797   else if (Context.isNameSpace())
 798     return getOrCreateNameSpace(DINameSpace(Context));
 799   else if (Context.isSubprogram())
 800     return getOrCreateSubprogramDIE(DISubprogram(Context));
 801   else
 802     return getDIE(Context);
 803 }
 804
 805 /// addToContextOwner - Add Die into the list of its context owner's children.
 806 void CompileUnit::addToContextOwner(DIE *Die, DIScope Context) {
 807   assert(!Die->getParent());
 808   if (DIE *ContextDIE = getOrCreateContextDIE(Context)) {
 809     if (Die->getParent()) {
 810       // While creating the context, if this is a type member, we will have
 811       // added the child to the context already.
 812       assert(Die->getParent() == ContextDIE);
 813       return;
 814     }
 815     ContextDIE->addChild(Die);
 816   } else
 817     addDie(Die);
 818 }
 819
 820 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
 821 /// given DIType.
 822 DIE *CompileUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
 823   DIType Ty(TyNode);
 824   if (!Ty.isType())
 825     return NULL;
 826   DIE *TyDIE = getDIE(Ty);
 827   if (TyDIE)
 828     return TyDIE;
 829
 830   // Create new type.
 831   TyDIE = new DIE(Ty.getTag());
 832   insertDIE(Ty, TyDIE);
 833   if (Ty.isBasicType())
 834     constructTypeDIE(*TyDIE, DIBasicType(Ty));
 835   else if (Ty.isCompositeType())
 836     constructTypeDIE(*TyDIE, DICompositeType(Ty));
 837   else {
 838     assert(Ty.isDerivedType() && "Unknown kind of DIType");
 839     constructTypeDIE(*TyDIE, DIDerivedType(Ty));
 840   }
 841   // If this is a named finished type then include it in the list of types
 842   // for the accelerator tables.
 843   if (!Ty.getName().empty() && !Ty.isForwardDecl()) {
 844     bool IsImplementation = 0;
 845     if (Ty.isCompositeType()) {
 846       DICompositeType CT(Ty);
 847       // A runtime language of 0 actually means C/C++ and that any
 848       // non-negative value is some version of Objective-C/C++.
 849       IsImplementation = (CT.getRunTimeLang() == 0) ||
 850         CT.isObjcClassComplete();
 851     }
 852     unsigned Flags = IsImplementation ? dwarf::DW_FLAG_type_implementation : 0;
 853     addAccelType(Ty.getName(), std::make_pair(TyDIE, Flags));
 854   }
 855
 856   addToContextOwner(TyDIE, resolve(Ty.getContext()));
 857   return TyDIE;
 858 }
 859
 860 /// addType - Add a new type attribute to the specified entity.
 861 void CompileUnit::addType(DIE *Entity, DIType Ty, uint16_t Attribute) {
 862   assert(Ty && "Trying to add a type that doesn't exist?");
 863
 864   // Check for pre-existence.
 865   DIEEntry *Entry = getDIEEntry(Ty);
 866   // If it exists then use the existing value.
 867   if (Entry) {
 868     Entity->addValue(Attribute, dwarf::DW_FORM_ref4, Entry);
 869     return;
 870   }
 871
 872   // Construct type.
 873   DIE *Buffer = getOrCreateTypeDIE(Ty);
 874
 875   // Set up proxy.
 876   Entry = createDIEEntry(Buffer);
 877   insertDIEEntry(Ty, Entry);
 878   Entity->addValue(Attribute, dwarf::DW_FORM_ref4, Entry);
 879
 880   // If this is a complete composite type then include it in the
 881   // list of global types.
 882   addGlobalType(Ty);
 883 }
 884
 885 // Accelerator table mutators - add each name along with its companion
 886 // DIE to the proper table while ensuring that the name that we're going
 887 // to reference is in the string table. We do this since the names we
 888 // add may not only be identical to the names in the DIE.
 889 void CompileUnit::addAccelName(StringRef Name, DIE *Die) {
 890   DU->getStringPoolEntry(Name);
 891   std::vector<DIE *> &DIEs = AccelNames[Name];
 892   DIEs.push_back(Die);
 893 }
 894
 895 void CompileUnit::addAccelObjC(StringRef Name, DIE *Die) {
 896   DU->getStringPoolEntry(Name);
 897   std::vector<DIE *> &DIEs = AccelObjC[Name];
 898   DIEs.push_back(Die);
 899 }
 900
 901 void CompileUnit::addAccelNamespace(StringRef Name, DIE *Die) {
 902   DU->getStringPoolEntry(Name);
 903   std::vector<DIE *> &DIEs = AccelNamespace[Name];
 904   DIEs.push_back(Die);
 905 }
 906
 907 void CompileUnit::addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die) {
 908   DU->getStringPoolEntry(Name);
 909   std::vector<std::pair<DIE *, unsigned> > &DIEs = AccelTypes[Name];
 910   DIEs.push_back(Die);
 911 }
 912
 913 /// addGlobalName - Add a new global name to the compile unit.
 914 void CompileUnit::addGlobalName(StringRef Name, DIE *Die) {
 915   GlobalNames[Name] = Die;
 916 }
 917
 918 /// addGlobalType - Add a new global type to the compile unit.
 919 ///
 920 void CompileUnit::addGlobalType(DIType Ty) {
 921   DIScope Context = resolve(Ty.getContext());
 922   if (!Ty.getName().empty() && !Ty.isForwardDecl() &&
 923       (!Context || Context.isCompileUnit() || Context.isFile() ||
 924        Context.isNameSpace()))
 925     if (DIEEntry *Entry = getDIEEntry(Ty))
 926       GlobalTypes[Ty.getName()] = Entry->getEntry();
 927 }
 928
 929 /// addPubTypes - Add subprogram argument types for pubtypes section.
 930 void CompileUnit::addPubTypes(DISubprogram SP) {
 931   DICompositeType SPTy = SP.getType();
 932   uint16_t SPTag = SPTy.getTag();
 933   if (SPTag != dwarf::DW_TAG_subroutine_type)
 934     return;
 935
 936   DIArray Args = SPTy.getTypeArray();
 937   for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
 938     DIType ATy(Args.getElement(i));
 939     if (!ATy.isType())
 940       continue;
 941     addGlobalType(ATy);
 942   }
 943 }
 944
 945 /// constructTypeDIE - Construct basic type die from DIBasicType.
 946 void CompileUnit::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
 947   // Get core information.
 948   StringRef Name = BTy.getName();
 949   // Add name if not anonymous or intermediate type.
 950   if (!Name.empty())
 951     addString(&Buffer, dwarf::DW_AT_name, Name);
 952
 953   // An unspecified type only has a name attribute.
 954   if (BTy.getTag() == dwarf::DW_TAG_unspecified_type)
 955     return;
 956
 957   addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
 958           BTy.getEncoding());
 959
 960   uint64_t Size = BTy.getSizeInBits() >> 3;
 961   addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
 962 }
 963
 964 /// constructTypeDIE - Construct derived type die from DIDerivedType.
 965 void CompileUnit::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
 966   // Get core information.
 967   StringRef Name = DTy.getName();
 968   uint64_t Size = DTy.getSizeInBits() >> 3;
 969   uint16_t Tag = Buffer.getTag();
 970
 971   // Map to main type, void will not have a type.
 972   DIType FromTy = resolve(DTy.getTypeDerivedFrom());
 973   if (FromTy)
 974     addType(&Buffer, FromTy);
 975
 976   // Add name if not anonymous or intermediate type.
 977   if (!Name.empty())
 978     addString(&Buffer, dwarf::DW_AT_name, Name);
 979
 980   // Add size if non-zero (derived types might be zero-sized.)
 981   if (Size && Tag != dwarf::DW_TAG_pointer_type)
 982     addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
 983
 984   if (Tag == dwarf::DW_TAG_ptr_to_member_type)
 985       addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
 986                   getOrCreateTypeDIE(resolve(DTy.getClassType())));
 987   // Add source line info if available and TyDesc is not a forward declaration.
 988   if (!DTy.isForwardDecl())
 989     addSourceLine(&Buffer, DTy);
 990 }
 991
 992 /// Return true if the type is appropriately scoped to be contained inside
 993 /// its own type unit.
 994 static bool isTypeUnitScoped(DIType Ty, const DwarfDebug *DD) {
 995   DIScope Parent = DD->resolve(Ty.getContext());
 996   while (Parent) {
 997     // Don't generate a hash for anything scoped inside a function.
 998     if (Parent.isSubprogram())
 999       return false;
1000     Parent = DD->resolve(Parent.getContext());
1001   }
1002   return true;
1003 }
1004
1005 /// Return true if the type should be split out into a type unit.
1006 static bool shouldCreateTypeUnit(DICompositeType CTy, const DwarfDebug *DD) {
1007   uint16_t Tag = CTy.getTag();
1008
1009   switch (Tag) {
1010   case dwarf::DW_TAG_structure_type:
1011   case dwarf::DW_TAG_union_type:
1012   case dwarf::DW_TAG_enumeration_type:
1013   case dwarf::DW_TAG_class_type:
1014     // If this is a class, structure, union, or enumeration type
1015     // that is a definition (not a declaration), and not scoped
1016     // inside a function then separate this out as a type unit.
1017     return !CTy.isForwardDecl() && isTypeUnitScoped(CTy, DD);
1018   default:
1019     return false;
1020   }
1021 }
1022
1023 /// constructTypeDIE - Construct type DIE from DICompositeType.
1024 void CompileUnit::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
1025   // Get core information.
1026   StringRef Name = CTy.getName();
1027
1028   uint64_t Size = CTy.getSizeInBits() >> 3;
1029   uint16_t Tag = Buffer.getTag();
1030
1031   switch (Tag) {
1032   case dwarf::DW_TAG_array_type:
1033     constructArrayTypeDIE(Buffer, &CTy);
1034     break;
1035   case dwarf::DW_TAG_enumeration_type: {
1036     DIArray Elements = CTy.getTypeArray();
1037
1038     // Add enumerators to enumeration type.
1039     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1040       DIE *ElemDie = NULL;
1041       DIDescriptor Enum(Elements.getElement(i));
1042       if (Enum.isEnumerator()) {
1043         ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
1044         Buffer.addChild(ElemDie);
1045       }
1046     }
1047     DIType DTy = resolve(CTy.getTypeDerivedFrom());
1048     if (DTy) {
1049       addType(&Buffer, DTy);
1050       addFlag(&Buffer, dwarf::DW_AT_enum_class);
1051     }
1052   }
1053     break;
1054   case dwarf::DW_TAG_subroutine_type: {
1055     // Add return type. A void return won't have a type.
1056     DIArray Elements = CTy.getTypeArray();
1057     DIDescriptor RTy = Elements.getElement(0);
1058     if (RTy)
1059       addType(&Buffer, DIType(RTy));
1060
1061     bool isPrototyped = true;
1062     // Add arguments.
1063     for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1064       DIDescriptor Ty = Elements.getElement(i);
1065       if (Ty.isUnspecifiedParameter()) {
1066         DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
1067         Buffer.addChild(Arg);
1068         isPrototyped = false;
1069       } else {
1070         DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1071         addType(Arg, DIType(Ty));
1072         if (DIType(Ty).isArtificial())
1073           addFlag(Arg, dwarf::DW_AT_artificial);
1074         Buffer.addChild(Arg);
1075       }
1076     }
1077     // Add prototype flag if we're dealing with a C language and the
1078     // function has been prototyped.
1079     uint16_t Language = DICompileUnit(Node).getLanguage();
1080     if (isPrototyped &&
1081         (Language == dwarf::DW_LANG_C89 ||
1082          Language == dwarf::DW_LANG_C99 ||
1083          Language == dwarf::DW_LANG_ObjC))
1084       addFlag(&Buffer, dwarf::DW_AT_prototyped);
1085   }
1086     break;
1087   case dwarf::DW_TAG_structure_type:
1088   case dwarf::DW_TAG_union_type:
1089   case dwarf::DW_TAG_class_type: {
1090     // Add elements to structure type.
1091     DIArray Elements = CTy.getTypeArray();
1092     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1093       DIDescriptor Element = Elements.getElement(i);
1094       DIE *ElemDie = NULL;
1095       if (Element.isSubprogram()) {
1096         DISubprogram SP(Element);
1097         ElemDie = getOrCreateSubprogramDIE(DISubprogram(Element));
1098         if (SP.isProtected())
1099           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1100                   dwarf::DW_ACCESS_protected);
1101         else if (SP.isPrivate())
1102           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1103                   dwarf::DW_ACCESS_private);
1104         else
1105           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1106             dwarf::DW_ACCESS_public);
1107         if (SP.isExplicit())
1108           addFlag(ElemDie, dwarf::DW_AT_explicit);
1109       } else if (Element.isDerivedType()) {
1110         DIDerivedType DDTy(Element);
1111         if (DDTy.getTag() == dwarf::DW_TAG_friend) {
1112           ElemDie = new DIE(dwarf::DW_TAG_friend);
1113           addType(ElemDie, resolve(DDTy.getTypeDerivedFrom()),
1114                   dwarf::DW_AT_friend);
1115         } else if (DDTy.isStaticMember())
1116           ElemDie = createStaticMemberDIE(DDTy);
1117         else
1118           ElemDie = createMemberDIE(DDTy);
1119         Buffer.addChild(ElemDie);
1120       } else if (Element.isObjCProperty()) {
1121         DIObjCProperty Property(Element);
1122         ElemDie = new DIE(Property.getTag());
1123         StringRef PropertyName = Property.getObjCPropertyName();
1124         addString(ElemDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
1125         addType(ElemDie, Property.getType());
1126         addSourceLine(ElemDie, Property);
1127         StringRef GetterName = Property.getObjCPropertyGetterName();
1128         if (!GetterName.empty())
1129           addString(ElemDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
1130         StringRef SetterName = Property.getObjCPropertySetterName();
1131         if (!SetterName.empty())
1132           addString(ElemDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
1133         unsigned PropertyAttributes = 0;
1134         if (Property.isReadOnlyObjCProperty())
1135           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readonly;
1136         if (Property.isReadWriteObjCProperty())
1137           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readwrite;
1138         if (Property.isAssignObjCProperty())
1139           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_assign;
1140         if (Property.isRetainObjCProperty())
1141           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_retain;
1142         if (Property.isCopyObjCProperty())
1143           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_copy;
1144         if (Property.isNonAtomicObjCProperty())
1145           PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_nonatomic;
1146         if (PropertyAttributes)
1147           addUInt(ElemDie, dwarf::DW_AT_APPLE_property_attribute, 0,
1148                  PropertyAttributes);
1149
1150         DIEEntry *Entry = getDIEEntry(Element);
1151         if (!Entry) {
1152           Entry = createDIEEntry(ElemDie);
1153           insertDIEEntry(Element, Entry);
1154         }
1155         Buffer.addChild(ElemDie);
1156       } else
1157         continue;
1158     }
1159
1160     if (CTy.isAppleBlockExtension())
1161       addFlag(&Buffer, dwarf::DW_AT_APPLE_block);
1162
1163     DICompositeType ContainingType(resolve(CTy.getContainingType()));
1164     if (DIDescriptor(ContainingType).isCompositeType())
1165       addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
1166                   getOrCreateTypeDIE(DIType(ContainingType)));
1167
1168     if (CTy.isObjcClassComplete())
1169       addFlag(&Buffer, dwarf::DW_AT_APPLE_objc_complete_type);
1170
1171     // Add template parameters to a class, structure or union types.
1172     // FIXME: The support isn't in the metadata for this yet.
1173     if (Tag == dwarf::DW_TAG_class_type ||
1174         Tag == dwarf::DW_TAG_structure_type ||
1175         Tag == dwarf::DW_TAG_union_type)
1176       addTemplateParams(Buffer, CTy.getTemplateParams());
1177
1178     break;
1179   }
1180   default:
1181     break;
1182   }
1183
1184   // Add name if not anonymous or intermediate type.
1185   if (!Name.empty())
1186     addString(&Buffer, dwarf::DW_AT_name, Name);
1187
1188   if (Tag == dwarf::DW_TAG_enumeration_type ||
1189       Tag == dwarf::DW_TAG_class_type ||
1190       Tag == dwarf::DW_TAG_structure_type ||
1191       Tag == dwarf::DW_TAG_union_type) {
1192     // Add size if non-zero (derived types might be zero-sized.)
1193     // TODO: Do we care about size for enum forward declarations?
1194     if (Size)
1195       addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
1196     else if (!CTy.isForwardDecl())
1197       // Add zero size if it is not a forward declaration.
1198       addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
1199
1200     // If we're a forward decl, say so.
1201     if (CTy.isForwardDecl())
1202       addFlag(&Buffer, dwarf::DW_AT_declaration);
1203
1204     // Add source line info if available.
1205     if (!CTy.isForwardDecl())
1206       addSourceLine(&Buffer, CTy);
1207
1208     // No harm in adding the runtime language to the declaration.
1209     unsigned RLang = CTy.getRunTimeLang();
1210     if (RLang)
1211       addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
1212               dwarf::DW_FORM_data1, RLang);
1213   }
1214   // If this is a type applicable to a type unit it then add it to the
1215   // list of types we'll compute a hash for later.
1216   if (shouldCreateTypeUnit(CTy, DD))
1217     DD->addTypeUnitType(&Buffer);
1218 }
1219
1220 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
1221 /// for the given DITemplateTypeParameter.
1222 DIE *
1223 CompileUnit::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
1224   DIE *ParamDIE = getDIE(TP);
1225   if (ParamDIE)
1226     return ParamDIE;
1227
1228   ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
1229   // Add the type if it exists, it could be void and therefore no type.
1230   if (TP.getType())
1231     addType(ParamDIE, resolve(TP.getType()));
1232   if (!TP.getName().empty())
1233     addString(ParamDIE, dwarf::DW_AT_name, TP.getName());
1234   return ParamDIE;
1235 }
1236
1237 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
1238 /// for the given DITemplateValueParameter.
1239 DIE *
1240 CompileUnit::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter VP) {
1241   DIE *ParamDIE = getDIE(VP);
1242   if (ParamDIE)
1243     return ParamDIE;
1244
1245   ParamDIE = new DIE(VP.getTag());
1246
1247   // Add the type if there is one, template template and template parameter
1248   // packs will not have a type.
1249   if (VP.getType())
1250     addType(ParamDIE, resolve(VP.getType()));
1251   if (!VP.getName().empty())
1252     addString(ParamDIE, dwarf::DW_AT_name, VP.getName());
1253   if (Value *Val = VP.getValue()) {
1254     if (ConstantInt *CI = dyn_cast<ConstantInt>(Val))
1255       addConstantValue(ParamDIE, CI,
1256                        isUnsignedDIType(DD, resolve(VP.getType())));
1257     else if (GlobalValue *GV = dyn_cast<GlobalValue>(Val)) {
1258       // For declaration non-type template parameters (such as global values and
1259       // functions)
1260       DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1261       addOpAddress(Block, Asm->Mang->getSymbol(GV));
1262       // Emit DW_OP_stack_value to use the address as the immediate value of the
1263       // parameter, rather than a pointer to it.
1264       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_stack_value);
1265       addBlock(ParamDIE, dwarf::DW_AT_location, 0, Block);
1266     } else if (VP.getTag() == dwarf::DW_TAG_GNU_template_template_param) {
1267       assert(isa<MDString>(Val));
1268       addString(ParamDIE, dwarf::DW_AT_GNU_template_name,
1269                 cast<MDString>(Val)->getString());
1270     } else if (VP.getTag() == dwarf::DW_TAG_GNU_template_parameter_pack) {
1271       assert(isa<MDNode>(Val));
1272       DIArray A(cast<MDNode>(Val));
1273       addTemplateParams(*ParamDIE, A);
1274     }
1275   }
1276
1277   return ParamDIE;
1278 }
1279
1280 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
1281 DIE *CompileUnit::getOrCreateNameSpace(DINameSpace NS) {
1282   DIE *NDie = getDIE(NS);
1283   if (NDie)
1284     return NDie;
1285   NDie = new DIE(dwarf::DW_TAG_namespace);
1286   insertDIE(NS, NDie);
1287   if (!NS.getName().empty()) {
1288     addString(NDie, dwarf::DW_AT_name, NS.getName());
1289     addAccelNamespace(NS.getName(), NDie);
1290     addGlobalName(NS.getName(), NDie);
1291   } else
1292     addAccelNamespace("(anonymous namespace)", NDie);
1293   addSourceLine(NDie, NS);
1294   addToContextOwner(NDie, NS.getContext());
1295   return NDie;
1296 }
1297
1298 /// getOrCreateSubprogramDIE - Create new DIE using SP.
1299 DIE *CompileUnit::getOrCreateSubprogramDIE(DISubprogram SP) {
1300   // Construct the context before querying for the existence of the DIE in case
1301   // such construction creates the DIE (as is the case for member function
1302   // declarations).
1303   DIE *ContextDIE = getOrCreateContextDIE(resolve(SP.getContext()));
1304   if (!ContextDIE)
1305     ContextDIE = CUDie.get();
1306
1307   DIE *SPDie = getDIE(SP);
1308   if (SPDie)
1309     return SPDie;
1310
1311   SPDie = new DIE(dwarf::DW_TAG_subprogram);
1312
1313   // DW_TAG_inlined_subroutine may refer to this DIE.
1314   insertDIE(SP, SPDie);
1315
1316   DISubprogram SPDecl = SP.getFunctionDeclaration();
1317   DIE *DeclDie = NULL;
1318   if (SPDecl.isSubprogram()) {
1319     DeclDie = getOrCreateSubprogramDIE(SPDecl);
1320   }
1321
1322   // Add to context owner.
1323   ContextDIE->addChild(SPDie);
1324
1325   // Add function template parameters.
1326   addTemplateParams(*SPDie, SP.getTemplateParams());
1327
1328   // If this DIE is going to refer declaration info using AT_specification
1329   // then there is no need to add other attributes.
1330   if (DeclDie) {
1331     // Refer function declaration directly.
1332     addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
1333                 DeclDie);
1334
1335     return SPDie;
1336   }
1337
1338   // Add the linkage name if we have one.
1339   StringRef LinkageName = SP.getLinkageName();
1340   if (!LinkageName.empty())
1341     addString(SPDie, dwarf::DW_AT_MIPS_linkage_name,
1342               GlobalValue::getRealLinkageName(LinkageName));
1343
1344   // Constructors and operators for anonymous aggregates do not have names.
1345   if (!SP.getName().empty())
1346     addString(SPDie, dwarf::DW_AT_name, SP.getName());
1347
1348   addSourceLine(SPDie, SP);
1349
1350   // Add the prototype if we have a prototype and we have a C like
1351   // language.
1352   uint16_t Language = DICompileUnit(Node).getLanguage();
1353   if (SP.isPrototyped() &&
1354       (Language == dwarf::DW_LANG_C89 ||
1355        Language == dwarf::DW_LANG_C99 ||
1356        Language == dwarf::DW_LANG_ObjC))
1357     addFlag(SPDie, dwarf::DW_AT_prototyped);
1358
1359   // Add Return Type. A void return type will not have a type.
1360   DICompositeType SPTy = SP.getType();
1361   assert(SPTy.getTag() == dwarf::DW_TAG_subroutine_type &&
1362          "the type of a subprogram should be a subroutine");
1363
1364   DIArray Args = SPTy.getTypeArray();
1365   if (Args.getElement(0))
1366     addType(SPDie, DIType(Args.getElement(0)));
1367
1368   unsigned VK = SP.getVirtuality();
1369   if (VK) {
1370     addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1, VK);
1371     DIEBlock *Block = getDIEBlock();
1372     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1373     addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
1374     addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
1375     ContainingTypeMap.insert(std::make_pair(SPDie,
1376                                             resolve(SP.getContainingType())));
1377   }
1378
1379   if (!SP.isDefinition()) {
1380     addFlag(SPDie, dwarf::DW_AT_declaration);
1381
1382     // Add arguments. Do not add arguments for subprogram definition. They will
1383     // be handled while processing variables.
1384     for (unsigned i = 1, N =  Args.getNumElements(); i < N; ++i) {
1385       DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
1386       DIType ATy = DIType(Args.getElement(i));
1387       addType(Arg, ATy);
1388       if (ATy.isArtificial())
1389         addFlag(Arg, dwarf::DW_AT_artificial);
1390       SPDie->addChild(Arg);
1391     }
1392   }
1393
1394   if (SP.isArtificial())
1395     addFlag(SPDie, dwarf::DW_AT_artificial);
1396
1397   if (!SP.isLocalToUnit())
1398     addFlag(SPDie, dwarf::DW_AT_external);
1399
1400   if (SP.isOptimized())
1401     addFlag(SPDie, dwarf::DW_AT_APPLE_optimized);
1402
1403   if (unsigned isa = Asm->getISAEncoding()) {
1404     addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1405   }
1406
1407   return SPDie;
1408 }
1409
1410 // Return const expression if value is a GEP to access merged global
1411 // constant. e.g.
1412 // i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1413 static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1414   const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1415   if (!CE || CE->getNumOperands() != 3 ||
1416       CE->getOpcode() != Instruction::GetElementPtr)
1417     return NULL;
1418
1419   // First operand points to a global struct.
1420   Value *Ptr = CE->getOperand(0);
1421   if (!isa<GlobalValue>(Ptr) ||
1422       !isa<StructType>(cast<PointerType>(Ptr->getType())->getElementType()))
1423     return NULL;
1424
1425   // Second operand is zero.
1426   const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
1427   if (!CI || !CI->isZero())
1428     return NULL;
1429
1430   // Third operand is offset.
1431   if (!isa<ConstantInt>(CE->getOperand(2)))
1432     return NULL;
1433
1434   return CE;
1435 }
1436
1437 /// createGlobalVariableDIE - create global variable DIE.
1438 void CompileUnit::createGlobalVariableDIE(const MDNode *N) {
1439   // Check for pre-existence.
1440   if (getDIE(N))
1441     return;
1442
1443   DIGlobalVariable GV(N);
1444   if (!GV.isGlobalVariable())
1445     return;
1446
1447   DIScope GVContext = GV.getContext();
1448   DIType GTy = GV.getType();
1449
1450   // If this is a static data member definition, some attributes belong
1451   // to the declaration DIE.
1452   DIE *VariableDIE = NULL;
1453   bool IsStaticMember = false;
1454   DIDerivedType SDMDecl = GV.getStaticDataMemberDeclaration();
1455   if (SDMDecl.Verify()) {
1456     assert(SDMDecl.isStaticMember() && "Expected static member decl");
1457     // We need the declaration DIE that is in the static member's class.
1458     // But that class might not exist in the DWARF yet.
1459     // Creating the class will create the static member decl DIE.
1460     getOrCreateContextDIE(resolve(SDMDecl.getContext()));
1461     VariableDIE = getDIE(SDMDecl);
1462     assert(VariableDIE && "Static member decl has no context?");
1463     IsStaticMember = true;
1464   }
1465
1466   // If this is not a static data member definition, create the variable
1467   // DIE and add the initial set of attributes to it.
1468   if (!VariableDIE) {
1469     VariableDIE = new DIE(GV.getTag());
1470     // Add to map.
1471     insertDIE(N, VariableDIE);
1472
1473     // Add name and type.
1474     addString(VariableDIE, dwarf::DW_AT_name, GV.getDisplayName());
1475     addType(VariableDIE, GTy);
1476
1477     // Add scoping info.
1478     if (!GV.isLocalToUnit()) {
1479       addFlag(VariableDIE, dwarf::DW_AT_external);
1480       addGlobalName(GV.getName(), VariableDIE);
1481     }
1482
1483     // Add line number info.
1484     addSourceLine(VariableDIE, GV);
1485     // Add to context owner.
1486     addToContextOwner(VariableDIE, GVContext);
1487   }
1488
1489   // Add location.
1490   bool addToAccelTable = false;
1491   DIE *VariableSpecDIE = NULL;
1492   bool isGlobalVariable = GV.getGlobal() != NULL;
1493   if (isGlobalVariable) {
1494     addToAccelTable = true;
1495     DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1496     const MCSymbol *Sym = Asm->Mang->getSymbol(GV.getGlobal());
1497     if (GV.getGlobal()->isThreadLocal()) {
1498       // FIXME: Make this work with -gsplit-dwarf.
1499       unsigned PointerSize = Asm->getDataLayout().getPointerSize();
1500       assert((PointerSize == 4 || PointerSize == 8) &&
1501              "Add support for other sizes if necessary");
1502       const MCExpr *Expr =
1503           Asm->getObjFileLowering().getDebugThreadLocalSymbol(Sym);
1504       // Based on GCC's support for TLS:
1505       if (!DD->useSplitDwarf()) {
1506         // 1) Start with a constNu of the appropriate pointer size
1507         addUInt(Block, 0, dwarf::DW_FORM_data1,
1508                 PointerSize == 4 ? dwarf::DW_OP_const4u : dwarf::DW_OP_const8u);
1509         // 2) containing the (relocated) offset of the TLS variable
1510         //    within the module's TLS block.
1511         addExpr(Block, 0, dwarf::DW_FORM_udata, Expr);
1512       } else {
1513         addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_const_index);
1514         addUInt(Block, 0, dwarf::DW_FORM_udata, DU->getAddrPoolIndex(Expr));
1515       }
1516       // 3) followed by a custom OP to make the debugger do a TLS lookup.
1517       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_GNU_push_tls_address);
1518     } else
1519       addOpAddress(Block, Sym);
1520     // Do not create specification DIE if context is either compile unit
1521     // or a subprogram.
1522     if (GVContext && GV.isDefinition() && !GVContext.isCompileUnit() &&
1523         !GVContext.isFile() && !DD->isSubprogramContext(GVContext)) {
1524       // Create specification DIE.
1525       VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1526       addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1527                   dwarf::DW_FORM_ref4, VariableDIE);
1528       addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1529       // A static member's declaration is already flagged as such.
1530       if (!SDMDecl.Verify())
1531         addFlag(VariableDIE, dwarf::DW_AT_declaration);
1532       addDie(VariableSpecDIE);
1533     } else {
1534       addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1535     }
1536     // Add the linkage name.
1537     StringRef LinkageName = GV.getLinkageName();
1538     if (!LinkageName.empty())
1539       // From DWARF4: DIEs to which DW_AT_linkage_name may apply include:
1540       // TAG_common_block, TAG_constant, TAG_entry_point, TAG_subprogram and
1541       // TAG_variable.
1542       addString(IsStaticMember && VariableSpecDIE ?
1543                 VariableSpecDIE : VariableDIE, dwarf::DW_AT_MIPS_linkage_name,
1544                 GlobalValue::getRealLinkageName(LinkageName));
1545   } else if (const ConstantInt *CI =
1546              dyn_cast_or_null<ConstantInt>(GV.getConstant())) {
1547     // AT_const_value was added when the static member was created. To avoid
1548     // emitting AT_const_value multiple times, we only add AT_const_value when
1549     // it is not a static member.
1550     if (!IsStaticMember)
1551       addConstantValue(VariableDIE, CI, isUnsignedDIType(DD, GTy));
1552   } else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
1553     addToAccelTable = true;
1554     // GV is a merged global.
1555     DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1556     Value *Ptr = CE->getOperand(0);
1557     addOpAddress(Block, Asm->Mang->getSymbol(cast<GlobalValue>(Ptr)));
1558     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1559     SmallVector<Value*, 3> Idx(CE->op_begin()+1, CE->op_end());
1560     addUInt(Block, 0, dwarf::DW_FORM_udata,
1561                    Asm->getDataLayout().getIndexedOffset(Ptr->getType(), Idx));
1562     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1563     addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1564   }
1565
1566   if (addToAccelTable) {
1567     DIE *AddrDIE = VariableSpecDIE ? VariableSpecDIE : VariableDIE;
1568     addAccelName(GV.getName(), AddrDIE);
1569
1570     // If the linkage name is different than the name, go ahead and output
1571     // that as well into the name table.
1572     if (GV.getLinkageName() != "" && GV.getName() != GV.getLinkageName())
1573       addAccelName(GV.getLinkageName(), AddrDIE);
1574   }
1575 }
1576
1577 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1578 void CompileUnit::constructSubrangeDIE(DIE &Buffer, DISubrange SR,
1579                                        DIE *IndexTy) {
1580   DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1581   addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
1582
1583   // The LowerBound value defines the lower bounds which is typically zero for
1584   // C/C++. The Count value is the number of elements.  Values are 64 bit. If
1585   // Count == -1 then the array is unbounded and we do not emit
1586   // DW_AT_lower_bound and DW_AT_upper_bound attributes. If LowerBound == 0 and
1587   // Count == 0, then the array has zero elements in which case we do not emit
1588   // an upper bound.
1589   int64_t LowerBound = SR.getLo();
1590   int64_t DefaultLowerBound = getDefaultLowerBound();
1591   int64_t Count = SR.getCount();
1592
1593   if (DefaultLowerBound == -1 || LowerBound != DefaultLowerBound)
1594     addUInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, LowerBound);
1595
1596   if (Count != -1 && Count != 0)
1597     // FIXME: An unbounded array should reference the expression that defines
1598     // the array.
1599     addUInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, LowerBound + Count - 1);
1600
1601   Buffer.addChild(DW_Subrange);
1602 }
1603
1604 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
1605 void CompileUnit::constructArrayTypeDIE(DIE &Buffer,
1606                                         DICompositeType *CTy) {
1607   if (CTy->isVector())
1608     addFlag(&Buffer, dwarf::DW_AT_GNU_vector);
1609
1610   // Emit the element type.
1611   addType(&Buffer, resolve(CTy->getTypeDerivedFrom()));
1612
1613   // Get an anonymous type for index type.
1614   // FIXME: This type should be passed down from the front end
1615   // as different languages may have different sizes for indexes.
1616   DIE *IdxTy = getIndexTyDie();
1617   if (!IdxTy) {
1618     // Construct an anonymous type for index type.
1619     IdxTy = new DIE(dwarf::DW_TAG_base_type);
1620     addString(IdxTy, dwarf::DW_AT_name, "int");
1621     addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1622     addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1623             dwarf::DW_ATE_signed);
1624     addDie(IdxTy);
1625     setIndexTyDie(IdxTy);
1626   }
1627
1628   // Add subranges to array type.
1629   DIArray Elements = CTy->getTypeArray();
1630   for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1631     DIDescriptor Element = Elements.getElement(i);
1632     if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1633       constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
1634   }
1635 }
1636
1637 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1638 DIE *CompileUnit::constructEnumTypeDIE(DIEnumerator ETy) {
1639   DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
1640   StringRef Name = ETy.getName();
1641   addString(Enumerator, dwarf::DW_AT_name, Name);
1642   int64_t Value = ETy.getEnumValue();
1643   addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
1644   return Enumerator;
1645 }
1646
1647 /// constructContainingTypeDIEs - Construct DIEs for types that contain
1648 /// vtables.
1649 void CompileUnit::constructContainingTypeDIEs() {
1650   for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
1651          CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1652     DIE *SPDie = CI->first;
1653     const MDNode *N = CI->second;
1654     if (!N) continue;
1655     DIE *NDie = getDIE(N);
1656     if (!NDie) continue;
1657     addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1658   }
1659 }
1660
1661 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
1662 DIE *CompileUnit::constructVariableDIE(DbgVariable *DV,
1663                                        bool isScopeAbstract) {
1664   StringRef Name = DV->getName();
1665
1666   // Define variable debug information entry.
1667   DIE *VariableDie = new DIE(DV->getTag());
1668   DbgVariable *AbsVar = DV->getAbstractVariable();
1669   DIE *AbsDIE = AbsVar ? AbsVar->getDIE() : NULL;
1670   if (AbsDIE)
1671     addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
1672                             dwarf::DW_FORM_ref4, AbsDIE);
1673   else {
1674     if (!Name.empty())
1675       addString(VariableDie, dwarf::DW_AT_name, Name);
1676     addSourceLine(VariableDie, DV->getVariable());
1677     addType(VariableDie, DV->getType());
1678   }
1679
1680   if (DV->isArtificial())
1681     addFlag(VariableDie, dwarf::DW_AT_artificial);
1682
1683   if (isScopeAbstract) {
1684     DV->setDIE(VariableDie);
1685     return VariableDie;
1686   }
1687
1688   // Add variable address.
1689
1690   unsigned Offset = DV->getDotDebugLocOffset();
1691   if (Offset != ~0U) {
1692     addLabel(VariableDie, dwarf::DW_AT_location, dwarf::DW_FORM_data4,
1693              Asm->GetTempSymbol("debug_loc", Offset));
1694     DV->setDIE(VariableDie);
1695     return VariableDie;
1696   }
1697
1698   // Check if variable is described by a DBG_VALUE instruction.
1699   if (const MachineInstr *DVInsn = DV->getMInsn()) {
1700     assert(DVInsn->getNumOperands() == 3);
1701     if (DVInsn->getOperand(0).isReg()) {
1702       const MachineOperand RegOp = DVInsn->getOperand(0);
1703       // If the second operand is an immediate, this is an indirect value.
1704       if (DVInsn->getOperand(1).isImm()) {
1705         MachineLocation Location(RegOp.getReg(), DVInsn->getOperand(1).getImm());
1706         addVariableAddress(*DV, VariableDie, Location);
1707       } else if (RegOp.getReg())
1708         addVariableAddress(*DV, VariableDie, MachineLocation(RegOp.getReg()));
1709     } else if (DVInsn->getOperand(0).isImm())
1710       addConstantValue(VariableDie, DVInsn->getOperand(0), DV->getType());
1711     else if (DVInsn->getOperand(0).isFPImm())
1712       addConstantFPValue(VariableDie, DVInsn->getOperand(0));
1713     else if (DVInsn->getOperand(0).isCImm())
1714       addConstantValue(VariableDie, DVInsn->getOperand(0).getCImm(),
1715                        isUnsignedDIType(DD, DV->getType()));
1716
1717     DV->setDIE(VariableDie);
1718     return VariableDie;
1719   } else {
1720     // .. else use frame index.
1721     int FI = DV->getFrameIndex();
1722     if (FI != ~0) {
1723       unsigned FrameReg = 0;
1724       const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
1725       int Offset =
1726         TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1727       MachineLocation Location(FrameReg, Offset);
1728       addVariableAddress(*DV, VariableDie, Location);
1729     }
1730   }
1731
1732   DV->setDIE(VariableDie);
1733   return VariableDie;
1734 }
1735
1736 /// createMemberDIE - Create new member DIE.
1737 DIE *CompileUnit::createMemberDIE(DIDerivedType DT) {
1738   DIE *MemberDie = new DIE(DT.getTag());
1739   StringRef Name = DT.getName();
1740   if (!Name.empty())
1741     addString(MemberDie, dwarf::DW_AT_name, Name);
1742
1743   addType(MemberDie, resolve(DT.getTypeDerivedFrom()));
1744
1745   addSourceLine(MemberDie, DT);
1746
1747   DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
1748   addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1749
1750   uint64_t Size = DT.getSizeInBits();
1751   uint64_t FieldSize = getBaseTypeSize(DD, DT);
1752
1753   if (Size != FieldSize) {
1754     // Handle bitfield.
1755     addUInt(MemberDie, dwarf::DW_AT_byte_size, 0,
1756             getBaseTypeSize(DD, DT)>>3);
1757     addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
1758
1759     uint64_t Offset = DT.getOffsetInBits();
1760     uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1761     uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1762     uint64_t FieldOffset = (HiMark - FieldSize);
1763     Offset -= FieldOffset;
1764
1765     // Maybe we need to work from the other end.
1766     if (Asm->getDataLayout().isLittleEndian())
1767       Offset = FieldSize - (Offset + Size);
1768     addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
1769
1770     // Here WD_AT_data_member_location points to the anonymous
1771     // field that includes this bit field.
1772     addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
1773
1774   } else
1775     // This is not a bitfield.
1776     addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
1777
1778   if (DT.getTag() == dwarf::DW_TAG_inheritance
1779       && DT.isVirtual()) {
1780
1781     // For C++, virtual base classes are not at fixed offset. Use following
1782     // expression to extract appropriate offset from vtable.
1783     // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1784
1785     DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
1786     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1787     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1788     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1789     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1790     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1791     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1792     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1793
1794     addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
1795              VBaseLocationDie);
1796   } else
1797     addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
1798
1799   if (DT.isProtected())
1800     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1801             dwarf::DW_ACCESS_protected);
1802   else if (DT.isPrivate())
1803     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1804             dwarf::DW_ACCESS_private);
1805   // Otherwise C++ member and base classes are considered public.
1806   else
1807     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1808             dwarf::DW_ACCESS_public);
1809   if (DT.isVirtual())
1810     addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_data1,
1811             dwarf::DW_VIRTUALITY_virtual);
1812
1813   // Objective-C properties.
1814   if (MDNode *PNode = DT.getObjCProperty())
1815     if (DIEEntry *PropertyDie = getDIEEntry(PNode))
1816       MemberDie->addValue(dwarf::DW_AT_APPLE_property, dwarf::DW_FORM_ref4,
1817                           PropertyDie);
1818
1819   if (DT.isArtificial())
1820     addFlag(MemberDie, dwarf::DW_AT_artificial);
1821
1822   return MemberDie;
1823 }
1824
1825 /// createStaticMemberDIE - Create new DIE for C++ static member.
1826 DIE *CompileUnit::createStaticMemberDIE(const DIDerivedType DT) {
1827   if (!DT.Verify())
1828     return NULL;
1829
1830   DIE *StaticMemberDIE = new DIE(DT.getTag());
1831   DIType Ty = resolve(DT.getTypeDerivedFrom());
1832
1833   addString(StaticMemberDIE, dwarf::DW_AT_name, DT.getName());
1834   addType(StaticMemberDIE, Ty);
1835   addSourceLine(StaticMemberDIE, DT);
1836   addFlag(StaticMemberDIE, dwarf::DW_AT_external);
1837   addFlag(StaticMemberDIE, dwarf::DW_AT_declaration);
1838
1839   // FIXME: We could omit private if the parent is a class_type, and
1840   // public if the parent is something else.
1841   if (DT.isProtected())
1842     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1843             dwarf::DW_ACCESS_protected);
1844   else if (DT.isPrivate())
1845     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1846             dwarf::DW_ACCESS_private);
1847   else
1848     addUInt(StaticMemberDIE, dwarf::DW_AT_accessibility, dwarf::DW_FORM_data1,
1849             dwarf::DW_ACCESS_public);
1850
1851   if (const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(DT.getConstant()))
1852     addConstantValue(StaticMemberDIE, CI, isUnsignedDIType(DD, Ty));
1853   if (const ConstantFP *CFP = dyn_cast_or_null<ConstantFP>(DT.getConstant()))
1854     addConstantFPValue(StaticMemberDIE, CFP);
1855
1856   insertDIE(DT, StaticMemberDIE);
1857   return StaticMemberDIE;
1858 }