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