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     EmitAbbrev(MCOS, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4);
 524   } else {
 525     EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
 526     EmitAbbrev(MCOS, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr);
 527   }
 528   EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
 529   if (!context.getCompilationDir().empty())
 530     EmitAbbrev(MCOS, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string);
 531   StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
 532   if (!DwarfDebugFlags.empty())
 533     EmitAbbrev(MCOS, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string);
 534   EmitAbbrev(MCOS, dwarf::DW_AT_producer, dwarf::DW_FORM_string);
 535   EmitAbbrev(MCOS, dwarf::DW_AT_language, dwarf::DW_FORM_data2);
 536   EmitAbbrev(MCOS, 0, 0);
 537
 538   // DW_TAG_label DIE abbrev (2).
 539   MCOS->EmitULEB128IntValue(2);
 540   MCOS->EmitULEB128IntValue(dwarf::DW_TAG_label);
 541   MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
 542   EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
 543   EmitAbbrev(MCOS, dwarf::DW_AT_decl_file, dwarf::DW_FORM_data4);
 544   EmitAbbrev(MCOS, dwarf::DW_AT_decl_line, dwarf::DW_FORM_data4);
 545   EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
 546   EmitAbbrev(MCOS, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag);
 547   EmitAbbrev(MCOS, 0, 0);
 548
 549   // DW_TAG_unspecified_parameters DIE abbrev (3).
 550   MCOS->EmitULEB128IntValue(3);
 551   MCOS->EmitULEB128IntValue(dwarf::DW_TAG_unspecified_parameters);
 552   MCOS->EmitIntValue(dwarf::DW_CHILDREN_no, 1);
 553   EmitAbbrev(MCOS, 0, 0);
 554
 555   // Terminate the abbreviations for this compilation unit.
 556   MCOS->EmitIntValue(0, 1);
 557 }
 558
 559 // When generating dwarf for assembly source files this emits the data for
 560 // .debug_aranges section. This section contains a header and a table of pairs
 561 // of PointerSize'ed values for the address and size of section(s) with line
 562 // table entries.
 563 static void EmitGenDwarfAranges(MCStreamer *MCOS,
 564                                 const MCSymbol *InfoSectionSymbol) {
 565   MCContext &context = MCOS->getContext();
 566
 567   auto &Sections = context.getGenDwarfSectionSyms();
 568
 569   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
 570
 571   // This will be the length of the .debug_aranges section, first account for
 572   // the size of each item in the header (see below where we emit these items).
 573   int Length = 4 + 2 + 4 + 1 + 1;
 574
 575   // Figure the padding after the header before the table of address and size
 576   // pairs who's values are PointerSize'ed.
 577   const MCAsmInfo *asmInfo = context.getAsmInfo();
 578   int AddrSize = asmInfo->getPointerSize();
 579   int Pad = 2 * AddrSize - (Length & (2 * AddrSize - 1));
 580   if (Pad == 2 * AddrSize)
 581     Pad = 0;
 582   Length += Pad;
 583
 584   // Add the size of the pair of PointerSize'ed values for the address and size
 585   // of each section we have in the table.
 586   Length += 2 * AddrSize * Sections.size();
 587   // And the pair of terminating zeros.
 588   Length += 2 * AddrSize;
 589
 590
 591   // Emit the header for this section.
 592   // The 4 byte length not including the 4 byte value for the length.
 593   MCOS->EmitIntValue(Length - 4, 4);
 594   // The 2 byte version, which is 2.
 595   MCOS->EmitIntValue(2, 2);
 596   // The 4 byte offset to the compile unit in the .debug_info from the start
 597   // of the .debug_info.
 598   if (InfoSectionSymbol)
 599     MCOS->EmitSymbolValue(InfoSectionSymbol, 4);
 600   else
 601     MCOS->EmitIntValue(0, 4);
 602   // The 1 byte size of an address.
 603   MCOS->EmitIntValue(AddrSize, 1);
 604   // The 1 byte size of a segment descriptor, we use a value of zero.
 605   MCOS->EmitIntValue(0, 1);
 606   // Align the header with the padding if needed, before we put out the table.
 607   for(int i = 0; i < Pad; i++)
 608     MCOS->EmitIntValue(0, 1);
 609
 610   // Now emit the table of pairs of PointerSize'ed values for the section
 611   // addresses and sizes.
 612   for (const auto &sec : Sections) {
 613     MCSymbol *StartSymbol = sec.second.first;
 614     MCSymbol *EndSymbol = sec.second.second;
 615     assert(StartSymbol && "StartSymbol must not be NULL");
 616     assert(EndSymbol && "EndSymbol must not be NULL");
 617
 618     const MCExpr *Addr = MCSymbolRefExpr::Create(
 619       StartSymbol, MCSymbolRefExpr::VK_None, context);
 620     const MCExpr *Size = MakeStartMinusEndExpr(*MCOS,
 621       *StartSymbol, *EndSymbol, 0);
 622     MCOS->EmitValue(Addr, AddrSize);
 623     MCOS->EmitAbsValue(Size, AddrSize);
 624   }
 625
 626   // And finally the pair of terminating zeros.
 627   MCOS->EmitIntValue(0, AddrSize);
 628   MCOS->EmitIntValue(0, AddrSize);
 629 }
 630
 631 // When generating dwarf for assembly source files this emits the data for
 632 // .debug_info section which contains three parts.  The header, the compile_unit
 633 // DIE and a list of label DIEs.
 634 static void EmitGenDwarfInfo(MCStreamer *MCOS,
 635                              const MCSymbol *AbbrevSectionSymbol,
 636                              const MCSymbol *LineSectionSymbol,
 637                              const MCSymbol *RangesSectionSymbol) {
 638   MCContext &context = MCOS->getContext();
 639
 640   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
 641
 642   // Create a symbol at the start and end of this section used in here for the
 643   // expression to calculate the length in the header.
 644   MCSymbol *InfoStart = context.CreateTempSymbol();
 645   MCOS->EmitLabel(InfoStart);
 646   MCSymbol *InfoEnd = context.CreateTempSymbol();
 647
 648   // First part: the header.
 649
 650   // The 4 byte total length of the information for this compilation unit, not
 651   // including these 4 bytes.
 652   const MCExpr *Length = MakeStartMinusEndExpr(*MCOS, *InfoStart, *InfoEnd, 4);
 653   MCOS->EmitAbsValue(Length, 4);
 654
 655   // The 2 byte DWARF version.
 656   MCOS->EmitIntValue(context.getDwarfVersion(), 2);
 657
 658   // The 4 byte offset to the debug abbrevs from the start of the .debug_abbrev,
 659   // it is at the start of that section so this is zero.
 660   if (AbbrevSectionSymbol) {
 661     MCOS->EmitSymbolValue(AbbrevSectionSymbol, 4);
 662   } else {
 663     MCOS->EmitIntValue(0, 4);
 664   }
 665
 666   const MCAsmInfo *asmInfo = context.getAsmInfo();
 667   int AddrSize = asmInfo->getPointerSize();
 668   // The 1 byte size of an address.
 669   MCOS->EmitIntValue(AddrSize, 1);
 670
 671   // Second part: the compile_unit DIE.
 672
 673   // The DW_TAG_compile_unit DIE abbrev (1).
 674   MCOS->EmitULEB128IntValue(1);
 675
 676   // DW_AT_stmt_list, a 4 byte offset from the start of the .debug_line section,
 677   // which is at the start of that section so this is zero.
 678   if (LineSectionSymbol) {
 679     MCOS->EmitSymbolValue(LineSectionSymbol, 4);
 680   } else {
 681     MCOS->EmitIntValue(0, 4);
 682   }
 683
 684   if (RangesSectionSymbol) {
 685     // There are multiple sections containing code, so we must use the
 686     // .debug_ranges sections.
 687
 688     // AT_ranges, the 4 byte offset from the start of the .debug_ranges section
 689     // to the address range list for this compilation unit.
 690     MCOS->EmitSymbolValue(RangesSectionSymbol, 4);
 691   } else {
 692     // If we only have one non-empty code section, we can use the simpler
 693     // AT_low_pc and AT_high_pc attributes.
 694
 695     // Find the first (and only) non-empty text section
 696     auto &Sections = context.getGenDwarfSectionSyms();
 697     const auto TextSection = Sections.begin();
 698     assert(TextSection != Sections.end() && "No text section found");
 699
 700     MCSymbol *StartSymbol = TextSection->second.first;
 701     MCSymbol *EndSymbol = TextSection->second.second;
 702     assert(StartSymbol && "StartSymbol must not be NULL");
 703     assert(EndSymbol && "EndSymbol must not be NULL");
 704
 705     // AT_low_pc, the first address of the default .text section.
 706     const MCExpr *Start = MCSymbolRefExpr::Create(
 707         StartSymbol, MCSymbolRefExpr::VK_None, context);
 708     MCOS->EmitValue(Start, AddrSize);
 709
 710     // AT_high_pc, the last address of the default .text section.
 711     const MCExpr *End = MCSymbolRefExpr::Create(
 712       EndSymbol, MCSymbolRefExpr::VK_None, context);
 713     MCOS->EmitValue(End, AddrSize);
 714   }
 715
 716   // AT_name, the name of the source file.  Reconstruct from the first directory
 717   // and file table entries.
 718   const SmallVectorImpl<std::string> &MCDwarfDirs = context.getMCDwarfDirs();
 719   if (MCDwarfDirs.size() > 0) {
 720     MCOS->EmitBytes(MCDwarfDirs[0]);
 721     MCOS->EmitBytes(sys::path::get_separator());
 722   }
 723   const SmallVectorImpl<MCDwarfFile> &MCDwarfFiles =
 724     MCOS->getContext().getMCDwarfFiles();
 725   MCOS->EmitBytes(MCDwarfFiles[1].Name);
 726   MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 727
 728   // AT_comp_dir, the working directory the assembly was done in.
 729   if (!context.getCompilationDir().empty()) {
 730     MCOS->EmitBytes(context.getCompilationDir());
 731     MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 732   }
 733
 734   // AT_APPLE_flags, the command line arguments of the assembler tool.
 735   StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
 736   if (!DwarfDebugFlags.empty()){
 737     MCOS->EmitBytes(DwarfDebugFlags);
 738     MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 739   }
 740
 741   // AT_producer, the version of the assembler tool.
 742   StringRef DwarfDebugProducer = context.getDwarfDebugProducer();
 743   if (!DwarfDebugProducer.empty())
 744     MCOS->EmitBytes(DwarfDebugProducer);
 745   else
 746     MCOS->EmitBytes(StringRef("llvm-mc (based on LLVM " PACKAGE_VERSION ")"));
 747   MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 748
 749   // AT_language, a 4 byte value.  We use DW_LANG_Mips_Assembler as the dwarf2
 750   // draft has no standard code for assembler.
 751   MCOS->EmitIntValue(dwarf::DW_LANG_Mips_Assembler, 2);
 752
 753   // Third part: the list of label DIEs.
 754
 755   // Loop on saved info for dwarf labels and create the DIEs for them.
 756   const std::vector<MCGenDwarfLabelEntry> &Entries =
 757       MCOS->getContext().getMCGenDwarfLabelEntries();
 758   for (const auto &Entry : Entries) {
 759     // The DW_TAG_label DIE abbrev (2).
 760     MCOS->EmitULEB128IntValue(2);
 761
 762     // AT_name, of the label without any leading underbar.
 763     MCOS->EmitBytes(Entry.getName());
 764     MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
 765
 766     // AT_decl_file, index into the file table.
 767     MCOS->EmitIntValue(Entry.getFileNumber(), 4);
 768
 769     // AT_decl_line, source line number.
 770     MCOS->EmitIntValue(Entry.getLineNumber(), 4);
 771
 772     // AT_low_pc, start address of the label.
 773     const MCExpr *AT_low_pc = MCSymbolRefExpr::Create(Entry.getLabel(),
 774                                              MCSymbolRefExpr::VK_None, context);
 775     MCOS->EmitValue(AT_low_pc, AddrSize);
 776
 777     // DW_AT_prototyped, a one byte flag value of 0 saying we have no prototype.
 778     MCOS->EmitIntValue(0, 1);
 779
 780     // The DW_TAG_unspecified_parameters DIE abbrev (3).
 781     MCOS->EmitULEB128IntValue(3);
 782
 783     // Add the NULL DIE terminating the DW_TAG_unspecified_parameters DIE's.
 784     MCOS->EmitIntValue(0, 1);
 785   }
 786
 787   // Add the NULL DIE terminating the Compile Unit DIE's.
 788   MCOS->EmitIntValue(0, 1);
 789
 790   // Now set the value of the symbol at the end of the info section.
 791   MCOS->EmitLabel(InfoEnd);
 792 }
 793
 794 // When generating dwarf for assembly source files this emits the data for
 795 // .debug_ranges section. We only emit one range list, which spans all of the
 796 // executable sections of this file.
 797 static void EmitGenDwarfRanges(MCStreamer *MCOS) {
 798   MCContext &context = MCOS->getContext();
 799   auto &Sections = context.getGenDwarfSectionSyms();
 800
 801   const MCAsmInfo *AsmInfo = context.getAsmInfo();
 802   int AddrSize = AsmInfo->getPointerSize();
 803
 804   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfRangesSection());
 805
 806   for (const auto sec : Sections) {
 807
 808     MCSymbol *StartSymbol = sec.second.first;
 809     MCSymbol *EndSymbol = sec.second.second;
 810     assert(StartSymbol && "StartSymbol must not be NULL");
 811     assert(EndSymbol && "EndSymbol must not be NULL");
 812
 813     // Emit a base address selection entry for the start of this section
 814     const MCExpr *SectionStartAddr = MCSymbolRefExpr::Create(
 815       StartSymbol, MCSymbolRefExpr::VK_None, context);
 816     MCOS->EmitFill(AddrSize, 0xFF);
 817     MCOS->EmitValue(SectionStartAddr, AddrSize);
 818
 819     // Emit a range list entry spanning this section
 820     const MCExpr *SectionSize = MakeStartMinusEndExpr(*MCOS,
 821       *StartSymbol, *EndSymbol, 0);
 822     MCOS->EmitIntValue(0, AddrSize);
 823     MCOS->EmitAbsValue(SectionSize, AddrSize);
 824   }
 825
 826   // Emit end of list entry
 827   MCOS->EmitIntValue(0, AddrSize);
 828   MCOS->EmitIntValue(0, AddrSize);
 829 }
 830
 831 //
 832 // When generating dwarf for assembly source files this emits the Dwarf
 833 // sections.
 834 //
 835 void MCGenDwarfInfo::Emit(MCStreamer *MCOS) {
 836   MCContext &context = MCOS->getContext();
 837
 838   // Create the dwarf sections in this order (.debug_line already created).
 839   const MCAsmInfo *AsmInfo = context.getAsmInfo();
 840   bool CreateDwarfSectionSymbols =
 841       AsmInfo->doesDwarfUseRelocationsAcrossSections();
 842   MCSymbol *LineSectionSymbol = nullptr;
 843   if (CreateDwarfSectionSymbols)
 844     LineSectionSymbol = MCOS->getDwarfLineTableSymbol(0);
 845   MCSymbol *AbbrevSectionSymbol = nullptr;
 846   MCSymbol *InfoSectionSymbol = nullptr;
 847   MCSymbol *RangesSectionSymbol = NULL;
 848
 849   // Create end symbols for each section, and remove empty sections
 850   MCOS->getContext().finalizeDwarfSections(*MCOS);
 851
 852   // If there are no sections to generate debug info for, we don't need
 853   // to do anything
 854   if (MCOS->getContext().getGenDwarfSectionSyms().empty())
 855     return;
 856
 857   // We only need to use the .debug_ranges section if we have multiple
 858   // code sections.
 859   const bool UseRangesSection =
 860       MCOS->getContext().getGenDwarfSectionSyms().size() > 1;
 861   CreateDwarfSectionSymbols |= UseRangesSection;
 862
 863   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
 864   if (CreateDwarfSectionSymbols) {
 865     InfoSectionSymbol = context.CreateTempSymbol();
 866     MCOS->EmitLabel(InfoSectionSymbol);
 867   }
 868   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
 869   if (CreateDwarfSectionSymbols) {
 870     AbbrevSectionSymbol = context.CreateTempSymbol();
 871     MCOS->EmitLabel(AbbrevSectionSymbol);
 872   }
 873   if (UseRangesSection) {
 874     MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfRangesSection());
 875     if (CreateDwarfSectionSymbols) {
 876       RangesSectionSymbol = context.CreateTempSymbol();
 877       MCOS->EmitLabel(RangesSectionSymbol);
 878     }
 879   }
 880
 881   assert((RangesSectionSymbol != NULL) || !UseRangesSection);
 882
 883   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
 884
 885   // Output the data for .debug_aranges section.
 886   EmitGenDwarfAranges(MCOS, InfoSectionSymbol);
 887
 888   if (UseRangesSection)
 889     EmitGenDwarfRanges(MCOS);
 890
 891   // Output the data for .debug_abbrev section.
 892   EmitGenDwarfAbbrev(MCOS);
 893
 894   // Output the data for .debug_info section.
 895   EmitGenDwarfInfo(MCOS, AbbrevSectionSymbol, LineSectionSymbol,
 896                    RangesSectionSymbol);
 897 }
 898
 899 //
 900 // When generating dwarf for assembly source files this is called when symbol
 901 // for a label is created.  If this symbol is not a temporary and is in the
 902 // section that dwarf is being generated for, save the needed info to create
 903 // a dwarf label.
 904 //
 905 void MCGenDwarfLabelEntry::Make(MCSymbol *Symbol, MCStreamer *MCOS,
 906                                      SourceMgr &SrcMgr, SMLoc &Loc) {
 907   // We won't create dwarf labels for temporary symbols.
 908   if (Symbol->isTemporary())
 909     return;
 910   MCContext &context = MCOS->getContext();
 911   // We won't create dwarf labels for symbols in sections that we are not
 912   // generating debug info for.
 913   if (!context.getGenDwarfSectionSyms().count(MCOS->getCurrentSection().first))
 914     return;
 915
 916   // The dwarf label's name does not have the symbol name's leading
 917   // underbar if any.
 918   StringRef Name = Symbol->getName();
 919   if (Name.startswith("_"))
 920     Name = Name.substr(1, Name.size()-1);
 921
 922   // Get the dwarf file number to be used for the dwarf label.
 923   unsigned FileNumber = context.getGenDwarfFileNumber();
 924
 925   // Finding the line number is the expensive part which is why we just don't
 926   // pass it in as for some symbols we won't create a dwarf label.
 927   unsigned CurBuffer = SrcMgr.FindBufferContainingLoc(Loc);
 928   unsigned LineNumber = SrcMgr.FindLineNumber(Loc, CurBuffer);
 929
 930   // We create a temporary symbol for use for the AT_high_pc and AT_low_pc
 931   // values so that they don't have things like an ARM thumb bit from the
 932   // original symbol. So when used they won't get a low bit set after
 933   // relocation.
 934   MCSymbol *Label = context.CreateTempSymbol();
 935   MCOS->EmitLabel(Label);
 936
 937   // Create and entry for the info and add it to the other entries.
 938   MCOS->getContext().addMCGenDwarfLabelEntry(
 939       MCGenDwarfLabelEntry(Name, FileNumber, LineNumber, Label));
 940 }
 941
 942 static int getDataAlignmentFactor(MCStreamer &streamer) {
 943   MCContext &context = streamer.getContext();
 944   const MCAsmInfo *asmInfo = context.getAsmInfo();
 945   int size = asmInfo->getCalleeSaveStackSlotSize();
 946   if (asmInfo->isStackGrowthDirectionUp())
 947     return size;
 948   else
 949     return -size;
 950 }
 951
 952 static unsigned getSizeForEncoding(MCStreamer &streamer,
 953                                    unsigned symbolEncoding) {
 954   MCContext &context = streamer.getContext();
 955   unsigned format = symbolEncoding & 0x0f;
 956   switch (format) {
 957   default: llvm_unreachable("Unknown Encoding");
 958   case dwarf::DW_EH_PE_absptr:
 959   case dwarf::DW_EH_PE_signed:
 960     return context.getAsmInfo()->getPointerSize();
 961   case dwarf::DW_EH_PE_udata2:
 962   case dwarf::DW_EH_PE_sdata2:
 963     return 2;
 964   case dwarf::DW_EH_PE_udata4:
 965   case dwarf::DW_EH_PE_sdata4:
 966     return 4;
 967   case dwarf::DW_EH_PE_udata8:
 968   case dwarf::DW_EH_PE_sdata8:
 969     return 8;
 970   }
 971 }
 972
 973 static void EmitFDESymbol(MCStreamer &streamer, const MCSymbol &symbol,
 974                        unsigned symbolEncoding, bool isEH,
 975                        const char *comment = nullptr) {
 976   MCContext &context = streamer.getContext();
 977   const MCAsmInfo *asmInfo = context.getAsmInfo();
 978   const MCExpr *v = asmInfo->getExprForFDESymbol(&symbol,
 979                                                  symbolEncoding,
 980                                                  streamer);
 981   unsigned size = getSizeForEncoding(streamer, symbolEncoding);
 982   if (streamer.isVerboseAsm() && comment) streamer.AddComment(comment);
 983   if (asmInfo->doDwarfFDESymbolsUseAbsDiff() && isEH)
 984     streamer.EmitAbsValue(v, size);
 985   else
 986     streamer.EmitValue(v, size);
 987 }
 988
 989 static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol,
 990                             unsigned symbolEncoding) {
 991   MCContext &context = streamer.getContext();
 992   const MCAsmInfo *asmInfo = context.getAsmInfo();
 993   const MCExpr *v = asmInfo->getExprForPersonalitySymbol(&symbol,
 994                                                          symbolEncoding,
 995                                                          streamer);
 996   unsigned size = getSizeForEncoding(streamer, symbolEncoding);
 997   streamer.EmitValue(v, size);
 998 }
 999
