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