src/mc/sosp/Snapshot.hpp

   1 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_MC_SNAPSHOT_HPP
   7 #define SIMGRID_MC_SNAPSHOT_HPP
   8
   9 #include "src/mc/ModelChecker.hpp"
  10 #include "src/mc/inspect/mc_unw.hpp"
  11 #include "src/mc/remote/RemoteClient.hpp"
  12 #include "src/mc/sosp/Region.hpp"
  13
  14 // ***** MC Snapshot
  15
  16 /** Ignored data
  17  *
  18  *  Some parts of the snapshot are ignored by zeroing them out: the real
  19  *  values is stored here.
  20  * */
  21 struct s_mc_snapshot_ignored_data_t {
  22   void* start;
  23   std::vector<char> data;
  24 };
  25
  26 /** Information about a given stack frame */
  27 struct s_mc_stack_frame_t {
  28   /** Instruction pointer */
  29   unw_word_t ip;
  30   /** Stack pointer */
  31   unw_word_t sp;
  32   unw_word_t frame_base;
  33   simgrid::mc::Frame* frame;
  34   std::string frame_name;
  35   unw_cursor_t unw_cursor;
  36 };
  37 typedef s_mc_stack_frame_t* mc_stack_frame_t;
  38
  39 struct s_local_variable_t {
  40   simgrid::mc::Frame* subprogram;
  41   unsigned long ip;
  42   std::string name;
  43   simgrid::mc::Type* type;
  44   void* address;
  45 };
  46 typedef s_local_variable_t* local_variable_t;
  47
  48 struct XBT_PRIVATE s_mc_snapshot_stack_t {
  49   std::vector<s_local_variable_t> local_variables;
  50   simgrid::mc::UnwindContext context;
  51   std::vector<s_mc_stack_frame_t> stack_frames;
  52 };
  53 typedef s_mc_snapshot_stack_t* mc_snapshot_stack_t;
  54
  55 namespace simgrid {
  56 namespace mc {
  57
  58 class XBT_PRIVATE Snapshot final : public AddressSpace {
  59 public:
  60   Snapshot(int num_state, RemoteClient* process = &mc_model_checker->process());
  61   ~Snapshot() = default;
  62
  63   /* Initialization */
  64
  65   /* Regular use */
  66   const void* read_bytes(void* buffer, std::size_t size, RemotePtr<void> address,
  67                          ReadOptions options = ReadOptions::none()) const override;
  68   Region* get_region(const void* addr) const;
  69   Region* get_region(const void* addr, Region* hinted_region) const;
  70   void restore(RemoteClient* process);
  71
  72   // To be private
  73   int num_state_;
  74   std::size_t heap_bytes_used_;
  75   std::vector<std::unique_ptr<Region>> snapshot_regions_;
  76   std::set<pid_t> enabled_processes_;
  77   std::vector<std::size_t> stack_sizes_;
  78   std::vector<s_mc_snapshot_stack_t> stacks_;
  79   std::vector<simgrid::mc::IgnoredHeapRegion> to_ignore_;
  80   std::uint64_t hash_ = 0;
  81   std::vector<s_mc_snapshot_ignored_data_t> ignored_data_;
  82
  83 private:
  84   void add_region(RegionType type, ObjectInformation* object_info, void* start_addr, std::size_t size);
  85   void snapshot_regions(simgrid::mc::RemoteClient* process);
  86   void snapshot_stacks(simgrid::mc::RemoteClient* process);
  87 };
  88 } // namespace mc
  89 } // namespace simgrid
  90
  91 static XBT_ALWAYS_INLINE const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot)
  92 {
  93   if (snapshot == nullptr)
  94     xbt_die("snapshot is nullptr");
  95   return mc_model_checker->process().get_heap()->breakval;
  96 }
  97
  98 #endif