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>
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
25 static unsigned long simix_process_maxpid = 0;
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 simgrid::kernel::context::Context* self_context = simgrid::kernel::context::Context::self();
38 return (self_context != nullptr) ? self_context->get_actor() : nullptr;
42 * @brief Returns whether a process has pending asynchronous communications.
43 * @return true if there are asynchronous communications in this process
46 int SIMIX_process_has_pending_comms(smx_actor_t process)
49 return process->comms.size() > 0;
56 ActorImpl::ActorImpl(const simgrid::xbt::string& name, s4u::Host* host) : host_(host), name_(name), piface_(this)
58 pid_ = simix_process_maxpid++;
59 simcall.issuer = this;
62 ActorImpl::~ActorImpl() = default;
64 /* Become an actor in the simulation
66 * Currently this can only be called by the main thread (once) and only work with some thread factories
67 * (currently ThreadContextFactory).
69 * In the future, it might be extended in order to attach other threads created by a third party library.
72 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host,
73 const std::unordered_map<std::string, std::string>* properties)
75 // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
77 XBT_DEBUG("Attach process %s on host '%s'", name.c_str(), host->get_cname());
79 if (not host->is_on()) {
80 XBT_WARN("Cannot launch process '%s' on failed host '%s'", name.c_str(), host->get_cname());
81 std::rethrow_exception(
82 std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.")));
85 ActorImpl* actor = new ActorImpl(xbt::string(name), host);
87 actor->set_user_data(data);
88 actor->code = nullptr;
90 XBT_VERB("Create context %s", actor->get_cname());
91 xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
92 actor->context_.reset(simix_global->context_factory->attach(actor));
95 if (properties != nullptr)
96 actor->set_properties(*properties);
98 /* Add the process to it's host process list */
99 host->pimpl_->process_list_.push_back(*actor);
101 /* Now insert it in the global process list and in the process to run list */
102 simix_global->process_list[actor->get_pid()] = actor;
103 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
104 simix_global->actors_to_run.push_back(actor);
105 intrusive_ptr_add_ref(actor);
107 auto* context = dynamic_cast<simgrid::kernel::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 simgrid::s4u::Actor::on_creation(*actor->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 if (context == nullptr)
126 xbt_die("Not a suitable context");
128 context->get_actor()->cleanup();
129 context->attach_stop();
132 void ActorImpl::cleanup()
136 if (has_to_auto_restart() && not get_host()->is_on()) {
137 XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", get_host()->get_cname(),
139 watched_hosts.insert(get_host()->get_name());
142 // Execute the termination callbacks
143 bool failed = context_->iwannadie;
144 for (auto exit_fun = on_exit->crbegin(); exit_fun != on_exit->crend(); ++exit_fun)
146 if (not has_to_auto_restart())
149 /* cancel non-blocking activities */
150 for (auto activity : comms)
151 boost::static_pointer_cast<activity::CommImpl>(activity)->cancel();
154 XBT_DEBUG("%s@%s(%ld) should not run anymore", get_cname(), get_host()->get_cname(), get_pid());
156 if (this == simix_global->maestro_process) /* Do not cleanup maestro */
159 XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro.get());
161 /* Unregister from the kill timer if any */
162 if (kill_timer != nullptr) {
163 kill_timer->remove();
164 kill_timer = nullptr;
167 simix_global->mutex.lock();
169 simix_global->process_list.erase(pid_);
170 if (host_ && host_process_list_hook.is_linked())
171 simgrid::xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
172 if (not smx_destroy_list_hook.is_linked()) {
174 xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
176 simix_global->actors_to_destroy.push_back(*this);
179 simix_global->mutex.unlock();
181 context_->iwannadie = false; // don't let the simcall's yield() do a Context::stop(), to avoid infinite loops
182 simgrid::simix::simcall([this] { simgrid::s4u::Actor::on_destruction(*ciface()); });
183 context_->iwannadie = true;
186 void ActorImpl::exit()
188 context_->iwannadie = true;
191 exception_ = nullptr;
193 // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
194 if (not host_->is_on())
195 this->throw_exception(std::make_exception_ptr(ForcefulKillException("host failed")));
197 /* destroy the blocking synchro if any */
198 if (waiting_synchro != nullptr) {
199 waiting_synchro->cancel();
200 waiting_synchro->state_ = SIMIX_FAILED;
202 activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
203 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
205 if (exec != nullptr) {
206 exec->clean_action();
207 } else if (comm != nullptr) {
208 comms.remove(waiting_synchro);
209 // Remove first occurrence of &actor->simcall:
210 auto i = boost::range::find(waiting_synchro->simcalls_, &simcall);
211 if (i != waiting_synchro->simcalls_.end())
212 waiting_synchro->simcalls_.remove(&simcall);
214 activity::ActivityImplPtr(waiting_synchro)->finish();
217 waiting_synchro = nullptr;
221 void ActorImpl::kill(ActorImpl* actor)
223 if (actor->finished_) {
224 XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
225 actor->host_->get_cname());
229 XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
230 actor->host_ ? actor->host_->get_cname() : "");
234 if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
235 end(simix_global->actors_to_run) &&
237 XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
238 simix_global->actors_to_run.push_back(actor);
242 void ActorImpl::kill_all()
244 for (auto const& kv : simix_global->process_list)
245 if (kv.second != this)
246 this->kill(kv.second);
249 void ActorImpl::set_kill_time(double kill_time)
251 if (kill_time <= SIMIX_get_clock())
253 XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
254 kill_timer = simix::Timer::set(kill_time, [this] {
256 kill_timer = nullptr;
260 double ActorImpl::get_kill_time()
262 return kill_timer ? kill_timer->get_date() : 0;
265 void ActorImpl::yield()
267 XBT_DEBUG("Yield actor '%s'", get_cname());
269 /* Go into sleep and return control to maestro */
272 /* Ok, maestro returned control to us */
273 XBT_DEBUG("Control returned to me: '%s'", get_cname());
275 if (context_->iwannadie) {
276 XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
277 // throw simgrid::kernel::context::ForcefulKillException(); Does not seem to properly kill the actor
283 XBT_DEBUG("Hey! I'm suspended.");
285 xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
290 if (exception_ != nullptr) {
291 XBT_DEBUG("Wait, maestro left me an exception");
292 std::exception_ptr exception = std::move(exception_);
293 exception_ = nullptr;
294 std::rethrow_exception(std::move(exception));
297 if (SMPI_switch_data_segment && not finished_) {
298 SMPI_switch_data_segment(iface());
302 /** This actor will be terminated automatically when the last non-daemon actor finishes */
303 void ActorImpl::daemonize()
307 simix_global->daemons.push_back(this);
308 SIMIX_process_on_exit(this, [this](bool) {
309 auto& vect = simix_global->daemons;
310 auto it = std::find(vect.begin(), vect.end(), this);
311 xbt_assert(it != vect.end(), "The dying daemon is not a daemon after all. Please report that bug.");
313 /* Don't move the whole content since we don't really care about the order */
314 std::swap(*it, vect.back());
320 s4u::Actor* ActorImpl::restart()
322 xbt_assert(this != simix_global->maestro_process, "Restarting maestro is not supported");
324 XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
326 // retrieve the arguments of the old actor
327 ProcessArg arg = ProcessArg(host_, this);
329 // kill the old actor
330 context::Context::self()->get_actor()->kill(this);
332 // start the new actor
334 ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
335 *actor->on_exit = std::move(*arg.on_exit);
336 actor->set_kill_time(arg.kill_time);
337 actor->set_auto_restart(arg.auto_restart);
339 return actor->ciface();
342 activity::ActivityImplPtr ActorImpl::suspend(ActorImpl* issuer)
345 XBT_DEBUG("Actor '%s' is already suspended", get_cname());
351 /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
352 if (this != issuer) {
354 waiting_synchro->suspend();
355 /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
359 activity::ExecImpl* exec = new activity::ExecImpl();
360 (*exec).set_name("suspend").set_host(host_).set_flops_amount(0.0).start();
361 return activity::ExecImplPtr(exec);
365 void ActorImpl::resume()
367 XBT_IN("actor = %p", this);
369 if (context_->iwannadie) {
370 XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
378 /* resume the synchronization that was blocking the resumed actor. */
380 waiting_synchro->resume();
385 activity::ActivityImplPtr ActorImpl::join(ActorImpl* actor, double timeout)
387 activity::ActivityImplPtr sleep = this->sleep(timeout);
388 SIMIX_process_on_exit(actor, [sleep](bool) {
389 if (sleep->surf_action_)
390 sleep->surf_action_->finish(resource::Action::State::FINISHED);
395 activity::ActivityImplPtr ActorImpl::sleep(double duration)
397 if (not host_->is_on())
398 throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
399 XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
401 activity::SleepImpl* sleep = new activity::SleepImpl();
402 (*sleep).set_name("sleep").set_host(host_).set_duration(duration).start();
403 return activity::SleepImplPtr(sleep);
406 void ActorImpl::throw_exception(std::exception_ptr e)
413 /* cancel the blocking synchro if any */
414 if (waiting_synchro) {
415 waiting_synchro->cancel();
417 activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
422 waiting_synchro = nullptr;
426 void ActorImpl::set_host(s4u::Host* dest)
428 xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
430 dest->pimpl_->process_list_.push_back(*this);
433 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
435 ActorImpl* actor = new ActorImpl(xbt::string(name), host);
436 actor->set_ppid(this->pid_);
438 intrusive_ptr_add_ref(actor);
439 /* The on_creation() signal must be delayed until there, where the pid and everything is set */
440 s4u::Actor::on_creation(*actor->ciface());
442 return ActorImplPtr(actor);
445 ActorImpl* ActorImpl::start(const simix::ActorCode& code)
447 xbt_assert(code && host_ != nullptr, "Invalid parameters");
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 std::rethrow_exception(
453 std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.")));
457 XBT_VERB("Create context %s", get_cname());
458 context_.reset(simix_global->context_factory->create_context(simix::ActorCode(code), this));
460 XBT_DEBUG("Start context '%s'", get_cname());
462 /* Add the actor to its host's actor list */
463 host_->pimpl_->process_list_.push_back(*this);
464 simix_global->process_list[pid_] = this;
466 /* Now insert it in the global actor list and in the actor to run list */
467 XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
468 simix_global->actors_to_run.push_back(this);
473 ActorImplPtr ActorImpl::create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host,
474 const std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
476 XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
479 if (parent_actor != nullptr)
480 actor = parent_actor->init(xbt::string(name), host);
482 actor = SIMIX_process_self()->init(xbt::string(name), host);
485 actor->set_user_data(data);
488 if (properties != nullptr)
489 actor->set_properties(*properties);
496 void create_maestro(const std::function<void()>& code)
498 /* Create maestro actor and initialize it */
499 ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
502 maestro->context_.reset(simix_global->context_factory->create_context(simix::ActorCode(), maestro));
504 maestro->context_.reset(simix_global->context_factory->create_maestro(simix::ActorCode(code), maestro));
507 maestro->simcall.issuer = maestro;
508 simix_global->maestro_process = maestro;
512 } // namespace kernel
513 } // namespace simgrid
515 void SIMIX_process_detach()
517 simgrid::kernel::actor::ActorImpl::detach();
520 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
521 std::unordered_map<std::string, std::string>* properties,
522 smx_actor_t /*parent_process*/)
524 return simgrid::kernel::actor::ActorImpl::attach(name, data, sg_host_by_name(hostname), properties).get();
527 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
529 void SIMIX_process_throw(smx_actor_t actor, xbt_errcat_t cat, int value, const char* msg)
531 xbt_ex e(XBT_THROW_POINT, msg);
534 actor->throw_exception(std::make_exception_ptr(e));
537 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t actor)
539 smx_activity_t sync_suspend = actor->suspend(simcall->issuer);
541 if (actor != simcall->issuer) {
542 SIMIX_simcall_answer(simcall);
544 sync_suspend->simcalls_.push_back(simcall);
545 actor->waiting_synchro = sync_suspend;
546 actor->waiting_synchro->suspend();
548 /* If we are suspending ourselves, then just do not finish the simcall now */
551 int SIMIX_process_get_maxpid()
553 return simix_process_maxpid;
556 int SIMIX_process_count()
558 return simix_global->process_list.size();
561 void* SIMIX_process_self_get_data() // deprecated
563 smx_actor_t self = SIMIX_process_self();
565 if (self == nullptr) {
568 return self->get_user_data();
571 void SIMIX_process_self_set_data(void* data) // deprecated
573 SIMIX_process_self()->set_user_data(data);
576 /* needs to be public and without simcall because it is called
577 by exceptions and logging events */
578 const char* SIMIX_process_self_get_name()
581 smx_actor_t process = SIMIX_process_self();
582 if (process == nullptr || process == simix_global->maestro_process)
585 return process->get_cname();
588 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
590 if (process->finished_) {
591 // The joined process is already finished, just wake up the issuer process right away
592 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
593 SIMIX_simcall_answer(simcall);
596 smx_activity_t sync = simcall->issuer->join(process, timeout);
597 sync->simcalls_.push_back(simcall);
598 simcall->issuer->waiting_synchro = sync;
601 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
603 if (MC_is_active() || MC_record_replay_is_active()) {
604 MC_process_clock_add(simcall->issuer, duration);
605 simcall_process_sleep__set__result(simcall, SIMIX_DONE);
606 SIMIX_simcall_answer(simcall);
609 smx_activity_t sync = simcall->issuer->sleep(duration);
610 sync->simcalls_.push_back(simcall);
611 simcall->issuer->waiting_synchro = sync;
615 * @brief Calling this function makes the process to yield.
617 * Only the current process can call this function, giving back the control to maestro.
619 * @param self the current process
622 /** @brief Returns the list of processes to run.
625 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
627 return simix_global->actors_to_run;
630 /** @brief Returns the process from PID. */
631 smx_actor_t SIMIX_process_from_PID(aid_t PID)
633 auto actor = simix_global->process_list.find(PID);
634 return actor == simix_global->process_list.end() ? nullptr : actor->second;
637 void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* data)
639 SIMIX_process_on_exit(actor, [fun, data](bool failed) {
640 intptr_t status = failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
641 fun(reinterpret_cast<void*>(status), data);
645 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(int, void*)>& fun, void* data)
647 SIMIX_process_on_exit(actor, [fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); });
650 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool /*failed*/)>& fun)
652 xbt_assert(actor, "current process not found: are you in maestro context ?");
653 actor->on_exit->emplace_back(fun);
656 /** @brief Restart a process, starting it again from the beginning. */
658 * @ingroup simix_process_management
659 * @brief Creates and runs a new SIMIX process.
661 * The structure and the corresponding thread are created and put in the list of ready processes.
663 * @param name a name for the process. It is for user-level information and can be nullptr.
664 * @param code the main function of the process
665 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
667 * It can be retrieved with the method ActorImpl::getUserData().
668 * @param host where the new agent is executed.
669 * @param properties the properties of the process
671 smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code, void* data,
672 sg_host_t host, std::unordered_map<std::string, std::string>* properties)
674 smx_actor_t self = SIMIX_process_self();
675 return simgrid::simix::simcall([&name, &code, data, host, properties, self] {
676 return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
680 void simcall_process_set_data(smx_actor_t process, void* data)
682 simgrid::simix::simcall([process, data] { process->set_user_data(data); });