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 "src/kernel/activity/ExecImpl.hpp"
12 #include "src/simix/smx_host_private.hpp"
13 #include "src/simix/smx_private.hpp"
14 #include "src/surf/HostImpl.hpp"
18 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
23 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
24 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_suspend;
25 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_resume;
26 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_sleep;
27 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_wake_up;
28 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_start;
29 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
30 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
32 // ***** Actor creation *****
33 ActorPtr Actor::self()
35 smx_context_t self_context = simgrid::kernel::context::Context::self();
36 if (self_context == nullptr)
37 return simgrid::s4u::ActorPtr();
39 return self_context->get_actor()->iface();
42 ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
44 simgrid::kernel::actor::ActorImpl* actor =
45 simcall_process_create(std::move(name), std::move(code), nullptr, host, nullptr);
46 return actor->iface();
49 ActorPtr Actor::create(std::string name, s4u::Host* host, const std::string& function, std::vector<std::string> args)
51 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
52 return create(std::move(name), host, factory(std::move(args)));
55 void intrusive_ptr_add_ref(Actor* actor)
57 intrusive_ptr_add_ref(actor->pimpl_);
59 void intrusive_ptr_release(Actor* actor)
61 intrusive_ptr_release(actor->pimpl_);
64 // ***** Actor methods *****
68 simcall_process_join(this->pimpl_, -1);
71 void Actor::join(double timeout)
73 simcall_process_join(this->pimpl_, timeout);
76 void Actor::set_auto_restart(bool autorestart)
78 simgrid::simix::simcall([this, autorestart]() {
79 xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
80 pimpl_->set_auto_restart(autorestart);
82 simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
83 XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
84 pimpl_->get_host()->pimpl_->actors_at_boot_.emplace_back(arg);
88 void Actor::on_exit(int_f_pvoid_pvoid_t fun,
89 void* data) /* deprecated: cleanup SIMIX_process_on_exit: change prototype of second parameter and
90 remove the last one */
92 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
95 void Actor::on_exit(std::function<void(bool /*failed*/)> const fun)
97 simgrid::simix::simcall(
98 [this, fun] { SIMIX_process_on_exit(pimpl_, [fun](int a, void* /*data*/) { fun(a != 0); }, nullptr); });
101 void Actor::migrate(Host* new_host)
103 s4u::Actor::on_migration_start(this);
105 simgrid::simix::simcall([this, new_host]() {
106 if (pimpl_->waiting_synchro != nullptr) {
107 // The actor is blocked on an activity. If it's an exec, migrate it too.
108 // FIXME: implement the migration of other kind of activities
109 simgrid::kernel::activity::ExecImplPtr exec =
110 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
111 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
112 exec->migrate(new_host);
114 this->pimpl_->set_host(new_host);
117 s4u::Actor::on_migration_end(this);
120 s4u::Host* Actor::get_host()
122 return this->pimpl_->get_host();
125 void Actor::daemonize()
127 simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
130 bool Actor::is_daemon() const
132 return this->pimpl_->is_daemon();
135 const simgrid::xbt::string& Actor::get_name() const
137 return this->pimpl_->get_name();
140 const char* Actor::get_cname() const
142 return this->pimpl_->get_cname();
145 aid_t Actor::get_pid() const
147 return this->pimpl_->get_pid();
150 aid_t Actor::get_ppid() const
152 return this->pimpl_->get_ppid();
155 void Actor::suspend()
157 s4u::Actor::on_suspend(this);
158 simcall_process_suspend(pimpl_);
163 simgrid::simix::simcall([this] { pimpl_->resume(); });
164 s4u::Actor::on_resume(this);
167 bool Actor::is_suspended()
169 return simgrid::simix::simcall([this] { return pimpl_->is_suspended(); });
172 void Actor::set_kill_time(double kill_time)
174 simgrid::simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
177 /** @brief Get the kill time of an actor(or 0 if unset). */
178 double Actor::get_kill_time()
180 return pimpl_->get_kill_time();
183 void Actor::kill(aid_t pid) // deprecated
185 smx_actor_t killer = SIMIX_process_self();
186 smx_actor_t victim = SIMIX_process_from_PID(pid);
187 if (victim != nullptr) {
188 simgrid::simix::simcall([killer, victim] { killer->kill(victim); });
190 std::ostringstream oss;
191 oss << "kill: (" << pid << ") - No such actor" << std::endl;
192 throw std::runtime_error(oss.str());
198 smx_actor_t process = SIMIX_process_self();
199 simgrid::simix::simcall([this, process] {
200 if (pimpl_ == simix_global->maestro_process)
203 process->kill(pimpl_);
207 smx_actor_t Actor::get_impl()
212 // ***** Static functions *****
214 ActorPtr Actor::by_pid(aid_t pid)
216 smx_actor_t process = SIMIX_process_from_PID(pid);
217 if (process != nullptr)
218 return process->iface();
223 void Actor::kill_all()
225 smx_actor_t self = SIMIX_process_self();
226 simgrid::simix::simcall([self] { self->kill_all(); });
229 std::unordered_map<std::string, std::string>* Actor::get_properties()
231 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
234 /** Retrieve the property value (or nullptr if not set) */
235 const char* Actor::get_property(const std::string& key)
237 return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
240 void Actor::set_property(const std::string& key, std::string value)
242 simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, std::move(value)); });
245 Actor* Actor::restart()
247 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
250 // ***** this_actor *****
252 namespace this_actor {
254 /** Returns true if run from the kernel mode, and false if run from a real actor
256 * Everything that is run out of any actor (simulation setup before the engine is run,
257 * computing the model evolutions as a result to the actors' action, etc) is run in
258 * kernel mode, just as in any operating systems.
260 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
261 * because it is the one scheduling when the others should move or wait.
265 smx_actor_t process = SIMIX_process_self();
266 return process == nullptr || process == simix_global->maestro_process;
269 void sleep_for(double duration)
272 smx_actor_t actor = SIMIX_process_self();
273 simgrid::s4u::Actor::on_sleep(actor->iface());
275 simcall_process_sleep(duration);
277 simgrid::s4u::Actor::on_wake_up(actor->iface());
283 simgrid::simix::simcall([] { /* do nothing*/ });
286 XBT_PUBLIC void sleep_until(double timeout)
288 double now = SIMIX_get_clock();
290 sleep_for(timeout - now);
293 void execute(double flops)
295 execute(flops, 1.0 /* priority */);
298 void execute(double flops, double priority)
300 exec_init(flops)->set_priority(priority)->start()->wait();
303 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
304 const std::vector<double>& bytes_amounts)
306 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
309 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
310 const std::vector<double>& bytes_amounts, double timeout)
312 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
313 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
314 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
315 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
316 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
317 hosts.size(), hosts.size(), flops_amounts.size());
319 /* The vectors live as parameter of parallel_execute. No copy is created for simcall_execution_parallel_start(),
320 * but that's OK because simcall_execution_wait() is called from here too.
322 smx_activity_t s = simcall_execution_parallel_start("", hosts.size(), hosts.data(),
323 (flops_amounts.empty() ? nullptr : flops_amounts.data()),
324 (bytes_amounts.empty() ? nullptr : bytes_amounts.data()),
325 /* rate */ -1, timeout);
326 simcall_execution_wait(s);
330 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
334 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
335 simcall_execution_wait(s);
336 delete[] flops_amount;
337 delete[] bytes_amount;
341 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
343 smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
344 /* rate */ -1, /*timeout*/ -1);
345 simcall_execution_wait(s);
346 delete[] flops_amount;
347 delete[] bytes_amount;
350 ExecPtr exec_init(double flops_amount)
352 return ExecPtr(new Exec(get_host(), flops_amount));
355 ExecPtr exec_async(double flops)
357 ExecPtr res = exec_init(flops);
364 return SIMIX_process_self()->get_pid();
369 return SIMIX_process_self()->get_ppid();
372 std::string get_name()
374 return SIMIX_process_self()->get_name();
377 const char* get_cname()
379 return SIMIX_process_self()->get_cname();
384 return SIMIX_process_self()->get_host();
389 smx_actor_t actor = SIMIX_process_self();
390 simgrid::s4u::Actor::on_suspend(actor->iface());
392 simcall_process_suspend(actor);
397 smx_actor_t process = SIMIX_process_self();
398 simgrid::simix::simcall([process] { process->resume(); });
399 simgrid::s4u::Actor::on_resume(process->iface());
404 smx_actor_t actor = SIMIX_process_self();
405 simgrid::simix::simcall([actor] { actor->exit(); });
408 void on_exit(std::function<void(bool)> const fun)
410 SIMIX_process_self()->iface()->on_exit(fun);
413 void on_exit(std::function<void(int, void*)> const fun, void* data) /* deprecated */
415 SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); });
418 /** @brief Moves the current actor to another host
420 * @see simgrid::s4u::Actor::migrate() for more information
422 void migrate(Host* new_host)
424 SIMIX_process_self()->iface()->migrate(new_host);
427 std::string getName() /* deprecated */
431 const char* getCname() /* deprecated */
435 bool isMaestro() /* deprecated */
439 aid_t getPid() /* deprecated */
443 aid_t getPpid() /* deprecated */
447 Host* getHost() /* deprecated */
451 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
453 SIMIX_process_self()->iface()->on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
455 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
457 on_exit([fun, data](int a) { fun((void*)(intptr_t)a, data); });
459 void kill() /* deprecated */
464 } // namespace this_actor
466 } // namespace simgrid
468 /* **************************** Public C interface *************************** */
470 /** @ingroup m_actor_management
471 * @brief Returns the process ID of @a actor.
473 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
475 aid_t sg_actor_get_PID(sg_actor_t actor)
477 /* Do not raise an exception here: this function is called by the logs
478 * and the exceptions, so it would be called back again and again */
479 if (actor == nullptr || actor->get_impl() == nullptr)
481 return actor->get_pid();
484 /** @ingroup m_actor_management
485 * @brief Returns the process ID of the parent of @a actor.
487 * This function checks whether @a actor is a valid pointer and return its parent's PID.
488 * Returns -1 if the actor has not been created by any other actor.
490 aid_t sg_actor_get_PPID(sg_actor_t actor)
492 return actor->get_ppid();
495 /** @ingroup m_actor_management
497 * @brief Return a #sg_actor_t given its PID.
499 * 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.
500 * If none is found, @c nullptr is returned.
501 Note that the PID are unique in the whole simulation, not only on a given host.
503 sg_actor_t sg_actor_by_PID(aid_t pid)
505 return simgrid::s4u::Actor::by_pid(pid).get();
508 /** @ingroup m_actor_management
509 * @brief Return the name of an actor.
511 const char* sg_actor_get_name(sg_actor_t actor)
513 return actor->get_cname();
516 sg_host_t sg_actor_get_host(sg_actor_t actor)
518 return actor->get_host();
521 /** @ingroup m_actor_management
522 * @brief Returns the value of a given actor property
524 * @param actor an actor
525 * @param name a property name
526 * @return value of a property (or nullptr if the property is not set)
528 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
530 return actor->get_property(name);
533 /** @ingroup m_actor_management
534 * @brief Return the list of properties
536 * This function returns all the parameters associated with an actor
538 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
540 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
541 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
542 std::unordered_map<std::string, std::string>* props = actor->get_properties();
543 if (props == nullptr)
545 for (auto const& kv : *props) {
546 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
551 /** @ingroup m_actor_management
552 * @brief Suspend the actor.
554 * This function suspends the actor by suspending the task on which it was waiting for the completion.
556 void sg_actor_suspend(sg_actor_t actor)
558 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
562 /** @ingroup m_actor_management
563 * @brief Resume a suspended actor.
565 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
567 void sg_actor_resume(sg_actor_t actor)
569 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
573 /** @ingroup m_actor_management
574 * @brief Returns true if the actor is suspended .
576 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
578 int sg_actor_is_suspended(sg_actor_t actor)
580 return actor->is_suspended();
584 * @ingroup m_actor_management
585 * @brief Restarts an actor from the beginning.
587 sg_actor_t sg_actor_restart(sg_actor_t actor)
589 return actor->restart();
593 * @ingroup m_actor_management
594 * @brief Sets the "auto-restart" flag of the actor.
595 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
597 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
599 actor->set_auto_restart(auto_restart);
602 /** @ingroup m_actor_management
603 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
605 void sg_actor_daemonize(sg_actor_t actor)
610 /** @ingroup m_actor_management
611 * @brief Migrates an actor to another location.
613 * This function changes the value of the #sg_host_t on which @a actor is running.
615 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
617 process->migrate(host);
620 /** @ingroup m_actor_management
621 * @brief Wait for the completion of a #sg_actor_t.
623 * @param actor the actor to wait for
624 * @param timeout wait until the actor is over, or the timeout expires
626 void sg_actor_join(sg_actor_t actor, double timeout)
628 actor->join(timeout);
631 void sg_actor_kill(sg_actor_t actor)
636 void sg_actor_kill_all()
638 simgrid::s4u::Actor::kill_all();
641 /** @ingroup m_actor_management
642 * @brief Set the kill time of an actor.
644 * @param actor an actor
645 * @param kill_time the time when the actor is killed.
647 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
649 actor->set_kill_time(kill_time);
652 /** Yield the current actor; let the other actors execute first */
653 void sg_actor_yield()
655 simgrid::s4u::this_actor::yield();
658 void sg_actor_sleep_for(double duration)
660 simgrid::s4u::this_actor::sleep_for(duration);
663 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
665 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
666 std::unordered_map<std::string, std::string> props;
667 xbt_dict_cursor_t cursor = nullptr;
670 xbt_dict_foreach (properties, cursor, key, value)
672 xbt_dict_free(&properties);
674 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
675 smx_actor_t actor = nullptr;
677 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
678 } catch (simgrid::HostFailureException const&) {
679 xbt_die("Could not attach");
682 simgrid::s4u::this_actor::yield();
683 return actor->ciface();
686 void sg_actor_detach()
688 simgrid::kernel::actor::ActorImpl::detach();