1 /* Copyright (c) 2007-2020. 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. */
6 #ifndef SIMGRID_MC_OBJECT_INFORMATION_HPP
7 #define SIMGRID_MC_OBJECT_INFORMATION_HPP
11 #include <unordered_map>
14 #include "src/mc/inspect/Frame.hpp"
15 #include "src/mc/inspect/Type.hpp"
16 #include "src/mc/mc_forward.hpp"
17 #include "src/xbt/memory_map.hpp"
19 #include "src/smpi/include/private.hpp"
24 /** An entry in the functions index
26 * See the code of ObjectInformation::find_function.
28 struct FunctionIndexEntry {
30 simgrid::mc::Frame* function;
33 /** Information about an ELF module (executable or shared object)
35 * This contains all the information we need about an executable or
36 * shared-object in the model-checked process:
38 * - where it is located in the virtual address space;
40 * - where are located its different memory mappings in the the
41 * virtual address space;
43 * - all the debugging (DWARF) information
45 * - location of the functions and their local variables,
50 class ObjectInformation {
52 ObjectInformation() = default;
55 ObjectInformation(ObjectInformation const&) = delete;
56 ObjectInformation& operator=(ObjectInformation const&) = delete;
59 static const int Executable = 1;
61 /** Bitfield of flags */
63 std::string file_name;
64 const void* start = nullptr;
65 const void* end = nullptr;
66 // Location of its text segment:
67 char* start_exec = nullptr;
68 char* end_exec = nullptr;
69 // Location of the read-only part of its data segment:
70 char* start_rw = nullptr;
71 char* end_rw = nullptr;
72 // Location of the read/write part of its data segment:
73 char* start_ro = nullptr;
74 char* end_ro = nullptr;
76 /** All of its subprograms indexed by their address */
77 std::unordered_map<std::uint64_t, simgrid::mc::Frame> subprograms;
79 /** Index of functions by instruction address
81 * We need to efficiently find the function from any given instruction
82 * address inside its range. This index is sorted by low_pc
84 * The entries are sorted by low_pc and a binary search can be used to look
85 * them up. In order to have a better cache locality, we only keep the
86 * information we need for the lookup in this vector. We could probably
87 * replace subprograms by an ordered vector of Frame and replace this one b
88 * a parallel `std::vector<void*>`.
90 std::vector<FunctionIndexEntry> functions_index;
92 std::vector<simgrid::mc::Variable> global_variables;
94 /** Types indexed by DWARF ID */
95 std::unordered_map<std::uint64_t, simgrid::mc::Type> types;
97 /** Types indexed by name
99 * Different compilation units have their separate type definitions
100 * (for the same type). When we find an opaque type in one compilation unit,
101 * we use this in order to try to find its definition in another compilation
104 std::unordered_map<std::string, simgrid::mc::Type*> full_types_by_name;
106 /** Whether this module is an executable
108 * More precisely we check if this is an ET_EXE ELF. These ELF files
109 * use fixed addresses instead of base-address relative addresses.
110 * Position independent executables are in fact ET_DYN.
112 bool executable() const { return this->flags & simgrid::mc::ObjectInformation::Executable; }
114 /** Base address of the module
116 * All the location information in ELF and DWARF are expressed as an offsets
117 * from this base address:
119 * - location of the functions and global variables
121 * - the DWARF instruction `OP_addr` pushes this on the DWARF stack.
123 void* base_address() const;
125 /** Find a function by instruction address
127 * @param ip instruction address
128 * @return corresponding function (if any) or nullptr
130 simgrid::mc::Frame* find_function(const void* ip) const;
132 /** Find a global variable by name
134 * This is used to ignore global variables and to find well-known variables
135 * (`__mmalloc_default_mdp`).
137 * @param name scopes name of the global variable (`myproject::Foo::count`)
138 * @return corresponding variable (if any) or nullptr
140 const simgrid::mc::Variable* find_variable(const char* name) const;
142 /** Remove a global variable (in order to ignore it)
144 * This is used to ignore a global variable for the snapshot comparison.
146 void remove_global_variable(const char* name);
148 /** Remove a local variables (in order to ignore it)
150 * @param name Name of the local variable
151 * @param scope scopes name name of the function (myproject::Foo::count) or null for all functions
153 void remove_local_variable(const char* name, const char* scope);
156 XBT_PRIVATE std::shared_ptr<ObjectInformation> createObjectInformation(std::vector<simgrid::xbt::VmMap> const& maps,
159 /** Augment the current module with informations about the other ones */
160 XBT_PRIVATE void postProcessObjectInformation(const simgrid::mc::RemoteClient* process,
161 simgrid::mc::ObjectInformation* info);
163 } // namespace simgrid