1 /* Copyright (c) 2006-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. */
6 #include "simgrid/Exception.hpp"
7 #include "simgrid/actor.h"
8 #include "simgrid/s4u/Actor.hpp"
9 #include "simgrid/s4u/Exec.hpp"
10 #include "simgrid/s4u/Host.hpp"
11 #include "simgrid/s4u/VirtualMachine.hpp"
12 #include "src/kernel/activity/ExecImpl.hpp"
13 #include "src/simix/smx_private.hpp"
14 #include "src/surf/HostImpl.hpp"
19 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
24 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
25 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_suspend;
26 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_resume;
27 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_sleep;
28 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_wake_up;
29 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_start;
30 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
31 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
33 // ***** Actor creation *****
34 ActorPtr Actor::self()
36 smx_context_t self_context = simgrid::kernel::context::Context::self();
37 if (self_context == nullptr)
38 return simgrid::s4u::ActorPtr();
40 return self_context->get_actor()->iface();
42 ActorPtr Actor::init(std::string name, s4u::Host* host)
44 smx_actor_t self = SIMIX_process_self();
45 simgrid::kernel::actor::ActorImpl* actor =
46 simgrid::simix::simcall([self, name, host] { return self->init(std::move(name), host).get(); });
47 return actor->ciface();
50 ActorPtr Actor::start(const std::function<void()>& code)
52 simgrid::simix::simcall([this, &code] { pimpl_->start(code); });
56 ActorPtr Actor::create(std::string name, s4u::Host* host, const std::function<void()>& code)
58 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(std::move(name), code, nullptr, host, nullptr);
60 return actor->iface();
63 ActorPtr Actor::create(std::string name, s4u::Host* host, const std::string& function, std::vector<std::string> args)
65 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
66 return create(std::move(name), host, factory(std::move(args)));
69 void intrusive_ptr_add_ref(Actor* actor)
71 intrusive_ptr_add_ref(actor->pimpl_);
73 void intrusive_ptr_release(Actor* actor)
75 intrusive_ptr_release(actor->pimpl_);
78 // ***** Actor methods *****
82 simcall_process_join(this->pimpl_, -1);
85 void Actor::join(double timeout)
87 simcall_process_join(this->pimpl_, timeout);
90 void Actor::set_auto_restart(bool autorestart)
92 simgrid::simix::simcall([this, autorestart]() {
93 xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
94 pimpl_->set_auto_restart(autorestart);
96 simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
97 XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
98 pimpl_->get_host()->pimpl_->actors_at_boot_.emplace_back(arg);
102 void Actor::on_exit(int_f_pvoid_pvoid_t fun,
103 void* data) /* deprecated: cleanup SIMIX_process_on_exit: change prototype of second parameter and
104 remove the last one */
106 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
109 void Actor::on_exit(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
111 on_exit([fun, data](bool exit) { fun(exit, data); });
114 void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun)
116 simgrid::simix::simcall(
117 [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* /*data*/) { fun(a != 0); }, nullptr); });
120 void Actor::migrate(Host* new_host)
122 s4u::Actor::on_migration_start(this);
124 simgrid::simix::simcall([this, new_host]() {
125 if (pimpl_->waiting_synchro != nullptr) {
126 // The actor is blocked on an activity. If it's an exec, migrate it too.
127 // FIXME: implement the migration of other kind of activities
128 simgrid::kernel::activity::ExecImplPtr exec =
129 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
130 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
131 exec->migrate(new_host);
133 this->pimpl_->set_host(new_host);
136 s4u::Actor::on_migration_end(this);
139 s4u::Host* Actor::get_host()
141 return this->pimpl_->get_host();
144 void Actor::daemonize()
146 simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
149 bool Actor::is_daemon() const
151 return this->pimpl_->is_daemon();
154 const simgrid::xbt::string& Actor::get_name() const
156 return this->pimpl_->get_name();
159 const char* Actor::get_cname() const
161 return this->pimpl_->get_cname();
164 aid_t Actor::get_pid() const
166 return this->pimpl_->get_pid();
169 aid_t Actor::get_ppid() const
171 return this->pimpl_->get_ppid();
174 void Actor::suspend()
176 s4u::Actor::on_suspend(this);
177 simcall_process_suspend(pimpl_);
182 simgrid::simix::simcall([this] { pimpl_->resume(); });
183 s4u::Actor::on_resume(this);
186 bool Actor::is_suspended()
188 return simgrid::simix::simcall([this] { return pimpl_->is_suspended(); });
191 void Actor::set_kill_time(double kill_time)
193 simgrid::simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
196 /** @brief Get the kill time of an actor(or 0 if unset). */
197 double Actor::get_kill_time()
199 return pimpl_->get_kill_time();
202 void Actor::kill(aid_t pid) // deprecated
204 smx_actor_t killer = SIMIX_process_self();
205 smx_actor_t victim = SIMIX_process_from_PID(pid);
206 if (victim != nullptr) {
207 simgrid::simix::simcall([killer, victim] { killer->kill(victim); });
209 std::ostringstream oss;
210 oss << "kill: (" << pid << ") - No such actor" << std::endl;
211 throw std::runtime_error(oss.str());
217 smx_actor_t process = SIMIX_process_self();
218 simgrid::simix::simcall([this, process] {
219 if (pimpl_ == simix_global->maestro_process)
222 process->kill(pimpl_);
226 smx_actor_t Actor::get_impl()
231 // ***** Static functions *****
233 ActorPtr Actor::by_pid(aid_t pid)
235 smx_actor_t process = SIMIX_process_from_PID(pid);
236 if (process != nullptr)
237 return process->iface();
242 void Actor::kill_all()
244 smx_actor_t self = SIMIX_process_self();
245 simgrid::simix::simcall([self] { self->kill_all(); });
248 std::unordered_map<std::string, std::string>* Actor::get_properties()
250 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
253 /** Retrieve the property value (or nullptr if not set) */
254 const char* Actor::get_property(const std::string& key)
256 return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
259 void Actor::set_property(const std::string& key, std::string value)
261 simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, std::move(value)); });
264 Actor* Actor::restart()
266 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
269 // ***** this_actor *****
271 namespace this_actor {
273 /** Returns true if run from the kernel mode, and false if run from a real actor
275 * Everything that is run out of any actor (simulation setup before the engine is run,
276 * computing the model evolutions as a result to the actors' action, etc) is run in
277 * kernel mode, just as in any operating systems.
279 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
280 * because it is the one scheduling when the others should move or wait.
284 smx_actor_t process = SIMIX_process_self();
285 return process == nullptr || process == simix_global->maestro_process;
288 void sleep_for(double duration)
291 smx_actor_t actor = SIMIX_process_self();
292 simgrid::s4u::Actor::on_sleep(actor->iface());
294 simcall_process_sleep(duration);
296 simgrid::s4u::Actor::on_wake_up(actor->iface());
302 simgrid::simix::simcall([] { /* do nothing*/ });
305 XBT_PUBLIC void sleep_until(double timeout)
307 double now = SIMIX_get_clock();
309 sleep_for(timeout - now);
312 void execute(double flops)
314 execute(flops, 1.0 /* priority */);
317 void execute(double flops, double priority)
319 exec_init(flops)->set_priority(priority)->start()->wait();
322 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
323 const std::vector<double>& bytes_amounts)
325 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
328 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
329 const std::vector<double>& bytes_amounts, double timeout)
331 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
332 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
333 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
334 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
335 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
336 hosts.size(), hosts.size(), flops_amounts.size());
337 /* Check that we are not mixing VMs and PMs in the parallel task */
338 bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(hosts.front()));
339 xbt_assert(std::all_of(hosts.begin(), hosts.end(),
340 [is_a_vm](s4u::Host* elm) {
341 bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(elm));
342 return is_a_vm == tmp_is_a_vm;
344 "parallel_execute: mixing VMs and PMs is not supported (yet).");
345 /* checking for infinite values */
346 xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
347 "flops_amounts comprises infinite values!");
348 xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
349 "flops_amounts comprises infinite values!");
351 exec_init(hosts, flops_amounts, bytes_amounts)->set_timeout(timeout)->wait();
355 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
359 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
360 simcall_execution_wait(s);
361 delete[] flops_amount;
362 delete[] bytes_amount;
366 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
368 smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
369 /* rate */ -1, /*timeout*/ -1);
370 simcall_execution_wait(s);
371 delete[] flops_amount;
372 delete[] bytes_amount;
375 ExecPtr exec_init(double flops_amount)
377 return ExecPtr(new ExecSeq(get_host(), flops_amount));
380 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
381 const std::vector<double>& bytes_amounts)
383 return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
386 ExecPtr exec_async(double flops)
388 ExecPtr res = exec_init(flops);
395 return SIMIX_process_self()->get_pid();
400 return SIMIX_process_self()->get_ppid();
403 std::string get_name()
405 return SIMIX_process_self()->get_name();
408 const char* get_cname()
410 return SIMIX_process_self()->get_cname();
415 return SIMIX_process_self()->get_host();
420 smx_actor_t actor = SIMIX_process_self();
421 simgrid::s4u::Actor::on_suspend(actor->iface());
423 simcall_process_suspend(actor);
428 smx_actor_t process = SIMIX_process_self();
429 simgrid::simix::simcall([process] { process->resume(); });
430 simgrid::s4u::Actor::on_resume(process->iface());
435 smx_actor_t actor = SIMIX_process_self();
436 simgrid::simix::simcall([actor] { actor->exit(); });
439 void on_exit(const std::function<void(bool)>& fun)
441 SIMIX_process_self()->iface()->on_exit(fun);
444 void on_exit(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
446 SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
449 /** @brief Moves the current actor to another host
451 * @see simgrid::s4u::Actor::migrate() for more information
453 void migrate(Host* new_host)
455 SIMIX_process_self()->iface()->migrate(new_host);
458 std::string getName() /* deprecated */
462 const char* getCname() /* deprecated */
466 bool isMaestro() /* deprecated */
470 aid_t getPid() /* deprecated */
474 aid_t getPpid() /* deprecated */
478 Host* getHost() /* deprecated */
482 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
484 SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
486 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
488 on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
490 void kill() /* deprecated */
495 } // namespace this_actor
497 } // namespace simgrid
499 /* **************************** Public C interface *************************** */
501 /** @ingroup m_actor_management
502 * @brief Returns the process ID of @a actor.
504 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
506 aid_t sg_actor_get_PID(sg_actor_t actor)
508 /* Do not raise an exception here: this function is called by the logs
509 * and the exceptions, so it would be called back again and again */
510 if (actor == nullptr || actor->get_impl() == nullptr)
512 return actor->get_pid();
515 /** @ingroup m_actor_management
516 * @brief Returns the process ID of the parent of @a actor.
518 * This function checks whether @a actor is a valid pointer and return its parent's PID.
519 * Returns -1 if the actor has not been created by any other actor.
521 aid_t sg_actor_get_PPID(sg_actor_t actor)
523 return actor->get_ppid();
526 /** @ingroup m_actor_management
528 * @brief Return a #sg_actor_t given its PID.
530 * 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.
531 * If none is found, @c nullptr is returned.
532 Note that the PID are unique in the whole simulation, not only on a given host.
534 sg_actor_t sg_actor_by_PID(aid_t pid)
536 return simgrid::s4u::Actor::by_pid(pid).get();
539 /** @ingroup m_actor_management
540 * @brief Return the name of an actor.
542 const char* sg_actor_get_name(sg_actor_t actor)
544 return actor->get_cname();
547 sg_host_t sg_actor_get_host(sg_actor_t actor)
549 return actor->get_host();
552 /** @ingroup m_actor_management
553 * @brief Returns the value of a given actor property
555 * @param actor an actor
556 * @param name a property name
557 * @return value of a property (or nullptr if the property is not set)
559 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
561 return actor->get_property(name);
564 /** @ingroup m_actor_management
565 * @brief Return the list of properties
567 * This function returns all the parameters associated with an actor
569 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
571 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
572 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
573 std::unordered_map<std::string, std::string>* props = actor->get_properties();
574 if (props == nullptr)
576 for (auto const& kv : *props) {
577 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
582 /** @ingroup m_actor_management
583 * @brief Suspend the actor.
585 * This function suspends the actor by suspending the task on which it was waiting for the completion.
587 void sg_actor_suspend(sg_actor_t actor)
589 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
593 /** @ingroup m_actor_management
594 * @brief Resume a suspended actor.
596 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
598 void sg_actor_resume(sg_actor_t actor)
600 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
604 /** @ingroup m_actor_management
605 * @brief Returns true if the actor is suspended .
607 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
609 int sg_actor_is_suspended(sg_actor_t actor)
611 return actor->is_suspended();
615 * @ingroup m_actor_management
616 * @brief Restarts an actor from the beginning.
618 sg_actor_t sg_actor_restart(sg_actor_t actor)
620 return actor->restart();
624 * @ingroup m_actor_management
625 * @brief Sets the "auto-restart" flag of the actor.
626 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
628 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
630 actor->set_auto_restart(auto_restart);
633 /** @ingroup m_actor_management
634 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
636 void sg_actor_daemonize(sg_actor_t actor)
641 /** @ingroup m_actor_management
642 * @brief Migrates an actor to another location.
644 * This function changes the value of the #sg_host_t on which @a actor is running.
646 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
648 process->migrate(host);
651 /** @ingroup m_actor_management
652 * @brief Wait for the completion of a #sg_actor_t.
654 * @param actor the actor to wait for
655 * @param timeout wait until the actor is over, or the timeout expires
657 void sg_actor_join(sg_actor_t actor, double timeout)
659 actor->join(timeout);
662 void sg_actor_kill(sg_actor_t actor)
667 void sg_actor_kill_all()
669 simgrid::s4u::Actor::kill_all();
672 /** @ingroup m_actor_management
673 * @brief Set the kill time of an actor.
675 * @param actor an actor
676 * @param kill_time the time when the actor is killed.
678 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
680 actor->set_kill_time(kill_time);
683 /** Yield the current actor; let the other actors execute first */
684 void sg_actor_yield()
686 simgrid::s4u::this_actor::yield();
689 void sg_actor_sleep_for(double duration)
691 simgrid::s4u::this_actor::sleep_for(duration);
694 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
696 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
697 std::unordered_map<std::string, std::string> props;
698 xbt_dict_cursor_t cursor = nullptr;
701 xbt_dict_foreach (properties, cursor, key, value)
703 xbt_dict_free(&properties);
705 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
706 smx_actor_t actor = nullptr;
708 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
709 } catch (simgrid::HostFailureException const&) {
710 xbt_die("Could not attach");
713 simgrid::s4u::this_actor::yield();
714 return actor->ciface();
717 void sg_actor_detach()
719 simgrid::kernel::actor::ActorImpl::detach();