Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
get_mbox() replaced by get_mbox_remote_addr()
[simgrid.git] / src / mc / api.cpp
1 #include "api.hpp"
2
3 #include "src/kernel/activity/MailboxImpl.hpp"
4 #include "src/kernel/activity/MutexImpl.hpp"
5 #include "src/mc/Session.hpp"
6 #include "src/mc/checker/SimcallInspector.hpp"
7 #include "src/mc/mc_comm_pattern.hpp"
8 #include "src/mc/mc_pattern.hpp"
9 #include "src/mc/mc_private.hpp"
10 #include "src/mc/mc_smx.hpp"
11 #include "src/mc/remote/RemoteSimulation.hpp"
12 #include <xbt/asserts.h>
13 #include <xbt/log.h>
14
15 #if HAVE_SMPI
16 #include "src/smpi/include/smpi_request.hpp"
17 #endif
18
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(Api, mc, "Logging specific to MC Fasade APIs ");
20
21 using Simcall = simgrid::simix::Simcall;
22
23 namespace simgrid {
24 namespace mc {
25
26 static inline const char* get_color(int id)
27 {
28   static constexpr std::array<const char*, 13> colors{{"blue", "red", "green3", "goldenrod", "brown", "purple",
29                                                        "magenta", "turquoise4", "gray25", "forestgreen", "hotpink",
30                                                        "lightblue", "tan"}};
31   return colors[id % colors.size()];
32 }
33
34 static char* pointer_to_string(void* pointer)
35 {
36   if (XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose))
37     return bprintf("%p", pointer);
38
39   return xbt_strdup("(verbose only)");
40 }
41
42 static char* buff_size_to_string(size_t buff_size)
43 {
44   if (XBT_LOG_ISENABLED(Api, xbt_log_priority_verbose))
45     return bprintf("%zu", buff_size);
46
47   return xbt_strdup("(verbose only)");
48 }
49
50 /* Search an enabled transition for the given process.
51  *
52  * This can be seen as an iterator returning the next transition of the process.
53  *
54  * We only consider the processes that are both
55  *  - marked "to be interleaved" in their ActorState (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.
58  *
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.
61  */
62 static inline smx_simcall_t MC_state_choose_request_for_process(simgrid::mc::State* state, smx_actor_t actor)
63 {
64   /* reset the outgoing transition */
65   simgrid::mc::ActorState* procstate = &state->actor_states_[actor->get_pid()];
66   state->transition_.pid_            = -1;
67   state->transition_.argument_       = -1;
68   state->executed_req_.call_         = Simcall::NONE;
69
70   if (not simgrid::mc::actor_is_enabled(actor))
71     return nullptr; // Not executable in the application
72
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;
81           break;
82         }
83         ++procstate->times_considered;
84       }
85
86       if (procstate->times_considered >= simcall_comm_waitany__get__count(&actor->simcall_))
87         procstate->set_done();
88       if (state->transition_.argument_ != -1)
89         req = &actor->simcall_;
90       break;
91
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;
99           break;
100         }
101         ++procstate->times_considered;
102       }
103
104       if (procstate->times_considered >= simcall_comm_testany__get__count(&actor->simcall_))
105         procstate->set_done();
106
107       if (state->transition_.argument_ != -1 || start_count == 0)
108         req = &actor->simcall_;
109
110       break;
111     }
112
113     case Simcall::COMM_WAIT: {
114       simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> remote_act =
115           remote(simcall_comm_wait__getraw__comm(&actor->simcall_));
116       simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_act;
117       mc_model_checker->get_remote_simulation().read(temp_act, remote_act);
118       const simgrid::kernel::activity::CommImpl* act = temp_act.get_buffer();
119       if (act->src_actor_.get() && act->dst_actor_.get())
120         state->transition_.argument_ = 0; // OK
121       else if (act->src_actor_.get() == nullptr && act->type_ == simgrid::kernel::activity::CommImpl::Type::READY &&
122                act->detached())
123         state->transition_.argument_ = 0; // OK
124       else
125         state->transition_.argument_ = -1; // timeout
126       procstate->set_done();
127       req = &actor->simcall_;
128       break;
129     }
130
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->set_done();
137       req = &actor->simcall_;
138       break;
139     }
140
141     default:
142       procstate->set_done();
143       state->transition_.argument_ = 0;
144       req                          = &actor->simcall_;
145       break;
146   }
147   if (not req)
148     return nullptr;
149
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;
154
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. */
157   switch (req->call_) {
158     case Simcall::COMM_WAITANY: {
159       state->internal_req_.call_ = Simcall::COMM_WAIT;
160       simgrid::kernel::activity::CommImpl* remote_comm;
161       remote_comm = mc_model_checker->get_remote_simulation().read(
162           remote(simcall_comm_waitany__get__comms(req) + state->transition_.argument_));
163       mc_model_checker->get_remote_simulation().read(state->internal_comm_, remote(remote_comm));
164       simcall_comm_wait__set__comm(&state->internal_req_, state->internal_comm_.get_buffer());
165       simcall_comm_wait__set__timeout(&state->internal_req_, 0);
166       break;
167     }
168
169     case Simcall::COMM_TESTANY:
170       state->internal_req_.call_ = Simcall::COMM_TEST;
171
172       if (state->transition_.argument_ > 0) {
173         simgrid::kernel::activity::CommImpl* remote_comm = mc_model_checker->get_remote_simulation().read(
174             remote(simcall_comm_testany__get__comms(req) + state->transition_.argument_));
175         mc_model_checker->get_remote_simulation().read(state->internal_comm_, remote(remote_comm));
176       }
177
178       simcall_comm_test__set__comm(&state->internal_req_, state->internal_comm_.get_buffer());
179       simcall_comm_test__set__result(&state->internal_req_, state->transition_.argument_);
180       break;
181
182     case Simcall::COMM_WAIT:
183       mc_model_checker->get_remote_simulation().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_.get_buffer());
186       simcall_comm_wait__set__comm(&state->internal_req_, state->internal_comm_.get_buffer());
187       break;
188
189     case Simcall::COMM_TEST:
190       mc_model_checker->get_remote_simulation().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_.get_buffer());
193       simcall_comm_test__set__comm(&state->internal_req_, state->internal_comm_.get_buffer());
194       break;
195
196     default:
197       /* No translation needed */
198       break;
199   }
200
201   return req;
202 }
203
204 simgrid::kernel::activity::CommImpl* Api::get_comm(smx_simcall_t const r) const
205 {
206   switch (r->call_) {
207     case Simcall::COMM_WAIT:
208       return simcall_comm_wait__getraw__comm(r);
209     case Simcall::COMM_TEST:
210       return simcall_comm_test__getraw__comm(r);
211     default:
212       return nullptr;
213   }
214 }
215
216 // Does half the job
217 bool Api::request_depend_asymmetric(smx_simcall_t r1, smx_simcall_t r2) const 
218 {
219   if (r1->call_ == Simcall::COMM_ISEND && r2->call_ == Simcall::COMM_IRECV)
220     return false;
221
222   if (r1->call_ == Simcall::COMM_IRECV && r2->call_ == Simcall::COMM_ISEND)
223     return false;
224
225   // Those are internal requests, we do not need indirection because those objects are copies:
226   const kernel::activity::CommImpl* synchro1 = get_comm(r1);
227   const kernel::activity::CommImpl* synchro2 = get_comm(r2);
228
229   if ((r1->call_ == Simcall::COMM_ISEND || r1->call_ == Simcall::COMM_IRECV) && r2->call_ == Simcall::COMM_WAIT) {
230     const kernel::activity::MailboxImpl* mbox = get_mbox_remote_addr(r1);
231
232     if (mbox != synchro2->mbox_cpy
233         && simcall_comm_wait__get__timeout(r2) <= 0)
234       return false;
235
236     if ((r1->issuer_ != synchro2->src_actor_.get()) && (r1->issuer_ != synchro2->dst_actor_.get()) &&
237         simcall_comm_wait__get__timeout(r2) <= 0)
238       return false;
239
240     if ((r1->call_ == Simcall::COMM_ISEND) && (synchro2->type_ == kernel::activity::CommImpl::Type::SEND) &&
241         (synchro2->src_buff_ != simcall_comm_isend__get__src_buff(r1)) && simcall_comm_wait__get__timeout(r2) <= 0)
242       return false;
243
244     if ((r1->call_ == Simcall::COMM_IRECV) && (synchro2->type_ == kernel::activity::CommImpl::Type::RECEIVE) &&
245         (synchro2->dst_buff_ != simcall_comm_irecv__get__dst_buff(r1)) && simcall_comm_wait__get__timeout(r2) <= 0)
246       return false;
247   }
248
249   /* FIXME: the following rule assumes that the result of the isend/irecv call is not stored in a buffer used in the
250    * test call. */
251 #if 0
252   if((r1->call == Simcall::COMM_ISEND || r1->call == Simcall::COMM_IRECV)
253       &&  r2->call == Simcall::COMM_TEST)
254     return false;
255 #endif
256
257   if (r1->call_ == Simcall::COMM_WAIT && (r2->call_ == Simcall::COMM_WAIT || r2->call_ == Simcall::COMM_TEST) &&
258       (synchro1->src_actor_.get() == nullptr || synchro1->dst_actor_.get() == nullptr))
259     return false;
260
261   if (r1->call_ == Simcall::COMM_TEST &&
262       (simcall_comm_test__get__comm(r1) == nullptr || synchro1->src_buff_ == nullptr || synchro1->dst_buff_ == nullptr))
263     return false;
264
265   if (r1->call_ == Simcall::COMM_TEST && r2->call_ == Simcall::COMM_WAIT &&
266       synchro1->src_buff_ == synchro2->src_buff_ && synchro1->dst_buff_ == synchro2->dst_buff_)
267     return false;
268
269   if (r1->call_ == Simcall::COMM_WAIT && r2->call_ == Simcall::COMM_TEST && synchro1->src_buff_ != nullptr &&
270       synchro1->dst_buff_ != nullptr && synchro2->src_buff_ != nullptr && synchro2->dst_buff_ != nullptr &&
271       synchro1->dst_buff_ != synchro2->src_buff_ && synchro1->dst_buff_ != synchro2->dst_buff_ &&
272       synchro2->dst_buff_ != synchro1->src_buff_)
273     return false;
274
275   return true;
276 }
277
278 void Api::initialize(char** argv) const
279 {
280   simgrid::mc::session = new simgrid::mc::Session([argv] {
281     int i = 1;
282     while (argv[i] != nullptr && argv[i][0] == '-')
283       i++;
284     xbt_assert(argv[i] != nullptr,
285                "Unable to find a binary to exec on the command line. Did you only pass config flags?");
286     execvp(argv[i], argv + i);
287     xbt_die("The model-checked process failed to exec(): %s", strerror(errno));
288   });
289 }
290
291 std::vector<simgrid::mc::ActorInformation>& Api::get_actors() const
292 {
293   return mc_model_checker->get_remote_simulation().actors();
294 }
295
296 bool Api::actor_is_enabled(aid_t pid) const
297 {
298   return session->actor_is_enabled(pid);
299 }
300
301 unsigned long Api::get_maxpid() const
302 {
303   return MC_smx_get_maxpid();
304 }
305
306 int Api::get_actors_size() const
307 {
308   return mc_model_checker->get_remote_simulation().actors().size();
309 }
310
311 RemotePtr<kernel::activity::CommImpl> Api::get_comm_isend_raw_addr(smx_simcall_t request) const
312 {
313   auto comm_addr = simgrid::simix::unmarshal_raw<simgrid::kernel::activity::ActivityImpl*>(request->result_);
314   return RemotePtr<kernel::activity::CommImpl>(static_cast<kernel::activity::CommImpl*>(comm_addr));
315 }
316
317 RemotePtr<kernel::activity::CommImpl> Api::get_comm_irecv_raw_addr(smx_simcall_t request) const
318 {
319   auto comm_addr = simgrid::simix::unmarshal_raw<simgrid::kernel::activity::ActivityImpl*>(request->result_);
320   return RemotePtr<kernel::activity::CommImpl>(static_cast<kernel::activity::CommImpl*>(comm_addr));
321 }
322
323 RemotePtr<kernel::activity::CommImpl> Api::get_comm_wait_raw_addr(smx_simcall_t request) const
324 {
325   auto comm_addr = simgrid::simix::unmarshal_raw<simgrid::kernel::activity::CommImpl*>(request->args_[0]);
326   return RemotePtr<kernel::activity::CommImpl>(static_cast<kernel::activity::CommImpl*>(comm_addr));
327 }
328
329 RemotePtr<kernel::activity::CommImpl> Api::get_comm_waitany_raw_addr(smx_simcall_t request, int value) const
330 {
331   auto addr = simgrid::simix::unmarshal_raw<simgrid::kernel::activity::CommImpl**>(request->args_[0]) + value;
332   auto comm_addr = mc_model_checker->get_remote_simulation().read(remote(addr));
333   return RemotePtr<kernel::activity::CommImpl>(static_cast<kernel::activity::CommImpl*>(comm_addr));
334 }
335
336 std::string Api::get_pattern_comm_rdv(RemotePtr<kernel::activity::CommImpl> const& addr) const
337 {
338   Remote<kernel::activity::CommImpl> temp_synchro;
339   mc_model_checker->get_remote_simulation().read(temp_synchro, addr);
340   const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
341
342   char* remote_name = mc_model_checker->get_remote_simulation().read<char*>(RemotePtr<char*>(
343       (uint64_t)(synchro->get_mailbox() ? &synchro->get_mailbox()->get_name() : &synchro->mbox_cpy->get_name())));
344   auto rdv          = mc_model_checker->get_remote_simulation().read_string(RemotePtr<char>(remote_name));
345   return rdv;
346 }
347
348 unsigned long Api::get_pattern_comm_src_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const
349 {
350   Remote<kernel::activity::CommImpl> temp_synchro;
351   mc_model_checker->get_remote_simulation().read(temp_synchro, addr);
352   const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
353   auto src_proc =
354       mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(synchro->src_actor_.get()))->get_pid();
355   return src_proc;
356 }
357
358 unsigned long Api::get_pattern_comm_dst_proc(RemotePtr<kernel::activity::CommImpl> const& addr) const
359 {
360   Remote<kernel::activity::CommImpl> temp_synchro;
361   mc_model_checker->get_remote_simulation().read(temp_synchro, addr);
362   const kernel::activity::CommImpl* synchro = temp_synchro.get_buffer();
363   auto src_proc =
364       mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(synchro->dst_actor_.get()))->get_pid();
365   return src_proc;
366 }
367
368 std::vector<char> Api::get_pattern_comm_data(RemotePtr<kernel::activity::CommImpl> const& addr) const
369 {
370   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
371   mc_model_checker->get_remote_simulation().read(temp_comm, addr);
372   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
373
374   std::vector<char> buffer{};
375   if (comm->src_buff_ != nullptr) {
376     buffer.resize(comm->src_buff_size_);
377     mc_model_checker->get_remote_simulation().read_bytes(buffer.data(), buffer.size(), remote(comm->src_buff_));
378   }
379   return buffer;
380 }
381
382 const char* Api::get_actor_host_name(smx_actor_t actor) const
383 {
384   const char* host_name = MC_smx_actor_get_host_name(actor);
385   return host_name;
386 }
387
388 #if HAVE_SMPI
389 bool Api::check_send_request_detached(smx_simcall_t const& simcall) const
390 {
391   simgrid::smpi::Request mpi_request;
392   mc_model_checker->get_remote_simulation().read(
393       &mpi_request, remote(static_cast<smpi::Request*>(simcall_comm_isend__get__data(simcall))));
394   return mpi_request.detached();
395 }
396 #endif
397
398 smx_actor_t Api::get_src_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
399 {
400   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
401   mc_model_checker->get_remote_simulation().read(temp_comm, comm_addr);
402   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
403
404   auto src_proc = mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(comm->src_actor_.get()));
405   return src_proc;
406 }
407
408 smx_actor_t Api::get_dst_actor(RemotePtr<kernel::activity::CommImpl> const& comm_addr) const
409 {
410   simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
411   mc_model_checker->get_remote_simulation().read(temp_comm, comm_addr);
412   const simgrid::kernel::activity::CommImpl* comm = temp_comm.get_buffer();
413
414   auto dst_proc = mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(comm->dst_actor_.get()));
415   return dst_proc;
416 }
417
418 std::size_t Api::get_remote_heap_bytes() const
419 {
420   RemoteSimulation& process = mc_model_checker->get_remote_simulation();
421   auto heap_bytes_used      = mmalloc_get_bytes_used_remote(process.get_heap()->heaplimit, process.get_malloc_info());
422   return heap_bytes_used;
423 }
424
425 void Api::session_initialize() const
426 {
427   session->initialize();
428 }
429
430 void Api::mc_inc_visited_states() const
431 {
432   mc_model_checker->visited_states++;
433 }
434
435 void Api::mc_inc_executed_trans() const
436 {
437   mc_model_checker->executed_transitions++;
438 }
439
440 unsigned long Api::mc_get_visited_states() const
441 {
442   return mc_model_checker->visited_states;
443 }
444
445 unsigned long Api::mc_get_executed_trans() const
446 {
447   return mc_model_checker->executed_transitions;
448 }
449
450 bool Api::mc_check_deadlock() const
451 {
452   return mc_model_checker->checkDeadlock();
453 }
454
455 void Api::mc_show_deadlock() const
456 {
457   MC_show_deadlock();
458 }
459
460 /** Get the issuer of a simcall (`req->issuer`)
461  *
462  *  In split-process mode, it does the black magic necessary to get an address
463  *  of a (shallow) copy of the data structure the issuer SIMIX actor in the local
464  *  address space.
465  *
466  *  @param process the MCed process
467  *  @param req     the simcall (copied in the local process)
468  */
469 smx_actor_t Api::simcall_get_issuer(s_smx_simcall const* req) const
470 {
471   xbt_assert(mc_model_checker != nullptr);
472
473   // This is the address of the smx_actor in the MCed process:
474   auto address = simgrid::mc::remote(req->issuer_);
475
476   // Lookup by address:
477   for (auto& actor : mc_model_checker->get_remote_simulation().actors())
478     if (actor.address == address)
479       return actor.copy.get_buffer();
480   for (auto& actor : mc_model_checker->get_remote_simulation().dead_actors())
481     if (actor.address == address)
482       return actor.copy.get_buffer();
483
484   xbt_die("Issuer not found");
485 }
486
487 long Api::simcall_get_actor_id(s_smx_simcall const* req) const
488 {
489   return simcall_get_issuer(req)->get_pid();
490 }
491
492 smx_mailbox_t Api::get_mbox_remote_addr(smx_simcall_t const req) const
493 {
494   switch (req->call_) {
495     case Simcall::COMM_ISEND:
496       return simix::unmarshal<smx_mailbox_t>(req->args_[1]); // simcall_comm_isend__get__mbox
497     case Simcall::COMM_IRECV:
498       return simix::unmarshal<smx_mailbox_t>(req->args_[1]); // simcall_comm_irecv__get__mbox
499     default:
500       return nullptr;
501   }
502 }
503
504 bool Api::mc_is_null() const
505 {
506   auto is_null = (mc_model_checker == nullptr) ? true : false;
507   return is_null;
508 }
509
510 Checker* Api::mc_get_checker() const
511 {
512   return mc_model_checker->getChecker();
513 }
514
515 void Api::set_checker(Checker* const checker) const
516 {
517   xbt_assert(mc_model_checker);
518   xbt_assert(mc_model_checker->getChecker() == nullptr);
519   mc_model_checker->setChecker(checker);
520 }
521
522 void Api::handle_simcall(Transition const& transition) const
523 {
524   mc_model_checker->handle_simcall(transition);
525 }
526
527 void Api::mc_wait_for_requests() const
528 {
529   mc_model_checker->wait_for_requests();
530 }
531
532 void Api::mc_exit(int status) const
533 {
534   mc_model_checker->exit(status);
535 }
536
537 std::string const& Api::mc_get_host_name(std::string const& hostname) const
538 {
539   return mc_model_checker->get_host_name(hostname);
540 }
541
542 void Api::dump_record_path() const
543 {
544   simgrid::mc::dumpRecordPath();
545 }
546
547 smx_simcall_t Api::mc_state_choose_request(simgrid::mc::State* state) const
548 {
549   for (auto& actor : mc_model_checker->get_remote_simulation().actors()) {
550     /* Only consider the actors that were marked as interleaving by the checker algorithm */
551     if (not state->actor_states_[actor.copy.get_buffer()->get_pid()].is_todo())
552       continue;
553
554     smx_simcall_t res = MC_state_choose_request_for_process(state, actor.copy.get_buffer());
555     if (res)
556       return res;
557   }
558   return nullptr;
559 }
560
561 bool Api::simcall_check_dependency(smx_simcall_t const req1, smx_simcall_t const req2) const
562 {
563   if (req1->issuer_ == req2->issuer_)
564     return false;
565
566   /* Wait with timeout transitions are not considered by the independence theorem, thus we consider them as dependent with all other transitions */
567   if ((req1->call_ == Simcall::COMM_WAIT && simcall_comm_wait__get__timeout(req1) > 0) ||
568       (req2->call_ == Simcall::COMM_WAIT && simcall_comm_wait__get__timeout(req2) > 0))
569     return true;
570
571   if (req1->call_ != req2->call_)
572     return request_depend_asymmetric(req1, req2) && request_depend_asymmetric(req2, req1);
573
574   // Those are internal requests, we do not need indirection because those objects are copies:
575   const kernel::activity::CommImpl* synchro1 = get_comm(req1);
576   const kernel::activity::CommImpl* synchro2 = get_comm(req2);
577
578   switch (req1->call_) {
579     case Simcall::COMM_ISEND:
580       return simcall_comm_isend__get__mbox(req1) == simcall_comm_isend__get__mbox(req2);
581     case Simcall::COMM_IRECV:
582       return simcall_comm_irecv__get__mbox(req1) == simcall_comm_irecv__get__mbox(req2);
583     case Simcall::COMM_WAIT:
584       if (synchro1->src_buff_ == synchro2->src_buff_ && synchro1->dst_buff_ == synchro2->dst_buff_)
585         return false;
586       if (synchro1->src_buff_ != nullptr && synchro1->dst_buff_ != nullptr && synchro2->src_buff_ != nullptr &&
587           synchro2->dst_buff_ != nullptr && synchro1->dst_buff_ != synchro2->src_buff_ &&
588           synchro1->dst_buff_ != synchro2->dst_buff_ && synchro2->dst_buff_ != synchro1->src_buff_)
589         return false;
590       return true;
591     default:
592       return true;
593   }
594 }
595
596 std::string Api::request_to_string(smx_simcall_t req, int value, RequestType request_type) const
597 {
598   xbt_assert(mc_model_checker != nullptr, "Must be called from MCer");
599
600   if (req->inspector_ != nullptr)
601     return req->inspector_->to_string();
602
603   bool use_remote_comm = true;
604   switch (request_type) {
605     case simgrid::mc::RequestType::simix:
606       use_remote_comm = true;
607       break;
608     case simgrid::mc::RequestType::executed:
609     case simgrid::mc::RequestType::internal:
610       use_remote_comm = false;
611       break;
612     default:
613       THROW_IMPOSSIBLE;
614   }
615
616   const char* type = nullptr;
617   char* args       = nullptr;
618
619   smx_actor_t issuer = simcall_get_issuer(req);
620
621   switch (req->call_) {
622     case Simcall::COMM_ISEND: {
623       type     = "iSend";
624       char* p  = pointer_to_string(simcall_comm_isend__get__src_buff(req));
625       char* bs = buff_size_to_string(simcall_comm_isend__get__src_buff_size(req));
626       if (issuer->get_host())
627         args = bprintf("src=(%ld)%s (%s), buff=%s, size=%s", issuer->get_pid(), MC_smx_actor_get_host_name(issuer),
628                        MC_smx_actor_get_name(issuer), p, bs);
629       else
630         args = bprintf("src=(%ld)%s, buff=%s, size=%s", issuer->get_pid(), MC_smx_actor_get_name(issuer), p, bs);
631       xbt_free(bs);
632       xbt_free(p);
633       break;
634     }
635
636     case Simcall::COMM_IRECV: {
637       size_t* remote_size = simcall_comm_irecv__get__dst_buff_size(req);
638       size_t size         = 0;
639       if (remote_size)
640         mc_model_checker->get_remote_simulation().read_bytes(&size, sizeof(size), remote(remote_size));
641
642       type     = "iRecv";
643       char* p  = pointer_to_string(simcall_comm_irecv__get__dst_buff(req));
644       char* bs = buff_size_to_string(size);
645       if (issuer->get_host())
646         args = bprintf("dst=(%ld)%s (%s), buff=%s, size=%s", issuer->get_pid(), MC_smx_actor_get_host_name(issuer),
647                        MC_smx_actor_get_name(issuer), p, bs);
648       else
649         args = bprintf("dst=(%ld)%s, buff=%s, size=%s", issuer->get_pid(), MC_smx_actor_get_name(issuer), p, bs);
650       xbt_free(bs);
651       xbt_free(p);
652       break;
653     }
654
655     case Simcall::COMM_WAIT: {
656       simgrid::kernel::activity::CommImpl* remote_act = simcall_comm_wait__getraw__comm(req);
657       char* p;
658       if (value == -1) {
659         type = "WaitTimeout";
660         p    = pointer_to_string(remote_act);
661         args = bprintf("comm=%s", p);
662       } else {
663         type = "Wait";
664         p    = pointer_to_string(remote_act);
665
666         simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_synchro;
667         const simgrid::kernel::activity::CommImpl* act;
668         if (use_remote_comm) {
669           mc_model_checker->get_remote_simulation().read(temp_synchro, remote(remote_act));
670           act = temp_synchro.get_buffer();
671         } else
672           act = remote_act;
673
674         smx_actor_t src_proc =
675             mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(act->src_actor_.get()));
676         smx_actor_t dst_proc =
677             mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(act->dst_actor_.get()));
678         args = bprintf("comm=%s [(%ld)%s (%s)-> (%ld)%s (%s)]", p, src_proc ? src_proc->get_pid() : 0,
679                        src_proc ? MC_smx_actor_get_host_name(src_proc) : "",
680                        src_proc ? MC_smx_actor_get_name(src_proc) : "", dst_proc ? dst_proc->get_pid() : 0,
681                        dst_proc ? MC_smx_actor_get_host_name(dst_proc) : "",
682                        dst_proc ? MC_smx_actor_get_name(dst_proc) : "");
683       }
684       xbt_free(p);
685       break;
686     }
687
688     case Simcall::COMM_TEST: {
689       simgrid::kernel::activity::CommImpl* remote_act = simcall_comm_test__getraw__comm(req);
690       simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_synchro;
691       const simgrid::kernel::activity::CommImpl* act;
692       if (use_remote_comm) {
693         mc_model_checker->get_remote_simulation().read(temp_synchro, remote(remote_act));
694         act = temp_synchro.get_buffer();
695       } else
696         act = remote_act;
697
698       char* p;
699       if (act->src_actor_.get() == nullptr || act->dst_actor_.get() == nullptr) {
700         type = "Test FALSE";
701         p    = pointer_to_string(remote_act);
702         args = bprintf("comm=%s", p);
703       } else {
704         type = "Test TRUE";
705         p    = pointer_to_string(remote_act);
706
707         smx_actor_t src_proc =
708             mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(act->src_actor_.get()));
709         smx_actor_t dst_proc =
710             mc_model_checker->get_remote_simulation().resolve_actor(simgrid::mc::remote(act->dst_actor_.get()));
711         args = bprintf("comm=%s [(%ld)%s (%s) -> (%ld)%s (%s)]", p, src_proc->get_pid(),
712                        MC_smx_actor_get_name(src_proc), MC_smx_actor_get_host_name(src_proc), dst_proc->get_pid(),
713                        MC_smx_actor_get_name(dst_proc), MC_smx_actor_get_host_name(dst_proc));
714       }
715       xbt_free(p);
716       break;
717     }
718
719     case Simcall::COMM_WAITANY: {
720       type         = "WaitAny";
721       size_t count = simcall_comm_waitany__get__count(req);
722       if (count > 0) {
723         simgrid::kernel::activity::CommImpl* remote_sync;
724         remote_sync =
725             mc_model_checker->get_remote_simulation().read(remote(simcall_comm_waitany__get__comms(req) + value));
726         char* p = pointer_to_string(remote_sync);
727         args    = bprintf("comm=%s (%d of %zu)", p, value + 1, count);
728         xbt_free(p);
729       } else
730         args = bprintf("comm at idx %d", value);
731       break;
732     }
733
734     case Simcall::COMM_TESTANY:
735       if (value == -1) {
736         type = "TestAny FALSE";
737         args = xbt_strdup("-");
738       } else {
739         type = "TestAny";
740         args = bprintf("(%d of %zu)", value + 1, simcall_comm_testany__get__count(req));
741       }
742       break;
743
744     case Simcall::MUTEX_TRYLOCK:
745     case Simcall::MUTEX_LOCK: {
746       if (req->call_ == Simcall::MUTEX_LOCK)
747         type = "Mutex LOCK";
748       else
749         type = "Mutex TRYLOCK";
750
751       simgrid::mc::Remote<simgrid::kernel::activity::MutexImpl> mutex;
752       mc_model_checker->get_remote_simulation().read_bytes(mutex.get_buffer(), sizeof(mutex),
753                                                            remote(req->call_ == Simcall::MUTEX_LOCK
754                                                                       ? simcall_mutex_lock__get__mutex(req)
755                                                                       : simcall_mutex_trylock__get__mutex(req)));
756       args = bprintf("locked = %d, owner = %d, sleeping = n/a", mutex.get_buffer()->is_locked(),
757                      mutex.get_buffer()->get_owner() != nullptr
758                          ? (int)mc_model_checker->get_remote_simulation()
759                                .resolve_actor(simgrid::mc::remote(mutex.get_buffer()->get_owner()))
760                                ->get_pid()
761                          : -1);
762       break;
763     }
764
765     case Simcall::MC_RANDOM:
766       type = "MC_RANDOM";
767       args = bprintf("%d", value);
768       break;
769
770     default:
771       type = SIMIX_simcall_name(req->call_);
772       args = bprintf("??");
773       break;
774   }
775
776   std::string str;
777   if (args != nullptr)
778     str = simgrid::xbt::string_printf("[(%ld)%s (%s)] %s(%s)", issuer->get_pid(), MC_smx_actor_get_host_name(issuer),
779                                       MC_smx_actor_get_name(issuer), type, args);
780   else
781     str = simgrid::xbt::string_printf("[(%ld)%s (%s)] %s ", issuer->get_pid(), MC_smx_actor_get_host_name(issuer),
782                                       MC_smx_actor_get_name(issuer), type);
783   xbt_free(args);
784   return str;
785 }
786
787 std::string Api::request_get_dot_output(smx_simcall_t req, int value) const
788 {
789   const smx_actor_t issuer = simcall_get_issuer(req);
790   const char* color        = get_color(issuer->get_pid() - 1);
791
792   if (req->inspector_ != nullptr)
793     return simgrid::xbt::string_printf("label = \"%s\", color = %s, fontcolor = %s",
794                                        req->inspector_->dot_label().c_str(), color, color);
795
796   std::string label;
797
798   switch (req->call_) {
799     case Simcall::COMM_ISEND:
800       if (issuer->get_host())
801         label = xbt::string_printf("[(%ld)%s] iSend", issuer->get_pid(), MC_smx_actor_get_host_name(issuer));
802       else
803         label = bprintf("[(%ld)] iSend", issuer->get_pid());
804       break;
805
806     case Simcall::COMM_IRECV:
807       if (issuer->get_host())
808         label = xbt::string_printf("[(%ld)%s] iRecv", issuer->get_pid(), MC_smx_actor_get_host_name(issuer));
809       else
810         label = xbt::string_printf("[(%ld)] iRecv", issuer->get_pid());
811       break;
812
813     case Simcall::COMM_WAIT:
814       if (value == -1) {
815         if (issuer->get_host())
816           label = xbt::string_printf("[(%ld)%s] WaitTimeout", issuer->get_pid(), MC_smx_actor_get_host_name(issuer));
817         else
818           label = xbt::string_printf("[(%ld)] WaitTimeout", issuer->get_pid());
819       } else {
820         kernel::activity::ActivityImpl* remote_act = simcall_comm_wait__getraw__comm(req);
821         Remote<kernel::activity::CommImpl> temp_comm;
822         mc_model_checker->get_remote_simulation().read(temp_comm,
823                                                        remote(static_cast<kernel::activity::CommImpl*>(remote_act)));
824         const kernel::activity::CommImpl* comm = temp_comm.get_buffer();
825
826         const kernel::actor::ActorImpl* src_proc =
827             mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(comm->src_actor_.get()));
828         const kernel::actor::ActorImpl* dst_proc =
829             mc_model_checker->get_remote_simulation().resolve_actor(mc::remote(comm->dst_actor_.get()));
830         if (issuer->get_host())
831           label =
832               xbt::string_printf("[(%ld)%s] Wait [(%ld)->(%ld)]", issuer->get_pid(), MC_smx_actor_get_host_name(issuer),
833                                  src_proc ? src_proc->get_pid() : 0, dst_proc ? dst_proc->get_pid() : 0);
834         else
835           label = xbt::string_printf("[(%ld)] Wait [(%ld)->(%ld)]", issuer->get_pid(),
836                                      src_proc ? src_proc->get_pid() : 0, dst_proc ? dst_proc->get_pid() : 0);
837       }
838       break;
839
840     case Simcall::COMM_TEST: {
841       kernel::activity::ActivityImpl* remote_act = simcall_comm_test__getraw__comm(req);
842       Remote<simgrid::kernel::activity::CommImpl> temp_comm;
843       mc_model_checker->get_remote_simulation().read(temp_comm,
844                                                      remote(static_cast<kernel::activity::CommImpl*>(remote_act)));
845       const kernel::activity::CommImpl* comm = temp_comm.get_buffer();
846       if (comm->src_actor_.get() == nullptr || comm->dst_actor_.get() == nullptr) {
847         if (issuer->get_host())
848           label = xbt::string_printf("[(%ld)%s] Test FALSE", issuer->get_pid(), MC_smx_actor_get_host_name(issuer));
849         else
850           label = bprintf("[(%ld)] Test FALSE", issuer->get_pid());
851       } else {
852         if (issuer->get_host())
853           label = xbt::string_printf("[(%ld)%s] Test TRUE", issuer->get_pid(), MC_smx_actor_get_host_name(issuer));
854         else
855           label = xbt::string_printf("[(%ld)] Test TRUE", issuer->get_pid());
856       }
857       break;
858     }
859
860     case Simcall::COMM_WAITANY: {
861       size_t comms_size = simcall_comm_waitany__get__count(req);
862       if (issuer->get_host())
863         label = xbt::string_printf("[(%ld)%s] WaitAny [%d of %zu]", issuer->get_pid(),
864                                    MC_smx_actor_get_host_name(issuer), value + 1, comms_size);
865       else
866         label = xbt::string_printf("[(%ld)] WaitAny [%d of %zu]", issuer->get_pid(), value + 1, comms_size);
867       break;
868     }
869
870     case Simcall::COMM_TESTANY:
871       if (value == -1) {
872         if (issuer->get_host())
873           label = xbt::string_printf("[(%ld)%s] TestAny FALSE", issuer->get_pid(), MC_smx_actor_get_host_name(issuer));
874         else
875           label = xbt::string_printf("[(%ld)] TestAny FALSE", issuer->get_pid());
876       } else {
877         if (issuer->get_host())
878           label =
879               xbt::string_printf("[(%ld)%s] TestAny TRUE [%d of %lu]", issuer->get_pid(),
880                                  MC_smx_actor_get_host_name(issuer), value + 1, simcall_comm_testany__get__count(req));
881         else
882           label = xbt::string_printf("[(%ld)] TestAny TRUE [%d of %lu]", issuer->get_pid(), value + 1,
883                                      simcall_comm_testany__get__count(req));
884       }
885       break;
886
887     case Simcall::MUTEX_TRYLOCK:
888       label = xbt::string_printf("[(%ld)] Mutex TRYLOCK", issuer->get_pid());
889       break;
890
891     case Simcall::MUTEX_LOCK:
892       label = xbt::string_printf("[(%ld)] Mutex LOCK", issuer->get_pid());
893       break;
894
895     case Simcall::MC_RANDOM:
896       if (issuer->get_host())
897         label = xbt::string_printf("[(%ld)%s] MC_RANDOM (%d)", issuer->get_pid(), MC_smx_actor_get_host_name(issuer),
898                                    value);
899       else
900         label = xbt::string_printf("[(%ld)] MC_RANDOM (%d)", issuer->get_pid(), value);
901       break;
902
903     default:
904       THROW_UNIMPLEMENTED;
905   }
906
907   return xbt::string_printf("label = \"%s\", color = %s, fontcolor = %s", label.c_str(), color, color);
908 }
909
910 const char* Api::simcall_get_name(simgrid::simix::Simcall kind) const
911 {
912   return SIMIX_simcall_name(kind);
913 }
914
915 #if HAVE_SMPI
916 int Api::get_smpi_request_tag(smx_simcall_t const& simcall, simgrid::simix::Simcall type) const
917 {
918   simgrid::smpi::Request mpi_request;
919   void* simcall_data = nullptr;
920   if (type == Simcall::COMM_ISEND)
921     simcall_data = simcall_comm_isend__get__data(simcall);
922   else if (type == Simcall::COMM_IRECV)
923     simcall_data = simcall_comm_irecv__get__data(simcall);
924   mc_model_checker->get_remote_simulation().read(&mpi_request, remote(static_cast<smpi::Request*>(simcall_data)));
925   return mpi_request.tag();
926 }
927 #endif
928
929 void Api::restore_state(std::shared_ptr<simgrid::mc::Snapshot> system_state) const
930 {
931   system_state->restore(&mc_model_checker->get_remote_simulation());
932 }
933
934 void Api::log_state() const
935 {
936   session->log_state();
937 }
938
939 bool Api::snapshot_equal(const Snapshot* s1, const Snapshot* s2) const
940 {
941   return simgrid::mc::snapshot_equal(s1, s2);
942 }
943
944 simgrid::mc::Snapshot* Api::take_snapshot(int num_state) const
945 {
946   auto snapshot = new simgrid::mc::Snapshot(num_state);
947   return snapshot;
948 }
949
950 void Api::s_close() const
951 {
952   session->close();
953 }
954
955 void Api::restore_initial_state() const
956 {
957   session->restore_initial_state();
958 }
959
960 void Api::execute(Transition const& transition) const
961 {
962   session->execute(transition);
963 }
964
965 #if SIMGRID_HAVE_MC
966 void Api::automaton_load(const char* file) const
967 {
968   MC_automaton_load(file);
969 }
970 #endif
971
972 std::vector<int> Api::automaton_propositional_symbol_evaluate() const
973 {
974   unsigned int cursor = 0;
975   std::vector<int> values;
976   xbt_automaton_propositional_symbol_t ps = nullptr;
977   xbt_dynar_foreach (mc::property_automaton->propositional_symbols, cursor, ps)
978     values.push_back(xbt_automaton_propositional_symbol_evaluate(ps));
979   return values;
980 }
981
982 std::vector<xbt_automaton_state_t> Api::get_automaton_state() const
983 {
984   std::vector<xbt_automaton_state_t> automaton_stack;
985   unsigned int cursor = 0;
986   xbt_automaton_state_t automaton_state;
987   xbt_dynar_foreach (mc::property_automaton->states, cursor, automaton_state)
988     if (automaton_state->type == -1)
989       automaton_stack.push_back(automaton_state);
990   return automaton_stack;
991 }
992
993 int Api::compare_automaton_exp_label(const xbt_automaton_exp_label* l) const
994 {
995   unsigned int cursor                    = 0;
996   xbt_automaton_propositional_symbol_t p = nullptr;
997   xbt_dynar_foreach (simgrid::mc::property_automaton->propositional_symbols, cursor, p) {
998     if (std::strcmp(xbt_automaton_propositional_symbol_get_name(p), l->u.predicat) == 0)
999       return cursor;
1000   }
1001   return -1;
1002 }
1003
1004 void Api::set_property_automaton(xbt_automaton_state_t const& automaton_state) const
1005 {
1006   mc::property_automaton->current_state = automaton_state;
1007 }
1008
1009 xbt_automaton_exp_label_t Api::get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const
1010 {
1011   const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
1012   return transition->label;
1013 }
1014
1015 xbt_automaton_state_t Api::get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const
1016 {
1017   const xbt_automaton_transition* transition = xbt_dynar_get_as(dynar, index, xbt_automaton_transition_t);
1018   return transition->dst;
1019 }
1020
1021 } // namespace mc
1022 } // namespace simgrid