1 /* Copyright (c) 2020-2021. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_MC_API_HPP
7 #define SIMGRID_MC_API_HPP
12 #include "simgrid/forward.h"
13 #include "src/mc/mc_forward.hpp"
14 #include "src/mc/mc_record.hpp"
15 #include "src/mc/mc_state.hpp"
16 #include "xbt/automaton.hpp"
22 XBT_DECLARE_ENUM_CLASS(CheckerAlgorithm, Safety, UDPOR, Liveness, CommDeterminism);
25 * @brief Maintains the transition's information.
27 struct s_transition_detail {
28 simgrid::simix::Simcall call_ = simgrid::simix::Simcall::NONE;
30 RemotePtr<kernel::activity::MailboxImpl> mbox_remote_addr {}; // used to represent mailbox remote address for isend and ireceive transitions
31 RemotePtr<kernel::activity::ActivityImpl> comm_remote_addr {}; // the communication this transition concerns (to be used only for isend, ireceive, wait and test)
34 using transition_detail_t = std::unique_ptr<s_transition_detail>;
37 ** This class aimes to implement FACADE APIs for simgrid. The FACADE layer sits between the CheckerSide
38 ** (Unfolding_Checker, DPOR, ...) layer and the
39 ** AppSide layer. The goal is to drill down into the entagled details in the CheckerSide layer and break down the
40 ** detailes in a way that the CheckerSide eventually
41 ** be capable to acquire the required information through the FACADE layer rather than the direct access to the AppSide.
48 struct DerefAndCompareByActorsCountAndUsedHeap {
49 template <class X, class Y> bool operator()(X const& a, Y const& b) const
51 return std::make_pair(a->actors_count, a->heap_bytes_used) < std::make_pair(b->actors_count, b->heap_bytes_used);
55 simgrid::kernel::activity::CommImpl* get_comm_or_nullptr(smx_simcall_t const r) const;
56 bool request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2) const;
57 simgrid::mc::ActorInformation* actor_info_cast(smx_actor_t actor) const;
58 std::string get_actor_string(smx_actor_t actor) const;
59 std::string get_actor_dot_label(smx_actor_t actor) const;
63 Api(Api const&) = delete;
64 void operator=(Api const&) = delete;
72 simgrid::mc::Checker* initialize(char** argv, simgrid::mc::CheckerAlgorithm algo) const;
75 std::vector<simgrid::mc::ActorInformation>& get_actors() const;
76 unsigned long get_maxpid() const;
77 int get_actors_size() const;
80 RemotePtr<kernel::activity::CommImpl> get_comm_isend_raw_addr(smx_simcall_t request) const;
81 RemotePtr<kernel::activity::CommImpl> get_comm_waitany_raw_addr(smx_simcall_t request, int value) const;
82 std::string get_pattern_comm_rdv(RemotePtr<kernel::activity::CommImpl> const& addr) const;
83 unsigned long get_pattern_comm_src_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const;
84 unsigned long get_pattern_comm_dst_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const;
85 std::vector<char> get_pattern_comm_data(RemotePtr<kernel::activity::CommImpl> const& addr) const;
86 xbt::string const& get_actor_name(smx_actor_t actor) const;
87 xbt::string const& get_actor_host_name(smx_actor_t actor) const;
89 bool check_send_request_detached(smx_simcall_t const& simcall) const;
91 smx_actor_t get_src_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const;
92 smx_actor_t get_dst_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const;
95 std::size_t get_remote_heap_bytes() const;
98 void mc_inc_visited_states() const;
99 void mc_inc_executed_trans() const;
100 unsigned long mc_get_visited_states() const;
101 unsigned long mc_get_executed_trans() const;
102 void mc_check_deadlock() const;
103 void handle_simcall(Transition const& transition) const;
104 void mc_wait_for_requests() const;
105 XBT_ATTRIB_NORETURN void mc_exit(int status) const;
106 void dump_record_path() const;
107 smx_simcall_t mc_state_choose_request(simgrid::mc::State* state) const;
110 std::list<transition_detail_t> get_enabled_transitions(simgrid::mc::State* state) const;
113 std::string request_to_string(smx_simcall_t req, int value) const;
114 std::string request_get_dot_output(smx_simcall_t req, int value) const;
115 smx_actor_t simcall_get_issuer(s_smx_simcall const* req) const;
116 RemotePtr<kernel::activity::MailboxImpl> get_mbox_remote_addr(smx_simcall_t const req) const;
117 RemotePtr<kernel::activity::ActivityImpl> get_comm_remote_addr(smx_simcall_t const req) const;
118 bool simcall_check_dependency(smx_simcall_t const req1, smx_simcall_t const req2) const;
121 int get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const;
125 void restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const;
126 void log_state() const;
129 bool snapshot_equal(const Snapshot* s1, const Snapshot* s2) const;
130 simgrid::mc::Snapshot* take_snapshot(int num_state) const;
133 void s_close() const;
134 void execute(Transition& transition, smx_simcall_t simcall) const;
138 void automaton_load(const char* file) const;
140 std::vector<int> automaton_propositional_symbol_evaluate() const;
141 std::vector<xbt_automaton_state_t> get_automaton_state() const;
142 int compare_automaton_exp_label(const xbt_automaton_exp_label* l) const;
143 void set_property_automaton(xbt_automaton_state_t const& automaton_state) const;
144 inline DerefAndCompareByActorsCountAndUsedHeap compare_pair() const
146 return DerefAndCompareByActorsCountAndUsedHeap();
148 inline int automaton_state_compare(const_xbt_automaton_state_t const& s1, const_xbt_automaton_state_t const& s2) const
150 return xbt_automaton_state_compare(s1, s2);
152 xbt_automaton_exp_label_t get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const;
153 xbt_automaton_state_t get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const;
156 inline unsigned long get_dynar_length(const_xbt_dynar_t const& dynar) const { return xbt_dynar_length(dynar); }
160 } // namespace simgrid