1 //===- lib/MC/MCDwarf.cpp - MCDwarf implementation ------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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"
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)
36 // The maximum address skip amount that can be encoded with a special op.
37 #define MAX_SPECIAL_ADDR_DELTA SPECIAL_ADDR(255)
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
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
48 // Range of line offsets in a special line info. opcode.
49 #define DWARF2_LINE_RANGE 14
51 static inline uint64_t ScaleAddrDelta(MCContext &Context, uint64_t AddrDelta) {
52 unsigned MinInsnLength = Context.getAsmInfo()->getMinInstAlignment();
53 if (MinInsnLength == 1)
55 if (AddrDelta % MinInsnLength != 0) {
56 // TODO: report this error, but really only once.
59 return AddrDelta / MinInsnLength;
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.
67 void MCLineEntry::Make(MCObjectStreamer *MCOS, const MCSection *Section) {
68 if (!MCOS->getContext().getDwarfLocSeen())
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);
76 // Get the current .loc info saved in the context.
77 const MCDwarfLoc &DwarfLoc = MCOS->getContext().getCurrentDwarfLoc();
79 // Create a (local) line entry with the symbol and the current .loc info.
80 MCLineEntry LineEntry(LineSym, DwarfLoc);
82 // clear DwarfLocSeen saying the current .loc info is now used.
83 MCOS->getContext().ClearDwarfLocSeen();
85 // Add the line entry to this section's entries.
87 .getMCDwarfLineTable(MCOS->getContext().getDwarfCompileUnitID())
89 .addLineEntry(LineEntry, Section);
93 // This helper routine returns an expression of End - Start + IntVal .
95 static inline const MCExpr *MakeStartMinusEndExpr(const MCStreamer &MCOS,
96 const MCSymbol &Start,
99 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
101 MCSymbolRefExpr::Create(&End, Variant, MCOS.getContext());
103 MCSymbolRefExpr::Create(&Start, Variant, MCOS.getContext());
105 MCBinaryExpr::Create(MCBinaryExpr::Sub, Res, RHS, MCOS.getContext());
107 MCConstantExpr::Create(IntVal, MCOS.getContext());
109 MCBinaryExpr::Create(MCBinaryExpr::Sub, Res1, Res2, MCOS.getContext());
114 // This emits the Dwarf line table for the specified section from the entries
115 // in the LineSection.
118 EmitDwarfLineTable(MCObjectStreamer *MCOS, const MCSection *Section,
119 const MCLineSection::MCLineEntryCollection &LineEntries) {
120 unsigned FileNum = 1;
121 unsigned LastLine = 1;
123 unsigned Flags = DWARF2_LINE_DEFAULT_IS_STMT ? DWARF2_FLAG_IS_STMT : 0;
125 unsigned Discriminator = 0;
126 MCSymbol *LastLabel = nullptr;
128 // Loop through each MCLineEntry and encode the dwarf line number table.
129 for (auto it = LineEntries.begin(),
130 ie = LineEntries.end();
133 if (FileNum != it->getFileNum()) {
134 FileNum = it->getFileNum();
135 MCOS->EmitIntValue(dwarf::DW_LNS_set_file, 1);
136 MCOS->EmitULEB128IntValue(FileNum);
138 if (Column != it->getColumn()) {
139 Column = it->getColumn();
140 MCOS->EmitIntValue(dwarf::DW_LNS_set_column, 1);
141 MCOS->EmitULEB128IntValue(Column);
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);
151 if (Isa != it->getIsa()) {
153 MCOS->EmitIntValue(dwarf::DW_LNS_set_isa, 1);
154 MCOS->EmitULEB128IntValue(Isa);
156 if ((it->getFlags() ^ Flags) & DWARF2_FLAG_IS_STMT) {
157 Flags = it->getFlags();
158 MCOS->EmitIntValue(dwarf::DW_LNS_negate_stmt, 1);
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);
167 int64_t LineDelta = static_cast<int64_t>(it->getLine()) - LastLine;
168 MCSymbol *Label = it->getLabel();
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());
177 LastLine = it->getLine();
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.
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
190 MCOS->SwitchSection(Section);
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);
198 // Switch back the dwarf line section.
199 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfLineSection());
201 const MCAsmInfo *asmInfo = MCOS->getContext().getAsmInfo();
202 MCOS->EmitDwarfAdvanceLineAddr(INT64_MAX, LastLabel, SectionEnd,
203 asmInfo->getPointerSize());
207 // This emits the Dwarf file and the line tables.
209 void MCDwarfLineTable::Emit(MCObjectStreamer *MCOS) {
210 MCContext &context = MCOS->getContext();
212 auto &LineTables = context.getMCDwarfLineTables();
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())
219 // Switch to the section where the table will be emitted into.
220 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfLineSection());
222 // Handle the rest of the Compile Units.
223 for (const auto &CUIDTablePair : LineTables)
224 CUIDTablePair.second.EmitCU(MCOS);
227 void MCDwarfDwoLineTable::Emit(MCStreamer &MCOS) const {
228 MCOS.EmitLabel(Header.Emit(&MCOS, None).second);
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
246 assert(array_lengthof(StandardOpcodeLengths) == (DWARF2_LINE_OPCODE_BASE - 1));
247 return Emit(MCOS, StandardOpcodeLengths);
250 static const MCExpr *forceExpAbs(MCStreamer &OS, const MCExpr* Expr) {
251 MCContext &Context = OS.getContext();
252 assert(!isa<MCSymbolRefExpr>(Expr));
253 if (Context.getAsmInfo()->hasAggressiveSymbolFolding())
256 MCSymbol *ABS = Context.CreateTempSymbol();
257 OS.EmitAssignment(ABS, Expr);
258 return MCSymbolRefExpr::Create(ABS, Context);
261 static void emitAbsValue(MCStreamer &OS, const MCExpr *Value, unsigned Size) {
262 const MCExpr *ABS = forceExpAbs(OS, Value);
263 OS.EmitValue(ABS, Size);
266 std::pair<MCSymbol *, MCSymbol *>
267 MCDwarfLineTableHeader::Emit(MCStreamer *MCOS,
268 ArrayRef<char> StandardOpcodeLengths) const {
270 MCContext &context = MCOS->getContext();
272 // Create a symbol at the beginning of the line table.
273 MCSymbol *LineStartSym = Label;
275 LineStartSym = context.CreateTempSymbol();
276 // Set the value of the symbol, as we are at the start of the line table.
277 MCOS->EmitLabel(LineStartSym);
279 // Create a symbol for the end of the section (to be set when we get there).
280 MCSymbol *LineEndSym = context.CreateTempSymbol();
282 // The first 4 bytes is the total length of the information for this
283 // compilation unit (not including these 4 bytes for the length).
285 MakeStartMinusEndExpr(*MCOS, *LineStartSym, *LineEndSym, 4), 4);
287 // Next 2 bytes is the Version, which is Dwarf 2.
288 MCOS->EmitIntValue(2, 2);
290 // Create a symbol for the end of the prologue (to be set when we get there).
291 MCSymbol *ProEndSym = context.CreateTempSymbol(); // Lprologue_end
293 // Length of the prologue, is the next 4 bytes. Which is the start of the
294 // section to the end of the prologue. Not including the 4 bytes for the
295 // total length, the 2 bytes for the version, and these 4 bytes for the
296 // length of the prologue.
299 MakeStartMinusEndExpr(*MCOS, *LineStartSym, *ProEndSym, (4 + 2 + 4)), 4);
301 // Parameters of the state machine, are next.
302 MCOS->EmitIntValue(context.getAsmInfo()->getMinInstAlignment(), 1);
303 MCOS->EmitIntValue(DWARF2_LINE_DEFAULT_IS_STMT, 1);
304 MCOS->EmitIntValue(DWARF2_LINE_BASE, 1);
305 MCOS->EmitIntValue(DWARF2_LINE_RANGE, 1);
306 MCOS->EmitIntValue(StandardOpcodeLengths.size() + 1, 1);
308 // Standard opcode lengths
309 for (char Length : StandardOpcodeLengths)
310 MCOS->EmitIntValue(Length, 1);
312 // Put out the directory and file tables.
314 // First the directory table.
315 for (unsigned i = 0; i < MCDwarfDirs.size(); i++) {
316 MCOS->EmitBytes(MCDwarfDirs[i]); // the DirectoryName
317 MCOS->EmitBytes(StringRef("\0", 1)); // the null term. of the string
319 MCOS->EmitIntValue(0, 1); // Terminate the directory list
321 // Second the file table.
322 for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
323 assert(!MCDwarfFiles[i].Name.empty());
324 MCOS->EmitBytes(MCDwarfFiles[i].Name); // FileName
325 MCOS->EmitBytes(StringRef("\0", 1)); // the null term. of the string
327 MCOS->EmitULEB128IntValue(MCDwarfFiles[i].DirIndex);
328 MCOS->EmitIntValue(0, 1); // last modification timestamp (always 0)
329 MCOS->EmitIntValue(0, 1); // filesize (always 0)
331 MCOS->EmitIntValue(0, 1); // Terminate the file list
333 // This is the end of the prologue, so set the value of the symbol at the
334 // end of the prologue (that was used in a previous expression).
335 MCOS->EmitLabel(ProEndSym);
337 return std::make_pair(LineStartSym, LineEndSym);
340 void MCDwarfLineTable::EmitCU(MCObjectStreamer *MCOS) const {
341 MCSymbol *LineEndSym = Header.Emit(MCOS).second;
343 // Put out the line tables.
344 for (const auto &LineSec : MCLineSections.getMCLineEntries())
345 EmitDwarfLineTable(MCOS, LineSec.first, LineSec.second);
347 if (MCOS->getContext().getAsmInfo()->getLinkerRequiresNonEmptyDwarfLines() &&
348 MCLineSections.getMCLineEntries().empty()) {
349 // The darwin9 linker has a bug (see PR8715). For for 32-bit architectures
351 // total_length >= prologue_length + 10
352 // We are 4 bytes short, since we have total_length = 51 and
353 // prologue_length = 45
355 // The regular end_sequence should be sufficient.
356 MCDwarfLineAddr::Emit(MCOS, INT64_MAX, 0);
359 // This is the end of the section, so set the value of the symbol at the end
360 // of this section (that was used in a previous expression).
361 MCOS->EmitLabel(LineEndSym);
364 unsigned MCDwarfLineTable::getFile(StringRef &Directory, StringRef &FileName,
365 unsigned FileNumber) {
366 return Header.getFile(Directory, FileName, FileNumber);
369 unsigned MCDwarfLineTableHeader::getFile(StringRef &Directory,
371 unsigned FileNumber) {
372 if (Directory == CompilationDir)
374 if (FileName.empty()) {
375 FileName = "<stdin>";
378 assert(!FileName.empty());
379 if (FileNumber == 0) {
380 FileNumber = SourceIdMap.size() + 1;
381 assert((MCDwarfFiles.empty() || FileNumber == MCDwarfFiles.size()) &&
382 "Don't mix autonumbered and explicit numbered line table usage");
383 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(
384 (Directory + Twine('\0') + FileName).str(), FileNumber);
385 if (Ent.getValue() != FileNumber)
386 return Ent.getValue();
388 // Make space for this FileNumber in the MCDwarfFiles vector if needed.
389 MCDwarfFiles.resize(FileNumber + 1);
391 // Get the new MCDwarfFile slot for this FileNumber.
392 MCDwarfFile &File = MCDwarfFiles[FileNumber];
394 // It is an error to use see the same number more than once.
395 if (!File.Name.empty())
398 if (Directory.empty()) {
399 // Separate the directory part from the basename of the FileName.
400 StringRef tFileName = sys::path::filename(FileName);
401 if (!tFileName.empty()) {
402 Directory = sys::path::parent_path(FileName);
403 if (!Directory.empty())
404 FileName = tFileName;
408 // Find or make an entry in the MCDwarfDirs vector for this Directory.
409 // Capture directory name.
411 if (Directory.empty()) {
412 // For FileNames with no directories a DirIndex of 0 is used.
416 for (unsigned End = MCDwarfDirs.size(); DirIndex < End; DirIndex++) {
417 if (Directory == MCDwarfDirs[DirIndex])
420 if (DirIndex >= MCDwarfDirs.size())
421 MCDwarfDirs.push_back(Directory);
422 // The DirIndex is one based, as DirIndex of 0 is used for FileNames with
423 // no directories. MCDwarfDirs[] is unlike MCDwarfFiles[] in that the
424 // directory names are stored at MCDwarfDirs[DirIndex-1] where FileNames
425 // are stored at MCDwarfFiles[FileNumber].Name .
429 File.Name = FileName;
430 File.DirIndex = DirIndex;
432 // return the allocated FileNumber.
436 /// Utility function to emit the encoding to a streamer.
437 void MCDwarfLineAddr::Emit(MCStreamer *MCOS, int64_t LineDelta,
438 uint64_t AddrDelta) {
439 MCContext &Context = MCOS->getContext();
440 SmallString<256> Tmp;
441 raw_svector_ostream OS(Tmp);
442 MCDwarfLineAddr::Encode(Context, LineDelta, AddrDelta, OS);
443 MCOS->EmitBytes(OS.str());
446 /// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
447 void MCDwarfLineAddr::Encode(MCContext &Context, int64_t LineDelta,
448 uint64_t AddrDelta, raw_ostream &OS) {
449 uint64_t Temp, Opcode;
450 bool NeedCopy = false;
452 // Scale the address delta by the minimum instruction length.
453 AddrDelta = ScaleAddrDelta(Context, AddrDelta);
455 // A LineDelta of INT64_MAX is a signal that this is actually a
456 // DW_LNE_end_sequence. We cannot use special opcodes here, since we want the
457 // end_sequence to emit the matrix entry.
458 if (LineDelta == INT64_MAX) {
459 if (AddrDelta == MAX_SPECIAL_ADDR_DELTA)
460 OS << char(dwarf::DW_LNS_const_add_pc);
462 OS << char(dwarf::DW_LNS_advance_pc);
463 encodeULEB128(AddrDelta, OS);
465 OS << char(dwarf::DW_LNS_extended_op);
467 OS << char(dwarf::DW_LNE_end_sequence);
471 // Bias the line delta by the base.
472 Temp = LineDelta - DWARF2_LINE_BASE;
474 // If the line increment is out of range of a special opcode, we must encode
475 // it with DW_LNS_advance_line.
476 if (Temp >= DWARF2_LINE_RANGE) {
477 OS << char(dwarf::DW_LNS_advance_line);
478 encodeSLEB128(LineDelta, OS);
481 Temp = 0 - DWARF2_LINE_BASE;
485 // Use DW_LNS_copy instead of a "line +0, addr +0" special opcode.
486 if (LineDelta == 0 && AddrDelta == 0) {
487 OS << char(dwarf::DW_LNS_copy);
491 // Bias the opcode by the special opcode base.
492 Temp += DWARF2_LINE_OPCODE_BASE;
494 // Avoid overflow when addr_delta is large.
495 if (AddrDelta < 256 + MAX_SPECIAL_ADDR_DELTA) {
496 // Try using a special opcode.
497 Opcode = Temp + AddrDelta * DWARF2_LINE_RANGE;
503 // Try using DW_LNS_const_add_pc followed by special op.
504 Opcode = Temp + (AddrDelta - MAX_SPECIAL_ADDR_DELTA) * DWARF2_LINE_RANGE;
506 OS << char(dwarf::DW_LNS_const_add_pc);
512 // Otherwise use DW_LNS_advance_pc.
513 OS << char(dwarf::DW_LNS_advance_pc);
514 encodeULEB128(AddrDelta, OS);
517 OS << char(dwarf::DW_LNS_copy);
522 // Utility function to write a tuple for .debug_abbrev.
523 static void EmitAbbrev(MCStreamer *MCOS, uint64_t Name, uint64_t Form) {
524 MCOS->EmitULEB128IntValue(Name);
525 MCOS->EmitULEB128IntValue(Form);
528 // When generating dwarf for assembly source files this emits
529 // the data for .debug_abbrev section which contains three DIEs.
530 static void EmitGenDwarfAbbrev(MCStreamer *MCOS) {
531 MCContext &context = MCOS->getContext();
532 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
534 // DW_TAG_compile_unit DIE abbrev (1).
535 MCOS->EmitULEB128IntValue(1);
536 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_compile_unit);
537 MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
538 EmitAbbrev(MCOS, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4);
539 if (MCOS->getContext().getGenDwarfSectionSyms().size() > 1) {
540 EmitAbbrev(MCOS, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4);
542 EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
543 EmitAbbrev(MCOS, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr);
545 EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
546 if (!context.getCompilationDir().empty())
547 EmitAbbrev(MCOS, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string);
548 StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
549 if (!DwarfDebugFlags.empty())
550 EmitAbbrev(MCOS, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string);
551 EmitAbbrev(MCOS, dwarf::DW_AT_producer, dwarf::DW_FORM_string);
552 EmitAbbrev(MCOS, dwarf::DW_AT_language, dwarf::DW_FORM_data2);
553 EmitAbbrev(MCOS, 0, 0);
555 // DW_TAG_label DIE abbrev (2).
556 MCOS->EmitULEB128IntValue(2);
557 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_label);
558 MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
559 EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
560 EmitAbbrev(MCOS, dwarf::DW_AT_decl_file, dwarf::DW_FORM_data4);
561 EmitAbbrev(MCOS, dwarf::DW_AT_decl_line, dwarf::DW_FORM_data4);
562 EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
563 EmitAbbrev(MCOS, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag);
564 EmitAbbrev(MCOS, 0, 0);
566 // DW_TAG_unspecified_parameters DIE abbrev (3).
567 MCOS->EmitULEB128IntValue(3);
568 MCOS->EmitULEB128IntValue(dwarf::DW_TAG_unspecified_parameters);
569 MCOS->EmitIntValue(dwarf::DW_CHILDREN_no, 1);
570 EmitAbbrev(MCOS, 0, 0);
572 // Terminate the abbreviations for this compilation unit.
573 MCOS->EmitIntValue(0, 1);
576 // When generating dwarf for assembly source files this emits the data for
577 // .debug_aranges section. This section contains a header and a table of pairs
578 // of PointerSize'ed values for the address and size of section(s) with line
580 static void EmitGenDwarfAranges(MCStreamer *MCOS,
581 const MCSymbol *InfoSectionSymbol) {
582 MCContext &context = MCOS->getContext();
584 auto &Sections = context.getGenDwarfSectionSyms();
586 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
588 // This will be the length of the .debug_aranges section, first account for
589 // the size of each item in the header (see below where we emit these items).
590 int Length = 4 + 2 + 4 + 1 + 1;
592 // Figure the padding after the header before the table of address and size
593 // pairs who's values are PointerSize'ed.
594 const MCAsmInfo *asmInfo = context.getAsmInfo();
595 int AddrSize = asmInfo->getPointerSize();
596 int Pad = 2 * AddrSize - (Length & (2 * AddrSize - 1));
597 if (Pad == 2 * AddrSize)
601 // Add the size of the pair of PointerSize'ed values for the address and size
602 // of each section we have in the table.
603 Length += 2 * AddrSize * Sections.size();
604 // And the pair of terminating zeros.
605 Length += 2 * AddrSize;
608 // Emit the header for this section.
609 // The 4 byte length not including the 4 byte value for the length.
610 MCOS->EmitIntValue(Length - 4, 4);
611 // The 2 byte version, which is 2.
612 MCOS->EmitIntValue(2, 2);
613 // The 4 byte offset to the compile unit in the .debug_info from the start
614 // of the .debug_info.
615 if (InfoSectionSymbol)
616 MCOS->EmitSymbolValue(InfoSectionSymbol, 4);
618 MCOS->EmitIntValue(0, 4);
619 // The 1 byte size of an address.
620 MCOS->EmitIntValue(AddrSize, 1);
621 // The 1 byte size of a segment descriptor, we use a value of zero.
622 MCOS->EmitIntValue(0, 1);
623 // Align the header with the padding if needed, before we put out the table.
624 for(int i = 0; i < Pad; i++)
625 MCOS->EmitIntValue(0, 1);
627 // Now emit the table of pairs of PointerSize'ed values for the section
628 // addresses and sizes.
629 for (const auto &sec : Sections) {
630 MCSymbol *StartSymbol = sec.second.first;
631 MCSymbol *EndSymbol = sec.second.second;
632 assert(StartSymbol && "StartSymbol must not be NULL");
633 assert(EndSymbol && "EndSymbol must not be NULL");
635 const MCExpr *Addr = MCSymbolRefExpr::Create(
636 StartSymbol, MCSymbolRefExpr::VK_None, context);
637 const MCExpr *Size = MakeStartMinusEndExpr(*MCOS,
638 *StartSymbol, *EndSymbol, 0);
639 MCOS->EmitValue(Addr, AddrSize);
640 emitAbsValue(*MCOS, Size, AddrSize);
643 // And finally the pair of terminating zeros.
644 MCOS->EmitIntValue(0, AddrSize);
645 MCOS->EmitIntValue(0, AddrSize);
648 // When generating dwarf for assembly source files this emits the data for
649 // .debug_info section which contains three parts. The header, the compile_unit
650 // DIE and a list of label DIEs.
651 static void EmitGenDwarfInfo(MCStreamer *MCOS,
652 const MCSymbol *AbbrevSectionSymbol,
653 const MCSymbol *LineSectionSymbol,
654 const MCSymbol *RangesSectionSymbol) {
655 MCContext &context = MCOS->getContext();
657 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
659 // Create a symbol at the start and end of this section used in here for the
660 // expression to calculate the length in the header.
661 MCSymbol *InfoStart = context.CreateTempSymbol();
662 MCOS->EmitLabel(InfoStart);
663 MCSymbol *InfoEnd = context.CreateTempSymbol();
665 // First part: the header.
667 // The 4 byte total length of the information for this compilation unit, not
668 // including these 4 bytes.
669 const MCExpr *Length = MakeStartMinusEndExpr(*MCOS, *InfoStart, *InfoEnd, 4);
670 emitAbsValue(*MCOS, Length, 4);
672 // The 2 byte DWARF version.
673 MCOS->EmitIntValue(context.getDwarfVersion(), 2);
675 const MCAsmInfo &AsmInfo = *context.getAsmInfo();
676 // The 4 byte offset to the debug abbrevs from the start of the .debug_abbrev,
677 // it is at the start of that section so this is zero.
678 if (AbbrevSectionSymbol == nullptr)
679 MCOS->EmitIntValue(0, 4);
681 MCOS->EmitSymbolValue(AbbrevSectionSymbol, 4,
682 AsmInfo.needsDwarfSectionOffsetDirective());
684 const MCAsmInfo *asmInfo = context.getAsmInfo();
685 int AddrSize = asmInfo->getPointerSize();
686 // The 1 byte size of an address.
687 MCOS->EmitIntValue(AddrSize, 1);
689 // Second part: the compile_unit DIE.
691 // The DW_TAG_compile_unit DIE abbrev (1).
692 MCOS->EmitULEB128IntValue(1);
694 // DW_AT_stmt_list, a 4 byte offset from the start of the .debug_line section,
695 // which is at the start of that section so this is zero.
696 if (LineSectionSymbol) {
697 MCOS->EmitSymbolValue(LineSectionSymbol, 4);
699 MCOS->EmitIntValue(0, 4);
702 if (RangesSectionSymbol) {
703 // There are multiple sections containing code, so we must use the
704 // .debug_ranges sections.
706 // AT_ranges, the 4 byte offset from the start of the .debug_ranges section
707 // to the address range list for this compilation unit.
708 MCOS->EmitSymbolValue(RangesSectionSymbol, 4);
710 // If we only have one non-empty code section, we can use the simpler
711 // AT_low_pc and AT_high_pc attributes.
713 // Find the first (and only) non-empty text section
714 auto &Sections = context.getGenDwarfSectionSyms();
715 const auto TextSection = Sections.begin();
716 assert(TextSection != Sections.end() && "No text section found");
718 MCSymbol *StartSymbol = TextSection->second.first;
719 MCSymbol *EndSymbol = TextSection->second.second;
720 assert(StartSymbol && "StartSymbol must not be NULL");
721 assert(EndSymbol && "EndSymbol must not be NULL");
723 // AT_low_pc, the first address of the default .text section.
724 const MCExpr *Start = MCSymbolRefExpr::Create(
725 StartSymbol, MCSymbolRefExpr::VK_None, context);
726 MCOS->EmitValue(Start, AddrSize);
728 // AT_high_pc, the last address of the default .text section.
729 const MCExpr *End = MCSymbolRefExpr::Create(
730 EndSymbol, MCSymbolRefExpr::VK_None, context);
731 MCOS->EmitValue(End, AddrSize);
734 // AT_name, the name of the source file. Reconstruct from the first directory
735 // and file table entries.
736 const SmallVectorImpl<std::string> &MCDwarfDirs = context.getMCDwarfDirs();
737 if (MCDwarfDirs.size() > 0) {
738 MCOS->EmitBytes(MCDwarfDirs[0]);
739 MCOS->EmitBytes(sys::path::get_separator());
741 const SmallVectorImpl<MCDwarfFile> &MCDwarfFiles =
742 MCOS->getContext().getMCDwarfFiles();
743 MCOS->EmitBytes(MCDwarfFiles[1].Name);
744 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
746 // AT_comp_dir, the working directory the assembly was done in.
747 if (!context.getCompilationDir().empty()) {
748 MCOS->EmitBytes(context.getCompilationDir());
749 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
752 // AT_APPLE_flags, the command line arguments of the assembler tool.
753 StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
754 if (!DwarfDebugFlags.empty()){
755 MCOS->EmitBytes(DwarfDebugFlags);
756 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
759 // AT_producer, the version of the assembler tool.
760 StringRef DwarfDebugProducer = context.getDwarfDebugProducer();
761 if (!DwarfDebugProducer.empty())
762 MCOS->EmitBytes(DwarfDebugProducer);
764 MCOS->EmitBytes(StringRef("llvm-mc (based on LLVM " PACKAGE_VERSION ")"));
765 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
767 // AT_language, a 4 byte value. We use DW_LANG_Mips_Assembler as the dwarf2
768 // draft has no standard code for assembler.
769 MCOS->EmitIntValue(dwarf::DW_LANG_Mips_Assembler, 2);
771 // Third part: the list of label DIEs.
773 // Loop on saved info for dwarf labels and create the DIEs for them.
774 const std::vector<MCGenDwarfLabelEntry> &Entries =
775 MCOS->getContext().getMCGenDwarfLabelEntries();
776 for (const auto &Entry : Entries) {
777 // The DW_TAG_label DIE abbrev (2).
778 MCOS->EmitULEB128IntValue(2);
780 // AT_name, of the label without any leading underbar.
781 MCOS->EmitBytes(Entry.getName());
782 MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
784 // AT_decl_file, index into the file table.
785 MCOS->EmitIntValue(Entry.getFileNumber(), 4);
787 // AT_decl_line, source line number.
788 MCOS->EmitIntValue(Entry.getLineNumber(), 4);
790 // AT_low_pc, start address of the label.
791 const MCExpr *AT_low_pc = MCSymbolRefExpr::Create(Entry.getLabel(),
792 MCSymbolRefExpr::VK_None, context);
793 MCOS->EmitValue(AT_low_pc, AddrSize);
795 // DW_AT_prototyped, a one byte flag value of 0 saying we have no prototype.
796 MCOS->EmitIntValue(0, 1);
798 // The DW_TAG_unspecified_parameters DIE abbrev (3).
799 MCOS->EmitULEB128IntValue(3);
801 // Add the NULL DIE terminating the DW_TAG_unspecified_parameters DIE's.
802 MCOS->EmitIntValue(0, 1);
805 // Add the NULL DIE terminating the Compile Unit DIE's.
806 MCOS->EmitIntValue(0, 1);
808 // Now set the value of the symbol at the end of the info section.
809 MCOS->EmitLabel(InfoEnd);
812 // When generating dwarf for assembly source files this emits the data for
813 // .debug_ranges section. We only emit one range list, which spans all of the
814 // executable sections of this file.
815 static void EmitGenDwarfRanges(MCStreamer *MCOS) {
816 MCContext &context = MCOS->getContext();
817 auto &Sections = context.getGenDwarfSectionSyms();
819 const MCAsmInfo *AsmInfo = context.getAsmInfo();
820 int AddrSize = AsmInfo->getPointerSize();
822 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfRangesSection());
824 for (const auto sec : Sections) {
826 MCSymbol *StartSymbol = sec.second.first;
827 MCSymbol *EndSymbol = sec.second.second;
828 assert(StartSymbol && "StartSymbol must not be NULL");
829 assert(EndSymbol && "EndSymbol must not be NULL");
831 // Emit a base address selection entry for the start of this section
832 const MCExpr *SectionStartAddr = MCSymbolRefExpr::Create(
833 StartSymbol, MCSymbolRefExpr::VK_None, context);
834 MCOS->EmitFill(AddrSize, 0xFF);
835 MCOS->EmitValue(SectionStartAddr, AddrSize);
837 // Emit a range list entry spanning this section
838 const MCExpr *SectionSize = MakeStartMinusEndExpr(*MCOS,
839 *StartSymbol, *EndSymbol, 0);
840 MCOS->EmitIntValue(0, AddrSize);
841 emitAbsValue(*MCOS, SectionSize, AddrSize);
844 // Emit end of list entry
845 MCOS->EmitIntValue(0, AddrSize);
846 MCOS->EmitIntValue(0, AddrSize);
850 // When generating dwarf for assembly source files this emits the Dwarf
853 void MCGenDwarfInfo::Emit(MCStreamer *MCOS) {
854 MCContext &context = MCOS->getContext();
856 // Create the dwarf sections in this order (.debug_line already created).
857 const MCAsmInfo *AsmInfo = context.getAsmInfo();
858 bool CreateDwarfSectionSymbols =
859 AsmInfo->doesDwarfUseRelocationsAcrossSections();
860 MCSymbol *LineSectionSymbol = nullptr;
861 if (CreateDwarfSectionSymbols)
862 LineSectionSymbol = MCOS->getDwarfLineTableSymbol(0);
863 MCSymbol *AbbrevSectionSymbol = nullptr;
864 MCSymbol *InfoSectionSymbol = nullptr;
865 MCSymbol *RangesSectionSymbol = NULL;
867 // Create end symbols for each section, and remove empty sections
868 MCOS->getContext().finalizeDwarfSections(*MCOS);
870 // If there are no sections to generate debug info for, we don't need
872 if (MCOS->getContext().getGenDwarfSectionSyms().empty())
875 // We only need to use the .debug_ranges section if we have multiple
877 const bool UseRangesSection =
878 MCOS->getContext().getGenDwarfSectionSyms().size() > 1;
879 CreateDwarfSectionSymbols |= UseRangesSection;
881 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
882 if (CreateDwarfSectionSymbols) {
883 InfoSectionSymbol = context.CreateTempSymbol();
884 MCOS->EmitLabel(InfoSectionSymbol);
886 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
887 if (CreateDwarfSectionSymbols) {
888 AbbrevSectionSymbol = context.CreateTempSymbol();
889 MCOS->EmitLabel(AbbrevSectionSymbol);
891 if (UseRangesSection) {
892 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfRangesSection());
893 if (CreateDwarfSectionSymbols) {
894 RangesSectionSymbol = context.CreateTempSymbol();
895 MCOS->EmitLabel(RangesSectionSymbol);
899 assert((RangesSectionSymbol != NULL) || !UseRangesSection);
901 MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
903 // Output the data for .debug_aranges section.
904 EmitGenDwarfAranges(MCOS, InfoSectionSymbol);
906 if (UseRangesSection)
907 EmitGenDwarfRanges(MCOS);
909 // Output the data for .debug_abbrev section.
910 EmitGenDwarfAbbrev(MCOS);
912 // Output the data for .debug_info section.
913 EmitGenDwarfInfo(MCOS, AbbrevSectionSymbol, LineSectionSymbol,
914 RangesSectionSymbol);
918 // When generating dwarf for assembly source files this is called when symbol
919 // for a label is created. If this symbol is not a temporary and is in the
920 // section that dwarf is being generated for, save the needed info to create
923 void MCGenDwarfLabelEntry::Make(MCSymbol *Symbol, MCStreamer *MCOS,
924 SourceMgr &SrcMgr, SMLoc &Loc) {
925 // We won't create dwarf labels for temporary symbols.
926 if (Symbol->isTemporary())
928 MCContext &context = MCOS->getContext();
929 // We won't create dwarf labels for symbols in sections that we are not
930 // generating debug info for.
931 if (!context.getGenDwarfSectionSyms().count(MCOS->getCurrentSection().first))
934 // The dwarf label's name does not have the symbol name's leading
936 StringRef Name = Symbol->getName();
937 if (Name.startswith("_"))
938 Name = Name.substr(1, Name.size()-1);
940 // Get the dwarf file number to be used for the dwarf label.
941 unsigned FileNumber = context.getGenDwarfFileNumber();
943 // Finding the line number is the expensive part which is why we just don't
944 // pass it in as for some symbols we won't create a dwarf label.
945 unsigned CurBuffer = SrcMgr.FindBufferContainingLoc(Loc);
946 unsigned LineNumber = SrcMgr.FindLineNumber(Loc, CurBuffer);
948 // We create a temporary symbol for use for the AT_high_pc and AT_low_pc
949 // values so that they don't have things like an ARM thumb bit from the
950 // original symbol. So when used they won't get a low bit set after
952 MCSymbol *Label = context.CreateTempSymbol();
953 MCOS->EmitLabel(Label);
955 // Create and entry for the info and add it to the other entries.
956 MCOS->getContext().addMCGenDwarfLabelEntry(
957 MCGenDwarfLabelEntry(Name, FileNumber, LineNumber, Label));
960 static int getDataAlignmentFactor(MCStreamer &streamer) {
961 MCContext &context = streamer.getContext();
962 const MCAsmInfo *asmInfo = context.getAsmInfo();
963 int size = asmInfo->getCalleeSaveStackSlotSize();
964 if (asmInfo->isStackGrowthDirectionUp())
970 static unsigned getSizeForEncoding(MCStreamer &streamer,
971 unsigned symbolEncoding) {
972 MCContext &context = streamer.getContext();
973 unsigned format = symbolEncoding & 0x0f;
975 default: llvm_unreachable("Unknown Encoding");
976 case dwarf::DW_EH_PE_absptr:
977 case dwarf::DW_EH_PE_signed:
978 return context.getAsmInfo()->getPointerSize();
979 case dwarf::DW_EH_PE_udata2:
980 case dwarf::DW_EH_PE_sdata2:
982 case dwarf::DW_EH_PE_udata4:
983 case dwarf::DW_EH_PE_sdata4:
985 case dwarf::DW_EH_PE_udata8:
986 case dwarf::DW_EH_PE_sdata8:
991 static void emitFDESymbol(MCObjectStreamer &streamer, const MCSymbol &symbol,
992 unsigned symbolEncoding, bool isEH) {
993 MCContext &context = streamer.getContext();
994 const MCAsmInfo *asmInfo = context.getAsmInfo();
995 const MCExpr *v = asmInfo->getExprForFDESymbol(&symbol,
998 unsigned size = getSizeForEncoding(streamer, symbolEncoding);
999 if (asmInfo->doDwarfFDESymbolsUseAbsDiff() && isEH)
1000 emitAbsValue(streamer, v, size);
1002 streamer.EmitValue(v, size);
1005 static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol,
1006 unsigned symbolEncoding) {
1007 MCContext &context = streamer.getContext();
1008 const MCAsmInfo *asmInfo = context.getAsmInfo();
1009 const MCExpr *v = asmInfo->getExprForPersonalitySymbol(&symbol,
1012 unsigned size = getSizeForEncoding(streamer, symbolEncoding);
1013 streamer.EmitValue(v, size);
1017 class FrameEmitterImpl {
1020 const MCSymbol *SectionStart;
1022 FrameEmitterImpl(bool isEH)
1023 : CFAOffset(0), IsEH(isEH), SectionStart(nullptr) {}
1025 void setSectionStart(const MCSymbol *Label) { SectionStart = Label; }
1027 /// Emit the unwind information in a compact way.
1028 void EmitCompactUnwind(MCObjectStreamer &streamer,
1029 const MCDwarfFrameInfo &frame);
1031 const MCSymbol &EmitCIE(MCObjectStreamer &streamer,
1032 const MCSymbol *personality,
1033 unsigned personalityEncoding,
1034 const MCSymbol *lsda,
1036 unsigned lsdaEncoding,
1038 MCSymbol *EmitFDE(MCObjectStreamer &streamer,
1039 const MCSymbol &cieStart,
1040 const MCDwarfFrameInfo &frame);
1041 void EmitCFIInstructions(MCObjectStreamer &streamer,
1042 ArrayRef<MCCFIInstruction> Instrs,
1043 MCSymbol *BaseLabel);
1044 void EmitCFIInstruction(MCObjectStreamer &Streamer,
1045 const MCCFIInstruction &Instr);
1048 } // end anonymous namespace
1050 static void emitEncodingByte(MCObjectStreamer &Streamer, unsigned Encoding) {
1051 Streamer.EmitIntValue(Encoding, 1);
1054 void FrameEmitterImpl::EmitCFIInstruction(MCObjectStreamer &Streamer,
1055 const MCCFIInstruction &Instr) {
1056 int dataAlignmentFactor = getDataAlignmentFactor(Streamer);
1058 switch (Instr.getOperation()) {
1059 case MCCFIInstruction::OpRegister: {
1060 unsigned Reg1 = Instr.getRegister();
1061 unsigned Reg2 = Instr.getRegister2();
1062 Streamer.EmitIntValue(dwarf::DW_CFA_register, 1);
1063 Streamer.EmitULEB128IntValue(Reg1);
1064 Streamer.EmitULEB128IntValue(Reg2);
1067 case MCCFIInstruction::OpWindowSave: {
1068 Streamer.EmitIntValue(dwarf::DW_CFA_GNU_window_save, 1);
1071 case MCCFIInstruction::OpUndefined: {
1072 unsigned Reg = Instr.getRegister();
1073 Streamer.EmitIntValue(dwarf::DW_CFA_undefined, 1);
1074 Streamer.EmitULEB128IntValue(Reg);
1077 case MCCFIInstruction::OpAdjustCfaOffset:
1078 case MCCFIInstruction::OpDefCfaOffset: {
1079 const bool IsRelative =
1080 Instr.getOperation() == MCCFIInstruction::OpAdjustCfaOffset;
1082 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
1085 CFAOffset += Instr.getOffset();
1087 CFAOffset = -Instr.getOffset();
1089 Streamer.EmitULEB128IntValue(CFAOffset);
1093 case MCCFIInstruction::OpDefCfa: {
1094 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
1095 Streamer.EmitULEB128IntValue(Instr.getRegister());
1096 CFAOffset = -Instr.getOffset();
1097 Streamer.EmitULEB128IntValue(CFAOffset);
1102 case MCCFIInstruction::OpDefCfaRegister: {
1103 Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
1104 Streamer.EmitULEB128IntValue(Instr.getRegister());
1109 case MCCFIInstruction::OpOffset:
1110 case MCCFIInstruction::OpRelOffset: {
1111 const bool IsRelative =
1112 Instr.getOperation() == MCCFIInstruction::OpRelOffset;
1114 unsigned Reg = Instr.getRegister();
1115 int Offset = Instr.getOffset();
1117 Offset -= CFAOffset;
1118 Offset = Offset / dataAlignmentFactor;
1121 Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
1122 Streamer.EmitULEB128IntValue(Reg);
1123 Streamer.EmitSLEB128IntValue(Offset);
1124 } else if (Reg < 64) {
1125 Streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
1126 Streamer.EmitULEB128IntValue(Offset);
1128 Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
1129 Streamer.EmitULEB128IntValue(Reg);
1130 Streamer.EmitULEB128IntValue(Offset);
1134 case MCCFIInstruction::OpRememberState:
1135 Streamer.EmitIntValue(dwarf::DW_CFA_remember_state, 1);
1137 case MCCFIInstruction::OpRestoreState:
1138 Streamer.EmitIntValue(dwarf::DW_CFA_restore_state, 1);
1140 case MCCFIInstruction::OpSameValue: {
1141 unsigned Reg = Instr.getRegister();
1142 Streamer.EmitIntValue(dwarf::DW_CFA_same_value, 1);
1143 Streamer.EmitULEB128IntValue(Reg);
1146 case MCCFIInstruction::OpRestore: {
1147 unsigned Reg = Instr.getRegister();
1148 Streamer.EmitIntValue(dwarf::DW_CFA_restore | Reg, 1);
1151 case MCCFIInstruction::OpEscape:
1152 Streamer.EmitBytes(Instr.getValues());
1155 llvm_unreachable("Unhandled case in switch");
1158 /// Emit frame instructions to describe the layout of the frame.
1159 void FrameEmitterImpl::EmitCFIInstructions(MCObjectStreamer &streamer,
1160 ArrayRef<MCCFIInstruction> Instrs,
1161 MCSymbol *BaseLabel) {
1162 for (unsigned i = 0, N = Instrs.size(); i < N; ++i) {
1163 const MCCFIInstruction &Instr = Instrs[i];
1164 MCSymbol *Label = Instr.getLabel();
1165 // Throw out move if the label is invalid.
1166 if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
1168 // Advance row if new location.
1169 if (BaseLabel && Label) {
1170 MCSymbol *ThisSym = Label;
1171 if (ThisSym != BaseLabel) {
1172 streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
1173 BaseLabel = ThisSym;
1177 EmitCFIInstruction(streamer, Instr);
1181 /// Emit the unwind information in a compact way.
1182 void FrameEmitterImpl::EmitCompactUnwind(MCObjectStreamer &Streamer,
1183 const MCDwarfFrameInfo &Frame) {
1184 MCContext &Context = Streamer.getContext();
1185 const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1187 // range-start range-length compact-unwind-enc personality-func lsda
1188 // _foo LfooEnd-_foo 0x00000023 0 0
1189 // _bar LbarEnd-_bar 0x00000025 __gxx_personality except_tab1
1191 // .section __LD,__compact_unwind,regular,debug
1193 // # compact unwind for _foo
1195 // .set L1,LfooEnd-_foo
1201 // # compact unwind for _bar
1203 // .set L2,LbarEnd-_bar
1206 // .quad __gxx_personality
1207 // .quad except_tab1
1209 uint32_t Encoding = Frame.CompactUnwindEncoding;
1210 if (!Encoding) return;
1211 bool DwarfEHFrameOnly = (Encoding == MOFI->getCompactUnwindDwarfEHFrameOnly());
1213 // The encoding needs to know we have an LSDA.
1214 if (!DwarfEHFrameOnly && Frame.Lsda)
1215 Encoding |= 0x40000000;
1218 unsigned FDEEncoding = MOFI->getFDEEncoding();
1219 unsigned Size = getSizeForEncoding(Streamer, FDEEncoding);
1220 Streamer.EmitSymbolValue(Frame.Begin, Size);
1223 const MCExpr *Range = MakeStartMinusEndExpr(Streamer, *Frame.Begin,
1225 emitAbsValue(Streamer, Range, 4);
1228 Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_udata4);
1229 Streamer.EmitIntValue(Encoding, Size);
1231 // Personality Function
1232 Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_absptr);
1233 if (!DwarfEHFrameOnly && Frame.Personality)
1234 Streamer.EmitSymbolValue(Frame.Personality, Size);
1236 Streamer.EmitIntValue(0, Size); // No personality fn
1239 Size = getSizeForEncoding(Streamer, Frame.LsdaEncoding);
1240 if (!DwarfEHFrameOnly && Frame.Lsda)
1241 Streamer.EmitSymbolValue(Frame.Lsda, Size);
1243 Streamer.EmitIntValue(0, Size); // No LSDA
1246 const MCSymbol &FrameEmitterImpl::EmitCIE(MCObjectStreamer &streamer,
1247 const MCSymbol *personality,
1248 unsigned personalityEncoding,
1249 const MCSymbol *lsda,
1251 unsigned lsdaEncoding,
1253 MCContext &context = streamer.getContext();
1254 const MCRegisterInfo *MRI = context.getRegisterInfo();
1255 const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1257 MCSymbol *sectionStart = context.CreateTempSymbol();
1258 streamer.EmitLabel(sectionStart);
1260 MCSymbol *sectionEnd = context.CreateTempSymbol();
1263 const MCExpr *Length = MakeStartMinusEndExpr(streamer, *sectionStart,
1265 emitAbsValue(streamer, Length, 4);
1268 unsigned CIE_ID = IsEH ? 0 : -1;
1269 streamer.EmitIntValue(CIE_ID, 4);
1272 // For DWARF2, we use CIE version 1
1273 // For DWARF3+, we use CIE version 3
1274 uint8_t CIEVersion = context.getDwarfVersion() <= 2 ? 1 : 3;
1275 streamer.EmitIntValue(CIEVersion, 1);
1277 // Augmentation String
1278 SmallString<8> Augmentation;
1280 Augmentation += "z";
1282 Augmentation += "P";
1284 Augmentation += "L";
1285 Augmentation += "R";
1287 Augmentation += "S";
1288 streamer.EmitBytes(Augmentation.str());
1290 streamer.EmitIntValue(0, 1);
1292 // Code Alignment Factor
1293 streamer.EmitULEB128IntValue(context.getAsmInfo()->getMinInstAlignment());
1295 // Data Alignment Factor
1296 streamer.EmitSLEB128IntValue(getDataAlignmentFactor(streamer));
1298 // Return Address Register
1299 if (CIEVersion == 1) {
1300 assert(MRI->getRARegister() <= 255 &&
1301 "DWARF 2 encodes return_address_register in one byte");
1302 streamer.EmitIntValue(MRI->getDwarfRegNum(MRI->getRARegister(), true), 1);
1304 streamer.EmitULEB128IntValue(
1305 MRI->getDwarfRegNum(MRI->getRARegister(), true));
1308 // Augmentation Data Length (optional)
1310 unsigned augmentationLength = 0;
1313 // Personality Encoding
1314 augmentationLength += 1;
1316 augmentationLength += getSizeForEncoding(streamer, personalityEncoding);
1319 augmentationLength += 1;
1320 // Encoding of the FDE pointers
1321 augmentationLength += 1;
1323 streamer.EmitULEB128IntValue(augmentationLength);
1325 // Augmentation Data (optional)
1327 // Personality Encoding
1328 emitEncodingByte(streamer, personalityEncoding);
1330 EmitPersonality(streamer, *personality, personalityEncoding);
1334 emitEncodingByte(streamer, lsdaEncoding);
1336 // Encoding of the FDE pointers
1337 emitEncodingByte(streamer, MOFI->getFDEEncoding());
1340 // Initial Instructions
1342 const MCAsmInfo *MAI = context.getAsmInfo();
1344 const std::vector<MCCFIInstruction> &Instructions =
1345 MAI->getInitialFrameState();
1346 EmitCFIInstructions(streamer, Instructions, nullptr);
1350 streamer.EmitValueToAlignment(IsEH ? 4 : MAI->getPointerSize());
1352 streamer.EmitLabel(sectionEnd);
1353 return *sectionStart;
1356 MCSymbol *FrameEmitterImpl::EmitFDE(MCObjectStreamer &streamer,
1357 const MCSymbol &cieStart,
1358 const MCDwarfFrameInfo &frame) {
1359 MCContext &context = streamer.getContext();
1360 MCSymbol *fdeStart = context.CreateTempSymbol();
1361 MCSymbol *fdeEnd = context.CreateTempSymbol();
1362 const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1365 const MCExpr *Length = MakeStartMinusEndExpr(streamer, *fdeStart, *fdeEnd, 0);
1366 emitAbsValue(streamer, Length, 4);
1368 streamer.EmitLabel(fdeStart);
1371 const MCAsmInfo *asmInfo = context.getAsmInfo();
1373 const MCExpr *offset = MakeStartMinusEndExpr(streamer, cieStart, *fdeStart,
1375 emitAbsValue(streamer, offset, 4);
1376 } else if (!asmInfo->doesDwarfUseRelocationsAcrossSections()) {
1377 const MCExpr *offset = MakeStartMinusEndExpr(streamer, *SectionStart,
1379 emitAbsValue(streamer, offset, 4);
1381 streamer.EmitSymbolValue(&cieStart, 4);
1385 unsigned PCEncoding =
1386 IsEH ? MOFI->getFDEEncoding() : (unsigned)dwarf::DW_EH_PE_absptr;
1387 unsigned PCSize = getSizeForEncoding(streamer, PCEncoding);
1388 emitFDESymbol(streamer, *frame.Begin, PCEncoding, IsEH);
1391 const MCExpr *Range = MakeStartMinusEndExpr(streamer, *frame.Begin,
1393 emitAbsValue(streamer, Range, PCSize);
1396 // Augmentation Data Length
1397 unsigned augmentationLength = 0;
1400 augmentationLength += getSizeForEncoding(streamer, frame.LsdaEncoding);
1402 streamer.EmitULEB128IntValue(augmentationLength);
1404 // Augmentation Data
1406 emitFDESymbol(streamer, *frame.Lsda, frame.LsdaEncoding, true);
1409 // Call Frame Instructions
1410 EmitCFIInstructions(streamer, frame.Instructions, frame.Begin);
1413 streamer.EmitValueToAlignment(PCSize);
1420 static const CIEKey getEmptyKey() {
1421 return CIEKey(nullptr, 0, -1, false, false);
1423 static const CIEKey getTombstoneKey() {
1424 return CIEKey(nullptr, -1, 0, false, false);
1427 CIEKey(const MCSymbol *Personality_, unsigned PersonalityEncoding_,
1428 unsigned LsdaEncoding_, bool IsSignalFrame_, bool IsSimple_)
1429 : Personality(Personality_), PersonalityEncoding(PersonalityEncoding_),
1430 LsdaEncoding(LsdaEncoding_), IsSignalFrame(IsSignalFrame_),
1431 IsSimple(IsSimple_) {}
1432 const MCSymbol *Personality;
1433 unsigned PersonalityEncoding;
1434 unsigned LsdaEncoding;
1442 struct DenseMapInfo<CIEKey> {
1443 static CIEKey getEmptyKey() {
1444 return CIEKey::getEmptyKey();
1446 static CIEKey getTombstoneKey() {
1447 return CIEKey::getTombstoneKey();
1449 static unsigned getHashValue(const CIEKey &Key) {
1450 return static_cast<unsigned>(hash_combine(Key.Personality,
1451 Key.PersonalityEncoding,
1456 static bool isEqual(const CIEKey &LHS,
1457 const CIEKey &RHS) {
1458 return LHS.Personality == RHS.Personality &&
1459 LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
1460 LHS.LsdaEncoding == RHS.LsdaEncoding &&
1461 LHS.IsSignalFrame == RHS.IsSignalFrame &&
1462 LHS.IsSimple == RHS.IsSimple;
1467 void MCDwarfFrameEmitter::Emit(MCObjectStreamer &Streamer, MCAsmBackend *MAB,
1469 Streamer.generateCompactUnwindEncodings(MAB);
1471 MCContext &Context = Streamer.getContext();
1472 const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1473 FrameEmitterImpl Emitter(IsEH);
1474 ArrayRef<MCDwarfFrameInfo> FrameArray = Streamer.getDwarfFrameInfos();
1476 // Emit the compact unwind info if available.
1477 bool NeedsEHFrameSection = !MOFI->getSupportsCompactUnwindWithoutEHFrame();
1478 if (IsEH && MOFI->getCompactUnwindSection()) {
1479 bool SectionEmitted = false;
1480 for (unsigned i = 0, n = FrameArray.size(); i < n; ++i) {
1481 const MCDwarfFrameInfo &Frame = FrameArray[i];
1482 if (Frame.CompactUnwindEncoding == 0) continue;
1483 if (!SectionEmitted) {
1484 Streamer.SwitchSection(MOFI->getCompactUnwindSection());
1485 Streamer.EmitValueToAlignment(Context.getAsmInfo()->getPointerSize());
1486 SectionEmitted = true;
1488 NeedsEHFrameSection |=
1489 Frame.CompactUnwindEncoding ==
1490 MOFI->getCompactUnwindDwarfEHFrameOnly();
1491 Emitter.EmitCompactUnwind(Streamer, Frame);
1495 if (!NeedsEHFrameSection) return;
1497 const MCSection &Section =
1498 IsEH ? *const_cast<MCObjectFileInfo*>(MOFI)->getEHFrameSection() :
1499 *MOFI->getDwarfFrameSection();
1501 Streamer.SwitchSection(&Section);
1502 MCSymbol *SectionStart = Context.CreateTempSymbol();
1503 Streamer.EmitLabel(SectionStart);
1504 Emitter.setSectionStart(SectionStart);
1506 MCSymbol *FDEEnd = nullptr;
1507 DenseMap<CIEKey, const MCSymbol *> CIEStarts;
1509 const MCSymbol *DummyDebugKey = nullptr;
1510 NeedsEHFrameSection = !MOFI->getSupportsCompactUnwindWithoutEHFrame();
1511 for (unsigned i = 0, n = FrameArray.size(); i < n; ++i) {
1512 const MCDwarfFrameInfo &Frame = FrameArray[i];
1514 // Emit the label from the previous iteration
1516 Streamer.EmitLabel(FDEEnd);
1520 if (!NeedsEHFrameSection && Frame.CompactUnwindEncoding !=
1521 MOFI->getCompactUnwindDwarfEHFrameOnly())
1522 // Don't generate an EH frame if we don't need one. I.e., it's taken care
1523 // of by the compact unwind encoding.
1526 CIEKey Key(Frame.Personality, Frame.PersonalityEncoding,
1527 Frame.LsdaEncoding, Frame.IsSignalFrame, Frame.IsSimple);
1528 const MCSymbol *&CIEStart = IsEH ? CIEStarts[Key] : DummyDebugKey;
1530 CIEStart = &Emitter.EmitCIE(Streamer, Frame.Personality,
1531 Frame.PersonalityEncoding, Frame.Lsda,
1532 Frame.IsSignalFrame,
1536 FDEEnd = Emitter.EmitFDE(Streamer, *CIEStart, Frame);
1539 Streamer.EmitValueToAlignment(Context.getAsmInfo()->getPointerSize());
1541 Streamer.EmitLabel(FDEEnd);
1544 void MCDwarfFrameEmitter::EmitAdvanceLoc(MCObjectStreamer &Streamer,
1545 uint64_t AddrDelta) {
1546 MCContext &Context = Streamer.getContext();
1547 SmallString<256> Tmp;
1548 raw_svector_ostream OS(Tmp);
1549 MCDwarfFrameEmitter::EncodeAdvanceLoc(Context, AddrDelta, OS);
1550 Streamer.EmitBytes(OS.str());
1553 void MCDwarfFrameEmitter::EncodeAdvanceLoc(MCContext &Context,
1556 // Scale the address delta by the minimum instruction length.
1557 AddrDelta = ScaleAddrDelta(Context, AddrDelta);
1559 if (AddrDelta == 0) {
1560 } else if (isUIntN(6, AddrDelta)) {
1561 uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
1563 } else if (isUInt<8>(AddrDelta)) {
1564 OS << uint8_t(dwarf::DW_CFA_advance_loc1);
1565 OS << uint8_t(AddrDelta);
1566 } else if (isUInt<16>(AddrDelta)) {
1567 // FIXME: check what is the correct behavior on a big endian machine.
1568 OS << uint8_t(dwarf::DW_CFA_advance_loc2);
1569 OS << uint8_t( AddrDelta & 0xff);
1570 OS << uint8_t((AddrDelta >> 8) & 0xff);
1572 // FIXME: check what is the correct behavior on a big endian machine.
1573 assert(isUInt<32>(AddrDelta));
1574 OS << uint8_t(dwarf::DW_CFA_advance_loc4);
1575 OS << uint8_t( AddrDelta & 0xff);
1576 OS << uint8_t((AddrDelta >> 8) & 0xff);
1577 OS << uint8_t((AddrDelta >> 16) & 0xff);
1578 OS << uint8_t((AddrDelta >> 24) & 0xff);