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(std::function<void()> code)
52 simgrid::simix::simcall([this, code] { pimpl_->start(code); });
56 ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
58 simgrid::kernel::actor::ActorImpl* actor =
59 simcall_process_create(std::move(name), std::move(code), nullptr, host, nullptr);
61 return actor->iface();
64 ActorPtr Actor::create(std::string name, s4u::Host* host, const std::string& function, std::vector<std::string> args)
66 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
67 return create(std::move(name), host, factory(std::move(args)));
70 void intrusive_ptr_add_ref(Actor* actor)
72 intrusive_ptr_add_ref(actor->pimpl_);
74 void intrusive_ptr_release(Actor* actor)
76 intrusive_ptr_release(actor->pimpl_);
79 // ***** Actor methods *****
83 simcall_process_join(this->pimpl_, -1);
86 void Actor::join(double timeout)
88 simcall_process_join(this->pimpl_, timeout);
91 void Actor::set_auto_restart(bool autorestart)
93 simgrid::simix::simcall([this, autorestart]() {
94 xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
95 pimpl_->set_auto_restart(autorestart);
97 simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
98 XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
99 pimpl_->get_host()->pimpl_->actors_at_boot_.emplace_back(arg);
103 void Actor::on_exit(int_f_pvoid_pvoid_t fun,
104 void* data) /* deprecated: cleanup SIMIX_process_on_exit: change prototype of second parameter and
105 remove the last one */
107 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
110 void Actor::on_exit(std::function<void(bool /*failed*/)> const fun)
112 simgrid::simix::simcall(
113 [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* /*data*/) { fun(a != 0); }, nullptr); });
116 void Actor::migrate(Host* new_host)
118 s4u::Actor::on_migration_start(this);
120 simgrid::simix::simcall([this, new_host]() {
121 if (pimpl_->waiting_synchro != nullptr) {
122 // The actor is blocked on an activity. If it's an exec, migrate it too.
123 // FIXME: implement the migration of other kind of activities
124 simgrid::kernel::activity::ExecImplPtr exec =
125 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
126 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
127 exec->migrate(new_host);
129 this->pimpl_->set_host(new_host);
132 s4u::Actor::on_migration_end(this);
135 s4u::Host* Actor::get_host()
137 return this->pimpl_->get_host();
140 void Actor::daemonize()
142 simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
145 bool Actor::is_daemon() const
147 return this->pimpl_->is_daemon();
150 const simgrid::xbt::string& Actor::get_name() const
152 return this->pimpl_->get_name();
155 const char* Actor::get_cname() const
157 return this->pimpl_->get_cname();
160 aid_t Actor::get_pid() const
162 return this->pimpl_->get_pid();
165 aid_t Actor::get_ppid() const
167 return this->pimpl_->get_ppid();
170 void Actor::suspend()
172 s4u::Actor::on_suspend(this);
173 simcall_process_suspend(pimpl_);
178 simgrid::simix::simcall([this] { pimpl_->resume(); });
179 s4u::Actor::on_resume(this);
182 bool Actor::is_suspended()
184 return simgrid::simix::simcall([this] { return pimpl_->is_suspended(); });
187 void Actor::set_kill_time(double kill_time)
189 simgrid::simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
192 /** @brief Get the kill time of an actor(or 0 if unset). */
193 double Actor::get_kill_time()
195 return pimpl_->get_kill_time();
198 void Actor::kill(aid_t pid) // deprecated
200 smx_actor_t killer = SIMIX_process_self();
201 smx_actor_t victim = SIMIX_process_from_PID(pid);
202 if (victim != nullptr) {
203 simgrid::simix::simcall([killer, victim] { killer->kill(victim); });
205 std::ostringstream oss;
206 oss << "kill: (" << pid << ") - No such actor" << std::endl;
207 throw std::runtime_error(oss.str());
213 smx_actor_t process = SIMIX_process_self();
214 simgrid::simix::simcall([this, process] {
215 if (pimpl_ == simix_global->maestro_process)
218 process->kill(pimpl_);
222 smx_actor_t Actor::get_impl()
227 // ***** Static functions *****
229 ActorPtr Actor::by_pid(aid_t pid)
231 smx_actor_t process = SIMIX_process_from_PID(pid);
232 if (process != nullptr)
233 return process->iface();
238 void Actor::kill_all()
240 smx_actor_t self = SIMIX_process_self();
241 simgrid::simix::simcall([self] { self->kill_all(); });
244 std::unordered_map<std::string, std::string>* Actor::get_properties()
246 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
249 /** Retrieve the property value (or nullptr if not set) */
250 const char* Actor::get_property(const std::string& key)
252 return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
255 void Actor::set_property(const std::string& key, std::string value)
257 simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, std::move(value)); });
260 Actor* Actor::restart()
262 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
265 // ***** this_actor *****
267 namespace this_actor {
269 /** Returns true if run from the kernel mode, and false if run from a real actor
271 * Everything that is run out of any actor (simulation setup before the engine is run,
272 * computing the model evolutions as a result to the actors' action, etc) is run in
273 * kernel mode, just as in any operating systems.
275 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
276 * because it is the one scheduling when the others should move or wait.
280 smx_actor_t process = SIMIX_process_self();
281 return process == nullptr || process == simix_global->maestro_process;
284 void sleep_for(double duration)
287 smx_actor_t actor = SIMIX_process_self();
288 simgrid::s4u::Actor::on_sleep(actor->iface());
290 simcall_process_sleep(duration);
292 simgrid::s4u::Actor::on_wake_up(actor->iface());
298 simgrid::simix::simcall([] { /* do nothing*/ });
301 XBT_PUBLIC void sleep_until(double timeout)
303 double now = SIMIX_get_clock();
305 sleep_for(timeout - now);
308 void execute(double flops)
310 execute(flops, 1.0 /* priority */);
313 void execute(double flops, double priority)
315 exec_init(flops)->set_priority(priority)->start()->wait();
318 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
319 const std::vector<double>& bytes_amounts)
321 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
324 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
325 const std::vector<double>& bytes_amounts, double timeout)
327 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
328 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
329 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
330 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
331 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
332 hosts.size(), hosts.size(), flops_amounts.size());
333 /* Check that we are not mixing VMs and PMs in the parallel task */
334 bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(hosts.front()));
335 xbt_assert(std::all_of(hosts.begin(), hosts.end(),
336 [is_a_vm](s4u::Host* elm) {
337 bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(elm));
338 return is_a_vm == tmp_is_a_vm;
340 "parallel_execute: mixing VMs and PMs is not supported (yet).");
341 /* checking for infinite values */
342 xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
343 "flops_amounts comprises infinite values!");
344 xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
345 "flops_amounts comprises infinite values!");
347 exec_init(hosts, flops_amounts, bytes_amounts)->set_timeout(timeout)->wait();
351 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
355 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
356 simcall_execution_wait(s);
357 delete[] flops_amount;
358 delete[] bytes_amount;
362 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
364 smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
365 /* rate */ -1, /*timeout*/ -1);
366 simcall_execution_wait(s);
367 delete[] flops_amount;
368 delete[] bytes_amount;
371 ExecPtr exec_init(double flops_amount)
373 return ExecPtr(new ExecSeq(get_host(), flops_amount));
376 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
377 const std::vector<double>& bytes_amounts)
379 return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
382 ExecPtr exec_async(double flops)
384 ExecPtr res = exec_init(flops);
391 return SIMIX_process_self()->get_pid();
396 return SIMIX_process_self()->get_ppid();
399 std::string get_name()
401 return SIMIX_process_self()->get_name();
404 const char* get_cname()
406 return SIMIX_process_self()->get_cname();
411 return SIMIX_process_self()->get_host();
416 smx_actor_t actor = SIMIX_process_self();
417 simgrid::s4u::Actor::on_suspend(actor->iface());
419 simcall_process_suspend(actor);
424 smx_actor_t process = SIMIX_process_self();
425 simgrid::simix::simcall([process] { process->resume(); });
426 simgrid::s4u::Actor::on_resume(process->iface());
431 smx_actor_t actor = SIMIX_process_self();
432 simgrid::simix::simcall([actor] { actor->exit(); });
435 void on_exit(std::function<void(bool)> const fun)
437 SIMIX_process_self()->iface()->on_exit(fun);
440 void on_exit(std::function<void(int, void*)> const fun, void* data) /* deprecated */
442 SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
445 /** @brief Moves the current actor to another host
447 * @see simgrid::s4u::Actor::migrate() for more information
449 void migrate(Host* new_host)
451 SIMIX_process_self()->iface()->migrate(new_host);
454 std::string getName() /* deprecated */
458 const char* getCname() /* deprecated */
462 bool isMaestro() /* deprecated */
466 aid_t getPid() /* deprecated */
470 aid_t getPpid() /* deprecated */
474 Host* getHost() /* deprecated */
478 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
480 SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
482 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
484 on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
486 void kill() /* deprecated */
491 } // namespace this_actor
493 } // namespace simgrid
495 /* **************************** Public C interface *************************** */
497 /** @ingroup m_actor_management
498 * @brief Returns the process ID of @a actor.
500 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
502 aid_t sg_actor_get_PID(sg_actor_t actor)
504 /* Do not raise an exception here: this function is called by the logs
505 * and the exceptions, so it would be called back again and again */
506 if (actor == nullptr || actor->get_impl() == nullptr)
508 return actor->get_pid();
511 /** @ingroup m_actor_management
512 * @brief Returns the process ID of the parent of @a actor.
514 * This function checks whether @a actor is a valid pointer and return its parent's PID.
515 * Returns -1 if the actor has not been created by any other actor.
517 aid_t sg_actor_get_PPID(sg_actor_t actor)
519 return actor->get_ppid();
522 /** @ingroup m_actor_management
524 * @brief Return a #sg_actor_t given its PID.
526 * 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.
527 * If none is found, @c nullptr is returned.
528 Note that the PID are unique in the whole simulation, not only on a given host.
530 sg_actor_t sg_actor_by_PID(aid_t pid)
532 return simgrid::s4u::Actor::by_pid(pid).get();
535 /** @ingroup m_actor_management
536 * @brief Return the name of an actor.
538 const char* sg_actor_get_name(sg_actor_t actor)
540 return actor->get_cname();
543 sg_host_t sg_actor_get_host(sg_actor_t actor)
545 return actor->get_host();
548 /** @ingroup m_actor_management
549 * @brief Returns the value of a given actor property
551 * @param actor an actor
552 * @param name a property name
553 * @return value of a property (or nullptr if the property is not set)
555 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
557 return actor->get_property(name);
560 /** @ingroup m_actor_management
561 * @brief Return the list of properties
563 * This function returns all the parameters associated with an actor
565 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
567 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
568 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
569 std::unordered_map<std::string, std::string>* props = actor->get_properties();
570 if (props == nullptr)
572 for (auto const& kv : *props) {
573 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
578 /** @ingroup m_actor_management
579 * @brief Suspend the actor.
581 * This function suspends the actor by suspending the task on which it was waiting for the completion.
583 void sg_actor_suspend(sg_actor_t actor)
585 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
589 /** @ingroup m_actor_management
590 * @brief Resume a suspended actor.
592 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
594 void sg_actor_resume(sg_actor_t actor)
596 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
600 /** @ingroup m_actor_management
601 * @brief Returns true if the actor is suspended .
603 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
605 int sg_actor_is_suspended(sg_actor_t actor)
607 return actor->is_suspended();
611 * @ingroup m_actor_management
612 * @brief Restarts an actor from the beginning.
614 sg_actor_t sg_actor_restart(sg_actor_t actor)
616 return actor->restart();
620 * @ingroup m_actor_management
621 * @brief Sets the "auto-restart" flag of the actor.
622 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
624 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
626 actor->set_auto_restart(auto_restart);
629 /** @ingroup m_actor_management
630 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
632 void sg_actor_daemonize(sg_actor_t actor)
637 /** @ingroup m_actor_management
638 * @brief Migrates an actor to another location.
640 * This function changes the value of the #sg_host_t on which @a actor is running.
642 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
644 process->migrate(host);
647 /** @ingroup m_actor_management
648 * @brief Wait for the completion of a #sg_actor_t.
650 * @param actor the actor to wait for
651 * @param timeout wait until the actor is over, or the timeout expires
653 void sg_actor_join(sg_actor_t actor, double timeout)
655 actor->join(timeout);
658 void sg_actor_kill(sg_actor_t actor)
663 void sg_actor_kill_all()
665 simgrid::s4u::Actor::kill_all();
668 /** @ingroup m_actor_management
669 * @brief Set the kill time of an actor.
671 * @param actor an actor
672 * @param kill_time the time when the actor is killed.
674 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
676 actor->set_kill_time(kill_time);
679 /** Yield the current actor; let the other actors execute first */
680 void sg_actor_yield()
682 simgrid::s4u::this_actor::yield();
685 void sg_actor_sleep_for(double duration)
687 simgrid::s4u::this_actor::sleep_for(duration);
690 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
692 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
693 std::unordered_map<std::string, std::string> props;
694 xbt_dict_cursor_t cursor = nullptr;
697 xbt_dict_foreach (properties, cursor, key, value)
699 xbt_dict_free(&properties);
701 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
702 smx_actor_t actor = nullptr;
704 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
705 } catch (simgrid::HostFailureException const&) {
706 xbt_die("Could not attach");
709 simgrid::s4u::this_actor::yield();
710 return actor->ciface();
713 void sg_actor_detach()
715 simgrid::kernel::actor::ActorImpl::detach();