1 /* Copyright (c) 2008-2019. 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. */
6 #include "src/mc/mc_comm_pattern.hpp"
7 #include "src/mc/mc_request.hpp"
8 #include "src/mc/mc_smx.hpp"
9 #include "src/mc/mc_state.hpp"
11 #include <boost/range/algorithm.hpp>
13 using simgrid::mc::remote;
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC (state)");
20 State::State(unsigned long state_number) : num(state_number)
22 this->internal_comm.clear();
23 std::memset(&this->internal_req, 0, sizeof(this->internal_req));
24 std::memset(&this->executed_req, 0, sizeof(this->executed_req));
26 actorStates.resize(MC_smx_get_maxpid());
27 /* Stateful model checking */
28 if ((_sg_mc_checkpoint > 0 && (state_number % _sg_mc_checkpoint == 0)) || _sg_mc_termination) {
29 system_state = simgrid::mc::take_snapshot(num);
30 if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
31 MC_state_copy_incomplete_communications_pattern(this);
32 MC_state_copy_index_communications_pattern(this);
37 std::size_t State::interleaveSize() const
39 return boost::range::count_if(this->actorStates, [](simgrid::mc::ProcessState const& p) { return p.isTodo(); });
42 Transition State::getTransition() const
44 return this->transition;
50 /* Search an enabled transition for the given process.
52 * This can be seen as an iterator returning the next transition of the process.
54 * We only consider the processes that are both
55 * - marked "to be interleaved" in their ProcessState (controlled by the checker algorithm).
56 * - which simcall can currently be executed (like a comm where the other partner is already known)
57 * Once we returned the last enabled transition of a process, it is marked done.
59 * Things can get muddled with the WAITANY and TESTANY simcalls, that are rewritten on the fly to a bunch of WAIT
60 * (resp TEST) transitions using the transition.argument field to remember what was the last returned sub-transition.
62 static inline smx_simcall_t MC_state_get_request_for_process(simgrid::mc::State* state, smx_actor_t actor)
64 /* reset the outgoing transition */
65 simgrid::mc::ProcessState* procstate = &state->actorStates[actor->get_pid()];
66 state->transition.pid = -1;
67 state->transition.argument = -1;
68 state->executed_req.call = SIMCALL_NONE;
70 if (not simgrid::mc::actor_is_enabled(actor))
71 return nullptr; // Not executable in the application
73 smx_simcall_t req = nullptr;
74 switch (actor->simcall.call) {
75 case SIMCALL_COMM_WAITANY:
76 state->transition.argument = -1;
77 while (procstate->times_considered < simcall_comm_waitany__get__count(&actor->simcall)) {
78 if (simgrid::mc::request_is_enabled_by_idx(&actor->simcall, procstate->times_considered)) {
79 state->transition.argument = procstate->times_considered;
80 ++procstate->times_considered;
83 ++procstate->times_considered;
86 if (procstate->times_considered >= simcall_comm_waitany__get__count(&actor->simcall))
88 if (state->transition.argument != -1)
89 req = &actor->simcall;
92 case SIMCALL_COMM_TESTANY: {
93 unsigned start_count = procstate->times_considered;
94 state->transition.argument = -1;
95 while (procstate->times_considered < simcall_comm_testany__get__count(&actor->simcall)) {
96 if (simgrid::mc::request_is_enabled_by_idx(&actor->simcall, procstate->times_considered)) {
97 state->transition.argument = procstate->times_considered;
98 ++procstate->times_considered;
101 ++procstate->times_considered;
104 if (procstate->times_considered >= simcall_comm_testany__get__count(&actor->simcall))
105 procstate->setDone();
107 if (state->transition.argument != -1 || start_count == 0)
108 req = &actor->simcall;
113 case SIMCALL_COMM_WAIT: {
114 simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> remote_act =
115 remote(static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(&actor->simcall)));
116 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_act;
117 mc_model_checker->process().read(temp_act, remote_act);
118 simgrid::kernel::activity::CommImpl* act = temp_act.getBuffer();
119 if (act->src_actor_.get() && act->dst_actor_.get())
120 state->transition.argument = 0;
121 else if (act->src_actor_.get() == nullptr && act->type_ == simgrid::kernel::activity::CommImpl::Type::READY &&
123 state->transition.argument = 0;
125 state->transition.argument = -1;
126 procstate->setDone();
127 req = &actor->simcall;
131 case SIMCALL_MC_RANDOM: {
132 int min_value = simcall_mc_random__get__min(&actor->simcall);
133 state->transition.argument = procstate->times_considered + min_value;
134 procstate->times_considered++;
135 if (state->transition.argument == simcall_mc_random__get__max(&actor->simcall))
136 procstate->setDone();
137 req = &actor->simcall;
142 procstate->setDone();
143 state->transition.argument = 0;
144 req = &actor->simcall;
150 state->transition.pid = actor->get_pid();
151 state->executed_req = *req;
152 // Fetch the data of the request and translate it:
153 state->internal_req = *req;
155 /* The waitany and testany request are transformed into a wait or test request over the corresponding communication
156 * action so it can be treated later by the dependence function. */
158 case SIMCALL_COMM_WAITANY: {
159 state->internal_req.call = SIMCALL_COMM_WAIT;
160 simgrid::kernel::activity::CommImpl* remote_comm;
162 mc_model_checker->process().read(remote(simcall_comm_waitany__get__comms(req) + state->transition.argument));
163 mc_model_checker->process().read(state->internal_comm, remote(remote_comm));
164 simcall_comm_wait__set__comm(&state->internal_req, state->internal_comm.getBuffer());
165 simcall_comm_wait__set__timeout(&state->internal_req, 0);
169 case SIMCALL_COMM_TESTANY:
170 state->internal_req.call = SIMCALL_COMM_TEST;
172 if (state->transition.argument > 0) {
173 simgrid::kernel::activity::CommImpl* remote_comm =
174 mc_model_checker->process().read(remote(simcall_comm_testany__get__comms(req) + state->transition.argument));
175 mc_model_checker->process().read(state->internal_comm, remote(remote_comm));
178 simcall_comm_test__set__comm(&state->internal_req, state->internal_comm.getBuffer());
179 simcall_comm_test__set__result(&state->internal_req, state->transition.argument);
182 case SIMCALL_COMM_WAIT:
183 mc_model_checker->process().read_bytes(&state->internal_comm, sizeof(state->internal_comm),
184 remote(simcall_comm_wait__getraw__comm(req)));
185 simcall_comm_wait__set__comm(&state->executed_req, state->internal_comm.getBuffer());
186 simcall_comm_wait__set__comm(&state->internal_req, state->internal_comm.getBuffer());
189 case SIMCALL_COMM_TEST:
190 mc_model_checker->process().read_bytes(&state->internal_comm, sizeof(state->internal_comm),
191 remote(simcall_comm_test__getraw__comm(req)));
192 simcall_comm_test__set__comm(&state->executed_req, state->internal_comm.getBuffer());
193 simcall_comm_test__set__comm(&state->internal_req, state->internal_comm.getBuffer());
197 /* No translation needed */
204 smx_simcall_t MC_state_get_request(simgrid::mc::State* state)
206 for (auto& actor : mc_model_checker->process().actors()) {
207 /* Only consider the actors that were marked as interleaving by the checker algorithm */
208 if (not state->actorStates[actor.copy.getBuffer()->get_pid()].isTodo())
211 smx_simcall_t res = MC_state_get_request_for_process(state, actor.copy.getBuffer());