1 /* Copyright (c) 2007-2021. 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 "src/kernel/activity/CommImpl.hpp"
11 #include "src/kernel/activity/ExecImpl.hpp"
12 #include "src/kernel/activity/IoImpl.hpp"
13 #include "src/kernel/activity/SleepImpl.hpp"
14 #include "src/kernel/activity/SynchroRaw.hpp"
15 #include "src/mc/mc_replay.hpp"
16 #include "src/mc/remote/AppSide.hpp"
17 #include "src/simix/smx_private.hpp"
18 #include "src/surf/HostImpl.hpp"
19 #include "src/surf/cpu_interface.hpp"
21 #include <boost/core/demangle.hpp>
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
28 * @brief Returns the current agent.
30 * This functions returns the currently running SIMIX process.
32 * @return The SIMIX process
34 smx_actor_t SIMIX_process_self()
36 return simgrid::kernel::actor::ActorImpl::self();
43 static unsigned long maxpid = 0;
44 unsigned long get_maxpid()
48 unsigned long* get_maxpid_addr()
52 ActorImpl* ActorImpl::by_pid(aid_t pid)
54 auto item = simix_global->process_list.find(pid);
55 if (item != simix_global->process_list.end())
59 for (auto& a : simix_global->actors_to_destroy)
60 if (a.get_pid() == pid)
62 return nullptr; // Not found, even in the trash
65 ActorImpl* ActorImpl::self()
67 const context::Context* self_context = context::Context::self();
69 return (self_context != nullptr) ? self_context->get_actor() : nullptr;
72 ActorImpl::ActorImpl(xbt::string name, s4u::Host* host) : host_(host), name_(std::move(name)), piface_(this)
75 simcall_.issuer_ = this;
76 stacksize_ = smx_context_stack_size;
79 ActorImpl::~ActorImpl()
81 if (simix_global != nullptr && this != simix_global->maestro_)
82 s4u::Actor::on_destruction(*get_ciface());
85 /* Become an actor in the simulation
87 * Currently this can only be called by the main thread (once) and only work with some thread factories
88 * (currently ThreadContextFactory).
90 * In the future, it might be extended in order to attach other threads created by a third party library.
93 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host)
95 // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
97 XBT_DEBUG("Attach actor %s on host '%s'", name.c_str(), host->get_cname());
99 if (not host->is_on()) {
100 XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
101 throw HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
104 auto* actor = new ActorImpl(xbt::string(name), host);
106 actor->set_user_data(data);
107 actor->code_ = nullptr;
109 XBT_VERB("Create context %s", actor->get_cname());
110 xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
111 actor->context_.reset(simix_global->context_factory->attach(actor));
113 /* Add the actor to it's host actor list */
114 host->get_impl()->add_actor(actor);
116 /* Now insert it in the global actor list and in the actors to run list */
117 simix_global->process_list[actor->get_pid()] = actor;
118 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
119 simix_global->actors_to_run.push_back(actor);
120 intrusive_ptr_add_ref(actor);
122 auto* context = dynamic_cast<context::AttachContext*>(actor->context_.get());
123 xbt_assert(nullptr != context, "Not a suitable context");
124 context->attach_start();
126 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
127 s4u::Actor::on_creation(*actor->get_ciface());
129 return ActorImplPtr(actor);
131 /** @brief Detach an actor attached with `attach()`
133 * This is called when the current actor has finished its job.
134 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
135 * simulated actors and the maestro are destroyed.
137 void ActorImpl::detach()
139 auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
140 xbt_assert(context != nullptr, "Not a suitable context");
142 context->get_actor()->cleanup();
143 context->attach_stop();
146 void ActorImpl::cleanup_from_simix()
148 const std::lock_guard<std::mutex> lock(simix_global->mutex);
149 simix_global->process_list.erase(pid_);
150 if (host_ && host_actor_list_hook.is_linked())
151 host_->get_impl()->remove_actor(this);
152 if (not smx_destroy_list_hook.is_linked()) {
154 xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
156 simix_global->actors_to_destroy.push_back(*this);
160 void ActorImpl::cleanup()
164 if (has_to_auto_restart() && not get_host()->is_on()) {
165 XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
167 watched_hosts().insert(get_host()->get_name());
171 // Execute the termination callbacks
172 bool failed = context_->wannadie();
173 for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
179 /* cancel non-blocking activities */
180 for (auto activity : activities_)
184 XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
186 if (this == simix_global->maestro_) /* Do not cleanup maestro */
189 XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro_.get());
191 /* Unregister associated timers if any */
192 if (kill_timer_ != nullptr) {
193 kill_timer_->remove();
194 kill_timer_ = nullptr;
196 if (simcall_.timeout_cb_) {
197 simcall_.timeout_cb_->remove();
198 simcall_.timeout_cb_ = nullptr;
201 cleanup_from_simix();
203 context_->set_wannadie(false); // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
204 actor::simcall([this] { s4u::Actor::on_termination(*get_ciface()); });
205 context_->set_wannadie();
208 void ActorImpl::exit()
210 context_->set_wannadie();
212 exception_ = nullptr;
214 /* destroy the blocking synchro if any */
215 if (waiting_synchro_ != nullptr) {
216 waiting_synchro_->cancel();
217 waiting_synchro_->state_ = activity::State::FAILED;
219 activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro_);
220 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro_);
222 if (exec != nullptr) {
223 exec->clean_action();
224 } else if (comm != nullptr) {
225 comm->unregister_simcall(&simcall_);
227 activity::ActivityImplPtr(waiting_synchro_)->finish();
230 activities_.remove(waiting_synchro_);
231 waiting_synchro_ = nullptr;
234 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
235 this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
238 void ActorImpl::kill(ActorImpl* actor) const
240 xbt_assert(actor != simix_global->maestro_, "Killing maestro is a rather bad idea");
241 if (actor->finished_) {
242 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
243 actor->host_->get_cname());
247 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
248 actor->host_ ? actor->host_->get_cname() : "");
253 XBT_DEBUG("Go on, this is a suicide,");
254 } else if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) !=
255 end(simix_global->actors_to_run)) {
256 XBT_DEBUG("Actor %s is already in the to_run list", actor->get_cname());
258 XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
259 simix_global->actors_to_run.push_back(actor);
263 void ActorImpl::kill_all() const
265 for (auto const& kv : simix_global->process_list)
266 if (kv.second != this)
267 this->kill(kv.second);
270 void ActorImpl::set_kill_time(double kill_time)
272 if (kill_time <= SIMIX_get_clock())
274 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
275 kill_timer_ = simix::Timer::set(kill_time, [this] {
277 kill_timer_ = nullptr;
281 double ActorImpl::get_kill_time() const
283 return kill_timer_ ? kill_timer_->date : 0.0;
286 void ActorImpl::yield()
288 XBT_DEBUG("Yield actor '%s'", get_cname());
290 /* Go into sleep and return control to maestro */
293 /* Ok, maestro returned control to us */
294 XBT_DEBUG("Control returned to me: '%s'", get_cname());
296 if (context_->wannadie()) {
297 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
303 XBT_DEBUG("Hey! I'm suspended.");
304 xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
305 yield(); // Yield back to maestro without proceeding with my execution. I'll get rescheduled by resume()
308 if (exception_ != nullptr) {
309 XBT_DEBUG("Wait, maestro left me an exception");
310 std::exception_ptr exception = std::move(exception_);
311 exception_ = nullptr;
313 std::rethrow_exception(std::move(exception));
314 } catch (const simgrid::Exception& e) {
315 e.rethrow_nested(XBT_THROW_POINT, boost::core::demangle(typeid(e).name()) + " raised in kernel mode.");
319 if (SMPI_switch_data_segment && not finished_) {
320 SMPI_switch_data_segment(get_iface());
324 /** This actor will be terminated automatically when the last non-daemon actor finishes */
325 void ActorImpl::daemonize()
329 simix_global->daemons.push_back(this);
333 void ActorImpl::undaemonize()
336 auto& vect = simix_global->daemons;
337 auto it = std::find(vect.begin(), vect.end(), this);
338 xbt_assert(it != vect.end(), "The dying daemon is not a daemon after all. Please report that bug.");
339 /* Don't move the whole content since we don't really care about the order */
341 std::swap(*it, vect.back());
347 s4u::Actor* ActorImpl::restart()
349 xbt_assert(this != simix_global->maestro_, "Restarting maestro is not supported");
351 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
353 // retrieve the arguments of the old actor
354 ProcessArg arg(host_, this);
356 // kill the old actor
357 context::Context::self()->get_actor()->kill(this);
359 // start the new actor
360 ActorImplPtr actor = ActorImpl::create(arg.name, arg.code, arg.data, arg.host, nullptr);
361 actor->set_properties(arg.properties);
362 *actor->on_exit = std::move(*arg.on_exit);
363 actor->set_kill_time(arg.kill_time);
364 actor->set_auto_restart(arg.auto_restart);
366 return actor->get_ciface();
369 void ActorImpl::suspend()
372 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
378 /* Suspend the activities associated with this actor. */
379 for (auto& activity : activities_)
383 void ActorImpl::resume()
385 XBT_IN("actor = %p", this);
387 if (context_->wannadie()) {
388 XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
396 /* resume the activities that were blocked when suspending the actor. */
397 for (auto& activity : activities_)
399 if (not waiting_synchro_) // Reschedule the actor if it was forcefully unscheduled in yield()
400 simix_global->actors_to_run.push_back(this);
405 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
407 activity::ActivityImplPtr sleep = this->sleep(timeout);
408 actor->on_exit->emplace_back([sleep](bool) {
409 if (sleep->surf_action_)
410 sleep->surf_action_->finish(resource::Action::State::FINISHED);
415 activity::ActivityImplPtr ActorImpl::sleep(double duration)
417 if (not host_->is_on())
418 throw_exception(std::make_exception_ptr(HostFailureException(
419 XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
421 auto sleep = new activity::SleepImpl();
422 sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
423 return activity::SleepImplPtr(sleep);
426 void ActorImpl::throw_exception(std::exception_ptr e)
433 /* cancel the blocking synchro if any */
434 if (waiting_synchro_) {
435 waiting_synchro_->cancel();
436 activities_.remove(waiting_synchro_);
437 waiting_synchro_ = nullptr;
441 void ActorImpl::simcall_answer()
443 if (this != simix_global->maestro_) {
444 XBT_DEBUG("Answer simcall %s issued by %s (%p)", SIMIX_simcall_name(simcall_), get_cname(), this);
445 xbt_assert(simcall_.call_ != simix::Simcall::NONE);
446 simcall_.call_ = simix::Simcall::NONE;
447 xbt_assert(not XBT_LOG_ISENABLED(simix_process, xbt_log_priority_debug) ||
448 std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
449 end(simix_global->actors_to_run),
450 "Actor %p should not exist in actors_to_run!", this);
451 simix_global->actors_to_run.push_back(this);
455 void ActorImpl::set_host(s4u::Host* dest)
457 host_->get_impl()->remove_actor(this);
459 dest->get_impl()->add_actor(this);
462 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host) const
464 auto* actor = new ActorImpl(xbt::string(name), host);
465 actor->set_ppid(this->pid_);
467 intrusive_ptr_add_ref(actor);
468 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
469 s4u::Actor::on_creation(*actor->get_ciface());
471 return ActorImplPtr(actor);
474 ActorImpl* ActorImpl::start(const ActorCode& code)
476 xbt_assert(code && host_ != nullptr, "Invalid parameters");
478 if (not host_->is_on()) {
479 XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
480 intrusive_ptr_release(this);
481 throw HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
485 XBT_VERB("Create context %s", get_cname());
486 context_.reset(simix_global->context_factory->create_context(ActorCode(code), this));
488 XBT_DEBUG("Start context '%s'", get_cname());
490 /* Add the actor to its host's actor list */
491 host_->get_impl()->add_actor(this);
492 simix_global->process_list[pid_] = this;
494 /* Now insert it in the global actor list and in the actor to run list */
495 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
496 simix_global->actors_to_run.push_back(this);
501 ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
502 const ActorImpl* parent_actor)
504 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
507 if (parent_actor != nullptr)
508 actor = parent_actor->init(xbt::string(name), host);
510 actor = self()->init(xbt::string(name), host);
513 actor->set_user_data(data);
520 void create_maestro(const std::function<void()>& code)
522 /* Create maestro actor and initialize it */
523 auto* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
526 maestro->context_.reset(simix_global->context_factory->create_context(ActorCode(), maestro));
528 maestro->context_.reset(simix_global->context_factory->create_maestro(ActorCode(code), maestro));
531 maestro->simcall_.issuer_ = maestro;
532 simix_global->maestro_ = maestro;
536 } // namespace kernel
537 } // namespace simgrid
539 int SIMIX_process_count() // XBT_ATTRIB_DEPRECATED_v329
541 return simix_global->process_list.size();
544 void* SIMIX_process_self_get_data() // XBT_ATTRIB_DEPRECATED_v329
546 smx_actor_t self = simgrid::kernel::actor::ActorImpl::self();
548 if (self == nullptr) {
551 return self->get_user_data();
554 void SIMIX_process_self_set_data(void* data) // XBT_ATTRIB_DEPRECATED_v329
556 simgrid::kernel::actor::ActorImpl::self()->set_user_data(data);
559 /* needs to be public and without simcall because it is called
560 by exceptions and logging events */
561 const char* SIMIX_process_self_get_name()
563 return SIMIX_is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
566 /** @brief Returns the process from PID. */
567 smx_actor_t SIMIX_process_from_PID(aid_t pid)
569 return simgrid::kernel::actor::ActorImpl::by_pid(pid);
572 void SIMIX_process_on_exit(smx_actor_t actor,
573 const std::function<void(bool /*failed*/)>& fun) // XBT_ATTRIB_DEPRECATED_v329
575 xbt_assert(actor, "current process not found: are you in maestro context ?");
576 actor->on_exit->emplace_back(fun);
579 void simcall_process_set_data(smx_actor_t process, void* data) // XBT_ATTRIB_DEPRECATED_v329
581 simgrid::kernel::actor::simcall([process, data] { process->set_user_data(data); });