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 #include "src/kernel/EngineImpl.hpp"
12 #include "src/smpi/include/private.hpp"
14 #include "src/surf/HostImpl.hpp"
16 #include <boost/core/demangle.hpp>
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_actor, kernel, "Logging specific to Actor's kernel side");
23 * @brief Returns the current agent.
25 * This functions returns the currently running SIMIX process.
27 * @return The SIMIX process
29 smx_actor_t SIMIX_process_self() // XBT_ATTRIB_DEPRECATED_v333
31 return simgrid::kernel::actor::ActorImpl::self();
38 static unsigned long maxpid = 0;
39 unsigned long get_maxpid()
43 unsigned long* get_maxpid_addr()
47 ActorImpl* ActorImpl::by_pid(aid_t pid)
49 return EngineImpl::get_instance()->get_actor_by_pid(pid);
52 ActorImpl* ActorImpl::self()
54 const context::Context* self_context = context::Context::self();
56 return (self_context != nullptr) ? self_context->get_actor() : nullptr;
59 ActorImpl::ActorImpl(xbt::string name, s4u::Host* host) : host_(host), name_(std::move(name)), piface_(this)
62 simcall_.issuer_ = this;
63 stacksize_ = context::stack_size;
66 ActorImpl::~ActorImpl()
68 if (EngineImpl::has_instance() && not EngineImpl::get_instance()->is_maestro(this))
69 s4u::Actor::on_destruction(*get_ciface());
72 /* Become an actor in the simulation
74 * Currently this can only be called by the main thread (once) and only work with some thread factories
75 * (currently ThreadContextFactory).
77 * In the future, it might be extended in order to attach other threads created by a third party library.
80 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host)
82 // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
83 auto* engine = EngineImpl::get_instance();
84 XBT_DEBUG("Attach actor %s on host '%s'", name.c_str(), host->get_cname());
86 if (not host->is_on()) {
87 XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
88 throw HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
91 auto* actor = new ActorImpl(xbt::string(name), host);
93 actor->piface_.set_data(data);
94 actor->code_ = nullptr;
96 XBT_VERB("Create context %s", actor->get_cname());
97 actor->context_.reset(engine->get_context_factory()->attach(actor));
99 /* Add the actor to it's host actor list */
100 host->get_impl()->add_actor(actor);
102 /* Now insert it in the global actor list and in the actors to run list */
103 engine->add_actor(actor->get_pid(), actor);
104 engine->add_actor_to_run_list_no_check(actor);
105 intrusive_ptr_add_ref(actor);
107 auto* context = dynamic_cast<context::AttachContext*>(actor->context_.get());
108 xbt_assert(nullptr != context, "Not a suitable context");
109 context->attach_start();
111 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
112 s4u::Actor::on_creation(*actor->get_ciface());
114 return ActorImplPtr(actor);
116 /** @brief Detach an actor attached with `attach()`
118 * This is called when the current actor has finished its job.
119 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
120 * simulated actors and the maestro are destroyed.
122 void ActorImpl::detach()
124 auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
125 xbt_assert(context != nullptr, "Not a suitable context");
127 context->get_actor()->cleanup();
128 context->attach_stop();
131 /** Whether this actor is actually maestro */
132 bool ActorImpl::is_maestro() const
134 return context_->is_maestro();
137 void ActorImpl::cleanup_from_simix()
139 auto* engine = EngineImpl::get_instance();
140 const std::lock_guard<std::mutex> lock(engine->get_mutex());
141 engine->remove_actor(pid_);
142 if (host_ && host_actor_list_hook.is_linked())
143 host_->get_impl()->remove_actor(this);
144 if (not kernel_destroy_list_hook.is_linked())
145 engine->add_actor_to_destroy_list(*this);
148 void ActorImpl::cleanup()
152 if (has_to_auto_restart() && not get_host()->is_on()) {
153 XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
155 watched_hosts().insert(get_host()->get_name());
159 // Execute the termination callbacks
160 bool failed = context_->wannadie();
161 for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
167 /* cancel non-blocking activities */
168 for (auto activity : activities_)
172 XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
174 if (EngineImpl::get_instance()->is_maestro(this)) /* Do not cleanup maestro */
177 XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro_.get());
179 /* Unregister associated timers if any */
180 if (kill_timer_ != nullptr) {
181 kill_timer_->remove();
182 kill_timer_ = nullptr;
184 if (simcall_.timeout_cb_) {
185 simcall_.timeout_cb_->remove();
186 simcall_.timeout_cb_ = nullptr;
189 cleanup_from_simix();
191 context_->set_wannadie(false); // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
192 actor::simcall_answered([this] { s4u::Actor::on_termination(*get_ciface()); });
193 context_->set_wannadie();
196 void ActorImpl::exit()
198 context_->set_wannadie();
200 exception_ = nullptr;
202 /* destroy the blocking synchro if any */
203 if (auto activity = waiting_synchro_) {
204 activities_.remove(waiting_synchro_);
205 waiting_synchro_ = nullptr;
208 activity->set_state(activity::State::FAILED);
211 for (auto const& activity : activities_)
215 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
216 this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
219 void ActorImpl::kill(ActorImpl* actor) const
221 xbt_assert(not actor->is_maestro(), "Killing maestro is a rather bad idea.");
222 if (actor->finished_) {
223 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
224 actor->host_->get_cname());
228 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
229 actor->host_ ? actor->host_->get_cname() : "");
234 XBT_DEBUG("Go on, this is a suicide,");
236 EngineImpl::get_instance()->add_actor_to_run_list(actor);
239 void ActorImpl::kill_all() const
241 for (auto const& kv : EngineImpl::get_instance()->get_actor_list())
242 if (kv.second != this)
243 this->kill(kv.second);
246 void ActorImpl::set_kill_time(double kill_time)
248 if (kill_time <= s4u::Engine::get_clock())
250 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
251 kill_timer_ = timer::Timer::set(kill_time, [this] {
253 kill_timer_ = nullptr;
257 double ActorImpl::get_kill_time() const
259 return kill_timer_ ? kill_timer_->get_date() : 0.0;
262 void ActorImpl::yield()
264 XBT_DEBUG("Yield actor '%s'", get_cname());
266 /* Go into sleep and return control to maestro */
268 /* Ok, maestro returned control to us */
269 XBT_DEBUG("Control returned to me: '%s'", get_cname());
271 if (context_->wannadie()) {
272 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
278 XBT_DEBUG("Hey! I'm suspended.");
279 xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
280 yield(); // Yield back to maestro without proceeding with my execution. I'll get rescheduled by resume()
283 if (exception_ != nullptr) {
284 XBT_DEBUG("Wait, maestro left me an exception");
285 std::exception_ptr exception = std::move(exception_);
286 exception_ = nullptr;
288 std::rethrow_exception(std::move(exception));
289 } catch (const simgrid::Exception& e) {
290 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
295 smpi_switch_data_segment(get_iface());
299 /** This actor will be terminated automatically when the last non-daemon actor finishes */
300 void ActorImpl::daemonize()
304 EngineImpl::get_instance()->add_daemon(this);
308 void ActorImpl::undaemonize()
312 EngineImpl::get_instance()->remove_daemon(this);
316 s4u::Actor* ActorImpl::restart()
318 xbt_assert(not this->is_maestro(), "Restarting maestro is not supported");
320 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
322 // retrieve the arguments of the old actor
323 ProcessArg arg(host_, this);
325 // kill the old actor
326 context::Context::self()->get_actor()->kill(this);
328 // start the new actor
329 ActorImplPtr actor = ActorImpl::create(arg.name, arg.code, arg.data, arg.host, nullptr);
330 actor->set_properties(arg.properties);
331 *actor->on_exit = std::move(*arg.on_exit);
332 actor->set_kill_time(arg.kill_time);
333 actor->set_auto_restart(arg.auto_restart);
335 return actor->get_ciface();
338 void ActorImpl::suspend()
341 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
347 /* Suspend the activities associated with this actor. */
348 for (auto const& activity : activities_)
352 void ActorImpl::resume()
354 XBT_IN("actor = %p", this);
356 if (context_->wannadie()) {
357 XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
365 /* resume the activities that were blocked when suspending the actor. */
366 for (auto const& activity : activities_)
368 if (not waiting_synchro_) // Reschedule the actor if it was forcefully unscheduled in yield()
369 EngineImpl::get_instance()->add_actor_to_run_list_no_check(this);
374 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
376 activity::ActivityImplPtr sleep = this->sleep(timeout);
377 actor->on_exit->emplace_back([sleep](bool) {
378 if (sleep->surf_action_)
379 sleep->surf_action_->finish(resource::Action::State::FINISHED);
384 activity::ActivityImplPtr ActorImpl::sleep(double duration)
386 if (not host_->is_on())
387 throw_exception(std::make_exception_ptr(HostFailureException(
388 XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
390 auto sleep = new activity::SleepImpl();
391 sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
392 return activity::SleepImplPtr(sleep);
395 void ActorImpl::throw_exception(std::exception_ptr e)
402 /* cancel the blocking synchro if any */
403 if (waiting_synchro_) {
404 waiting_synchro_->cancel();
405 activities_.remove(waiting_synchro_);
406 waiting_synchro_ = nullptr;
410 void ActorImpl::simcall_answer()
412 auto* engine = EngineImpl::get_instance();
413 if (not this->is_maestro()) {
414 XBT_DEBUG("Answer simcall %s issued by %s (%p)", SIMIX_simcall_name(simcall_), get_cname(), this);
415 xbt_assert(simcall_.call_ != simix::Simcall::NONE);
416 simcall_.call_ = simix::Simcall::NONE;
417 const auto& actors_to_run = engine->get_actors_to_run();
418 xbt_assert(not XBT_LOG_ISENABLED(ker_actor, xbt_log_priority_debug) ||
419 std::find(begin(actors_to_run), end(actors_to_run), this) == end(actors_to_run),
420 "Actor %p should not exist in actors_to_run!", this);
421 engine->add_actor_to_run_list_no_check(this);
425 void ActorImpl::set_host(s4u::Host* dest)
427 host_->get_impl()->remove_actor(this);
429 dest->get_impl()->add_actor(this);
432 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
434 auto* actor = new ActorImpl(xbt::string(name), host);
435 actor->set_ppid(this->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'", name_.c_str(), 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(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 */
489 void create_maestro(const std::function<void()>& code)
491 auto* engine = EngineImpl::get_instance();
492 /* Create maestro actor and initialize it */
493 auto* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
496 maestro->context_.reset(engine->get_context_factory()->create_context(ActorCode(), maestro));
498 maestro->context_.reset(engine->get_context_factory()->create_maestro(ActorCode(code), maestro));
501 maestro->simcall_.issuer_ = maestro;
502 engine->set_maestro(maestro);
506 } // namespace kernel
507 } // namespace simgrid
509 /* needs to be public and without simcall because it is called by exceptions and logging events */
510 const char* SIMIX_process_self_get_name() // XBT_ATTRIB_DEPRECATED_v333
512 return simgrid::s4u::Actor::is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
515 int SIMIX_is_maestro() // XBT_ATTRIB_DEPRECATED_v333
517 const auto* self = simgrid::kernel::actor::ActorImpl::self();
518 return self != nullptr && self->is_maestro();