Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Make s_mc_snapshot_stack::context not a pointer
[simgrid.git] / src / mc / mc_snapshot.h
index 4d93f1c..8d9ce91 100644 (file)
 #include <sys/types.h> // off_t
 #include <stdint.h> // size_t
 
+#include <vector>
+#include <set>
+#include <memory>
+
 #include <simgrid_config.h>
 #include "../xbt/mmalloc/mmprivate.h"
 #include <xbt/asserts.h>
 #include "ModelChecker.hpp"
 #include "PageStore.hpp"
 #include "mc_mmalloc.h"
-#include "mc_address_space.h"
+#include "mc/AddressSpace.hpp"
 #include "mc_unw.h"
+#include "RegionSnapshot.hpp"
 
 SG_BEGIN_DECL()
 
 // ***** Snapshot region
 
-typedef enum e_mc_region_type_t {
-  MC_REGION_TYPE_UNKNOWN = 0,
-  MC_REGION_TYPE_HEAP = 1,
-  MC_REGION_TYPE_DATA = 2
-} mc_region_type_t;
-
-// TODO, use OO instead of this
-typedef enum e_mc_region_storeage_type_t {
-  MC_REGION_STORAGE_TYPE_NONE = 0,
-  MC_REGION_STORAGE_TYPE_FLAT = 1,
-  MC_REGION_STORAGE_TYPE_CHUNKED = 2,
-  MC_REGION_STORAGE_TYPE_PRIVATIZED = 3
-} mc_region_storage_type_t;
-
-/** @brief Copy/snapshot of a given memory region
- *
- *  Different types of region snapshot storage types exist:
- *  <ul>
- *    <li>flat/dense snapshots are a simple copy of the region;</li>
- *    <li>sparse/per-page snapshots are snaapshots which shared
- *    identical pages.</li>
- *    <li>privatized (SMPI global variable privatisation).
- *  </ul>
- *
- *  This is handled with a variant based approch:
- *
- *    * `storage_type` identified the type of storage;
- *    * an anonymous enum is used to distinguish the relevant types for
- *      each type.
- */
-typedef struct s_mc_mem_region s_mc_mem_region_t, *mc_mem_region_t;
-
-struct s_mc_mem_region {
-  mc_region_type_t region_type;
-  mc_region_storage_type_t storage_type;
-  mc_object_info_t object_info;
-
-  /** @brief  Virtual address of the region in the simulated process */
-  void *start_addr;
-
-  /** @brief Size of the data region in bytes */
-  size_t size;
-
-  /** @brief Permanent virtual address of the region
-   *
-   * This is usually the same address as the simuilated process address.
-   * However, when using SMPI privatization of global variables,
-   * each SMPI process has its own set of global variables stored
-   * at a different virtual address. The scheduler maps those region
-   * on the region of the global variables.
-   *
-   * */
-  void *permanent_addr;
-
-  union {
-    struct {
-      /** @brief Copy of the snapshot for flat snapshots regions (NULL otherwise) */
-      void *data;
-    } flat;
-    struct {
-      /** @brief Pages indices in the page store for per-page snapshots (NULL otherwise) */
-      size_t* page_numbers;
-    } chunked;
-    struct {
-      size_t regions_count;
-      mc_mem_region_t* regions;
-    } privatized;
-  };
-
-};
-
-MC_SHOULD_BE_INTERNAL mc_mem_region_t mc_region_new_sparse(
-  mc_region_type_t type, void *start_addr, void* data_addr, size_t size);
-MC_SHOULD_BE_INTERNAL void MC_region_destroy(mc_mem_region_t reg);
 XBT_INTERNAL void mc_region_restore_sparse(mc_process_t process, mc_mem_region_t reg);
 
-static inline  __attribute__ ((always_inline))
-bool mc_region_contain(mc_mem_region_t region, const void* p)
-{
-  return p >= region->start_addr &&
-    p < (void*)((char*) region->start_addr + region->size);
-}
-
 static inline __attribute__((always_inline))
