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 c8cd39e..5879580 100644 (file)
 #define MC_PROCESS_H
 
 #include <stdbool.h>
+#include <sys/types.h>
 
-#include "simgrid_config.h"
+#include <vector>
 
+#include "simgrid_config.h"
 #include <sys/types.h>
 
+#include <xbt/mmalloc.h>
+
+#ifdef HAVE_MC
+#include "xbt/mmalloc/mmprivate.h"
+#endif
+
+#include <simgrid/simix.h>
+#include "simix/popping_private.h"
+#include "simix/smx_private.h"
+
 #include "mc_forward.h"
+#include "mc_base.h"
+#include "mc_mmalloc.h" // std_heap
 #include "mc_memory_map.h"
+#include "AddressSpace.hpp"
+#include "mc_protocol.h"
 
-SG_BEGIN_DECL()
+typedef int mc_process_flags_t;
+#define MC_PROCESS_NO_FLAG 0
+#define MC_PROCESS_SELF_FLAG 1
+
+// Those flags are used to track down which cached information
+// is still up to date and which information needs to be updated.
+typedef int mc_process_cache_flags_t;
+#define MC_PROCESS_CACHE_FLAG_NONE 0
+#define MC_PROCESS_CACHE_FLAG_HEAP 1
+#define MC_PROCESS_CACHE_FLAG_MALLOC_INFO 2
+#define MC_PROCESS_CACHE_FLAG_SIMIX_PROCESSES 4
 
-typedef enum {
-  MC_PROCESS_NO_FLAG = 0,
-  MC_PROCESS_SELF_FLAG = 1,
-} e_mc_process_flags_t;
+typedef struct s_mc_smx_process_info s_mc_smx_process_info_t, *mc_smx_process_info_t;
+
+namespace simgrid {
+namespace mc {
+
+struct IgnoredRegion {
+  std::uint64_t addr;
+  size_t size;
+};
 
 /** Representation of a process
  */
-struct s_mc_process {
-  e_mc_process_flags_t process_flags;
-  pid_t pid;
+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,
+    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_;
+public: // to be private
+  int socket;
+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.
+   */
+  xbt_dynar_t smx_process_infos;
+
+  /** Copy of `simix_global->process_to_destroy`
+   *
+   *  See mc_smx.c.
+   */
+  xbt_dynar_t smx_old_process_infos;
+
+  /** State of the cache (which variables are up to date) */
+  mc_process_cache_flags_t cache_flags;
+
+  /** Address of the heap structure in the MCed process. */
+  void* heap_address;
+
+  /** Copy of the heap structure of the process
+   *
+   *  This is refreshed with the `MC_process_refresh` call.
+   *  This is not used if the process is the current one:
+   *  use `get_heap_info()` in order to use it.
+   */
+   xbt_mheap_t heap;
+
+  /** Copy of the allocation info structure
+   *
+   *  This is refreshed with the `MC_process_refresh` call.
+   *  This is not used if the process is the current one:
+   *  use `get_malloc_info()` in order to use it.
+   */
+  malloc_info* heap_info;
+
+public: // Libunwind-data
+
+  /** Full-featured MC-aware libunwind address space for the process
+   *
+   *  This address space is using a mc_unw_context_t
+   *  (with mc_process_t/mc_address_space_t and unw_context_t).
+   */
+  unw_addr_space_t unw_addr_space;
+
+  /** Underlying libunwind addres-space
+   *
+   *  The `find_proc_info`, `put_unwind_info`, `get_dyn_info_list_addr`
+   *  operations of the native MC address space is currently delegated
+   *  to this address space (either the local or a ptrace unwinder).
+   */
+  unw_addr_space_t unw_underlying_addr_space;
+
+  /** The corresponding context
+   */
+  void* unw_underlying_context;
 };
 
-void MC_process_init(mc_process_t process, pid_t pid);
-void MC_process_clear(mc_process_t process);
+/** Open a FD to a remote process memory (`/dev/$pid/mem`)
+ */
+int open_vm(pid_t pid, int flags);
 
-static inline
-bool MC_process_is_self(mc_process_t process)
-{
-  return process->process_flags & MC_PROCESS_SELF_FLAG;
+}
 }
 
-/* Process memory access: */
-
-/** Read data from a process memory
- *
- *  @param process the process
- *  @param local   local memory address (destination)
- *  @param remote  target process memory address (source)
- *  @param len     data size
- */
-void MC_process_read(mc_process_t process, void* local, const void* remote, size_t len);
-
-/** 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
- */
-void MC_process_write(mc_process_t process, const void* local, void* remote, size_t len);
-
-/* Functions, variables of the process: */
+SG_BEGIN_DECL()
 
-mc_object_info_t MC_process_find_object_info(mc_process_t process, void* ip);
-dw_frame_t MC_process_find_function(mc_process_t process, void* ip);
+XBT_INTERNAL void MC_invalidate_cache(void);
 
 SG_END_DECL()