src/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_record.hpp"
  10 #include "src/mc/mc_request.hpp"
  11 #include "src/mc/mc_state.hpp"
  12 #include "xbt/automaton.hpp"
  13 #include "xbt/base.h"
  14
  15 namespace simgrid {
  16 namespace mc {
  17
  18 /**
  19  * @brief Maintains the transition's information.
  20  */
  21 struct s_udpor_transition {
  22   simgrid::simix::Simcall call_ = simgrid::simix::Simcall::NONE;
  23   long issuer_id                = -1;
  24   RemotePtr<kernel::activity::MailboxImpl> mbox_remote_addr {}; // used to represent mailbox remote address for isend and ireceive transitions
  25   RemotePtr<kernel::activity::ActivityImpl> comm_remote_addr {}; // the communication this transition concerns (to be used only for isend, ireceive, wait and test)
  26 };
  27
  28 typedef std::unique_ptr<s_udpor_transition> udpor_transition_t;
  29
  30 /*
  31 ** This class aimes to implement FACADE APIs for simgrid. The FACADE layer sits between the CheckerSide
  32 ** (Unfolding_Checker, DPOR, ...) layer and the
  33 ** AppSide layer. The goal is to drill down into the entagled details in the CheckerSide layer and break down the
  34 ** detailes in a way that the CheckerSide eventually
  35 ** be capable to acquire the required information through the FACADE layer rather than the direct access to the AppSide.
  36 */
  37
  38 class Api {
  39 private:
  40   Api() = default;
  41
  42   struct DerefAndCompareByActorsCountAndUsedHeap {
  43     template <class X, class Y> bool operator()(X const& a, Y const& b) const
  44     {
  45       return std::make_pair(a->actors_count, a->heap_bytes_used) < std::make_pair(b->actors_count, b->heap_bytes_used);
  46     }
  47   };
  48
  49   simgrid::kernel::activity::CommImpl* get_comm(smx_simcall_t const r) const;
  50   bool request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2) const;
  51   simgrid::mc::ActorInformation* actor_info_cast(smx_actor_t actor) const;
  52   const char* actor_get_host_name(smx_actor_t actor) const;
  53
  54 public:
  55   // No copy:
  56   Api(Api const&) = delete;
  57   void operator=(Api const&) = delete;
  58
  59   static Api& get()
  60   {
  61     static Api api;
  62     return api;
  63   }
  64
  65   void initialize(char** argv) const;
  66
  67   // ACTOR APIs
  68   std::vector<simgrid::mc::ActorInformation>& get_actors() const;
  69   bool actor_is_enabled(aid_t pid) const;
  70   unsigned long get_maxpid() const;
  71   int get_actors_size() const;
  72
  73   // COMMUNICATION APIs
  74   RemotePtr<kernel::activity::CommImpl> get_comm_isend_raw_addr(smx_simcall_t request) const;
  75   RemotePtr<kernel::activity::CommImpl> get_comm_irecv_raw_addr(smx_simcall_t request) const;
  76   RemotePtr<kernel::activity::CommImpl> get_comm_wait_raw_addr(smx_simcall_t request) const;
  77   RemotePtr<kernel::activity::CommImpl> get_comm_waitany_raw_addr(smx_simcall_t request, int value) const;
  78   std::string get_pattern_comm_rdv(RemotePtr<kernel::activity::CommImpl> const& addr) const;
  79   unsigned long get_pattern_comm_src_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const;
  80   unsigned long get_pattern_comm_dst_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const;
  81   std::vector<char> get_pattern_comm_data(RemotePtr<kernel::activity::CommImpl> const& addr) const;
  82   const char* get_actor_host_name(smx_actor_t actor) const;
  83 #if HAVE_SMPI
  84   bool check_send_request_detached(smx_simcall_t const& simcall) const;
  85 #endif
  86   smx_actor_t get_src_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const;
  87   smx_actor_t get_dst_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const;
  88
  89   // REMOTE APIs
  90   std::size_t get_remote_heap_bytes() const;
  91
  92   // MODEL CHECKER APIs
  93   void mc_inc_visited_states() const;
  94   void mc_inc_executed_trans() const;
  95   unsigned long mc_get_visited_states() const;
  96   unsigned long mc_get_executed_trans() const;
  97   bool mc_check_deadlock() const;
  98   void mc_show_deadlock() const;
  99   bool mc_is_null() const;
 100   Checker* mc_get_checker() const;
 101   void set_checker(Checker* const checker) const;
 102   void handle_simcall(Transition const& transition) const;
 103   void mc_wait_for_requests() const;
 104   XBT_ATTRIB_NORETURN void mc_exit(int status) const;
 105   std::string const& mc_get_host_name(std::string const& hostname) const;
 106   void dump_record_path() const;
 107   smx_simcall_t mc_state_choose_request(simgrid::mc::State* state) const;
 108
 109   // UDPOR APIs
 110   std::list<udpor_transition_t> get_enabled_transitions(simgrid::mc::State* state);
 111
 112   // SIMCALL APIs
 113   std::string request_to_string(smx_simcall_t req, int value, RequestType request_type) const;
 114   std::string request_get_dot_output(smx_simcall_t req, int value) const;
 115   const char* simcall_get_name(simgrid::simix::Simcall kind) const;
 116   smx_actor_t simcall_get_issuer(s_smx_simcall const* req) const;
 117   long simcall_get_actor_id(s_smx_simcall const* req) const;
 118   RemotePtr<kernel::activity::MailboxImpl> get_mbox_remote_addr(smx_simcall_t const req) const;
 119   RemotePtr<kernel::activity::ActivityImpl> get_comm_remote_addr(smx_simcall_t const req) const;
 120   bool simcall_check_dependency(smx_simcall_t const req1, smx_simcall_t const req2) const;
 121
 122 #if HAVE_SMPI
 123   int get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const;
 124 #endif
 125
 126   // STATE APIs
 127   void restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const;
 128   void log_state() const;
 129   void restore_initial_state() const;
 130
 131   // SNAPSHOT APIs
 132   bool snapshot_equal(const Snapshot* s1, const Snapshot* s2) const;
 133   simgrid::mc::Snapshot* take_snapshot(int num_state) const;
 134
 135   // SESSION APIs
 136   void session_initialize() const;
 137   void s_close() const;
 138   void execute(Transition const& transition) const;
 139
 140 // AUTOMATION APIs
 141 #if SIMGRID_HAVE_MC
 142   void automaton_load(const char* file) const;
 143 #endif
 144   std::vector<int> automaton_propositional_symbol_evaluate() const;
 145   std::vector<xbt_automaton_state_t> get_automaton_state() const;
 146   int compare_automaton_exp_label(const xbt_automaton_exp_label* l) const;
 147   void set_property_automaton(xbt_automaton_state_t const& automaton_state) const;
 148   inline DerefAndCompareByActorsCountAndUsedHeap compare_pair() const
 149   {
 150     return DerefAndCompareByActorsCountAndUsedHeap();
 151   }
 152   inline int automaton_state_compare(const_xbt_automaton_state_t const& s1, const_xbt_automaton_state_t const& s2) const
 153   {
 154     return xbt_automaton_state_compare(s1, s2);
 155   }
 156   xbt_automaton_exp_label_t get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const;
 157   xbt_automaton_state_t get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const;
 158
 159   // DYNAR APIs
 160   inline unsigned long get_dynar_length(const_xbt_dynar_t const& dynar) const { return xbt_dynar_length(dynar); }
 161 };
 162
 163 } // namespace mc
 164 } // namespace simgrid
 165
 166 #endif