Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use activity cancel, not the action cancel
[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       sleep->cancel();
221       sleep->post();
222     } else if (raw != nullptr) {
223       raw->finish();
224     } else if (io != nullptr) {
225       io->cancel();
226     } else {
227       simgrid::kernel::activity::ActivityImplPtr activity = waiting_synchro;
228       xbt_die("Activity is of unknown type %s", simgrid::xbt::demangle(typeid(activity).name()).get());
229     }
230
231     waiting_synchro = nullptr;
232   }
233 }
234
235 void ActorImpl::kill(ActorImpl* actor)
236 {
237   if (actor->finished_) {
238     XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
239               actor->host_->get_cname());
240     return;
241   }
242
243   XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
244             actor->host_ ? actor->host_->get_cname() : "");
245
246   actor->exit();
247
248   if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
249           end(simix_global->actors_to_run) &&
250       actor != this) {
251     XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
252     simix_global->actors_to_run.push_back(actor);
253   }
254 }
255
256 void ActorImpl::kill_all()
257 {
258   for (auto const& kv : simix_global->process_list)
259     if (kv.second != this)
260       this->kill(kv.second);
261 }
262
263 void ActorImpl::set_kill_time(double kill_time)
264 {
265   if (kill_time <= SIMIX_get_clock())
266     return;
267   XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
268   kill_timer = simix::Timer::set(kill_time, [this] {
269     this->exit();
270     kill_timer = nullptr;
271   });
272 }
273
274 double ActorImpl::get_kill_time()
275 {
276   return kill_timer ? kill_timer->get_date() : 0;
277 }
278
279 void ActorImpl::yield()
280 {
281   XBT_DEBUG("Yield actor '%s'", get_cname());
282
283   /* Go into sleep and return control to maestro */
284   context_->suspend();
285
286   /* Ok, maestro returned control to us */
287   XBT_DEBUG("Control returned to me: '%s'", get_cname());
288
289   if (context_->iwannadie) {
290     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
291     // throw simgrid::kernel::context::ForcefulKillException(); Does not seem to properly kill the actor
292     context_->stop();
293     THROW_IMPOSSIBLE;
294   }
295
296   if (suspended_) {
297     XBT_DEBUG("Hey! I'm suspended.");
298
299     xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
300     suspended_ = false;
301     suspend(this);
302   }
303
304   if (exception_ != nullptr) {
305     XBT_DEBUG("Wait, maestro left me an exception");
306     std::exception_ptr exception = std::move(exception_);
307     exception_                   = nullptr;
308     std::rethrow_exception(std::move(exception));
309   }
310
311   if (SMPI_switch_data_segment && not finished_) {
312     SMPI_switch_data_segment(iface());
313   }
314 }
315
316 /** This actor will be terminated automatically when the last non-daemon actor finishes */
317 void ActorImpl::daemonize()
318 {
319   if (not daemon_) {
320     daemon_ = true;
321     simix_global->daemons.push_back(this);
322     SIMIX_process_on_exit(this, [this](bool) {
323       auto& vect = simix_global->daemons;
324       auto it    = std::find(vect.begin(), vect.end(), this);
325       xbt_assert(it != vect.end(), "The dying daemon is not a daemon after all. Please report that bug.");
326
327       /* Don't move the whole content since we don't really care about the order */
328       std::swap(*it, vect.back());
329       vect.pop_back();
330     });
331   }
332 }
333
334 s4u::Actor* ActorImpl::restart()
335 {
336   xbt_assert(this != simix_global->maestro_process, "Restarting maestro is not supported");
337
338   XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
339
340   // retrieve the arguments of the old actor
341   ProcessArg arg = ProcessArg(host_, this);
342
343   // kill the old actor
344   context::Context::self()->get_actor()->kill(this);
345
346   // start the new actor
347   ActorImplPtr actor =
348       ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
349   actor->set_kill_time(arg.kill_time);
350   actor->set_auto_restart(arg.auto_restart);
351
352   return actor->ciface();
353 }
354
355 activity::ActivityImplPtr ActorImpl::suspend(ActorImpl* issuer)
356 {
357   if (suspended_) {
358     XBT_DEBUG("Actor '%s' is already suspended", get_cname());
359     return nullptr;
360   }
361
362   suspended_ = true;
363
364   /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
365   if (this != issuer) {
366     if (waiting_synchro)
367       waiting_synchro->suspend();
368     /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
369
370     return nullptr;
371   } else {
372     activity::ExecImpl* exec = new activity::ExecImpl();
373     (*exec).set_name("suspend").set_host(host_).set_flops_amount(0.0).start();
374     return activity::ExecImplPtr(exec);
375   }
376 }
377
378 void ActorImpl::resume()
379 {
380   XBT_IN("actor = %p", this);
381
382   if (context_->iwannadie) {
383     XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
384     return;
385   }
386
387   if (not suspended_)
388     return;
389   suspended_ = false;
390
391   /* resume the synchronization that was blocking the resumed actor. */
392   if (waiting_synchro)
393     waiting_synchro->resume();
394
395   XBT_OUT();
396 }
397
398 activity::ActivityImplPtr ActorImpl::join(ActorImpl* actor, double timeout)
399 {
400   activity::ActivityImplPtr sleep = this->sleep(timeout);
401   SIMIX_process_on_exit(actor, [sleep](bool) {
402     if (sleep->surf_action_)
403       sleep->surf_action_->finish(resource::Action::State::FINISHED);
404   });
405   return sleep;
406 }
407
408 activity::ActivityImplPtr ActorImpl::sleep(double duration)
409 {
410   if (not host_->is_on())
411     throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
412         XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
413
414   activity::SleepImpl* sleep = new activity::SleepImpl();
415   (*sleep).set_name("sleep").set_host(host_).set_duration(duration).start();
416   return activity::SleepImplPtr(sleep);
417 }
418
419 void ActorImpl::throw_exception(std::exception_ptr e)
420 {
421   exception_ = e;
422
423   if (suspended_)
424     resume();
425
426   /* cancel the blocking synchro if any */
427   if (waiting_synchro) {
428
429     activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
430     if (exec != nullptr)
431       exec->cancel();
432
433     activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
434     if (comm != nullptr) {
435       comms.remove(comm);
436       comm->cancel();
437     }
438
439     activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
440     if (sleep != nullptr) {
441       SIMIX_process_sleep_destroy(sleep);
442       if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
443               end(simix_global->actors_to_run) &&
444           this != SIMIX_process_self()) {
445         XBT_DEBUG("Inserting [%p] %s in the to_run list", this, get_cname());
446         simix_global->actors_to_run.push_back(this);
447       }
448     }
449
450     activity::RawImplPtr raw = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
451     if (raw != nullptr) {
452       raw->finish();
453     }
454
455     activity::IoImplPtr io = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
456     if (io != nullptr) {
457       io->cancel();
458     }
459   }
460   waiting_synchro = nullptr;
461 }
462
463 void ActorImpl::set_host(s4u::Host* dest)
464 {
465   xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
466   host_ = dest;
467   dest->pimpl_->process_list_.push_back(*this);
468 }
469
470 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
471 {
472   ActorImpl* actor = new ActorImpl(xbt::string(name), host);
473   actor->set_ppid(this->pid_);
474
475   intrusive_ptr_add_ref(actor);
476   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
477   s4u::Actor::on_creation(*actor->ciface());
478
479   return ActorImplPtr(actor);
480 }
481
482 ActorImpl* ActorImpl::start(const simix::ActorCode& code)
483 {
484   xbt_assert(code && host_ != nullptr, "Invalid parameters");
485
486   if (not host_->is_on()) {
487     XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
488     intrusive_ptr_release(this);
489     std::rethrow_exception(
490         std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.")));
491   }
492
493   this->code = code;
494   XBT_VERB("Create context %s", get_cname());
495   context_.reset(simix_global->context_factory->create_context(simix::ActorCode(code), this));
496
497   XBT_DEBUG("Start context '%s'", get_cname());
498
499   /* Add the actor to its host's actor list */
500   host_->pimpl_->process_list_.push_back(*this);
501   simix_global->process_list[pid_] = this;
502
503   /* Now insert it in the global actor list and in the actor to run list */
504   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
505   simix_global->actors_to_run.push_back(this);
506
507   return this;
508 }
509
510 ActorImplPtr ActorImpl::create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host,
511                                std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
512 {
513   XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
514
515   ActorImplPtr actor;
516   if (parent_actor != nullptr)
517     actor = parent_actor->init(xbt::string(name), host);
518   else
519     actor = SIMIX_process_self()->init(xbt::string(name), host);
520
521   /* actor data */
522   actor->set_user_data(data);
523
524   /* Add properties */
525   if (properties != nullptr)
526     for (auto const& kv : *properties)
527       actor->set_property(kv.first, kv.second);
528
529   actor->start(code);
530
531   return actor;
532 }
533
534 void create_maestro(const std::function<void()>& code)
535 {
536   /* Create maestro actor and initialize it */
537   ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
538
539   if (not code) {
540     maestro->context_.reset(simix_global->context_factory->create_context(simix::ActorCode(), maestro));
541   } else {
542     maestro->context_.reset(simix_global->context_factory->create_maestro(simix::ActorCode(code), maestro));
543   }
544
545   maestro->simcall.issuer       = maestro;
546   simix_global->maestro_process = maestro;
547 }
548
549 } // namespace actor
550 } // namespace kernel
551 } // namespace simgrid
552
553 void SIMIX_process_detach()
554 {
555   simgrid::kernel::actor::ActorImpl::detach();
556 }
557
558 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
559                                  std::unordered_map<std::string, std::string>* properties,
560                                  smx_actor_t /*parent_process*/)
561 {
562   return simgrid::kernel::actor::ActorImpl::attach(name, data, sg_host_by_name(hostname), properties).get();
563 }
564
565 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
566  * transition */
567 void SIMIX_process_throw(smx_actor_t actor, xbt_errcat_t cat, int value, const char* msg)
568 {
569   SMX_EXCEPTION(actor, cat, value, msg);
570
571   if (actor->is_suspended())
572     actor->resume();
573
574   /* cancel the blocking synchro if any */
575   if (actor->waiting_synchro) {
576
577     simgrid::kernel::activity::ExecImplPtr exec =
578         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(actor->waiting_synchro);
579     if (exec != nullptr)
580       exec->cancel();
581
582     simgrid::kernel::activity::CommImplPtr comm =
583         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(actor->waiting_synchro);
584     if (comm != nullptr) {
585       actor->comms.remove(comm);
586       comm->cancel();
587     }
588
589     simgrid::kernel::activity::SleepImplPtr sleep =
590         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(actor->waiting_synchro);
591     if (sleep != nullptr) {
592       SIMIX_process_sleep_destroy(sleep);
593       if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
594               end(simix_global->actors_to_run) &&
595           actor != SIMIX_process_self()) {
596         XBT_DEBUG("Inserting [%p] %s in the to_run list", actor, actor->get_cname());
597         simix_global->actors_to_run.push_back(actor);
598       }
599     }
600
601     simgrid::kernel::activity::RawImplPtr raw =
602         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(actor->waiting_synchro);
603     if (raw != nullptr) {
604       raw->finish();
605     }
606
607     simgrid::kernel::activity::IoImplPtr io =
608         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(actor->waiting_synchro);
609     if (io != nullptr) {
610       io->cancel();
611     }
612   }
613   actor->waiting_synchro = nullptr;
614 }
615
616 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t actor)
617 {
618   smx_activity_t sync_suspend = actor->suspend(simcall->issuer);
619
620   if (actor != simcall->issuer) {
621     SIMIX_simcall_answer(simcall);
622   } else {
623     sync_suspend->simcalls_.push_back(simcall);
624     actor->waiting_synchro = sync_suspend;
625     actor->waiting_synchro->suspend();
626   }
627   /* If we are suspending ourselves, then just do not finish the simcall now */
628 }
629
630 int SIMIX_process_get_maxpid()
631 {
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() // deprecated
641 {
642   smx_actor_t self = SIMIX_process_self();
643
644   if (self == nullptr) {
645     return nullptr;
646   }
647   return self->get_user_data();
648 }
649
650 void SIMIX_process_self_set_data(void* data) // deprecated
651 {
652   SIMIX_process_self()->set_user_data(data);
653 }
654
655 /* needs to be public and without simcall because it is called
656    by exceptions and logging events */
657 const char* SIMIX_process_self_get_name()
658 {
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->get_cname();
665 }
666
667 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
668 {
669   if (process->finished_) {
670     // The joined process is already finished, just wake up the issuer process right away
671     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
672     SIMIX_simcall_answer(simcall);
673     return;
674   }
675   smx_activity_t sync = simcall->issuer->join(process, timeout);
676   sync->simcalls_.push_back(simcall);
677   simcall->issuer->waiting_synchro = sync;
678 }
679
680 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
681 {
682   if (MC_is_active() || MC_record_replay_is_active()) {
683     MC_process_clock_add(simcall->issuer, duration);
684     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
685     SIMIX_simcall_answer(simcall);
686     return;
687   }
688   smx_activity_t sync = simcall->issuer->sleep(duration);
689   sync->simcalls_.push_back(simcall);
690   simcall->issuer->waiting_synchro = sync;
691 }
692
693 void SIMIX_process_sleep_destroy(simgrid::kernel::activity::SleepImplPtr sleep)
694 {
695   XBT_DEBUG("Destroy sleep synchro %p", sleep.get());
696
697   if (sleep->surf_action_) {
698     sleep->surf_action_->unref();
699     sleep->surf_action_ = nullptr;
700   }
701 }
702
703 /**
704  * @brief Calling this function makes the process to yield.
705  *
706  * Only the current process can call this function, giving back the control to maestro.
707  *
708  * @param self the current process
709  */
710
711 /** @brief Returns the list of processes to run.
712  * @deprecated
713  */
714 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
715 {
716   return simix_global->actors_to_run;
717 }
718
719 /** @brief Returns the process from PID. */
720 smx_actor_t SIMIX_process_from_PID(aid_t PID)
721 {
722   auto actor = simix_global->process_list.find(PID);
723   return actor == simix_global->process_list.end() ? nullptr : actor->second;
724 }
725
726 void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* data)
727 {
728   SIMIX_process_on_exit(actor, [fun, data](bool failed) {
729     intptr_t status = failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
730     fun(reinterpret_cast<void*>(status), data);
731   });
732 }
733
734 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(int, void*)>& fun, void* data)
735 {
736   SIMIX_process_on_exit(actor, [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
737 }
738
739 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool /*failed*/)>& fun)
740 {
741   xbt_assert(actor, "current process not found: are you in maestro context ?");
742   actor->on_exit.emplace_back(fun);
743 }
744
745 /** @brief Restart a process, starting it again from the beginning. */
746 /**
747  * @ingroup simix_process_management
748  * @brief Creates and runs a new SIMIX process.
749  *
750  * The structure and the corresponding thread are created and put in the list of ready processes.
751  *
752  * @param name a name for the process. It is for user-level information and can be nullptr.
753  * @param code the main function of the process
754  * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
755  * be nullptr.
756  * It can be retrieved with the method ActorImpl::getUserData().
757  * @param host where the new agent is executed.
758  * @param properties the properties of the process
759  */
760 smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code, void* data,
761                                    sg_host_t host, std::unordered_map<std::string, std::string>* properties)
762 {
763   smx_actor_t self = SIMIX_process_self();
764   return simgrid::simix::simcall([&name, &code, data, host, properties, self] {
765     return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
766   });
767 }
768
769 void simcall_process_set_data(smx_actor_t process, void* data)
770 {
771   simgrid::simix::simcall([process, data] { process->set_user_data(data); });
772 }