1 /* Copyright (c) 2008-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef SIMGRID_MC_PROCESS_H
8 #define SIMGRID_MC_PROCESS_H
13 #include <type_traits>
18 #include <sys/types.h>
20 #include <simgrid_config.h>
23 #include <xbt/mmalloc.h>
25 #include "src/xbt/mmalloc/mmprivate.h"
26 #include "src/mc/Channel.hpp"
28 #include <simgrid/simix.h>
29 #include "src/simix/popping_private.h"
30 #include "src/simix/smx_private.h"
32 #include "src/xbt/memory_map.hpp"
34 #include "src/mc/mc_forward.hpp"
35 #include "src/mc/mc_base.h"
36 #include "src/mc/RemotePtr.hpp"
37 #include "src/mc/AddressSpace.hpp"
38 #include "src/mc/mc_protocol.h"
39 #include "src/mc/ObjectInformation.hpp"
45 class SimixProcessInformation {
47 /** MCed address of the process */
48 RemotePtr<simgrid::simix::ActorImpl> address = nullptr;
49 Remote<simgrid::simix::ActorImpl> copy;
51 /** Hostname (owned by `mc_modelchecker->hostnames`) */
52 const char* hostname = nullptr;
63 struct IgnoredRegion {
68 struct IgnoredHeapRegion {
75 /** Representation of a process
77 * This class is mixing a lot of different responsibilities and is tied
78 * to SIMIX. It should probably be split into different classes.
82 * - reading from the process memory (`AddressSpace`);
83 * - accessing the system state of the process (heap, …);
84 * - storing the SIMIX state of the process;
86 * - communication with the model-checked process;
90 class Process final : public AddressSpace {
92 // Those flags are used to track down which cached information
93 // is still up to date and which information needs to be updated.
94 static constexpr int cache_none = 0;
95 static constexpr int cache_heap = 1;
96 static constexpr int cache_malloc = 2;
97 static constexpr int cache_simix_processes = 4;
99 Process(pid_t pid, int sockfd);
103 Process(Process const&) = delete;
104 Process(Process &&) = delete;
105 Process& operator=(Process const&) = delete;
106 Process& operator=(Process &&) = delete;
109 const void* read_bytes(void* buffer, std::size_t size,
110 RemotePtr<void> address, int process_index = ProcessIndexAny,
111 ReadOptions options = ReadOptions::none()) const override;
113 void read_variable(const char* name, void* target, size_t size) const;
114 template<class T> void read_variable(const char* name, T* target) const
116 read_variable(name, target, sizeof(*target));
119 Remote<T> read_variable(const char *name) const
122 read_variable(name, res.getBuffer(), sizeof(T));
126 std::string read_string(RemotePtr<char> address) const;
127 std::string read_string(RemotePtr<char> address, std::size_t len) const
129 return AddressSpace::read_string(address, len);
133 void write_bytes(const void* buffer, size_t len, RemotePtr<void> address);
134 void clear_bytes(RemotePtr<void> address, size_t len);
136 // Debug information:
137 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info(RemotePtr<void> addr) const;
138 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_exec(RemotePtr<void> addr) const;
139 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_rw(RemotePtr<void> addr) const;
140 simgrid::mc::Frame* find_function(RemotePtr<void> ip) const;
141 simgrid::mc::Variable* find_variable(const char* name) const;
144 xbt_mheap_t get_heap()
146 if (!(this->cache_flags_ & Process::cache_heap))
147 this->refresh_heap();
148 return this->heap.get();
150 malloc_info* get_malloc_info()
152 if (!(this->cache_flags_ & Process::cache_malloc))
153 this->refresh_malloc_info();
154 return this->heap_info.data();
159 this->cache_flags_ = Process::cache_none;
162 Channel const& getChannel() const { return channel_; }
163 Channel& getChannel() { return channel_; }
165 std::vector<IgnoredRegion> const& ignored_regions() const
167 return ignored_regions_;
169 void ignore_region(std::uint64_t address, std::size_t size);
171 pid_t pid() const { return pid_; }
173 bool in_maestro_stack(RemotePtr<void> p) const
175 return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
188 bool privatized(ObjectInformation const& info) const
190 return privatized_ && info.executable();
192 bool privatized() const
196 void privatized(bool privatized) { privatized_ = privatized; }
198 void ignore_global_variable(const char* name)
200 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
202 info->remove_global_variable(name);
205 std::vector<s_stack_region_t>& stack_areas()
209 std::vector<s_stack_region_t> const& stack_areas() const
214 std::vector<IgnoredHeapRegion> const& ignored_heap() const
216 return ignored_heap_;
218 void ignore_heap(IgnoredHeapRegion const& region);
219 void unignore_heap(void *address, size_t size);
221 void ignore_local_variable(const char *var_name, const char *frame_name);
222 std::vector<simgrid::mc::SimixProcessInformation>& simix_processes();
223 std::vector<simgrid::mc::SimixProcessInformation>& old_simix_processes();
225 /** Get a local description of a remote SIMIX process */
226 simgrid::mc::SimixProcessInformation* resolveProcessInfo(
227 simgrid::mc::RemotePtr<simgrid::simix::ActorImpl> process)
229 xbt_assert(mc_model_checker != nullptr);
232 this->refresh_simix();
233 for (auto& process_info : this->smx_process_infos)
234 if (process_info.address == process)
235 return &process_info;
236 for (auto& process_info : this->smx_old_process_infos)
237 if (process_info.address == process)
238 return &process_info;
242 /** Get a local copy of the SIMIX process structure */
243 simgrid::simix::ActorImpl* resolveProcess(simgrid::mc::RemotePtr<simgrid::simix::ActorImpl> process)
245 simgrid::mc::SimixProcessInformation* process_info =
246 this->resolveProcessInfo(process);
248 return process_info->copy.getBuffer();
256 void init_memory_map_info();
258 void refresh_malloc_info();
259 void refresh_simix();
264 bool running_ = false;
265 std::vector<simgrid::xbt::VmMap> memory_map_;
266 RemotePtr<void> maestro_stack_start_, maestro_stack_end_;
267 int memory_file = -1;
268 std::vector<IgnoredRegion> ignored_regions_;
269 bool privatized_ = false;
270 std::vector<s_stack_region_t> stack_areas_;
271 std::vector<IgnoredHeapRegion> ignored_heap_;
273 public: // object info
274 // TODO, make private (first, objectify simgrid::mc::ObjectInformation*)
275 std::vector<std::shared_ptr<simgrid::mc::ObjectInformation>> object_infos;
276 std::shared_ptr<simgrid::mc::ObjectInformation> libsimgrid_info;
277 std::shared_ptr<simgrid::mc::ObjectInformation> binary_info;
279 public: // Copies of MCed SMX data structures
280 /** Copy of `simix_global->process_list`
284 std::vector<SimixProcessInformation> smx_process_infos;
286 /** Copy of `simix_global->process_to_destroy`
290 std::vector<SimixProcessInformation> smx_old_process_infos;
293 /** State of the cache (which variables are up to date) */
294 int cache_flags_ = Process::cache_none;
297 /** Address of the heap structure in the MCed process. */
300 /** Copy of the heap structure of the process
302 * This is refreshed with the `MC_process_refresh` call.
303 * This is not used if the process is the current one:
304 * use `get_heap_info()` in order to use it.
306 std::unique_ptr<s_xbt_mheap_t> heap;
308 /** Copy of the allocation info structure
310 * This is refreshed with the `MC_process_refresh` call.
311 * This is not used if the process is the current one:
312 * use `get_malloc_info()` in order to use it.
314 std::vector<malloc_info> heap_info;
316 public: // Libunwind-data
318 /** Full-featured MC-aware libunwind address space for the process
320 * This address space is using a simgrid::mc::UnwindContext*
321 * (with simgrid::mc::Process* / simgrid::mc::AddressSpace*
322 * and unw_context_t).
324 unw_addr_space_t unw_addr_space;
326 /** Underlying libunwind address-space
328 * The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr`
329 * operations of the native MC address space is currently delegated
330 * to this address space (either the local or a ptrace unwinder).
332 unw_addr_space_t unw_underlying_addr_space;
334 /** The corresponding context
336 void* unw_underlying_context;
339 /** Open a FD to a remote process memory (`/dev/$pid/mem`)
341 XBT_PRIVATE int open_vm(pid_t pid, int flags);