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 "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"
24 #include <boost/range/algorithm.hpp>
26 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
28 static unsigned long simix_process_maxpid = 0;
31 * @brief Returns the current agent.
33 * This functions returns the currently running SIMIX process.
35 * @return The SIMIX process
37 smx_actor_t SIMIX_process_self()
39 smx_context_t self_context = simgrid::kernel::context::Context::self();
41 return (self_context != nullptr) ? self_context->get_actor() : nullptr;
45 * @brief Returns whether a process has pending asynchronous communications.
46 * @return true if there are asynchronous communications in this process
48 int SIMIX_process_has_pending_comms(smx_actor_t process) {
50 return process->comms.size() > 0;
57 ActorImpl::ActorImpl(simgrid::xbt::string name, s4u::Host* host) : host_(host), name_(name), piface_(this)
59 pid_ = simix_process_maxpid++;
60 simcall.issuer = this;
63 ActorImpl::~ActorImpl()
65 delete this->context_;
68 void ActorImpl::cleanup()
70 if (this == simix_global->maestro_process) /* Do not cleanup maestro */
73 XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro.get());
75 simix_global->mutex.lock();
77 simix_global->process_list.erase(pid_);
78 if (host_ && host_process_list_hook.is_linked())
79 simgrid::xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
80 if (not smx_destroy_list_hook.is_linked()) {
82 xbt_dynar_push_as(simix_global->dead_actors_vector, smx_actor_t, this);
84 simix_global->actors_to_destroy.push_back(*this);
86 context_->iwannadie = false;
88 simix_global->mutex.unlock();
91 void ActorImpl::exit()
93 context_->iwannadie = true;
98 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
99 if (not host_->is_on())
100 this->throw_exception(std::make_exception_ptr(simgrid::kernel::context::StopRequest("host failed")));
102 /* destroy the blocking synchro if any */
103 if (waiting_synchro != nullptr) {
105 activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
106 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
107 activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
108 activity::RawImplPtr raw = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
109 activity::IoImplPtr io = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
111 if (exec != nullptr && exec->surf_action_) {
113 exec->surf_action_->unref();
114 exec->surf_action_ = nullptr;
115 } else if (comm != nullptr) {
116 comms.remove(waiting_synchro);
118 // Remove first occurrence of &actor->simcall:
119 auto i = boost::range::find(waiting_synchro->simcalls_, &simcall);
120 if (i != waiting_synchro->simcalls_.end())
121 waiting_synchro->simcalls_.remove(&simcall);
122 } else if (sleep != nullptr) {
123 if (sleep->surf_action_)
124 sleep->surf_action_->cancel();
126 } else if (raw != nullptr) {
127 SIMIX_synchro_stop_waiting(this, &simcall);
128 } else if (io != nullptr) {
131 simgrid::kernel::activity::ActivityImplPtr activity = waiting_synchro;
132 xbt_die("Activity %s is of unknown type %s", activity->get_cname(),
133 simgrid::xbt::demangle(typeid(activity).name()).get());
136 waiting_synchro = nullptr;
140 void ActorImpl::kill(ActorImpl* actor)
142 if (actor->finished_) {
143 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
144 actor->host_->get_cname());
148 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_->get_cname(), actor->get_cname(),
149 actor->host_->get_cname());
153 if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
154 end(simix_global->actors_to_run) &&
156 XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
157 simix_global->actors_to_run.push_back(actor);
161 void ActorImpl::kill_all()
163 for (auto const& kv : simix_global->process_list)
164 if (kv.second != this)
165 this->kill(kv.second);
168 void ActorImpl::set_kill_time(double kill_time)
170 if (kill_time <= SIMIX_get_clock())
172 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
173 kill_timer = simix::Timer::set(kill_time, [this] {
175 kill_timer = nullptr;
179 double ActorImpl::get_kill_time()
181 return kill_timer ? kill_timer->get_date() : 0;
184 static void dying_daemon(int /*exit_status*/, void* data)
186 std::vector<ActorImpl*>* vect = &simix_global->daemons;
188 auto it = std::find(vect->begin(), vect->end(), static_cast<ActorImpl*>(data));
189 xbt_assert(it != vect->end(), "The dying daemon is not a daemon after all. Please report that bug.");
191 /* Don't move the whole content since we don't really care about the order */
192 std::swap(*it, vect->back());
196 void ActorImpl::yield()
198 XBT_DEBUG("Yield actor '%s'", get_cname());
200 /* Go into sleep and return control to maestro */
203 /* Ok, maestro returned control to us */
204 XBT_DEBUG("Control returned to me: '%s'", get_cname());
206 if (context_->iwannadie) {
208 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
209 // throw simgrid::kernel::context::StopRequest(); Does not seem to properly kill the actor
215 XBT_DEBUG("Hey! I'm suspended.");
216 xbt_assert(exception_ != nullptr, "Gasp! This exception may be lost by subsequent calls.");
221 if (exception_ != nullptr) {
222 XBT_DEBUG("Wait, maestro left me an exception");
223 std::exception_ptr exception = std::move(exception_);
224 exception_ = nullptr;
225 std::rethrow_exception(std::move(exception));
228 if (SMPI_switch_data_segment && not finished_) {
229 SMPI_switch_data_segment(iface());
233 /** This actor will be terminated automatically when the last non-daemon actor finishes */
234 void ActorImpl::daemonize()
238 simix_global->daemons.push_back(this);
239 SIMIX_process_on_exit(this, dying_daemon, this);
243 s4u::Actor* ActorImpl::restart()
245 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
247 // retrieve the arguments of the old actor
248 ProcessArg arg = ProcessArg(host_, this);
250 // kill the old actor
251 (this == simix_global->maestro_process) ? this->exit() : SIMIX_process_self()->kill(this);
253 // start the new actor
255 ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
256 actor->set_kill_time(arg.kill_time);
257 actor->set_auto_restart(arg.auto_restart);
259 return actor->ciface();
262 activity::ActivityImplPtr ActorImpl::suspend(ActorImpl* issuer)
265 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
271 /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
272 if (this != issuer) {
274 waiting_synchro->suspend();
275 /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
279 return activity::ExecImplPtr(new activity::ExecImpl("suspend", "", nullptr, this->host_))->start(0.0, 1.0, 0.0);
283 void ActorImpl::resume()
285 XBT_IN("actor = %p", this);
287 if (context_->iwannadie) {
288 XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
296 /* resume the synchronization that was blocking the resumed actor. */
298 waiting_synchro->resume();
303 activity::ActivityImplPtr ActorImpl::join(smx_actor_t actor, double timeout)
305 activity::ActivityImplPtr res = this->sleep(timeout);
306 intrusive_ptr_add_ref(res.get());
307 SIMIX_process_on_exit(actor,
309 auto sleep = static_cast<simgrid::kernel::activity::SleepImpl*>(arg);
310 if (sleep->surf_action_)
311 sleep->surf_action_->finish(simgrid::kernel::resource::Action::State::FINISHED);
312 intrusive_ptr_release(sleep);
318 activity::ActivityImplPtr ActorImpl::sleep(double duration)
320 if (not host_->is_on())
321 throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
322 XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
324 return simgrid::kernel::activity::SleepImplPtr(new simgrid::kernel::activity::SleepImpl("sleep", host_))
328 void ActorImpl::throw_exception(std::exception_ptr e)
335 /* cancel the blocking synchro if any */
336 if (waiting_synchro) {
338 activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
342 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
343 if (comm != nullptr) {
348 activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
349 if (sleep != nullptr) {
350 SIMIX_process_sleep_destroy(waiting_synchro);
351 if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
352 end(simix_global->actors_to_run) &&
353 this != SIMIX_process_self()) {
354 XBT_DEBUG("Inserting [%p] %s in the to_run list", this, get_cname());
355 simix_global->actors_to_run.push_back(this);
359 activity::RawImplPtr raw = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
360 if (raw != nullptr) {
361 SIMIX_synchro_stop_waiting(this, &simcall);
364 activity::IoImplPtr io = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
369 waiting_synchro = nullptr;
372 void ActorImpl::set_host(s4u::Host* dest)
374 simgrid::xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
376 dest->pimpl_->process_list_.push_back(*this);
379 ActorImplPtr ActorImpl::create(std::string name, simix::ActorCode code, void* data, s4u::Host* host,
380 std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
383 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
385 if (not host->is_on()) {
386 XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
390 ActorImpl* actor = new ActorImpl(simgrid::xbt::string(name), host);
392 xbt_assert(code && host != nullptr, "Invalid parameters");
394 actor->set_user_data(data);
397 if (parent_actor != nullptr)
398 actor->set_ppid(parent_actor->get_pid());
400 XBT_VERB("Create context %s", actor->get_cname());
401 actor->context_ = simix_global->context_factory->create_context(std::move(code), actor);
404 if (properties != nullptr)
405 for (auto const& kv : *properties)
406 actor->set_property(kv.first, kv.second);
408 /* Add the actor to its host's actor list */
409 host->pimpl_->process_list_.push_back(*actor);
411 XBT_DEBUG("Start context '%s'", actor->get_cname());
413 /* Now insert it in the global actor list and in the actor to run list */
414 simix_global->process_list[actor->get_pid()] = actor;
415 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
416 simix_global->actors_to_run.push_back(actor);
417 intrusive_ptr_add_ref(actor);
419 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
420 s4u::Actor::on_creation(actor->iface());
422 return ActorImplPtr(actor);
425 void create_maestro(simix::ActorCode code)
427 /* Create maestro actor and initialize it */
428 ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
431 maestro->context_ = simix_global->context_factory->create_context(simix::ActorCode(), maestro);
433 maestro->context_ = simix_global->context_factory->create_maestro(code, maestro);
436 maestro->simcall.issuer = maestro;
437 simix_global->maestro_process = maestro;
441 } // namespace kernel
444 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
445 std::unordered_map<std::string, std::string>* properties, smx_actor_t parent_process)
447 // This is mostly a copy/paste from SIMIX_process_new(),
448 // it'd be nice to share some code between those two functions.
450 sg_host_t host = sg_host_by_name(hostname);
451 XBT_DEBUG("Attach process %s on host '%s'", name, hostname);
453 if (not host->is_on()) {
454 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name, hostname);
458 smx_actor_t actor = new simgrid::kernel::actor::ActorImpl(simgrid::xbt::string(name), host);
460 actor->set_user_data(data);
461 actor->code = nullptr;
463 if (parent_process != nullptr)
464 actor->set_ppid(parent_process->get_pid());
466 XBT_VERB("Create context %s", actor->get_cname());
467 xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
468 actor->context_ = simix_global->context_factory->attach(actor);
471 if (properties != nullptr)
472 for (auto const& kv : *properties)
473 actor->set_property(kv.first, kv.second);
475 /* Add the process to it's host process list */
476 host->pimpl_->process_list_.push_back(*actor);
478 /* Now insert it in the global process list and in the process to run list */
479 simix_global->process_list[actor->get_pid()] = actor;
480 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
481 simix_global->actors_to_run.push_back(actor);
482 intrusive_ptr_add_ref(actor);
484 auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_);
485 xbt_assert(nullptr != context, "Not a suitable context");
486 context->attach_start();
488 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
489 simgrid::s4u::ActorPtr tmp = actor->iface(); // Passing this directly to on_creation will lead to crashes
490 simgrid::s4u::Actor::on_creation(tmp);
495 void SIMIX_process_detach()
497 auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(simgrid::kernel::context::Context::self());
498 if (context == nullptr)
499 xbt_die("Not a suitable context");
501 context->get_actor()->cleanup();
502 context->attach_stop();
506 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
508 void SIMIX_process_throw(smx_actor_t actor, xbt_errcat_t cat, int value, const char* msg)
510 SMX_EXCEPTION(actor, cat, value, msg);
512 if (actor->is_suspended())
515 /* cancel the blocking synchro if any */
516 if (actor->waiting_synchro) {
518 simgrid::kernel::activity::ExecImplPtr exec =
519 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(actor->waiting_synchro);
523 simgrid::kernel::activity::CommImplPtr comm =
524 boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(actor->waiting_synchro);
525 if (comm != nullptr) {
526 actor->comms.remove(comm);
530 simgrid::kernel::activity::SleepImplPtr sleep =
531 boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(actor->waiting_synchro);
532 if (sleep != nullptr) {
533 SIMIX_process_sleep_destroy(actor->waiting_synchro);
534 if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
535 end(simix_global->actors_to_run) &&
536 actor != SIMIX_process_self()) {
537 XBT_DEBUG("Inserting [%p] %s in the to_run list", actor, actor->get_cname());
538 simix_global->actors_to_run.push_back(actor);
542 simgrid::kernel::activity::RawImplPtr raw =
543 boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(actor->waiting_synchro);
544 if (raw != nullptr) {
545 SIMIX_synchro_stop_waiting(actor, &actor->simcall);
548 simgrid::kernel::activity::IoImplPtr io =
549 boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(actor->waiting_synchro);
554 actor->waiting_synchro = nullptr;
557 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t actor)
559 smx_activity_t sync_suspend = actor->suspend(simcall->issuer);
561 if (actor != simcall->issuer) {
562 SIMIX_simcall_answer(simcall);
564 sync_suspend->simcalls_.push_back(simcall);
565 actor->waiting_synchro = sync_suspend;
566 actor->waiting_synchro->suspend();
568 /* If we are suspending ourselves, then just do not finish the simcall now */
571 int SIMIX_process_get_maxpid() {
572 return simix_process_maxpid;
575 int SIMIX_process_count()
577 return simix_global->process_list.size();
580 void* SIMIX_process_self_get_data()
582 smx_actor_t self = SIMIX_process_self();
584 if (self == nullptr) {
587 return self->get_user_data();
590 void SIMIX_process_self_set_data(void *data)
592 SIMIX_process_self()->set_user_data(data);
596 /* needs to be public and without simcall because it is called
597 by exceptions and logging events */
598 const char* SIMIX_process_self_get_name() {
600 smx_actor_t process = SIMIX_process_self();
601 if (process == nullptr || process == simix_global->maestro_process)
604 return process->get_cname();
607 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
609 if (process->finished_) {
610 // The joined process is already finished, just wake up the issuer process right away
611 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
612 SIMIX_simcall_answer(simcall);
615 smx_activity_t sync = simcall->issuer->join(process, timeout);
616 sync->simcalls_.push_back(simcall);
617 simcall->issuer->waiting_synchro = sync;
620 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
622 if (MC_is_active() || MC_record_replay_is_active()) {
623 MC_process_clock_add(simcall->issuer, duration);
624 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
625 SIMIX_simcall_answer(simcall);
628 smx_activity_t sync = simcall->issuer->sleep(duration);
629 sync->simcalls_.push_back(simcall);
630 simcall->issuer->waiting_synchro = sync;
633 void SIMIX_process_sleep_destroy(smx_activity_t synchro)
635 XBT_DEBUG("Destroy sleep synchro %p", synchro.get());
636 simgrid::kernel::activity::SleepImplPtr sleep =
637 boost::static_pointer_cast<simgrid::kernel::activity::SleepImpl>(synchro);
639 if (sleep->surf_action_) {
640 sleep->surf_action_->unref();
641 sleep->surf_action_ = nullptr;
646 * @brief Calling this function makes the process to yield.
648 * Only the current process can call this function, giving back the control to maestro.
650 * @param self the current process
653 /** @brief Returns the list of processes to run.
656 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
658 return simix_global->actors_to_run;
661 /** @brief Returns the process from PID. */
662 smx_actor_t SIMIX_process_from_PID(aid_t PID)
664 auto actor = simix_global->process_list.find(PID);
665 return actor == simix_global->process_list.end() ? nullptr : actor->second;
668 void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* data)
670 SIMIX_process_on_exit(actor, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
673 void SIMIX_process_on_exit(smx_actor_t actor, std::function<void(int, void*)> fun, void* data)
675 xbt_assert(actor, "current process not found: are you in maestro context ?");
677 actor->on_exit.emplace_back(s_smx_process_exit_fun_t{fun, data});
680 /** @brief Restart a process, starting it again from the beginning. */
682 * @ingroup simix_process_management
683 * @brief Creates and runs a new SIMIX process.
685 * The structure and the corresponding thread are created and put in the list of ready processes.
687 * @param name a name for the process. It is for user-level information and can be nullptr.
688 * @param code the main function of the process
689 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
691 * It can be retrieved with the method ActorImpl::getUserData().
692 * @param host where the new agent is executed.
693 * @param properties the properties of the process
695 smx_actor_t simcall_process_create(std::string name, simgrid::simix::ActorCode code, void* data, sg_host_t host,
696 std::unordered_map<std::string, std::string>* properties)
698 smx_actor_t self = SIMIX_process_self();
699 return simgrid::simix::simcall([name, code, data, host, properties, self] {
700 return simgrid::kernel::actor::ActorImpl::create(std::move(name), std::move(code), data, host, properties, self)
705 void simcall_process_set_data(smx_actor_t process, void* data)
707 simgrid::simix::simcall([process, data] { process->set_user_data(data); });