lib/MC/MCDwarf.cpp

   1 //===- lib/MC/MCDwarf.cpp - MCDwarf implementation ------------------------===//
   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 #include "llvm/MC/MCDwarf.h"
  11 #include "llvm/MC/MCAsmInfo.h"
  12 #include "llvm/MC/MCContext.h"
  13 #include "llvm/MC/MCObjectFileInfo.h"
  14 #include "llvm/MC/MCObjectWriter.h"
  15 #include "llvm/MC/MCRegisterInfo.h"
  16 #include "llvm/MC/MCStreamer.h"
  17 #include "llvm/MC/MCSymbol.h"
  18 #include "llvm/MC/MCExpr.h"
  19 #include "llvm/Support/Debug.h"
  20 #include "llvm/Support/ErrorHandling.h"
  21 #include "llvm/Support/raw_ostream.h"
  22 #include "llvm/Support/Path.h"
  23 #include "llvm/Support/SourceMgr.h"
  24 #include "llvm/ADT/FoldingSet.h"
  25 #include "llvm/ADT/SmallString.h"
  26 #include "llvm/ADT/Twine.h"
  27 #include "llvm/Config/config.h"
  28 using namespace llvm;
  29
  30 // Given a special op, return the address skip amount (in units of
  31 // DWARF2_LINE_MIN_INSN_LENGTH.
  32 #define SPECIAL_ADDR(op) (((op) - DWARF2_LINE_OPCODE_BASE)/DWARF2_LINE_RANGE)
  33
  34 // The maximum address skip amount that can be encoded with a special op.
  35 #define MAX_SPECIAL_ADDR_DELTA         SPECIAL_ADDR(255)
  36
  37 // First special line opcode - leave room for the standard opcodes.
  38 // Note: If you want to change this, you'll have to update the
  39 // "standard_opcode_lengths" table that is emitted in DwarfFileTable::Emit().
  40 #define DWARF2_LINE_OPCODE_BASE         13
  41
  42 // Minimum line offset in a special line info. opcode.  This value
  43 // was chosen to give a reasonable range of values.
  44 #define DWARF2_LINE_BASE                -5
  45
  46 // Range of line offsets in a special line info. opcode.
  47 #define DWARF2_LINE_RANGE               14
  48
  49 // Define the architecture-dependent minimum instruction length (in bytes).
  50 // This value should be rather too small than too big.
  51 #define DWARF2_LINE_MIN_INSN_LENGTH     1
  52
  53 // Note: when DWARF2_LINE_MIN_INSN_LENGTH == 1 which is the current setting,
  54 // this routine is a nop and will be optimized away.
  55 static inline uint64_t ScaleAddrDelta(uint64_t AddrDelta) {
  56   if (DWARF2_LINE_MIN_INSN_LENGTH == 1)
  57     return AddrDelta;
  58   if (AddrDelta % DWARF2_LINE_MIN_INSN_LENGTH != 0) {
  59     // TODO: report this error, but really only once.
  60     ;
  61   }
  62   return AddrDelta / DWARF2_LINE_MIN_INSN_LENGTH;
  63 }
  64
  65 //
  66 // This is called when an instruction is assembled into the specified section
  67 // and if there is information from the last .loc directive that has yet to have
  68 // a line entry made for it is made.
  69 //
  70 void MCLineEntry::Make(MCStreamer *MCOS, const MCSection *Section) {
  71   if (!MCOS->getContext().getDwarfLocSeen())
  72     return;
  73
  74   // Create a symbol at in the current section for use in the line entry.
  75   MCSymbol *LineSym = MCOS->getContext().CreateTempSymbol();
  76   // Set the value of the symbol to use for the MCLineEntry.
  77   MCOS->EmitLabel(LineSym);
  78
  79   // Get the current .loc info saved in the context.
  80   const MCDwarfLoc &DwarfLoc = MCOS->getContext().getCurrentDwarfLoc();
  81
  82   // Create a (local) line entry with the symbol and the current .loc info.
  83   MCLineEntry LineEntry(LineSym, DwarfLoc);
  84
  85   // clear DwarfLocSeen saying the current .loc info is now used.
  86   MCOS->getContext().ClearDwarfLocSeen();
  87
  88   // Get the MCLineSection for this section, if one does not exist for this
  89   // section create it.
  90   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
  91     MCOS->getContext().getMCLineSections();
  92   MCLineSection *LineSection = MCLineSections.lookup(Section);
  93   if (!LineSection) {
  94     // Create a new MCLineSection.  This will be deleted after the dwarf line
  95     // table is created using it by iterating through the MCLineSections
  96     // DenseMap.
  97     LineSection = new MCLineSection;
  98     // Save a pointer to the new LineSection into the MCLineSections DenseMap.
  99     MCOS->getContext().addMCLineSection(Section, LineSection);
 100   }
 101
 102   // Add the line entry to this section's entries.
 103   LineSection->addLineEntry(LineEntry);
 104 }
 105
 106 //
 107 // This helper routine returns an expression of End - Start + IntVal .
 108 //
 109 static inline const MCExpr *MakeStartMinusEndExpr(const MCStreamer &MCOS,
 110                                                   const MCSymbol &Start,
 111                                                   const MCSymbol &End,
 112                                                   int IntVal) {
 113   MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
 114   const MCExpr *Res =
 115     MCSymbolRefExpr::Create(&End, Variant, MCOS.getContext());
 116   const MCExpr *RHS =
 117     MCSymbolRefExpr::Create(&Start, Variant, MCOS.getContext());
 118   const MCExpr *Res1 =
 119     MCBinaryExpr::Create(MCBinaryExpr::Sub, Res, RHS, MCOS.getContext());
 120   const MCExpr *Res2 =
 121     MCConstantExpr::Create(IntVal, MCOS.getContext());
 122   const MCExpr *Res3 =
 123     MCBinaryExpr::Create(MCBinaryExpr::Sub, Res1, Res2, MCOS.getContext());
 124   return Res3;
 125 }
 126
 127 //
 128 // This emits the Dwarf line table for the specified section from the entries
 129 // in the LineSection.
 130 //
 131 static inline void EmitDwarfLineTable(MCStreamer *MCOS,
 132                                       const MCSection *Section,
 133                                       const MCLineSection *LineSection) {
 134   unsigned FileNum = 1;
 135   unsigned LastLine = 1;
 136   unsigned Column = 0;
 137   unsigned Flags = DWARF2_LINE_DEFAULT_IS_STMT ? DWARF2_FLAG_IS_STMT : 0;
 138   unsigned Isa = 0;
 139   MCSymbol *LastLabel = NULL;
 140
 141   // Loop through each MCLineEntry and encode the dwarf line number table.
 142   for (MCLineSection::const_iterator
 143          it = LineSection->getMCLineEntries()->begin(),
 144          ie = LineSection->getMCLineEntries()->end(); it != ie; ++it) {
 145
 146     if (FileNum != it->getFileNum()) {
 147       FileNum = it->getFileNum();
 148       MCOS->EmitIntValue(dwarf::DW_LNS_set_file, 1);
 149       MCOS->EmitULEB128IntValue(FileNum);
 150     }
 151     if (Column != it->getColumn()) {
 152       Column = it->getColumn();
 153       MCOS->EmitIntValue(dwarf::DW_LNS_set_column, 1);
 154       MCOS->EmitULEB128IntValue(Column);
 155     }
 156     if (Isa != it->getIsa()) {
 157       Isa = it->getIsa();
 158       MCOS->EmitIntValue(dwarf::DW_LNS_set_isa, 1);
 159       MCOS->EmitULEB128IntValue(Isa);
 160     }
 161     if ((it->getFlags() ^ Flags) & DWARF2_FLAG_IS_STMT) {
 162       Flags = it->getFlags();
 163       MCOS->EmitIntValue(dwarf::DW_LNS_negate_stmt, 1);
 164     }
 165     if (it->getFlags() & DWARF2_FLAG_BASIC_BLOCK)
 166       MCOS->EmitIntValue(dwarf::DW_LNS_set_basic_block, 1);
 167     if (it->getFlags() & DWARF2_FLAG_PROLOGUE_END)
 168       MCOS->EmitIntValue(dwarf::DW_LNS_set_prologue_end, 1);
 169     if (it->getFlags() & DWARF2_FLAG_EPILOGUE_BEGIN)
 170       MCOS->EmitIntValue(dwarf::DW_LNS_set_epilogue_begin, 1);
 171
 172     int64_t LineDelta = static_cast<int64_t>(it->getLine()) - LastLine;
 173     MCSymbol *Label = it->getLabel();
 174
 175     // At this point we want to emit/create the sequence to encode the delta in
 176     // line numbers and the increment of the address from the previous Label
 177     // and the current Label.
 178     const MCAsmInfo &asmInfo = MCOS->getContext().getAsmInfo();
 179     MCOS->EmitDwarfAdvanceLineAddr(LineDelta, LastLabel, Label,
 180                                    asmInfo.getPointerSize());
 181
 182     LastLine = it->getLine();
 183     LastLabel = Label;
 184   }
 185
 186   // Emit a DW_LNE_end_sequence for the end of the section.
 187   // Using the pointer Section create a temporary label at the end of the
 188   // section and use that and the LastLabel to compute the address delta
 189   // and use INT64_MAX as the line delta which is the signal that this is
 190   // actually a DW_LNE_end_sequence.
 191
 192   // Switch to the section to be able to create a symbol at its end.
 193   MCOS->SwitchSection(Section);
 194
 195   MCContext &context = MCOS->getContext();
 196   // Create a symbol at the end of the section.
 197   MCSymbol *SectionEnd = context.CreateTempSymbol();
 198   // Set the value of the symbol, as we are at the end of the section.
 199   MCOS->EmitLabel(SectionEnd);
 200
 201   // Switch back the the dwarf line section.
 202   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfLineSection());
 203
 204   const MCAsmInfo &asmInfo = MCOS->getContext().getAsmInfo();
 205   MCOS->EmitDwarfAdvanceLineAddr(INT64_MAX, LastLabel, SectionEnd,
 206                                  asmInfo.getPointerSize());
 207 }
 208
 209 //
 210 // This emits the Dwarf file and the line tables.
 211 //
 212 void MCDwarfFileTable::Emit(MCStreamer *MCOS) {
 213   MCContext &context = MCOS->getContext();
 214   // Switch to the section where the table will be emitted into.
 215   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfLineSection());
 216
 217   // Create a symbol at the beginning of this section.
 218   MCSymbol *LineStartSym = context.CreateTempSymbol();
 219   // Set the value of the symbol, as we are at the start of the section.
 220   MCOS->EmitLabel(LineStartSym);
 221
 222   // Create a symbol for the end of the section (to be set when we get there).
 223   MCSymbol *LineEndSym = context.CreateTempSymbol();
 224
 225   // The first 4 bytes is the total length of the information for this
 226   // compilation unit (not including these 4 bytes for the length).
 227   MCOS->EmitAbsValue(MakeStartMinusEndExpr(*MCOS, *LineStartSym, *LineEndSym,4),
 228                      4);
 229
 230   // Next 2 bytes is the Version, which is Dwarf 2.
 231   MCOS->EmitIntValue(2, 2);
 232
 233   // Create a symbol for the end of the prologue (to be set when we get there).
 234   MCSymbol *ProEndSym = context.CreateTempSymbol(); // Lprologue_end
 235
 236   // Length of the prologue, is the next 4 bytes.  Which is the start of the
 237   // section to the end of the prologue.  Not including the 4 bytes for the
 238   // total length, the 2 bytes for the version, and these 4 bytes for the
 239   // length of the prologue.
 240   MCOS->EmitAbsValue(MakeStartMinusEndExpr(*MCOS, *LineStartSym, *ProEndSym,
 241                                         (4 + 2 + 4)),
 242                   4, 0);
 243
 244   // Parameters of the state machine, are next.
 245   MCOS->EmitIntValue(DWARF2_LINE_MIN_INSN_LENGTH, 1);
 246   MCOS->EmitIntValue(DWARF2_LINE_DEFAULT_IS_STMT, 1);
 247   MCOS->EmitIntValue(DWARF2_LINE_BASE, 1);
 248   MCOS->EmitIntValue(DWARF2_LINE_RANGE, 1);
 249   MCOS->EmitIntValue(DWARF2_LINE_OPCODE_BASE, 1);
 250
 251   // Standard opcode lengths
 252   MCOS->EmitIntValue(0, 1); // length of DW_LNS_copy
 253   MCOS->EmitIntValue(1, 1); // length of DW_LNS_advance_pc
 254   MCOS->EmitIntValue(1, 1); // length of DW_LNS_advance_line
 255   MCOS->EmitIntValue(1, 1); // length of DW_LNS_set_file
 256   MCOS->EmitIntValue(1, 1); // length of DW_LNS_set_column
 257   MCOS->EmitIntValue(0, 1); // length of DW_LNS_negate_stmt
 258   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_basic_block
 259   MCOS->EmitIntValue(0, 1); // length of DW_LNS_const_add_pc
 260   MCOS->EmitIntValue(1, 1); // length of DW_LNS_fixed_advance_pc
 261   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_prologue_end
 262   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_epilogue_begin
 263   MCOS->EmitIntValue(1, 1); // DW_LNS_set_isa
 264
 265   // Put out the directory and file tables.
 266
 267   // First the directory table.
 268   const std::vector<StringRef> &MCDwarfDirs =
 269     context.getMCDwarfDirs();
 270   for (unsigned i = 0; i < MCDwarfDirs.size(); i++) {
 271     MCOS->EmitBytes(MCDwarfDirs[i], 0); // the DirectoryName
 272     MCOS->EmitBytes(StringRef("\0", 1), 0); // the null term. of the string
 273   }
 274   MCOS->EmitIntValue(0, 1); // Terminate the directory list
 275
 276   // Second the file table.
 277   const std::vector<MCDwarfFile *> &MCDwarfFiles =
 278     MCOS->getContext().getMCDwarfFiles();
 279   for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
 280     MCOS->EmitBytes(MCDwarfFiles[i]->getName(), 0); // FileName
 281     MCOS->EmitBytes(StringRef("\0", 1), 0); // the null term. of the string
 282     // the Directory num
 283     MCOS->EmitULEB128IntValue(MCDwarfFiles[i]->getDirIndex());
 284     MCOS->EmitIntValue(0, 1); // last modification timestamp (always 0)
 285     MCOS->EmitIntValue(0, 1); // filesize (always 0)
 286   }
 287   MCOS->EmitIntValue(0, 1); // Terminate the file list
 288
 289   // This is the end of the prologue, so set the value of the symbol at the
 290   // end of the prologue (that was used in a previous expression).
 291   MCOS->EmitLabel(ProEndSym);
 292
 293   // Put out the line tables.
 294   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
 295     MCOS->getContext().getMCLineSections();
 296   const std::vector<const MCSection *> &MCLineSectionOrder =
 297     MCOS->getContext().getMCLineSectionOrder();
 298   for (std::vector<const MCSection*>::const_iterator it =
 299          MCLineSectionOrder.begin(), ie = MCLineSectionOrder.end(); it != ie;
 300        ++it) {
 301     const MCSection *Sec = *it;
 302     const MCLineSection *Line = MCLineSections.lookup(Sec);
 303     EmitDwarfLineTable(MCOS, Sec, Line);
 304
 305     // Now delete the MCLineSections that were created in MCLineEntry::Make()
 306     // and used to emit the line table.
 307     delete Line;
 308   }
 309
 310   if (MCOS->getContext().getAsmInfo().getLinkerRequiresNonEmptyDwarfLines()
 311       && MCLineSectionOrder.begin() == MCLineSectionOrder.end()) {
 312     // The darwin9 linker has a bug (see PR8715). For for 32-bit architectures
 313     // it requires:
 314     // total_length >= prologue_length + 10
 315     // We are 4 bytes short, since we have total_length = 51 and
 316     // prologue_length = 45
 317
 318     // The regular end_sequence should be sufficient.
 319     MCDwarfLineAddr::Emit(MCOS, INT64_MAX, 0);
 320   }
 321
 322   // This is the end of the section, so set the value of the symbol at the end
 323   // of this section (that was used in a previous expression).
 324   MCOS->EmitLabel(LineEndSym);
 325 }
 326
 327 /// Utility function to write the encoding to an object writer.
 328 void MCDwarfLineAddr::Write(MCObjectWriter *OW, int64_t LineDelta,
 329                             uint64_t AddrDelta) {
 330   SmallString<256> Tmp;
 331   raw_svector_ostream OS(Tmp);
 332   MCDwarfLineAddr::Encode(LineDelta, AddrDelta, OS);
 333   OW->WriteBytes(OS.str());
 334 }
 335
 336 /// Utility function to emit the encoding to a streamer.
 337 void MCDwarfLineAddr::Emit(MCStreamer *MCOS, int64_t LineDelta,
 338                            uint64_t AddrDelta) {
 339   SmallString<256> Tmp;
 340   raw_svector_ostream OS(Tmp);
 341   MCDwarfLineAddr::Encode(LineDelta, AddrDelta, OS);
 342   MCOS->EmitBytes(OS.str(), /*AddrSpace=*/0);
 343 }
 344
 345 /// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
 346 void MCDwarfLineAddr::Encode(int64_t LineDelta, uint64_t AddrDelta,
 347                              raw_ostream &OS) {
 348   uint64_t Temp, Opcode;
 349   bool NeedCopy = false;
 350
 351   // Scale the address delta by the minimum instruction length.
 352   AddrDelta = ScaleAddrDelta(AddrDelta);
 353
 354   // A LineDelta of INT64_MAX is a signal that this is actually a
 355   // DW_LNE_end_sequence. We cannot use special opcodes here, since we want the
 356   // end_sequence to emit the matrix entry.
 357   if (LineDelta == INT64_MAX) {
 358     if (AddrDelta == MAX_SPECIAL_ADDR_DELTA)
 359       OS << char(dwarf::DW_LNS_const_add_pc);
 360     else {
 361       OS << char(dwarf::DW_LNS_advance_pc);
 362       MCObjectWriter::EncodeULEB128(AddrDelta, OS);
 363     }
 364     OS << char(dwarf::DW_LNS_extended_op);
 365     OS << char(1);
 366     OS << char(dwarf::DW_LNE_end_sequence);
 367     return;
 368   }
 369
 370   // Bias the line delta by the base.
 371   Temp = LineDelta - DWARF2_LINE_BASE;
 372
 373   // If the line increment is out of range of a special opcode, we must encode
 374   // it with DW_LNS_advance_line.
 375   if (Temp >= DWARF2_LINE_RANGE) {
 376     OS << char(dwarf::DW_LNS_advance_line);
 377     MCObjectWriter::EncodeSLEB128(LineDelta, OS);
 378
 379     LineDelta = 0;
 380     Temp = 0 - DWARF2_LINE_BASE;
 381     NeedCopy = true;
 382   }
 383
 384   // Use DW_LNS_copy instead of a "line +0, addr +0" special opcode.
 385   if (LineDelta == 0 && AddrDelta == 0) {
 386     OS << char(dwarf::DW_LNS_copy);
 387     return;
 388   }
 389
 390   // Bias the opcode by the special opcode base.
 391   Temp += DWARF2_LINE_OPCODE_BASE;
 392
 393   // Avoid overflow when addr_delta is large.
 394   if (AddrDelta < 256 + MAX_SPECIAL_ADDR_DELTA) {
 395     // Try using a special opcode.
 396     Opcode = Temp + AddrDelta * DWARF2_LINE_RANGE;
 397     if (Opcode <= 255) {
 398       OS << char(Opcode);
 399       return;
 400     }
 401
 402     // Try using DW_LNS_const_add_pc followed by special op.
 403     Opcode = Temp + (AddrDelta - MAX_SPECIAL_ADDR_DELTA) * DWARF2_LINE_RANGE;
 404     if (Opcode <= 255) {
 405       OS << char(dwarf::DW_LNS_const_add_pc);
 406       OS << char(Opcode);
 407       return;
 408     }
 409   }
 410
 411   // Otherwise use DW_LNS_advance_pc.
 412   OS << char(dwarf::DW_LNS_advance_pc);
 413   MCObjectWriter::EncodeULEB128(AddrDelta, OS);
 414
 415   if (NeedCopy)
 416     OS << char(dwarf::DW_LNS_copy);
 417   else
 418     OS << char(Temp);
 419 }
 420
 421 void MCDwarfFile::print(raw_ostream &OS) const {
 422   OS << '"' << getName() << '"';
 423 }
 424
 425 void MCDwarfFile::dump() const {
 426   print(dbgs());
 427 }
 428
 429 // Utility function to write a tuple for .debug_abbrev.
 430 static void EmitAbbrev(MCStreamer *MCOS, uint64_t Name, uint64_t Form) {
 431   MCOS->EmitULEB128IntValue(Name);
 432   MCOS->EmitULEB128IntValue(Form);
 433 }
 434
 435 // When generating dwarf for assembly source files this emits
 436 // the data for .debug_abbrev section which contains three DIEs.
 437 static void EmitGenDwarfAbbrev(MCStreamer *MCOS) {
 438   MCContext &context = MCOS->getContext();
 439   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
 440
 441   // DW_TAG_compile_unit DIE abbrev (1).
 442   MCOS->EmitULEB128IntValue(1);
 443   MCOS->EmitULEB128IntValue(dwarf::DW_TAG_compile_unit);
 444   MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
 445   EmitAbbrev(MCOS, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4);
 446   EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
 447   EmitAbbrev(MCOS, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr);
 448   EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
 449   EmitAbbrev(MCOS, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string);
 450   StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
 451   if (!DwarfDebugFlags.empty())
 452     EmitAbbrev(MCOS, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string);
 453   EmitAbbrev(MCOS, dwarf::DW_AT_producer, dwarf::DW_FORM_string);
 454   EmitAbbrev(MCOS, dwarf::DW_AT_language, dwarf::DW_FORM_data2);
 455   EmitAbbrev(MCOS, 0, 0);
 456
 457   // DW_TAG_subprogram DIE abbrev (2).
 458   MCOS->EmitULEB128IntValue(2);
 459   MCOS->EmitULEB128IntValue(dwarf::DW_TAG_subprogram);
 460   MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
 461   EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
 462   EmitAbbrev(MCOS, dwarf::DW_AT_decl_file, dwarf::DW_FORM_data4);
 463   EmitAbbrev(MCOS, dwarf::DW_AT_decl_line, dwarf::DW_FORM_data4);
 464   EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
 465   EmitAbbrev(MCOS, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr);
 466   EmitAbbrev(MCOS, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag);
 467   EmitAbbrev(MCOS, 0, 0);
 468
 469   // DW_TAG_unspecified_parameters DIE abbrev (3).
 470   MCOS->EmitULEB128IntValue(3);
 471   MCOS->EmitULEB128IntValue(dwarf::DW_TAG_unspecified_parameters);
 472   MCOS->EmitIntValue(dwarf::DW_CHILDREN_no, 1);
 473   EmitAbbrev(MCOS, 0, 0);
 474
 475   // Terminate the abbreviations for this compilation unit.
 476   MCOS->EmitIntValue(0, 1);
 477 }
 478
 479 // When generating dwarf for assembly source files this emits the data for
 480 // .debug_aranges section.  Which contains a header and a table of pairs of
 481 // PointerSize'ed values for the address and size of section(s) with line table
 482 // entries (just the default .text in our case) and a terminating pair of zeros.
 483 static void EmitGenDwarfAranges(MCStreamer *MCOS) {
 484   MCContext &context = MCOS->getContext();
 485
 486   // Create a symbol at the end of the section that we are creating the dwarf
 487   // debugging info to use later in here as part of the expression to calculate
 488   // the size of the section for the table.
 489   MCOS->SwitchSection(context.getGenDwarfSection());
 490   MCSymbol *SectionEndSym = context.CreateTempSymbol();
 491   MCOS->EmitLabel(SectionEndSym);
 492   context.setGenDwarfSectionEndSym(SectionEndSym);
 493
 494   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
 495
 496   // This will be the length of the .debug_aranges section, first account for
 497   // the size of each item in the header (see below where we emit these items).
 498   int Length = 4 + 2 + 4 + 1 + 1;
 499
 500   // Figure the padding after the header before the table of address and size
 501   // pairs who's values are PointerSize'ed.
 502   const MCAsmInfo &asmInfo = context.getAsmInfo();
 503   int AddrSize = asmInfo.getPointerSize();
 504   int Pad = 2 * AddrSize - (Length & (2 * AddrSize - 1));
 505   if (Pad == 2 * AddrSize)
 506     Pad = 0;
 507   Length += Pad;
 508
 509   // Add the size of the pair of PointerSize'ed values for the address and size
 510   // of the one default .text section we have in the table.
 511   Length += 2 * AddrSize;
 512   // And the pair of terminating zeros.
 513   Length += 2 * AddrSize;
 514
 515
 516   // Emit the header for this section.
 517   // The 4 byte length not including the 4 byte value for the length.
 518   MCOS->EmitIntValue(Length - 4, 4);
 519   // The 2 byte version, which is 2.
 520   MCOS->EmitIntValue(2, 2);
 521   // The 4 byte offset to the compile unit in the .debug_info from the start
 522   // of the .debug_info, it is at the start of that section so this is zero.
 523   MCOS->EmitIntValue(0, 4);
 524   // The 1 byte size of an address.
 525   MCOS->EmitIntValue(AddrSize, 1);
 526   // The 1 byte size of a segment descriptor, we use a value of zero.
 527   MCOS->EmitIntValue(0, 1);
 528   // Align the header with the padding if needed, before we put out the table.
 529   for(int i = 0; i < Pad; i++)
 530     MCOS->EmitIntValue(0, 1);
 531
 532   // Now emit the table of pairs of PointerSize'ed values for the section(s)
 533   // address and size, in our case just the one default .text section.
 534   const MCExpr *Addr = MCSymbolRefExpr::Create(
 535     context.getGenDwarfSectionStartSym(), MCSymbolRefExpr::VK_None, context);
 536   const MCExpr *Size = MakeStartMinusEndExpr(*MCOS,
 537     *context.getGenDwarfSectionStartSym(), *SectionEndSym, 0);
 538   MCOS->EmitAbsValue(Addr, AddrSize);
 539   MCOS->EmitAbsValue(Size, AddrSize);
 540
 541   // And finally the pair of terminating zeros.
 542   MCOS->EmitIntValue(0, AddrSize);
 543   MCOS->EmitIntValue(0, AddrSize);
 544 }
 545
 546 // When generating dwarf for assembly source files this emits the data for
 547 // .debug_info section which contains three parts.  The header, the compile_unit
 548 // DIE and a list of subprogram DIEs.
 549 static void EmitGenDwarfInfo(MCStreamer *MCOS) {
 550   MCContext &context = MCOS->getContext();
 551
 552   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
 553
 554   // Create a symbol at the start and end of this section used in here for the
 555   // expression to calculate the length in the header.
 556   MCSymbol *InfoStart = context.CreateTempSymbol();
 557   MCOS->EmitLabel(InfoStart);
 558   MCSymbol *InfoEnd = context.CreateTempSymbol();
 559
 560   // First part: the header.
 561
 562   // The 4 byte total length of the information for this compilation unit, not
 563   // including these 4 bytes.
 564   const MCExpr *Length = MakeStartMinusEndExpr(*MCOS, *InfoStart, *InfoEnd, 4);
 565   MCOS->EmitAbsValue(Length, 4);
 566
 567   // The 2 byte DWARF version, which is 2.
 568   MCOS->EmitIntValue(2, 2);
 569
 570   // The 4 byte offset to the debug abbrevs from the start of the .debug_abbrev,
 571   // it is at the start of that section so this is zero.
 572   MCOS->EmitIntValue(0, 4);
 573
 574   const MCAsmInfo &asmInfo = context.getAsmInfo();
 575   int AddrSize = asmInfo.getPointerSize();
 576   // The 1 byte size of an address.
 577   MCOS->EmitIntValue(AddrSize, 1);
 578
 579   // Second part: the compile_unit DIE.
 580
 581   // The DW_TAG_compile_unit DIE abbrev (1).
 582   MCOS->EmitULEB128IntValue(1);
 583
 584   // DW_AT_stmt_list, a 4 byte offset from the start of the .debug_line section,
 585   // which is at the start of that section so this is zero.
 586   MCOS->EmitIntValue(0, 4);
 587
 588   // AT_low_pc, the first address of the default .text section.
 589   const MCExpr *Start = MCSymbolRefExpr::Create(
 590     context.getGenDwarfSectionStartSym(), MCSymbolRefExpr::VK_None, context);
 591   MCOS->EmitAbsValue(Start, AddrSize);
 592
 593   // AT_high_pc, the last address of the default .text section.
 594   const MCExpr *End = MCSymbolRefExpr::Create(
 595     context.getGenDwarfSectionEndSym(), MCSymbolRefExpr::VK_None, context);
 596   MCOS->EmitAbsValue(End, AddrSize);
 597
 598   // AT_name, the name of the source file.  Reconstruct from the first directory
 599   // and file table entries.
 600   const std::vector<StringRef> &MCDwarfDirs =
 601     context.getMCDwarfDirs();
 602   if (MCDwarfDirs.size() > 0) {
 603     MCOS->EmitBytes(MCDwarfDirs[0], 0);
 604     MCOS->EmitBytes("/", 0);
 605   }
 606   const std::vector<MCDwarfFile *> &MCDwarfFiles =
 607     MCOS->getContext().getMCDwarfFiles();
 608   MCOS->EmitBytes(MCDwarfFiles[1]->getName(), 0);
 609   MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 610
 611   // AT_comp_dir, the working directory the assembly was done in.
 612   llvm::sys::Path CWD = llvm::sys::Path::GetCurrentDirectory();
 613   MCOS->EmitBytes(StringRef(CWD.c_str()), 0);
 614   MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 615
 616   // AT_APPLE_flags, the command line arguments of the assembler tool.
 617   StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
 618   if (!DwarfDebugFlags.empty()){
 619     MCOS->EmitBytes(DwarfDebugFlags, 0);
 620     MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 621   }
 622
 623   // AT_producer, the version of the assembler tool.
 624   MCOS->EmitBytes(StringRef("llvm-mc (based on LLVM "), 0);
 625   MCOS->EmitBytes(StringRef(PACKAGE_VERSION), 0);
 626   MCOS->EmitBytes(StringRef(")"), 0);
 627   MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 628
 629   // AT_language, a 4 byte value.  We use DW_LANG_Mips_Assembler as the dwarf2
 630   // draft has no standard code for assembler.
 631   MCOS->EmitIntValue(dwarf::DW_LANG_Mips_Assembler, 2);
 632
 633   // Third part: the list of subprogram DIEs.
 634
 635   // Loop on saved info for dwarf subprograms and create the DIEs for them.
 636   const std::vector<const MCGenDwarfSubprogramEntry *> &Entries =
 637     MCOS->getContext().getMCGenDwarfSubprogramEntries();
 638   for (std::vector<const MCGenDwarfSubprogramEntry *>::const_iterator it =
 639        Entries.begin(), ie = Entries.end(); it != ie;
 640        ++it) {
 641     const MCGenDwarfSubprogramEntry *Entry = *it;
 642
 643     // The DW_TAG_subprogram DIE abbrev (2).
 644     MCOS->EmitULEB128IntValue(2);
 645
 646     // AT_name, of the label without any leading underbar.
 647     MCOS->EmitBytes(Entry->getName(), 0);
 648     MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 649
 650     // AT_decl_file, index into the file table.
 651     MCOS->EmitIntValue(Entry->getFileNumber(), 4);
 652
 653     // AT_decl_line, source line number.
 654     MCOS->EmitIntValue(Entry->getLineNumber(), 4);
 655
 656     // AT_low_pc, start address of the label.
 657     const MCExpr *AT_low_pc = MCSymbolRefExpr::Create(Entry->getLabel(),
 658                                              MCSymbolRefExpr::VK_None, context);
 659     MCOS->EmitAbsValue(AT_low_pc, AddrSize);
 660
 661     // AT_high_pc, end address which is the next label or end of the section.
 662     std::vector<const MCGenDwarfSubprogramEntry *>::const_iterator next = it+1;
 663     if (next != Entries.end()){
 664       const MCGenDwarfSubprogramEntry *NextEntry = *next;
 665       const MCExpr *AT_high_pc = MCSymbolRefExpr::Create(NextEntry->getLabel(),
 666                                              MCSymbolRefExpr::VK_None, context);
 667       MCOS->EmitAbsValue(AT_high_pc, AddrSize);
 668     } else {
 669       MCOS->EmitAbsValue(End, AddrSize);
 670     }
 671
 672     // DW_AT_prototyped, a one byte flag value of 0 saying we have no prototype.
 673     MCOS->EmitIntValue(0, 1);
 674
 675     // The DW_TAG_unspecified_parameters DIE abbrev (3).
 676     MCOS->EmitULEB128IntValue(3);
 677
 678     // Add the NULL DIE terminating the DW_TAG_unspecified_parameters DIE's.
 679     MCOS->EmitIntValue(0, 1);
 680   }
 681   // Deallocate the MCGenDwarfSubprogramEntry classes that saved away the info
 682   // for the dwarf subprograms.
 683   for (std::vector<const MCGenDwarfSubprogramEntry *>::const_iterator it =
 684        Entries.begin(), ie = Entries.end(); it != ie;
 685        ++it) {
 686     const MCGenDwarfSubprogramEntry *Entry = *it;
 687     delete Entry;
 688   }
 689
 690   // Add the NULL DIE terminating the Compile Unit DIE's.
 691   MCOS->EmitIntValue(0, 1);
 692
 693   // Now set the value of the symbol at the end of the info section.
 694   MCOS->EmitLabel(InfoEnd);
 695 }
 696
 697 //
 698 // When generating dwarf for assembly source files this emits the Dwarf
 699 // sections.
 700 //
 701 void MCGenDwarfInfo::Emit(MCStreamer *MCOS) {
 702   // Create the dwarf sections in this order (.debug_line already created).
 703   MCContext &context = MCOS->getContext();
 704   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
 705   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
 706   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
 707
 708   // If there are no line table entries then do not emit any section contents.
 709   if (context.getMCLineSections().empty())
 710     return;
 711
 712   // Output the data for .debug_aranges section.
 713   EmitGenDwarfAranges(MCOS);
 714
 715   // Output the data for .debug_abbrev section.
 716   EmitGenDwarfAbbrev(MCOS);
 717
 718   // Output the data for .debug_info section.
 719   EmitGenDwarfInfo(MCOS);
 720 }
 721
 722 //
 723 // When generating dwarf for assembly source files this is called when symbol
 724 // for a label is created.  If this symbol is not a temporary and is in the
 725 // section that dwarf is being generated for, save the needed info to create
 726 // a dwarf subprogram.
 727 //
 728 void MCGenDwarfSubprogramEntry::Make(MCSymbol *Symbol, MCStreamer *MCOS,
 729                                      SourceMgr &SrcMgr, SMLoc &Loc) {
 730   // We won't create dwarf subprogram's for temporary symbols or symbols not in
 731   // the default text.
 732   if (Symbol->isTemporary())
 733     return;
 734   MCContext &context = MCOS->getContext();
 735   if (context.getGenDwarfSection() != MCOS->getCurrentSection())
 736     return;
 737
 738   // The dwarf subprogram's name does not have the symbol name's leading
 739   // underbar if any.
 740   StringRef Name = Symbol->getName();
 741   if (Name.startswith("_"))
 742     Name = Name.substr(1, Name.size()-1);
 743
 744   // Get the dwarf file number to be used for the dwarf subprogram.
 745   unsigned FileNumber = context.getGenDwarfFileNumber();
 746
 747   // Finding the line number is the expensive part which is why we just don't
 748   // pass it in as for some symbols we won't create a dwarf subprogram.
 749   int CurBuffer = SrcMgr.FindBufferContainingLoc(Loc);
 750   unsigned LineNumber = SrcMgr.FindLineNumber(Loc, CurBuffer);
 751
 752   // We create a temporary symbol for use for the AT_high_pc and AT_low_pc
 753   // values so that they don't have things like an ARM thumb bit from the
 754   // original symbol. So when used they won't get a low bit set after
 755   // relocation.
 756   MCSymbol *Label = context.CreateTempSymbol();
 757   MCOS->EmitLabel(Label);
 758
 759   // Create and entry for the info and add it to the other entries.
 760   MCGenDwarfSubprogramEntry *Entry =
 761     new MCGenDwarfSubprogramEntry(Name, FileNumber, LineNumber, Label);
 762   MCOS->getContext().addMCGenDwarfSubprogramEntry(Entry);
 763 }
 764
 765 static int getDataAlignmentFactor(MCStreamer &streamer) {
 766   MCContext &context = streamer.getContext();
 767   const MCAsmInfo &asmInfo = context.getAsmInfo();
 768   int size = asmInfo.getPointerSize();
 769   if (asmInfo.isStackGrowthDirectionUp())
 770     return size;
 771   else
 772     return -size;
 773 }
 774
 775 static unsigned getSizeForEncoding(MCStreamer &streamer,
 776                                    unsigned symbolEncoding) {
 777   MCContext &context = streamer.getContext();
 778   unsigned format = symbolEncoding & 0x0f;
 779   switch (format) {
 780   default:
 781     assert(0 && "Unknown Encoding");
 782   case dwarf::DW_EH_PE_absptr:
 783   case dwarf::DW_EH_PE_signed:
 784     return context.getAsmInfo().getPointerSize();
 785   case dwarf::DW_EH_PE_udata2:
 786   case dwarf::DW_EH_PE_sdata2:
 787     return 2;
 788   case dwarf::DW_EH_PE_udata4:
 789   case dwarf::DW_EH_PE_sdata4:
 790     return 4;
 791   case dwarf::DW_EH_PE_udata8:
 792   case dwarf::DW_EH_PE_sdata8:
 793     return 8;
 794   }
 795 }
 796
 797 static void EmitSymbol(MCStreamer &streamer, const MCSymbol &symbol,
 798                        unsigned symbolEncoding, const char *comment = 0) {
 799   MCContext &context = streamer.getContext();
 800   const MCAsmInfo &asmInfo = context.getAsmInfo();
 801   const MCExpr *v = asmInfo.getExprForFDESymbol(&symbol,
 802                                                 symbolEncoding,
 803                                                 streamer);
 804   unsigned size = getSizeForEncoding(streamer, symbolEncoding);
 805   if (streamer.isVerboseAsm() && comment) streamer.AddComment(comment);
 806   streamer.EmitAbsValue(v, size);
 807 }
 808
 809 static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol,
 810                             unsigned symbolEncoding) {
 811   MCContext &context = streamer.getContext();
 812   const MCAsmInfo &asmInfo = context.getAsmInfo();
 813   const MCExpr *v = asmInfo.getExprForPersonalitySymbol(&symbol,
 814                                                         symbolEncoding,
 815                                                         streamer);
 816   unsigned size = getSizeForEncoding(streamer, symbolEncoding);
 817   streamer.EmitValue(v, size);
 818 }
 819
 820 static const MachineLocation TranslateMachineLocation(
 821                                                   const MCRegisterInfo &MRI,
 822                                                   const MachineLocation &Loc) {
 823   unsigned Reg = Loc.getReg() == MachineLocation::VirtualFP ?
 824     MachineLocation::VirtualFP :
 825     unsigned(MRI.getDwarfRegNum(Loc.getReg(), true));
 826   const MachineLocation &NewLoc = Loc.isReg() ?
 827     MachineLocation(Reg) : MachineLocation(Reg, Loc.getOffset());
 828   return NewLoc;
 829 }
 830
 831 namespace {
 832   class FrameEmitterImpl {
 833     int CFAOffset;
 834     int CIENum;
 835     bool UsingCFI;
 836     bool IsEH;
 837     const MCSymbol *SectionStart;
 838   public:
 839     FrameEmitterImpl(bool usingCFI, bool isEH)
 840       : CFAOffset(0), CIENum(0), UsingCFI(usingCFI), IsEH(isEH),
 841         SectionStart(0) {}
 842
 843     void setSectionStart(const MCSymbol *Label) { SectionStart = Label; }
 844
 845     /// EmitCompactUnwind - Emit the unwind information in a compact way. If
 846     /// we're successful, return 'true'. Otherwise, return 'false' and it will
 847     /// emit the normal CIE and FDE.
 848     bool EmitCompactUnwind(MCStreamer &streamer,
 849                            const MCDwarfFrameInfo &frame);
 850
 851     const MCSymbol &EmitCIE(MCStreamer &streamer,
 852                             const MCSymbol *personality,
 853                             unsigned personalityEncoding,
 854                             const MCSymbol *lsda,
 855                             unsigned lsdaEncoding);
 856     MCSymbol *EmitFDE(MCStreamer &streamer,
 857                       const MCSymbol &cieStart,
 858                       const MCDwarfFrameInfo &frame);
 859     void EmitCFIInstructions(MCStreamer &streamer,
 860                              const std::vector<MCCFIInstruction> &Instrs,
 861                              MCSymbol *BaseLabel);
 862     void EmitCFIInstruction(MCStreamer &Streamer,
 863                             const MCCFIInstruction &Instr);
 864   };
 865
 866 } // end anonymous namespace
 867
 868 static void EmitEncodingByte(MCStreamer &Streamer, unsigned Encoding,
 869                              StringRef Prefix) {
 870   if (Streamer.isVerboseAsm()) {
 871     const char *EncStr = 0;
 872     switch (Encoding) {
 873     default: EncStr = "<unknown encoding>";
 874     case dwarf::DW_EH_PE_absptr: EncStr = "absptr";
 875     case dwarf::DW_EH_PE_omit:   EncStr = "omit";
 876     case dwarf::DW_EH_PE_pcrel:  EncStr = "pcrel";
 877     case dwarf::DW_EH_PE_udata4: EncStr = "udata4";
 878     case dwarf::DW_EH_PE_udata8: EncStr = "udata8";
 879     case dwarf::DW_EH_PE_sdata4: EncStr = "sdata4";
 880     case dwarf::DW_EH_PE_sdata8: EncStr = "sdata8";
 881     case dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_udata4: EncStr = "pcrel udata4";
 882     case dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_sdata4: EncStr = "pcrel sdata4";
 883     case dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_udata8: EncStr = "pcrel udata8";
 884     case dwarf::DW_EH_PE_pcrel |dwarf::DW_EH_PE_sdata8: EncStr = "pcrel sdata8";
 885     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_udata4:
 886       EncStr = "indirect pcrel udata4";
 887     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_sdata4:
 888       EncStr = "indirect pcrel sdata4";
 889     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_udata8:
 890       EncStr = "indirect pcrel udata8";
 891     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_sdata8:
 892       EncStr = "indirect pcrel sdata8";
 893     }
 894
 895     Streamer.AddComment(Twine(Prefix) + " = " + EncStr);
 896   }
 897
 898   Streamer.EmitIntValue(Encoding, 1);
 899 }
 900
 901 void FrameEmitterImpl::EmitCFIInstruction(MCStreamer &Streamer,
 902                                           const MCCFIInstruction &Instr) {
 903   int dataAlignmentFactor = getDataAlignmentFactor(Streamer);
 904   bool VerboseAsm = Streamer.isVerboseAsm();
 905
 906   switch (Instr.getOperation()) {
 907   case MCCFIInstruction::Move:
 908   case MCCFIInstruction::RelMove: {
 909     const MachineLocation &Dst = Instr.getDestination();
 910     const MachineLocation &Src = Instr.getSource();
 911     const bool IsRelative = Instr.getOperation() == MCCFIInstruction::RelMove;
 912
 913     // If advancing cfa.
 914     if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
 915       if (Src.getReg() == MachineLocation::VirtualFP) {
 916         if (VerboseAsm) Streamer.AddComment("DW_CFA_def_cfa_offset");
 917         Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
 918       } else {
 919         if (VerboseAsm) Streamer.AddComment("DW_CFA_def_cfa");
 920         Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
 921         if (VerboseAsm) Streamer.AddComment(Twine("Reg ") +
 922                                             Twine(Src.getReg()));
 923         Streamer.EmitULEB128IntValue(Src.getReg());
 924       }
 925
 926       if (IsRelative)
 927         CFAOffset += Src.getOffset();
 928       else
 929         CFAOffset = -Src.getOffset();
 930
 931       if (VerboseAsm) Streamer.AddComment(Twine("Offset " + Twine(CFAOffset)));
 932       Streamer.EmitULEB128IntValue(CFAOffset);
 933       return;
 934     }
 935
 936     if (Src.isReg() && Src.getReg() == MachineLocation::VirtualFP) {
 937       assert(Dst.isReg() && "Machine move not supported yet.");
 938       if (VerboseAsm) Streamer.AddComment("DW_CFA_def_cfa_register");
 939       Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
 940       if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Dst.getReg()));
 941       Streamer.EmitULEB128IntValue(Dst.getReg());
 942       return;
 943     }
 944
 945     unsigned Reg = Src.getReg();
 946     int Offset = Dst.getOffset();
 947     if (IsRelative)
 948       Offset -= CFAOffset;
 949     Offset = Offset / dataAlignmentFactor;
 950
 951     if (Offset < 0) {
 952       if (VerboseAsm) Streamer.AddComment("DW_CFA_offset_extended_sf");
 953       Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
 954       if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
 955       Streamer.EmitULEB128IntValue(Reg);
 956       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
 957       Streamer.EmitSLEB128IntValue(Offset);
 958     } else if (Reg < 64) {
 959       if (VerboseAsm) Streamer.AddComment(Twine("DW_CFA_offset + Reg(") +
 960                                           Twine(Reg) + ")");
 961       Streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
 962       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
 963       Streamer.EmitULEB128IntValue(Offset);
 964     } else {
 965       if (VerboseAsm) Streamer.AddComment("DW_CFA_offset_extended");
 966       Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
 967       if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
 968       Streamer.EmitULEB128IntValue(Reg);
 969       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
 970       Streamer.EmitULEB128IntValue(Offset);
 971     }
 972     return;
 973   }
 974   case MCCFIInstruction::RememberState:
 975     if (VerboseAsm) Streamer.AddComment("DW_CFA_remember_state");
 976     Streamer.EmitIntValue(dwarf::DW_CFA_remember_state, 1);
 977     return;
 978   case MCCFIInstruction::RestoreState:
 979     if (VerboseAsm) Streamer.AddComment("DW_CFA_restore_state");
 980     Streamer.EmitIntValue(dwarf::DW_CFA_restore_state, 1);
 981     return;
 982   case MCCFIInstruction::SameValue: {
 983     unsigned Reg = Instr.getDestination().getReg();
 984     if (VerboseAsm) Streamer.AddComment("DW_CFA_same_value");
 985     Streamer.EmitIntValue(dwarf::DW_CFA_same_value, 1);
 986     if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
 987     Streamer.EmitULEB128IntValue(Reg);
 988     return;
 989   }
 990   case MCCFIInstruction::Restore: {
 991     unsigned Reg = Instr.getDestination().getReg();
 992     if (VerboseAsm) {
 993       Streamer.AddComment("DW_CFA_restore");
 994       Streamer.AddComment(Twine("Reg ") + Twine(Reg));
 995     }
 996     Streamer.EmitIntValue(dwarf::DW_CFA_restore | Reg, 1);
 997     return;
 998   }
 999   case MCCFIInstruction::Escape:
