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
10 #include <type_traits>
12 #include <sys/types.h>
17 #include "simgrid_config.h"
18 #include <sys/types.h>
20 #include <xbt/mmalloc.h>
23 #include "xbt/mmalloc/mmprivate.h"
26 #include <simgrid/simix.h>
27 #include "simix/popping_private.h"
28 #include "simix/smx_private.h"
30 #include "mc_forward.hpp"
32 #include "mc_mmalloc.h" // std_heap
33 #include "mc_memory_map.h"
34 #include "AddressSpace.hpp"
35 #include "mc_protocol.h"
37 typedef int mc_process_flags_t;
38 #define MC_PROCESS_NO_FLAG 0
39 #define MC_PROCESS_SELF_FLAG 1
41 // Those flags are used to track down which cached information
42 // is still up to date and which information needs to be updated.
43 typedef int mc_process_cache_flags_t;
44 #define MC_PROCESS_CACHE_FLAG_NONE 0
45 #define MC_PROCESS_CACHE_FLAG_HEAP 1
46 #define MC_PROCESS_CACHE_FLAG_MALLOC_INFO 2
47 #define MC_PROCESS_CACHE_FLAG_SIMIX_PROCESSES 4
49 typedef struct s_mc_smx_process_info s_mc_smx_process_info_t, *mc_smx_process_info_t;
54 struct IgnoredRegion {
59 /** Representation of a process
61 class Process : public AddressSpace {
63 Process(pid_t pid, int sockfd);
69 return this->process_flags & MC_PROCESS_SELF_FLAG;
73 const void* read_bytes(void* buffer, std::size_t size,
74 remote_ptr<void> address, int process_index = ProcessIndexAny,
75 ReadMode mode = Normal) const override;
76 void read_variable(const char* name, void* target, size_t size) const;
78 T read_variable(const char *name) const
80 static_assert(std::is_trivial<T>::value, "Cannot read a non-trivial type");
82 read_variable(name, &res, sizeof(T));
85 char* read_string(remote_ptr<void> address) const;
88 void write_bytes(const void* buffer, size_t len, remote_ptr<void> address);
89 void clear_bytes(remote_ptr<void> address, size_t len);
92 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info(remote_ptr<void> addr) const;
93 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_exec(remote_ptr<void> addr) const;
94 std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_rw(remote_ptr<void> addr) const;
95 simgrid::mc::Frame* find_function(remote_ptr<void> ip) const;
96 simgrid::mc::Variable* find_variable(const char* name) const;
99 xbt_mheap_t get_heap()
101 if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
102 this->refresh_heap();
105 malloc_info* get_malloc_info()
107 if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_MALLOC_INFO))
108 this->refresh_malloc_info();
109 return this->heap_info;
112 std::vector<IgnoredRegion> const& ignored_regions() const
114 return ignored_regions_;
116 void ignore_region(std::uint64_t address, std::size_t size);
118 pid_t pid() const { return pid_; }
120 bool in_maestro_stack(remote_ptr<void> p) const
122 return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
130 void terminate(int status)
142 typename std::enable_if< std::is_class<M>::value && std::is_trivial<M>::value, int >::type
143 send_message(M const& m)
145 return MC_protocol_send(this->socket_, &m, sizeof(M));
148 int send_message(e_mc_message_type message_id)
150 return MC_protocol_send_simple_message(this->socket_, message_id);
154 typename std::enable_if< std::is_class<M>::value && std::is_trivial<M>::value, ssize_t >::type
155 receive_message(M& m)
157 return MC_receive_message(this->socket_, &m, sizeof(M), 0);
161 void init_memory_map_info();
163 void refresh_malloc_info();
165 mc_process_flags_t process_flags;
170 std::vector<VmMap> memory_map_;
171 remote_ptr<void> maestro_stack_start_, maestro_stack_end_;
173 std::vector<IgnoredRegion> ignored_regions_;
175 public: // object info
176 // TODO, make private (first, objectify simgrid::mc::ObjectInformation*)
177 std::vector<std::shared_ptr<simgrid::mc::ObjectInformation>> object_infos;
178 std::shared_ptr<simgrid::mc::ObjectInformation> libsimgrid_info;
179 std::shared_ptr<simgrid::mc::ObjectInformation> binary_info;
181 public: // Copies of MCed SMX data structures
182 /** Copy of `simix_global->process_list`
186 xbt_dynar_t smx_process_infos;
188 /** Copy of `simix_global->process_to_destroy`
192 xbt_dynar_t smx_old_process_infos;
194 /** State of the cache (which variables are up to date) */
195 mc_process_cache_flags_t cache_flags;
197 /** Address of the heap structure in the MCed process. */
200 /** Copy of the heap structure of the process
202 * This is refreshed with the `MC_process_refresh` call.
203 * This is not used if the process is the current one:
204 * use `get_heap_info()` in order to use it.
208 /** Copy of the allocation info structure
210 * This is refreshed with the `MC_process_refresh` call.
211 * This is not used if the process is the current one:
212 * use `get_malloc_info()` in order to use it.
214 malloc_info* heap_info;
216 public: // Libunwind-data
218 /** Full-featured MC-aware libunwind address space for the process
220 * This address space is using a mc_unw_context_t
221 * (with simgrid::mc::Process* / simgrid::mc::AddressSpace*
222 * and unw_context_t).
224 unw_addr_space_t unw_addr_space;
226 /** Underlying libunwind addres-space
228 * The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr`
229 * operations of the native MC address space is currently delegated
230 * to this address space (either the local or a ptrace unwinder).
232 unw_addr_space_t unw_underlying_addr_space;
234 /** The corresponding context
236 void* unw_underlying_context;
239 /** Open a FD to a remote process memory (`/dev/$pid/mem`)
241 int open_vm(pid_t pid, int flags);
248 XBT_INTERNAL void MC_invalidate_cache(void);