LLVM 18.0.0git
DWARFDebugLine.cpp
Go to the documentation of this file.
1//===- DWARFDebugLine.cpp -------------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
12#include "llvm/ADT/StringRef.h"
17#include "llvm/Support/Errc.h"
18#include "llvm/Support/Format.h"
21#include <algorithm>
22#include <cassert>
23#include <cinttypes>
24#include <cstdint>
25#include <cstdio>
26#include <utility>
27
28using namespace llvm;
29using namespace dwarf;
30
32
33namespace {
34
35struct ContentDescriptor {
38};
39
40using ContentDescriptors = SmallVector<ContentDescriptor, 4>;
41
42} // end anonymous namespace
43
44static bool versionIsSupported(uint16_t Version) {
45 return Version >= 2 && Version <= 5;
46}
47
49 dwarf::LineNumberEntryFormat ContentType) {
50 switch (ContentType) {
51 case dwarf::DW_LNCT_timestamp:
52 HasModTime = true;
53 break;
54 case dwarf::DW_LNCT_size:
55 HasLength = true;
56 break;
57 case dwarf::DW_LNCT_MD5:
58 HasMD5 = true;
59 break;
60 case dwarf::DW_LNCT_LLVM_source:
61 HasSource = true;
62 break;
63 default:
64 // We only care about values we consider optional, and new values may be
65 // added in the vendor extension range, so we do not match exhaustively.
66 break;
67 }
68}
69
71
73 uint16_t DwarfVersion = getVersion();
74 assert(DwarfVersion != 0 &&
75 "line table prologue has no dwarf version information");
76 if (DwarfVersion >= 5)
77 return FileIndex < FileNames.size();
78 return FileIndex != 0 && FileIndex <= FileNames.size();
79}
80
81std::optional<uint64_t>
83 if (FileNames.empty())
84 return std::nullopt;
85 uint16_t DwarfVersion = getVersion();
86 assert(DwarfVersion != 0 &&
87 "line table prologue has no dwarf version information");
88 // In DWARF v5 the file names are 0-indexed.
89 if (DwarfVersion >= 5)
90 return FileNames.size() - 1;
91 return FileNames.size();
92}
93
96 uint16_t DwarfVersion = getVersion();
97 assert(DwarfVersion != 0 &&
98 "line table prologue has no dwarf version information");
99 // In DWARF v5 the file names are 0-indexed.
100 if (DwarfVersion >= 5)
101 return FileNames[Index];
102 return FileNames[Index - 1];
103}
104
106 TotalLength = PrologueLength = 0;
107 SegSelectorSize = 0;
108 MinInstLength = MaxOpsPerInst = DefaultIsStmt = LineBase = LineRange = 0;
109 OpcodeBase = 0;
111 ContentTypes = ContentTypeTracker();
112 StandardOpcodeLengths.clear();
113 IncludeDirectories.clear();
114 FileNames.clear();
115}
116
118 DIDumpOptions DumpOptions) const {
119 if (!totalLengthIsValid())
120 return;
121 int OffsetDumpWidth = 2 * dwarf::getDwarfOffsetByteSize(FormParams.Format);
122 OS << "Line table prologue:\n"
123 << format(" total_length: 0x%0*" PRIx64 "\n", OffsetDumpWidth,
124 TotalLength)
125 << " format: " << dwarf::FormatString(FormParams.Format) << "\n"
126 << format(" version: %u\n", getVersion());
127 if (!versionIsSupported(getVersion()))
128 return;
129 if (getVersion() >= 5)
130 OS << format(" address_size: %u\n", getAddressSize())
131 << format(" seg_select_size: %u\n", SegSelectorSize);
132 OS << format(" prologue_length: 0x%0*" PRIx64 "\n", OffsetDumpWidth,
133 PrologueLength)
134 << format(" min_inst_length: %u\n", MinInstLength)
135 << format(getVersion() >= 4 ? "max_ops_per_inst: %u\n" : "", MaxOpsPerInst)
136 << format(" default_is_stmt: %u\n", DefaultIsStmt)
137 << format(" line_base: %i\n", LineBase)
138 << format(" line_range: %u\n", LineRange)
139 << format(" opcode_base: %u\n", OpcodeBase);
140
141 for (uint32_t I = 0; I != StandardOpcodeLengths.size(); ++I)
142 OS << formatv("standard_opcode_lengths[{0}] = {1}\n",
143 static_cast<dwarf::LineNumberOps>(I + 1),
144 StandardOpcodeLengths[I]);
145
146 if (!IncludeDirectories.empty()) {
147 // DWARF v5 starts directory indexes at 0.
148 uint32_t DirBase = getVersion() >= 5 ? 0 : 1;
149 for (uint32_t I = 0; I != IncludeDirectories.size(); ++I) {
150 OS << format("include_directories[%3u] = ", I + DirBase);
151 IncludeDirectories[I].dump(OS, DumpOptions);
152 OS << '\n';
153 }
154 }
155
156 if (!FileNames.empty()) {
157 // DWARF v5 starts file indexes at 0.
158 uint32_t FileBase = getVersion() >= 5 ? 0 : 1;
159 for (uint32_t I = 0; I != FileNames.size(); ++I) {
160 const FileNameEntry &FileEntry = FileNames[I];
161 OS << format("file_names[%3u]:\n", I + FileBase);
162 OS << " name: ";
163 FileEntry.Name.dump(OS, DumpOptions);
164 OS << '\n'
165 << format(" dir_index: %" PRIu64 "\n", FileEntry.DirIdx);
166 if (ContentTypes.HasMD5)
167 OS << " md5_checksum: " << FileEntry.Checksum.digest() << '\n';
168 if (ContentTypes.HasModTime)
169 OS << format(" mod_time: 0x%8.8" PRIx64 "\n", FileEntry.ModTime);
170 if (ContentTypes.HasLength)
171 OS << format(" length: 0x%8.8" PRIx64 "\n", FileEntry.Length);
172 if (ContentTypes.HasSource) {
173 OS << " source: ";
174 FileEntry.Source.dump(OS, DumpOptions);
175 OS << '\n';
176 }
177 }
178 }
179}
180
181// Parse v2-v4 directory and file tables.
182static Error
184 uint64_t *OffsetPtr,
186 std::vector<DWARFFormValue> &IncludeDirectories,
187 std::vector<DWARFDebugLine::FileNameEntry> &FileNames) {
188 while (true) {
189 Error Err = Error::success();
190 StringRef S = DebugLineData.getCStrRef(OffsetPtr, &Err);
191 if (Err) {
192 consumeError(std::move(Err));
194 "include directories table was not null "
195 "terminated before the end of the prologue");
196 }
197 if (S.empty())
198 break;
199 DWARFFormValue Dir =
200 DWARFFormValue::createFromPValue(dwarf::DW_FORM_string, S.data());
201 IncludeDirectories.push_back(Dir);
202 }
203
204 ContentTypes.HasModTime = true;
205 ContentTypes.HasLength = true;
206
207 while (true) {
208 Error Err = Error::success();
209 StringRef Name = DebugLineData.getCStrRef(OffsetPtr, &Err);
210 if (!Err && Name.empty())
211 break;
212
214 FileEntry.Name =
215 DWARFFormValue::createFromPValue(dwarf::DW_FORM_string, Name.data());
216 FileEntry.DirIdx = DebugLineData.getULEB128(OffsetPtr, &Err);
217 FileEntry.ModTime = DebugLineData.getULEB128(OffsetPtr, &Err);
218 FileEntry.Length = DebugLineData.getULEB128(OffsetPtr, &Err);
219
220 if (Err) {
221 consumeError(std::move(Err));
222 return createStringError(
224 "file names table was not null terminated before "
225 "the end of the prologue");
226 }
227 FileNames.push_back(FileEntry);
228 }
229
230 return Error::success();
231}
232
233// Parse v5 directory/file entry content descriptions.
234// Returns the descriptors, or an error if we did not find a path or ran off
235// the end of the prologue.
237parseV5EntryFormat(const DWARFDataExtractor &DebugLineData, uint64_t *OffsetPtr,
239 Error Err = Error::success();
240 ContentDescriptors Descriptors;
241 int FormatCount = DebugLineData.getU8(OffsetPtr, &Err);
242 bool HasPath = false;
243 for (int I = 0; I != FormatCount && !Err; ++I) {
244 ContentDescriptor Descriptor;
245 Descriptor.Type =
246 dwarf::LineNumberEntryFormat(DebugLineData.getULEB128(OffsetPtr, &Err));
247 Descriptor.Form = dwarf::Form(DebugLineData.getULEB128(OffsetPtr, &Err));
248 if (Descriptor.Type == dwarf::DW_LNCT_path)
249 HasPath = true;
250 if (ContentTypes)
251 ContentTypes->trackContentType(Descriptor.Type);
252 Descriptors.push_back(Descriptor);
253 }
254
255 if (Err)
257 "failed to parse entry content descriptors: %s",
258 toString(std::move(Err)).c_str());
259
260 if (!HasPath)
262 "failed to parse entry content descriptions"
263 " because no path was found");
264 return Descriptors;
265}
266
267static Error
269 uint64_t *OffsetPtr, const dwarf::FormParams &FormParams,
270 const DWARFContext &Ctx, const DWARFUnit *U,
272 std::vector<DWARFFormValue> &IncludeDirectories,
273 std::vector<DWARFDebugLine::FileNameEntry> &FileNames) {
274 // Get the directory entry description.
276 parseV5EntryFormat(DebugLineData, OffsetPtr, nullptr);
277 if (!DirDescriptors)
278 return DirDescriptors.takeError();
279
280 // Get the directory entries, according to the format described above.
281 uint64_t DirEntryCount = DebugLineData.getULEB128(OffsetPtr);
282 for (uint64_t I = 0; I != DirEntryCount; ++I) {
283 for (auto Descriptor : *DirDescriptors) {
284 DWARFFormValue Value(Descriptor.Form);
285 switch (Descriptor.Type) {
286 case DW_LNCT_path:
287 if (!Value.extractValue(DebugLineData, OffsetPtr, FormParams, &Ctx, U))
289 "failed to parse directory entry because "
290 "extracting the form value failed");
291 IncludeDirectories.push_back(Value);
292 break;
293 default:
294 if (!Value.skipValue(DebugLineData, OffsetPtr, FormParams))
296 "failed to parse directory entry because "
297 "skipping the form value failed");
298 }
299 }
300 }
301
302 // Get the file entry description.
303 llvm::Expected<ContentDescriptors> FileDescriptors =
304 parseV5EntryFormat(DebugLineData, OffsetPtr, &ContentTypes);
305 if (!FileDescriptors)
306 return FileDescriptors.takeError();
307
308 // Get the file entries, according to the format described above.
309 uint64_t FileEntryCount = DebugLineData.getULEB128(OffsetPtr);
310 for (uint64_t I = 0; I != FileEntryCount; ++I) {
312 for (auto Descriptor : *FileDescriptors) {
313 DWARFFormValue Value(Descriptor.Form);
314 if (!Value.extractValue(DebugLineData, OffsetPtr, FormParams, &Ctx, U))
316 "failed to parse file entry because "
317 "extracting the form value failed");
318 switch (Descriptor.Type) {
319 case DW_LNCT_path:
320 FileEntry.Name = Value;
321 break;
322 case DW_LNCT_LLVM_source:
323 FileEntry.Source = Value;
324 break;
325 case DW_LNCT_directory_index:
326 FileEntry.DirIdx = *Value.getAsUnsignedConstant();
327 break;
328 case DW_LNCT_timestamp:
329 FileEntry.ModTime = *Value.getAsUnsignedConstant();
330 break;
331 case DW_LNCT_size:
332 FileEntry.Length = *Value.getAsUnsignedConstant();
333 break;
334 case DW_LNCT_MD5:
335 if (!Value.getAsBlock() || Value.getAsBlock()->size() != 16)
336 return createStringError(
338 "failed to parse file entry because the MD5 hash is invalid");
339 std::uninitialized_copy_n(Value.getAsBlock()->begin(), 16,
340 FileEntry.Checksum.begin());
341 break;
342 default:
343 break;
344 }
345 }
346 FileNames.push_back(FileEntry);
347 }
348 return Error::success();
349}
350
352 uint64_t Length = PrologueLength + sizeofTotalLength() +
353 sizeof(getVersion()) + sizeofPrologueLength();
354 if (getVersion() >= 5)
355 Length += 2; // Address + Segment selector sizes.
356 return Length;
357}
358
360 DWARFDataExtractor DebugLineData, uint64_t *OffsetPtr,
361 function_ref<void(Error)> RecoverableErrorHandler, const DWARFContext &Ctx,
362 const DWARFUnit *U) {
363 const uint64_t PrologueOffset = *OffsetPtr;
364
365 clear();
366 DataExtractor::Cursor Cursor(*OffsetPtr);
367 std::tie(TotalLength, FormParams.Format) =
368 DebugLineData.getInitialLength(Cursor);
369
370 DebugLineData =
371 DWARFDataExtractor(DebugLineData, Cursor.tell() + TotalLength);
372 FormParams.Version = DebugLineData.getU16(Cursor);
373 if (Cursor && !versionIsSupported(getVersion())) {
374 // Treat this error as unrecoverable - we cannot be sure what any of
375 // the data represents including the length field, so cannot skip it or make
376 // any reasonable assumptions.
377 *OffsetPtr = Cursor.tell();
378 return createStringError(
380 "parsing line table prologue at offset 0x%8.8" PRIx64
381 ": unsupported version %" PRIu16,
382 PrologueOffset, getVersion());
383 }
384
385 if (getVersion() >= 5) {
386 FormParams.AddrSize = DebugLineData.getU8(Cursor);
387 assert((!Cursor || DebugLineData.getAddressSize() == 0 ||
388 DebugLineData.getAddressSize() == getAddressSize()) &&
389 "Line table header and data extractor disagree");
390 SegSelectorSize = DebugLineData.getU8(Cursor);
391 }
392
393 PrologueLength =
394 DebugLineData.getRelocatedValue(Cursor, sizeofPrologueLength());
395 const uint64_t EndPrologueOffset = PrologueLength + Cursor.tell();
396 DebugLineData = DWARFDataExtractor(DebugLineData, EndPrologueOffset);
397 MinInstLength = DebugLineData.getU8(Cursor);
398 if (getVersion() >= 4)
399 MaxOpsPerInst = DebugLineData.getU8(Cursor);
400 DefaultIsStmt = DebugLineData.getU8(Cursor);
401 LineBase = DebugLineData.getU8(Cursor);
402 LineRange = DebugLineData.getU8(Cursor);
403 OpcodeBase = DebugLineData.getU8(Cursor);
404
405 if (Cursor && OpcodeBase == 0) {
406 // If the opcode base is 0, we cannot read the standard opcode lengths (of
407 // which there are supposed to be one fewer than the opcode base). Assume
408 // there are no standard opcodes and continue parsing.
409 RecoverableErrorHandler(createStringError(
411 "parsing line table prologue at offset 0x%8.8" PRIx64
412 " found opcode base of 0. Assuming no standard opcodes",
413 PrologueOffset));
414 } else if (Cursor) {
415 StandardOpcodeLengths.reserve(OpcodeBase - 1);
416 for (uint32_t I = 1; I < OpcodeBase; ++I) {
417 uint8_t OpLen = DebugLineData.getU8(Cursor);
418 StandardOpcodeLengths.push_back(OpLen);
419 }
420 }
421
422 *OffsetPtr = Cursor.tell();
423 // A corrupt file name or directory table does not prevent interpretation of
424 // the main line program, so check the cursor state now so that its errors can
425 // be handled separately.
426 if (!Cursor)
427 return createStringError(
429 "parsing line table prologue at offset 0x%8.8" PRIx64 ": %s",
430 PrologueOffset, toString(Cursor.takeError()).c_str());
431
432 Error E =
433 getVersion() >= 5
434 ? parseV5DirFileTables(DebugLineData, OffsetPtr, FormParams, Ctx, U,
435 ContentTypes, IncludeDirectories, FileNames)
436 : parseV2DirFileTables(DebugLineData, OffsetPtr, ContentTypes,
437 IncludeDirectories, FileNames);
438 if (E) {
439 RecoverableErrorHandler(joinErrors(
442 "parsing line table prologue at 0x%8.8" PRIx64
443 " found an invalid directory or file table description at"
444 " 0x%8.8" PRIx64,
445 PrologueOffset, *OffsetPtr),
446 std::move(E)));
447 return Error::success();
448 }
449
450 assert(*OffsetPtr <= EndPrologueOffset);
451 if (*OffsetPtr != EndPrologueOffset) {
452 RecoverableErrorHandler(createStringError(
454 "unknown data in line table prologue at offset 0x%8.8" PRIx64
455 ": parsing ended (at offset 0x%8.8" PRIx64
456 ") before reaching the prologue end at offset 0x%8.8" PRIx64,
457 PrologueOffset, *OffsetPtr, EndPrologueOffset));
458 }
459 return Error::success();
460}
461
462DWARFDebugLine::Row::Row(bool DefaultIsStmt) { reset(DefaultIsStmt); }
463
465 Discriminator = 0;
466 BasicBlock = false;
467 PrologueEnd = false;
468 EpilogueBegin = false;
469}
470
471void DWARFDebugLine::Row::reset(bool DefaultIsStmt) {
472 Address.Address = 0;
474 Line = 1;
475 Column = 0;
476 File = 1;
477 Isa = 0;
478 Discriminator = 0;
479 IsStmt = DefaultIsStmt;
480 OpIndex = 0;
481 BasicBlock = false;
482 EndSequence = false;
483 PrologueEnd = false;
484 EpilogueBegin = false;
485}
486
488 OS.indent(Indent)
489 << "Address Line Column File ISA Discriminator OpIndex "
490 "Flags\n";
491 OS.indent(Indent)
492 << "------------------ ------ ------ ------ --- ------------- ------- "
493 "-------------\n";
494}
495
497 OS << format("0x%16.16" PRIx64 " %6u %6u", Address.Address, Line, Column)
498 << format(" %6u %3u %13u %7u ", File, Isa, Discriminator, OpIndex)
499 << (IsStmt ? " is_stmt" : "") << (BasicBlock ? " basic_block" : "")
500 << (PrologueEnd ? " prologue_end" : "")
501 << (EpilogueBegin ? " epilogue_begin" : "")
502 << (EndSequence ? " end_sequence" : "") << '\n';
503}
504
506
508 LowPC = 0;
509 HighPC = 0;
511 FirstRowIndex = 0;
512 LastRowIndex = 0;
513 Empty = true;
514}
515
517
519 DIDumpOptions DumpOptions) const {
520 Prologue.dump(OS, DumpOptions);
521
522 if (!Rows.empty()) {
523 OS << '\n';
525 for (const Row &R : Rows) {
526 R.dump(OS);
527 }
528 }
529
530 // Terminate the table with a final blank line to clearly delineate it from
531 // later dumps.
532 OS << '\n';
533}
534
536 Prologue.clear();
537 Rows.clear();
538 Sequences.clear();
539}
540
541DWARFDebugLine::ParsingState::ParsingState(
542 struct LineTable *LT, uint64_t TableOffset,
544 : LineTable(LT), LineTableOffset(TableOffset), ErrorHandler(ErrorHandler) {
545 resetRowAndSequence();
546}
547
548void DWARFDebugLine::ParsingState::resetRowAndSequence() {
549 Row.reset(LineTable->Prologue.DefaultIsStmt);
550 Sequence.reset();
551}
552
553void DWARFDebugLine::ParsingState::appendRowToMatrix() {
554 unsigned RowNumber = LineTable->Rows.size();
555 if (Sequence.Empty) {
556 // Record the beginning of instruction sequence.
557 Sequence.Empty = false;
558 Sequence.LowPC = Row.Address.Address;
559 Sequence.FirstRowIndex = RowNumber;
560 }
561 LineTable->appendRow(Row);
562 if (Row.EndSequence) {
563 // Record the end of instruction sequence.
564 Sequence.HighPC = Row.Address.Address;
565 Sequence.LastRowIndex = RowNumber + 1;
566 Sequence.SectionIndex = Row.Address.SectionIndex;
567 if (Sequence.isValid())
568 LineTable->appendSequence(Sequence);
569 Sequence.reset();
570 }
571 Row.postAppend();
572}
573
576 LineTableConstIter Pos = LineTableMap.find(Offset);
577 if (Pos != LineTableMap.end())
578 return &Pos->second;
579 return nullptr;
580}
581
583 DWARFDataExtractor &DebugLineData, uint64_t Offset, const DWARFContext &Ctx,
584 const DWARFUnit *U, function_ref<void(Error)> RecoverableErrorHandler) {
585 if (!DebugLineData.isValidOffset(Offset))
586 return createStringError(errc::invalid_argument, "offset 0x%8.8" PRIx64
587 " is not a valid debug line section offset",
588 Offset);
589
590 std::pair<LineTableIter, bool> Pos =
591 LineTableMap.insert(LineTableMapTy::value_type(Offset, LineTable()));
592 LineTable *LT = &Pos.first->second;
593 if (Pos.second) {
594 if (Error Err =
595 LT->parse(DebugLineData, &Offset, Ctx, U, RecoverableErrorHandler))
596 return std::move(Err);
597 return LT;
598 }
599 return LT;
600}
601
603 LineTableMap.erase(Offset);
604}
605
606static StringRef getOpcodeName(uint8_t Opcode, uint8_t OpcodeBase) {
607 assert(Opcode != 0);
608 if (Opcode < OpcodeBase)
609 return LNStandardString(Opcode);
610 return "special";
611}
612
614DWARFDebugLine::ParsingState::advanceAddrOpIndex(uint64_t OperationAdvance,
615 uint8_t Opcode,
616 uint64_t OpcodeOffset) {
617 StringRef OpcodeName = getOpcodeName(Opcode, LineTable->Prologue.OpcodeBase);
618 // For versions less than 4, the MaxOpsPerInst member is set to 0, as the
619 // maximum_operations_per_instruction field wasn't introduced until DWARFv4.
620 // Don't warn about bad values in this situation.
621 if (ReportAdvanceAddrProblem && LineTable->Prologue.getVersion() >= 4 &&
622 LineTable->Prologue.MaxOpsPerInst == 0)
625 "line table program at offset 0x%8.8" PRIx64
626 " contains a %s opcode at offset 0x%8.8" PRIx64
627 ", but the prologue maximum_operations_per_instruction value is 0"
628 ", which is invalid. Assuming a value of 1 instead",
629 LineTableOffset, OpcodeName.data(), OpcodeOffset));
630 // Although we are able to correctly parse line number programs with
631 // MaxOpsPerInst > 1, the rest of DWARFDebugLine and its
632 // users have not been updated to handle line information for all operations
633 // in a multi-operation instruction, so warn about potentially incorrect
634 // results.
635 if (ReportAdvanceAddrProblem && LineTable->Prologue.MaxOpsPerInst > 1)
638 "line table program at offset 0x%8.8" PRIx64
639 " contains a %s opcode at offset 0x%8.8" PRIx64
640 ", but the prologue maximum_operations_per_instruction value is %" PRId8
641 ", which is experimentally supported, so line number information "
642 "may be incorrect",
643 LineTableOffset, OpcodeName.data(), OpcodeOffset,
644 LineTable->Prologue.MaxOpsPerInst));
645 if (ReportAdvanceAddrProblem && LineTable->Prologue.MinInstLength == 0)
648 "line table program at offset 0x%8.8" PRIx64
649 " contains a %s opcode at offset 0x%8.8" PRIx64
650 ", but the prologue minimum_instruction_length value "
651 "is 0, which prevents any address advancing",
652 LineTableOffset, OpcodeName.data(), OpcodeOffset));
653 ReportAdvanceAddrProblem = false;
654
655 // Advances the address and op_index according to DWARFv5, section 6.2.5.1:
656 //
657 // new address = address +
658 // minimum_instruction_length *
659 // ((op_index + operation advance) / maximum_operations_per_instruction)
660 //
661 // new op_index =
662 // (op_index + operation advance) % maximum_operations_per_instruction
663
664 // For versions less than 4, the MaxOpsPerInst member is set to 0, as the
665 // maximum_operations_per_instruction field wasn't introduced until DWARFv4.
666 uint8_t MaxOpsPerInst =
667 std::max(LineTable->Prologue.MaxOpsPerInst, uint8_t{1});
668
669 uint64_t AddrOffset = ((Row.OpIndex + OperationAdvance) / MaxOpsPerInst) *
670 LineTable->Prologue.MinInstLength;
671 Row.Address.Address += AddrOffset;
672
673 uint8_t PrevOpIndex = Row.OpIndex;
674 Row.OpIndex = (Row.OpIndex + OperationAdvance) % MaxOpsPerInst;
675 int16_t OpIndexDelta = static_cast<int16_t>(Row.OpIndex) - PrevOpIndex;
676
677 return {AddrOffset, OpIndexDelta};
678}
679
681DWARFDebugLine::ParsingState::advanceForOpcode(uint8_t Opcode,
682 uint64_t OpcodeOffset) {
683 assert(Opcode == DW_LNS_const_add_pc ||
684 Opcode >= LineTable->Prologue.OpcodeBase);
685 if (ReportBadLineRange && LineTable->Prologue.LineRange == 0) {
686 StringRef OpcodeName =
687 getOpcodeName(Opcode, LineTable->Prologue.OpcodeBase);
690 "line table program at offset 0x%8.8" PRIx64
691 " contains a %s opcode at offset 0x%8.8" PRIx64
692 ", but the prologue line_range value is 0. The "
693 "address and line will not be adjusted",
694 LineTableOffset, OpcodeName.data(), OpcodeOffset));
695 ReportBadLineRange = false;
696 }
697
698 uint8_t OpcodeValue = Opcode;
699 if (Opcode == DW_LNS_const_add_pc)
700 OpcodeValue = 255;
701 uint8_t AdjustedOpcode = OpcodeValue - LineTable->Prologue.OpcodeBase;
702 uint64_t OperationAdvance =
703 LineTable->Prologue.LineRange != 0
704 ? AdjustedOpcode / LineTable->Prologue.LineRange
705 : 0;
706 AddrOpIndexDelta Advance =
707 advanceAddrOpIndex(OperationAdvance, Opcode, OpcodeOffset);
708 return {Advance.AddrOffset, Advance.OpIndexDelta, AdjustedOpcode};
709}
710
712DWARFDebugLine::ParsingState::handleSpecialOpcode(uint8_t Opcode,
713 uint64_t OpcodeOffset) {
714 // A special opcode value is chosen based on the amount that needs
715 // to be added to the line and address registers. The maximum line
716 // increment for a special opcode is the value of the line_base
717 // field in the header, plus the value of the line_range field,
718 // minus 1 (line base + line range - 1). If the desired line
719 // increment is greater than the maximum line increment, a standard
720 // opcode must be used instead of a special opcode. The "address
721 // advance" is calculated by dividing the desired address increment
722 // by the minimum_instruction_length field from the header. The
723 // special opcode is then calculated using the following formula:
724 //
725 // opcode = (desired line increment - line_base) +
726 // (line_range * address advance) + opcode_base
727 //
728 // If the resulting opcode is greater than 255, a standard opcode
729 // must be used instead.
730 //
731 // To decode a special opcode, subtract the opcode_base from the
732 // opcode itself to give the adjusted opcode. The amount to
733 // increment the address register is the result of the adjusted
734 // opcode divided by the line_range multiplied by the
735 // minimum_instruction_length field from the header. That is:
736 //
737 // address increment = (adjusted opcode / line_range) *
738 // minimum_instruction_length
739 //
740 // The amount to increment the line register is the line_base plus
741 // the result of the adjusted opcode modulo the line_range. That is:
742 //
743 // line increment = line_base + (adjusted opcode % line_range)
744
746 advanceForOpcode(Opcode, OpcodeOffset);
747 int32_t LineOffset = 0;
748 if (LineTable->Prologue.LineRange != 0)
749 LineOffset =
750 LineTable->Prologue.LineBase +
751 (AddrAdvanceResult.AdjustedOpcode % LineTable->Prologue.LineRange);
752 Row.Line += LineOffset;
753 return {AddrAdvanceResult.AddrDelta, LineOffset,
754 AddrAdvanceResult.OpIndexDelta};
755}
756
757/// Parse a ULEB128 using the specified \p Cursor. \returns the parsed value on
758/// success, or std::nullopt if \p Cursor is in a failing state.
759template <typename T>
760static std::optional<T> parseULEB128(DWARFDataExtractor &Data,
761 DataExtractor::Cursor &Cursor) {
762 T Value = Data.getULEB128(Cursor);
763 if (Cursor)
764 return Value;
765 return std::nullopt;
766}
767
769 DWARFDataExtractor &DebugLineData, uint64_t *OffsetPtr,
770 const DWARFContext &Ctx, const DWARFUnit *U,
771 function_ref<void(Error)> RecoverableErrorHandler, raw_ostream *OS,
772 bool Verbose) {
773 assert((OS || !Verbose) && "cannot have verbose output without stream");
774 const uint64_t DebugLineOffset = *OffsetPtr;
775
776 clear();
777
778 Error PrologueErr =
779 Prologue.parse(DebugLineData, OffsetPtr, RecoverableErrorHandler, Ctx, U);
780
781 if (OS) {
782 DIDumpOptions DumpOptions;
783 DumpOptions.Verbose = Verbose;
784 Prologue.dump(*OS, DumpOptions);
785 }
786
787 if (PrologueErr) {
788 // Ensure there is a blank line after the prologue to clearly delineate it
789 // from later dumps.
790 if (OS)
791 *OS << "\n";
792 return PrologueErr;
793 }
794
796 if (!DebugLineData.isValidOffsetForDataOfSize(DebugLineOffset,
797 ProgramLength)) {
798 assert(DebugLineData.size() > DebugLineOffset &&
799 "prologue parsing should handle invalid offset");
800 uint64_t BytesRemaining = DebugLineData.size() - DebugLineOffset;
801 RecoverableErrorHandler(
803 "line table program with offset 0x%8.8" PRIx64
804 " has length 0x%8.8" PRIx64 " but only 0x%8.8" PRIx64
805 " bytes are available",
806 DebugLineOffset, ProgramLength, BytesRemaining));
807 // Continue by capping the length at the number of remaining bytes.
808 ProgramLength = BytesRemaining;
809 }
810
811 // Create a DataExtractor which can only see the data up to the end of the
812 // table, to prevent reading past the end.
813 const uint64_t EndOffset = DebugLineOffset + ProgramLength;
814 DWARFDataExtractor TableData(DebugLineData, EndOffset);
815
816 // See if we should tell the data extractor the address size.
817 if (TableData.getAddressSize() == 0)
819 else
821 Prologue.getAddressSize() == TableData.getAddressSize());
822
823 ParsingState State(this, DebugLineOffset, RecoverableErrorHandler);
824
825 *OffsetPtr = DebugLineOffset + Prologue.getLength();
826 if (OS && *OffsetPtr < EndOffset) {
827 *OS << '\n';
828 Row::dumpTableHeader(*OS, /*Indent=*/Verbose ? 12 : 0);
829 }
830 bool TombstonedAddress = false;
831 auto EmitRow = [&] {
832 if (!TombstonedAddress) {
833 if (Verbose) {
834 *OS << "\n";
835 OS->indent(12);
836 }
837 if (OS)
838 State.Row.dump(*OS);
839 State.appendRowToMatrix();
840 }
841 };
842 while (*OffsetPtr < EndOffset) {
843 DataExtractor::Cursor Cursor(*OffsetPtr);
844
845 if (Verbose)
846 *OS << format("0x%08.08" PRIx64 ": ", *OffsetPtr);
847
848 uint64_t OpcodeOffset = *OffsetPtr;
849 uint8_t Opcode = TableData.getU8(Cursor);
850 size_t RowCount = Rows.size();
851
852 if (Cursor && Verbose)
853 *OS << format("%02.02" PRIx8 " ", Opcode);
854
855 if (Opcode == 0) {
856 // Extended Opcodes always start with a zero opcode followed by
857 // a uleb128 length so you can skip ones you don't know about
858 uint64_t Len = TableData.getULEB128(Cursor);
859 uint64_t ExtOffset = Cursor.tell();
860
861 // Tolerate zero-length; assume length is correct and soldier on.
862 if (Len == 0) {
863 if (Cursor && Verbose)
864 *OS << "Badly formed extended line op (length 0)\n";
865 if (!Cursor) {
866 if (Verbose)
867 *OS << "\n";
868 RecoverableErrorHandler(Cursor.takeError());
869 }
870 *OffsetPtr = Cursor.tell();
871 continue;
872 }
873
874 uint8_t SubOpcode = TableData.getU8(Cursor);
875 // OperandOffset will be the same as ExtOffset, if it was not possible to
876 // read the SubOpcode.
877 uint64_t OperandOffset = Cursor.tell();
878 if (Verbose)
879 *OS << LNExtendedString(SubOpcode);
880 switch (SubOpcode) {
881 case DW_LNE_end_sequence:
882 // Set the end_sequence register of the state machine to true and
883 // append a row to the matrix using the current values of the
884 // state-machine registers. Then reset the registers to the initial
885 // values specified above. Every statement program sequence must end
886 // with a DW_LNE_end_sequence instruction which creates a row whose
887 // address is that of the byte after the last target machine instruction
888 // of the sequence.
889 State.Row.EndSequence = true;
890 // No need to test the Cursor is valid here, since it must be to get
891 // into this code path - if it were invalid, the default case would be
892 // followed.
893 EmitRow();
894 State.resetRowAndSequence();
895 break;
896
897 case DW_LNE_set_address:
898 // Takes a single relocatable address as an operand. The size of the
899 // operand is the size appropriate to hold an address on the target
900 // machine. Set the address register to the value given by the
901 // relocatable address and set the op_index register to 0. All of the
902 // other statement program opcodes that affect the address register
903 // add a delta to it. This instruction stores a relocatable value into
904 // it instead.
905 //
906 // Make sure the extractor knows the address size. If not, infer it
907 // from the size of the operand.
908 {
909 uint8_t ExtractorAddressSize = TableData.getAddressSize();
910 uint64_t OpcodeAddressSize = Len - 1;
911 if (ExtractorAddressSize != OpcodeAddressSize &&
912 ExtractorAddressSize != 0)
913 RecoverableErrorHandler(createStringError(
915 "mismatching address size at offset 0x%8.8" PRIx64
916 " expected 0x%2.2" PRIx8 " found 0x%2.2" PRIx64,
917 ExtOffset, ExtractorAddressSize, Len - 1));
918
919 // Assume that the line table is correct and temporarily override the
920 // address size. If the size is unsupported, give up trying to read
921 // the address and continue to the next opcode.
922 if (OpcodeAddressSize != 1 && OpcodeAddressSize != 2 &&
923 OpcodeAddressSize != 4 && OpcodeAddressSize != 8) {
924 RecoverableErrorHandler(createStringError(
926 "address size 0x%2.2" PRIx64
927 " of DW_LNE_set_address opcode at offset 0x%8.8" PRIx64
928 " is unsupported",
929 OpcodeAddressSize, ExtOffset));
930 TableData.skip(Cursor, OpcodeAddressSize);
931 } else {
932 TableData.setAddressSize(OpcodeAddressSize);
933 State.Row.Address.Address = TableData.getRelocatedAddress(
934 Cursor, &State.Row.Address.SectionIndex);
935 State.Row.OpIndex = 0;
936
937 uint64_t Tombstone =
938 dwarf::computeTombstoneAddress(OpcodeAddressSize);
939 TombstonedAddress = State.Row.Address.Address == Tombstone;
940
941 // Restore the address size if the extractor already had it.
942 if (ExtractorAddressSize != 0)
943 TableData.setAddressSize(ExtractorAddressSize);
944 }
945
946 if (Cursor && Verbose) {
947 *OS << " (";
948 DWARFFormValue::dumpAddress(*OS, OpcodeAddressSize, State.Row.Address.Address);
949 *OS << ')';
950 }
951 }
952 break;
953
954 case DW_LNE_define_file:
955 // Takes 4 arguments. The first is a null terminated string containing
956 // a source file name. The second is an unsigned LEB128 number
957 // representing the directory index of the directory in which the file
958 // was found. The third is an unsigned LEB128 number representing the
959 // time of last modification of the file. The fourth is an unsigned
960 // LEB128 number representing the length in bytes of the file. The time
961 // and length fields may contain LEB128(0) if the information is not
962 // available.
963 //
964 // The directory index represents an entry in the include_directories
965 // section of the statement program prologue. The index is LEB128(0)
966 // if the file was found in the current directory of the compilation,
967 // LEB128(1) if it was found in the first directory in the
968 // include_directories section, and so on. The directory index is
969 // ignored for file names that represent full path names.
970 //
971 // The files are numbered, starting at 1, in the order in which they
972 // appear; the names in the prologue come before names defined by
973 // the DW_LNE_define_file instruction. These numbers are used in the
974 // the file register of the state machine.
975 {
976 FileNameEntry FileEntry;
977 const char *Name = TableData.getCStr(Cursor);
978 FileEntry.Name =
979 DWARFFormValue::createFromPValue(dwarf::DW_FORM_string, Name);
980 FileEntry.DirIdx = TableData.getULEB128(Cursor);
981 FileEntry.ModTime = TableData.getULEB128(Cursor);
982 FileEntry.Length = TableData.getULEB128(Cursor);
983 Prologue.FileNames.push_back(FileEntry);
984 if (Cursor && Verbose)
985 *OS << " (" << Name << ", dir=" << FileEntry.DirIdx << ", mod_time="
986 << format("(0x%16.16" PRIx64 ")", FileEntry.ModTime)
987 << ", length=" << FileEntry.Length << ")";
988 }
989 break;
990
991 case DW_LNE_set_discriminator:
992 State.Row.Discriminator = TableData.getULEB128(Cursor);
993 if (Cursor && Verbose)
994 *OS << " (" << State.Row.Discriminator << ")";
995 break;
996
997 default:
998 if (Cursor && Verbose)
999 *OS << format("Unrecognized extended op 0x%02.02" PRIx8, SubOpcode)
1000 << format(" length %" PRIx64, Len);
1001 // Len doesn't include the zero opcode byte or the length itself, but
1002 // it does include the sub_opcode, so we have to adjust for that.
1003 TableData.skip(Cursor, Len - 1);
1004 break;
1005 }
1006 // Make sure the length as recorded in the table and the standard length
1007 // for the opcode match. If they don't, continue from the end as claimed
1008 // by the table. Similarly, continue from the claimed end in the event of
1009 // a parsing error.
1010 uint64_t End = ExtOffset + Len;
1011 if (Cursor && Cursor.tell() != End)
1012 RecoverableErrorHandler(createStringError(
1014 "unexpected line op length at offset 0x%8.8" PRIx64
1015 " expected 0x%2.2" PRIx64 " found 0x%2.2" PRIx64,
1016 ExtOffset, Len, Cursor.tell() - ExtOffset));
1017 if (!Cursor && Verbose) {
1018 DWARFDataExtractor::Cursor ByteCursor(OperandOffset);
1019 uint8_t Byte = TableData.getU8(ByteCursor);
1020 if (ByteCursor) {
1021 *OS << " (<parsing error>";
1022 do {
1023 *OS << format(" %2.2" PRIx8, Byte);
1024 Byte = TableData.getU8(ByteCursor);
1025 } while (ByteCursor);
1026 *OS << ")";
1027 }
1028
1029 // The only parse failure in this case should be if the end was reached.
1030 // In that case, throw away the error, as the main Cursor's error will
1031 // be sufficient.
1032 consumeError(ByteCursor.takeError());
1033 }
1034 *OffsetPtr = End;
1035 } else if (Opcode < Prologue.OpcodeBase) {
1036 if (Verbose)
1037 *OS << LNStandardString(Opcode);
1038 switch (Opcode) {
1039 // Standard Opcodes
1040 case DW_LNS_copy:
1041 // Takes no arguments. Append a row to the matrix using the
1042 // current values of the state-machine registers.
1043 EmitRow();
1044 break;
1045
1046 case DW_LNS_advance_pc:
1047 // Takes a single unsigned LEB128 operand as the operation advance
1048 // and modifies the address and op_index registers of the state machine
1049 // according to that.
1050 if (std::optional<uint64_t> Operand =
1051 parseULEB128<uint64_t>(TableData, Cursor)) {
1053 State.advanceAddrOpIndex(*Operand, Opcode, OpcodeOffset);
1054 if (Verbose)
1055 *OS << " (addr += " << Advance.AddrOffset
1056 << ", op-index += " << Advance.OpIndexDelta << ")";
1057 }
1058 break;
1059
1060 case DW_LNS_advance_line:
1061 // Takes a single signed LEB128 operand and adds that value to
1062 // the line register of the state machine.
1063 {
1064 int64_t LineDelta = TableData.getSLEB128(Cursor);
1065 if (Cursor) {
1066 State.Row.Line += LineDelta;
1067 if (Verbose)
1068 *OS << " (" << State.Row.Line << ")";
1069 }
1070 }
1071 break;
1072
1073 case DW_LNS_set_file:
1074 // Takes a single unsigned LEB128 operand and stores it in the file
1075 // register of the state machine.
1076 if (std::optional<uint16_t> File =
1077 parseULEB128<uint16_t>(TableData, Cursor)) {
1078 State.Row.File = *File;
1079 if (Verbose)
1080 *OS << " (" << State.Row.File << ")";
1081 }
1082 break;
1083
1084 case DW_LNS_set_column:
1085 // Takes a single unsigned LEB128 operand and stores it in the
1086 // column register of the state machine.
1087 if (std::optional<uint16_t> Column =
1088 parseULEB128<uint16_t>(TableData, Cursor)) {
1089 State.Row.Column = *Column;
1090 if (Verbose)
1091 *OS << " (" << State.Row.Column << ")";
1092 }
1093 break;
1094
1095 case DW_LNS_negate_stmt:
1096 // Takes no arguments. Set the is_stmt register of the state
1097 // machine to the logical negation of its current value.
1098 State.Row.IsStmt = !State.Row.IsStmt;
1099 break;
1100
1101 case DW_LNS_set_basic_block:
1102 // Takes no arguments. Set the basic_block register of the
1103 // state machine to true
1104 State.Row.BasicBlock = true;
1105 break;
1106
1107 case DW_LNS_const_add_pc:
1108 // Takes no arguments. Advance the address and op_index registers of
1109 // the state machine by the increments corresponding to special
1110 // opcode 255. The motivation for DW_LNS_const_add_pc is this:
1111 // when the statement program needs to advance the address by a
1112 // small amount, it can use a single special opcode, which occupies
1113 // a single byte. When it needs to advance the address by up to
1114 // twice the range of the last special opcode, it can use
1115 // DW_LNS_const_add_pc followed by a special opcode, for a total
1116 // of two bytes. Only if it needs to advance the address by more
1117 // than twice that range will it need to use both DW_LNS_advance_pc
1118 // and a special opcode, requiring three or more bytes.
1119 {
1121 State.advanceForOpcode(Opcode, OpcodeOffset);
1122 if (Verbose)
1123 *OS << format(" (addr += 0x%16.16" PRIx64 ", op-index += %" PRIu8
1124 ")",
1125 Advance.AddrDelta, Advance.OpIndexDelta);
1126 }
1127 break;
1128
1129 case DW_LNS_fixed_advance_pc:
1130 // Takes a single uhalf operand. Add to the address register of
1131 // the state machine the value of the (unencoded) operand and set
1132 // the op_index register to 0. This is the only extended opcode that
1133 // takes an argument that is not a variable length number.
1134 // The motivation for DW_LNS_fixed_advance_pc is this: existing
1135 // assemblers cannot emit DW_LNS_advance_pc or special opcodes because
1136 // they cannot encode LEB128 numbers or judge when the computation
1137 // of a special opcode overflows and requires the use of
1138 // DW_LNS_advance_pc. Such assemblers, however, can use
1139 // DW_LNS_fixed_advance_pc instead, sacrificing compression.
1140 {
1141 uint16_t PCOffset =
1142 TableData.getRelocatedValue(Cursor, 2);
1143 if (Cursor) {
1144 State.Row.Address.Address += PCOffset;
1145 State.Row.OpIndex = 0;
1146 if (Verbose)
1147 *OS << format(" (addr += 0x%4.4" PRIx16 ", op-index = 0)",
1148 PCOffset);
1149 }
1150 }
1151 break;
1152
1153 case DW_LNS_set_prologue_end:
1154 // Takes no arguments. Set the prologue_end register of the
1155 // state machine to true
1156 State.Row.PrologueEnd = true;
1157 break;
1158
1159 case DW_LNS_set_epilogue_begin:
1160 // Takes no arguments. Set the basic_block register of the
1161 // state machine to true
1162 State.Row.EpilogueBegin = true;
1163 break;
1164
1165 case DW_LNS_set_isa:
1166 // Takes a single unsigned LEB128 operand and stores it in the
1167 // ISA register of the state machine.
1168 if (std::optional<uint8_t> Isa =
1169 parseULEB128<uint8_t>(TableData, Cursor)) {
1170 State.Row.Isa = *Isa;
1171 if (Verbose)
1172 *OS << " (" << (uint64_t)State.Row.Isa << ")";
1173 }
1174 break;
1175
1176 default:
1177 // Handle any unknown standard opcodes here. We know the lengths
1178 // of such opcodes because they are specified in the prologue
1179 // as a multiple of LEB128 operands for each opcode.
1180 {
1181 assert(Opcode - 1U < Prologue.StandardOpcodeLengths.size());
1182 if (Verbose)
1183 *OS << "Unrecognized standard opcode";
1184 uint8_t OpcodeLength = Prologue.StandardOpcodeLengths[Opcode - 1];
1185 std::vector<uint64_t> Operands;
1186 for (uint8_t I = 0; I < OpcodeLength; ++I) {
1187 if (std::optional<uint64_t> Value =
1188 parseULEB128<uint64_t>(TableData, Cursor))
1189 Operands.push_back(*Value);
1190 else
1191 break;
1192 }
1193 if (Verbose && !Operands.empty()) {
1194 *OS << " (operands: ";
1195 bool First = true;
1196 for (uint64_t Value : Operands) {
1197 if (!First)
1198 *OS << ", ";
1199 First = false;
1200 *OS << format("0x%16.16" PRIx64, Value);
1201 }
1202 if (Verbose)
1203 *OS << ')';
1204 }
1205 }
1206 break;
1207 }
1208
1209 *OffsetPtr = Cursor.tell();
1210 } else {
1211 // Special Opcodes.
1213 State.handleSpecialOpcode(Opcode, OpcodeOffset);
1214
1215 if (Verbose)
1216 *OS << "address += " << Delta.Address << ", line += " << Delta.Line
1217 << ", op-index += " << Delta.OpIndex;
1218 EmitRow();
1219 *OffsetPtr = Cursor.tell();
1220 }
1221
1222 // When a row is added to the matrix, it is also dumped, which includes a
1223 // new line already, so don't add an extra one.
1224 if (Verbose && Rows.size() == RowCount)
1225 *OS << "\n";
1226
1227 // Most parse failures other than when parsing extended opcodes are due to
1228 // failures to read ULEBs. Bail out of parsing, since we don't know where to
1229 // continue reading from as there is no stated length for such byte
1230 // sequences. Print the final trailing new line if needed before doing so.
1231 if (!Cursor && Opcode != 0) {
1232 if (Verbose)
1233 *OS << "\n";
1234 return Cursor.takeError();
1235 }
1236
1237 if (!Cursor)
1238 RecoverableErrorHandler(Cursor.takeError());
1239 }
1240
1241 if (!State.Sequence.Empty)
1242 RecoverableErrorHandler(createStringError(
1244 "last sequence in debug line table at offset 0x%8.8" PRIx64
1245 " is not terminated",
1246 DebugLineOffset));
1247
1248 // Sort all sequences so that address lookup will work faster.
1249 if (!Sequences.empty()) {
1251 // Note: actually, instruction address ranges of sequences should not
1252 // overlap (in shared objects and executables). If they do, the address
1253 // lookup would still work, though, but result would be ambiguous.
1254 // We don't report warning in this case. For example,
1255 // sometimes .so compiled from multiple object files contains a few
1256 // rudimentary sequences for address ranges [0x0, 0xsomething).
1257 }
1258
1259 // Terminate the table with a final blank line to clearly delineate it from
1260 // later dumps.
1261 if (OS)
1262 *OS << "\n";
1263
1264 return Error::success();
1265}
1266
1267uint32_t DWARFDebugLine::LineTable::findRowInSeq(
1268 const DWARFDebugLine::Sequence &Seq,
1270 if (!Seq.containsPC(Address))
1271 return UnknownRowIndex;
1272 assert(Seq.SectionIndex == Address.SectionIndex);
1273 // In some cases, e.g. first instruction in a function, the compiler generates
1274 // two entries, both with the same address. We want the last one.
1275 //
1276 // In general we want a non-empty range: the last row whose address is less
1277 // than or equal to Address. This can be computed as upper_bound - 1.
1278 //
1279 // TODO: This function, and its users, needs to be update to return multiple
1280 // rows for bundles with multiple op-indexes.
1283 RowIter FirstRow = Rows.begin() + Seq.FirstRowIndex;
1284 RowIter LastRow = Rows.begin() + Seq.LastRowIndex;
1285 assert(FirstRow->Address.Address <= Row.Address.Address &&
1286 Row.Address.Address < LastRow[-1].Address.Address);
1287 RowIter RowPos = std::upper_bound(FirstRow + 1, LastRow - 1, Row,
1289 1;
1290 assert(Seq.SectionIndex == RowPos->Address.SectionIndex);
1291 return RowPos - Rows.begin();
1292}
1293
1296
1297 // Search for relocatable addresses
1298 uint32_t Result = lookupAddressImpl(Address);
1299
1300 if (Result != UnknownRowIndex ||
1302 return Result;
1303
1304 // Search for absolute addresses
1306 return lookupAddressImpl(Address);
1307}
1308
1309uint32_t DWARFDebugLine::LineTable::lookupAddressImpl(
1311 // First, find an instruction sequence containing the given address.
1313 Sequence.SectionIndex = Address.SectionIndex;
1314 Sequence.HighPC = Address.Address;
1315 SequenceIter It = llvm::upper_bound(Sequences, Sequence,
1317 if (It == Sequences.end() || It->SectionIndex != Address.SectionIndex)
1318 return UnknownRowIndex;
1319 return findRowInSeq(*It, Address);
1320}
1321
1324 std::vector<uint32_t> &Result) const {
1325
1326 // Search for relocatable addresses
1327 if (lookupAddressRangeImpl(Address, Size, Result))
1328 return true;
1329
1331 return false;
1332
1333 // Search for absolute addresses
1335 return lookupAddressRangeImpl(Address, Size, Result);
1336}
1337
1338bool DWARFDebugLine::LineTable::lookupAddressRangeImpl(
1340 std::vector<uint32_t> &Result) const {
1341 if (Sequences.empty())
1342 return false;
1343 uint64_t EndAddr = Address.Address + Size;
1344 // First, find an instruction sequence containing the given address.
1346 Sequence.SectionIndex = Address.SectionIndex;
1347 Sequence.HighPC = Address.Address;
1348 SequenceIter LastSeq = Sequences.end();
1349 SequenceIter SeqPos = llvm::upper_bound(
1351 if (SeqPos == LastSeq || !SeqPos->containsPC(Address))
1352 return false;
1353
1354 SequenceIter StartPos = SeqPos;
1355
1356 // Add the rows from the first sequence to the vector, starting with the
1357 // index we just calculated
1358
1359 while (SeqPos != LastSeq && SeqPos->LowPC < EndAddr) {
1360 const DWARFDebugLine::Sequence &CurSeq = *SeqPos;
1361 // For the first sequence, we need to find which row in the sequence is the
1362 // first in our range.
1363 uint32_t FirstRowIndex = CurSeq.FirstRowIndex;
1364 if (SeqPos == StartPos)
1365 FirstRowIndex = findRowInSeq(CurSeq, Address);
1366
1367 // Figure out the last row in the range.
1368 uint32_t LastRowIndex =
1369 findRowInSeq(CurSeq, {EndAddr - 1, Address.SectionIndex});
1370 if (LastRowIndex == UnknownRowIndex)
1371 LastRowIndex = CurSeq.LastRowIndex - 1;
1372
1373 assert(FirstRowIndex != UnknownRowIndex);
1374 assert(LastRowIndex != UnknownRowIndex);
1375
1376 for (uint32_t I = FirstRowIndex; I <= LastRowIndex; ++I) {
1377 Result.push_back(I);
1378 }
1379
1380 ++SeqPos;
1381 }
1382
1383 return true;
1384}
1385
1386std::optional<StringRef>
1387DWARFDebugLine::LineTable::getSourceByIndex(uint64_t FileIndex,
1388 FileLineInfoKind Kind) const {
1389 if (Kind == FileLineInfoKind::None || !Prologue.hasFileAtIndex(FileIndex))
1390 return std::nullopt;
1391 const FileNameEntry &Entry = Prologue.getFileNameEntry(FileIndex);
1392 if (auto E = dwarf::toString(Entry.Source))
1393 return StringRef(*E);
1394 return std::nullopt;
1395}
1396
1397static bool isPathAbsoluteOnWindowsOrPosix(const Twine &Path) {
1398 // Debug info can contain paths from any OS, not necessarily
1399 // an OS we're currently running on. Moreover different compilation units can
1400 // be compiled on different operating systems and linked together later.
1403}
1404
1406 uint64_t FileIndex, StringRef CompDir, FileLineInfoKind Kind,
1407 std::string &Result, sys::path::Style Style) const {
1408 if (Kind == FileLineInfoKind::None || !hasFileAtIndex(FileIndex))
1409 return false;
1410 const FileNameEntry &Entry = getFileNameEntry(FileIndex);
1411 auto E = dwarf::toString(Entry.Name);
1412 if (!E)
1413 return false;
1414 StringRef FileName = *E;
1415 if (Kind == FileLineInfoKind::RawValue ||
1417 Result = std::string(FileName);
1418 return true;
1419 }
1420 if (Kind == FileLineInfoKind::BaseNameOnly) {
1421 Result = std::string(llvm::sys::path::filename(FileName));
1422 return true;
1423 }
1424
1425 SmallString<16> FilePath;
1426 StringRef IncludeDir;
1427 // Be defensive about the contents of Entry.
1428 if (getVersion() >= 5) {
1429 // DirIdx 0 is the compilation directory, so don't include it for
1430 // relative names.
1431 if ((Entry.DirIdx != 0 || Kind != FileLineInfoKind::RelativeFilePath) &&
1432 Entry.DirIdx < IncludeDirectories.size())
1433 IncludeDir = dwarf::toStringRef(IncludeDirectories[Entry.DirIdx]);
1434 } else {
1435 if (0 < Entry.DirIdx && Entry.DirIdx <= IncludeDirectories.size())
1436 IncludeDir = dwarf::toStringRef(IncludeDirectories[Entry.DirIdx - 1]);
1437 }
1438
1439 // For absolute paths only, include the compilation directory of compile unit,
1440 // unless v5 DirIdx == 0 (IncludeDir indicates the compilation directory). We
1441 // know that FileName is not absolute, the only way to have an absolute path
1442 // at this point would be if IncludeDir is absolute.
1443 if (Kind == FileLineInfoKind::AbsoluteFilePath &&
1444 (getVersion() < 5 || Entry.DirIdx != 0) && !CompDir.empty() &&
1445 !isPathAbsoluteOnWindowsOrPosix(IncludeDir))
1446 sys::path::append(FilePath, Style, CompDir);
1447
1448 assert((Kind == FileLineInfoKind::AbsoluteFilePath ||
1449 Kind == FileLineInfoKind::RelativeFilePath) &&
1450 "invalid FileLineInfo Kind");
1451
1452 // sys::path::append skips empty strings.
1453 sys::path::append(FilePath, Style, IncludeDir, FileName);
1454 Result = std::string(FilePath.str());
1455 return true;
1456}
1457
1459 object::SectionedAddress Address, const char *CompDir,
1460 FileLineInfoKind Kind, DILineInfo &Result) const {
1461 // Get the index of row we're looking for in the line table.
1462 uint32_t RowIndex = lookupAddress(Address);
1463 if (RowIndex == -1U)
1464 return false;
1465 // Take file number and line/column from the row.
1466 const auto &Row = Rows[RowIndex];
1467 if (!getFileNameByIndex(Row.File, CompDir, Kind, Result.FileName))
1468 return false;
1469 Result.Line = Row.Line;
1470 Result.Column = Row.Column;
1471 Result.Discriminator = Row.Discriminator;
1472 Result.Source = getSourceByIndex(Row.File, Kind);
1473 return true;
1474}
1475
1477 const FileNameEntry &Entry, std::string &Directory) const {
1478 if (Prologue.getVersion() >= 5) {
1479 if (Entry.DirIdx < Prologue.IncludeDirectories.size()) {
1480 Directory =
1481 dwarf::toString(Prologue.IncludeDirectories[Entry.DirIdx], "");
1482 return true;
1483 }
1484 return false;
1485 }
1486 if (0 < Entry.DirIdx && Entry.DirIdx <= Prologue.IncludeDirectories.size()) {
1487 Directory =
1488 dwarf::toString(Prologue.IncludeDirectories[Entry.DirIdx - 1], "");
1489 return true;
1490 }
1491 return false;
1492}
1493
1494// We want to supply the Unit associated with a .debug_line[.dwo] table when
1495// we dump it, if possible, but still dump the table even if there isn't a Unit.
1496// Therefore, collect up handles on all the Units that point into the
1497// line-table section.
1501 for (const auto &U : Units)
1502 if (auto CUDIE = U->getUnitDIE())
1503 if (auto StmtOffset = toSectionOffset(CUDIE.find(DW_AT_stmt_list)))
1504 LineToUnit.insert(std::make_pair(*StmtOffset, &*U));
1505 return LineToUnit;
1506}
1507
1511 : DebugLineData(Data), Context(C) {
1512 LineToUnit = buildLineToUnitMap(Units);
1513 if (!DebugLineData.isValidOffset(Offset))
1514 Done = true;
1515}
1516
1518 return TotalLength != 0u;
1519}
1520
1522 function_ref<void(Error)> RecoverableErrorHandler,
1523 function_ref<void(Error)> UnrecoverableErrorHandler, raw_ostream *OS,
1524 bool Verbose) {
1525 assert(DebugLineData.isValidOffset(Offset) &&
1526 "parsing should have terminated");
1527 DWARFUnit *U = prepareToParse(Offset);
1528 uint64_t OldOffset = Offset;
1529 LineTable LT;
1530 if (Error Err = LT.parse(DebugLineData, &Offset, Context, U,
1531 RecoverableErrorHandler, OS, Verbose))
1532 UnrecoverableErrorHandler(std::move(Err));
1533 moveToNextTable(OldOffset, LT.Prologue);
1534 return LT;
1535}
1536
1538 function_ref<void(Error)> RecoverableErrorHandler,
1539 function_ref<void(Error)> UnrecoverableErrorHandler) {
1540 assert(DebugLineData.isValidOffset(Offset) &&
1541 "parsing should have terminated");
1542 DWARFUnit *U = prepareToParse(Offset);
1543 uint64_t OldOffset = Offset;
1544 LineTable LT;
1545 if (Error Err = LT.Prologue.parse(DebugLineData, &Offset,
1546 RecoverableErrorHandler, Context, U))
1547 UnrecoverableErrorHandler(std::move(Err));
1548 moveToNextTable(OldOffset, LT.Prologue);
1549}
1550
1551DWARFUnit *DWARFDebugLine::SectionParser::prepareToParse(uint64_t Offset) {
1552 DWARFUnit *U = nullptr;
1553 auto It = LineToUnit.find(Offset);
1554 if (It != LineToUnit.end())
1555 U = It->second;
1556 DebugLineData.setAddressSize(U ? U->getAddressByteSize() : 0);
1557 return U;
1558}
1559
1560bool DWARFDebugLine::SectionParser::hasValidVersion(uint64_t Offset) {
1562 auto [TotalLength, _] = DebugLineData.getInitialLength(Cursor);
1563 DWARFDataExtractor HeaderData(DebugLineData, Cursor.tell() + TotalLength);
1564 uint16_t Version = HeaderData.getU16(Cursor);
1565 if (!Cursor) {
1566 // Ignore any error here.
1567 // If this is not the end of the section parseNext() will still be
1568 // attempted, where this error will occur again (and can be handled).
1569 consumeError(Cursor.takeError());
1570 return false;
1571 }
1572 return versionIsSupported(Version);
1573}
1574
1575void DWARFDebugLine::SectionParser::moveToNextTable(uint64_t OldOffset,
1576 const Prologue &P) {
1577 // If the length field is not valid, we don't know where the next table is, so
1578 // cannot continue to parse. Mark the parser as done, and leave the Offset
1579 // value as it currently is. This will be the end of the bad length field.
1580 if (!P.totalLengthIsValid()) {
1581 Done = true;
1582 return;
1583 }
1584
1585 Offset = OldOffset + P.TotalLength + P.sizeofTotalLength();
1586 if (!DebugLineData.isValidOffset(Offset)) {
1587 Done = true;
1588 return;
1589 }
1590
1591 // Heuristic: If the version is valid, then this is probably a line table.
1592 // Otherwise, the offset might need alignment (to a 4 or 8 byte boundary).
1593 if (hasValidVersion(Offset))
1594 return;
1595
1596 // ARM C/C++ Compiler aligns each line table to word boundaries and pads out
1597 // the .debug_line section to a word multiple. Note that in the specification
1598 // this does not seem forbidden since each unit has a DW_AT_stmt_list.
1599 for (unsigned Align : {4, 8}) {
1600 uint64_t AlignedOffset = alignTo(Offset, Align);
1601 if (!DebugLineData.isValidOffset(AlignedOffset)) {
1602 // This is almost certainly not another line table but some alignment
1603 // padding. This assumes the alignments tested are ordered, and are
1604 // smaller than the header size (which is true for 4 and 8).
1605 Done = true;
1606 return;
1607 }
1608 if (hasValidVersion(AlignedOffset)) {
1609 Offset = AlignedOffset;
1610 break;
1611 }
1612 }
1613}
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
static void clear(coro::Shape &Shape)
Definition: Coroutines.cpp:150
static Error parseV5DirFileTables(const DWARFDataExtractor &DebugLineData, uint64_t *OffsetPtr, const dwarf::FormParams &FormParams, const DWARFContext &Ctx, const DWARFUnit *U, DWARFDebugLine::ContentTypeTracker &ContentTypes, std::vector< DWARFFormValue > &IncludeDirectories, std::vector< DWARFDebugLine::FileNameEntry > &FileNames)
static Error parseV2DirFileTables(const DWARFDataExtractor &DebugLineData, uint64_t *OffsetPtr, DWARFDebugLine::ContentTypeTracker &ContentTypes, std::vector< DWARFFormValue > &IncludeDirectories, std::vector< DWARFDebugLine::FileNameEntry > &FileNames)
static llvm::Expected< ContentDescriptors > parseV5EntryFormat(const DWARFDataExtractor &DebugLineData, uint64_t *OffsetPtr, DWARFDebugLine::ContentTypeTracker *ContentTypes)
static DWARFDebugLine::SectionParser::LineToUnitMap buildLineToUnitMap(DWARFUnitVector::iterator_range Units)
static bool isPathAbsoluteOnWindowsOrPosix(const Twine &Path)
static bool versionIsSupported(uint16_t Version)
static StringRef getOpcodeName(uint8_t Opcode, uint8_t OpcodeBase)
static std::optional< T > parseULEB128(DWARFDataExtractor &Data, DataExtractor::Cursor &Cursor)
Parse a ULEB128 using the specified Cursor.
This file contains constants used for implementing Dwarf debug support.
std::string Name
uint64_t Size
bool End
Definition: ELF_riscv.cpp:469
static fatal_error_handler_t ErrorHandler
#define _
@ EndSequence
End of the line table.
Definition: LineTable.cpp:17
#define I(x, y, z)
Definition: MD5.cpp:58
mir Rename Register Operands
LLVMContext & Context
#define P(N)
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
unsigned OpIndex
raw_pwrite_stream & OS
This file defines the SmallString class.
This file defines the SmallVector class.
LLVM Basic Block Representation.
Definition: BasicBlock.h:56
DWARFContext This data structure is the top level entity that deals with dwarf debug information pars...
Definition: DWARFContext.h:48
A DataExtractor (typically for an in-memory copy of an object-file section) plus a relocation map for...
uint64_t getRelocatedAddress(uint64_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...
std::pair< uint64_t, dwarf::DwarfFormat > getInitialLength(uint64_t *Off, Error *Err=nullptr) const
Extracts the DWARF "initial length" field, which can either be a 32-bit value smaller than 0xfffffff0...
uint64_t getRelocatedValue(uint32_t Size, uint64_t *Off, uint64_t *SectionIndex=nullptr, Error *Err=nullptr) const
Extracts a value and applies a relocation to the result if one exists for the given offset.
void skip(function_ref< void(Error)> RecoverableErrorHandler, function_ref< void(Error)> UnrecoverableErrorHandler)
Skip the current line table and go to the following line table (if present) immediately.
std::map< uint64_t, DWARFUnit * > LineToUnitMap
LineTable parseNext(function_ref< void(Error)> RecoverableErrorHandler, function_ref< void(Error)> UnrecoverableErrorHandler, raw_ostream *OS=nullptr, bool Verbose=false)
Get the next line table from the section.
SectionParser(DWARFDataExtractor &Data, const DWARFContext &C, DWARFUnitVector::iterator_range Units)
void clearLineTable(uint64_t Offset)
Expected< const LineTable * > getOrParseLineTable(DWARFDataExtractor &DebugLineData, uint64_t Offset, const DWARFContext &Ctx, const DWARFUnit *U, function_ref< void(Error)> RecoverableErrorHandler)
const LineTable * getLineTable(uint64_t Offset) const
void dumpAddress(raw_ostream &OS, uint64_t Address) const
static DWARFFormValue createFromPValue(dwarf::Form F, const char *V)
void dump(raw_ostream &OS, DIDumpOptions DumpOpts=DIDumpOptions()) const
A class representing a position in a DataExtractor, as well as any error encountered during extractio...
Definition: DataExtractor.h:54
uint64_t tell() const
Return the current position of this Cursor.
Definition: DataExtractor.h:71
Error takeError()
Return error contained inside this Cursor, if any.
Definition: DataExtractor.h:78
size_t size() const
Return the number of bytes in the underlying buffer.
const char * getCStr(uint64_t *OffsetPtr, Error *Err=nullptr) const
Extract a C string from *offset_ptr.
StringRef getCStrRef(uint64_t *OffsetPtr, Error *Err=nullptr) const
Extract a C string from *offset_ptr.
uint8_t getU8(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint8_t value from *offset_ptr.
uint64_t getULEB128(uint64_t *offset_ptr, llvm::Error *Err=nullptr) const
Extract a unsigned LEB128 value from *offset_ptr.
uint8_t getAddressSize() const
Get the address size for this extractor.
Definition: DataExtractor.h:99
int64_t getSLEB128(uint64_t *OffsetPtr, Error *Err=nullptr) const
Extract a signed LEB128 value from *offset_ptr.
uint16_t getU16(uint64_t *offset_ptr, Error *Err=nullptr) const
Extract a uint16_t value from *offset_ptr.
void skip(Cursor &C, uint64_t Length) const
Advance the Cursor position by the given number of bytes.
void setAddressSize(uint8_t Size)
Set the address size for this extractor.
bool isValidOffset(uint64_t offset) const
Test the validity of offset.
bool isValidOffsetForDataOfSize(uint64_t offset, uint64_t length) const
Test the availability of length bytes of data from offset.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:154
static ErrorSuccess success()
Create a success value.
Definition: Error.h:328
Tagged union holding either a T or a Error.
Definition: Error.h:468
Error takeError()
Take ownership of the stored error.
Definition: Error.h:595
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition: SmallString.h:26
StringRef str() const
Explicit conversion to StringRef.
Definition: SmallString.h:261
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1200
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
constexpr bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:134
const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:131
Twine - A lightweight data structure for efficiently representing the concatenation of temporary valu...
Definition: Twine.h:81
The instances of the Type class are immutable: once they are created, they are never changed.
Definition: Type.h:45
LLVM Value Representation.
Definition: Value.h:74
An efficient, type-erasing, non-owning reference to a callable.
A range adaptor for a pair of iterators.
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
raw_ostream & indent(unsigned NumSpaces)
indent - Insert 'NumSpaces' spaces.
StringRef LNExtendedString(unsigned Encoding)
Definition: Dwarf.cpp:481
StringRef FormatString(DwarfFormat Format)
Definition: Dwarf.cpp:826
StringRef LNStandardString(unsigned Standard)
Definition: Dwarf.cpp:470
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
LineNumberEntryFormat
Definition: Dwarf.h:463
std::optional< const char * > toString(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract a string value from it.
LineNumberOps
Line Number Standard Opcode Encodings.
Definition: Dwarf.h:450
@ DWARF32
Definition: Dwarf.h:91
std::optional< uint64_t > toSectionOffset(const std::optional< DWARFFormValue > &V)
Take an optional DWARFFormValue and try to extract an section offset.
StringRef toStringRef(const std::optional< DWARFFormValue > &V, StringRef Default={})
Take an optional DWARFFormValue and try to extract a string value from it.
uint8_t getDwarfOffsetByteSize(DwarfFormat Format)
The size of a reference determined by the DWARF 32/64-bit format.
Definition: Dwarf.h:730
uint64_t computeTombstoneAddress(uint8_t AddressByteSize)
Definition: Dwarf.h:871
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
StringRef filename(StringRef path, Style style=Style::native)
Get filename.
Definition: Path.cpp:579
bool is_absolute(const Twine &path, Style style=Style::native)
Is path absolute?
Definition: Path.cpp:673
void append(SmallVectorImpl< char > &path, const Twine &a, const Twine &b="", const Twine &c="", const Twine &d="")
Append to path.
Definition: Path.cpp:458
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
@ Offset
Definition: DWP.cpp:440
@ Length
Definition: DWP.cpp:440
auto formatv(const char *Fmt, Ts &&... Vals) -> formatv_object< decltype(std::make_tuple(detail::build_format_adapter(std::forward< Ts >(Vals))...))>
@ Done
Definition: Threading.h:61
SmallVectorImpl< T >::const_pointer c_str(SmallVectorImpl< T > &str)
auto upper_bound(R &&Range, T &&Value)
Provide wrappers to std::upper_bound which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:1959
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition: Error.h:1238
@ illegal_byte_sequence
Error joinErrors(Error E1, Error E2)
Concatenate errors.
Definition: Error.h:425
void sort(IteratorTy Start, IteratorTy End)
Definition: STLExtras.h:1652
format_object< Ts... > format(const char *Fmt, const Ts &... Vals)
These are helper functions used to produce formatted output.
Definition: Format.h:125
@ First
Helpers to iterate all locations in the MemoryEffectsBase class.
uint64_t alignTo(uint64_t Size, Align A)
Returns a multiple of A needed to store Size bytes.
Definition: Alignment.h:155
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:1035
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition: Alignment.h:39
Container for dump options that control which debug information will be dumped.
Definition: DIContext.h:193
A format-neutral container for source line information.
Definition: DIContext.h:32
Tracks which optional content types are present in a DWARF file name entry format.
bool HasLength
Whether filename entries provide a file size.
bool HasSource
For v5, whether filename entries provide source text.
bool HasModTime
Whether filename entries provide a modification timestamp.
bool HasMD5
For v5, whether filename entries provide an MD5 checksum.
void trackContentType(dwarf::LineNumberEntryFormat ContentType)
Update tracked content types with ContentType.
bool getDirectoryForEntry(const FileNameEntry &Entry, std::string &Directory) const
Extracts directory name by its Entry in include directories table in prologue.
Error parse(DWARFDataExtractor &DebugLineData, uint64_t *OffsetPtr, const DWARFContext &Ctx, const DWARFUnit *U, function_ref< void(Error)> RecoverableErrorHandler, raw_ostream *OS=nullptr, bool Verbose=false)
Parse prologue and all rows.
uint32_t lookupAddress(object::SectionedAddress Address) const
Returns the index of the row with file/line info for a given address, or UnknownRowIndex if there is ...
bool getFileLineInfoForAddress(object::SectionedAddress Address, const char *CompDir, DILineInfoSpecifier::FileLineInfoKind Kind, DILineInfo &Result) const
Fills the Result argument with the file and line information corresponding to Address.
bool lookupAddressRange(object::SectionedAddress Address, uint64_t Size, std::vector< uint32_t > &Result) const
void dump(raw_ostream &OS, DIDumpOptions DumpOptions) const
bool hasFileAtIndex(uint64_t FileIndex) const
void dump(raw_ostream &OS, DIDumpOptions DumpOptions) const
uint32_t sizeofTotalLength() const
std::optional< uint64_t > getLastValidFileIndex() const
Error parse(DWARFDataExtractor Data, uint64_t *OffsetPtr, function_ref< void(Error)> RecoverableErrorHandler, const DWARFContext &Ctx, const DWARFUnit *U=nullptr)
std::vector< DWARFFormValue > IncludeDirectories
uint8_t OpcodeBase
The number assigned to the first special opcode.
std::vector< uint8_t > StandardOpcodeLengths
const llvm::DWARFDebugLine::FileNameEntry & getFileNameEntry(uint64_t Index) const
Get DWARF-version aware access to the file name entry at the provided index.
bool getFileNameByIndex(uint64_t FileIndex, StringRef CompDir, DILineInfoSpecifier::FileLineInfoKind Kind, std::string &Result, sys::path::Style Style=sys::path::Style::native) const
uint64_t TotalLength
The size in bytes of the statement information for this compilation unit (not including the total_len...
uint64_t getLength() const
Length of the prologue in bytes.
std::vector< FileNameEntry > FileNames
Standard .debug_line state machine structure.
static bool orderByAddress(const Row &LHS, const Row &RHS)
uint32_t Line
An unsigned integer indicating a source line number.
uint16_t File
An unsigned integer indicating the identity of the source file corresponding to a machine instruction...
uint32_t Discriminator
An unsigned integer representing the DWARF path discriminator value for this location.
object::SectionedAddress Address
The program-counter value corresponding to a machine instruction generated by the compiler and sectio...
void postAppend()
Called after a row is appended to the matrix.
uint16_t Column
An unsigned integer indicating a column number within a source line.
static void dumpTableHeader(raw_ostream &OS, unsigned Indent)
void reset(bool DefaultIsStmt)
Row(bool DefaultIsStmt=false)
void dump(raw_ostream &OS) const
Represents a series of contiguous machine instructions.
static bool orderByHighPC(const Sequence &LHS, const Sequence &RHS)
bool containsPC(object::SectionedAddress PC) const
uint64_t SectionIndex
If relocation information is present then this is the index of the section which contains above addre...
SmallString< 32 > digest() const
Definition: MD5.cpp:281
A helper struct providing information about the byte size of DW_FORM values that vary in size dependi...
Definition: Dwarf.h:743
DwarfFormat Format
Definition: Dwarf.h:746
static const uint64_t UndefSection
Definition: ObjectFile.h:146