Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of https://framagit.org/simgrid/simgrid
[simgrid.git] / src / kernel / actor / ActorImpl.cpp
1 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #include "mc/mc.h"
7 #include "simgrid/Exception.hpp"
8 #include "simgrid/s4u/Actor.hpp"
9 #include "simgrid/s4u/Exec.hpp"
10 #include "src/kernel/activity/CommImpl.hpp"
11 #include "src/kernel/activity/ExecImpl.hpp"
12 #include "src/kernel/activity/IoImpl.hpp"
13 #include "src/kernel/activity/SleepImpl.hpp"
14 #include "src/kernel/activity/SynchroRaw.hpp"
15 #include "src/mc/mc_replay.hpp"
16 #include "src/mc/remote/Client.hpp"
17 #include "src/simix/smx_private.hpp"
18 #include "src/surf/HostImpl.hpp"
19 #include "src/surf/cpu_interface.hpp"
20
21 #include <boost/range/algorithm.hpp>
22
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
24
25 static unsigned long simix_process_maxpid = 0;
26
27 /**
28  * @brief Returns the current agent.
29  *
30  * This functions returns the currently running SIMIX process.
31  *
32  * @return The SIMIX process
33  */
34 smx_actor_t SIMIX_process_self()
35 {
36   simgrid::kernel::context::Context* self_context = simgrid::kernel::context::Context::self();
37
38   return (self_context != nullptr) ? self_context->get_actor() : nullptr;
39 }
40
41 /**
42  * @brief Returns whether a process has pending asynchronous communications.
43  * @return true if there are asynchronous communications in this process
44  * @deprecated
45  */
46 int SIMIX_process_has_pending_comms(smx_actor_t process)
47 {
48
49   return process->comms.size() > 0;
50 }
51
52 namespace simgrid {
53 namespace kernel {
54 namespace actor {
55
56 ActorImpl::ActorImpl(const simgrid::xbt::string& name, s4u::Host* host) : host_(host), name_(name), piface_(this)
57 {
58   pid_           = simix_process_maxpid++;
59   simcall.issuer = this;
60 }
61
62 ActorImpl::~ActorImpl() = default;
63
64 /* Become an actor in the simulation
65  *
66  * Currently this can only be called by the main thread (once) and only work with some thread factories
67  * (currently ThreadContextFactory).
68  *
69  * In the future, it might be extended in order to attach other threads created by a third party library.
70  */
71
72 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host,
73                                std::unordered_map<std::string, std::string>* properties)
74 {
75   // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
76
77   XBT_DEBUG("Attach process %s on host '%s'", name.c_str(), host->get_cname());
78
79   if (not host->is_on()) {
80     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name.c_str(), host->get_cname());
81     std::rethrow_exception(
82         std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.")));
83   }
84
85   ActorImpl* actor = new ActorImpl(xbt::string(name), host);
86   /* Actor data */
87   actor->set_user_data(data);
88   actor->code = nullptr;
89
90   XBT_VERB("Create context %s", actor->get_cname());
91   xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
92   actor->context_.reset(simix_global->context_factory->attach(actor));
93
94   /* Add properties */
95   if (properties != nullptr)
96     for (auto const& kv : *properties)
97       actor->set_property(kv.first, kv.second);
98
99   /* Add the process to it's host process list */
100   host->pimpl_->process_list_.push_back(*actor);
101
102   /* Now insert it in the global process list and in the process to run list */
103   simix_global->process_list[actor->get_pid()] = actor;
104   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
105   simix_global->actors_to_run.push_back(actor);
106   intrusive_ptr_add_ref(actor);
107
108   auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_.get());
109   xbt_assert(nullptr != context, "Not a suitable context");
110   context->attach_start();
111
112   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
113   simgrid::s4u::Actor::on_creation(*actor->ciface());
114
115   return ActorImplPtr(actor);
116 }
117 /** @brief Detach an actor attached with `attach()`
118  *
119  *  This is called when the current actor has finished its job.
120  *  Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
121  *  simulated actors and the maestro are destroyed.
122  */
123 void ActorImpl::detach()
124 {
125   auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
126   if (context == nullptr)
127     xbt_die("Not a suitable context");
128
129   context->get_actor()->cleanup();
130   context->attach_stop();
131 }
132
133 void ActorImpl::cleanup()
134 {
135   finished_ = true;
136
137   if (has_to_auto_restart() && not get_host()->is_on()) {
138     XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
139               get_cname());
140     watched_hosts.insert(get_host()->get_name());
141   }
142
143   // Execute the termination callbacks
144   bool failed = context_->iwannadie;
145   while (not on_exit.empty()) {
146     auto exit_fun = on_exit.back();
147     on_exit.pop_back();
148     exit_fun(failed);
149   }
150
151   /* cancel non-blocking activities */
152   for (auto activity : comms)
153     boost::static_pointer_cast<activity::CommImpl>(activity)->cancel();
154   comms.clear();
155
156   XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
157
158   if (this == simix_global->maestro_process) /* Do not cleanup maestro */
159     return;
160
161   XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro.get());
162
163   /* Unregister from the kill timer if any */
164   if (kill_timer != nullptr) {
165     kill_timer->remove();
166     kill_timer = nullptr;
167   }
168
169   simix_global->mutex.lock();
170
171   simix_global->process_list.erase(pid_);
172   if (host_ && host_process_list_hook.is_linked())
173     simgrid::xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
174   if (not smx_destroy_list_hook.is_linked()) {
175 #if SIMGRID_HAVE_MC
176     xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
177 #endif
178     simix_global->actors_to_destroy.push_back(*this);
179   }
180
181   simix_global->mutex.unlock();
182
183   context_->iwannadie = false; // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
184   simgrid::simix::simcall([this] { simgrid::s4u::Actor::on_destruction(*ciface()); });
185   context_->iwannadie = true;
186 }
187
188 void ActorImpl::exit()
189 {
190   context_->iwannadie = true;
191   blocked_            = false;
192   suspended_          = false;
193   exception_          = nullptr;
194
195   // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
196   if (not host_->is_on())
197     this->throw_exception(std::make_exception_ptr(ForcefulKillException("host failed")));
198
199   /* destroy the blocking synchro if any */
200   if (waiting_synchro != nullptr) {
201
202     activity::ExecImplPtr exec   = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
203     activity::CommImplPtr comm   = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
204     activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
205     activity::RawImplPtr raw     = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
206     activity::IoImplPtr io       = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
207
208     if (exec != nullptr && exec->surf_action_) {
209       exec->cancel();
210       exec->surf_action_->unref();
211       exec->surf_action_ = nullptr;
212     } else if (comm != nullptr) {
213       comms.remove(waiting_synchro);
214       comm->cancel();
215       // Remove first occurrence of &actor->simcall:
216       auto i = boost::range::find(waiting_synchro->simcalls_, &simcall);
217       if (i != waiting_synchro->simcalls_.end())
218         waiting_synchro->simcalls_.remove(&simcall);
219     } else if (sleep != nullptr) {
220       if (sleep->surf_action_)
221         sleep->surf_action_->cancel();
222       sleep->post();
223     } else if (raw != nullptr) {
224       raw->finish();
225     } else if (io != nullptr) {
226       io->cancel();
227     } else {
228       simgrid::kernel::activity::ActivityImplPtr activity = waiting_synchro;
229       xbt_die("Activity is of unknown type %s", simgrid::xbt::demangle(typeid(activity).name()).get());
230     }
231
232     waiting_synchro = nullptr;
233   }
234 }
235
236 void ActorImpl::kill(ActorImpl* actor)
237 {
238   if (actor->finished_) {
239     XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
240               actor->host_->get_cname());
241     return;
242   }
243
244   XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
245             actor->host_ ? actor->host_->get_cname() : "");
246
247   actor->exit();
248
249   if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
250           end(simix_global->actors_to_run) &&
251       actor != this) {
252     XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
253     simix_global->actors_to_run.push_back(actor);
254   }
255 }
256
257 void ActorImpl::kill_all()
258 {
259   for (auto const& kv : simix_global->process_list)
260     if (kv.second != this)
261       this->kill(kv.second);
262 }
263
264 void ActorImpl::set_kill_time(double kill_time)
265 {
266   if (kill_time <= SIMIX_get_clock())
267     return;
268   XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
269   kill_timer = simix::Timer::set(kill_time, [this] {
270     this->exit();
271     kill_timer = nullptr;
272   });
273 }
274
275 double ActorImpl::get_kill_time()
276 {
277   return kill_timer ? kill_timer->get_date() : 0;
278 }
279
280 void ActorImpl::yield()
281 {
282   XBT_DEBUG("Yield actor '%s'", get_cname());
283
284   /* Go into sleep and return control to maestro */
285   context_->suspend();
286
287   /* Ok, maestro returned control to us */
288   XBT_DEBUG("Control returned to me: '%s'", get_cname());
289
290   if (context_->iwannadie) {
291     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
292     // throw simgrid::kernel::context::ForcefulKillException(); Does not seem to properly kill the actor
293     context_->stop();
294     THROW_IMPOSSIBLE;
295   }
296
297   if (suspended_) {
298     XBT_DEBUG("Hey! I'm suspended.");
299
300     xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
301     suspended_ = false;
302     suspend(this);
303   }
304
305   if (exception_ != nullptr) {
306     XBT_DEBUG("Wait, maestro left me an exception");
307     std::exception_ptr exception = std::move(exception_);
308     exception_                   = nullptr;
309     std::rethrow_exception(std::move(exception));
310   }
311
312   if (SMPI_switch_data_segment && not finished_) {
313     SMPI_switch_data_segment(iface());
314   }
315 }
316
317 /** This actor will be terminated automatically when the last non-daemon actor finishes */
318 void ActorImpl::daemonize()
319 {
320   if (not daemon_) {
321     daemon_ = true;
322     simix_global->daemons.push_back(this);
323     SIMIX_process_on_exit(this, [this](bool) {
324       auto& vect = simix_global->daemons;
325       auto it    = std::find(vect.begin(), vect.end(), this);
326       xbt_assert(it != vect.end(), "The dying daemon is not a daemon after all. Please report that bug.");
327
328       /* Don't move the whole content since we don't really care about the order */
329       std::swap(*it, vect.back());
330       vect.pop_back();
331     });
332   }
333 }
334
335 s4u::Actor* ActorImpl::restart()
336 {
337   xbt_assert(this != simix_global->maestro_process, "Restarting maestro is not supported");
338
339   XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
340
341   // retrieve the arguments of the old actor
342   ProcessArg arg = ProcessArg(host_, this);
343
344   // kill the old actor
345   context::Context::self()->get_actor()->kill(this);
346
347   // start the new actor
348   ActorImplPtr actor =
349       ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
350   actor->set_kill_time(arg.kill_time);
351   actor->set_auto_restart(arg.auto_restart);
352
353   return actor->ciface();
354 }
355
356 activity::ActivityImplPtr ActorImpl::suspend(ActorImpl* issuer)
357 {
358   if (suspended_) {
359     XBT_DEBUG("Actor '%s' is already suspended", get_cname());
360     return nullptr;
361   }
362
363   suspended_ = true;
364
365   /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
366   if (this != issuer) {
367     if (waiting_synchro)
368       waiting_synchro->suspend();
369     /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
370
371     return nullptr;
372   } else {
373     activity::ExecImpl* exec = new activity::ExecImpl();
374     (*exec).set_name("suspend").set_host(host_).set_flops_amount(0.0).start();
375     return activity::ExecImplPtr(exec);
376   }
377 }
378
379 void ActorImpl::resume()
380 {
381   XBT_IN("actor = %p", this);
382
383   if (context_->iwannadie) {
384     XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
385     return;
386   }
387
388   if (not suspended_)
389     return;
390   suspended_ = false;
391
392   /* resume the synchronization that was blocking the resumed actor. */
393   if (waiting_synchro)
394     waiting_synchro->resume();
395
396   XBT_OUT();
397 }
398
399 activity::ActivityImplPtr ActorImpl::join(ActorImpl* actor, double timeout)
400 {
401   activity::ActivityImplPtr sleep = this->sleep(timeout);
402   SIMIX_process_on_exit(actor, [sleep](bool) {
403     if (sleep->surf_action_)
404       sleep->surf_action_->finish(resource::Action::State::FINISHED);
405   });
406   return sleep;
407 }
408
409 activity::ActivityImplPtr ActorImpl::sleep(double duration)
410 {
411   if (not host_->is_on())
412     throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
413         XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
414
415   activity::SleepImpl* sleep = new activity::SleepImpl();
416   (*sleep).set_name("sleep").set_host(host_).set_duration(duration).start();
417   return activity::SleepImplPtr(sleep);
418 }
419
420 void ActorImpl::throw_exception(std::exception_ptr e)
421 {
422   exception_ = e;
423
424   if (suspended_)
425     resume();
426
427   /* cancel the blocking synchro if any */
428   if (waiting_synchro) {
429
430     activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
431     if (exec != nullptr)
432       exec->cancel();
433
434     activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
435     if (comm != nullptr) {
436       comms.remove(comm);
437       comm->cancel();
438     }
439
440     activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
441     if (sleep != nullptr) {
442       SIMIX_process_sleep_destroy(sleep);
443       if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
444               end(simix_global->actors_to_run) &&
445           this != SIMIX_process_self()) {
446         XBT_DEBUG("Inserting [%p] %s in the to_run list", this, get_cname());
447         simix_global->actors_to_run.push_back(this);
448       }
449     }
450
451     activity::RawImplPtr raw = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
452     if (raw != nullptr) {
453       raw->finish();
454     }
455
456     activity::IoImplPtr io = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
457     if (io != nullptr) {
458       io->cancel();
459     }
460   }
461   waiting_synchro = nullptr;
462 }
463
464 void ActorImpl::set_host(s4u::Host* dest)
465 {
466   xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
467   host_ = dest;
468   dest->pimpl_->process_list_.push_back(*this);
469 }
470
471 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
472 {
473   ActorImpl* actor = new ActorImpl(xbt::string(name), host);
474   actor->set_ppid(this->pid_);
475
476   intrusive_ptr_add_ref(actor);
477   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
478   s4u::Actor::on_creation(*actor->ciface());
479
480   return ActorImplPtr(actor);
481 }
482
483 ActorImpl* ActorImpl::start(const simix::ActorCode& code)
484 {
485   xbt_assert(code && host_ != nullptr, "Invalid parameters");
486
487   if (not host_->is_on()) {
488     XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
489     intrusive_ptr_release(this);
490     std::rethrow_exception(
491         std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.")));
492   }
493
494   this->code = code;
495   XBT_VERB("Create context %s", get_cname());
496   context_.reset(simix_global->context_factory->create_context(simix::ActorCode(code), this));
497
498   XBT_DEBUG("Start context '%s'", get_cname());
499
500   /* Add the actor to its host's actor list */
501   host_->pimpl_->process_list_.push_back(*this);
502   simix_global->process_list[pid_] = this;
503
504   /* Now insert it in the global actor list and in the actor to run list */
505   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
506   simix_global->actors_to_run.push_back(this);
507
508   return this;
509 }
510
511 ActorImplPtr ActorImpl::create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host,
512                                std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
513 {
514   XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
515
516   ActorImplPtr actor;
517   if (parent_actor != nullptr)
518     actor = parent_actor->init(xbt::string(name), host);
519   else
520     actor = SIMIX_process_self()->init(xbt::string(name), host);
521
522   /* actor data */
523   actor->set_user_data(data);
524
525   /* Add properties */
526   if (properties != nullptr)
527     for (auto const& kv : *properties)
528       actor->set_property(kv.first, kv.second);
529
530   actor->start(code);
531
532   return actor;
533 }
534
535 void create_maestro(const std::function<void()>& code)
536 {
537   /* Create maestro actor and initialize it */
538   ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
539
540   if (not code) {
541     maestro->context_.reset(simix_global->context_factory->create_context(simix::ActorCode(), maestro));
542   } else {
543     maestro->context_.reset(simix_global->context_factory->create_maestro(simix::ActorCode(code), maestro));
544   }
545
546   maestro->simcall.issuer       = maestro;
547   simix_global->maestro_process = maestro;
548 }
549
550 } // namespace actor
551 } // namespace kernel
552 } // namespace simgrid
553
554 void SIMIX_process_detach()
555 {
556   simgrid::kernel::actor::ActorImpl::detach();
557 }
558
559 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
560                                  std::unordered_map<std::string, std::string>* properties,
561                                  smx_actor_t /*parent_process*/)
562 {
563   return simgrid::kernel::actor::ActorImpl::attach(name, data, sg_host_by_name(hostname), properties).get();
564 }
565
566 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
567  * transition */
568 void SIMIX_process_throw(smx_actor_t actor, xbt_errcat_t cat, int value, const char* msg)
569 {
570   SMX_EXCEPTION(actor, cat, value, msg);
571
572   if (actor->is_suspended())
573     actor->resume();
574
575   /* cancel the blocking synchro if any */
576   if (actor->waiting_synchro) {
577
578     simgrid::kernel::activity::ExecImplPtr exec =
579         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(actor->waiting_synchro);
580     if (exec != nullptr)
581       exec->cancel();
582
583     simgrid::kernel::activity::CommImplPtr comm =
584         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(actor->waiting_synchro);
585     if (comm != nullptr) {
586       actor->comms.remove(comm);
587       comm->cancel();
588     }
589
590     simgrid::kernel::activity::SleepImplPtr sleep =
591         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(actor->waiting_synchro);
592     if (sleep != nullptr) {
593       SIMIX_process_sleep_destroy(sleep);
594       if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
595               end(simix_global->actors_to_run) &&
596           actor != SIMIX_process_self()) {
597         XBT_DEBUG("Inserting [%p] %s in the to_run list", actor, actor->get_cname());
598         simix_global->actors_to_run.push_back(actor);
599       }
600     }
601
602     simgrid::kernel::activity::RawImplPtr raw =
603         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(actor->waiting_synchro);
604     if (raw != nullptr) {
605       raw->finish();
606     }
607
608     simgrid::kernel::activity::IoImplPtr io =
609         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(actor->waiting_synchro);
610     if (io != nullptr) {
611       io->cancel();
612     }
613   }
614   actor->waiting_synchro = nullptr;
615 }
616
617 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t actor)
618 {
619   smx_activity_t sync_suspend = actor->suspend(simcall->issuer);
620
621   if (actor != simcall->issuer) {
622     SIMIX_simcall_answer(simcall);
623   } else {
624     sync_suspend->simcalls_.push_back(simcall);
625     actor->waiting_synchro = sync_suspend;
626     actor->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 {
633   return simix_process_maxpid;
634 }
635
636 int SIMIX_process_count()
637 {
638   return simix_global->process_list.size();
639 }
640
641 void* SIMIX_process_self_get_data() // deprecated
642 {
643   smx_actor_t self = SIMIX_process_self();
644
645   if (self == nullptr) {
646     return nullptr;
647   }
648   return self->get_user_data();
649 }
650
651 void SIMIX_process_self_set_data(void* data) // deprecated
652 {
653   SIMIX_process_self()->set_user_data(data);
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
661   smx_actor_t process = SIMIX_process_self();
662   if (process == nullptr || process == simix_global->maestro_process)
663     return "maestro";
664
665   return process->get_cname();
666 }
667
668 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
669 {
670   if (process->finished_) {
671     // The joined process is already finished, just wake up the issuer process right away
672     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
673     SIMIX_simcall_answer(simcall);
674     return;
675   }
676   smx_activity_t sync = simcall->issuer->join(process, timeout);
677   sync->simcalls_.push_back(simcall);
678   simcall->issuer->waiting_synchro = sync;
679 }
680
681 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
682 {
683   if (MC_is_active() || MC_record_replay_is_active()) {
684     MC_process_clock_add(simcall->issuer, duration);
685     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
686     SIMIX_simcall_answer(simcall);
687     return;
688   }
689   smx_activity_t sync = simcall->issuer->sleep(duration);
690   sync->simcalls_.push_back(simcall);
691   simcall->issuer->waiting_synchro = sync;
692 }
693
694 void SIMIX_process_sleep_destroy(simgrid::kernel::activity::SleepImplPtr sleep)
695 {
696   XBT_DEBUG("Destroy sleep synchro %p", sleep.get());
697
698   if (sleep->surf_action_) {
699     sleep->surf_action_->unref();
700     sleep->surf_action_ = nullptr;
701   }
702 }
703
704 /**
705  * @brief Calling this function makes the process to yield.
706  *
707  * Only the current process can call this function, giving back the control to maestro.
708  *
709  * @param self the current process
710  */
711
712 /** @brief Returns the list of processes to run.
713  * @deprecated
714  */
715 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
716 {
717   return simix_global->actors_to_run;
718 }
719
720 /** @brief Returns the process from PID. */
721 smx_actor_t SIMIX_process_from_PID(aid_t PID)
722 {
723   auto actor = simix_global->process_list.find(PID);
724   return actor == simix_global->process_list.end() ? nullptr : actor->second;
725 }
726
727 void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* data)
728 {
729   SIMIX_process_on_exit(actor, [fun, data](bool failed) {
730     intptr_t status = failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
731     fun(reinterpret_cast<void*>(status), data);
732   });
733 }
734
735 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(int, void*)>& fun, void* data)
736 {
737   SIMIX_process_on_exit(actor, [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
738 }
739
740 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool /*failed*/)>& fun)
741 {
742   xbt_assert(actor, "current process not found: are you in maestro context ?");
743   actor->on_exit.emplace_back(fun);
744 }
745
746 /** @brief Restart a process, starting it again from the beginning. */
747 /**
748  * @ingroup simix_process_management
749  * @brief Creates and runs a new SIMIX process.
750  *
751  * The structure and the corresponding thread are created and put in the list of ready processes.
752  *
753  * @param name a name for the process. It is for user-level information and can be nullptr.
754  * @param code the main function of the process
755  * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
756  * be nullptr.
757  * It can be retrieved with the method ActorImpl::getUserData().
758  * @param host where the new agent is executed.
759  * @param properties the properties of the process
760  */
761 smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code, void* data,
762                                    sg_host_t host, std::unordered_map<std::string, std::string>* properties)
763 {
764   smx_actor_t self = SIMIX_process_self();
765   return simgrid::simix::simcall([&name, &code, data, host, properties, self] {
766     return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
767   });
768 }
769
770 void simcall_process_set_data(smx_actor_t process, void* data)
771 {
772   simgrid::simix::simcall([process, data] { process->set_user_data(data); });
773 }