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