src/mc/api.cpp

   1 #include "api.hpp"
   2
   3 #include "src/kernel/activity/MailboxImpl.hpp"
   4 #include "src/kernel/activity/MutexImpl.hpp"
   5 #include "src/mc/Session.hpp"
   6 #include "src/mc/checker/SimcallObserver.hpp"
   7 #include "src/mc/mc_comm_pattern.hpp"
   8 #include "src/mc/mc_exit.hpp"
   9 #include "src/mc/mc_pattern.hpp"
  10 #include "src/mc/mc_private.hpp"
  11 #include "src/mc/remote/RemoteSimulation.hpp"
  12
  13 #include <xbt/asserts.h>
  14 #include <xbt/log.h>
  15 #include "simgrid/s4u/Host.hpp"
  16 #include "xbt/string.hpp"
  17 #if HAVE_SMPI
  18 #include "src/smpi/include/smpi_request.hpp"
  19 #endif
  20
  21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(Api, mc, "Logging specific to MC Facade APIs ");
  22
  23 using Simcall = simgrid::simix::Simcall;
  24
  25 namespace simgrid {
  26 namespace mc {
  27
  28 static inline const char* get_color(int id)
  29 {
  30   static constexpr std::array<const char*, 13> colors{{"blue", "red", "green3", "goldenrod", "brown", "purple",
  31                                                        "magenta", "turquoise4", "gray25", "forestgreen", "hotpink",
  32                                                        "lightblue", "tan"}};
  33   return colors[id % colors.size()];
  34 }
  35
  36 static std::string pointer_to_string(void* pointer)
  37 {
  38   return XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose) ? xbt::string_printf("%p", pointer) : "(verbose only)";
  39 }
  40
  41 static std::string buff_size_to_string(size_t buff_size)
  42 {
  43   return XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose) ? std::to_string(buff_size) : "(verbose only)";
  44 }
  45
  46 static void simcall_translate(smx_simcall_t req,
  47                               simgrid::mc::Remote<simgrid::kernel::activity::CommImpl>& buffered_comm);
  48
  49 /* Search an enabled transition for the given process.
  50  *
  51  * This can be seen as an iterator returning the next transition of the process.
  52  *
  53  * We only consider the processes that are both
  54  *  - marked "to be interleaved" in their ActorState (controlled by the checker algorithm).
  55  *  - which simcall can currently be executed (like a comm where the other partner is already known)
  56  * Once we returned the last enabled transition of a process, it is marked done.
  57  *
  58  * Things can get muddled with the WAITANY and TESTANY simcalls, that are rewritten on the fly to a bunch of WAIT
  59  * (resp TEST) transitions using the transition.argument field to remember what was the last returned sub-transition.
  60  */
  61 static inline smx_simcall_t MC_state_choose_request_for_process(simgrid::mc::State* state, smx_actor_t actor)
  62 {
  63   /* reset the outgoing transition */
  64   simgrid::mc::ActorState* procstate = &state->actor_states_[actor->get_pid()];
  65   state->transition_.pid_            = -1;
  66   state->transition_.times_considered_ = -1;
  67   state->transition_.textual[0]        = '\0';
  68   state->executed_req_.call_         = Simcall::NONE;
  69
  70   if (not simgrid::mc::actor_is_enabled(actor))
  71     return nullptr; // Not executable in the application
  72
  73   smx_simcall_t req = nullptr;
  74   if (actor->simcall_.observer_ != nullptr) {
  75     state->transition_.times_considered_ = procstate->times_considered;
  76     procstate->times_considered++;
  77     if (actor->simcall_.mc_max_consider_ <= procstate->times_considered)
  78       procstate->set_done();
  79     req = &actor->simcall_;
  80   } else
  81     switch (actor->simcall_.call_) {
  82       case Simcall::COMM_WAITANY:
  83         state->transition_.times_considered_ = -1;
  84         while (procstate->times_considered < simcall_comm_waitany__get__count(&actor->simcall_)) {
  85           if (simgrid::mc::request_is_enabled_by_idx(&actor->simcall_, procstate->times_considered)) {
  86             state->transition_.times_considered_ = procstate->times_considered;
  87             ++procstate->times_considered;
  88             break;
  89           }
  90           ++procstate->times_considered;
  91         }
  92
  93         if (procstate->times_considered >= simcall_comm_waitany__get__count(&actor->simcall_))
  94           procstate->set_done();
  95         if (state->transition_.times_considered_ != -1)
  96           req = &actor->simcall_;
  97         break;
  98
  99       case Simcall::COMM_TESTANY:
 100         state->transition_.times_considered_ = -1;
 101         while (procstate->times_considered < simcall_comm_testany__get__count(&actor->simcall_)) {
 102           if (simgrid::mc::request_is_enabled_by_idx(&actor->simcall_, procstate->times_considered)) {
 103             state->transition_.times_considered_ = procstate->times_considered;
 104             ++procstate->times_considered;
 105             break;
 106           }
 107           ++procstate->times_considered;
 108         }
 109
 110         if (procstate->times_considered >= simcall_comm_testany__get__count(&actor->simcall_))
 111           procstate->set_done();
 112         if (state->transition_.times_considered_ != -1)
 113           req = &actor->simcall_;
 114         break;
 115
 116       case Simcall::COMM_WAIT: {
 117         simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> remote_act =
 118             remote(simcall_comm_wait__getraw__comm(&actor->simcall_));
 119         simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_act;
 120         mc_model_checker->get_remote_simulation().read(temp_act, remote_act);
 121         const simgrid::kernel::activity::CommImpl* act = temp_act.get_buffer();
 122         if (act->src_actor_.get() && act->dst_actor_.get())
 123           state->transition_.times_considered_ = 0; // OK
 124         else if (act->src_actor_.get() == nullptr && act->state_ == simgrid::kernel::activity::State::READY &&
 125                  act->detached())
 126           state->transition_.times_considered_ = 0; // OK
 127         else
 128           state->transition_.times_considered_ = -1; // timeout
 129         procstate->set_done();
 130         req = &actor->simcall_;
 131         break;
 132       }
 133
 134       default:
 135         procstate->set_done();
 136         state->transition_.times_considered_ = 0;
 137         req                                  = &actor->simcall_;
 138         break;
 139     }
 140   if (not req)
 141     return nullptr;
 142
 143   state->transition_.pid_ = actor->get_pid();
 144   state->executed_req_    = *req;
 145
 146   // Fetch the data of the request and translate it:
 147   state->internal_req_ = *req;
 148   state->internal_req_.mc_value_ = state->transition_.times_considered_;
 149   simcall_translate(&state->internal_req_, state->internal_comm_);
 150
 151   return req;
 152 }
 153
 154 static void simcall_translate(smx_simcall_t req,
 155                               simgrid::mc::Remote<simgrid::kernel::activity::CommImpl>& buffered_comm)
 156 {
 157   simgrid::kernel::activity::CommImpl* chosen_comm;
 158
 159   /* The waitany and testany request are transformed into a wait or test request over the corresponding communication
 160    * action so it can be treated later by the dependence function. */
 161   switch (req->call_) {
 162     case Simcall::COMM_WAITANY:
 163       req->call_  = Simcall::COMM_WAIT;
 164       chosen_comm = mc_model_checker->get_remote_simulation().read(
 165           remote(simcall_comm_waitany__get__comms(req) + req->mc_value_));
 166
 167       mc_model_checker->get_remote_simulation().read(buffered_comm, remote(chosen_comm));
 168       simcall_comm_wait__set__comm(req, buffered_comm.get_buffer());
 169       simcall_comm_wait__set__timeout(req, 0);
 170       break;
 171
 172     case Simcall::COMM_TESTANY:
 173       req->call_  = Simcall::COMM_TEST;
 174       chosen_comm = mc_model_checker->get_remote_simulation().read(
 175           remote(simcall_comm_testany__get__comms(req) + req->mc_value_));
 176
 177       mc_model_checker->get_remote_simulation().read(buffered_comm, remote(chosen_comm));
 178       simcall_comm_test__set__comm(req, buffered_comm.get_buffer());
 179       simcall_comm_test__set__result(req, req->mc_value_);
 180       break;
 181
 182     case Simcall::COMM_WAIT:
 183       chosen_comm = simcall_comm_wait__getraw__comm(req);
 184       mc_model_checker->get_remote_simulation().read(buffered_comm, remote(chosen_comm));
 185       simcall_comm_wait__set__comm(req, buffered_comm.get_buffer());
 186       break;
 187
 188     case Simcall::COMM_TEST:
 189       chosen_comm = simcall_comm_test__getraw__comm(req);
 190       mc_model_checker->get_remote_simulation().read(buffered_comm, remote(chosen_comm));
 191       simcall_comm_test__set__comm(req, buffered_comm.get_buffer());
 192       break;
 193
 194     default:
 195       /* No translation needed */
 196       break;
 197   }
 198 }
 199
 200 simgrid::kernel::activity::CommImpl* Api::get_comm_or_nullptr(smx_simcall_t const r) const
 201 {
 202   if (r->call_ == Simcall::COMM_WAIT)
 203     return simcall_comm_wait__getraw__comm(r);
 204   if (r->call_ == Simcall::COMM_TEST)
 205     return simcall_comm_test__getraw__comm(r);
 206   return nullptr;
 207 }
 208
 209 /** Statically "upcast" a s_smx_actor_t into an ActorInformation
 210  *
 211  *  This gets 'actorInfo' from '&actorInfo->copy'. It upcasts in the
 212  *  sense that we could achieve the same thing by having ActorInformation
 213  *  inherit from s_smx_actor_t but we don't really want to do that.
 214  */
 215 simgrid::mc::ActorInformation* Api::actor_info_cast(smx_actor_t actor) const
 216 {
 217   simgrid::mc::ActorInformation temp;
 218   std::size_t offset = (char*)temp.copy.get_buffer() - (char*)&temp;
 219
 220   auto* process_info = reinterpret_cast<simgrid::mc::ActorInformation*>((char*)actor - offset);
 221   return process_info;
 222 }
 223
 224 // Does half the job
 225 bool Api::request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2) const
 226 {
 227   if (r1->call_ == Simcall::COMM_IRECV && r2->call_ == Simcall::COMM_ISEND)
 228     return false;
 229
 230   // Those are internal requests, we do not need indirection because those objects are copies:
 231   auto comm1 = get_comm_or_nullptr(r1);
 232   auto comm2 = get_comm_or_nullptr(r2);
 233
 234   if ((r1->call_ == Simcall::COMM_ISEND || r1->call_ == Simcall::COMM_IRECV) && r2->call_ == Simcall::COMM_WAIT) {
 235     auto mbox1 = get_mbox_remote_addr(r1);
 236     auto mbox2 = remote(comm2->mbox_cpy);
 237
 238     if (mbox1 != mbox2 && simcall_comm_wait__get__timeout(r2) <= 0)
 239       return false;
 240
 241     if ((r1->issuer_ != comm2->src_actor_.get()) && (r1->issuer_ != comm2->dst_actor_.get()) &&
 242         simcall_comm_wait__get__timeout(r2) <= 0)
 243       return false;
 244
 245     if ((r1->call_ == Simcall::COMM_ISEND) && (comm2->type_ == kernel::activity::CommImpl::Type::SEND) &&
 246         (comm2->src_buff_ != simcall_comm_isend__get__src_buff(r1)) && simcall_comm_wait__get__timeout(r2) <= 0)
 247       return false;
 248
 249     if ((r1->call_ == Simcall::COMM_IRECV) && (comm2->type_ == kernel::activity::CommImpl::Type::RECEIVE) &&
 250         (comm2->dst_buff_ != simcall_comm_irecv__get__dst_buff(r1)) && simcall_comm_wait__get__timeout(r2) <= 0)
 251       return false;
 252   }
 253
 254   /* FIXME: the following rule assumes that the result of the isend/irecv call is not stored in a buffer used in the
 255    * test call. */
 256 #if 0
 257   if((r1->call == Simcall::COMM_ISEND || r1->call == Simcall::COMM_IRECV)
 258       &&  r2->call == Simcall::COMM_TEST)
 259     return false;
 260 #endif
 261
 262   if (r1->call_ == Simcall::COMM_TEST && r2->call_ == Simcall::COMM_WAIT &&
 263       (comm1->src_actor_.get() == nullptr || comm1->dst_actor_.get() == nullptr))
 264     return false;
 265
 266   if (r1->call_ == Simcall::COMM_TEST &&
 267       (simcall_comm_test__get__comm(r1) == nullptr || comm1->src_buff_ == nullptr || comm1->dst_buff_ == nullptr))
 268     return false;
 269
 270   if (r1->call_ == Simcall::COMM_TEST && r2->call_ == Simcall::COMM_WAIT && comm1->src_buff_ == comm2->src_buff_ &&
 271       comm1->dst_buff_ == comm2->dst_buff_)
 272     return false;
 273
 274   if (r1->call_ == Simcall::COMM_TEST && r2->call_ == Simcall::COMM_WAIT && comm1->src_buff_ != nullptr &&
 275       comm1->dst_buff_ != nullptr && comm2->src_buff_ != nullptr && comm2->dst_buff_ != nullptr &&
 276       comm1->dst_buff_ != comm2->src_buff_ && comm1->dst_buff_ != comm2->dst_buff_ &&
 277       comm2->dst_buff_ != comm1->src_buff_)
 278     return false;
 279
 280   return true;
 281 }
 282
 283 bool Api::simcall_check_dependency(smx_simcall_t req1, smx_simcall_t req2) const
 284 {
 285   const auto ISEND = Simcall::COMM_ISEND;
 286   const auto IRECV = Simcall::COMM_IRECV;
 287   const auto TEST  = Simcall::COMM_TEST;
 288   const auto WAIT  = Simcall::COMM_WAIT;
 289
 290   if (req1->issuer_ == req2->issuer_)
 291     return false;
 292
 293   /* The independence theorem only consider 4 simcalls. All others are dependent with anything. */
 294   if (req1->call_ != ISEND && req1->call_ != IRECV && req1->call_ != TEST && req1->call_ != WAIT)
 295     return true;
 296   if (req2->call_ != ISEND && req2->call_ != IRECV && req2->call_ != TEST && req2->call_ != WAIT)
 297     return true;
 298
 299   /* Timeouts in wait transitions are not considered by the independence theorem, thus assumed dependent */
 300   if ((req1->call_ == WAIT && simcall_comm_wait__get__timeout(req1) > 0) ||
 301       (req2->call_ == WAIT && simcall_comm_wait__get__timeout(req2) > 0))
 302     return true;
 303
 304   if (req1->call_ < req2->call_) {
 305     auto temp = req1;
 306     req1 = req2;
 307     req2 = temp;
 308   }
 309   if (req1->call_ != req2->call_)
 310     return request_depend_asymmetric(req1, req2) && request_depend_asymmetric(req2, req1);
 311
 312   // Those are internal requests, we do not need indirection because those objects are copies:
 313   const auto comm1 = get_comm_or_nullptr(req1);
 314   const auto comm2 = get_comm_or_nullptr(req2);
 315
 316   switch (req1->call_) {
 317     case Simcall::COMM_ISEND:
 318       return simcall_comm_isend__get__mbox(req1) == simcall_comm_isend__get__mbox(req2);
 319     case Simcall::COMM_IRECV:
 320       return simcall_comm_irecv__get__mbox(req1) == simcall_comm_irecv__get__mbox(req2);
 321     case Simcall::COMM_WAIT:
 322       if (comm1->src_buff_ == comm2->src_buff_ && comm1->dst_buff_ == comm2->dst_buff_)
 323         return false;
 324       if (comm1->src_buff_ != nullptr && comm1->dst_buff_ != nullptr && comm2->src_buff_ != nullptr &&
 325           comm2->dst_buff_ != nullptr && comm1->dst_buff_ != comm2->src_buff_ && comm1->dst_buff_ != comm2->dst_buff_ &&
 326           comm2->dst_buff_ != comm1->src_buff_)
 327         return false;
 328       return true;
 329     default:
 330       return true;
 331   }
 332 }
 333
 334 xbt::string const& Api::get_actor_host_name(smx_actor_t actor) const
 335 {
 336   if (mc_model_checker == nullptr)
 337     return actor->get_host()->get_name();
 338
 339   const simgrid::mc::RemoteSimulation* process = &mc_model_checker->get_remote_simulation();
 340
 341   // Read the simgrid::xbt::string in the MCed process:
 342   simgrid::mc::ActorInformation* info = actor_info_cast(actor);
 343   auto remote_string_address =
 344       remote(reinterpret_cast<const simgrid::xbt::string_data*>(&actor->get_host()->get_name()));
 345   simgrid::xbt::string_data remote_string = process->read(remote_string_address);
 346   std::vector<char> hostname(remote_string.len + 1);
 347   // no need to read the terminating null byte, and thus hostname[remote_string.len] is guaranteed to be '\0'
 348   process->read_bytes(hostname.data(), remote_string.len, remote(remote_string.data));
 349   info->hostname = &mc_model_checker->get_host_name(hostname.data());
 350   return *info->hostname;
 351 }
 352
 353 std::string Api::get_actor_name(smx_actor_t actor) const
 354 {
 355   if (mc_model_checker == nullptr)
 356     return actor->get_cname();
 357
 358   simgrid::mc::ActorInformation* info = actor_info_cast(actor);
 359   if (info->name.empty()) {
 360     const simgrid::mc::RemoteSimulation* process = &mc_model_checker->get_remote_simulation();
 361
 362     simgrid::xbt::string_data string_data = simgrid::xbt::string::to_string_data(actor->name_);
 363     info->name = process->read_string(remote(string_data.data), string_data.len);
 364   }
 365   return info->name;
 366 }
 367
 368 std::string Api::get_actor_string(smx_actor_t actor) const
 369 {
 370   std::string res;
 371   if (actor) {
 372     res = "(" + std::to_string(actor->get_pid()) + ")";
 373     if (actor->get_host())
 374       res += std::string(get_actor_host_name(actor)) + " (" + get_actor_name(actor) + ")";
 375     else
 376       res += get_actor_name(actor);
 377   } else
 378     res = "(0) ()";
 379   return res;
 380 }
 381
 382 std::string Api::get_actor_dot_label(smx_actor_t actor) const
 383 {
 384   std::string res = "(" + std::to_string(actor->get_pid()) + ")";
 385   if (actor->get_host())
 386     res += get_actor_host_name(actor);
 387   return res;
 388 }
 389
 390 void Api::initialize(char** argv) const
 391 {
 392   simgrid::mc::session = new simgrid::mc::Session([argv] {
 393     int i = 1;
 394     while (argv[i] != nullptr && argv[i][0] == '-')
 395       i++;
 396     xbt_assert(argv[i] != nullptr,
 397                "Unable to find a binary to exec on the command line. Did you only pass config flags?");
 398     execvp(argv[i], argv + i);
 399     xbt_die("The model-checked process failed to exec(): %s", strerror(errno));
 400   });
 401 }
 402
 403 std::vector<simgrid::mc::ActorInformation>& Api::get_actors() const
 404 {
 405   return mc_model_checker->get_remote_simulation().actors();
 406 }
 407
 408 bool Api::actor_is_enabled(aid_t pid) const
 409 {
 410   return session->actor_is_enabled(pid);
 411 }
 412
 413 unsigned long Api::get_maxpid() const
 414 {
 415   static const char* name = nullptr;
 416   if (not name) {
 417     name = "simgrid::kernel::actor::maxpid";
 418     if (mc_model_checker->get_remote_simulation().find_variable(name) == nullptr)
 419       name = "maxpid"; // We seem to miss the namespaces when compiling with GCC
 420   }
 421   unsigned long maxpid;
 422   mc_model_checker->get_remote_simulation().read_variable(name, &maxpid, sizeof(maxpid));
 423   return maxpid;
 424 }
 425
 426 int Api::get_actors_size() const
 427 {
 428   return mc_model_checker->get_remote_simulation().actors().size();
 429 }
 430
 431 RemotePtr<kernel::activity::CommImpl> Api::get_comm_isend_raw_addr(smx_simcall_t request) const
 432 {
 433   return remote(static_cast<kernel::activity::CommImpl*>(simcall_comm_isend__getraw__result(request)));
 434 }
 435
 436 RemotePtr<kernel::activity::CommImpl> Api::get_comm_waitany_raw_addr(smx_simcall_t request, int value) const
 437 {
 438   auto addr      = simcall_comm_waitany__getraw__comms(request) + value;
 439   auto comm_addr = mc_model_checker->get_remote_simulation().read(remote(addr));
 440   return RemotePtr<kernel::activity::CommImpl>(static_cast<kernel::activity::CommImpl*>(comm_addr));
 441 }
 442
 443 std::string Api::get_pattern_comm_rdv(RemotePtr<kernel::activity::CommImpl> const& addr) const
 444 {
 445   Remote<kernel::activity::CommImpl> temp_activity;
 446   mc_model_checker->get_remote_simulation().read(temp_activity, addr);
 447   const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
 448
 449   char* remote_name = mc_model_checker->get_remote_simulation().read<char*>(RemotePtr<char*>(
 450       (uint64_t)(activity->get_mailbox() ? &activity->get_mailbox()->get_name() : &activity->mbox_cpy->get_name())));
 451   auto rdv          = mc_model_checker->get_remote_simulation().read_string(RemotePtr<char>(remote_name));
 452   return rdv;
 453 }
 454
 455 unsigned long Api::get_pattern_comm_src_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const
 456 {
 457   Remote<kernel::activity::CommImpl> temp_activity;
 458   mc_model_checker->get_remote_simulation().read(temp_activity, addr);
 459   const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
 460   auto src_proc =
 461       mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(activity->src_actor_.get()))->get_pid();
 462   return src_proc;
 463 }
 464
 465 unsigned long Api::get_pattern_comm_dst_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const
 466 {
 467   Remote<kernel::activity::CommImpl> temp_activity;
 468   mc_model_checker->get_remote_simulation().read(temp_activity, addr);
 469   const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
 470   auto src_proc =
 471       mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(activity->dst_actor_.get()))->get_pid();
 472   return src_proc;
 473 }
 474
 475 std::vector<char> Api::get_pattern_comm_data(RemotePtr<kernel::activity::CommImpl> const& addr) const
 476 {
 477   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
 478   mc_model_checker->get_remote_simulation().read(temp_comm, addr);
 479   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
 480
 481   std::vector<char> buffer{};
 482   if (comm->src_buff_ != nullptr) {
 483     buffer.resize(comm->src_buff_size_);
 484     mc_model_checker->get_remote_simulation().read_bytes(buffer.data(), buffer.size(), remote(comm->src_buff_));
 485   }
 486   return buffer;
 487 }
 488
 489 #if HAVE_SMPI
 490 bool Api::check_send_request_detached(smx_simcall_t const& simcall) const
 491 {
 492   simgrid::smpi::Request mpi_request;
 493   mc_model_checker->get_remote_simulation().read(
 494       &mpi_request, remote(static_cast<smpi::Request*>(simcall_comm_isend__get__data(simcall))));
 495   return mpi_request.detached();
 496 }
 497 #endif
 498
 499 smx_actor_t Api::get_src_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
 500 {
 501   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
 502   mc_model_checker->get_remote_simulation().read(temp_comm, comm_addr);
 503   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
 504
 505   auto src_proc = mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(comm->src_actor_.get()));
 506   return src_proc;
 507 }
 508
 509 smx_actor_t Api::get_dst_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
 510 {
 511   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
 512   mc_model_checker->get_remote_simulation().read(temp_comm, comm_addr);
 513   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
 514
 515   auto dst_proc = mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(comm->dst_actor_.get()));
 516   return dst_proc;
 517 }
 518
 519 std::size_t Api::get_remote_heap_bytes() const
 520 {
 521   RemoteSimulation& process = mc_model_checker->get_remote_simulation();
 522   auto heap_bytes_used      = mmalloc_get_bytes_used_remote(process.get_heap()->heaplimit, process.get_malloc_info());
 523   return heap_bytes_used;
 524 }
 525
 526 void Api::session_initialize() const
 527 {
 528   session->initialize();
 529 }
 530
 531 void Api::mc_inc_visited_states() const
 532 {
 533   mc_model_checker->visited_states++;
 534 }
 535
 536 void Api::mc_inc_executed_trans() const
 537 {
 538   mc_model_checker->executed_transitions++;
 539 }
 540
 541 unsigned long Api::mc_get_visited_states() const
 542 {
 543   return mc_model_checker->visited_states;
 544 }
 545
 546 unsigned long Api::mc_get_executed_trans() const
 547 {
 548   return mc_model_checker->executed_transitions;
 549 }
 550
 551 void Api::mc_check_deadlock() const
 552 {
 553   if (mc_model_checker->checkDeadlock()) {
 554     MC_show_deadlock();
 555     throw DeadlockError();
 556   }
 557 }
 558
 559 /** Get the issuer of a simcall (`req->issuer`)
 560  *
 561  *  In split-process mode, it does the black magic necessary to get an address
 562  *  of a (shallow) copy of the data structure the issuer SIMIX actor in the local
 563  *  address space.
 564  *
 565  *  @param process the MCed process
 566  *  @param req     the simcall (copied in the local process)
 567  */
 568 smx_actor_t Api::simcall_get_issuer(s_smx_simcall const* req) const
 569 {
 570   xbt_assert(mc_model_checker != nullptr);
 571
 572   // This is the address of the smx_actor in the MCed process:
 573   auto address = simgrid::mc::remote(req->issuer_);
 574
 575   // Lookup by address:
 576   for (auto& actor : mc_model_checker->get_remote_simulation().actors())
 577     if (actor.address == address)
 578       return actor.copy.get_buffer();
 579   for (auto& actor : mc_model_checker->get_remote_simulation().dead_actors())
 580     if (actor.address == address)
 581       return actor.copy.get_buffer();
 582
 583   xbt_die("Issuer not found");
 584 }
 585
 586 long Api::simcall_get_actor_id(s_smx_simcall const* req) const
 587 {
 588   return simcall_get_issuer(req)->get_pid();
 589 }
 590
 591 RemotePtr<kernel::activity::MailboxImpl> Api::get_mbox_remote_addr(smx_simcall_t const req) const
 592 {
 593   if (req->call_ == Simcall::COMM_ISEND)
 594     return remote(simcall_comm_isend__get__mbox(req));
 595   if (req->call_ == Simcall::COMM_IRECV)
 596     return remote(simcall_comm_irecv__get__mbox(req));
 597   THROW_IMPOSSIBLE;
 598 }
 599
 600 RemotePtr<kernel::activity::ActivityImpl> Api::get_comm_remote_addr(smx_simcall_t const req) const
 601 {
 602   if (req->call_ == Simcall::COMM_ISEND)
 603     return remote(simcall_comm_isend__getraw__result(req));
 604   if (req->call_ == Simcall::COMM_IRECV)
 605     return remote(simcall_comm_irecv__getraw__result(req));
 606   THROW_IMPOSSIBLE;
 607 }
 608
 609 bool Api::mc_is_null() const
 610 {
 611   auto is_null = (mc_model_checker == nullptr) ? true : false;
 612   return is_null;
 613 }
 614
 615 Checker* Api::mc_get_checker() const
 616 {
 617   return mc_model_checker->getChecker();
 618 }
 619
 620 void Api::set_checker(Checker* const checker) const
 621 {
 622   xbt_assert(mc_model_checker);
 623   xbt_assert(mc_model_checker->getChecker() == nullptr);
 624   mc_model_checker->setChecker(checker);
 625 }
 626
 627 void Api::handle_simcall(Transition const& transition) const
 628 {
 629   mc_model_checker->handle_simcall(transition);
 630 }
 631
 632 void Api::mc_wait_for_requests() const
 633 {
 634   mc_model_checker->wait_for_requests();
 635 }
 636
 637 void Api::mc_exit(int status) const
 638 {
 639   mc_model_checker->exit(status);
 640 }
 641
 642 void Api::dump_record_path() const
 643 {
 644   simgrid::mc::dumpRecordPath();
 645 }
 646
 647 smx_simcall_t Api::mc_state_choose_request(simgrid::mc::State* state) const
 648 {
 649   for (auto& actor : mc_model_checker->get_remote_simulation().actors()) {
 650     /* Only consider the actors that were marked as interleaving by the checker algorithm */
 651     if (not state->actor_states_[actor.copy.get_buffer()->get_pid()].is_todo())
 652       continue;
 653
 654     smx_simcall_t res = MC_state_choose_request_for_process(state, actor.copy.get_buffer());
 655     if (res)
 656       return res;
 657   }
 658   return nullptr;
 659 }
 660
 661 std::list<transition_detail_t> Api::get_enabled_transitions(simgrid::mc::State* state) const
 662 {
 663   std::list<transition_detail_t> tr_list{};
 664
 665   for (auto& actor : mc_model_checker->get_remote_simulation().actors()) {
 666     auto actor_pid  = actor.copy.get_buffer()->get_pid();
 667     auto actor_impl = actor.copy.get_buffer();
 668
 669     // Only consider the actors that were marked as interleaving by the checker algorithm
 670     if (not state->actor_states_[actor_pid].is_todo())
 671       continue;
 672     // Not executable in the application
 673     if (not simgrid::mc::actor_is_enabled(actor_impl))
 674       continue;
 675
 676     auto transition       = std::make_unique<s_transition_detail>();
 677     Simcall simcall_call  = actor_impl->simcall_.call_;
 678     smx_simcall_t simcall = &actor_impl->simcall_;
 679     transition->call_     = simcall_call;
 680     switch (simcall_call) {
 681       case Simcall::COMM_ISEND:
 682       case Simcall::COMM_IRECV:
 683         transition->mbox_remote_addr = get_mbox_remote_addr(simcall);
 684         transition->comm_remote_addr = get_comm_remote_addr(simcall);
 685         break;
 686
 687       default:
 688         break;
 689     }
 690     tr_list.emplace_back(std::move(transition));
 691   }
 692
 693   return tr_list;
 694 }
 695
 696 std::string Api::request_to_string(smx_simcall_t req, int value) const
 697 {
 698   xbt_assert(mc_model_checker != nullptr, "Must be called from MCer");
 699
 700   std::string type;
 701   std::string args;
 702
 703   smx_actor_t issuer = simcall_get_issuer(req);
 704
 705   if (issuer->simcall_.observer_ != nullptr)
 706     return mc_model_checker->simcall_to_string(issuer->get_pid(), value);
 707
 708   switch (req->call_) {
 709     case Simcall::COMM_ISEND:
 710       type = "iSend";
 711       args = "src=" + get_actor_string(issuer);
 712       args += ", buff=" + pointer_to_string(simcall_comm_isend__get__src_buff(req));
 713       args += ", size=" + buff_size_to_string(simcall_comm_isend__get__src_buff_size(req));
 714       break;
 715
 716     case Simcall::COMM_IRECV: {
 717       size_t* remote_size = simcall_comm_irecv__get__dst_buff_size(req);
 718       size_t size         = 0;
 719       if (remote_size)
 720         mc_model_checker->get_remote_simulation().read_bytes(&size, sizeof(size), remote(remote_size));
 721
 722       type = "iRecv";
 723       args = "dst=" + get_actor_string(issuer);
 724       args += ", buff=" + pointer_to_string(simcall_comm_irecv__get__dst_buff(req));
 725       args += ", size=" + buff_size_to_string(size);
 726       break;
 727     }
 728
 729     case Simcall::COMM_WAIT: {
 730       simgrid::kernel::activity::CommImpl* remote_act = simcall_comm_wait__getraw__comm(req);
 731       if (value == -1) {
 732         type = "WaitTimeout";
 733         args = "comm=" + pointer_to_string(remote_act);
 734       } else {
 735         type = "Wait";
 736
 737         simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_activity;
 738         const simgrid::kernel::activity::CommImpl* act;
 739         mc_model_checker->get_remote_simulation().read(temp_activity, remote(remote_act));
 740         act = temp_activity.get_buffer();
 741
 742         smx_actor_t src_proc =
 743             mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(act->src_actor_.get()));
 744         smx_actor_t dst_proc =
 745             mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(act->dst_actor_.get()));
 746         args = "comm=" + pointer_to_string(remote_act);
 747         args += " [" + get_actor_string(src_proc) + "-> " + get_actor_string(dst_proc) + "]";
 748       }
 749       break;
 750     }
 751
 752     case Simcall::COMM_TEST: {
 753       simgrid::kernel::activity::CommImpl* remote_act = simcall_comm_test__getraw__comm(req);
 754       simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_activity;
 755       const simgrid::kernel::activity::CommImpl* act;
 756       mc_model_checker->get_remote_simulation().read(temp_activity, remote(remote_act));
 757       act = temp_activity.get_buffer();
 758
 759       if (act->src_actor_.get() == nullptr || act->dst_actor_.get() == nullptr) {
 760         type = "Test FALSE";
 761         args = "comm=" + pointer_to_string(remote_act);
 762       } else {
 763         type = "Test TRUE";
 764
 765         smx_actor_t src_proc =
 766             mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(act->src_actor_.get()));
 767         smx_actor_t dst_proc =
 768             mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(act->dst_actor_.get()));
 769         args = "comm=" + pointer_to_string(remote_act);
 770         args += " [" + get_actor_string(src_proc) + " -> " + get_actor_string(dst_proc) + "]";
 771       }
 772       break;
 773     }
 774
 775     case Simcall::COMM_WAITANY: {
 776       type         = "WaitAny";
 777       size_t count = simcall_comm_waitany__get__count(req);
 778       if (count > 0) {
 779         simgrid::kernel::activity::CommImpl* remote_sync;
 780         remote_sync =
 781             mc_model_checker->get_remote_simulation().read(remote(simcall_comm_waitany__get__comms(req) + value));
 782         args = "comm=" + pointer_to_string(remote_sync) + xbt::string_printf("(%d of %zu)", value + 1, count);
 783       } else
 784         args = "comm at idx " + std::to_string(value);
 785       break;
 786     }
 787
 788     case Simcall::COMM_TESTANY:
 789       if (value == -1) {
 790         type = "TestAny FALSE";
 791         args = "-";
 792       } else {
 793         type = "TestAny";
 794         args = xbt::string_printf("(%d of %zu)", value + 1, simcall_comm_testany__get__count(req));
 795       }
 796       break;
 797
 798     default:
 799       type = SIMIX_simcall_name(req->call_);
 800       args = "??";
 801       break;
 802   }
 803
 804   return "[" + get_actor_string(issuer) + "] " + type + "(" + args + ")";
 805 }
 806
 807 std::string Api::request_get_dot_output(smx_simcall_t req, int value) const
 808 {
 809   const smx_actor_t issuer = simcall_get_issuer(req);
 810   const char* color        = get_color(issuer->get_pid() - 1);
 811
 812   std::string label;
 813
 814   if (req->observer_ != nullptr) {
 815     label = mc_model_checker->simcall_dot_label(issuer->get_pid(), value);
 816   } else
 817     switch (req->call_) {
 818       case Simcall::COMM_ISEND:
 819         label = "[" + get_actor_dot_label(issuer) + "] iSend";
 820         break;
 821
 822       case Simcall::COMM_IRECV:
 823         label = "[" + get_actor_dot_label(issuer) + "] iRecv";
 824         break;
 825
 826       case Simcall::COMM_WAIT:
 827         if (value == -1) {
 828           label = "[" + get_actor_dot_label(issuer) + "] WaitTimeout";
 829         } else {
 830           kernel::activity::ActivityImpl* remote_act = simcall_comm_wait__getraw__comm(req);
 831           Remote<kernel::activity::CommImpl> temp_comm;
 832           mc_model_checker->get_remote_simulation().read(temp_comm,
 833                                                          remote(static_cast<kernel::activity::CommImpl*>(remote_act)));
 834           const kernel::activity::CommImpl* comm = temp_comm.get_buffer();
 835
 836           const kernel::actor::ActorImpl* src_proc =
 837               mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(comm->src_actor_.get()));
 838           const kernel::actor::ActorImpl* dst_proc =
 839               mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(comm->dst_actor_.get()));
 840           label = "[" + get_actor_dot_label(issuer) + "] Wait";
 841           label += " [(" + std::to_string(src_proc ? src_proc->get_pid() : 0) + ")";
 842           label += "->(" + std::to_string(dst_proc ? dst_proc->get_pid() : 0) + ")]";
 843         }
 844         break;
 845
 846       case Simcall::COMM_TEST: {
 847         kernel::activity::ActivityImpl* remote_act = simcall_comm_test__getraw__comm(req);
 848         Remote<simgrid::kernel::activity::CommImpl> temp_comm;
 849         mc_model_checker->get_remote_simulation().read(temp_comm,
 850                                                        remote(static_cast<kernel::activity::CommImpl*>(remote_act)));
 851         const kernel::activity::CommImpl* comm = temp_comm.get_buffer();
 852         if (comm->src_actor_.get() == nullptr || comm->dst_actor_.get() == nullptr) {
 853           label = "[" + get_actor_dot_label(issuer) + "] Test FALSE";
 854         } else {
 855           label = "[" + get_actor_dot_label(issuer) + "] Test TRUE";
 856         }
 857         break;
 858       }
 859
 860       case Simcall::COMM_WAITANY:
 861         label = "[" + get_actor_dot_label(issuer) + "] WaitAny";
 862         label += xbt::string_printf(" [%d of %zu]", value + 1, simcall_comm_waitany__get__count(req));
 863         break;
 864
 865       case Simcall::COMM_TESTANY:
 866         if (value == -1) {
 867           label = "[" + get_actor_dot_label(issuer) + "] TestAny FALSE";
 868         } else {
 869           label = "[" + get_actor_dot_label(issuer) + "] TestAny TRUE";
 870           label += xbt::string_printf(" [%d of %zu]", value + 1, simcall_comm_testany__get__count(req));
 871         }
 872         break;
 873
 874       default:
 875         THROW_UNIMPLEMENTED;
 876     }
 877
 878   return "label = \"" + label + "\", color = " + color + ", fontcolor = " + color;
 879 }
 880
 881 #if HAVE_SMPI
 882 int Api::get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const
 883 {
 884   simgrid::smpi::Request mpi_request;
 885   void* simcall_data = nullptr;
 886   if (type == Simcall::COMM_ISEND)
 887     simcall_data = simcall_comm_isend__get__data(simcall);
 888   else if (type == Simcall::COMM_IRECV)
 889     simcall_data = simcall_comm_irecv__get__data(simcall);
 890   mc_model_checker->get_remote_simulation().read(&mpi_request, remote(static_cast<smpi::Request*>(simcall_data)));
 891   return mpi_request.tag();
 892 }
 893 #endif
 894
 895 void Api::restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const
 896 {
 897   system_state->restore(&mc_model_checker->get_remote_simulation());
 898 }
 899
 900 void Api::log_state() const
 901 {
 902   session->log_state();
 903 }
 904
 905 bool Api::snapshot_equal(const Snapshot* s1, const Snapshot* s2) const
 906 {
 907   return simgrid::mc::snapshot_equal(s1, s2);
 908 }
 909
 910 simgrid::mc::Snapshot* Api::take_snapshot(int num_state) const
 911 {
 912   auto snapshot = new simgrid::mc::Snapshot(num_state);
 913   return snapshot;
 914 }
 915
 916 void Api::s_close() const
 917 {
 918   session->close();
 919 }
 920
 921 void Api::restore_initial_state() const
 922 {
 923   session->restore_initial_state();
 924 }
 925
 926 void Api::execute(Transition& transition, smx_simcall_t simcall) const
 927 {
 928   /* FIXME: once all simcalls have observers, kill the simcall parameter and use mc_model_checker->simcall_to_string() */
 929   transition.textual = request_to_string(simcall, transition.times_considered_);
 930   session->execute(transition);
 931 }
 932
 933 #if SIMGRID_HAVE_MC
 934 void Api::automaton_load(const char* file) const
 935 {
 936   MC_automaton_load(file);
 937 }
 938 #endif
 939
 940 std::vector<int> Api::automaton_propositional_symbol_evaluate() const
 941 {
 942   unsigned int cursor = 0;
 943   std::vector<int> values;
 944   xbt_automaton_propositional_symbol_t ps = nullptr;
 945   xbt_dynar_foreach (mc::property_automaton->propositional_symbols, cursor, ps)
 946     values.push_back(xbt_automaton_propositional_symbol_evaluate(ps));
 947   return values;
 948 }
 949
 950 std::vector<xbt_automaton_state_t> Api::get_automaton_state() const
 951 {
 952   std::vector<xbt_automaton_state_t> automaton_stack;
 953   unsigned int cursor = 0;
 954   xbt_automaton_state_t automaton_state;
 955   xbt_dynar_foreach (mc::property_automaton->states, cursor, automaton_state)
 956     if (automaton_state->type == -1)
 957       automaton_stack.push_back(automaton_state);
 958   return automaton_stack;
 959 }
 960
 961 int Api::compare_automaton_exp_label(const xbt_automaton_exp_label* l) const
 962 {
 963   unsigned int cursor                    = 0;
 964   xbt_automaton_propositional_symbol_t p = nullptr;
 965   xbt_dynar_foreach (simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
 966     if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
 967       return cursor;
 968   }
 969   return -1;
 970 }
 971
 972 void Api::set_property_automaton(xbt_automaton_state_t const& automaton_state) const
 973 {
 974   mc::property_automaton->current_state = automaton_state;
 975 }
 976
 977 xbt_automaton_exp_label_t Api::get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const
 978 {
 979   const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
 980   return transition->label;
 981 }
 982
 983 xbt_automaton_state_t Api::get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const
 984 {
 985   const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
 986   return transition->dst;
 987 }
 988
 989 } // namespace mc
 990 } // namespace simgrid