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