Logo AND Algorithmique Numérique Distribuée

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