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<s_smx_process_t> address = nullptr;
50 /** (Flat) Copy of the process data structure */
51 struct s_smx_process copy;
53 /** Hostname (owned by `mc_modelchecker->hostnames`) */
54 const char* hostname = nullptr;
65 struct IgnoredRegion {
70 struct IgnoredHeapRegion {
77 /** Representation of a process
79 * This class is mixing a lot of different responsabilities and is tied
80 * to SIMIX. It should probably be split into different classes.
84 * - reading from the process memory (`AddressSpace`);
85 * - accessing the system state of the porcess (heap, …);
86 * - storing the SIMIX state of the process;
88 * - communication with the model-checked process;
92 class Process final : public AddressSpace {
94 // Those flags are used to track down which cached information
95 // is still up to date and which information needs to be updated.
96 static constexpr int cache_none = 0;
97 static constexpr int cache_heap = 1;
98 static constexpr int cache_malloc = 2;
99 static constexpr int cache_simix_processes = 4;
101 Process(pid_t pid, int sockfd);
105 Process(Process const&) = delete;
106 Process(Process &&) = delete;
107 Process& operator=(Process const&) = delete;
108 Process& operator=(Process &&) = delete;
111 const void* read_bytes(void* buffer, std::size_t size,
112 RemotePtr<void> address, int process_index = ProcessIndexAny,
113 ReadOptions options = ReadOptions::none()) const override;
114 void read_variable(const char* name, void* target, size_t size) const;
116 T read_variable(const char *name) const
118 static_assert(std::is_trivial<T>::value, "Cannot read a non-trivial type");
120 read_variable(name, &res, sizeof(T));
123 std::string read_string(RemotePtr<void> address) const;
126 void write_bytes(const void* buffer, size_t len, RemotePtr<void> address);
127 void clear_bytes(RemotePtr<void> address, size_t len);
129 // Debug information:
130 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info(RemotePtr<void> addr) const;
131 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_exec(RemotePtr<void> addr) const;
132 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_rw(RemotePtr<void> addr) const;
133 simgrid::mc::Frame* find_function(RemotePtr<void> ip) const;
134 simgrid::mc::Variable* find_variable(const char* name) const;
137 xbt_mheap_t get_heap()
139 if (!(this->cache_flags_ & Process::cache_heap))
140 this->refresh_heap();
141 return this->heap.get();
143 malloc_info* get_malloc_info()
145 if (!(this->cache_flags_ & Process::cache_malloc))
146 this->refresh_malloc_info();
147 return this->heap_info.data();
152 this->cache_flags_ = Process::cache_none;
155 Channel const& getChannel() const { return channel_; }
156 Channel& getChannel() { return channel_; }
158 std::vector<IgnoredRegion> const& ignored_regions() const
160 return ignored_regions_;
162 void ignore_region(std::uint64_t address, std::size_t size);
164 pid_t pid() const { return pid_; }
166 bool in_maestro_stack(RemotePtr<void> p) const
168 return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
181 bool privatized(ObjectInformation const& info) const
183 return privatized_ && info.executable();
185 bool privatized() const
189 void privatized(bool privatized) { privatized_ = privatized; }
191 void ignore_global_variable(const char* name)
193 for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
195 info->remove_global_variable(name);
198 std::vector<s_stack_region_t>& stack_areas()
202 std::vector<s_stack_region_t> const& stack_areas() const
207 std::vector<IgnoredHeapRegion> const& ignored_heap() const
209 return ignored_heap_;
211 void ignore_heap(IgnoredHeapRegion const& region);
212 void unignore_heap(void *address, size_t size);
214 void ignore_local_variable(const char *var_name, const char *frame_name);
215 std::vector<simgrid::mc::SimixProcessInformation>& simix_processes();
216 std::vector<simgrid::mc::SimixProcessInformation>& old_simix_processes();
218 /** Get a local description of a remote SIMIX process */
219 simgrid::mc::SimixProcessInformation* resolveProcessInfo(
220 simgrid::mc::RemotePtr<s_smx_process_t> process)
222 xbt_assert(mc_model_checker != nullptr);
225 this->refresh_simix();
226 for (auto& process_info : this->smx_process_infos)
227 if (process_info.address == process)
228 return &process_info;
229 for (auto& process_info : this->smx_old_process_infos)
230 if (process_info.address == process)
231 return &process_info;
235 /** Get a local copy of the SIMIX process structure */
236 smx_process_t resolveProcess(simgrid::mc::RemotePtr<s_smx_process_t> process)
238 simgrid::mc::SimixProcessInformation* process_info =
239 this->resolveProcessInfo(process);
241 return &process_info->copy;
249 void init_memory_map_info();
251 void refresh_malloc_info();
252 void refresh_simix();
257 bool running_ = false;
258 std::vector<simgrid::xbt::VmMap> memory_map_;
259 RemotePtr<void> maestro_stack_start_, maestro_stack_end_;
260 int memory_file = -1;
261 std::vector<IgnoredRegion> ignored_regions_;
262 bool privatized_ = false;
263 std::vector<s_stack_region_t> stack_areas_;
264 std::vector<IgnoredHeapRegion> ignored_heap_;
266 public: // object info
267 // TODO, make private (first, objectify simgrid::mc::ObjectInformation*)
268 std::vector<std::shared_ptr<simgrid::mc::ObjectInformation>> object_infos;
269 std::shared_ptr<simgrid::mc::ObjectInformation> libsimgrid_info;
270 std::shared_ptr<simgrid::mc::ObjectInformation> binary_info;
272 public: // Copies of MCed SMX data structures
273 /** Copy of `simix_global->process_list`
277 std::vector<SimixProcessInformation> smx_process_infos;
279 /** Copy of `simix_global->process_to_destroy`
283 std::vector<SimixProcessInformation> smx_old_process_infos;
286 /** State of the cache (which variables are up to date) */
287 int cache_flags_ = Process::cache_none;
290 /** Address of the heap structure in the MCed process. */
293 /** Copy of the heap structure of the process
295 * This is refreshed with the `MC_process_refresh` call.
296 * This is not used if the process is the current one:
297 * use `get_heap_info()` in order to use it.
299 std::unique_ptr<s_xbt_mheap_t> heap;
301 /** Copy of the allocation info structure
303 * This is refreshed with the `MC_process_refresh` call.
304 * This is not used if the process is the current one:
305 * use `get_malloc_info()` in order to use it.
307 std::vector<malloc_info> heap_info;
309 public: // Libunwind-data
311 /** Full-featured MC-aware libunwind address space for the process
313 * This address space is using a simgrid::mc::UnwindContext*
314 * (with simgrid::mc::Process* / simgrid::mc::AddressSpace*
315 * and unw_context_t).
317 unw_addr_space_t unw_addr_space;
319 /** Underlying libunwind addres-space
321 * The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr`
322 * operations of the native MC address space is currently delegated
323 * to this address space (either the local or a ptrace unwinder).
325 unw_addr_space_t unw_underlying_addr_space;
327 /** The corresponding context
329 void* unw_underlying_context;
332 /** Open a FD to a remote process memory (`/dev/$pid/mem`)
334 XBT_PRIVATE int open_vm(pid_t pid, int flags);