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/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 return simgrid::kernel::actor::ActorImpl::self();
42 static unsigned long maxpid = 0;
48 ActorImpl* ActorImpl::self()
50 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;
61 ActorImpl::~ActorImpl()
63 if (simix_global != nullptr && this != simix_global->maestro_)
64 s4u::Actor::on_destruction(*ciface());
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 actor %s on host '%s'", name.c_str(), host->get_cname());
82 if (not host->is_on()) {
83 XBT_WARN("Cannot attach actor '%s' on failed host '%s'", name.c_str(), host->get_cname());
84 throw 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 actor to it's host actor list */
101 host->pimpl_->add_actor(actor);
103 /* Now insert it in the global actor list and in the actors 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<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 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_from_simix()
136 const std::lock_guard<std::mutex> lock(simix_global->mutex);
137 simix_global->process_list.erase(pid_);
138 if (host_ && host_actor_list_hook.is_linked())
139 host_->pimpl_->remove_actor(this);
140 if (not smx_destroy_list_hook.is_linked()) {
142 xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
144 simix_global->actors_to_destroy.push_back(*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 : comms)
169 boost::static_pointer_cast<activity::CommImpl>(activity)->cancel();
172 XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
174 if (this == simix_global->maestro_) /* 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([this] { s4u::Actor::on_termination(*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 (waiting_synchro != nullptr) {
204 waiting_synchro->cancel();
205 waiting_synchro->state_ = activity::State::FAILED;
207 activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
208 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
210 if (exec != nullptr) {
211 exec->clean_action();
212 } else if (comm != nullptr) {
213 comms.remove(waiting_synchro);
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 waiting_synchro = nullptr;
225 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
226 this->throw_exception(std::make_exception_ptr(ForcefulKillException(host_->is_on() ? "exited" : "host failed")));
229 void ActorImpl::kill(ActorImpl* actor)
231 xbt_assert(actor != simix_global->maestro_, "Killing maestro is a rather bad idea");
232 if (actor->finished_) {
233 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
234 actor->host_->get_cname());
238 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
239 actor->host_ ? actor->host_->get_cname() : "");
244 XBT_DEBUG("Go on, this is a suicide,");
245 } else if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) !=
246 end(simix_global->actors_to_run)) {
247 XBT_DEBUG("Actor %s is already in the to_run list", actor->get_cname());
249 XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
250 simix_global->actors_to_run.push_back(actor);
254 void ActorImpl::kill_all()
256 for (auto const& kv : simix_global->process_list)
257 if (kv.second != this)
258 this->kill(kv.second);
261 void ActorImpl::set_kill_time(double kill_time)
263 if (kill_time <= SIMIX_get_clock())
265 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
266 kill_timer = simix::Timer::set(kill_time, [this] {
268 kill_timer = nullptr;
272 double ActorImpl::get_kill_time()
274 return kill_timer ? kill_timer->get_date() : 0;
277 void ActorImpl::yield()
279 XBT_DEBUG("Yield actor '%s'", get_cname());
281 /* Go into sleep and return control to maestro */
284 /* Ok, maestro returned control to us */
285 XBT_DEBUG("Control returned to me: '%s'", get_cname());
287 if (context_->wannadie()) {
288 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
294 XBT_DEBUG("Hey! I'm suspended.");
296 xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
301 if (exception_ != nullptr) {
302 XBT_DEBUG("Wait, maestro left me an exception");
303 std::exception_ptr exception = std::move(exception_);
304 exception_ = nullptr;
305 std::rethrow_exception(std::move(exception));
308 if (SMPI_switch_data_segment && not finished_) {
309 SMPI_switch_data_segment(iface());
313 /** This actor will be terminated automatically when the last non-daemon actor finishes */
314 void ActorImpl::daemonize()
318 simix_global->daemons.push_back(this);
322 void ActorImpl::undaemonize()
325 auto& vect = simix_global->daemons;
326 auto it = std::find(vect.begin(), vect.end(), this);
327 xbt_assert(it != vect.end(), "The dying daemon is not a daemon after all. Please report that bug.");
328 /* Don't move the whole content since we don't really care about the order */
330 std::swap(*it, vect.back());
336 s4u::Actor* ActorImpl::restart()
338 xbt_assert(this != simix_global->maestro_, "Restarting maestro is not supported");
340 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
342 // retrieve the arguments of the old actor
343 ProcessArg arg = ProcessArg(host_, this);
345 // kill the old actor
346 context::Context::self()->get_actor()->kill(this);
348 // start the new actor
350 ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
351 *actor->on_exit = std::move(*arg.on_exit);
352 actor->set_kill_time(arg.kill_time);
353 actor->set_auto_restart(arg.auto_restart);
355 return actor->ciface();
358 void ActorImpl::suspend()
361 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
367 /* If the suspended actor is waiting on a sync, suspend its synchronization. */
368 if (waiting_synchro == nullptr) {
369 auto exec = new activity::ExecImpl();
370 exec->set_name("suspend").set_host(host_).set_flops_amount(0.0).start();
371 waiting_synchro = activity::ExecImplPtr(exec);
373 waiting_synchro->simcalls_.push_back(&simcall);
375 waiting_synchro->suspend();
378 void ActorImpl::resume()
380 XBT_IN("actor = %p", this);
382 if (context_->wannadie()) {
383 XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
391 /* resume the synchronization that was blocking the resumed actor. */
393 waiting_synchro->resume();
398 activity::ActivityImplPtr ActorImpl::join(const ActorImpl* actor, double timeout)
400 activity::ActivityImplPtr sleep = this->sleep(timeout);
401 actor->on_exit->emplace_back([sleep](bool) {
402 if (sleep->surf_action_)
403 sleep->surf_action_->finish(resource::Action::State::FINISHED);
408 activity::ActivityImplPtr ActorImpl::sleep(double duration)
410 if (not host_->is_on())
411 throw_exception(std::make_exception_ptr(HostFailureException(
412 XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
414 auto sleep = new activity::SleepImpl();
415 sleep->set_name("sleep").set_host(host_).set_duration(duration).start();
416 return activity::SleepImplPtr(sleep);
419 void ActorImpl::throw_exception(std::exception_ptr e)
426 /* cancel the blocking synchro if any */
427 if (waiting_synchro) {
428 waiting_synchro->cancel();
430 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
435 waiting_synchro = nullptr;
439 void ActorImpl::simcall_answer()
441 if (this != simix_global->maestro_) {
442 XBT_DEBUG("Answer simcall %s (%d) issued by %s (%p)", SIMIX_simcall_name(simcall.call_), (int)simcall.call_,
444 xbt_assert(simcall.call_ != SIMCALL_NONE);
445 simcall.call_ = SIMCALL_NONE;
446 xbt_assert(not XBT_LOG_ISENABLED(simix_process, xbt_log_priority_debug) ||
447 std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
448 end(simix_global->actors_to_run),
449 "Actor %p should not exist in actors_to_run!", this);
450 simix_global->actors_to_run.push_back(this);
454 void ActorImpl::set_host(s4u::Host* dest)
456 host_->pimpl_->remove_actor(this);
458 dest->pimpl_->add_actor(this);
461 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
463 ActorImpl* actor = new ActorImpl(xbt::string(name), host);
464 actor->set_ppid(this->pid_);
466 intrusive_ptr_add_ref(actor);
467 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
468 s4u::Actor::on_creation(*actor->ciface());
470 return ActorImplPtr(actor);
473 ActorImpl* ActorImpl::start(const ActorCode& code)
475 xbt_assert(code && host_ != nullptr, "Invalid parameters");
477 if (not host_->is_on()) {
478 XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
479 intrusive_ptr_release(this);
480 throw HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.");
484 XBT_VERB("Create context %s", get_cname());
485 context_.reset(simix_global->context_factory->create_context(ActorCode(code), this));
487 XBT_DEBUG("Start context '%s'", get_cname());
489 /* Add the actor to its host's actor list */
490 host_->pimpl_->add_actor(this);
491 simix_global->process_list[pid_] = this;
493 /* Now insert it in the global actor list and in the actor to run list */
494 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
495 simix_global->actors_to_run.push_back(this);
500 ActorImplPtr ActorImpl::create(const std::string& name, const ActorCode& code, void* data, s4u::Host* host,
501 const std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
503 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
506 if (parent_actor != nullptr)
507 actor = parent_actor->init(xbt::string(name), host);
509 actor = self()->init(xbt::string(name), host);
512 actor->set_user_data(data);
515 if (properties != nullptr)
516 actor->set_properties(*properties);
523 void create_maestro(const std::function<void()>& code)
525 /* Create maestro actor and initialize it */
526 ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
529 maestro->context_.reset(simix_global->context_factory->create_context(ActorCode(), maestro));
531 maestro->context_.reset(simix_global->context_factory->create_maestro(ActorCode(code), maestro));
534 maestro->simcall.issuer_ = maestro;
535 simix_global->maestro_ = maestro;
539 } // namespace kernel
540 } // namespace simgrid
542 int SIMIX_process_count() // XBT_ATTRIB_DEPRECATED_v329
544 return simix_global->process_list.size();
547 // XBT_DEPRECATED_v329
548 void* SIMIX_process_self_get_data()
550 smx_actor_t self = simgrid::kernel::actor::ActorImpl::self();
552 if (self == nullptr) {
555 return self->get_user_data();
558 // XBT_DEPRECATED_v329
559 void SIMIX_process_self_set_data(void* data)
561 simgrid::kernel::actor::ActorImpl::self()->set_user_data(data);
564 /* needs to be public and without simcall because it is called
565 by exceptions and logging events */
566 const char* SIMIX_process_self_get_name()
568 return SIMIX_is_maestro() ? "maestro" : simgrid::kernel::actor::ActorImpl::self()->get_cname();
572 * @brief Calling this function makes the process to yield.
574 * Only the current process can call this function, giving back the control to maestro.
576 * @param self the current process
579 /** @brief Returns the process from PID. */
580 smx_actor_t SIMIX_process_from_PID(aid_t PID)
582 auto item = simix_global->process_list.find(PID);
583 if (item == simix_global->process_list.end()) {
584 for (auto& a : simix_global->actors_to_destroy)
585 if (a.get_pid() == PID)
587 return nullptr; // Not found, even in the trash
592 void SIMIX_process_on_exit(smx_actor_t actor,
593 const std::function<void(bool /*failed*/)>& fun) // XBT_ATTRIB_DEPRECATED_v329
595 xbt_assert(actor, "current process not found: are you in maestro context ?");
596 actor->on_exit->emplace_back(fun);
599 /** @brief Restart a process, starting it again from the beginning. */
601 * @ingroup simix_process_management
602 * @brief Creates and runs a new SIMIX process.
604 * The structure and the corresponding thread are created and put in the list of ready processes.
606 * @param name a name for the process. It is for user-level information and can be nullptr.
607 * @param code the main function of the process
608 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
610 * It can be retrieved with the method ActorImpl::getUserData().
611 * @param host where the new agent is executed.
612 * @param properties the properties of the process
614 smx_actor_t simcall_process_create(const std::string& name, const simgrid::kernel::actor::ActorCode& code, void* data,
615 sg_host_t host, std::unordered_map<std::string, std::string>* properties)
617 smx_actor_t self = simgrid::kernel::actor::ActorImpl::self();
618 return simgrid::kernel::actor::simcall([&name, &code, data, host, properties, self] {
619 return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
623 void simcall_process_set_data(smx_actor_t process, void* data) // XBT_ATTRIB_DEPRECATED_v329
625 simgrid::kernel::actor::simcall([process, data] { process->set_user_data(data); });