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"
14 #include <xbt/asserts.h>
16 #include "simgrid/s4u/Host.hpp"
17 #include "xbt/string.hpp"
19 #include "src/smpi/include/smpi_request.hpp"
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(Api, mc, "Logging specific to MC Facade APIs ");
24 using Simcall = simgrid::simix::Simcall;
29 static inline const char* get_color(int id)
31 static constexpr std::array<const char*, 13> colors{{"blue", "red", "green3", "goldenrod", "brown", "purple",
32 "magenta", "turquoise4", "gray25", "forestgreen", "hotpink",
34 return colors[id % colors.size()];
37 static std::string pointer_to_string(void* pointer)
39 return XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose) ? xbt::string_printf("%p", pointer) : "(verbose only)";
42 static std::string buff_size_to_string(size_t buff_size)
44 return XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose) ? std::to_string(buff_size) : "(verbose only)";
47 static void simcall_translate(smx_simcall_t req,
48 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl>& buffered_comm);
50 static bool request_is_enabled_by_idx(const RemoteProcess& process, smx_simcall_t req, unsigned int idx)
52 kernel::activity::CommImpl* remote_act = nullptr;
54 case Simcall::COMM_WAIT:
55 /* FIXME: check also that src and dst processes are not suspended */
56 remote_act = simcall_comm_wait__getraw__comm(req);
59 case Simcall::COMM_WAITANY:
60 remote_act = process.read(remote(simcall_comm_waitany__get__comms(req) + idx));
63 case Simcall::COMM_TESTANY:
64 remote_act = process.read(remote(simcall_comm_testany__get__comms(req) + idx));
71 Remote<kernel::activity::CommImpl> temp_comm;
72 process.read(temp_comm, remote(remote_act));
73 const kernel::activity::CommImpl* comm = temp_comm.get_buffer();
74 return comm->src_actor_.get() && comm->dst_actor_.get();
77 /* Search an enabled transition for the given process.
79 * This can be seen as an iterator returning the next transition of the process.
81 * We only consider the processes that are both
82 * - marked "to be interleaved" in their ActorState (controlled by the checker algorithm).
83 * - which simcall can currently be executed (like a comm where the other partner is already known)
84 * Once we returned the last enabled transition of a process, it is marked done.
86 * Things can get muddled with the WAITANY and TESTANY simcalls, that are rewritten on the fly to a bunch of WAIT
87 * (resp TEST) transitions using the transition.argument field to remember what was the last returned sub-transition.
89 static inline smx_simcall_t MC_state_choose_request_for_process(const RemoteProcess& process, simgrid::mc::State* state,
92 /* reset the outgoing transition */
93 simgrid::mc::ActorState* procstate = &state->actor_states_[actor->get_pid()];
94 state->transition_.pid_ = -1;
95 state->transition_.times_considered_ = -1;
96 state->transition_.textual[0] = '\0';
97 state->executed_req_.call_ = Simcall::NONE;
99 if (not simgrid::mc::actor_is_enabled(actor))
100 return nullptr; // Not executable in the application
102 smx_simcall_t req = nullptr;
103 if (actor->simcall_.observer_ != nullptr) {
104 state->transition_.times_considered_ = procstate->times_considered;
105 procstate->times_considered++;
106 if (actor->simcall_.mc_max_consider_ <= procstate->times_considered)
107 procstate->set_done();
108 req = &actor->simcall_;
110 switch (actor->simcall_.call_) {
111 case Simcall::COMM_WAITANY:
112 state->transition_.times_considered_ = -1;
113 while (procstate->times_considered < simcall_comm_waitany__get__count(&actor->simcall_)) {
114 if (simgrid::mc::request_is_enabled_by_idx(process, &actor->simcall_, procstate->times_considered)) {
115 state->transition_.times_considered_ = procstate->times_considered;
116 ++procstate->times_considered;
119 ++procstate->times_considered;
122 if (procstate->times_considered >= simcall_comm_waitany__get__count(&actor->simcall_))
123 procstate->set_done();
124 if (state->transition_.times_considered_ != -1)
125 req = &actor->simcall_;
128 case Simcall::COMM_TESTANY:
129 state->transition_.times_considered_ = -1;
130 while (procstate->times_considered < simcall_comm_testany__get__count(&actor->simcall_)) {
131 if (simgrid::mc::request_is_enabled_by_idx(process, &actor->simcall_, procstate->times_considered)) {
132 state->transition_.times_considered_ = procstate->times_considered;
133 ++procstate->times_considered;
136 ++procstate->times_considered;
139 if (procstate->times_considered >= simcall_comm_testany__get__count(&actor->simcall_))
140 procstate->set_done();
141 if (state->transition_.times_considered_ != -1)
142 req = &actor->simcall_;
145 case Simcall::COMM_WAIT: {
146 simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> remote_act =
147 remote(simcall_comm_wait__get__comm(&actor->simcall_));
148 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_act;
149 process.read(temp_act, remote_act);
150 const simgrid::kernel::activity::CommImpl* act = temp_act.get_buffer();
151 if (act->src_actor_.get() && act->dst_actor_.get())
152 state->transition_.times_considered_ = 0; // OK
153 else if (act->src_actor_.get() == nullptr && act->state_ == simgrid::kernel::activity::State::READY &&
155 state->transition_.times_considered_ = 0; // OK
157 state->transition_.times_considered_ = -1; // timeout
158 procstate->set_done();
159 req = &actor->simcall_;
164 procstate->set_done();
165 state->transition_.times_considered_ = 0;
166 req = &actor->simcall_;
172 state->transition_.pid_ = actor->get_pid();
173 state->executed_req_ = *req;
175 // Fetch the data of the request and translate it:
176 state->internal_req_ = *req;
177 state->internal_req_.mc_value_ = state->transition_.times_considered_;
178 simcall_translate(&state->internal_req_, state->internal_comm_);
183 static void simcall_translate(smx_simcall_t req,
184 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl>& buffered_comm)
186 simgrid::kernel::activity::CommImpl* chosen_comm;
188 /* The waitany and testany request are transformed into a wait or test request over the corresponding communication
189 * action so it can be treated later by the dependence function. */
190 switch (req->call_) {
191 case Simcall::COMM_WAITANY:
192 req->call_ = Simcall::COMM_WAIT;
194 mc_model_checker->get_remote_process().read(remote(simcall_comm_waitany__get__comms(req) + req->mc_value_));
196 mc_model_checker->get_remote_process().read(buffered_comm, remote(chosen_comm));
197 simcall_comm_wait__set__comm(req, buffered_comm.get_buffer());
198 simcall_comm_wait__set__timeout(req, 0);
201 case Simcall::COMM_TESTANY:
202 req->call_ = Simcall::COMM_TEST;
204 mc_model_checker->get_remote_process().read(remote(simcall_comm_testany__get__comms(req) + req->mc_value_));
206 mc_model_checker->get_remote_process().read(buffered_comm, remote(chosen_comm));
207 simcall_comm_test__set__comm(req, buffered_comm.get_buffer());
208 simcall_comm_test__set__result(req, req->mc_value_);
211 case Simcall::COMM_WAIT:
212 chosen_comm = simcall_comm_wait__get__comm(req);
213 mc_model_checker->get_remote_process().read(buffered_comm, remote(chosen_comm));
214 simcall_comm_wait__set__comm(req, buffered_comm.get_buffer());
217 case Simcall::COMM_TEST:
218 chosen_comm = simcall_comm_test__get__comm(req);
219 mc_model_checker->get_remote_process().read(buffered_comm, remote(chosen_comm));
220 simcall_comm_test__set__comm(req, buffered_comm.get_buffer());
224 /* No translation needed */
229 simgrid::kernel::activity::CommImpl* Api::get_comm_or_nullptr(smx_simcall_t const r) const
231 if (r->call_ == Simcall::COMM_WAIT)
232 return simcall_comm_wait__get__comm(r);
233 if (r->call_ == Simcall::COMM_TEST)
234 return simcall_comm_test__get__comm(r);
238 /** Statically "upcast" a s_smx_actor_t into an ActorInformation
240 * This gets 'actorInfo' from '&actorInfo->copy'. It upcasts in the
241 * sense that we could achieve the same thing by having ActorInformation
242 * inherit from s_smx_actor_t but we don't really want to do that.
244 simgrid::mc::ActorInformation* Api::actor_info_cast(smx_actor_t actor) const
246 simgrid::mc::ActorInformation temp;
247 std::size_t offset = (char*)temp.copy.get_buffer() - (char*)&temp;
249 auto* process_info = reinterpret_cast<simgrid::mc::ActorInformation*>((char*)actor - offset);
253 bool Api::simcall_check_dependency(smx_simcall_t req1, smx_simcall_t req2) const
255 const auto IRECV = Simcall::COMM_IRECV;
256 const auto ISEND = Simcall::COMM_ISEND;
257 const auto TEST = Simcall::COMM_TEST;
258 const auto WAIT = Simcall::COMM_WAIT;
260 if (req1->issuer_ == req2->issuer_)
263 /* The independence theorem only consider 4 simcalls. All others are dependent with anything. */
264 if (req1->call_ != ISEND && req1->call_ != IRECV && req1->call_ != TEST && req1->call_ != WAIT)
266 if (req2->call_ != ISEND && req2->call_ != IRECV && req2->call_ != TEST && req2->call_ != WAIT)
269 /* Timeouts in wait transitions are not considered by the independence theorem, thus assumed dependent */
270 if ((req1->call_ == WAIT && simcall_comm_wait__get__timeout(req1) > 0) ||
271 (req2->call_ == WAIT && simcall_comm_wait__get__timeout(req2) > 0))
274 /* Make sure that req1 and req2 are in alphabetic order */
275 if (req1->call_ > req2->call_) {
281 auto comm1 = get_comm_or_nullptr(req1);
282 auto comm2 = get_comm_or_nullptr(req2);
284 /* First case: that's not the same kind of request (we also know that req1 < req2 alphabetically) */
285 if (req1->call_ != req2->call_) {
286 if (req1->call_ == IRECV && req2->call_ == ISEND)
289 if ((req1->call_ == IRECV || req1->call_ == ISEND) && req2->call_ == WAIT) {
290 auto mbox1 = get_mbox_remote_addr(req1);
291 auto mbox2 = remote(comm2->mbox_cpy);
293 if (mbox1 != mbox2 && simcall_comm_wait__get__timeout(req2) <= 0)
296 if ((req1->issuer_ != comm2->src_actor_.get()) && (req1->issuer_ != comm2->dst_actor_.get()) &&
297 simcall_comm_wait__get__timeout(req2) <= 0)
300 if ((req1->call_ == ISEND) && (comm2->type_ == kernel::activity::CommImpl::Type::SEND) &&
301 (comm2->src_buff_ != simcall_comm_isend__get__src_buff(req1)) && simcall_comm_wait__get__timeout(req2) <= 0)
304 if ((req1->call_ == IRECV) && (comm2->type_ == kernel::activity::CommImpl::Type::RECEIVE) &&
305 (comm2->dst_buff_ != simcall_comm_irecv__get__dst_buff(req1)) && simcall_comm_wait__get__timeout(req2) <= 0)
309 /* FIXME: the following rule assumes that the result of the isend/irecv call is not stored in a buffer used in the
312 if((req1->call == ISEND || req1->call == IRECV)
313 && req2->call == TEST)
317 if (req1->call_ == TEST && req2->call_ == WAIT &&
318 (comm1->src_actor_.get() == nullptr || comm1->dst_actor_.get() == nullptr))
321 if (req1->call_ == TEST &&
322 (simcall_comm_test__get__comm(req1) == nullptr || comm1->src_buff_ == nullptr || comm1->dst_buff_ == nullptr))
324 if (req2->call_ == TEST &&
325 (simcall_comm_test__get__comm(req2) == nullptr || comm2->src_buff_ == nullptr || comm2->dst_buff_ == nullptr))
328 if (req1->call_ == TEST && req2->call_ == WAIT && comm1->src_buff_ == comm2->src_buff_ &&
329 comm1->dst_buff_ == comm2->dst_buff_)
332 if (req1->call_ == TEST && req2->call_ == WAIT && comm1->src_buff_ != nullptr && comm1->dst_buff_ != nullptr &&
333 comm2->src_buff_ != nullptr && comm2->dst_buff_ != nullptr && comm1->dst_buff_ != comm2->src_buff_ &&
334 comm1->dst_buff_ != comm2->dst_buff_ && comm2->dst_buff_ != comm1->src_buff_)
340 /* Second case: req1 and req2 are of the same call type */
341 switch (req1->call_) {
343 return simcall_comm_isend__get__mbox(req1) == simcall_comm_isend__get__mbox(req2);
345 return simcall_comm_irecv__get__mbox(req1) == simcall_comm_irecv__get__mbox(req2);
347 if (comm1->src_buff_ == comm2->src_buff_ && comm1->dst_buff_ == comm2->dst_buff_)
349 if (comm1->src_buff_ != nullptr && comm1->dst_buff_ != nullptr && comm2->src_buff_ != nullptr &&
350 comm2->dst_buff_ != nullptr && comm1->dst_buff_ != comm2->src_buff_ && comm1->dst_buff_ != comm2->dst_buff_ &&
351 comm2->dst_buff_ != comm1->src_buff_)
359 xbt::string const& Api::get_actor_host_name(smx_actor_t actor) const
361 if (mc_model_checker == nullptr)
362 return actor->get_host()->get_name();
364 const simgrid::mc::RemoteProcess* process = &mc_model_checker->get_remote_process();
366 // Read the simgrid::xbt::string in the MCed process:
367 simgrid::mc::ActorInformation* info = actor_info_cast(actor);
368 auto remote_string_address =
369 remote(reinterpret_cast<const simgrid::xbt::string_data*>(&actor->get_host()->get_name()));
370 simgrid::xbt::string_data remote_string = process->read(remote_string_address);
371 std::vector<char> hostname(remote_string.len + 1);
372 // no need to read the terminating null byte, and thus hostname[remote_string.len] is guaranteed to be '\0'
373 process->read_bytes(hostname.data(), remote_string.len, remote(remote_string.data));
374 info->hostname = &mc_model_checker->get_host_name(hostname.data());
375 return *info->hostname;
378 std::string Api::get_actor_name(smx_actor_t actor) const
380 if (mc_model_checker == nullptr)
381 return actor->get_cname();
383 simgrid::mc::ActorInformation* info = actor_info_cast(actor);
384 if (info->name.empty()) {
385 const simgrid::mc::RemoteProcess* process = &mc_model_checker->get_remote_process();
387 simgrid::xbt::string_data string_data = simgrid::xbt::string::to_string_data(actor->name_);
388 info->name = process->read_string(remote(string_data.data), string_data.len);
393 std::string Api::get_actor_string(smx_actor_t actor) const
397 res = "(" + std::to_string(actor->get_pid()) + ")";
398 if (actor->get_host())
399 res += std::string(get_actor_host_name(actor)) + " (" + get_actor_name(actor) + ")";
401 res += get_actor_name(actor);
407 std::string Api::get_actor_dot_label(smx_actor_t actor) const
409 std::string res = "(" + std::to_string(actor->get_pid()) + ")";
410 if (actor->get_host())
411 res += get_actor_host_name(actor);
415 simgrid::mc::Checker* Api::initialize(char** argv, simgrid::mc::CheckerAlgorithm algo) const
417 auto session = new simgrid::mc::Session([argv] {
419 while (argv[i] != nullptr && argv[i][0] == '-')
421 xbt_assert(argv[i] != nullptr,
422 "Unable to find a binary to exec on the command line. Did you only pass config flags?");
423 execvp(argv[i], argv + i);
424 xbt_die("The model-checked process failed to exec(%s): %s", argv[i], strerror(errno));
427 simgrid::mc::Checker* checker;
429 case CheckerAlgorithm::CommDeterminism:
430 checker = simgrid::mc::createCommunicationDeterminismChecker(session);
433 case CheckerAlgorithm::UDPOR:
434 checker = simgrid::mc::createUdporChecker(session);
437 case CheckerAlgorithm::Safety:
438 checker = simgrid::mc::createSafetyChecker(session);
441 case CheckerAlgorithm::Liveness:
442 checker = simgrid::mc::createLivenessChecker(session);
449 simgrid::mc::session_singleton = session;
450 mc_model_checker->setChecker(checker);
454 std::vector<simgrid::mc::ActorInformation>& Api::get_actors() const
456 return mc_model_checker->get_remote_process().actors();
459 unsigned long Api::get_maxpid() const
461 return mc_model_checker->get_remote_process().get_maxpid();
464 int Api::get_actors_size() const
466 return mc_model_checker->get_remote_process().actors().size();
469 RemotePtr<kernel::activity::CommImpl> Api::get_comm_isend_raw_addr(smx_simcall_t request) const
471 return remote(static_cast<kernel::activity::CommImpl*>(simcall_comm_isend__getraw__result(request)));
474 RemotePtr<kernel::activity::CommImpl> Api::get_comm_waitany_raw_addr(smx_simcall_t request, int value) const
476 auto addr = simcall_comm_waitany__getraw__comms(request) + value;
477 auto comm_addr = mc_model_checker->get_remote_process().read(remote(addr));
478 return RemotePtr<kernel::activity::CommImpl>(static_cast<kernel::activity::CommImpl*>(comm_addr));
481 std::string Api::get_pattern_comm_rdv(RemotePtr<kernel::activity::CommImpl> const& addr) const
483 Remote<kernel::activity::CommImpl> temp_activity;
484 mc_model_checker->get_remote_process().read(temp_activity, addr);
485 const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
487 char* remote_name = mc_model_checker->get_remote_process().read<char*>(RemotePtr<char*>(
488 (uint64_t)(activity->get_mailbox() ? &activity->get_mailbox()->get_name() : &activity->mbox_cpy->get_name())));
489 auto rdv = mc_model_checker->get_remote_process().read_string(RemotePtr<char>(remote_name));
493 unsigned long Api::get_pattern_comm_src_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const
495 Remote<kernel::activity::CommImpl> temp_activity;
496 mc_model_checker->get_remote_process().read(temp_activity, addr);
497 const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
499 mc_model_checker->get_remote_process().resolve_actor(mc::remote(activity->src_actor_.get()))->get_pid();
503 unsigned long Api::get_pattern_comm_dst_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const
505 Remote<kernel::activity::CommImpl> temp_activity;
506 mc_model_checker->get_remote_process().read(temp_activity, addr);
507 const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
509 mc_model_checker->get_remote_process().resolve_actor(mc::remote(activity->dst_actor_.get()))->get_pid();
513 std::vector<char> Api::get_pattern_comm_data(RemotePtr<kernel::activity::CommImpl> const& addr) const
515 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
516 mc_model_checker->get_remote_process().read(temp_comm, addr);
517 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
519 std::vector<char> buffer{};
520 if (comm->src_buff_ != nullptr) {
521 buffer.resize(comm->src_buff_size_);
522 mc_model_checker->get_remote_process().read_bytes(buffer.data(), buffer.size(), remote(comm->src_buff_));
528 bool Api::check_send_request_detached(smx_simcall_t const& simcall) const
530 simgrid::smpi::Request mpi_request;
531 mc_model_checker->get_remote_process().read(
532 &mpi_request, remote(static_cast<smpi::Request*>(simcall_comm_isend__get__data(simcall))));
533 return mpi_request.detached();
537 smx_actor_t Api::get_src_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
539 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
540 mc_model_checker->get_remote_process().read(temp_comm, comm_addr);
541 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
543 auto src_proc = mc_model_checker->get_remote_process().resolve_actor(simgrid::mc::remote(comm->src_actor_.get()));
547 smx_actor_t Api::get_dst_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
549 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
550 mc_model_checker->get_remote_process().read(temp_comm, comm_addr);
551 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
553 auto dst_proc = mc_model_checker->get_remote_process().resolve_actor(simgrid::mc::remote(comm->dst_actor_.get()));
557 std::size_t Api::get_remote_heap_bytes() const
559 RemoteProcess& process = mc_model_checker->get_remote_process();
560 auto heap_bytes_used = mmalloc_get_bytes_used_remote(process.get_heap()->heaplimit, process.get_malloc_info());
561 return heap_bytes_used;
564 void Api::mc_inc_visited_states() const
566 mc_model_checker->visited_states++;
569 void Api::mc_inc_executed_trans() const
571 mc_model_checker->executed_transitions++;
574 unsigned long Api::mc_get_visited_states() const
576 return mc_model_checker->visited_states;
579 unsigned long Api::mc_get_executed_trans() const
581 return mc_model_checker->executed_transitions;
584 void Api::mc_check_deadlock() const
586 if (mc_model_checker->checkDeadlock()) {
588 throw DeadlockError();
592 /** Get the issuer of a simcall (`req->issuer`)
594 * In split-process mode, it does the black magic necessary to get an address
595 * of a (shallow) copy of the data structure the issuer SIMIX actor in the local
598 * @param process the MCed process
599 * @param req the simcall (copied in the local process)
601 smx_actor_t Api::simcall_get_issuer(s_smx_simcall const* req) const
603 xbt_assert(mc_model_checker != nullptr);
605 // This is the address of the smx_actor in the MCed process:
606 auto address = simgrid::mc::remote(req->issuer_);
608 // Lookup by address:
609 for (auto& actor : mc_model_checker->get_remote_process().actors())
610 if (actor.address == address)
611 return actor.copy.get_buffer();
612 for (auto& actor : mc_model_checker->get_remote_process().dead_actors())
613 if (actor.address == address)
614 return actor.copy.get_buffer();
616 xbt_die("Issuer not found");
619 long Api::simcall_get_actor_id(s_smx_simcall const* req) const
621 return simcall_get_issuer(req)->get_pid();
624 RemotePtr<kernel::activity::MailboxImpl> Api::get_mbox_remote_addr(smx_simcall_t const req) const
626 if (req->call_ == Simcall::COMM_ISEND)
627 return remote(simcall_comm_isend__get__mbox(req));
628 if (req->call_ == Simcall::COMM_IRECV)
629 return remote(simcall_comm_irecv__get__mbox(req));
633 RemotePtr<kernel::activity::ActivityImpl> Api::get_comm_remote_addr(smx_simcall_t const req) const
635 if (req->call_ == Simcall::COMM_ISEND)
636 return remote(simcall_comm_isend__getraw__result(req));
637 if (req->call_ == Simcall::COMM_IRECV)
638 return remote(simcall_comm_irecv__getraw__result(req));
642 bool Api::mc_is_null() const
644 auto is_null = (mc_model_checker == nullptr) ? true : false;
648 Checker* Api::mc_get_checker() const
650 return mc_model_checker->getChecker();
653 void Api::handle_simcall(Transition const& transition) const
655 mc_model_checker->handle_simcall(transition);
658 void Api::mc_wait_for_requests() const
660 mc_model_checker->wait_for_requests();
663 void Api::mc_exit(int status) const
665 mc_model_checker->exit(status);
668 void Api::dump_record_path() const
670 simgrid::mc::dumpRecordPath();
673 smx_simcall_t Api::mc_state_choose_request(simgrid::mc::State* state) const
675 RemoteProcess& process = mc_model_checker->get_remote_process();
676 for (auto& actor : process.actors()) {
677 /* Only consider the actors that were marked as interleaving by the checker algorithm */
678 if (not state->actor_states_[actor.copy.get_buffer()->get_pid()].is_todo())
681 smx_simcall_t res = MC_state_choose_request_for_process(process, state, actor.copy.get_buffer());
688 std::list<transition_detail_t> Api::get_enabled_transitions(simgrid::mc::State* state) const
690 std::list<transition_detail_t> tr_list{};
692 for (auto& actor : mc_model_checker->get_remote_process().actors()) {
693 auto actor_pid = actor.copy.get_buffer()->get_pid();
694 auto actor_impl = actor.copy.get_buffer();
696 // Only consider the actors that were marked as interleaving by the checker algorithm
697 if (not state->actor_states_[actor_pid].is_todo())
699 // Not executable in the application
700 if (not simgrid::mc::actor_is_enabled(actor_impl))
703 auto transition = std::make_unique<s_transition_detail>();
704 Simcall simcall_call = actor_impl->simcall_.call_;
705 smx_simcall_t simcall = &actor_impl->simcall_;
706 transition->call_ = simcall_call;
707 switch (simcall_call) {
708 case Simcall::COMM_ISEND:
709 case Simcall::COMM_IRECV:
710 transition->mbox_remote_addr = get_mbox_remote_addr(simcall);
711 transition->comm_remote_addr = get_comm_remote_addr(simcall);
717 tr_list.emplace_back(std::move(transition));
723 std::string Api::request_to_string(smx_simcall_t req, int value) const
725 xbt_assert(mc_model_checker != nullptr, "Must be called from MCer");
730 smx_actor_t issuer = simcall_get_issuer(req);
732 if (issuer->simcall_.observer_ != nullptr)
733 return mc_model_checker->simcall_to_string(issuer->get_pid(), value);
735 switch (req->call_) {
736 case Simcall::COMM_ISEND:
738 args = "src=" + get_actor_string(issuer);
739 args += ", buff=" + pointer_to_string(simcall_comm_isend__get__src_buff(req));
740 args += ", size=" + buff_size_to_string(simcall_comm_isend__get__src_buff_size(req));
743 case Simcall::COMM_IRECV: {
744 size_t* remote_size = simcall_comm_irecv__get__dst_buff_size(req);
747 mc_model_checker->get_remote_process().read_bytes(&size, sizeof(size), remote(remote_size));
750 args = "dst=" + get_actor_string(issuer);
751 args += ", buff=" + pointer_to_string(simcall_comm_irecv__get__dst_buff(req));
752 args += ", size=" + buff_size_to_string(size);
756 case Simcall::COMM_WAIT: {
757 simgrid::kernel::activity::CommImpl* remote_act = simcall_comm_wait__get__comm(req);
759 type = "WaitTimeout";
760 args = "comm=" + pointer_to_string(remote_act);
764 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_activity;
765 const simgrid::kernel::activity::CommImpl* act;
766 mc_model_checker->get_remote_process().read(temp_activity, remote(remote_act));
767 act = temp_activity.get_buffer();
769 smx_actor_t src_proc =
770 mc_model_checker->get_remote_process().resolve_actor(simgrid::mc::remote(act->src_actor_.get()));
771 smx_actor_t dst_proc =
772 mc_model_checker->get_remote_process().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) + "]";
779 case Simcall::COMM_TEST: {
780 simgrid::kernel::activity::CommImpl* remote_act = simcall_comm_test__get__comm(req);
781 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_activity;
782 const simgrid::kernel::activity::CommImpl* act;
783 mc_model_checker->get_remote_process().read(temp_activity, remote(remote_act));
784 act = temp_activity.get_buffer();
786 if (act->src_actor_.get() == nullptr || act->dst_actor_.get() == nullptr) {
788 args = "comm=" + pointer_to_string(remote_act);
792 smx_actor_t src_proc =
793 mc_model_checker->get_remote_process().resolve_actor(simgrid::mc::remote(act->src_actor_.get()));
794 smx_actor_t dst_proc =
795 mc_model_checker->get_remote_process().resolve_actor(simgrid::mc::remote(act->dst_actor_.get()));
796 args = "comm=" + pointer_to_string(remote_act);
797 args += " [" + get_actor_string(src_proc) + " -> " + get_actor_string(dst_proc) + "]";
802 case Simcall::COMM_WAITANY: {
804 size_t count = simcall_comm_waitany__get__count(req);
806 simgrid::kernel::activity::CommImpl* remote_sync;
808 mc_model_checker->get_remote_process().read(remote(simcall_comm_waitany__get__comms(req) + value));
809 args = "comm=" + pointer_to_string(remote_sync) + xbt::string_printf("(%d of %zu)", value + 1, count);
811 args = "comm at idx " + std::to_string(value);
815 case Simcall::COMM_TESTANY:
817 type = "TestAny FALSE";
821 args = xbt::string_printf("(%d of %zu)", value + 1, simcall_comm_testany__get__count(req));
826 type = SIMIX_simcall_name(req->call_);
831 return "[" + get_actor_string(issuer) + "] " + type + "(" + args + ")";
834 std::string Api::request_get_dot_output(smx_simcall_t req, int value) const
836 const smx_actor_t issuer = simcall_get_issuer(req);
837 const char* color = get_color(issuer->get_pid() - 1);
841 if (req->observer_ != nullptr) {
842 label = mc_model_checker->simcall_dot_label(issuer->get_pid(), value);
844 switch (req->call_) {
845 case Simcall::COMM_ISEND:
846 label = "[" + get_actor_dot_label(issuer) + "] iSend";
849 case Simcall::COMM_IRECV:
850 label = "[" + get_actor_dot_label(issuer) + "] iRecv";
853 case Simcall::COMM_WAIT:
855 label = "[" + get_actor_dot_label(issuer) + "] WaitTimeout";
857 kernel::activity::ActivityImpl* remote_act = simcall_comm_wait__get__comm(req);
858 Remote<kernel::activity::CommImpl> temp_comm;
859 mc_model_checker->get_remote_process().read(temp_comm,
860 remote(static_cast<kernel::activity::CommImpl*>(remote_act)));
861 const kernel::activity::CommImpl* comm = temp_comm.get_buffer();
863 const kernel::actor::ActorImpl* src_proc =
864 mc_model_checker->get_remote_process().resolve_actor(mc::remote(comm->src_actor_.get()));
865 const kernel::actor::ActorImpl* dst_proc =
866 mc_model_checker->get_remote_process().resolve_actor(mc::remote(comm->dst_actor_.get()));
867 label = "[" + get_actor_dot_label(issuer) + "] Wait";
868 label += " [(" + std::to_string(src_proc ? src_proc->get_pid() : 0) + ")";
869 label += "->(" + std::to_string(dst_proc ? dst_proc->get_pid() : 0) + ")]";
873 case Simcall::COMM_TEST: {
874 kernel::activity::ActivityImpl* remote_act = simcall_comm_test__get__comm(req);
875 Remote<simgrid::kernel::activity::CommImpl> temp_comm;
876 mc_model_checker->get_remote_process().read(temp_comm,
877 remote(static_cast<kernel::activity::CommImpl*>(remote_act)));
878 const kernel::activity::CommImpl* comm = temp_comm.get_buffer();
879 if (comm->src_actor_.get() == nullptr || comm->dst_actor_.get() == nullptr) {
880 label = "[" + get_actor_dot_label(issuer) + "] Test FALSE";
882 label = "[" + get_actor_dot_label(issuer) + "] Test TRUE";
887 case Simcall::COMM_WAITANY:
888 label = "[" + get_actor_dot_label(issuer) + "] WaitAny";
889 label += xbt::string_printf(" [%d of %zu]", value + 1, simcall_comm_waitany__get__count(req));
892 case Simcall::COMM_TESTANY:
894 label = "[" + get_actor_dot_label(issuer) + "] TestAny FALSE";
896 label = "[" + get_actor_dot_label(issuer) + "] TestAny TRUE";
897 label += xbt::string_printf(" [%d of %zu]", value + 1, simcall_comm_testany__get__count(req));
905 return "label = \"" + label + "\", color = " + color + ", fontcolor = " + color;
909 int Api::get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const
911 simgrid::smpi::Request mpi_request;
912 void* simcall_data = nullptr;
913 if (type == Simcall::COMM_ISEND)
914 simcall_data = simcall_comm_isend__get__data(simcall);
915 else if (type == Simcall::COMM_IRECV)
916 simcall_data = simcall_comm_irecv__get__data(simcall);
917 mc_model_checker->get_remote_process().read(&mpi_request, remote(static_cast<smpi::Request*>(simcall_data)));
918 return mpi_request.tag();
922 void Api::restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const
924 system_state->restore(&mc_model_checker->get_remote_process());
927 void Api::log_state() const
929 session_singleton->log_state();
932 bool Api::snapshot_equal(const Snapshot* s1, const Snapshot* s2) const
934 return simgrid::mc::snapshot_equal(s1, s2);
937 simgrid::mc::Snapshot* Api::take_snapshot(int num_state) const
939 auto snapshot = new simgrid::mc::Snapshot(num_state);
943 void Api::s_close() const
945 session_singleton->close();
948 void Api::execute(Transition& transition, smx_simcall_t simcall) const
950 /* FIXME: once all simcalls have observers, kill the simcall parameter and use mc_model_checker->simcall_to_string() */
951 transition.textual = request_to_string(simcall, transition.times_considered_);
952 session_singleton->execute(transition);
955 void Api::automaton_load(const char* file) const
957 MC_automaton_load(file);
960 std::vector<int> Api::automaton_propositional_symbol_evaluate() const
962 unsigned int cursor = 0;
963 std::vector<int> values;
964 xbt_automaton_propositional_symbol_t ps = nullptr;
965 xbt_dynar_foreach (mc::property_automaton->propositional_symbols, cursor, ps)
966 values.push_back(xbt_automaton_propositional_symbol_evaluate(ps));
970 std::vector<xbt_automaton_state_t> Api::get_automaton_state() const
972 std::vector<xbt_automaton_state_t> automaton_stack;
973 unsigned int cursor = 0;
974 xbt_automaton_state_t automaton_state;
975 xbt_dynar_foreach (mc::property_automaton->states, cursor, automaton_state)
976 if (automaton_state->type == -1)
977 automaton_stack.push_back(automaton_state);
978 return automaton_stack;
981 int Api::compare_automaton_exp_label(const xbt_automaton_exp_label* l) const
983 unsigned int cursor = 0;
984 xbt_automaton_propositional_symbol_t p = nullptr;
985 xbt_dynar_foreach (simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
986 if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
992 void Api::set_property_automaton(xbt_automaton_state_t const& automaton_state) const
994 mc::property_automaton->current_state = automaton_state;
997 xbt_automaton_exp_label_t Api::get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const
999 const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
1000 return transition->label;
1003 xbt_automaton_state_t Api::get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const
1005 const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
1006 return transition->dst;
1010 } // namespace simgrid