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 writing dwarf compile unit.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #define DEBUG_TYPE "dwarfdebug"
  15
  16 #include "DwarfCompileUnit.h"
  17 #include "DwarfDebug.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/GlobalVariable.h"
  20 #include "llvm/Instructions.h"
  21 #include "llvm/Analysis/DIBuilder.h"
  22 #include "llvm/Target/Mangler.h"
  23 #include "llvm/Target/TargetData.h"
  24 #include "llvm/Target/TargetFrameLowering.h"
  25 #include "llvm/Target/TargetMachine.h"
  26 #include "llvm/Target/TargetRegisterInfo.h"
  27 #include "llvm/ADT/APFloat.h"
  28 #include "llvm/Support/ErrorHandling.h"
  29
  30 using namespace llvm;
  31
  32 /// CompileUnit - Compile unit constructor.
  33 CompileUnit::CompileUnit(unsigned I, DIE *D, AsmPrinter *A, DwarfDebug *DW)
  34   : ID(I), CUDie(D), Asm(A), DD(DW), IndexTyDie(0) {
  35   DIEIntegerOne = new (DIEValueAllocator) DIEInteger(1);
  36 }
  37
  38 /// ~CompileUnit - Destructor for compile unit.
  39 CompileUnit::~CompileUnit() {
  40   for (unsigned j = 0, M = DIEBlocks.size(); j < M; ++j)
  41     DIEBlocks[j]->~DIEBlock();
  42 }
  43
  44 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
  45 /// information entry.
  46 DIEEntry *CompileUnit::createDIEEntry(DIE *Entry) {
  47   DIEEntry *Value = new (DIEValueAllocator) DIEEntry(Entry);
  48   return Value;
  49 }
  50
  51 /// addUInt - Add an unsigned integer attribute data and value.
  52 ///
  53 void CompileUnit::addUInt(DIE *Die, unsigned Attribute,
  54                           unsigned Form, uint64_t Integer) {
  55   if (!Form) Form = DIEInteger::BestForm(false, Integer);
  56   DIEValue *Value = Integer == 1 ?
  57     DIEIntegerOne : new (DIEValueAllocator) DIEInteger(Integer);
  58   Die->addValue(Attribute, Form, Value);
  59 }
  60
  61 /// addSInt - Add an signed integer attribute data and value.
  62 ///
  63 void CompileUnit::addSInt(DIE *Die, unsigned Attribute,
  64                           unsigned Form, int64_t Integer) {
  65   if (!Form) Form = DIEInteger::BestForm(true, Integer);
  66   DIEValue *Value = new (DIEValueAllocator) DIEInteger(Integer);
  67   Die->addValue(Attribute, Form, Value);
  68 }
  69
  70 /// addString - Add a string attribute data and value. We always emit a
  71 /// reference to the string pool instead of immediate strings so that DIEs have
  72 /// more predictable sizes.
  73 void CompileUnit::addString(DIE *Die, unsigned Attribute, StringRef String) {
  74   MCSymbol *Symb = DD->getStringPoolEntry(String);
  75   DIEValue *Value;
  76   if (Asm->needsRelocationsForDwarfStringPool())
  77     Value = new (DIEValueAllocator) DIELabel(Symb);
  78   else {
  79     MCSymbol *StringPool = DD->getStringPool();
  80     Value = new (DIEValueAllocator) DIEDelta(Symb, StringPool);
  81   }
  82   Die->addValue(Attribute, dwarf::DW_FORM_strp, Value);
  83 }
  84
  85 /// addLabel - Add a Dwarf label attribute data and value.
  86 ///
  87 void CompileUnit::addLabel(DIE *Die, unsigned Attribute, unsigned Form,
  88                            const MCSymbol *Label) {
  89   DIEValue *Value = new (DIEValueAllocator) DIELabel(Label);
  90   Die->addValue(Attribute, Form, Value);
  91 }
  92
  93 /// addDelta - Add a label delta attribute data and value.
  94 ///
  95 void CompileUnit::addDelta(DIE *Die, unsigned Attribute, unsigned Form,
  96                            const MCSymbol *Hi, const MCSymbol *Lo) {
  97   DIEValue *Value = new (DIEValueAllocator) DIEDelta(Hi, Lo);
  98   Die->addValue(Attribute, Form, Value);
  99 }
 100
 101 /// addDIEEntry - Add a DIE attribute data and value.
 102 ///
 103 void CompileUnit::addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form,
 104                               DIE *Entry) {
 105   Die->addValue(Attribute, Form, createDIEEntry(Entry));
 106 }
 107
 108 /// addBlock - Add block data.
 109 ///
 110 void CompileUnit::addBlock(DIE *Die, unsigned Attribute, unsigned Form,
 111                            DIEBlock *Block) {
 112   Block->ComputeSize(Asm);
 113   DIEBlocks.push_back(Block); // Memoize so we can call the destructor later on.
 114   Die->addValue(Attribute, Block->BestForm(), Block);
 115 }
 116
 117 /// addSourceLine - Add location information to specified debug information
 118 /// entry.
 119 void CompileUnit::addSourceLine(DIE *Die, DIVariable V) {
 120   // Verify variable.
 121   if (!V.Verify())
 122     return;
 123
 124   unsigned Line = V.getLineNumber();
 125   if (Line == 0)
 126     return;
 127   unsigned FileID = DD->GetOrCreateSourceID(V.getContext().getFilename(),
 128                                             V.getContext().getDirectory());
 129   assert(FileID && "Invalid file id");
 130   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 131   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 132 }
 133
 134 /// addSourceLine - Add location information to specified debug information
 135 /// entry.
 136 void CompileUnit::addSourceLine(DIE *Die, DIGlobalVariable G) {
 137   // Verify global variable.
 138   if (!G.Verify())
 139     return;
 140
 141   unsigned Line = G.getLineNumber();
 142   if (Line == 0)
 143     return;
 144   unsigned FileID = DD->GetOrCreateSourceID(G.getFilename(), G.getDirectory());
 145   assert(FileID && "Invalid file id");
 146   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 147   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 148 }
 149
 150 /// addSourceLine - Add location information to specified debug information
 151 /// entry.
 152 void CompileUnit::addSourceLine(DIE *Die, DISubprogram SP) {
 153   // Verify subprogram.
 154   if (!SP.Verify())
 155     return;
 156   // If the line number is 0, don't add it.
 157   if (SP.getLineNumber() == 0)
 158     return;
 159
 160   unsigned Line = SP.getLineNumber();
 161   if (!SP.getContext().Verify())
 162     return;
 163   unsigned FileID = DD->GetOrCreateSourceID(SP.getFilename(),
 164                                             SP.getDirectory());
 165   assert(FileID && "Invalid file id");
 166   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 167   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 168 }
 169
 170 /// addSourceLine - Add location information to specified debug information
 171 /// entry.
 172 void CompileUnit::addSourceLine(DIE *Die, DIType Ty) {
 173   // Verify type.
 174   if (!Ty.Verify())
 175     return;
 176
 177   unsigned Line = Ty.getLineNumber();
 178   if (Line == 0 || !Ty.getContext().Verify())
 179     return;
 180   unsigned FileID = DD->GetOrCreateSourceID(Ty.getFilename(),
 181                                             Ty.getDirectory());
 182   assert(FileID && "Invalid file id");
 183   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 184   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 185 }
 186
 187 /// addSourceLine - Add location information to specified debug information
 188 /// entry.
 189 void CompileUnit::addSourceLine(DIE *Die, DINameSpace NS) {
 190   // Verify namespace.
 191   if (!NS.Verify())
 192     return;
 193
 194   unsigned Line = NS.getLineNumber();
 195   if (Line == 0)
 196     return;
 197   StringRef FN = NS.getFilename();
 198
 199   unsigned FileID = DD->GetOrCreateSourceID(FN, NS.getDirectory());
 200   assert(FileID && "Invalid file id");
 201   addUInt(Die, dwarf::DW_AT_decl_file, 0, FileID);
 202   addUInt(Die, dwarf::DW_AT_decl_line, 0, Line);
 203 }
 204
 205 /// addVariableAddress - Add DW_AT_location attribute for a
 206 /// DbgVariable based on provided MachineLocation.
 207 void CompileUnit::addVariableAddress(DbgVariable *&DV, DIE *Die,
 208                                      MachineLocation Location) {
 209   if (DV->variableHasComplexAddress())
 210     addComplexAddress(DV, Die, dwarf::DW_AT_location, Location);
 211   else if (DV->isBlockByrefVariable())
 212     addBlockByrefAddress(DV, Die, dwarf::DW_AT_location, Location);
 213   else
 214     addAddress(Die, dwarf::DW_AT_location, Location);
 215 }
 216
 217 /// addRegisterOp - Add register operand.
 218 void CompileUnit::addRegisterOp(DIE *TheDie, unsigned Reg) {
 219   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
 220   unsigned DWReg = RI->getDwarfRegNum(Reg, false);
 221   if (DWReg < 32)
 222     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + DWReg);
 223   else {
 224     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
 225     addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
 226   }
 227 }
 228
 229 /// addRegisterOffset - Add register offset.
 230 void CompileUnit::addRegisterOffset(DIE *TheDie, unsigned Reg,
 231                                     int64_t Offset) {
 232   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
 233   unsigned DWReg = RI->getDwarfRegNum(Reg, false);
 234   const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
 235   if (Reg == TRI->getFrameRegister(*Asm->MF))
 236     // If variable offset is based in frame register then use fbreg.
 237     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_fbreg);
 238   else if (DWReg < 32)
 239     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + DWReg);
 240   else {
 241     addUInt(TheDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
 242     addUInt(TheDie, 0, dwarf::DW_FORM_udata, DWReg);
 243   }
 244   addSInt(TheDie, 0, dwarf::DW_FORM_sdata, Offset);
 245 }
 246
 247 /// addAddress - Add an address attribute to a die based on the location
 248 /// provided.
 249 void CompileUnit::addAddress(DIE *Die, unsigned Attribute,
 250                              const MachineLocation &Location) {
 251   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 252
 253   if (Location.isReg())
 254     addRegisterOp(Block, Location.getReg());
 255   else
 256     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
 257
 258   // Now attach the location information to the DIE.
 259   addBlock(Die, Attribute, 0, Block);
 260 }
 261
 262 /// addComplexAddress - Start with the address based on the location provided,
 263 /// and generate the DWARF information necessary to find the actual variable
 264 /// given the extra address information encoded in the DIVariable, starting from
 265 /// the starting location.  Add the DWARF information to the die.
 266 ///
 267 void CompileUnit::addComplexAddress(DbgVariable *&DV, DIE *Die,
 268                                     unsigned Attribute,
 269                                     const MachineLocation &Location) {
 270   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 271   unsigned N = DV->getNumAddrElements();
 272   unsigned i = 0;
 273   if (Location.isReg()) {
 274     if (N >= 2 && DV->getAddrElement(0) == DIBuilder::OpPlus) {
 275       // If first address element is OpPlus then emit
 276       // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
 277       addRegisterOffset(Block, Location.getReg(), DV->getAddrElement(1));
 278       i = 2;
 279     } else
 280       addRegisterOp(Block, Location.getReg());
 281   }
 282   else
 283     addRegisterOffset(Block, Location.getReg(), Location.getOffset());
 284
 285   for (;i < N; ++i) {
 286     uint64_t Element = DV->getAddrElement(i);
 287     if (Element == DIBuilder::OpPlus) {
 288       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
 289       addUInt(Block, 0, dwarf::DW_FORM_udata, DV->getAddrElement(++i));
 290     } else if (Element == DIBuilder::OpDeref) {
 291       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
 292     } else llvm_unreachable("unknown DIBuilder Opcode");
 293   }
 294
 295   // Now attach the location information to the DIE.
 296   addBlock(Die, Attribute, 0, Block);
 297 }
 298
 299 /* Byref variables, in Blocks, are declared by the programmer as "SomeType
 300    VarName;", but the compiler creates a __Block_byref_x_VarName struct, and
 301    gives the variable VarName either the struct, or a pointer to the struct, as
 302    its type.  This is necessary for various behind-the-scenes things the
 303    compiler needs to do with by-reference variables in Blocks.
 304
 305    However, as far as the original *programmer* is concerned, the variable
 306    should still have type 'SomeType', as originally declared.
 307
 308    The function getBlockByrefType dives into the __Block_byref_x_VarName
 309    struct to find the original type of the variable, which is then assigned to
 310    the variable's Debug Information Entry as its real type.  So far, so good.
 311    However now the debugger will expect the variable VarName to have the type
 312    SomeType.  So we need the location attribute for the variable to be an
 313    expression that explains to the debugger how to navigate through the
 314    pointers and struct to find the actual variable of type SomeType.
 315
 316    The following function does just that.  We start by getting
 317    the "normal" location for the variable. This will be the location
 318    of either the struct __Block_byref_x_VarName or the pointer to the
 319    struct __Block_byref_x_VarName.
 320
 321    The struct will look something like:
 322
 323    struct __Block_byref_x_VarName {
 324      ... <various fields>
 325      struct __Block_byref_x_VarName *forwarding;
 326      ... <various other fields>
 327      SomeType VarName;
 328      ... <maybe more fields>
 329    };
 330
 331    If we are given the struct directly (as our starting point) we
 332    need to tell the debugger to:
 333
 334    1).  Add the offset of the forwarding field.
 335
 336    2).  Follow that pointer to get the real __Block_byref_x_VarName
 337    struct to use (the real one may have been copied onto the heap).
 338
 339    3).  Add the offset for the field VarName, to find the actual variable.
 340
 341    If we started with a pointer to the struct, then we need to
 342    dereference that pointer first, before the other steps.
 343    Translating this into DWARF ops, we will need to append the following
 344    to the current location description for the variable:
 345
 346    DW_OP_deref                    -- optional, if we start with a pointer
 347    DW_OP_plus_uconst <forward_fld_offset>
 348    DW_OP_deref
 349    DW_OP_plus_uconst <varName_fld_offset>
 350
 351    That is what this function does.  */
 352
 353 /// addBlockByrefAddress - Start with the address based on the location
 354 /// provided, and generate the DWARF information necessary to find the
 355 /// actual Block variable (navigating the Block struct) based on the
 356 /// starting location.  Add the DWARF information to the die.  For
 357 /// more information, read large comment just above here.
 358 ///
 359 void CompileUnit::addBlockByrefAddress(DbgVariable *&DV, DIE *Die,
 360                                        unsigned Attribute,
 361                                        const MachineLocation &Location) {
 362   DIType Ty = DV->getType();
 363   DIType TmpTy = Ty;
 364   unsigned Tag = Ty.getTag();
 365   bool isPointer = false;
 366
 367   StringRef varName = DV->getName();
 368
 369   if (Tag == dwarf::DW_TAG_pointer_type) {
 370     DIDerivedType DTy = DIDerivedType(Ty);
 371     TmpTy = DTy.getTypeDerivedFrom();
 372     isPointer = true;
 373   }
 374
 375   DICompositeType blockStruct = DICompositeType(TmpTy);
 376
 377   // Find the __forwarding field and the variable field in the __Block_byref
 378   // struct.
 379   DIArray Fields = blockStruct.getTypeArray();
 380   DIDescriptor varField = DIDescriptor();
 381   DIDescriptor forwardingField = DIDescriptor();
 382
 383   for (unsigned i = 0, N = Fields.getNumElements(); i < N; ++i) {
 384     DIDescriptor Element = Fields.getElement(i);
 385     DIDerivedType DT = DIDerivedType(Element);
 386     StringRef fieldName = DT.getName();
 387     if (fieldName == "__forwarding")
 388       forwardingField = Element;
 389     else if (fieldName == varName)
 390       varField = Element;
 391   }
 392
 393   // Get the offsets for the forwarding field and the variable field.
 394   unsigned forwardingFieldOffset =
 395     DIDerivedType(forwardingField).getOffsetInBits() >> 3;
 396   unsigned varFieldOffset =
 397     DIDerivedType(varField).getOffsetInBits() >> 3;
 398
 399   // Decode the original location, and use that as the start of the byref
 400   // variable's location.
 401   const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
 402   unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
 403   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 404
 405   if (Location.isReg()) {
 406     if (Reg < 32)
 407       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_reg0 + Reg);
 408     else {
 409       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_regx);
 410       addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
 411     }
 412   } else {
 413     if (Reg < 32)
 414       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_breg0 + Reg);
 415     else {
 416       addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_bregx);
 417       addUInt(Block, 0, dwarf::DW_FORM_udata, Reg);
 418     }
 419
 420     addUInt(Block, 0, dwarf::DW_FORM_sdata, Location.getOffset());
 421   }
 422
 423   // If we started with a pointer to the __Block_byref... struct, then
 424   // the first thing we need to do is dereference the pointer (DW_OP_deref).
 425   if (isPointer)
 426     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
 427
 428   // Next add the offset for the '__forwarding' field:
 429   // DW_OP_plus_uconst ForwardingFieldOffset.  Note there's no point in
 430   // adding the offset if it's 0.
 431   if (forwardingFieldOffset > 0) {
 432     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
 433     addUInt(Block, 0, dwarf::DW_FORM_udata, forwardingFieldOffset);
 434   }
 435
 436   // Now dereference the __forwarding field to get to the real __Block_byref
 437   // struct:  DW_OP_deref.
 438   addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
 439
 440   // Now that we've got the real __Block_byref... struct, add the offset
 441   // for the variable's field to get to the location of the actual variable:
 442   // DW_OP_plus_uconst varFieldOffset.  Again, don't add if it's 0.
 443   if (varFieldOffset > 0) {
 444     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
 445     addUInt(Block, 0, dwarf::DW_FORM_udata, varFieldOffset);
 446   }
 447
 448   // Now attach the location information to the DIE.
 449   addBlock(Die, Attribute, 0, Block);
 450 }
 451
 452 /// isTypeSigned - Return true if the type is signed.
 453 static bool isTypeSigned(DIType Ty, int *SizeInBits) {
 454   if (Ty.isDerivedType())
 455     return isTypeSigned(DIDerivedType(Ty).getTypeDerivedFrom(), SizeInBits);
 456   if (Ty.isBasicType())
 457     if (DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed
 458         || DIBasicType(Ty).getEncoding() == dwarf::DW_ATE_signed_char) {
 459       *SizeInBits = Ty.getSizeInBits();
 460       return true;
 461     }
 462   return false;
 463 }
 464
 465 /// addConstantValue - Add constant value entry in variable DIE.
 466 bool CompileUnit::addConstantValue(DIE *Die, const MachineOperand &MO,
 467                                    DIType Ty) {
 468   assert(MO.isImm() && "Invalid machine operand!");
 469   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 470   int SizeInBits = -1;
 471   bool SignedConstant = isTypeSigned(Ty, &SizeInBits);
 472   unsigned Form = SignedConstant ? dwarf::DW_FORM_sdata : dwarf::DW_FORM_udata;
 473   switch (SizeInBits) {
 474     case 8:  Form = dwarf::DW_FORM_data1; break;
 475     case 16: Form = dwarf::DW_FORM_data2; break;
 476     case 32: Form = dwarf::DW_FORM_data4; break;
 477     case 64: Form = dwarf::DW_FORM_data8; break;
 478     default: break;
 479   }
 480   SignedConstant ? addSInt(Block, 0, Form, MO.getImm())
 481     : addUInt(Block, 0, Form, MO.getImm());
 482
 483   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
 484   return true;
 485 }
 486
 487 /// addConstantFPValue - Add constant value entry in variable DIE.
 488 bool CompileUnit::addConstantFPValue(DIE *Die, const MachineOperand &MO) {
 489   assert (MO.isFPImm() && "Invalid machine operand!");
 490   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 491   APFloat FPImm = MO.getFPImm()->getValueAPF();
 492
 493   // Get the raw data form of the floating point.
 494   const APInt FltVal = FPImm.bitcastToAPInt();
 495   const char *FltPtr = (const char*)FltVal.getRawData();
 496
 497   int NumBytes = FltVal.getBitWidth() / 8; // 8 bits per byte.
 498   bool LittleEndian = Asm->getTargetData().isLittleEndian();
 499   int Incr = (LittleEndian ? 1 : -1);
 500   int Start = (LittleEndian ? 0 : NumBytes - 1);
 501   int Stop = (LittleEndian ? NumBytes : -1);
 502
 503   // Output the constant to DWARF one byte at a time.
 504   for (; Start != Stop; Start += Incr)
 505     addUInt(Block, 0, dwarf::DW_FORM_data1,
 506             (unsigned char)0xFF & FltPtr[Start]);
 507
 508   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
 509   return true;
 510 }
 511
 512 /// addConstantValue - Add constant value entry in variable DIE.
 513 bool CompileUnit::addConstantValue(DIE *Die, const ConstantInt *CI,
 514                                    bool Unsigned) {
 515   unsigned CIBitWidth = CI->getBitWidth();
 516   if (CIBitWidth <= 64) {
 517     unsigned form = 0;
 518     switch (CIBitWidth) {
 519     case 8: form = dwarf::DW_FORM_data1; break;
 520     case 16: form = dwarf::DW_FORM_data2; break;
 521     case 32: form = dwarf::DW_FORM_data4; break;
 522     case 64: form = dwarf::DW_FORM_data8; break;
 523     default:
 524       form = Unsigned ? dwarf::DW_FORM_udata : dwarf::DW_FORM_sdata;
 525     }
 526     if (Unsigned)
 527       addUInt(Die, dwarf::DW_AT_const_value, form, CI->getZExtValue());
 528     else
 529       addSInt(Die, dwarf::DW_AT_const_value, form, CI->getSExtValue());
 530     return true;
 531   }
 532
 533   DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
 534
 535   // Get the raw data form of the large APInt.
 536   const APInt Val = CI->getValue();
 537   const uint64_t *Ptr64 = Val.getRawData();
 538
 539   int NumBytes = Val.getBitWidth() / 8; // 8 bits per byte.
 540   bool LittleEndian = Asm->getTargetData().isLittleEndian();
 541
 542   // Output the constant to DWARF one byte at a time.
 543   for (int i = 0; i < NumBytes; i++) {
 544     uint8_t c;
 545     if (LittleEndian)
 546       c = Ptr64[i / 8] >> (8 * (i & 7));
 547     else
 548       c = Ptr64[(NumBytes - 1 - i) / 8] >> (8 * ((NumBytes - 1 - i) & 7));
 549     addUInt(Block, 0, dwarf::DW_FORM_data1, c);
 550   }
 551
 552   addBlock(Die, dwarf::DW_AT_const_value, 0, Block);
 553   return true;
 554 }
 555
 556 /// addTemplateParams - Add template parameters in buffer.
 557 void CompileUnit::addTemplateParams(DIE &Buffer, DIArray TParams) {
 558   // Add template parameters.
 559   for (unsigned i = 0, e = TParams.getNumElements(); i != e; ++i) {
 560     DIDescriptor Element = TParams.getElement(i);
 561     if (Element.isTemplateTypeParameter())
 562       Buffer.addChild(getOrCreateTemplateTypeParameterDIE(
 563                         DITemplateTypeParameter(Element)));
 564     else if (Element.isTemplateValueParameter())
 565       Buffer.addChild(getOrCreateTemplateValueParameterDIE(
 566                         DITemplateValueParameter(Element)));
 567   }
 568 }
 569
 570 /// addToContextOwner - Add Die into the list of its context owner's children.
 571 void CompileUnit::addToContextOwner(DIE *Die, DIDescriptor Context) {
 572   if (Context.isType()) {
 573     DIE *ContextDIE = getOrCreateTypeDIE(DIType(Context));
 574     ContextDIE->addChild(Die);
 575   } else if (Context.isNameSpace()) {
 576     DIE *ContextDIE = getOrCreateNameSpace(DINameSpace(Context));
 577     ContextDIE->addChild(Die);
 578   } else if (Context.isSubprogram()) {
 579     DIE *ContextDIE = getOrCreateSubprogramDIE(DISubprogram(Context));
 580     ContextDIE->addChild(Die);
 581   } else if (DIE *ContextDIE = getDIE(Context))
 582     ContextDIE->addChild(Die);
 583   else
 584     addDie(Die);
 585 }
 586
 587 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
 588 /// given DIType.
 589 DIE *CompileUnit::getOrCreateTypeDIE(const MDNode *TyNode) {
 590   DIType Ty(TyNode);
 591   if (!Ty.Verify())
 592     return NULL;
 593   DIE *TyDIE = getDIE(Ty);
 594   if (TyDIE)
 595     return TyDIE;
 596
 597   // Create new type.
 598   TyDIE = new DIE(dwarf::DW_TAG_base_type);
 599   insertDIE(Ty, TyDIE);
 600   if (Ty.isBasicType())
 601     constructTypeDIE(*TyDIE, DIBasicType(Ty));
 602   else if (Ty.isCompositeType())
 603     constructTypeDIE(*TyDIE, DICompositeType(Ty));
 604   else {
 605     assert(Ty.isDerivedType() && "Unknown kind of DIType");
 606     constructTypeDIE(*TyDIE, DIDerivedType(Ty));
 607   }
 608
 609   addToContextOwner(TyDIE, Ty.getContext());
 610   return TyDIE;
 611 }
 612
 613 /// addType - Add a new type attribute to the specified entity.
 614 void CompileUnit::addType(DIE *Entity, DIType Ty) {
 615   if (!Ty.Verify())
 616     return;
 617
 618   // Check for pre-existence.
 619   DIEEntry *Entry = getDIEEntry(Ty);
 620   // If it exists then use the existing value.
 621   if (Entry) {
 622     Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
 623     return;
 624   }
 625
 626   // Construct type.
 627   DIE *Buffer = getOrCreateTypeDIE(Ty);
 628
 629   // Set up proxy.
 630   Entry = createDIEEntry(Buffer);
 631   insertDIEEntry(Ty, Entry);
 632   Entity->addValue(dwarf::DW_AT_type, dwarf::DW_FORM_ref4, Entry);
 633
 634   // If this is a complete composite type then include it in the
 635   // list of global types.
 636   addGlobalType(Ty);
 637 }
 638
 639 /// addGlobalType - Add a new global type to the compile unit.
 640 ///
 641 void CompileUnit::addGlobalType(DIType Ty) {
 642   DIDescriptor Context = Ty.getContext();
 643   if (Ty.isCompositeType() && !Ty.getName().empty() && !Ty.isForwardDecl()
 644       && (!Context || Context.isCompileUnit() || Context.isFile()
 645           || Context.isNameSpace()))
 646     if (DIEEntry *Entry = getDIEEntry(Ty))
 647       GlobalTypes[Ty.getName()] = Entry->getEntry();
 648 }
 649
 650 /// addPubTypes - Add type for pubtypes section.
 651 void CompileUnit::addPubTypes(DISubprogram SP) {
 652   DICompositeType SPTy = SP.getType();
 653   unsigned SPTag = SPTy.getTag();
 654   if (SPTag != dwarf::DW_TAG_subroutine_type)
 655     return;
 656
 657   DIArray Args = SPTy.getTypeArray();
 658   for (unsigned i = 0, e = Args.getNumElements(); i != e; ++i) {
 659     DIType ATy(Args.getElement(i));
 660     if (!ATy.Verify())
 661       continue;
 662     addGlobalType(ATy);
 663   }
 664 }
 665
 666 /// constructTypeDIE - Construct basic type die from DIBasicType.
 667 void CompileUnit::constructTypeDIE(DIE &Buffer, DIBasicType BTy) {
 668   // Get core information.
 669   StringRef Name = BTy.getName();
 670   // Add name if not anonymous or intermediate type.
 671   if (!Name.empty())
 672     addString(&Buffer, dwarf::DW_AT_name, Name);
 673
 674   if (BTy.getTag() == dwarf::DW_TAG_unspecified_type) {
 675     Buffer.setTag(dwarf::DW_TAG_unspecified_type);
 676     // Unspecified types has only name, nothing else.
 677     return;
 678   }
 679
 680   Buffer.setTag(dwarf::DW_TAG_base_type);
 681   addUInt(&Buffer, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
 682           BTy.getEncoding());
 683
 684   uint64_t Size = BTy.getSizeInBits() >> 3;
 685   addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
 686 }
 687
 688 /// constructTypeDIE - Construct derived type die from DIDerivedType.
 689 void CompileUnit::constructTypeDIE(DIE &Buffer, DIDerivedType DTy) {
 690   // Get core information.
 691   StringRef Name = DTy.getName();
 692   uint64_t Size = DTy.getSizeInBits() >> 3;
 693   unsigned Tag = DTy.getTag();
 694
 695   // FIXME - Workaround for templates.
 696   if (Tag == dwarf::DW_TAG_inheritance) Tag = dwarf::DW_TAG_reference_type;
 697
 698   Buffer.setTag(Tag);
 699
 700   // Map to main type, void will not have a type.
 701   DIType FromTy = DTy.getTypeDerivedFrom();
 702   addType(&Buffer, FromTy);
 703
 704   // Add name if not anonymous or intermediate type.
 705   if (!Name.empty())
 706     addString(&Buffer, dwarf::DW_AT_name, Name);
 707
 708   // Add size if non-zero (derived types might be zero-sized.)
 709   if (Size)
 710     addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
 711
 712   // Add source line info if available and TyDesc is not a forward declaration.
 713   if (!DTy.isForwardDecl())
 714     addSourceLine(&Buffer, DTy);
 715 }
 716
 717 /// constructTypeDIE - Construct type DIE from DICompositeType.
 718 void CompileUnit::constructTypeDIE(DIE &Buffer, DICompositeType CTy) {
 719   // Get core information.
 720   StringRef Name = CTy.getName();
 721
 722   uint64_t Size = CTy.getSizeInBits() >> 3;
 723   unsigned Tag = CTy.getTag();
 724   Buffer.setTag(Tag);
 725
 726   switch (Tag) {
 727   case dwarf::DW_TAG_vector_type:
 728   case dwarf::DW_TAG_array_type:
 729     constructArrayTypeDIE(Buffer, &CTy);
 730     break;
 731   case dwarf::DW_TAG_enumeration_type: {
 732     DIArray Elements = CTy.getTypeArray();
 733
 734     // Add enumerators to enumeration type.
 735     for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
 736       DIE *ElemDie = NULL;
 737       DIDescriptor Enum(Elements.getElement(i));
 738       if (Enum.isEnumerator()) {
 739         ElemDie = constructEnumTypeDIE(DIEnumerator(Enum));
 740         Buffer.addChild(ElemDie);
 741       }
 742     }
 743   }
 744     break;
 745   case dwarf::DW_TAG_subroutine_type: {
 746     // Add return type.
 747     DIArray Elements = CTy.getTypeArray();
 748     DIDescriptor RTy = Elements.getElement(0);
 749     addType(&Buffer, DIType(RTy));
 750
 751     bool isPrototyped = true;
 752     // Add arguments.
 753     for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
 754       DIDescriptor Ty = Elements.getElement(i);
 755       if (Ty.isUnspecifiedParameter()) {
 756         DIE *Arg = new DIE(dwarf::DW_TAG_unspecified_parameters);
 757         Buffer.addChild(Arg);
 758         isPrototyped = false;
 759       } else {
 760         DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
 761         addType(Arg, DIType(Ty));
 762         Buffer.addChild(Arg);
 763       }
 764     }
 765     // Add prototype flag.
 766     if (isPrototyped)
 767       addUInt(&Buffer, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
 768   }
 769     break;
 770   case dwarf::DW_TAG_structure_type:
 771   case dwarf::DW_TAG_union_type:
 772   case dwarf::DW_TAG_class_type: {
 773     // Add elements to structure type.
 774     DIArray Elements = CTy.getTypeArray();
 775
 776     // A forward struct declared type may not have elements available.
 777     unsigned N = Elements.getNumElements();
 778     if (N == 0)
 779       break;
 780
 781     // Add elements to structure type.
 782     for (unsigned i = 0; i < N; ++i) {
 783       DIDescriptor Element = Elements.getElement(i);
 784       DIE *ElemDie = NULL;
 785       if (Element.isSubprogram()) {
 786         DISubprogram SP(Element);
 787         ElemDie = getOrCreateSubprogramDIE(DISubprogram(Element));
 788         if (SP.isProtected())
 789           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
 790                   dwarf::DW_ACCESS_protected);
 791         else if (SP.isPrivate())
 792           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
 793                   dwarf::DW_ACCESS_private);
 794         else
 795           addUInt(ElemDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
 796             dwarf::DW_ACCESS_public);
 797         if (SP.isExplicit())
 798           addUInt(ElemDie, dwarf::DW_AT_explicit, dwarf::DW_FORM_flag, 1);
 799       }
 800       else if (Element.isVariable()) {
 801         DIVariable DV(Element);
 802         ElemDie = new DIE(dwarf::DW_TAG_variable);
 803         addString(ElemDie, dwarf::DW_AT_name, DV.getName());
 804         addType(ElemDie, DV.getType());
 805         addUInt(ElemDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
 806         addUInt(ElemDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
 807         addSourceLine(ElemDie, DV);
 808       } else if (Element.isDerivedType())
 809         ElemDie = createMemberDIE(DIDerivedType(Element));
 810       else
 811         continue;
 812       Buffer.addChild(ElemDie);
 813     }
 814
 815     if (CTy.isAppleBlockExtension())
 816       addUInt(&Buffer, dwarf::DW_AT_APPLE_block, dwarf::DW_FORM_flag, 1);
 817
 818     unsigned RLang = CTy.getRunTimeLang();
 819     if (RLang)
 820       addUInt(&Buffer, dwarf::DW_AT_APPLE_runtime_class,
 821               dwarf::DW_FORM_data1, RLang);
 822
 823     DICompositeType ContainingType = CTy.getContainingType();
 824     if (DIDescriptor(ContainingType).isCompositeType())
 825       addDIEEntry(&Buffer, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4,
 826                   getOrCreateTypeDIE(DIType(ContainingType)));
 827     else {
 828       DIDescriptor Context = CTy.getContext();
 829       addToContextOwner(&Buffer, Context);
 830     }
 831
 832     if (CTy.isObjcClassComplete())
 833       addUInt(&Buffer, dwarf::DW_AT_APPLE_objc_complete_type,
 834               dwarf::DW_FORM_flag, 1);
 835
 836     if (Tag == dwarf::DW_TAG_class_type)
 837       addTemplateParams(Buffer, CTy.getTemplateParams());
 838
 839     break;
 840   }
 841   default:
 842     break;
 843   }
 844
 845   // Add name if not anonymous or intermediate type.
 846   if (!Name.empty())
 847     addString(&Buffer, dwarf::DW_AT_name, Name);
 848
 849   if (Tag == dwarf::DW_TAG_enumeration_type || Tag == dwarf::DW_TAG_class_type
 850       || Tag == dwarf::DW_TAG_structure_type || Tag == dwarf::DW_TAG_union_type)
 851   {
 852     // Add size if non-zero (derived types might be zero-sized.)
 853     if (Size)
 854       addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, Size);
 855     else {
 856       // Add zero size if it is not a forward declaration.
 857       if (CTy.isForwardDecl())
 858         addUInt(&Buffer, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
 859       else
 860         addUInt(&Buffer, dwarf::DW_AT_byte_size, 0, 0);
 861     }
 862
 863     // Add source line info if available.
 864     if (!CTy.isForwardDecl())
 865       addSourceLine(&Buffer, CTy);
 866   }
 867 }
 868
 869 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
 870 /// for the given DITemplateTypeParameter.
 871 DIE *
 872 CompileUnit::getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP) {
 873   DIE *ParamDIE = getDIE(TP);
 874   if (ParamDIE)
 875     return ParamDIE;
 876
 877   ParamDIE = new DIE(dwarf::DW_TAG_template_type_parameter);
 878   addType(ParamDIE, TP.getType());
 879   addString(ParamDIE, dwarf::DW_AT_name, TP.getName());
 880   return ParamDIE;
 881 }
 882
 883 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
 884 /// for the given DITemplateValueParameter.
 885 DIE *
 886 CompileUnit::getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TPV) {
 887   DIE *ParamDIE = getDIE(TPV);
 888   if (ParamDIE)
 889     return ParamDIE;
 890
 891   ParamDIE = new DIE(dwarf::DW_TAG_template_value_parameter);
 892   addType(ParamDIE, TPV.getType());
 893   if (!TPV.getName().empty())
 894     addString(ParamDIE, dwarf::DW_AT_name, TPV.getName());
 895   addUInt(ParamDIE, dwarf::DW_AT_const_value, dwarf::DW_FORM_udata,
 896           TPV.getValue());
 897   return ParamDIE;
 898 }
 899
 900 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
 901 DIE *CompileUnit::getOrCreateNameSpace(DINameSpace NS) {
 902   DIE *NDie = getDIE(NS);
 903   if (NDie)
 904     return NDie;
 905   NDie = new DIE(dwarf::DW_TAG_namespace);
 906   insertDIE(NS, NDie);
 907   if (!NS.getName().empty())
 908     addString(NDie, dwarf::DW_AT_name, NS.getName());
 909   addSourceLine(NDie, NS);
 910   addToContextOwner(NDie, NS.getContext());
 911   return NDie;
 912 }
 913
 914 /// getRealLinkageName - If special LLVM prefix that is used to inform the asm
 915 /// printer to not emit usual symbol prefix before the symbol name is used then
 916 /// return linkage name after skipping this special LLVM prefix.
 917 static StringRef getRealLinkageName(StringRef LinkageName) {
 918   char One = '\1';
 919   if (LinkageName.startswith(StringRef(&One, 1)))
 920     return LinkageName.substr(1);
 921   return LinkageName;
 922 }
 923
 924 /// getOrCreateSubprogramDIE - Create new DIE using SP.
 925 DIE *CompileUnit::getOrCreateSubprogramDIE(DISubprogram SP) {
 926   DIE *SPDie = getDIE(SP);
 927   if (SPDie)
 928     return SPDie;
 929
 930   SPDie = new DIE(dwarf::DW_TAG_subprogram);
 931
 932   // DW_TAG_inlined_subroutine may refer to this DIE.
 933   insertDIE(SP, SPDie);
 934
 935   // Add to context owner.
 936   addToContextOwner(SPDie, SP.getContext());
 937
 938   // Add function template parameters.
 939   addTemplateParams(*SPDie, SP.getTemplateParams());
 940
 941   StringRef LinkageName = SP.getLinkageName();
 942   if (!LinkageName.empty())
 943     addString(SPDie, dwarf::DW_AT_MIPS_linkage_name,
 944               getRealLinkageName(LinkageName));
 945
 946   // If this DIE is going to refer declaration info using AT_specification
 947   // then there is no need to add other attributes.
 948   if (SP.getFunctionDeclaration().isSubprogram())
 949     return SPDie;
 950
 951   // Constructors and operators for anonymous aggregates do not have names.
 952   if (!SP.getName().empty())
 953     addString(SPDie, dwarf::DW_AT_name, SP.getName());
 954
 955   addSourceLine(SPDie, SP);
 956
 957   if (SP.isPrototyped())
 958     addUInt(SPDie, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag, 1);
 959
 960   // Add Return Type.
 961   DICompositeType SPTy = SP.getType();
 962   DIArray Args = SPTy.getTypeArray();
 963   unsigned SPTag = SPTy.getTag();
 964
 965   if (Args.getNumElements() == 0 || SPTag != dwarf::DW_TAG_subroutine_type)
 966     addType(SPDie, SPTy);
 967   else
 968     addType(SPDie, DIType(Args.getElement(0)));
 969
 970   unsigned VK = SP.getVirtuality();
 971   if (VK) {
 972     addUInt(SPDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag, VK);
 973     DIEBlock *Block = getDIEBlock();
 974     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
 975     addUInt(Block, 0, dwarf::DW_FORM_udata, SP.getVirtualIndex());
 976     addBlock(SPDie, dwarf::DW_AT_vtable_elem_location, 0, Block);
 977     ContainingTypeMap.insert(std::make_pair(SPDie,
 978                                             SP.getContainingType()));
 979   }
 980
 981   if (!SP.isDefinition()) {
 982     addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
 983
 984     // Add arguments. Do not add arguments for subprogram definition. They will
 985     // be handled while processing variables.
 986     DICompositeType SPTy = SP.getType();
 987     DIArray Args = SPTy.getTypeArray();
 988     unsigned SPTag = SPTy.getTag();
 989
 990     if (SPTag == dwarf::DW_TAG_subroutine_type)
 991       for (unsigned i = 1, N =  Args.getNumElements(); i < N; ++i) {
 992         DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
 993         DIType ATy = DIType(DIType(Args.getElement(i)));
 994         addType(Arg, ATy);
 995         if (ATy.isArtificial())
 996           addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
 997         SPDie->addChild(Arg);
 998       }
 999   }
1000
1001   if (SP.isArtificial())
1002     addUInt(SPDie, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
1003
1004   if (!SP.isLocalToUnit())
1005     addUInt(SPDie, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1006
1007   if (SP.isOptimized())
1008     addUInt(SPDie, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
1009
1010   if (unsigned isa = Asm->getISAEncoding()) {
1011     addUInt(SPDie, dwarf::DW_AT_APPLE_isa, dwarf::DW_FORM_flag, isa);
1012   }
1013
1014   return SPDie;
1015 }
1016
1017 // Return const expression if value is a GEP to access merged global
1018 // constant. e.g.
1019 // i8* getelementptr ({ i8, i8, i8, i8 }* @_MergedGlobals, i32 0, i32 0)
1020 static const ConstantExpr *getMergedGlobalExpr(const Value *V) {
1021   const ConstantExpr *CE = dyn_cast_or_null<ConstantExpr>(V);
1022   if (!CE || CE->getNumOperands() != 3 ||
1023       CE->getOpcode() != Instruction::GetElementPtr)
1024     return NULL;
1025
1026   // First operand points to a global struct.
1027   Value *Ptr = CE->getOperand(0);
1028   if (!isa<GlobalValue>(Ptr) ||
1029       !isa<StructType>(cast<PointerType>(Ptr->getType())->getElementType()))
1030     return NULL;
1031
1032   // Second operand is zero.
1033   const ConstantInt *CI = dyn_cast_or_null<ConstantInt>(CE->getOperand(1));
1034   if (!CI || !CI->isZero())
1035     return NULL;
1036
1037   // Third operand is offset.
1038   if (!isa<ConstantInt>(CE->getOperand(2)))
1039     return NULL;
1040
1041   return CE;
1042 }
1043
1044 /// createGlobalVariableDIE - create global variable DIE.
1045 void CompileUnit::createGlobalVariableDIE(const MDNode *N) {
1046   // Check for pre-existence.
1047   if (getDIE(N))
1048     return;
1049
1050   DIGlobalVariable GV(N);
1051   if (!GV.Verify())
1052     return;
1053
1054   DIE *VariableDIE = new DIE(GV.getTag());
1055   // Add to map.
1056   insertDIE(N, VariableDIE);
1057
1058   // Add name.
1059   addString(VariableDIE, dwarf::DW_AT_name, GV.getDisplayName());
1060   StringRef LinkageName = GV.getLinkageName();
1061   bool isGlobalVariable = GV.getGlobal() != NULL;
1062   if (!LinkageName.empty() && isGlobalVariable)
1063     addString(VariableDIE, dwarf::DW_AT_MIPS_linkage_name,
1064               getRealLinkageName(LinkageName));
1065   // Add type.
1066   DIType GTy = GV.getType();
1067   addType(VariableDIE, GTy);
1068
1069   // Add scoping info.
1070   if (!GV.isLocalToUnit()) {
1071     addUInt(VariableDIE, dwarf::DW_AT_external, dwarf::DW_FORM_flag, 1);
1072     // Expose as global.
1073     addGlobal(GV.getName(), VariableDIE);
1074   }
1075   // Add line number info.
1076   addSourceLine(VariableDIE, GV);
1077   // Add to context owner.
1078   DIDescriptor GVContext = GV.getContext();
1079   addToContextOwner(VariableDIE, GVContext);
1080   // Add location.
1081   if (isGlobalVariable) {
1082     DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1083     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1084     addLabel(Block, 0, dwarf::DW_FORM_udata,
1085              Asm->Mang->getSymbol(GV.getGlobal()));
1086     // Do not create specification DIE if context is either compile unit
1087     // or a subprogram.
1088     if (GVContext && GV.isDefinition() && !GVContext.isCompileUnit() &&
1089         !GVContext.isFile() && !isSubprogramContext(GVContext)) {
1090       // Create specification DIE.
1091       DIE *VariableSpecDIE = new DIE(dwarf::DW_TAG_variable);
1092       addDIEEntry(VariableSpecDIE, dwarf::DW_AT_specification,
1093                   dwarf::DW_FORM_ref4, VariableDIE);
1094       addBlock(VariableSpecDIE, dwarf::DW_AT_location, 0, Block);
1095       addUInt(VariableDIE, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag,
1096                      1);
1097       addDie(VariableSpecDIE);
1098     } else {
1099       addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1100     }
1101   } else if (const ConstantInt *CI =
1102              dyn_cast_or_null<ConstantInt>(GV.getConstant()))
1103     addConstantValue(VariableDIE, CI, GTy.isUnsignedDIType());
1104   else if (const ConstantExpr *CE = getMergedGlobalExpr(N->getOperand(11))) {
1105     // GV is a merged global.
1106     DIEBlock *Block = new (DIEValueAllocator) DIEBlock();
1107     Value *Ptr = CE->getOperand(0);
1108     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_addr);
1109     addLabel(Block, 0, dwarf::DW_FORM_udata,
1110                     Asm->Mang->getSymbol(cast<GlobalValue>(Ptr)));
1111     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1112     SmallVector<Value*, 3> Idx(CE->op_begin()+1, CE->op_end());
1113     addUInt(Block, 0, dwarf::DW_FORM_udata,
1114                    Asm->getTargetData().getIndexedOffset(Ptr->getType(), Idx));
1115     addUInt(Block, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1116     addBlock(VariableDIE, dwarf::DW_AT_location, 0, Block);
1117   }
1118
1119   return;
1120 }
1121
1122 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
1123 void CompileUnit::constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy){
1124   DIE *DW_Subrange = new DIE(dwarf::DW_TAG_subrange_type);
1125   addDIEEntry(DW_Subrange, dwarf::DW_AT_type, dwarf::DW_FORM_ref4, IndexTy);
1126   int64_t L = SR.getLo();
1127   int64_t H = SR.getHi();
1128
1129   // The L value defines the lower bounds which is typically zero for C/C++. The
1130   // H value is the upper bounds.  Values are 64 bit.  H - L + 1 is the size
1131   // of the array. If L > H then do not emit DW_AT_lower_bound and
1132   // DW_AT_upper_bound attributes. If L is zero and H is also zero then the
1133   // array has one element and in such case do not emit lower bound.
1134
1135   if (L > H) {
1136     Buffer.addChild(DW_Subrange);
1137     return;
1138   }
1139   if (L)
1140     addSInt(DW_Subrange, dwarf::DW_AT_lower_bound, 0, L);
1141   addSInt(DW_Subrange, dwarf::DW_AT_upper_bound, 0, H);
1142   Buffer.addChild(DW_Subrange);
1143 }
1144
1145 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
1146 void CompileUnit::constructArrayTypeDIE(DIE &Buffer,
1147                                         DICompositeType *CTy) {
1148   Buffer.setTag(dwarf::DW_TAG_array_type);
1149   if (CTy->getTag() == dwarf::DW_TAG_vector_type)
1150     addUInt(&Buffer, dwarf::DW_AT_GNU_vector, dwarf::DW_FORM_flag, 1);
1151
1152   // Emit derived type.
1153   addType(&Buffer, CTy->getTypeDerivedFrom());
1154   DIArray Elements = CTy->getTypeArray();
1155
1156   // Get an anonymous type for index type.
1157   DIE *IdxTy = getIndexTyDie();
1158   if (!IdxTy) {
1159     // Construct an anonymous type for index type.
1160     IdxTy = new DIE(dwarf::DW_TAG_base_type);
1161     addUInt(IdxTy, dwarf::DW_AT_byte_size, 0, sizeof(int32_t));
1162     addUInt(IdxTy, dwarf::DW_AT_encoding, dwarf::DW_FORM_data1,
1163             dwarf::DW_ATE_signed);
1164     addDie(IdxTy);
1165     setIndexTyDie(IdxTy);
1166   }
1167
1168   // Add subranges to array type.
1169   for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1170     DIDescriptor Element = Elements.getElement(i);
1171     if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1172       constructSubrangeDIE(Buffer, DISubrange(Element), IdxTy);
1173   }
1174 }
1175
1176 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1177 DIE *CompileUnit::constructEnumTypeDIE(DIEnumerator ETy) {
1178   DIE *Enumerator = new DIE(dwarf::DW_TAG_enumerator);
1179   StringRef Name = ETy.getName();
1180   addString(Enumerator, dwarf::DW_AT_name, Name);
1181   int64_t Value = ETy.getEnumValue();
1182   addSInt(Enumerator, dwarf::DW_AT_const_value, dwarf::DW_FORM_sdata, Value);
1183   return Enumerator;
1184 }
1185
1186 /// constructContainingTypeDIEs - Construct DIEs for types that contain
1187 /// vtables.
1188 void CompileUnit::constructContainingTypeDIEs() {
1189   for (DenseMap<DIE *, const MDNode *>::iterator CI = ContainingTypeMap.begin(),
1190          CE = ContainingTypeMap.end(); CI != CE; ++CI) {
1191     DIE *SPDie = CI->first;
1192     const MDNode *N = CI->second;
1193     if (!N) continue;
1194     DIE *NDie = getDIE(N);
1195     if (!NDie) continue;
1196     addDIEEntry(SPDie, dwarf::DW_AT_containing_type, dwarf::DW_FORM_ref4, NDie);
1197   }
1198 }
1199
1200 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
1201 DIE *CompileUnit::constructVariableDIE(DbgVariable *DV, bool isScopeAbstract) {
1202   StringRef Name = DV->getName();
1203   if (Name.empty())
1204     return NULL;
1205
1206   // Translate tag to proper Dwarf tag.
1207   unsigned Tag = DV->getTag();
1208
1209   // Define variable debug information entry.
1210   DIE *VariableDie = new DIE(Tag);
1211   DbgVariable *AbsVar = DV->getAbstractVariable();
1212   DIE *AbsDIE = AbsVar ? AbsVar->getDIE() : NULL;
1213   if (AbsDIE)
1214     addDIEEntry(VariableDie, dwarf::DW_AT_abstract_origin,
1215                             dwarf::DW_FORM_ref4, AbsDIE);
1216   else {
1217     addString(VariableDie, dwarf::DW_AT_name, Name);
1218     addSourceLine(VariableDie, DV->getVariable());
1219     addType(VariableDie, DV->getType());
1220   }
1221
1222   if (DV->isArtificial())
1223     addUInt(VariableDie, dwarf::DW_AT_artificial,
1224                         dwarf::DW_FORM_flag, 1);
1225
1226   if (isScopeAbstract) {
1227     DV->setDIE(VariableDie);
1228     return VariableDie;
1229   }
1230
1231   // Add variable address.
1232
1233   unsigned Offset = DV->getDotDebugLocOffset();
1234   if (Offset != ~0U) {
1235     addLabel(VariableDie, dwarf::DW_AT_location,
1236                          dwarf::DW_FORM_data4,
1237                          Asm->GetTempSymbol("debug_loc", Offset));
1238     DV->setDIE(VariableDie);
1239     return VariableDie;
1240   }
1241
1242   // Check if variable is described by a DBG_VALUE instruction.
1243   if (const MachineInstr *DVInsn = DV->getMInsn()) {
1244     bool updated = false;
1245     if (DVInsn->getNumOperands() == 3) {
1246       if (DVInsn->getOperand(0).isReg()) {
1247         const MachineOperand RegOp = DVInsn->getOperand(0);
1248         const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1249         if (DVInsn->getOperand(1).isImm() &&
1250             TRI->getFrameRegister(*Asm->MF) == RegOp.getReg()) {
1251           unsigned FrameReg = 0;
1252           const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
1253           int Offset =
1254             TFI->getFrameIndexReference(*Asm->MF,
1255                                         DVInsn->getOperand(1).getImm(),
1256                                         FrameReg);
1257           MachineLocation Location(FrameReg, Offset);
1258           addVariableAddress(DV, VariableDie, Location);
1259
1260         } else if (RegOp.getReg())
1261           addVariableAddress(DV, VariableDie,
1262                                          MachineLocation(RegOp.getReg()));
1263         updated = true;
1264       }
1265       else if (DVInsn->getOperand(0).isImm())
1266         updated =
1267           addConstantValue(VariableDie, DVInsn->getOperand(0),
1268                                        DV->getType());
1269       else if (DVInsn->getOperand(0).isFPImm())
1270         updated =
1271           addConstantFPValue(VariableDie, DVInsn->getOperand(0));
1272       else if (DVInsn->getOperand(0).isCImm())
1273         updated =
1274           addConstantValue(VariableDie,
1275                                        DVInsn->getOperand(0).getCImm(),
1276                                        DV->getType().isUnsignedDIType());
1277     } else {
1278       addVariableAddress(DV, VariableDie,
1279                                      Asm->getDebugValueLocation(DVInsn));
1280       updated = true;
1281     }
1282     if (!updated) {
1283       // If variableDie is not updated then DBG_VALUE instruction does not
1284       // have valid variable info.
1285       delete VariableDie;
1286       return NULL;
1287     }
1288     DV->setDIE(VariableDie);
1289     return VariableDie;
1290   } else {
1291     // .. else use frame index.
1292     int FI = DV->getFrameIndex();
1293     if (FI != ~0) {
1294       unsigned FrameReg = 0;
1295       const TargetFrameLowering *TFI = Asm->TM.getFrameLowering();
1296       int Offset =
1297         TFI->getFrameIndexReference(*Asm->MF, FI, FrameReg);
1298       MachineLocation Location(FrameReg, Offset);
1299       addVariableAddress(DV, VariableDie, Location);
1300     }
1301   }
1302
1303   DV->setDIE(VariableDie);
1304   return VariableDie;
1305 }
1306
1307 /// createMemberDIE - Create new member DIE.
1308 DIE *CompileUnit::createMemberDIE(DIDerivedType DT) {
1309   DIE *MemberDie = new DIE(DT.getTag());
1310   StringRef Name = DT.getName();
1311   if (!Name.empty())
1312     addString(MemberDie, dwarf::DW_AT_name, Name);
1313
1314   addType(MemberDie, DT.getTypeDerivedFrom());
1315
1316   addSourceLine(MemberDie, DT);
1317
1318   DIEBlock *MemLocationDie = new (DIEValueAllocator) DIEBlock();
1319   addUInt(MemLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus_uconst);
1320
1321   uint64_t Size = DT.getSizeInBits();
1322   uint64_t FieldSize = DT.getOriginalTypeSize();
1323
1324   if (Size != FieldSize) {
1325     // Handle bitfield.
1326     addUInt(MemberDie, dwarf::DW_AT_byte_size, 0, DT.getOriginalTypeSize()>>3);
1327     addUInt(MemberDie, dwarf::DW_AT_bit_size, 0, DT.getSizeInBits());
1328
1329     uint64_t Offset = DT.getOffsetInBits();
1330     uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1331     uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1332     uint64_t FieldOffset = (HiMark - FieldSize);
1333     Offset -= FieldOffset;
1334
1335     // Maybe we need to work from the other end.
1336     if (Asm->getTargetData().isLittleEndian())
1337       Offset = FieldSize - (Offset + Size);
1338     addUInt(MemberDie, dwarf::DW_AT_bit_offset, 0, Offset);
1339
1340     // Here WD_AT_data_member_location points to the anonymous
1341     // field that includes this bit field.
1342     addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, FieldOffset >> 3);
1343
1344   } else
1345     // This is not a bitfield.
1346     addUInt(MemLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits() >> 3);
1347
1348   if (DT.getTag() == dwarf::DW_TAG_inheritance
1349       && DT.isVirtual()) {
1350
1351     // For C++, virtual base classes are not at fixed offset. Use following
1352     // expression to extract appropriate offset from vtable.
1353     // BaseAddr = ObAddr + *((*ObAddr) - Offset)
1354
1355     DIEBlock *VBaseLocationDie = new (DIEValueAllocator) DIEBlock();
1356     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_dup);
1357     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1358     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_constu);
1359     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_udata, DT.getOffsetInBits());
1360     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_minus);
1361     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_deref);
1362     addUInt(VBaseLocationDie, 0, dwarf::DW_FORM_data1, dwarf::DW_OP_plus);
1363
1364     addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0,
1365              VBaseLocationDie);
1366   } else
1367     addBlock(MemberDie, dwarf::DW_AT_data_member_location, 0, MemLocationDie);
1368
1369   if (DT.isProtected())
1370     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1371             dwarf::DW_ACCESS_protected);
1372   else if (DT.isPrivate())
1373     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1374             dwarf::DW_ACCESS_private);
1375   // Otherwise C++ member and base classes are considered public.
1376   else
1377     addUInt(MemberDie, dwarf::DW_AT_accessibility, dwarf::DW_FORM_flag,
1378             dwarf::DW_ACCESS_public);
1379   if (DT.isVirtual())
1380     addUInt(MemberDie, dwarf::DW_AT_virtuality, dwarf::DW_FORM_flag,
1381             dwarf::DW_VIRTUALITY_virtual);
1382
1383   // Objective-C properties.
1384   StringRef PropertyName = DT.getObjCPropertyName();
1385   if (!PropertyName.empty()) {
1386     addString(MemberDie, dwarf::DW_AT_APPLE_property_name, PropertyName);
1387     StringRef GetterName = DT.getObjCPropertyGetterName();
1388     if (!GetterName.empty())
1389       addString(MemberDie, dwarf::DW_AT_APPLE_property_getter, GetterName);
1390     StringRef SetterName = DT.getObjCPropertySetterName();
1391     if (!SetterName.empty())
1392       addString(MemberDie, dwarf::DW_AT_APPLE_property_setter, SetterName);
1393     unsigned PropertyAttributes = 0;
1394     if (DT.isReadOnlyObjCProperty())
1395       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readonly;
1396     if (DT.isReadWriteObjCProperty())
1397       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_readwrite;
1398     if (DT.isAssignObjCProperty())
1399       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_assign;
1400     if (DT.isRetainObjCProperty())
1401       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_retain;
1402     if (DT.isCopyObjCProperty())
1403       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_copy;
1404     if (DT.isNonAtomicObjCProperty())
1405       PropertyAttributes |= dwarf::DW_APPLE_PROPERTY_nonatomic;
1406     if (PropertyAttributes)
1407       addUInt(MemberDie, dwarf::DW_AT_APPLE_property_attribute, 0,
1408               PropertyAttributes);
1409   }
1410   return MemberDie;
1411 }