Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ad755f745a3767b545205347f46db8b7cbb989ff
[simgrid.git] / 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 typedef const s_local_variable_t* const_local_variable_t;
48
49 struct XBT_PRIVATE s_mc_snapshot_stack_t {
50   std::vector<s_local_variable_t> local_variables;
51   simgrid::mc::UnwindContext context;
52   std::vector<s_mc_stack_frame_t> stack_frames;
53 };
54 typedef s_mc_snapshot_stack_t* mc_snapshot_stack_t;
55 typedef const s_mc_snapshot_stack_t* const_mc_snapshot_stack_t;
56
57 namespace simgrid {
58 namespace mc {
59
60 class XBT_PRIVATE Snapshot final : public AddressSpace {
61 public:
62   Snapshot(int num_state, RemoteClient* process = &mc_model_checker->process());
63   ~Snapshot() = default;
64
65   /* Initialization */
66
67   /* Regular use */
68   void* read_bytes(void* buffer, std::size_t size, RemotePtr<void> address,
69                    ReadOptions options = ReadOptions::none()) const override;
70   Region* get_region(const void* addr) const;
71   Region* get_region(const void* addr, Region* hinted_region) const;
72   void restore(RemoteClient* process);
73
74   // To be private
75   int num_state_;
76   std::size_t heap_bytes_used_;
77   std::vector<std::unique_ptr<Region>> snapshot_regions_;
78   std::set<pid_t> enabled_processes_;
79   std::vector<std::size_t> stack_sizes_;
80   std::vector<s_mc_snapshot_stack_t> stacks_;
81   std::vector<simgrid::mc::IgnoredHeapRegion> to_ignore_;
82   std::uint64_t hash_ = 0;
83   std::vector<s_mc_snapshot_ignored_data_t> ignored_data_;
84
85 private:
86   void add_region(RegionType type, ObjectInformation* object_info, void* start_addr, std::size_t size);
87   void snapshot_regions(simgrid::mc::RemoteClient* process);
88   void snapshot_stacks(simgrid::mc::RemoteClient* process);
89 };
90 } // namespace mc
91 } // namespace simgrid
92
93 #endif