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. */
11 #include <simgrid/s4u/Engine.hpp>
13 #include "mc/datatypes.h"
14 #include "src/mc/mc_private.hpp"
16 #include "src/mc/inspect/ObjectInformation.hpp"
17 #include "src/mc/inspect/Type.hpp"
18 #include "src/mc/inspect/Variable.hpp"
19 #include "src/mc/remote/RemoteProcess.hpp"
24 #include <elfutils/version.h>
25 #if _ELFUTILS_VERSION < 171
26 // Elder elfutils/libdw broken with multi-dimensional arrays. See https://sourceware.org/bugzilla/show_bug.cgi?id=22546
27 int test_some_array[4 * 5 * 6];
29 int test_some_array[4][5][6];
36 some_struct test_some_struct;
38 static simgrid::mc::Frame* find_function_by_name(
39 simgrid::mc::ObjectInformation* info, const char* name)
41 for (auto& [_, entry] : info->subprograms)
42 if (entry.name == name)
47 static simgrid::mc::Variable* find_local_variable(
48 simgrid::mc::Frame* frame, const char* argument_name)
50 for (simgrid::mc::Variable& variable : frame->variables)
51 if(argument_name == variable.name)
54 for (simgrid::mc::Frame& scope : frame->scopes) {
55 simgrid::mc::Variable* variable = find_local_variable(
56 &scope, argument_name);
64 static void test_local_variable(simgrid::mc::ObjectInformation* info, const char* function, const char* variable,
65 const void* address, unw_cursor_t* cursor)
67 simgrid::mc::Frame* subprogram = find_function_by_name(info, function);
69 // TODO, Lookup frame by IP and test against name instead
71 const simgrid::mc::Variable* var = find_local_variable(subprogram, variable);
74 void* frame_base = subprogram->frame_base(*cursor);
75 simgrid::dwarf::Location location = simgrid::dwarf::resolve(var->location_list, info, cursor, frame_base, nullptr);
77 xbt_assert(location.in_memory(), "Expected the variable %s of function %s to be in memory", variable, function);
78 xbt_assert(location.address() == address, "Bad resolution of local variable %s of %s", variable, function);
81 static const simgrid::mc::Variable* test_global_variable(const simgrid::mc::RemoteProcess& process,
82 simgrid::mc::ObjectInformation* info, const char* name,
83 void* address, long byte_size)
85 const simgrid::mc::Variable* variable = info->find_variable(name);
86 xbt_assert(variable, "Global variable %s was not found", name);
87 xbt_assert(variable->name == name, "Name mismatch for %s", name);
88 xbt_assert(variable->global, "Variable %s is not global", name);
89 xbt_assert(variable->address == address, "Address mismatch for %s : %p expected but %p found", name, address,
92 auto i = process.binary_info->types.find(variable->type_id);
93 xbt_assert(i != process.binary_info->types.end(), "Missing type for %s", name);
94 const simgrid::mc::Type* type = &i->second;
95 xbt_assert(type->byte_size == byte_size, "Byte size mismatch for %s", name);
99 static simgrid::mc::Member* find_member(simgrid::mc::Type& type, const char* name)
101 for (simgrid::mc::Member& member : type.members)
102 if(member.name == name)
107 int some_local_variable = 0;
113 static void test_type_by_name(const simgrid::mc::RemoteProcess& process, s_foo /*my_foo*/)
115 assert(process.binary_info->full_types_by_name.find("struct s_foo") != process.binary_info->full_types_by_name.end());
118 int main(int argc, char** argv)
120 simgrid::s4u::Engine::get_instance(&argc, argv);
122 const simgrid::mc::Variable* var;
123 simgrid::mc::Type* type;
125 simgrid::mc::RemoteProcess process(getpid());
126 process.init(nullptr, nullptr);
128 test_global_variable(process, process.binary_info.get(), "some_local_variable", &some_local_variable, sizeof(int));
130 var = test_global_variable(process, process.binary_info.get(), "test_some_array", &test_some_array,
131 sizeof(test_some_array));
132 auto i = process.binary_info->types.find(var->type_id);
133 xbt_assert(i != process.binary_info->types.end(), "Missing type");
135 xbt_assert(type->element_count == 6 * 5 * 4, "element_count mismatch in test_some_array : %i / %i",
136 type->element_count, 6 * 5 * 4);
138 var = test_global_variable(process, process.binary_info.get(), "test_some_struct", &test_some_struct,
139 sizeof(test_some_struct));
140 i = process.binary_info->types.find(var->type_id);
141 xbt_assert(i != process.binary_info->types.end(), "Missing type");
145 assert(find_member(*type, "first")->offset() == 0);
146 assert(find_member(*type, "second")->offset() ==
147 ((const char*)&test_some_struct.second) - (const char*)&test_some_struct);
149 unw_context_t context;
151 unw_getcontext(&context);
152 unw_init_local(&cursor, &context);
154 test_local_variable(process.binary_info.get(), "main", "argc", &argc, &cursor);
156 int lexical_block_variable = 50;
157 test_local_variable(process.binary_info.get(), "main", "lexical_block_variable", &lexical_block_variable, &cursor);
160 test_type_by_name(process, my_foo);