Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Integrate the (WIP) hashing logic in the Snapshot object
[simgrid.git] / src / mc / sosp / Snapshot.cpp
index de20ddd..b36d8cd 100644 (file)
@@ -1,29 +1,26 @@
-/* Copyright (c) 2014-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2014-2022. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/mc/sosp/Snapshot.hpp"
 #include "src/mc/mc_config.hpp"
-#include "src/mc/mc_hash.hpp"
-#include "src/mc/mc_smx.hpp"
 
 #include <cstddef> /* std::size_t */
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_snapshot, mc, "Taking and restoring snapshots");
-namespace simgrid {
-namespace mc {
+namespace simgrid::mc {
 /************************************* Take Snapshot ************************************/
 /****************************************************************************************/
 
-void Snapshot::snapshot_regions(RemoteClient* process)
+void Snapshot::snapshot_regions(RemoteProcess* process)
 {
   snapshot_regions_.clear();
 
   for (auto const& object_info : process->object_infos)
     add_region(RegionType::Data, object_info.get(), object_info->start_rw, object_info->end_rw - object_info->start_rw);
 
-  xbt_mheap_t heap = process->get_heap();
+  const s_xbt_mheap_t* heap = process->get_heap();
   void* start_heap = heap->base;
   void* end_heap   = heap->breakval;
 
@@ -40,7 +37,7 @@ void Snapshot::snapshot_regions(RemoteClient* process)
  *  @param ip    Instruction pointer
  *  @return      true if the variable is valid
  * */
-static bool valid_variable(simgrid::mc::Variable* var, simgrid::mc::Frame* scope, const void* ip)
+static bool valid_variable(const simgrid::mc::Variable* var, simgrid::mc::Frame* scope, const void* ip)
 {
   // The variable is not yet valid:
   if (scope->range.begin() + var->start_scope > (std::uint64_t)ip)
@@ -55,10 +52,16 @@ static void fill_local_variables_values(mc_stack_frame_t stack_frame, Frame* sco
   if (not scope || not scope->range.contain(stack_frame->ip))
     return;
 
-  for (Variable& current_variable : scope->variables) {
+  for (const Variable& current_variable : scope->variables) {
     if (not valid_variable(&current_variable, scope, (void*)stack_frame->ip))
       continue;
 
+    if (not current_variable.type) {
+      XBT_VERB("Ignore local variable without type: '%s' [%s]", current_variable.name.c_str(),
+               stack_frame->frame->name.c_str());
+      continue;
+    }
+
     s_local_variable_t new_var;
     new_var.subprogram = stack_frame->frame;
     new_var.ip         = stack_frame->ip;
@@ -71,10 +74,9 @@ static void fill_local_variables_values(mc_stack_frame_t stack_frame, Frame* sco
     else if (not current_variable.location_list.empty()) {
       dwarf::Location location = simgrid::dwarf::resolve(current_variable.location_list, current_variable.object_info,
                                                          &(stack_frame->unw_cursor), (void*)stack_frame->frame_base,
-                                                         &mc_model_checker->process());
+                                                         &mc_model_checker->get_remote_process());
 
-      if (not location.in_memory())
-        xbt_die("Cannot handle non-address variable");
+      xbt_assert(location.in_memory(), "Cannot handle non-address variable");
       new_var.address = location.address();
     } else
       xbt_die("No address");
@@ -97,14 +99,14 @@ static std::vector<s_local_variable_t> get_local_variables_values(std::vector<s_
 
 static std::vector<s_mc_stack_frame_t> unwind_stack_frames(UnwindContext* stack_context)
 {
-  RemoteClient* process = &mc_model_checker->process();
+  const RemoteProcess* process = &mc_model_checker->get_remote_process();
   std::vector<s_mc_stack_frame_t> result;
 
   unw_cursor_t c = stack_context->cursor();
 
   // TODO, check condition check (unw_init_local==0 means end of frame)
 
-  while (1) {
+  while (true) {
     s_mc_stack_frame_t stack_frame;
 
     stack_frame.unw_cursor = c;
@@ -138,10 +140,8 @@ static std::vector<s_mc_stack_frame_t> unwind_stack_frames(UnwindContext* stack_
       break;
 
     int ret = unw_step(&c);
-    if (ret == 0)
-      xbt_die("Unexpected end of stack.");
-    else if (ret < 0)
-      xbt_die("Error while unwinding stack");
+    xbt_assert(ret >= 0, "Error while unwinding stack");
+    xbt_assert(ret != 0, "Unexpected end of stack.");
   }
 
   xbt_assert(not result.empty(), "unw_init_local failed");
@@ -149,7 +149,7 @@ static std::vector<s_mc_stack_frame_t> unwind_stack_frames(UnwindContext* stack_
   return result;
 }
 
-void Snapshot::snapshot_stacks(RemoteClient* process)
+void Snapshot::snapshot_stacks(RemoteProcess* process)
 {
   for (auto const& stack : process->stack_areas()) {
     s_mc_snapshot_stack_t st;
@@ -172,39 +172,36 @@ void Snapshot::snapshot_stacks(RemoteClient* process)
   }
 }
 
-static void snapshot_handle_ignore(Snapshot* snapshot)
+void Snapshot::handle_ignore()
 {
-  xbt_assert(snapshot->process());
+  xbt_assert(get_remote_process());
 
   // Copy the memory:
-  for (auto const& region : snapshot->process()->ignored_regions()) {
+  for (auto const& region : get_remote_process()->ignored_regions()) {
     s_mc_snapshot_ignored_data_t ignored_data;
     ignored_data.start = (void*)region.addr;
     ignored_data.data.resize(region.size);
     // TODO, we should do this once per privatization segment:
-    snapshot->process()->read_bytes(ignored_data.data.data(), region.size, remote(region.addr));
-    snapshot->ignored_data_.push_back(std::move(ignored_data));
+    get_remote_process()->read_bytes(ignored_data.data.data(), region.size, remote(region.addr));
+    ignored_data_.push_back(std::move(ignored_data));
   }
 
   // Zero the memory:
-  for (auto const& region : snapshot->process()->ignored_regions())
-    snapshot->process()->clear_bytes(remote(region.addr), region.size);
+  for (auto const& region : get_remote_process()->ignored_regions())
+    get_remote_process()->clear_bytes(remote(region.addr), region.size);
 }
 
-static void snapshot_ignore_restore(simgrid::mc::Snapshot* snapshot)
+void Snapshot::ignore_restore() const
 {
-  for (auto const& ignored_data : snapshot->ignored_data_)
-    snapshot->process()->write_bytes(ignored_data.data.data(), ignored_data.data.size(), remote(ignored_data.start));
+  for (auto const& ignored_data : ignored_data_)
+    get_remote_process()->write_bytes(ignored_data.data.data(), ignored_data.data.size(), remote(ignored_data.start));
 }
 
-Snapshot::Snapshot(int num_state, RemoteClient* process) : AddressSpace(process), num_state_(num_state)
+Snapshot::Snapshot(long num_state, RemoteProcess* process) : AddressSpace(process), num_state_(num_state)
 {
-  XBT_DEBUG("Taking snapshot %i", num_state);
-
-  for (auto const& p : process->actors())
-    enabled_processes_.insert(p.copy.get_buffer()->get_pid());
+  XBT_DEBUG("Taking snapshot %ld", num_state);
 
-  snapshot_handle_ignore(this);
+  handle_ignore();
 
   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
   snapshot_regions(process);
@@ -213,10 +210,10 @@ Snapshot::Snapshot(int num_state, RemoteClient* process) : AddressSpace(process)
 
   if (_sg_mc_max_visited_states > 0 || not _sg_mc_property_file.get().empty()) {
     snapshot_stacks(process);
-    hash_ = simgrid::mc::hash(*this);
+    hash_ = this->do_hash();
   }
 
-  snapshot_ignore_restore(this);
+  ignore_restore();
 }
 
 void Snapshot::add_region(RegionType type, ObjectInformation* object_info, void* start_addr, std::size_t size)
@@ -226,14 +223,14 @@ void Snapshot::add_region(RegionType type, ObjectInformation* object_info, void*
   else if (type == RegionType::Heap)
     xbt_assert(not object_info, "Unexpected object info for heap region.");
 
-  Region* region = new Region(type, start_addr, size);
+  auto* region = new Region(type, start_addr, size);
   region->object_info(object_info);
-  snapshot_regions_.push_back(std::unique_ptr<Region>(std::move(region)));
+  snapshot_regions_.push_back(std::unique_ptr<Region>(region));
 }
 
 void* Snapshot::read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, ReadOptions options) const
 {
-  Region* region = this->get_region((void*)address.address());
+  const Region* region = this->get_region((void*)address.address());
   if (region) {
     void* res = region->read(buffer, (void*)address.address(), size);
     if (buffer == res || options & ReadOptions::lazy())
@@ -243,7 +240,7 @@ void* Snapshot::read_bytes(void* buffer, std::size_t size, RemotePtr<void> addre
       return buffer;
     }
   } else
-    return this->process()->read_bytes(buffer, size, address, options);
+    return this->get_remote_process()->read_bytes(buffer, size, address, options);
 }
 /** @brief Find the snapshotted region from a pointer
  *
@@ -272,9 +269,9 @@ Region* Snapshot::get_region(const void* addr, Region* hinted_region) const
     return get_region(addr);
 }
 
-void Snapshot::restore(RemoteClient* process)
+void Snapshot::restore(RemoteProcess* process) const
 {
-  XBT_DEBUG("Restore snapshot %i", num_state_);
+  XBT_DEBUG("Restore snapshot %ld", num_state_);
 
   // Restore regions
   for (std::unique_ptr<Region> const& region : snapshot_regions_) {
@@ -282,9 +279,30 @@ void Snapshot::restore(RemoteClient* process)
       region.get()->restore();
   }
 
-  snapshot_ignore_restore(this);
+  ignore_restore();
   process->clear_cache();
 }
 
-} // namespace mc
-} // namespace simgrid
+/* ----------- Hashing logic -------------- */
+class djb_hash {
+  hash_type state_ = 5381LL;
+
+public:
+  template <class T> void update(T& x) { state_ = (state_ << 5) + state_ + x; }
+  hash_type value() const { return state_; }
+};
+hash_type Snapshot::do_hash() const
+{
+  XBT_DEBUG("START hash %ld", num_state_);
+  djb_hash hash;
+  // TODO:
+  // * nb_processes
+  // * heap_bytes_used
+  // * root variables
+  // * basic stack frame information
+  // * stack frame local variables
+  XBT_DEBUG("END hash %ld", num_state_);
+  return hash.value();
+}
+
+} // namespace simgrid::mc