Logo AND Algorithmique Numérique Distribuée

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