LLVM  7.0.0svn
DWARFDebugLine.cpp
Go to the documentation of this file.
1 //===- DWARFDebugLine.cpp -------------------------------------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
11 #include "llvm/ADT/Optional.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/SmallVector.h"
14 #include "llvm/ADT/StringRef.h"
18 #include "llvm/Support/Format.h"
19 #include "llvm/Support/Path.h"
20 #include "llvm/Support/WithColor.h"
22 #include <algorithm>
23 #include <cassert>
24 #include <cinttypes>
25 #include <cstdint>
26 #include <cstdio>
27 #include <utility>
28 
29 using namespace llvm;
30 using namespace dwarf;
31 
33 
34 namespace {
35 
36 struct ContentDescriptor {
39 };
40 
41 using ContentDescriptors = SmallVector<ContentDescriptor, 4>;
42 
43 } // end anonmyous namespace
44 
46  dwarf::LineNumberEntryFormat ContentType) {
47  switch (ContentType) {
48  case dwarf::DW_LNCT_timestamp:
49  HasModTime = true;
50  break;
51  case dwarf::DW_LNCT_size:
52  HasLength = true;
53  break;
54  case dwarf::DW_LNCT_MD5:
55  HasMD5 = true;
56  break;
57  case dwarf::DW_LNCT_LLVM_source:
58  HasSource = true;
59  break;
60  default:
61  // We only care about values we consider optional, and new values may be
62  // added in the vendor extension range, so we do not match exhaustively.
63  break;
64  }
65 }
66 
68 
70  TotalLength = PrologueLength = 0;
71  SegSelectorSize = 0;
72  MinInstLength = MaxOpsPerInst = DefaultIsStmt = LineBase = LineRange = 0;
73  OpcodeBase = 0;
75  ContentTypes = ContentTypeTracker();
76  StandardOpcodeLengths.clear();
77  IncludeDirectories.clear();
78  FileNames.clear();
79 }
80 
82  DIDumpOptions DumpOptions) const {
83  OS << "Line table prologue:\n"
84  << format(" total_length: 0x%8.8" PRIx64 "\n", TotalLength)
85  << format(" version: %u\n", getVersion());
86  if (getVersion() >= 5)
87  OS << format(" address_size: %u\n", getAddressSize())
88  << format(" seg_select_size: %u\n", SegSelectorSize);
89  OS << format(" prologue_length: 0x%8.8" PRIx64 "\n", PrologueLength)
90  << format(" min_inst_length: %u\n", MinInstLength)
91  << format(getVersion() >= 4 ? "max_ops_per_inst: %u\n" : "", MaxOpsPerInst)
92  << format(" default_is_stmt: %u\n", DefaultIsStmt)
93  << format(" line_base: %i\n", LineBase)
94  << format(" line_range: %u\n", LineRange)
95  << format(" opcode_base: %u\n", OpcodeBase);
96 
97  for (uint32_t I = 0; I != StandardOpcodeLengths.size(); ++I)
98  OS << format("standard_opcode_lengths[%s] = %u\n",
99  LNStandardString(I + 1).data(), StandardOpcodeLengths[I]);
100 
101  if (!IncludeDirectories.empty()) {
102  // DWARF v5 starts directory indexes at 0.
103  uint32_t DirBase = getVersion() >= 5 ? 0 : 1;
104  for (uint32_t I = 0; I != IncludeDirectories.size(); ++I) {
105  OS << format("include_directories[%3u] = ", I + DirBase);
106  IncludeDirectories[I].dump(OS, DumpOptions);
107  OS << '\n';
108  }
109  }
110 
111  if (!FileNames.empty()) {
112  // DWARF v5 starts file indexes at 0.
113  uint32_t FileBase = getVersion() >= 5 ? 0 : 1;
114  for (uint32_t I = 0; I != FileNames.size(); ++I) {
115  const FileNameEntry &FileEntry = FileNames[I];
116  OS << format("file_names[%3u]:\n", I + FileBase);
117  OS << " name: ";
118  FileEntry.Name.dump(OS, DumpOptions);
119  OS << '\n'
120  << format(" dir_index: %" PRIu64 "\n", FileEntry.DirIdx);
121  if (ContentTypes.HasMD5)
122  OS << " md5_checksum: " << FileEntry.Checksum.digest() << '\n';
123  if (ContentTypes.HasModTime)
124  OS << format(" mod_time: 0x%8.8" PRIx64 "\n", FileEntry.ModTime);
125  if (ContentTypes.HasLength)
126  OS << format(" length: 0x%8.8" PRIx64 "\n", FileEntry.Length);
127  if (ContentTypes.HasSource) {
128  OS << " source: ";
129  FileEntry.Source.dump(OS, DumpOptions);
130  OS << '\n';
131  }
132  }
133  }
134 }
135 
136 // Parse v2-v4 directory and file tables.
137 static void
139  uint32_t *OffsetPtr, uint64_t EndPrologueOffset,
141  std::vector<DWARFFormValue> &IncludeDirectories,
142  std::vector<DWARFDebugLine::FileNameEntry> &FileNames) {
143  while (*OffsetPtr < EndPrologueOffset) {
144  StringRef S = DebugLineData.getCStrRef(OffsetPtr);
145  if (S.empty())
146  break;
147  DWARFFormValue Dir(dwarf::DW_FORM_string);
148  Dir.setPValue(S.data());
149  IncludeDirectories.push_back(Dir);
150  }
151 
152  while (*OffsetPtr < EndPrologueOffset) {
153  StringRef Name = DebugLineData.getCStrRef(OffsetPtr);
154  if (Name.empty())
155  break;
157  FileEntry.Name.setForm(dwarf::DW_FORM_string);
158  FileEntry.Name.setPValue(Name.data());
159  FileEntry.DirIdx = DebugLineData.getULEB128(OffsetPtr);
160  FileEntry.ModTime = DebugLineData.getULEB128(OffsetPtr);
161  FileEntry.Length = DebugLineData.getULEB128(OffsetPtr);
162  FileNames.push_back(FileEntry);
163  }
164 
165  ContentTypes.HasModTime = true;
166  ContentTypes.HasLength = true;
167 }
168 
169 // Parse v5 directory/file entry content descriptions.
170 // Returns the descriptors, or an empty vector if we did not find a path or
171 // ran off the end of the prologue.
172 static ContentDescriptors
174  *OffsetPtr, uint64_t EndPrologueOffset, DWARFDebugLine::ContentTypeTracker
175  *ContentTypes) {
176  ContentDescriptors Descriptors;
177  int FormatCount = DebugLineData.getU8(OffsetPtr);
178  bool HasPath = false;
179  for (int I = 0; I != FormatCount; ++I) {
180  if (*OffsetPtr >= EndPrologueOffset)
181  return ContentDescriptors();
182  ContentDescriptor Descriptor;
183  Descriptor.Type =
184  dwarf::LineNumberEntryFormat(DebugLineData.getULEB128(OffsetPtr));
185  Descriptor.Form = dwarf::Form(DebugLineData.getULEB128(OffsetPtr));
186  if (Descriptor.Type == dwarf::DW_LNCT_path)
187  HasPath = true;
188  if (ContentTypes)
189  ContentTypes->trackContentType(Descriptor.Type);
190  Descriptors.push_back(Descriptor);
191  }
192  return HasPath ? Descriptors : ContentDescriptors();
193 }
194 
195 static bool
197  uint32_t *OffsetPtr, uint64_t EndPrologueOffset,
199  const DWARFContext &Ctx, const DWARFUnit *U,
201  std::vector<DWARFFormValue> &IncludeDirectories,
202  std::vector<DWARFDebugLine::FileNameEntry> &FileNames) {
203  // Get the directory entry description.
204  ContentDescriptors DirDescriptors =
205  parseV5EntryFormat(DebugLineData, OffsetPtr, EndPrologueOffset, nullptr);
206  if (DirDescriptors.empty())
207  return false;
208 
209  // Get the directory entries, according to the format described above.
210  int DirEntryCount = DebugLineData.getU8(OffsetPtr);
211  for (int I = 0; I != DirEntryCount; ++I) {
212  if (*OffsetPtr >= EndPrologueOffset)
213  return false;
214  for (auto Descriptor : DirDescriptors) {
215  DWARFFormValue Value(Descriptor.Form);
216  switch (Descriptor.Type) {
217  case DW_LNCT_path:
218  if (!Value.extractValue(DebugLineData, OffsetPtr, FormParams, &Ctx, U))
219  return false;
220  IncludeDirectories.push_back(Value);
221  break;
222  default:
223  if (!Value.skipValue(DebugLineData, OffsetPtr, FormParams))
224  return false;
225  }
226  }
227  }
228 
229  // Get the file entry description.
230  ContentDescriptors FileDescriptors =
231  parseV5EntryFormat(DebugLineData, OffsetPtr, EndPrologueOffset,
232  &ContentTypes);
233  if (FileDescriptors.empty())
234  return false;
235 
236  // Get the file entries, according to the format described above.
237  int FileEntryCount = DebugLineData.getU8(OffsetPtr);
238  for (int I = 0; I != FileEntryCount; ++I) {
239  if (*OffsetPtr >= EndPrologueOffset)
240  return false;
242  for (auto Descriptor : FileDescriptors) {
243  DWARFFormValue Value(Descriptor.Form);
244  if (!Value.extractValue(DebugLineData, OffsetPtr, FormParams, &Ctx, U))
245  return false;
246  switch (Descriptor.Type) {
247  case DW_LNCT_path:
248  FileEntry.Name = Value;
249  break;
250  case DW_LNCT_LLVM_source:
251  FileEntry.Source = Value;
252  break;
253  case DW_LNCT_directory_index:
254  FileEntry.DirIdx = Value.getAsUnsignedConstant().getValue();
255  break;
256  case DW_LNCT_timestamp:
257  FileEntry.ModTime = Value.getAsUnsignedConstant().getValue();
258  break;
259  case DW_LNCT_size:
260  FileEntry.Length = Value.getAsUnsignedConstant().getValue();
261  break;
262  case DW_LNCT_MD5:
263  assert(Value.getAsBlock().getValue().size() == 16);
264  std::uninitialized_copy_n(Value.getAsBlock().getValue().begin(), 16,
265  FileEntry.Checksum.Bytes.begin());
266  break;
267  default:
268  break;
269  }
270  }
271  FileNames.push_back(FileEntry);
272  }
273  return true;
274 }
275 
276 template <typename... Ts>
277 static std::string formatErrorString(char const *Fmt, const Ts &... Vals) {
278  std::string Buffer;
279  raw_string_ostream Stream(Buffer);
280  Stream << format(Fmt, Vals...);
281  return Stream.str();
282 }
283 
284 template <typename... Ts>
285 static Error createError(char const *Fmt, const Ts &... Vals) {
286  return make_error<StringError>(formatErrorString(Fmt, Vals...),
288 }
289 
290 static Error createError(char const *Msg) {
291  return make_error<StringError>(Msg, inconvertibleErrorCode());
292 }
293 
295  uint32_t *OffsetPtr,
296  const DWARFContext &Ctx,
297  const DWARFUnit *U) {
298  const uint64_t PrologueOffset = *OffsetPtr;
299 
300  clear();
301  TotalLength = DebugLineData.getU32(OffsetPtr);
302  if (TotalLength == UINT32_MAX) {
304  TotalLength = DebugLineData.getU64(OffsetPtr);
305  } else if (TotalLength >= 0xffffff00) {
306  return createError(
307  "parsing line table prologue at offset 0x%8.8" PRIx64
308  " unsupported reserved unit length found of value 0x%8.8" PRIx64,
309  PrologueOffset, TotalLength);
310  }
311  FormParams.Version = DebugLineData.getU16(OffsetPtr);
312  if (getVersion() < 2)
313  return createError("parsing line table prologue at offset 0x%8.8" PRIx64
314  " found unsupported version 0x%2.2" PRIx16,
315  PrologueOffset, getVersion());
316 
317  if (getVersion() >= 5) {
318  FormParams.AddrSize = DebugLineData.getU8(OffsetPtr);
319  assert((DebugLineData.getAddressSize() == 0 ||
320  DebugLineData.getAddressSize() == getAddressSize()) &&
321  "Line table header and data extractor disagree");
322  SegSelectorSize = DebugLineData.getU8(OffsetPtr);
323  }
324 
325  PrologueLength = DebugLineData.getUnsigned(OffsetPtr, sizeofPrologueLength());
326  const uint64_t EndPrologueOffset = PrologueLength + *OffsetPtr;
327  MinInstLength = DebugLineData.getU8(OffsetPtr);
328  if (getVersion() >= 4)
329  MaxOpsPerInst = DebugLineData.getU8(OffsetPtr);
330  DefaultIsStmt = DebugLineData.getU8(OffsetPtr);
331  LineBase = DebugLineData.getU8(OffsetPtr);
332  LineRange = DebugLineData.getU8(OffsetPtr);
333  OpcodeBase = DebugLineData.getU8(OffsetPtr);
334 
335  StandardOpcodeLengths.reserve(OpcodeBase - 1);
336  for (uint32_t I = 1; I < OpcodeBase; ++I) {
337  uint8_t OpLen = DebugLineData.getU8(OffsetPtr);
338  StandardOpcodeLengths.push_back(OpLen);
339  }
340 
341  if (getVersion() >= 5) {
342  if (!parseV5DirFileTables(DebugLineData, OffsetPtr, EndPrologueOffset,
343  FormParams, Ctx, U, ContentTypes,
344  IncludeDirectories, FileNames)) {
345  return createError(
346  "parsing line table prologue at 0x%8.8" PRIx64
347  " found an invalid directory or file table description at"
348  " 0x%8.8" PRIx64,
349  PrologueOffset, (uint64_t)*OffsetPtr);
350  }
351  } else
352  parseV2DirFileTables(DebugLineData, OffsetPtr, EndPrologueOffset,
353  ContentTypes, IncludeDirectories, FileNames);
354 
355  if (*OffsetPtr != EndPrologueOffset)
356  return createError("parsing line table prologue at 0x%8.8" PRIx64
357  " should have ended at 0x%8.8" PRIx64
358  " but it ended at 0x%8.8" PRIx64,
359  PrologueOffset, EndPrologueOffset, (uint64_t)*OffsetPtr);
360  return Error::success();
361 }
362 
363 DWARFDebugLine::Row::Row(bool DefaultIsStmt) { reset(DefaultIsStmt); }
364 
366  BasicBlock = false;
367  PrologueEnd = false;
368  EpilogueBegin = false;
369 }
370 
371 void DWARFDebugLine::Row::reset(bool DefaultIsStmt) {
372  Address = 0;
373  Line = 1;
374  Column = 0;
375  File = 1;
376  Isa = 0;
377  Discriminator = 0;
378  IsStmt = DefaultIsStmt;
379  BasicBlock = false;
380  EndSequence = false;
381  PrologueEnd = false;
382  EpilogueBegin = false;
383 }
384 
386  OS << "Address Line Column File ISA Discriminator Flags\n"
387  << "------------------ ------ ------ ------ --- ------------- "
388  "-------------\n";
389 }
390 
392  OS << format("0x%16.16" PRIx64 " %6u %6u", Address, Line, Column)
393  << format(" %6u %3u %13u ", File, Isa, Discriminator)
394  << (IsStmt ? " is_stmt" : "") << (BasicBlock ? " basic_block" : "")
395  << (PrologueEnd ? " prologue_end" : "")
396  << (EpilogueBegin ? " epilogue_begin" : "")
397  << (EndSequence ? " end_sequence" : "") << '\n';
398 }
399 
401 
403  LowPC = 0;
404  HighPC = 0;
405  FirstRowIndex = 0;
406  LastRowIndex = 0;
407  Empty = true;
408 }
409 
411 
413  DIDumpOptions DumpOptions) const {
414  Prologue.dump(OS, DumpOptions);
415  OS << '\n';
416 
417  if (!Rows.empty()) {
418  Row::dumpTableHeader(OS);
419  for (const Row &R : Rows) {
420  R.dump(OS);
421  }
422  }
423 }
424 
426  Prologue.clear();
427  Rows.clear();
428  Sequences.clear();
429 }
430 
431 DWARFDebugLine::ParsingState::ParsingState(struct LineTable *LT)
432  : LineTable(LT) {
433  resetRowAndSequence();
434 }
435 
436 void DWARFDebugLine::ParsingState::resetRowAndSequence() {
438  Sequence.reset();
439 }
440 
441 void DWARFDebugLine::ParsingState::appendRowToMatrix(uint32_t Offset) {
442  if (Sequence.Empty) {
443  // Record the beginning of instruction sequence.
444  Sequence.Empty = false;
446  Sequence.FirstRowIndex = RowNumber;
447  }
448  ++RowNumber;
450  if (Row.EndSequence) {
451  // Record the end of instruction sequence.
453  Sequence.LastRowIndex = RowNumber;
454  if (Sequence.isValid())
456  Sequence.reset();
457  }
458  Row.postAppend();
459 }
460 
463  LineTableConstIter Pos = LineTableMap.find(Offset);
464  if (Pos != LineTableMap.end())
465  return &Pos->second;
466  return nullptr;
467 }
468 
470  DWARFDataExtractor &DebugLineData, uint32_t Offset, const DWARFContext &Ctx,
471  const DWARFUnit *U, std::function<void(Error)> RecoverableErrorCallback) {
472  if (!DebugLineData.isValidOffset(Offset))
473  return createError("offset 0x%8.8" PRIx32
474  " is not a valid debug line section offset",
475  Offset);
476 
477  std::pair<LineTableIter, bool> Pos =
478  LineTableMap.insert(LineTableMapTy::value_type(Offset, LineTable()));
479  LineTable *LT = &Pos.first->second;
480  if (Pos.second) {
481  if (Error Err =
482  LT->parse(DebugLineData, &Offset, Ctx, U, RecoverableErrorCallback))
483  return std::move(Err);
484  return LT;
485  }
486  return LT;
487 }
488 
490  DWARFDataExtractor &DebugLineData, uint32_t *OffsetPtr,
491  const DWARFContext &Ctx, const DWARFUnit *U,
492  std::function<void(Error)> RecoverableErrorCallback, raw_ostream *OS) {
493  const uint32_t DebugLineOffset = *OffsetPtr;
494 
495  clear();
496 
497  Error PrologueErr = Prologue.parse(DebugLineData, OffsetPtr, Ctx, U);
498 
499  if (OS) {
500  // The presence of OS signals verbose dumping.
501  DIDumpOptions DumpOptions;
502  DumpOptions.Verbose = true;
503  Prologue.dump(*OS, DumpOptions);
504  }
505 
506  if (PrologueErr)
507  return PrologueErr;
508 
509  const uint32_t EndOffset =
510  DebugLineOffset + Prologue.TotalLength + Prologue.sizeofTotalLength();
511 
512  // See if we should tell the data extractor the address size.
513  if (DebugLineData.getAddressSize() == 0)
514  DebugLineData.setAddressSize(Prologue.getAddressSize());
515  else
516  assert(Prologue.getAddressSize() == 0 ||
517  Prologue.getAddressSize() == DebugLineData.getAddressSize());
518 
519  ParsingState State(this);
520 
521  while (*OffsetPtr < EndOffset) {
522  if (OS)
523  *OS << format("0x%08.08" PRIx32 ": ", *OffsetPtr);
524 
525  uint8_t Opcode = DebugLineData.getU8(OffsetPtr);
526 
527  if (OS)
528  *OS << format("%02.02" PRIx8 " ", Opcode);
529 
530  if (Opcode == 0) {
531  // Extended Opcodes always start with a zero opcode followed by
532  // a uleb128 length so you can skip ones you don't know about
533  uint64_t Len = DebugLineData.getULEB128(OffsetPtr);
534  uint32_t ExtOffset = *OffsetPtr;
535 
536  // Tolerate zero-length; assume length is correct and soldier on.
537  if (Len == 0) {
538  if (OS)
539  *OS << "Badly formed extended line op (length 0)\n";
540  continue;
541  }
542 
543  uint8_t SubOpcode = DebugLineData.getU8(OffsetPtr);
544  if (OS)
545  *OS << LNExtendedString(SubOpcode);
546  switch (SubOpcode) {
547  case DW_LNE_end_sequence:
548  // Set the end_sequence register of the state machine to true and
549  // append a row to the matrix using the current values of the
550  // state-machine registers. Then reset the registers to the initial
551  // values specified above. Every statement program sequence must end
552  // with a DW_LNE_end_sequence instruction which creates a row whose
553  // address is that of the byte after the last target machine instruction
554  // of the sequence.
555  State.Row.EndSequence = true;
556  State.appendRowToMatrix(*OffsetPtr);
557  if (OS) {
558  *OS << "\n";
559  OS->indent(12);
560  State.Row.dump(*OS);
561  }
562  State.resetRowAndSequence();
563  break;
564 
565  case DW_LNE_set_address:
566  // Takes a single relocatable address as an operand. The size of the
567  // operand is the size appropriate to hold an address on the target
568  // machine. Set the address register to the value given by the
569  // relocatable address. All of the other statement program opcodes
570  // that affect the address register add a delta to it. This instruction
571  // stores a relocatable value into it instead.
572  //
573  // Make sure the extractor knows the address size. If not, infer it
574  // from the size of the operand.
575  if (DebugLineData.getAddressSize() == 0)
576  DebugLineData.setAddressSize(Len - 1);
577  else if (DebugLineData.getAddressSize() != Len - 1) {
578  return createError("mismatching address size at offset 0x%8.8" PRIx32
579  " expected 0x%2.2" PRIx8 " found 0x%2.2" PRIx64,
580  ExtOffset, DebugLineData.getAddressSize(),
581  Len - 1);
582  }
583  State.Row.Address = DebugLineData.getRelocatedAddress(OffsetPtr);
584  if (OS)
585  *OS << format(" (0x%16.16" PRIx64 ")", State.Row.Address);
586  break;
587 
588  case DW_LNE_define_file:
589  // Takes 4 arguments. The first is a null terminated string containing
590  // a source file name. The second is an unsigned LEB128 number
591  // representing the directory index of the directory in which the file
592  // was found. The third is an unsigned LEB128 number representing the
593  // time of last modification of the file. The fourth is an unsigned
594  // LEB128 number representing the length in bytes of the file. The time
595  // and length fields may contain LEB128(0) if the information is not
596  // available.
597  //
598  // The directory index represents an entry in the include_directories
599  // section of the statement program prologue. The index is LEB128(0)
600  // if the file was found in the current directory of the compilation,
601  // LEB128(1) if it was found in the first directory in the
602  // include_directories section, and so on. The directory index is
603  // ignored for file names that represent full path names.
604  //
605  // The files are numbered, starting at 1, in the order in which they
606  // appear; the names in the prologue come before names defined by
607  // the DW_LNE_define_file instruction. These numbers are used in the
608  // the file register of the state machine.
609  {
610  FileNameEntry FileEntry;
611  const char *Name = DebugLineData.getCStr(OffsetPtr);
612  FileEntry.Name.setForm(dwarf::DW_FORM_string);
613  FileEntry.Name.setPValue(Name);
614  FileEntry.DirIdx = DebugLineData.getULEB128(OffsetPtr);
615  FileEntry.ModTime = DebugLineData.getULEB128(OffsetPtr);
616  FileEntry.Length = DebugLineData.getULEB128(OffsetPtr);
617  Prologue.FileNames.push_back(FileEntry);
618  if (OS)
619  *OS << " (" << Name << ", dir=" << FileEntry.DirIdx << ", mod_time="
620  << format("(0x%16.16" PRIx64 ")", FileEntry.ModTime)
621  << ", length=" << FileEntry.Length << ")";
622  }
623  break;
624 
625  case DW_LNE_set_discriminator:
626  State.Row.Discriminator = DebugLineData.getULEB128(OffsetPtr);
627  if (OS)
628  *OS << " (" << State.Row.Discriminator << ")";
629  break;
630 
631  default:
632  if (OS)
633  *OS << format("Unrecognized extended op 0x%02.02" PRIx8, SubOpcode)
634  << format(" length %" PRIx64, Len);
635  // Len doesn't include the zero opcode byte or the length itself, but
636  // it does include the sub_opcode, so we have to adjust for that.
637  (*OffsetPtr) += Len - 1;
638  break;
639  }
640  // Make sure the stated and parsed lengths are the same.
641  // Otherwise we have an unparseable line-number program.
642  if (*OffsetPtr - ExtOffset != Len)
643  return createError("unexpected line op length at offset 0x%8.8" PRIx32
644  " expected 0x%2.2" PRIx64 " found 0x%2.2" PRIx32,
645  ExtOffset, Len, *OffsetPtr - ExtOffset);
646  } else if (Opcode < Prologue.OpcodeBase) {
647  if (OS)
648  *OS << LNStandardString(Opcode);
649  switch (Opcode) {
650  // Standard Opcodes
651  case DW_LNS_copy:
652  // Takes no arguments. Append a row to the matrix using the
653  // current values of the state-machine registers. Then set
654  // the basic_block register to false.
655  State.appendRowToMatrix(*OffsetPtr);
656  if (OS) {
657  *OS << "\n";
658  OS->indent(12);
659  State.Row.dump(*OS);
660  *OS << "\n";
661  }
662  break;
663 
664  case DW_LNS_advance_pc:
665  // Takes a single unsigned LEB128 operand, multiplies it by the
666  // min_inst_length field of the prologue, and adds the
667  // result to the address register of the state machine.
668  {
669  uint64_t AddrOffset =
670  DebugLineData.getULEB128(OffsetPtr) * Prologue.MinInstLength;
671  State.Row.Address += AddrOffset;
672  if (OS)
673  *OS << " (" << AddrOffset << ")";
674  }
675  break;
676 
677  case DW_LNS_advance_line:
678  // Takes a single signed LEB128 operand and adds that value to
679  // the line register of the state machine.
680  State.Row.Line += DebugLineData.getSLEB128(OffsetPtr);
681  if (OS)
682  *OS << " (" << State.Row.Line << ")";
683  break;
684 
685  case DW_LNS_set_file:
686  // Takes a single unsigned LEB128 operand and stores it in the file
687  // register of the state machine.
688  State.Row.File = DebugLineData.getULEB128(OffsetPtr);
689  if (OS)
690  *OS << " (" << State.Row.File << ")";
691  break;
692 
693  case DW_LNS_set_column:
694  // Takes a single unsigned LEB128 operand and stores it in the
695  // column register of the state machine.
696  State.Row.Column = DebugLineData.getULEB128(OffsetPtr);
697  if (OS)
698  *OS << " (" << State.Row.Column << ")";
699  break;
700 
701  case DW_LNS_negate_stmt:
702  // Takes no arguments. Set the is_stmt register of the state
703  // machine to the logical negation of its current value.
704  State.Row.IsStmt = !State.Row.IsStmt;
705  break;
706 
707  case DW_LNS_set_basic_block:
708  // Takes no arguments. Set the basic_block register of the
709  // state machine to true
710  State.Row.BasicBlock = true;
711  break;
712 
713  case DW_LNS_const_add_pc:
714  // Takes no arguments. Add to the address register of the state
715  // machine the address increment value corresponding to special
716  // opcode 255. The motivation for DW_LNS_const_add_pc is this:
717  // when the statement program needs to advance the address by a
718  // small amount, it can use a single special opcode, which occupies
719  // a single byte. When it needs to advance the address by up to
720  // twice the range of the last special opcode, it can use
721  // DW_LNS_const_add_pc followed by a special opcode, for a total
722  // of two bytes. Only if it needs to advance the address by more
723  // than twice that range will it need to use both DW_LNS_advance_pc
724  // and a special opcode, requiring three or more bytes.
725  {
726  uint8_t AdjustOpcode = 255 - Prologue.OpcodeBase;
727  uint64_t AddrOffset =
728  (AdjustOpcode / Prologue.LineRange) * Prologue.MinInstLength;
729  State.Row.Address += AddrOffset;
730  if (OS)
731  *OS
732  << format(" (0x%16.16" PRIx64 ")", AddrOffset);
733  }
734  break;
735 
736  case DW_LNS_fixed_advance_pc:
737  // Takes a single uhalf operand. Add to the address register of
738  // the state machine the value of the (unencoded) operand. This
739  // is the only extended opcode that takes an argument that is not
740  // a variable length number. The motivation for DW_LNS_fixed_advance_pc
741  // is this: existing assemblers cannot emit DW_LNS_advance_pc or
742  // special opcodes because they cannot encode LEB128 numbers or
743  // judge when the computation of a special opcode overflows and
744  // requires the use of DW_LNS_advance_pc. Such assemblers, however,
745  // can use DW_LNS_fixed_advance_pc instead, sacrificing compression.
746  {
747  uint16_t PCOffset = DebugLineData.getU16(OffsetPtr);
748  State.Row.Address += PCOffset;
749  if (OS)
750  *OS
751  << format(" (0x%16.16" PRIx64 ")", PCOffset);
752  }
753  break;
754 
755  case DW_LNS_set_prologue_end:
756  // Takes no arguments. Set the prologue_end register of the
757  // state machine to true
758  State.Row.PrologueEnd = true;
759  break;
760 
761  case DW_LNS_set_epilogue_begin:
762  // Takes no arguments. Set the basic_block register of the
763  // state machine to true
764  State.Row.EpilogueBegin = true;
765  break;
766 
767  case DW_LNS_set_isa:
768  // Takes a single unsigned LEB128 operand and stores it in the
769  // column register of the state machine.
770  State.Row.Isa = DebugLineData.getULEB128(OffsetPtr);
771  if (OS)
772  *OS << " (" << State.Row.Isa << ")";
773  break;
774 
775  default:
776  // Handle any unknown standard opcodes here. We know the lengths
777  // of such opcodes because they are specified in the prologue
778  // as a multiple of LEB128 operands for each opcode.
779  {
780  assert(Opcode - 1U < Prologue.StandardOpcodeLengths.size());
781  uint8_t OpcodeLength = Prologue.StandardOpcodeLengths[Opcode - 1];
782  for (uint8_t I = 0; I < OpcodeLength; ++I) {
783  uint64_t Value = DebugLineData.getULEB128(OffsetPtr);
784  if (OS)
785  *OS << format("Skipping ULEB128 value: 0x%16.16" PRIx64 ")\n",
786  Value);
787  }
788  }
789  break;
790  }
791  } else {
792  // Special Opcodes
793 
794  // A special opcode value is chosen based on the amount that needs
795  // to be added to the line and address registers. The maximum line
796  // increment for a special opcode is the value of the line_base
797  // field in the header, plus the value of the line_range field,
798  // minus 1 (line base + line range - 1). If the desired line
799  // increment is greater than the maximum line increment, a standard
800  // opcode must be used instead of a special opcode. The "address
801  // advance" is calculated by dividing the desired address increment
802  // by the minimum_instruction_length field from the header. The
803  // special opcode is then calculated using the following formula:
804  //
805  // opcode = (desired line increment - line_base) +
806  // (line_range * address advance) + opcode_base
807  //
808  // If the resulting opcode is greater than 255, a standard opcode
809  // must be used instead.
810  //
811  // To decode a special opcode, subtract the opcode_base from the
812  // opcode itself to give the adjusted opcode. The amount to
813  // increment the address register is the result of the adjusted
814  // opcode divided by the line_range multiplied by the
815  // minimum_instruction_length field from the header. That is:
816  //
817  // address increment = (adjusted opcode / line_range) *
818  // minimum_instruction_length
819  //
820  // The amount to increment the line register is the line_base plus
821  // the result of the adjusted opcode modulo the line_range. That is:
822  //
823  // line increment = line_base + (adjusted opcode % line_range)
824 
825  uint8_t AdjustOpcode = Opcode - Prologue.OpcodeBase;
826  uint64_t AddrOffset =
827  (AdjustOpcode / Prologue.LineRange) * Prologue.MinInstLength;
828  int32_t LineOffset =
829  Prologue.LineBase + (AdjustOpcode % Prologue.LineRange);
830  State.Row.Line += LineOffset;
831  State.Row.Address += AddrOffset;
832 
833  if (OS) {
834  *OS << "address += " << ((uint32_t)AdjustOpcode)
835  << ", line += " << LineOffset << "\n";
836  OS->indent(12);
837  State.Row.dump(*OS);
838  }
839 
840  State.appendRowToMatrix(*OffsetPtr);
841  // Reset discriminator to 0.
842  State.Row.Discriminator = 0;
843  }
844  if(OS)
845  *OS << "\n";
846  }
847 
848  if (!State.Sequence.Empty)
849  RecoverableErrorCallback(
850  createError("last sequence in debug line table is not terminated!"));
851 
852  // Sort all sequences so that address lookup will work faster.
853  if (!Sequences.empty()) {
854  llvm::sort(Sequences.begin(), Sequences.end(), Sequence::orderByLowPC);
855  // Note: actually, instruction address ranges of sequences should not
856  // overlap (in shared objects and executables). If they do, the address
857  // lookup would still work, though, but result would be ambiguous.
858  // We don't report warning in this case. For example,
859  // sometimes .so compiled from multiple object files contains a few
860  // rudimentary sequences for address ranges [0x0, 0xsomething).
861  }
862 
863  return Error::success();
864 }
865 
866 uint32_t
867 DWARFDebugLine::LineTable::findRowInSeq(const DWARFDebugLine::Sequence &Seq,
868  uint64_t Address) const {
869  if (!Seq.containsPC(Address))
870  return UnknownRowIndex;
871  // Search for instruction address in the rows describing the sequence.
872  // Rows are stored in a vector, so we may use arithmetical operations with
873  // iterators.
875  Row.Address = Address;
876  RowIter FirstRow = Rows.begin() + Seq.FirstRowIndex;
877  RowIter LastRow = Rows.begin() + Seq.LastRowIndex;
879  FirstRow, LastRow, Row, DWARFDebugLine::Row::orderByAddress);
880  if (RowPos == LastRow) {
881  return Seq.LastRowIndex - 1;
882  }
883  uint32_t Index = Seq.FirstRowIndex + (RowPos - FirstRow);
884  if (RowPos->Address > Address) {
885  if (RowPos == FirstRow)
886  return UnknownRowIndex;
887  else
888  Index--;
889  }
890  return Index;
891 }
892 
894  if (Sequences.empty())
895  return UnknownRowIndex;
896  // First, find an instruction sequence containing the given address.
898  Sequence.LowPC = Address;
899  SequenceIter FirstSeq = Sequences.begin();
900  SequenceIter LastSeq = Sequences.end();
902  FirstSeq, LastSeq, Sequence, DWARFDebugLine::Sequence::orderByLowPC);
903  DWARFDebugLine::Sequence FoundSeq;
904  if (SeqPos == LastSeq) {
905  FoundSeq = Sequences.back();
906  } else if (SeqPos->LowPC == Address) {
907  FoundSeq = *SeqPos;
908  } else {
909  if (SeqPos == FirstSeq)
910  return UnknownRowIndex;
911  FoundSeq = *(SeqPos - 1);
912  }
913  return findRowInSeq(FoundSeq, Address);
914 }
915 
917  uint64_t Address, uint64_t Size, std::vector<uint32_t> &Result) const {
918  if (Sequences.empty())
919  return false;
920  uint64_t EndAddr = Address + Size;
921  // First, find an instruction sequence containing the given address.
923  Sequence.LowPC = Address;
924  SequenceIter FirstSeq = Sequences.begin();
925  SequenceIter LastSeq = Sequences.end();
927  FirstSeq, LastSeq, Sequence, DWARFDebugLine::Sequence::orderByLowPC);
928  if (SeqPos == LastSeq || SeqPos->LowPC != Address) {
929  if (SeqPos == FirstSeq)
930  return false;
931  SeqPos--;
932  }
933  if (!SeqPos->containsPC(Address))
934  return false;
935 
936  SequenceIter StartPos = SeqPos;
937 
938  // Add the rows from the first sequence to the vector, starting with the
939  // index we just calculated
940 
941  while (SeqPos != LastSeq && SeqPos->LowPC < EndAddr) {
942  const DWARFDebugLine::Sequence &CurSeq = *SeqPos;
943  // For the first sequence, we need to find which row in the sequence is the
944  // first in our range.
945  uint32_t FirstRowIndex = CurSeq.FirstRowIndex;
946  if (SeqPos == StartPos)
947  FirstRowIndex = findRowInSeq(CurSeq, Address);
948 
949  // Figure out the last row in the range.
950  uint32_t LastRowIndex = findRowInSeq(CurSeq, EndAddr - 1);
951  if (LastRowIndex == UnknownRowIndex)
952  LastRowIndex = CurSeq.LastRowIndex - 1;
953 
954  assert(FirstRowIndex != UnknownRowIndex);
955  assert(LastRowIndex != UnknownRowIndex);
956 
957  for (uint32_t I = FirstRowIndex; I <= LastRowIndex; ++I) {
958  Result.push_back(I);
959  }
960 
961  ++SeqPos;
962  }
963 
964  return true;
965 }
966 
967 bool DWARFDebugLine::LineTable::hasFileAtIndex(uint64_t FileIndex) const {
968  return FileIndex != 0 && FileIndex <= Prologue.FileNames.size();
969 }
970 
971 Optional<StringRef> DWARFDebugLine::LineTable::getSourceByIndex(uint64_t FileIndex,
972  FileLineInfoKind Kind) const {
973  if (Kind == FileLineInfoKind::None || !hasFileAtIndex(FileIndex))
974  return None;
975  const FileNameEntry &Entry = Prologue.FileNames[FileIndex - 1];
976  if (Optional<const char *> source = Entry.Source.getAsCString())
977  return StringRef(*source);
978  return None;
979 }
980 
981 static bool isPathAbsoluteOnWindowsOrPosix(const Twine &Path) {
982  // Debug info can contain paths from any OS, not necessarily
983  // an OS we're currently running on. Moreover different compilation units can
984  // be compiled on different operating systems and linked together later.
987 }
988 
990  const char *CompDir,
991  FileLineInfoKind Kind,
992  std::string &Result) const {
993  if (Kind == FileLineInfoKind::None || !hasFileAtIndex(FileIndex))
994  return false;
995  const FileNameEntry &Entry = Prologue.FileNames[FileIndex - 1];
996  StringRef FileName = Entry.Name.getAsCString().getValue();
997  if (Kind != FileLineInfoKind::AbsoluteFilePath ||
998  isPathAbsoluteOnWindowsOrPosix(FileName)) {
999  Result = FileName;
1000  return true;
1001  }
1002 
1003  SmallString<16> FilePath;
1004  uint64_t IncludeDirIndex = Entry.DirIdx;
1005  StringRef IncludeDir;
1006  // Be defensive about the contents of Entry.
1007  if (IncludeDirIndex > 0 &&
1008  IncludeDirIndex <= Prologue.IncludeDirectories.size())
1009  IncludeDir = Prologue.IncludeDirectories[IncludeDirIndex - 1]
1010  .getAsCString()
1011  .getValue();
1012 
1013  // We may still need to append compilation directory of compile unit.
1014  // We know that FileName is not absolute, the only way to have an
1015  // absolute path at this point would be if IncludeDir is absolute.
1016  if (CompDir && Kind == FileLineInfoKind::AbsoluteFilePath &&
1017  !isPathAbsoluteOnWindowsOrPosix(IncludeDir))
1018  sys::path::append(FilePath, CompDir);
1019 
1020  // sys::path::append skips empty strings.
1021  sys::path::append(FilePath, IncludeDir, FileName);
1022  Result = FilePath.str();
1023  return true;
1024 }
1025 
1027  uint64_t Address, const char *CompDir, FileLineInfoKind Kind,
1028  DILineInfo &Result) const {
1029  // Get the index of row we're looking for in the line table.
1030  uint32_t RowIndex = lookupAddress(Address);
1031  if (RowIndex == -1U)
1032  return false;
1033  // Take file number and line/column from the row.
1034  const auto &Row = Rows[RowIndex];
1035  if (!getFileNameByIndex(Row.File, CompDir, Kind, Result.FileName))
1036  return false;
1037  Result.Line = Row.Line;
1038  Result.Column = Row.Column;
1039  Result.Discriminator = Row.Discriminator;
1040  Result.Source = getSourceByIndex(Row.File, Kind);
1041  return true;
1042 }
1043 
1044 // We want to supply the Unit associated with a .debug_line[.dwo] table when
1045 // we dump it, if possible, but still dump the table even if there isn't a Unit.
1046 // Therefore, collect up handles on all the Units that point into the
1047 // line-table section.
1052  for (const auto &CU : CUs)
1053  if (auto CUDIE = CU->getUnitDIE())
1054  if (auto StmtOffset = toSectionOffset(CUDIE.find(DW_AT_stmt_list)))
1055  LineToUnit.insert(std::make_pair(*StmtOffset, &*CU));
1056  for (const auto &TUS : TUSections)
1057  for (const auto &TU : TUS)
1058  if (auto TUDIE = TU->getUnitDIE())
1059  if (auto StmtOffset = toSectionOffset(TUDIE.find(DW_AT_stmt_list)))
1060  LineToUnit.insert(std::make_pair(*StmtOffset, &*TU));
1061  return LineToUnit;
1062 }
1063 
1065  const DWARFContext &C,
1066  cu_range CUs, tu_range TUs)
1067  : DebugLineData(Data), Context(C) {
1068  LineToUnit = buildLineToUnitMap(CUs, TUs);
1069  if (!DebugLineData.isValidOffset(Offset))
1070  Done = true;
1071 }
1072 
1074  return TotalLength == 0xffffffff || TotalLength < 0xffffff00;
1075 }
1076 
1078  function_ref<void(Error)> RecoverableErrorCallback,
1079  function_ref<void(Error)> UnrecoverableErrorCallback, raw_ostream *OS) {
1080  assert(DebugLineData.isValidOffset(Offset) &&
1081  "parsing should have terminated");
1082  DWARFUnit *U = prepareToParse(Offset);
1083  uint32_t OldOffset = Offset;
1084  LineTable LT;
1085  if (Error Err = LT.parse(DebugLineData, &Offset, Context, U,
1086  RecoverableErrorCallback, OS))
1087  UnrecoverableErrorCallback(std::move(Err));
1088  moveToNextTable(OldOffset, LT.Prologue);
1089  return LT;
1090 }
1091 
1093  function_ref<void(Error)> ErrorCallback) {
1094  assert(DebugLineData.isValidOffset(Offset) &&
1095  "parsing should have terminated");
1096  DWARFUnit *U = prepareToParse(Offset);
1097  uint32_t OldOffset = Offset;
1098  LineTable LT;
1099  if (Error Err = LT.Prologue.parse(DebugLineData, &Offset, Context, U))
1100  ErrorCallback(std::move(Err));
1101  moveToNextTable(OldOffset, LT.Prologue);
1102 }
1103 
1104 DWARFUnit *DWARFDebugLine::SectionParser::prepareToParse(uint32_t Offset) {
1105  DWARFUnit *U = nullptr;
1106  auto It = LineToUnit.find(Offset);
1107  if (It != LineToUnit.end())
1108  U = It->second;
1109  DebugLineData.setAddressSize(U ? U->getAddressByteSize() : 0);
1110  return U;
1111 }
1112 
1113 void DWARFDebugLine::SectionParser::moveToNextTable(uint32_t OldOffset,
1114  const Prologue &P) {
1115  // If the length field is not valid, we don't know where the next table is, so
1116  // cannot continue to parse. Mark the parser as done, and leave the Offset
1117  // value as it currently is. This will be the end of the bad length field.
1118  if (!P.totalLengthIsValid()) {
1119  Done = true;
1120  return;
1121  }
1122 
1123  Offset = OldOffset + P.TotalLength + P.sizeofTotalLength();
1124  if (!DebugLineData.isValidOffset(Offset)) {
1125  Done = true;
1126  }
1127 }
1128 
1130  handleAllErrors(std::move(Err), [](ErrorInfoBase &Info) {
1131  WithColor::warning() << Info.message() << '\n';
1132  });
1133 }
SequenceVector::const_iterator SequenceIter
void dump(raw_ostream &OS, DIDumpOptions DumpOpts=DIDumpOptions()) const
const NoneType None
Definition: None.h:24
uint64_t CallInst * C
uint32_t Discriminator
Definition: DIContext.h:40
A helper struct providing information about the byte size of DW_FORM values that vary in size dependi...
Definition: Dwarf.h:495
Optional< StringRef > Source
Definition: DIContext.h:34
static void warn(Error Err)
Helper function for DWARFDebugLine parse functions, to report issues identified during parsing...
uint64_t LowPC
Sequence describes instructions at address range [LowPC, HighPC) and is described by line table rows ...
std::string FileName
Definition: DIContext.h:32
LLVMContext & Context
uint64_t getULEB128(uint32_t *offset_ptr) const
Extract a unsigned LEB128 value from *offset_ptr.
Compute iterated dominance frontiers using a linear time algorithm.
Definition: AllocatorList.h:24
Row(bool DefaultIsStmt=false)
uint32_t sizeofTotalLength() const
SmallString< 32 > digest() const
Definition: MD5.cpp:264
StringRef LNExtendedString(unsigned Encoding)
Definition: Dwarf.cpp:407
static bool orderByAddress(const Row &LHS, const Row &RHS)
StringRef LNStandardString(unsigned Standard)
Definition: Dwarf.cpp:396
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition: Format.h:124
raw_ostream & indent(unsigned NumSpaces)
indent - Insert &#39;NumSpaces&#39; spaces.
uint8_t MinInstLength
The size in bytes of the smallest target machine instruction.
An efficient, type-erasing, non-owning reference to a callable.
Definition: STLExtras.h:93
uint32_t Line
An unsigned integer indicating a source line number.
static DWARFDebugLine::SectionParser::LineToUnitMap buildLineToUnitMap(DWARFDebugLine::SectionParser::cu_range CUs, DWARFDebugLine::SectionParser::tu_range TUSections)
virtual std::string message() const
Return the error message as a string.
Definition: Error.h:55
SectionParser(DWARFDataExtractor &Data, const DWARFContext &C, cu_range CUs, tu_range TUs)
uint64_t getRelocatedAddress(uint32_t *Off, uint64_t *SecIx=nullptr) const
Extracts an address-sized value and applies a relocation to the result if one exists for the given of...
static raw_ostream & warning()
Convenience method for printing "warning: " to stderr.
Definition: WithColor.cpp:65
void dump(raw_ostream &OS, DIDumpOptions DumpOptions) const
uint16_t getU16(uint32_t *offset_ptr) const
Extract a uint16_t value from *offset_ptr.
Base class for error info classes.
Definition: Error.h:47
Error parse(const DWARFDataExtractor &DebugLineData, uint32_t *OffsetPtr, const DWARFContext &Ctx, const DWARFUnit *U=nullptr)
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:128
std::vector< DWARFFormValue > IncludeDirectories
A format-neutral container for source line information.
Definition: DIContext.h:31
void append(SmallVectorImpl< char > &path, const Twine &a, const Twine &b="", const Twine &c="", const Twine &d="")
Append to path.
Definition: Path.cpp:471
uint32_t getU32(uint32_t *offset_ptr) const
Extract a uint32_t value from *offset_ptr.
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
Represents a series of contiguous machine instructions.
Optional< ArrayRef< uint8_t > > getAsBlock() const
uint64_t Address
The program-counter value corresponding to a machine instruction generated by the compiler...
bool hasFileAtIndex(uint64_t FileIndex) const
Expected< const LineTable * > getOrParseLineTable(DWARFDataExtractor &DebugLineData, uint32_t Offset, const DWARFContext &Ctx, const DWARFUnit *U, std::function< void(Error)> RecoverableErrorCallback=warn)
void postAppend()
Called after a row is appended to the matrix.
bool is_absolute(const Twine &path, Style style=Style::native)
Is path absolute?
Definition: Path.cpp:679
Tagged union holding either a T or a Error.
Definition: CachePruning.h:23
static std::string formatErrorString(char const *Fmt, const Ts &... Vals)
uint32_t lookupAddress(uint64_t Address) const
Returns the index of the row with file/line info for a given address, or UnknownRowIndex if there is ...
void setForm(dwarf::Form F)
uint8_t LineRange
This parameter affects the meaning of the special opcodes. See below.
uint8_t getAddressByteSize() const
Definition: DWARFUnit.h:338
StringRef str() const
Explicit conversion to StringRef.
Definition: SmallString.h:267
uint8_t OpcodeBase
The number assigned to the first special opcode.
void reset(bool DefaultIsStmt)
const T & getValue() const LLVM_LVALUE_FUNCTION
Definition: Optional.h:179
LLVM_NODISCARD LLVM_ATTRIBUTE_ALWAYS_INLINE bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:133
uint64_t TotalLength
The size in bytes of the statement information for this compilation unit (not including the total_len...
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition: SmallString.h:26
auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range))
Provide wrappers to std::lower_bound which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:1004
bool HasModTime
Whether filename entries provide a modification timestamp.
int64_t getSLEB128(uint32_t *offset_ptr) const
Extract a signed LEB128 value from *offset_ptr.
Container for dump options that control which debug information will be dumped.
Definition: DIContext.h:154
Optional< uint64_t > toSectionOffset(const Optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an section offset.
void setPValue(const char *V)
uint8_t EndSequence
A boolean indicating that the current address is that of the first byte after the end of a sequence o...
Error parse(DWARFDataExtractor &DebugLineData, uint32_t *OffsetPtr, const DWARFContext &Ctx, const DWARFUnit *U, std::function< void(Error)> RecoverableErrorCallback=warn, raw_ostream *OS=nullptr)
Parse prologue and all rows.
#define P(N)
* if(!EatIfPresent(lltok::kw_thread_local)) return false
ParseOptionalThreadLocal := /*empty.
uint32_t Column
Definition: DIContext.h:36
void dump(raw_ostream &OS) const
LLVM Basic Block Representation.
Definition: BasicBlock.h:59
uint16_t File
An unsigned integer indicating the identity of the source file corresponding to a machine instruction...
bool HasLength
Whether filename entries provide a file size.
uint8_t getAddressSize() const
Get the address size for this extractor.
Definition: DataExtractor.h:59
static ContentDescriptors parseV5EntryFormat(const DWARFDataExtractor &DebugLineData, uint32_t *OffsetPtr, uint64_t EndPrologueOffset, DWARFDebugLine::ContentTypeTracker *ContentTypes)
void skip(function_ref< void(Error)> ErrorCallback=warn)
Skip the current line table and go to the following line table (if present) immediately.
uint8_t getU8(uint32_t *offset_ptr) const
Extract a uint8_t value from *offset_ptr.
Optional< uint64_t > getAsUnsignedConstant() const
bool skipValue(DataExtractor DebugInfoData, uint32_t *OffsetPtr, const dwarf::FormParams Params) const
Skip a form&#39;s value in DebugInfoData at the offset specified by OffsetPtr.
uint64_t getU64(uint32_t *offset_ptr) const
Extract a uint64_t value from *offset_ptr.
void appendSequence(const DWARFDebugLine::Sequence &S)
void dump(raw_ostream &OS, DIDumpOptions DumpOptions) const
std::string & str()
Flushes the stream contents to the target string and returns the string&#39;s reference.
Definition: raw_ostream.h:493
Standard .debug_line state machine structure.
void sort(IteratorTy Start, IteratorTy End)
Definition: STLExtras.h:859
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
bool lookupAddressRange(uint64_t Address, uint64_t Size, std::vector< uint32_t > &Result) const
bool containsPC(uint64_t PC) const
static Error createError(char const *Fmt, const Ts &... Vals)
void handleAllErrors(Error E, HandlerTs &&... Handlers)
Behaves the same as handleErrors, except that by contract all errors must be handled by the given han...
Definition: Error.h:889
static bool parseV5DirFileTables(const DWARFDataExtractor &DebugLineData, uint32_t *OffsetPtr, uint64_t EndPrologueOffset, const dwarf::FormParams &FormParams, const DWARFContext &Ctx, const DWARFUnit *U, DWARFDebugLine::ContentTypeTracker &ContentTypes, std::vector< DWARFFormValue > &IncludeDirectories, std::vector< DWARFDebugLine::FileNameEntry > &FileNames)
uint16_t Column
An unsigned integer indicating a column number within a source line.
static ErrorSuccess success()
Create a success value.
Definition: Error.h:313
std::map< uint64_t, DWARFUnit * > LineToUnitMap
bool getFileLineInfoForAddress(uint64_t Address, const char *CompDir, DILineInfoSpecifier::FileLineInfoKind Kind, DILineInfo &Result) const
Fills the Result argument with the file and line information corresponding to Address.
uint32_t Line
Definition: DIContext.h:35
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:861
void appendRow(const DWARFDebugLine::Row &R)
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
Definition: DWARFContext.h:59
static void dumpTableHeader(raw_ostream &OS)
void setAddressSize(uint8_t Size)
Set the address size for this extractor.
Definition: DataExtractor.h:61
std::vector< uint8_t > StandardOpcodeLengths
A range adaptor for a pair of iterators.
This file contains constants used for implementing Dwarf debug support.
static void clear(coro::Shape &Shape)
Definition: Coroutines.cpp:211
bool extractValue(const DWARFDataExtractor &Data, uint32_t *OffsetPtr, dwarf::FormParams FormParams, const DWARFContext *Context=nullptr, const DWARFUnit *Unit=nullptr)
Extracts a value in Data at offset *OffsetPtr.
Tracks which optional content types are present in a DWARF file name entry format.
std::vector< FileNameEntry > FileNames
uint32_t Discriminator
An unsigned integer representing the DWARF path discriminator value for this location.
RowVector::const_iterator RowIter
uint64_t getUnsigned(uint32_t *offset_ptr, uint32_t byte_size) const
Extract an unsigned integer of size byte_size from *offset_ptr.
#define I(x, y, z)
Definition: MD5.cpp:58
static bool orderByLowPC(const Sequence &LHS, const Sequence &RHS)
Optional< const char * > getAsCString() const
Sequence
A sequence of states that a pointer may go through in which an objc_retain and objc_release are actua...
Definition: PtrState.h:41
const char * getCStr(uint32_t *offset_ptr) const
Extract a C string from *offset_ptr.
bool isValidOffset(uint32_t offset) const
Test the validity of offset.
uint8_t DefaultIsStmt
The initial value of theis_stmtregister.
const unsigned Kind
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
DwarfFormat Format
Definition: Dwarf.h:498
LineTable parseNext(function_ref< void(Error)> RecoverableErrorCallback=warn, function_ref< void(Error)> UnrecoverableErrorCallback=warn, raw_ostream *OS=nullptr)
Get the next line table from the section.
std::array< uint8_t, 16 > Bytes
Definition: MD5.h:56
static bool isPathAbsoluteOnWindowsOrPosix(const Twine &Path)
A raw_ostream that writes to an std::string.
Definition: raw_ostream.h:477
int8_t LineBase
This parameter affects the meaning of the special opcodes. See below.
bool getFileNameByIndex(uint64_t FileIndex, const char *CompDir, DILineInfoSpecifier::FileLineInfoKind Kind, std::string &Result) const
Extracts filename by its index in filename table in prologue.
const LineTable * getLineTable(uint32_t Offset) const
LLVM Value Representation.
Definition: Value.h:73
StringRef getCStrRef(uint32_t *OffsetPtr) const
Extract a C string from *OffsetPtr.
constexpr char Size[]
Key for Kernel::Arg::Metadata::mSize.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:156
This class implements an extremely fast bulk output stream that can only output to a stream...
Definition: raw_ostream.h:46
static void parseV2DirFileTables(const DWARFDataExtractor &DebugLineData, uint32_t *OffsetPtr, uint64_t EndPrologueOffset, DWARFDebugLine::ContentTypeTracker &ContentTypes, std::vector< DWARFFormValue > &IncludeDirectories, std::vector< DWARFDebugLine::FileNameEntry > &FileNames)
print Print MemDeps of function
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:49
void trackContentType(dwarf::LineNumberEntryFormat ContentType)
Update tracked content types with ContentType.
LineNumberEntryFormat
Definition: Dwarf.h:243
std::error_code inconvertibleErrorCode()
The value returned by this function can be returned from convertToErrorCode for Error values where no...
Definition: Error.cpp:73