Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Mark some Process attributes as private
[simgrid.git] / src / mc / mc_process.h
index 19640aa..5879580 100644 (file)
@@ -10,6 +10,8 @@
 #include <stdbool.h>
 #include <sys/types.h>
 
+#include <vector>
+
 #include "simgrid_config.h"
 #include <sys/types.h>
 
@@ -47,29 +49,117 @@ typedef struct s_mc_smx_process_info s_mc_smx_process_info_t, *mc_smx_process_in
 namespace simgrid {
 namespace mc {
 
+struct IgnoredRegion {
+  std::uint64_t addr;
+  size_t size;
+};
+
 /** Representation of a process
  */
 class Process : public AddressSpace {
 public:
   Process(pid_t pid, int sockfd);
   ~Process();
+
+  bool is_self() const
+  {
+    return this->process_flags & MC_PROCESS_SELF_FLAG;
+  }
+
+  // Read memory:
   const void* read_bytes(void* buffer, std::size_t size,
-    std::uint64_t address, int process_index = ProcessIndexAny,
-    ReadMode mode = Normal) override;
-public: // to be private
+    remote_ptr<void> address, int process_index = ProcessIndexAny,
+    ReadMode mode = Normal) const MC_OVERRIDE;
+  void read_variable(const char* name, void* target, size_t size) const;
+  template<class T>
+  T read_variable(const char *name) const
+  {
+    static_assert(std::is_trivial<T>::value, "Cannot read a non-trivial type");
+    T res;
+    read_variable(name, &res, sizeof(T));
+    return res;
+  }
+  char* read_string(remote_ptr<void> address) const;
+
+  // Write memory:
+  void write_bytes(const void* buffer, size_t len, remote_ptr<void> address);
+  void clear_bytes(remote_ptr<void> address, size_t len);
+
+  // Debug information:
+  mc_object_info_t find_object_info(remote_ptr<void> addr) const;
+  mc_object_info_t find_object_info_exec(remote_ptr<void> addr) const;
+  mc_object_info_t find_object_info_rw(remote_ptr<void> addr) const;
+  dw_frame_t find_function(remote_ptr<void> ip) const;
+  dw_variable_t find_variable(const char* name) const;
+
+  // Heap access:
+  xbt_mheap_t get_heap()
+  {
+    if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
+      this->refresh_heap();
+    return this->heap;
+  }
+  malloc_info* get_malloc_info()
+  {
+    if (!(this->cache_flags & MC_PROCESS_CACHE_FLAG_MALLOC_INFO))
+      this->refresh_malloc_info();
+    return this->heap_info;
+  }
+
+  std::vector<IgnoredRegion> const& ignored_regions() const
+  {
+    return ignored_regions_;
+  }
+  void ignore_region(std::uint64_t address, std::size_t size);
+
+  pid_t pid() const { return pid_; }
+
+  bool in_maestro_stack(remote_ptr<void> p) const
+  {
+    return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
+  }
+
+  bool running() const
+  {
+    return running_;
+  }
+
+  void terminate(int status)
+  {
+    status_ = status;
+    running_ = false;
+  }
+
+  int status() const
+  {
+    return status_;
+  }
+
+private:
+  void init_memory_map_info();
+  void refresh_heap();
+  void refresh_malloc_info();
+private:
   mc_process_flags_t process_flags;
-  pid_t pid;
+  pid_t pid_;
+public: // to be private
   int socket;
-  int status;
-  bool running;
+private:
+  int status_;
+  bool running_;
   memory_map_t memory_map;
-  void *maestro_stack_start, *maestro_stack_end;
+  remote_ptr<void> maestro_stack_start_, maestro_stack_end_;
+  int memory_file;
+  std::vector<IgnoredRegion> ignored_regions_;
+
+public: // object info
+  // TODO, make private (first, objectify mc_object_info_t)
   mc_object_info_t libsimgrid_info;
   mc_object_info_t binary_info;
   mc_object_info_t* object_infos;
   size_t object_infos_size;
-  int memory_file;
 
+public: // Copies of MCed SMX data structures
   /** Copy of `simix_global->process_list`
    *
    *  See mc_smx.c.
@@ -92,7 +182,7 @@ public: // to be private
    *
    *  This is refreshed with the `MC_process_refresh` call.
    *  This is not used if the process is the current one:
-   *  use `MC_process_get_heap_info` in order to use it.
+   *  use `get_heap_info()` in order to use it.
    */
    xbt_mheap_t heap;
 
@@ -100,11 +190,11 @@ public: // to be private
    *
    *  This is refreshed with the `MC_process_refresh` call.
    *  This is not used if the process is the current one:
-   *  use `MC_process_get_malloc_info` in order to use it.
+   *  use `get_malloc_info()` in order to use it.
    */
   malloc_info* heap_info;
 
-  // ***** Libunwind-data
+public: // Libunwind-data
 
   /** Full-featured MC-aware libunwind address space for the process
    *
@@ -124,101 +214,16 @@ public: // to be private
   /** The corresponding context
    */
   void* unw_underlying_context;
-
-  xbt_dynar_t checkpoint_ignore;
 };
 
-}
-}
-
-SG_BEGIN_DECL()
-
-int MC_process_vm_open(pid_t pid, int flags);
-
-/** Refresh the information about the process
- *
- *  Do not use direclty, this is used by the getters when appropriate
- *  in order to have fresh data.
+/** Open a FD to a remote process memory (`/dev/$pid/mem`)
  */
