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/ADT/FoldingSet.h"
  11 #include "llvm/MC/MCAsmInfo.h"
  12 #include "llvm/MC/MCDwarf.h"
  13 #include "llvm/MC/MCAssembler.h"
  14 #include "llvm/MC/MCStreamer.h"
  15 #include "llvm/MC/MCSymbol.h"
  16 #include "llvm/MC/MCExpr.h"
  17 #include "llvm/MC/MCContext.h"
  18 #include "llvm/MC/MCObjectWriter.h"
  19 #include "llvm/ADT/SmallString.h"
  20 #include "llvm/ADT/Twine.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23 #include "llvm/Support/raw_ostream.h"
  24 #include "llvm/Target/TargetAsmBackend.h"
  25 #include "llvm/Target/TargetAsmInfo.h"
  26 using namespace llvm;
  27
  28 // Given a special op, return the address skip amount (in units of
  29 // DWARF2_LINE_MIN_INSN_LENGTH.
  30 #define SPECIAL_ADDR(op) (((op) - DWARF2_LINE_OPCODE_BASE)/DWARF2_LINE_RANGE)
  31
  32 // The maximum address skip amount that can be encoded with a special op.
  33 #define MAX_SPECIAL_ADDR_DELTA          SPECIAL_ADDR(255)
  34
  35 // First special line opcode - leave room for the standard opcodes.
  36 // Note: If you want to change this, you'll have to update the
  37 // "standard_opcode_lengths" table that is emitted in DwarfFileTable::Emit().
  38 #define DWARF2_LINE_OPCODE_BASE         13
  39
  40 // Minimum line offset in a special line info. opcode.  This value
  41 // was chosen to give a reasonable range of values.
  42 #define DWARF2_LINE_BASE                -5
  43
  44 // Range of line offsets in a special line info. opcode.
  45 # define DWARF2_LINE_RANGE              14
  46
  47 // Define the architecture-dependent minimum instruction length (in bytes).
  48 // This value should be rather too small than too big.
  49 # define DWARF2_LINE_MIN_INSN_LENGTH    1
  50
  51 // Note: when DWARF2_LINE_MIN_INSN_LENGTH == 1 which is the current setting,
  52 // this routine is a nop and will be optimized away.
  53 static inline uint64_t ScaleAddrDelta(uint64_t AddrDelta)
  54 {
  55   if (DWARF2_LINE_MIN_INSN_LENGTH == 1)
  56     return AddrDelta;
  57   if (AddrDelta % DWARF2_LINE_MIN_INSN_LENGTH != 0) {
  58     // TODO: report this error, but really only once.
  59     ;
  60   }
  61   return AddrDelta / DWARF2_LINE_MIN_INSN_LENGTH;
  62 }
  63
  64 //
  65 // This is called when an instruction is assembled into the specified section
  66 // and if there is information from the last .loc directive that has yet to have
  67 // a line entry made for it is made.
  68 //
  69 void MCLineEntry::Make(MCStreamer *MCOS, const MCSection *Section) {
  70   if (!MCOS->getContext().getDwarfLocSeen())
  71     return;
  72
  73   // Create a symbol at in the current section for use in the line entry.
  74   MCSymbol *LineSym = MCOS->getContext().CreateTempSymbol();
  75   // Set the value of the symbol to use for the MCLineEntry.
  76   MCOS->EmitLabel(LineSym);
  77
  78   // Get the current .loc info saved in the context.
  79   const MCDwarfLoc &DwarfLoc = MCOS->getContext().getCurrentDwarfLoc();
  80
  81   // Create a (local) line entry with the symbol and the current .loc info.
  82   MCLineEntry LineEntry(LineSym, DwarfLoc);
  83
  84   // clear DwarfLocSeen saying the current .loc info is now used.
  85   MCOS->getContext().ClearDwarfLocSeen();
  86
  87   // Get the MCLineSection for this section, if one does not exist for this
  88   // section create it.
  89   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
  90     MCOS->getContext().getMCLineSections();
  91   MCLineSection *LineSection = MCLineSections.lookup(Section);
  92   if (!LineSection) {
  93     // Create a new MCLineSection.  This will be deleted after the dwarf line
  94     // table is created using it by iterating through the MCLineSections
  95     // DenseMap.
  96     LineSection = new MCLineSection;
  97     // Save a pointer to the new LineSection into the MCLineSections DenseMap.
  98     MCOS->getContext().addMCLineSection(Section, LineSection);
  99   }
 100
 101   // Add the line entry to this section's entries.
 102   LineSection->addLineEntry(LineEntry);
 103 }
 104
 105 //
 106 // This helper routine returns an expression of End - Start + IntVal .
 107 //
 108 static inline const MCExpr *MakeStartMinusEndExpr(const MCStreamer &MCOS,
 109                                                   const MCSymbol &Start,
 110                                                   const MCSymbol &End,
 111                                                   int IntVal) {
 112   MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
 113   const MCExpr *Res =
 114     MCSymbolRefExpr::Create(&End, Variant, MCOS.getContext());
 115   const MCExpr *RHS =
 116     MCSymbolRefExpr::Create(&Start, Variant, MCOS.getContext());
 117   const MCExpr *Res1 =
 118     MCBinaryExpr::Create(MCBinaryExpr::Sub, Res, RHS, MCOS.getContext());
 119   const MCExpr *Res2 =
 120     MCConstantExpr::Create(IntVal, MCOS.getContext());
 121   const MCExpr *Res3 =
 122     MCBinaryExpr::Create(MCBinaryExpr::Sub, Res1, Res2, MCOS.getContext());
 123   return Res3;
 124 }
 125
 126 //
 127 // This emits the Dwarf line table for the specified section from the entries
 128 // in the LineSection.
 129 //
 130 static inline void EmitDwarfLineTable(MCStreamer *MCOS,
 131                                       const MCSection *Section,
 132                                       const MCLineSection *LineSection) {
 133   unsigned FileNum = 1;
 134   unsigned LastLine = 1;
 135   unsigned Column = 0;
 136   unsigned Flags = DWARF2_LINE_DEFAULT_IS_STMT ? DWARF2_FLAG_IS_STMT : 0;
 137   unsigned Isa = 0;
 138   MCSymbol *LastLabel = NULL;
 139
 140   // Loop through each MCLineEntry and encode the dwarf line number table.
 141   for (MCLineSection::const_iterator
 142          it = LineSection->getMCLineEntries()->begin(),
 143          ie = LineSection->getMCLineEntries()->end(); it != ie; ++it) {
 144
 145     if (FileNum != it->getFileNum()) {
 146       FileNum = it->getFileNum();
 147       MCOS->EmitIntValue(dwarf::DW_LNS_set_file, 1);
 148       MCOS->EmitULEB128IntValue(FileNum);
 149     }
 150     if (Column != it->getColumn()) {
 151       Column = it->getColumn();
 152       MCOS->EmitIntValue(dwarf::DW_LNS_set_column, 1);
 153       MCOS->EmitULEB128IntValue(Column);
 154     }
 155     if (Isa != it->getIsa()) {
 156       Isa = it->getIsa();
 157       MCOS->EmitIntValue(dwarf::DW_LNS_set_isa, 1);
 158       MCOS->EmitULEB128IntValue(Isa);
 159     }
 160     if ((it->getFlags() ^ Flags) & DWARF2_FLAG_IS_STMT) {
 161       Flags = it->getFlags();
 162       MCOS->EmitIntValue(dwarf::DW_LNS_negate_stmt, 1);
 163     }
 164     if (it->getFlags() & DWARF2_FLAG_BASIC_BLOCK)
 165       MCOS->EmitIntValue(dwarf::DW_LNS_set_basic_block, 1);
 166     if (it->getFlags() & DWARF2_FLAG_PROLOGUE_END)
 167       MCOS->EmitIntValue(dwarf::DW_LNS_set_prologue_end, 1);
 168     if (it->getFlags() & DWARF2_FLAG_EPILOGUE_BEGIN)
 169       MCOS->EmitIntValue(dwarf::DW_LNS_set_epilogue_begin, 1);
 170
 171     int64_t LineDelta = static_cast<int64_t>(it->getLine()) - LastLine;
 172     MCSymbol *Label = it->getLabel();
 173
 174     // At this point we want to emit/create the sequence to encode the delta in
 175     // line numbers and the increment of the address from the previous Label
 176     // and the current Label.
 177     MCOS->EmitDwarfAdvanceLineAddr(LineDelta, LastLabel, Label);
 178
 179     LastLine = it->getLine();
 180     LastLabel = Label;
 181   }
 182
 183   // Emit a DW_LNE_end_sequence for the end of the section.
 184   // Using the pointer Section create a temporary label at the end of the
 185   // section and use that and the LastLabel to compute the address delta
 186   // and use INT64_MAX as the line delta which is the signal that this is
 187   // actually a DW_LNE_end_sequence.
 188
 189   // Switch to the section to be able to create a symbol at its end.
 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 the dwarf line section.
 199   MCOS->SwitchSection(context.getTargetAsmInfo().getDwarfLineSection());
 200
 201   MCOS->EmitDwarfAdvanceLineAddr(INT64_MAX, LastLabel, SectionEnd);
 202 }
 203
 204 //
 205 // This emits the Dwarf file and the line tables.
 206 //
 207 void MCDwarfFileTable::Emit(MCStreamer *MCOS) {
 208   MCContext &context = MCOS->getContext();
 209   // Switch to the section where the table will be emitted into.
 210   MCOS->SwitchSection(context.getTargetAsmInfo().getDwarfLineSection());
 211
 212   // Create a symbol at the beginning of this section.
 213   MCSymbol *LineStartSym = context.CreateTempSymbol();
 214   // Set the value of the symbol, as we are at the start of the section.
 215   MCOS->EmitLabel(LineStartSym);
 216
 217   // Create a symbol for the end of the section (to be set when we get there).
 218   MCSymbol *LineEndSym = context.CreateTempSymbol();
 219
 220   // The first 4 bytes is the total length of the information for this
 221   // compilation unit (not including these 4 bytes for the length).
 222   MCOS->EmitAbsValue(MakeStartMinusEndExpr(*MCOS, *LineStartSym, *LineEndSym,4),
 223                      4);
 224
 225   // Next 2 bytes is the Version, which is Dwarf 2.
 226   MCOS->EmitIntValue(2, 2);
 227
 228   // Create a symbol for the end of the prologue (to be set when we get there).
 229   MCSymbol *ProEndSym = context.CreateTempSymbol(); // Lprologue_end
 230
 231   // Length of the prologue, is the next 4 bytes.  Which is the start of the
 232   // section to the end of the prologue.  Not including the 4 bytes for the
 233   // total length, the 2 bytes for the version, and these 4 bytes for the
 234   // length of the prologue.
 235   MCOS->EmitAbsValue(MakeStartMinusEndExpr(*MCOS, *LineStartSym, *ProEndSym,
 236                                         (4 + 2 + 4)),
 237                   4, 0);
 238
 239   // Parameters of the state machine, are next.
 240   MCOS->EmitIntValue(DWARF2_LINE_MIN_INSN_LENGTH, 1);
 241   MCOS->EmitIntValue(DWARF2_LINE_DEFAULT_IS_STMT, 1);
 242   MCOS->EmitIntValue(DWARF2_LINE_BASE, 1);
 243   MCOS->EmitIntValue(DWARF2_LINE_RANGE, 1);
 244   MCOS->EmitIntValue(DWARF2_LINE_OPCODE_BASE, 1);
 245
 246   // Standard opcode lengths
 247   MCOS->EmitIntValue(0, 1); // length of DW_LNS_copy
 248   MCOS->EmitIntValue(1, 1); // length of DW_LNS_advance_pc
 249   MCOS->EmitIntValue(1, 1); // length of DW_LNS_advance_line
 250   MCOS->EmitIntValue(1, 1); // length of DW_LNS_set_file
 251   MCOS->EmitIntValue(1, 1); // length of DW_LNS_set_column
 252   MCOS->EmitIntValue(0, 1); // length of DW_LNS_negate_stmt
 253   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_basic_block
 254   MCOS->EmitIntValue(0, 1); // length of DW_LNS_const_add_pc
 255   MCOS->EmitIntValue(1, 1); // length of DW_LNS_fixed_advance_pc
 256   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_prologue_end
 257   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_epilogue_begin
 258   MCOS->EmitIntValue(1, 1); // DW_LNS_set_isa
 259
 260   // Put out the directory and file tables.
 261
 262   // First the directory table.
 263   const std::vector<StringRef> &MCDwarfDirs =
 264     context.getMCDwarfDirs();
 265   for (unsigned i = 0; i < MCDwarfDirs.size(); i++) {
 266     MCOS->EmitBytes(MCDwarfDirs[i], 0); // the DirectoryName
 267     MCOS->EmitBytes(StringRef("\0", 1), 0); // the null term. of the string
 268   }
 269   MCOS->EmitIntValue(0, 1); // Terminate the directory list
 270
 271   // Second the file table.
 272   const std::vector<MCDwarfFile *> &MCDwarfFiles =
 273     MCOS->getContext().getMCDwarfFiles();
 274   for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
 275     MCOS->EmitBytes(MCDwarfFiles[i]->getName(), 0); // FileName
 276     MCOS->EmitBytes(StringRef("\0", 1), 0); // the null term. of the string
 277     // the Directory num
 278     MCOS->EmitULEB128IntValue(MCDwarfFiles[i]->getDirIndex());
 279     MCOS->EmitIntValue(0, 1); // last modification timestamp (always 0)
 280     MCOS->EmitIntValue(0, 1); // filesize (always 0)
 281   }
 282   MCOS->EmitIntValue(0, 1); // Terminate the file list
 283
 284   // This is the end of the prologue, so set the value of the symbol at the
 285   // end of the prologue (that was used in a previous expression).
 286   MCOS->EmitLabel(ProEndSym);
 287
 288   // Put out the line tables.
 289   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
 290     MCOS->getContext().getMCLineSections();
 291   const std::vector<const MCSection *> &MCLineSectionOrder =
 292     MCOS->getContext().getMCLineSectionOrder();
 293   for (std::vector<const MCSection*>::const_iterator it =
 294         MCLineSectionOrder.begin(), ie = MCLineSectionOrder.end(); it != ie;
 295        ++it) {
 296     const MCSection *Sec = *it;
 297     const MCLineSection *Line = MCLineSections.lookup(Sec);
 298     EmitDwarfLineTable(MCOS, Sec, Line);
 299
 300     // Now delete the MCLineSections that were created in MCLineEntry::Make()
 301     // and used to emit the line table.
 302     delete Line;
 303   }
 304
 305   if (MCOS->getContext().getAsmInfo().getLinkerRequiresNonEmptyDwarfLines()
 306       && MCLineSectionOrder.begin() == MCLineSectionOrder.end()) {
 307     // The darwin9 linker has a bug (see PR8715). For for 32-bit architectures
 308     // it requires:
 309     // total_length >= prologue_length + 10
 310     // We are 4 bytes short, since we have total_length = 51 and
 311     // prologue_length = 45
 312
 313     // The regular end_sequence should be sufficient.
 314     MCDwarfLineAddr::Emit(MCOS, INT64_MAX, 0);
 315   }
 316
 317   // This is the end of the section, so set the value of the symbol at the end
 318   // of this section (that was used in a previous expression).
 319   MCOS->EmitLabel(LineEndSym);
 320 }
 321
 322 /// Utility function to write the encoding to an object writer.
 323 void MCDwarfLineAddr::Write(MCObjectWriter *OW, int64_t LineDelta,
 324                             uint64_t AddrDelta) {
 325   SmallString<256> Tmp;
 326   raw_svector_ostream OS(Tmp);
 327   MCDwarfLineAddr::Encode(LineDelta, AddrDelta, OS);
 328   OW->WriteBytes(OS.str());
 329 }
 330
 331 /// Utility function to emit the encoding to a streamer.
 332 void MCDwarfLineAddr::Emit(MCStreamer *MCOS, int64_t LineDelta,
 333                            uint64_t AddrDelta) {
 334   SmallString<256> Tmp;
 335   raw_svector_ostream OS(Tmp);
 336   MCDwarfLineAddr::Encode(LineDelta, AddrDelta, OS);
 337   MCOS->EmitBytes(OS.str(), /*AddrSpace=*/0);
 338 }
 339
 340 /// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
 341 void MCDwarfLineAddr::Encode(int64_t LineDelta, uint64_t AddrDelta,
 342                              raw_ostream &OS) {
 343   uint64_t Temp, Opcode;
 344   bool NeedCopy = false;
 345
 346   // Scale the address delta by the minimum instruction length.
 347   AddrDelta = ScaleAddrDelta(AddrDelta);
 348
 349   // A LineDelta of INT64_MAX is a signal that this is actually a
 350   // DW_LNE_end_sequence. We cannot use special opcodes here, since we want the
 351   // end_sequence to emit the matrix entry.
 352   if (LineDelta == INT64_MAX) {
 353     if (AddrDelta == MAX_SPECIAL_ADDR_DELTA)
 354       OS << char(dwarf::DW_LNS_const_add_pc);
 355     else {
 356       OS << char(dwarf::DW_LNS_advance_pc);
 357       MCObjectWriter::EncodeULEB128(AddrDelta, OS);
 358     }
 359     OS << char(dwarf::DW_LNS_extended_op);
 360     OS << char(1);
 361     OS << char(dwarf::DW_LNE_end_sequence);
 362     return;
 363   }
 364
 365   // Bias the line delta by the base.
 366   Temp = LineDelta - DWARF2_LINE_BASE;
 367
 368   // If the line increment is out of range of a special opcode, we must encode
 369   // it with DW_LNS_advance_line.
 370   if (Temp >= DWARF2_LINE_RANGE) {
 371     OS << char(dwarf::DW_LNS_advance_line);
 372     SmallString<32> Tmp;
 373     raw_svector_ostream OSE(Tmp);
 374     MCObjectWriter::EncodeSLEB128(LineDelta, OSE);
 375     OS << OSE.str();
 376
 377     LineDelta = 0;
 378     Temp = 0 - DWARF2_LINE_BASE;
 379     NeedCopy = true;
 380   }
 381
 382   // Use DW_LNS_copy instead of a "line +0, addr +0" special opcode.
 383   if (LineDelta == 0 && AddrDelta == 0) {
 384     OS << char(dwarf::DW_LNS_copy);
 385     return;
 386   }
 387
 388   // Bias the opcode by the special opcode base.
 389   Temp += DWARF2_LINE_OPCODE_BASE;
 390
 391   // Avoid overflow when addr_delta is large.
 392   if (AddrDelta < 256 + MAX_SPECIAL_ADDR_DELTA) {
 393     // Try using a special opcode.
 394     Opcode = Temp + AddrDelta * DWARF2_LINE_RANGE;
 395     if (Opcode <= 255) {
 396       OS << char(Opcode);
 397       return;
 398     }
 399
 400     // Try using DW_LNS_const_add_pc followed by special op.
 401     Opcode = Temp + (AddrDelta - MAX_SPECIAL_ADDR_DELTA) * DWARF2_LINE_RANGE;
 402     if (Opcode <= 255) {
 403       OS << char(dwarf::DW_LNS_const_add_pc);
 404       OS << char(Opcode);
 405       return;
 406     }
 407   }
 408
 409   // Otherwise use DW_LNS_advance_pc.
 410   OS << char(dwarf::DW_LNS_advance_pc);
 411   SmallString<32> Tmp;
 412   raw_svector_ostream OSE(Tmp);
 413   MCObjectWriter::EncodeULEB128(AddrDelta, OSE);
 414   OS << OSE.str();
 415
 416   if (NeedCopy)
 417     OS << char(dwarf::DW_LNS_copy);
 418   else
 419     OS << char(Temp);
 420 }
 421
 422 void MCDwarfFile::print(raw_ostream &OS) const {
 423   OS << '"' << getName() << '"';
 424 }
 425
 426 void MCDwarfFile::dump() const {
 427   print(dbgs());
 428 }
 429
 430 static int getDataAlignmentFactor(MCStreamer &streamer) {
 431   MCContext &context = streamer.getContext();
 432   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 433   int size = asmInfo.getPointerSize();
 434   if (asmInfo.getStackGrowthDirection() == TargetFrameLowering::StackGrowsUp)
 435     return size;
 436  else
 437    return -size;
 438 }
 439
 440 static unsigned getSizeForEncoding(MCStreamer &streamer,
 441                                    unsigned symbolEncoding) {
 442   MCContext &context = streamer.getContext();
 443   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 444   unsigned format = symbolEncoding & 0x0f;
 445   switch (format) {
 446   default:
 447     assert(0 && "Unknown Encoding");
 448   case dwarf::DW_EH_PE_absptr:
 449   case dwarf::DW_EH_PE_signed:
 450     return asmInfo.getPointerSize();
 451   case dwarf::DW_EH_PE_udata2:
 452   case dwarf::DW_EH_PE_sdata2:
 453     return 2;
 454   case dwarf::DW_EH_PE_udata4:
 455   case dwarf::DW_EH_PE_sdata4:
 456     return 4;
 457   case dwarf::DW_EH_PE_udata8:
 458   case dwarf::DW_EH_PE_sdata8:
 459     return 8;
 460   }
 461 }
 462
 463 static void EmitSymbol(MCStreamer &streamer, const MCSymbol &symbol,
 464                        unsigned symbolEncoding) {
 465   MCContext &context = streamer.getContext();
 466   const MCAsmInfo &asmInfo = context.getAsmInfo();
 467   const MCExpr *v = asmInfo.getExprForFDESymbol(&symbol,
 468                                                 symbolEncoding,
 469                                                 streamer);
 470   unsigned size = getSizeForEncoding(streamer, symbolEncoding);
 471   streamer.EmitAbsValue(v, size);
 472 }
 473
 474 static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol,
 475                             unsigned symbolEncoding) {
 476   MCContext &context = streamer.getContext();
 477   const MCAsmInfo &asmInfo = context.getAsmInfo();
 478   const MCExpr *v = asmInfo.getExprForPersonalitySymbol(&symbol,
 479                                                         symbolEncoding,
 480                                                         streamer);
 481   unsigned size = getSizeForEncoding(streamer, symbolEncoding);
 482   streamer.EmitValue(v, size);
 483 }
 484
 485 static const MachineLocation TranslateMachineLocation(
 486                                                   const TargetAsmInfo &AsmInfo,
 487                                                   const MachineLocation &Loc) {
 488   unsigned Reg = Loc.getReg() == MachineLocation::VirtualFP ?
 489     MachineLocation::VirtualFP :
 490     unsigned(AsmInfo.getDwarfRegNum(Loc.getReg(), true));
 491   const MachineLocation &NewLoc = Loc.isReg() ?
 492     MachineLocation(Reg) : MachineLocation(Reg, Loc.getOffset());
 493   return NewLoc;
 494 }
 495
 496 namespace {
 497   class FrameEmitterImpl {
 498     int CFAOffset;
 499     int CIENum;
 500     bool UsingCFI;
 501     bool IsEH;
 502     const MCSymbol *SectionStart;
 503
 504   public:
 505     FrameEmitterImpl(bool usingCFI, bool isEH, const MCSymbol *sectionStart) :
 506       CFAOffset(0), CIENum(0), UsingCFI(usingCFI), IsEH(isEH),
 507       SectionStart(sectionStart) {
 508     }
 509
 510     /// EmitCompactUnwind - Emit the unwind information in a compact way. If
 511     /// we're successful, return 'true'. Otherwise, return 'false' and it will
 512     /// emit the normal CIE and FDE.
 513     bool EmitCompactUnwind(MCStreamer &streamer,
 514                            const MCDwarfFrameInfo &frame);
 515
 516     const MCSymbol &EmitCIE(MCStreamer &streamer,
 517                             const MCSymbol *personality,
 518                             unsigned personalityEncoding,
 519                             const MCSymbol *lsda,
 520                             unsigned lsdaEncoding);
 521     MCSymbol *EmitFDE(MCStreamer &streamer,
 522                       const MCSymbol &cieStart,
 523                       const MCDwarfFrameInfo &frame);
 524     void EmitCFIInstructions(MCStreamer &streamer,
 525                              const std::vector<MCCFIInstruction> &Instrs,
 526                              MCSymbol *BaseLabel);
 527     void EmitCFIInstruction(MCStreamer &Streamer,
 528                             const MCCFIInstruction &Instr);
 529   };
 530 }
 531
 532 void FrameEmitterImpl::EmitCFIInstruction(MCStreamer &Streamer,
 533                                           const MCCFIInstruction &Instr) {
 534   int dataAlignmentFactor = getDataAlignmentFactor(Streamer);
 535
 536   switch (Instr.getOperation()) {
 537   case MCCFIInstruction::Move:
 538   case MCCFIInstruction::RelMove: {
 539     const MachineLocation &Dst = Instr.getDestination();
 540     const MachineLocation &Src = Instr.getSource();
 541     const bool IsRelative = Instr.getOperation() == MCCFIInstruction::RelMove;
 542
 543     // If advancing cfa.
 544     if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
 545       if (Src.getReg() == MachineLocation::VirtualFP) {
 546         Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
 547       } else {
 548         Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
 549         Streamer.EmitULEB128IntValue(Src.getReg());
 550       }
 551
 552       if (IsRelative)
 553         CFAOffset += Src.getOffset();
 554       else
 555         CFAOffset = -Src.getOffset();
 556
 557       Streamer.EmitULEB128IntValue(CFAOffset);
 558       return;
 559     }
 560
 561     if (Src.isReg() && Src.getReg() == MachineLocation::VirtualFP) {
 562       assert(Dst.isReg() && "Machine move not supported yet.");
 563       Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
 564       Streamer.EmitULEB128IntValue(Dst.getReg());
 565       return;
 566     }
 567
 568     unsigned Reg = Src.getReg();
 569
 570     int Offset = Dst.getOffset();
 571     if (IsRelative)
 572       Offset -= CFAOffset;
 573     Offset = Offset / dataAlignmentFactor;
 574
 575     if (Offset < 0) {
 576       Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
 577       Streamer.EmitULEB128IntValue(Reg);
 578       Streamer.EmitSLEB128IntValue(Offset);
 579     } else if (Reg < 64) {
 580       Streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
 581       Streamer.EmitULEB128IntValue(Offset);
 582     } else {
 583       Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
 584       Streamer.EmitULEB128IntValue(Reg);
 585       Streamer.EmitULEB128IntValue(Offset);
 586     }
 587     return;
 588   }
 589   case MCCFIInstruction::Remember:
 590     Streamer.EmitIntValue(dwarf::DW_CFA_remember_state, 1);
 591     return;
 592   case MCCFIInstruction::Restore:
 593     Streamer.EmitIntValue(dwarf::DW_CFA_restore_state, 1);
 594     return;
 595   case MCCFIInstruction::SameValue: {
 596     unsigned Reg = Instr.getDestination().getReg();
 597     Streamer.EmitIntValue(dwarf::DW_CFA_same_value, 1);
 598     Streamer.EmitULEB128IntValue(Reg);
 599     return;
 600   }
 601   }
 602   llvm_unreachable("Unhandled case in switch");
 603 }
 604
 605 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
 606 /// frame.
 607 void FrameEmitterImpl::EmitCFIInstructions(MCStreamer &streamer,
 608                                     const std::vector<MCCFIInstruction> &Instrs,
 609                                            MCSymbol *BaseLabel) {
 610   for (unsigned i = 0, N = Instrs.size(); i < N; ++i) {
 611     const MCCFIInstruction &Instr = Instrs[i];
 612     MCSymbol *Label = Instr.getLabel();
 613     // Throw out move if the label is invalid.
 614     if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
 615
 616     // Advance row if new location.
 617     if (BaseLabel && Label) {
 618       MCSymbol *ThisSym = Label;
 619       if (ThisSym != BaseLabel) {
 620         streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
 621         BaseLabel = ThisSym;
 622       }
 623     }
 624
 625     EmitCFIInstruction(streamer, Instr);
 626   }
 627 }
 628
 629 /// EmitCompactUnwind - Emit the unwind information in a compact way. If we're
 630 /// successful, return 'true'. Otherwise, return 'false' and it will emit the
 631 /// normal CIE and FDE.
 632 bool FrameEmitterImpl::EmitCompactUnwind(MCStreamer &Streamer,
 633                                          const MCDwarfFrameInfo &Frame) {
 634 #if 1
 635   return false;
 636 #else
 637   MCContext &Context = Streamer.getContext();
 638   const TargetAsmInfo &TAI = Context.getTargetAsmInfo();
 639   Streamer.SwitchSection(TAI.getCompactUnwindSection());
 640
 641   unsigned FDEEncoding = TAI.getFDEEncoding(UsingCFI);
 642   unsigned Size = getSizeForEncoding(Streamer, FDEEncoding);
 643
 644   // range-start range-length  compact-unwind-enc personality-func   lsda
 645   //  _foo       LfooEnd-_foo  0x00000023          0                 0
 646   //  _bar       LbarEnd-_bar  0x00000025         __gxx_personality  except_tab1
 647   //
 648   //   .section __LD,__compact_unwind,regular,debug
 649   //
 650   //   # compact unwind for _foo
 651   //   .quad _foo
 652   //   .set L1,LfooEnd-_foo
 653   //   .long L1
 654   //   .long 0x01010001
 655   //   .quad 0
 656   //   .quad 0
 657   //
 658   //   # compact unwind for _bar
 659   //   .quad _bar
 660   //   .set L2,LbarEnd-_bar
 661   //   .long L2
 662   //   .long 0x01020011
 663   //   .quad __gxx_personality
 664   //   .quad except_tab1
 665
 666   // Range Start
 667   EmitSymbol(Streamer, *Frame.Begin, FDEEncoding);
 668
 669   // Range Length
 670   const MCExpr *Range = MakeStartMinusEndExpr(Streamer, *Frame.Begin,
 671                                               *Frame.End, 0);
 672   Streamer.EmitAbsValue(Range, Size);
 673
 674   return true;
 675 #endif
 676 }
 677
 678 const MCSymbol &FrameEmitterImpl::EmitCIE(MCStreamer &streamer,
 679                                           const MCSymbol *personality,
 680                                           unsigned personalityEncoding,
 681                                           const MCSymbol *lsda,
 682                                           unsigned lsdaEncoding) {
 683   MCContext &context = streamer.getContext();
 684   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 685
 686   MCSymbol *sectionStart;
 687   if (asmInfo.isFunctionEHFrameSymbolPrivate() || !IsEH)
 688     sectionStart = context.CreateTempSymbol();
 689   else
 690     sectionStart = context.GetOrCreateSymbol(Twine("EH_frame") + Twine(CIENum));
 691
 692   CIENum++;
 693
 694   MCSymbol *sectionEnd = streamer.getContext().CreateTempSymbol();
 695
 696   // Length
 697   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *sectionStart,
 698                                                *sectionEnd, 4);
 699   streamer.EmitLabel(sectionStart);
 700   streamer.EmitAbsValue(Length, 4);
 701
 702   // CIE ID
 703   unsigned CIE_ID = IsEH ? 0 : -1;
 704   streamer.EmitIntValue(CIE_ID, 4);
 705
 706   // Version
 707   streamer.EmitIntValue(dwarf::DW_CIE_VERSION, 1);
 708
 709   // Augmentation String
 710   SmallString<8> Augmentation;
 711   if (IsEH) {
 712     Augmentation += "z";
 713     if (personality)
 714       Augmentation += "P";
 715     if (lsda)
 716       Augmentation += "L";
 717     Augmentation += "R";
 718     streamer.EmitBytes(Augmentation.str(), 0);
 719   }
 720   streamer.EmitIntValue(0, 1);
 721
 722   // Code Alignment Factor
 723   streamer.EmitULEB128IntValue(1);
 724
 725   // Data Alignment Factor
 726   streamer.EmitSLEB128IntValue(getDataAlignmentFactor(streamer));
 727
 728   // Return Address Register
 729   streamer.EmitULEB128IntValue(asmInfo.getDwarfRARegNum(true));
 730
 731   // Augmentation Data Length (optional)
 732
 733   unsigned augmentationLength = 0;
 734   if (IsEH) {
 735     if (personality) {
 736       // Personality Encoding
 737       augmentationLength += 1;
 738       // Personality
 739       augmentationLength += getSizeForEncoding(streamer, personalityEncoding);
 740     }
 741     if (lsda)
 742       augmentationLength += 1;
 743     // Encoding of the FDE pointers
 744     augmentationLength += 1;
 745
 746     streamer.EmitULEB128IntValue(augmentationLength);
 747
 748     // Augmentation Data (optional)
 749     if (personality) {
 750       // Personality Encoding
 751       streamer.EmitIntValue(personalityEncoding, 1);
 752       // Personality
 753       EmitPersonality(streamer, *personality, personalityEncoding);
 754     }
 755     if (lsda)
 756       streamer.EmitIntValue(lsdaEncoding, 1); // LSDA Encoding
 757     // Encoding of the FDE pointers
 758     streamer.EmitIntValue(asmInfo.getFDEEncoding(UsingCFI), 1);
 759   }
 760
 761   // Initial Instructions
 762
 763   const std::vector<MachineMove> Moves = asmInfo.getInitialFrameState();
 764   std::vector<MCCFIInstruction> Instructions;
 765
 766   for (int i = 0, n = Moves.size(); i != n; ++i) {
 767     MCSymbol *Label = Moves[i].getLabel();
 768     const MachineLocation &Dst =
 769       TranslateMachineLocation(asmInfo, Moves[i].getDestination());
 770     const MachineLocation &Src =
 771       TranslateMachineLocation(asmInfo, Moves[i].getSource());
 772     MCCFIInstruction Inst(Label, Dst, Src);
 773     Instructions.push_back(Inst);
 774   }
 775
 776   EmitCFIInstructions(streamer, Instructions, NULL);
 777
 778   // Padding
 779   streamer.EmitValueToAlignment(IsEH ? 4 : asmInfo.getPointerSize());
 780
 781   streamer.EmitLabel(sectionEnd);
 782   return *sectionStart;
 783 }
 784
 785 MCSymbol *FrameEmitterImpl::EmitFDE(MCStreamer &streamer,
 786                                     const MCSymbol &cieStart,
 787                                     const MCDwarfFrameInfo &frame) {
 788   MCContext &context = streamer.getContext();
 789   MCSymbol *fdeStart = context.CreateTempSymbol();
 790   MCSymbol *fdeEnd = context.CreateTempSymbol();
 791   const TargetAsmInfo &TAsmInfo = context.getTargetAsmInfo();
 792
 793   if (!TAsmInfo.isFunctionEHFrameSymbolPrivate() && IsEH) {
 794     MCSymbol *EHSym = context.GetOrCreateSymbol(
 795       frame.Function->getName() + Twine(".eh"));
 796     streamer.EmitEHSymAttributes(frame.Function, EHSym);
 797     streamer.EmitLabel(EHSym);
 798   }
 799
 800   // Length
 801   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *fdeStart, *fdeEnd, 0);
 802   streamer.EmitAbsValue(Length, 4);
 803
 804   streamer.EmitLabel(fdeStart);
 805
 806   // CIE Pointer
 807   const MCAsmInfo &asmInfo = context.getAsmInfo();
 808   if (IsEH) {
 809     const MCExpr *offset = MakeStartMinusEndExpr(streamer, cieStart, *fdeStart,
 810                                                  0);
 811     streamer.EmitAbsValue(offset, 4);
 812   } else if (!asmInfo.doesDwarfRequireRelocationForSectionOffset()) {
 813     const MCExpr *offset = MakeStartMinusEndExpr(streamer, *SectionStart,
 814                                                  cieStart, 0);
 815     streamer.EmitAbsValue(offset, 4);
 816   } else {
 817     streamer.EmitSymbolValue(&cieStart, 4);
 818   }
 819   unsigned fdeEncoding = TAsmInfo.getFDEEncoding(UsingCFI);
 820   unsigned size = getSizeForEncoding(streamer, fdeEncoding);
 821
 822   // PC Begin
 823   unsigned PCBeginEncoding = IsEH ? fdeEncoding :
 824     (unsigned)dwarf::DW_EH_PE_absptr;
 825   unsigned PCBeginSize = getSizeForEncoding(streamer, PCBeginEncoding);
 826   EmitSymbol(streamer, *frame.Begin, PCBeginEncoding);
 827
 828   // PC Range
 829   const MCExpr *Range = MakeStartMinusEndExpr(streamer, *frame.Begin,
 830                                               *frame.End, 0);
 831   streamer.EmitAbsValue(Range, size);
 832
 833   if (IsEH) {
 834     // Augmentation Data Length
 835     unsigned augmentationLength = 0;
 836
 837     if (frame.Lsda)
 838       augmentationLength += getSizeForEncoding(streamer, frame.LsdaEncoding);
 839
 840     streamer.EmitULEB128IntValue(augmentationLength);
 841
 842     // Augmentation Data
 843     if (frame.Lsda)
 844       EmitSymbol(streamer, *frame.Lsda, frame.LsdaEncoding);
 845   }
 846
 847   // Call Frame Instructions
 848
 849   EmitCFIInstructions(streamer, frame.Instructions, frame.Begin);
 850
 851   // Padding
 852   streamer.EmitValueToAlignment(PCBeginSize);
 853
 854   return fdeEnd;
 855 }
 856
 857 namespace {
 858   struct CIEKey {
 859     static const CIEKey getEmptyKey() { return CIEKey(0, 0, -1); }
 860     static const CIEKey getTombstoneKey() { return CIEKey(0, -1, 0); }
 861
 862     CIEKey(const MCSymbol* Personality_, unsigned PersonalityEncoding_,
 863            unsigned LsdaEncoding_) : Personality(Personality_),
 864                                      PersonalityEncoding(PersonalityEncoding_),
 865                                      LsdaEncoding(LsdaEncoding_) {
 866     }
 867     const MCSymbol* Personality;
 868     unsigned PersonalityEncoding;
 869     unsigned LsdaEncoding;
 870   };
 871 }
 872
 873 namespace llvm {
 874   template <>
 875   struct DenseMapInfo<CIEKey> {
 876     static CIEKey getEmptyKey() {
 877       return CIEKey::getEmptyKey();
 878     }
 879     static CIEKey getTombstoneKey() {
 880       return CIEKey::getTombstoneKey();
 881     }
 882     static unsigned getHashValue(const CIEKey &Key) {
 883       FoldingSetNodeID ID;
 884       ID.AddPointer(Key.Personality);
 885       ID.AddInteger(Key.PersonalityEncoding);
 886       ID.AddInteger(Key.LsdaEncoding);
 887       return ID.ComputeHash();
 888     }
 889     static bool isEqual(const CIEKey &LHS,
 890                         const CIEKey &RHS) {
 891       return LHS.Personality == RHS.Personality &&
 892         LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
 893         LHS.LsdaEncoding == RHS.LsdaEncoding;
 894     }
 895   };
 896 }
 897
 898 void MCDwarfFrameEmitter::Emit(MCStreamer &streamer,
 899                                bool usingCFI,
 900                                bool isEH) {
 901   MCContext &context = streamer.getContext();
 902   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 903   const MCSection &section = isEH ?
 904     *asmInfo.getEHFrameSection() :
 905     *asmInfo.getDwarfFrameSection();
 906   streamer.SwitchSection(&section);
 907   MCSymbol *SectionStart = context.CreateTempSymbol();
 908   streamer.EmitLabel(SectionStart);
 909
 910   MCSymbol *fdeEnd = NULL;
 911   DenseMap<CIEKey, const MCSymbol*> CIEStarts;
 912   FrameEmitterImpl Emitter(usingCFI, isEH, SectionStart);
 913
 914   const MCSymbol *DummyDebugKey = NULL;
 915   for (unsigned i = 0, n = streamer.getNumFrameInfos(); i < n; ++i) {
 916     const MCDwarfFrameInfo &frame = streamer.getFrameInfo(i);
 917     CIEKey key(frame.Personality, frame.PersonalityEncoding,
 918                frame.LsdaEncoding);
 919     const MCSymbol *&cieStart = isEH ? CIEStarts[key] : DummyDebugKey;
 920     if (isEH && asmInfo.getCompactUnwindSection() &&
 921         Emitter.EmitCompactUnwind(streamer, frame))
 922       continue;
 923
 924     if (!cieStart)
 925       cieStart = &Emitter.EmitCIE(streamer, frame.Personality,
 926                                   frame.PersonalityEncoding, frame.Lsda,
 927                                   frame.LsdaEncoding);
 928
 929     fdeEnd = Emitter.EmitFDE(streamer, *cieStart, frame);
 930
 931     if (i != n - 1)
 932       streamer.EmitLabel(fdeEnd);
 933   }
 934
 935   streamer.EmitValueToAlignment(asmInfo.getPointerSize());
 936   if (fdeEnd)
 937     streamer.EmitLabel(fdeEnd);
 938 }
 939
 940 void MCDwarfFrameEmitter::EmitAdvanceLoc(MCStreamer &Streamer,
 941                                          uint64_t AddrDelta) {
 942   SmallString<256> Tmp;
 943   raw_svector_ostream OS(Tmp);
 944   MCDwarfFrameEmitter::EncodeAdvanceLoc(AddrDelta, OS);
 945   Streamer.EmitBytes(OS.str(), /*AddrSpace=*/0);
 946 }
 947
 948 void MCDwarfFrameEmitter::EncodeAdvanceLoc(uint64_t AddrDelta,
 949                                            raw_ostream &OS) {
 950   // FIXME: Assumes the code alignment factor is 1.
 951   if (AddrDelta == 0) {
 952   } else if (isUIntN(6, AddrDelta)) {
 953     uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
 954     OS << Opcode;
 955   } else if (isUInt<8>(AddrDelta)) {
 956     OS << uint8_t(dwarf::DW_CFA_advance_loc1);
 957     OS << uint8_t(AddrDelta);
 958   } else if (isUInt<16>(AddrDelta)) {
 959     // FIXME: check what is the correct behavior on a big endian machine.
 960     OS << uint8_t(dwarf::DW_CFA_advance_loc2);
 961     OS << uint8_t( AddrDelta       & 0xff);
 962     OS << uint8_t((AddrDelta >> 8) & 0xff);
 963   } else {
 964     // FIXME: check what is the correct behavior on a big endian machine.
 965     assert(isUInt<32>(AddrDelta));
 966     OS << uint8_t(dwarf::DW_CFA_advance_loc4);
 967     OS << uint8_t( AddrDelta        & 0xff);
 968     OS << uint8_t((AddrDelta >> 8)  & 0xff);
 969     OS << uint8_t((AddrDelta >> 16) & 0xff);
 970     OS << uint8_t((AddrDelta >> 24) & 0xff);
 971
 972   }
 973 }