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/actor.h"
7 #include "simgrid/s4u/Actor.hpp"
8 #include "simgrid/s4u/Exec.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "src/kernel/activity/ExecImpl.hpp"
11 #include "src/simix/smx_host_private.hpp"
12 #include "src/simix/smx_private.hpp"
13 #include "src/surf/HostImpl.hpp"
17 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
22 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
23 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_suspend;
24 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_resume;
25 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_sleep;
26 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_wake_up;
27 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_start;
28 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
29 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
31 // ***** Actor creation *****
32 ActorPtr Actor::self()
34 smx_context_t self_context = simgrid::kernel::context::Context::self();
35 if (self_context == nullptr)
36 return simgrid::s4u::ActorPtr();
38 return self_context->get_actor()->iface();
41 ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
43 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
44 return actor->iface();
47 ActorPtr Actor::create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args)
49 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
50 return create(name, host, factory(std::move(args)));
53 void intrusive_ptr_add_ref(Actor* actor)
55 intrusive_ptr_add_ref(actor->pimpl_);
57 void intrusive_ptr_release(Actor* actor)
59 intrusive_ptr_release(actor->pimpl_);
62 // ***** Actor methods *****
66 simcall_process_join(this->pimpl_, -1);
69 void Actor::join(double timeout)
71 simcall_process_join(this->pimpl_, timeout);
74 void Actor::set_auto_restart(bool autorestart)
76 simgrid::simix::simcall([this, autorestart]() {
77 xbt_assert(autorestart && not pimpl_->auto_restart_); // FIXME: handle all cases
78 pimpl_->set_auto_restart(autorestart);
80 simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->host_, pimpl_);
81 XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
82 pimpl_->host_->pimpl_->actors_at_boot_.emplace_back(arg);
86 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
88 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
91 void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
93 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
96 void Actor::migrate(Host* new_host)
98 s4u::Actor::on_migration_start(this);
100 simgrid::simix::simcall([this, new_host]() {
101 if (pimpl_->waiting_synchro != nullptr) {
102 // The actor is blocked on an activity. If it's an exec, migrate it too.
103 // FIXME: implement the migration of other kind of activities
104 simgrid::kernel::activity::ExecImplPtr exec =
105 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
106 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
107 exec->migrate(new_host);
109 this->pimpl_->change_host(new_host);
112 s4u::Actor::on_migration_end(this);
115 s4u::Host* Actor::get_host()
117 return this->pimpl_->host_;
120 void Actor::daemonize()
122 simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
125 bool Actor::is_daemon() const
127 return this->pimpl_->is_daemon();
130 const simgrid::xbt::string& Actor::get_name() const
132 return this->pimpl_->get_name();
135 const char* Actor::get_cname() const
137 return this->pimpl_->get_cname();
140 aid_t Actor::get_pid() const
142 return this->pimpl_->pid_;
145 aid_t Actor::get_ppid() const
147 return this->pimpl_->ppid_;
150 void Actor::suspend()
152 s4u::Actor::on_suspend(this);
153 simcall_process_suspend(pimpl_);
158 simgrid::simix::simcall([this] { pimpl_->resume(); });
159 s4u::Actor::on_resume(this);
162 bool Actor::is_suspended()
164 return simgrid::simix::simcall([this] { return pimpl_->suspended_; });
167 void Actor::set_kill_time(double kill_time)
169 simgrid::simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
172 /** @brief Get the kill time of an actor(or 0 if unset). */
173 double Actor::get_kill_time()
175 return SIMIX_timer_get_date(pimpl_->kill_timer);
178 void Actor::kill(aid_t pid) // deprecated
180 smx_actor_t killer = SIMIX_process_self();
181 smx_actor_t process = SIMIX_process_from_PID(pid);
182 if (process != nullptr) {
183 simgrid::simix::simcall([killer, process] { SIMIX_process_kill(process, killer); });
185 std::ostringstream oss;
186 oss << "kill: (" << pid << ") - No such actor" << std::endl;
187 throw std::runtime_error(oss.str());
193 smx_actor_t process = SIMIX_process_self();
194 simgrid::simix::simcall(
195 [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
198 smx_actor_t Actor::get_impl()
203 // ***** Static functions *****
205 ActorPtr Actor::by_pid(aid_t pid)
207 smx_actor_t process = SIMIX_process_from_PID(pid);
208 if (process != nullptr)
209 return process->iface();
214 void Actor::kill_all()
216 smx_actor_t self = SIMIX_process_self();
217 simgrid::simix::simcall([&self] { SIMIX_process_killall(self); });
220 std::unordered_map<std::string, std::string>* Actor::get_properties()
222 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
225 /** Retrieve the property value (or nullptr if not set) */
226 const char* Actor::get_property(std::string key)
228 return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
231 void Actor::set_property(std::string key, std::string value)
233 simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
236 Actor* Actor::restart()
238 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
241 // ***** this_actor *****
243 namespace this_actor {
245 /** Returns true if run from the kernel mode, and false if run from a real actor
247 * Everything that is run out of any actor (simulation setup before the engine is run,
248 * computing the model evolutions as a result to the actors' action, etc) is run in
249 * kernel mode, just as in any operating systems.
251 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
252 * because it is the one scheduling when the others should move or wait.
256 smx_actor_t process = SIMIX_process_self();
257 return process == nullptr || process == simix_global->maestro_process;
260 void sleep_for(double duration)
263 smx_actor_t actor = SIMIX_process_self();
264 simgrid::s4u::Actor::on_sleep(actor->iface());
266 simcall_process_sleep(duration);
268 simgrid::s4u::Actor::on_wake_up(actor->iface());
274 simgrid::simix::simcall([] { /* do nothing*/ });
277 XBT_PUBLIC void sleep_until(double timeout)
279 double now = SIMIX_get_clock();
281 sleep_for(timeout - now);
284 void execute(double flops)
286 execute(flops, 1.0 /* priority */);
289 void execute(double flops, double priority)
291 exec_init(flops)->set_priority(priority)->start()->wait();
294 void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
295 std::vector<double> bytes_amounts)
297 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
299 void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
300 std::vector<double> bytes_amounts, double timeout)
302 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
303 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
304 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
305 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
306 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
307 hosts.size(), hosts.size(), flops_amounts.size());
309 /* The vectors live as parameter of parallel_execute. No copy is created for simcall_execution_parallel_start(),
310 * but that's OK because simcall_execution_wait() is called from here too.
312 smx_activity_t s = simcall_execution_parallel_start("", hosts.size(), hosts.data(),
313 (flops_amounts.empty() ? nullptr : flops_amounts.data()),
314 (bytes_amounts.empty() ? nullptr : bytes_amounts.data()),
315 /* rate */ -1, timeout);
316 simcall_execution_wait(s);
320 void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
323 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
324 simcall_execution_wait(s);
325 delete[] flops_amount;
326 delete[] bytes_amount;
330 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
332 smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
333 /* rate */ -1, /*timeout*/ -1);
334 simcall_execution_wait(s);
335 delete[] flops_amount;
336 delete[] bytes_amount;
339 ExecPtr exec_init(double flops_amount)
341 return ExecPtr(new Exec(get_host(), flops_amount));
344 ExecPtr exec_async(double flops)
346 ExecPtr res = exec_init(flops);
353 return SIMIX_process_self()->pid_;
358 return SIMIX_process_self()->ppid_;
361 std::string get_name()
363 return SIMIX_process_self()->get_name();
366 const char* get_cname()
368 return SIMIX_process_self()->get_cname();
373 return SIMIX_process_self()->host_;
378 smx_actor_t actor = SIMIX_process_self();
379 simgrid::s4u::Actor::on_suspend(actor->iface());
381 simcall_process_suspend(actor);
386 smx_actor_t process = SIMIX_process_self();
387 simgrid::simix::simcall([process] { process->resume(); });
388 simgrid::s4u::Actor::on_resume(process->iface());
393 smx_actor_t process = SIMIX_process_self();
394 simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
397 void on_exit(std::function<void(int, void*)> fun, void* data)
399 SIMIX_process_self()->iface()->on_exit(fun, data);
402 /** @brief Moves the current actor to another host
404 * @see simgrid::s4u::Actor::migrate() for more information
406 void migrate(Host* new_host)
408 SIMIX_process_self()->iface()->migrate(new_host);
411 std::string getName() /* deprecated */
415 const char* getCname() /* deprecated */
419 bool isMaestro() /* deprecated */
423 aid_t getPid() /* deprecated */
427 aid_t getPpid() /* deprecated */
431 Host* getHost() /* deprecated */
435 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
437 SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
439 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
441 on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
443 void kill() /* deprecated */
448 } // namespace this_actor
450 } // namespace simgrid
452 /* **************************** Public C interface *************************** */
454 /** @ingroup m_actor_management
455 * @brief Returns the process ID of @a actor.
457 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
459 aid_t sg_actor_get_PID(sg_actor_t actor)
461 /* Do not raise an exception here: this function is called by the logs
462 * and the exceptions, so it would be called back again and again */
463 if (actor == nullptr || actor->get_impl() == nullptr)
465 return actor->get_pid();
468 /** @ingroup m_actor_management
469 * @brief Returns the process ID of the parent of @a actor.
471 * This function checks whether @a actor is a valid pointer and return its parent's PID.
472 * Returns -1 if the actor has not been created by any other actor.
474 aid_t sg_actor_get_PPID(sg_actor_t actor)
476 return actor->get_ppid();
479 /** @ingroup m_actor_management
481 * @brief Return a #sg_actor_t given its PID.
483 * 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.
484 * If none is found, @c nullptr is returned.
485 Note that the PID are unique in the whole simulation, not only on a given host.
487 sg_actor_t sg_actor_by_PID(aid_t pid)
489 return simgrid::s4u::Actor::by_pid(pid).get();
492 /** @ingroup m_actor_management
493 * @brief Return the name of an actor.
495 const char* sg_actor_get_name(sg_actor_t actor)
497 return actor->get_cname();
500 sg_host_t sg_actor_get_host(sg_actor_t actor)
502 return actor->get_host();
505 /** @ingroup m_actor_management
506 * @brief Returns the value of a given actor property
508 * @param actor an actor
509 * @param name a property name
510 * @return value of a property (or nullptr if the property is not set)
512 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
514 return actor->get_property(name);
517 /** @ingroup m_actor_management
518 * @brief Return the list of properties
520 * This function returns all the parameters associated with an actor
522 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
524 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
525 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
526 std::unordered_map<std::string, std::string>* props = actor->get_properties();
527 if (props == nullptr)
529 for (auto const& kv : *props) {
530 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
535 /** @ingroup m_actor_management
536 * @brief Suspend the actor.
538 * This function suspends the actor by suspending the task on which it was waiting for the completion.
540 void sg_actor_suspend(sg_actor_t actor)
542 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
546 /** @ingroup m_actor_management
547 * @brief Resume a suspended actor.
549 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
551 void sg_actor_resume(sg_actor_t actor)
553 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
557 /** @ingroup m_actor_management
558 * @brief Returns true if the actor is suspended .
560 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
562 int sg_actor_is_suspended(sg_actor_t actor)
564 return actor->is_suspended();
568 * @ingroup m_actor_management
569 * @brief Restarts an actor from the beginning.
571 sg_actor_t sg_actor_restart(sg_actor_t actor)
573 return actor->restart();
577 * @ingroup m_actor_management
578 * @brief Sets the "auto-restart" flag of the actor.
579 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
581 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
583 actor->set_auto_restart(auto_restart);
586 /** @ingroup m_actor_management
587 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
589 void sg_actor_daemonize(sg_actor_t actor)
594 /** @ingroup m_actor_management
595 * @brief Migrates an actor to another location.
597 * This function changes the value of the #sg_host_t on which @a actor is running.
599 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
601 process->migrate(host);
604 /** @ingroup m_actor_management
605 * @brief Wait for the completion of a #sg_actor_t.
607 * @param actor the actor to wait for
608 * @param timeout wait until the actor is over, or the timeout expires
610 void sg_actor_join(sg_actor_t actor, double timeout)
612 actor->join(timeout);
615 void sg_actor_kill(sg_actor_t actor)
620 void sg_actor_kill_all()
622 simgrid::s4u::Actor::kill_all();
625 /** @ingroup m_actor_management
626 * @brief Set the kill time of an actor.
628 * @param actor an actor
629 * @param kill_time the time when the actor is killed.
631 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
633 actor->set_kill_time(kill_time);
636 /** Yield the current actor; let the other actors execute first */
637 void sg_actor_yield()
639 simgrid::s4u::this_actor::yield();