[ORC] Add std::tuple support to SimplePackedSerialization.
[llvm-project.git] / llvm / lib / DebugInfo / DWARF / DWARFExpression.cpp
blob4b9be85f68853dbd0a513f494926210390a491f7
1 //===-- DWARFExpression.cpp -----------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
9 #include "llvm/DebugInfo/DWARF/DWARFExpression.h"
10 #include "llvm/DebugInfo/DWARF/DWARFUnit.h"
11 #include "llvm/MC/MCRegisterInfo.h"
12 #include "llvm/Support/Format.h"
13 #include <cassert>
14 #include <cstdint>
15 #include <vector>
17 using namespace llvm;
18 using namespace dwarf;
20 namespace llvm {
22 typedef std::vector<DWARFExpression::Operation::Description> DescVector;
24 static DescVector getDescriptions() {
25 DescVector Descriptions;
26 typedef DWARFExpression::Operation Op;
27 typedef Op::Description Desc;
29 Descriptions.resize(0xff);
30 Descriptions[DW_OP_addr] = Desc(Op::Dwarf2, Op::SizeAddr);
31 Descriptions[DW_OP_deref] = Desc(Op::Dwarf2);
32 Descriptions[DW_OP_const1u] = Desc(Op::Dwarf2, Op::Size1);
33 Descriptions[DW_OP_const1s] = Desc(Op::Dwarf2, Op::SignedSize1);
34 Descriptions[DW_OP_const2u] = Desc(Op::Dwarf2, Op::Size2);
35 Descriptions[DW_OP_const2s] = Desc(Op::Dwarf2, Op::SignedSize2);
36 Descriptions[DW_OP_const4u] = Desc(Op::Dwarf2, Op::Size4);
37 Descriptions[DW_OP_const4s] = Desc(Op::Dwarf2, Op::SignedSize4);
38 Descriptions[DW_OP_const8u] = Desc(Op::Dwarf2, Op::Size8);
39 Descriptions[DW_OP_const8s] = Desc(Op::Dwarf2, Op::SignedSize8);
40 Descriptions[DW_OP_constu] = Desc(Op::Dwarf2, Op::SizeLEB);
41 Descriptions[DW_OP_consts] = Desc(Op::Dwarf2, Op::SignedSizeLEB);
42 Descriptions[DW_OP_dup] = Desc(Op::Dwarf2);
43 Descriptions[DW_OP_drop] = Desc(Op::Dwarf2);
44 Descriptions[DW_OP_over] = Desc(Op::Dwarf2);
45 Descriptions[DW_OP_pick] = Desc(Op::Dwarf2, Op::Size1);
46 Descriptions[DW_OP_swap] = Desc(Op::Dwarf2);
47 Descriptions[DW_OP_rot] = Desc(Op::Dwarf2);
48 Descriptions[DW_OP_xderef] = Desc(Op::Dwarf2);
49 Descriptions[DW_OP_abs] = Desc(Op::Dwarf2);
50 Descriptions[DW_OP_and] = Desc(Op::Dwarf2);
51 Descriptions[DW_OP_div] = Desc(Op::Dwarf2);
52 Descriptions[DW_OP_minus] = Desc(Op::Dwarf2);
53 Descriptions[DW_OP_mod] = Desc(Op::Dwarf2);
54 Descriptions[DW_OP_mul] = Desc(Op::Dwarf2);
55 Descriptions[DW_OP_neg] = Desc(Op::Dwarf2);
56 Descriptions[DW_OP_not] = Desc(Op::Dwarf2);
57 Descriptions[DW_OP_or] = Desc(Op::Dwarf2);
58 Descriptions[DW_OP_plus] = Desc(Op::Dwarf2);
59 Descriptions[DW_OP_plus_uconst] = Desc(Op::Dwarf2, Op::SizeLEB);
60 Descriptions[DW_OP_shl] = Desc(Op::Dwarf2);
61 Descriptions[DW_OP_shr] = Desc(Op::Dwarf2);
62 Descriptions[DW_OP_shra] = Desc(Op::Dwarf2);
63 Descriptions[DW_OP_xor] = Desc(Op::Dwarf2);
64 Descriptions[DW_OP_skip] = Desc(Op::Dwarf2, Op::SignedSize2);
65 Descriptions[DW_OP_bra] = Desc(Op::Dwarf2, Op::SignedSize2);
66 Descriptions[DW_OP_eq] = Desc(Op::Dwarf2);
67 Descriptions[DW_OP_ge] = Desc(Op::Dwarf2);
68 Descriptions[DW_OP_gt] = Desc(Op::Dwarf2);
69 Descriptions[DW_OP_le] = Desc(Op::Dwarf2);
70 Descriptions[DW_OP_lt] = Desc(Op::Dwarf2);
71 Descriptions[DW_OP_ne] = Desc(Op::Dwarf2);
72 for (uint16_t LA = DW_OP_lit0; LA <= DW_OP_lit31; ++LA)
73 Descriptions[LA] = Desc(Op::Dwarf2);
74 for (uint16_t LA = DW_OP_reg0; LA <= DW_OP_reg31; ++LA)
75 Descriptions[LA] = Desc(Op::Dwarf2);
76 for (uint16_t LA = DW_OP_breg0; LA <= DW_OP_breg31; ++LA)
77 Descriptions[LA] = Desc(Op::Dwarf2, Op::SignedSizeLEB);
78 Descriptions[DW_OP_regx] = Desc(Op::Dwarf2, Op::SizeLEB);
79 Descriptions[DW_OP_fbreg] = Desc(Op::Dwarf2, Op::SignedSizeLEB);
80 Descriptions[DW_OP_bregx] = Desc(Op::Dwarf2, Op::SizeLEB, Op::SignedSizeLEB);
81 Descriptions[DW_OP_piece] = Desc(Op::Dwarf2, Op::SizeLEB);
82 Descriptions[DW_OP_deref_size] = Desc(Op::Dwarf2, Op::Size1);
83 Descriptions[DW_OP_xderef_size] = Desc(Op::Dwarf2, Op::Size1);
84 Descriptions[DW_OP_nop] = Desc(Op::Dwarf2);
85 Descriptions[DW_OP_push_object_address] = Desc(Op::Dwarf3);
86 Descriptions[DW_OP_call2] = Desc(Op::Dwarf3, Op::Size2);
87 Descriptions[DW_OP_call4] = Desc(Op::Dwarf3, Op::Size4);
88 Descriptions[DW_OP_call_ref] = Desc(Op::Dwarf3, Op::SizeRefAddr);
89 Descriptions[DW_OP_form_tls_address] = Desc(Op::Dwarf3);
90 Descriptions[DW_OP_call_frame_cfa] = Desc(Op::Dwarf3);
91 Descriptions[DW_OP_bit_piece] = Desc(Op::Dwarf3, Op::SizeLEB, Op::SizeLEB);
92 Descriptions[DW_OP_implicit_value] =
93 Desc(Op::Dwarf3, Op::SizeLEB, Op::SizeBlock);
94 Descriptions[DW_OP_stack_value] = Desc(Op::Dwarf3);
95 Descriptions[DW_OP_WASM_location] =
96 Desc(Op::Dwarf4, Op::SizeLEB, Op::WasmLocationArg);
97 Descriptions[DW_OP_GNU_push_tls_address] = Desc(Op::Dwarf3);
98 Descriptions[DW_OP_addrx] = Desc(Op::Dwarf4, Op::SizeLEB);
99 Descriptions[DW_OP_GNU_addr_index] = Desc(Op::Dwarf4, Op::SizeLEB);
100 Descriptions[DW_OP_GNU_const_index] = Desc(Op::Dwarf4, Op::SizeLEB);
101 Descriptions[DW_OP_GNU_entry_value] = Desc(Op::Dwarf4, Op::SizeLEB);
103 Descriptions[DW_OP_convert] = Desc(Op::Dwarf5, Op::BaseTypeRef);
104 Descriptions[DW_OP_entry_value] = Desc(Op::Dwarf5, Op::SizeLEB);
105 Descriptions[DW_OP_regval_type] =
106 Desc(Op::Dwarf5, Op::SizeLEB, Op::BaseTypeRef);
108 return Descriptions;
111 static DWARFExpression::Operation::Description getOpDesc(unsigned OpCode) {
112 // FIXME: Make this constexpr once all compilers are smart enough to do it.
113 static DescVector Descriptions = getDescriptions();
114 // Handle possible corrupted or unsupported operation.
115 if (OpCode >= Descriptions.size())
116 return {};
117 return Descriptions[OpCode];
120 bool DWARFExpression::Operation::extract(DataExtractor Data,
121 uint8_t AddressSize, uint64_t Offset,
122 Optional<DwarfFormat> Format) {
123 EndOffset = Offset;
124 Opcode = Data.getU8(&Offset);
126 Desc = getOpDesc(Opcode);
127 if (Desc.Version == Operation::DwarfNA)
128 return false;
130 for (unsigned Operand = 0; Operand < 2; ++Operand) {
131 unsigned Size = Desc.Op[Operand];
132 unsigned Signed = Size & Operation::SignBit;
134 if (Size == Operation::SizeNA)
135 break;
137 switch (Size & ~Operation::SignBit) {
138 case Operation::Size1:
139 Operands[Operand] = Data.getU8(&Offset);
140 if (Signed)
141 Operands[Operand] = (int8_t)Operands[Operand];
142 break;
143 case Operation::Size2:
144 Operands[Operand] = Data.getU16(&Offset);
145 if (Signed)
146 Operands[Operand] = (int16_t)Operands[Operand];
147 break;
148 case Operation::Size4:
149 Operands[Operand] = Data.getU32(&Offset);
150 if (Signed)
151 Operands[Operand] = (int32_t)Operands[Operand];
152 break;
153 case Operation::Size8:
154 Operands[Operand] = Data.getU64(&Offset);
155 break;
156 case Operation::SizeAddr:
157 Operands[Operand] = Data.getUnsigned(&Offset, AddressSize);
158 break;
159 case Operation::SizeRefAddr:
160 if (!Format)
161 return false;
162 Operands[Operand] =
163 Data.getUnsigned(&Offset, dwarf::getDwarfOffsetByteSize(*Format));
164 break;
165 case Operation::SizeLEB:
166 if (Signed)
167 Operands[Operand] = Data.getSLEB128(&Offset);
168 else
169 Operands[Operand] = Data.getULEB128(&Offset);
170 break;
171 case Operation::BaseTypeRef:
172 Operands[Operand] = Data.getULEB128(&Offset);
173 break;
174 case Operation::WasmLocationArg:
175 assert(Operand == 1);
176 switch (Operands[0]) {
177 case 0:
178 case 1:
179 case 2:
180 case 4:
181 Operands[Operand] = Data.getULEB128(&Offset);
182 break;
183 case 3: // global as uint32
184 Operands[Operand] = Data.getU32(&Offset);
185 break;
186 default:
187 return false; // Unknown Wasm location
189 break;
190 case Operation::SizeBlock:
191 // We need a size, so this cannot be the first operand
192 if (Operand == 0)
193 return false;
194 // Store the offset of the block as the value.
195 Operands[Operand] = Offset;
196 Offset += Operands[Operand - 1];
197 break;
198 default:
199 llvm_unreachable("Unknown DWARFExpression Op size");
202 OperandEndOffsets[Operand] = Offset;
205 EndOffset = Offset;
206 return true;
209 static void prettyPrintBaseTypeRef(DWARFUnit *U, raw_ostream &OS,
210 DIDumpOptions DumpOpts, uint64_t Operands[2],
211 unsigned Operand) {
212 assert(Operand < 2 && "operand out of bounds");
213 auto Die = U->getDIEForOffset(U->getOffset() + Operands[Operand]);
214 if (Die && Die.getTag() == dwarf::DW_TAG_base_type) {
215 OS << " (";
216 if (DumpOpts.Verbose)
217 OS << format("0x%08" PRIx64 " -> ", Operands[Operand]);
218 OS << format("0x%08" PRIx64 ")", U->getOffset() + Operands[Operand]);
219 if (auto Name = Die.find(dwarf::DW_AT_name))
220 OS << " \"" << Name->getAsCString() << "\"";
221 } else {
222 OS << format(" <invalid base_type ref: 0x%" PRIx64 ">",
223 Operands[Operand]);
227 static bool prettyPrintRegisterOp(DWARFUnit *U, raw_ostream &OS,
228 DIDumpOptions DumpOpts, uint8_t Opcode,
229 uint64_t Operands[2],
230 const MCRegisterInfo *MRI, bool isEH) {
231 if (!MRI)
232 return false;
234 uint64_t DwarfRegNum;
235 unsigned OpNum = 0;
237 if (Opcode == DW_OP_bregx || Opcode == DW_OP_regx ||
238 Opcode == DW_OP_regval_type)
239 DwarfRegNum = Operands[OpNum++];
240 else if (Opcode >= DW_OP_breg0 && Opcode < DW_OP_bregx)
241 DwarfRegNum = Opcode - DW_OP_breg0;
242 else
243 DwarfRegNum = Opcode - DW_OP_reg0;
245 if (Optional<unsigned> LLVMRegNum = MRI->getLLVMRegNum(DwarfRegNum, isEH)) {
246 if (const char *RegName = MRI->getName(*LLVMRegNum)) {
247 if ((Opcode >= DW_OP_breg0 && Opcode <= DW_OP_breg31) ||
248 Opcode == DW_OP_bregx)
249 OS << format(" %s%+" PRId64, RegName, Operands[OpNum]);
250 else
251 OS << ' ' << RegName;
253 if (Opcode == DW_OP_regval_type)
254 prettyPrintBaseTypeRef(U, OS, DumpOpts, Operands, 1);
255 return true;
259 return false;
262 bool DWARFExpression::Operation::print(raw_ostream &OS, DIDumpOptions DumpOpts,
263 const DWARFExpression *Expr,
264 const MCRegisterInfo *RegInfo,
265 DWARFUnit *U, bool isEH) {
266 if (Error) {
267 OS << "<decoding error>";
268 return false;
271 StringRef Name = OperationEncodingString(Opcode);
272 assert(!Name.empty() && "DW_OP has no name!");
273 OS << Name;
275 if ((Opcode >= DW_OP_breg0 && Opcode <= DW_OP_breg31) ||
276 (Opcode >= DW_OP_reg0 && Opcode <= DW_OP_reg31) ||
277 Opcode == DW_OP_bregx || Opcode == DW_OP_regx ||
278 Opcode == DW_OP_regval_type)
279 if (prettyPrintRegisterOp(U, OS, DumpOpts, Opcode, Operands, RegInfo, isEH))
280 return true;
282 for (unsigned Operand = 0; Operand < 2; ++Operand) {
283 unsigned Size = Desc.Op[Operand];
284 unsigned Signed = Size & Operation::SignBit;
286 if (Size == Operation::SizeNA)
287 break;
289 if (Size == Operation::BaseTypeRef && U) {
290 // For DW_OP_convert the operand may be 0 to indicate that conversion to
291 // the generic type should be done. The same holds for DW_OP_reinterpret,
292 // which is currently not supported.
293 if (Opcode == DW_OP_convert && Operands[Operand] == 0)
294 OS << " 0x0";
295 else
296 prettyPrintBaseTypeRef(U, OS, DumpOpts, Operands, Operand);
297 } else if (Size == Operation::WasmLocationArg) {
298 assert(Operand == 1);
299 switch (Operands[0]) {
300 case 0:
301 case 1:
302 case 2:
303 case 3: // global as uint32
304 case 4:
305 OS << format(" 0x%" PRIx64, Operands[Operand]);
306 break;
307 default: assert(false);
309 } else if (Size == Operation::SizeBlock) {
310 uint64_t Offset = Operands[Operand];
311 for (unsigned i = 0; i < Operands[Operand - 1]; ++i)
312 OS << format(" 0x%02x", Expr->Data.getU8(&Offset));
313 } else {
314 if (Signed)
315 OS << format(" %+" PRId64, (int64_t)Operands[Operand]);
316 else if (Opcode != DW_OP_entry_value &&
317 Opcode != DW_OP_GNU_entry_value)
318 OS << format(" 0x%" PRIx64, Operands[Operand]);
321 return true;
324 void DWARFExpression::print(raw_ostream &OS, DIDumpOptions DumpOpts,
325 const MCRegisterInfo *RegInfo, DWARFUnit *U,
326 bool IsEH) const {
327 uint32_t EntryValExprSize = 0;
328 uint64_t EntryValStartOffset = 0;
329 if (Data.getData().empty())
330 OS << "<empty>";
332 for (auto &Op : *this) {
333 if (!Op.print(OS, DumpOpts, this, RegInfo, U, IsEH)) {
334 uint64_t FailOffset = Op.getEndOffset();
335 while (FailOffset < Data.getData().size())
336 OS << format(" %02x", Data.getU8(&FailOffset));
337 return;
340 if (Op.getCode() == DW_OP_entry_value ||
341 Op.getCode() == DW_OP_GNU_entry_value) {
342 OS << "(";
343 EntryValExprSize = Op.getRawOperand(0);
344 EntryValStartOffset = Op.getEndOffset();
345 continue;
348 if (EntryValExprSize) {
349 EntryValExprSize -= Op.getEndOffset() - EntryValStartOffset;
350 if (EntryValExprSize == 0)
351 OS << ")";
354 if (Op.getEndOffset() < Data.getData().size())
355 OS << ", ";
359 bool DWARFExpression::Operation::verify(DWARFUnit *U) {
361 for (unsigned Operand = 0; Operand < 2; ++Operand) {
362 unsigned Size = Desc.Op[Operand];
364 if (Size == Operation::SizeNA)
365 break;
367 if (Size == Operation::BaseTypeRef) {
368 // For DW_OP_convert the operand may be 0 to indicate that conversion to
369 // the generic type should be done, so don't look up a base type in that
370 // case. The same holds for DW_OP_reinterpret, which is currently not
371 // supported.
372 if (Opcode == DW_OP_convert && Operands[Operand] == 0)
373 continue;
374 auto Die = U->getDIEForOffset(U->getOffset() + Operands[Operand]);
375 if (!Die || Die.getTag() != dwarf::DW_TAG_base_type) {
376 Error = true;
377 return false;
382 return true;
385 bool DWARFExpression::verify(DWARFUnit *U) {
386 for (auto &Op : *this)
387 if (!Op.verify(U))
388 return false;
390 return true;
393 /// A user-facing string representation of a DWARF expression. This might be an
394 /// Address expression, in which case it will be implicitly dereferenced, or a
395 /// Value expression.
396 struct PrintedExpr {
397 enum ExprKind {
398 Address,
399 Value,
401 ExprKind Kind;
402 SmallString<16> String;
404 PrintedExpr(ExprKind K = Address) : Kind(K) {}
407 static bool printCompactDWARFExpr(raw_ostream &OS, DWARFExpression::iterator I,
408 const DWARFExpression::iterator E,
409 const MCRegisterInfo &MRI) {
410 SmallVector<PrintedExpr, 4> Stack;
412 while (I != E) {
413 DWARFExpression::Operation &Op = *I;
414 uint8_t Opcode = Op.getCode();
415 switch (Opcode) {
416 case dwarf::DW_OP_regx: {
417 // DW_OP_regx: A register, with the register num given as an operand.
418 // Printed as the plain register name.
419 uint64_t DwarfRegNum = Op.getRawOperand(0);
420 Optional<unsigned> LLVMRegNum = MRI.getLLVMRegNum(DwarfRegNum, false);
421 if (!LLVMRegNum) {
422 OS << "<unknown register " << DwarfRegNum << ">";
423 return false;
425 raw_svector_ostream S(Stack.emplace_back(PrintedExpr::Value).String);
426 S << MRI.getName(*LLVMRegNum);
427 break;
429 case dwarf::DW_OP_bregx: {
430 int DwarfRegNum = Op.getRawOperand(0);
431 int64_t Offset = Op.getRawOperand(1);
432 Optional<unsigned> LLVMRegNum = MRI.getLLVMRegNum(DwarfRegNum, false);
433 if (!LLVMRegNum) {
434 OS << "<unknown register " << DwarfRegNum << ">";
435 return false;
437 raw_svector_ostream S(Stack.emplace_back().String);
438 S << MRI.getName(*LLVMRegNum);
439 if (Offset)
440 S << format("%+" PRId64, Offset);
441 break;
443 case dwarf::DW_OP_entry_value:
444 case dwarf::DW_OP_GNU_entry_value: {
445 // DW_OP_entry_value contains a sub-expression which must be rendered
446 // separately.
447 uint64_t SubExprLength = Op.getRawOperand(0);
448 DWARFExpression::iterator SubExprEnd = I.skipBytes(SubExprLength);
449 ++I;
450 raw_svector_ostream S(Stack.emplace_back().String);
451 S << "entry(";
452 printCompactDWARFExpr(S, I, SubExprEnd, MRI);
453 S << ")";
454 I = SubExprEnd;
455 continue;
457 case dwarf::DW_OP_stack_value: {
458 // The top stack entry should be treated as the actual value of tne
459 // variable, rather than the address of the variable in memory.
460 assert(!Stack.empty());
461 Stack.back().Kind = PrintedExpr::Value;
462 break;
464 default:
465 if (Opcode >= dwarf::DW_OP_reg0 && Opcode <= dwarf::DW_OP_reg31) {
466 // DW_OP_reg<N>: A register, with the register num implied by the
467 // opcode. Printed as the plain register name.
468 uint64_t DwarfRegNum = Opcode - dwarf::DW_OP_reg0;
469 Optional<unsigned> LLVMRegNum = MRI.getLLVMRegNum(DwarfRegNum, false);
470 if (!LLVMRegNum) {
471 OS << "<unknown register " << DwarfRegNum << ">";
472 return false;
474 raw_svector_ostream S(Stack.emplace_back(PrintedExpr::Value).String);
475 S << MRI.getName(*LLVMRegNum);
476 } else if (Opcode >= dwarf::DW_OP_breg0 &&
477 Opcode <= dwarf::DW_OP_breg31) {
478 int DwarfRegNum = Opcode - dwarf::DW_OP_breg0;
479 int64_t Offset = Op.getRawOperand(0);
480 Optional<unsigned> LLVMRegNum = MRI.getLLVMRegNum(DwarfRegNum, false);
481 if (!LLVMRegNum) {
482 OS << "<unknown register " << DwarfRegNum << ">";
483 return false;
485 raw_svector_ostream S(Stack.emplace_back().String);
486 S << MRI.getName(*LLVMRegNum);
487 if (Offset)
488 S << format("%+" PRId64, Offset);
489 } else {
490 // If we hit an unknown operand, we don't know its effect on the stack,
491 // so bail out on the whole expression.
492 OS << "<unknown op " << dwarf::OperationEncodingString(Opcode) << " ("
493 << (int)Opcode << ")>";
494 return false;
496 break;
498 ++I;
501 assert(Stack.size() == 1 && "expected one value on stack");
503 if (Stack.front().Kind == PrintedExpr::Address)
504 OS << "[" << Stack.front().String << "]";
505 else
506 OS << Stack.front().String;
508 return true;
511 bool DWARFExpression::printCompact(raw_ostream &OS, const MCRegisterInfo &MRI) {
512 return printCompactDWARFExpr(OS, begin(), end(), MRI);
515 bool DWARFExpression::operator==(const DWARFExpression &RHS) const {
516 if (AddressSize != RHS.AddressSize || Format != RHS.Format)
517 return false;
518 return Data.getData() == RHS.Data.getData();
521 } // namespace llvm