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