src/mc/api.cpp

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