LLVM  9.0.0svn
MCDwarf.cpp
Go to the documentation of this file.
1 //===- lib/MC/MCDwarf.cpp - MCDwarf implementation ------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/MC/MCDwarf.h"
10 #include "llvm/ADT/ArrayRef.h"
11 #include "llvm/ADT/DenseMap.h"
12 #include "llvm/ADT/Hashing.h"
13 #include "llvm/ADT/Optional.h"
14 #include "llvm/ADT/STLExtras.h"
15 #include "llvm/ADT/SmallString.h"
16 #include "llvm/ADT/SmallVector.h"
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/ADT/Twine.h"
20 #include "llvm/Config/config.h"
21 #include "llvm/MC/MCAsmInfo.h"
22 #include "llvm/MC/MCContext.h"
23 #include "llvm/MC/MCExpr.h"
26 #include "llvm/MC/MCRegisterInfo.h"
27 #include "llvm/MC/MCSection.h"
28 #include "llvm/MC/MCStreamer.h"
29 #include "llvm/MC/MCSymbol.h"
31 #include "llvm/Support/Casting.h"
32 #include "llvm/Support/Endian.h"
35 #include "llvm/Support/LEB128.h"
37 #include "llvm/Support/Path.h"
38 #include "llvm/Support/SourceMgr.h"
40 #include <cassert>
41 #include <cstdint>
42 #include <string>
43 #include <utility>
44 #include <vector>
45 
46 using namespace llvm;
47 
48 /// Manage the .debug_line_str section contents, if we use it.
50  MCSymbol *LineStrLabel = nullptr;
52  bool UseRelocs = false;
53 
54 public:
55  /// Construct an instance that can emit .debug_line_str (for use in a normal
56  /// v5 line table).
57  explicit MCDwarfLineStr(MCContext &Ctx) {
59  if (UseRelocs)
60  LineStrLabel =
62  }
63 
64  /// Emit a reference to the string.
65  void emitRef(MCStreamer *MCOS, StringRef Path);
66 
67  /// Emit the .debug_line_str section if appropriate.
68  void emitSection(MCStreamer *MCOS);
69 };
70 
71 static inline uint64_t ScaleAddrDelta(MCContext &Context, uint64_t AddrDelta) {
72  unsigned MinInsnLength = Context.getAsmInfo()->getMinInstAlignment();
73  if (MinInsnLength == 1)
74  return AddrDelta;
75  if (AddrDelta % MinInsnLength != 0) {
76  // TODO: report this error, but really only once.
77  ;
78  }
79  return AddrDelta / MinInsnLength;
80 }
81 
82 //
83 // This is called when an instruction is assembled into the specified section
84 // and if there is information from the last .loc directive that has yet to have
85 // a line entry made for it is made.
86 //
88  if (!MCOS->getContext().getDwarfLocSeen())
89  return;
90 
91  // Create a symbol at in the current section for use in the line entry.
92  MCSymbol *LineSym = MCOS->getContext().createTempSymbol();
93  // Set the value of the symbol to use for the MCDwarfLineEntry.
94  MCOS->EmitLabel(LineSym);
95 
96  // Get the current .loc info saved in the context.
97  const MCDwarfLoc &DwarfLoc = MCOS->getContext().getCurrentDwarfLoc();
98 
99  // Create a (local) line entry with the symbol and the current .loc info.
100  MCDwarfLineEntry LineEntry(LineSym, DwarfLoc);
101 
102  // clear DwarfLocSeen saying the current .loc info is now used.
103  MCOS->getContext().clearDwarfLocSeen();
104 
105  // Add the line entry to this section's entries.
106  MCOS->getContext()
108  .getMCLineSections()
109  .addLineEntry(LineEntry, Section);
110 }
111 
112 //
113 // This helper routine returns an expression of End - Start + IntVal .
114 //
115 static inline const MCExpr *MakeStartMinusEndExpr(const MCStreamer &MCOS,
116  const MCSymbol &Start,
117  const MCSymbol &End,
118  int IntVal) {
120  const MCExpr *Res =
121  MCSymbolRefExpr::create(&End, Variant, MCOS.getContext());
122  const MCExpr *RHS =
123  MCSymbolRefExpr::create(&Start, Variant, MCOS.getContext());
124  const MCExpr *Res1 =
126  const MCExpr *Res2 =
127  MCConstantExpr::create(IntVal, MCOS.getContext());
128  const MCExpr *Res3 =
130  return Res3;
131 }
132 
133 //
134 // This helper routine returns an expression of Start + IntVal .
135 //
136 static inline const MCExpr *
137 makeStartPlusIntExpr(MCContext &Ctx, const MCSymbol &Start, int IntVal) {
139  const MCExpr *LHS = MCSymbolRefExpr::create(&Start, Variant, Ctx);
140  const MCExpr *RHS = MCConstantExpr::create(IntVal, Ctx);
141  const MCExpr *Res = MCBinaryExpr::create(MCBinaryExpr::Add, LHS, RHS, Ctx);
142  return Res;
143 }
144 
145 //
146 // This emits the Dwarf line table for the specified section from the entries
147 // in the LineSection.
148 //
149 static inline void
151  const MCLineSection::MCDwarfLineEntryCollection &LineEntries) {
152  unsigned FileNum = 1;
153  unsigned LastLine = 1;
154  unsigned Column = 0;
155  unsigned Flags = DWARF2_LINE_DEFAULT_IS_STMT ? DWARF2_FLAG_IS_STMT : 0;
156  unsigned Isa = 0;
157  unsigned Discriminator = 0;
158  MCSymbol *LastLabel = nullptr;
159 
160  // Loop through each MCDwarfLineEntry and encode the dwarf line number table.
161  for (const MCDwarfLineEntry &LineEntry : LineEntries) {
162  int64_t LineDelta = static_cast<int64_t>(LineEntry.getLine()) - LastLine;
163 
164  if (FileNum != LineEntry.getFileNum()) {
165  FileNum = LineEntry.getFileNum();
166  MCOS->EmitIntValue(dwarf::DW_LNS_set_file, 1);
167  MCOS->EmitULEB128IntValue(FileNum);
168  }
169  if (Column != LineEntry.getColumn()) {
170  Column = LineEntry.getColumn();
171  MCOS->EmitIntValue(dwarf::DW_LNS_set_column, 1);
172  MCOS->EmitULEB128IntValue(Column);
173  }
174  if (Discriminator != LineEntry.getDiscriminator() &&
175  MCOS->getContext().getDwarfVersion() >= 4) {
176  Discriminator = LineEntry.getDiscriminator();
177  unsigned Size = getULEB128Size(Discriminator);
178  MCOS->EmitIntValue(dwarf::DW_LNS_extended_op, 1);
179  MCOS->EmitULEB128IntValue(Size + 1);
180  MCOS->EmitIntValue(dwarf::DW_LNE_set_discriminator, 1);
181  MCOS->EmitULEB128IntValue(Discriminator);
182  }
183  if (Isa != LineEntry.getIsa()) {
184  Isa = LineEntry.getIsa();
185  MCOS->EmitIntValue(dwarf::DW_LNS_set_isa, 1);
186  MCOS->EmitULEB128IntValue(Isa);
187  }
188  if ((LineEntry.getFlags() ^ Flags) & DWARF2_FLAG_IS_STMT) {
189  Flags = LineEntry.getFlags();
190  MCOS->EmitIntValue(dwarf::DW_LNS_negate_stmt, 1);
191  }
192  if (LineEntry.getFlags() & DWARF2_FLAG_BASIC_BLOCK)
193  MCOS->EmitIntValue(dwarf::DW_LNS_set_basic_block, 1);
194  if (LineEntry.getFlags() & DWARF2_FLAG_PROLOGUE_END)
195  MCOS->EmitIntValue(dwarf::DW_LNS_set_prologue_end, 1);
196  if (LineEntry.getFlags() & DWARF2_FLAG_EPILOGUE_BEGIN)
197  MCOS->EmitIntValue(dwarf::DW_LNS_set_epilogue_begin, 1);
198 
199  MCSymbol *Label = LineEntry.getLabel();
200 
201  // At this point we want to emit/create the sequence to encode the delta in
202  // line numbers and the increment of the address from the previous Label
203  // and the current Label.
204  const MCAsmInfo *asmInfo = MCOS->getContext().getAsmInfo();
205  MCOS->EmitDwarfAdvanceLineAddr(LineDelta, LastLabel, Label,
206  asmInfo->getCodePointerSize());
207 
208  Discriminator = 0;
209  LastLine = LineEntry.getLine();
210  LastLabel = Label;
211  }
212 
213  // Emit a DW_LNE_end_sequence for the end of the section.
214  // Use the section end label to compute the address delta and use INT64_MAX
215  // as the line delta which is the signal that this is actually a
216  // DW_LNE_end_sequence.
217  MCSymbol *SectionEnd = MCOS->endSection(Section);
218 
219  // Switch back the dwarf line section, in case endSection had to switch the
220  // section.
221  MCContext &Ctx = MCOS->getContext();
223 
224  const MCAsmInfo *AsmInfo = Ctx.getAsmInfo();
225  MCOS->EmitDwarfAdvanceLineAddr(INT64_MAX, LastLabel, SectionEnd,
226  AsmInfo->getCodePointerSize());
227 }
228 
229 //
230 // This emits the Dwarf file and the line tables.
231 //
233  MCDwarfLineTableParams Params) {
234  MCContext &context = MCOS->getContext();
235 
236  auto &LineTables = context.getMCDwarfLineTables();
237 
238  // Bail out early so we don't switch to the debug_line section needlessly and
239  // in doing so create an unnecessary (if empty) section.
240  if (LineTables.empty())
241  return;
242 
243  // In a v5 non-split line table, put the strings in a separate section.
244  Optional<MCDwarfLineStr> LineStr;
245  if (context.getDwarfVersion() >= 5)
246  LineStr = MCDwarfLineStr(context);
247 
248  // Switch to the section where the table will be emitted into.
250 
251  // Handle the rest of the Compile Units.
252  for (const auto &CUIDTablePair : LineTables) {
253  CUIDTablePair.second.EmitCU(MCOS, Params, LineStr);
254  }
255 
256  if (LineStr)
257  LineStr->emitSection(MCOS);
258 }
259 
261  MCSection *Section) const {
262  if (Header.MCDwarfFiles.empty())
263  return;
264  Optional<MCDwarfLineStr> NoLineStr(None);
265  MCOS.SwitchSection(Section);
266  MCOS.EmitLabel(Header.Emit(&MCOS, Params, None, NoLineStr).second);
267 }
268 
269 std::pair<MCSymbol *, MCSymbol *>
271  Optional<MCDwarfLineStr> &LineStr) const {
272  static const char StandardOpcodeLengths[] = {
273  0, // length of DW_LNS_copy
274  1, // length of DW_LNS_advance_pc
275  1, // length of DW_LNS_advance_line
276  1, // length of DW_LNS_set_file
277  1, // length of DW_LNS_set_column
278  0, // length of DW_LNS_negate_stmt
279  0, // length of DW_LNS_set_basic_block
280  0, // length of DW_LNS_const_add_pc
281  1, // length of DW_LNS_fixed_advance_pc
282  0, // length of DW_LNS_set_prologue_end
283  0, // length of DW_LNS_set_epilogue_begin
284  1 // DW_LNS_set_isa
285  };
286  assert(array_lengthof(StandardOpcodeLengths) >=
287  (Params.DWARF2LineOpcodeBase - 1U));
288  return Emit(
289  MCOS, Params,
290  makeArrayRef(StandardOpcodeLengths, Params.DWARF2LineOpcodeBase - 1),
291  LineStr);
292 }
293 
294 static const MCExpr *forceExpAbs(MCStreamer &OS, const MCExpr* Expr) {
295  MCContext &Context = OS.getContext();
296  assert(!isa<MCSymbolRefExpr>(Expr));
297  if (Context.getAsmInfo()->hasAggressiveSymbolFolding())
298  return Expr;
299 
300  MCSymbol *ABS = Context.createTempSymbol();
301  OS.EmitAssignment(ABS, Expr);
302  return MCSymbolRefExpr::create(ABS, Context);
303 }
304 
305 static void emitAbsValue(MCStreamer &OS, const MCExpr *Value, unsigned Size) {
306  const MCExpr *ABS = forceExpAbs(OS, Value);
307  OS.EmitValue(ABS, Size);
308 }
309 
311  // Switch to the .debug_line_str section.
312  MCOS->SwitchSection(
314  // Emit the strings without perturbing the offsets we used.
315  LineStrings.finalizeInOrder();
317  Data.resize(LineStrings.getSize());
318  LineStrings.write((uint8_t *)Data.data());
319  MCOS->EmitBinaryData(Data.str());
320 }
321 
323  int RefSize = 4; // FIXME: Support DWARF-64
324  size_t Offset = LineStrings.add(Path);
325  if (UseRelocs) {
326  MCContext &Ctx = MCOS->getContext();
327  MCOS->EmitValue(makeStartPlusIntExpr(Ctx, *LineStrLabel, Offset), RefSize);
328  } else
329  MCOS->EmitIntValue(Offset, RefSize);
330 }
331 
332 void MCDwarfLineTableHeader::emitV2FileDirTables(MCStreamer *MCOS) const {
333  // First the directory table.
334  for (auto &Dir : MCDwarfDirs) {
335  MCOS->EmitBytes(Dir); // The DirectoryName, and...
336  MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
337  }
338  MCOS->EmitIntValue(0, 1); // Terminate the directory list.
339 
340  // Second the file table.
341  for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
342  assert(!MCDwarfFiles[i].Name.empty());
343  MCOS->EmitBytes(MCDwarfFiles[i].Name); // FileName and...
344  MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
345  MCOS->EmitULEB128IntValue(MCDwarfFiles[i].DirIndex); // Directory number.
346  MCOS->EmitIntValue(0, 1); // Last modification timestamp (always 0).
347  MCOS->EmitIntValue(0, 1); // File size (always 0).
348  }
349  MCOS->EmitIntValue(0, 1); // Terminate the file list.
350 }
351 
353  bool EmitMD5, bool HasSource,
354  Optional<MCDwarfLineStr> &LineStr) {
355  assert(!DwarfFile.Name.empty());
356  if (LineStr)
357  LineStr->emitRef(MCOS, DwarfFile.Name);
358  else {
359  MCOS->EmitBytes(DwarfFile.Name); // FileName and...
360  MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
361  }
362  MCOS->EmitULEB128IntValue(DwarfFile.DirIndex); // Directory number.
363  if (EmitMD5) {
364  MD5::MD5Result *Cksum = DwarfFile.Checksum;
365  MCOS->EmitBinaryData(
366  StringRef(reinterpret_cast<const char *>(Cksum->Bytes.data()),
367  Cksum->Bytes.size()));
368  }
369  if (HasSource) {
370  if (LineStr)
371  LineStr->emitRef(MCOS, DwarfFile.Source.getValueOr(StringRef()));
372  else {
373  MCOS->EmitBytes(
374  DwarfFile.Source.getValueOr(StringRef())); // Source and...
375  MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
376  }
377  }
378 }
379 
380 void MCDwarfLineTableHeader::emitV5FileDirTables(
381  MCStreamer *MCOS, Optional<MCDwarfLineStr> &LineStr,
382  StringRef CtxCompilationDir) const {
383  // The directory format, which is just a list of the directory paths. In a
384  // non-split object, these are references to .debug_line_str; in a split
385  // object, they are inline strings.
386  MCOS->EmitIntValue(1, 1);
387  MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_path);
388  MCOS->EmitULEB128IntValue(LineStr ? dwarf::DW_FORM_line_strp
389  : dwarf::DW_FORM_string);
390  MCOS->EmitULEB128IntValue(MCDwarfDirs.size() + 1);
391  // Try not to emit an empty compilation directory.
392  const StringRef CompDir =
393  CompilationDir.empty() ? CtxCompilationDir : StringRef(CompilationDir);
394  if (LineStr) {
395  // Record path strings, emit references here.
396  LineStr->emitRef(MCOS, CompDir);
397  for (const auto &Dir : MCDwarfDirs)
398  LineStr->emitRef(MCOS, Dir);
399  } else {
400  // The list of directory paths. Compilation directory comes first.
401  MCOS->EmitBytes(CompDir);
402  MCOS->EmitBytes(StringRef("\0", 1));
403  for (const auto &Dir : MCDwarfDirs) {
404  MCOS->EmitBytes(Dir); // The DirectoryName, and...
405  MCOS->EmitBytes(StringRef("\0", 1)); // its null terminator.
406  }
407  }
408 
409  // The file format, which is the inline null-terminated filename and a
410  // directory index. We don't track file size/timestamp so don't emit them
411  // in the v5 table. Emit MD5 checksums and source if we have them.
412  uint64_t Entries = 2;
413  if (HasAllMD5)
414  Entries += 1;
415  if (HasSource)
416  Entries += 1;
417  MCOS->EmitIntValue(Entries, 1);
418  MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_path);
419  MCOS->EmitULEB128IntValue(LineStr ? dwarf::DW_FORM_line_strp
420  : dwarf::DW_FORM_string);
421  MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_directory_index);
422  MCOS->EmitULEB128IntValue(dwarf::DW_FORM_udata);
423  if (HasAllMD5) {
424  MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_MD5);
425  MCOS->EmitULEB128IntValue(dwarf::DW_FORM_data16);
426  }
427  if (HasSource) {
428  MCOS->EmitULEB128IntValue(dwarf::DW_LNCT_LLVM_source);
429  MCOS->EmitULEB128IntValue(LineStr ? dwarf::DW_FORM_line_strp
430  : dwarf::DW_FORM_string);
431  }
432  // Then the counted list of files. The root file is file #0, then emit the
433  // files as provide by .file directives.
434  // MCDwarfFiles has an unused element [0] so use size() not size()+1.
435  // But sometimes MCDwarfFiles is empty, in which case we still emit one file.
436  MCOS->EmitULEB128IntValue(MCDwarfFiles.empty() ? 1 : MCDwarfFiles.size());
437  // To accommodate assembler source written for DWARF v4 but trying to emit
438  // v5: If we didn't see a root file explicitly, replicate file #1.
439  assert((!RootFile.Name.empty() || MCDwarfFiles.size() >= 1) &&
440  "No root file and no .file directives");
441  emitOneV5FileEntry(MCOS, RootFile.Name.empty() ? MCDwarfFiles[1] : RootFile,
442  HasAllMD5, HasSource, LineStr);
443  for (unsigned i = 1; i < MCDwarfFiles.size(); ++i)
444  emitOneV5FileEntry(MCOS, MCDwarfFiles[i], HasAllMD5, HasSource, LineStr);
445 }
446 
447 std::pair<MCSymbol *, MCSymbol *>
449  ArrayRef<char> StandardOpcodeLengths,
450  Optional<MCDwarfLineStr> &LineStr) const {
451  MCContext &context = MCOS->getContext();
452 
453  // Create a symbol at the beginning of the line table.
454  MCSymbol *LineStartSym = Label;
455  if (!LineStartSym)
456  LineStartSym = context.createTempSymbol();
457  // Set the value of the symbol, as we are at the start of the line table.
458  MCOS->EmitLabel(LineStartSym);
459 
460  // Create a symbol for the end of the section (to be set when we get there).
461  MCSymbol *LineEndSym = context.createTempSymbol();
462 
463  // The first 4 bytes is the total length of the information for this
464  // compilation unit (not including these 4 bytes for the length).
465  emitAbsValue(*MCOS,
466  MakeStartMinusEndExpr(*MCOS, *LineStartSym, *LineEndSym, 4), 4);
467 
468  // Next 2 bytes is the Version.
469  unsigned LineTableVersion = context.getDwarfVersion();
470  MCOS->EmitIntValue(LineTableVersion, 2);
471 
472  // Keep track of the bytes between the very start and where the header length
473  // comes out.
474  unsigned PreHeaderLengthBytes = 4 + 2;
475 
476  // In v5, we get address info next.
477  if (LineTableVersion >= 5) {
478  MCOS->EmitIntValue(context.getAsmInfo()->getCodePointerSize(), 1);
479  MCOS->EmitIntValue(0, 1); // Segment selector; same as EmitGenDwarfAranges.
480  PreHeaderLengthBytes += 2;
481  }
482 
483  // Create a symbol for the end of the prologue (to be set when we get there).
484  MCSymbol *ProEndSym = context.createTempSymbol(); // Lprologue_end
485 
486  // Length of the prologue, is the next 4 bytes. This is actually the length
487  // from after the length word, to the end of the prologue.
488  emitAbsValue(*MCOS,
489  MakeStartMinusEndExpr(*MCOS, *LineStartSym, *ProEndSym,
490  (PreHeaderLengthBytes + 4)),
491  4);
492 
493  // Parameters of the state machine, are next.
494  MCOS->EmitIntValue(context.getAsmInfo()->getMinInstAlignment(), 1);
495  // maximum_operations_per_instruction
496  // For non-VLIW architectures this field is always 1.
497  // FIXME: VLIW architectures need to update this field accordingly.
498  if (LineTableVersion >= 4)
499  MCOS->EmitIntValue(1, 1);
501  MCOS->EmitIntValue(Params.DWARF2LineBase, 1);
502  MCOS->EmitIntValue(Params.DWARF2LineRange, 1);
503  MCOS->EmitIntValue(StandardOpcodeLengths.size() + 1, 1);
504 
505  // Standard opcode lengths
506  for (char Length : StandardOpcodeLengths)
507  MCOS->EmitIntValue(Length, 1);
508 
509  // Put out the directory and file tables. The formats vary depending on
510  // the version.
511  if (LineTableVersion >= 5)
512  emitV5FileDirTables(MCOS, LineStr, context.getCompilationDir());
513  else
514  emitV2FileDirTables(MCOS);
515 
516  // This is the end of the prologue, so set the value of the symbol at the
517  // end of the prologue (that was used in a previous expression).
518  MCOS->EmitLabel(ProEndSym);
519 
520  return std::make_pair(LineStartSym, LineEndSym);
521 }
522 
524  MCDwarfLineTableParams Params,
525  Optional<MCDwarfLineStr> &LineStr) const {
526  MCSymbol *LineEndSym = Header.Emit(MCOS, Params, LineStr).second;
527 
528  // Put out the line tables.
529  for (const auto &LineSec : MCLineSections.getMCLineEntries())
530  EmitDwarfLineTable(MCOS, LineSec.first, LineSec.second);
531 
532  // This is the end of the section, so set the value of the symbol at the end
533  // of this section (that was used in a previous expression).
534  MCOS->EmitLabel(LineEndSym);
535 }
536 
538  StringRef &FileName,
539  MD5::MD5Result *Checksum,
541  unsigned FileNumber) {
542  return Header.tryGetFile(Directory, FileName, Checksum, Source, FileNumber);
543 }
544 
547  StringRef &FileName,
548  MD5::MD5Result *Checksum,
550  unsigned FileNumber) {
551  if (Directory == CompilationDir)
552  Directory = "";
553  if (FileName.empty()) {
554  FileName = "<stdin>";
555  Directory = "";
556  }
557  assert(!FileName.empty());
558  // Keep track of whether any or all files have an MD5 checksum.
559  // If any files have embedded source, they all must.
560  if (MCDwarfFiles.empty()) {
561  trackMD5Usage(Checksum);
562  HasSource = (Source != None);
563  }
564  if (FileNumber == 0) {
565  // File numbers start with 1 and/or after any file numbers
566  // allocated by inline-assembler .file directives.
567  FileNumber = MCDwarfFiles.empty() ? 1 : MCDwarfFiles.size();
568  SmallString<256> Buffer;
569  auto IterBool = SourceIdMap.insert(
570  std::make_pair((Directory + Twine('\0') + FileName).toStringRef(Buffer),
571  FileNumber));
572  if (!IterBool.second)
573  return IterBool.first->second;
574  }
575  // Make space for this FileNumber in the MCDwarfFiles vector if needed.
576  if (FileNumber >= MCDwarfFiles.size())
577  MCDwarfFiles.resize(FileNumber + 1);
578 
579  // Get the new MCDwarfFile slot for this FileNumber.
580  MCDwarfFile &File = MCDwarfFiles[FileNumber];
581 
582  // It is an error to see the same number more than once.
583  if (!File.Name.empty())
584  return make_error<StringError>("file number already allocated",
586 
587  // If any files have embedded source, they all must.
588  if (HasSource != (Source != None))
589  return make_error<StringError>("inconsistent use of embedded source",
591 
592  if (Directory.empty()) {
593  // Separate the directory part from the basename of the FileName.
594  StringRef tFileName = sys::path::filename(FileName);
595  if (!tFileName.empty()) {
596  Directory = sys::path::parent_path(FileName);
597  if (!Directory.empty())
598  FileName = tFileName;
599  }
600  }
601 
602  // Find or make an entry in the MCDwarfDirs vector for this Directory.
603  // Capture directory name.
604  unsigned DirIndex;
605  if (Directory.empty()) {
606  // For FileNames with no directories a DirIndex of 0 is used.
607  DirIndex = 0;
608  } else {
609  DirIndex = 0;
610  for (unsigned End = MCDwarfDirs.size(); DirIndex < End; DirIndex++) {
611  if (Directory == MCDwarfDirs[DirIndex])
612  break;
613  }
614  if (DirIndex >= MCDwarfDirs.size())
615  MCDwarfDirs.push_back(Directory);
616  // The DirIndex is one based, as DirIndex of 0 is used for FileNames with
617  // no directories. MCDwarfDirs[] is unlike MCDwarfFiles[] in that the
618  // directory names are stored at MCDwarfDirs[DirIndex-1] where FileNames
619  // are stored at MCDwarfFiles[FileNumber].Name .
620  DirIndex++;
621  }
622 
623  File.Name = FileName;
624  File.DirIndex = DirIndex;
625  File.Checksum = Checksum;
626  trackMD5Usage(Checksum);
627  File.Source = Source;
628  if (Source)
629  HasSource = true;
630 
631  // return the allocated FileNumber.
632  return FileNumber;
633 }
634 
635 /// Utility function to emit the encoding to a streamer.
637  int64_t LineDelta, uint64_t AddrDelta) {
638  MCContext &Context = MCOS->getContext();
639  SmallString<256> Tmp;
640  raw_svector_ostream OS(Tmp);
641  MCDwarfLineAddr::Encode(Context, Params, LineDelta, AddrDelta, OS);
642  MCOS->EmitBytes(OS.str());
643 }
644 
645 /// Given a special op, return the address skip amount (in units of
646 /// DWARF2_LINE_MIN_INSN_LENGTH).
647 static uint64_t SpecialAddr(MCDwarfLineTableParams Params, uint64_t op) {
648  return (op - Params.DWARF2LineOpcodeBase) / Params.DWARF2LineRange;
649 }
650 
651 /// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
653  int64_t LineDelta, uint64_t AddrDelta,
654  raw_ostream &OS) {
655  uint64_t Temp, Opcode;
656  bool NeedCopy = false;
657 
658  // The maximum address skip amount that can be encoded with a special op.
659  uint64_t MaxSpecialAddrDelta = SpecialAddr(Params, 255);
660 
661  // Scale the address delta by the minimum instruction length.
662  AddrDelta = ScaleAddrDelta(Context, AddrDelta);
663 
664  // A LineDelta of INT64_MAX is a signal that this is actually a
665  // DW_LNE_end_sequence. We cannot use special opcodes here, since we want the
666  // end_sequence to emit the matrix entry.
667  if (LineDelta == INT64_MAX) {
668  if (AddrDelta == MaxSpecialAddrDelta)
669  OS << char(dwarf::DW_LNS_const_add_pc);
670  else if (AddrDelta) {
671  OS << char(dwarf::DW_LNS_advance_pc);
672  encodeULEB128(AddrDelta, OS);
673  }
674  OS << char(dwarf::DW_LNS_extended_op);
675  OS << char(1);
676  OS << char(dwarf::DW_LNE_end_sequence);
677  return;
678  }
679 
680  // Bias the line delta by the base.
681  Temp = LineDelta - Params.DWARF2LineBase;
682 
683  // If the line increment is out of range of a special opcode, we must encode
684  // it with DW_LNS_advance_line.
685  if (Temp >= Params.DWARF2LineRange ||
686  Temp + Params.DWARF2LineOpcodeBase > 255) {
687  OS << char(dwarf::DW_LNS_advance_line);
688  encodeSLEB128(LineDelta, OS);
689 
690  LineDelta = 0;
691  Temp = 0 - Params.DWARF2LineBase;
692  NeedCopy = true;
693  }
694 
695  // Use DW_LNS_copy instead of a "line +0, addr +0" special opcode.
696  if (LineDelta == 0 && AddrDelta == 0) {
697  OS << char(dwarf::DW_LNS_copy);
698  return;
699  }
700 
701  // Bias the opcode by the special opcode base.
702  Temp += Params.DWARF2LineOpcodeBase;
703 
704  // Avoid overflow when addr_delta is large.
705  if (AddrDelta < 256 + MaxSpecialAddrDelta) {
706  // Try using a special opcode.
707  Opcode = Temp + AddrDelta * Params.DWARF2LineRange;
708  if (Opcode <= 255) {
709  OS << char(Opcode);
710  return;
711  }
712 
713  // Try using DW_LNS_const_add_pc followed by special op.
714  Opcode = Temp + (AddrDelta - MaxSpecialAddrDelta) * Params.DWARF2LineRange;
715  if (Opcode <= 255) {
716  OS << char(dwarf::DW_LNS_const_add_pc);
717  OS << char(Opcode);
718  return;
719  }
720  }
721 
722  // Otherwise use DW_LNS_advance_pc.
723  OS << char(dwarf::DW_LNS_advance_pc);
724  encodeULEB128(AddrDelta, OS);
725 
726  if (NeedCopy)
727  OS << char(dwarf::DW_LNS_copy);
728  else {
729  assert(Temp <= 255 && "Buggy special opcode encoding.");
730  OS << char(Temp);
731  }
732 }
733 
735  MCDwarfLineTableParams Params,
736  int64_t LineDelta, uint64_t AddrDelta,
737  raw_ostream &OS,
739  if (LineDelta != INT64_MAX) {
740  OS << char(dwarf::DW_LNS_advance_line);
741  encodeSLEB128(LineDelta, OS);
742  }
743 
744  // Use address delta to adjust address or use absolute address to adjust
745  // address.
746  bool SetDelta;
747  // According to DWARF spec., the DW_LNS_fixed_advance_pc opcode takes a
748  // single uhalf (unencoded) operand. So, the maximum value of AddrDelta
749  // is 65535. We set a conservative upper bound for it for relaxation.
750  if (AddrDelta > 60000) {
751  const MCAsmInfo *asmInfo = Context.getAsmInfo();
752  unsigned AddrSize = asmInfo->getCodePointerSize();
753 
754  OS << char(dwarf::DW_LNS_extended_op);
755  encodeULEB128(1 + AddrSize, OS);
756  OS << char(dwarf::DW_LNE_set_address);
757  // Generate fixup for the address.
758  *Offset = OS.tell();
759  *Size = AddrSize;
760  SetDelta = false;
761  std::vector<uint8_t> FillData;
762  FillData.insert(FillData.begin(), AddrSize, 0);
763  OS.write(reinterpret_cast<char *>(FillData.data()), AddrSize);
764  } else {
765  OS << char(dwarf::DW_LNS_fixed_advance_pc);
766  // Generate fixup for 2-bytes address delta.
767  *Offset = OS.tell();
768  *Size = 2;
769  SetDelta = true;
770  OS << char(0);
771  OS << char(0);
772  }
773 
774  if (LineDelta == INT64_MAX) {
775  OS << char(dwarf::DW_LNS_extended_op);
776  OS << char(1);
777  OS << char(dwarf::DW_LNE_end_sequence);
778  } else {
779  OS << char(dwarf::DW_LNS_copy);
780  }
781 
782  return SetDelta;
783 }
784 
785 // Utility function to write a tuple for .debug_abbrev.
786 static void EmitAbbrev(MCStreamer *MCOS, uint64_t Name, uint64_t Form) {
787  MCOS->EmitULEB128IntValue(Name);
788  MCOS->EmitULEB128IntValue(Form);
789 }
790 
791 // When generating dwarf for assembly source files this emits
792 // the data for .debug_abbrev section which contains three DIEs.
793 static void EmitGenDwarfAbbrev(MCStreamer *MCOS) {
794  MCContext &context = MCOS->getContext();
796 
797  // DW_TAG_compile_unit DIE abbrev (1).
798  MCOS->EmitULEB128IntValue(1);
799  MCOS->EmitULEB128IntValue(dwarf::DW_TAG_compile_unit);
801  EmitAbbrev(MCOS, dwarf::DW_AT_stmt_list, context.getDwarfVersion() >= 4
802  ? dwarf::DW_FORM_sec_offset
803  : dwarf::DW_FORM_data4);
804  if (context.getGenDwarfSectionSyms().size() > 1 &&
805  context.getDwarfVersion() >= 3) {
806  EmitAbbrev(MCOS, dwarf::DW_AT_ranges, context.getDwarfVersion() >= 4
807  ? dwarf::DW_FORM_sec_offset
808  : dwarf::DW_FORM_data4);
809  } else {
810  EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
811  EmitAbbrev(MCOS, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr);
812  }
813  EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
814  if (!context.getCompilationDir().empty())
815  EmitAbbrev(MCOS, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string);
816  StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
817  if (!DwarfDebugFlags.empty())
818  EmitAbbrev(MCOS, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string);
819  EmitAbbrev(MCOS, dwarf::DW_AT_producer, dwarf::DW_FORM_string);
820  EmitAbbrev(MCOS, dwarf::DW_AT_language, dwarf::DW_FORM_data2);
821  EmitAbbrev(MCOS, 0, 0);
822 
823  // DW_TAG_label DIE abbrev (2).
824  MCOS->EmitULEB128IntValue(2);
825  MCOS->EmitULEB128IntValue(dwarf::DW_TAG_label);
827  EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
828  EmitAbbrev(MCOS, dwarf::DW_AT_decl_file, dwarf::DW_FORM_data4);
829  EmitAbbrev(MCOS, dwarf::DW_AT_decl_line, dwarf::DW_FORM_data4);
830  EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
831  EmitAbbrev(MCOS, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag);
832  EmitAbbrev(MCOS, 0, 0);
833 
834  // DW_TAG_unspecified_parameters DIE abbrev (3).
835  MCOS->EmitULEB128IntValue(3);
836  MCOS->EmitULEB128IntValue(dwarf::DW_TAG_unspecified_parameters);
838  EmitAbbrev(MCOS, 0, 0);
839 
840  // Terminate the abbreviations for this compilation unit.
841  MCOS->EmitIntValue(0, 1);
842 }
843 
844 // When generating dwarf for assembly source files this emits the data for
845 // .debug_aranges section. This section contains a header and a table of pairs
846 // of PointerSize'ed values for the address and size of section(s) with line
847 // table entries.
848 static void EmitGenDwarfAranges(MCStreamer *MCOS,
849  const MCSymbol *InfoSectionSymbol) {
850  MCContext &context = MCOS->getContext();
851 
852  auto &Sections = context.getGenDwarfSectionSyms();
853 
855 
856  // This will be the length of the .debug_aranges section, first account for
857  // the size of each item in the header (see below where we emit these items).
858  int Length = 4 + 2 + 4 + 1 + 1;
859 
860  // Figure the padding after the header before the table of address and size
861  // pairs who's values are PointerSize'ed.
862  const MCAsmInfo *asmInfo = context.getAsmInfo();
863  int AddrSize = asmInfo->getCodePointerSize();
864  int Pad = 2 * AddrSize - (Length & (2 * AddrSize - 1));
865  if (Pad == 2 * AddrSize)
866  Pad = 0;
867  Length += Pad;
868 
869  // Add the size of the pair of PointerSize'ed values for the address and size
870  // of each section we have in the table.
871  Length += 2 * AddrSize * Sections.size();
872  // And the pair of terminating zeros.
873  Length += 2 * AddrSize;
874 
875  // Emit the header for this section.
876  // The 4 byte length not including the 4 byte value for the length.
877  MCOS->EmitIntValue(Length - 4, 4);
878  // The 2 byte version, which is 2.
879  MCOS->EmitIntValue(2, 2);
880  // The 4 byte offset to the compile unit in the .debug_info from the start
881  // of the .debug_info.
882  if (InfoSectionSymbol)
883  MCOS->EmitSymbolValue(InfoSectionSymbol, 4,
885  else
886  MCOS->EmitIntValue(0, 4);
887  // The 1 byte size of an address.
888  MCOS->EmitIntValue(AddrSize, 1);
889  // The 1 byte size of a segment descriptor, we use a value of zero.
890  MCOS->EmitIntValue(0, 1);
891  // Align the header with the padding if needed, before we put out the table.
892  for(int i = 0; i < Pad; i++)
893  MCOS->EmitIntValue(0, 1);
894 
895  // Now emit the table of pairs of PointerSize'ed values for the section
896  // addresses and sizes.
897  for (MCSection *Sec : Sections) {
898  const MCSymbol *StartSymbol = Sec->getBeginSymbol();
899  MCSymbol *EndSymbol = Sec->getEndSymbol(context);
900  assert(StartSymbol && "StartSymbol must not be NULL");
901  assert(EndSymbol && "EndSymbol must not be NULL");
902 
903  const MCExpr *Addr = MCSymbolRefExpr::create(
904  StartSymbol, MCSymbolRefExpr::VK_None, context);
905  const MCExpr *Size = MakeStartMinusEndExpr(*MCOS,
906  *StartSymbol, *EndSymbol, 0);
907  MCOS->EmitValue(Addr, AddrSize);
908  emitAbsValue(*MCOS, Size, AddrSize);
909  }
910 
911  // And finally the pair of terminating zeros.
912  MCOS->EmitIntValue(0, AddrSize);
913  MCOS->EmitIntValue(0, AddrSize);
914 }
915 
916 // When generating dwarf for assembly source files this emits the data for
917 // .debug_info section which contains three parts. The header, the compile_unit
918 // DIE and a list of label DIEs.
919 static void EmitGenDwarfInfo(MCStreamer *MCOS,
920  const MCSymbol *AbbrevSectionSymbol,
921  const MCSymbol *LineSectionSymbol,
922  const MCSymbol *RangesSectionSymbol) {
923  MCContext &context = MCOS->getContext();
924 
926 
927  // Create a symbol at the start and end of this section used in here for the
928  // expression to calculate the length in the header.
929  MCSymbol *InfoStart = context.createTempSymbol();
930  MCOS->EmitLabel(InfoStart);
931  MCSymbol *InfoEnd = context.createTempSymbol();
932 
933  // First part: the header.
934 
935  // The 4 byte total length of the information for this compilation unit, not
936  // including these 4 bytes.
937  const MCExpr *Length = MakeStartMinusEndExpr(*MCOS, *InfoStart, *InfoEnd, 4);
938  emitAbsValue(*MCOS, Length, 4);
939 
940  // The 2 byte DWARF version.
941  MCOS->EmitIntValue(context.getDwarfVersion(), 2);
942 
943  // The DWARF v5 header has unit type, address size, abbrev offset.
944  // Earlier versions have abbrev offset, address size.
945  const MCAsmInfo &AsmInfo = *context.getAsmInfo();
946  int AddrSize = AsmInfo.getCodePointerSize();
947  if (context.getDwarfVersion() >= 5) {
948  MCOS->EmitIntValue(dwarf::DW_UT_compile, 1);
949  MCOS->EmitIntValue(AddrSize, 1);
950  }
951  // The 4 byte offset to the debug abbrevs from the start of the .debug_abbrev,
952  // it is at the start of that section so this is zero.
953  if (AbbrevSectionSymbol == nullptr)
954  MCOS->EmitIntValue(0, 4);
955  else
956  MCOS->EmitSymbolValue(AbbrevSectionSymbol, 4,
958  if (context.getDwarfVersion() <= 4)
959  MCOS->EmitIntValue(AddrSize, 1);
960 
961  // Second part: the compile_unit DIE.
962 
963  // The DW_TAG_compile_unit DIE abbrev (1).
964  MCOS->EmitULEB128IntValue(1);
965 
966  // DW_AT_stmt_list, a 4 byte offset from the start of the .debug_line section,
967  // which is at the start of that section so this is zero.
968  if (LineSectionSymbol)
969  MCOS->EmitSymbolValue(LineSectionSymbol, 4,
971  else
972  MCOS->EmitIntValue(0, 4);
973 
974  if (RangesSectionSymbol) {
975  // There are multiple sections containing code, so we must use the
976  // .debug_ranges sections.
977 
978  // AT_ranges, the 4 byte offset from the start of the .debug_ranges section
979  // to the address range list for this compilation unit.
980  MCOS->EmitSymbolValue(RangesSectionSymbol, 4);
981  } else {
982  // If we only have one non-empty code section, we can use the simpler
983  // AT_low_pc and AT_high_pc attributes.
984 
985  // Find the first (and only) non-empty text section
986  auto &Sections = context.getGenDwarfSectionSyms();
987  const auto TextSection = Sections.begin();
988  assert(TextSection != Sections.end() && "No text section found");
989 
990  MCSymbol *StartSymbol = (*TextSection)->getBeginSymbol();
991  MCSymbol *EndSymbol = (*TextSection)->getEndSymbol(context);
992  assert(StartSymbol && "StartSymbol must not be NULL");
993  assert(EndSymbol && "EndSymbol must not be NULL");
994 
995  // AT_low_pc, the first address of the default .text section.
996  const MCExpr *Start = MCSymbolRefExpr::create(
997  StartSymbol, MCSymbolRefExpr::VK_None, context);
998  MCOS->EmitValue(Start, AddrSize);
999 
1000  // AT_high_pc, the last address of the default .text section.
1001  const MCExpr *End = MCSymbolRefExpr::create(
1002  EndSymbol, MCSymbolRefExpr::VK_None, context);
1003  MCOS->EmitValue(End, AddrSize);
1004  }
1005 
1006  // AT_name, the name of the source file. Reconstruct from the first directory
1007  // and file table entries.
1008  const SmallVectorImpl<std::string> &MCDwarfDirs = context.getMCDwarfDirs();
1009  if (MCDwarfDirs.size() > 0) {
1010  MCOS->EmitBytes(MCDwarfDirs[0]);
1012  }
1013  const SmallVectorImpl<MCDwarfFile> &MCDwarfFiles = context.getMCDwarfFiles();
1014  // MCDwarfFiles might be empty if we have an empty source file.
1015  // If it's not empty, [0] is unused and [1] is the first actual file.
1016  assert(MCDwarfFiles.empty() || MCDwarfFiles.size() >= 2);
1017  const MCDwarfFile &RootFile =
1018  MCDwarfFiles.empty()
1019  ? context.getMCDwarfLineTable(/*CUID=*/0).getRootFile()
1020  : MCDwarfFiles[1];
1021  MCOS->EmitBytes(RootFile.Name);
1022  MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
1023 
1024  // AT_comp_dir, the working directory the assembly was done in.
1025  if (!context.getCompilationDir().empty()) {
1026  MCOS->EmitBytes(context.getCompilationDir());
1027  MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
1028  }
1029 
1030  // AT_APPLE_flags, the command line arguments of the assembler tool.
1031  StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
1032  if (!DwarfDebugFlags.empty()){
1033  MCOS->EmitBytes(DwarfDebugFlags);
1034  MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
1035  }
1036 
1037  // AT_producer, the version of the assembler tool.
1038  StringRef DwarfDebugProducer = context.getDwarfDebugProducer();
1039  if (!DwarfDebugProducer.empty())
1040  MCOS->EmitBytes(DwarfDebugProducer);
1041  else
1042  MCOS->EmitBytes(StringRef("llvm-mc (based on LLVM " PACKAGE_VERSION ")"));
1043  MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
1044 
1045  // AT_language, a 4 byte value. We use DW_LANG_Mips_Assembler as the dwarf2
1046  // draft has no standard code for assembler.
1047  MCOS->EmitIntValue(dwarf::DW_LANG_Mips_Assembler, 2);
1048 
1049  // Third part: the list of label DIEs.
1050 
1051  // Loop on saved info for dwarf labels and create the DIEs for them.
1052  const std::vector<MCGenDwarfLabelEntry> &Entries =
1054  for (const auto &Entry : Entries) {
1055  // The DW_TAG_label DIE abbrev (2).
1056  MCOS->EmitULEB128IntValue(2);
1057 
1058  // AT_name, of the label without any leading underbar.
1059  MCOS->EmitBytes(Entry.getName());
1060  MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
1061 
1062  // AT_decl_file, index into the file table.
1063  MCOS->EmitIntValue(Entry.getFileNumber(), 4);
1064 
1065  // AT_decl_line, source line number.
1066  MCOS->EmitIntValue(Entry.getLineNumber(), 4);
1067 
1068  // AT_low_pc, start address of the label.
1069  const MCExpr *AT_low_pc = MCSymbolRefExpr::create(Entry.getLabel(),
1070  MCSymbolRefExpr::VK_None, context);
1071  MCOS->EmitValue(AT_low_pc, AddrSize);
1072 
1073  // DW_AT_prototyped, a one byte flag value of 0 saying we have no prototype.
1074  MCOS->EmitIntValue(0, 1);
1075 
1076  // The DW_TAG_unspecified_parameters DIE abbrev (3).
1077  MCOS->EmitULEB128IntValue(3);
1078 
1079  // Add the NULL DIE terminating the DW_TAG_unspecified_parameters DIE's.
1080  MCOS->EmitIntValue(0, 1);
1081  }
1082 
1083  // Add the NULL DIE terminating the Compile Unit DIE's.
1084  MCOS->EmitIntValue(0, 1);
1085 
1086  // Now set the value of the symbol at the end of the info section.
1087  MCOS->EmitLabel(InfoEnd);
1088 }
1089 
1090 // When generating dwarf for assembly source files this emits the data for
1091 // .debug_ranges section. We only emit one range list, which spans all of the
1092 // executable sections of this file.
1093 static void EmitGenDwarfRanges(MCStreamer *MCOS) {
1094  MCContext &context = MCOS->getContext();
1095  auto &Sections = context.getGenDwarfSectionSyms();
1096 
1097  const MCAsmInfo *AsmInfo = context.getAsmInfo();
1098  int AddrSize = AsmInfo->getCodePointerSize();
1099 
1101 
1102  for (MCSection *Sec : Sections) {
1103  const MCSymbol *StartSymbol = Sec->getBeginSymbol();
1104  MCSymbol *EndSymbol = Sec->getEndSymbol(context);
1105  assert(StartSymbol && "StartSymbol must not be NULL");
1106  assert(EndSymbol && "EndSymbol must not be NULL");
1107 
1108  // Emit a base address selection entry for the start of this section
1109  const MCExpr *SectionStartAddr = MCSymbolRefExpr::create(
1110  StartSymbol, MCSymbolRefExpr::VK_None, context);
1111  MCOS->emitFill(AddrSize, 0xFF);
1112  MCOS->EmitValue(SectionStartAddr, AddrSize);
1113 
1114  // Emit a range list entry spanning this section
1115  const MCExpr *SectionSize = MakeStartMinusEndExpr(*MCOS,
1116  *StartSymbol, *EndSymbol, 0);
1117  MCOS->EmitIntValue(0, AddrSize);
1118  emitAbsValue(*MCOS, SectionSize, AddrSize);
1119  }
1120 
1121  // Emit end of list entry
1122  MCOS->EmitIntValue(0, AddrSize);
1123  MCOS->EmitIntValue(0, AddrSize);
1124 }
1125 
1126 //
1127 // When generating dwarf for assembly source files this emits the Dwarf
1128 // sections.
1129 //
1131  MCContext &context = MCOS->getContext();
1132 
1133  // Create the dwarf sections in this order (.debug_line already created).
1134  const MCAsmInfo *AsmInfo = context.getAsmInfo();
1135  bool CreateDwarfSectionSymbols =
1137  MCSymbol *LineSectionSymbol = nullptr;
1138  if (CreateDwarfSectionSymbols)
1139  LineSectionSymbol = MCOS->getDwarfLineTableSymbol(0);
1140  MCSymbol *AbbrevSectionSymbol = nullptr;
1141  MCSymbol *InfoSectionSymbol = nullptr;
1142  MCSymbol *RangesSectionSymbol = nullptr;
1143 
1144  // Create end symbols for each section, and remove empty sections
1145  MCOS->getContext().finalizeDwarfSections(*MCOS);
1146 
1147  // If there are no sections to generate debug info for, we don't need
1148  // to do anything
1149  if (MCOS->getContext().getGenDwarfSectionSyms().empty())
1150  return;
1151 
1152  // We only use the .debug_ranges section if we have multiple code sections,
1153  // and we are emitting a DWARF version which supports it.
1154  const bool UseRangesSection =
1155  MCOS->getContext().getGenDwarfSectionSyms().size() > 1 &&
1156  MCOS->getContext().getDwarfVersion() >= 3;
1157  CreateDwarfSectionSymbols |= UseRangesSection;
1158 
1160  if (CreateDwarfSectionSymbols) {
1161  InfoSectionSymbol = context.createTempSymbol();
1162  MCOS->EmitLabel(InfoSectionSymbol);
1163  }
1165  if (CreateDwarfSectionSymbols) {
1166  AbbrevSectionSymbol = context.createTempSymbol();
1167  MCOS->EmitLabel(AbbrevSectionSymbol);
1168  }
1169  if (UseRangesSection) {
1171  if (CreateDwarfSectionSymbols) {
1172  RangesSectionSymbol = context.createTempSymbol();
1173  MCOS->EmitLabel(RangesSectionSymbol);
1174  }
1175  }
1176 
1177  assert((RangesSectionSymbol != nullptr) || !UseRangesSection);
1178 
1180 
1181  // Output the data for .debug_aranges section.
1182  EmitGenDwarfAranges(MCOS, InfoSectionSymbol);
1183 
1184  if (UseRangesSection)
1185  EmitGenDwarfRanges(MCOS);
1186 
1187  // Output the data for .debug_abbrev section.
1188  EmitGenDwarfAbbrev(MCOS);
1189 
1190  // Output the data for .debug_info section.
1191  EmitGenDwarfInfo(MCOS, AbbrevSectionSymbol, LineSectionSymbol,
1192  RangesSectionSymbol);
1193 }
1194 
1195 //
1196 // When generating dwarf for assembly source files this is called when symbol
1197 // for a label is created. If this symbol is not a temporary and is in the
1198 // section that dwarf is being generated for, save the needed info to create
1199 // a dwarf label.
1200 //
1202  SourceMgr &SrcMgr, SMLoc &Loc) {
1203  // We won't create dwarf labels for temporary symbols.
1204  if (Symbol->isTemporary())
1205  return;
1206  MCContext &context = MCOS->getContext();
1207  // We won't create dwarf labels for symbols in sections that we are not
1208  // generating debug info for.
1209  if (!context.getGenDwarfSectionSyms().count(MCOS->getCurrentSectionOnly()))
1210  return;
1211 
1212  // The dwarf label's name does not have the symbol name's leading
1213  // underbar if any.
1214  StringRef Name = Symbol->getName();
1215  if (Name.startswith("_"))
1216  Name = Name.substr(1, Name.size()-1);
1217 
1218  // Get the dwarf file number to be used for the dwarf label.
1219  unsigned FileNumber = context.getGenDwarfFileNumber();
1220 
1221  // Finding the line number is the expensive part which is why we just don't
1222  // pass it in as for some symbols we won't create a dwarf label.
1223  unsigned CurBuffer = SrcMgr.FindBufferContainingLoc(Loc);
1224  unsigned LineNumber = SrcMgr.FindLineNumber(Loc, CurBuffer);
1225 
1226  // We create a temporary symbol for use for the AT_high_pc and AT_low_pc
1227  // values so that they don't have things like an ARM thumb bit from the
1228  // original symbol. So when used they won't get a low bit set after
1229  // relocation.
1230  MCSymbol *Label = context.createTempSymbol();
1231  MCOS->EmitLabel(Label);
1232 
1233  // Create and entry for the info and add it to the other entries.
1235  MCGenDwarfLabelEntry(Name, FileNumber, LineNumber, Label));
1236 }
1237 
1238 static int getDataAlignmentFactor(MCStreamer &streamer) {
1239  MCContext &context = streamer.getContext();
1240  const MCAsmInfo *asmInfo = context.getAsmInfo();
1241  int size = asmInfo->getCalleeSaveStackSlotSize();
1242  if (asmInfo->isStackGrowthDirectionUp())
1243  return size;
1244  else
1245  return -size;
1246 }
1247 
1248 static unsigned getSizeForEncoding(MCStreamer &streamer,
1249  unsigned symbolEncoding) {
1250  MCContext &context = streamer.getContext();
1251  unsigned format = symbolEncoding & 0x0f;
1252  switch (format) {
1253  default: llvm_unreachable("Unknown Encoding");
1256  return context.getAsmInfo()->getCodePointerSize();
1259  return 2;
1262  return 4;
1265  return 8;
1266  }
1267 }
1268 
1269 static void emitFDESymbol(MCObjectStreamer &streamer, const MCSymbol &symbol,
1270  unsigned symbolEncoding, bool isEH) {
1271  MCContext &context = streamer.getContext();
1272  const MCAsmInfo *asmInfo = context.getAsmInfo();
1273  const MCExpr *v = asmInfo->getExprForFDESymbol(&symbol,
1274  symbolEncoding,
1275  streamer);
1276  unsigned size = getSizeForEncoding(streamer, symbolEncoding);
1277  if (asmInfo->doDwarfFDESymbolsUseAbsDiff() && isEH)
1278  emitAbsValue(streamer, v, size);
1279  else
1280  streamer.EmitValue(v, size);
1281 }
1282 
1283 static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol,
1284  unsigned symbolEncoding) {
1285  MCContext &context = streamer.getContext();
1286  const MCAsmInfo *asmInfo = context.getAsmInfo();
1287  const MCExpr *v = asmInfo->getExprForPersonalitySymbol(&symbol,
1288  symbolEncoding,
1289  streamer);
1290  unsigned size = getSizeForEncoding(streamer, symbolEncoding);
1291  streamer.EmitValue(v, size);
1292 }
1293 
1294 namespace {
1295 
1296 class FrameEmitterImpl {
1297  int CFAOffset = 0;
1298  int InitialCFAOffset = 0;
1299  bool IsEH;
1300  MCObjectStreamer &Streamer;
1301 
1302 public:
1303  FrameEmitterImpl(bool IsEH, MCObjectStreamer &Streamer)
1304  : IsEH(IsEH), Streamer(Streamer) {}
1305 
1306  /// Emit the unwind information in a compact way.
1307  void EmitCompactUnwind(const MCDwarfFrameInfo &frame);
1308 
1309  const MCSymbol &EmitCIE(const MCDwarfFrameInfo &F);
1310  void EmitFDE(const MCSymbol &cieStart, const MCDwarfFrameInfo &frame,
1311  bool LastInSection, const MCSymbol &SectionStart);
1312  void EmitCFIInstructions(ArrayRef<MCCFIInstruction> Instrs,
1313  MCSymbol *BaseLabel);
1314  void EmitCFIInstruction(const MCCFIInstruction &Instr);
1315 };
1316 
1317 } // end anonymous namespace
1318 
1319 static void emitEncodingByte(MCObjectStreamer &Streamer, unsigned Encoding) {
1320  Streamer.EmitIntValue(Encoding, 1);
1321 }
1322 
1323 void FrameEmitterImpl::EmitCFIInstruction(const MCCFIInstruction &Instr) {
1324  int dataAlignmentFactor = getDataAlignmentFactor(Streamer);
1325  auto *MRI = Streamer.getContext().getRegisterInfo();
1326 
1327  switch (Instr.getOperation()) {
1329  unsigned Reg1 = Instr.getRegister();
1330  unsigned Reg2 = Instr.getRegister2();
1331  if (!IsEH) {
1332  Reg1 = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg1);
1333  Reg2 = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg2);
1334  }
1335  Streamer.EmitIntValue(dwarf::DW_CFA_register, 1);
1336  Streamer.EmitULEB128IntValue(Reg1);
1337  Streamer.EmitULEB128IntValue(Reg2);
1338  return;
1339  }
1341  Streamer.EmitIntValue(dwarf::DW_CFA_GNU_window_save, 1);
1342  return;
1343 
1345  Streamer.EmitIntValue(dwarf::DW_CFA_AARCH64_negate_ra_state, 1);
1346  return;
1347 
1349  unsigned Reg = Instr.getRegister();
1350  Streamer.EmitIntValue(dwarf::DW_CFA_undefined, 1);
1351  Streamer.EmitULEB128IntValue(Reg);
1352  return;
1353  }
1356  const bool IsRelative =
1358 
1359  Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
1360 
1361  if (IsRelative)
1362  CFAOffset += Instr.getOffset();
1363  else
1364  CFAOffset = -Instr.getOffset();
1365 
1366  Streamer.EmitULEB128IntValue(CFAOffset);
1367 
1368  return;
1369  }
1371  unsigned Reg = Instr.getRegister();
1372  if (!IsEH)
1373  Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
1374  Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
1375  Streamer.EmitULEB128IntValue(Reg);
1376  CFAOffset = -Instr.getOffset();
1377  Streamer.EmitULEB128IntValue(CFAOffset);
1378 
1379  return;
1380  }
1382  unsigned Reg = Instr.getRegister();
1383  if (!IsEH)
1384  Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
1385  Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
1386  Streamer.EmitULEB128IntValue(Reg);
1387 
1388  return;
1389  }
1392  const bool IsRelative =
1394 
1395  unsigned Reg = Instr.getRegister();
1396  if (!IsEH)
1397  Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
1398 
1399  int Offset = Instr.getOffset();
1400  if (IsRelative)
1401  Offset -= CFAOffset;
1402  Offset = Offset / dataAlignmentFactor;
1403 
1404  if (Offset < 0) {
1405  Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
1406  Streamer.EmitULEB128IntValue(Reg);
1407  Streamer.EmitSLEB128IntValue(Offset);
1408  } else if (Reg < 64) {
1409  Streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
1410  Streamer.EmitULEB128IntValue(Offset);
1411  } else {
1412  Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
1413  Streamer.EmitULEB128IntValue(Reg);
1414  Streamer.EmitULEB128IntValue(Offset);
1415  }
1416  return;
1417  }
1419  Streamer.EmitIntValue(dwarf::DW_CFA_remember_state, 1);
1420  return;
1422  Streamer.EmitIntValue(dwarf::DW_CFA_restore_state, 1);
1423  return;
1425  unsigned Reg = Instr.getRegister();
1426  Streamer.EmitIntValue(dwarf::DW_CFA_same_value, 1);
1427  Streamer.EmitULEB128IntValue(Reg);
1428  return;
1429  }
1431  unsigned Reg = Instr.getRegister();
1432  if (!IsEH)
1433  Reg = MRI->getDwarfRegNumFromDwarfEHRegNum(Reg);
1434  if (Reg < 64) {
1435  Streamer.EmitIntValue(dwarf::DW_CFA_restore | Reg, 1);
1436  } else {
1437  Streamer.EmitIntValue(dwarf::DW_CFA_restore_extended, 1);
1438  Streamer.EmitULEB128IntValue(Reg);
1439  }
1440  return;
1441  }
1443  Streamer.EmitIntValue(dwarf::DW_CFA_GNU_args_size, 1);
1444  Streamer.EmitULEB128IntValue(Instr.getOffset());
1445  return;
1446 
1448  Streamer.EmitBytes(Instr.getValues());
1449  return;
1450  }
1451  llvm_unreachable("Unhandled case in switch");
1452 }
1453 
1454 /// Emit frame instructions to describe the layout of the frame.
1455 void FrameEmitterImpl::EmitCFIInstructions(ArrayRef<MCCFIInstruction> Instrs,
1456  MCSymbol *BaseLabel) {
1457  for (const MCCFIInstruction &Instr : Instrs) {
1458  MCSymbol *Label = Instr.getLabel();
1459  // Throw out move if the label is invalid.
1460  if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
1461 
1462  // Advance row if new location.
1463  if (BaseLabel && Label) {
1464  MCSymbol *ThisSym = Label;
1465  if (ThisSym != BaseLabel) {
1466  Streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
1467  BaseLabel = ThisSym;
1468  }
1469  }
1470 
1471  EmitCFIInstruction(Instr);
1472  }
1473 }
1474 
1475 /// Emit the unwind information in a compact way.
1476 void FrameEmitterImpl::EmitCompactUnwind(const MCDwarfFrameInfo &Frame) {
1477  MCContext &Context = Streamer.getContext();
1478  const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1479 
1480  // range-start range-length compact-unwind-enc personality-func lsda
1481  // _foo LfooEnd-_foo 0x00000023 0 0
1482  // _bar LbarEnd-_bar 0x00000025 __gxx_personality except_tab1
1483  //
1484  // .section __LD,__compact_unwind,regular,debug
1485  //
1486  // # compact unwind for _foo
1487  // .quad _foo
1488  // .set L1,LfooEnd-_foo
1489  // .long L1
1490  // .long 0x01010001
1491  // .quad 0
1492  // .quad 0
1493  //
1494  // # compact unwind for _bar
1495  // .quad _bar
1496  // .set L2,LbarEnd-_bar
1497  // .long L2
1498  // .long 0x01020011
1499  // .quad __gxx_personality
1500  // .quad except_tab1
1501 
1502  uint32_t Encoding = Frame.CompactUnwindEncoding;
1503  if (!Encoding) return;
1504  bool DwarfEHFrameOnly = (Encoding == MOFI->getCompactUnwindDwarfEHFrameOnly());
1505 
1506  // The encoding needs to know we have an LSDA.
1507  if (!DwarfEHFrameOnly && Frame.Lsda)
1508  Encoding |= 0x40000000;
1509 
1510  // Range Start
1511  unsigned FDEEncoding = MOFI->getFDEEncoding();
1512  unsigned Size = getSizeForEncoding(Streamer, FDEEncoding);
1513  Streamer.EmitSymbolValue(Frame.Begin, Size);
1514 
1515  // Range Length
1516  const MCExpr *Range = MakeStartMinusEndExpr(Streamer, *Frame.Begin,
1517  *Frame.End, 0);
1518  emitAbsValue(Streamer, Range, 4);
1519 
1520  // Compact Encoding
1521  Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_udata4);
1522  Streamer.EmitIntValue(Encoding, Size);
1523 
1524  // Personality Function
1525  Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_absptr);
1526  if (!DwarfEHFrameOnly && Frame.Personality)
1527  Streamer.EmitSymbolValue(Frame.Personality, Size);
1528  else
1529  Streamer.EmitIntValue(0, Size); // No personality fn
1530 
1531  // LSDA
1532  Size = getSizeForEncoding(Streamer, Frame.LsdaEncoding);
1533  if (!DwarfEHFrameOnly && Frame.Lsda)
1534  Streamer.EmitSymbolValue(Frame.Lsda, Size);
1535  else
1536  Streamer.EmitIntValue(0, Size); // No LSDA
1537 }
1538 
1539 static unsigned getCIEVersion(bool IsEH, unsigned DwarfVersion) {
1540  if (IsEH)
1541  return 1;
1542  switch (DwarfVersion) {
1543  case 2:
1544  return 1;
1545  case 3:
1546  return 3;
1547  case 4:
1548  case 5:
1549  return 4;
1550  }
1551  llvm_unreachable("Unknown version");
1552 }
1553 
1554 const MCSymbol &FrameEmitterImpl::EmitCIE(const MCDwarfFrameInfo &Frame) {
1555  MCContext &context = Streamer.getContext();
1556  const MCRegisterInfo *MRI = context.getRegisterInfo();
1557  const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1558 
1559  MCSymbol *sectionStart = context.createTempSymbol();
1560  Streamer.EmitLabel(sectionStart);
1561 
1562  MCSymbol *sectionEnd = context.createTempSymbol();
1563 
1564  // Length
1565  const MCExpr *Length =
1566  MakeStartMinusEndExpr(Streamer, *sectionStart, *sectionEnd, 4);
1567  emitAbsValue(Streamer, Length, 4);
1568 
1569  // CIE ID
1570  unsigned CIE_ID = IsEH ? 0 : -1;
1571  Streamer.EmitIntValue(CIE_ID, 4);
1572 
1573  // Version
1574  uint8_t CIEVersion = getCIEVersion(IsEH, context.getDwarfVersion());
1575  Streamer.EmitIntValue(CIEVersion, 1);
1576 
1577  if (IsEH) {
1578  SmallString<8> Augmentation;
1579  Augmentation += "z";
1580  if (Frame.Personality)
1581  Augmentation += "P";
1582  if (Frame.Lsda)
1583  Augmentation += "L";
1584  Augmentation += "R";
1585  if (Frame.IsSignalFrame)
1586  Augmentation += "S";
1587  if (Frame.IsBKeyFrame)
1588  Augmentation += "B";
1589  Streamer.EmitBytes(Augmentation);
1590  }
1591  Streamer.EmitIntValue(0, 1);
1592 
1593  if (CIEVersion >= 4) {
1594  // Address Size
1595  Streamer.EmitIntValue(context.getAsmInfo()->getCodePointerSize(), 1);
1596 
1597  // Segment Descriptor Size
1598  Streamer.EmitIntValue(0, 1);
1599  }
1600 
1601  // Code Alignment Factor
1602  Streamer.EmitULEB128IntValue(context.getAsmInfo()->getMinInstAlignment());
1603 
1604  // Data Alignment Factor
1605  Streamer.EmitSLEB128IntValue(getDataAlignmentFactor(Streamer));
1606 
1607  // Return Address Register
1608  unsigned RAReg = Frame.RAReg;
1609  if (RAReg == static_cast<unsigned>(INT_MAX))
1610  RAReg = MRI->getDwarfRegNum(MRI->getRARegister(), IsEH);
1611 
1612  if (CIEVersion == 1) {
1613  assert(RAReg <= 255 &&
1614  "DWARF 2 encodes return_address_register in one byte");
1615  Streamer.EmitIntValue(RAReg, 1);
1616  } else {
1617  Streamer.EmitULEB128IntValue(RAReg);
1618  }
1619 
1620  // Augmentation Data Length (optional)
1621  unsigned augmentationLength = 0;
1622  if (IsEH) {
1623  if (Frame.Personality) {
1624  // Personality Encoding
1625  augmentationLength += 1;
1626  // Personality
1627  augmentationLength +=
1628  getSizeForEncoding(Streamer, Frame.PersonalityEncoding);
1629  }
1630  if (Frame.Lsda)
1631  augmentationLength += 1;
1632  // Encoding of the FDE pointers
1633  augmentationLength += 1;
1634 
1635  Streamer.EmitULEB128IntValue(augmentationLength);
1636 
1637  // Augmentation Data (optional)
1638  if (Frame.Personality) {
1639  // Personality Encoding
1640  emitEncodingByte(Streamer, Frame.PersonalityEncoding);
1641  // Personality
1642  EmitPersonality(Streamer, *Frame.Personality, Frame.PersonalityEncoding);
1643  }
1644 
1645  if (Frame.Lsda)
1646  emitEncodingByte(Streamer, Frame.LsdaEncoding);
1647 
1648  // Encoding of the FDE pointers
1649  emitEncodingByte(Streamer, MOFI->getFDEEncoding());
1650  }
1651 
1652  // Initial Instructions
1653 
1654  const MCAsmInfo *MAI = context.getAsmInfo();
1655  if (!Frame.IsSimple) {
1656  const std::vector<MCCFIInstruction> &Instructions =
1657  MAI->getInitialFrameState();
1658  EmitCFIInstructions(Instructions, nullptr);
1659  }
1660 
1661  InitialCFAOffset = CFAOffset;
1662 
1663  // Padding
1664  Streamer.EmitValueToAlignment(IsEH ? 4 : MAI->getCodePointerSize());
1665 
1666  Streamer.EmitLabel(sectionEnd);
1667  return *sectionStart;
1668 }
1669 
1670 void FrameEmitterImpl::EmitFDE(const MCSymbol &cieStart,
1671  const MCDwarfFrameInfo &frame,
1672  bool LastInSection,
1673  const MCSymbol &SectionStart) {
1674  MCContext &context = Streamer.getContext();
1675  MCSymbol *fdeStart = context.createTempSymbol();
1676  MCSymbol *fdeEnd = context.createTempSymbol();
1677  const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1678 
1679  CFAOffset = InitialCFAOffset;
1680 
1681  // Length
1682  const MCExpr *Length = MakeStartMinusEndExpr(Streamer, *fdeStart, *fdeEnd, 0);
1683  emitAbsValue(Streamer, Length, 4);
1684 
1685  Streamer.EmitLabel(fdeStart);
1686 
1687  // CIE Pointer
1688  const MCAsmInfo *asmInfo = context.getAsmInfo();
1689  if (IsEH) {
1690  const MCExpr *offset =
1691  MakeStartMinusEndExpr(Streamer, cieStart, *fdeStart, 0);
1692  emitAbsValue(Streamer, offset, 4);
1693  } else if (!asmInfo->doesDwarfUseRelocationsAcrossSections()) {
1694  const MCExpr *offset =
1695  MakeStartMinusEndExpr(Streamer, SectionStart, cieStart, 0);
1696  emitAbsValue(Streamer, offset, 4);
1697  } else {
1698  Streamer.EmitSymbolValue(&cieStart, 4);
1699  }
1700 
1701  // PC Begin
1702  unsigned PCEncoding =
1704  unsigned PCSize = getSizeForEncoding(Streamer, PCEncoding);
1705  emitFDESymbol(Streamer, *frame.Begin, PCEncoding, IsEH);
1706 
1707  // PC Range
1708  const MCExpr *Range =
1709  MakeStartMinusEndExpr(Streamer, *frame.Begin, *frame.End, 0);
1710  emitAbsValue(Streamer, Range, PCSize);
1711 
1712  if (IsEH) {
1713  // Augmentation Data Length
1714  unsigned augmentationLength = 0;
1715 
1716  if (frame.Lsda)
1717  augmentationLength += getSizeForEncoding(Streamer, frame.LsdaEncoding);
1718 
1719  Streamer.EmitULEB128IntValue(augmentationLength);
1720 
1721  // Augmentation Data
1722  if (frame.Lsda)
1723  emitFDESymbol(Streamer, *frame.Lsda, frame.LsdaEncoding, true);
1724  }
1725 
1726  // Call Frame Instructions
1727  EmitCFIInstructions(frame.Instructions, frame.Begin);
1728 
1729  // Padding
1730  // The size of a .eh_frame section has to be a multiple of the alignment
1731  // since a null CIE is interpreted as the end. Old systems overaligned
1732  // .eh_frame, so we do too and account for it in the last FDE.
1733  unsigned Align = LastInSection ? asmInfo->getCodePointerSize() : PCSize;
1734  Streamer.EmitValueToAlignment(Align);
1735 
1736  Streamer.EmitLabel(fdeEnd);
1737 }
1738 
1739 namespace {
1740 
1741 struct CIEKey {
1742  static const CIEKey getEmptyKey() {
1743  return CIEKey(nullptr, 0, -1, false, false, static_cast<unsigned>(INT_MAX),
1744  false);
1745  }
1746 
1747  static const CIEKey getTombstoneKey() {
1748  return CIEKey(nullptr, -1, 0, false, false, static_cast<unsigned>(INT_MAX),
1749  false);
1750  }
1751 
1752  CIEKey(const MCSymbol *Personality, unsigned PersonalityEncoding,
1753  unsigned LSDAEncoding, bool IsSignalFrame, bool IsSimple,
1754  unsigned RAReg, bool IsBKeyFrame)
1755  : Personality(Personality), PersonalityEncoding(PersonalityEncoding),
1756  LsdaEncoding(LSDAEncoding), IsSignalFrame(IsSignalFrame),
1757  IsSimple(IsSimple), RAReg(RAReg), IsBKeyFrame(IsBKeyFrame) {}
1758 
1759  explicit CIEKey(const MCDwarfFrameInfo &Frame)
1760  : Personality(Frame.Personality),
1761  PersonalityEncoding(Frame.PersonalityEncoding),
1762  LsdaEncoding(Frame.LsdaEncoding), IsSignalFrame(Frame.IsSignalFrame),
1763  IsSimple(Frame.IsSimple), RAReg(Frame.RAReg),
1764  IsBKeyFrame(Frame.IsBKeyFrame) {}
1765 
1766  StringRef PersonalityName() const {
1767  if (!Personality)
1768  return StringRef();
1769  return Personality->getName();
1770  }
1771 
1772  bool operator<(const CIEKey &Other) const {
1773  return std::make_tuple(PersonalityName(), PersonalityEncoding, LsdaEncoding,
1774  IsSignalFrame, IsSimple, RAReg) <
1775  std::make_tuple(Other.PersonalityName(), Other.PersonalityEncoding,
1776  Other.LsdaEncoding, Other.IsSignalFrame,
1777  Other.IsSimple, Other.RAReg);
1778  }
1779 
1780  const MCSymbol *Personality;
1781  unsigned PersonalityEncoding;
1782  unsigned LsdaEncoding;
1783  bool IsSignalFrame;
1784  bool IsSimple;
1785  unsigned RAReg;
1786  bool IsBKeyFrame;
1787 };
1788 
1789 } // end anonymous namespace
1790 
1791 namespace llvm {
1792 
1793 template <> struct DenseMapInfo<CIEKey> {
1794  static CIEKey getEmptyKey() { return CIEKey::getEmptyKey(); }
1795  static CIEKey getTombstoneKey() { return CIEKey::getTombstoneKey(); }
1796 
1797  static unsigned getHashValue(const CIEKey &Key) {
1798  return static_cast<unsigned>(hash_combine(
1799  Key.Personality, Key.PersonalityEncoding, Key.LsdaEncoding,
1800  Key.IsSignalFrame, Key.IsSimple, Key.RAReg, Key.IsBKeyFrame));
1801  }
1802 
1803  static bool isEqual(const CIEKey &LHS, const CIEKey &RHS) {
1804  return LHS.Personality == RHS.Personality &&
1805  LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
1806  LHS.LsdaEncoding == RHS.LsdaEncoding &&
1807  LHS.IsSignalFrame == RHS.IsSignalFrame &&
1808  LHS.IsSimple == RHS.IsSimple && LHS.RAReg == RHS.RAReg &&
1809  LHS.IsBKeyFrame == RHS.IsBKeyFrame;
1810  }
1811 };
1812 
1813 } // end namespace llvm
1814 
1816  bool IsEH) {
1817  Streamer.generateCompactUnwindEncodings(MAB);
1818 
1819  MCContext &Context = Streamer.getContext();
1820  const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1821  const MCAsmInfo *AsmInfo = Context.getAsmInfo();
1822  FrameEmitterImpl Emitter(IsEH, Streamer);
1823  ArrayRef<MCDwarfFrameInfo> FrameArray = Streamer.getDwarfFrameInfos();
1824 
1825  // Emit the compact unwind info if available.
1826  bool NeedsEHFrameSection = !MOFI->getSupportsCompactUnwindWithoutEHFrame();
1827  if (IsEH && MOFI->getCompactUnwindSection()) {
1828  bool SectionEmitted = false;
1829  for (const MCDwarfFrameInfo &Frame : FrameArray) {
1830  if (Frame.CompactUnwindEncoding == 0) continue;
1831  if (!SectionEmitted) {
1832  Streamer.SwitchSection(MOFI->getCompactUnwindSection());
1833  Streamer.EmitValueToAlignment(AsmInfo->getCodePointerSize());
1834  SectionEmitted = true;
1835  }
1836  NeedsEHFrameSection |=
1837  Frame.CompactUnwindEncoding ==
1839  Emitter.EmitCompactUnwind(Frame);
1840  }
1841  }
1842 
1843  if (!NeedsEHFrameSection) return;
1844 
1845  MCSection &Section =
1846  IsEH ? *const_cast<MCObjectFileInfo *>(MOFI)->getEHFrameSection()
1847  : *MOFI->getDwarfFrameSection();
1848 
1849  Streamer.SwitchSection(&Section);
1850  MCSymbol *SectionStart = Context.createTempSymbol();
1851  Streamer.EmitLabel(SectionStart);
1852 
1854 
1855  const MCSymbol *DummyDebugKey = nullptr;
1856  bool CanOmitDwarf = MOFI->getOmitDwarfIfHaveCompactUnwind();
1857  // Sort the FDEs by their corresponding CIE before we emit them.
1858  // This isn't technically necessary according to the DWARF standard,
1859  // but the Android libunwindstack rejects eh_frame sections where
1860  // an FDE refers to a CIE other than the closest previous CIE.
1861  std::vector<MCDwarfFrameInfo> FrameArrayX(FrameArray.begin(), FrameArray.end());
1862  std::stable_sort(
1863  FrameArrayX.begin(), FrameArrayX.end(),
1864  [&](const MCDwarfFrameInfo &X, const MCDwarfFrameInfo &Y) -> bool {
1865  return CIEKey(X) < CIEKey(Y);
1866  });
1867  for (auto I = FrameArrayX.begin(), E = FrameArrayX.end(); I != E;) {
1868  const MCDwarfFrameInfo &Frame = *I;
1869  ++I;
1870  if (CanOmitDwarf && Frame.CompactUnwindEncoding !=
1872  // Don't generate an EH frame if we don't need one. I.e., it's taken care
1873  // of by the compact unwind encoding.
1874  continue;
1875 
1876  CIEKey Key(Frame);
1877  const MCSymbol *&CIEStart = IsEH ? CIEStarts[Key] : DummyDebugKey;
1878  if (!CIEStart)
1879  CIEStart = &Emitter.EmitCIE(Frame);
1880 
1881  Emitter.EmitFDE(*CIEStart, Frame, I == E, *SectionStart);
1882  }
1883 }
1884 
1886  uint64_t AddrDelta) {
1887  MCContext &Context = Streamer.getContext();
1888  SmallString<256> Tmp;
1889  raw_svector_ostream OS(Tmp);
1890  MCDwarfFrameEmitter::EncodeAdvanceLoc(Context, AddrDelta, OS);
1891  Streamer.EmitBytes(OS.str());
1892 }
1893 
1895  uint64_t AddrDelta,
1896  raw_ostream &OS) {
1897  // Scale the address delta by the minimum instruction length.
1898  AddrDelta = ScaleAddrDelta(Context, AddrDelta);
1899 
1902  if (AddrDelta == 0) {
1903  } else if (isUIntN(6, AddrDelta)) {
1904  uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
1905  OS << Opcode;
1906  } else if (isUInt<8>(AddrDelta)) {
1907  OS << uint8_t(dwarf::DW_CFA_advance_loc1);
1908  OS << uint8_t(AddrDelta);
1909  } else if (isUInt<16>(AddrDelta)) {
1910  OS << uint8_t(dwarf::DW_CFA_advance_loc2);
1911  support::endian::write<uint16_t>(OS, AddrDelta, E);
1912  } else {
1913  assert(isUInt<32>(AddrDelta));
1914  OS << uint8_t(dwarf::DW_CFA_advance_loc4);
1915  support::endian::write<uint32_t>(OS, AddrDelta, E);
1916  }
1917 }
static const MCExpr * forceExpAbs(MCStreamer &OS, const MCExpr *Expr)
Definition: MCDwarf.cpp:294
const MCAsmInfo * getAsmInfo() const
Definition: MCContext.h:292
void addMCGenDwarfLabelEntry(const MCGenDwarfLabelEntry &E)
Definition: MCContext.h:615
constexpr bool isUInt< 32 >(uint64_t x)
Definition: MathExtras.h:348
Instances of this class represent a uniqued identifier for a section in the current translation unit...
Definition: MCSection.h:38
constexpr char Align[]
Key for Kernel::Arg::Metadata::mAlign.
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
static int getDataAlignmentFactor(MCStreamer &streamer)
Definition: MCDwarf.cpp:1238
unsigned FindBufferContainingLoc(SMLoc Loc) const
Return the ID of the buffer containing the specified location.
Definition: SourceMgr.cpp:61
void EmitBytes(StringRef Data) override
Emit the bytes in Data into the output.
LLVMContext & Context
static CIEKey getTombstoneKey()
Definition: MCDwarf.cpp:1795
#define DWARF2_FLAG_PROLOGUE_END
Definition: MCDwarf.h:81
static void Make(MCObjectStreamer *MCOS, MCSection *Section)
Definition: MCDwarf.cpp:87
static const MCSymbolRefExpr * create(const MCSymbol *Symbol, MCContext &Ctx)
Definition: MCExpr.h:319
Optional< StringRef > Source
The source code of the file.
Definition: MCDwarf.h:62
This class represents lattice values for constants.
Definition: AllocatorList.h:23
void EmitSymbolValue(const MCSymbol *Sym, unsigned Size, bool IsSectionRelative=false)
Special case of EmitValue that avoids the client having to pass in a MCExpr for MCSymbols.
Definition: MCStreamer.cpp:158
MCSection * getDwarfLineSection() const
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
iterator begin() const
Definition: ArrayRef.h:136
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
LLVM_NODISCARD bool startswith(StringRef Prefix) const
Check if this string starts with the given Prefix.
Definition: StringRef.h:256
static bool FixedEncode(MCContext &Context, MCDwarfLineTableParams Params, int64_t LineDelta, uint64_t AddrDelta, raw_ostream &OS, uint32_t *Offset, uint32_t *Size)
Utility function to encode a Dwarf pair of LineDelta and AddrDeltas using fixed length operands...
Definition: MCDwarf.cpp:734
const SmallVectorImpl< MCDwarfFile > & getMCDwarfFiles(unsigned CUID=0)
Definition: MCContext.h:533
SourceMgr SrcMgr
Definition: Error.cpp:23
virtual void EmitBytes(StringRef Data)
Emit the bytes in Data into the output.
unsigned Reg
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition: Format.h:123
bool needsDwarfSectionOffsetDirective() const
Definition: MCAsmInfo.h:466
static void EmitAdvanceLoc(MCObjectStreamer &Streamer, uint64_t AddrDelta)
Definition: MCDwarf.cpp:1885
MCSection * getDwarfLineStrSection() const
A raw_ostream that writes to an SmallVector or SmallString.
Definition: raw_ostream.h:509
F(f)
MCSection * getDwarfARangesSection() const
MCDwarfLineStr(MCContext &Ctx)
Construct an instance that can emit .debug_line_str (for use in a normal v5 line table).
Definition: MCDwarf.cpp:57
uint16_t getDwarfVersion() const
Definition: MCContext.h:631
#define op(i)
static void Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params, int64_t LineDelta, uint64_t AddrDelta)
Utility function to emit the encoding to a streamer.
Definition: MCDwarf.cpp:636
virtual MCSymbol * getDwarfLineTableSymbol(unsigned CUID)
Definition: MCStreamer.cpp:239
bool getSupportsCompactUnwindWithoutEHFrame() const
static void EmitGenDwarfInfo(MCStreamer *MCOS, const MCSymbol *AbbrevSectionSymbol, const MCSymbol *LineSectionSymbol, const MCSymbol *RangesSectionSymbol)
Definition: MCDwarf.cpp:919
unsigned LsdaEncoding
Definition: MCDwarf.h:598
StringRef getDwarfDebugFlags()
Definition: MCContext.h:620
std::vector< MCDwarfLineEntry > MCDwarfLineEntryCollection
Definition: MCDwarf.h:181
static void Encode(MCContext &Context, MCDwarfLineTableParams Params, int64_t LineDelta, uint64_t AddrDelta, raw_ostream &OS)
Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
Definition: MCDwarf.cpp:652
void EmitDwarfAdvanceLineAddr(int64_t LineDelta, const MCSymbol *LastLabel, const MCSymbol *Label, unsigned PointerSize)
std::vector< MCCFIInstruction > Instructions
Definition: MCDwarf.h:595
static GCMetadataPrinterRegistry::Add< OcamlGCMetadataPrinter > Y("ocaml", "ocaml 3.10-compatible collector")
const std::vector< MCGenDwarfLabelEntry > & getMCGenDwarfLabelEntries() const
Definition: MCContext.h:611
MCContext & getContext() const
Definition: MCStreamer.h:250
#define DWARF2_FLAG_IS_STMT
Definition: MCDwarf.h:79
StringRef getDwarfDebugProducer()
Definition: MCContext.h:623
std::string Name
Definition: MCDwarf.h:51
virtual const MCExpr * getExprForPersonalitySymbol(const MCSymbol *Sym, unsigned Encoding, MCStreamer &Streamer) const
Definition: MCAsmInfo.cpp:78
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:80
ArrayRef< T > makeArrayRef(const T &OneElt)
Construct an ArrayRef from a single element.
Definition: ArrayRef.h:450
ABS - Determine the unsigned absolute value of a signed integer value of the same bitwidth...
Definition: ISDOpcodes.h:392
void finalizeDwarfSections(MCStreamer &MCOS)
Remove empty sections from SectionsForRanges, to avoid generating useless debug info for them...
Definition: MCContext.cpp:624
Base class for the full range of assembler expressions which are needed for parsing.
Definition: MCExpr.h:35
#define INT64_MAX
Definition: DataTypes.h:77
MCSymbol * Begin
Definition: MCDwarf.h:591
uint8_t DWARF2LineRange
Range of line offsets in a special line info. opcode.
Definition: MCDwarf.h:207
const MCSymbol * Lsda
Definition: MCDwarf.h:594
int getDwarfRegNum(unsigned RegNum, bool isEH) const
Map a target register to an equivalent dwarf register number.
Tagged union holding either a T or a Error.
Definition: CachePruning.h:22
unsigned getCompactUnwindDwarfEHFrameOnly() const
static void emitFDESymbol(MCObjectStreamer &streamer, const MCSymbol &symbol, unsigned symbolEncoding, bool isEH)
Definition: MCDwarf.cpp:1269
LLVM_NODISCARD StringRef substr(size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N).
Definition: StringRef.h:578
MCDwarfLineTable & getMCDwarfLineTable(unsigned CUID)
Definition: MCContext.h:523
LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:126
MCSection * getDwarfFrameSection() const
ELFYAML::ELF_STO Other
Definition: ELFYAML.cpp:838
const SmallVectorImpl< std::string > & getMCDwarfDirs(unsigned CUID=0)
Definition: MCContext.h:537
bool hasAggressiveSymbolFolding() const
Definition: MCAsmInfo.h:527
bool getOmitDwarfIfHaveCompactUnwind() const
virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value)
Emit an assignment of Value to Symbol.
Definition: MCStreamer.cpp:911
StringRef str() const
Explicit conversion to StringRef.
Definition: SmallString.h:266
Context object for machine code objects.
Definition: MCContext.h:62
Key
PAL metadata keys.
static void EmitGenDwarfAbbrev(MCStreamer *MCOS)
Definition: MCDwarf.cpp:793
void write(raw_ostream &OS) const
Utility for building string tables with deduplicated suffixes.
unsigned getDwarfCompileUnitID()
Definition: MCContext.h:548
size_t add(CachedHashStringRef S)
Add a string to the builder.
const std::map< unsigned, MCDwarfLineTable > & getMCDwarfLineTables() const
Definition: MCContext.h:519
Streaming object file generation interface.
bool doesDwarfUseRelocationsAcrossSections() const
Definition: MCAsmInfo.h:589
Instances of this class represent the information from a dwarf .loc directive.
Definition: MCDwarf.h:67
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
MCSection * getCompactUnwindSection() const
LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:130
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition: SmallString.h:25
virtual void EmitBinaryData(StringRef Data)
Functionally identical to EmitBytes.
unsigned getGenDwarfFileNumber()
Definition: MCContext.h:591
virtual void EmitIntValue(uint64_t Value, unsigned Size)
Special case of EmitValue that avoids the client having to pass in a MCExpr for constant integers...
Definition: MCStreamer.cpp:123
MCSymbol * getLabel() const
Definition: MCDwarf.h:560
void EmitValue(const MCExpr *Value, unsigned Size, SMLoc Loc=SMLoc())
Definition: MCStreamer.cpp:154
MCSection * getDwarfAbbrevSection() const
static const MCBinaryExpr * create(Opcode Op, const MCExpr *LHS, const MCExpr *RHS, MCContext &Ctx, SMLoc Loc=SMLoc())
Definition: MCExpr.cpp:152
MCRegisterInfo base class - We assume that the target defines a static array of MCRegisterDesc object...
This class is intended to be used as a base class for asm properties and features specific to the tar...
Definition: MCAsmInfo.h:55
static uint64_t SpecialAddr(MCDwarfLineTableParams Params, uint64_t op)
Given a special op, return the address skip amount (in units of DWARF2_LINE_MIN_INSN_LENGTH).
Definition: MCDwarf.cpp:647
static unsigned getSizeForEncoding(MCStreamer &streamer, unsigned symbolEncoding)
Definition: MCDwarf.cpp:1248
Streaming machine code generation interface.
Definition: MCStreamer.h:188
static unsigned getCIEVersion(bool IsEH, unsigned DwarfVersion)
Definition: MCDwarf.cpp:1539
static void EmitAbbrev(MCStreamer *MCOS, uint64_t Name, uint64_t Form)
Definition: MCDwarf.cpp:786
MCSymbol * createTempSymbol(bool CanBeUnnamed=true)
Create and return a new assembler temporary symbol with a unique but unspecified name.
Definition: MCContext.cpp:220
uint8_t DWARF2LineOpcodeBase
First special line opcode - leave room for the standard opcodes.
Definition: MCDwarf.h:202
* if(!EatIfPresent(lltok::kw_thread_local)) return false
ParseOptionalThreadLocal := /*empty.
constexpr bool isUInt< 8 >(uint64_t x)
Definition: MathExtras.h:342
unsigned const MachineRegisterInfo * MRI
void EmitLabel(MCSymbol *Symbol, SMLoc Loc=SMLoc()) override
Emit a label for Symbol into the current section.
unsigned getRegister2() const
Definition: MCDwarf.h:570
void finalizeInOrder()
Finalize the string table without reording it.
#define DWARF2_FLAG_EPILOGUE_BEGIN
Definition: MCDwarf.h:82
Instrumentation for Order File
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:148
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
virtual void SwitchSection(MCSection *Section, const MCExpr *Subsection=nullptr)
Set the current section where code is being emitted to Section.
static void emitAbsValue(MCStreamer &OS, const MCExpr *Value, unsigned Size)
Definition: MCDwarf.cpp:305
unsigned getFDEEncoding() const
static void EmitDwarfLineTable(MCObjectStreamer *MCOS, MCSection *Section, const MCLineSection::MCDwarfLineEntryCollection &LineEntries)
Definition: MCDwarf.cpp:150
int getOffset() const
Definition: MCDwarf.h:575
static void EmitGenDwarfAranges(MCStreamer *MCOS, const MCSymbol *InfoSectionSymbol)
Definition: MCDwarf.cpp:848
bool isTemporary() const
isTemporary - Check if this is an assembler temporary symbol.
Definition: MCSymbol.h:219
OpType getOperation() const
Definition: MCDwarf.h:559
const MCObjectFileInfo * getObjectFileInfo() const
Definition: MCContext.h:296
#define DWARF2_FLAG_BASIC_BLOCK
Definition: MCDwarf.h:80
const MCDwarfFile & getRootFile() const
Definition: MCDwarf.h:323
bool doDwarfFDESymbolsUseAbsDiff() const
Definition: MCAsmInfo.h:593
const MCDwarfLoc & getCurrentDwarfLoc()
Definition: MCContext.h:587
StringRef parent_path(StringRef path, Style style=Style::native)
Get parent path.
Definition: Path.cpp:465
unsigned PersonalityEncoding
Definition: MCDwarf.h:597
This owns the files read by a parser, handles include stacks, and handles diagnostic wrangling...
Definition: SourceMgr.h:41
static void emitOneV5FileEntry(MCStreamer *MCOS, const MCDwarfFile &DwarfFile, bool EmitMD5, bool HasSource, Optional< MCDwarfLineStr > &LineStr)
Definition: MCDwarf.cpp:352
StringRef getValues() const
Definition: MCDwarf.h:582
StringRef toStringRef(bool B)
Construct a string ref from a boolean.
Definition: StringExtras.h:52
size_t size() const
Definition: SmallVector.h:52
int8_t DWARF2LineBase
Minimum line offset in a special line info.
Definition: MCDwarf.h:205
StringRef get_separator(Style style=Style::native)
Return the preferred separator for this platform.
Definition: Path.cpp:600
void generateCompactUnwindEncodings(MCAsmBackend *MAB)
Definition: MCStreamer.cpp:115
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
void clearDwarfLocSeen()
Definition: MCContext.h:584
unsigned getULEB128Size(uint64_t Value)
Utility function to get the size of the ULEB128-encoded value.
Definition: LEB128.cpp:19
void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value=0, unsigned ValueSize=1, unsigned MaxBytesToEmit=0) override
Emit some number of copies of Value until the byte alignment ByteAlignment is reached.
raw_ostream & write(unsigned char C)
StringRef getCompilationDir() const
Get the compilation directory for DW_AT_comp_dir The compilation directory should be set with setComp...
Definition: MCContext.h:486
unsigned getRegister() const
Definition: MCDwarf.h:562
const SetVector< MCSection * > & getGenDwarfSectionSyms()
Definition: MCContext.h:601
const std::vector< MCCFIInstruction > & getInitialFrameState() const
Definition: MCAsmInfo.h:604
void Emit(MCStreamer &MCOS, MCDwarfLineTableParams Params, MCSection *Section) const
Definition: MCDwarf.cpp:260
auto size(R &&Range, typename std::enable_if< std::is_same< typename std::iterator_traits< decltype(Range.begin())>::iterator_category, std::random_access_iterator_tag >::value, void >::type *=nullptr) -> decltype(std::distance(Range.begin(), Range.end()))
Get the size of a range.
Definition: STLExtras.h:1166
static unsigned getHashValue(const CIEKey &Key)
Definition: MCDwarf.cpp:1797
void EmitCU(MCObjectStreamer *MCOS, MCDwarfLineTableParams Params, Optional< MCDwarfLineStr > &LineStr) const
Definition: MCDwarf.cpp:523
unsigned encodeULEB128(uint64_t Value, raw_ostream &OS, unsigned PadTo=0)
Utility function to encode a ULEB128 value to an output stream.
Definition: LEB128.h:80
Expected< unsigned > tryGetFile(StringRef &Directory, StringRef &FileName, MD5::MD5Result *Checksum, Optional< StringRef > Source, unsigned FileNumber=0)
Definition: MCDwarf.cpp:537
unsigned encodeSLEB128(int64_t Value, raw_ostream &OS, unsigned PadTo=0)
Utility function to encode a SLEB128 value to an output stream.
Definition: LEB128.h:23
unsigned getMinInstAlignment() const
Definition: MCAsmInfo.h:477
constexpr size_t array_lengthof(T(&)[N])
Find the length of an array.
Definition: STLExtras.h:1043
static bool isEqual(const CIEKey &LHS, const CIEKey &RHS)
Definition: MCDwarf.cpp:1803
iterator end() const
Definition: ArrayRef.h:137
MCSymbol * getBeginSymbol()
Definition: MCSection.h:109
StringRef str()
Return a StringRef for the vector contents.
Definition: raw_ostream.h:534
static void EncodeAdvanceLoc(MCContext &Context, uint64_t AddrDelta, raw_ostream &OS)
Definition: MCDwarf.cpp:1894
MCSection * getDwarfInfoSection() const
void EmitULEB128IntValue(uint64_t Value, unsigned PadTo=0)
Special case of EmitULEB128Value that avoids the client having to pass in a MCExpr for constant integ...
Definition: MCStreamer.cpp:138
uint32_t CompactUnwindEncoding
Definition: MCDwarf.h:599
static void EmitGenDwarfRanges(MCStreamer *MCOS)
Definition: MCDwarf.cpp:1093
bool getDwarfLocSeen()
Definition: MCContext.h:586
This file contains constants used for implementing Dwarf debug support.
bool isDefined() const
isDefined - Check if this symbol is defined (i.e., it has an address).
Definition: MCSymbol.h:247
MCSection * getCurrentSectionOnly() const
Definition: MCStreamer.h:345
static CIEKey getEmptyKey()
Definition: MCDwarf.cpp:1794
hash_code hash_combine(const Ts &...args)
Combine values into a single hash_code.
Definition: Hashing.h:600
static void Emit(MCStreamer *MCOS)
Definition: MCDwarf.cpp:1130
iterator insert(iterator I, T &&Elt)
Definition: SmallVector.h:471
#define DWARF2_LINE_DEFAULT_IS_STMT
Definition: MCDwarf.h:77
unsigned FindLineNumber(SMLoc Loc, unsigned BufferID=0) const
Find the line number for the specified location in the specified file.
Definition: SourceMgr.h:176
bool isStackGrowthDirectionUp() const
True if target stack grow up.
Definition: MCAsmInfo.h:407
static uint64_t ScaleAddrDelta(MCContext &Context, uint64_t AddrDelta)
Definition: MCDwarf.cpp:71
Instances of this class represent the line information for the dwarf line table entries.
Definition: MCDwarf.h:150
static void Emit(MCObjectStreamer *MCOS, MCDwarfLineTableParams Params)
Definition: MCDwarf.cpp:232
static const MCExpr * MakeStartMinusEndExpr(const MCStreamer &MCOS, const MCSymbol &Start, const MCSymbol &End, int IntVal)
Definition: MCDwarf.cpp:115
pointer data()
Return a pointer to the vector&#39;s buffer, even if empty().
Definition: SmallVector.h:144
static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol, unsigned symbolEncoding)
Definition: MCDwarf.cpp:1283
StringRef filename(StringRef path, Style style=Style::native)
Get filename.
Definition: Path.cpp:564
static void Make(MCSymbol *Symbol, MCStreamer *MCOS, SourceMgr &SrcMgr, SMLoc &Loc)
Definition: MCDwarf.cpp:1201
LLVM_NODISCARD bool empty() const
Definition: SmallVector.h:55
const MCSymbol * Personality
Definition: MCDwarf.h:593
#define I(x, y, z)
Definition: MD5.cpp:58
static const MCExpr * makeStartPlusIntExpr(MCContext &Ctx, const MCSymbol &Start, int IntVal)
Definition: MCDwarf.cpp:137
unsigned getCalleeSaveStackSlotSize() const
Get the callee-saved register stack slot size in bytes.
Definition: MCAsmInfo.h:399
uint32_t Size
Definition: Profile.cpp:46
bool isLittleEndian() const
True if the target is little endian.
Definition: MCAsmInfo.h:404
Manage the .debug_line_str section contents, if we use it.
Definition: MCDwarf.cpp:49
constexpr bool isUInt< 16 >(uint64_t x)
Definition: MathExtras.h:345
void emitFill(uint64_t NumBytes, uint8_t FillValue)
Emit NumBytes bytes worth of the value specified by FillValue.
Definition: MCStreamer.cpp:195
MD5::MD5Result * Checksum
The MD5 checksum, if there is one.
Definition: MCDwarf.h:58
unsigned getRARegister() const
This method should return the register where the return address can be found.
MCSymbol * endSection(MCSection *Section)
unsigned DirIndex
Definition: MCDwarf.h:54
StringRef getName() const
getName - Get the symbol name.
Definition: MCSymbol.h:202
unsigned getCodePointerSize() const
Get the code pointer size in bytes.
Definition: MCAsmInfo.h:395
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
void emitRef(MCStreamer *MCOS, StringRef Path)
Emit a reference to the string.
Definition: MCDwarf.cpp:322
std::array< uint8_t, 16 > Bytes
Definition: MD5.h:56
bool operator<(int64_t V1, const APSInt &V2)
Definition: APSInt.h:325
const MCRegisterInfo * getRegisterInfo() const
Definition: MCContext.h:294
LLVM Value Representation.
Definition: Value.h:72
Generic interface to target specific assembler backends.
Definition: MCAsmBackend.h:41
ArrayRef< MCDwarfFrameInfo > getDwarfFrameInfos() const
Definition: MCStreamer.h:270
virtual void EmitLabel(MCSymbol *Symbol, SMLoc Loc=SMLoc())
Emit a label for Symbol into the current section.
Definition: MCStreamer.cpp:346
uint64_t tell() const
tell - Return the current offset with the file.
Definition: raw_ostream.h:99
static void emitEncodingByte(MCObjectStreamer &Streamer, unsigned Encoding)
Definition: MCDwarf.cpp:1319
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:45
Subtraction.
Definition: MCExpr.h:437
void emitSection(MCStreamer *MCOS)
Emit the .debug_line_str section if appropriate.
Definition: MCDwarf.cpp:310
static void Emit(MCObjectStreamer &streamer, MCAsmBackend *MAB, bool isEH)
Definition: MCDwarf.cpp:1815
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
Instances of this class represent the name of the dwarf .file directive and its associated dwarf file...
Definition: MCDwarf.h:49
MCSection * getDwarfRangesSection() const
Represents a location in source code.
Definition: SMLoc.h:23
Expected< unsigned > tryGetFile(StringRef &Directory, StringRef &FileName, MD5::MD5Result *Checksum, Optional< StringRef > &Source, unsigned FileNumber=0)
Definition: MCDwarf.cpp:546
bool isUIntN(unsigned N, uint64_t x)
Checks if an unsigned integer fits into the given (dynamic) bit width.
Definition: MathExtras.h:392
static const MCConstantExpr * create(int64_t Value, MCContext &Ctx)
Definition: MCExpr.cpp:163
virtual const MCExpr * getExprForFDESymbol(const MCSymbol *Sym, unsigned Encoding, MCStreamer &Streamer) const
Definition: MCAsmInfo.cpp:85
std::pair< MCSymbol *, MCSymbol * > Emit(MCStreamer *MCOS, MCDwarfLineTableParams Params, Optional< MCDwarfLineStr > &LineStr) const
Definition: MCDwarf.cpp:270
std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition: Error.cpp:77
void resize(size_type N)
Definition: SmallVector.h:344