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/Support/Debug.h"
  21 #include "llvm/Support/raw_ostream.h"
  22 #include "llvm/Target/TargetAsmBackend.h"
  23 #include "llvm/Target/TargetAsmInfo.h"
  24 using namespace llvm;
  25
  26 // Given a special op, return the address skip amount (in units of
  27 // DWARF2_LINE_MIN_INSN_LENGTH.
  28 #define SPECIAL_ADDR(op) (((op) - DWARF2_LINE_OPCODE_BASE)/DWARF2_LINE_RANGE)
  29
  30 // The maximum address skip amount that can be encoded with a special op.
  31 #define MAX_SPECIAL_ADDR_DELTA          SPECIAL_ADDR(255)
  32
  33 // First special line opcode - leave room for the standard opcodes.
  34 // Note: If you want to change this, you'll have to update the
  35 // "standard_opcode_lengths" table that is emitted in DwarfFileTable::Emit().
  36 #define DWARF2_LINE_OPCODE_BASE         13
  37
  38 // Minimum line offset in a special line info. opcode.  This value
  39 // was chosen to give a reasonable range of values.
  40 #define DWARF2_LINE_BASE                -5
  41
  42 // Range of line offsets in a special line info. opcode.
  43 # define DWARF2_LINE_RANGE              14
  44
  45 // Define the architecture-dependent minimum instruction length (in bytes).
  46 // This value should be rather too small than too big.
  47 # define DWARF2_LINE_MIN_INSN_LENGTH    1
  48
  49 // Note: when DWARF2_LINE_MIN_INSN_LENGTH == 1 which is the current setting,
  50 // this routine is a nop and will be optimized away.
  51 static inline uint64_t ScaleAddrDelta(uint64_t AddrDelta)
  52 {
  53   if (DWARF2_LINE_MIN_INSN_LENGTH == 1)
  54     return AddrDelta;
  55   if (AddrDelta % DWARF2_LINE_MIN_INSN_LENGTH != 0) {
  56     // TODO: report this error, but really only once.
  57     ;
  58   }
  59   return AddrDelta / DWARF2_LINE_MIN_INSN_LENGTH;
  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(MCStreamer *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   // Get the MCLineSection for this section, if one does not exist for this
  86   // section create it.
  87   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
  88     MCOS->getContext().getMCLineSections();
  89   MCLineSection *LineSection = MCLineSections.lookup(Section);
  90   if (!LineSection) {
  91     // Create a new MCLineSection.  This will be deleted after the dwarf line
  92     // table is created using it by iterating through the MCLineSections
  93     // DenseMap.
  94     LineSection = new MCLineSection;
  95     // Save a pointer to the new LineSection into the MCLineSections DenseMap.
  96     MCOS->getContext().addMCLineSection(Section, LineSection);
  97   }
  98
  99   // Add the line entry to this section's entries.
 100   LineSection->addLineEntry(LineEntry);
 101 }
 102
 103 //
 104 // This helper routine returns an expression of End - Start + IntVal .
 105 //
 106 static inline const MCExpr *MakeStartMinusEndExpr(const MCStreamer &MCOS,
 107                                                   const MCSymbol &Start,
 108                                                   const MCSymbol &End,
 109                                                   int IntVal) {
 110   MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
 111   const MCExpr *Res =
 112     MCSymbolRefExpr::Create(&End, Variant, MCOS.getContext());
 113   const MCExpr *RHS =
 114     MCSymbolRefExpr::Create(&Start, Variant, MCOS.getContext());
 115   const MCExpr *Res1 =
 116     MCBinaryExpr::Create(MCBinaryExpr::Sub, Res, RHS, MCOS.getContext());
 117   const MCExpr *Res2 =
 118     MCConstantExpr::Create(IntVal, MCOS.getContext());
 119   const MCExpr *Res3 =
 120     MCBinaryExpr::Create(MCBinaryExpr::Sub, Res1, Res2, MCOS.getContext());
 121   return Res3;
 122 }
 123
 124 //
 125 // This emits the Dwarf line table for the specified section from the entries
 126 // in the LineSection.
 127 //
 128 static inline void EmitDwarfLineTable(MCStreamer *MCOS,
 129                                       const MCSection *Section,
 130                                       const MCLineSection *LineSection) {
 131   unsigned FileNum = 1;
 132   unsigned LastLine = 1;
 133   unsigned Column = 0;
 134   unsigned Flags = DWARF2_LINE_DEFAULT_IS_STMT ? DWARF2_FLAG_IS_STMT : 0;
 135   unsigned Isa = 0;
 136   MCSymbol *LastLabel = NULL;
 137
 138   // Loop through each MCLineEntry and encode the dwarf line number table.
 139   for (MCLineSection::const_iterator
 140          it = LineSection->getMCLineEntries()->begin(),
 141          ie = LineSection->getMCLineEntries()->end(); it != ie; ++it) {
 142
 143     if (FileNum != it->getFileNum()) {
 144       FileNum = it->getFileNum();
 145       MCOS->EmitIntValue(dwarf::DW_LNS_set_file, 1);
 146       MCOS->EmitULEB128IntValue(FileNum);
 147     }
 148     if (Column != it->getColumn()) {
 149       Column = it->getColumn();
 150       MCOS->EmitIntValue(dwarf::DW_LNS_set_column, 1);
 151       MCOS->EmitULEB128IntValue(Column);
 152     }
 153     if (Isa != it->getIsa()) {
 154       Isa = it->getIsa();
 155       MCOS->EmitIntValue(dwarf::DW_LNS_set_isa, 1);
 156       MCOS->EmitULEB128IntValue(Isa);
 157     }
 158     if ((it->getFlags() ^ Flags) & DWARF2_FLAG_IS_STMT) {
 159       Flags = it->getFlags();
 160       MCOS->EmitIntValue(dwarf::DW_LNS_negate_stmt, 1);
 161     }
 162     if (it->getFlags() & DWARF2_FLAG_BASIC_BLOCK)
 163       MCOS->EmitIntValue(dwarf::DW_LNS_set_basic_block, 1);
 164     if (it->getFlags() & DWARF2_FLAG_PROLOGUE_END)
 165       MCOS->EmitIntValue(dwarf::DW_LNS_set_prologue_end, 1);
 166     if (it->getFlags() & DWARF2_FLAG_EPILOGUE_BEGIN)
 167       MCOS->EmitIntValue(dwarf::DW_LNS_set_epilogue_begin, 1);
 168
 169     int64_t LineDelta = static_cast<int64_t>(it->getLine()) - LastLine;
 170     MCSymbol *Label = it->getLabel();
 171
 172     // At this point we want to emit/create the sequence to encode the delta in
 173     // line numbers and the increment of the address from the previous Label
 174     // and the current Label.
 175     MCOS->EmitDwarfAdvanceLineAddr(LineDelta, LastLabel, Label);
 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   MCOS->SwitchSection(Section);
 189
 190   MCContext &context = MCOS->getContext();
 191   // Create a symbol at the end of the section.
 192   MCSymbol *SectionEnd = context.CreateTempSymbol();
 193   // Set the value of the symbol, as we are at the end of the section.
 194   MCOS->EmitLabel(SectionEnd);
 195
 196   // Switch back the the dwarf line section.
 197   MCOS->SwitchSection(context.getTargetAsmInfo().getDwarfLineSection());
 198
 199   MCOS->EmitDwarfAdvanceLineAddr(INT64_MAX, LastLabel, SectionEnd);
 200 }
 201
 202 //
 203 // This emits the Dwarf file and the line tables.
 204 //
 205 void MCDwarfFileTable::Emit(MCStreamer *MCOS) {
 206   MCContext &context = MCOS->getContext();
 207   // Switch to the section where the table will be emitted into.
 208   MCOS->SwitchSection(context.getTargetAsmInfo().getDwarfLineSection());
 209
 210   // Create a symbol at the beginning of this section.
 211   MCSymbol *LineStartSym = context.CreateTempSymbol();
 212   // Set the value of the symbol, as we are at the start of the section.
 213   MCOS->EmitLabel(LineStartSym);
 214
 215   // Create a symbol for the end of the section (to be set when we get there).
 216   MCSymbol *LineEndSym = context.CreateTempSymbol();
 217
 218   // The first 4 bytes is the total length of the information for this
 219   // compilation unit (not including these 4 bytes for the length).
 220   MCOS->EmitAbsValue(MakeStartMinusEndExpr(*MCOS, *LineStartSym, *LineEndSym,4),
 221                      4);
 222
 223   // Next 2 bytes is the Version, which is Dwarf 2.
 224   MCOS->EmitIntValue(2, 2);
 225
 226   // Create a symbol for the end of the prologue (to be set when we get there).
 227   MCSymbol *ProEndSym = context.CreateTempSymbol(); // Lprologue_end
 228
 229   // Length of the prologue, is the next 4 bytes.  Which is the start of the
 230   // section to the end of the prologue.  Not including the 4 bytes for the
 231   // total length, the 2 bytes for the version, and these 4 bytes for the
 232   // length of the prologue.
 233   MCOS->EmitAbsValue(MakeStartMinusEndExpr(*MCOS, *LineStartSym, *ProEndSym,
 234                                         (4 + 2 + 4)),
 235                   4, 0);
 236
 237   // Parameters of the state machine, are next.
 238   MCOS->EmitIntValue(DWARF2_LINE_MIN_INSN_LENGTH, 1);
 239   MCOS->EmitIntValue(DWARF2_LINE_DEFAULT_IS_STMT, 1);
 240   MCOS->EmitIntValue(DWARF2_LINE_BASE, 1);
 241   MCOS->EmitIntValue(DWARF2_LINE_RANGE, 1);
 242   MCOS->EmitIntValue(DWARF2_LINE_OPCODE_BASE, 1);
 243
 244   // Standard opcode lengths
 245   MCOS->EmitIntValue(0, 1); // length of DW_LNS_copy
 246   MCOS->EmitIntValue(1, 1); // length of DW_LNS_advance_pc
 247   MCOS->EmitIntValue(1, 1); // length of DW_LNS_advance_line
 248   MCOS->EmitIntValue(1, 1); // length of DW_LNS_set_file
 249   MCOS->EmitIntValue(1, 1); // length of DW_LNS_set_column
 250   MCOS->EmitIntValue(0, 1); // length of DW_LNS_negate_stmt
 251   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_basic_block
 252   MCOS->EmitIntValue(0, 1); // length of DW_LNS_const_add_pc
 253   MCOS->EmitIntValue(1, 1); // length of DW_LNS_fixed_advance_pc
 254   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_prologue_end
 255   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_epilogue_begin
 256   MCOS->EmitIntValue(1, 1); // DW_LNS_set_isa
 257
 258   // Put out the directory and file tables.
 259
 260   // First the directory table.
 261   const std::vector<StringRef> &MCDwarfDirs =
 262     context.getMCDwarfDirs();
 263   for (unsigned i = 0; i < MCDwarfDirs.size(); i++) {
 264     MCOS->EmitBytes(MCDwarfDirs[i], 0); // the DirectoryName
 265     MCOS->EmitBytes(StringRef("\0", 1), 0); // the null term. of the string
 266   }
 267   MCOS->EmitIntValue(0, 1); // Terminate the directory list
 268
 269   // Second the file table.
 270   const std::vector<MCDwarfFile *> &MCDwarfFiles =
 271     MCOS->getContext().getMCDwarfFiles();
 272   for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
 273     MCOS->EmitBytes(MCDwarfFiles[i]->getName(), 0); // FileName
 274     MCOS->EmitBytes(StringRef("\0", 1), 0); // the null term. of the string
 275     // the Directory num
 276     MCOS->EmitULEB128IntValue(MCDwarfFiles[i]->getDirIndex());
 277     MCOS->EmitIntValue(0, 1); // last modification timestamp (always 0)
 278     MCOS->EmitIntValue(0, 1); // filesize (always 0)
 279   }
 280   MCOS->EmitIntValue(0, 1); // Terminate the file list
 281
 282   // This is the end of the prologue, so set the value of the symbol at the
 283   // end of the prologue (that was used in a previous expression).
 284   MCOS->EmitLabel(ProEndSym);
 285
 286   // Put out the line tables.
 287   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
 288     MCOS->getContext().getMCLineSections();
 289   const std::vector<const MCSection *> &MCLineSectionOrder =
 290     MCOS->getContext().getMCLineSectionOrder();
 291   for (std::vector<const MCSection*>::const_iterator it =
 292         MCLineSectionOrder.begin(), ie = MCLineSectionOrder.end(); it != ie;
 293        ++it) {
 294     const MCSection *Sec = *it;
 295     const MCLineSection *Line = MCLineSections.lookup(Sec);
 296     EmitDwarfLineTable(MCOS, Sec, Line);
 297
 298     // Now delete the MCLineSections that were created in MCLineEntry::Make()
 299     // and used to emit the line table.
 300     delete Line;
 301   }
 302
 303   if (MCOS->getContext().getAsmInfo().getLinkerRequiresNonEmptyDwarfLines()
 304       && MCLineSectionOrder.begin() == MCLineSectionOrder.end()) {
 305     // The darwin9 linker has a bug (see PR8715). For for 32-bit architectures
 306     // it requires:
 307     // total_length >= prologue_length + 10
 308     // We are 4 bytes short, since we have total_length = 51 and
 309     // prologue_length = 45
 310
 311     // The regular end_sequence should be sufficient.
 312     MCDwarfLineAddr::Emit(MCOS, INT64_MAX, 0);
 313   }
 314
 315   // This is the end of the section, so set the value of the symbol at the end
 316   // of this section (that was used in a previous expression).
 317   MCOS->EmitLabel(LineEndSym);
 318 }
 319
 320 /// Utility function to write the encoding to an object writer.
 321 void MCDwarfLineAddr::Write(MCObjectWriter *OW, int64_t LineDelta,
 322                             uint64_t AddrDelta) {
 323   SmallString<256> Tmp;
 324   raw_svector_ostream OS(Tmp);
 325   MCDwarfLineAddr::Encode(LineDelta, AddrDelta, OS);
 326   OW->WriteBytes(OS.str());
 327 }
 328
 329 /// Utility function to emit the encoding to a streamer.
 330 void MCDwarfLineAddr::Emit(MCStreamer *MCOS, int64_t LineDelta,
 331                            uint64_t AddrDelta) {
 332   SmallString<256> Tmp;
 333   raw_svector_ostream OS(Tmp);
 334   MCDwarfLineAddr::Encode(LineDelta, AddrDelta, OS);
 335   MCOS->EmitBytes(OS.str(), /*AddrSpace=*/0);
 336 }
 337
 338 /// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
 339 void MCDwarfLineAddr::Encode(int64_t LineDelta, uint64_t AddrDelta,
 340                              raw_ostream &OS) {
 341   uint64_t Temp, Opcode;
 342   bool NeedCopy = false;
 343
 344   // Scale the address delta by the minimum instruction length.
 345   AddrDelta = ScaleAddrDelta(AddrDelta);
 346
 347   // A LineDelta of INT64_MAX is a signal that this is actually a
 348   // DW_LNE_end_sequence. We cannot use special opcodes here, since we want the
 349   // end_sequence to emit the matrix entry.
 350   if (LineDelta == INT64_MAX) {
 351     if (AddrDelta == MAX_SPECIAL_ADDR_DELTA)
 352       OS << char(dwarf::DW_LNS_const_add_pc);
 353     else {
 354       OS << char(dwarf::DW_LNS_advance_pc);
 355       SmallString<32> Tmp;
 356       raw_svector_ostream OSE(Tmp);
 357       MCObjectWriter::EncodeULEB128(AddrDelta, OSE);
 358       OS << OSE.str();
 359     }
 360     OS << char(dwarf::DW_LNS_extended_op);
 361     OS << char(1);
 362     OS << char(dwarf::DW_LNE_end_sequence);
 363     return;
 364   }
 365
 366   // Bias the line delta by the base.
 367   Temp = LineDelta - DWARF2_LINE_BASE;
 368
 369   // If the line increment is out of range of a special opcode, we must encode
 370   // it with DW_LNS_advance_line.
 371   if (Temp >= DWARF2_LINE_RANGE) {
 372     OS << char(dwarf::DW_LNS_advance_line);
 373     SmallString<32> Tmp;
 374     raw_svector_ostream OSE(Tmp);
 375     MCObjectWriter::EncodeSLEB128(LineDelta, OSE);
 376     OS << OSE.str();
 377
 378     LineDelta = 0;
 379     Temp = 0 - DWARF2_LINE_BASE;
 380     NeedCopy = true;
 381   }
 382
 383   // Use DW_LNS_copy instead of a "line +0, addr +0" special opcode.
 384   if (LineDelta == 0 && AddrDelta == 0) {
 385     OS << char(dwarf::DW_LNS_copy);
 386     return;
 387   }
 388
 389   // Bias the opcode by the special opcode base.
 390   Temp += DWARF2_LINE_OPCODE_BASE;
 391
 392   // Avoid overflow when addr_delta is large.
 393   if (AddrDelta < 256 + MAX_SPECIAL_ADDR_DELTA) {
 394     // Try using a special opcode.
 395     Opcode = Temp + AddrDelta * DWARF2_LINE_RANGE;
 396     if (Opcode <= 255) {
 397       OS << char(Opcode);
 398       return;
 399     }
 400
 401     // Try using DW_LNS_const_add_pc followed by special op.
 402     Opcode = Temp + (AddrDelta - MAX_SPECIAL_ADDR_DELTA) * DWARF2_LINE_RANGE;
 403     if (Opcode <= 255) {
 404       OS << char(dwarf::DW_LNS_const_add_pc);
 405       OS << char(Opcode);
 406       return;
 407     }
 408   }
 409
 410   // Otherwise use DW_LNS_advance_pc.
 411   OS << char(dwarf::DW_LNS_advance_pc);
 412   SmallString<32> Tmp;
 413   raw_svector_ostream OSE(Tmp);
 414   MCObjectWriter::EncodeULEB128(AddrDelta, OSE);
 415   OS << OSE.str();
 416
 417   if (NeedCopy)
 418     OS << char(dwarf::DW_LNS_copy);
 419   else
 420     OS << char(Temp);
 421 }
 422
 423 void MCDwarfFile::print(raw_ostream &OS) const {
 424   OS << '"' << getName() << '"';
 425 }
 426
 427 void MCDwarfFile::dump() const {
 428   print(dbgs());
 429 }
 430
 431 static int getDataAlignmentFactor(MCStreamer &streamer) {
 432   MCContext &context = streamer.getContext();
 433   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 434   int size = asmInfo.getPointerSize();
 435   if (asmInfo.getStackGrowthDirection() == TargetFrameInfo::StackGrowsUp)
 436     return size;
 437  else
 438    return -size;
 439 }
 440
 441 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
 442 /// frame.
 443 static void EmitFrameMoves(MCStreamer &streamer,
 444                            const std::vector<MachineMove> &Moves,
 445                            MCSymbol *BaseLabel, bool isEH) {
 446   MCContext &context = streamer.getContext();
 447   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 448   int dataAlignmentFactor = getDataAlignmentFactor(streamer);
 449
 450   for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
 451     const MachineMove &Move = Moves[i];
 452     MCSymbol *Label = Move.getLabel();
 453     // Throw out move if the label is invalid.
 454     if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
 455
 456     const MachineLocation &Dst = Move.getDestination();
 457     const MachineLocation &Src = Move.getSource();
 458
 459     // Advance row if new location.
 460     if (BaseLabel && Label) {
 461       MCSymbol *ThisSym = Label;
 462       if (ThisSym != BaseLabel) {
 463         streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
 464         BaseLabel = ThisSym;
 465       }
 466     }
 467
 468     // If advancing cfa.
 469     if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
 470       assert(!Src.isReg() && "Machine move not supported yet.");
 471
 472       if (Src.getReg() == MachineLocation::VirtualFP) {
 473         streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
 474       } else {
 475         streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
 476         streamer.EmitULEB128IntValue(asmInfo.getDwarfRegNum(Src.getReg(),
 477                                                             isEH));
 478       }
 479
 480       streamer.EmitULEB128IntValue(-Src.getOffset(), 1);
 481       continue;
 482     }
 483
 484     if (Src.isReg() && Src.getReg() == MachineLocation::VirtualFP) {
 485       assert(Dst.isReg() && "Machine move not supported yet.");
 486       streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
 487       streamer.EmitULEB128IntValue(asmInfo.getDwarfRegNum(Dst.getReg(), isEH));
 488       continue;
 489     }
 490
 491     unsigned Reg = asmInfo.getDwarfRegNum(Src.getReg(), isEH);
 492     int Offset = Dst.getOffset() / dataAlignmentFactor;
 493
 494     if (Offset < 0) {
 495       streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
 496       streamer.EmitULEB128IntValue(Reg);
 497       streamer.EmitSLEB128IntValue(Offset);
 498     } else if (Reg < 64) {
 499       streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
 500       streamer.EmitULEB128IntValue(Offset, 1);
 501     } else {
 502       streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
 503       streamer.EmitULEB128IntValue(Reg, 1);
 504       streamer.EmitULEB128IntValue(Offset, 1);
 505     }
 506   }
 507 }
 508
 509 static void EmitSymbol(MCStreamer &streamer, const MCSymbol &symbol,
 510                        unsigned symbolEncoding) {
 511   MCContext &context = streamer.getContext();
 512   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 513   unsigned format = symbolEncoding & 0x0f;
 514   unsigned application = symbolEncoding & 0xf0;
 515   unsigned size;
 516   switch (format) {
 517   default:
 518     assert(0 && "Unknown Encoding");
 519     break;
 520   case dwarf::DW_EH_PE_absptr:
 521   case dwarf::DW_EH_PE_signed:
 522     size = asmInfo.getPointerSize();
 523     break;
 524   case dwarf::DW_EH_PE_udata2:
 525   case dwarf::DW_EH_PE_sdata2:
 526     size = 2;
 527     break;
 528   case dwarf::DW_EH_PE_udata4:
 529   case dwarf::DW_EH_PE_sdata4:
 530     size = 4;
 531     break;
 532   case dwarf::DW_EH_PE_udata8:
 533   case dwarf::DW_EH_PE_sdata8:
 534     size = 8;
 535     break;
 536   }
 537   switch (application) {
 538   default:
 539     assert(0 && "Unknown Encoding");
 540     break;
 541   case 0:
 542   case dwarf::DW_EH_PE_indirect:
 543     streamer.EmitSymbolValue(&symbol, size);
 544     break;
 545   case dwarf::DW_EH_PE_pcrel:
 546     streamer.EmitPCRelSymbolValue(&symbol, size);
 547     break;
 548   }
 549 }
 550
 551 static const MCSymbol &EmitCIE(MCStreamer &streamer,
 552                                const MCSymbol *personality,
 553                                unsigned personalityEncoding,
 554                                const MCSymbol *lsda,
 555                                unsigned lsdaEncoding) {
 556   MCContext &context = streamer.getContext();
 557   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 558   const MCSection &section = *asmInfo.getEHFrameSection();
 559   streamer.SwitchSection(&section);
 560   MCSymbol *sectionStart = streamer.getContext().CreateTempSymbol();
 561   MCSymbol *sectionEnd = streamer.getContext().CreateTempSymbol();
 562
 563   // Length
 564   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *sectionStart,
 565                                                *sectionEnd, 4);
 566   streamer.EmitLabel(sectionStart);
 567   streamer.EmitValue(Length, 4);
 568
 569   // CIE ID
 570   streamer.EmitIntValue(0, 4);
 571
 572   // Version
 573   streamer.EmitIntValue(dwarf::DW_CIE_VERSION, 1);
 574
 575   // Augmentation String
 576   SmallString<8> Augmentation;
 577   Augmentation += "z";
 578   if (personality)
 579     Augmentation += "P";
 580   if (lsda)
 581     Augmentation += "L";
 582   Augmentation += "R";
 583   streamer.EmitBytes(Augmentation.str(), 0);
 584   streamer.EmitIntValue(0, 1);
 585
 586   // Code Alignment Factor
 587   streamer.EmitULEB128IntValue(1);
 588
 589   // Data Alignment Factor
 590   streamer.EmitSLEB128IntValue(getDataAlignmentFactor(streamer));
 591
 592   // Return Address Register
 593   streamer.EmitULEB128IntValue(asmInfo.getDwarfRARegNum(true));
 594
 595   // Augmentation Data Length (optional)
 596   MCSymbol *augmentationStart = streamer.getContext().CreateTempSymbol();
 597   MCSymbol *augmentationEnd = streamer.getContext().CreateTempSymbol();
 598   const MCExpr *augmentationLength = MakeStartMinusEndExpr(streamer,
 599                                                            *augmentationStart,
 600                                                            *augmentationEnd, 0);
 601   streamer.EmitULEB128Value(augmentationLength);
 602
 603   // Augmentation Data (optional)
 604   streamer.EmitLabel(augmentationStart);
 605   if (personality) {
 606     // Personality Encoding
 607     streamer.EmitIntValue(personalityEncoding, 1);
 608     // Personality
 609     EmitSymbol(streamer, *personality, personalityEncoding);
 610   }
 611   if (lsda) {
 612     // LSDA Encoding
 613     streamer.EmitIntValue(lsdaEncoding, 1);
 614   }
 615   // Encoding of the FDE pointers
 616   streamer.EmitIntValue(dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4, 1);
 617   streamer.EmitLabel(augmentationEnd);
 618
 619   // Initial Instructions
 620
 621   const std::vector<MachineMove> Moves = asmInfo.getInitialFrameState();
 622
 623   EmitFrameMoves(streamer, Moves, NULL, true);
 624
 625   // Padding
 626   streamer.EmitValueToAlignment(4);
 627
 628   streamer.EmitLabel(sectionEnd);
 629   return *sectionStart;
 630 }
 631
 632 static MCSymbol *EmitFDE(MCStreamer &streamer,
 633                          const MCSymbol &cieStart,
 634                          const MCDwarfFrameInfo &frame) {
 635   MCContext &context = streamer.getContext();
 636   MCSymbol *fdeStart = context.CreateTempSymbol();
 637   MCSymbol *fdeEnd = context.CreateTempSymbol();
 638
 639   // Length
 640   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *fdeStart, *fdeEnd, 0);
 641   streamer.EmitValue(Length, 4);
 642
 643   streamer.EmitLabel(fdeStart);
 644   // CIE Pointer
 645   const MCExpr *offset = MakeStartMinusEndExpr(streamer, cieStart, *fdeStart,
 646                                                0);
 647   streamer.EmitValue(offset, 4);
 648
 649   // PC Begin
 650   streamer.EmitPCRelSymbolValue(frame.Begin, 4);
 651
 652   // PC Range
 653   const MCExpr *Range = MakeStartMinusEndExpr(streamer, *frame.Begin,
 654                                               *frame.End, 0);
 655   streamer.EmitValue(Range, 4);
 656
 657   // Augmentation Data Length
 658   MCSymbol *augmentationStart = streamer.getContext().CreateTempSymbol();
 659   MCSymbol *augmentationEnd = streamer.getContext().CreateTempSymbol();
 660   const MCExpr *augmentationLength = MakeStartMinusEndExpr(streamer,
 661                                                            *augmentationStart,
 662                                                            *augmentationEnd, 0);
 663   streamer.EmitULEB128Value(augmentationLength);
 664
 665   // Augmentation Data
 666   streamer.EmitLabel(augmentationStart);
 667   if (frame.Lsda)
 668     EmitSymbol(streamer, *frame.Lsda, frame.LsdaEncoding);
 669   streamer.EmitLabel(augmentationEnd);
 670   // Call Frame Instructions
 671
 672   EmitFrameMoves(streamer, frame.Moves, frame.Begin, true);
 673
 674   // Padding
 675   streamer.EmitValueToAlignment(4);
 676
 677   return fdeEnd;
 678 }
 679
 680 struct CIEKey {
 681   static const CIEKey EmptyKey;
 682   static const CIEKey TombstoneKey;
 683
 684   CIEKey(const MCSymbol* Personality_, unsigned PersonalityEncoding_,
 685          unsigned LsdaEncoding_) : Personality(Personality_),
 686                                    PersonalityEncoding(PersonalityEncoding_),
 687                                    LsdaEncoding(LsdaEncoding_) {
 688   }
 689   const MCSymbol* Personality;
 690   unsigned PersonalityEncoding;
 691   unsigned LsdaEncoding;
 692 };
 693
 694 const CIEKey CIEKey::EmptyKey(0, 0, -1);
 695 const CIEKey CIEKey::TombstoneKey(0, -1, 0);
 696
 697 namespace llvm {
 698   template <>
 699   struct DenseMapInfo<CIEKey> {
 700     static CIEKey getEmptyKey() {
 701       return CIEKey::EmptyKey;
 702     }
 703     static CIEKey getTombstoneKey() {
 704       return CIEKey::TombstoneKey;
 705     }
 706     static unsigned getHashValue(const CIEKey &Key) {
 707       FoldingSetNodeID ID;
 708       ID.AddPointer(Key.Personality);
 709       ID.AddInteger(Key.PersonalityEncoding);
 710       ID.AddInteger(Key.LsdaEncoding);
 711       return ID.ComputeHash();
 712     }
 713     static bool isEqual(const CIEKey &LHS,
 714                         const CIEKey &RHS) {
 715       return LHS.Personality == RHS.Personality &&
 716         LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
 717         LHS.LsdaEncoding == RHS.LsdaEncoding;
 718     }
 719   };
 720 }
 721
 722 void MCDwarfFrameEmitter::Emit(MCStreamer &streamer) {
 723   const MCContext &context = streamer.getContext();
 724   const TargetAsmInfo &asmInfo = context.getTargetAsmInfo();
 725   MCSymbol *fdeEnd = NULL;
 726   DenseMap<CIEKey, const MCSymbol*> CIEStarts;
 727
 728   for (unsigned i = 0, n = streamer.getNumFrameInfos(); i < n; ++i) {
 729     const MCDwarfFrameInfo &frame = streamer.getFrameInfo(i);
 730     CIEKey key(frame.Personality, frame.PersonalityEncoding,
 731                frame.LsdaEncoding);
 732     const MCSymbol *&cieStart = CIEStarts[key];
 733     if (!cieStart)
 734       cieStart = &EmitCIE(streamer, frame.Personality,
 735                           frame.PersonalityEncoding, frame.Lsda,
 736                           frame.LsdaEncoding);
 737     fdeEnd = EmitFDE(streamer, *cieStart, frame);
 738     if (i != n - 1)
 739       streamer.EmitLabel(fdeEnd);
 740   }
 741
 742   streamer.EmitValueToAlignment(asmInfo.getPointerSize());
 743   if (fdeEnd)
 744     streamer.EmitLabel(fdeEnd);
 745 }
 746
 747 void MCDwarfFrameEmitter::EmitAdvanceLoc(MCStreamer &Streamer,
 748                                          uint64_t AddrDelta) {
 749   SmallString<256> Tmp;
 750   raw_svector_ostream OS(Tmp);
 751   MCDwarfFrameEmitter::EncodeAdvanceLoc(AddrDelta, OS);
 752   Streamer.EmitBytes(OS.str(), /*AddrSpace=*/0);
 753 }
 754
 755 void MCDwarfFrameEmitter::EncodeAdvanceLoc(uint64_t AddrDelta,
 756                                            raw_ostream &OS) {
 757   // FIXME: Assumes the code alignment factor is 1.
 758   if (isUIntN(6, AddrDelta)) {
 759     uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
 760     OS << Opcode;
 761   } else if (isUInt<8>(AddrDelta)) {
 762     OS << uint8_t(dwarf::DW_CFA_advance_loc1);
 763     OS << uint8_t(AddrDelta);
 764   } else if (isUInt<16>(AddrDelta)) {
 765     OS << uint8_t(dwarf::DW_CFA_advance_loc2);
 766     OS << uint16_t(AddrDelta);
 767   } else {
 768     assert(isUInt<32>(AddrDelta));
 769     OS << uint8_t(dwarf::DW_CFA_advance_loc4);
 770     OS << uint32_t(AddrDelta);
 771   }
 772 }