1 /* Copyright (c) 2007-2019. 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/Client.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 simgrid::kernel::context::Context* self_context = simgrid::kernel::context::Context::self();
37 return (self_context != nullptr) ? self_context->get_actor() : nullptr;
44 static unsigned long maxpid = 0;
50 ActorImpl::ActorImpl(simgrid::xbt::string name, s4u::Host* host) : host_(host), name_(std::move(name)), piface_(this)
53 simcall.issuer_ = this;
56 ActorImpl::~ActorImpl()
58 if (simix_global != nullptr && this != simix_global->maestro_process) {
59 if (context_.get() != nullptr) /* the actor was not start()ed yet. This happens if its host was initially off */
60 context_->iwannadie = false; // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
61 simgrid::kernel::actor::simcall([this] { simgrid::s4u::Actor::on_destruction(*ciface()); });
62 if (context_.get() != nullptr)
63 context_->iwannadie = true;
67 /* Become an actor in the simulation
69 * Currently this can only be called by the main thread (once) and only work with some thread factories
70 * (currently ThreadContextFactory).
72 * In the future, it might be extended in order to attach other threads created by a third party library.
75 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host,
76 const std::unordered_map<std::string, std::string>* properties)
78 // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
80 XBT_DEBUG("Attach process %s on host '%s'", name.c_str(), host->get_cname());
82 if (not host->is_on()) {
83 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name.c_str(), host->get_cname());
84 throw simgrid::HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.");
87 ActorImpl* actor = new ActorImpl(xbt::string(name), host);
89 actor->set_user_data(data);
90 actor->code_ = nullptr;
92 XBT_VERB("Create context %s", actor->get_cname());
93 xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
94 actor->context_.reset(simix_global->context_factory->attach(actor));
97 if (properties != nullptr)
98 actor->set_properties(*properties);
100 /* Add the process to it's host process list */
101 host->pimpl_->add_actor(actor);
103 /* Now insert it in the global process list and in the process to run list */
104 simix_global->process_list[actor->get_pid()] = actor;
105 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
106 simix_global->actors_to_run.push_back(actor);
107 intrusive_ptr_add_ref(actor);
109 auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_.get());
110 xbt_assert(nullptr != context, "Not a suitable context");
111 context->attach_start();
113 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
114 simgrid::s4u::Actor::on_creation(*actor->ciface());
116 return ActorImplPtr(actor);
118 /** @brief Detach an actor attached with `attach()`
120 * This is called when the current actor has finished its job.
121 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
122 * simulated actors and the maestro are destroyed.
124 void ActorImpl::detach()
126 auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
127 if (context == nullptr)
128 xbt_die("Not a suitable context");
130 context->get_actor()->cleanup();
131 context->attach_stop();
134 void ActorImpl::cleanup()
138 if (has_to_auto_restart() && not get_host()->is_on()) {
139 XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
141 watched_hosts.insert(get_host()->get_name());
145 // Execute the termination callbacks
146 bool failed = context_->iwannadie;
147 for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
153 /* cancel non-blocking activities */
154 for (auto activity : comms)
155 boost::static_pointer_cast<activity::CommImpl>(activity)->cancel();
158 XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
160 if (this == simix_global->maestro_process) /* Do not cleanup maestro */
163 XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro.get());
165 /* Unregister from the kill timer if any */
166 if (kill_timer != nullptr) {
167 kill_timer->remove();
168 kill_timer = nullptr;
171 simix_global->mutex.lock();
173 simix_global->process_list.erase(pid_);
174 if (host_ && host_actor_list_hook.is_linked())
175 host_->pimpl_->remove_actor(this);
176 if (not smx_destroy_list_hook.is_linked()) {
178 xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
180 simix_global->actors_to_destroy.push_back(*this);
183 simix_global->mutex.unlock();
185 context_->iwannadie = false; // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
186 simgrid::kernel::actor::simcall([this] { simgrid::s4u::Actor::on_termination(*ciface()); });
187 context_->iwannadie = true;
190 void ActorImpl::exit()
192 context_->iwannadie = true;
194 exception_ = nullptr;
196 /* destroy the blocking synchro if any */
197 if (waiting_synchro != nullptr) {
198 waiting_synchro->cancel();
199 waiting_synchro->state_ = SIMIX_FAILED;
201 activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
202 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
204 if (exec != nullptr) {
205 exec->clean_action();
206 } else if (comm != nullptr) {
207 comms.remove(waiting_synchro);
208 // Remove first occurrence of &actor->simcall:
209 auto i = boost::range::find(waiting_synchro->simcalls_, &simcall);
210 if (i != waiting_synchro->simcalls_.end())
211 waiting_synchro->simcalls_.remove(&simcall);
213 activity::ActivityImplPtr(waiting_synchro)->finish();
216 waiting_synchro = nullptr;
219 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
220 this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
223 void ActorImpl::kill(ActorImpl* actor)
225 if (actor->finished_) {
226 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
227 actor->host_->get_cname());
231 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
232 actor->host_ ? actor->host_->get_cname() : "");
236 if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
237 end(simix_global->actors_to_run) &&
239 XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
240 simix_global->actors_to_run.push_back(actor);
244 void ActorImpl::kill_all()
246 for (auto const& kv : simix_global->process_list)
247 if (kv.second != this)
248 this->kill(kv.second);
251 void ActorImpl::set_kill_time(double kill_time)
253 if (kill_time <= SIMIX_get_clock())
255 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
256 kill_timer = simix::Timer::set(kill_time, [this] {
258 kill_timer = nullptr;
262 double ActorImpl::get_kill_time()
264 return kill_timer ? kill_timer->get_date() : 0;
267 void ActorImpl::yield()
269 XBT_DEBUG("Yield actor '%s'", get_cname());
271 /* Go into sleep and return control to maestro */
274 /* Ok, maestro returned control to us */
275 XBT_DEBUG("Control returned to me: '%s'", get_cname());
277 if (context_->iwannadie) {
278 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
279 // throw simgrid::kernel::context::ForcefulKillException(); Does not seem to properly kill the actor
285 XBT_DEBUG("Hey! I'm suspended.");
287 xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
292 if (exception_ != nullptr) {
293 XBT_DEBUG("Wait, maestro left me an exception");
294 std::exception_ptr exception = std::move(exception_);
295 exception_ = nullptr;
296 std::rethrow_exception(std::move(exception));
299 if (SMPI_switch_data_segment && not finished_) {
300 SMPI_switch_data_segment(iface());
304 /** This actor will be terminated automatically when the last non-daemon actor finishes */
305 void ActorImpl::daemonize()
309 simix_global->daemons.push_back(this);
313 void ActorImpl::undaemonize()
316 auto& vect = simix_global->daemons;
317 auto it = std::find(vect.begin(), vect.end(), this);
318 xbt_assert(it != vect.end(), "The dying daemon is not a daemon after all. Please report that bug.");
319 /* Don't move the whole content since we don't really care about the order */
321 std::swap(*it, vect.back());
327 s4u::Actor* ActorImpl::restart()
329 xbt_assert(this != simix_global->maestro_process, "Restarting maestro is not supported");
331 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
333 // retrieve the arguments of the old actor
334 ProcessArg arg = ProcessArg(host_, this);
336 // kill the old actor
337 context::Context::self()->get_actor()->kill(this);
339 // start the new actor
341 ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
342 *actor->on_exit = std::move(*arg.on_exit);
343 actor->set_kill_time(arg.kill_time);
344 actor->set_auto_restart(arg.auto_restart);
346 return actor->ciface();
349 void ActorImpl::suspend()
352 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
358 /* If the suspended actor is waiting on a sync, suspend its synchronization. */
359 if (waiting_synchro == nullptr) {
360 auto exec = new activity::ExecImpl();
361 exec->set_name("suspend").set_host(host_).set_flops_amount(0.0).start();
362 waiting_synchro = activity::ExecImplPtr(exec);
364 waiting_synchro->simcalls_.push_back(&simcall);
366 waiting_synchro->suspend();
369 void ActorImpl::resume()
371 XBT_IN("actor = %p", this);
373 if (context_->iwannadie) {
374 XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
382 /* resume the synchronization that was blocking the resumed actor. */
384 waiting_synchro->resume();
389 activity::ActivityImplPtr ActorImpl::join(ActorImpl* actor, double timeout)
391 activity::ActivityImplPtr sleep = this->sleep(timeout);
392 SIMIX_process_on_exit(actor, [sleep](bool) {
393 if (sleep->surf_action_)
394 sleep->surf_action_->finish(resource::Action::State::FINISHED);
399 activity::ActivityImplPtr ActorImpl::sleep(double duration)
401 if (not host_->is_on())
402 throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
403 XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
405 auto sleep = new activity::SleepImpl();
406 sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
407 return activity::SleepImplPtr(sleep);
410 void ActorImpl::throw_exception(std::exception_ptr e)
417 /* cancel the blocking synchro if any */
418 if (waiting_synchro) {
419 waiting_synchro->cancel();
421 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
426 waiting_synchro = nullptr;
430 void ActorImpl::simcall_answer()
432 if (this != simix_global->maestro_process){
433 XBT_DEBUG("Answer simcall %s (%d) issued by %s (%p)", SIMIX_simcall_name(simcall.call_), (int)simcall.call_,
435 simcall.call_ = SIMCALL_NONE;
436 xbt_assert(not XBT_LOG_ISENABLED(simix_process, xbt_log_priority_debug) ||
437 std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
438 end(simix_global->actors_to_run),
439 "Actor %p should not exist in actors_to_run!", this);
440 simix_global->actors_to_run.push_back(this);
444 void ActorImpl::set_host(s4u::Host* dest)
446 host_->pimpl_->remove_actor(this);
448 dest->pimpl_->add_actor(this);
451 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
453 ActorImpl* actor = new ActorImpl(xbt::string(name), host);
454 actor->set_ppid(this->pid_);
456 intrusive_ptr_add_ref(actor);
457 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
458 s4u::Actor::on_creation(*actor->ciface());
460 return ActorImplPtr(actor);
463 ActorImpl* ActorImpl::start(const simix::ActorCode& code)
465 xbt_assert(code && host_ != nullptr, "Invalid parameters");
467 if (not host_->is_on()) {
468 XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
469 intrusive_ptr_release(this);
470 throw simgrid::HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
474 XBT_VERB("Create context %s", get_cname());
475 context_.reset(simix_global->context_factory->create_context(simix::ActorCode(code), this));
477 XBT_DEBUG("Start context '%s'", get_cname());
479 /* Add the actor to its host's actor list */
480 host_->pimpl_->add_actor(this);
481 simix_global->process_list[pid_] = this;
483 /* Now insert it in the global actor list and in the actor to run list */
484 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
485 simix_global->actors_to_run.push_back(this);
490 ActorImplPtr ActorImpl::create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host,
491 const std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
493 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
496 if (parent_actor != nullptr)
497 actor = parent_actor->init(xbt::string(name), host);
499 actor = SIMIX_process_self()->init(xbt::string(name), host);
502 actor->set_user_data(data);
505 if (properties != nullptr)
506 actor->set_properties(*properties);
513 void create_maestro(const std::function<void()>& code)
515 /* Create maestro actor and initialize it */
516 ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
519 maestro->context_.reset(simix_global->context_factory->create_context(simix::ActorCode(), maestro));
521 maestro->context_.reset(simix_global->context_factory->create_maestro(simix::ActorCode(code), maestro));
524 maestro->simcall.issuer_ = maestro;
525 simix_global->maestro_process = maestro;
529 } // namespace kernel
530 } // namespace simgrid
532 int SIMIX_process_count()
534 return simix_global->process_list.size();
537 void* SIMIX_process_self_get_data()
539 smx_actor_t self = SIMIX_process_self();
541 if (self == nullptr) {
544 return self->get_user_data();
547 void SIMIX_process_self_set_data(void* data)
549 SIMIX_process_self()->set_user_data(data);
552 /* needs to be public and without simcall because it is called
553 by exceptions and logging events */
554 const char* SIMIX_process_self_get_name()
557 smx_actor_t process = SIMIX_process_self();
558 if (process == nullptr || process == simix_global->maestro_process)
561 return process->get_cname();
565 * @brief Calling this function makes the process to yield.
567 * Only the current process can call this function, giving back the control to maestro.
569 * @param self the current process
572 /** @brief Returns the process from PID. */
573 smx_actor_t SIMIX_process_from_PID(aid_t PID)
575 auto item = simix_global->process_list.find(PID);
576 if (item == simix_global->process_list.end()) {
577 for (auto& a : simix_global->actors_to_destroy)
578 if (a.get_pid() == PID)
580 return nullptr; // Not found, even in the trash
585 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool /*failed*/)>& fun)
587 xbt_assert(actor, "current process not found: are you in maestro context ?");
588 actor->on_exit->emplace_back(fun);
591 /** @brief Restart a process, starting it again from the beginning. */
593 * @ingroup simix_process_management
594 * @brief Creates and runs a new SIMIX process.
596 * The structure and the corresponding thread are created and put in the list of ready processes.
598 * @param name a name for the process. It is for user-level information and can be nullptr.
599 * @param code the main function of the process
600 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
602 * It can be retrieved with the method ActorImpl::getUserData().
603 * @param host where the new agent is executed.
604 * @param properties the properties of the process
606 smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code, void* data,
607 sg_host_t host, std::unordered_map<std::string, std::string>* properties)
609 smx_actor_t self = SIMIX_process_self();
610 return simgrid::kernel::actor::simcall([&name, &code, data, host, properties, self] {
611 return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
615 void simcall_process_set_data(smx_actor_t process, void* data)
617 simgrid::kernel::actor::simcall([process, data] { process->set_user_data(data); });