clang -cc1 -cc1 -triple amd64-unknown-openbsd7.0 -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name DWARFDebugLine.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -mrelocation-model pic -pic-level 1 -fhalf-no-semantic-interposition -mframe-pointer=all -relaxed-aliasing -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -fcoverage-compilation-dir=/usr/src/gnu/usr.bin/clang/libLLVM/obj -resource-dir /usr/local/lib/clang/13.0.0 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/AMDGPU -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Analysis -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ASMParser -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/BinaryFormat -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitcode -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitcode -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Bitstream -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /include/llvm/CodeGen -I /include/llvm/CodeGen/PBQP -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/IR -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IR -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Coroutines -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ProfileData/Coverage -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/CodeView -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/DWARF -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/MSF -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/PDB -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Demangle -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine/JITLink -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ExecutionEngine/Orc -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend/OpenACC -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Frontend/OpenMP -I /include/llvm/CodeGen/GlobalISel -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/IRReader -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/InstCombine -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/Transforms/InstCombine -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/LTO -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Linker -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/MC -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/MC/MCParser -I /include/llvm/CodeGen/MIRParser -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Object -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Option -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Passes -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ProfileData -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Scalar -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/ADT -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Support -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/DebugInfo/Symbolize -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Target -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Utils -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/Vectorize -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include/llvm/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/Target/X86 -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include/llvm/Transforms/IPO -I /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/include -I /usr/src/gnu/usr.bin/clang/libLLVM/../include -I /usr/src/gnu/usr.bin/clang/libLLVM/obj -I /usr/src/gnu/usr.bin/clang/libLLVM/obj/../include -D NDEBUG -D __STDC_LIMIT_MACROS -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D LLVM_PREFIX="/usr" -D PIC -internal-isystem /usr/include/c++/v1 -internal-isystem /usr/local/lib/clang/13.0.0/include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/usr/src/gnu/usr.bin/clang/libLLVM/obj -ferror-limit 19 -fvisibility-inlines-hidden -fwrapv -D_RET_PROTECTOR -ret-protector -fno-rtti -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -fno-builtin-malloc -fno-builtin-calloc -fno-builtin-realloc -fno-builtin-valloc -fno-builtin-free -fno-builtin-strdup -fno-builtin-strndup -analyzer-output=html -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /home/ben/Projects/vmm/scan-build/2022-01-12-194120-40624-1 -x c++ /usr/src/gnu/usr.bin/clang/libLLVM/../../../llvm/llvm/lib/DebugInfo/DWARF/DWARFDebugLine.cpp
1 | |
2 | |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | #include "llvm/DebugInfo/DWARF/DWARFDebugLine.h" |
10 | #include "llvm/ADT/Optional.h" |
11 | #include "llvm/ADT/SmallString.h" |
12 | #include "llvm/ADT/SmallVector.h" |
13 | #include "llvm/ADT/StringRef.h" |
14 | #include "llvm/BinaryFormat/Dwarf.h" |
15 | #include "llvm/DebugInfo/DWARF/DWARFFormValue.h" |
16 | #include "llvm/DebugInfo/DWARF/DWARFRelocMap.h" |
17 | #include "llvm/Support/Errc.h" |
18 | #include "llvm/Support/Format.h" |
19 | #include "llvm/Support/FormatVariadic.h" |
20 | #include "llvm/Support/WithColor.h" |
21 | #include "llvm/Support/raw_ostream.h" |
22 | #include <algorithm> |
23 | #include <cassert> |
24 | #include <cinttypes> |
25 | #include <cstdint> |
26 | #include <cstdio> |
27 | #include <utility> |
28 | |
29 | using namespace llvm; |
30 | using namespace dwarf; |
31 | |
32 | using FileLineInfoKind = DILineInfoSpecifier::FileLineInfoKind; |
33 | |
34 | namespace { |
35 | |
36 | struct ContentDescriptor { |
37 | dwarf::LineNumberEntryFormat Type; |
38 | dwarf::Form Form; |
39 | }; |
40 | |
41 | using ContentDescriptors = SmallVector<ContentDescriptor, 4>; |
42 | |
43 | } |
44 | |
45 | static bool versionIsSupported(uint16_t Version) { |
46 | return Version >= 2 && Version <= 5; |
47 | } |
48 | |
49 | void DWARFDebugLine::ContentTypeTracker::trackContentType( |
50 | dwarf::LineNumberEntryFormat ContentType) { |
51 | switch (ContentType) { |
52 | case dwarf::DW_LNCT_timestamp: |
53 | HasModTime = true; |
54 | break; |
55 | case dwarf::DW_LNCT_size: |
56 | HasLength = true; |
57 | break; |
58 | case dwarf::DW_LNCT_MD5: |
59 | HasMD5 = true; |
60 | break; |
61 | case dwarf::DW_LNCT_LLVM_source: |
62 | HasSource = true; |
63 | break; |
64 | default: |
65 | |
66 | |
67 | break; |
68 | } |
69 | } |
70 | |
71 | DWARFDebugLine::Prologue::Prologue() { clear(); } |
72 | |
73 | bool DWARFDebugLine::Prologue::hasFileAtIndex(uint64_t FileIndex) const { |
74 | uint16_t DwarfVersion = getVersion(); |
75 | assert(DwarfVersion != 0 && |
76 | "line table prologue has no dwarf version information"); |
77 | if (DwarfVersion >= 5) |
78 | return FileIndex < FileNames.size(); |
79 | return FileIndex != 0 && FileIndex <= FileNames.size(); |
80 | } |
81 | |
82 | Optional<uint64_t> DWARFDebugLine::Prologue::getLastValidFileIndex() const { |
83 | if (FileNames.empty()) |
84 | return None; |
85 | uint16_t DwarfVersion = getVersion(); |
86 | assert(DwarfVersion != 0 && |
87 | "line table prologue has no dwarf version information"); |
88 | |
89 | if (DwarfVersion >= 5) |
90 | return FileNames.size() - 1; |
91 | return FileNames.size(); |
92 | } |
93 | |
94 | const llvm::DWARFDebugLine::FileNameEntry & |
95 | DWARFDebugLine::Prologue::getFileNameEntry(uint64_t Index) const { |
96 | uint16_t DwarfVersion = getVersion(); |
97 | assert(DwarfVersion != 0 && |
98 | "line table prologue has no dwarf version information"); |
99 | |
100 | if (DwarfVersion >= 5) |
101 | return FileNames[Index]; |
102 | return FileNames[Index - 1]; |
103 | } |
104 | |
105 | void DWARFDebugLine::Prologue::clear() { |
106 | TotalLength = PrologueLength = 0; |
107 | SegSelectorSize = 0; |
108 | MinInstLength = MaxOpsPerInst = DefaultIsStmt = LineBase = LineRange = 0; |
109 | OpcodeBase = 0; |
110 | FormParams = dwarf::FormParams({0, 0, DWARF32}); |
111 | ContentTypes = ContentTypeTracker(); |
112 | StandardOpcodeLengths.clear(); |
113 | IncludeDirectories.clear(); |
114 | FileNames.clear(); |
115 | } |
116 | |
117 | void DWARFDebugLine::Prologue::dump(raw_ostream &OS, |
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 | |
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 | |
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 | |
182 | static Error |
183 | parseV2DirFileTables(const DWARFDataExtractor &DebugLineData, |
184 | uint64_t *OffsetPtr, |
185 | DWARFDebugLine::ContentTypeTracker &ContentTypes, |
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)); |
193 | return createStringError(errc::invalid_argument, |
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 | |
213 | DWARFDebugLine::FileNameEntry FileEntry; |
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( |
223 | errc::invalid_argument, |
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 | |
234 | |
235 | |
236 | static llvm::Expected<ContentDescriptors> |
237 | parseV5EntryFormat(const DWARFDataExtractor &DebugLineData, uint64_t *OffsetPtr, |
238 | DWARFDebugLine::ContentTypeTracker *ContentTypes) { |
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) |
256 | return createStringError(errc::invalid_argument, |
257 | "failed to parse entry content descriptors: %s", |
258 | toString(std::move(Err)).c_str()); |
259 | |
260 | if (!HasPath) |
261 | return createStringError(errc::invalid_argument, |
262 | "failed to parse entry content descriptions" |
263 | " because no path was found"); |
264 | return Descriptors; |
265 | } |
266 | |
267 | static Error |
268 | parseV5DirFileTables(const DWARFDataExtractor &DebugLineData, |
269 | uint64_t *OffsetPtr, const dwarf::FormParams &FormParams, |
270 | const DWARFContext &Ctx, const DWARFUnit *U, |
271 | DWARFDebugLine::ContentTypeTracker &ContentTypes, |
272 | std::vector<DWARFFormValue> &IncludeDirectories, |
273 | std::vector<DWARFDebugLine::FileNameEntry> &FileNames) { |
274 | |
275 | llvm::Expected<ContentDescriptors> DirDescriptors = |
276 | parseV5EntryFormat(DebugLineData, OffsetPtr, nullptr); |
277 | if (!DirDescriptors) |
278 | return DirDescriptors.takeError(); |
279 | |
280 | |
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)) |
288 | return createStringError(errc::invalid_argument, |
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)) |
295 | return createStringError(errc::invalid_argument, |
296 | "failed to parse directory entry because " |
297 | "skipping the form value failed"); |
298 | } |
299 | } |
300 | } |
301 | |
302 | |
303 | llvm::Expected<ContentDescriptors> FileDescriptors = |
304 | parseV5EntryFormat(DebugLineData, OffsetPtr, &ContentTypes); |
305 | if (!FileDescriptors) |
306 | return FileDescriptors.takeError(); |
307 | |
308 | |
309 | uint64_t FileEntryCount = DebugLineData.getULEB128(OffsetPtr); |
310 | for (uint64_t I = 0; I != FileEntryCount; ++I) { |
311 | DWARFDebugLine::FileNameEntry FileEntry; |
312 | for (auto Descriptor : *FileDescriptors) { |
313 | DWARFFormValue Value(Descriptor.Form); |
314 | if (!Value.extractValue(DebugLineData, OffsetPtr, FormParams, &Ctx, U)) |
315 | return createStringError(errc::invalid_argument, |
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().getValue(); |
327 | break; |
328 | case DW_LNCT_timestamp: |
329 | FileEntry.ModTime = Value.getAsUnsignedConstant().getValue(); |
330 | break; |
331 | case DW_LNCT_size: |
332 | FileEntry.Length = Value.getAsUnsignedConstant().getValue(); |
333 | break; |
334 | case DW_LNCT_MD5: |
335 | if (!Value.getAsBlock() || Value.getAsBlock().getValue().size() != 16) |
336 | return createStringError( |
337 | errc::invalid_argument, |
338 | "failed to parse file entry because the MD5 hash is invalid"); |
339 | std::uninitialized_copy_n(Value.getAsBlock().getValue().begin(), 16, |
340 | FileEntry.Checksum.Bytes.begin()); |
341 | break; |
342 | default: |
343 | break; |
344 | } |
345 | } |
346 | FileNames.push_back(FileEntry); |
347 | } |
348 | return Error::success(); |
349 | } |
350 | |
351 | uint64_t DWARFDebugLine::Prologue::getLength() const { |
352 | uint64_t Length = PrologueLength + sizeofTotalLength() + |
353 | sizeof(getVersion()) + sizeofPrologueLength(); |
354 | if (getVersion() >= 5) |
355 | Length += 2; |
356 | return Length; |
357 | } |
358 | |
359 | Error DWARFDebugLine::Prologue::parse( |
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 | |
375 | |
376 | |
377 | *OffsetPtr = Cursor.tell(); |
378 | return createStringError( |
379 | errc::not_supported, |
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 | |
407 | |
408 | |
409 | RecoverableErrorHandler(createStringError( |
410 | errc::invalid_argument, |
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 | |
424 | |
425 | |
426 | if (!Cursor) |
427 | return createStringError( |
428 | errc::invalid_argument, |
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( |
440 | createStringError( |
441 | errc::invalid_argument, |
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( |
453 | errc::invalid_argument, |
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 | |
462 | DWARFDebugLine::Row::Row(bool DefaultIsStmt) { reset(DefaultIsStmt); } |
463 | |
464 | void DWARFDebugLine::Row::postAppend() { |
465 | Discriminator = 0; |
466 | BasicBlock = false; |
467 | PrologueEnd = false; |
468 | EpilogueBegin = false; |
469 | } |
470 | |
471 | void DWARFDebugLine::Row::reset(bool DefaultIsStmt) { |
472 | Address.Address = 0; |
473 | Address.SectionIndex = object::SectionedAddress::UndefSection; |
474 | Line = 1; |
475 | Column = 0; |
476 | File = 1; |
477 | Isa = 0; |
478 | Discriminator = 0; |
479 | IsStmt = DefaultIsStmt; |
480 | BasicBlock = false; |
481 | EndSequence = false; |
482 | PrologueEnd = false; |
483 | EpilogueBegin = false; |
484 | } |
485 | |
486 | void DWARFDebugLine::Row::dumpTableHeader(raw_ostream &OS, unsigned Indent) { |
487 | OS.indent(Indent) |
488 | << "Address Line Column File ISA Discriminator Flags\n"; |
489 | OS.indent(Indent) |
490 | << "------------------ ------ ------ ------ --- ------------- " |
491 | "-------------\n"; |
492 | } |
493 | |
494 | void DWARFDebugLine::Row::dump(raw_ostream &OS) const { |
495 | OS << format("0x%16.16" PRIx64 " %6u %6u", Address.Address, Line, Column) |
496 | << format(" %6u %3u %13u ", File, Isa, Discriminator) |
497 | << (IsStmt ? " is_stmt" : "") << (BasicBlock ? " basic_block" : "") |
498 | << (PrologueEnd ? " prologue_end" : "") |
499 | << (EpilogueBegin ? " epilogue_begin" : "") |
500 | << (EndSequence ? " end_sequence" : "") << '\n'; |
501 | } |
502 | |
503 | DWARFDebugLine::Sequence::Sequence() { reset(); } |
504 | |
505 | void DWARFDebugLine::Sequence::reset() { |
506 | LowPC = 0; |
507 | HighPC = 0; |
508 | SectionIndex = object::SectionedAddress::UndefSection; |
509 | FirstRowIndex = 0; |
510 | LastRowIndex = 0; |
511 | Empty = true; |
512 | } |
513 | |
514 | DWARFDebugLine::LineTable::LineTable() { clear(); } |
515 | |
516 | void DWARFDebugLine::LineTable::dump(raw_ostream &OS, |
517 | DIDumpOptions DumpOptions) const { |
518 | Prologue.dump(OS, DumpOptions); |
519 | |
520 | if (!Rows.empty()) { |
521 | OS << '\n'; |
522 | Row::dumpTableHeader(OS, 0); |
523 | for (const Row &R : Rows) { |
524 | R.dump(OS); |
525 | } |
526 | } |
527 | |
528 | |
529 | |
530 | OS << '\n'; |
531 | } |
532 | |
533 | void DWARFDebugLine::LineTable::clear() { |
534 | Prologue.clear(); |
535 | Rows.clear(); |
536 | Sequences.clear(); |
537 | } |
538 | |
539 | DWARFDebugLine::ParsingState::ParsingState( |
540 | struct LineTable *LT, uint64_t TableOffset, |
541 | function_ref<void(Error)> ErrorHandler) |
542 | : LineTable(LT), LineTableOffset(TableOffset), ErrorHandler(ErrorHandler) { |
543 | resetRowAndSequence(); |
544 | } |
545 | |
546 | void DWARFDebugLine::ParsingState::resetRowAndSequence() { |
547 | Row.reset(LineTable->Prologue.DefaultIsStmt); |
548 | Sequence.reset(); |
549 | } |
550 | |
551 | void DWARFDebugLine::ParsingState::appendRowToMatrix() { |
552 | unsigned RowNumber = LineTable->Rows.size(); |
553 | if (Sequence.Empty) { |
554 | |
555 | Sequence.Empty = false; |
556 | Sequence.LowPC = Row.Address.Address; |
557 | Sequence.FirstRowIndex = RowNumber; |
558 | } |
559 | LineTable->appendRow(Row); |
560 | if (Row.EndSequence) { |
561 | |
562 | Sequence.HighPC = Row.Address.Address; |
563 | Sequence.LastRowIndex = RowNumber + 1; |
564 | Sequence.SectionIndex = Row.Address.SectionIndex; |
565 | if (Sequence.isValid()) |
566 | LineTable->appendSequence(Sequence); |
567 | Sequence.reset(); |
568 | } |
569 | Row.postAppend(); |
570 | } |
571 | |
572 | const DWARFDebugLine::LineTable * |
573 | DWARFDebugLine::getLineTable(uint64_t Offset) const { |
574 | LineTableConstIter Pos = LineTableMap.find(Offset); |
575 | if (Pos != LineTableMap.end()) |
576 | return &Pos->second; |
577 | return nullptr; |
578 | } |
579 | |
580 | Expected<const DWARFDebugLine::LineTable *> DWARFDebugLine::getOrParseLineTable( |
581 | DWARFDataExtractor &DebugLineData, uint64_t Offset, const DWARFContext &Ctx, |
582 | const DWARFUnit *U, function_ref<void(Error)> RecoverableErrorHandler) { |
583 | if (!DebugLineData.isValidOffset(Offset)) |
584 | return createStringError(errc::invalid_argument, "offset 0x%8.8" PRIx64 |
585 | " is not a valid debug line section offset", |
586 | Offset); |
587 | |
588 | std::pair<LineTableIter, bool> Pos = |
589 | LineTableMap.insert(LineTableMapTy::value_type(Offset, LineTable())); |
590 | LineTable *LT = &Pos.first->second; |
591 | if (Pos.second) { |
592 | if (Error Err = |
593 | LT->parse(DebugLineData, &Offset, Ctx, U, RecoverableErrorHandler)) |
594 | return std::move(Err); |
595 | return LT; |
596 | } |
597 | return LT; |
598 | } |
599 | |
600 | static StringRef getOpcodeName(uint8_t Opcode, uint8_t OpcodeBase) { |
601 | assert(Opcode != 0); |
602 | if (Opcode < OpcodeBase) |
603 | return LNStandardString(Opcode); |
604 | return "special"; |
605 | } |
606 | |
607 | uint64_t DWARFDebugLine::ParsingState::advanceAddr(uint64_t OperationAdvance, |
608 | uint8_t Opcode, |
609 | uint64_t OpcodeOffset) { |
610 | StringRef OpcodeName = getOpcodeName(Opcode, LineTable->Prologue.OpcodeBase); |
611 | |
612 | |
613 | |
614 | if (ReportAdvanceAddrProblem && LineTable->Prologue.getVersion() >= 4 && |
615 | LineTable->Prologue.MaxOpsPerInst != 1) |
616 | ErrorHandler(createStringError( |
617 | errc::not_supported, |
618 | "line table program at offset 0x%8.8" PRIx64 |
619 | " contains a %s opcode at offset 0x%8.8" PRIx64 |
620 | ", but the prologue maximum_operations_per_instruction value is %" PRId8 |
621 | ", which is unsupported. Assuming a value of 1 instead", |
622 | LineTableOffset, OpcodeName.data(), OpcodeOffset, |
623 | LineTable->Prologue.MaxOpsPerInst)); |
624 | if (ReportAdvanceAddrProblem && LineTable->Prologue.MinInstLength == 0) |
625 | ErrorHandler( |
626 | createStringError(errc::invalid_argument, |
627 | "line table program at offset 0x%8.8" PRIx64 |
628 | " contains a %s opcode at offset 0x%8.8" PRIx64 |
629 | ", but the prologue minimum_instruction_length value " |
630 | "is 0, which prevents any address advancing", |
631 | LineTableOffset, OpcodeName.data(), OpcodeOffset)); |
632 | ReportAdvanceAddrProblem = false; |
633 | uint64_t AddrOffset = OperationAdvance * LineTable->Prologue.MinInstLength; |
634 | Row.Address.Address += AddrOffset; |
635 | return AddrOffset; |
636 | } |
637 | |
638 | DWARFDebugLine::ParsingState::AddrAndAdjustedOpcode |
639 | DWARFDebugLine::ParsingState::advanceAddrForOpcode(uint8_t Opcode, |
640 | uint64_t OpcodeOffset) { |
641 | assert(Opcode == DW_LNS_const_add_pc || |
642 | Opcode >= LineTable->Prologue.OpcodeBase); |
643 | if (ReportBadLineRange && LineTable->Prologue.LineRange == 0) { |
644 | StringRef OpcodeName = |
645 | getOpcodeName(Opcode, LineTable->Prologue.OpcodeBase); |
646 | ErrorHandler( |
647 | createStringError(errc::not_supported, |
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 line_range value is 0. The " |
651 | "address and line will not be adjusted", |
652 | LineTableOffset, OpcodeName.data(), OpcodeOffset)); |
653 | ReportBadLineRange = false; |
654 | } |
655 | |
656 | uint8_t OpcodeValue = Opcode; |
657 | if (Opcode == DW_LNS_const_add_pc) |
658 | OpcodeValue = 255; |
659 | uint8_t AdjustedOpcode = OpcodeValue - LineTable->Prologue.OpcodeBase; |
660 | uint64_t OperationAdvance = |
661 | LineTable->Prologue.LineRange != 0 |
662 | ? AdjustedOpcode / LineTable->Prologue.LineRange |
663 | : 0; |
664 | uint64_t AddrOffset = advanceAddr(OperationAdvance, Opcode, OpcodeOffset); |
665 | return {AddrOffset, AdjustedOpcode}; |
666 | } |
667 | |
668 | DWARFDebugLine::ParsingState::AddrAndLineDelta |
669 | DWARFDebugLine::ParsingState::handleSpecialOpcode(uint8_t Opcode, |
670 | uint64_t OpcodeOffset) { |
671 | |
672 | |
673 | |
674 | |
675 | |
676 | |
677 | |
678 | |
679 | |
680 | |
681 | |
682 | |
683 | |
684 | |
685 | |
686 | |
687 | |
688 | |
689 | |
690 | |
691 | |
692 | |
693 | |
694 | |
695 | |
696 | |
697 | |
698 | |
699 | |
700 | |
701 | |
702 | DWARFDebugLine::ParsingState::AddrAndAdjustedOpcode AddrAdvanceResult = |
703 | advanceAddrForOpcode(Opcode, OpcodeOffset); |
704 | int32_t LineOffset = 0; |
705 | if (LineTable->Prologue.LineRange != 0) |
706 | LineOffset = |
707 | LineTable->Prologue.LineBase + |
708 | (AddrAdvanceResult.AdjustedOpcode % LineTable->Prologue.LineRange); |
709 | Row.Line += LineOffset; |
710 | return {AddrAdvanceResult.AddrDelta, LineOffset}; |
711 | } |
712 | |
713 | |
714 | |
715 | template <typename T> |
716 | static Optional<T> parseULEB128(DWARFDataExtractor &Data, |
717 | DataExtractor::Cursor &Cursor) { |
718 | T Value = Data.getULEB128(Cursor); |
719 | if (Cursor) |
720 | return Value; |
721 | return None; |
722 | } |
723 | |
724 | Error DWARFDebugLine::LineTable::parse( |
725 | DWARFDataExtractor &DebugLineData, uint64_t *OffsetPtr, |
726 | const DWARFContext &Ctx, const DWARFUnit *U, |
727 | function_ref<void(Error)> RecoverableErrorHandler, raw_ostream *OS, |
728 | bool Verbose) { |
729 | assert((OS || !Verbose) && "cannot have verbose output without stream"); |
730 | const uint64_t DebugLineOffset = *OffsetPtr; |
731 | |
732 | clear(); |
733 | |
734 | Error PrologueErr = |
735 | Prologue.parse(DebugLineData, OffsetPtr, RecoverableErrorHandler, Ctx, U); |
736 | |
737 | if (OS) { |
| |
| |
738 | DIDumpOptions DumpOptions; |
739 | DumpOptions.Verbose = Verbose; |
740 | Prologue.dump(*OS, DumpOptions); |
741 | } |
742 | |
743 | if (PrologueErr) { |
| 3 | | Calling 'Error::operator bool' | |
|
| 6 | | Returning from 'Error::operator bool' | |
|
| |
744 | |
745 | |
746 | if (OS) |
747 | *OS << "\n"; |
748 | return PrologueErr; |
749 | } |
750 | |
751 | uint64_t ProgramLength = Prologue.TotalLength + Prologue.sizeofTotalLength(); |
752 | if (!DebugLineData.isValidOffsetForDataOfSize(DebugLineOffset, |
| |
753 | ProgramLength)) { |
754 | assert(DebugLineData.size() > DebugLineOffset && |
755 | "prologue parsing should handle invalid offset"); |
756 | uint64_t BytesRemaining = DebugLineData.size() - DebugLineOffset; |
757 | RecoverableErrorHandler( |
758 | createStringError(errc::invalid_argument, |
759 | "line table program with offset 0x%8.8" PRIx64 |
760 | " has length 0x%8.8" PRIx64 " but only 0x%8.8" PRIx64 |
761 | " bytes are available", |
762 | DebugLineOffset, ProgramLength, BytesRemaining)); |
763 | |
764 | ProgramLength = BytesRemaining; |
765 | } |
766 | |
767 | |
768 | |
769 | const uint64_t EndOffset = DebugLineOffset + ProgramLength; |
770 | DWARFDataExtractor TableData(DebugLineData, EndOffset); |
771 | |
772 | |
773 | if (TableData.getAddressSize() == 0) |
| 9 | | Assuming the condition is false | |
|
| |
774 | TableData.setAddressSize(Prologue.getAddressSize()); |
775 | else |
776 | assert(Prologue.getAddressSize() == 0 || |
777 | Prologue.getAddressSize() == TableData.getAddressSize()); |
778 | |
779 | ParsingState State(this, DebugLineOffset, RecoverableErrorHandler); |
780 | |
781 | *OffsetPtr = DebugLineOffset + Prologue.getLength(); |
782 | if (OS && *OffsetPtr < EndOffset) { |
783 | *OS << '\n'; |
784 | Row::dumpTableHeader(*OS, Verbose ? 12 : 0); |
785 | } |
786 | bool TombstonedAddress = false; |
787 | auto EmitRow = [&] { |
788 | if (!TombstonedAddress) { |
789 | if (Verbose) { |
790 | *OS << "\n"; |
791 | OS->indent(12); |
792 | } |
793 | if (OS) |
794 | State.Row.dump(*OS); |
795 | State.appendRowToMatrix(); |
796 | } |
797 | }; |
798 | while (*OffsetPtr < EndOffset) { |
| 11 | | Assuming the condition is true | |
|
| 12 | | Loop condition is true. Entering loop body | |
|
799 | DataExtractor::Cursor Cursor(*OffsetPtr); |
800 | |
801 | if (Verbose) |
| 13 | | Assuming 'Verbose' is true | |
|
| |
802 | *OS << format("0x%08.08" PRIx64 ": ", *OffsetPtr); |
| 15 | | Called C++ object pointer is null |
|
803 | |
804 | uint64_t OpcodeOffset = *OffsetPtr; |
805 | uint8_t Opcode = TableData.getU8(Cursor); |
806 | size_t RowCount = Rows.size(); |
807 | |
808 | if (Cursor && Verbose) |
809 | *OS << format("%02.02" PRIx8 " ", Opcode); |
810 | |
811 | if (Opcode == 0) { |
812 | |
813 | |
814 | uint64_t Len = TableData.getULEB128(Cursor); |
815 | uint64_t ExtOffset = Cursor.tell(); |
816 | |
817 | |
818 | if (Len == 0) { |
819 | if (Cursor && Verbose) |
820 | *OS << "Badly formed extended line op (length 0)\n"; |
821 | if (!Cursor) { |
822 | if (Verbose) |
823 | *OS << "\n"; |
824 | RecoverableErrorHandler(Cursor.takeError()); |
825 | } |
826 | *OffsetPtr = Cursor.tell(); |
827 | continue; |
828 | } |
829 | |
830 | uint8_t SubOpcode = TableData.getU8(Cursor); |
831 | |
832 | |
833 | uint64_t OperandOffset = Cursor.tell(); |
834 | if (Verbose) |
835 | *OS << LNExtendedString(SubOpcode); |
836 | switch (SubOpcode) { |
837 | case DW_LNE_end_sequence: |
838 | |
839 | |
840 | |
841 | |
842 | |
843 | |
844 | |
845 | State.Row.EndSequence = true; |
846 | |
847 | |
848 | |
849 | EmitRow(); |
850 | State.resetRowAndSequence(); |
851 | break; |
852 | |
853 | case DW_LNE_set_address: |
854 | |
855 | |
856 | |
857 | |
858 | |
859 | |
860 | |
861 | |
862 | |
863 | { |
864 | uint8_t ExtractorAddressSize = TableData.getAddressSize(); |
865 | uint64_t OpcodeAddressSize = Len - 1; |
866 | if (ExtractorAddressSize != OpcodeAddressSize && |
867 | ExtractorAddressSize != 0) |
868 | RecoverableErrorHandler(createStringError( |
869 | errc::invalid_argument, |
870 | "mismatching address size at offset 0x%8.8" PRIx64 |
871 | " expected 0x%2.2" PRIx8 " found 0x%2.2" PRIx64, |
872 | ExtOffset, ExtractorAddressSize, Len - 1)); |
873 | |
874 | |
875 | |
876 | |
877 | if (OpcodeAddressSize != 1 && OpcodeAddressSize != 2 && |
878 | OpcodeAddressSize != 4 && OpcodeAddressSize != 8) { |
879 | RecoverableErrorHandler(createStringError( |
880 | errc::invalid_argument, |
881 | "address size 0x%2.2" PRIx64 |
882 | " of DW_LNE_set_address opcode at offset 0x%8.8" PRIx64 |
883 | " is unsupported", |
884 | OpcodeAddressSize, ExtOffset)); |
885 | TableData.skip(Cursor, OpcodeAddressSize); |
886 | } else { |
887 | TableData.setAddressSize(OpcodeAddressSize); |
888 | State.Row.Address.Address = TableData.getRelocatedAddress( |
889 | Cursor, &State.Row.Address.SectionIndex); |
890 | |
891 | uint64_t Tombstone = |
892 | dwarf::computeTombstoneAddress(OpcodeAddressSize); |
893 | TombstonedAddress = State.Row.Address.Address == Tombstone; |
894 | |
895 | |
896 | if (ExtractorAddressSize != 0) |
897 | TableData.setAddressSize(ExtractorAddressSize); |
898 | } |
899 | |
900 | if (Cursor && Verbose) { |
901 | *OS << " ("; |
902 | DWARFFormValue::dumpAddress(*OS, OpcodeAddressSize, State.Row.Address.Address); |
903 | *OS << ')'; |
904 | } |
905 | } |
906 | break; |
907 | |
908 | case DW_LNE_define_file: |
909 | |
910 | |
911 | |
912 | |
913 | |
914 | |
915 | |
916 | |
917 | |
918 | |
919 | |
920 | |
921 | |
922 | |
923 | |
924 | |
925 | |
926 | |
927 | |
928 | |
929 | { |
930 | FileNameEntry FileEntry; |
931 | const char *Name = TableData.getCStr(Cursor); |
932 | FileEntry.Name = |
933 | DWARFFormValue::createFromPValue(dwarf::DW_FORM_string, Name); |
934 | FileEntry.DirIdx = TableData.getULEB128(Cursor); |
935 | FileEntry.ModTime = TableData.getULEB128(Cursor); |
936 | FileEntry.Length = TableData.getULEB128(Cursor); |
937 | Prologue.FileNames.push_back(FileEntry); |
938 | if (Cursor && Verbose) |
939 | *OS << " (" << Name << ", dir=" << FileEntry.DirIdx << ", mod_time=" |
940 | << format("(0x%16.16" PRIx64 ")", FileEntry.ModTime) |
941 | << ", length=" << FileEntry.Length << ")"; |
942 | } |
943 | break; |
944 | |
945 | case DW_LNE_set_discriminator: |
946 | State.Row.Discriminator = TableData.getULEB128(Cursor); |
947 | if (Cursor && Verbose) |
948 | *OS << " (" << State.Row.Discriminator << ")"; |
949 | break; |
950 | |
951 | default: |
952 | if (Cursor && Verbose) |
953 | *OS << format("Unrecognized extended op 0x%02.02" PRIx8, SubOpcode) |
954 | << format(" length %" PRIx64, Len); |
955 | |
956 | |
957 | TableData.skip(Cursor, Len - 1); |
958 | break; |
959 | } |
960 | |
961 | |
962 | |
963 | |
964 | uint64_t End = ExtOffset + Len; |
965 | if (Cursor && Cursor.tell() != End) |
966 | RecoverableErrorHandler(createStringError( |
967 | errc::illegal_byte_sequence, |
968 | "unexpected line op length at offset 0x%8.8" PRIx64 |
969 | " expected 0x%2.2" PRIx64 " found 0x%2.2" PRIx64, |
970 | ExtOffset, Len, Cursor.tell() - ExtOffset)); |
971 | if (!Cursor && Verbose) { |
972 | DWARFDataExtractor::Cursor ByteCursor(OperandOffset); |
973 | uint8_t Byte = TableData.getU8(ByteCursor); |
974 | if (ByteCursor) { |
975 | *OS << " (<parsing error>"; |
976 | do { |
977 | *OS << format(" %2.2" PRIx8, Byte); |
978 | Byte = TableData.getU8(ByteCursor); |
979 | } while (ByteCursor); |
980 | *OS << ")"; |
981 | } |
982 | |
983 | |
984 | |
985 | |
986 | consumeError(ByteCursor.takeError()); |
987 | } |
988 | *OffsetPtr = End; |
989 | } else if (Opcode < Prologue.OpcodeBase) { |
990 | if (Verbose) |
991 | *OS << LNStandardString(Opcode); |
992 | switch (Opcode) { |
993 | |
994 | case DW_LNS_copy: |
995 | |
996 | |
997 | EmitRow(); |
998 | break; |
999 | |
1000 | case DW_LNS_advance_pc: |
1001 | |
1002 | |
1003 | |
1004 | if (Optional<uint64_t> Operand = |
1005 | parseULEB128<uint64_t>(TableData, Cursor)) { |
1006 | uint64_t AddrOffset = |
1007 | State.advanceAddr(*Operand, Opcode, OpcodeOffset); |
1008 | if (Verbose) |
1009 | *OS << " (" << AddrOffset << ")"; |
1010 | } |
1011 | break; |
1012 | |
1013 | case DW_LNS_advance_line: |
1014 | |
1015 | |
1016 | { |
1017 | int64_t LineDelta = TableData.getSLEB128(Cursor); |
1018 | if (Cursor) { |
1019 | State.Row.Line += LineDelta; |
1020 | if (Verbose) |
1021 | *OS << " (" << State.Row.Line << ")"; |
1022 | } |
1023 | } |
1024 | break; |
1025 | |
1026 | case DW_LNS_set_file: |
1027 | |
1028 | |
1029 | if (Optional<uint16_t> File = |
1030 | parseULEB128<uint16_t>(TableData, Cursor)) { |
1031 | State.Row.File = *File; |
1032 | if (Verbose) |
1033 | *OS << " (" << State.Row.File << ")"; |
1034 | } |
1035 | break; |
1036 | |
1037 | case DW_LNS_set_column: |
1038 | |
1039 | |
1040 | if (Optional<uint16_t> Column = |
1041 | parseULEB128<uint16_t>(TableData, Cursor)) { |
1042 | State.Row.Column = *Column; |
1043 | if (Verbose) |
1044 | *OS << " (" << State.Row.Column << ")"; |
1045 | } |
1046 | break; |
1047 | |
1048 | case DW_LNS_negate_stmt: |
1049 | |
1050 | |
1051 | State.Row.IsStmt = !State.Row.IsStmt; |
1052 | break; |
1053 | |
1054 | case DW_LNS_set_basic_block: |
1055 | |
1056 | |
1057 | State.Row.BasicBlock = true; |
1058 | break; |
1059 | |
1060 | case DW_LNS_const_add_pc: |
1061 | |
1062 | |
1063 | |
1064 | |
1065 | |
1066 | |
1067 | |
1068 | |
1069 | |
1070 | |
1071 | |
1072 | { |
1073 | uint64_t AddrOffset = |
1074 | State.advanceAddrForOpcode(Opcode, OpcodeOffset).AddrDelta; |
1075 | if (Verbose) |
1076 | *OS << format(" (0x%16.16" PRIx64 ")", AddrOffset); |
1077 | } |
1078 | break; |
1079 | |
1080 | case DW_LNS_fixed_advance_pc: |
1081 | |
1082 | |
1083 | |
1084 | |
1085 | |
1086 | |
1087 | |
1088 | |
1089 | |
1090 | { |
1091 | uint16_t PCOffset = |
1092 | TableData.getRelocatedValue(Cursor, 2); |
1093 | if (Cursor) { |
1094 | State.Row.Address.Address += PCOffset; |
1095 | if (Verbose) |
1096 | *OS << format(" (0x%4.4" PRIx16 ")", PCOffset); |
1097 | } |
1098 | } |
1099 | break; |
1100 | |
1101 | case DW_LNS_set_prologue_end: |
1102 | |
1103 | |
1104 | State.Row.PrologueEnd = true; |
1105 | break; |
1106 | |
1107 | case DW_LNS_set_epilogue_begin: |
1108 | |
1109 | |
1110 | State.Row.EpilogueBegin = true; |
1111 | break; |
1112 | |
1113 | case DW_LNS_set_isa: |
1114 | |
1115 | |
1116 | if (Optional<uint8_t> Isa = parseULEB128<uint8_t>(TableData, Cursor)) { |
1117 | State.Row.Isa = *Isa; |
1118 | if (Verbose) |
1119 | *OS << " (" << (uint64_t)State.Row.Isa << ")"; |
1120 | } |
1121 | break; |
1122 | |
1123 | default: |
1124 | |
1125 | |
1126 | |
1127 | { |
1128 | assert(Opcode - 1U < Prologue.StandardOpcodeLengths.size()); |
1129 | if (Verbose) |
1130 | *OS << "Unrecognized standard opcode"; |
1131 | uint8_t OpcodeLength = Prologue.StandardOpcodeLengths[Opcode - 1]; |
1132 | std::vector<uint64_t> Operands; |
1133 | for (uint8_t I = 0; I < OpcodeLength; ++I) { |
1134 | if (Optional<uint64_t> Value = |
1135 | parseULEB128<uint64_t>(TableData, Cursor)) |
1136 | Operands.push_back(*Value); |
1137 | else |
1138 | break; |
1139 | } |
1140 | if (Verbose && !Operands.empty()) { |
1141 | *OS << " (operands: "; |
1142 | bool First = true; |
1143 | for (uint64_t Value : Operands) { |
1144 | if (!First) |
1145 | *OS << ", "; |
1146 | First = false; |
1147 | *OS << format("0x%16.16" PRIx64, Value); |
1148 | } |
1149 | if (Verbose) |
1150 | *OS << ')'; |
1151 | } |
1152 | } |
1153 | break; |
1154 | } |
1155 | |
1156 | *OffsetPtr = Cursor.tell(); |
1157 | } else { |
1158 | |
1159 | ParsingState::AddrAndLineDelta Delta = |
1160 | State.handleSpecialOpcode(Opcode, OpcodeOffset); |
1161 | |
1162 | if (Verbose) |
1163 | *OS << "address += " << Delta.Address << ", line += " << Delta.Line; |
1164 | EmitRow(); |
1165 | *OffsetPtr = Cursor.tell(); |
1166 | } |
1167 | |
1168 | |
1169 | |
1170 | if (Verbose && Rows.size() == RowCount) |
1171 | *OS << "\n"; |
1172 | |
1173 | |
1174 | |
1175 | |
1176 | |
1177 | if (!Cursor && Opcode != 0) { |
1178 | if (Verbose) |
1179 | *OS << "\n"; |
1180 | return Cursor.takeError(); |
1181 | } |
1182 | |
1183 | if (!Cursor) |
1184 | RecoverableErrorHandler(Cursor.takeError()); |
1185 | } |
1186 | |
1187 | if (!State.Sequence.Empty) |
1188 | RecoverableErrorHandler(createStringError( |
1189 | errc::illegal_byte_sequence, |
1190 | "last sequence in debug line table at offset 0x%8.8" PRIx64 |
1191 | " is not terminated", |
1192 | DebugLineOffset)); |
1193 | |
1194 | |
1195 | if (!Sequences.empty()) { |
1196 | llvm::sort(Sequences, Sequence::orderByHighPC); |
1197 | |
1198 | |
1199 | |
1200 | |
1201 | |
1202 | |
1203 | } |
1204 | |
1205 | |
1206 | |
1207 | if (OS) |
1208 | *OS << "\n"; |
1209 | |
1210 | return Error::success(); |
1211 | } |
1212 | |
1213 | uint32_t DWARFDebugLine::LineTable::findRowInSeq( |
1214 | const DWARFDebugLine::Sequence &Seq, |
1215 | object::SectionedAddress Address) const { |
1216 | if (!Seq.containsPC(Address)) |
1217 | return UnknownRowIndex; |
1218 | assert(Seq.SectionIndex == Address.SectionIndex); |
1219 | |
1220 | |
1221 | |
1222 | |
1223 | |
1224 | DWARFDebugLine::Row Row; |
1225 | Row.Address = Address; |
1226 | RowIter FirstRow = Rows.begin() + Seq.FirstRowIndex; |
1227 | RowIter LastRow = Rows.begin() + Seq.LastRowIndex; |
1228 | assert(FirstRow->Address.Address <= Row.Address.Address && |
1229 | Row.Address.Address < LastRow[-1].Address.Address); |
1230 | RowIter RowPos = std::upper_bound(FirstRow + 1, LastRow - 1, Row, |
1231 | DWARFDebugLine::Row::orderByAddress) - |
1232 | 1; |
1233 | assert(Seq.SectionIndex == RowPos->Address.SectionIndex); |
1234 | return RowPos - Rows.begin(); |
1235 | } |
1236 | |
1237 | uint32_t DWARFDebugLine::LineTable::lookupAddress( |
1238 | object::SectionedAddress Address) const { |
1239 | |
1240 | |
1241 | uint32_t Result = lookupAddressImpl(Address); |
1242 | |
1243 | if (Result != UnknownRowIndex || |
1244 | Address.SectionIndex == object::SectionedAddress::UndefSection) |
1245 | return Result; |
1246 | |
1247 | |
1248 | Address.SectionIndex = object::SectionedAddress::UndefSection; |
1249 | return lookupAddressImpl(Address); |
1250 | } |
1251 | |
1252 | uint32_t DWARFDebugLine::LineTable::lookupAddressImpl( |
1253 | object::SectionedAddress Address) const { |
1254 | |
1255 | DWARFDebugLine::Sequence Sequence; |
1256 | Sequence.SectionIndex = Address.SectionIndex; |
1257 | Sequence.HighPC = Address.Address; |
1258 | SequenceIter It = llvm::upper_bound(Sequences, Sequence, |
1259 | DWARFDebugLine::Sequence::orderByHighPC); |
1260 | if (It == Sequences.end() || It->SectionIndex != Address.SectionIndex) |
1261 | return UnknownRowIndex; |
1262 | return findRowInSeq(*It, Address); |
1263 | } |
1264 | |
1265 | bool DWARFDebugLine::LineTable::lookupAddressRange( |
1266 | object::SectionedAddress Address, uint64_t Size, |
1267 | std::vector<uint32_t> &Result) const { |
1268 | |
1269 | |
1270 | if (lookupAddressRangeImpl(Address, Size, Result)) |
1271 | return true; |
1272 | |
1273 | if (Address.SectionIndex == object::SectionedAddress::UndefSection) |
1274 | return false; |
1275 | |
1276 | |
1277 | Address.SectionIndex = object::SectionedAddress::UndefSection; |
1278 | return lookupAddressRangeImpl(Address, Size, Result); |
1279 | } |
1280 | |
1281 | bool DWARFDebugLine::LineTable::lookupAddressRangeImpl( |
1282 | object::SectionedAddress Address, uint64_t Size, |
1283 | std::vector<uint32_t> &Result) const { |
1284 | if (Sequences.empty()) |
1285 | return false; |
1286 | uint64_t EndAddr = Address.Address + Size; |
1287 | |
1288 | DWARFDebugLine::Sequence Sequence; |
1289 | Sequence.SectionIndex = Address.SectionIndex; |
1290 | Sequence.HighPC = Address.Address; |
1291 | SequenceIter LastSeq = Sequences.end(); |
1292 | SequenceIter SeqPos = llvm::upper_bound( |
1293 | Sequences, Sequence, DWARFDebugLine::Sequence::orderByHighPC); |
1294 | if (SeqPos == LastSeq || !SeqPos->containsPC(Address)) |
1295 | return false; |
1296 | |
1297 | SequenceIter StartPos = SeqPos; |
1298 | |
1299 | |
1300 | |
1301 | |
1302 | while (SeqPos != LastSeq && SeqPos->LowPC < EndAddr) { |
1303 | const DWARFDebugLine::Sequence &CurSeq = *SeqPos; |
1304 | |
1305 | |
1306 | uint32_t FirstRowIndex = CurSeq.FirstRowIndex; |
1307 | if (SeqPos == StartPos) |
1308 | FirstRowIndex = findRowInSeq(CurSeq, Address); |
1309 | |
1310 | |
1311 | uint32_t LastRowIndex = |
1312 | findRowInSeq(CurSeq, {EndAddr - 1, Address.SectionIndex}); |
1313 | if (LastRowIndex == UnknownRowIndex) |
1314 | LastRowIndex = CurSeq.LastRowIndex - 1; |
1315 | |
1316 | assert(FirstRowIndex != UnknownRowIndex); |
1317 | assert(LastRowIndex != UnknownRowIndex); |
1318 | |
1319 | for (uint32_t I = FirstRowIndex; I <= LastRowIndex; ++I) { |
1320 | Result.push_back(I); |
1321 | } |
1322 | |
1323 | ++SeqPos; |
1324 | } |
1325 | |
1326 | return true; |
1327 | } |
1328 | |
1329 | Optional<StringRef> DWARFDebugLine::LineTable::getSourceByIndex(uint64_t FileIndex, |
1330 | FileLineInfoKind Kind) const { |
1331 | if (Kind == FileLineInfoKind::None || !Prologue.hasFileAtIndex(FileIndex)) |
1332 | return None; |
1333 | const FileNameEntry &Entry = Prologue.getFileNameEntry(FileIndex); |
1334 | if (Optional<const char *> source = Entry.Source.getAsCString()) |
1335 | return StringRef(*source); |
1336 | return None; |
1337 | } |
1338 | |
1339 | static bool isPathAbsoluteOnWindowsOrPosix(const Twine &Path) { |
1340 | |
1341 | |
1342 | |
1343 | return sys::path::is_absolute(Path, sys::path::Style::posix) || |
1344 | sys::path::is_absolute(Path, sys::path::Style::windows); |
1345 | } |
1346 | |
1347 | bool DWARFDebugLine::Prologue::getFileNameByIndex( |
1348 | uint64_t FileIndex, StringRef CompDir, FileLineInfoKind Kind, |
1349 | std::string &Result, sys::path::Style Style) const { |
1350 | if (Kind == FileLineInfoKind::None || !hasFileAtIndex(FileIndex)) |
1351 | return false; |
1352 | const FileNameEntry &Entry = getFileNameEntry(FileIndex); |
1353 | Optional<const char *> Name = Entry.Name.getAsCString(); |
1354 | if (!Name) |
1355 | return false; |
1356 | StringRef FileName = *Name; |
1357 | if (Kind == FileLineInfoKind::RawValue || |
1358 | isPathAbsoluteOnWindowsOrPosix(FileName)) { |
1359 | Result = std::string(FileName); |
1360 | return true; |
1361 | } |
1362 | if (Kind == FileLineInfoKind::BaseNameOnly) { |
1363 | Result = std::string(llvm::sys::path::filename(FileName)); |
1364 | return true; |
1365 | } |
1366 | |
1367 | SmallString<16> FilePath; |
1368 | StringRef IncludeDir; |
1369 | |
1370 | if (getVersion() >= 5) { |
1371 | |
1372 | |
1373 | if ((Entry.DirIdx != 0 || Kind != FileLineInfoKind::RelativeFilePath) && |
1374 | Entry.DirIdx < IncludeDirectories.size()) |
1375 | IncludeDir = IncludeDirectories[Entry.DirIdx].getAsCString().getValue(); |
1376 | } else { |
1377 | if (0 < Entry.DirIdx && Entry.DirIdx <= IncludeDirectories.size()) |
1378 | IncludeDir = |
1379 | IncludeDirectories[Entry.DirIdx - 1].getAsCString().getValue(); |
1380 | } |
1381 | |
1382 | |
1383 | |
1384 | |
1385 | if (Kind == FileLineInfoKind::AbsoluteFilePath && !CompDir.empty() && |
1386 | !isPathAbsoluteOnWindowsOrPosix(IncludeDir)) |
1387 | sys::path::append(FilePath, Style, CompDir); |
1388 | |
1389 | assert((Kind == FileLineInfoKind::AbsoluteFilePath || |
1390 | Kind == FileLineInfoKind::RelativeFilePath) && |
1391 | "invalid FileLineInfo Kind"); |
1392 | |
1393 | |
1394 | sys::path::append(FilePath, Style, IncludeDir, FileName); |
1395 | Result = std::string(FilePath.str()); |
1396 | return true; |
1397 | } |
1398 | |
1399 | bool DWARFDebugLine::LineTable::getFileLineInfoForAddress( |
1400 | object::SectionedAddress Address, const char *CompDir, |
1401 | FileLineInfoKind Kind, DILineInfo &Result) const { |
1402 | |
1403 | uint32_t RowIndex = lookupAddress(Address); |
1404 | if (RowIndex == -1U) |
1405 | return false; |
1406 | |
1407 | const auto &Row = Rows[RowIndex]; |
1408 | if (!getFileNameByIndex(Row.File, CompDir, Kind, Result.FileName)) |
1409 | return false; |
1410 | Result.Line = Row.Line; |
1411 | Result.Column = Row.Column; |
1412 | Result.Discriminator = Row.Discriminator; |
1413 | Result.Source = getSourceByIndex(Row.File, Kind); |
1414 | return true; |
1415 | } |
1416 | |
1417 | |
1418 | |
1419 | |
1420 | |
1421 | static DWARFDebugLine::SectionParser::LineToUnitMap |
1422 | buildLineToUnitMap(DWARFUnitVector::iterator_range Units) { |
1423 | DWARFDebugLine::SectionParser::LineToUnitMap LineToUnit; |
1424 | for (const auto &U : Units) |
1425 | if (auto CUDIE = U->getUnitDIE()) |
1426 | if (auto StmtOffset = toSectionOffset(CUDIE.find(DW_AT_stmt_list))) |
1427 | LineToUnit.insert(std::make_pair(*StmtOffset, &*U)); |
1428 | return LineToUnit; |
1429 | } |
1430 | |
1431 | DWARFDebugLine::SectionParser::SectionParser( |
1432 | DWARFDataExtractor &Data, const DWARFContext &C, |
1433 | DWARFUnitVector::iterator_range Units) |
1434 | : DebugLineData(Data), Context(C) { |
1435 | LineToUnit = buildLineToUnitMap(Units); |
1436 | if (!DebugLineData.isValidOffset(Offset)) |
1437 | Done = true; |
1438 | } |
1439 | |
1440 | bool DWARFDebugLine::Prologue::totalLengthIsValid() const { |
1441 | return TotalLength != 0u; |
1442 | } |
1443 | |
1444 | DWARFDebugLine::LineTable DWARFDebugLine::SectionParser::parseNext( |
1445 | function_ref<void(Error)> RecoverableErrorHandler, |
1446 | function_ref<void(Error)> UnrecoverableErrorHandler, raw_ostream *OS, |
1447 | bool Verbose) { |
1448 | assert(DebugLineData.isValidOffset(Offset) && |
1449 | "parsing should have terminated"); |
1450 | DWARFUnit *U = prepareToParse(Offset); |
1451 | uint64_t OldOffset = Offset; |
1452 | LineTable LT; |
1453 | if (Error Err = LT.parse(DebugLineData, &Offset, Context, U, |
1454 | RecoverableErrorHandler, OS, Verbose)) |
1455 | UnrecoverableErrorHandler(std::move(Err)); |
1456 | moveToNextTable(OldOffset, LT.Prologue); |
1457 | return LT; |
1458 | } |
1459 | |
1460 | void DWARFDebugLine::SectionParser::skip( |
1461 | function_ref<void(Error)> RecoverableErrorHandler, |
1462 | function_ref<void(Error)> UnrecoverableErrorHandler) { |
1463 | assert(DebugLineData.isValidOffset(Offset) && |
1464 | "parsing should have terminated"); |
1465 | DWARFUnit *U = prepareToParse(Offset); |
1466 | uint64_t OldOffset = Offset; |
1467 | LineTable LT; |
1468 | if (Error Err = LT.Prologue.parse(DebugLineData, &Offset, |
1469 | RecoverableErrorHandler, Context, U)) |
1470 | UnrecoverableErrorHandler(std::move(Err)); |
1471 | moveToNextTable(OldOffset, LT.Prologue); |
1472 | } |
1473 | |
1474 | DWARFUnit *DWARFDebugLine::SectionParser::prepareToParse(uint64_t Offset) { |
1475 | DWARFUnit *U = nullptr; |
1476 | auto It = LineToUnit.find(Offset); |
1477 | if (It != LineToUnit.end()) |
1478 | U = It->second; |
1479 | DebugLineData.setAddressSize(U ? U->getAddressByteSize() : 0); |
1480 | return U; |
1481 | } |
1482 | |
1483 | void DWARFDebugLine::SectionParser::moveToNextTable(uint64_t OldOffset, |
1484 | const Prologue &P) { |
1485 | |
1486 | |
1487 | |
1488 | if (!P.totalLengthIsValid()) { |
1489 | Done = true; |
1490 | return; |
1491 | } |
1492 | |
1493 | Offset = OldOffset + P.TotalLength + P.sizeofTotalLength(); |
1494 | if (!DebugLineData.isValidOffset(Offset)) { |
1495 | Done = true; |
1496 | } |
1497 | } |
1 | |
2 | |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | |
10 | |
11 | |
12 | |
13 | #ifndef LLVM_SUPPORT_ERROR_H |
14 | #define LLVM_SUPPORT_ERROR_H |
15 | |
16 | #include "llvm-c/Error.h" |
17 | #include "llvm/ADT/STLExtras.h" |
18 | #include "llvm/ADT/SmallVector.h" |
19 | #include "llvm/ADT/StringExtras.h" |
20 | #include "llvm/ADT/Twine.h" |
21 | #include "llvm/Config/abi-breaking.h" |
22 | #include "llvm/Support/AlignOf.h" |
23 | #include "llvm/Support/Compiler.h" |
24 | #include "llvm/Support/Debug.h" |
25 | #include "llvm/Support/ErrorHandling.h" |
26 | #include "llvm/Support/ErrorOr.h" |
27 | #include "llvm/Support/Format.h" |
28 | #include "llvm/Support/raw_ostream.h" |
29 | #include <algorithm> |
30 | #include <cassert> |
31 | #include <cstdint> |
32 | #include <cstdlib> |
33 | #include <functional> |
34 | #include <memory> |
35 | #include <new> |
36 | #include <string> |
37 | #include <system_error> |
38 | #include <type_traits> |
39 | #include <utility> |
40 | #include <vector> |
41 | |
42 | namespace llvm { |
43 | |
44 | class ErrorSuccess; |
45 | |
46 | |
47 | |
48 | class ErrorInfoBase { |
49 | public: |
50 | virtual ~ErrorInfoBase() = default; |
51 | |
52 | |
53 | virtual void log(raw_ostream &OS) const = 0; |
54 | |
55 | |
56 | virtual std::string message() const { |
57 | std::string Msg; |
58 | raw_string_ostream OS(Msg); |
59 | log(OS); |
60 | return OS.str(); |
61 | } |
62 | |
63 | |
64 | |
65 | |
66 | |
67 | virtual std::error_code convertToErrorCode() const = 0; |
68 | |
69 | |
70 | static const void *classID() { return &ID; } |
71 | |
72 | |
73 | virtual const void *dynamicClassID() const = 0; |
74 | |
75 | |
76 | |
77 | virtual bool isA(const void *const ClassID) const { |
78 | return ClassID == classID(); |
79 | } |
80 | |
81 | |
82 | template <typename ErrorInfoT> bool isA() const { |
83 | return isA(ErrorInfoT::classID()); |
84 | } |
85 | |
86 | private: |
87 | virtual void anchor(); |
88 | |
89 | static char ID; |
90 | }; |
91 | |
92 | |
93 | |
94 | |
95 | |
96 | |
97 | |
98 | |
99 | |
100 | |
101 | |
102 | |
103 | |
104 | |
105 | |
106 | |
107 | |
108 | |
109 | |
110 | |
111 | |
112 | |
113 | |
114 | |
115 | |
116 | |
117 | |
118 | |
119 | |
120 | |
121 | |
122 | |
123 | |
124 | |
125 | |
126 | |
127 | |
128 | |
129 | |
130 | |
131 | |
132 | |
133 | |
134 | |
135 | |
136 | |
137 | |
138 | |
139 | |
140 | |
141 | |
142 | |
143 | |
144 | |
145 | |
146 | |
147 | |
148 | |
149 | |
150 | |
151 | |
152 | |
153 | |
154 | |
155 | |
156 | |
157 | class LLVM_NODISCARD Error { |
158 | |
159 | |
160 | |
161 | friend class ErrorList; |
162 | |
163 | |
164 | template <typename... HandlerTs> |
165 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); |
166 | |
167 | |
168 | |
169 | template <typename T> friend class Expected; |
170 | |
171 | |
172 | friend LLVMErrorRef wrap(Error); |
173 | |
174 | protected: |
175 | |
176 | Error() { |
177 | setPtr(nullptr); |
178 | setChecked(false); |
179 | } |
180 | |
181 | public: |
182 | |
183 | static ErrorSuccess success(); |
184 | |
185 | |
186 | Error(const Error &Other) = delete; |
187 | |
188 | |
189 | |
190 | |
191 | Error(Error &&Other) { |
192 | setChecked(true); |
193 | *this = std::move(Other); |
194 | } |
195 | |
196 | |
197 | |
198 | Error(std::unique_ptr<ErrorInfoBase> Payload) { |
199 | setPtr(Payload.release()); |
200 | setChecked(false); |
201 | } |
202 | |
203 | |
204 | Error &operator=(const Error &Other) = delete; |
205 | |
206 | |
207 | |
208 | |
209 | |
210 | Error &operator=(Error &&Other) { |
211 | |
212 | assertIsChecked(); |
213 | setPtr(Other.getPtr()); |
214 | |
215 | |
216 | setChecked(false); |
217 | |
218 | |
219 | Other.setPtr(nullptr); |
220 | Other.setChecked(true); |
221 | |
222 | return *this; |
223 | } |
224 | |
225 | |
226 | |
227 | ~Error() { |
228 | assertIsChecked(); |
229 | delete getPtr(); |
230 | } |
231 | |
232 | |
233 | |
234 | |
235 | explicit operator bool() { |
236 | setChecked(getPtr() == nullptr); |
| 4 | | Assuming the condition is true | |
|
237 | return getPtr() != nullptr; |
| 5 | | Returning zero, which participates in a condition later | |
|
238 | } |
239 | |
240 | |
241 | template <typename ErrT> bool isA() const { |
242 | return getPtr() && getPtr()->isA(ErrT::classID()); |
243 | } |
244 | |
245 | |
246 | |
247 | const void* dynamicClassID() const { |
248 | if (!getPtr()) |
249 | return nullptr; |
250 | return getPtr()->dynamicClassID(); |
251 | } |
252 | |
253 | private: |
254 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
255 | |
256 | |
257 | |
258 | |
259 | |
260 | LLVM_ATTRIBUTE_NORETURN |
261 | void fatalUncheckedError() const; |
262 | #endif |
263 | |
264 | void assertIsChecked() { |
265 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
266 | if (LLVM_UNLIKELY(!getChecked() || getPtr())) |
267 | fatalUncheckedError(); |
268 | #endif |
269 | } |
270 | |
271 | ErrorInfoBase *getPtr() const { |
272 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
273 | return reinterpret_cast<ErrorInfoBase*>( |
274 | reinterpret_cast<uintptr_t>(Payload) & |
275 | ~static_cast<uintptr_t>(0x1)); |
276 | #else |
277 | return Payload; |
278 | #endif |
279 | } |
280 | |
281 | void setPtr(ErrorInfoBase *EI) { |
282 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
283 | Payload = reinterpret_cast<ErrorInfoBase*>( |
284 | (reinterpret_cast<uintptr_t>(EI) & |
285 | ~static_cast<uintptr_t>(0x1)) | |
286 | (reinterpret_cast<uintptr_t>(Payload) & 0x1)); |
287 | #else |
288 | Payload = EI; |
289 | #endif |
290 | } |
291 | |
292 | bool getChecked() const { |
293 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
294 | return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0; |
295 | #else |
296 | return true; |
297 | #endif |
298 | } |
299 | |
300 | void setChecked(bool V) { |
301 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
302 | Payload = reinterpret_cast<ErrorInfoBase*>( |
303 | (reinterpret_cast<uintptr_t>(Payload) & |
304 | ~static_cast<uintptr_t>(0x1)) | |
305 | (V ? 0 : 1)); |
306 | #endif |
307 | } |
308 | |
309 | std::unique_ptr<ErrorInfoBase> takePayload() { |
310 | std::unique_ptr<ErrorInfoBase> Tmp(getPtr()); |
311 | setPtr(nullptr); |
312 | setChecked(true); |
313 | return Tmp; |
314 | } |
315 | |
316 | friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) { |
317 | if (auto P = E.getPtr()) |
318 | P->log(OS); |
319 | else |
320 | OS << "success"; |
321 | return OS; |
322 | } |
323 | |
324 | ErrorInfoBase *Payload = nullptr; |
325 | }; |
326 | |
327 | |
328 | |
329 | |
330 | class ErrorSuccess final : public Error {}; |
331 | |
332 | inline ErrorSuccess Error::success() { return ErrorSuccess(); } |
333 | |
334 | |
335 | |
336 | template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) { |
337 | return Error(std::make_unique<ErrT>(std::forward<ArgTs>(Args)...)); |
338 | } |
339 | |
340 | |
341 | |
342 | |
343 | |
344 | |
345 | |
346 | |
347 | |
348 | |
349 | template <typename ThisErrT, typename ParentErrT = ErrorInfoBase> |
350 | class ErrorInfo : public ParentErrT { |
351 | public: |
352 | using ParentErrT::ParentErrT; |
353 | |
354 | static const void *classID() { return &ThisErrT::ID; } |
355 | |
356 | const void *dynamicClassID() const override { return &ThisErrT::ID; } |
357 | |
358 | bool isA(const void *const ClassID) const override { |
359 | return ClassID == classID() || ParentErrT::isA(ClassID); |
360 | } |
361 | }; |
362 | |
363 | |
364 | |
365 | class ErrorList final : public ErrorInfo<ErrorList> { |
366 | |
367 | |
368 | template <typename... HandlerTs> |
369 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); |
370 | |
371 | |
372 | friend Error joinErrors(Error, Error); |
373 | |
374 | public: |
375 | void log(raw_ostream &OS) const override { |
376 | OS << "Multiple errors:\n"; |
377 | for (auto &ErrPayload : Payloads) { |
378 | ErrPayload->log(OS); |
379 | OS << "\n"; |
380 | } |
381 | } |
382 | |
383 | std::error_code convertToErrorCode() const override; |
384 | |
385 | |
386 | static char ID; |
387 | |
388 | private: |
389 | ErrorList(std::unique_ptr<ErrorInfoBase> Payload1, |
390 | std::unique_ptr<ErrorInfoBase> Payload2) { |
391 | assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && |
392 | "ErrorList constructor payloads should be singleton errors"); |
393 | Payloads.push_back(std::move(Payload1)); |
394 | Payloads.push_back(std::move(Payload2)); |
395 | } |
396 | |
397 | static Error join(Error E1, Error E2) { |
398 | if (!E1) |
399 | return E2; |
400 | if (!E2) |
401 | return E1; |
402 | if (E1.isA<ErrorList>()) { |
403 | auto &E1List = static_cast<ErrorList &>(*E1.getPtr()); |
404 | if (E2.isA<ErrorList>()) { |
405 | auto E2Payload = E2.takePayload(); |
406 | auto &E2List = static_cast<ErrorList &>(*E2Payload); |
407 | for (auto &Payload : E2List.Payloads) |
408 | E1List.Payloads.push_back(std::move(Payload)); |
409 | } else |
410 | E1List.Payloads.push_back(E2.takePayload()); |
411 | |
412 | return E1; |
413 | } |
414 | if (E2.isA<ErrorList>()) { |
415 | auto &E2List = static_cast<ErrorList &>(*E2.getPtr()); |
416 | E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload()); |
417 | return E2; |
418 | } |
419 | return Error(std::unique_ptr<ErrorList>( |
420 | new ErrorList(E1.takePayload(), E2.takePayload()))); |
421 | } |
422 | |
423 | std::vector<std::unique_ptr<ErrorInfoBase>> Payloads; |
424 | }; |
425 | |
426 | |
427 | |
428 | |
429 | inline Error joinErrors(Error E1, Error E2) { |
430 | return ErrorList::join(std::move(E1), std::move(E2)); |
431 | } |
432 | |
433 | |
434 | |
435 | |
436 | |
437 | |
438 | |
439 | |
440 | |
441 | |
442 | |
443 | |
444 | |
445 | |
446 | |
447 | |
448 | |
449 | |
450 | |
451 | |
452 | |
453 | |
454 | |
455 | |
456 | |
457 | |
458 | |
459 | |
460 | |
461 | |
462 | |
463 | |
464 | |
465 | |
466 | |
467 | |
468 | |
469 | |
470 | |
471 | |
472 | template <class T> class LLVM_NODISCARD Expected { |
473 | template <class T1> friend class ExpectedAsOutParameter; |
474 | template <class OtherT> friend class Expected; |
475 | |
476 | static constexpr bool isRef = std::is_reference<T>::value; |
477 | |
478 | using wrap = std::reference_wrapper<std::remove_reference_t<T>>; |
479 | |
480 | using error_type = std::unique_ptr<ErrorInfoBase>; |
481 | |
482 | public: |
483 | using storage_type = std::conditional_t<isRef, wrap, T>; |
484 | using value_type = T; |
485 | |
486 | private: |
487 | using reference = std::remove_reference_t<T> &; |
488 | using const_reference = const std::remove_reference_t<T> &; |
489 | using pointer = std::remove_reference_t<T> *; |
490 | using const_pointer = const std::remove_reference_t<T> *; |
491 | |
492 | public: |
493 | |
494 | Expected(Error Err) |
495 | : HasError(true) |
496 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
497 | |
498 | , Unchecked(true) |
499 | #endif |
500 | { |
501 | assert(Err && "Cannot create Expected<T> from Error success value."); |
502 | new (getErrorStorage()) error_type(Err.takePayload()); |
503 | } |
504 | |
505 | |
506 | |
507 | |
508 | Expected(ErrorSuccess) = delete; |
509 | |
510 | |
511 | |
512 | template <typename OtherT> |
513 | Expected(OtherT &&Val, |
514 | std::enable_if_t<std::is_convertible<OtherT, T>::value> * = nullptr) |
515 | : HasError(false) |
516 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
517 | |
518 | , |
519 | Unchecked(true) |
520 | #endif |
521 | { |
522 | new (getStorage()) storage_type(std::forward<OtherT>(Val)); |
523 | } |
524 | |
525 | |
526 | Expected(Expected &&Other) { moveConstruct(std::move(Other)); } |
527 | |
528 | |
529 | |
530 | template <class OtherT> |
531 | Expected( |
532 | Expected<OtherT> &&Other, |
533 | std::enable_if_t<std::is_convertible<OtherT, T>::value> * = nullptr) { |
534 | moveConstruct(std::move(Other)); |
535 | } |
536 | |
537 | |
538 | |
539 | template <class OtherT> |
540 | explicit Expected( |
541 | Expected<OtherT> &&Other, |
542 | std::enable_if_t<!std::is_convertible<OtherT, T>::value> * = nullptr) { |
543 | moveConstruct(std::move(Other)); |
544 | } |
545 | |
546 | |
547 | Expected &operator=(Expected &&Other) { |
548 | moveAssign(std::move(Other)); |
549 | return *this; |
550 | } |
551 | |
552 | |
553 | ~Expected() { |
554 | assertIsChecked(); |
555 | if (!HasError) |
556 | getStorage()->~storage_type(); |
557 | else |
558 | getErrorStorage()->~error_type(); |
559 | } |
560 | |
561 | |
562 | explicit operator bool() { |
563 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
564 | Unchecked = HasError; |
565 | #endif |
566 | return !HasError; |
567 | } |
568 | |
569 | |
570 | reference get() { |
571 | assertIsChecked(); |
572 | return *getStorage(); |
573 | } |
574 | |
575 | |
576 | const_reference get() const { |
577 | assertIsChecked(); |
578 | return const_cast<Expected<T> *>(this)->get(); |
579 | } |
580 | |
581 | |
582 | template <typename ErrT> bool errorIsA() const { |
583 | return HasError && (*getErrorStorage())->template isA<ErrT>(); |
584 | } |
585 | |
586 | |
587 | |
588 | |
589 | |
590 | Error takeError() { |
591 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
592 | Unchecked = false; |
593 | #endif |
594 | return HasError ? Error(std::move(*getErrorStorage())) : Error::success(); |
595 | } |
596 | |
597 | |
598 | pointer operator->() { |
599 | assertIsChecked(); |
600 | return toPointer(getStorage()); |
601 | } |
602 | |
603 | |
604 | const_pointer operator->() const { |
605 | assertIsChecked(); |
606 | return toPointer(getStorage()); |
607 | } |
608 | |
609 | |
610 | reference operator*() { |
611 | assertIsChecked(); |
612 | return *getStorage(); |
613 | } |
614 | |
615 | |
616 | const_reference operator*() const { |
617 | assertIsChecked(); |
618 | return *getStorage(); |
619 | } |
620 | |
621 | private: |
622 | template <class T1> |
623 | static bool compareThisIfSameType(const T1 &a, const T1 &b) { |
624 | return &a == &b; |
625 | } |
626 | |
627 | template <class T1, class T2> |
628 | static bool compareThisIfSameType(const T1 &, const T2 &) { |
629 | return false; |
630 | } |
631 | |
632 | template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) { |
633 | HasError = Other.HasError; |
634 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
635 | Unchecked = true; |
636 | Other.Unchecked = false; |
637 | #endif |
638 | |
639 | if (!HasError) |
640 | new (getStorage()) storage_type(std::move(*Other.getStorage())); |
641 | else |
642 | new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage())); |
643 | } |
644 | |
645 | template <class OtherT> void moveAssign(Expected<OtherT> &&Other) { |
646 | assertIsChecked(); |
647 | |
648 | if (compareThisIfSameType(*this, Other)) |
649 | return; |
650 | |
651 | this->~Expected(); |
652 | new (this) Expected(std::move(Other)); |
653 | } |
654 | |
655 | pointer toPointer(pointer Val) { return Val; } |
656 | |
657 | const_pointer toPointer(const_pointer Val) const { return Val; } |
658 | |
659 | pointer toPointer(wrap *Val) { return &Val->get(); } |
660 | |
661 | const_pointer toPointer(const wrap *Val) const { return &Val->get(); } |
662 | |
663 | storage_type *getStorage() { |
664 | assert(!HasError && "Cannot get value when an error exists!"); |
665 | return reinterpret_cast<storage_type *>(&TStorage); |
666 | } |
667 | |
668 | const storage_type *getStorage() const { |
669 | assert(!HasError && "Cannot get value when an error exists!"); |
670 | return reinterpret_cast<const storage_type *>(&TStorage); |
671 | } |
672 | |
673 | error_type *getErrorStorage() { |
674 | assert(HasError && "Cannot get error when a value exists!"); |
675 | return reinterpret_cast<error_type *>(&ErrorStorage); |
676 | } |
677 | |
678 | const error_type *getErrorStorage() const { |
679 | assert(HasError && "Cannot get error when a value exists!"); |
680 | return reinterpret_cast<const error_type *>(&ErrorStorage); |
681 | } |
682 | |
683 | |
684 | void setUnchecked() { |
685 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
686 | Unchecked = true; |
687 | #endif |
688 | } |
689 | |
690 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
691 | LLVM_ATTRIBUTE_NORETURN |
692 | LLVM_ATTRIBUTE_NOINLINE |
693 | void fatalUncheckedExpected() const { |
694 | dbgs() << "Expected<T> must be checked before access or destruction.\n"; |
695 | if (HasError) { |
696 | dbgs() << "Unchecked Expected<T> contained error:\n"; |
697 | (*getErrorStorage())->log(dbgs()); |
698 | } else |
699 | dbgs() << "Expected<T> value was in success state. (Note: Expected<T> " |
700 | "values in success mode must still be checked prior to being " |
701 | "destroyed).\n"; |
702 | abort(); |
703 | } |
704 | #endif |
705 | |
706 | void assertIsChecked() const { |
707 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
708 | if (LLVM_UNLIKELY(Unchecked)) |
709 | fatalUncheckedExpected(); |
710 | #endif |
711 | } |
712 | |
713 | union { |
714 | AlignedCharArrayUnion<storage_type> TStorage; |
715 | AlignedCharArrayUnion<error_type> ErrorStorage; |
716 | }; |
717 | bool HasError : 1; |
718 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS |
719 | bool Unchecked : 1; |
720 | #endif |
721 | }; |
722 | |
723 | |
724 | |
725 | LLVM_ATTRIBUTE_NORETURN void report_fatal_error(Error Err, |
726 | bool gen_crash_diag = true); |
727 | |
728 | |
729 | |
730 | |
731 | |
732 | |
733 | |
734 | |
735 | |
736 | |
737 | |
738 | |
739 | |
740 | |
741 | inline void cantFail(Error Err, const char *Msg = nullptr) { |
742 | if (Err) { |
743 | if (!Msg) |
744 | Msg = "Failure value returned from cantFail wrapped call"; |
745 | #ifndef NDEBUG |
746 | std::string Str; |
747 | raw_string_ostream OS(Str); |
748 | OS << Msg << "\n" << Err; |
749 | Msg = OS.str().c_str(); |
750 | #endif |
751 | llvm_unreachable(Msg); |
752 | } |
753 | } |
754 | |
755 | |
756 | |
757 | |
758 | |
759 | |
760 | |
761 | |
762 | |
763 | |
764 | |
765 | |
766 | |
767 | |
768 | template <typename T> |
769 | T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) { |
770 | if (ValOrErr) |
771 | return std::move(*ValOrErr); |
772 | else { |
773 | if (!Msg) |
774 | Msg = "Failure value returned from cantFail wrapped call"; |
775 | #ifndef NDEBUG |
776 | std::string Str; |
777 | raw_string_ostream OS(Str); |
778 | auto E = ValOrErr.takeError(); |
779 | OS << Msg << "\n" << E; |
780 | Msg = OS.str().c_str(); |
781 | #endif |
782 | llvm_unreachable(Msg); |
783 | } |
784 | } |
785 | |
786 | |
787 | |
788 | |
789 | |
790 | |
791 | |
792 | |
793 | |
794 | |
795 | |
796 | |
797 | |
798 | |
799 | template <typename T> |
800 | T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) { |
801 | if (ValOrErr) |
802 | return *ValOrErr; |
803 | else { |
804 | if (!Msg) |
805 | Msg = "Failure value returned from cantFail wrapped call"; |
806 | #ifndef NDEBUG |
807 | std::string Str; |
808 | raw_string_ostream OS(Str); |
809 | auto E = ValOrErr.takeError(); |
810 | OS << Msg << "\n" << E; |
811 | Msg = OS.str().c_str(); |
812 | #endif |
813 | llvm_unreachable(Msg); |
814 | } |
815 | } |
816 | |
817 | |
818 | |
819 | template <typename HandlerT> |
820 | class ErrorHandlerTraits |
821 | : public ErrorHandlerTraits<decltype( |
822 | &std::remove_reference<HandlerT>::type::operator())> {}; |
823 | |
824 | |
825 | template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> { |
826 | public: |
827 | static bool appliesTo(const ErrorInfoBase &E) { |
828 | return E.template isA<ErrT>(); |
829 | } |
830 | |
831 | template <typename HandlerT> |
832 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
833 | assert(appliesTo(*E) && "Applying incorrect handler"); |
834 | return H(static_cast<ErrT &>(*E)); |
835 | } |
836 | }; |
837 | |
838 | |
839 | template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> { |
840 | public: |
841 | static bool appliesTo(const ErrorInfoBase &E) { |
842 | return E.template isA<ErrT>(); |
843 | } |
844 | |
845 | template <typename HandlerT> |
846 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
847 | assert(appliesTo(*E) && "Applying incorrect handler"); |
848 | H(static_cast<ErrT &>(*E)); |
849 | return Error::success(); |
850 | } |
851 | }; |
852 | |
853 | |
854 | template <typename ErrT> |
855 | class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> { |
856 | public: |
857 | static bool appliesTo(const ErrorInfoBase &E) { |
858 | return E.template isA<ErrT>(); |
859 | } |
860 | |
861 | template <typename HandlerT> |
862 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
863 | assert(appliesTo(*E) && "Applying incorrect handler"); |
864 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); |
865 | return H(std::move(SubE)); |
866 | } |
867 | }; |
868 | |
869 | |
870 | template <typename ErrT> |
871 | class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> { |
872 | public: |
873 | static bool appliesTo(const ErrorInfoBase &E) { |
874 | return E.template isA<ErrT>(); |
875 | } |
876 | |
877 | template <typename HandlerT> |
878 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { |
879 | assert(appliesTo(*E) && "Applying incorrect handler"); |
880 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); |
881 | H(std::move(SubE)); |
882 | return Error::success(); |
883 | } |
884 | }; |
885 | |
886 | |
887 | template <typename C, typename RetT, typename ErrT> |
888 | class ErrorHandlerTraits<RetT (C::*)(ErrT &)> |
889 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
890 | |
891 | |
892 | template <typename C, typename RetT, typename ErrT> |
893 | class ErrorHandlerTraits<RetT (C::*)(ErrT &) const> |
894 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
895 | |
896 | |
897 | template <typename C, typename RetT, typename ErrT> |
898 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &)> |
899 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
900 | |
901 | |
902 | template <typename C, typename RetT, typename ErrT> |
903 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const> |
904 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; |
905 | |
906 | |
907 | |
908 | template <typename C, typename RetT, typename ErrT> |
909 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)> |
910 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; |
911 | |
912 | |
913 | |
914 | template <typename C, typename RetT, typename ErrT> |
915 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const> |
916 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; |
917 | |
918 | inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) { |
919 | return Error(std::move(Payload)); |
920 | } |
921 | |
922 | template <typename HandlerT, typename... HandlerTs> |
923 | Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload, |
924 | HandlerT &&Handler, HandlerTs &&... Handlers) { |
925 | if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload)) |
926 | return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler), |
927 | std::move(Payload)); |
928 | return handleErrorImpl(std::move(Payload), |
929 | std::forward<HandlerTs>(Handlers)...); |
930 | } |
931 | |
932 | |
933 | |
934 | |
935 | |
936 | |
937 | |
938 | template <typename... HandlerTs> |
939 | Error handleErrors(Error E, HandlerTs &&... Hs) { |
940 | if (!E) |
941 | return Error::success(); |
942 | |
943 | std::unique_ptr<ErrorInfoBase> Payload = E.takePayload(); |
944 | |
945 | if (Payload->isA<ErrorList>()) { |
946 | ErrorList &List = static_cast<ErrorList &>(*Payload); |
947 | Error R; |
948 | for (auto &P : List.Payloads) |
949 | R = ErrorList::join( |
950 | std::move(R), |
951 | handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...)); |
952 | return R; |
953 | } |
954 | |
955 | return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...); |
956 | } |
957 | |
958 | |
959 | |
960 | |
961 | template <typename... HandlerTs> |
962 | void handleAllErrors(Error E, HandlerTs &&... Handlers) { |
963 | cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...)); |
964 | } |
965 | |
966 | |
967 | |
968 | inline void handleAllErrors(Error E) { |
969 | cantFail(std::move(E)); |
970 | } |
971 | |
972 | |
973 | |
974 | |
975 | |
976 | |
977 | |
978 | |
979 | |
980 | |
981 | |
982 | |
983 | |
984 | |
985 | |
986 | |
987 | |
988 | |
989 | |
990 | |
991 | |
992 | |
993 | |
994 | |
995 | |
996 | template <typename T, typename RecoveryFtor, typename... HandlerTs> |
997 | Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath, |
998 | HandlerTs &&... Handlers) { |
999 | if (ValOrErr) |
1000 | return ValOrErr; |
1001 | |
1002 | if (auto Err = handleErrors(ValOrErr.takeError(), |
1003 | std::forward<HandlerTs>(Handlers)...)) |
1004 | return std::move(Err); |
1005 | |
1006 | return RecoveryPath(); |
1007 | } |
1008 | |
1009 | |
1010 | |
1011 | |
1012 | |
1013 | |
1014 | |
1015 | |
1016 | |
1017 | |
1018 | |
1019 | |
1020 | void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner = {}); |
1021 | |
1022 | |
1023 | |
1024 | inline std::string toString(Error E) { |
1025 | SmallVector<std::string, 2> Errors; |
1026 | handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) { |
1027 | Errors.push_back(EI.message()); |
1028 | }); |
1029 | return join(Errors.begin(), Errors.end(), "\n"); |
1030 | } |
1031 | |
1032 | |
1033 | |
1034 | |
1035 | |
1036 | |
1037 | |
1038 | |
1039 | inline void consumeError(Error Err) { |
1040 | handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {}); |
1041 | } |
1042 | |
1043 | |
1044 | |
1045 | |
1046 | |
1047 | |
1048 | |
1049 | |
1050 | template <typename T> Optional<T> expectedToOptional(Expected<T> &&E) { |
1051 | if (E) |
1052 | return std::move(*E); |
1053 | consumeError(E.takeError()); |
1054 | return None; |
1055 | } |
1056 | |
1057 | |
1058 | |
1059 | |
1060 | |
1061 | |
1062 | inline bool errorToBool(Error Err) { |
1063 | bool IsError = static_cast<bool>(Err); |
1064 | if (IsError) |
1065 | consumeError(std::move(Err)); |
1066 | return IsError; |
1067 | } |
1068 | |
1069 | |
1070 | |
1071 | |
1072 | |
1073 | |
1074 | |
1075 | |
1076 | |
1077 | |
1078 | |
1079 | |
1080 | |
1081 | |
1082 | |
1083 | |
1084 | |
1085 | |
1086 | |
1087 | |
1088 | |
1089 | |
1090 | |
1091 | |
1092 | |
1093 | class ErrorAsOutParameter { |
1094 | public: |
1095 | ErrorAsOutParameter(Error *Err) : Err(Err) { |
1096 | |
1097 | if (Err) |
1098 | (void)!!*Err; |
1099 | } |
1100 | |
1101 | ~ErrorAsOutParameter() { |
1102 | |
1103 | if (Err && !*Err) |
1104 | *Err = Error::success(); |
1105 | } |
1106 | |
1107 | private: |
1108 | Error *Err; |
1109 | }; |
1110 | |
1111 | |
1112 | |
1113 | |
1114 | template <typename T> |
1115 | class ExpectedAsOutParameter { |
1116 | public: |
1117 | ExpectedAsOutParameter(Expected<T> *ValOrErr) |
1118 | : ValOrErr(ValOrErr) { |
1119 | if (ValOrErr) |
1120 | (void)!!*ValOrErr; |
1121 | } |
1122 | |
1123 | ~ExpectedAsOutParameter() { |
1124 | if (ValOrErr) |
1125 | ValOrErr->setUnchecked(); |
1126 | } |
1127 | |
1128 | private: |
1129 | Expected<T> *ValOrErr; |
1130 | }; |
1131 | |
1132 | |
1133 | |
1134 | |
1135 | |
1136 | |
1137 | class ECError : public ErrorInfo<ECError> { |
1138 | friend Error errorCodeToError(std::error_code); |
1139 | |
1140 | virtual void anchor() override; |
1141 | |
1142 | public: |
1143 | void setErrorCode(std::error_code EC) { this->EC = EC; } |
1144 | std::error_code convertToErrorCode() const override { return EC; } |
1145 | void log(raw_ostream &OS) const override { OS << EC.message(); } |
1146 | |
1147 | |
1148 | static char ID; |
1149 | |
1150 | protected: |
1151 | ECError() = default; |
1152 | ECError(std::error_code EC) : EC(EC) {} |
1153 | |
1154 | std::error_code EC; |
1155 | }; |
1156 | |
1157 | |
1158 | |
1159 | |
1160 | |
1161 | |
1162 | |
1163 | std::error_code inconvertibleErrorCode(); |
1164 | |
1165 | |
1166 | Error errorCodeToError(std::error_code EC); |
1167 | |
1168 | |
1169 | |
1170 | |
1171 | |
1172 | std::error_code errorToErrorCode(Error Err); |
1173 | |
1174 | |
1175 | template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) { |
1176 | if (auto EC = EO.getError()) |
1177 | return errorCodeToError(EC); |
1178 | return std::move(*EO); |
1179 | } |
1180 | |
1181 | |
1182 | template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) { |
1183 | if (auto Err = E.takeError()) |
1184 | return errorToErrorCode(std::move(Err)); |
1185 | return std::move(*E); |
1186 | } |
1187 | |
1188 | |
1189 | |
1190 | |
1191 | |
1192 | |
1193 | |
1194 | |
1195 | |
1196 | |
1197 | |
1198 | |
1199 | |
1200 | |
1201 | |
1202 | |
1203 | |
1204 | |
1205 | |
1206 | |
1207 | |
1208 | |
1209 | |
1210 | |
1211 | |
1212 | class StringError : public ErrorInfo<StringError> { |
1213 | public: |
1214 | static char ID; |
1215 | |
1216 | |
1217 | StringError(std::error_code EC, const Twine &S = Twine()); |
1218 | |
1219 | |
1220 | StringError(const Twine &S, std::error_code EC); |
1221 | |
1222 | void log(raw_ostream &OS) const override; |
1223 | std::error_code convertToErrorCode() const override; |
1224 | |
1225 | const std::string &getMessage() const { return Msg; } |
1226 | |
1227 | private: |
1228 | std::string Msg; |
1229 | std::error_code EC; |
1230 | const bool PrintMsgOnly = false; |
1231 | }; |
1232 | |
1233 | |
1234 | template <typename... Ts> |
1235 | inline Error createStringError(std::error_code EC, char const *Fmt, |
1236 | const Ts &... Vals) { |
1237 | std::string Buffer; |
1238 | raw_string_ostream Stream(Buffer); |
1239 | Stream << format(Fmt, Vals...); |
1240 | return make_error<StringError>(Stream.str(), EC); |
1241 | } |
1242 | |
1243 | Error createStringError(std::error_code EC, char const *Msg); |
1244 | |
1245 | inline Error createStringError(std::error_code EC, const Twine &S) { |
1246 | return createStringError(EC, S.str().c_str()); |
1247 | } |
1248 | |
1249 | template <typename... Ts> |
1250 | inline Error createStringError(std::errc EC, char const *Fmt, |
1251 | const Ts &... Vals) { |
1252 | return createStringError(std::make_error_code(EC), Fmt, Vals...); |
1253 | } |
1254 | |
1255 | |
1256 | |
1257 | |
1258 | |
1259 | class FileError final : public ErrorInfo<FileError> { |
1260 | |
1261 | friend Error createFileError(const Twine &, Error); |
1262 | friend Error createFileError(const Twine &, size_t, Error); |
1263 | |
1264 | public: |
1265 | void log(raw_ostream &OS) const override { |
1266 | assert(Err && !FileName.empty() && "Trying to log after takeError()."); |
1267 | OS << "'" << FileName << "': "; |
1268 | if (Line.hasValue()) |
1269 | OS << "line " << Line.getValue() << ": "; |
1270 | Err->log(OS); |
1271 | } |
1272 | |
1273 | StringRef getFileName() { return FileName; } |
1274 | |
1275 | Error takeError() { return Error(std::move(Err)); } |
1276 | |
1277 | std::error_code convertToErrorCode() const override; |
1278 | |
1279 | |
1280 | static char ID; |
1281 | |
1282 | private: |
1283 | FileError(const Twine &F, Optional<size_t> LineNum, |
1284 | std::unique_ptr<ErrorInfoBase> E) { |
1285 | assert(E && "Cannot create FileError from Error success value."); |
1286 | assert(!F.isTriviallyEmpty() && |
1287 | "The file name provided to FileError must not be empty."); |
1288 | FileName = F.str(); |
1289 | Err = std::move(E); |
1290 | Line = std::move(LineNum); |
1291 | } |
1292 | |
1293 | static Error build(const Twine &F, Optional<size_t> Line, Error E) { |
1294 | std::unique_ptr<ErrorInfoBase> Payload; |
1295 | handleAllErrors(std::move(E), |
1296 | [&](std::unique_ptr<ErrorInfoBase> EIB) -> Error { |
1297 | Payload = std::move(EIB); |
1298 | return Error::success(); |
1299 | }); |
1300 | return Error( |
1301 | std::unique_ptr<FileError>(new FileError(F, Line, std::move(Payload)))); |
1302 | } |
1303 | |
1304 | std::string FileName; |
1305 | Optional<size_t> Line; |
1306 | std::unique_ptr<ErrorInfoBase> Err; |
1307 | }; |
1308 | |
1309 | |
1310 | |
1311 | inline Error createFileError(const Twine &F, Error E) { |
1312 | return FileError::build(F, Optional<size_t>(), std::move(E)); |
1313 | } |
1314 | |
1315 | |
1316 | |
1317 | inline Error createFileError(const Twine &F, size_t Line, Error E) { |
1318 | return FileError::build(F, Optional<size_t>(Line), std::move(E)); |
1319 | } |
1320 | |
1321 | |
1322 | |
1323 | inline Error createFileError(const Twine &F, std::error_code EC) { |
1324 | return createFileError(F, errorCodeToError(EC)); |
1325 | } |
1326 | |
1327 | |
1328 | |
1329 | inline Error createFileError(const Twine &F, size_t Line, std::error_code EC) { |
1330 | return createFileError(F, Line, errorCodeToError(EC)); |
1331 | } |
1332 | |
1333 | Error createFileError(const Twine &F, ErrorSuccess) = delete; |
1334 | |
1335 | |
1336 | |
1337 | |
1338 | |
1339 | class ExitOnError { |
1340 | public: |
1341 | |
1342 | ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1) |
1343 | : Banner(std::move(Banner)), |
1344 | GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {} |
1345 | |
1346 | |
1347 | void setBanner(std::string Banner) { this->Banner = std::move(Banner); } |
1348 | |
1349 | |
1350 | void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) { |
1351 | this->GetExitCode = std::move(GetExitCode); |
1352 | } |
1353 | |
1354 | |
1355 | void operator()(Error Err) const { checkError(std::move(Err)); } |
1356 | |
1357 | |
1358 | |
1359 | template <typename T> T operator()(Expected<T> &&E) const { |
1360 | checkError(E.takeError()); |
1361 | return std::move(*E); |
1362 | } |
1363 | |
1364 | |
1365 | |
1366 | template <typename T> T& operator()(Expected<T&> &&E) const { |
1367 | checkError(E.takeError()); |
1368 | return *E; |
1369 | } |
1370 | |
1371 | private: |
1372 | void checkError(Error Err) const { |
1373 | if (Err) { |
1374 | int ExitCode = GetExitCode(Err); |
1375 | logAllUnhandledErrors(std::move(Err), errs(), Banner); |
1376 | exit(ExitCode); |
1377 | } |
1378 | } |
1379 | |
1380 | std::string Banner; |
1381 | std::function<int(const Error &)> GetExitCode; |
1382 | }; |
1383 | |
1384 | |
1385 | inline LLVMErrorRef wrap(Error Err) { |
1386 | return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release()); |
1387 | } |
1388 | |
1389 | |
1390 | inline Error unwrap(LLVMErrorRef ErrRef) { |
1391 | return Error(std::unique_ptr<ErrorInfoBase>( |
1392 | reinterpret_cast<ErrorInfoBase *>(ErrRef))); |
1393 | } |
1394 | |
1395 | } |
1396 | |
1397 | #endif // LLVM_SUPPORT_ERROR_H |