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