1 /* Copyright (c) 2007-2020. 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/range/algorithm.hpp>
24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
27 * @brief Returns the current agent.
29 * This functions returns the currently running SIMIX process.
31 * @return The SIMIX process
33 smx_actor_t SIMIX_process_self()
35 return simgrid::kernel::actor::ActorImpl::self();
42 static unsigned long maxpid = 0;
48 ActorImpl* ActorImpl::self()
50 const context::Context* self_context = context::Context::self();
52 return (self_context != nullptr) ? self_context->get_actor() : nullptr;
55 ActorImpl::ActorImpl(xbt::string name, s4u::Host* host) : host_(host), name_(std::move(name)), piface_(this)
58 simcall.issuer_ = this;
59 stacksize_ = smx_context_stack_size;
62 ActorImpl::~ActorImpl()
64 if (simix_global != nullptr && this != simix_global->maestro_)
65 s4u::Actor::on_destruction(*ciface());
68 /* Become an actor in the simulation
70 * Currently this can only be called by the main thread (once) and only work with some thread factories
71 * (currently ThreadContextFactory).
73 * In the future, it might be extended in order to attach other threads created by a third party library.
76 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host,
77 const std::unordered_map<std::string, std::string>* properties)
79 // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
81 XBT_DEBUG("Attach actor %s on host '%s'", name.c_str(), host->get_cname());
83 if (not host->is_on()) {
84 XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
85 throw HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
88 ActorImpl* actor = new ActorImpl(xbt::string(name), host);
90 actor->set_user_data(data);
91 actor->code_ = nullptr;
93 XBT_VERB("Create context %s", actor->get_cname());
94 xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
95 actor->context_.reset(simix_global->context_factory->attach(actor));
98 if (properties != nullptr)
99 actor->set_properties(*properties);
101 /* Add the actor to it's host actor list */
102 host->pimpl_->add_actor(actor);
104 /* Now insert it in the global actor list and in the actors to run list */
105 simix_global->process_list[actor->get_pid()] = actor;
106 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
107 simix_global->actors_to_run.push_back(actor);
108 intrusive_ptr_add_ref(actor);
110 auto* context = dynamic_cast<context::AttachContext*>(actor->context_.get());
111 xbt_assert(nullptr != context, "Not a suitable context");
112 context->attach_start();
114 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
115 s4u::Actor::on_creation(*actor->ciface());
117 return ActorImplPtr(actor);
119 /** @brief Detach an actor attached with `attach()`
121 * This is called when the current actor has finished its job.
122 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
123 * simulated actors and the maestro are destroyed.
125 void ActorImpl::detach()
127 auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
128 if (context == nullptr)
129 xbt_die("Not a suitable context");
131 context->get_actor()->cleanup();
132 context->attach_stop();
135 void ActorImpl::cleanup_from_simix()
137 const std::lock_guard<std::mutex> lock(simix_global->mutex);
138 simix_global->process_list.erase(pid_);
139 if (host_ && host_actor_list_hook.is_linked())
140 host_->pimpl_->remove_actor(this);
141 if (not smx_destroy_list_hook.is_linked()) {
143 xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
145 simix_global->actors_to_destroy.push_back(*this);
149 void ActorImpl::cleanup()
153 if (has_to_auto_restart() && not get_host()->is_on()) {
154 XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
156 watched_hosts.insert(get_host()->get_name());
160 // Execute the termination callbacks
161 bool failed = context_->wannadie();
162 for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
168 /* cancel non-blocking activities */
169 for (auto activity : activities)
173 XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
175 if (this == simix_global->maestro_) /* Do not cleanup maestro */
178 XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro.get());
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 cleanup_from_simix();
192 context_->set_wannadie(false); // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
193 actor::simcall([this] { s4u::Actor::on_termination(*ciface()); });
194 context_->set_wannadie();
197 void ActorImpl::exit()
199 context_->set_wannadie();
201 exception_ = nullptr;
203 /* destroy the blocking synchro if any */
204 if (waiting_synchro != nullptr) {
205 waiting_synchro->cancel();
206 waiting_synchro->state_ = activity::State::FAILED;
208 activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
209 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
211 if (exec != nullptr) {
212 exec->clean_action();
213 } else if (comm != nullptr) {
214 // Remove first occurrence of &actor->simcall:
215 auto i = boost::range::find(waiting_synchro->simcalls_, &simcall);
216 if (i != waiting_synchro->simcalls_.end())
217 waiting_synchro->simcalls_.remove(&simcall);
219 activity::ActivityImplPtr(waiting_synchro)->finish();
222 activities.remove(waiting_synchro);
223 waiting_synchro = nullptr;
226 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
227 this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
230 void ActorImpl::kill(ActorImpl* actor)
232 xbt_assert(actor != simix_global->maestro_, "Killing maestro is a rather bad idea");
233 if (actor->finished_) {
234 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
235 actor->host_->get_cname());
239 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
240 actor->host_ ? actor->host_->get_cname() : "");
245 XBT_DEBUG("Go on, this is a suicide,");
246 } else if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) !=
247 end(simix_global->actors_to_run)) {
248 XBT_DEBUG("Actor %s is already in the to_run list", actor->get_cname());
250 XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
251 simix_global->actors_to_run.push_back(actor);
255 void ActorImpl::kill_all()
257 for (auto const& kv : simix_global->process_list)
258 if (kv.second != this)
259 this->kill(kv.second);
262 void ActorImpl::set_kill_time(double kill_time)
264 if (kill_time <= SIMIX_get_clock())
266 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
267 kill_timer = simix::Timer::set(kill_time, [this] {
269 kill_timer = nullptr;
273 double ActorImpl::get_kill_time()
275 return kill_timer ? kill_timer->get_date() : 0;
278 void ActorImpl::yield()
280 XBT_DEBUG("Yield actor '%s'", get_cname());
282 /* Go into sleep and return control to maestro */
285 /* Ok, maestro returned control to us */
286 XBT_DEBUG("Control returned to me: '%s'", get_cname());
288 if (context_->wannadie()) {
289 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
295 XBT_DEBUG("Hey! I'm suspended.");
297 xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
300 yield(); // Yield back to maestro without proceeding with my execution. I'll get resumed at some point
303 if (exception_ != nullptr) {
304 XBT_DEBUG("Wait, maestro left me an exception");
305 std::exception_ptr exception = std::move(exception_);
306 exception_ = nullptr;
307 std::rethrow_exception(std::move(exception));
310 if (SMPI_switch_data_segment && not finished_) {
311 SMPI_switch_data_segment(iface());
315 /** This actor will be terminated automatically when the last non-daemon actor finishes */
316 void ActorImpl::daemonize()
320 simix_global->daemons.push_back(this);
324 void ActorImpl::undaemonize()
327 auto& vect = simix_global->daemons;
328 auto it = std::find(vect.begin(), vect.end(), this);
329 xbt_assert(it != vect.end(), "The dying daemon is not a daemon after all. Please report that bug.");
330 /* Don't move the whole content since we don't really care about the order */
332 std::swap(*it, vect.back());
338 s4u::Actor* ActorImpl::restart()
340 xbt_assert(this != simix_global->maestro_, "Restarting maestro is not supported");
342 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
344 // retrieve the arguments of the old actor
345 ProcessArg arg = ProcessArg(host_, this);
347 // kill the old actor
348 context::Context::self()->get_actor()->kill(this);
350 // start the new actor
352 ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
353 *actor->on_exit = std::move(*arg.on_exit);
354 actor->set_kill_time(arg.kill_time);
355 actor->set_auto_restart(arg.auto_restart);
357 return actor->ciface();
360 void ActorImpl::suspend()
363 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
369 /* If the suspended actor is waiting on a sync, suspend its synchronization. */
370 if (waiting_synchro == nullptr) {
371 auto exec = new activity::ExecImpl();
372 exec->set_name("suspend").set_host(host_).set_flops_amount(0.0).start();
373 waiting_synchro = activity::ExecImplPtr(exec);
375 waiting_synchro->simcalls_.push_back(&simcall);
377 waiting_synchro->suspend();
380 void ActorImpl::resume()
382 XBT_IN("actor = %p", this);
384 if (context_->wannadie()) {
385 XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
393 /* resume the synchronization that was blocking the resumed actor. */
395 waiting_synchro->resume();
400 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
402 activity::ActivityImplPtr sleep = this->sleep(timeout);
403 actor->on_exit->emplace_back([sleep](bool) {
404 if (sleep->surf_action_)
405 sleep->surf_action_->finish(resource::Action::State::FINISHED);
410 activity::ActivityImplPtr ActorImpl::sleep(double duration)
412 if (not host_->is_on())
413 throw_exception(std::make_exception_ptr(HostFailureException(
414 XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
416 auto sleep = new activity::SleepImpl();
417 sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
418 return activity::SleepImplPtr(sleep);
421 void ActorImpl::throw_exception(std::exception_ptr e)
428 /* cancel the blocking synchro if any */
429 if (waiting_synchro) {
430 waiting_synchro->cancel();
431 activities.remove(waiting_synchro);
432 waiting_synchro = nullptr;
436 void ActorImpl::simcall_answer()
438 if (this != simix_global->maestro_) {
439 XBT_DEBUG("Answer simcall %s (%d) issued by %s (%p)", SIMIX_simcall_name(simcall.call_), (int)simcall.call_,
441 xbt_assert(simcall.call_ != SIMCALL_NONE);
442 simcall.call_ = SIMCALL_NONE;
443 xbt_assert(not XBT_LOG_ISENABLED(simix_process, xbt_log_priority_debug) ||
444 std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
445 end(simix_global->actors_to_run),
446 "Actor %p should not exist in actors_to_run!", this);
447 simix_global->actors_to_run.push_back(this);
451 void ActorImpl::set_host(s4u::Host* dest)
453 host_->pimpl_->remove_actor(this);
455 dest->pimpl_->add_actor(this);
458 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
460 ActorImpl* actor = new ActorImpl(xbt::string(name), host);
461 actor->set_ppid(this->pid_);
463 intrusive_ptr_add_ref(actor);
464 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
465 s4u::Actor::on_creation(*actor->ciface());
467 return ActorImplPtr(actor);
470 ActorImpl* ActorImpl::start(const ActorCode& code)
472 xbt_assert(code && host_ != nullptr, "Invalid parameters");
474 if (not host_->is_on()) {
475 XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
476 intrusive_ptr_release(this);
477 throw HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
481 XBT_VERB("Create context %s", get_cname());
482 context_.reset(simix_global->context_factory->create_context(ActorCode(code), this));
484 XBT_DEBUG("Start context '%s'", get_cname());
486 /* Add the actor to its host's actor list */
487 host_->pimpl_->add_actor(this);
488 simix_global->process_list[pid_] = this;
490 /* Now insert it in the global actor list and in the actor to run list */
491 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
492 simix_global->actors_to_run.push_back(this);
497 ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
498 const std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
500 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
503 if (parent_actor != nullptr)
504 actor = parent_actor->init(xbt::string(name), host);
506 actor = self()->init(xbt::string(name), host);
509 actor->set_user_data(data);
512 if (properties != nullptr)
513 actor->set_properties(*properties);
520 void create_maestro(const std::function<void()>& code)
522 /* Create maestro actor and initialize it */
523 ActorImpl* 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 // XBT_DEPRECATED_v329
545 void* SIMIX_process_self_get_data()
547 smx_actor_t self = simgrid::kernel::actor::ActorImpl::self();
549 if (self == nullptr) {
552 return self->get_user_data();
555 // XBT_DEPRECATED_v329
556 void SIMIX_process_self_set_data(void* data)
558 simgrid::kernel::actor::ActorImpl::self()->set_user_data(data);
561 /* needs to be public and without simcall because it is called
562 by exceptions and logging events */
563 const char* SIMIX_process_self_get_name()
565 return SIMIX_is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
569 * @brief Calling this function makes the process to yield.
571 * Only the current process can call this function, giving back the control to maestro.
573 * @param self the current process
576 /** @brief Returns the process from PID. */
577 smx_actor_t SIMIX_process_from_PID(aid_t PID)
579 auto item = simix_global->process_list.find(PID);
580 if (item == simix_global->process_list.end()) {
581 for (auto& a : simix_global->actors_to_destroy)
582 if (a.get_pid() == PID)
584 return nullptr; // Not found, even in the trash
589 void SIMIX_process_on_exit(smx_actor_t actor,
590 const std::function<void(bool /*failed*/)>& fun) // XBT_ATTRIB_DEPRECATED_v329
592 xbt_assert(actor, "current process not found: are you in maestro context ?");
593 actor->on_exit->emplace_back(fun);
596 /** @brief Restart a process, starting it again from the beginning. */
598 * @ingroup simix_process_management
599 * @brief Creates and runs a new SIMIX process.
601 * The structure and the corresponding thread are created and put in the list of ready processes.
603 * @param name a name for the process. It is for user-level information and can be nullptr.
604 * @param code the main function of the process
605 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
607 * It can be retrieved with the method ActorImpl::getUserData().
608 * @param host where the new agent is executed.
609 * @param properties the properties of the process
611 smx_actor_t simcall_process_create(const std::string& name, const simgrid::kernel::actor::ActorCode& code, void* data,
612 sg_host_t host, std::unordered_map<std::string, std::string>* properties)
614 smx_actor_t self = simgrid::kernel::actor::ActorImpl::self();
615 return simgrid::kernel::actor::simcall([&name, &code, data, host, properties, self] {
616 return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
620 void simcall_process_set_data(smx_actor_t process, void* data) // XBT_ATTRIB_DEPRECATED_v329
622 simgrid::kernel::actor::simcall([process, data] { process->set_user_data(data); });