Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
707a6d0d99425d359153f3282c11602b7d211dda
[simgrid.git] / src / mc / mc_state.cpp
1 /* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved.          */
2
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. */
5
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"
10 #include "src/mc/mc_xbt.hpp"
11
12 #include <boost/range/algorithm.hpp>
13
14 using simgrid::mc::remote;
15
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_state, mc, "Logging specific to MC (state)");
17
18 namespace simgrid {
19 namespace mc {
20
21 State::State(unsigned long state_number) : num(state_number)
22 {
23   this->internal_comm.clear();
24   std::memset(&this->internal_req, 0, sizeof(this->internal_req));
25   std::memset(&this->executed_req, 0, sizeof(this->executed_req));
26
27   actorStates.resize(MC_smx_get_maxpid());
28   /* Stateful model checking */
29   if ((_sg_mc_checkpoint > 0 && (state_number % _sg_mc_checkpoint == 0)) || _sg_mc_termination) {
30     system_state = simgrid::mc::take_snapshot(num);
31     if (_sg_mc_comms_determinism || _sg_mc_send_determinism) {
32       MC_state_copy_incomplete_communications_pattern(this);
33       MC_state_copy_index_communications_pattern(this);
34     }
35   }
36 }
37
38 std::size_t State::interleaveSize() const
39 {
40   return boost::range::count_if(this->actorStates, [](simgrid::mc::ProcessState const& p) { return p.isTodo(); });
41 }
42
43 Transition State::getTransition() const
44 {
45   return this->transition;
46 }
47
48 }
49 }
50
51 /* Search an enabled transition for the given process.
52  *
53  * This can be seen as an iterator returning the next transition of the process.
54  *
55  * We only consider the processes that are both
56  *  - marked "to be interleaved" in their ProcessState (controlled by the checker algorithm).
57  *  - which simcall can currently be executed (like a comm where the other partner is already known)
58  * Once we returned the last enabled transition of a process, it is marked done.
59  *
60  * Things can get muddled with the WAITANY and TESTANY simcalls, that are rewritten on the fly to a bunch of WAIT
61  * (resp TEST) transitions using the transition.argument field to remember what was the last returned sub-transition.
62  */
63 static inline smx_simcall_t MC_state_get_request_for_process(simgrid::mc::State* state, smx_actor_t actor)
64 {
65   /* reset the outgoing transition */
66   simgrid::mc::ProcessState* procstate = &state->actorStates[actor->get_pid()];
67   state->transition.pid                = -1;
68   state->transition.argument           = -1;
69   state->executed_req.call             = SIMCALL_NONE;
70
71   if (not simgrid::mc::actor_is_enabled(actor))
72     return nullptr; // Not executable in the application
73
74   smx_simcall_t req = nullptr;
75   switch (actor->simcall.call) {
76     case SIMCALL_COMM_WAITANY:
77       state->transition.argument = -1;
78       while (procstate->times_considered < simcall_comm_waitany__get__count(&actor->simcall)) {
79         if (simgrid::mc::request_is_enabled_by_idx(&actor->simcall, procstate->times_considered++)) {
80           state->transition.argument = procstate->times_considered - 1;
81           break;
82         }
83       }
84
85       if (procstate->times_considered >= simcall_comm_waitany__get__count(&actor->simcall))
86         procstate->setDone();
87       if (state->transition.argument != -1)
88         req = &actor->simcall;
89       break;
90
91     case SIMCALL_COMM_TESTANY: {
92       unsigned start_count       = procstate->times_considered;
93       state->transition.argument = -1;
94       while (procstate->times_considered < simcall_comm_testany__get__count(&actor->simcall))
95         if (simgrid::mc::request_is_enabled_by_idx(&actor->simcall, procstate->times_considered++)) {
96           state->transition.argument = procstate->times_considered - 1;
97           break;
98         }
99
100       if (procstate->times_considered >= simcall_comm_testany__get__count(&actor->simcall))
101         procstate->setDone();
102
103       if (state->transition.argument != -1 || start_count == 0)
104         req = &actor->simcall;
105
106       break;
107     }
108
109     case SIMCALL_COMM_WAIT: {
110       simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> remote_act =
111           remote(static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_wait__getraw__comm(&actor->simcall)));
112       simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_act;
113       mc_model_checker->process().read(temp_act, remote_act);
114       simgrid::kernel::activity::CommImpl* act = temp_act.getBuffer();
115       if (act->src_actor_.get() && act->dst_actor_.get())
116         state->transition.argument = 0;
117       else if (act->src_actor_.get() == nullptr && act->type == simgrid::kernel::activity::CommImpl::Type::READY &&
118                act->detached == 1)
119         state->transition.argument = 0;
120       else
121         state->transition.argument = -1;
122       procstate->setDone();
123       req = &actor->simcall;
124       break;
125     }
126
127     case SIMCALL_MC_RANDOM: {
128       int min_value              = simcall_mc_random__get__min(&actor->simcall);
129       state->transition.argument = procstate->times_considered + min_value;
130       procstate->times_considered++;
131       if (state->transition.argument == simcall_mc_random__get__max(&actor->simcall))
132         procstate->setDone();
133       req = &actor->simcall;
134       break;
135     }
136
137     default:
138       procstate->setDone();
139       state->transition.argument = 0;
140       req                        = &actor->simcall;
141       break;
142   }
143   if (not req)
144     return nullptr;
145
146   state->transition.pid = actor->get_pid();
147   state->executed_req = *req;
148   // Fetch the data of the request and translate it:
149   state->internal_req = *req;
150
151   /* The waitany and testany request are transformed into a wait or test request over the corresponding communication
152    * action so it can be treated later by the dependence function. */
153   switch (req->call) {
154   case SIMCALL_COMM_WAITANY: {
155     state->internal_req.call = SIMCALL_COMM_WAIT;
156     simgrid::kernel::activity::ActivityImpl* remote_comm;
157     remote_comm =
158         mc_model_checker->process().read(remote(simcall_comm_waitany__getraw__comms(req) + state->transition.argument));
159     mc_model_checker->process().read(state->internal_comm,
160                                      remote(static_cast<simgrid::kernel::activity::CommImpl*>(remote_comm)));
161     simcall_comm_wait__set__comm(&state->internal_req, state->internal_comm.getBuffer());
162     simcall_comm_wait__set__timeout(&state->internal_req, 0);
163     break;
164   }
165
166   case SIMCALL_COMM_TESTANY:
167     state->internal_req.call = SIMCALL_COMM_TEST;
168
169     if (state->transition.argument > 0) {
170       simgrid::kernel::activity::ActivityImpl* remote_comm = mc_model_checker->process().read(
171           remote(simcall_comm_testany__getraw__comms(req) + state->transition.argument));
172       mc_model_checker->process().read(state->internal_comm,
173                                        remote(static_cast<simgrid::kernel::activity::CommImpl*>(remote_comm)));
174     }
175
176     simcall_comm_test__set__comm(&state->internal_req, state->internal_comm.getBuffer());
177     simcall_comm_test__set__result(&state->internal_req, state->transition.argument);
178     break;
179
180   case SIMCALL_COMM_WAIT:
181     mc_model_checker->process().read_bytes(&state->internal_comm, sizeof(state->internal_comm),
182                                            remote(simcall_comm_wait__getraw__comm(req)));
183     simcall_comm_wait__set__comm(&state->executed_req, state->internal_comm.getBuffer());
184     simcall_comm_wait__set__comm(&state->internal_req, state->internal_comm.getBuffer());
185     break;
186
187   case SIMCALL_COMM_TEST:
188     mc_model_checker->process().read_bytes(&state->internal_comm, sizeof(state->internal_comm),
189                                            remote(simcall_comm_test__getraw__comm(req)));
190     simcall_comm_test__set__comm(&state->executed_req, state->internal_comm.getBuffer());
191     simcall_comm_test__set__comm(&state->internal_req, state->internal_comm.getBuffer());
192     break;
193
194   default:
195     /* No translation needed */
196     break;
197   }
198
199   return req;
200 }
201
202 smx_simcall_t MC_state_get_request(simgrid::mc::State* state)
203 {
204   for (auto& actor : mc_model_checker->process().actors()) {
205     /* Only consider the actors that were marked as interleaving by the checker algorithm */
206     if (not state->actorStates[actor.copy.getBuffer()->get_pid()].isTodo())
207       continue;
208
209     smx_simcall_t res = MC_state_get_request_for_process(state, actor.copy.getBuffer());
210     if (res)
211       return res;
212   }
213   return nullptr;
214 }