Logo AND Algorithmique Numérique Distribuée

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