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(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 simgrid::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 simgrid::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 simgrid::kernel::actor::ProcessArg* arg = new simgrid::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 simgrid::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)
118 simgrid::simix::simcall(
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 simgrid::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 simgrid::kernel::activity::ExecImplPtr exec =
131 boost::dynamic_pointer_cast<simgrid::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()
143 return this->pimpl_->get_host();
146 void Actor::daemonize()
148 simgrid::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 simgrid::simix::simcall([this] { pimpl_->resume(); });
185 s4u::Actor::on_resume(this);
188 bool Actor::is_suspended()
190 return simgrid::simix::simcall([this] { return pimpl_->is_suspended(); });
193 void Actor::set_kill_time(double kill_time)
195 simgrid::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 smx_actor_t killer = SIMIX_process_self();
207 smx_actor_t victim = SIMIX_process_from_PID(pid);
208 if (victim != nullptr) {
209 simgrid::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 smx_actor_t process = SIMIX_process_self();
220 simgrid::simix::simcall([this, process] {
221 if (pimpl_ == simix_global->maestro_process)
224 process->kill(pimpl_);
228 smx_actor_t Actor::get_impl()
233 // ***** Static functions *****
235 ActorPtr Actor::by_pid(aid_t pid)
237 smx_actor_t process = SIMIX_process_from_PID(pid);
238 if (process != nullptr)
239 return process->iface();
244 void Actor::kill_all()
246 smx_actor_t self = SIMIX_process_self();
247 simgrid::simix::simcall([self] { self->kill_all(); });
250 std::unordered_map<std::string, std::string>* Actor::get_properties()
252 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
255 /** Retrieve the property value (or nullptr if not set) */
256 const char* Actor::get_property(const std::string& key)
258 return simgrid::simix::simcall([this, &key] { return pimpl_->get_property(key); });
261 void Actor::set_property(const std::string& key, const std::string& value)
263 simgrid::simix::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
266 Actor* Actor::restart()
268 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
271 // ***** this_actor *****
273 namespace this_actor {
275 /** Returns true if run from the kernel mode, and false if run from a real actor
277 * Everything that is run out of any actor (simulation setup before the engine is run,
278 * computing the model evolutions as a result to the actors' action, etc) is run in
279 * kernel mode, just as in any operating systems.
281 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
282 * because it is the one scheduling when the others should move or wait.
286 smx_actor_t process = SIMIX_process_self();
287 return process == nullptr || process == simix_global->maestro_process;
290 void sleep_for(double duration)
293 smx_actor_t actor = SIMIX_process_self();
294 simgrid::s4u::Actor::on_sleep(actor->iface());
296 simcall_process_sleep(duration);
298 simgrid::s4u::Actor::on_wake_up(actor->iface());
304 simgrid::simix::simcall([] { /* do nothing*/ });
307 XBT_PUBLIC void sleep_until(double timeout)
309 double now = SIMIX_get_clock();
311 sleep_for(timeout - now);
314 void execute(double flops)
316 execute(flops, 1.0 /* priority */);
319 void execute(double flops, double priority)
321 exec_init(flops)->set_priority(priority)->start()->wait();
324 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
325 const std::vector<double>& bytes_amounts)
327 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
330 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
331 const std::vector<double>& bytes_amounts, double timeout)
333 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
334 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
335 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
336 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
337 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
338 hosts.size(), hosts.size(), flops_amounts.size());
339 /* Check that we are not mixing VMs and PMs in the parallel task */
340 bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(hosts.front()));
341 xbt_assert(std::all_of(hosts.begin(), hosts.end(),
342 [is_a_vm](s4u::Host* elm) {
343 bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(elm));
344 return is_a_vm == tmp_is_a_vm;
346 "parallel_execute: mixing VMs and PMs is not supported (yet).");
347 /* checking for infinite values */
348 xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
349 "flops_amounts comprises infinite values!");
350 xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
351 "flops_amounts comprises infinite values!");
353 exec_init(hosts, flops_amounts, bytes_amounts)->set_timeout(timeout)->wait();
357 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
361 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
362 simcall_execution_wait(s);
363 delete[] flops_amount;
364 delete[] bytes_amount;
368 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
370 smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
371 /* rate */ -1, /*timeout*/ -1);
372 simcall_execution_wait(s);
373 delete[] flops_amount;
374 delete[] bytes_amount;
377 ExecPtr exec_init(double flops_amount)
379 return ExecPtr(new ExecSeq(get_host(), flops_amount));
382 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
383 const std::vector<double>& bytes_amounts)
385 return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
388 ExecPtr exec_async(double flops)
390 ExecPtr res = exec_init(flops);
397 return SIMIX_process_self()->get_pid();
402 return SIMIX_process_self()->get_ppid();
405 std::string get_name()
407 return SIMIX_process_self()->get_name();
410 const char* get_cname()
412 return SIMIX_process_self()->get_cname();
417 return SIMIX_process_self()->get_host();
422 smx_actor_t actor = SIMIX_process_self();
423 simgrid::s4u::Actor::on_suspend(actor->iface());
425 simcall_process_suspend(actor);
430 smx_actor_t process = SIMIX_process_self();
431 simgrid::simix::simcall([process] { process->resume(); });
432 simgrid::s4u::Actor::on_resume(process->iface());
437 smx_actor_t actor = SIMIX_process_self();
438 simgrid::simix::simcall([actor] { actor->exit(); });
441 void on_exit(const std::function<void(bool)>& fun)
443 SIMIX_process_self()->iface()->on_exit(fun);
446 void on_exit(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
448 SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
451 /** @brief Moves the current actor to another host
453 * @see simgrid::s4u::Actor::migrate() for more information
455 void migrate(Host* new_host)
457 SIMIX_process_self()->iface()->migrate(new_host);
460 std::string getName() /* deprecated */
464 const char* getCname() /* deprecated */
468 bool isMaestro() /* deprecated */
472 aid_t getPid() /* deprecated */
476 aid_t getPpid() /* deprecated */
480 Host* getHost() /* deprecated */
484 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
486 SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
488 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
490 on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
492 void kill() /* deprecated */
497 } // namespace this_actor
499 } // namespace simgrid
501 /* **************************** Public C interface *************************** */
503 /** @ingroup m_actor_management
504 * @brief Returns the process ID of @a actor.
506 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
508 aid_t sg_actor_get_PID(sg_actor_t actor)
510 /* Do not raise an exception here: this function is called by the logs
511 * and the exceptions, so it would be called back again and again */
512 if (actor == nullptr || actor->get_impl() == nullptr)
514 return actor->get_pid();
517 /** @ingroup m_actor_management
518 * @brief Returns the process ID of the parent of @a actor.
520 * This function checks whether @a actor is a valid pointer and return its parent's PID.
521 * Returns -1 if the actor has not been created by any other actor.
523 aid_t sg_actor_get_PPID(sg_actor_t actor)
525 return actor->get_ppid();
528 /** @ingroup m_actor_management
530 * @brief Return a #sg_actor_t given its PID.
532 * 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.
533 * If none is found, @c nullptr is returned.
534 Note that the PID are unique in the whole simulation, not only on a given host.
536 sg_actor_t sg_actor_by_PID(aid_t pid)
538 return simgrid::s4u::Actor::by_pid(pid).get();
541 /** @ingroup m_actor_management
542 * @brief Return the name of an actor.
544 const char* sg_actor_get_name(sg_actor_t actor)
546 return actor->get_cname();
549 sg_host_t sg_actor_get_host(sg_actor_t actor)
551 return actor->get_host();
554 /** @ingroup m_actor_management
555 * @brief Returns the value of a given actor property
557 * @param actor an actor
558 * @param name a property name
559 * @return value of a property (or nullptr if the property is not set)
561 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
563 return actor->get_property(name);
566 /** @ingroup m_actor_management
567 * @brief Return the list of properties
569 * This function returns all the parameters associated with an actor
571 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
573 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
574 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
575 std::unordered_map<std::string, std::string>* props = actor->get_properties();
576 if (props == nullptr)
578 for (auto const& kv : *props) {
579 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
584 /** @ingroup m_actor_management
585 * @brief Suspend the actor.
587 * This function suspends the actor by suspending the task on which it was waiting for the completion.
589 void sg_actor_suspend(sg_actor_t actor)
591 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
595 /** @ingroup m_actor_management
596 * @brief Resume a suspended actor.
598 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
600 void sg_actor_resume(sg_actor_t actor)
602 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
606 /** @ingroup m_actor_management
607 * @brief Returns true if the actor is suspended .
609 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
611 int sg_actor_is_suspended(sg_actor_t actor)
613 return actor->is_suspended();
617 * @ingroup m_actor_management
618 * @brief Restarts an actor from the beginning.
620 sg_actor_t sg_actor_restart(sg_actor_t actor)
622 return actor->restart();
626 * @ingroup m_actor_management
627 * @brief Sets the "auto-restart" flag of the actor.
628 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
630 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
632 actor->set_auto_restart(auto_restart);
635 /** @ingroup m_actor_management
636 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
638 void sg_actor_daemonize(sg_actor_t actor)
643 /** @ingroup m_actor_management
644 * @brief Migrates an actor to another location.
646 * This function changes the value of the #sg_host_t on which @a actor is running.
648 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
650 process->migrate(host);
653 /** @ingroup m_actor_management
654 * @brief Wait for the completion of a #sg_actor_t.
656 * @param actor the actor to wait for
657 * @param timeout wait until the actor is over, or the timeout expires
659 void sg_actor_join(sg_actor_t actor, double timeout)
661 actor->join(timeout);
664 void sg_actor_kill(sg_actor_t actor)
669 void sg_actor_kill_all()
671 simgrid::s4u::Actor::kill_all();
674 /** @ingroup m_actor_management
675 * @brief Set the kill time of an actor.
677 * @param actor an actor
678 * @param kill_time the time when the actor is killed.
680 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
682 actor->set_kill_time(kill_time);
685 /** Yield the current actor; let the other actors execute first */
686 void sg_actor_yield()
688 simgrid::s4u::this_actor::yield();
691 void sg_actor_sleep_for(double duration)
693 simgrid::s4u::this_actor::sleep_for(duration);
696 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
698 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
699 std::unordered_map<std::string, std::string> props;
700 xbt_dict_cursor_t cursor = nullptr;
703 xbt_dict_foreach (properties, cursor, key, value)
705 xbt_dict_free(&properties);
707 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
708 smx_actor_t actor = nullptr;
710 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
711 } catch (simgrid::HostFailureException const&) {
712 xbt_die("Could not attach");
715 simgrid::s4u::this_actor::yield();
716 return actor->ciface();
719 void sg_actor_detach()
721 simgrid::kernel::actor::ActorImpl::detach();