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 "src/mc/mc_replay.hpp"
7 #include <simgrid/Exception.hpp>
8 #include <simgrid/s4u/Actor.hpp>
9 #include <simgrid/s4u/Host.hpp>
11 #include "src/kernel/EngineImpl.hpp"
13 #include "src/smpi/include/private.hpp"
15 #include "src/surf/HostImpl.hpp"
17 #include <boost/core/demangle.hpp>
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_actor, kernel, "Logging specific to Actor's kernel side");
23 namespace simgrid::kernel::actor {
25 /*------------------------- [ ActorIDTrait ] -------------------------*/
26 unsigned long ActorIDTrait::maxpid_ = 0;
28 ActorIDTrait::ActorIDTrait(const std::string& name, aid_t ppid) : name_(name), pid_(maxpid_++), ppid_(ppid) {}
30 ActorImpl* ActorImpl::self()
32 const context::Context* self_context = context::Context::self();
34 return (self_context != nullptr) ? self_context->get_actor() : nullptr;
37 ActorImpl::ActorImpl(const std::string& name, s4u::Host* host, aid_t ppid)
38 : ActorIDTrait(name, ppid), host_(host), piface_(this)
40 simcall_.issuer_ = this;
41 stacksize_ = context::stack_size;
44 ActorImpl::~ActorImpl()
46 if (EngineImpl::has_instance() && not EngineImpl::get_instance()->is_maestro(this))
47 s4u::Actor::on_destruction(*get_ciface());
50 /* Become an actor in the simulation
52 * Currently this can only be called by the main thread (once) and only work with some thread factories
53 * (currently ThreadContextFactory).
55 * In the future, it might be extended in order to attach other threads created by a third party library.
58 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host)
60 // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
61 auto* engine = EngineImpl::get_instance();
62 XBT_DEBUG("Attach actor %s on host '%s'", name.c_str(), host->get_cname());
64 if (not host->is_on()) {
65 XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
66 throw HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
69 auto* actor = new ActorImpl(name, host, /*ppid*/ -1);
71 actor->piface_.set_data(data);
72 actor->code_ = nullptr;
74 XBT_VERB("Create context %s", actor->get_cname());
75 actor->context_.reset(engine->get_context_factory()->attach(actor));
77 /* Add the actor to it's host actor list */
78 host->get_impl()->add_actor(actor);
80 /* Now insert it in the global actor list and in the actors to run list */
81 engine->add_actor(actor->get_pid(), actor);
82 engine->add_actor_to_run_list_no_check(actor);
83 intrusive_ptr_add_ref(actor);
85 auto* context = dynamic_cast<context::AttachContext*>(actor->context_.get());
86 xbt_assert(nullptr != context, "Not a suitable context");
87 context->attach_start();
89 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
90 s4u::Actor::on_creation(*actor->get_ciface());
92 return ActorImplPtr(actor);
94 /** @brief Detach an actor attached with `attach()`
96 * This is called when the current actor has finished its job.
97 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
98 * simulated actors and the maestro are destroyed.
100 void ActorImpl::detach()
102 auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
103 xbt_assert(context != nullptr, "Not a suitable context");
105 context->get_actor()->cleanup_from_self();
106 context->attach_stop();
109 /** Whether this actor is actually maestro */
110 bool ActorImpl::is_maestro() const
112 return context_->is_maestro();
115 void ActorImpl::cleanup_from_kernel()
117 xbt_assert(s4u::Actor::is_maestro(), "Cleanup_from_kernel must be called in maestro context");
119 auto* engine = EngineImpl::get_instance();
120 if (engine->get_actor_by_pid(get_pid()) == nullptr)
121 return; // Already cleaned
123 engine->remove_actor(get_pid());
124 if (host_ && host_actor_list_hook.is_linked())
125 host_->get_impl()->remove_actor(this);
126 if (not kernel_destroy_list_hook.is_linked())
127 engine->add_actor_to_destroy_list(*this);
129 if (has_to_auto_restart() && not get_host()->is_on()) {
130 XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
132 watched_hosts().insert(get_host()->get_name());
136 s4u::Actor::on_termination(*get_ciface());
138 while (not mailboxes_.empty())
139 mailboxes_.back()->set_receiver(nullptr);
142 /* Do all the cleanups from the actor context. Warning, the simcall mechanism was not reignited so doing simcalls in
143 * this context is dangerous */
144 void ActorImpl::cleanup_from_self()
146 xbt_assert(not ActorImpl::is_maestro(), "Cleanup_from_self called from maestro on '%s'", get_cname());
150 // Execute the termination callbacks
151 bool failed = wannadie();
152 for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
157 /* cancel non-blocking activities */
158 for (auto activity : activities_)
162 XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
164 /* Unregister associated timers if any */
165 if (kill_timer_ != nullptr) {
166 kill_timer_->remove();
167 kill_timer_ = nullptr;
169 if (simcall_.timeout_cb_) {
170 simcall_.timeout_cb_->remove();
171 simcall_.timeout_cb_ = nullptr;
174 /* maybe the actor was killed during a simcall, reset its observer */
175 simcall_.observer_ = nullptr;
180 void ActorImpl::exit()
184 exception_ = nullptr;
186 if (waiting_synchro_ != nullptr) {
187 /* Take an extra reference on the activity object that may be unref by Comm::finish() or friends */
188 activity::ActivityImplPtr activity = waiting_synchro_;
190 activity->set_state(activity::State::FAILED);
193 activities_.erase(waiting_synchro_);
194 waiting_synchro_ = nullptr;
196 for (auto const& activity : activities_)
200 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
201 this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
204 void ActorImpl::kill(ActorImpl* actor) const
206 xbt_assert(not actor->is_maestro(), "Killing maestro is a rather bad idea.");
207 if (actor->wannadie()) {
208 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
209 actor->host_->get_cname());
213 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
214 actor->host_ ? actor->host_->get_cname() : "");
219 XBT_DEBUG("Go on, this is a suicide,");
221 EngineImpl::get_instance()->add_actor_to_run_list(actor);
224 void ActorImpl::kill_all() const
226 for (auto const& [_, actor] : EngineImpl::get_instance()->get_actor_list())
231 void ActorImpl::set_kill_time(double kill_time)
233 if (kill_time <= s4u::Engine::get_clock())
235 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
236 kill_timer_ = timer::Timer::set(kill_time, [this] {
238 kill_timer_ = nullptr;
239 EngineImpl::get_instance()->add_actor_to_run_list(this);
243 double ActorImpl::get_kill_time() const
245 return kill_timer_ ? kill_timer_->get_date() : 0.0;
248 void ActorImpl::yield()
250 XBT_DEBUG("Yield actor '%s'", get_cname());
252 /* Go into sleep and return control to maestro */
254 /* Ok, maestro returned control to us */
255 XBT_DEBUG("Control returned to me: '%s'", get_cname());
258 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
264 XBT_DEBUG("Hey! I'm suspended.");
265 xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
266 yield(); // Yield back to maestro without proceeding with my execution. I'll get rescheduled by resume()
269 if (exception_ != nullptr) {
270 XBT_DEBUG("Wait, maestro left me an exception");
271 std::exception_ptr exception = std::move(exception_);
272 exception_ = nullptr;
274 std::rethrow_exception(std::move(exception));
275 } catch (const simgrid::Exception& e) {
276 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
281 smpi_switch_data_segment(get_iface());
283 if (simgrid_mc_replay_show_backtraces)
284 xbt_backtrace_display_current();
287 /** This actor will be terminated automatically when the last non-daemon actor finishes */
288 void ActorImpl::daemonize()
292 EngineImpl::get_instance()->add_daemon(this);
296 void ActorImpl::undaemonize()
300 EngineImpl::get_instance()->remove_daemon(this);
304 s4u::Actor* ActorImpl::restart()
306 xbt_assert(not this->is_maestro(), "Restarting maestro is not supported");
308 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
310 // retrieve the arguments of the old actor
311 ProcessArg args(host_, this);
313 // kill the old actor
314 context::Context::self()->get_actor()->kill(this);
316 // start the new actor
317 return create(&args)->get_ciface();
320 void ActorImpl::suspend()
323 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
329 /* Suspend the activities associated with this actor. */
330 for (auto const& activity : activities_)
334 void ActorImpl::resume()
336 XBT_IN("actor = %p", this);
339 XBT_VERB("Ignoring request to resume an actor that is currently dying.");
347 /* resume the activities that were blocked when suspending the actor. */
348 for (auto const& activity : activities_)
350 if (not waiting_synchro_) // Reschedule the actor if it was forcefully unscheduled in yield()
351 EngineImpl::get_instance()->add_actor_to_run_list_no_check(this);
356 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
358 activity::ActivityImplPtr sleep_activity = this->sleep(timeout);
359 if (actor->wannadie() || actor->to_be_freed()) {
360 if (sleep_activity->surf_action_)
361 sleep_activity->surf_action_->finish(resource::Action::State::FINISHED);
363 actor->on_exit->emplace_back([sleep_activity](bool) {
364 if (sleep_activity->surf_action_)
365 sleep_activity->surf_action_->finish(resource::Action::State::FINISHED);
368 return sleep_activity;
371 activity::ActivityImplPtr ActorImpl::sleep(double duration)
373 if (not host_->is_on())
374 throw_exception(std::make_exception_ptr(
375 HostFailureException(XBT_THROW_POINT, "Host " + host_->get_name() + " failed, you cannot sleep there.")));
377 auto sleep_activity = new activity::SleepImpl();
378 sleep_activity->set_name("sleep").set_host(host_).set_duration(duration).start();
379 return activity::SleepImplPtr(sleep_activity);
382 void ActorImpl::throw_exception(std::exception_ptr e)
389 /* cancel the blocking synchro if any */
390 if (waiting_synchro_) {
391 waiting_synchro_->cancel();
392 activities_.erase(waiting_synchro_);
393 waiting_synchro_ = nullptr;
397 void ActorImpl::simcall_answer()
399 auto* engine = EngineImpl::get_instance();
400 if (not this->is_maestro()) {
401 XBT_DEBUG("Answer simcall %s issued by %s (%p)", simcall_.get_cname(), get_cname(), this);
402 xbt_assert(simcall_.call_ != Simcall::Type::NONE);
403 simcall_.call_ = Simcall::Type::NONE;
404 const auto& actors_to_run = engine->get_actors_to_run();
405 xbt_assert(not XBT_LOG_ISENABLED(ker_actor, xbt_log_priority_debug) ||
406 std::find(begin(actors_to_run), end(actors_to_run), this) == end(actors_to_run),
407 "Actor %p should not exist in actors_to_run!", this);
408 engine->add_actor_to_run_list_no_check(this);
412 void ActorImpl::set_host(s4u::Host* dest)
414 host_->get_impl()->remove_actor(this);
416 dest->get_impl()->add_actor(this);
419 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
421 auto* actor = new ActorImpl(name, host, get_pid());
423 intrusive_ptr_add_ref(actor);
424 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
425 s4u::Actor::on_creation(*actor->get_ciface());
427 return ActorImplPtr(actor);
430 ActorImpl* ActorImpl::start(const ActorCode& code)
432 xbt_assert(code && host_ != nullptr, "Invalid parameters");
433 auto* engine = EngineImpl::get_instance();
435 if (not host_->is_on()) {
436 XBT_WARN("Cannot launch actor '%s' on failed host '%s'", get_cname(), host_->get_cname());
437 intrusive_ptr_release(this);
438 throw HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
442 XBT_VERB("Create context %s", get_cname());
443 context_.reset(engine->get_context_factory()->create_context(ActorCode(code), this));
445 XBT_DEBUG("Start context '%s'", get_cname());
447 /* Add the actor to its host's actor list */
448 host_->get_impl()->add_actor(this);
449 engine->add_actor(get_pid(), this);
451 /* Now insert it in the global actor list and in the actor to run list */
452 engine->add_actor_to_run_list_no_check(this);
457 ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
458 const ActorImpl* parent_actor)
460 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
463 if (parent_actor != nullptr)
464 actor = parent_actor->init(name, host);
466 actor = self()->init(name, host);
468 actor->piface_.set_data(data); /* actor data */
474 ActorImplPtr ActorImpl::create(ProcessArg* args)
476 ActorImplPtr actor = ActorImpl::create(args->name, args->code, nullptr, args->host, nullptr);
477 actor->restart_count_ = args->restart_count_;
478 actor->set_properties(args->properties);
480 *actor->on_exit = *args->on_exit;
481 if (args->kill_time >= 0)
482 actor->set_kill_time(args->kill_time);
483 if (args->auto_restart)
484 actor->set_auto_restart(args->auto_restart);
489 void ActorImpl::set_wannadie(bool value)
491 XBT_DEBUG("Actor %s gonna die.", get_cname());
495 void create_maestro(const std::function<void()>& code)
497 auto* engine = EngineImpl::get_instance();
498 /* Create maestro actor and initialize it */
499 auto* maestro = new ActorImpl(/*name*/ "", /*host*/ nullptr, /*ppid*/ -1);
502 maestro->context_.reset(engine->get_context_factory()->create_context(ActorCode(), maestro));
504 maestro->context_.reset(engine->get_context_factory()->create_maestro(ActorCode(code), maestro));
507 maestro->simcall_.issuer_ = maestro;
508 engine->set_maestro(maestro);
511 /** (in kernel mode) unpack the simcall and activate the handler */
512 void ActorImpl::simcall_handle(int times_considered)
514 XBT_DEBUG("Handling simcall %p: %s(%ld) %s", &simcall_, simcall_.issuer_->get_cname(), simcall_.issuer_->get_pid(),
515 (simcall_.observer_ != nullptr ? simcall_.observer_->to_string().c_str() : simcall_.get_cname()));
516 if (simcall_.observer_ != nullptr)
517 simcall_.observer_->prepare(times_considered);
521 xbt_assert(simcall_.call_ != Simcall::Type::NONE, "Asked to do the noop syscall on %s@%s", get_cname(),
522 get_host()->get_cname());
525 if (simcall_.call_ == Simcall::Type::RUN_ANSWERED)
529 } // namespace simgrid::kernel::actor