1 /* Copyright (c) 2006-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. */
6 #include "simgrid/Exception.hpp"
7 #include "simgrid/actor.h"
8 #include "simgrid/modelchecker.h"
9 #include "simgrid/s4u/Actor.hpp"
10 #include "simgrid/s4u/Exec.hpp"
11 #include "simgrid/s4u/Host.hpp"
12 #include "simgrid/s4u/VirtualMachine.hpp"
13 #include "src/include/mc/mc.h"
14 #include "src/kernel/EngineImpl.hpp"
15 #include "src/kernel/activity/ExecImpl.hpp"
16 #include "src/mc/mc_replay.hpp"
17 #include "src/surf/HostImpl.hpp"
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_actor, s4u, "S4U actors");
26 template class xbt::Extendable<s4u::Actor>;
30 xbt::signal<void(Actor&)> s4u::Actor::on_creation;
31 xbt::signal<void(Actor const&)> s4u::Actor::on_suspend;
32 xbt::signal<void(Actor const&)> s4u::Actor::on_resume;
33 xbt::signal<void(Actor const&)> s4u::Actor::on_sleep;
34 xbt::signal<void(Actor const&)> s4u::Actor::on_wake_up;
35 xbt::signal<void(Actor const&)> s4u::Actor::on_migration_start; // deprecated
36 xbt::signal<void(Actor const&)> s4u::Actor::on_migration_end; // deprecated
37 xbt::signal<void(Actor const&, Host const& previous_location)> s4u::Actor::on_host_change;
38 xbt::signal<void(Actor const&)> s4u::Actor::on_termination;
39 xbt::signal<void(Actor const&)> s4u::Actor::on_destruction;
41 // ***** Actor creation *****
44 kernel::context::Context* self_context = kernel::context::Context::self();
45 if (self_context == nullptr)
48 return self_context->get_actor()->ciface();
51 ActorPtr Actor::init(const std::string& name, s4u::Host* host)
53 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
54 kernel::actor::ActorImpl* actor =
55 kernel::actor::simcall([self, &name, host] { return self->init(name, host).get(); });
56 return actor->iface();
59 ActorPtr Actor::start(const std::function<void()>& code)
61 simgrid::kernel::actor::simcall([this, &code] { pimpl_->start(code); });
65 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::function<void()>& code)
67 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
68 kernel::actor::ActorImpl* actor =
69 kernel::actor::simcall([self, &name, host, &code] { return self->init(name, host)->start(code); });
71 return actor->iface();
74 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function,
75 std::vector<std::string> args)
77 const simgrid::kernel::actor::ActorCodeFactory& factory =
78 simgrid::kernel::EngineImpl::get_instance()->get_function(function);
79 return create(name, host, factory(std::move(args)));
82 void intrusive_ptr_add_ref(const Actor* actor)
84 intrusive_ptr_add_ref(actor->pimpl_);
86 void intrusive_ptr_release(const Actor* actor)
88 intrusive_ptr_release(actor->pimpl_);
90 int Actor::get_refcount()
92 return pimpl_->get_refcount();
95 // ***** Actor methods *****
102 void Actor::join(double timeout)
104 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
105 kernel::actor::ActorImpl* target = pimpl_;
106 kernel::actor::simcall_blocking<void>([issuer, target, timeout] {
107 if (target->finished_) {
108 // The joined process is already finished, just wake up the issuer right away
109 issuer->simcall_answer();
111 kernel::activity::ActivityImplPtr sync = issuer->join(target, timeout);
112 sync->register_simcall(&issuer->simcall);
117 void Actor::set_auto_restart(bool autorestart)
119 kernel::actor::simcall([this, autorestart]() {
120 xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
121 pimpl_->set_auto_restart(autorestart);
123 kernel::actor::ProcessArg* arg = new kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
124 XBT_DEBUG("Adding %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
125 pimpl_->get_host()->pimpl_->add_actor_at_boot(arg);
129 void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun) const
131 kernel::actor::simcall([this, &fun] { pimpl_->on_exit->emplace_back(fun); });
134 void Actor::set_host(Host* new_host)
136 if (s4u::Actor::on_migration_start.get_slot_count() > 0) { // XBT_ATTRIB_DEPRECATED_v329
137 static bool already_warned = false;
138 if (not already_warned) {
139 XBT_INFO("Please use s4u::Actor::on_host_change instead of s4u::Actor::on_migration_start. This will be removed "
141 already_warned = true;
143 s4u::Actor::on_migration_start(*this);
146 const s4u::Host* previous_location = get_host();
148 kernel::actor::simcall([this, new_host]() {
149 if (pimpl_->waiting_synchro != nullptr) {
150 // The actor is blocked on an activity. If it's an exec, migrate it too.
151 // FIXME: implement the migration of other kinds of activities
152 kernel::activity::ExecImplPtr exec =
153 boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
154 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
155 exec->migrate(new_host);
157 this->pimpl_->set_host(new_host);
160 if (s4u::Actor::on_migration_end.get_slot_count() > 0) { // XBT_ATTRIB_DEPRECATED_v329
161 static bool already_warned = false;
162 if (not already_warned) {
163 XBT_INFO("Please use s4u::Actor::on_host_change instead of s4u::Actor::on_migration_end. This will be removed in "
165 already_warned = true;
167 s4u::Actor::on_migration_end(*this);
170 s4u::Actor::on_host_change(*this, *previous_location);
173 s4u::Host* Actor::get_host() const
175 return this->pimpl_->get_host();
178 void Actor::daemonize()
180 kernel::actor::simcall([this]() { pimpl_->daemonize(); });
183 bool Actor::is_daemon() const
185 return this->pimpl_->is_daemon();
188 const simgrid::xbt::string& Actor::get_name() const
190 return this->pimpl_->get_name();
193 const char* Actor::get_cname() const
195 return this->pimpl_->get_cname();
198 aid_t Actor::get_pid() const
200 return this->pimpl_->get_pid();
203 aid_t Actor::get_ppid() const
205 return this->pimpl_->get_ppid();
208 void Actor::suspend()
210 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
211 kernel::actor::ActorImpl* target = pimpl_;
212 s4u::Actor::on_suspend(*this);
213 kernel::actor::simcall_blocking<void>([issuer, target]() {
215 if (target != issuer) {
216 /* If we are suspending ourselves, then just do not finish the simcall now */
217 issuer->simcall_answer();
224 kernel::actor::simcall([this] { pimpl_->resume(); });
225 s4u::Actor::on_resume(*this);
228 bool Actor::is_suspended()
230 return pimpl_->is_suspended();
233 void Actor::set_kill_time(double kill_time)
235 kernel::actor::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
238 /** @brief Get the kill time of an actor(or 0 if unset). */
239 double Actor::get_kill_time()
241 return pimpl_->get_kill_time();
246 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
247 kernel::actor::simcall([this, self] { self->kill(pimpl_); });
250 // ***** Static functions *****
252 ActorPtr Actor::by_pid(aid_t pid)
254 kernel::actor::ActorImpl* actor = SIMIX_process_from_PID(pid);
255 if (actor != nullptr)
256 return actor->iface();
261 void Actor::kill_all()
263 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
264 kernel::actor::simcall([self] { self->kill_all(); });
267 const std::unordered_map<std::string, std::string>* Actor::get_properties() const
269 return pimpl_->get_properties();
272 /** Retrieve the property value (or nullptr if not set) */
273 const char* Actor::get_property(const std::string& key) const
275 return pimpl_->get_property(key);
278 void Actor::set_property(const std::string& key, const std::string& value)
280 kernel::actor::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
283 Actor* Actor::restart()
285 return kernel::actor::simcall([this]() { return pimpl_->restart(); });
288 // ***** this_actor *****
290 namespace this_actor {
292 /** Returns true if run from the kernel mode, and false if run from a real actor
294 * Everything that is run out of any actor (simulation setup before the engine is run,
295 * computing the model evolutions as a result to the actors' action, etc) is run in
296 * kernel mode, just as in any operating systems.
298 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
299 * because it is the one scheduling when the others should move or wait.
303 return SIMIX_is_maestro();
306 void sleep_for(double duration)
308 xbt_assert(std::isfinite(duration), "duration is not finite!");
311 kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
312 Actor::on_sleep(*issuer->ciface());
314 kernel::actor::simcall_blocking<void>([issuer, duration]() {
315 if (MC_is_active() || MC_record_replay_is_active()) {
316 MC_process_clock_add(issuer, duration);
317 issuer->simcall_answer();
320 kernel::activity::ActivityImplPtr sync = issuer->sleep(duration);
321 sync->register_simcall(&issuer->simcall);
324 Actor::on_wake_up(*issuer->ciface());
330 kernel::actor::simcall([] { /* do nothing*/ });
333 XBT_PUBLIC void sleep_until(double wakeup_time)
335 double now = SIMIX_get_clock();
336 if (wakeup_time > now)
337 sleep_for(wakeup_time - now);
340 void execute(double flops)
342 execute(flops, 1.0 /* priority */);
345 void execute(double flops, double priority)
347 exec_init(flops)->set_priority(priority)->start()->wait();
350 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
351 const std::vector<double>& bytes_amounts)
353 exec_init(hosts, flops_amounts, bytes_amounts)->wait();
356 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
357 const std::vector<double>& bytes_amounts, double timeout) // XBT_ATTRIB_DEPRECATED_v329
359 exec_init(hosts, flops_amounts, bytes_amounts)->wait_for(timeout);
362 ExecPtr exec_init(double flops_amount)
364 return ExecPtr(new ExecSeq(get_host(), flops_amount));
367 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
368 const std::vector<double>& bytes_amounts)
370 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
371 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
372 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
373 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
374 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
375 hosts.size(), hosts.size(), flops_amounts.size());
376 /* Check that we are not mixing VMs and PMs in the parallel task */
377 bool is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(hosts.front()));
378 xbt_assert(std::all_of(hosts.begin(), hosts.end(),
379 [is_a_vm](s4u::Host* elm) {
380 bool tmp_is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(elm));
381 return is_a_vm == tmp_is_a_vm;
383 "parallel_execute: mixing VMs and PMs is not supported (yet).");
384 /* checking for infinite values */
385 xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
386 "flops_amounts comprises infinite values!");
387 xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
388 "flops_amounts comprises infinite values!");
390 return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
393 ExecPtr exec_async(double flops)
395 ExecPtr res = exec_init(flops);
402 return simgrid::kernel::actor::ActorImpl::self()->get_pid();
407 return simgrid::kernel::actor::ActorImpl::self()->get_ppid();
410 std::string get_name()
412 return simgrid::kernel::actor::ActorImpl::self()->get_name();
415 const char* get_cname()
417 return simgrid::kernel::actor::ActorImpl::self()->get_cname();
422 return simgrid::kernel::actor::ActorImpl::self()->get_host();
427 kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
428 s4u::Actor::on_suspend(*self->ciface());
429 kernel::actor::simcall_blocking<void>([self] { self->suspend(); });
434 kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
435 simgrid::kernel::actor::simcall([self] { self->exit(); });
438 void on_exit(const std::function<void(bool)>& fun)
440 simgrid::kernel::actor::ActorImpl::self()->iface()->on_exit(fun);
443 /** @brief Moves the current actor to another host
445 * @see simgrid::s4u::Actor::migrate() for more information
447 void set_host(Host* new_host)
449 simgrid::kernel::actor::ActorImpl::self()->iface()->set_host(new_host);
451 void migrate(Host* new_host) // deprecated
456 } // namespace this_actor
458 } // namespace simgrid
460 /* **************************** Public C interface *************************** */
462 sg_actor_t sg_actor_init(const char* name, sg_host_t host)
464 return simgrid::s4u::Actor::init(name, host).get();
467 void sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char* const* argv)
469 simgrid::kernel::actor::ActorCode function;
471 function = simgrid::xbt::wrap_main(code, argc, argv);
472 actor->start(std::move(function));
477 simgrid::s4u::this_actor::exit();
480 /** @ingroup m_actor_management
481 * @brief Returns the process ID of @a actor.
483 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
486 aid_t sg_actor_get_PID(const_sg_actor_t actor)
488 /* Do not raise an exception here: this function is called by the logs
489 * and the exceptions, so it would be called back again and again */
490 if (actor == nullptr || actor->get_impl() == nullptr)
492 return actor->get_pid();
495 /** @ingroup m_actor_management
496 * @brief Returns the process ID of the parent of @a actor.
498 * This function checks whether @a actor is a valid pointer and return its parent's PID.
499 * Returns -1 if the actor has not been created by any other actor.
501 aid_t sg_actor_get_PPID(const_sg_actor_t actor)
503 return actor->get_ppid();
506 /** @ingroup m_actor_management
508 * @brief Return a #sg_actor_t given its PID.
510 * This function search in the list of all the created sg_actor_t for a sg_actor_t whose PID is equal to @a PID.
511 * If none is found, @c nullptr is returned.
512 Note that the PID are unique in the whole simulation, not only on a given host.
514 sg_actor_t sg_actor_by_PID(aid_t pid)
516 return simgrid::s4u::Actor::by_pid(pid).get();
519 /** @ingroup m_actor_management
520 * @brief Return the name of an actor.
522 const char* sg_actor_get_name(const_sg_actor_t actor)
524 return actor->get_cname();
527 sg_host_t sg_actor_get_host(const_sg_actor_t actor)
529 return actor->get_host();
532 /** @ingroup m_actor_management
533 * @brief Returns the value of a given actor property
535 * @param actor an actor
536 * @param name a property name
537 * @return value of a property (or nullptr if the property is not set)
539 const char* sg_actor_get_property_value(const_sg_actor_t actor, const char* name)
541 return actor->get_property(name);
544 /** @ingroup m_actor_management
545 * @brief Return the list of properties
547 * This function returns all the parameters associated with an actor
549 xbt_dict_t sg_actor_get_properties(const_sg_actor_t actor)
551 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
552 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
553 const std::unordered_map<std::string, std::string>* props = actor->get_properties();
554 if (props == nullptr)
556 for (auto const& kv : *props) {
557 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()));
562 /** @ingroup m_actor_management
563 * @brief Suspend the actor.
565 * This function suspends the actor by suspending the task on which it was waiting for the completion.
567 void sg_actor_suspend(sg_actor_t actor)
569 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
573 /** @ingroup m_actor_management
574 * @brief Resume a suspended actor.
576 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
578 void sg_actor_resume(sg_actor_t actor)
580 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
584 /** @ingroup m_actor_management
585 * @brief Returns true if the actor is suspended .
587 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
589 int sg_actor_is_suspended(sg_actor_t actor)
591 return actor->is_suspended();
595 * @ingroup m_actor_management
596 * @brief Restarts an actor from the beginning.
598 sg_actor_t sg_actor_restart(sg_actor_t actor)
600 return actor->restart();
604 * @ingroup m_actor_management
605 * @brief Sets the "auto-restart" flag of the actor.
606 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
608 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
610 actor->set_auto_restart(auto_restart);
613 /** @ingroup m_actor_management
614 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
616 void sg_actor_daemonize(sg_actor_t actor)
621 /** @ingroup m_actor_management
622 * @brief Migrates an actor to another location.
624 * This function changes the value of the #sg_host_t on which @a actor is running.
626 void sg_actor_set_host(sg_actor_t actor, sg_host_t host)
628 actor->set_host(host);
630 void sg_actor_migrate(sg_actor_t process, sg_host_t host) // deprecated
632 process->set_host(host);
635 /** @ingroup m_actor_management
636 * @brief Wait for the completion of a #sg_actor_t.
638 * @param actor the actor to wait for
639 * @param timeout wait until the actor is over, or the timeout expires
641 void sg_actor_join(sg_actor_t actor, double timeout)
643 actor->join(timeout);
646 void sg_actor_kill(sg_actor_t actor)
651 void sg_actor_kill_all()
653 simgrid::s4u::Actor::kill_all();
656 /** @ingroup m_actor_management
657 * @brief Set the kill time of an actor.
659 * @param actor an actor
660 * @param kill_time the time when the actor is killed.
662 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
664 actor->set_kill_time(kill_time);
667 /** Yield the current actor; let the other actors execute first */
668 void sg_actor_yield()
670 simgrid::s4u::this_actor::yield();
673 void sg_actor_sleep_for(double duration)
675 simgrid::s4u::this_actor::sleep_for(duration);
678 void sg_actor_sleep_until(double wakeup_time)
680 simgrid::s4u::this_actor::sleep_until(wakeup_time);
683 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
685 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
686 std::unordered_map<std::string, std::string> props;
687 xbt_dict_cursor_t cursor = nullptr;
690 xbt_dict_foreach (properties, cursor, key, value)
692 xbt_dict_free(&properties);
694 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
695 smx_actor_t actor = nullptr;
697 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
698 } catch (simgrid::HostFailureException const&) {
699 xbt_die("Could not attach");
702 simgrid::s4u::this_actor::yield();
703 return actor->ciface();
706 void sg_actor_detach()
708 simgrid::kernel::actor::ActorImpl::detach();
711 aid_t sg_actor_self_get_pid()
713 return simgrid::s4u::this_actor::get_pid();
716 aid_t sg_actor_self_get_ppid()
718 return simgrid::s4u::this_actor::get_ppid();
721 const char* sg_actor_self_get_name()
723 return simgrid::s4u::this_actor::get_cname();
726 void* sg_actor_self_data()
728 return simgrid::s4u::Actor::self()->get_data();
731 void sg_actor_self_data_set(void* userdata)
733 simgrid::s4u::Actor::self()->set_data(userdata);
736 sg_actor_t sg_actor_self()
738 return simgrid::s4u::Actor::self();
741 void sg_actor_self_execute(double flops)
743 simgrid::s4u::this_actor::execute(flops);
746 /** @brief Take an extra reference on that actor to prevent it to be garbage-collected */
747 void sg_actor_ref(const_sg_actor_t actor)
749 intrusive_ptr_add_ref(actor);
751 /** @brief Release a reference on that actor so that it can get be garbage-collected */
752 void sg_actor_unref(const_sg_actor_t actor)
754 intrusive_ptr_release(actor);
757 /** @brief Return the user data of a #sg_actor_t */
758 void* sg_actor_data(const_sg_actor_t actor)
760 return actor->get_data();
762 /** @brief Set the user data of a #sg_actor_t */
763 void sg_actor_data_set(sg_actor_t actor, void* userdata)
765 actor->set_data(userdata);
767 /** @brief Add a function to the list of "on_exit" functions for the current process.
768 * The on_exit functions are the functions executed when your process is killed.
769 * You should use them to free the data used by your process.
771 void sg_actor_on_exit(int_f_int_pvoid_t fun, void* data)
773 simgrid::s4u::this_actor::on_exit([fun, data](bool failed) { fun(failed ? 1 /*FAILURE*/ : 0 /*SUCCESS*/, data); });