1000     if (VerboseAsm) Streamer.AddComment("Escape bytes");
1001     Streamer.EmitBytes(Instr.getValues(), 0);
1002     return;
1003   }
1004   llvm_unreachable("Unhandled case in switch");
1005 }
1006
1007 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1008 /// frame.
1009 void FrameEmitterImpl::EmitCFIInstructions(MCStreamer &streamer,
1010                                     const std::vector<MCCFIInstruction> &Instrs,
1011                                            MCSymbol *BaseLabel) {
1012   for (unsigned i = 0, N = Instrs.size(); i < N; ++i) {
1013     const MCCFIInstruction &Instr = Instrs[i];
1014     MCSymbol *Label = Instr.getLabel();
1015     // Throw out move if the label is invalid.
1016     if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
1017
1018     // Advance row if new location.
1019     if (BaseLabel && Label) {
1020       MCSymbol *ThisSym = Label;
1021       if (ThisSym != BaseLabel) {
1022         if (streamer.isVerboseAsm()) streamer.AddComment("DW_CFA_advance_loc4");
1023         streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
1024         BaseLabel = ThisSym;
1025       }
1026     }
1027
1028     EmitCFIInstruction(streamer, Instr);
1029   }
1030 }
1031
1032 /// EmitCompactUnwind - Emit the unwind information in a compact way. If we're
1033 /// successful, return 'true'. Otherwise, return 'false' and it will emit the
1034 /// normal CIE and FDE.
1035 bool FrameEmitterImpl::EmitCompactUnwind(MCStreamer &Streamer,
1036                                          const MCDwarfFrameInfo &Frame) {
1037   MCContext &Context = Streamer.getContext();
1038   const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1039   bool VerboseAsm = Streamer.isVerboseAsm();
1040
1041   // range-start range-length  compact-unwind-enc personality-func   lsda
1042   //  _foo       LfooEnd-_foo  0x00000023          0                 0
1043   //  _bar       LbarEnd-_bar  0x00000025         __gxx_personality  except_tab1
1044   //
1045   //   .section __LD,__compact_unwind,regular,debug
1046   //
1047   //   # compact unwind for _foo
1048   //   .quad _foo
1049   //   .set L1,LfooEnd-_foo
1050   //   .long L1
1051   //   .long 0x01010001
1052   //   .quad 0
1053   //   .quad 0
1054   //
1055   //   # compact unwind for _bar
1056   //   .quad _bar
1057   //   .set L2,LbarEnd-_bar
1058   //   .long L2
1059   //   .long 0x01020011
1060   //   .quad __gxx_personality
1061   //   .quad except_tab1
1062
1063   uint32_t Encoding = Frame.CompactUnwindEncoding;
1064   if (!Encoding) return false;
1065
1066   // The encoding needs to know we have an LSDA.
1067   if (Frame.Lsda)
1068     Encoding |= 0x40000000;
1069
1070   Streamer.SwitchSection(MOFI->getCompactUnwindSection());
1071
1072   // Range Start
1073   unsigned FDEEncoding = MOFI->getFDEEncoding(UsingCFI);
1074   unsigned Size = getSizeForEncoding(Streamer, FDEEncoding);
1075   if (VerboseAsm) Streamer.AddComment("Range Start");
1076   Streamer.EmitSymbolValue(Frame.Function, Size);
1077
1078   // Range Length
1079   const MCExpr *Range = MakeStartMinusEndExpr(Streamer, *Frame.Begin,
1080                                               *Frame.End, 0);
1081   if (VerboseAsm) Streamer.AddComment("Range Length");
1082   Streamer.EmitAbsValue(Range, 4);
1083
1084   // Compact Encoding
1085   Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_udata4);
1086   if (VerboseAsm) Streamer.AddComment("Compact Unwind Encoding: 0x" +
1087                                       Twine::utohexstr(Encoding));
1088   Streamer.EmitIntValue(Encoding, Size);
1089
1090
1091   // Personality Function
1092   Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_absptr);
1093   if (VerboseAsm) Streamer.AddComment("Personality Function");
1094   if (Frame.Personality)
1095     Streamer.EmitSymbolValue(Frame.Personality, Size);
1096   else
1097     Streamer.EmitIntValue(0, Size); // No personality fn
1098
1099   // LSDA
1100   Size = getSizeForEncoding(Streamer, Frame.LsdaEncoding);
1101   if (VerboseAsm) Streamer.AddComment("LSDA");
1102   if (Frame.Lsda)
1103     Streamer.EmitSymbolValue(Frame.Lsda, Size);
1104   else
1105     Streamer.EmitIntValue(0, Size); // No LSDA
1106
1107   return true;
1108 }
1109
1110 const MCSymbol &FrameEmitterImpl::EmitCIE(MCStreamer &streamer,
1111                                           const MCSymbol *personality,
1112                                           unsigned personalityEncoding,
1113                                           const MCSymbol *lsda,
1114                                           unsigned lsdaEncoding) {
1115   MCContext &context = streamer.getContext();
1116   const MCRegisterInfo &MRI = context.getRegisterInfo();
1117   const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1118   bool verboseAsm = streamer.isVerboseAsm();
1119
1120   MCSymbol *sectionStart;
1121   if (MOFI->isFunctionEHFrameSymbolPrivate() || !IsEH)
1122     sectionStart = context.CreateTempSymbol();
1123   else
1124     sectionStart = context.GetOrCreateSymbol(Twine("EH_frame") + Twine(CIENum));
1125
1126   streamer.EmitLabel(sectionStart);
1127   CIENum++;
1128
1129   MCSymbol *sectionEnd = context.CreateTempSymbol();
1130
1131   // Length
1132   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *sectionStart,
1133                                                *sectionEnd, 4);
1134   if (verboseAsm) streamer.AddComment("CIE Length");
1135   streamer.EmitAbsValue(Length, 4);
1136
1137   // CIE ID
1138   unsigned CIE_ID = IsEH ? 0 : -1;
1139   if (verboseAsm) streamer.AddComment("CIE ID Tag");
1140   streamer.EmitIntValue(CIE_ID, 4);
1141
1142   // Version
1143   if (verboseAsm) streamer.AddComment("DW_CIE_VERSION");
1144   streamer.EmitIntValue(dwarf::DW_CIE_VERSION, 1);
1145
1146   // Augmentation String
1147   SmallString<8> Augmentation;
1148   if (IsEH) {
1149     if (verboseAsm) streamer.AddComment("CIE Augmentation");
1150     Augmentation += "z";
1151     if (personality)
1152       Augmentation += "P";
1153     if (lsda)
1154       Augmentation += "L";
1155     Augmentation += "R";
1156     streamer.EmitBytes(Augmentation.str(), 0);
1157   }
1158   streamer.EmitIntValue(0, 1);
1159
1160   // Code Alignment Factor
1161   if (verboseAsm) streamer.AddComment("CIE Code Alignment Factor");
1162   streamer.EmitULEB128IntValue(1);
1163
1164   // Data Alignment Factor
1165   if (verboseAsm) streamer.AddComment("CIE Data Alignment Factor");
1166   streamer.EmitSLEB128IntValue(getDataAlignmentFactor(streamer));
1167
1168   // Return Address Register
1169   if (verboseAsm) streamer.AddComment("CIE Return Address Column");
1170   streamer.EmitULEB128IntValue(MRI.getDwarfRegNum(MRI.getRARegister(), true));
1171
1172   // Augmentation Data Length (optional)
1173
1174   unsigned augmentationLength = 0;
1175   if (IsEH) {
1176     if (personality) {
1177       // Personality Encoding
1178       augmentationLength += 1;
1179       // Personality
1180       augmentationLength += getSizeForEncoding(streamer, personalityEncoding);
1181     }
1182     if (lsda)
1183       augmentationLength += 1;
1184     // Encoding of the FDE pointers
1185     augmentationLength += 1;
1186
1187     if (verboseAsm) streamer.AddComment("Augmentation Size");
1188     streamer.EmitULEB128IntValue(augmentationLength);
1189
1190     // Augmentation Data (optional)
1191     if (personality) {
1192       // Personality Encoding
1193       EmitEncodingByte(streamer, personalityEncoding,
1194                        "Personality Encoding");
1195       // Personality
1196       if (verboseAsm) streamer.AddComment("Personality");
1197       EmitPersonality(streamer, *personality, personalityEncoding);
1198     }
1199
1200     if (lsda)
1201       EmitEncodingByte(streamer, lsdaEncoding, "LSDA Encoding");
1202
1203     // Encoding of the FDE pointers
1204     EmitEncodingByte(streamer, MOFI->getFDEEncoding(UsingCFI),
1205                      "FDE Encoding");
1206   }
1207
1208   // Initial Instructions
1209
1210   const MCAsmInfo &MAI = context.getAsmInfo();
1211   const std::vector<MachineMove> &Moves = MAI.getInitialFrameState();
1212   std::vector<MCCFIInstruction> Instructions;
1213
1214   for (int i = 0, n = Moves.size(); i != n; ++i) {
1215     MCSymbol *Label = Moves[i].getLabel();
1216     const MachineLocation &Dst =
1217       TranslateMachineLocation(MRI, Moves[i].getDestination());
1218     const MachineLocation &Src =
1219       TranslateMachineLocation(MRI, Moves[i].getSource());
1220     MCCFIInstruction Inst(Label, Dst, Src);
1221     Instructions.push_back(Inst);
1222   }
1223
1224   EmitCFIInstructions(streamer, Instructions, NULL);
1225
1226   // Padding
1227   streamer.EmitValueToAlignment(IsEH
1228                                 ? 4 : context.getAsmInfo().getPointerSize());
1229
1230   streamer.EmitLabel(sectionEnd);
1231   return *sectionStart;
1232 }
1233
1234 MCSymbol *FrameEmitterImpl::EmitFDE(MCStreamer &streamer,
1235                                     const MCSymbol &cieStart,
1236                                     const MCDwarfFrameInfo &frame) {
1237   MCContext &context = streamer.getContext();
1238   MCSymbol *fdeStart = context.CreateTempSymbol();
1239   MCSymbol *fdeEnd = context.CreateTempSymbol();
1240   const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1241   bool verboseAsm = streamer.isVerboseAsm();
1242
1243   if (IsEH && frame.Function && !MOFI->isFunctionEHFrameSymbolPrivate()) {
1244     MCSymbol *EHSym =
1245       context.GetOrCreateSymbol(frame.Function->getName() + Twine(".eh"));
1246     streamer.EmitEHSymAttributes(frame.Function, EHSym);
1247     streamer.EmitLabel(EHSym);
1248   }
1249
1250   // Length
1251   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *fdeStart, *fdeEnd, 0);
1252   if (verboseAsm) streamer.AddComment("FDE Length");
1253   streamer.EmitAbsValue(Length, 4);
1254
1255   streamer.EmitLabel(fdeStart);
1256
1257   // CIE Pointer
1258   const MCAsmInfo &asmInfo = context.getAsmInfo();
1259   if (IsEH) {
1260     const MCExpr *offset = MakeStartMinusEndExpr(streamer, cieStart, *fdeStart,
1261                                                  0);
1262     if (verboseAsm) streamer.AddComment("FDE CIE Offset");
1263     streamer.EmitAbsValue(offset, 4);
1264   } else if (!asmInfo.doesDwarfRequireRelocationForSectionOffset()) {
1265     const MCExpr *offset = MakeStartMinusEndExpr(streamer, *SectionStart,
1266                                                  cieStart, 0);
1267     streamer.EmitAbsValue(offset, 4);
1268   } else {
1269     streamer.EmitSymbolValue(&cieStart, 4);
1270   }
1271
1272   unsigned fdeEncoding = MOFI->getFDEEncoding(UsingCFI);
1273   unsigned size = getSizeForEncoding(streamer, fdeEncoding);
1274
1275   // PC Begin
1276   unsigned PCBeginEncoding = IsEH ? fdeEncoding :
1277     (unsigned)dwarf::DW_EH_PE_absptr;
1278   unsigned PCBeginSize = getSizeForEncoding(streamer, PCBeginEncoding);
1279   EmitSymbol(streamer, *frame.Begin, PCBeginEncoding, "FDE initial location");
1280
1281   // PC Range
1282   const MCExpr *Range = MakeStartMinusEndExpr(streamer, *frame.Begin,
1283                                               *frame.End, 0);
1284   if (verboseAsm) streamer.AddComment("FDE address range");
1285   streamer.EmitAbsValue(Range, size);
1286
1287   if (IsEH) {
1288     // Augmentation Data Length
1289     unsigned augmentationLength = 0;
1290
1291     if (frame.Lsda)
1292       augmentationLength += getSizeForEncoding(streamer, frame.LsdaEncoding);
1293
1294     if (verboseAsm) streamer.AddComment("Augmentation size");
1295     streamer.EmitULEB128IntValue(augmentationLength);
1296
1297     // Augmentation Data
1298     if (frame.Lsda)
1299       EmitSymbol(streamer, *frame.Lsda, frame.LsdaEncoding,
1300                  "Language Specific Data Area");
1301   }
1302
1303   // Call Frame Instructions
1304
1305   EmitCFIInstructions(streamer, frame.Instructions, frame.Begin);
1306
1307   // Padding
1308   streamer.EmitValueToAlignment(PCBeginSize);
1309
1310   return fdeEnd;
1311 }
1312
1313 namespace {
1314   struct CIEKey {
1315     static const CIEKey getEmptyKey() { return CIEKey(0, 0, -1); }
1316     static const CIEKey getTombstoneKey() { return CIEKey(0, -1, 0); }
1317
1318     CIEKey(const MCSymbol* Personality_, unsigned PersonalityEncoding_,
1319            unsigned LsdaEncoding_) : Personality(Personality_),
1320                                      PersonalityEncoding(PersonalityEncoding_),
1321                                      LsdaEncoding(LsdaEncoding_) {
1322     }
1323     const MCSymbol* Personality;
1324     unsigned PersonalityEncoding;
1325     unsigned LsdaEncoding;
1326   };
1327 }
1328
1329 namespace llvm {
1330   template <>
1331   struct DenseMapInfo<CIEKey> {
1332     static CIEKey getEmptyKey() {
1333       return CIEKey::getEmptyKey();
1334     }
1335     static CIEKey getTombstoneKey() {
1336       return CIEKey::getTombstoneKey();
1337     }
1338     static unsigned getHashValue(const CIEKey &Key) {
1339       FoldingSetNodeID ID;
1340       ID.AddPointer(Key.Personality);
1341       ID.AddInteger(Key.PersonalityEncoding);
1342       ID.AddInteger(Key.LsdaEncoding);
1343       return ID.ComputeHash();
1344     }
1345     static bool isEqual(const CIEKey &LHS,
1346                         const CIEKey &RHS) {
1347       return LHS.Personality == RHS.Personality &&
1348         LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
1349         LHS.LsdaEncoding == RHS.LsdaEncoding;
1350     }
1351   };
1352 }
1353
1354 void MCDwarfFrameEmitter::Emit(MCStreamer &Streamer,
1355                                bool UsingCFI,
1356                                bool IsEH) {
1357   MCContext &Context = Streamer.getContext();
1358   MCObjectFileInfo *MOFI =
1359     const_cast<MCObjectFileInfo*>(Context.getObjectFileInfo());
1360   FrameEmitterImpl Emitter(UsingCFI, IsEH);
1361   ArrayRef<MCDwarfFrameInfo> FrameArray = Streamer.getFrameInfos();
1362
1363   // Emit the compact unwind info if available.
1364   if (IsEH && MOFI->getCompactUnwindSection())
1365     for (unsigned i = 0, n = Streamer.getNumFrameInfos(); i < n; ++i) {
1366       const MCDwarfFrameInfo &Frame = Streamer.getFrameInfo(i);
1367       if (Frame.CompactUnwindEncoding)
1368         Emitter.EmitCompactUnwind(Streamer, Frame);
1369     }
1370
1371   const MCSection &Section = IsEH ? *MOFI->getEHFrameSection() :
1372                                     *MOFI->getDwarfFrameSection();
1373   Streamer.SwitchSection(&Section);
1374   MCSymbol *SectionStart = Context.CreateTempSymbol();
1375   Streamer.EmitLabel(SectionStart);
1376   Emitter.setSectionStart(SectionStart);
1377
1378   MCSymbol *FDEEnd = NULL;
1379   DenseMap<CIEKey, const MCSymbol*> CIEStarts;
1380
1381   const MCSymbol *DummyDebugKey = NULL;
1382   for (unsigned i = 0, n = FrameArray.size(); i < n; ++i) {
1383     const MCDwarfFrameInfo &Frame = FrameArray[i];
1384     CIEKey Key(Frame.Personality, Frame.PersonalityEncoding,
1385                Frame.LsdaEncoding);
1386     const MCSymbol *&CIEStart = IsEH ? CIEStarts[Key] : DummyDebugKey;
1387     if (!CIEStart)
1388       CIEStart = &Emitter.EmitCIE(Streamer, Frame.Personality,
1389                                   Frame.PersonalityEncoding, Frame.Lsda,
1390                                   Frame.LsdaEncoding);
1391
1392     FDEEnd = Emitter.EmitFDE(Streamer, *CIEStart, Frame);
1393
1394     if (i != n - 1)
1395       Streamer.EmitLabel(FDEEnd);
1396   }
1397
1398   Streamer.EmitValueToAlignment(Context.getAsmInfo().getPointerSize());
1399   if (FDEEnd)
1400     Streamer.EmitLabel(FDEEnd);
1401 }
1402
1403 void MCDwarfFrameEmitter::EmitAdvanceLoc(MCStreamer &Streamer,
1404                                          uint64_t AddrDelta) {
1405   SmallString<256> Tmp;
1406   raw_svector_ostream OS(Tmp);
1407   MCDwarfFrameEmitter::EncodeAdvanceLoc(AddrDelta, OS);
1408   Streamer.EmitBytes(OS.str(), /*AddrSpace=*/0);
1409 }
1410
1411 void MCDwarfFrameEmitter::EncodeAdvanceLoc(uint64_t AddrDelta,
1412                                            raw_ostream &OS) {
1413   // FIXME: Assumes the code alignment factor is 1.
1414   if (AddrDelta == 0) {
1415   } else if (isUIntN(6, AddrDelta)) {
1416     uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
1417     OS << Opcode;
1418   } else if (isUInt<8>(AddrDelta)) {
1419     OS << uint8_t(dwarf::DW_CFA_advance_loc1);
1420     OS << uint8_t(AddrDelta);
1421   } else if (isUInt<16>(AddrDelta)) {
1422     // FIXME: check what is the correct behavior on a big endian machine.
1423     OS << uint8_t(dwarf::DW_CFA_advance_loc2);
1424     OS << uint8_t( AddrDelta       & 0xff);
1425     OS << uint8_t((AddrDelta >> 8) & 0xff);
1426   } else {
1427     // FIXME: check what is the correct behavior on a big endian machine.
1428     assert(isUInt<32>(AddrDelta));
1429     OS << uint8_t(dwarf::DW_CFA_advance_loc4);
1430     OS << uint8_t( AddrDelta        & 0xff);
1431     OS << uint8_t((AddrDelta >> 8)  & 0xff);
1432     OS << uint8_t((AddrDelta >> 16) & 0xff);
1433     OS << uint8_t((AddrDelta >> 24) & 0xff);
1434
1435   }
1436 }