Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
CommDet shall become an extension of the SafetyChecker
[simgrid.git] / src / mc / api.cpp
index b963b8e19c33eaf83640cd2eff1eb705ccbcc4a3..8bf2519c73eb27944fe079bf32a3d5fc91d0c8ec 100644 (file)
@@ -11,7 +11,6 @@
 #include "src/mc/Session.hpp"
 #include "src/mc/checker/Checker.hpp"
 #include "src/mc/mc_base.hpp"
-#include "src/mc/mc_comm_pattern.hpp"
 #include "src/mc/mc_exit.hpp"
 #include "src/mc/mc_pattern.hpp"
 #include "src/mc/mc_private.hpp"
@@ -34,131 +33,6 @@ using Simcall = simgrid::simix::Simcall;
 namespace simgrid {
 namespace mc {
 
-static inline const char* get_color(int id)
-{
-  static constexpr std::array<const char*, 13> colors{{"blue", "red", "green3", "goldenrod", "brown", "purple",
-                                                       "magenta", "turquoise4", "gray25", "forestgreen", "hotpink",
-                                                       "lightblue", "tan"}};
-  return colors[id % colors.size()];
-}
-
-static std::string pointer_to_string(void* pointer)
-{
-  return XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose) ? xbt::string_printf("%p", pointer) : "(verbose only)";
-}
-
-static std::string buff_size_to_string(size_t buff_size)
-{
-  return XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose) ? std::to_string(buff_size) : "(verbose only)";
-}
-
-static void simcall_translate(smx_simcall_t req, Remote<kernel::activity::CommImpl>& buffered_comm);
-
-/* Search an enabled transition for the given process.
- *
- * This can be seen as an iterator returning the next transition of the process.
- *
- * We only consider the processes that are both
- *  - marked "to be interleaved" in their ActorState (controlled by the checker algorithm).
- *  - which simcall can currently be executed (like a comm where the other partner is already known)
- * Once we returned the last enabled transition of a process, it is marked done.
- *
- * Things can get muddled with the WAITANY and TESTANY simcalls, that are rewritten on the fly to a bunch of WAIT
- * (resp TEST) transitions using the transition.argument field to remember what was the last returned sub-transition.
- */
-static inline smx_simcall_t MC_state_choose_request_for_process(const RemoteProcess& process, simgrid::mc::State* state,
-                                                                smx_actor_t actor)
-{
-  /* reset the outgoing transition */
-  simgrid::mc::ActorState* procstate = &state->actor_states_[actor->get_pid()];
-  state->transition_.aid_              = -1;
-  state->transition_.times_considered_ = -1;
-  state->transition_.textual[0]        = '\0';
-  state->executed_req_.call_         = Simcall::NONE;
-
-  if (not simgrid::mc::actor_is_enabled(actor))
-    return nullptr; // Not executable in the application
-
-  smx_simcall_t req = nullptr;
-  if (actor->simcall_.observer_ != nullptr) {
-    state->transition_.times_considered_ = procstate->get_times_considered_and_inc();
-    if (actor->simcall_.mc_max_consider_ <= procstate->get_times_considered())
-      procstate->set_done();
-    req = &actor->simcall_;
-  } else {
-    procstate->set_done();
-    state->transition_.times_considered_ = 0;
-    req                                  = &actor->simcall_;
-  }
-  if (not req)
-    return nullptr;
-
-  state->transition_.aid_ = actor->get_pid();
-  state->executed_req_    = *req;
-
-  // Fetch the data of the request and translate it:
-  state->internal_req_ = *req;
-  state->internal_req_.mc_value_ = state->transition_.times_considered_;
-  simcall_translate(&state->internal_req_, state->internal_comm_);
-
-  return req;
-}
-
-static void simcall_translate(smx_simcall_t req,
-                              simgrid::mc::Remote<simgrid::kernel::activity::CommImpl>& buffered_comm)
-{
-  simgrid::kernel::activity::CommImpl* chosen_comm;
-
-  /* The waitany and testany request are transformed into a wait or test request over the corresponding communication
-   * action so it can be treated later by the dependence function. */
-  switch (req->call_) {
-    case Simcall::COMM_WAITANY:
-      req->call_  = Simcall::COMM_WAIT;
-      chosen_comm =
-          mc_model_checker->get_remote_process().read(remote(simcall_comm_waitany__get__comms(req) + req->mc_value_));
-
-      mc_model_checker->get_remote_process().read(buffered_comm, remote(chosen_comm));
-      simcall_comm_wait__set__comm(req, buffered_comm.get_buffer());
-      simcall_comm_wait__set__timeout(req, 0);
-      break;
-
-    case Simcall::COMM_TESTANY:
-      req->call_  = Simcall::COMM_TEST;
-      chosen_comm =
-          mc_model_checker->get_remote_process().read(remote(simcall_comm_testany__get__comms(req) + req->mc_value_));
-
-      mc_model_checker->get_remote_process().read(buffered_comm, remote(chosen_comm));
-      simcall_comm_test__set__comm(req, buffered_comm.get_buffer());
-      simcall_comm_test__set__result(req, req->mc_value_);
-      break;
-
-    case Simcall::COMM_WAIT:
-      chosen_comm = simcall_comm_wait__get__comm(req);
-      mc_model_checker->get_remote_process().read(buffered_comm, remote(chosen_comm));
-      simcall_comm_wait__set__comm(req, buffered_comm.get_buffer());
-      break;
-
-    case Simcall::COMM_TEST:
-      chosen_comm = simcall_comm_test__get__comm(req);
-      mc_model_checker->get_remote_process().read(buffered_comm, remote(chosen_comm));
-      simcall_comm_test__set__comm(req, buffered_comm.get_buffer());
-      break;
-
-    default:
-      /* No translation needed */
-      break;
-  }
-}
-
-kernel::activity::CommImpl* Api::get_comm_or_nullptr(smx_simcall_t const r) const
-{
-  if (auto wait = dynamic_cast<kernel::actor::ActivityWaitSimcall*>(r->observer_))
-    return static_cast<kernel::activity::CommImpl*>(wait->get_activity());
-  if (auto test = dynamic_cast<kernel::actor::ActivityTestSimcall*>(r->observer_))
-    return static_cast<kernel::activity::CommImpl*>(test->get_activity());
-  return nullptr;
-}
-
 /** Statically "upcast" a s_smx_actor_t into an ActorInformation
  *
  *  This gets 'actorInfo' from '&actorInfo->copy'. It upcasts in the
@@ -174,78 +48,6 @@ simgrid::mc::ActorInformation* Api::actor_info_cast(smx_actor_t actor) const
   return process_info;
 }
 
-bool Api::simcall_check_dependency(smx_simcall_t req1, smx_simcall_t req2) const
-{
-  const auto IRECV = Simcall::COMM_IRECV;
-  const auto ISEND = Simcall::COMM_ISEND;
-  const auto TEST  = Simcall::COMM_TEST;
-  const auto WAIT  = Simcall::COMM_WAIT;
-
-  if (req1->issuer_ == req2->issuer_) // Done in observer for TEST and WAIT
-    return false;
-
-  /* The independence theorem only consider 4 simcalls. All others are dependent with anything. */
-  if (req1->call_ != ISEND && req1->call_ != IRECV && req1->call_ != TEST && req1->call_ != WAIT)
-    return true;
-  if (req2->call_ != ISEND && req2->call_ != IRECV && req2->call_ != TEST && req2->call_ != WAIT)
-    return true;
-
-  /* Make sure that req1 and req2 are in alphabetic order */
-  if (req1->call_ > req2->call_) {
-    auto temp = req1;
-    req1      = req2;
-    req2      = temp;
-  }
-
-  auto comm2 = get_comm_or_nullptr(req2);
-
-  /* First case: that's not the same kind of request (we also know that req1 < req2 alphabetically) */
-  if (req1->call_ != req2->call_) {
-    if (req1->call_ == IRECV && req2->call_ == ISEND)
-      return false;
-
-    if ((req1->call_ == IRECV || req1->call_ == ISEND) && req2->call_ == WAIT) {
-      auto mbox1 = get_mbox_remote_addr(req1);
-      auto mbox2 = remote(comm2->mbox_cpy);
-
-      if (mbox1 != mbox2 && simcall_comm_wait__get__timeout(req2) <= 0)
-        return false;
-
-      if ((req1->issuer_ != comm2->src_actor_.get()) && (req1->issuer_ != comm2->dst_actor_.get()) &&
-          simcall_comm_wait__get__timeout(req2) <= 0)
-        return false;
-
-      if ((req1->call_ == ISEND) && (comm2->type_ == kernel::activity::CommImpl::Type::SEND) &&
-          (comm2->src_buff_ != simcall_comm_isend__get__src_buff(req1)) && simcall_comm_wait__get__timeout(req2) <= 0)
-        return false;
-
-      if ((req1->call_ == IRECV) && (comm2->type_ == kernel::activity::CommImpl::Type::RECEIVE) &&
-          (comm2->dst_buff_ != simcall_comm_irecv__get__dst_buff(req1)) && simcall_comm_wait__get__timeout(req2) <= 0)
-        return false;
-    }
-
-    /* FIXME: the following rule assumes that the result of the isend/irecv call is not stored in a buffer used in the
-     * test call. */
-#if 0
-  if((req1->call == ISEND || req1->call == IRECV)
-      &&  req2->call == TEST)
-    return false;
-#endif
-
-    return true;
-  }
-
-  /* Second case: req1 and req2 are of the same call type */
-  switch (req1->call_) {
-    case ISEND:
-      return simcall_comm_isend__get__mbox(req1) == simcall_comm_isend__get__mbox(req2);
-    case IRECV:
-      return simcall_comm_irecv__get__mbox(req1) == simcall_comm_irecv__get__mbox(req2);
-    default:
-      return true;
-  }
-}
-
 xbt::string const& Api::get_actor_host_name(smx_actor_t actor) const
 {
   if (mc_model_checker == nullptr)
@@ -460,21 +262,11 @@ void Api::mc_inc_visited_states() const
   mc_model_checker->visited_states++;
 }
 
