Logo AND Algorithmique Numérique Distribuée

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