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