Logo AND Algorithmique Numérique Distribuée

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