1 /* Copyright (c) 2014-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include <unordered_set>
10 #include "src/mc/AddressSpace.hpp"
11 #include "src/mc/inspect/DwarfExpression.hpp"
12 #include "src/mc/inspect/Frame.hpp"
13 #include "src/mc/inspect/LocationList.hpp"
14 #include "src/mc/inspect/ObjectInformation.hpp"
15 #include "src/mc/inspect/mc_dwarf.hpp"
16 #include "src/mc/mc_private.hpp"
18 namespace simgrid::dwarf {
20 void execute(const Dwarf_Op* ops, std::size_t n, const ExpressionContext& context, ExpressionStack& stack)
22 for (size_t i = 0; i != n; ++i) {
23 const Dwarf_Op* op = ops + i;
24 std::uint8_t atom = op->atom;
29 // Push the CFA (Canonical Frame Address):
30 case DW_OP_call_frame_cfa:
31 /* See 6.4 of DWARF4 (http://dwarfstd.org/doc/DWARF4.pdf#page=140):
33 * > Typically, the CFA is defined to be the value of the stack
34 * > pointer at the call site in the previous frame (which may be
35 * > different from its value on entry to the current frame).
37 * We need to unwind the frame in order to get the SP of the parent
40 * Warning: the CFA returned by libunwind (UNW_X86_64_RSP, etc.)
41 * is the SP of the *current* frame. */
44 unw_cursor_t cursor = *(context.cursor);
48 unw_get_reg(&cursor, UNW_REG_SP, &res);
52 throw evaluation_error("Missing cursor");
56 stack.push((std::uintptr_t)context.frame_base + op->number);
59 // Address from the base address of this ELF object.
60 // Push the address on the stack (base_address + argument).
62 if (context.object_info) {
63 Dwarf_Off addr = (Dwarf_Off)(std::uintptr_t)context.object_info->base_address() + op->number;
67 throw evaluation_error("No base address");
69 // ***** Stack manipulation:
71 // Push another copy/duplicate the value at the top of the stack:
76 // Pop/drop the top of the stack:
85 // Duplicate the value under the top of the stack:
87 stack.push(stack.top(1));
91 // Those usually take the top of the stack and the next value as argument
92 // and replace the top of the stack with the computed value
93 // (stack.top() += stack.before_top()).
98 stack.push(first + second);
103 second = stack.pop();
104 stack.push(first * second);
107 case DW_OP_plus_uconst:
108 stack.top() += op->number;
112 stack.top() = ~stack.top();
116 stack.top() = -(intptr_t)stack.top();
121 second = stack.pop();
122 stack.push(second - first);
127 second = stack.pop();
128 stack.push(first & second);
133 second = stack.pop();
134 stack.push(first | second);
139 second = stack.pop();
140 stack.push(first ^ second);
146 // ***** Deference (memory fetch)
148 case DW_OP_deref_size:
149 throw evaluation_error("Unsupported operation");
153 if (not context.address_space)
154 throw evaluation_error("Missing address space");
155 context.address_space->read_bytes(&stack.top(), sizeof(uintptr_t), mc::remote(stack.top()));
161 if (static const std::unordered_set<uint8_t> registers =
162 {DW_OP_breg0, DW_OP_breg1, DW_OP_breg2, DW_OP_breg3, DW_OP_breg4, DW_OP_breg5, DW_OP_breg6,
163 DW_OP_breg7, DW_OP_breg8, DW_OP_breg9, DW_OP_breg10, DW_OP_breg11, DW_OP_breg12, DW_OP_breg13,
164 DW_OP_breg14, DW_OP_breg15, DW_OP_breg16, DW_OP_breg17, DW_OP_breg18, DW_OP_breg19, DW_OP_breg20,
165 DW_OP_breg21, DW_OP_breg22, DW_OP_breg23, DW_OP_breg24, DW_OP_breg25, DW_OP_breg26, DW_OP_breg27,
166 DW_OP_breg28, DW_OP_breg29, DW_OP_breg30, DW_OP_breg31};
167 registers.count(atom) > 0) {
168 // Push register + constant:
169 int register_id = dwarf_register_to_libunwind(op->atom - DW_OP_breg0);
171 if (not context.cursor)
172 throw evaluation_error("Missing stack context");
173 unw_get_reg(context.cursor, register_id, &res);
174 stack.push(res + op->number);
180 // Short constant literals:
181 if (static const std::unordered_set<uint8_t> literals = {DW_OP_lit0, DW_OP_lit1, DW_OP_lit2, DW_OP_lit3,
182 DW_OP_lit4, DW_OP_lit5, DW_OP_lit6, DW_OP_lit7,
183 DW_OP_lit8, DW_OP_lit9, DW_OP_lit10, DW_OP_lit11,
184 DW_OP_lit12, DW_OP_lit13, DW_OP_lit14, DW_OP_lit15,
185 DW_OP_lit16, DW_OP_lit17, DW_OP_lit18, DW_OP_lit19,
186 DW_OP_lit20, DW_OP_lit21, DW_OP_lit22, DW_OP_lit23,
187 DW_OP_lit24, DW_OP_lit25, DW_OP_lit26, DW_OP_lit27,
188 DW_OP_lit28, DW_OP_lit29, DW_OP_lit30, DW_OP_lit31};
189 literals.count(atom) > 0) {
190 // Push a literal/constant on the stack:
191 stack.push(atom - DW_OP_lit0);
195 // General constants:
196 if (static const std::unordered_set<uint8_t> constants = {DW_OP_const1u, DW_OP_const2u, DW_OP_const4u,
197 DW_OP_const8u, DW_OP_const1s, DW_OP_const2s,
198 DW_OP_const4s, DW_OP_const8s, DW_OP_constu,
200 constants.count(atom) > 0) {
201 // Push the constant argument on the stack.
202 stack.push(op->number);
207 throw evaluation_error("Unsupported operation");
212 } // namespace simgrid::dwarf