1 /* Copyright (c) 2007-2022. 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. */
6 #include <simgrid/Exception.hpp>
7 #include <simgrid/s4u/Actor.hpp>
8 #include <simgrid/s4u/Host.hpp>
10 #define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v333)
11 #include <simgrid/simix.h>
13 #include "src/kernel/EngineImpl.hpp"
15 #include "src/smpi/include/private.hpp"
17 #include "src/surf/HostImpl.hpp"
19 #include <boost/core/demangle.hpp>
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_actor, kernel, "Logging specific to Actor's kernel side");
26 * @brief Returns the current agent.
28 * This functions returns the currently running SIMIX process.
30 * @return The SIMIX process
32 simgrid::kernel::actor::ActorImpl* SIMIX_process_self() // XBT_ATTRIB_DEPRECATED_v333
34 return simgrid::kernel::actor::ActorImpl::self();
41 /*------------------------- [ ActorIDTrait ] -------------------------*/
42 unsigned long ActorIDTrait::maxpid_ = 0;
44 ActorIDTrait::ActorIDTrait(const std::string& name, aid_t ppid) : name_(name), pid_(maxpid_++), ppid_(ppid) {}
46 ActorImpl* ActorImpl::self()
48 const context::Context* self_context = context::Context::self();
50 return (self_context != nullptr) ? self_context->get_actor() : nullptr;
53 ActorImpl::ActorImpl(xbt::string name, s4u::Host* host, aid_t ppid)
54 : ActorIDTrait(std::move(name), ppid), host_(host), piface_(this)
56 simcall_.issuer_ = this;
57 stacksize_ = context::stack_size;
60 ActorImpl::~ActorImpl()
62 if (EngineImpl::has_instance() && not EngineImpl::get_instance()->is_maestro(this))
63 s4u::Actor::on_destruction(*get_ciface());
66 /* Become an actor in the simulation
68 * Currently this can only be called by the main thread (once) and only work with some thread factories
69 * (currently ThreadContextFactory).
71 * In the future, it might be extended in order to attach other threads created by a third party library.
74 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host)
76 // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
77 auto* engine = EngineImpl::get_instance();
78 XBT_DEBUG("Attach actor %s on host '%s'", name.c_str(), host->get_cname());
80 if (not host->is_on()) {
81 XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
82 throw HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
85 auto* actor = new ActorImpl(xbt::string(name), host, /*ppid*/ -1);
87 actor->piface_.set_data(data);
88 actor->code_ = nullptr;
90 XBT_VERB("Create context %s", actor->get_cname());
91 actor->context_.reset(engine->get_context_factory()->attach(actor));
93 /* Add the actor to it's host actor list */
94 host->get_impl()->add_actor(actor);
96 /* Now insert it in the global actor list and in the actors to run list */
97 engine->add_actor(actor->get_pid(), actor);
98 engine->add_actor_to_run_list_no_check(actor);
99 intrusive_ptr_add_ref(actor);
101 auto* context = dynamic_cast<context::AttachContext*>(actor->context_.get());
102 xbt_assert(nullptr != context, "Not a suitable context");
103 context->attach_start();
105 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
106 s4u::Actor::on_creation(*actor->get_ciface());
108 return ActorImplPtr(actor);
110 /** @brief Detach an actor attached with `attach()`
112 * This is called when the current actor has finished its job.
113 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
114 * simulated actors and the maestro are destroyed.
116 void ActorImpl::detach()
118 auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
119 xbt_assert(context != nullptr, "Not a suitable context");
121 context->get_actor()->cleanup_from_self();
122 context->attach_stop();
125 /** Whether this actor is actually maestro */
126 bool ActorImpl::is_maestro() const
128 return context_->is_maestro();
131 void ActorImpl::cleanup_from_kernel()
133 xbt_assert(s4u::Actor::is_maestro(), "Cleanup_from_kernel must be called in maestro context");
135 auto* engine = EngineImpl::get_instance();
136 if (engine->get_actor_by_pid(get_pid()) == nullptr)
137 return; // Already cleaned
139 engine->remove_actor(get_pid());
140 if (host_ && host_actor_list_hook.is_linked())
141 host_->get_impl()->remove_actor(this);
142 if (not kernel_destroy_list_hook.is_linked())
143 engine->add_actor_to_destroy_list(*this);
145 if (has_to_auto_restart() && not get_host()->is_on()) {
146 XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
148 watched_hosts().insert(get_host()->get_name());
152 s4u::Actor::on_termination(*get_ciface());
154 while (not mailboxes_.empty())
155 mailboxes_.back()->set_receiver(nullptr);
158 /* Do all the cleanups from the actor context. Warning, the simcall mechanism was not reignited so doing simcalls in
159 * this context is dangerous */
160 void ActorImpl::cleanup_from_self()
162 xbt_assert(not ActorImpl::is_maestro(), "Cleanup_from_self called from maestro on '%s'", get_cname());
166 // Execute the termination callbacks
167 bool failed = wannadie();
168 for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
173 /* cancel non-blocking activities */
174 for (auto activity : activities_)
178 XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
180 /* Unregister associated timers if any */
181 if (kill_timer_ != nullptr) {
182 kill_timer_->remove();
183 kill_timer_ = nullptr;
185 if (simcall_.timeout_cb_) {
186 simcall_.timeout_cb_->remove();
187 simcall_.timeout_cb_ = nullptr;
190 /* maybe the actor was killed during a simcall, reset its observer */
191 simcall_.observer_ = nullptr;
196 void ActorImpl::exit()
200 exception_ = nullptr;
202 if (waiting_synchro_ != nullptr) {
203 /* Take an extra reference on the activity object that may be unref by Comm::finish() or friends */
204 activity::ActivityImplPtr activity = waiting_synchro_;
206 activity->set_state(activity::State::FAILED);
209 activities_.remove(waiting_synchro_);
210 waiting_synchro_ = nullptr;
212 for (auto const& activity : activities_)
216 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
217 this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
220 void ActorImpl::kill(ActorImpl* actor) const
222 xbt_assert(not actor->is_maestro(), "Killing maestro is a rather bad idea.");
223 if (actor->wannadie()) {
224 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
225 actor->host_->get_cname());
229 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
230 actor->host_ ? actor->host_->get_cname() : "");
235 XBT_DEBUG("Go on, this is a suicide,");
237 EngineImpl::get_instance()->add_actor_to_run_list(actor);
240 void ActorImpl::kill_all() const
242 for (auto const& [_, actor] : EngineImpl::get_instance()->get_actor_list())
247 void ActorImpl::set_kill_time(double kill_time)
249 if (kill_time <= s4u::Engine::get_clock())
251 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
252 kill_timer_ = timer::Timer::set(kill_time, [this] {
254 kill_timer_ = nullptr;
255 EngineImpl::get_instance()->add_actor_to_run_list(this);
259 double ActorImpl::get_kill_time() const
261 return kill_timer_ ? kill_timer_->get_date() : 0.0;
264 void ActorImpl::yield()
266 XBT_DEBUG("Yield actor '%s'", get_cname());
268 /* Go into sleep and return control to maestro */
270 /* Ok, maestro returned control to us */
271 XBT_DEBUG("Control returned to me: '%s'", get_cname());
274 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
280 XBT_DEBUG("Hey! I'm suspended.");
281 xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
282 yield(); // Yield back to maestro without proceeding with my execution. I'll get rescheduled by resume()
285 if (exception_ != nullptr) {
286 XBT_DEBUG("Wait, maestro left me an exception");
287 std::exception_ptr exception = std::move(exception_);
288 exception_ = nullptr;
290 std::rethrow_exception(std::move(exception));
291 } catch (const simgrid::Exception& e) {
292 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
297 smpi_switch_data_segment(get_iface());
301 /** This actor will be terminated automatically when the last non-daemon actor finishes */
302 void ActorImpl::daemonize()
306 EngineImpl::get_instance()->add_daemon(this);
310 void ActorImpl::undaemonize()
314 EngineImpl::get_instance()->remove_daemon(this);
318 s4u::Actor* ActorImpl::restart()
320 xbt_assert(not this->is_maestro(), "Restarting maestro is not supported");
322 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
324 // retrieve the arguments of the old actor
325 ProcessArg args(host_, this);
327 // kill the old actor
328 context::Context::self()->get_actor()->kill(this);
330 // start the new actor
331 return create(&args)->get_ciface();
334 void ActorImpl::suspend()
337 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
343 /* Suspend the activities associated with this actor. */
344 for (auto const& activity : activities_)
348 void ActorImpl::resume()
350 XBT_IN("actor = %p", this);
353 XBT_VERB("Ignoring request to resume an actor that is currently dying.");
361 /* resume the activities that were blocked when suspending the actor. */
362 for (auto const& activity : activities_)
364 if (not waiting_synchro_) // Reschedule the actor if it was forcefully unscheduled in yield()
365 EngineImpl::get_instance()->add_actor_to_run_list_no_check(this);
370 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
372 activity::ActivityImplPtr sleep = this->sleep(timeout);
373 if (actor->wannadie() || actor->to_be_freed()) {
374 if (sleep->surf_action_)
375 sleep->surf_action_->finish(resource::Action::State::FINISHED);
377 actor->on_exit->emplace_back([sleep](bool) {
378 if (sleep->surf_action_)
379 sleep->surf_action_->finish(resource::Action::State::FINISHED);
385 activity::ActivityImplPtr ActorImpl::sleep(double duration)
387 if (not host_->is_on())
388 throw_exception(std::make_exception_ptr(HostFailureException(
389 XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
391 auto sleep = new activity::SleepImpl();
392 sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
393 return activity::SleepImplPtr(sleep);
396 void ActorImpl::throw_exception(std::exception_ptr e)
403 /* cancel the blocking synchro if any */
404 if (waiting_synchro_) {
405 waiting_synchro_->cancel();
406 activities_.remove(waiting_synchro_);
407 waiting_synchro_ = nullptr;
411 void ActorImpl::simcall_answer()
413 auto* engine = EngineImpl::get_instance();
414 if (not this->is_maestro()) {
415 XBT_DEBUG("Answer simcall %s issued by %s (%p)", simcall_.get_cname(), get_cname(), this);
416 xbt_assert(simcall_.call_ != Simcall::Type::NONE);
417 simcall_.call_ = Simcall::Type::NONE;
418 const auto& actors_to_run = engine->get_actors_to_run();
419 xbt_assert(not XBT_LOG_ISENABLED(ker_actor, xbt_log_priority_debug) ||
420 std::find(begin(actors_to_run), end(actors_to_run), this) == end(actors_to_run),
421 "Actor %p should not exist in actors_to_run!", this);
422 engine->add_actor_to_run_list_no_check(this);
426 void ActorImpl::set_host(s4u::Host* dest)
428 host_->get_impl()->remove_actor(this);
430 dest->get_impl()->add_actor(this);
433 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
435 auto* actor = new ActorImpl(xbt::string(name), host, get_pid());
437 intrusive_ptr_add_ref(actor);
438 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
439 s4u::Actor::on_creation(*actor->get_ciface());
441 return ActorImplPtr(actor);
444 ActorImpl* ActorImpl::start(const ActorCode& code)
446 xbt_assert(code && host_ != nullptr, "Invalid parameters");
447 auto* engine = EngineImpl::get_instance();
449 if (not host_->is_on()) {
450 XBT_WARN("Cannot launch actor '%s' on failed host '%s'", get_cname(), host_->get_cname());
451 intrusive_ptr_release(this);
452 throw HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
456 XBT_VERB("Create context %s", get_cname());
457 context_.reset(engine->get_context_factory()->create_context(ActorCode(code), this));
459 XBT_DEBUG("Start context '%s'", get_cname());
461 /* Add the actor to its host's actor list */
462 host_->get_impl()->add_actor(this);
463 engine->add_actor(get_pid(), this);
465 /* Now insert it in the global actor list and in the actor to run list */
466 engine->add_actor_to_run_list_no_check(this);
471 ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
472 const ActorImpl* parent_actor)
474 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
477 if (parent_actor != nullptr)
478 actor = parent_actor->init(xbt::string(name), host);
480 actor = self()->init(xbt::string(name), host);
482 actor->piface_.set_data(data); /* actor data */
488 ActorImplPtr ActorImpl::create(ProcessArg* args)
490 ActorImplPtr actor = ActorImpl::create(args->name, args->code, nullptr, args->host, nullptr);
491 actor->restart_count_ = args->restart_count_;
492 actor->set_properties(args->properties);
494 *actor->on_exit = *args->on_exit;
495 if (args->kill_time >= 0)
496 actor->set_kill_time(args->kill_time);
497 if (args->auto_restart)
498 actor->set_auto_restart(args->auto_restart);
503 void ActorImpl::set_wannadie(bool value)
505 XBT_DEBUG("Actor %s gonna die.", get_cname());
509 void create_maestro(const std::function<void()>& code)
511 auto* engine = EngineImpl::get_instance();
512 /* Create maestro actor and initialize it */
513 auto* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr, /*ppid*/ -1);
516 maestro->context_.reset(engine->get_context_factory()->create_context(ActorCode(), maestro));
518 maestro->context_.reset(engine->get_context_factory()->create_maestro(ActorCode(code), maestro));
521 maestro->simcall_.issuer_ = maestro;
522 engine->set_maestro(maestro);
526 } // namespace kernel
527 } // namespace simgrid
529 /* needs to be public and without simcall because it is called by exceptions and logging events */
530 const char* SIMIX_process_self_get_name() // XBT_ATTRIB_DEPRECATED_v333
532 return simgrid::s4u::Actor::is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
535 int SIMIX_is_maestro() // XBT_ATTRIB_DEPRECATED_v333
537 const auto* self = simgrid::kernel::actor::ActorImpl::self();
538 return self != nullptr && self->is_maestro();