1 /* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved. */
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. */
7 #include "simgrid/Exception.hpp"
8 #include "smx_private.hpp"
9 #include "src/kernel/activity/CommImpl.hpp"
10 #include "src/kernel/activity/ExecImpl.hpp"
11 #include "src/kernel/activity/IoImpl.hpp"
12 #include "src/kernel/activity/SleepImpl.hpp"
13 #include "src/kernel/activity/SynchroRaw.hpp"
14 #include "src/mc/mc_replay.hpp"
15 #include "src/mc/remote/Client.hpp"
16 #include "src/simix/smx_host_private.hpp"
17 #include "src/simix/smx_io_private.hpp"
18 #include "src/simix/smx_synchro_private.hpp"
19 #include "src/surf/HostImpl.hpp"
20 #include "src/surf/cpu_interface.hpp"
22 #include <boost/range/algorithm.hpp>
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
26 static unsigned long simix_process_maxpid = 0;
29 * @brief Returns the current agent.
31 * This functions returns the currently running SIMIX process.
33 * @return The SIMIX process
35 smx_actor_t SIMIX_process_self()
37 smx_context_t self_context = simgrid::kernel::context::Context::self();
39 return (self_context != nullptr) ? self_context->process() : nullptr;
43 * @brief Returns whether a process has pending asynchronous communications.
44 * @return true if there are asynchronous communications in this process
46 int SIMIX_process_has_pending_comms(smx_actor_t process) {
48 return process->comms.size() > 0;
52 * @brief Moves a process to the list of processes to destroy.
54 void SIMIX_process_cleanup(smx_actor_t process)
56 XBT_DEBUG("Cleanup process %s (%p), waiting synchro %p", process->get_cname(), process,
57 process->waiting_synchro.get());
59 process->finished_ = true;
60 SIMIX_process_on_exit_runall(process);
62 /* Unregister from the kill timer if any */
63 if (process->kill_timer != nullptr) {
64 SIMIX_timer_remove(process->kill_timer);
65 process->kill_timer = nullptr;
68 simix_global->mutex.lock();
70 /* cancel non-blocking communications */
71 while (not process->comms.empty()) {
72 smx_activity_t synchro = process->comms.front();
73 process->comms.pop_front();
74 simgrid::kernel::activity::CommImplPtr comm =
75 boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
77 /* make sure no one will finish the comm after this process is destroyed,
78 * because src_proc or dst_proc would be an invalid pointer */
80 if (comm->src_proc == process) {
81 XBT_DEBUG("Found an unfinished send comm %p (detached = %d), state %d, src = %p, dst = %p", comm.get(),
82 comm->detached, (int)comm->state_, comm->src_proc, comm->dst_proc);
83 comm->src_proc = nullptr;
85 } else if (comm->dst_proc == process) {
86 XBT_DEBUG("Found an unfinished recv comm %p, state %d, src = %p, dst = %p", comm.get(), (int)comm->state_,
87 comm->src_proc, comm->dst_proc);
88 comm->dst_proc = nullptr;
90 if (comm->detached && comm->src_proc != nullptr) {
91 /* the comm will be freed right now, remove it from the sender */
92 comm->src_proc->comms.remove(comm);
95 xbt_die("Communication synchro %p is in my list but I'm not the sender nor the receiver", synchro.get());
100 XBT_DEBUG("%s@%s(%ld) should not run anymore", process->get_cname(), process->iface()->get_host()->get_cname(),
102 simix_global->process_list.erase(process->pid_);
103 if (process->host_ && process->host_process_list_hook.is_linked())
104 simgrid::xbt::intrusive_erase(process->host_->pimpl_->process_list_, *process);
105 if (not process->smx_destroy_list_hook.is_linked()) {
107 xbt_dynar_push_as(simix_global->dead_actors_vector, smx_actor_t, process);
109 simix_global->process_to_destroy.push_back(*process);
111 process->context_->iwannadie = false;
113 simix_global->mutex.unlock();
119 * Should be called some time to time to free the memory allocated for processes that have finished (or killed).
121 void SIMIX_process_empty_trash()
123 while (not simix_global->process_to_destroy.empty()) {
124 smx_actor_t process = &simix_global->process_to_destroy.front();
125 simix_global->process_to_destroy.pop_front();
126 XBT_DEBUG("Getting rid of %p",process);
127 intrusive_ptr_release(process);
130 xbt_dynar_reset(simix_global->dead_actors_vector);
139 ActorImpl::ActorImpl(simgrid::xbt::string name, simgrid::s4u::Host* host) : name_(name), host_(host), piface_(this)
141 pid_ = simix_process_maxpid++;
142 simcall.issuer = this;
145 ActorImpl::~ActorImpl()
147 delete this->context_;
150 static void dying_daemon(int /*exit_status*/, void* data)
152 std::vector<ActorImpl*>* vect = &simix_global->daemons;
154 auto it = std::find(vect->begin(), vect->end(), static_cast<ActorImpl*>(data));
155 xbt_assert(it != vect->end(), "The dying daemon is not a daemon after all. Please report that bug.");
157 /* Don't move the whole content since we don't really care about the order */
158 std::swap(*it, vect->back());
162 /** This process will be terminated automatically when the last non-daemon process finishes */
163 void ActorImpl::daemonize()
167 simix_global->daemons.push_back(this);
168 SIMIX_process_on_exit(this, dying_daemon, this);
172 simgrid::s4u::Actor* ActorImpl::restart()
174 XBT_DEBUG("Restarting process %s on %s", get_cname(), host_->get_cname());
176 // retrieve the arguments of the old process
177 simgrid::kernel::actor::ProcessArg arg = ProcessArg(host_, this);
179 // kill the old process
180 SIMIX_process_kill(this, (this == simix_global->maestro_process) ? this : SIMIX_process_self());
182 // start the new process
184 SIMIX_process_create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
185 simcall_process_set_kill_time(actor, arg.kill_time);
186 actor->set_auto_restart(arg.auto_restart);
188 return actor->ciface();
191 smx_activity_t ActorImpl::suspend(ActorImpl* issuer)
194 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
200 /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
201 if (this != issuer) {
203 waiting_synchro->suspend();
204 /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
208 return SIMIX_execution_start("suspend", "", 0.0, 1.0, 0.0, this->host_);
212 void ActorImpl::resume()
214 XBT_IN("process = %p", this);
216 if (context_->iwannadie) {
217 XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
225 /* resume the synchronization that was blocking the resumed actor. */
227 waiting_synchro->resume();
232 smx_activity_t ActorImpl::sleep(double duration)
235 throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
236 XBT_THROW_POINT, std::string("Host ") + std::string(host_->get_cname()) + " failed, you cannot sleep there.")));
238 simgrid::kernel::activity::SleepImpl* synchro = new simgrid::kernel::activity::SleepImpl();
239 synchro->host = host_;
240 synchro->surf_sleep = host_->pimpl_cpu->sleep(duration);
241 synchro->surf_sleep->set_data(synchro);
242 XBT_DEBUG("Create sleep synchronization %p", synchro);
247 void ActorImpl::throw_exception(std::exception_ptr e)
254 /* cancel the blocking synchro if any */
255 if (waiting_synchro) {
257 simgrid::kernel::activity::ExecImplPtr exec =
258 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(waiting_synchro);
259 if (exec != nullptr && exec->surf_action_)
260 exec->surf_action_->cancel();
262 simgrid::kernel::activity::CommImplPtr comm =
263 boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(waiting_synchro);
264 if (comm != nullptr) {
269 simgrid::kernel::activity::SleepImplPtr sleep =
270 boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(waiting_synchro);
271 if (sleep != nullptr) {
272 SIMIX_process_sleep_destroy(waiting_synchro);
273 if (std::find(begin(simix_global->process_to_run), end(simix_global->process_to_run), this) ==
274 end(simix_global->process_to_run) &&
275 this != SIMIX_process_self()) {
276 XBT_DEBUG("Inserting %s in the to_run list", get_cname());
277 simix_global->process_to_run.push_back(this);
281 simgrid::kernel::activity::RawImplPtr raw =
282 boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(waiting_synchro);
283 if (raw != nullptr) {
284 SIMIX_synchro_stop_waiting(this, &simcall);
287 simgrid::kernel::activity::IoImplPtr io =
288 boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(waiting_synchro);
293 waiting_synchro = nullptr;
296 void create_maestro(simgrid::simix::ActorCode code)
298 /* Create maestro process and initialize it */
299 smx_actor_t maestro = new simgrid::kernel::actor::ActorImpl(simgrid::xbt::string(""), /*host*/ nullptr);
302 maestro->context_ = SIMIX_context_new(simgrid::simix::ActorCode(), nullptr, maestro);
304 maestro->context_ = simix_global->context_factory->create_maestro(code, maestro);
307 maestro->simcall.issuer = maestro;
308 simix_global->maestro_process = maestro;
315 /** @brief Creates and runs the maestro process */
316 void SIMIX_maestro_create(void (*code)(void*), void* data)
318 simgrid::kernel::actor::create_maestro(std::bind(code, data));
322 * @brief Internal function to create a process.
324 * This function actually creates the process.
325 * It may be called when a SIMCALL_PROCESS_CREATE simcall occurs,
326 * or directly for SIMIX internal purposes. The sure thing is that it's called from maestro context.
328 * @return the process created
330 smx_actor_t SIMIX_process_create(std::string name, simgrid::simix::ActorCode code, void* data, simgrid::s4u::Host* host,
331 std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process)
334 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
336 if (host->is_off()) {
337 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name.c_str(), host->get_cname());
341 smx_actor_t process = new simgrid::kernel::actor::ActorImpl(simgrid::xbt::string(name), host);
343 xbt_assert(code && host != nullptr, "Invalid parameters");
345 process->set_user_data(data);
346 process->code = code;
348 if (parent_process != nullptr)
349 process->ppid_ = parent_process->pid_;
351 XBT_VERB("Create context %s", process->get_cname());
352 process->context_ = SIMIX_context_new(std::move(code), &SIMIX_process_cleanup, process);
355 if (properties != nullptr)
356 for (auto const& kv : *properties)
357 process->set_property(kv.first, kv.second);
359 /* Add the process to its host's process list */
360 host->pimpl_->process_list_.push_back(*process);
362 XBT_DEBUG("Start context '%s'", process->get_cname());
364 /* Now insert it in the global process list and in the process to run list */
365 simix_global->process_list[process->pid_] = process;
366 XBT_DEBUG("Inserting %s(%s) in the to_run list", process->get_cname(), host->get_cname());
367 simix_global->process_to_run.push_back(process);
368 intrusive_ptr_add_ref(process);
370 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
371 simgrid::s4u::Actor::on_creation(process->iface());
376 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
377 std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process)
379 // This is mostly a copy/paste from SIMIX_process_new(),
380 // it'd be nice to share some code between those two functions.
382 sg_host_t host = sg_host_by_name(hostname);
383 XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
385 if (host->is_off()) {
386 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, hostname);
390 smx_actor_t actor = new simgrid::kernel::actor::ActorImpl(simgrid::xbt::string(name), host);
392 actor->set_user_data(data);
393 actor->code = nullptr;
395 if (parent_process != nullptr)
396 actor->ppid_ = parent_process->pid_;
398 XBT_VERB("Create context %s", actor->get_cname());
399 xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
400 actor->context_ = simix_global->context_factory->attach(&SIMIX_process_cleanup, actor);
403 if (properties != nullptr)
404 for (auto const& kv : *properties)
405 actor->set_property(kv.first, kv.second);
407 /* Add the process to it's host process list */
408 host->pimpl_->process_list_.push_back(*actor);
410 /* Now insert it in the global process list and in the process to run list */
411 simix_global->process_list[actor->pid_] = actor;
412 XBT_DEBUG("Inserting %s(%s) in the to_run list", actor->get_cname(), host->get_cname());
413 simix_global->process_to_run.push_back(actor);
414 intrusive_ptr_add_ref(actor);
416 auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_);
417 xbt_assert(nullptr != context, "Not a suitable context");
418 context->attach_start();
420 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
421 simgrid::s4u::ActorPtr tmp = actor->iface(); // Passing this directly to on_creation will lead to crashes
422 simgrid::s4u::Actor::on_creation(tmp);
427 void SIMIX_process_detach()
429 auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(simgrid::kernel::context::Context::self());
430 if (context == nullptr)
431 xbt_die("Not a suitable context");
433 SIMIX_process_cleanup(context->process());
434 context->attach_stop();
438 * @brief Executes the processes from simix_global->process_to_run.
440 * The processes of simix_global->process_to_run are run (in parallel if
441 * possible). On exit, simix_global->process_to_run is empty, and
442 * simix_global->process_that_ran contains the list of processes that just ran.
443 * The two lists are swapped so, be careful when using them before and after a
444 * call to this function.
446 void SIMIX_process_runall()
448 SIMIX_context_runall();
450 simix_global->process_to_run.swap(simix_global->process_that_ran);
451 simix_global->process_to_run.clear();
455 * @brief Internal function to kill a SIMIX process.
457 * This function may be called when a SIMCALL_PROCESS_KILL simcall occurs,
458 * or directly for SIMIX internal purposes.
460 * @param actor poor victim
461 * @param issuer the actor which has sent the PROCESS_KILL. Important to not schedule twice the same actor.
463 void SIMIX_process_kill(smx_actor_t actor, smx_actor_t issuer)
466 if (actor->finished_) {
467 XBT_DEBUG("Ignoring request to kill process %s@%s that is already dead", actor->get_cname(),
468 actor->host_->get_cname());
472 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", issuer == nullptr ? "(null)" : issuer->get_cname(),
473 (issuer == nullptr || issuer->host_ == nullptr ? "(null)" : issuer->host_->get_cname()), actor->get_cname(),
474 actor->host_->get_cname());
476 actor->context_->iwannadie = true;
477 actor->blocked_ = false;
478 actor->suspended_ = false;
479 actor->exception = nullptr;
481 // Forcefully kill the actor if its host is turned off. Not an HostFailureException because you should not survive that
482 if (actor->host_->is_off()) {
483 /* HORRIBLE HACK: Don't throw an StopRequest exception in Java, because it breaks sometimes.
485 * It seems to break for the actors started from the Java world, with new Process()
486 * while it works for the ones started from the C world, with the deployment file.
487 * When it happens, the simulation stops brutally with a message "untrapped exception StopRequest".
489 * From what I understand, it works for the native actors because they have a nice try/catch block around their main
490 * but I fail to have something like that for pure Java actors. That's probably a story of C->Java vs Java->C
491 * calling conventions. The right solution may be to have try/catch(StopRequest) blocks around each native call in
492 * JNI. ie, protect every Java->C++ call from C++ exceptions. But this sounds long and painful to do before we
493 * switch to an automatic generator such as SWIG. For now, we don't throw here that exception that we sometimes fail
496 * One of the unfortunate outcome is that the threads started from the deployment file are not stopped anymore.
497 * Or maybe this is the actors stopping gracefully as opposed to the killed ones? Or maybe this is absolutely all
498 * actors of the Java simulation? I'm not sure. Anyway. Because of them, the simulation hangs at the end, waiting
499 * for them to stop but they won't. The current answer to that is very brutal:
500 * we do a "exit(0)" to kill the JVM from the C code after the call to MSG_run(). Definitely unpleasant.
503 if (simgrid::kernel::context::factory_initializer == nullptr) // Only Java sets a factory_initializer, for now
504 actor->throw_exception(std::make_exception_ptr(simgrid::kernel::context::Context::StopRequest("host failed")));
507 /* destroy the blocking synchro if any */
508 if (actor->waiting_synchro != nullptr) {
510 simgrid::kernel::activity::ExecImplPtr exec =
511 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(actor->waiting_synchro);
512 simgrid::kernel::activity::CommImplPtr comm =
513 boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(actor->waiting_synchro);
514 simgrid::kernel::activity::SleepImplPtr sleep =
515 boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(actor->waiting_synchro);
516 simgrid::kernel::activity::RawImplPtr raw =
517 boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(actor->waiting_synchro);
518 simgrid::kernel::activity::IoImplPtr io =
519 boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(actor->waiting_synchro);
521 if (exec != nullptr) {
522 if (exec->surf_action_) {
523 exec->surf_action_->cancel();
524 exec->surf_action_->unref();
525 exec->surf_action_ = nullptr;
527 } else if (comm != nullptr) {
528 actor->comms.remove(actor->waiting_synchro);
530 // Remove first occurrence of &process->simcall:
531 auto i = boost::range::find(actor->waiting_synchro->simcalls_, &actor->simcall);
532 if (i != actor->waiting_synchro->simcalls_.end())
533 actor->waiting_synchro->simcalls_.remove(&actor->simcall);
534 } else if (sleep != nullptr) {
535 if (sleep->surf_sleep)
536 sleep->surf_sleep->cancel();
538 } else if (raw != nullptr) {
539 SIMIX_synchro_stop_waiting(actor, &actor->simcall);
541 } else if (io != nullptr) {
544 simgrid::kernel::activity::ActivityImplPtr activity = actor->waiting_synchro;
545 xbt_die("Activity %s is of unknown type %s", activity->name_.c_str(),
546 simgrid::xbt::demangle(typeid(activity).name()).get());
549 actor->waiting_synchro = nullptr;
551 if (std::find(begin(simix_global->process_to_run), end(simix_global->process_to_run), actor) ==
552 end(simix_global->process_to_run) &&
554 XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
555 simix_global->process_to_run.push_back(actor);
559 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
561 void SIMIX_process_throw(smx_actor_t actor, xbt_errcat_t cat, int value, const char* msg)
563 SMX_EXCEPTION(actor, cat, value, msg);
565 if (actor->suspended_)
568 /* cancel the blocking synchro if any */
569 if (actor->waiting_synchro) {
571 simgrid::kernel::activity::ExecImplPtr exec =
572 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(actor->waiting_synchro);
573 if (exec != nullptr && exec->surf_action_)
574 exec->surf_action_->cancel();
576 simgrid::kernel::activity::CommImplPtr comm =
577 boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(actor->waiting_synchro);
578 if (comm != nullptr) {
579 actor->comms.remove(comm);
583 simgrid::kernel::activity::SleepImplPtr sleep =
584 boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(actor->waiting_synchro);
585 if (sleep != nullptr) {
586 SIMIX_process_sleep_destroy(actor->waiting_synchro);
587 if (std::find(begin(simix_global->process_to_run), end(simix_global->process_to_run), actor) ==
588 end(simix_global->process_to_run) &&
589 actor != SIMIX_process_self()) {
590 XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
591 simix_global->process_to_run.push_back(actor);
595 simgrid::kernel::activity::RawImplPtr raw =
596 boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(actor->waiting_synchro);
597 if (raw != nullptr) {
598 SIMIX_synchro_stop_waiting(actor, &actor->simcall);
601 simgrid::kernel::activity::IoImplPtr io =
602 boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(actor->waiting_synchro);
607 actor->waiting_synchro = nullptr;
611 * @brief Kills all running processes.
612 * @param issuer this one will not be killed
614 void SIMIX_process_killall(smx_actor_t issuer)
616 for (auto const& kv : simix_global->process_list)
617 if (kv.second != issuer)
618 SIMIX_process_kill(kv.second, issuer);
621 void SIMIX_process_change_host(smx_actor_t actor, sg_host_t dest)
623 xbt_assert((actor != nullptr), "Invalid parameters");
624 simgrid::xbt::intrusive_erase(actor->host_->pimpl_->process_list_, *actor);
626 dest->pimpl_->process_list_.push_back(*actor);
629 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t actor)
631 smx_activity_t sync_suspend = actor->suspend(simcall->issuer);
633 if (actor != simcall->issuer) {
634 SIMIX_simcall_answer(simcall);
636 sync_suspend->simcalls_.push_back(simcall);
637 actor->waiting_synchro = sync_suspend;
638 actor->waiting_synchro->suspend();
640 /* If we are suspending ourselves, then just do not finish the simcall now */
643 int SIMIX_process_get_maxpid() {
644 return simix_process_maxpid;
647 int SIMIX_process_count()
649 return simix_global->process_list.size();
652 void* SIMIX_process_self_get_data()
654 smx_actor_t self = SIMIX_process_self();
656 if (self == nullptr) {
659 return self->get_user_data();
662 void SIMIX_process_self_set_data(void *data)
664 SIMIX_process_self()->set_user_data(data);
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() {
672 smx_actor_t process = SIMIX_process_self();
673 if (process == nullptr || process == simix_global->maestro_process)
676 return process->get_cname();
679 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
681 if (process->finished_) {
682 // The joined process is already finished, just wake up the issuer process right away
683 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
684 SIMIX_simcall_answer(simcall);
687 smx_activity_t sync = SIMIX_process_join(simcall->issuer, process, timeout);
688 sync->simcalls_.push_back(simcall);
689 simcall->issuer->waiting_synchro = sync;
692 smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout)
694 smx_activity_t res = issuer->sleep(timeout);
695 intrusive_ptr_add_ref(res.get());
696 SIMIX_process_on_exit(process,
698 auto sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(arg);
699 if (sleep->surf_sleep)
700 sleep->surf_sleep->finish(simgrid::kernel::resource::Action::State::FINISHED);
701 intrusive_ptr_release(sleep);
707 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
709 if (MC_is_active() || MC_record_replay_is_active()) {
710 MC_process_clock_add(simcall->issuer, duration);
711 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
712 SIMIX_simcall_answer(simcall);
715 smx_activity_t sync = simcall->issuer->sleep(duration);
716 sync->simcalls_.push_back(simcall);
717 simcall->issuer->waiting_synchro = sync;
720 void SIMIX_process_sleep_destroy(smx_activity_t synchro)
722 XBT_DEBUG("Destroy sleep synchro %p", synchro.get());
723 simgrid::kernel::activity::SleepImplPtr sleep =
724 boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(synchro);
726 if (sleep->surf_sleep) {
727 sleep->surf_sleep->unref();
728 sleep->surf_sleep = nullptr;
733 * @brief Calling this function makes the process to yield.
735 * Only the current process can call this function, giving back the control to maestro.
737 * @param self the current process
739 void SIMIX_process_yield(smx_actor_t self)
741 XBT_DEBUG("Yield actor '%s'", self->get_cname());
743 /* Go into sleep and return control to maestro */
744 self->context_->suspend();
746 /* Ok, maestro returned control to us */
747 XBT_DEBUG("Control returned to me: '%s'", self->get_cname());
749 if (self->context_->iwannadie) {
750 XBT_DEBUG("I wanna die!");
751 self->finished_ = true;
752 /* execute the on_exit functions */
753 SIMIX_process_on_exit_runall(self);
755 if (self->auto_restart_ && self->host_->is_off() &&
756 watched_hosts.find(self->host_->get_cname()) == watched_hosts.end()) {
757 XBT_DEBUG("Push host %s to watched_hosts because it's off and %s needs to restart", self->host_->get_cname(),
759 watched_hosts.insert(self->host_->get_cname());
762 XBT_DEBUG("Process %s@%s is dead", self->get_cname(), self->host_->get_cname());
763 self->context_->stop();
764 xbt_backtrace_display_current();
765 xbt_die("I should be dead by now.");
768 if (self->suspended_) {
769 XBT_DEBUG("Hey! I'm suspended.");
770 xbt_assert(self->exception != nullptr, "Gasp! This exception may be lost by subsequent calls.");
771 self->suspended_ = false;
775 if (self->exception != nullptr) {
776 XBT_DEBUG("Wait, maestro left me an exception");
777 std::exception_ptr exception = std::move(self->exception);
778 self->exception = nullptr;
779 std::rethrow_exception(std::move(exception));
782 if (SMPI_switch_data_segment && not self->finished_) {
783 SMPI_switch_data_segment(self->iface());
787 /** @brief Returns the list of processes to run. */
788 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
790 return simix_global->process_to_run;
793 /** @brief Returns the process from PID. */
794 smx_actor_t SIMIX_process_from_PID(aid_t PID)
796 auto actor = simix_global->process_list.find(PID);
797 return actor == simix_global->process_list.end() ? nullptr : actor->second;
800 void SIMIX_process_on_exit_runall(smx_actor_t actor)
802 simgrid::s4u::Actor::on_destruction(actor->iface());
803 smx_process_exit_status_t exit_status = (actor->context_->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
804 while (not actor->on_exit.empty()) {
805 s_smx_process_exit_fun_t exit_fun = actor->on_exit.back();
806 actor->on_exit.pop_back();
807 (exit_fun.fun)(exit_status, exit_fun.arg);
811 void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* data)
813 SIMIX_process_on_exit(actor, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
816 void SIMIX_process_on_exit(smx_actor_t actor, std::function<void(int, void*)> fun, void* data)
818 xbt_assert(actor, "current process not found: are you in maestro context ?");
820 actor->on_exit.emplace_back(s_smx_process_exit_fun_t{fun, data});
823 /** @brief Restart a process, starting it again from the beginning. */
825 * @ingroup simix_process_management
826 * @brief Creates and runs a new SIMIX process.
828 * The structure and the corresponding thread are created and put in the list of ready processes.
830 * @param name a name for the process. It is for user-level information and can be nullptr.
831 * @param code the main function of the process
832 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
834 * It can be retrieved with the method ActorImpl::getUserData().
835 * @param host where the new agent is executed.
836 * @param properties the properties of the process
838 smx_actor_t simcall_process_create(std::string name, simgrid::simix::ActorCode code, void* data, sg_host_t host,
839 std::unordered_map<std::string, std::string>* properties)
841 smx_actor_t self = SIMIX_process_self();
842 return simgrid::simix::simcall([name, code, data, host, properties, self] {
843 return SIMIX_process_create(name, std::move(code), data, host, properties, self);