1 /* Copyright (c) 2020-2022. 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/api/State.hpp"
14 #include "src/mc/mc_forward.hpp"
15 #include "src/mc/mc_record.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);
56 std::string get_actor_string(smx_actor_t actor) const;
57 std::string get_actor_dot_label(smx_actor_t actor) const;
60 Api(Api const&) = delete;
61 void operator=(Api const&) = delete;
69 simgrid::mc::Checker* initialize(char** argv, simgrid::mc::CheckerAlgorithm algo) const;
72 std::vector<simgrid::mc::ActorInformation>& get_actors() const;
73 unsigned long get_maxpid() const;
76 xbt::string const& get_actor_name(smx_actor_t actor) const;
77 xbt::string const& get_actor_host_name(smx_actor_t actor) const;
80 std::size_t get_remote_heap_bytes() const;
83 void mc_inc_visited_states() const;
84 unsigned long mc_get_visited_states() const;
85 XBT_ATTRIB_NORETURN void mc_exit(int status) const;
88 std::string request_get_dot_output(const Transition* t) const;
91 void restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const;
94 bool snapshot_equal(const Snapshot* s1, const Snapshot* s2) const;
95 simgrid::mc::Snapshot* take_snapshot(long num_state) const;
102 void automaton_load(const char* file) const;
104 std::vector<int> automaton_propositional_symbol_evaluate() const;
105 std::vector<xbt_automaton_state_t> get_automaton_state() const;
106 int compare_automaton_exp_label(const xbt_automaton_exp_label* l) const;
107 void set_property_automaton(xbt_automaton_state_t const& automaton_state) const;
108 inline DerefAndCompareByActorsCountAndUsedHeap compare_pair() const
110 return DerefAndCompareByActorsCountAndUsedHeap();
112 inline int automaton_state_compare(const_xbt_automaton_state_t const& s1, const_xbt_automaton_state_t const& s2) const
114 return xbt_automaton_state_compare(s1, s2);
116 xbt_automaton_exp_label_t get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const;
117 xbt_automaton_state_t get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const;
120 inline unsigned long get_dynar_length(const_xbt_dynar_t const& dynar) const { return xbt_dynar_length(dynar); }
124 } // namespace simgrid