src/mc/mc_process.h

   1 /* Copyright (c) 2008-2014. 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 MC_PROCESS_H
   8 #define MC_PROCESS_H
   9
  10 #include <type_traits>
  11
  12 #include <sys/types.h>
  13
  14 #include <vector>
  15 #include <memory>
  16
  17 #include "simgrid_config.h"
  18 #include <sys/types.h>
  19
  20 #include <xbt/mmalloc.h>
  21
  22 #ifdef HAVE_MC
  23 #include "xbt/mmalloc/mmprivate.h"
  24 #endif
  25
  26 #include <simgrid/simix.h>
  27 #include "simix/popping_private.h"
  28 #include "simix/smx_private.h"
  29
  30 #include "mc_forward.h"
  31 #include "mc_base.h"
  32 #include "mc_mmalloc.h" // std_heap
  33 #include "mc_memory_map.h"
  34 #include "AddressSpace.hpp"
  35 #include "mc_protocol.h"
  36
  37 typedef int mc_process_flags_t;
  38 #define MC_PROCESS_NO_FLAG 0
  39 #define MC_PROCESS_SELF_FLAG 1
  40
  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
  48
  49 typedef struct s_mc_smx_process_info s_mc_smx_process_info_t, *mc_smx_process_info_t;
  50
  51 namespace simgrid {
  52 namespace mc {
  53
  54 struct IgnoredRegion {
  55   std::uint64_t addr;
  56   size_t size;
  57 };
  58
  59 /** Representation of a process
  60  */
  61 class Process : public AddressSpace {
  62 public:
  63   Process(pid_t pid, int sockfd);
  64   ~Process();
  65
  66   bool is_self() const
  67   {
  68     return this->process_flags & MC_PROCESS_SELF_FLAG;
  69   }
  70
  71   // Read memory:
  72   const void* read_bytes(void* buffer, std::size_t size,
  73     remote_ptr<void> address, int process_index = ProcessIndexAny,
  74     ReadMode mode = Normal) const MC_OVERRIDE;
  75   void read_variable(const char* name, void* target, size_t size) const;
  76   template<class T>
  77   T read_variable(const char *name) const
  78   {
  79     static_assert(std::is_trivial<T>::value, "Cannot read a non-trivial type");
  80     T res;
  81     read_variable(name, &res, sizeof(T));
  82     return res;
  83   }
  84   char* read_string(remote_ptr<void> address) const;
  85
  86   // Write memory:
  87   void write_bytes(const void* buffer, size_t len, remote_ptr<void> address);
  88   void clear_bytes(remote_ptr<void> address, size_t len);
  89
  90   // Debug information:
  91   std::shared_ptr<s_mc_object_info_t> find_object_info(remote_ptr<void> addr) const;
  92   std::shared_ptr<s_mc_object_info_t> find_object_info_exec(remote_ptr<void> addr) const;
  93   std::shared_ptr<s_mc_object_info_t> find_object_info_rw(remote_ptr<void> addr) const;
  94   dw_frame_t find_function(remote_ptr<void> ip) const;
  95   dw_variable_t find_variable(const char* name) const;
  96
  97   // Heap access:
  98   xbt_mheap_t get_heap()
  99   {
 100     if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
 101       this->refresh_heap();
 102     return this->heap;
 103   }
 104   malloc_info* get_malloc_info()
 105   {
 106     if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_MALLOC_INFO))
 107       this->refresh_malloc_info();
 108     return this->heap_info;
 109   }
 110
 111   std::vector<IgnoredRegion> const& ignored_regions() const
 112   {
 113     return ignored_regions_;
 114   }
 115   void ignore_region(std::uint64_t address, std::size_t size);
 116
 117   pid_t pid() const { return pid_; }
 118
 119   bool in_maestro_stack(remote_ptr<void> p) const
 120   {
 121     return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
 122   }
 123
 124   bool running() const
 125   {
 126     return running_;
 127   }
 128
 129   void terminate(int status)
 130   {
 131     status_ = status;
 132     running_ = false;
 133   }
 134
 135   int status() const
 136   {
 137     return status_;
 138   }
 139
 140   template<class M>
 141   typename std::enable_if< std::is_class<M>::value && std::is_trivial<M>::value, int >::type
 142   send_message(M const& m)
 143   {
 144     return MC_protocol_send(this->socket_, &m, sizeof(M));
 145   }
 146
 147   int send_message(e_mc_message_type message_id)
 148   {
 149     return MC_protocol_send_simple_message(this->socket_, message_id);
 150   }
 151
 152   template<class M>
 153   typename std::enable_if< std::is_class<M>::value && std::is_trivial<M>::value, ssize_t >::type
 154   receive_message(M& m)
 155   {
 156     return MC_receive_message(this->socket_, &m, sizeof(M), 0);
 157   }
 158
 159 private:
 160   void init_memory_map_info();
 161   void refresh_heap();
 162   void refresh_malloc_info();
 163 private:
 164   mc_process_flags_t process_flags;
 165   pid_t pid_;
 166   int socket_;
 167   int status_;
 168   bool running_;
 169   std::vector<VmMap> memory_map_;
 170   remote_ptr<void> maestro_stack_start_, maestro_stack_end_;
 171   int memory_file;
 172   std::vector<IgnoredRegion> ignored_regions_;
 173
 174 public: // object info
 175   // TODO, make private (first, objectify mc_object_info_t)
 176   std::vector<std::shared_ptr<s_mc_object_info_t>> object_infos;
 177   std::shared_ptr<s_mc_object_info_t> libsimgrid_info;
 178   std::shared_ptr<s_mc_object_info_t> binary_info;
 179
 180 public: // Copies of MCed SMX data structures
 181   /** Copy of `simix_global->process_list`
 182    *
 183    *  See mc_smx.c.
 184    */
 185   xbt_dynar_t smx_process_infos;
 186
 187   /** Copy of `simix_global->process_to_destroy`
 188    *
 189    *  See mc_smx.c.
 190    */
 191   xbt_dynar_t smx_old_process_infos;
 192
 193   /** State of the cache (which variables are up to date) */
 194   mc_process_cache_flags_t cache_flags;
 195
 196   /** Address of the heap structure in the MCed process. */
 197   void* heap_address;
 198
 199   /** Copy of the heap structure of the process
 200    *
 201    *  This is refreshed with the `MC_process_refresh` call.
 202    *  This is not used if the process is the current one:
 203    *  use `get_heap_info()` in order to use it.
 204    */
 205    xbt_mheap_t heap;
 206
 207   /** Copy of the allocation info structure
 208    *
 209    *  This is refreshed with the `MC_process_refresh` call.
 210    *  This is not used if the process is the current one:
 211    *  use `get_malloc_info()` in order to use it.
 212    */
 213   malloc_info* heap_info;
 214
 215 public: // Libunwind-data
 216
 217   /** Full-featured MC-aware libunwind address space for the process
 218    *
 219    *  This address space is using a mc_unw_context_t
 220    *  (with mc_process_t/mc_address_space_t and unw_context_t).
 221    */
 222   unw_addr_space_t unw_addr_space;
 223
 224   /** Underlying libunwind addres-space
 225    *
 226    *  The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr`
 227    *  operations of the native MC address space is currently delegated
 228    *  to this address space (either the local or a ptrace unwinder).
 229    */
 230   unw_addr_space_t unw_underlying_addr_space;
 231
 232   /** The corresponding context
 233    */
 234   void* unw_underlying_context;
 235 };
 236
 237 /** Open a FD to a remote process memory (`/dev/$pid/mem`)
 238  */
 239 int open_vm(pid_t pid, int flags);
 240
 241 }
 242 }
 243
 244 SG_BEGIN_DECL()
 245
 246 XBT_INTERNAL void MC_invalidate_cache(void);
 247
 248 SG_END_DECL()
 249
 250 #endif