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