+/* Copyright (c) 2020-2022. The SimGrid Team. All rights reserved. */
+
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
+
#ifndef SIMGRID_MC_API_HPP
#define SIMGRID_MC_API_HPP
#include "simgrid/forward.h"
#include "src/mc/mc_forward.hpp"
-#include "src/mc/mc_request.hpp"
-#include "src/mc/mc_state.hpp"
#include "src/mc/mc_record.hpp"
+#include "src/mc/mc_state.hpp"
#include "xbt/automaton.hpp"
#include "xbt/base.h"
namespace simgrid {
namespace mc {
+XBT_DECLARE_ENUM_CLASS(CheckerAlgorithm, Safety, UDPOR, Liveness, CommDeterminism);
+
+/**
+ * @brief Maintains the transition's information.
+ */
+struct s_transition_detail {
+ simgrid::simix::Simcall call_ = simgrid::simix::Simcall::NONE;
+ long issuer_id = -1;
+ RemotePtr<kernel::activity::MailboxImpl> mbox_remote_addr {}; // used to represent mailbox remote address for isend and ireceive transitions
+ RemotePtr<kernel::activity::ActivityImpl> comm_remote_addr {}; // the communication this transition concerns (to be used only for isend, ireceive, wait and test)
+};
+
+using transition_detail_t = std::unique_ptr<s_transition_detail>;
+
/*
** This class aimes to implement FACADE APIs for simgrid. The FACADE layer sits between the CheckerSide
** (Unfolding_Checker, DPOR, ...) layer and the
}
};
-smx_mailbox_t get_mbox(smx_simcall_t const r) const;
-simgrid::kernel::activity::CommImpl* get_comm(smx_simcall_t const r) const;
-bool request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2) const;
+ simgrid::kernel::activity::CommImpl* get_comm_or_nullptr(smx_simcall_t const r) const;
+ bool request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2) const;
+ simgrid::mc::ActorInformation* actor_info_cast(smx_actor_t actor) const;
public:
+ std::string get_actor_string(smx_actor_t actor) const;
+ std::string get_actor_dot_label(smx_actor_t actor) const;
+
// No copy:
Api(Api const&) = delete;
void operator=(Api const&) = delete;
return api;
}
- void initialize(char** argv) const;
+ simgrid::mc::Checker* initialize(char** argv, simgrid::mc::CheckerAlgorithm algo) const;
- // ACTOR APIs
+ // ACTOR APIs
std::vector<simgrid::mc::ActorInformation>& get_actors() const;
- bool actor_is_enabled(aid_t pid) const;
unsigned long get_maxpid() const;
int get_actors_size() const;
// COMMUNICATION APIs
RemotePtr<kernel::activity::CommImpl> get_comm_isend_raw_addr(smx_simcall_t request) const;
- RemotePtr<kernel::activity::CommImpl> get_comm_irecv_raw_addr(smx_simcall_t request) const;
- RemotePtr<kernel::activity::CommImpl> get_comm_wait_raw_addr(smx_simcall_t request) const;
RemotePtr<kernel::activity::CommImpl> get_comm_waitany_raw_addr(smx_simcall_t request, int value) const;
std::string get_pattern_comm_rdv(RemotePtr<kernel::activity::CommImpl> const& addr) const;
unsigned long get_pattern_comm_src_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const;
unsigned long get_pattern_comm_dst_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const;
std::vector<char> get_pattern_comm_data(RemotePtr<kernel::activity::CommImpl> const& addr) const;
- const char* get_actor_host_name(smx_actor_t actor) const;
+ xbt::string const& get_actor_name(smx_actor_t actor) const;
+ xbt::string const& get_actor_host_name(smx_actor_t actor) const;
#if HAVE_SMPI
bool check_send_request_detached(smx_simcall_t const& simcall) const;
#endif
void mc_inc_executed_trans() const;
unsigned long mc_get_visited_states() const;
unsigned long mc_get_executed_trans() const;
- bool mc_check_deadlock() const;
- void mc_show_deadlock() const;
- bool mc_is_null() const;
- Checker* mc_get_checker() const;
- void set_checker(Checker* const checker) const;
+ void mc_check_deadlock() const;
void handle_simcall(Transition const& transition) const;
void mc_wait_for_requests() const;
XBT_ATTRIB_NORETURN void mc_exit(int status) const;
- std::string const& mc_get_host_name(std::string const& hostname) const;
void dump_record_path() const;
smx_simcall_t mc_state_choose_request(simgrid::mc::State* state) const;
+ // UDPOR APIs
+ std::list<transition_detail_t> get_enabled_transitions(simgrid::mc::State* state) const;
+
// SIMCALL APIs
- std::string request_to_string(smx_simcall_t req, int value, RequestType request_type) const;
+ std::string request_to_string(smx_simcall_t req, int value) const;
std::string request_get_dot_output(smx_simcall_t req, int value) const;
- const char *simcall_get_name(simgrid::simix::Simcall kind) const;
smx_actor_t simcall_get_issuer(s_smx_simcall const* req) const;
- long simcall_get_actor_id(s_smx_simcall const* req) const;
- smx_mailbox_t simcall_get_mbox(smx_simcall_t const req) const;
+ RemotePtr<kernel::activity::MailboxImpl> get_mbox_remote_addr(smx_simcall_t const req) const;
+ RemotePtr<kernel::activity::ActivityImpl> get_comm_remote_addr(smx_simcall_t const req) const;
bool simcall_check_dependency(smx_simcall_t const req1, smx_simcall_t const req2) const;
#if HAVE_SMPI
// STATE APIs
void restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const;
void log_state() const;
- void restore_initial_state() const;
// SNAPSHOT APIs
bool snapshot_equal(const Snapshot* s1, const Snapshot* s2) const;
simgrid::mc::Snapshot* take_snapshot(int num_state) const;
// SESSION APIs
- void session_initialize() const;
void s_close() const;
- void execute(Transition const& transition) const;
+ void execute(Transition& transition, smx_simcall_t simcall) const;
- // AUTOMATION APIs
- #if SIMGRID_HAVE_MC
- void automaton_load(const char *file) const;
- #endif
+// AUTOMATION APIs
+#if SIMGRID_HAVE_MC
+ void automaton_load(const char* file) const;
+#endif
std::vector<int> automaton_propositional_symbol_evaluate() const;
std::vector<xbt_automaton_state_t> get_automaton_state() const;
int compare_automaton_exp_label(const xbt_automaton_exp_label* l) const;
void set_property_automaton(xbt_automaton_state_t const& automaton_state) const;
- inline DerefAndCompareByActorsCountAndUsedHeap compare_pair() const {
+ inline DerefAndCompareByActorsCountAndUsedHeap compare_pair() const
+ {
return DerefAndCompareByActorsCountAndUsedHeap();
}
- inline int automaton_state_compare(const_xbt_automaton_state_t const& s1, const_xbt_automaton_state_t const& s2) const {
+ inline int automaton_state_compare(const_xbt_automaton_state_t const& s1, const_xbt_automaton_state_t const& s2) const
+ {
return xbt_automaton_state_compare(s1, s2);
}
xbt_automaton_exp_label_t get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const;
xbt_automaton_state_t get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const;
// DYNAR APIs
- inline unsigned long get_dynar_length(const_xbt_dynar_t const& dynar) const {
- return xbt_dynar_length(dynar);
- }
+ inline unsigned long get_dynar_length(const_xbt_dynar_t const& dynar) const { return xbt_dynar_length(dynar); }
};
} // namespace mc
