Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Move some SIMIX inspection code in the Process class
[simgrid.git] / src / mc / Process.hpp
index 5d50961..a2cef85 100644 (file)
@@ -7,20 +7,22 @@
 #ifndef SIMGRID_MC_PROCESS_H
 #define SIMGRID_MC_PROCESS_H
 
-#include <type_traits>
-
-#include <sys/types.h>
+#include <cstdint>
+#include <cstddef>
 
+#include <type_traits>
 #include <vector>
 #include <memory>
 
-#include "simgrid_config.h"
 #include <sys/types.h>
 
+#include <simgrid_config.h>
+
 #include <xbt/base.h>
+#include <xbt/dynar.h>
 #include <xbt/mmalloc.h>
 
-#ifdef HAVE_MC
+#if HAVE_MC
 #include "src/xbt/mmalloc/mmprivate.h"
 #endif
 
 #include "src/simix/popping_private.h"
 #include "src/simix/smx_private.h"
 
-#include "../xbt/memory_map.hpp"
-
-#include "mc_forward.hpp"
-#include "mc_base.h"
-#include "mc_mmalloc.h" // std_heap
-#include "AddressSpace.hpp"
-#include "mc_protocol.h"
+#include "src/xbt/memory_map.hpp"
 
-#include "ObjectInformation.hpp"
+#include "src/mc/mc_forward.hpp"
+#include "src/mc/mc_base.h"
+#include "src/mc/AddressSpace.hpp"
+#include "src/mc/mc_protocol.h"
+#include "src/mc/ObjectInformation.hpp"
 
 // Those flags are used to track down which cached information
 // is still up to date and which information needs to be updated.
@@ -49,17 +49,58 @@ typedef int mc_process_cache_flags_t;
 namespace simgrid {
 namespace mc {
 
+class SimixProcessInformation {
+public:
+  /** MCed address of the process */
+  void* address = nullptr;
+  union {
+    /** (Flat) Copy of the process data structure */
+    struct s_smx_process copy;
+  };
+  /** Hostname (owned by `mc_modelchecker->hostnames`) */
+  const char* hostname = nullptr;
+  std::string name;
+
+  void clear()
+  {
+    name.clear();
+    address = nullptr;
+    hostname = nullptr;
+  }
+};
+
 struct IgnoredRegion {
   std::uint64_t addr;
-  size_t size;
+  std::size_t size;
+};
+
+struct IgnoredHeapRegion {
+  int block;
+  int fragment;
+  void *address;
+  std::size_t size;
 };
 
 /** Representation of a process
+ *
+ *  This class is mixing a lot of differents responsabilities and is tied
+ *  to SIMIX. It should probably split into different classes.
+ *
+ *  Responsabilities:
+ *
+ *  - reading from the process memory (`AddressSpace`);
+ *  - accessing the system state of the porcess (heap, …);
+ *  - storing the SIMIX state of the process;
+ *  - privatization;
+ *  - communication with the model-checked process;
+ *  - stack unwinding;
+ *  - etc.
  */
 class Process final : public AddressSpace {
 public:
   Process(pid_t pid, int sockfd);
   ~Process();
+  void init();
 
   Process(Process const&) = delete;
   Process(Process &&) = delete;
@@ -68,8 +109,8 @@ public:
 
   // Read memory:
   const void* read_bytes(void* buffer, std::size_t size,
-    remote_ptr<void> address, int process_index = ProcessIndexAny,
-    ReadMode mode = Normal) const override;
+    RemotePtr<void> address, int process_index = ProcessIndexAny,
+    ReadOptions options = ReadOptions::none()) const override;
   void read_variable(const char* name, void* target, size_t size) const;
   template<class T>
   T read_variable(const char *name) const
@@ -79,17 +120,17 @@ public:
     read_variable(name, &res, sizeof(T));
     return res;
   }
-  char* read_string(remote_ptr<void> address) const;
+  char* read_string(RemotePtr<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);
+  void write_bytes(const void* buffer, size_t len, RemotePtr<void> address);
+  void clear_bytes(RemotePtr<void> address, size_t len);
 
   // Debug information:
-  std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info(remote_ptr<void> addr) const;
-  std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_exec(remote_ptr<void> addr) const;
-  std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_rw(remote_ptr<void> addr) const;
-  simgrid::mc::Frame* find_function(remote_ptr<void> ip) const;
+  std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info(RemotePtr<void> addr) const;
+  std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_exec(RemotePtr<void> addr) const;
+  std::shared_ptr<simgrid::mc::ObjectInformation> find_object_info_rw(RemotePtr<void> addr) const;
+  simgrid::mc::Frame* find_function(RemotePtr<void> ip) const;
   simgrid::mc::Variable* find_variable(const char* name) const;
 
   // Heap access:
@@ -114,7 +155,7 @@ public:
 
   pid_t pid() const { return pid_; }
 
-  bool in_maestro_stack(remote_ptr<void> p) const
+  bool in_maestro_stack(RemotePtr<void> p) const
   {
     return p >= this->maestro_stack_start_ && p < this->maestro_stack_end_;
   }
@@ -161,21 +202,54 @@ public:
   }
   void privatized(bool privatized) { privatized_ = privatized; }
 
