Start moving classes into the mc/api directory

[simgrid.git] / src / mc / api.hpp

diff --git a/src/mc/api.hpp b/src/mc/api.hpp
index 788cf40..ebdc965 100644 (file)
--- a/src/mc/api.hpp
+++ b/src/mc/api.hpp
@@ -1,3 +1,8 @@
+/* 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
 
@@ -5,16 +10,17 @@
 #include <vector>
 
 #include "simgrid/forward.h"
+#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 {
 
+XBT_DECLARE_ENUM_CLASS(CheckerAlgorithm, Safety, UDPOR, Liveness, CommDeterminism);
+
 /**
  * @brief Maintains the transition's information.
  */
@@ -46,13 +52,13 @@ private:
     }
   };
 
-  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;
 
 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;
@@ -63,23 +69,21 @@ public:
     return api;
   }
 
-  void initialize(char** argv) const;
+  simgrid::mc::Checker* initialize(char** argv, simgrid::mc::CheckerAlgorithm algo) 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;
+  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;
@@ -92,31 +96,15 @@ public:
 
   // 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;
+  void mc_check_deadlock() const;
   XBT_ATTRIB_NORETURN void mc_exit(int status) 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;
+  std::string request_get_dot_output(aid_t aid, int value) 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;
@@ -125,16 +113,13 @@ public:
   // 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& transition, smx_simcall_t simcall) const;
 
 // AUTOMATION APIs
 #if SIMGRID_HAVE_MC