-XBT_INTERNAL void MC_process_refresh_heap(mc_process_t process);
-
-/** Refresh the information about the process
- *
- *  Do not use direclty, this is used by the getters when appropriate
- *  in order to have fresh data.
- * */
-XBT_INTERNAL void MC_process_refresh_malloc_info(mc_process_t process);
-
-static inline
-bool MC_process_is_self(mc_process_t process)
-{
-  return process->process_flags & MC_PROCESS_SELF_FLAG;
-}
-
-/* Process memory access: */
-
-static inline
-const void* MC_process_read(mc_process_t process,
-  simgrid::mc::AddressSpace::ReadMode mode,
-  void* local, const void* remote, size_t len,
-  int process_index)
-{
-  return process->read_bytes(local, len, (std::uint64_t)remote, process_index, mode);
-}
-
-// Simplified versions/wrappers (whould be moved in mc_address_space):
-static inline const void* MC_process_read_simple(mc_process_t process,
-  void* local, const void* remote, size_t len)
-{
-  return process->read_bytes(local, len, (std::uint64_t)remote);
-}
-
-XBT_INTERNAL const void* MC_process_read_dynar_element(mc_process_t process,
-  void* local, const void* remote_dynar, size_t i, size_t len);
-XBT_INTERNAL unsigned long MC_process_read_dynar_length(mc_process_t process,
-  const void* remote_dynar);
-
-/** Write data to a process memory
- *
- *  @param process the process
- *  @param local   local memory address (source)
- *  @param remote  target process memory address (target)
- *  @param len     data size
- */
-XBT_INTERNAL void MC_process_write(mc_process_t process,
-  const void* local, void* remote, size_t len);
+int open_vm(pid_t pid, int flags);
 
-XBT_INTERNAL void MC_process_clear_memory(mc_process_t process,
-  void* remote, size_t len);
-
-/* Functions, variables of the process: */
-
-XBT_INTERNAL mc_object_info_t MC_process_find_object_info(mc_process_t process, const void* addr);
-XBT_INTERNAL mc_object_info_t MC_process_find_object_info_exec(mc_process_t process, const void* addr);
-XBT_INTERNAL mc_object_info_t MC_process_find_object_info_rw(mc_process_t process, const void* addr);
-
-XBT_INTERNAL dw_frame_t MC_process_find_function(mc_process_t process, const void* ip);
-
-XBT_INTERNAL void MC_process_read_variable(mc_process_t process, const char* name, void* target, size_t size);
-XBT_INTERNAL char* MC_process_read_string(mc_process_t, void* address);
-
-static inline xbt_mheap_t MC_process_get_heap(mc_process_t process)
-{
-  if (!(process->cache_flags & MC_PROCESS_CACHE_FLAG_HEAP))
-    MC_process_refresh_heap(process);
-  return process->heap;
 }
-
-static inline malloc_info* MC_process_get_malloc_info(mc_process_t process)
-{
-  if (!(process->cache_flags & MC_PROCESS_CACHE_FLAG_MALLOC_INFO))
-    MC_process_refresh_malloc_info(process);
-  return process->heap_info;
 }
 
-/** Find (one occurence of) the named variable definition
- */
-XBT_INTERNAL dw_variable_t MC_process_find_variable_by_name(mc_process_t process, const char* name);
+SG_BEGIN_DECL()
 
 XBT_INTERNAL void MC_invalidate_cache(void);