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();
43 ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
45 smx_actor_t self = SIMIX_process_self();
47 simgrid::kernel::actor::ActorImpl* actor =
48 simgrid::simix::simcall([self, name, host, code] { return self->init(std::move(name), host)->start(code); });
50 return actor->ciface();
53 ActorPtr Actor::create(std::string name, s4u::Host* host, const std::string& function, std::vector<std::string> args)
55 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
56 return create(std::move(name), host, factory(std::move(args)));
59 void intrusive_ptr_add_ref(Actor* actor)
61 intrusive_ptr_add_ref(actor->pimpl_);
63 void intrusive_ptr_release(Actor* actor)
65 intrusive_ptr_release(actor->pimpl_);
68 // ***** Actor methods *****
72 simcall_process_join(this->pimpl_, -1);
75 void Actor::join(double timeout)
77 simcall_process_join(this->pimpl_, timeout);
80 void Actor::set_auto_restart(bool autorestart)
82 simgrid::simix::simcall([this, autorestart]() {
83 xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
84 pimpl_->set_auto_restart(autorestart);
86 simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
87 XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
88 pimpl_->get_host()->pimpl_->actors_at_boot_.emplace_back(arg);
92 void Actor::on_exit(int_f_pvoid_pvoid_t fun,
93 void* data) /* deprecated: cleanup SIMIX_process_on_exit: change prototype of second parameter and
94 remove the last one */
96 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
99 void Actor::on_exit(std::function<void(bool /*failed*/)> const fun)
101 simgrid::simix::simcall(
102 [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* /*data*/) { fun(a != 0); }, nullptr); });
105 void Actor::migrate(Host* new_host)
107 s4u::Actor::on_migration_start(this);
109 simgrid::simix::simcall([this, new_host]() {
110 if (pimpl_->waiting_synchro != nullptr) {
111 // The actor is blocked on an activity. If it's an exec, migrate it too.
112 // FIXME: implement the migration of other kind of activities
113 simgrid::kernel::activity::ExecImplPtr exec =
114 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
115 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
116 exec->migrate(new_host);
118 this->pimpl_->set_host(new_host);
121 s4u::Actor::on_migration_end(this);
124 s4u::Host* Actor::get_host()
126 return this->pimpl_->get_host();
129 void Actor::daemonize()
131 simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
134 bool Actor::is_daemon() const
136 return this->pimpl_->is_daemon();
139 const simgrid::xbt::string& Actor::get_name() const
141 return this->pimpl_->get_name();
144 const char* Actor::get_cname() const
146 return this->pimpl_->get_cname();
149 aid_t Actor::get_pid() const
151 return this->pimpl_->get_pid();
154 aid_t Actor::get_ppid() const
156 return this->pimpl_->get_ppid();
159 void Actor::suspend()
161 s4u::Actor::on_suspend(this);
162 simcall_process_suspend(pimpl_);
167 simgrid::simix::simcall([this] { pimpl_->resume(); });
168 s4u::Actor::on_resume(this);
171 bool Actor::is_suspended()
173 return simgrid::simix::simcall([this] { return pimpl_->is_suspended(); });
176 void Actor::set_kill_time(double kill_time)
178 simgrid::simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
181 /** @brief Get the kill time of an actor(or 0 if unset). */
182 double Actor::get_kill_time()
184 return pimpl_->get_kill_time();
187 void Actor::kill(aid_t pid) // deprecated
189 smx_actor_t killer = SIMIX_process_self();
190 smx_actor_t victim = SIMIX_process_from_PID(pid);
191 if (victim != nullptr) {
192 simgrid::simix::simcall([killer, victim] { killer->kill(victim); });
194 std::ostringstream oss;
195 oss << "kill: (" << pid << ") - No such actor" << std::endl;
196 throw std::runtime_error(oss.str());
202 smx_actor_t process = SIMIX_process_self();
203 simgrid::simix::simcall([this, process] {
204 if (pimpl_ == simix_global->maestro_process)
207 process->kill(pimpl_);
211 smx_actor_t Actor::get_impl()
216 // ***** Static functions *****
218 ActorPtr Actor::by_pid(aid_t pid)
220 smx_actor_t process = SIMIX_process_from_PID(pid);
221 if (process != nullptr)
222 return process->iface();
227 void Actor::kill_all()
229 smx_actor_t self = SIMIX_process_self();
230 simgrid::simix::simcall([self] { self->kill_all(); });
233 std::unordered_map<std::string, std::string>* Actor::get_properties()
235 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
238 /** Retrieve the property value (or nullptr if not set) */
239 const char* Actor::get_property(const std::string& key)
241 return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
244 void Actor::set_property(const std::string& key, std::string value)
246 simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, std::move(value)); });
249 Actor* Actor::restart()
251 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
254 // ***** this_actor *****
256 namespace this_actor {
258 /** Returns true if run from the kernel mode, and false if run from a real actor
260 * Everything that is run out of any actor (simulation setup before the engine is run,
261 * computing the model evolutions as a result to the actors' action, etc) is run in
262 * kernel mode, just as in any operating systems.
264 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
265 * because it is the one scheduling when the others should move or wait.
269 smx_actor_t process = SIMIX_process_self();
270 return process == nullptr || process == simix_global->maestro_process;
273 void sleep_for(double duration)
276 smx_actor_t actor = SIMIX_process_self();
277 simgrid::s4u::Actor::on_sleep(actor->iface());
279 simcall_process_sleep(duration);
281 simgrid::s4u::Actor::on_wake_up(actor->iface());
287 simgrid::simix::simcall([] { /* do nothing*/ });
290 XBT_PUBLIC void sleep_until(double timeout)
292 double now = SIMIX_get_clock();
294 sleep_for(timeout - now);
297 void execute(double flops)
299 execute(flops, 1.0 /* priority */);
302 void execute(double flops, double priority)
304 exec_init(flops)->set_priority(priority)->start()->wait();
307 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
308 const std::vector<double>& bytes_amounts)
310 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
313 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
314 const std::vector<double>& bytes_amounts, double timeout)
316 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
317 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
318 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
319 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
320 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
321 hosts.size(), hosts.size(), flops_amounts.size());
322 /* Check that we are not mixing VMs and PMs in the parallel task */
323 bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(hosts.front()));
324 xbt_assert(std::all_of(hosts.begin(), hosts.end(),
325 [is_a_vm](s4u::Host* elm) {
326 bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(elm));
327 return is_a_vm == tmp_is_a_vm;
329 "parallel_execute: mixing VMs and PMs is not supported (yet).");
330 /* checking for infinite values */
331 xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
332 "flops_amounts comprises infinite values!");
333 xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
334 "flops_amounts comprises infinite values!");
336 exec_init(hosts, flops_amounts, bytes_amounts)->set_timeout(timeout)->wait();
340 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
344 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
345 simcall_execution_wait(s);
346 delete[] flops_amount;
347 delete[] bytes_amount;
351 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
353 smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
354 /* rate */ -1, /*timeout*/ -1);
355 simcall_execution_wait(s);
356 delete[] flops_amount;
357 delete[] bytes_amount;
360 ExecPtr exec_init(double flops_amount)
362 return ExecPtr(new ExecSeq(get_host(), flops_amount));
365 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
366 const std::vector<double>& bytes_amounts)
368 return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
371 ExecPtr exec_async(double flops)
373 ExecPtr res = exec_init(flops);
380 return SIMIX_process_self()->get_pid();
385 return SIMIX_process_self()->get_ppid();
388 std::string get_name()
390 return SIMIX_process_self()->get_name();
393 const char* get_cname()
395 return SIMIX_process_self()->get_cname();
400 return SIMIX_process_self()->get_host();
405 smx_actor_t actor = SIMIX_process_self();
406 simgrid::s4u::Actor::on_suspend(actor->iface());
408 simcall_process_suspend(actor);
413 smx_actor_t process = SIMIX_process_self();
414 simgrid::simix::simcall([process] { process->resume(); });
415 simgrid::s4u::Actor::on_resume(process->iface());
420 smx_actor_t actor = SIMIX_process_self();
421 simgrid::simix::simcall([actor] { actor->exit(); });
424 void on_exit(std::function<void(bool)> const fun)
426 SIMIX_process_self()->iface()->on_exit(fun);
429 void on_exit(std::function<void(int, void*)> const fun, void* data) /* deprecated */
431 SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
434 /** @brief Moves the current actor to another host
436 * @see simgrid::s4u::Actor::migrate() for more information
438 void migrate(Host* new_host)
440 SIMIX_process_self()->iface()->migrate(new_host);
443 std::string getName() /* deprecated */
447 const char* getCname() /* deprecated */
451 bool isMaestro() /* deprecated */
455 aid_t getPid() /* deprecated */
459 aid_t getPpid() /* deprecated */
463 Host* getHost() /* deprecated */
467 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
469 SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
471 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
473 on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
475 void kill() /* deprecated */
480 } // namespace this_actor
482 } // namespace simgrid
484 /* **************************** Public C interface *************************** */
486 /** @ingroup m_actor_management
487 * @brief Returns the process ID of @a actor.
489 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
491 aid_t sg_actor_get_PID(sg_actor_t actor)
493 /* Do not raise an exception here: this function is called by the logs
494 * and the exceptions, so it would be called back again and again */
495 if (actor == nullptr || actor->get_impl() == nullptr)
497 return actor->get_pid();
500 /** @ingroup m_actor_management
501 * @brief Returns the process ID of the parent of @a actor.
503 * This function checks whether @a actor is a valid pointer and return its parent's PID.
504 * Returns -1 if the actor has not been created by any other actor.
506 aid_t sg_actor_get_PPID(sg_actor_t actor)
508 return actor->get_ppid();
511 /** @ingroup m_actor_management
513 * @brief Return a #sg_actor_t given its PID.
515 * 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.
516 * If none is found, @c nullptr is returned.
517 Note that the PID are unique in the whole simulation, not only on a given host.
519 sg_actor_t sg_actor_by_PID(aid_t pid)
521 return simgrid::s4u::Actor::by_pid(pid).get();
524 /** @ingroup m_actor_management
525 * @brief Return the name of an actor.
527 const char* sg_actor_get_name(sg_actor_t actor)
529 return actor->get_cname();
532 sg_host_t sg_actor_get_host(sg_actor_t actor)
534 return actor->get_host();
537 /** @ingroup m_actor_management
538 * @brief Returns the value of a given actor property
540 * @param actor an actor
541 * @param name a property name
542 * @return value of a property (or nullptr if the property is not set)
544 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
546 return actor->get_property(name);
549 /** @ingroup m_actor_management
550 * @brief Return the list of properties
552 * This function returns all the parameters associated with an actor
554 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
556 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
557 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
558 std::unordered_map<std::string, std::string>* props = actor->get_properties();
559 if (props == nullptr)
561 for (auto const& kv : *props) {
562 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
567 /** @ingroup m_actor_management
568 * @brief Suspend the actor.
570 * This function suspends the actor by suspending the task on which it was waiting for the completion.
572 void sg_actor_suspend(sg_actor_t actor)
574 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
578 /** @ingroup m_actor_management
579 * @brief Resume a suspended actor.
581 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
583 void sg_actor_resume(sg_actor_t actor)
585 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
589 /** @ingroup m_actor_management
590 * @brief Returns true if the actor is suspended .
592 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
594 int sg_actor_is_suspended(sg_actor_t actor)
596 return actor->is_suspended();
600 * @ingroup m_actor_management
601 * @brief Restarts an actor from the beginning.
603 sg_actor_t sg_actor_restart(sg_actor_t actor)
605 return actor->restart();
609 * @ingroup m_actor_management
610 * @brief Sets the "auto-restart" flag of the actor.
611 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
613 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
615 actor->set_auto_restart(auto_restart);
618 /** @ingroup m_actor_management
619 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
621 void sg_actor_daemonize(sg_actor_t actor)
626 /** @ingroup m_actor_management
627 * @brief Migrates an actor to another location.
629 * This function changes the value of the #sg_host_t on which @a actor is running.
631 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
633 process->migrate(host);
636 /** @ingroup m_actor_management
637 * @brief Wait for the completion of a #sg_actor_t.
639 * @param actor the actor to wait for
640 * @param timeout wait until the actor is over, or the timeout expires
642 void sg_actor_join(sg_actor_t actor, double timeout)
644 actor->join(timeout);
647 void sg_actor_kill(sg_actor_t actor)
652 void sg_actor_kill_all()
654 simgrid::s4u::Actor::kill_all();
657 /** @ingroup m_actor_management
658 * @brief Set the kill time of an actor.
660 * @param actor an actor
661 * @param kill_time the time when the actor is killed.
663 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
665 actor->set_kill_time(kill_time);
668 /** Yield the current actor; let the other actors execute first */
669 void sg_actor_yield()
671 simgrid::s4u::this_actor::yield();
674 void sg_actor_sleep_for(double duration)
676 simgrid::s4u::this_actor::sleep_for(duration);
679 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
681 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
682 std::unordered_map<std::string, std::string> props;
683 xbt_dict_cursor_t cursor = nullptr;
686 xbt_dict_foreach (properties, cursor, key, value)
688 xbt_dict_free(&properties);
690 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
691 smx_actor_t actor = nullptr;
693 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
694 } catch (simgrid::HostFailureException const&) {
695 xbt_die("Could not attach");
698 simgrid::s4u::this_actor::yield();
699 return actor->ciface();
702 void sg_actor_detach()
704 simgrid::kernel::actor::ActorImpl::detach();