1 /* mc::RemoteClient: representative of the Client memory on the MC side */
3 /* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #ifndef SIMGRID_MC_PROCESS_H
9 #define SIMGRID_MC_PROCESS_H
11 #include "src/mc/AddressSpace.hpp"
12 #include "src/mc/datatypes.h"
13 #include "src/mc/inspect/ObjectInformation.hpp"
14 #include "src/mc/remote/RemotePtr.hpp"
15 #include "src/xbt/memory_map.hpp"
16 #include "src/xbt/mmalloc/mmprivate.h"
18 #include <libunwind.h>
21 namespace simgrid::mc {
23 struct IgnoredRegion {
28 struct IgnoredHeapRegion {
35 /** The Application's process memory, seen from the Checker perspective. This class is not needed if you don't need to
36 * introspect the application process.
39 * - reading from the process memory (`AddressSpace`);
40 * - accessing the system state of the process (heap, …);
44 class RemoteProcessMemory final : public AddressSpace {
46 // Those flags are used to track down which cached information
47 // is still up to date and which information needs to be updated.
48 static constexpr int cache_none = 0;
49 static constexpr int cache_heap = 1;
50 static constexpr int cache_malloc = 2;
53 explicit RemoteProcessMemory(pid_t pid, xbt_mheap_t mmalloc_default_mdp);
54 ~RemoteProcessMemory() override;
56 RemoteProcessMemory(RemoteProcessMemory const&) = delete;
57 RemoteProcessMemory(RemoteProcessMemory&&) = delete;
58 RemoteProcessMemory& operator=(RemoteProcessMemory const&) = delete;
59 RemoteProcessMemory& operator=(RemoteProcessMemory&&) = delete;
66 void* read_bytes(void* buffer, std::size_t size, RemotePtr<void> address,
67 ReadOptions options = ReadOptions::none()) const override;
69 void read_variable(const char* name, void* target, size_t size) const;
70 template <class T> void read_variable(const char* name, T* target) const
72 read_variable(name, target, sizeof(*target));
74 template <class T> Remote<T> read_variable(const char* name) const
77 read_variable(name, res.get_buffer(), sizeof(T));
81 std::string read_string(RemotePtr<char> address) const;
82 using AddressSpace::read_string;
85 void write_bytes(const void* buffer, size_t len, RemotePtr<void> address) const;
86 void clear_bytes(RemotePtr<void> address, size_t len) const;
89 std::shared_ptr<ObjectInformation> find_object_info(RemotePtr<void> addr) const;
90 std::shared_ptr<ObjectInformation> find_object_info_exec(RemotePtr<void> addr) const;
91 std::shared_ptr<ObjectInformation> find_object_info_rw(RemotePtr<void> addr) const;
92 Frame* find_function(RemotePtr<void> ip) const;
93 const Variable* find_variable(const char* name) const;
96 xbt_mheap_t get_heap()
98 if (not(cache_flags_ & RemoteProcessMemory::cache_heap))
100 return this->heap.get();
102 const malloc_info* get_malloc_info()
104 if (not(this->cache_flags_ & RemoteProcessMemory::cache_malloc))
105 this->refresh_malloc_info();
106 return this->heap_info.data();
108 /* Get the amount of memory mallocated in the remote process (requires mmalloc) */
109 std::size_t get_remote_heap_bytes();
111 void clear_cache() { this->cache_flags_ = RemoteProcessMemory::cache_none; }
113 std::vector<IgnoredRegion> const& ignored_regions() const { return ignored_regions_; }
114 void ignore_region(std::uint64_t address, std::size_t size);
116 bool in_maestro_stack(RemotePtr<void> p) const
118 return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
121 void ignore_global_variable(const char* name) const
123 for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
124 info->remove_global_variable(name);
127 std::vector<s_stack_region_t>& stack_areas() { return stack_areas_; }
128 std::vector<s_stack_region_t> const& stack_areas() const { return stack_areas_; }
130 std::vector<IgnoredHeapRegion> const& ignored_heap() const { return ignored_heap_; }
131 void ignore_heap(IgnoredHeapRegion const& region);
132 void unignore_heap(void* address, size_t size);
134 void ignore_local_variable(const char* var_name, const char* frame_name) const;
136 void dump_stack() const;
139 void init_memory_map_info();
141 void refresh_malloc_info();
144 std::vector<xbt::VmMap> memory_map_;
145 RemotePtr<void> maestro_stack_start_;
146 RemotePtr<void> maestro_stack_end_;
147 int memory_file = -1;
148 std::vector<IgnoredRegion> ignored_regions_;
149 std::vector<s_stack_region_t> stack_areas_;
150 std::vector<IgnoredHeapRegion> ignored_heap_;
152 /** State of the cache (which variables are up to date) */
153 int cache_flags_ = RemoteProcessMemory::cache_none;
157 // TODO, make private (first, objectify simgrid::mc::ObjectInformation*)
158 std::vector<std::shared_ptr<ObjectInformation>> object_infos;
159 std::shared_ptr<ObjectInformation> binary_info;
161 /** Address of the heap structure in the MCed process. */
162 RemotePtr<s_xbt_mheap_t> heap_address;
164 /** Copy of the heap structure of the process
166 * This is refreshed with the `MC_process_refresh` call.
167 * This is not used if the process is the current one:
168 * use `get_heap_info()` in order to use it.
170 std::unique_ptr<s_xbt_mheap_t> heap = std::make_unique<s_xbt_mheap_t>();
172 /** Copy of the allocation info structure
174 * This is refreshed with the `MC_process_refresh` call.
175 * This is not used if the process is the current one:
176 * use `get_malloc_info()` in order to use it.
178 std::vector<malloc_info> heap_info;
181 /** Full-featured MC-aware libunwind address space for the process
183 * This address space is using a simgrid::mc::UnwindContext*
184 * (with simgrid::mc::Process* / simgrid::mc::AddressSpace*
185 * and unw_context_t).
187 unw_addr_space_t unw_addr_space = nullptr;
189 /** Underlying libunwind address-space
191 * The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr`
192 * operations of the native MC address space is currently delegated
193 * to this address space (either the local or a ptrace unwinder).
195 unw_addr_space_t unw_underlying_addr_space = nullptr;
197 /** The corresponding context
199 void* unw_underlying_context = nullptr;
202 /** Open a FD to a remote process memory (`/dev/$pid/mem`) */
203 XBT_PRIVATE int open_vm(pid_t pid, int flags);
204 } // namespace simgrid::mc