1 /* Copyright (c) 2020-2022. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include "src/kernel/activity/MailboxImpl.hpp"
9 #include "src/kernel/activity/MutexImpl.hpp"
10 #include "src/kernel/actor/SimcallObserver.hpp"
11 #include "src/mc/Session.hpp"
12 #include "src/mc/checker/Checker.hpp"
13 #include "src/mc/mc_base.hpp"
14 #include "src/mc/mc_comm_pattern.hpp"
15 #include "src/mc/mc_exit.hpp"
16 #include "src/mc/mc_pattern.hpp"
17 #include "src/mc/mc_private.hpp"
18 #include "src/mc/remote/RemoteProcess.hpp"
19 #include "src/surf/HostImpl.hpp"
21 #include <xbt/asserts.h>
23 #include "simgrid/s4u/Host.hpp"
24 #include "xbt/string.hpp"
26 #include "src/smpi/include/smpi_request.hpp"
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(Api, mc, "Logging specific to MC Facade APIs ");
30 XBT_LOG_EXTERNAL_CATEGORY(mc_global);
32 using Simcall = simgrid::simix::Simcall;
37 static inline const char* get_color(int id)
39 static constexpr std::array<const char*, 13> colors{{"blue", "red", "green3", "goldenrod", "brown", "purple",
40 "magenta", "turquoise4", "gray25", "forestgreen", "hotpink",
42 return colors[id % colors.size()];
45 static std::string pointer_to_string(void* pointer)
47 return XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose) ? xbt::string_printf("%p", pointer) : "(verbose only)";
50 static std::string buff_size_to_string(size_t buff_size)
52 return XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose) ? std::to_string(buff_size) : "(verbose only)";
55 /* Search an enabled transition for the given process.
57 * This can be seen as an iterator returning the next transition of the process.
59 * We only consider the processes that are both
60 * - marked "to be interleaved" in their ActorState (controlled by the checker algorithm).
61 * - which simcall can currently be executed (like a comm where the other partner is already known)
62 * Once we returned the last enabled transition of a process, it is marked done.
64 * Things can get muddled with the WAITANY and TESTANY simcalls, that are rewritten on the fly to a bunch of WAIT
65 * (resp TEST) transitions using the transition.argument field to remember what was the last returned sub-transition.
67 static inline smx_simcall_t MC_state_choose_request_for_process(const RemoteProcess& process, simgrid::mc::State* state,
70 /* reset the outgoing transition */
71 simgrid::mc::ActorState* procstate = &state->actor_states_[actor->get_pid()];
72 state->transition_.aid_ = -1;
73 state->transition_.times_considered_ = -1;
74 state->transition_.textual[0] = '\0';
75 state->executed_req_.call_ = Simcall::NONE;
77 if (not simgrid::mc::actor_is_enabled(actor))
78 return nullptr; // Not executable in the application
80 smx_simcall_t req = nullptr;
81 if (actor->simcall_.observer_ != nullptr) {
82 state->transition_.times_considered_ = procstate->get_times_considered_and_inc();
83 if (actor->simcall_.mc_max_consider_ <= procstate->get_times_considered())
84 procstate->set_done();
85 req = &actor->simcall_;
87 procstate->set_done();
88 state->transition_.times_considered_ = 0;
89 req = &actor->simcall_;
94 state->transition_.aid_ = actor->get_pid();
95 state->executed_req_ = *req;
97 // Fetch the data of the request and translate it:
98 state->internal_req_ = *req;
99 state->internal_req_.mc_value_ = state->transition_.times_considered_;
104 kernel::activity::CommImpl* Api::get_comm_or_nullptr(smx_simcall_t const r) const
106 if (auto wait = dynamic_cast<kernel::actor::ActivityWaitSimcall*>(r->observer_))
107 return static_cast<kernel::activity::CommImpl*>(wait->get_activity());
108 if (auto test = dynamic_cast<kernel::actor::ActivityTestSimcall*>(r->observer_))
109 return static_cast<kernel::activity::CommImpl*>(test->get_activity());
113 /** Statically "upcast" a s_smx_actor_t into an ActorInformation
115 * This gets 'actorInfo' from '&actorInfo->copy'. It upcasts in the
116 * sense that we could achieve the same thing by having ActorInformation
117 * inherit from s_smx_actor_t but we don't really want to do that.
119 simgrid::mc::ActorInformation* Api::actor_info_cast(smx_actor_t actor) const
121 simgrid::mc::ActorInformation temp;
122 std::size_t offset = (char*)temp.copy.get_buffer() - (char*)&temp;
124 auto* process_info = reinterpret_cast<simgrid::mc::ActorInformation*>((char*)actor - offset);
128 bool Api::requests_are_dependent(RemotePtr<kernel::actor::SimcallObserver> obs1,
129 RemotePtr<kernel::actor::SimcallObserver> obs2) const
131 xbt_assert(mc_model_checker != nullptr, "Must be called from MCer");
133 return mc_model_checker->requests_are_dependent(obs1, obs2);
136 xbt::string const& Api::get_actor_host_name(smx_actor_t actor) const
138 if (mc_model_checker == nullptr)
139 return actor->get_host()->get_name();
141 const simgrid::mc::RemoteProcess* process = &mc_model_checker->get_remote_process();
143 // Read the simgrid::xbt::string in the MCed process:
144 simgrid::mc::ActorInformation* info = actor_info_cast(actor);
146 if (not info->hostname) {
147 Remote<s4u::Host> temp_host = process->read(remote(actor->get_host()));
148 auto remote_string_address = remote(&xbt::string::to_string_data(temp_host.get_buffer()->get_impl()->get_name()));
149 simgrid::xbt::string_data remote_string = process->read(remote_string_address);
150 std::vector<char> hostname(remote_string.len + 1);
151 // no need to read the terminating null byte, and thus hostname[remote_string.len] is guaranteed to be '\0'
152 process->read_bytes(hostname.data(), remote_string.len, remote(remote_string.data));
153 info->hostname = &mc_model_checker->get_host_name(hostname.data());
155 return *info->hostname;
158 xbt::string const& Api::get_actor_name(smx_actor_t actor) const
160 if (mc_model_checker == nullptr)
161 return actor->get_name();
163 simgrid::mc::ActorInformation* info = actor_info_cast(actor);
164 if (info->name.empty()) {
165 const simgrid::mc::RemoteProcess* process = &mc_model_checker->get_remote_process();
167 simgrid::xbt::string_data string_data = simgrid::xbt::string::to_string_data(actor->name_);
168 info->name = process->read_string(remote(string_data.data), string_data.len);
173 std::string Api::get_actor_string(smx_actor_t actor) const
177 res = "(" + std::to_string(actor->get_pid()) + ")";
178 if (actor->get_host())
179 res += std::string(get_actor_host_name(actor)) + " (" + std::string(get_actor_name(actor)) + ")";
181 res += get_actor_name(actor);
187 std::string Api::get_actor_dot_label(smx_actor_t actor) const
189 std::string res = "(" + std::to_string(actor->get_pid()) + ")";
190 if (actor->get_host())
191 res += get_actor_host_name(actor);
195 simgrid::mc::Checker* Api::initialize(char** argv, simgrid::mc::CheckerAlgorithm algo) const
197 auto session = new simgrid::mc::Session([argv] {
199 while (argv[i] != nullptr && argv[i][0] == '-')
201 xbt_assert(argv[i] != nullptr,
202 "Unable to find a binary to exec on the command line. Did you only pass config flags?");
203 execvp(argv[i], argv + i);
204 xbt_die("The model-checked process failed to exec(%s): %s", argv[i], strerror(errno));
207 simgrid::mc::Checker* checker;
209 case CheckerAlgorithm::CommDeterminism:
210 checker = simgrid::mc::create_communication_determinism_checker(session);
213 case CheckerAlgorithm::UDPOR:
214 checker = simgrid::mc::create_udpor_checker(session);
217 case CheckerAlgorithm::Safety:
218 checker = simgrid::mc::create_safety_checker(session);
221 case CheckerAlgorithm::Liveness:
222 checker = simgrid::mc::create_liveness_checker(session);
229 // FIXME: session and checker are never deleted
230 simgrid::mc::session_singleton = session;
231 mc_model_checker->setChecker(checker);
235 std::vector<simgrid::mc::ActorInformation>& Api::get_actors() const
237 return mc_model_checker->get_remote_process().actors();
240 unsigned long Api::get_maxpid() const
242 return mc_model_checker->get_remote_process().get_maxpid();
245 int Api::get_actors_size() const
247 return mc_model_checker->get_remote_process().actors().size();
250 RemotePtr<kernel::activity::CommImpl> Api::get_comm_isend_raw_addr(smx_simcall_t request) const
252 return remote(static_cast<kernel::activity::CommImpl*>(simcall_comm_isend__getraw__result(request)));
255 RemotePtr<kernel::activity::CommImpl> Api::get_comm_waitany_raw_addr(smx_simcall_t request, int value) const
257 auto addr = simcall_comm_waitany__getraw__comms(request) + value;
258 auto comm_addr = mc_model_checker->get_remote_process().read(remote(addr));
259 return RemotePtr<kernel::activity::CommImpl>(static_cast<kernel::activity::CommImpl*>(comm_addr));
262 std::string Api::get_pattern_comm_rdv(RemotePtr<kernel::activity::CommImpl> const& addr) const
264 Remote<kernel::activity::CommImpl> temp_activity;
265 mc_model_checker->get_remote_process().read(temp_activity, addr);
266 const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
268 char* remote_name = mc_model_checker->get_remote_process().read<char*>(RemotePtr<char*>(
269 (uint64_t)(activity->get_mailbox() ? &activity->get_mailbox()->get_name() : &activity->mbox_cpy->get_name())));
270 auto rdv = mc_model_checker->get_remote_process().read_string(RemotePtr<char>(remote_name));
274 unsigned long Api::get_pattern_comm_src_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const
276 Remote<kernel::activity::CommImpl> temp_activity;
277 mc_model_checker->get_remote_process().read(temp_activity, addr);
278 const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
280 mc_model_checker->get_remote_process().resolve_actor(mc::remote(activity->src_actor_.get()))->get_pid();
284 unsigned long Api::get_pattern_comm_dst_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const
286 Remote<kernel::activity::CommImpl> temp_activity;
287 mc_model_checker->get_remote_process().read(temp_activity, addr);
288 const kernel::activity::CommImpl* activity = temp_activity.get_buffer();
290 mc_model_checker->get_remote_process().resolve_actor(mc::remote(activity->dst_actor_.get()))->get_pid();
294 std::vector<char> Api::get_pattern_comm_data(RemotePtr<kernel::activity::CommImpl> const& addr) const
296 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
297 mc_model_checker->get_remote_process().read(temp_comm, addr);
298 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
300 std::vector<char> buffer{};
301 if (comm->src_buff_ != nullptr) {
302 buffer.resize(comm->src_buff_size_);
303 mc_model_checker->get_remote_process().read_bytes(buffer.data(), buffer.size(), remote(comm->src_buff_));
309 bool Api::check_send_request_detached(smx_simcall_t const& simcall) const
311 Remote<simgrid::smpi::Request> mpi_request;
312 mc_model_checker->get_remote_process().read(
313 mpi_request, remote(static_cast<smpi::Request*>(simcall_comm_isend__get__data(simcall))));
314 return mpi_request.get_buffer()->detached();
318 smx_actor_t Api::get_src_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
320 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
321 mc_model_checker->get_remote_process().read(temp_comm, comm_addr);
322 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
324 auto src_proc = mc_model_checker->get_remote_process().resolve_actor(simgrid::mc::remote(comm->src_actor_.get()));
328 smx_actor_t Api::get_dst_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
330 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
331 mc_model_checker->get_remote_process().read(temp_comm, comm_addr);
332 const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
334 auto dst_proc = mc_model_checker->get_remote_process().resolve_actor(simgrid::mc::remote(comm->dst_actor_.get()));
338 std::size_t Api::get_remote_heap_bytes() const
340 RemoteProcess& process = mc_model_checker->get_remote_process();
341 auto heap_bytes_used = mmalloc_get_bytes_used_remote(process.get_heap()->heaplimit, process.get_malloc_info());
342 return heap_bytes_used;
345 void Api::mc_inc_visited_states() const
347 mc_model_checker->visited_states++;
350 void Api::mc_inc_executed_trans() const
352 mc_model_checker->executed_transitions++;
355 unsigned long Api::mc_get_visited_states() const
357 return mc_model_checker->visited_states;
360 unsigned long Api::mc_get_executed_trans() const
362 return mc_model_checker->executed_transitions;
365 void Api::mc_check_deadlock() const
367 if (mc_model_checker->checkDeadlock()) {
368 XBT_CINFO(mc_global, "**************************");
369 XBT_CINFO(mc_global, "*** DEADLOCK DETECTED ***");
370 XBT_CINFO(mc_global, "**************************");
371 XBT_CINFO(mc_global, "Counter-example execution trace:");
372 for (auto const& s : mc_model_checker->getChecker()->get_textual_trace())
373 XBT_CINFO(mc_global, " %s", s.c_str());
374 simgrid::mc::dumpRecordPath();
375 simgrid::mc::session_singleton->log_state();
376 throw DeadlockError();
380 /** Get the issuer of a simcall (`req->issuer`)
382 * In split-process mode, it does the black magic necessary to get an address
383 * of a (shallow) copy of the data structure the issuer SIMIX actor in the local
386 * @param process the MCed process
387 * @param req the simcall (copied in the local process)
389 smx_actor_t Api::simcall_get_issuer(s_smx_simcall const* req) const
391 xbt_assert(mc_model_checker != nullptr);
393 // This is the address of the smx_actor in the MCed process:
394 auto address = simgrid::mc::remote(req->issuer_);
396 // Lookup by address:
397 for (auto& actor : mc_model_checker->get_remote_process().actors())
398 if (actor.address == address)
399 return actor.copy.get_buffer();
400 for (auto& actor : mc_model_checker->get_remote_process().dead_actors())
401 if (actor.address == address)
402 return actor.copy.get_buffer();
404 xbt_die("Issuer not found");
407 RemotePtr<kernel::activity::MailboxImpl> Api::get_mbox_remote_addr(smx_simcall_t const req) const
409 if (req->call_ == Simcall::COMM_ISEND)
410 return remote(simcall_comm_isend__get__mbox(req));
411 if (req->call_ == Simcall::COMM_IRECV)
412 return remote(simcall_comm_irecv__get__mbox(req));
416 RemotePtr<kernel::activity::ActivityImpl> Api::get_comm_remote_addr(smx_simcall_t const req) const
418 if (req->call_ == Simcall::COMM_ISEND)
419 return remote(simcall_comm_isend__getraw__result(req));
420 if (req->call_ == Simcall::COMM_IRECV)
421 return remote(simcall_comm_irecv__getraw__result(req));
425 void Api::handle_simcall(Transition const& transition) const
427 mc_model_checker->handle_simcall(transition);
430 void Api::mc_wait_for_requests() const
432 mc_model_checker->wait_for_requests();
435 void Api::mc_exit(int status) const
437 mc_model_checker->exit(status);
440 void Api::dump_record_path() const
442 simgrid::mc::dumpRecordPath();
445 smx_simcall_t Api::mc_state_choose_request(simgrid::mc::State* state) const
447 RemoteProcess& process = mc_model_checker->get_remote_process();
448 XBT_DEBUG("Search for an actor to run. %zu actors to consider", process.actors().size());
449 for (auto& actor : process.actors()) {
450 /* Only consider the actors that were marked as interleaving by the checker algorithm */
451 if (not state->actor_states_[actor.copy.get_buffer()->get_pid()].is_todo())
454 smx_simcall_t res = MC_state_choose_request_for_process(process, state, actor.copy.get_buffer());
456 XBT_DEBUG("Let's run actor %ld, going for transition %s", actor.copy.get_buffer()->get_pid(),
457 SIMIX_simcall_name(*res));
464 std::list<transition_detail_t> Api::get_enabled_transitions(simgrid::mc::State* state) const
466 std::list<transition_detail_t> tr_list{};
468 for (auto& actor : mc_model_checker->get_remote_process().actors()) {
469 auto actor_pid = actor.copy.get_buffer()->get_pid();
470 auto actor_impl = actor.copy.get_buffer();
472 // Only consider the actors that were marked as interleaving by the checker algorithm
473 if (not state->actor_states_[actor_pid].is_todo())
475 // Not executable in the application
476 if (not simgrid::mc::actor_is_enabled(actor_impl))
479 auto transition = std::make_unique<s_transition_detail>();
480 Simcall simcall_call = actor_impl->simcall_.call_;
481 smx_simcall_t simcall = &actor_impl->simcall_;
482 transition->call_ = simcall_call;
483 switch (simcall_call) {
484 case Simcall::COMM_ISEND:
485 case Simcall::COMM_IRECV:
486 transition->mbox_remote_addr = get_mbox_remote_addr(simcall);
487 transition->comm_remote_addr = get_comm_remote_addr(simcall);
493 tr_list.emplace_back(std::move(transition));
499 std::string Api::request_to_string(smx_simcall_t req, int value) const
501 xbt_assert(mc_model_checker != nullptr, "Must be called from MCer");
503 smx_actor_t issuer = simcall_get_issuer(req);
505 if (issuer->simcall_.observer_ != nullptr)
506 return mc_model_checker->simcall_to_string(issuer->get_pid(), value);
508 return "[" + get_actor_string(issuer) + "] " + SIMIX_simcall_name(*req) + "(unknown?)";
511 std::string Api::request_get_dot_output(smx_simcall_t req, int value) const
513 if (req->observer_ != nullptr) {
514 const smx_actor_t issuer = simcall_get_issuer(req);
515 const char* color = get_color(issuer->get_pid() - 1);
516 return "label = \"" + mc_model_checker->simcall_dot_label(issuer->get_pid(), value) + "\", color = " + color +
517 ", fontcolor = " + color;
519 return "UNIMPLEMENTED";
523 int Api::get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const
525 void* simcall_data = nullptr;
526 if (type == Simcall::COMM_ISEND)
527 simcall_data = simcall_comm_isend__get__data(simcall);
528 else if (type == Simcall::COMM_IRECV)
529 simcall_data = simcall_comm_irecv__get__data(simcall);
530 Remote<simgrid::smpi::Request> mpi_request;
531 mc_model_checker->get_remote_process().read(mpi_request, remote(static_cast<smpi::Request*>(simcall_data)));
532 return mpi_request.get_buffer()->tag();
536 void Api::restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const
538 system_state->restore(&mc_model_checker->get_remote_process());
541 void Api::log_state() const
543 session_singleton->log_state();
546 bool Api::snapshot_equal(const Snapshot* s1, const Snapshot* s2) const
548 return simgrid::mc::snapshot_equal(s1, s2);
551 simgrid::mc::Snapshot* Api::take_snapshot(int num_state) const
553 auto snapshot = new simgrid::mc::Snapshot(num_state);
557 void Api::s_close() const
559 session_singleton->close();
562 RemotePtr<simgrid::kernel::actor::SimcallObserver> Api::execute(Transition& transition, smx_simcall_t simcall) const
564 /* FIXME: once all simcalls have observers, kill the simcall parameter and use mc_model_checker->simcall_to_string() */
565 transition.textual = request_to_string(simcall, transition.times_considered_);
566 return session_singleton->execute(transition);
569 void Api::automaton_load(const char* file) const
571 MC_automaton_load(file);
574 std::vector<int> Api::automaton_propositional_symbol_evaluate() const
576 unsigned int cursor = 0;
577 std::vector<int> values;
578 xbt_automaton_propositional_symbol_t ps = nullptr;
579 xbt_dynar_foreach (mc::property_automaton->propositional_symbols, cursor, ps)
580 values.push_back(xbt_automaton_propositional_symbol_evaluate(ps));
584 std::vector<xbt_automaton_state_t> Api::get_automaton_state() const
586 std::vector<xbt_automaton_state_t> automaton_stack;
587 unsigned int cursor = 0;
588 xbt_automaton_state_t automaton_state;
589 xbt_dynar_foreach (mc::property_automaton->states, cursor, automaton_state)
590 if (automaton_state->type == -1)
591 automaton_stack.push_back(automaton_state);
592 return automaton_stack;
595 int Api::compare_automaton_exp_label(const xbt_automaton_exp_label* l) const
597 unsigned int cursor = 0;
598 xbt_automaton_propositional_symbol_t p = nullptr;
599 xbt_dynar_foreach (simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
600 if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
606 void Api::set_property_automaton(xbt_automaton_state_t const& automaton_state) const
608 mc::property_automaton->current_state = automaton_state;
611 xbt_automaton_exp_label_t Api::get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const
613 const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
614 return transition->label;
617 xbt_automaton_state_t Api::get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const
619 const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
620 return transition->dst;
624 } // namespace simgrid