+  void ignore_global_variable(const char* name)
+  {
+    for (std::shared_ptr<simgrid::mc::ObjectInformation> const& info :
+        this->object_infos)
+      info->remove_global_variable(name);
+  }
+
+  std::vector<s_stack_region_t>& stack_areas()
+  {
+    return stack_areas_;
+  }
+  std::vector<s_stack_region_t> const& stack_areas() const
+  {
+    return stack_areas_;
+  }
+
+  std::vector<IgnoredHeapRegion> const& ignored_heap() const
+  {
+    return ignored_heap_;
+  }
+  void ignore_heap(IgnoredHeapRegion const& region);
+  void unignore_heap(void *address, size_t size);
+
+  void ignore_local_variable(const char *var_name, const char *frame_name);
+  int socket() { return socket_; }
+  std::vector<simgrid::mc::SimixProcessInformation>& simix_processes();
+  std::vector<simgrid::mc::SimixProcessInformation>& old_simix_processes();
+
 private:
   void init_memory_map_info();
   void refresh_heap();
   void refresh_malloc_info();
+  void refresh_simix();
+
 private:
-  pid_t pid_;
-  int socket_;
-  bool running_;
+  pid_t pid_ = -1;
+  int socket_ = -1;
+  bool running_ = false;
   std::vector<simgrid::xbt::VmMap> memory_map_;
-  remote_ptr<void> maestro_stack_start_, maestro_stack_end_;
-  int memory_file;
+  RemotePtr<void> maestro_stack_start_, maestro_stack_end_;
+  int memory_file = -1;
   std::vector<IgnoredRegion> ignored_regions_;
-  int clear_refs_fd_;
-  int pagemap_fd_;
-  bool privatized_;
+  int clear_refs_fd_ = -1;
+  int pagemap_fd_ = -1;
+  bool privatized_ = false;
+  std::vector<s_stack_region_t> stack_areas_;
+  std::vector<IgnoredHeapRegion> ignored_heap_;
+
 public: // object info
   // TODO, make private (first, objectify simgrid::mc::ObjectInformation*)
   std::vector<std::shared_ptr<simgrid::mc::ObjectInformation>> object_infos;
@@ -187,16 +261,16 @@ public: // Copies of MCed SMX data structures
    *
    *  See mc_smx.c.
    */
-  xbt_dynar_t smx_process_infos;
+  std::vector<SimixProcessInformation> smx_process_infos;
 
   /** Copy of `simix_global->process_to_destroy`
    *
    *  See mc_smx.c.
    */
-  xbt_dynar_t smx_old_process_infos;
+  std::vector<SimixProcessInformation> smx_old_process_infos;
 
   /** State of the cache (which variables are up to date) */
-  mc_process_cache_flags_t cache_flags;
+  mc_process_cache_flags_t cache_flags = MC_PROCESS_CACHE_FLAG_NONE;
 
   /** Address of the heap structure in the MCed process. */
   void* heap_address;
@@ -247,10 +321,4 @@ XBT_PRIVATE int open_vm(pid_t pid, int flags);
 }
 }
 
-SG_BEGIN_DECL()
-
-XBT_PRIVATE void MC_invalidate_cache(void);
-
-SG_END_DECL()
-
 #endif