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 xbt::signal<void(ActorPtr)> s4u::Actor::on_creation;
25 xbt::signal<void(ActorPtr)> s4u::Actor::on_suspend;
26 xbt::signal<void(ActorPtr)> s4u::Actor::on_resume;
27 xbt::signal<void(ActorPtr)> s4u::Actor::on_sleep;
28 xbt::signal<void(ActorPtr)> s4u::Actor::on_wake_up;
29 xbt::signal<void(ActorPtr)> s4u::Actor::on_migration_start;
30 xbt::signal<void(ActorPtr)> s4u::Actor::on_migration_end;
31 xbt::signal<void(ActorPtr)> s4u::Actor::on_destruction;
33 // ***** Actor creation *****
34 ActorPtr Actor::self()
36 kernel::context::Context* self_context = kernel::context::Context::self();
37 if (self_context == nullptr)
40 return self_context->get_actor()->iface();
42 ActorPtr Actor::init(const std::string& name, s4u::Host* host)
44 smx_actor_t self = SIMIX_process_self();
45 kernel::actor::ActorImpl* actor = simix::simcall([self, &name, host] { return self->init(name, host).get(); });
46 return actor->ciface();
49 ActorPtr Actor::start(const std::function<void()>& code)
51 simgrid::simix::simcall([this, &code] { pimpl_->start(code); });
55 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::function<void()>& code)
57 smx_actor_t self = SIMIX_process_self();
58 kernel::actor::ActorImpl* actor =
59 simix::simcall([self, &name, host, &code] { return self->init(name, host)->start(code); });
61 return actor->iface();
64 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function,
65 std::vector<std::string> args)
67 simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
68 return create(name, host, factory(std::move(args)));
71 void intrusive_ptr_add_ref(Actor* actor)
73 intrusive_ptr_add_ref(actor->pimpl_);
75 void intrusive_ptr_release(Actor* actor)
77 intrusive_ptr_release(actor->pimpl_);
80 // ***** Actor methods *****
84 simcall_process_join(this->pimpl_, -1);
87 void Actor::join(double timeout)
89 simcall_process_join(this->pimpl_, timeout);
92 void Actor::set_auto_restart(bool autorestart)
94 simix::simcall([this, autorestart]() {
95 xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
96 pimpl_->set_auto_restart(autorestart);
98 kernel::actor::ProcessArg* arg = new kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
99 XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
100 pimpl_->get_host()->pimpl_->actors_at_boot_.emplace_back(arg);
104 void Actor::on_exit(int_f_pvoid_pvoid_t fun,
105 void* data) /* deprecated: cleanup SIMIX_process_on_exit: change prototype of second parameter and
106 remove the last one */
108 simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
111 void Actor::on_exit(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
113 on_exit([fun, data](bool exit) { fun(exit, data); });
116 void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun) const
119 [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* /*data*/) { fun(a != 0); }, nullptr); });
122 void Actor::migrate(Host* new_host)
124 s4u::Actor::on_migration_start(this);
126 simix::simcall([this, new_host]() {
127 if (pimpl_->waiting_synchro != nullptr) {
128 // The actor is blocked on an activity. If it's an exec, migrate it too.
129 // FIXME: implement the migration of other kind of activities
130 kernel::activity::ExecImplPtr exec =
131 boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
132 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
133 exec->migrate(new_host);
135 this->pimpl_->set_host(new_host);
138 s4u::Actor::on_migration_end(this);
141 s4u::Host* Actor::get_host() const
143 return this->pimpl_->get_host();
146 void Actor::daemonize()
148 simix::simcall([this]() { pimpl_->daemonize(); });
151 bool Actor::is_daemon() const
153 return this->pimpl_->is_daemon();
156 const simgrid::xbt::string& Actor::get_name() const
158 return this->pimpl_->get_name();
161 const char* Actor::get_cname() const
163 return this->pimpl_->get_cname();
166 aid_t Actor::get_pid() const
168 return this->pimpl_->get_pid();
171 aid_t Actor::get_ppid() const
173 return this->pimpl_->get_ppid();
176 void Actor::suspend()
178 s4u::Actor::on_suspend(this);
179 simcall_process_suspend(pimpl_);
184 simix::simcall([this] { pimpl_->resume(); });
185 s4u::Actor::on_resume(this);
188 bool Actor::is_suspended()
190 return simix::simcall([this] { return pimpl_->is_suspended(); });
193 void Actor::set_kill_time(double kill_time)
195 simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
198 /** @brief Get the kill time of an actor(or 0 if unset). */
199 double Actor::get_kill_time()
201 return pimpl_->get_kill_time();
204 void Actor::kill(aid_t pid) // deprecated
206 kernel::actor::ActorImpl* killer = SIMIX_process_self();
207 kernel::actor::ActorImpl* victim = SIMIX_process_from_PID(pid);
208 if (victim != nullptr) {
209 simix::simcall([killer, victim] { killer->kill(victim); });
211 std::ostringstream oss;
212 oss << "kill: (" << pid << ") - No such actor" << std::endl;
213 throw std::runtime_error(oss.str());
219 kernel::actor::ActorImpl* process = SIMIX_process_self();
220 simix::simcall([this, process] {
221 xbt_assert(pimpl_ != simix_global->maestro_process, "Killing maestro is a rather bad idea");
222 process->kill(pimpl_);
226 // ***** Static functions *****
228 ActorPtr Actor::by_pid(aid_t pid)
230 kernel::actor::ActorImpl* process = SIMIX_process_from_PID(pid);
231 if (process != nullptr)
232 return process->iface();
237 void Actor::kill_all()
239 kernel::actor::ActorImpl* self = SIMIX_process_self();
240 simix::simcall([self] { self->kill_all(); });
243 std::unordered_map<std::string, std::string>* Actor::get_properties()
245 return simix::simcall([this] { return this->pimpl_->get_properties(); });
248 /** Retrieve the property value (or nullptr if not set) */
249 const char* Actor::get_property(const std::string& key)
251 return simix::simcall([this, &key] { return pimpl_->get_property(key); });
254 void Actor::set_property(const std::string& key, const std::string& value)
256 simix::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
259 Actor* Actor::restart()
261 return simix::simcall([this]() { return pimpl_->restart(); });
264 // ***** this_actor *****
266 namespace this_actor {
268 /** Returns true if run from the kernel mode, and false if run from a real actor
270 * Everything that is run out of any actor (simulation setup before the engine is run,
271 * computing the model evolutions as a result to the actors' action, etc) is run in
272 * kernel mode, just as in any operating systems.
274 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
275 * because it is the one scheduling when the others should move or wait.
279 kernel::actor::ActorImpl* process = SIMIX_process_self();
280 return process == nullptr || process == simix_global->maestro_process;
283 void sleep_for(double duration)
286 kernel::actor::ActorImpl* actor = SIMIX_process_self();
287 Actor::on_sleep(actor->iface());
289 simcall_process_sleep(duration);
291 Actor::on_wake_up(actor->iface());
297 simix::simcall([] { /* do nothing*/ });
300 XBT_PUBLIC void sleep_until(double timeout)
302 double now = SIMIX_get_clock();
304 sleep_for(timeout - now);
307 void execute(double flops)
309 execute(flops, 1.0 /* priority */);
312 void execute(double flops, double priority)
314 exec_init(flops)->set_priority(priority)->start()->wait();
317 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
318 const std::vector<double>& bytes_amounts)
320 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
323 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
324 const std::vector<double>& bytes_amounts, double timeout)
326 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
327 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
328 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
329 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
330 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
331 hosts.size(), hosts.size(), flops_amounts.size());
332 /* Check that we are not mixing VMs and PMs in the parallel task */
333 bool is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(hosts.front()));
334 xbt_assert(std::all_of(hosts.begin(), hosts.end(),
335 [is_a_vm](s4u::Host* elm) {
336 bool tmp_is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(elm));
337 return is_a_vm == tmp_is_a_vm;
339 "parallel_execute: mixing VMs and PMs is not supported (yet).");
340 /* checking for infinite values */
341 xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
342 "flops_amounts comprises infinite values!");
343 xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
344 "flops_amounts comprises infinite values!");
346 exec_init(hosts, flops_amounts, bytes_amounts)->set_timeout(timeout)->wait();
350 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
354 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
355 simcall_execution_wait(s);
356 delete[] flops_amount;
357 delete[] bytes_amount;
361 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
363 smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
364 /* rate */ -1, /*timeout*/ -1);
365 simcall_execution_wait(s);
366 delete[] flops_amount;
367 delete[] bytes_amount;
370 ExecPtr exec_init(double flops_amount)
372 return ExecPtr(new ExecSeq(get_host(), flops_amount));
375 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
376 const std::vector<double>& bytes_amounts)
378 return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
381 ExecPtr exec_async(double flops)
383 ExecPtr res = exec_init(flops);
390 return SIMIX_process_self()->get_pid();
395 return SIMIX_process_self()->get_ppid();
398 std::string get_name()
400 return SIMIX_process_self()->get_name();
403 const char* get_cname()
405 return SIMIX_process_self()->get_cname();
410 return SIMIX_process_self()->get_host();
415 kernel::actor::ActorImpl* actor = SIMIX_process_self();
416 Actor::on_suspend(actor->iface());
418 simcall_process_suspend(actor);
423 kernel::actor::ActorImpl* self = SIMIX_process_self();
424 simix::simcall([self] { self->resume(); });
425 Actor::on_resume(self->iface());
430 kernel::actor::ActorImpl* self = SIMIX_process_self();
431 simgrid::simix::simcall([self] { self->exit(); });
434 void on_exit(const std::function<void(bool)>& fun)
436 SIMIX_process_self()->iface()->on_exit(fun);
439 void on_exit(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
441 SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
444 /** @brief Moves the current actor to another host
446 * @see simgrid::s4u::Actor::migrate() for more information
448 void migrate(Host* new_host)
450 SIMIX_process_self()->iface()->migrate(new_host);
453 std::string getName() /* deprecated */
457 const char* getCname() /* deprecated */
461 bool isMaestro() /* deprecated */
465 aid_t getPid() /* deprecated */
469 aid_t getPpid() /* deprecated */
473 Host* getHost() /* deprecated */
477 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
479 SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
481 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
483 on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
485 void kill() /* deprecated */
490 } // namespace this_actor
492 } // namespace simgrid
494 /* **************************** Public C interface *************************** */
496 /** @ingroup m_actor_management
497 * @brief Returns the process ID of @a actor.
499 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
501 aid_t sg_actor_get_PID(sg_actor_t actor)
503 /* Do not raise an exception here: this function is called by the logs
504 * and the exceptions, so it would be called back again and again */
505 if (actor == nullptr || actor->get_impl() == nullptr)
507 return actor->get_pid();
510 /** @ingroup m_actor_management
511 * @brief Returns the process ID of the parent of @a actor.
513 * This function checks whether @a actor is a valid pointer and return its parent's PID.
514 * Returns -1 if the actor has not been created by any other actor.
516 aid_t sg_actor_get_PPID(sg_actor_t actor)
518 return actor->get_ppid();
521 /** @ingroup m_actor_management
523 * @brief Return a #sg_actor_t given its PID.
525 * 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.
526 * If none is found, @c nullptr is returned.
527 Note that the PID are unique in the whole simulation, not only on a given host.
529 sg_actor_t sg_actor_by_PID(aid_t pid)
531 return simgrid::s4u::Actor::by_pid(pid).get();
534 /** @ingroup m_actor_management
535 * @brief Return the name of an actor.
537 const char* sg_actor_get_name(sg_actor_t actor)
539 return actor->get_cname();
542 sg_host_t sg_actor_get_host(sg_actor_t actor)
544 return actor->get_host();
547 /** @ingroup m_actor_management
548 * @brief Returns the value of a given actor property
550 * @param actor an actor
551 * @param name a property name
552 * @return value of a property (or nullptr if the property is not set)
554 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
556 return actor->get_property(name);
559 /** @ingroup m_actor_management
560 * @brief Return the list of properties
562 * This function returns all the parameters associated with an actor
564 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
566 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
567 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
568 std::unordered_map<std::string, std::string>* props = actor->get_properties();
569 if (props == nullptr)
571 for (auto const& kv : *props) {
572 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
577 /** @ingroup m_actor_management
578 * @brief Suspend the actor.
580 * This function suspends the actor by suspending the task on which it was waiting for the completion.
582 void sg_actor_suspend(sg_actor_t actor)
584 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
588 /** @ingroup m_actor_management
589 * @brief Resume a suspended actor.
591 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
593 void sg_actor_resume(sg_actor_t actor)
595 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
599 /** @ingroup m_actor_management
600 * @brief Returns true if the actor is suspended .
602 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
604 int sg_actor_is_suspended(sg_actor_t actor)
606 return actor->is_suspended();
610 * @ingroup m_actor_management
611 * @brief Restarts an actor from the beginning.
613 sg_actor_t sg_actor_restart(sg_actor_t actor)
615 return actor->restart();
619 * @ingroup m_actor_management
620 * @brief Sets the "auto-restart" flag of the actor.
621 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
623 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
625 actor->set_auto_restart(auto_restart);
628 /** @ingroup m_actor_management
629 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
631 void sg_actor_daemonize(sg_actor_t actor)
636 /** @ingroup m_actor_management
637 * @brief Migrates an actor to another location.
639 * This function changes the value of the #sg_host_t on which @a actor is running.
641 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
643 process->migrate(host);
646 /** @ingroup m_actor_management
647 * @brief Wait for the completion of a #sg_actor_t.
649 * @param actor the actor to wait for
650 * @param timeout wait until the actor is over, or the timeout expires
652 void sg_actor_join(sg_actor_t actor, double timeout)
654 actor->join(timeout);
657 void sg_actor_kill(sg_actor_t actor)
662 void sg_actor_kill_all()
664 simgrid::s4u::Actor::kill_all();
667 /** @ingroup m_actor_management
668 * @brief Set the kill time of an actor.
670 * @param actor an actor
671 * @param kill_time the time when the actor is killed.
673 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
675 actor->set_kill_time(kill_time);
678 /** Yield the current actor; let the other actors execute first */
679 void sg_actor_yield()
681 simgrid::s4u::this_actor::yield();
684 void sg_actor_sleep_for(double duration)
686 simgrid::s4u::this_actor::sleep_for(duration);
689 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
691 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
692 std::unordered_map<std::string, std::string> props;
693 xbt_dict_cursor_t cursor = nullptr;
696 xbt_dict_foreach (properties, cursor, key, value)
698 xbt_dict_free(&properties);
700 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
701 smx_actor_t actor = nullptr;
703 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
704 } catch (simgrid::HostFailureException const&) {
705 xbt_die("Could not attach");
708 simgrid::s4u::this_actor::yield();
709 return actor->ciface();
712 void sg_actor_detach()
714 simgrid::kernel::actor::ActorImpl::detach();