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