src/mc/mc_api.cpp

   1 #include "mc_api.hpp"
   2
   3 #include "src/kernel/activity/MailboxImpl.hpp"
   4 #include "src/mc/Session.hpp"
   5 #include "src/mc/mc_comm_pattern.hpp"
   6 #include "src/mc/mc_private.hpp"
   7 #include "src/mc/mc_record.hpp"
   8 #include "src/mc/mc_smx.hpp"
   9 #include "src/mc/remote/RemoteSimulation.hpp"
  10 #include "src/mc/mc_pattern.hpp"
  11
  12 #include <xbt/asserts.h>
  13 #include <xbt/log.h>
  14
  15 #if HAVE_SMPI
  16 #include "src/smpi/include/smpi_request.hpp"
  17 #endif
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_api, mc, "Logging specific to MC Fasade APIs ");
  20
  21 using Simcall = simgrid::simix::Simcall;
  22
  23 namespace simgrid {
  24 namespace mc {
  25
  26 /* Search an enabled transition for the given process.
  27  *
  28  * This can be seen as an iterator returning the next transition of the process.
  29  *
  30  * We only consider the processes that are both
  31  *  - marked "to be interleaved" in their ActorState (controlled by the checker algorithm).
  32  *  - which simcall can currently be executed (like a comm where the other partner is already known)
  33  * Once we returned the last enabled transition of a process, it is marked done.
  34  *
  35  * Things can get muddled with the WAITANY and TESTANY simcalls, that are rewritten on the fly to a bunch of WAIT
  36  * (resp TEST) transitions using the transition.argument field to remember what was the last returned sub-transition.
  37  */
  38 static inline smx_simcall_t MC_state_choose_request_for_process(simgrid::mc::State* state, smx_actor_t actor)
  39 {
  40   /* reset the outgoing transition */
  41   simgrid::mc::ActorState* procstate = &state->actor_states_[actor->get_pid()];
  42   state->transition_.pid_            = -1;
  43   state->transition_.argument_       = -1;
  44   state->executed_req_.call_         =  Simcall::NONE;
  45
  46   if (not simgrid::mc::actor_is_enabled(actor))
  47     return nullptr; // Not executable in the application
  48
  49   smx_simcall_t req = nullptr;
  50   switch (actor->simcall_.call_) {
  51     case Simcall::COMM_WAITANY:
  52       state->transition_.argument_ = -1;
  53       while (procstate->times_considered < simcall_comm_waitany__get__count(&actor->simcall_)) {
  54         if (simgrid::mc::request_is_enabled_by_idx(&actor->simcall_, procstate->times_considered)) {
  55           state->transition_.argument_ = procstate->times_considered;
  56           ++procstate->times_considered;
  57           break;
  58         }
  59         ++procstate->times_considered;
  60       }
  61
  62       if (procstate->times_considered >= simcall_comm_waitany__get__count(&actor->simcall_))
  63         procstate->set_done();
  64       if (state->transition_.argument_ != -1)
  65         req = &actor->simcall_;
  66       break;
  67
  68     case Simcall::COMM_TESTANY: {
  69       unsigned start_count         = procstate->times_considered;
  70       state->transition_.argument_ = -1;
  71       while (procstate->times_considered < simcall_comm_testany__get__count(&actor->simcall_)) {
  72         if (simgrid::mc::request_is_enabled_by_idx(&actor->simcall_, procstate->times_considered)) {
  73           state->transition_.argument_ = procstate->times_considered;
  74           ++procstate->times_considered;
  75           break;
  76         }
  77         ++procstate->times_considered;
  78       }
  79
  80       if (procstate->times_considered >= simcall_comm_testany__get__count(&actor->simcall_))
  81         procstate->set_done();
  82
  83       if (state->transition_.argument_ != -1 || start_count == 0)
  84         req = &actor->simcall_;
  85
  86       break;
  87     }
  88
  89     case Simcall::COMM_WAIT: {
  90       simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> remote_act =
  91           remote(simcall_comm_wait__getraw__comm(&actor->simcall_));
  92       simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_act;
  93       mc_model_checker->get_remote_simulation().read(temp_act, remote_act);
  94       const simgrid::kernel::activity::CommImpl* act = temp_act.get_buffer();
  95       if (act->src_actor_.get() && act->dst_actor_.get())
  96         state->transition_.argument_ = 0; // OK
  97       else if (act->src_actor_.get() == nullptr && act->type_ == simgrid::kernel::activity::CommImpl::Type::READY &&
  98                act->detached())
  99         state->transition_.argument_ = 0; // OK
 100       else
 101         state->transition_.argument_ = -1; // timeout
 102       procstate->set_done();
 103       req = &actor->simcall_;
 104       break;
 105     }
 106
 107     case Simcall::MC_RANDOM: {
 108       int min_value                = simcall_mc_random__get__min(&actor->simcall_);
 109       state->transition_.argument_ = procstate->times_considered + min_value;
 110       procstate->times_considered++;
 111       if (state->transition_.argument_ == simcall_mc_random__get__max(&actor->simcall_))
 112         procstate->set_done();
 113       req = &actor->simcall_;
 114       break;
 115     }
 116
 117     default:
 118       procstate->set_done();
 119       state->transition_.argument_ = 0;
 120       req                          = &actor->simcall_;
 121       break;
 122   }
 123   if (not req)
 124     return nullptr;
 125
 126   state->transition_.pid_ = actor->get_pid();
 127   state->executed_req_    = *req;
 128   // Fetch the data of the request and translate it:
 129   state->internal_req_ = *req;
 130
 131   /* The waitany and testany request are transformed into a wait or test request over the corresponding communication
 132    * action so it can be treated later by the dependence function. */
 133   switch (req->call_) {
 134     case Simcall::COMM_WAITANY: {
 135       state->internal_req_.call_ = Simcall::COMM_WAIT;
 136       simgrid::kernel::activity::CommImpl* remote_comm;
 137       remote_comm = mc_model_checker->get_remote_simulation().read(
 138           remote(simcall_comm_waitany__get__comms(req) + state->transition_.argument_));
 139       mc_model_checker->get_remote_simulation().read(state->internal_comm_, remote(remote_comm));
 140       simcall_comm_wait__set__comm(&state->internal_req_, state->internal_comm_.get_buffer());
 141       simcall_comm_wait__set__timeout(&state->internal_req_, 0);
 142       break;
 143     }
 144
 145     case Simcall::COMM_TESTANY:
 146       state->internal_req_.call_ = Simcall::COMM_TEST;
 147
 148       if (state->transition_.argument_ > 0) {
 149         simgrid::kernel::activity::CommImpl* remote_comm = mc_model_checker->get_remote_simulation().read(
 150             remote(simcall_comm_testany__get__comms(req) + state->transition_.argument_));
 151         mc_model_checker->get_remote_simulation().read(state->internal_comm_, remote(remote_comm));
 152       }
 153
 154       simcall_comm_test__set__comm(&state->internal_req_, state->internal_comm_.get_buffer());
 155       simcall_comm_test__set__result(&state->internal_req_, state->transition_.argument_);
 156       break;
 157
 158     case Simcall::COMM_WAIT:
 159       mc_model_checker->get_remote_simulation().read_bytes(&state->internal_comm_, sizeof(state->internal_comm_),
 160                                                            remote(simcall_comm_wait__getraw__comm(req)));
 161       simcall_comm_wait__set__comm(&state->executed_req_, state->internal_comm_.get_buffer());
 162       simcall_comm_wait__set__comm(&state->internal_req_, state->internal_comm_.get_buffer());
 163       break;
 164
 165     case Simcall::COMM_TEST:
 166       mc_model_checker->get_remote_simulation().read_bytes(&state->internal_comm_, sizeof(state->internal_comm_),
 167                                                            remote(simcall_comm_test__getraw__comm(req)));
 168       simcall_comm_test__set__comm(&state->executed_req_, state->internal_comm_.get_buffer());
 169       simcall_comm_test__set__comm(&state->internal_req_, state->internal_comm_.get_buffer());
 170       break;
 171
 172     default:
 173       /* No translation needed */
 174       break;
 175   }
 176
 177   return req;
 178 }
 179
 180 void mc_api::initialize(char** argv)
 181 {
 182   simgrid::mc::session = new simgrid::mc::Session([argv] {
 183     int i = 1;
 184     while (argv[i] != nullptr && argv[i][0] == '-')
 185       i++;
 186     xbt_assert(argv[i] != nullptr,
 187                "Unable to find a binary to exec on the command line. Did you only pass config flags?");
 188     execvp(argv[i], argv + i);
 189     xbt_die("The model-checked process failed to exec(): %s", strerror(errno));
 190   });
 191 }
 192
 193 std::vector<simgrid::mc::ActorInformation>& mc_api::get_actors() const
 194 {
 195   return mc_model_checker->get_remote_simulation().actors();
 196 }
 197
 198 bool mc_api::actor_is_enabled(aid_t pid) const
 199 {
 200   return session->actor_is_enabled(pid);
 201 }
 202
 203 unsigned long mc_api::get_maxpid() const
 204 {
 205   return MC_smx_get_maxpid();
 206 }
 207
 208 int mc_api::get_actors_size() const
 209 {
 210   return mc_model_checker->get_remote_simulation().actors().size();
 211 }
 212
 213 void mc_api::copy_incomplete_comm_pattern(simgrid::mc::State* state) const
 214 {
 215   state->incomplete_comm_pattern_.clear();
 216   for (unsigned i=0; i < MC_smx_get_maxpid(); i++) {
 217     std::vector<simgrid::mc::PatternCommunication> res;
 218     for (auto const& comm : incomplete_communications_pattern[i])
 219       res.push_back(comm->dup());
 220     state->incomplete_comm_pattern_.push_back(std::move(res));
 221   }
 222 }
 223
 224 void mc_api::copy_index_comm_pattern(simgrid::mc::State* state) const
 225 {
 226   state->communication_indices_.clear();
 227   for (auto const& list_process_comm : initial_communications_pattern)
 228     state->communication_indices_.push_back(list_process_comm.index_comm);
 229 }
 230
 231 kernel::activity::CommImpl* mc_api::get_comm_isend_raw_addr(smx_simcall_t request) const
 232 {
 233   auto comm_addr = simcall_comm_isend__getraw__result(request);
 234   return static_cast<kernel::activity::CommImpl*>(comm_addr);
 235 }
 236
 237 simgrid::mc::RemotePtr<kernel::activity::CommImpl> mc_api::get_comm_wait_raw_addr(smx_simcall_t request) const
 238 {
 239   return remote(simcall_comm_wait__getraw__comm(request));
 240 }
 241
 242 std::string mc_api::get_pattern_comm_rdv(void* addr) const
 243 {
 244   Remote<kernel::activity::CommImpl> temp_synchro;
 245   mc_model_checker->get_remote_simulation().read(temp_synchro, remote((simgrid::kernel::activity::CommImpl*)addr));
 246   const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
 247
 248   char* remote_name = mc_model_checker->get_remote_simulation().read<char*>(RemotePtr<char*>(
 249       (uint64_t)(synchro->get_mailbox() ? &synchro->get_mailbox()->get_name() : &synchro->mbox_cpy->get_name())));
 250   auto rdv = mc_model_checker->get_remote_simulation().read_string(RemotePtr<char>(remote_name));
 251   return rdv;
 252 }
 253
 254 unsigned long mc_api::get_pattern_comm_src_proc(void* addr) const
 255 {
 256   Remote<kernel::activity::CommImpl> temp_synchro;
 257   mc_model_checker->get_remote_simulation().read(temp_synchro, remote((simgrid::kernel::activity::CommImpl*)addr));
 258   const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
 259   auto src_proc = mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(synchro->src_actor_.get()))->get_pid();
 260   return src_proc;
 261 }
 262
 263 unsigned long mc_api::get_pattern_comm_dst_proc(void* addr) const
 264 {
 265   Remote<kernel::activity::CommImpl> temp_synchro;
 266   mc_model_checker->get_remote_simulation().read(temp_synchro, remote((simgrid::kernel::activity::CommImpl*)addr));
 267   const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
 268   auto src_proc = mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(synchro->dst_actor_.get()))->get_pid();
 269   return src_proc;
 270 }
 271
 272 std::vector<char> mc_api::get_pattern_comm_data(void* addr) const
 273 {
 274   Remote<kernel::activity::CommImpl> temp_synchro;
 275   mc_model_checker->get_remote_simulation().read(temp_synchro, remote((simgrid::kernel::activity::CommImpl*)addr));
 276   const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
 277
 278   std::vector<char> buffer {};
 279   if (synchro->src_buff_ != nullptr) {
 280     buffer.resize(synchro->src_buff_size_);
 281     mc_model_checker->get_remote_simulation().read_bytes(buffer.data(), buffer.size(),
 282                                                          remote(synchro->src_buff_));
 283   }
 284   return buffer;
 285 }
 286
 287 std::vector<char> mc_api::get_pattern_comm_data(mc::RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
 288 {
 289   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
 290   mc_model_checker->get_remote_simulation().read(temp_comm, comm_addr);
 291   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
 292
 293   std::vector<char> buffer {};
 294   if (comm->src_buff_ != nullptr) {
 295     buffer.resize(comm->src_buff_size_);
 296     mc_model_checker->get_remote_simulation().read_bytes(buffer.data(), buffer.size(),
 297                                                          remote(comm->src_buff_));
 298   }
 299   return buffer;
 300 }
 301
 302 const char* mc_api::get_actor_host_name(smx_actor_t actor) const
 303 {
 304   const char* host_name = MC_smx_actor_get_host_name(actor);
 305   return host_name;
 306 }
 307
 308 bool mc_api::check_send_request_detached(smx_simcall_t const& simcall) const
 309 {
 310   simgrid::smpi::Request mpi_request;
 311   mc_model_checker->get_remote_simulation().read(
 312       &mpi_request, remote(static_cast<smpi::Request*>(simcall_comm_isend__get__data(simcall))));
 313   return mpi_request.detached();
 314 }
 315
 316 smx_actor_t mc_api::get_src_actor(mc::RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
 317 {
 318   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
 319   mc_model_checker->get_remote_simulation().read(temp_comm, comm_addr);
 320   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
 321
 322   auto src_proc = mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(comm->src_actor_.get()));
 323   return src_proc;
 324 }
 325
 326 smx_actor_t mc_api::get_dst_actor(mc::RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
 327 {
 328   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
 329   mc_model_checker->get_remote_simulation().read(temp_comm, comm_addr);
 330   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
 331
 332   auto dst_proc = mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(comm->dst_actor_.get()));
 333   return dst_proc;
 334 }
 335
 336 std::size_t mc_api::get_remote_heap_bytes() const
 337 {
 338   RemoteSimulation& process = mc_model_checker->get_remote_simulation();
 339   auto heap_bytes_used      = mmalloc_get_bytes_used_remote(process.get_heap()->heaplimit, process.get_malloc_info());
 340   return heap_bytes_used;
 341 }
 342
 343 void mc_api::s_initialize() const
 344 {
 345   session->initialize();
 346 }
 347
 348 ModelChecker* mc_api::get_model_checker() const
 349 {
 350   return mc_model_checker;
 351 }
 352
 353 void mc_api::mc_inc_visited_states() const
 354 {
 355   mc_model_checker->visited_states++;
 356 }
 357
 358 void mc_api::mc_inc_executed_trans() const
 359 {
 360   mc_model_checker->executed_transitions++;
 361 }
 362
 363 unsigned long mc_api::mc_get_visited_states() const
 364 {
 365   return mc_model_checker->visited_states;
 366 }
 367
 368 unsigned long mc_api::mc_get_executed_trans() const
 369 {
 370   return mc_model_checker->executed_transitions;
 371 }
 372
 373 bool mc_api::mc_check_deadlock() const
 374 {
 375   return mc_model_checker->checkDeadlock();
 376 }
 377
 378 void mc_api::mc_show_deadlock() const
 379 {
 380   MC_show_deadlock();
 381 }
 382
 383 smx_actor_t mc_api::simcall_get_issuer(s_smx_simcall const* req) const
 384 {
 385   return MC_smx_simcall_get_issuer(req);
 386 }
 387
 388 bool mc_api::mc_is_null() const
 389 {
 390   auto is_null = (mc_model_checker == nullptr) ? true : false;
 391   return is_null;
 392 }
 393
 394 Checker* mc_api::mc_get_checker() const
 395 {
 396   return mc_model_checker->getChecker();
 397 }
 398
 399 RemoteSimulation& mc_api::mc_get_remote_simulation() const
 400 {
 401   return mc_model_checker->get_remote_simulation();
 402 }
 403
 404 void mc_api::handle_simcall(Transition const& transition) const
 405 {
 406   mc_model_checker->handle_simcall(transition);
 407 }
 408
 409 void mc_api::mc_wait_for_requests() const
 410 {
 411   mc_model_checker->wait_for_requests();
 412 }
 413
 414 void mc_api::mc_exit(int status) const
 415 {
 416   mc_model_checker->exit(status);
 417 }
 418
 419 std::string const& mc_api::mc_get_host_name(std::string const& hostname) const
 420 {
 421   return mc_model_checker->get_host_name(hostname);
 422 }
 423
 424 void mc_api::mc_dump_record_path() const
 425 {
 426   simgrid::mc::dumpRecordPath();
 427 }
 428
 429 smx_simcall_t mc_api::mc_state_choose_request(simgrid::mc::State* state) const
 430 {
 431   for (auto& actor : mc_model_checker->get_remote_simulation().actors()) {
 432     /* Only consider the actors that were marked as interleaving by the checker algorithm */
 433     if (not state->actor_states_[actor.copy.get_buffer()->get_pid()].is_todo())
 434       continue;
 435
 436     smx_simcall_t res = MC_state_choose_request_for_process(state, actor.copy.get_buffer());
 437     if (res)
 438       return res;
 439   }
 440   return nullptr;
 441 }
 442
 443 bool mc_api::request_depend(smx_simcall_t req1, smx_simcall_t req2) const
 444 {
 445   return simgrid::mc::request_depend(req1, req2);
 446 }
 447
 448 std::string mc_api::request_to_string(smx_simcall_t req, int value, RequestType request_type) const
 449 {
 450   return simgrid::mc::request_to_string(req, value, request_type).c_str();
 451 }
 452
 453 std::string mc_api::request_get_dot_output(smx_simcall_t req, int value) const
 454 {
 455   return simgrid::mc::request_get_dot_output(req, value);
 456 }
 457
 458 const char* mc_api::simcall_get_name(simgrid::simix::Simcall kind) const
 459 {
 460   return SIMIX_simcall_name(kind);
 461 }
 462
 463 #if HAVE_SMPI
 464 int mc_api::get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const
 465 {
 466   simgrid::smpi::Request mpi_request;
 467   void* simcall_data = nullptr;
 468   if (type == Simcall::COMM_ISEND)
 469     simcall_data = simcall_comm_isend__get__data(simcall);
 470   else if (type == Simcall::COMM_IRECV)
 471     simcall_data = simcall_comm_irecv__get__data(simcall);
 472   mc_model_checker->get_remote_simulation().read(&mpi_request, remote(static_cast<smpi::Request*>(simcall_data)));
 473   return mpi_request.tag();
 474 }
 475 #endif
 476
 477 void mc_api::restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const
 478 {
 479   system_state->restore(&mc_model_checker->get_remote_simulation());
 480 }
 481
 482 bool mc_api::snapshot_equal(const Snapshot* s1, const Snapshot* s2) const
 483 {
 484   return simgrid::mc::snapshot_equal(s1, s2);
 485 }
 486
 487 simgrid::mc::Snapshot* mc_api::take_snapshot(int num_state) const
 488 {
 489   auto snapshot = new simgrid::mc::Snapshot(num_state);
 490   return snapshot;
 491 }
 492
 493 void mc_api::s_close() const
 494 {
 495   session->close();
 496 }
 497
 498 void mc_api::restore_initial_state() const
 499 {
 500   session->restore_initial_state();
 501 }
 502
 503 void mc_api::execute(Transition const& transition)
 504 {
 505   session->execute(transition);
 506 }
 507
 508 void mc_api::log_state() const
 509 {
 510   session->log_state();
 511 }
 512
 513 } // namespace mc
 514 } // namespace simgrid