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