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"
12 #include <xbt/asserts.h>
16 #include "src/smpi/include/smpi_request.hpp"
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_api, mc, "Logging specific to MC Fasade APIs ");
21 using Simcall = simgrid::simix::Simcall;
26 /* Search an enabled transition for the given process.
28 * This can be seen as an iterator returning the next transition of the process.
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.
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.
38 static inline smx_simcall_t MC_state_choose_request_for_process(simgrid::mc::State* state, smx_actor_t actor)
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;
46 if (not simgrid::mc::actor_is_enabled(actor))
47 return nullptr; // Not executable in the application
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;
59 ++procstate->times_considered;
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_;
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;
77 ++procstate->times_considered;
80 if (procstate->times_considered >= simcall_comm_testany__get__count(&actor->simcall_))
81 procstate->set_done();
83 if (state->transition_.argument_ != -1 || start_count == 0)
84 req = &actor->simcall_;
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 &&
99 state->transition_.argument_ = 0; // OK
101 state->transition_.argument_ = -1; // timeout
102 procstate->set_done();
103 req = &actor->simcall_;
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_;
118 procstate->set_done();
119 state->transition_.argument_ = 0;
120 req = &actor->simcall_;
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;
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);
145 case Simcall::COMM_TESTANY:
146 state->internal_req_.call_ = Simcall::COMM_TEST;
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));
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_);
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());
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());
173 /* No translation needed */
180 void mc_api::initialize(char** argv)
182 simgrid::mc::session = new simgrid::mc::Session([argv] {
184 while (argv[i] != nullptr && argv[i][0] == '-')
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));
193 std::vector<simgrid::mc::ActorInformation>& mc_api::get_actors() const
195 return mc_model_checker->get_remote_simulation().actors();
198 bool mc_api::actor_is_enabled(aid_t pid) const
200 return session->actor_is_enabled(pid);
203 unsigned long mc_api::get_maxpid() const
205 return MC_smx_get_maxpid();
208 int mc_api::get_actors_size() const
210 return mc_model_checker->get_remote_simulation().actors().size();
213 bool mc_api::comm_addr_equal(const kernel::activity::CommImpl* comm_addr1, const kernel::activity::CommImpl* comm_addr2) const
215 return remote(comm_addr1) == remote(comm_addr2);
218 kernel::activity::CommImpl* mc_api::get_comm_isend_raw_addr(smx_simcall_t request) const
220 auto comm_addr = simcall_comm_isend__getraw__result(request);
221 return static_cast<kernel::activity::CommImpl*>(comm_addr);
224 kernel::activity::CommImpl* mc_api::get_comm_wait_raw_addr(smx_simcall_t request) const
226 return simcall_comm_wait__getraw__comm(request);
229 kernel::activity::CommImpl* mc_api::get_comm_waitany_raw_addr(smx_simcall_t request, int value) const
231 auto addr = mc_model_checker->get_remote_simulation().read(remote(simcall_comm_waitany__getraw__comms(request) + value));
232 return static_cast<simgrid::kernel::activity::CommImpl*>(addr);
235 std::string mc_api::get_pattern_comm_rdv(void* addr) const
237 Remote<kernel::activity::CommImpl> temp_synchro;
238 mc_model_checker->get_remote_simulation().read(temp_synchro, remote((simgrid::kernel::activity::CommImpl*)addr));
239 const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
241 char* remote_name = mc_model_checker->get_remote_simulation().read<char*>(RemotePtr<char*>(
242 (uint64_t)(synchro->get_mailbox() ? &synchro->get_mailbox()->get_name() : &synchro->mbox_cpy->get_name())));
243 auto rdv = mc_model_checker->get_remote_simulation().read_string(RemotePtr<char>(remote_name));
247 unsigned long mc_api::get_pattern_comm_src_proc(void* addr) const
249 Remote<kernel::activity::CommImpl> temp_synchro;
250 mc_model_checker->get_remote_simulation().read(temp_synchro, remote((simgrid::kernel::activity::CommImpl*)addr));
251 const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
252 auto src_proc = mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(synchro->src_actor_.get()))->get_pid();
256 unsigned long mc_api::get_pattern_comm_dst_proc(void* addr) const
258 Remote<kernel::activity::CommImpl> temp_synchro;
259 mc_model_checker->get_remote_simulation().read(temp_synchro, remote((simgrid::kernel::activity::CommImpl*)addr));
260 const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
261 auto src_proc = mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(synchro->dst_actor_.get()))->get_pid();
265 std::vector<char> mc_api::get_pattern_comm_data(void* addr) const
267 Remote<kernel::activity::CommImpl> temp_synchro;
268 mc_model_checker->get_remote_simulation().read(temp_synchro, remote((simgrid::kernel::activity::CommImpl*)addr));
269 const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
271 std::vector<char> buffer {};
272 if (synchro->src_buff_ != nullptr) {
273 buffer.resize(synchro->src_buff_size_);
274 mc_model_checker->get_remote_simulation().read_bytes(buffer.data(), buffer.size(),
275 remote(synchro->src_buff_));
280 std::vector<char> mc_api::get_pattern_comm_data(const kernel::activity::CommImpl* comm_addr) const
282 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
283 mc_model_checker->get_remote_simulation().read(temp_comm, remote((kernel::activity::CommImpl*)comm_addr));
284 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
286 std::vector<char> buffer {};
287 if (comm->src_buff_ != nullptr) {
288 buffer.resize(comm->src_buff_size_);
289 mc_model_checker->get_remote_simulation().read_bytes(buffer.data(), buffer.size(),
290 remote(comm->src_buff_));
295 const char* mc_api::get_actor_host_name(smx_actor_t actor) const
297 const char* host_name = MC_smx_actor_get_host_name(actor);
302 bool mc_api::check_send_request_detached(smx_simcall_t const& simcall) const
304 simgrid::smpi::Request mpi_request;
305 mc_model_checker->get_remote_simulation().read(
306 &mpi_request, remote(static_cast<smpi::Request*>(simcall_comm_isend__get__data(simcall))));
307 return mpi_request.detached();
311 smx_actor_t mc_api::get_src_actor(const kernel::activity::CommImpl* comm_addr) const
313 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
314 mc_model_checker->get_remote_simulation().read(temp_comm, remote((kernel::activity::CommImpl*)comm_addr));
315 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
317 auto src_proc = mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(comm->src_actor_.get()));
321 smx_actor_t mc_api::get_dst_actor(const kernel::activity::CommImpl* comm_addr) const
323 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
324 mc_model_checker->get_remote_simulation().read(temp_comm, remote((kernel::activity::CommImpl*)comm_addr));
325 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
327 auto dst_proc = mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(comm->dst_actor_.get()));
331 std::size_t mc_api::get_remote_heap_bytes() const
333 RemoteSimulation& process = mc_model_checker->get_remote_simulation();
334 auto heap_bytes_used = mmalloc_get_bytes_used_remote(process.get_heap()->heaplimit, process.get_malloc_info());
335 return heap_bytes_used;
338 void mc_api::session_initialize() const
340 session->initialize();
343 ModelChecker* mc_api::get_model_checker() const
345 return mc_model_checker;
348 void mc_api::mc_inc_visited_states() const
350 mc_model_checker->visited_states++;
353 void mc_api::mc_inc_executed_trans() const
355 mc_model_checker->executed_transitions++;
358 unsigned long mc_api::mc_get_visited_states() const
360 return mc_model_checker->visited_states;
363 unsigned long mc_api::mc_get_executed_trans() const
365 return mc_model_checker->executed_transitions;
368 bool mc_api::mc_check_deadlock() const
370 return mc_model_checker->checkDeadlock();
373 void mc_api::mc_show_deadlock() const
378 smx_actor_t mc_api::simcall_get_issuer(s_smx_simcall const* req) const
380 return MC_smx_simcall_get_issuer(req);
383 bool mc_api::mc_is_null() const
385 auto is_null = (mc_model_checker == nullptr) ? true : false;
389 Checker* mc_api::mc_get_checker() const
391 return mc_model_checker->getChecker();
394 RemoteSimulation& mc_api::mc_get_remote_simulation() const
396 return mc_model_checker->get_remote_simulation();
399 void mc_api::handle_simcall(Transition const& transition) const
401 mc_model_checker->handle_simcall(transition);
404 void mc_api::mc_wait_for_requests() const
406 mc_model_checker->wait_for_requests();
409 void mc_api::mc_exit(int status) const
411 mc_model_checker->exit(status);
414 std::string const& mc_api::mc_get_host_name(std::string const& hostname) const
416 return mc_model_checker->get_host_name(hostname);
419 void mc_api::dump_record_path() const
421 simgrid::mc::dumpRecordPath();
424 smx_simcall_t mc_api::mc_state_choose_request(simgrid::mc::State* state) const
426 for (auto& actor : mc_model_checker->get_remote_simulation().actors()) {
427 /* Only consider the actors that were marked as interleaving by the checker algorithm */
428 if (not state->actor_states_[actor.copy.get_buffer()->get_pid()].is_todo())
431 smx_simcall_t res = MC_state_choose_request_for_process(state, actor.copy.get_buffer());
438 bool mc_api::request_depend(smx_simcall_t req1, smx_simcall_t req2) const
440 return simgrid::mc::request_depend(req1, req2);
443 std::string mc_api::request_to_string(smx_simcall_t req, int value, RequestType request_type) const
445 return simgrid::mc::request_to_string(req, value, request_type).c_str();
448 std::string mc_api::request_get_dot_output(smx_simcall_t req, int value) const
450 return simgrid::mc::request_get_dot_output(req, value);
453 const char* mc_api::simcall_get_name(simgrid::simix::Simcall kind) const
455 return SIMIX_simcall_name(kind);
459 int mc_api::get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const
461 simgrid::smpi::Request mpi_request;
462 void* simcall_data = nullptr;
463 if (type == Simcall::COMM_ISEND)
464 simcall_data = simcall_comm_isend__get__data(simcall);
465 else if (type == Simcall::COMM_IRECV)
466 simcall_data = simcall_comm_irecv__get__data(simcall);
467 mc_model_checker->get_remote_simulation().read(&mpi_request, remote(static_cast<smpi::Request*>(simcall_data)));
468 return mpi_request.tag();
472 void mc_api::restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const
474 system_state->restore(&mc_model_checker->get_remote_simulation());
477 bool mc_api::snapshot_equal(const Snapshot* s1, const Snapshot* s2) const
479 return simgrid::mc::snapshot_equal(s1, s2);
482 simgrid::mc::Snapshot* mc_api::take_snapshot(int num_state) const
484 auto snapshot = new simgrid::mc::Snapshot(num_state);
488 void mc_api::s_close() const
493 void mc_api::restore_initial_state() const
495 session->restore_initial_state();
498 void mc_api::execute(Transition const& transition) const
500 session->execute(transition);
504 void mc_api::automaton_load(const char *file) const
506 MC_automaton_load(file);
510 void mc_api::log_state() const
512 session->log_state();
516 } // namespace simgrid