src/mc/sosp/RemoteProcessMemory.hpp

   1 /* mc::RemoteClient: representative of the Client memory on the MC side */
   2
   3 /* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef SIMGRID_MC_PROCESS_H
   9 #define SIMGRID_MC_PROCESS_H
  10
  11 #include "src/mc/AddressSpace.hpp"
  12 #include "src/mc/datatypes.h"
  13 #include "src/mc/inspect/ObjectInformation.hpp"
  14 #include "src/mc/remote/RemotePtr.hpp"
  15 #include "src/xbt/memory_map.hpp"
  16 #include "src/xbt/mmalloc/mmprivate.h"
  17
  18 #include <libunwind.h>
  19 #include <vector>
  20
  21 namespace simgrid::mc {
  22
  23 class ActorInformation {
  24 public:
  25   /** MCed address of the process */
  26   RemotePtr<kernel::actor::ActorImpl> address{nullptr};
  27   Remote<kernel::actor::ActorImpl> copy;
  28
  29   /** Hostname (owned by `mc_model_checker->hostnames_`) */
  30   const std::string* hostname = nullptr;
  31   std::string name;
  32
  33   void clear()
  34   {
  35     name.clear();
  36     address  = nullptr;
  37     hostname = nullptr;
  38   }
  39 };
  40
  41 struct IgnoredRegion {
  42   std::uint64_t addr;
  43   std::size_t size;
  44 };
  45
  46 struct IgnoredHeapRegion {
  47   int block;
  48   int fragment;
  49   void* address;
  50   std::size_t size;
  51 };
  52
  53 /** The Application's process memory, seen from the Checker perspective
  54  *
  55  *  Responsibilities:
  56  *
  57  *  - reading from the process memory (`AddressSpace`);
  58  *  - accessing the system state of the process (heap, …);
  59  *  - privatization;
  60  *  - stack unwinding;
  61  *  - etc.
  62  */
  63 class RemoteProcessMemory final : public AddressSpace {
  64 private:
  65   // Those flags are used to track down which cached information
  66   // is still up to date and which information needs to be updated.
  67   static constexpr int cache_none   = 0;
  68   static constexpr int cache_heap   = 1;
  69   static constexpr int cache_malloc = 2;
  70
  71 public:
  72   explicit RemoteProcessMemory(pid_t pid);
  73   ~RemoteProcessMemory() override;
  74   void init(xbt_mheap_t mmalloc_default_mdp);
  75
  76   RemoteProcessMemory(RemoteProcessMemory const&)            = delete;
  77   RemoteProcessMemory(RemoteProcessMemory&&)                 = delete;
  78   RemoteProcessMemory& operator=(RemoteProcessMemory const&) = delete;
  79   RemoteProcessMemory& operator=(RemoteProcessMemory&&)      = delete;
  80
  81   /* ************* */
  82   /* Low-level API */
  83   /* ************* */
  84
  85   // Read memory:
  86   void* read_bytes(void* buffer, std::size_t size, RemotePtr<void> address,
  87                    ReadOptions options = ReadOptions::none()) const override;
  88
  89   void read_variable(const char* name, void* target, size_t size) const;
  90   template <class T> void read_variable(const char* name, T* target) const
  91   {
  92     read_variable(name, target, sizeof(*target));
  93   }
  94   template <class T> Remote<T> read_variable(const char* name) const
  95   {
  96     Remote<T> res;
  97     read_variable(name, res.get_buffer(), sizeof(T));
  98     return res;
  99   }
 100
 101   std::string read_string(RemotePtr<char> address) const;
 102   using AddressSpace::read_string;
 103
 104   // Write memory:
 105   void write_bytes(const void* buffer, size_t len, RemotePtr<void> address) const;
 106   void clear_bytes(RemotePtr<void> address, size_t len) const;
 107
 108   // Debug information:
 109   std::shared_ptr<ObjectInformation> find_object_info(RemotePtr<void> addr) const;
 110   std::shared_ptr<ObjectInformation> find_object_info_exec(RemotePtr<void> addr) const;
 111   std::shared_ptr<ObjectInformation> find_object_info_rw(RemotePtr<void> addr) const;
 112   Frame* find_function(RemotePtr<void> ip) const;
 113   const Variable* find_variable(const char* name) const;
 114
 115   // Heap access:
 116   xbt_mheap_t get_heap()
 117   {
 118     if (not(this->cache_flags_ & RemoteProcessMemory::cache_heap))
 119       this->refresh_heap();
 120     return this->heap.get();
 121   }
 122   const malloc_info* get_malloc_info()
 123   {
 124     if (not(this->cache_flags_ & RemoteProcessMemory::cache_malloc))
 125       this->refresh_malloc_info();
 126     return this->heap_info.data();
 127   }
 128   /* Get the amount of memory mallocated in the remote process (requires mmalloc) */
 129   std::size_t get_remote_heap_bytes();
 130
 131   void clear_cache() { this->cache_flags_ = RemoteProcessMemory::cache_none; }
 132
 133   std::vector<IgnoredRegion> const& ignored_regions() const { return ignored_regions_; }
 134   void ignore_region(std::uint64_t address, std::size_t size);
 135
 136   pid_t pid() const { return pid_; }
 137
 138   bool in_maestro_stack(RemotePtr<void> p) const
 139   {
 140     return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
 141   }
 142
 143   bool running() const { return running_; }
 144
 145   void terminate() { running_ = false; }
 146
 147   void ignore_global_variable(const char* name) const
 148   {
 149     for (std::shared_ptr<ObjectInformation> const& info : this->object_infos)
 150       info->remove_global_variable(name);
 151   }
 152
 153   std::vector<s_stack_region_t>& stack_areas() { return stack_areas_; }
 154   std::vector<s_stack_region_t> const& stack_areas() const { return stack_areas_; }
 155
 156   std::vector<IgnoredHeapRegion> const& ignored_heap() const { return ignored_heap_; }
 157   void ignore_heap(IgnoredHeapRegion const& region);
 158   void unignore_heap(void* address, size_t size);
 159
 160   void ignore_local_variable(const char* var_name, const char* frame_name) const;
 161
 162   void dump_stack() const;
 163
 164 private:
 165   void init_memory_map_info();
 166   void refresh_heap();
 167   void refresh_malloc_info();
 168
 169   pid_t pid_    = -1;
 170   bool running_ = false;
 171   std::vector<xbt::VmMap> memory_map_;
 172   RemotePtr<void> maestro_stack_start_;
 173   RemotePtr<void> maestro_stack_end_;
 174   int memory_file = -1;
 175   std::vector<IgnoredRegion> ignored_regions_;
 176   std::vector<s_stack_region_t> stack_areas_;
 177   std::vector<IgnoredHeapRegion> ignored_heap_;
 178
 179   /** State of the cache (which variables are up to date) */
 180   int cache_flags_ = RemoteProcessMemory::cache_none;
 181
 182 public:
 183   // object info
 184   // TODO, make private (first, objectify simgrid::mc::ObjectInformation*)
 185   std::vector<std::shared_ptr<ObjectInformation>> object_infos;
 186   std::shared_ptr<ObjectInformation> binary_info;
 187
 188   /** Address of the heap structure in the MCed process. */
 189   RemotePtr<s_xbt_mheap_t> heap_address;
 190
 191   /** Copy of the heap structure of the process
 192    *
 193    *  This is refreshed with the `MC_process_refresh` call.
 194    *  This is not used if the process is the current one:
 195    *  use `get_heap_info()` in order to use it.
 196    */
 197   std::unique_ptr<s_xbt_mheap_t> heap = std::make_unique<s_xbt_mheap_t>();
 198
 199   /** Copy of the allocation info structure
 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_malloc_info()` in order to use it.
 204    */
 205   std::vector<malloc_info> heap_info;
 206
 207   // Libunwind-data
 208   /** Full-featured MC-aware libunwind address space for the process
 209    *
 210    *  This address space is using a simgrid::mc::UnwindContext*
 211    *  (with simgrid::mc::Process* / simgrid::mc::AddressSpace*
 212    *  and unw_context_t).
 213    */
 214   unw_addr_space_t unw_addr_space = nullptr;
 215
 216   /** Underlying libunwind address-space
 217    *
 218    *  The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr`
 219    *  operations of the native MC address space is currently delegated
 220    *  to this address space (either the local or a ptrace unwinder).
 221    */
 222   unw_addr_space_t unw_underlying_addr_space = nullptr;
 223
 224   /** The corresponding context
 225    */
 226   void* unw_underlying_context = nullptr;
 227 };
 228
 229 /** Open a FD to a remote process memory (`/dev/$pid/mem`) */
 230 XBT_PRIVATE int open_vm(pid_t pid, int flags);
 231 } // namespace simgrid::mc
 232
 233 #endif