-void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region)
+void* mc_translate_address_region_chunked(uintptr_t addr, mc_mem_region_t region)
 {
-  size_t pageno = mc_page_number(region->start_addr, (void*) addr);
-  size_t snapshot_pageno = region->chunked.page_numbers[pageno];
+  size_t pageno = mc_page_number((void*)region->start().address(), (void*) addr);
   const void* snapshot_page =
-    mc_model_checker->page_store().get_page(snapshot_pageno);
+    region->page_data().page(pageno);
   return (char*) snapshot_page + mc_page_offset((void*) addr);
 }
 
-XBT_INTERNAL mc_mem_region_t mc_get_snapshot_region(
-  const void* addr, mc_snapshot_t snapshot, int process_index);
-
-/** \brief Translate a pointer from process address space to snapshot address space
- *
- *  The address space contains snapshot of the main/application memory:
- *  this function finds the address in a given snaphot for a given
- *  real/application address.
- *
- *  For read only memory regions and other regions which are not int the
- *  snapshot, the address is not changed.
- *
- *  \param addr     Application address
- *  \param snapshot The snapshot of interest (if NULL no translation is done)
- *  \return         Translated address in the snapshot address space
- * */
 static inline __attribute__((always_inline))
-void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot, int process_index)
+void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
 {
-
-  // If not in a process state/clone:
-  if (!snapshot) {
-    return (uintptr_t *) addr;
-  }
-
-  mc_mem_region_t region = mc_get_snapshot_region((void*) addr, snapshot, process_index);
-
-  xbt_assert(mc_region_contain(region, (void*) addr), "Trying to read out of the region boundary.");
-
-  if (!region) {
-    return (void *) addr;
-  }
-
-  switch (region->storage_type) {
-  case MC_REGION_STORAGE_TYPE_NONE:
+  switch (region->storage_type()) {
+  case simgrid::mc::StorageType::NoData:
   default:
     xbt_die("Storage type not supported");
 
-  case MC_REGION_STORAGE_TYPE_FLAT:
+  case simgrid::mc::StorageType::Flat:
     {
-      uintptr_t offset = addr - (uintptr_t) region->start_addr;
-      return (void *) ((uintptr_t) region->flat.data + offset);
+      uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
+      return (void *) ((uintptr_t) region->flat_data().data() + offset);
     }
 
-  case MC_REGION_STORAGE_TYPE_CHUNKED:
-    return mc_translate_address_region(addr, region);
+  case simgrid::mc::StorageType::Chunked:
+    return mc_translate_address_region_chunked(addr, region);
 
-  case MC_REGION_STORAGE_TYPE_PRIVATIZED:
+  case simgrid::mc::StorageType::Privatized:
     {
       xbt_assert(process_index >=0,
         "Missing process index for privatized region");
-      xbt_assert((size_t) process_index < region->privatized.regions_count,
+      xbt_assert((size_t) process_index < region->privatized_data().size(),
         "Out of range process index");
-      mc_mem_region_t subregion = region->privatized.regions[process_index];
-      xbt_assert(subregion, "Missing memory region for process %i", process_index);
-      return mc_translate_address(addr, snapshot, process_index);
+      simgrid::mc::RegionSnapshot& subregion= region->privatized_data()[process_index];
+      return mc_translate_address_region(addr, &subregion, process_index);
     }
   }
 }
 
+XBT_INTERNAL mc_mem_region_t mc_get_snapshot_region(
+  const void* addr, const s_mc_snapshot_t *snapshot, int process_index);
+
+}
+
 // ***** MC Snapshot
 
 /** Ignored data
@@ -188,44 +85,16 @@ void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot, int process_i
  * */
 typedef struct s_mc_snapshot_ignored_data {
   void* start;
-  size_t size;
-  void* data;
+  std::vector<char> data;
 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
 
 typedef struct s_fd_infos{
-  char *filename;
+  std::string filename;
   int number;
   off_t current_position;
   int flags;
 }s_fd_infos_t, *fd_infos_t;
 
-struct s_mc_snapshot {
-  mc_process_t process;
-  int num_state;
-  s_mc_address_space_t address_space;
-  size_t heap_bytes_used;
-  mc_mem_region_t* snapshot_regions;
-  size_t snapshot_regions_count;
-  xbt_dynar_t enabled_processes;
-  int privatization_index;
-  size_t *stack_sizes;
-  xbt_dynar_t stacks;
-  xbt_dynar_t to_ignore;
-  uint64_t hash;
-  xbt_dynar_t ignored_data;
-  int total_fd;
-  fd_infos_t *current_fd;
-};
-
-static inline __attribute__ ((always_inline))
-mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
-{
-  if (mc_region_contain(region, addr))
-    return region;
-  else
-    return mc_get_snapshot_region(addr, snapshot, process_index);
-}
-
 /** Information about a given stack frame
  *
  */
@@ -236,16 +105,25 @@ typedef struct s_mc_stack_frame {
   unw_word_t sp;
   unw_word_t frame_base;
   dw_frame_t frame;
-  char* frame_name;
+  std::string frame_name;
   unw_cursor_t unw_cursor;
 } s_mc_stack_frame_t, *mc_stack_frame_t;
 
-typedef struct s_mc_snapshot_stack{
-  xbt_dynar_t local_variables;
-  mc_unw_context_t context;
-  xbt_dynar_t stack_frames; // mc_stack_frame_t
+typedef struct s_local_variable{
+  dw_frame_t subprogram;
+  unsigned long ip;
+  std::string name;
+  dw_type_t type;
+  void *address;
+  int region;
+} s_local_variable_t, *local_variable_t;
+
+typedef struct s_mc_snapshot_stack {
+  std::vector<s_local_variable> local_variables;
+  s_mc_unw_context_t context;
+  std::vector<s_mc_stack_frame_t> stack_frames;
   int process_index;
-}s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
+} s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
 
 typedef struct s_mc_global_t {
   mc_snapshot_t snapshot;
@@ -258,30 +136,57 @@ typedef struct s_mc_global_t {
   char *recv_diff;
 }s_mc_global_t, *mc_global_t;
 
-typedef struct s_mc_checkpoint_ignore_region{
-  void *addr;
-  size_t size;
-}s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
+namespace simgrid {
+namespace mc {
+
+class Snapshot : public AddressSpace {
+public:
+  Snapshot();
+  ~Snapshot();
+  const void* read_bytes(void* buffer, std::size_t size,
+    remote_ptr<void> address, int process_index = ProcessIndexAny,
+    ReadMode mode = Normal) const MC_OVERRIDE;
+public: // To be private
+  mc_process_t process;
+  int num_state;
+  size_t heap_bytes_used;
+  std::vector<std::unique_ptr<s_mc_mem_region_t>> snapshot_regions;
+  std::set<pid_t> enabled_processes;
+  int privatization_index;
+  std::vector<size_t> stack_sizes;
+  std::vector<s_mc_snapshot_stack_t> stacks;
+  std::vector<s_mc_heap_ignore_region_t> to_ignore;
+  uint64_t hash;
+  std::vector<s_mc_snapshot_ignored_data> ignored_data;
+  std::vector<s_fd_infos_t> current_fds;
+};
+
+}
+}
+
+extern "C" {
+
+static inline __attribute__ ((always_inline))
+mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
+{
+  if (region->contain(simgrid::mc::remote(addr)))
+    return region;
+  else
+    return mc_get_snapshot_region(addr, snapshot, process_index);
+}
 
 static const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
 
 XBT_INTERNAL mc_snapshot_t MC_take_snapshot(int num_state);
 XBT_INTERNAL void MC_restore_snapshot(mc_snapshot_t);
-XBT_INTERNAL void MC_free_snapshot(mc_snapshot_t);
 
-XBT_INTERNAL size_t* mc_take_page_snapshot_region(mc_process_t process,
-  void* data, size_t page_count);
-XBT_INTERNAL void mc_free_page_snapshot_region(size_t* pagenos, size_t page_count);
 XBT_INTERNAL void mc_restore_page_snapshot_region(
   mc_process_t process,
-  void* start_addr, size_t page_count, size_t* pagenos);
+  void* start_addr, simgrid::mc::PerPageCopy const& pagenos);
 
 MC_SHOULD_BE_INTERNAL const void* MC_region_read_fragmented(
   mc_mem_region_t region, void* target, const void* addr, size_t size);
 
-XBT_INTERNAL const void* MC_snapshot_read(mc_snapshot_t snapshot,
-  adress_space_read_flags_t flags,
-  void* target, const void* addr, size_t size, int process_index);
 MC_SHOULD_BE_INTERNAL int MC_snapshot_region_memcmp(
   const void* addr1, mc_mem_region_t region1,
   const void* addr2, mc_mem_region_t region2, size_t size);
@@ -289,20 +194,12 @@ XBT_INTERNAL int MC_snapshot_memcmp(
   const void* addr1, mc_snapshot_t snapshot1,
   const void* addr2, mc_snapshot_t snapshot2, int process_index, size_t size);
 
-static inline __attribute__ ((always_inline))
-const void* MC_snapshot_read_pointer(mc_snapshot_t snapshot, const void* addr, int process_index)
-{
-  void* res;
-  return *(const void**) MC_snapshot_read(snapshot, MC_ADDRESS_SPACE_READ_FLAGS_LAZY,
-    &res, addr, sizeof(void*), process_index);
-}
-
 static inline __attribute__ ((always_inline))
 const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot)
 {
   if(snapshot==NULL)
       xbt_die("snapshot is NULL");
-  return MC_process_get_heap(&mc_model_checker->process())->breakval;
+  return mc_model_checker->process().get_heap()->breakval;
 }
 
 /** @brief Read memory from a snapshot region
@@ -316,30 +213,28 @@ const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot)
 static inline __attribute__((always_inline))
 const void* MC_region_read(mc_mem_region_t region, void* target, const void* addr, size_t size)
 {
-  if (region==NULL)
-    // Should be deprecated:
-    return addr;
+  xbt_assert(region);
 
-  uintptr_t offset = (char*) addr - (char*) region->start_addr;
+  uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
 
-  xbt_assert(mc_region_contain(region, addr),
+  xbt_assert(region->contain(simgrid::mc::remote(addr)),
     "Trying to read out of the region boundary.");
 
-  switch (region->storage_type) {
-  case MC_REGION_STORAGE_TYPE_NONE:
+  switch (region->storage_type()) {
+  case simgrid::mc::StorageType::NoData:
   default:
     xbt_die("Storage type not supported");
 
-  case MC_REGION_STORAGE_TYPE_FLAT:
-    return (char*) region->flat.data + offset;
+  case simgrid::mc::StorageType::Flat:
+    return (char*) region->flat_data().data() + offset;
 
-  case MC_REGION_STORAGE_TYPE_CHUNKED:
+  case simgrid::mc::StorageType::Chunked:
     {
       // Last byte of the region:
       void* end = (char*) addr + size - 1;
       if (mc_same_page(addr, end) ) {
         // The memory is contained in a single page:
-        return mc_translate_address_region((uintptr_t) addr, region);
+        return mc_translate_address_region_chunked((uintptr_t) addr, region);
       } else {
         // The memory spans several pages:
         return MC_region_read_fragmented(region, target, addr, size);
@@ -348,7 +243,7 @@ const void* MC_region_read(mc_mem_region_t region, void* target, const void* add
 
   // We currently do not pass the process_index to this function so we assume
   // that the privatized region has been resolved in the callers:
-  case MC_REGION_STORAGE_TYPE_PRIVATIZED:
+  case simgrid::mc::StorageType::Privatized:
     xbt_die("Storage type not supported");
   }
 }
@@ -362,4 +257,8 @@ void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
 
 SG_END_DECL()
 
+XBT_INTERNAL int init_heap_information(xbt_mheap_t heap1, xbt_mheap_t heap2,
+                          std::vector<s_mc_heap_ignore_region_t>* i1,
+                          std::vector<s_mc_heap_ignore_region_t>* i2);
+
 #endif