-void Api::mc_inc_executed_trans() const
-{
-  mc_model_checker->executed_transitions++;
-}
-
 unsigned long Api::mc_get_visited_states() const
 {
   return mc_model_checker->visited_states;
 }
 
-unsigned long Api::mc_get_executed_trans() const
-{
-  return mc_model_checker->executed_transitions;
-}
-
 void Api::mc_check_deadlock() const
 {
   if (mc_model_checker->checkDeadlock()) {
@@ -484,7 +276,7 @@ void Api::mc_check_deadlock() const
     XBT_CINFO(mc_global, "Counter-example execution trace:");
     for (auto const& s : mc_model_checker->getChecker()->get_textual_trace())
       XBT_CINFO(mc_global, "  %s", s.c_str());
-    simgrid::mc::dumpRecordPath();
+    XBT_INFO("Path = %s", mc_model_checker->getChecker()->get_record_trace().to_string().c_str());
     simgrid::mc::session_singleton->log_state();
     throw DeadlockError();
   }
@@ -535,97 +327,19 @@ RemotePtr<kernel::activity::ActivityImpl> Api::get_comm_remote_addr(smx_simcall_
   THROW_IMPOSSIBLE;
 }
 
-void Api::handle_simcall(Transition const& transition) const
-{
-  mc_model_checker->handle_simcall(transition);
-}
-
-void Api::mc_wait_for_requests() const
-{
-  mc_model_checker->wait_for_requests();
-}
-
 void Api::mc_exit(int status) const
 {
   mc_model_checker->exit(status);
 }
 
-void Api::dump_record_path() const
-{
-  simgrid::mc::dumpRecordPath();
-}
-
-smx_simcall_t Api::mc_state_choose_request(simgrid::mc::State* state) const
-{
-  RemoteProcess& process = mc_model_checker->get_remote_process();
-  for (auto& actor : process.actors()) {
-    /* Only consider the actors that were marked as interleaving by the checker algorithm */
-    if (not state->actor_states_[actor.copy.get_buffer()->get_pid()].is_todo())
-      continue;
-
-    smx_simcall_t res = MC_state_choose_request_for_process(process, state, actor.copy.get_buffer());
-    if (res)
-      return res;
-  }
-  return nullptr;
-}
-
-std::list<transition_detail_t> Api::get_enabled_transitions(simgrid::mc::State* state) const
-{
-  std::list<transition_detail_t> tr_list{};
-
-  for (auto& actor : mc_model_checker->get_remote_process().actors()) {
-    auto actor_pid  = actor.copy.get_buffer()->get_pid();
-    auto actor_impl = actor.copy.get_buffer();
-
-    // Only consider the actors that were marked as interleaving by the checker algorithm
-    if (not state->actor_states_[actor_pid].is_todo())
-      continue;
-    // Not executable in the application
-    if (not simgrid::mc::actor_is_enabled(actor_impl))
-      continue;
-
-    auto transition       = std::make_unique<s_transition_detail>();
-    Simcall simcall_call  = actor_impl->simcall_.call_;
-    smx_simcall_t simcall = &actor_impl->simcall_;
-    transition->call_     = simcall_call;
-    switch (simcall_call) {
-      case Simcall::COMM_ISEND:
-      case Simcall::COMM_IRECV:
-        transition->mbox_remote_addr = get_mbox_remote_addr(simcall);
-        transition->comm_remote_addr = get_comm_remote_addr(simcall);
-        break;
-
-      default:
-        break;
-    }
-    tr_list.emplace_back(std::move(transition));
-  }
-
-  return tr_list;
-}
-
-std::string Api::request_to_string(smx_simcall_t req, int value) const
+std::string Api::request_get_dot_output(const Transition* t) const
 {
-  xbt_assert(mc_model_checker != nullptr, "Must be called from MCer");
-
-  smx_actor_t issuer = simcall_get_issuer(req);
-
-  if (issuer->simcall_.observer_ != nullptr)
-    return mc_model_checker->simcall_to_string(issuer->get_pid(), value);
-  else
-    return "[" + get_actor_string(issuer) + "] " + SIMIX_simcall_name(*req) + "(unknown?)";
-}
+  static constexpr std::array<const char*, 13> colors{{"blue", "red", "green3", "goldenrod", "brown", "purple",
+                                                       "magenta", "turquoise4", "gray25", "forestgreen", "hotpink",
+                                                       "lightblue", "tan"}};
+  const char* color = colors[(t->aid_ - 1) % colors.size()];
 
-std::string Api::request_get_dot_output(smx_simcall_t req, int value) const
-{
-  if (req->observer_ != nullptr) {
-    const smx_actor_t issuer = simcall_get_issuer(req);
-    const char* color        = get_color(issuer->get_pid() - 1);
-    return "label = \"" + mc_model_checker->simcall_dot_label(issuer->get_pid(), value) + "\", color = " + color +
-           ", fontcolor = " + color;
-  } else
-    return "UNIMPLEMENTED";
+  return "label = \"" + t->dot_label() + "\", color = " + color + ", fontcolor = " + color;
 }
 
 #if HAVE_SMPI
@@ -657,7 +371,7 @@ bool Api::snapshot_equal(const Snapshot* s1, const Snapshot* s2) const
   return simgrid::mc::snapshot_equal(s1, s2);
 }
 
-simgrid::mc::Snapshot* Api::take_snapshot(int num_state) const
+simgrid::mc::Snapshot* Api::take_snapshot(long num_state) const
 {
   auto snapshot = new simgrid::mc::Snapshot(num_state);
   return snapshot;
@@ -668,16 +382,12 @@ void Api::s_close() const
   session_singleton->close();
 }
 
-void Api::execute(Transition& transition, smx_simcall_t simcall) const
-{
-  /* FIXME: once all simcalls have observers, kill the simcall parameter and use mc_model_checker->simcall_to_string() */
-  transition.textual = request_to_string(simcall, transition.times_considered_);
-  session_singleton->execute(transition);
-}
-
 void Api::automaton_load(const char* file) const
 {
-  MC_automaton_load(file);
+  if (simgrid::mc::property_automaton == nullptr)
+    simgrid::mc::property_automaton = xbt_automaton_new();
+
+  xbt_automaton_load(simgrid::mc::property_automaton, file);
 }
 
 std::vector<int> Api::automaton_propositional_symbol_evaluate() const