src/mc/mc_api.hpp

   1 #ifndef SIMGRID_MC_API_HPP
   2 #define SIMGRID_MC_API_HPP
   3
   4 #include <memory>
   5 #include <vector>
   6
   7 #include "simgrid/forward.h"
   8 #include "src/mc/mc_forward.hpp"
   9 #include "src/mc/mc_request.hpp"
  10 #include "src/mc/mc_state.hpp"
  11 #include "src/mc/mc_record.hpp"
  12 #include "xbt/automaton.hpp"
  13 #include "xbt/base.h"
  14
  15 namespace simgrid {
  16 namespace mc {
  17
  18 /*
  19 ** This class aimes to implement FACADE APIs for simgrid. The FACADE layer sits between the CheckerSide
  20 ** (Unfolding_Checker, DPOR, ...) layer and the
  21 ** AppSide layer. The goal is to drill down into the entagled details in the CheckerSide layer and break down the
  22 ** detailes in a way that the CheckerSide eventually
  23 ** be capable to acquire the required information through the FACADE layer rather than the direct access to the AppSide.
  24 */
  25
  26 class mc_api {
  27 private:
  28   mc_api() = default;
  29
  30   struct DerefAndCompareByActorsCountAndUsedHeap {
  31     template <class X, class Y> bool operator()(X const& a, Y const& b) const
  32     {
  33       return std::make_pair(a->actors_count, a->heap_bytes_used) < std::make_pair(b->actors_count, b->heap_bytes_used);
  34     }
  35   };
  36
  37
  38 public:
  39   // No copy:
  40   mc_api(mc_api const&) = delete;
  41   void operator=(mc_api const&) = delete;
  42
  43   static mc_api& get()
  44   {
  45     static mc_api mcapi;
  46     return mcapi;
  47   }
  48
  49   void initialize(char** argv) const;
  50
  51   // ACTOR APIs
  52   std::vector<simgrid::mc::ActorInformation>& get_actors() const;
  53   bool actor_is_enabled(aid_t pid) const;
  54   unsigned long get_maxpid() const;
  55   int get_actors_size() const;
  56
  57   // COMMUNICATION APIs
  58   bool comm_addr_equal(const kernel::activity::CommImpl* comm_addr1, const kernel::activity::CommImpl* comm_addr2) const;
  59   kernel::activity::CommImpl* get_comm_isend_raw_addr(smx_simcall_t request) const;
  60   kernel::activity::CommImpl* get_comm_wait_raw_addr(smx_simcall_t request) const;
  61   kernel::activity::CommImpl* get_comm_waitany_raw_addr(smx_simcall_t request, int value) const;
  62   std::string get_pattern_comm_rdv(void* addr) const;
  63   unsigned long get_pattern_comm_src_proc(void* addr) const;
  64   unsigned long get_pattern_comm_dst_proc(void* addr) const;
  65   std::vector<char> get_pattern_comm_data(void* addr) const;
  66   std::vector<char> get_pattern_comm_data(const kernel::activity::CommImpl* comm_addr) const;
  67   const char* get_actor_host_name(smx_actor_t actor) const;
  68 #if HAVE_SMPI
  69   bool check_send_request_detached(smx_simcall_t const& simcall) const;
  70 #endif
  71   smx_actor_t get_src_actor(const kernel::activity::CommImpl* comm_addr) const;
  72   smx_actor_t get_dst_actor(const kernel::activity::CommImpl* comm_addr) const;
  73
  74   // REMOTE APIs
  75   std::size_t get_remote_heap_bytes() const;
  76
  77   // MODEL CHECKER APIs
  78   void mc_inc_visited_states() const;
  79   void mc_inc_executed_trans() const;
  80   unsigned long mc_get_visited_states() const;
  81   unsigned long mc_get_executed_trans() const;
  82   bool mc_check_deadlock() const;
  83   void mc_show_deadlock() const;
  84   bool mc_is_null() const;
  85   Checker* mc_get_checker() const;
  86   void set_checker(Checker* const checker) const;
  87   RemoteSimulation& mc_get_remote_simulation() const;
  88   void handle_simcall(Transition const& transition) const;
  89   void mc_wait_for_requests() const;
  90   XBT_ATTRIB_NORETURN void mc_exit(int status) const;
  91   std::string const& mc_get_host_name(std::string const& hostname) const;
  92   void dump_record_path() const;
  93   smx_simcall_t mc_state_choose_request(simgrid::mc::State* state) const;
  94
  95   // SIMCALL APIs
  96   bool request_depend(smx_simcall_t req1, smx_simcall_t req2) const;
  97   std::string request_to_string(smx_simcall_t req, int value, RequestType request_type) const;
  98   std::string request_get_dot_output(smx_simcall_t req, int value) const;
  99   const char *simcall_get_name(simgrid::simix::Simcall kind) const;
 100   smx_actor_t simcall_get_issuer(s_smx_simcall const* req) const;
 101 #if HAVE_SMPI
 102   int get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const;
 103 #endif
 104
 105   // STATE APIs
 106   void restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const;
 107   void log_state() const;
 108   void restore_initial_state() const;
 109
 110   // SNAPSHOT APIs
 111   bool snapshot_equal(const Snapshot* s1, const Snapshot* s2) const;
 112   simgrid::mc::Snapshot* take_snapshot(int num_state) const;
 113
 114   // SESSION APIs
 115   void session_initialize() const;
 116   void s_close() const;
 117   void execute(Transition const& transition) const;
 118
 119   // AUTOMATION APIs
 120   #if SIMGRID_HAVE_MC
 121   void automaton_load(const char *file) const;
 122   #endif
 123   std::vector<int> automaton_propositional_symbol_evaluate() const;
 124   std::vector<xbt_automaton_state_t> get_automaton_state() const;
 125   int compare_automaton_exp_label(const xbt_automaton_exp_label* l) const;
 126   void set_property_automaton(xbt_automaton_state_t const& automaton_state) const;
 127   inline DerefAndCompareByActorsCountAndUsedHeap compare_pair() const {
 128     return DerefAndCompareByActorsCountAndUsedHeap();
 129   }
 130   inline int automaton_state_compare(const_xbt_automaton_state_t const& s1, const_xbt_automaton_state_t const& s2) const {
 131     return xbt_automaton_state_compare(s1, s2);
 132   }
 133   xbt_automaton_exp_label_t get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const;
 134   xbt_automaton_state_t get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const;
 135
 136   // DYNAR APIs
 137   inline unsigned long get_dynar_length(const_xbt_dynar_t const& dynar) const {
 138     return xbt_dynar_length(dynar);
 139   }
 140 };
 141
 142 } // namespace mc
 143 } // namespace simgrid
 144
 145 #endif