1 | //===- DWARFDebugPubTable.h -------------------------------------*- C++ -*-===// |
2 | // |
3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
4 | // See https://llvm.org/LICENSE.txt for license information. |
5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
6 | // |
7 | //===----------------------------------------------------------------------===// |
8 | |
9 | #ifndef LLVM_DEBUGINFO_DWARF_DWARFDEBUGPUBTABLE_H |
10 | #define LLVM_DEBUGINFO_DWARF_DWARFDEBUGPUBTABLE_H |
11 | |
12 | #include "llvm/ADT/ArrayRef.h" |
13 | #include "llvm/ADT/STLFunctionalExtras.h" |
14 | #include "llvm/ADT/StringRef.h" |
15 | #include "llvm/BinaryFormat/Dwarf.h" |
16 | #include <cstdint> |
17 | #include <vector> |
18 | |
19 | namespace llvm { |
20 | |
21 | class raw_ostream; |
22 | class ; |
23 | class Error; |
24 | |
25 | /// Represents structure for holding and parsing .debug_pub* tables. |
26 | class DWARFDebugPubTable { |
27 | public: |
28 | struct Entry { |
29 | /// Section offset from the beginning of the compilation unit. |
30 | uint64_t SecOffset; |
31 | |
32 | /// An entry of the various gnu_pub* debug sections. |
33 | dwarf::PubIndexEntryDescriptor Descriptor; |
34 | |
35 | /// The name of the object as given by the DW_AT_name attribute of the |
36 | /// referenced DIE. |
37 | StringRef Name; |
38 | }; |
39 | |
40 | /// Each table consists of sets of variable length entries. Each set describes |
41 | /// the names of global objects and functions, or global types, respectively, |
42 | /// whose definitions are represented by debugging information entries owned |
43 | /// by a single compilation unit. |
44 | struct Set { |
45 | /// The total length of the entries for that set, not including the length |
46 | /// field itself. |
47 | uint64_t Length; |
48 | |
49 | /// The DWARF format of the set. |
50 | dwarf::DwarfFormat Format; |
51 | |
52 | /// This number is specific to the name lookup table and is independent of |
53 | /// the DWARF version number. |
54 | uint16_t Version; |
55 | |
56 | /// The offset from the beginning of the .debug_info section of the |
57 | /// compilation unit header referenced by the set. |
58 | uint64_t Offset; |
59 | |
60 | /// The size in bytes of the contents of the .debug_info section generated |
61 | /// to represent that compilation unit. |
62 | uint64_t Size; |
63 | |
64 | std::vector<Entry> Entries; |
65 | }; |
66 | |
67 | private: |
68 | std::vector<Set> Sets; |
69 | |
70 | /// gnu styled tables contains additional information. |
71 | /// This flag determines whether or not section we parse is debug_gnu* table. |
72 | bool GnuStyle = false; |
73 | |
74 | public: |
75 | DWARFDebugPubTable() = default; |
76 | |
77 | void (DWARFDataExtractor Data, bool GnuStyle, |
78 | function_ref<void(Error)> RecoverableErrorHandler); |
79 | |
80 | void dump(raw_ostream &OS) const; |
81 | |
82 | ArrayRef<Set> getData() { return Sets; } |
83 | }; |
84 | |
85 | } // end namespace llvm |
86 | |
87 | #endif // LLVM_DEBUGINFO_DWARF_DWARFDEBUGPUBTABLE_H |
88 | |