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 simgrid::kernel::actor::ActorImpl* actor =
46 simgrid::simix::simcall([self, &name, host] { return self->init(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(const std::string& name, s4u::Host* host, const std::function<void()>& code)
58 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, code, nullptr, host, nullptr);
60 return actor->iface();
63 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function,
64 std::vector<std::string> args)
66 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
67 return create(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(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
112 on_exit([fun, data](bool exit) { fun(exit, data); });
115 void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun)
117 simgrid::simix::simcall(
118 [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* /*data*/) { fun(a != 0); }, nullptr); });
121 void Actor::migrate(Host* new_host)
123 s4u::Actor::on_migration_start(this);
125 simgrid::simix::simcall([this, new_host]() {
126 if (pimpl_->waiting_synchro != nullptr) {
127 // The actor is blocked on an activity. If it's an exec, migrate it too.
128 // FIXME: implement the migration of other kind of activities
129 simgrid::kernel::activity::ExecImplPtr exec =
130 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
131 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
132 exec->migrate(new_host);
134 this->pimpl_->set_host(new_host);
137 s4u::Actor::on_migration_end(this);
140 s4u::Host* Actor::get_host()
142 return this->pimpl_->get_host();
145 void Actor::daemonize()
147 simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
150 bool Actor::is_daemon() const
152 return this->pimpl_->is_daemon();
155 const simgrid::xbt::string& Actor::get_name() const
157 return this->pimpl_->get_name();
160 const char* Actor::get_cname() const
162 return this->pimpl_->get_cname();
165 aid_t Actor::get_pid() const
167 return this->pimpl_->get_pid();
170 aid_t Actor::get_ppid() const
172 return this->pimpl_->get_ppid();
175 void Actor::suspend()
177 s4u::Actor::on_suspend(this);
178 simcall_process_suspend(pimpl_);
183 simgrid::simix::simcall([this] { pimpl_->resume(); });
184 s4u::Actor::on_resume(this);
187 bool Actor::is_suspended()
189 return simgrid::simix::simcall([this] { return pimpl_->is_suspended(); });
192 void Actor::set_kill_time(double kill_time)
194 simgrid::simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
197 /** @brief Get the kill time of an actor(or 0 if unset). */
198 double Actor::get_kill_time()
200 return pimpl_->get_kill_time();
203 void Actor::kill(aid_t pid) // deprecated
205 smx_actor_t killer = SIMIX_process_self();
206 smx_actor_t victim = SIMIX_process_from_PID(pid);
207 if (victim != nullptr) {
208 simgrid::simix::simcall([killer, victim] { killer->kill(victim); });
210 std::ostringstream oss;
211 oss << "kill: (" << pid << ") - No such actor" << std::endl;
212 throw std::runtime_error(oss.str());
218 smx_actor_t process = SIMIX_process_self();
219 simgrid::simix::simcall([this, process] {
220 if (pimpl_ == simix_global->maestro_process)
223 process->kill(pimpl_);
227 smx_actor_t Actor::get_impl()
232 // ***** Static functions *****
234 ActorPtr Actor::by_pid(aid_t pid)
236 smx_actor_t process = SIMIX_process_from_PID(pid);
237 if (process != nullptr)
238 return process->iface();
243 void Actor::kill_all()
245 smx_actor_t self = SIMIX_process_self();
246 simgrid::simix::simcall([self] { self->kill_all(); });
249 std::unordered_map<std::string, std::string>* Actor::get_properties()
251 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
254 /** Retrieve the property value (or nullptr if not set) */
255 const char* Actor::get_property(const std::string& key)
257 return simgrid::simix::simcall([this, &key] { return pimpl_->get_property(key); });
260 void Actor::set_property(const std::string& key, const std::string& value)
262 simgrid::simix::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
265 Actor* Actor::restart()
267 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
270 // ***** this_actor *****
272 namespace this_actor {
274 /** Returns true if run from the kernel mode, and false if run from a real actor
276 * Everything that is run out of any actor (simulation setup before the engine is run,
277 * computing the model evolutions as a result to the actors' action, etc) is run in
278 * kernel mode, just as in any operating systems.
280 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
281 * because it is the one scheduling when the others should move or wait.
285 smx_actor_t process = SIMIX_process_self();
286 return process == nullptr || process == simix_global->maestro_process;
289 void sleep_for(double duration)
292 smx_actor_t actor = SIMIX_process_self();
293 simgrid::s4u::Actor::on_sleep(actor->iface());
295 simcall_process_sleep(duration);
297 simgrid::s4u::Actor::on_wake_up(actor->iface());
303 simgrid::simix::simcall([] { /* do nothing*/ });
306 XBT_PUBLIC void sleep_until(double timeout)
308 double now = SIMIX_get_clock();
310 sleep_for(timeout - now);
313 void execute(double flops)
315 execute(flops, 1.0 /* priority */);
318 void execute(double flops, double priority)
320 exec_init(flops)->set_priority(priority)->start()->wait();
323 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
324 const std::vector<double>& bytes_amounts)
326 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
329 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
330 const std::vector<double>& bytes_amounts, double timeout)
332 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
333 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
334 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
335 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
336 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
337 hosts.size(), hosts.size(), flops_amounts.size());
338 /* Check that we are not mixing VMs and PMs in the parallel task */
339 bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(hosts.front()));
340 xbt_assert(std::all_of(hosts.begin(), hosts.end(),
341 [is_a_vm](s4u::Host* elm) {
342 bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(elm));
343 return is_a_vm == tmp_is_a_vm;
345 "parallel_execute: mixing VMs and PMs is not supported (yet).");
346 /* checking for infinite values */
347 xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
348 "flops_amounts comprises infinite values!");
349 xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
350 "flops_amounts comprises infinite values!");
352 exec_init(hosts, flops_amounts, bytes_amounts)->set_timeout(timeout)->wait();
356 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
360 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
361 simcall_execution_wait(s);
362 delete[] flops_amount;
363 delete[] bytes_amount;
367 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
369 smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
370 /* rate */ -1, /*timeout*/ -1);
371 simcall_execution_wait(s);
372 delete[] flops_amount;
373 delete[] bytes_amount;
376 ExecPtr exec_init(double flops_amount)
378 return ExecPtr(new ExecSeq(get_host(), flops_amount));
381 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
382 const std::vector<double>& bytes_amounts)
384 return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
387 ExecPtr exec_async(double flops)
389 ExecPtr res = exec_init(flops);
396 return SIMIX_process_self()->get_pid();
401 return SIMIX_process_self()->get_ppid();
404 std::string get_name()
406 return SIMIX_process_self()->get_name();
409 const char* get_cname()
411 return SIMIX_process_self()->get_cname();
416 return SIMIX_process_self()->get_host();
421 smx_actor_t actor = SIMIX_process_self();
422 simgrid::s4u::Actor::on_suspend(actor->iface());
424 simcall_process_suspend(actor);
429 smx_actor_t process = SIMIX_process_self();
430 simgrid::simix::simcall([process] { process->resume(); });
431 simgrid::s4u::Actor::on_resume(process->iface());
436 smx_actor_t actor = SIMIX_process_self();
437 simgrid::simix::simcall([actor] { actor->exit(); });
440 void on_exit(const std::function<void(bool)>& fun)
442 SIMIX_process_self()->iface()->on_exit(fun);
445 void on_exit(const std::function<void(int, void*)>& fun, void* data) /* deprecated */
447 SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
450 /** @brief Moves the current actor to another host
452 * @see simgrid::s4u::Actor::migrate() for more information
454 void migrate(Host* new_host)
456 SIMIX_process_self()->iface()->migrate(new_host);
459 std::string getName() /* deprecated */
463 const char* getCname() /* deprecated */
467 bool isMaestro() /* deprecated */
471 aid_t getPid() /* deprecated */
475 aid_t getPpid() /* deprecated */
479 Host* getHost() /* deprecated */
483 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
485 SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
487 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
489 on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
491 void kill() /* deprecated */
496 } // namespace this_actor
498 } // namespace simgrid
500 /* **************************** Public C interface *************************** */
502 /** @ingroup m_actor_management
503 * @brief Returns the process ID of @a actor.
505 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
507 aid_t sg_actor_get_PID(sg_actor_t actor)
509 /* Do not raise an exception here: this function is called by the logs
510 * and the exceptions, so it would be called back again and again */
511 if (actor == nullptr || actor->get_impl() == nullptr)
513 return actor->get_pid();
516 /** @ingroup m_actor_management
517 * @brief Returns the process ID of the parent of @a actor.
519 * This function checks whether @a actor is a valid pointer and return its parent's PID.
520 * Returns -1 if the actor has not been created by any other actor.
522 aid_t sg_actor_get_PPID(sg_actor_t actor)
524 return actor->get_ppid();
527 /** @ingroup m_actor_management
529 * @brief Return a #sg_actor_t given its PID.
531 * 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.
532 * If none is found, @c nullptr is returned.
533 Note that the PID are unique in the whole simulation, not only on a given host.
535 sg_actor_t sg_actor_by_PID(aid_t pid)
537 return simgrid::s4u::Actor::by_pid(pid).get();
540 /** @ingroup m_actor_management
541 * @brief Return the name of an actor.
543 const char* sg_actor_get_name(sg_actor_t actor)
545 return actor->get_cname();
548 sg_host_t sg_actor_get_host(sg_actor_t actor)
550 return actor->get_host();
553 /** @ingroup m_actor_management
554 * @brief Returns the value of a given actor property
556 * @param actor an actor
557 * @param name a property name
558 * @return value of a property (or nullptr if the property is not set)
560 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
562 return actor->get_property(name);
565 /** @ingroup m_actor_management
566 * @brief Return the list of properties
568 * This function returns all the parameters associated with an actor
570 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
572 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
573 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
574 std::unordered_map<std::string, std::string>* props = actor->get_properties();
575 if (props == nullptr)
577 for (auto const& kv : *props) {
578 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
583 /** @ingroup m_actor_management
584 * @brief Suspend the actor.
586 * This function suspends the actor by suspending the task on which it was waiting for the completion.
588 void sg_actor_suspend(sg_actor_t actor)
590 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
594 /** @ingroup m_actor_management
595 * @brief Resume a suspended actor.
597 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
599 void sg_actor_resume(sg_actor_t actor)
601 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
605 /** @ingroup m_actor_management
606 * @brief Returns true if the actor is suspended .
608 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
610 int sg_actor_is_suspended(sg_actor_t actor)
612 return actor->is_suspended();
616 * @ingroup m_actor_management
617 * @brief Restarts an actor from the beginning.
619 sg_actor_t sg_actor_restart(sg_actor_t actor)
621 return actor->restart();
625 * @ingroup m_actor_management
626 * @brief Sets the "auto-restart" flag of the actor.
627 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
629 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
631 actor->set_auto_restart(auto_restart);
634 /** @ingroup m_actor_management
635 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
637 void sg_actor_daemonize(sg_actor_t actor)
642 /** @ingroup m_actor_management
643 * @brief Migrates an actor to another location.
645 * This function changes the value of the #sg_host_t on which @a actor is running.
647 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
649 process->migrate(host);
652 /** @ingroup m_actor_management
653 * @brief Wait for the completion of a #sg_actor_t.
655 * @param actor the actor to wait for
656 * @param timeout wait until the actor is over, or the timeout expires
658 void sg_actor_join(sg_actor_t actor, double timeout)
660 actor->join(timeout);
663 void sg_actor_kill(sg_actor_t actor)
668 void sg_actor_kill_all()
670 simgrid::s4u::Actor::kill_all();
673 /** @ingroup m_actor_management
674 * @brief Set the kill time of an actor.
676 * @param actor an actor
677 * @param kill_time the time when the actor is killed.
679 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
681 actor->set_kill_time(kill_time);
684 /** Yield the current actor; let the other actors execute first */
685 void sg_actor_yield()
687 simgrid::s4u::this_actor::yield();
690 void sg_actor_sleep_for(double duration)
692 simgrid::s4u::this_actor::sleep_for(duration);
695 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
697 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
698 std::unordered_map<std::string, std::string> props;
699 xbt_dict_cursor_t cursor = nullptr;
702 xbt_dict_foreach (properties, cursor, key, value)
704 xbt_dict_free(&properties);
706 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
707 smx_actor_t actor = nullptr;
709 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
710 } catch (simgrid::HostFailureException const&) {
711 xbt_die("Could not attach");
714 simgrid::s4u::this_actor::yield();
715 return actor->ciface();
718 void sg_actor_detach()
720 simgrid::kernel::actor::ActorImpl::detach();