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