+/* 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 <vector>
#include "simgrid/forward.h"
+#include "src/mc/api/RemoteApp.hpp"
+#include "src/mc/api/State.hpp"
#include "src/mc/mc_forward.hpp"
#include "src/mc/mc_record.hpp"
-#include "src/mc/mc_request.hpp"
-#include "src/mc/mc_state.hpp"
#include "xbt/automaton.hpp"
#include "xbt/base.h"
-namespace simgrid {
-namespace mc {
-
-/**
- * @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)
-};
+namespace simgrid::mc {
-using transition_detail_t = std::unique_ptr<s_transition_detail>;
+XBT_DECLARE_ENUM_CLASS(ExplorationAlgorithm, Safety, UDPOR, Liveness, CommDeterminism);
/*
** This class aimes to implement FACADE APIs for simgrid. The FACADE layer sits between the CheckerSide
struct DerefAndCompareByActorsCountAndUsedHeap {
template <class X, class Y> bool operator()(X const& a, Y const& b) const
{
- return std::make_pair(a->actors_count, a->heap_bytes_used) < std::make_pair(b->actors_count, b->heap_bytes_used);
+ return std::make_pair(a->actor_count_, a->heap_bytes_used) < std::make_pair(b->actor_count_, b->heap_bytes_used);
}
};
- 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::mc::ActorInformation* actor_info_cast(smx_actor_t actor) const;
- const char* actor_get_host_name(smx_actor_t actor) const;
- const char* actor_get_name(smx_actor_t actor) const;
+ std::unique_ptr<simgrid::mc::RemoteApp> remote_app_;
public:
// No copy:
return api;
}
- void initialize(char** argv) const;
-
- // 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;
-#if HAVE_SMPI
- bool check_send_request_detached(smx_simcall_t const& simcall) const;
-#endif
- smx_actor_t get_src_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const;
- smx_actor_t get_dst_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const;
+ simgrid::mc::Exploration* initialize(char** argv, const std::unordered_map<std::string, std::string>& env,
+ simgrid::mc::ExplorationAlgorithm algo);
// REMOTE APIs
std::size_t get_remote_heap_bytes() const;
- // MODEL CHECKER APIs
- void mc_inc_visited_states() const;
- 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 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);
-
- // SIMCALL APIs
- std::string request_to_string(smx_simcall_t req, int value, RequestType request_type) 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;
- 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
- int get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const;
-#endif
-
// STATE APIs
- void restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const;
- void log_state() const;
- void restore_initial_state() const;
+ void restore_state(const Snapshot* system_state) const;
// SNAPSHOT APIs
bool snapshot_equal(const Snapshot* s1, const Snapshot* s2) const;
- simgrid::mc::Snapshot* take_snapshot(int num_state) const;
+ simgrid::mc::Snapshot* take_snapshot(long num_state) const;
- // SESSION APIs
- void session_initialize() const;
- void s_close() const;
- void execute(Transition& transition, smx_simcall_t simcall) const;
-
-// 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;
+ // AUTOMATION APIs
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
- {
- 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); }
};
-} // namespace mc
-} // namespace simgrid
+} // namespace simgrid::mc
#endif
