Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] C++ style SimixProcessInformation
[simgrid.git] / src / mc / Process.hpp
1 /* Copyright (c) 2008-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef SIMGRID_MC_PROCESS_H
8 #define SIMGRID_MC_PROCESS_H
9
10 #include <cstdint>
11 #include <cstddef>
12
13 #include <type_traits>
14 #include <vector>
15 #include <memory>
16
17 #include <boost/range/iterator_range.hpp>
18
19 #include <sys/types.h>
20
21 #include <simgrid_config.h>
22
23 #include <xbt/base.h>
24 #include <xbt/dynar.h>
25 #include <xbt/dynar.hpp>
26 #include <xbt/mmalloc.h>
27
28 #ifdef HAVE_MC
29 #include "src/xbt/mmalloc/mmprivate.h"
30 #endif
31
32 #include <simgrid/simix.h>
33 #include "src/simix/popping_private.h"
34 #include "src/simix/smx_private.h"
35
36 #include "src/xbt/memory_map.hpp"
37
38 #include "src/mc/mc_forward.hpp"
39 #include "src/mc/mc_base.h"
40 #include "src/mc/AddressSpace.hpp"
41 #include "src/mc/mc_protocol.h"
42 #include "src/mc/ObjectInformation.hpp"
43
44 // Those flags are used to track down which cached information
45 // is still up to date and which information needs to be updated.
46 typedef int mc_process_cache_flags_t;
47 #define MC_PROCESS_CACHE_FLAG_NONE 0
48 #define MC_PROCESS_CACHE_FLAG_HEAP 1
49 #define MC_PROCESS_CACHE_FLAG_MALLOC_INFO 2
50 #define MC_PROCESS_CACHE_FLAG_SIMIX_PROCESSES 4
51
52 namespace simgrid {
53 namespace mc {
54
55 class SimixProcessInformation {
56 public:
57   /** MCed address of the process */
58   void* address = nullptr;
59   union {
60     /** (Flat) Copy of the process data structure */
61     struct s_smx_process copy;
62   };
63   /** Hostname (owned by `mc_modelchecker->hostnames`) */
64   const char* hostname = nullptr;
65   char* name = nullptr;
66 };
67
68 struct IgnoredRegion {
69   std::uint64_t addr;
70   std::size_t size;
71 };
72
73 struct IgnoredHeapRegion {
74   int block;
75   int fragment;
76   void *address;
77   std::size_t size;
78 };
79
80 /** Representation of a process
81  */
82 class Process final : public AddressSpace {
83 public:
84   Process(pid_t pid, int sockfd);
85   ~Process();
86   void init();
87
88   Process(Process const&) = delete;
89   Process(Process &&) = delete;
90   Process& operator=(Process const&) = delete;
91   Process& operator=(Process &&) = delete;
92
93   // Read memory:
94   const void* read_bytes(void* buffer, std::size_t size,
95     RemotePtr<void> address, int process_index = ProcessIndexAny,
96     ReadOptions options = ReadOptions::none()) const override;
97   void read_variable(const char* name, void* target, size_t size) const;
98   template<class T>
99   T read_variable(const char *name) const
100   {
101     static_assert(std::is_trivial<T>::value, "Cannot read a non-trivial type");
102     T res;
103     read_variable(name, &res, sizeof(T));
104     return res;
105   }
106   char* read_string(RemotePtr<void> address) const;
107
108   // Write memory:
109   void write_bytes(const void* buffer, size_t len, RemotePtr<void> address);
110   void clear_bytes(RemotePtr<void> address, size_t len);
111
112   // Debug information:
113   std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info(RemotePtr<void> addr) const;
114   std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_exec(RemotePtr<void> addr) const;
115   std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_rw(RemotePtr<void> addr) const;
116   simgrid::mc::Frame* find_function(RemotePtr<void> ip) const;
117   simgrid::mc::Variable* find_variable(const char* name) const;
118
119   // Heap access:
120   xbt_mheap_t get_heap()
121   {
122     if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
123       this->refresh_heap();
124     return this->heap.get();
125   }
126   malloc_info* get_malloc_info()
127   {
128     if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_MALLOC_INFO))
129       this->refresh_malloc_info();
130     return this->heap_info.data();
131   }
132
133   std::vector<IgnoredRegion> const& ignored_regions() const
134   {
135     return ignored_regions_;
136   }
137   void ignore_region(std::uint64_t address, std::size_t size);
138
139   pid_t pid() const { return pid_; }
140
141   bool in_maestro_stack(RemotePtr<void> p) const
142   {
143     return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
144   }
145
146   bool running() const
147   {
148     return running_;
149   }
150
151   void terminate()
152   {
153     running_ = false;
154   }
155
156   template<class M>
157   typename std::enable_if< std::is_class<M>::value && std::is_trivial<M>::value, int >::type
158   send_message(M const& m)
159   {
160     return MC_protocol_send(this->socket_, &m, sizeof(M));
161   }
162
163   int send_message(e_mc_message_type message_id)
164   {
165     return MC_protocol_send_simple_message(this->socket_, message_id);
166   }
167
168   template<class M>
169   typename std::enable_if< std::is_class<M>::value && std::is_trivial<M>::value, ssize_t >::type
170   receive_message(M& m)
171   {
172     return MC_receive_message(this->socket_, &m, sizeof(M), 0);
173   }
174
175   void reset_soft_dirty();
176   void read_pagemap(uint64_t* pagemap, size_t start_page, size_t page_count);
177
178   bool privatized(ObjectInformation const& info) const
179   {
180     return privatized_ && info.executable();
181   }
182   bool privatized() const
183   {
184     return privatized_;
185   }
186   void privatized(bool privatized) { privatized_ = privatized; }
187
188   void ignore_global_variable(const char* name)
189   {
190     for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
191         this->object_infos)
192       info->remove_global_variable(name);
193   }
194
195   std::vector<s_stack_region_t>& stack_areas()
196   {
197     return stack_areas_;
198   }
199   std::vector<s_stack_region_t> const& stack_areas() const
200   {
201     return stack_areas_;
202   }
203
204   std::vector<IgnoredHeapRegion> const& ignored_heap() const
205   {
206     return ignored_heap_;
207   }
208   void ignore_heap(IgnoredHeapRegion const& region);
209   void unignore_heap(void *address, size_t size);
210
211   void ignore_local_variable(const char *var_name, const char *frame_name);
212   int socket() { return socket_; }
213   simgrid::xbt::DynarRange<s_mc_smx_process_info> simix_processes();
214
215 private:
216   void init_memory_map_info();
217   void refresh_heap();
218   void refresh_malloc_info();
219
220 private:
221   pid_t pid_ = -1;
222   int socket_ = -1;
223   bool running_ = false;
224   std::vector<simgrid::xbt::VmMap> memory_map_;
225   RemotePtr<void> maestro_stack_start_, maestro_stack_end_;
226   int memory_file = -1;
227   std::vector<IgnoredRegion> ignored_regions_;
228   int clear_refs_fd_ = -1;
229   int pagemap_fd_ = -1;
230   bool privatized_ = false;
231   std::vector<s_stack_region_t> stack_areas_;
232   std::vector<IgnoredHeapRegion> ignored_heap_;
233
234 public: // object info
235   // TODO, make private (first, objectify simgrid::mc::ObjectInformation*)
236   std::vector<std::shared_ptr<simgrid::mc::ObjectInformation>> object_infos;
237   std::shared_ptr<simgrid::mc::ObjectInformation> libsimgrid_info;
238   std::shared_ptr<simgrid::mc::ObjectInformation> binary_info;
239
240 public: // Copies of MCed SMX data structures
241   /** Copy of `simix_global->process_list`
242    *
243    *  See mc_smx.c.
244    */
245   xbt_dynar_t smx_process_infos = nullptr;
246
247   /** Copy of `simix_global->process_to_destroy`
248    *
249    *  See mc_smx.c.
250    */
251   xbt_dynar_t smx_old_process_infos = nullptr;
252
253   /** State of the cache (which variables are up to date) */
254   mc_process_cache_flags_t cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
255
256   /** Address of the heap structure in the MCed process. */
257   void* heap_address;
258
259   /** Copy of the heap structure of the process
260    *
261    *  This is refreshed with the `MC_process_refresh` call.
262    *  This is not used if the process is the current one:
263    *  use `get_heap_info()` in order to use it.
264    */
265    std::unique_ptr<s_xbt_mheap_t> heap;
266
267   /** Copy of the allocation info structure
268    *
269    *  This is refreshed with the `MC_process_refresh` call.
270    *  This is not used if the process is the current one:
271    *  use `get_malloc_info()` in order to use it.
272    */
273   std::vector<malloc_info> heap_info;
274
275 public: // Libunwind-data
276
277   /** Full-featured MC-aware libunwind address space for the process
278    *
279    *  This address space is using a mc_unw_context_t
280    *  (with simgrid::mc::Process* / simgrid::mc::AddressSpace*
281    *  and unw_context_t).
282    */
283   unw_addr_space_t unw_addr_space;
284
285   /** Underlying libunwind addres-space
286    *
287    *  The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr`
288    *  operations of the native MC address space is currently delegated
289    *  to this address space (either the local or a ptrace unwinder).
290    */
291   unw_addr_space_t unw_underlying_addr_space;
292
293   /** The corresponding context
294    */
295   void* unw_underlying_context;
296 };
297
298 /** Open a FD to a remote process memory (`/dev/$pid/mem`)
299  */
300 XBT_PRIVATE int open_vm(pid_t pid, int flags);
301
302 }
303 }
304
305 #endif