Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Don't try to get front() from an empty list.
[simgrid.git] / src / simix / ActorImpl.cpp
1 /* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include <exception>
7 #include <functional>
8 #include <map>
9 #include <string>
10 #include <utility>
11
12 #include <boost/range/algorithm.hpp>
13
14 #include "xbt/ex.hpp"
15 #include "xbt/functional.hpp"
16 #include "xbt/log.h"
17 #include "xbt/sysdep.h"
18
19 #include "simgrid/s4u/Host.hpp"
20
21 #include "mc/mc.h"
22
23 #include "smx_private.h"
24 #include "src/kernel/activity/SleepImpl.hpp"
25 #include "src/kernel/activity/SynchroIo.hpp"
26 #include "src/kernel/activity/SynchroRaw.hpp"
27 #include "src/mc/mc_replay.h"
28 #include "src/mc/remote/Client.hpp"
29 #include "src/msg/msg_private.h"
30 #include "src/surf/cpu_interface.hpp"
31 #include "src/surf/surf_interface.hpp"
32
33 #ifdef HAVE_SMPI
34 #include "src/smpi/include/private.hpp"
35 #endif
36
37 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
38
39 unsigned long simix_process_maxpid = 0;
40
41 /**
42  * \brief Returns the current agent.
43  *
44  * This functions returns the currently running SIMIX process.
45  *
46  * \return The SIMIX process
47  */
48 smx_actor_t SIMIX_process_self()
49 {
50   smx_context_t self_context = SIMIX_context_self();
51
52   return (self_context != nullptr) ? self_context->process() : nullptr;
53 }
54
55 /**
56  * \brief Returns whether a process has pending asynchronous communications.
57  * \return true if there are asynchronous communications in this process
58  */
59 int SIMIX_process_has_pending_comms(smx_actor_t process) {
60
61   return process->comms.size() > 0;
62 }
63
64 /**
65  * \brief Moves a process to the list of processes to destroy.
66  */
67 void SIMIX_process_cleanup(smx_actor_t process)
68 {
69   XBT_DEBUG("Cleanup process %s (%p), waiting synchro %p", process->name.c_str(), process,
70             process->waiting_synchro.get());
71
72   process->finished = true;
73   SIMIX_process_on_exit_runall(process);
74
75   /* Unregister from the kill timer if any */
76   if (process->kill_timer != nullptr)
77     SIMIX_timer_remove(process->kill_timer);
78
79   xbt_os_mutex_acquire(simix_global->mutex);
80
81   /* cancel non-blocking communications */
82   while (not process->comms.empty()) {
83     smx_activity_t synchro = process->comms.front();
84     process->comms.pop_front();
85     simgrid::kernel::activity::CommImplPtr comm =
86         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
87
88     /* make sure no one will finish the comm after this process is destroyed,
89      * because src_proc or dst_proc would be an invalid pointer */
90
91     if (comm->src_proc == process) {
92       XBT_DEBUG("Found an unfinished send comm %p (detached = %d), state %d, src = %p, dst = %p", comm.get(),
93                 comm->detached, (int)comm->state, comm->src_proc, comm->dst_proc);
94       comm->src_proc = nullptr;
95
96     } else if (comm->dst_proc == process) {
97       XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p", comm.get(), (int)comm->state,
98                 comm->src_proc, comm->dst_proc);
99       comm->dst_proc = nullptr;
100
101       if (comm->detached && comm->src_proc != nullptr) {
102         /* the comm will be freed right now, remove it from the sender */
103         comm->src_proc->comms.remove(comm);
104       }
105     } else {
106       xbt_die("Communication synchro %p is in my list but I'm not the sender nor the receiver", synchro.get());
107     }
108     comm->cancel();
109   }
110
111   XBT_DEBUG("%p should not be run anymore",process);
112   simix_global->process_list.erase(process->pid);
113   if (process->host)
114     xbt_swag_remove(process, process->host->extension<simgrid::simix::Host>()->process_list);
115   xbt_swag_insert(process, simix_global->process_to_destroy);
116   process->context->iwannadie = 0;
117
118   xbt_os_mutex_release(simix_global->mutex);
119 }
120
121 /**
122  * Garbage collection
123  *
124  * Should be called some time to time to free the memory allocated for processes that have finished (or killed).
125  */
126 void SIMIX_process_empty_trash()
127 {
128   smx_actor_t process = static_cast<smx_actor_t>(xbt_swag_extract(simix_global->process_to_destroy));
129
130   while (process) {
131     XBT_DEBUG("Getting rid of %p",process);
132     intrusive_ptr_release(process);
133     process = static_cast<smx_actor_t>(xbt_swag_extract(simix_global->process_to_destroy));
134   }
135 }
136
137 namespace simgrid {
138 namespace simix {
139
140 ActorImpl::~ActorImpl()
141 {
142   delete this->context;
143 }
144
145 static int dying_daemon(void* exit_status, void* data)
146 {
147   std::vector<ActorImpl*>* vect = &simix_global->daemons;
148
149   auto it = std::find(vect->begin(), vect->end(), static_cast<ActorImpl*>(data));
150   xbt_assert(it != vect->end(), "The dying daemon is not a daemon after all. Please report that bug.");
151
152   /* Don't move the whole content since we don't really care about the order */
153   std::swap(*it, vect->back());
154   vect->pop_back();
155
156   return 0;
157 }
158 /** This process will be terminated automatically when the last non-daemon process finishes */
159 void ActorImpl::daemonize()
160 {
161   if (not daemon) {
162     daemon = true;
163     simix_global->daemons.push_back(this);
164     SIMIX_process_on_exit(this, dying_daemon, this);
165   }
166 }
167
168 simgrid::s4u::Actor* ActorImpl::restart()
169 {
170   XBT_DEBUG("Restarting process %s on %s", cname(), host->getCname());
171
172   // retrieve the arguments of the old process
173   // FIXME: Factorize this with SIMIX_host_add_auto_restart_process ?
174   simgrid::simix::ProcessArg arg;
175   arg.name         = name;
176   arg.code         = code;
177   arg.host         = host;
178   arg.kill_time    = SIMIX_timer_get_date(kill_timer);
179   arg.data         = userdata;
180   arg.properties   = nullptr;
181   arg.auto_restart = auto_restart;
182
183   // kill the old process
184   SIMIX_process_kill(this, (this == simix_global->maestro_process) ? this : SIMIX_process_self());
185
186   // start the new process
187   ActorImpl* actor = simix_global->create_process_function(arg.name.c_str(), std::move(arg.code), arg.data, arg.host,
188                                                            arg.properties, nullptr);
189   if (arg.kill_time >= 0)
190     simcall_process_set_kill_time(actor, arg.kill_time);
191   if (arg.auto_restart)
192     actor->auto_restart = arg.auto_restart;
193
194   return actor->ciface();
195 }
196
197 smx_activity_t ActorImpl::suspend(ActorImpl* issuer)
198 {
199   if (suspended) {
200     XBT_DEBUG("Actor '%s' is already suspended", name.c_str());
201     return nullptr;
202   }
203
204   suspended = 1;
205
206   /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
207   if (this != issuer) {
208     if (waiting_synchro)
209       waiting_synchro->suspend();
210     /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
211
212     return nullptr;
213   } else {
214     return SIMIX_execution_start(this, "suspend", 0.0, 1.0, 0.0);
215   }
216 }
217
218 void ActorImpl::resume()
219 {
220   XBT_IN("process = %p", this);
221
222   if (context->iwannadie) {
223     XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
224     return;
225   }
226
227   if (not suspended)
228     return;
229   suspended = 0;
230
231   /* resume the synchronization that was blocking the resumed actor. */
232   if (waiting_synchro)
233     waiting_synchro->resume();
234
235   XBT_OUT();
236 }
237
238 smx_activity_t ActorImpl::sleep(double duration)
239 {
240   if (host->isOff())
241     THROWF(host_error, 0, "Host %s failed, you cannot sleep there.", host->getCname());
242
243   simgrid::kernel::activity::SleepImpl* synchro = new simgrid::kernel::activity::SleepImpl();
244   synchro->host                                 = host;
245   synchro->surf_sleep                           = host->pimpl_cpu->sleep(duration);
246   synchro->surf_sleep->setData(synchro);
247   XBT_DEBUG("Create sleep synchronization %p", synchro);
248
249   return synchro;
250 }
251
252 void create_maestro(std::function<void()> code)
253 {
254   smx_actor_t maestro = nullptr;
255   /* Create maestro process and initialize it */
256   maestro = new simgrid::simix::ActorImpl();
257   maestro->pid = simix_process_maxpid++;
258   maestro->name = "";
259   maestro->userdata = nullptr;
260
261   if (not code) {
262     maestro->context = SIMIX_context_new(std::function<void()>(), nullptr, maestro);
263   } else {
264     if (not simix_global)
265       xbt_die("simix is not initialized, please call MSG_init first");
266     maestro->context = simix_global->context_factory->create_maestro(code, maestro);
267   }
268
269   maestro->simcall.issuer = maestro;
270   simix_global->maestro_process = maestro;
271 }
272
273 }
274 }
275
276 /** @brief Creates and runs the maestro process */
277 void SIMIX_maestro_create(void (*code)(void*), void* data)
278 {
279   simgrid::simix::create_maestro(std::bind(code, data));
280 }
281
282 /**
283  * \brief Internal function to create a process.
284  *
285  * This function actually creates the process.
286  * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
287  * or directly for SIMIX internal purposes. The sure thing is that it's called from maestro context.
288  *
289  * \return the process created
290  */
291 smx_actor_t SIMIX_process_create(const char* name, std::function<void()> code, void* data, simgrid::s4u::Host* host,
292                                  std::map<std::string, std::string>* properties, smx_actor_t parent_process)
293 {
294
295   XBT_DEBUG("Start process %s on host '%s'", name, host->getCname());
296
297   if (host->isOff()) {
298     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, host->getCname());
299     return nullptr;
300   }
301
302   smx_actor_t process = new simgrid::simix::ActorImpl();
303
304   xbt_assert(code && host != nullptr, "Invalid parameters");
305   /* Process data */
306   process->pid            = simix_process_maxpid++;
307   process->name           = simgrid::xbt::string(name);
308   process->host           = host;
309   process->userdata       = data;
310   process->simcall.issuer = process;
311
312   if (parent_process != nullptr) {
313     process->ppid = parent_process->pid;
314 /* SMPI process have their own data segment and each other inherit from their father */
315 #if HAVE_SMPI
316     if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP) {
317       if (parent_process->pid != 0) {
318         process->segment_index = parent_process->segment_index;
319       } else {
320         process->segment_index = process->pid - 1;
321       }
322     }
323 #endif
324   }
325
326   process->code         = code;
327
328   XBT_VERB("Create context %s", process->name.c_str());
329   process->context = SIMIX_context_new(std::move(code), simix_global->cleanup_process_function, process);
330
331   /* Add properties */
332   if (properties != nullptr)
333     for (auto kv : *properties)
334       process->setProperty(kv.first, kv.second);
335
336   /* Make sure that the process is initialized for simix, in case we are called from the Host::onCreation signal */
337   if (host->extension<simgrid::simix::Host>() == nullptr)
338     host->extension_set<simgrid::simix::Host>(new simgrid::simix::Host());
339
340   /* Add the process to its host process list */
341   xbt_swag_insert(process, host->extension<simgrid::simix::Host>()->process_list);
342
343   XBT_DEBUG("Start context '%s'", process->name.c_str());
344
345   /* Now insert it in the global process list and in the process to run list */
346   simix_global->process_list[process->pid] = process;
347   XBT_DEBUG("Inserting %s(%s) in the to_run list", process->cname(), host->getCname());
348   xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
349   intrusive_ptr_add_ref(process);
350
351   /* Tracing the process creation */
352   TRACE_msg_process_create(process->cname(), process->pid, process->host);
353
354   return process;
355 }
356
357 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
358                                  std::map<std::string, std::string>* properties, smx_actor_t parent_process)
359 {
360   // This is mostly a copy/paste from SIMIX_process_new(),
361   // it'd be nice to share some code between those two functions.
362
363   sg_host_t host = sg_host_by_name(hostname);
364   XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
365
366   if (host->isOff()) {
367     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, hostname);
368     return nullptr;
369   }
370
371   smx_actor_t process = new simgrid::simix::ActorImpl();
372   /* Process data */
373   process->pid = simix_process_maxpid++;
374   process->name = std::string(name);
375   process->host = host;
376   process->userdata       = data;
377   process->simcall.issuer = process;
378
379   if (parent_process != nullptr) {
380     process->ppid = parent_process->pid;
381     /* SMPI process have their own data segment and each other inherit from their father */
382 #if HAVE_SMPI
383     if (smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP) {
384       if (parent_process->pid != 0) {
385         process->segment_index = parent_process->segment_index;
386       } else {
387         process->segment_index = process->pid - 1;
388       }
389     }
390 #endif
391   }
392
393   /* Process data for auto-restart */
394   process->code = nullptr;
395
396   XBT_VERB("Create context %s", process->name.c_str());
397   if (not simix_global)
398     xbt_die("simix is not initialized, please call MSG_init first");
399   process->context = simix_global->context_factory->attach(simix_global->cleanup_process_function, process);
400
401   /* Add properties */
402   if (properties != nullptr)
403     for (auto kv : *properties)
404       process->setProperty(kv.first, kv.second);
405
406   /* Add the process to it's host process list */
407   xbt_swag_insert(process, host->extension<simgrid::simix::Host>()->process_list);
408
409   /* Now insert it in the global process list and in the process to run list */
410   simix_global->process_list[process->pid] = process;
411   XBT_DEBUG("Inserting %s(%s) in the to_run list", process->cname(), host->getCname());
412   xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
413
414   /* Tracing the process creation */
415   TRACE_msg_process_create(process->cname(), process->pid, process->host);
416
417   auto context = dynamic_cast<simgrid::kernel::context::AttachContext*>(process->context);
418   if (not context)
419     xbt_die("Not a suitable context");
420
421   context->attach_start();
422   return process;
423 }
424
425 void SIMIX_process_detach()
426 {
427   auto context = dynamic_cast<simgrid::kernel::context::AttachContext*>(SIMIX_context_self());
428   if (not context)
429     xbt_die("Not a suitable context");
430
431   simix_global->cleanup_process_function(context->process());
432
433   // Let maestro ignore we are still alive:
434   // xbt_swag_remove(context->process(), simix_global->process_list);
435
436   // TODO, Remove from proces list:
437   //   xbt_swag_remove(process, sg_host_simix(host)->process_list);
438
439   context->attach_stop();
440   // delete context;
441 }
442
443 /**
444  * \brief Executes the processes from simix_global->process_to_run.
445  *
446  * The processes of simix_global->process_to_run are run (in parallel if
447  * possible).  On exit, simix_global->process_to_run is empty, and
448  * simix_global->process_that_ran contains the list of processes that just ran.
449  * The two lists are swapped so, be careful when using them before and after a
450  * call to this function.
451  */
452 void SIMIX_process_runall()
453 {
454   SIMIX_context_runall();
455
456   xbt_dynar_t tmp = simix_global->process_that_ran;
457   simix_global->process_that_ran = simix_global->process_to_run;
458   simix_global->process_to_run = tmp;
459   xbt_dynar_reset(simix_global->process_to_run);
460 }
461
462 void simcall_HANDLER_process_kill(smx_simcall_t simcall, smx_actor_t process) {
463   SIMIX_process_kill(process, simcall->issuer);
464 }
465 /**
466  * \brief Internal function to kill a SIMIX process.
467  *
468  * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
469  * or directly for SIMIX internal purposes.
470  *
471  * \param process poor victim
472  * \param issuer the process which has sent the PROCESS_KILL. Important to not schedule twice the same process.
473  */
474 void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer) {
475
476   XBT_DEBUG("Killing process %s@%s", process->cname(), process->host->getCname());
477
478   process->context->iwannadie = 1;
479   process->blocked = 0;
480   process->suspended = 0;
481   process->exception = nullptr;
482
483   /* destroy the blocking synchro if any */
484   if (process->waiting_synchro != nullptr) {
485
486     simgrid::kernel::activity::ExecImplPtr exec =
487         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro);
488     simgrid::kernel::activity::CommImplPtr comm =
489         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro);
490     simgrid::kernel::activity::SleepImplPtr sleep =
491         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro);
492     simgrid::kernel::activity::RawImplPtr raw =
493         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro);
494     simgrid::kernel::activity::IoImplPtr io =
495         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro);
496
497     if (exec != nullptr) {
498       /* Nothing to do */
499     } else if (comm != nullptr) {
500       process->comms.remove(process->waiting_synchro);
501       comm->cancel();
502       // Remove first occurrence of &process->simcall:
503       auto i = boost::range::find(process->waiting_synchro->simcalls, &process->simcall);
504       if (i != process->waiting_synchro->simcalls.end())
505         process->waiting_synchro->simcalls.remove(&process->simcall);
506     } else if (sleep != nullptr) {
507       SIMIX_process_sleep_destroy(process->waiting_synchro);
508
509     } else if (raw != nullptr) {
510       SIMIX_synchro_stop_waiting(process, &process->simcall);
511
512     } else if (io != nullptr) {
513       SIMIX_io_destroy(process->waiting_synchro);
514     } else {
515       xbt_die("Unknown type of activity");
516     }
517
518     /*
519     switch (process->waiting_synchro->type) {
520     case SIMIX_SYNC_JOIN:
521       SIMIX_process_sleep_destroy(process->waiting_synchro);
522       break;
523     } */
524
525     process->waiting_synchro = nullptr;
526   }
527   if (not xbt_dynar_member(simix_global->process_to_run, &(process)) && process != issuer) {
528     XBT_DEBUG("Inserting %s in the to_run list", process->name.c_str());
529     xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
530   }
531 }
532
533 /** @brief Ask another process to raise the given exception
534  *
535  * @param process The process that should raise that exception
536  * @param cat category of exception
537  * @param value value associated to the exception
538  * @param msg string information associated to the exception
539  */
540 void SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg) {
541   SMX_EXCEPTION(process, cat, value, msg);
542
543   if (process->suspended)
544     process->resume();
545
546   /* cancel the blocking synchro if any */
547   if (process->waiting_synchro) {
548
549     simgrid::kernel::activity::ExecImplPtr exec =
550         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(process->waiting_synchro);
551     if (exec != nullptr) {
552       SIMIX_execution_cancel(process->waiting_synchro);
553     }
554
555     simgrid::kernel::activity::CommImplPtr comm =
556         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(process->waiting_synchro);
557     if (comm != nullptr) {
558       process->comms.remove(comm);
559       comm->cancel();
560     }
561
562     simgrid::kernel::activity::SleepImplPtr sleep =
563         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(process->waiting_synchro);
564     if (sleep != nullptr) {
565       SIMIX_process_sleep_destroy(process->waiting_synchro);
566       if (not xbt_dynar_member(simix_global->process_to_run, &(process)) && process != SIMIX_process_self()) {
567         XBT_DEBUG("Inserting %s in the to_run list", process->name.c_str());
568         xbt_dynar_push_as(simix_global->process_to_run, smx_actor_t, process);
569       }
570     }
571
572     simgrid::kernel::activity::RawImplPtr raw =
573         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(process->waiting_synchro);
574     if (raw != nullptr) {
575       SIMIX_synchro_stop_waiting(process, &process->simcall);
576     }
577
578     simgrid::kernel::activity::IoImplPtr io =
579         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro);
580     if (io != nullptr) {
581       SIMIX_io_destroy(process->waiting_synchro);
582     }
583   }
584   process->waiting_synchro = nullptr;
585
586 }
587
588 void simcall_HANDLER_process_killall(smx_simcall_t simcall, int reset_pid) {
589   SIMIX_process_killall(simcall->issuer, reset_pid);
590 }
591 /**
592  * \brief Kills all running processes.
593  * \param issuer this one will not be killed
594  */
595 void SIMIX_process_killall(smx_actor_t issuer, int reset_pid)
596 {
597   for (auto kv : simix_global->process_list)
598     if (kv.second != issuer)
599       SIMIX_process_kill(kv.second, issuer);
600
601   if (reset_pid > 0)
602     simix_process_maxpid = reset_pid;
603
604   SIMIX_context_runall();
605
606   SIMIX_process_empty_trash();
607 }
608
609 void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest)
610 {
611   xbt_assert((process != nullptr), "Invalid parameters");
612   xbt_swag_remove(process, process->host->extension<simgrid::simix::Host>()->process_list);
613   process->host = dest;
614   xbt_swag_insert(process, dest->extension<simgrid::simix::Host>()->process_list);
615 }
616
617 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t process)
618 {
619   smx_activity_t sync_suspend = process->suspend(simcall->issuer);
620
621   if (process != simcall->issuer) {
622     SIMIX_simcall_answer(simcall);
623   } else {
624     sync_suspend->simcalls.push_back(simcall);
625     process->waiting_synchro = sync_suspend;
626     process->waiting_synchro->suspend();
627   }
628   /* If we are suspending ourselves, then just do not finish the simcall now */
629 }
630
631 int SIMIX_process_get_maxpid() {
632   return simix_process_maxpid;
633 }
634
635 int SIMIX_process_count()
636 {
637   return simix_global->process_list.size();
638 }
639
640 void* SIMIX_process_self_get_data()
641 {
642   smx_actor_t self = SIMIX_process_self();
643
644   if (not self) {
645     return nullptr;
646   }
647   return self->getUserData();
648 }
649
650 void SIMIX_process_self_set_data(void *data)
651 {
652   SIMIX_process_self()->setUserData(data);
653 }
654
655
656 /* needs to be public and without simcall because it is called
657    by exceptions and logging events */
658 const char* SIMIX_process_self_get_name() {
659
660   smx_actor_t process = SIMIX_process_self();
661   if (process == nullptr || process == simix_global->maestro_process)
662     return "maestro";
663
664   return process->name.c_str();
665 }
666
667 smx_actor_t SIMIX_process_get_by_name(const char* name)
668 {
669   for (auto kv : simix_global->process_list)
670     if (kv.second->name == name)
671       return kv.second;
672   return nullptr;
673 }
674
675 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
676 {
677   if (process->finished) {
678     // The joined process is already finished, just wake up the issuer process right away
679     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
680     SIMIX_simcall_answer(simcall);
681     return;
682   }
683   smx_activity_t sync = SIMIX_process_join(simcall->issuer, process, timeout);
684   sync->simcalls.push_back(simcall);
685   simcall->issuer->waiting_synchro = sync;
686 }
687
688 static int SIMIX_process_join_finish(smx_process_exit_status_t status, void* synchro)
689 {
690   simgrid::kernel::activity::SleepImpl* sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(synchro);
691
692   if (sleep->surf_sleep) {
693     sleep->surf_sleep->cancel();
694
695     while (not sleep->simcalls.empty()) {
696       smx_simcall_t simcall = sleep->simcalls.front();
697       sleep->simcalls.pop_front();
698       simcall_process_sleep__set__result(simcall, SIMIX_DONE);
699       simcall->issuer->waiting_synchro = nullptr;
700       if (simcall->issuer->suspended) {
701         XBT_DEBUG("Wait! This process is suspended and can't wake up now.");
702         simcall->issuer->suspended = 0;
703         simcall_HANDLER_process_suspend(simcall, simcall->issuer);
704       } else {
705         SIMIX_simcall_answer(simcall);
706       }
707     }
708     sleep->surf_sleep->unref();
709     sleep->surf_sleep = nullptr;
710   }
711   // intrusive_ptr_release(process); // FIXME: We are leaking here. See comment in SIMIX_process_join()
712   return 0;
713 }
714
715 smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout)
716 {
717   smx_activity_t res = issuer->sleep(timeout);
718   intrusive_ptr_add_ref(res.get());
719   /* We are leaking the process here, but if we don't take the ref, we get a "use after free".
720    * The correct solution would be to derivate the type SynchroSleep into a SynchroProcessJoin,
721    * but the code is not clean enough for now for this.
722    * The C API should first be properly replaced with the C++ one, which is a fair amount of work.
723    */
724   intrusive_ptr_add_ref(process);
725   SIMIX_process_on_exit(process,
726                         [](void*, void* arg) {
727                           return simgrid::simix::kernelImmediate(
728                               [&] { return SIMIX_process_join_finish(SMX_EXIT_SUCCESS, arg); });
729                         },
730                         &*res);
731   return res;
732 }
733
734 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
735 {
736   if (MC_is_active() || MC_record_replay_is_active()) {
737     MC_process_clock_add(simcall->issuer, duration);
738     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
739     SIMIX_simcall_answer(simcall);
740     return;
741   }
742   smx_activity_t sync = simcall->issuer->sleep(duration);
743   sync->simcalls.push_back(simcall);
744   simcall->issuer->waiting_synchro = sync;
745 }
746
747 void SIMIX_process_sleep_destroy(smx_activity_t synchro)
748 {
749   XBT_DEBUG("Destroy sleep synchro %p", synchro.get());
750   simgrid::kernel::activity::SleepImplPtr sleep =
751       boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(synchro);
752
753   if (sleep->surf_sleep) {
754     sleep->surf_sleep->unref();
755     sleep->surf_sleep = nullptr;
756   }
757 }
758
759 /**
760  * \brief Calling this function makes the process to yield.
761  *
762  * Only the current process can call this function, giving back the control to maestro.
763  *
764  * \param self the current process
765  */
766 void SIMIX_process_yield(smx_actor_t self)
767 {
768   XBT_DEBUG("Yield actor '%s'", self->cname());
769
770   /* Go into sleep and return control to maestro */
771   self->context->suspend();
772
773   /* Ok, maestro returned control to us */
774   XBT_DEBUG("Control returned to me: '%s'", self->name.c_str());
775
776   if (self->new_host) {
777     SIMIX_process_change_host(self, self->new_host);
778     self->new_host = nullptr;
779   }
780
781   if (self->context->iwannadie){
782     XBT_DEBUG("I wanna die!");
783     self->finished = true;
784     /* execute the on_exit functions */
785     SIMIX_process_on_exit_runall(self);
786     /* Add the process to the list of process to restart, only if the host is down */
787     if (self->auto_restart && self->host->isOff()) {
788       SIMIX_host_add_auto_restart_process(self->host, self->cname(), self->code, self->userdata,
789                                           SIMIX_timer_get_date(self->kill_timer), self->getProperties(),
790                                           self->auto_restart);
791     }
792     XBT_DEBUG("Process %s@%s is dead", self->cname(), self->host->getCname());
793     self->context->stop();
794   }
795
796   if (self->suspended) {
797     XBT_DEBUG("Hey! I'm suspended.");
798     xbt_assert(self->exception != nullptr, "Gasp! This exception may be lost by subsequent calls.");
799     self->suspended = 0;
800     self->suspend(self);
801   }
802
803   if (self->exception != nullptr) {
804     XBT_DEBUG("Wait, maestro left me an exception");
805     std::exception_ptr exception = std::move(self->exception);
806     self->exception = nullptr;
807     std::rethrow_exception(std::move(exception));
808   }
809
810   if(SMPI_switch_data_segment && self->segment_index != -1){
811     SMPI_switch_data_segment(self->segment_index);
812   }
813 }
814
815 /* callback: termination */
816 void SIMIX_process_exception_terminate(xbt_ex_t * e)
817 {
818   xbt_ex_display(e);
819   xbt_abort();
820 }
821
822 /** @brief Returns the list of processes to run. */
823 xbt_dynar_t SIMIX_process_get_runnable()
824 {
825   return simix_global->process_to_run;
826 }
827
828 /** @brief Returns the process from PID. */
829 smx_actor_t SIMIX_process_from_PID(aid_t PID)
830 {
831   auto process = simix_global->process_list.find(PID);
832   return process == simix_global->process_list.end() ? nullptr : process->second;
833 }
834
835 /** @brief returns a dynar containing all currently existing processes */
836 xbt_dynar_t SIMIX_processes_as_dynar() {
837   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t),nullptr);
838   for (auto kv : simix_global->process_list) {
839     smx_actor_t proc = kv.second;
840     xbt_dynar_push(res,&proc);
841   }
842   return res;
843 }
844
845 void SIMIX_process_on_exit_runall(smx_actor_t process) {
846   smx_process_exit_status_t exit_status = (process->context->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
847   while (not process->on_exit.empty()) {
848     s_smx_process_exit_fun_t exit_fun = process->on_exit.back();
849     (exit_fun.fun)((void*)exit_status, exit_fun.arg);
850     process->on_exit.pop_back();
851   }
852 }
853
854 void SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data) {
855   xbt_assert(process, "current process not found: are you in maestro context ?");
856
857   s_smx_process_exit_fun_t exit_fun = {fun, data};
858
859   process->on_exit.push_back(exit_fun);
860 }
861
862 /**
863  * \brief Sets the auto-restart status of the process.
864  * If set to 1, the process will be automatically restarted when its host comes back.
865  */
866 void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart) {
867   process->auto_restart = auto_restart;
868 }
869
870 /** @brief Restart a process, starting it again from the beginning. */
871 /**
872  * \ingroup simix_process_management
873  * \brief Creates and runs a new SIMIX process.
874  *
875  * The structure and the corresponding thread are created and put in the list of ready processes.
876  *
877  * \param name a name for the process. It is for user-level information and can be nullptr.
878  * \param code the main function of the process
879  * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
880  * be nullptr.
881  * It can be retrieved with the function \ref simcall_process_get_data.
882  * \param host where the new agent is executed.
883  * \param kill_time time when the process is killed
884  * \param argc first argument passed to \a code
885  * \param argv second argument passed to \a code
886  * \param properties the properties of the process
887  * \param auto_restart either it is autorestarting or not.
888  */
889 extern "C" smx_actor_t simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host,
890                                               int argc, char** argv, std::map<std::string, std::string>* properties)
891 {
892   if (name == nullptr)
893     name = "";
894   auto wrapped_code = simgrid::xbt::wrapMain(code, argc, argv);
895   for (int i = 0; i != argc; ++i)
896     xbt_free(argv[i]);
897   xbt_free(argv);
898   smx_actor_t res = simcall_process_create(name, std::move(wrapped_code), data, host, properties);
899   return res;
900 }
901
902 smx_actor_t simcall_process_create(const char* name, std::function<void()> code, void* data, sg_host_t host,
903                                    std::map<std::string, std::string>* properties)
904 {
905   if (name == nullptr)
906     name = "";
907   smx_actor_t self = SIMIX_process_self();
908   return simgrid::simix::kernelImmediate([name, code, data, host, properties, self] {
909     return SIMIX_process_create(name, std::move(code), data, host, properties, self);
910   });
911 }