1000 namespace {
1001   class FrameEmitterImpl {
1002     int CFAOffset;
1003     int CIENum;
1004     bool IsEH;
1005     const MCSymbol *SectionStart;
1006   public:
1007     FrameEmitterImpl(bool isEH)
1008         : CFAOffset(0), CIENum(0), IsEH(isEH), SectionStart(nullptr) {}
1009
1010     void setSectionStart(const MCSymbol *Label) { SectionStart = Label; }
1011
1012     /// EmitCompactUnwind - Emit the unwind information in a compact way.
1013     void EmitCompactUnwind(MCStreamer &streamer,
1014                            const MCDwarfFrameInfo &frame);
1015
1016     const MCSymbol &EmitCIE(MCObjectStreamer &streamer,
1017                             const MCSymbol *personality,
1018                             unsigned personalityEncoding,
1019                             const MCSymbol *lsda,
1020                             bool IsSignalFrame,
1021                             unsigned lsdaEncoding,
1022                             bool IsSimple);
1023     MCSymbol *EmitFDE(MCObjectStreamer &streamer,
1024                       const MCSymbol &cieStart,
1025                       const MCDwarfFrameInfo &frame);
1026     void EmitCFIInstructions(MCObjectStreamer &streamer,
1027                              ArrayRef<MCCFIInstruction> Instrs,
1028                              MCSymbol *BaseLabel);
1029     void EmitCFIInstruction(MCObjectStreamer &Streamer,
1030                             const MCCFIInstruction &Instr);
1031   };
1032
1033 } // end anonymous namespace
1034
1035 static void EmitEncodingByte(MCStreamer &Streamer, unsigned Encoding,
1036                              StringRef Prefix) {
1037   if (Streamer.isVerboseAsm()) {
1038     const char *EncStr;
1039     switch (Encoding) {
1040     default: EncStr = "<unknown encoding>"; break;
1041     case dwarf::DW_EH_PE_absptr: EncStr = "absptr"; break;
1042     case dwarf::DW_EH_PE_omit:   EncStr = "omit"; break;
1043     case dwarf::DW_EH_PE_pcrel:  EncStr = "pcrel"; break;
1044     case dwarf::DW_EH_PE_udata4: EncStr = "udata4"; break;
1045     case dwarf::DW_EH_PE_udata8: EncStr = "udata8"; break;
1046     case dwarf::DW_EH_PE_sdata4: EncStr = "sdata4"; break;
1047     case dwarf::DW_EH_PE_sdata8: EncStr = "sdata8"; break;
1048     case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata4:
1049       EncStr = "pcrel udata4";
1050       break;
1051     case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4:
1052       EncStr = "pcrel sdata4";
1053       break;
1054     case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata8:
1055       EncStr = "pcrel udata8";
1056       break;
1057     case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata8:
1058       EncStr = "screl sdata8";
1059       break;
1060     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_udata4:
1061       EncStr = "indirect pcrel udata4";
1062       break;
1063     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_sdata4:
1064       EncStr = "indirect pcrel sdata4";
1065       break;
1066     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_udata8:
1067       EncStr = "indirect pcrel udata8";
1068       break;
1069     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_sdata8:
1070       EncStr = "indirect pcrel sdata8";
1071       break;
1072     }
1073
1074     Streamer.AddComment(Twine(Prefix) + " = " + EncStr);
1075   }
1076
1077   Streamer.EmitIntValue(Encoding, 1);
1078 }
1079
1080 void FrameEmitterImpl::EmitCFIInstruction(MCObjectStreamer &Streamer,
1081                                           const MCCFIInstruction &Instr) {
1082   int dataAlignmentFactor = getDataAlignmentFactor(Streamer);
1083   bool VerboseAsm = Streamer.isVerboseAsm();
1084
1085   switch (Instr.getOperation()) {
1086   case MCCFIInstruction::OpRegister: {
1087     unsigned Reg1 = Instr.getRegister();
1088     unsigned Reg2 = Instr.getRegister2();
1089     if (VerboseAsm) {
1090       Streamer.AddComment("DW_CFA_register");
1091       Streamer.AddComment(Twine("Reg1 ") + Twine(Reg1));
1092       Streamer.AddComment(Twine("Reg2 ") + Twine(Reg2));
1093     }
1094     Streamer.EmitIntValue(dwarf::DW_CFA_register, 1);
1095     Streamer.EmitULEB128IntValue(Reg1);
1096     Streamer.EmitULEB128IntValue(Reg2);
1097     return;
1098   }
1099   case MCCFIInstruction::OpWindowSave: {
1100     Streamer.EmitIntValue(dwarf::DW_CFA_GNU_window_save, 1);
1101     return;
1102   }
1103   case MCCFIInstruction::OpUndefined: {
1104     unsigned Reg = Instr.getRegister();
1105     if (VerboseAsm) {
1106       Streamer.AddComment("DW_CFA_undefined");
1107       Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1108     }
1109     Streamer.EmitIntValue(dwarf::DW_CFA_undefined, 1);
1110     Streamer.EmitULEB128IntValue(Reg);
1111     return;
1112   }
1113   case MCCFIInstruction::OpAdjustCfaOffset:
1114   case MCCFIInstruction::OpDefCfaOffset: {
1115     const bool IsRelative =
1116       Instr.getOperation() == MCCFIInstruction::OpAdjustCfaOffset;
1117
1118     if (VerboseAsm)
1119       Streamer.AddComment("DW_CFA_def_cfa_offset");
1120     Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
1121
1122     if (IsRelative)
1123       CFAOffset += Instr.getOffset();
1124     else
1125       CFAOffset = -Instr.getOffset();
1126
1127     if (VerboseAsm)
1128       Streamer.AddComment(Twine("Offset " + Twine(CFAOffset)));
1129     Streamer.EmitULEB128IntValue(CFAOffset);
1130
1131     return;
1132   }
1133   case MCCFIInstruction::OpDefCfa: {
1134     if (VerboseAsm)
1135       Streamer.AddComment("DW_CFA_def_cfa");
1136     Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
1137
1138     if (VerboseAsm)
1139       Streamer.AddComment(Twine("Reg ") + Twine(Instr.getRegister()));
1140     Streamer.EmitULEB128IntValue(Instr.getRegister());
1141
1142     CFAOffset = -Instr.getOffset();
1143
1144     if (VerboseAsm)
1145       Streamer.AddComment(Twine("Offset " + Twine(CFAOffset)));
1146     Streamer.EmitULEB128IntValue(CFAOffset);
1147
1148     return;
1149   }
1150
1151   case MCCFIInstruction::OpDefCfaRegister: {
1152     if (VerboseAsm)
1153       Streamer.AddComment("DW_CFA_def_cfa_register");
1154     Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
1155
1156     if (VerboseAsm)
1157       Streamer.AddComment(Twine("Reg ") + Twine(Instr.getRegister()));
1158     Streamer.EmitULEB128IntValue(Instr.getRegister());
1159
1160     return;
1161   }
1162
1163   case MCCFIInstruction::OpOffset:
1164   case MCCFIInstruction::OpRelOffset: {
1165     const bool IsRelative =
1166       Instr.getOperation() == MCCFIInstruction::OpRelOffset;
1167
1168     unsigned Reg = Instr.getRegister();
1169     int Offset = Instr.getOffset();
1170     if (IsRelative)
1171       Offset -= CFAOffset;
1172     Offset = Offset / dataAlignmentFactor;
1173
1174     if (Offset < 0) {
1175       if (VerboseAsm) Streamer.AddComment("DW_CFA_offset_extended_sf");
1176       Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
1177       if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1178       Streamer.EmitULEB128IntValue(Reg);
1179       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
1180       Streamer.EmitSLEB128IntValue(Offset);
1181     } else if (Reg < 64) {
1182       if (VerboseAsm) Streamer.AddComment(Twine("DW_CFA_offset + Reg(") +
1183                                           Twine(Reg) + ")");
1184       Streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
1185       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
1186       Streamer.EmitULEB128IntValue(Offset);
1187     } else {
1188       if (VerboseAsm) Streamer.AddComment("DW_CFA_offset_extended");
1189       Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
1190       if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1191       Streamer.EmitULEB128IntValue(Reg);
1192       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
1193       Streamer.EmitULEB128IntValue(Offset);
1194     }
1195     return;
1196   }
1197   case MCCFIInstruction::OpRememberState:
1198     if (VerboseAsm) Streamer.AddComment("DW_CFA_remember_state");
1199     Streamer.EmitIntValue(dwarf::DW_CFA_remember_state, 1);
1200     return;
1201   case MCCFIInstruction::OpRestoreState:
1202     if (VerboseAsm) Streamer.AddComment("DW_CFA_restore_state");
1203     Streamer.EmitIntValue(dwarf::DW_CFA_restore_state, 1);
1204     return;
1205   case MCCFIInstruction::OpSameValue: {
1206     unsigned Reg = Instr.getRegister();
1207     if (VerboseAsm) Streamer.AddComment("DW_CFA_same_value");
1208     Streamer.EmitIntValue(dwarf::DW_CFA_same_value, 1);
1209     if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1210     Streamer.EmitULEB128IntValue(Reg);
1211     return;
1212   }
1213   case MCCFIInstruction::OpRestore: {
1214     unsigned Reg = Instr.getRegister();
1215     if (VerboseAsm) {
1216       Streamer.AddComment("DW_CFA_restore");
1217       Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1218     }
1219     Streamer.EmitIntValue(dwarf::DW_CFA_restore | Reg, 1);
1220     return;
1221   }
1222   case MCCFIInstruction::OpEscape:
1223     if (VerboseAsm) Streamer.AddComment("Escape bytes");
1224     Streamer.EmitBytes(Instr.getValues());
1225     return;
1226   }
1227   llvm_unreachable("Unhandled case in switch");
1228 }
1229
1230 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1231 /// frame.
1232 void FrameEmitterImpl::EmitCFIInstructions(MCObjectStreamer &streamer,
1233                                            ArrayRef<MCCFIInstruction> Instrs,
1234                                            MCSymbol *BaseLabel) {
1235   for (unsigned i = 0, N = Instrs.size(); i < N; ++i) {
1236     const MCCFIInstruction &Instr = Instrs[i];
1237     MCSymbol *Label = Instr.getLabel();
1238     // Throw out move if the label is invalid.
1239     if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
1240
1241     // Advance row if new location.
1242     if (BaseLabel && Label) {
1243       MCSymbol *ThisSym = Label;
1244       if (ThisSym != BaseLabel) {
1245         if (streamer.isVerboseAsm()) streamer.AddComment("DW_CFA_advance_loc4");
1246         streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
1247         BaseLabel = ThisSym;
1248       }
1249     }
1250
1251     EmitCFIInstruction(streamer, Instr);
1252   }
1253 }
1254
1255 /// EmitCompactUnwind - Emit the unwind information in a compact way.
1256 void FrameEmitterImpl::EmitCompactUnwind(MCStreamer &Streamer,
1257                                          const MCDwarfFrameInfo &Frame) {
1258   MCContext &Context = Streamer.getContext();
1259   const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1260   bool VerboseAsm = Streamer.isVerboseAsm();
1261
1262   // range-start range-length  compact-unwind-enc personality-func   lsda
1263   //  _foo       LfooEnd-_foo  0x00000023          0                 0
1264   //  _bar       LbarEnd-_bar  0x00000025         __gxx_personality  except_tab1
1265   //
1266   //   .section __LD,__compact_unwind,regular,debug
1267   //
1268   //   # compact unwind for _foo
1269   //   .quad _foo
1270   //   .set L1,LfooEnd-_foo
1271   //   .long L1
1272   //   .long 0x01010001
1273   //   .quad 0
1274   //   .quad 0
1275   //
1276   //   # compact unwind for _bar
1277   //   .quad _bar
1278   //   .set L2,LbarEnd-_bar
1279   //   .long L2
1280   //   .long 0x01020011
1281   //   .quad __gxx_personality
1282   //   .quad except_tab1
1283
1284   uint32_t Encoding = Frame.CompactUnwindEncoding;
1285   if (!Encoding) return;
1286   bool DwarfEHFrameOnly = (Encoding == MOFI->getCompactUnwindDwarfEHFrameOnly());
1287
1288   // The encoding needs to know we have an LSDA.
1289   if (!DwarfEHFrameOnly && Frame.Lsda)
1290     Encoding |= 0x40000000;
1291
1292   // Range Start
1293   unsigned FDEEncoding = MOFI->getFDEEncoding();
1294   unsigned Size = getSizeForEncoding(Streamer, FDEEncoding);
1295   if (VerboseAsm) Streamer.AddComment("Range Start");
1296   Streamer.EmitSymbolValue(Frame.Begin, Size);
1297
1298   // Range Length
1299   const MCExpr *Range = MakeStartMinusEndExpr(Streamer, *Frame.Begin,
1300                                               *Frame.End, 0);
1301   if (VerboseAsm) Streamer.AddComment("Range Length");
1302   Streamer.EmitAbsValue(Range, 4);
1303
1304   // Compact Encoding
1305   Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_udata4);
1306   if (VerboseAsm) Streamer.AddComment("Compact Unwind Encoding: 0x" +
1307                                       Twine::utohexstr(Encoding));
1308   Streamer.EmitIntValue(Encoding, Size);
1309
1310   // Personality Function
1311   Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_absptr);
1312   if (VerboseAsm) Streamer.AddComment("Personality Function");
1313   if (!DwarfEHFrameOnly && Frame.Personality)
1314     Streamer.EmitSymbolValue(Frame.Personality, Size);
1315   else
1316     Streamer.EmitIntValue(0, Size); // No personality fn
1317
1318   // LSDA
1319   Size = getSizeForEncoding(Streamer, Frame.LsdaEncoding);
1320   if (VerboseAsm) Streamer.AddComment("LSDA");
1321   if (!DwarfEHFrameOnly && Frame.Lsda)
1322     Streamer.EmitSymbolValue(Frame.Lsda, Size);
1323   else
1324     Streamer.EmitIntValue(0, Size); // No LSDA
1325 }
1326
1327 const MCSymbol &FrameEmitterImpl::EmitCIE(MCObjectStreamer &streamer,
1328                                           const MCSymbol *personality,
1329                                           unsigned personalityEncoding,
1330                                           const MCSymbol *lsda,
1331                                           bool IsSignalFrame,
1332                                           unsigned lsdaEncoding,
1333                                           bool IsSimple) {
1334   MCContext &context = streamer.getContext();
1335   const MCRegisterInfo *MRI = context.getRegisterInfo();
1336   const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1337   bool verboseAsm = streamer.isVerboseAsm();
1338
1339   MCSymbol *sectionStart = context.CreateTempSymbol();
1340   streamer.EmitLabel(sectionStart);
1341   CIENum++;
1342
1343   MCSymbol *sectionEnd = context.CreateTempSymbol();
1344
1345   // Length
1346   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *sectionStart,
1347                                                *sectionEnd, 4);
1348   if (verboseAsm) streamer.AddComment("CIE Length");
1349   streamer.EmitAbsValue(Length, 4);
1350
1351   // CIE ID
1352   unsigned CIE_ID = IsEH ? 0 : -1;
1353   if (verboseAsm) streamer.AddComment("CIE ID Tag");
1354   streamer.EmitIntValue(CIE_ID, 4);
1355
1356   // Version
1357   if (verboseAsm) streamer.AddComment("DW_CIE_VERSION");
1358   // For DWARF2, we use CIE version 1
1359   // For DWARF3+, we use CIE version 3
1360   uint8_t CIEVersion = context.getDwarfVersion() <= 2 ? 1 : 3;
1361   streamer.EmitIntValue(CIEVersion, 1);
1362
1363   // Augmentation String
1364   SmallString<8> Augmentation;
1365   if (IsEH) {
1366     if (verboseAsm) streamer.AddComment("CIE Augmentation");
1367     Augmentation += "z";
1368     if (personality)
1369       Augmentation += "P";
1370     if (lsda)
1371       Augmentation += "L";
1372     Augmentation += "R";
1373     if (IsSignalFrame)
1374       Augmentation += "S";
1375     streamer.EmitBytes(Augmentation.str());
1376   }
1377   streamer.EmitIntValue(0, 1);
1378
1379   // Code Alignment Factor
1380   if (verboseAsm) streamer.AddComment("CIE Code Alignment Factor");
1381   streamer.EmitULEB128IntValue(context.getAsmInfo()->getMinInstAlignment());
1382
1383   // Data Alignment Factor
1384   if (verboseAsm) streamer.AddComment("CIE Data Alignment Factor");
1385   streamer.EmitSLEB128IntValue(getDataAlignmentFactor(streamer));
1386
1387   // Return Address Register
1388   if (verboseAsm) streamer.AddComment("CIE Return Address Column");
1389   if (CIEVersion == 1) {
1390     assert(MRI->getRARegister() <= 255 &&
1391            "DWARF 2 encodes return_address_register in one byte");
1392     streamer.EmitIntValue(MRI->getDwarfRegNum(MRI->getRARegister(), true), 1);
1393   } else {
1394     streamer.EmitULEB128IntValue(
1395         MRI->getDwarfRegNum(MRI->getRARegister(), true));
1396   }
1397
1398   // Augmentation Data Length (optional)
1399
1400   unsigned augmentationLength = 0;
1401   if (IsEH) {
1402     if (personality) {
1403       // Personality Encoding
1404       augmentationLength += 1;
1405       // Personality
1406       augmentationLength += getSizeForEncoding(streamer, personalityEncoding);
1407     }
1408     if (lsda)
1409       augmentationLength += 1;
1410     // Encoding of the FDE pointers
1411     augmentationLength += 1;
1412
1413     if (verboseAsm) streamer.AddComment("Augmentation Size");
1414     streamer.EmitULEB128IntValue(augmentationLength);
1415
1416     // Augmentation Data (optional)
1417     if (personality) {
1418       // Personality Encoding
1419       EmitEncodingByte(streamer, personalityEncoding,
1420                        "Personality Encoding");
1421       // Personality
1422       if (verboseAsm) streamer.AddComment("Personality");
1423       EmitPersonality(streamer, *personality, personalityEncoding);
1424     }
1425
1426     if (lsda)
1427       EmitEncodingByte(streamer, lsdaEncoding, "LSDA Encoding");
1428
1429     // Encoding of the FDE pointers
1430     EmitEncodingByte(streamer, MOFI->getFDEEncoding(), "FDE Encoding");
1431   }
1432
1433   // Initial Instructions
1434
1435   const MCAsmInfo *MAI = context.getAsmInfo();
1436   if (!IsSimple) {
1437     const std::vector<MCCFIInstruction> &Instructions =
1438         MAI->getInitialFrameState();
1439     EmitCFIInstructions(streamer, Instructions, nullptr);
1440   }
1441
1442   // Padding
1443   streamer.EmitValueToAlignment(IsEH ? 4 : MAI->getPointerSize());
1444
1445   streamer.EmitLabel(sectionEnd);
1446   return *sectionStart;
1447 }
1448
1449 MCSymbol *FrameEmitterImpl::EmitFDE(MCObjectStreamer &streamer,
1450                                     const MCSymbol &cieStart,
1451                                     const MCDwarfFrameInfo &frame) {
1452   MCContext &context = streamer.getContext();
1453   MCSymbol *fdeStart = context.CreateTempSymbol();
1454   MCSymbol *fdeEnd = context.CreateTempSymbol();
1455   const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1456   bool verboseAsm = streamer.isVerboseAsm();
1457
1458   // Length
1459   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *fdeStart, *fdeEnd, 0);
1460   if (verboseAsm) streamer.AddComment("FDE Length");
1461   streamer.EmitAbsValue(Length, 4);
1462
1463   streamer.EmitLabel(fdeStart);
1464
1465   // CIE Pointer
1466   const MCAsmInfo *asmInfo = context.getAsmInfo();
1467   if (IsEH) {
1468     const MCExpr *offset = MakeStartMinusEndExpr(streamer, cieStart, *fdeStart,
1469                                                  0);
1470     if (verboseAsm) streamer.AddComment("FDE CIE Offset");
1471     streamer.EmitAbsValue(offset, 4);
1472   } else if (!asmInfo->doesDwarfUseRelocationsAcrossSections()) {
1473     const MCExpr *offset = MakeStartMinusEndExpr(streamer, *SectionStart,
1474                                                  cieStart, 0);
1475     streamer.EmitAbsValue(offset, 4);
1476   } else {
1477     streamer.EmitSymbolValue(&cieStart, 4);
1478   }
1479
1480   // PC Begin
1481   unsigned PCEncoding =
1482       IsEH ? MOFI->getFDEEncoding() : (unsigned)dwarf::DW_EH_PE_absptr;
1483   unsigned PCSize = getSizeForEncoding(streamer, PCEncoding);
1484   EmitFDESymbol(streamer, *frame.Begin, PCEncoding, IsEH, "FDE initial location");
1485
1486   // PC Range
1487   const MCExpr *Range = MakeStartMinusEndExpr(streamer, *frame.Begin,
1488                                               *frame.End, 0);
1489   if (verboseAsm) streamer.AddComment("FDE address range");
1490   streamer.EmitAbsValue(Range, PCSize);
1491
1492   if (IsEH) {
1493     // Augmentation Data Length
1494     unsigned augmentationLength = 0;
1495
1496     if (frame.Lsda)
1497       augmentationLength += getSizeForEncoding(streamer, frame.LsdaEncoding);
1498
1499     if (verboseAsm) streamer.AddComment("Augmentation size");
1500     streamer.EmitULEB128IntValue(augmentationLength);
1501
1502     // Augmentation Data
1503     if (frame.Lsda)
1504       EmitFDESymbol(streamer, *frame.Lsda, frame.LsdaEncoding, true,
1505                     "Language Specific Data Area");
1506   }
1507
1508   // Call Frame Instructions
1509   EmitCFIInstructions(streamer, frame.Instructions, frame.Begin);
1510
1511   // Padding
1512   streamer.EmitValueToAlignment(PCSize);
1513
1514   return fdeEnd;
1515 }
1516
1517 namespace {
1518   struct CIEKey {
1519     static const CIEKey getEmptyKey() {
1520       return CIEKey(nullptr, 0, -1, false, false);
1521     }
1522     static const CIEKey getTombstoneKey() {
1523       return CIEKey(nullptr, -1, 0, false, false);
1524     }
1525
1526     CIEKey(const MCSymbol *Personality_, unsigned PersonalityEncoding_,
1527            unsigned LsdaEncoding_, bool IsSignalFrame_, bool IsSimple_)
1528         : Personality(Personality_), PersonalityEncoding(PersonalityEncoding_),
1529           LsdaEncoding(LsdaEncoding_), IsSignalFrame(IsSignalFrame_),
1530           IsSimple(IsSimple_) {}
1531     const MCSymbol *Personality;
1532     unsigned PersonalityEncoding;
1533     unsigned LsdaEncoding;
1534     bool IsSignalFrame;
1535     bool IsSimple;
1536   };
1537 }
1538
1539 namespace llvm {
1540   template <>
1541   struct DenseMapInfo<CIEKey> {
1542     static CIEKey getEmptyKey() {
1543       return CIEKey::getEmptyKey();
1544     }
1545     static CIEKey getTombstoneKey() {
1546       return CIEKey::getTombstoneKey();
1547     }
1548     static unsigned getHashValue(const CIEKey &Key) {
1549       return static_cast<unsigned>(hash_combine(Key.Personality,
1550                                                 Key.PersonalityEncoding,
1551                                                 Key.LsdaEncoding,
1552                                                 Key.IsSignalFrame,
1553                                                 Key.IsSimple));
1554     }
1555     static bool isEqual(const CIEKey &LHS,
1556                         const CIEKey &RHS) {
1557       return LHS.Personality == RHS.Personality &&
1558         LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
1559         LHS.LsdaEncoding == RHS.LsdaEncoding &&
1560         LHS.IsSignalFrame == RHS.IsSignalFrame &&
1561         LHS.IsSimple == RHS.IsSimple;
1562     }
1563   };
1564 }
1565
1566 void MCDwarfFrameEmitter::Emit(MCObjectStreamer &Streamer, MCAsmBackend *MAB,
1567                                bool IsEH) {
1568   Streamer.generateCompactUnwindEncodings(MAB);
1569
1570   MCContext &Context = Streamer.getContext();
1571   const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1572   FrameEmitterImpl Emitter(IsEH);
1573   ArrayRef<MCDwarfFrameInfo> FrameArray = Streamer.getDwarfFrameInfos();
1574
1575   // Emit the compact unwind info if available.
1576   bool NeedsEHFrameSection = !MOFI->getSupportsCompactUnwindWithoutEHFrame();
1577   if (IsEH && MOFI->getCompactUnwindSection()) {
1578     bool SectionEmitted = false;
1579     for (unsigned i = 0, n = FrameArray.size(); i < n; ++i) {
1580       const MCDwarfFrameInfo &Frame = FrameArray[i];
1581       if (Frame.CompactUnwindEncoding == 0) continue;
1582       if (!SectionEmitted) {
1583         Streamer.SwitchSection(MOFI->getCompactUnwindSection());
1584         Streamer.EmitValueToAlignment(Context.getAsmInfo()->getPointerSize());
1585         SectionEmitted = true;
1586       }
1587       NeedsEHFrameSection |=
1588         Frame.CompactUnwindEncoding ==
1589           MOFI->getCompactUnwindDwarfEHFrameOnly();
1590       Emitter.EmitCompactUnwind(Streamer, Frame);
1591     }
1592   }
1593
1594   if (!NeedsEHFrameSection) return;
1595
1596   const MCSection &Section =
1597     IsEH ? *const_cast<MCObjectFileInfo*>(MOFI)->getEHFrameSection() :
1598            *MOFI->getDwarfFrameSection();
1599
1600   Streamer.SwitchSection(&Section);
1601   MCSymbol *SectionStart = Context.CreateTempSymbol();
1602   Streamer.EmitLabel(SectionStart);
1603   Emitter.setSectionStart(SectionStart);
1604
1605   MCSymbol *FDEEnd = nullptr;
1606   DenseMap<CIEKey, const MCSymbol *> CIEStarts;
1607
1608   const MCSymbol *DummyDebugKey = nullptr;
1609   NeedsEHFrameSection = !MOFI->getSupportsCompactUnwindWithoutEHFrame();
1610   for (unsigned i = 0, n = FrameArray.size(); i < n; ++i) {
1611     const MCDwarfFrameInfo &Frame = FrameArray[i];
1612
1613     // Emit the label from the previous iteration
1614     if (FDEEnd) {
1615       Streamer.EmitLabel(FDEEnd);
1616       FDEEnd = nullptr;
1617     }
1618
1619     if (!NeedsEHFrameSection && Frame.CompactUnwindEncoding !=
1620           MOFI->getCompactUnwindDwarfEHFrameOnly())
1621       // Don't generate an EH frame if we don't need one. I.e., it's taken care
1622       // of by the compact unwind encoding.
1623       continue;
1624
1625     CIEKey Key(Frame.Personality, Frame.PersonalityEncoding,
1626                Frame.LsdaEncoding, Frame.IsSignalFrame, Frame.IsSimple);
1627     const MCSymbol *&CIEStart = IsEH ? CIEStarts[Key] : DummyDebugKey;
1628     if (!CIEStart)
1629       CIEStart = &Emitter.EmitCIE(Streamer, Frame.Personality,
1630                                   Frame.PersonalityEncoding, Frame.Lsda,
1631                                   Frame.IsSignalFrame,
1632                                   Frame.LsdaEncoding,
1633                                   Frame.IsSimple);
1634
1635     FDEEnd = Emitter.EmitFDE(Streamer, *CIEStart, Frame);
1636   }
1637
1638   Streamer.EmitValueToAlignment(Context.getAsmInfo()->getPointerSize());
1639   if (FDEEnd)
1640     Streamer.EmitLabel(FDEEnd);
1641 }
1642
1643 void MCDwarfFrameEmitter::EmitAdvanceLoc(MCObjectStreamer &Streamer,
1644                                          uint64_t AddrDelta) {
1645   MCContext &Context = Streamer.getContext();
1646   SmallString<256> Tmp;
1647   raw_svector_ostream OS(Tmp);
1648   MCDwarfFrameEmitter::EncodeAdvanceLoc(Context, AddrDelta, OS);
1649   Streamer.EmitBytes(OS.str());
1650 }
1651
1652 void MCDwarfFrameEmitter::EncodeAdvanceLoc(MCContext &Context,
1653                                            uint64_t AddrDelta,
1654                                            raw_ostream &OS) {
1655   // Scale the address delta by the minimum instruction length.
1656   AddrDelta = ScaleAddrDelta(Context, AddrDelta);
1657
1658   if (AddrDelta == 0) {
1659   } else if (isUIntN(6, AddrDelta)) {
1660     uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
1661     OS << Opcode;
1662   } else if (isUInt<8>(AddrDelta)) {
1663     OS << uint8_t(dwarf::DW_CFA_advance_loc1);
1664     OS << uint8_t(AddrDelta);
1665   } else if (isUInt<16>(AddrDelta)) {
1666     // FIXME: check what is the correct behavior on a big endian machine.
1667     OS << uint8_t(dwarf::DW_CFA_advance_loc2);
1668     OS << uint8_t( AddrDelta       & 0xff);
1669     OS << uint8_t((AddrDelta >> 8) & 0xff);
1670   } else {
1671     // FIXME: check what is the correct behavior on a big endian machine.
1672     assert(isUInt<32>(AddrDelta));
1673     OS << uint8_t(dwarf::DW_CFA_advance_loc4);
1674     OS << uint8_t( AddrDelta        & 0xff);
1675     OS << uint8_t((AddrDelta >> 8)  & 0xff);
1676     OS << uint8_t((AddrDelta >> 16) & 0xff);
1677     OS << uint8_t((AddrDelta >> 24) & 0xff);
1678
1679   }
1680 }