1 /* Copyright (c) 2006-2018. 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/simix/smx_private.hpp"
13 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
18 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
19 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_suspend;
20 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_resume;
21 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_sleep;
22 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_wake_up;
23 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_start;
24 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
25 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
27 // ***** Actor creation *****
28 ActorPtr Actor::self()
30 smx_context_t self_context = SIMIX_context_self();
31 if (self_context == nullptr)
32 return simgrid::s4u::ActorPtr();
34 return self_context->process()->iface();
37 ActorPtr Actor::create(const char* name, s4u::Host* host, std::function<void()> code)
39 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
40 return actor->iface();
43 ActorPtr Actor::create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
45 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
46 simgrid::simix::ActorCode code = factory(std::move(args));
47 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
48 return actor->iface();
51 void intrusive_ptr_add_ref(Actor* actor)
53 intrusive_ptr_add_ref(actor->pimpl_);
55 void intrusive_ptr_release(Actor* actor)
57 intrusive_ptr_release(actor->pimpl_);
60 // ***** Actor methods *****
64 simcall_process_join(this->pimpl_, -1);
67 void Actor::join(double timeout)
69 simcall_process_join(this->pimpl_, timeout);
72 void Actor::set_auto_restart(bool autorestart)
74 simgrid::simix::simcall([this, autorestart]() { pimpl_->auto_restart = autorestart; });
77 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data)
79 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
82 /** @brief Moves the actor to another host
84 * If the actor is currently blocked on an execution activity, the activity is also
85 * migrated to the new host. If it's blocked on another kind of activity, an error is
86 * raised as the mandated code is not written yet. Please report that bug if you need it.
88 * Asynchronous activities started by the actor are not migrated automatically, so you have
89 * to take care of this yourself (only you knows which ones should be migrated).
91 void Actor::migrate(Host* new_host)
93 s4u::Actor::on_migration_start(this);
95 simgrid::simix::simcall([this, new_host]() {
96 if (pimpl_->waiting_synchro != nullptr) {
97 // The actor is blocked on an activity. If it's an exec, migrate it too.
98 // FIXME: implement the migration of other kind of activities
99 simgrid::kernel::activity::ExecImplPtr exec =
100 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
101 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
102 exec->migrate(new_host);
104 SIMIX_process_change_host(this->pimpl_, new_host);
107 s4u::Actor::on_migration_end(this);
110 s4u::Host* Actor::get_host()
112 return this->pimpl_->host;
115 void Actor::daemonize()
117 simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
120 bool Actor::is_daemon() const
122 return this->pimpl_->isDaemon();
125 const simgrid::xbt::string& Actor::get_name() const
127 return this->pimpl_->get_name();
130 const char* Actor::get_cname() const
132 return this->pimpl_->get_cname();
135 aid_t Actor::get_pid() const
137 return this->pimpl_->pid;
140 aid_t Actor::get_ppid() const
142 return this->pimpl_->ppid;
145 void Actor::suspend()
147 s4u::Actor::on_suspend(this);
148 simcall_process_suspend(pimpl_);
153 simgrid::simix::simcall([this] { pimpl_->resume(); });
154 s4u::Actor::on_resume(this);
157 int Actor::is_suspended()
159 return simgrid::simix::simcall([this] { return pimpl_->suspended; });
162 void Actor::set_kill_time(double time)
164 simcall_process_set_kill_time(pimpl_, time);
167 /** \brief Get the kill time of an actor(or 0 if unset). */
168 double Actor::get_kill_time()
170 return SIMIX_timer_get_date(pimpl_->kill_timer);
173 void Actor::kill(aid_t pid)
175 smx_actor_t killer = SIMIX_process_self();
176 smx_actor_t process = SIMIX_process_from_PID(pid);
177 if (process != nullptr) {
178 simgrid::simix::simcall([killer, process] { SIMIX_process_kill(process, killer); });
180 std::ostringstream oss;
181 oss << "kill: (" << pid << ") - No such actor" << std::endl;
182 throw std::runtime_error(oss.str());
188 smx_actor_t process = SIMIX_process_self();
189 simgrid::simix::simcall(
190 [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
193 smx_actor_t Actor::get_impl()
198 // ***** Static functions *****
200 ActorPtr Actor::by_pid(aid_t pid)
202 smx_actor_t process = SIMIX_process_from_PID(pid);
203 if (process != nullptr)
204 return process->iface();
209 void Actor::kill_all()
211 smx_actor_t self = SIMIX_process_self();
212 simgrid::simix::simcall([&self] { SIMIX_process_killall(self); });
215 std::map<std::string, std::string>* Actor::get_properties()
217 return simgrid::simix::simcall([this] { return this->pimpl_->getProperties(); });
220 /** Retrieve the property value (or nullptr if not set) */
221 const char* Actor::get_property(const char* key)
223 return simgrid::simix::simcall([this, key] { return pimpl_->getProperty(key); });
226 void Actor::set_property(const char* key, const char* value)
228 simgrid::simix::simcall([this, key, value] { pimpl_->setProperty(key, value); });
231 Actor* Actor::restart()
233 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
236 // ***** this_actor *****
238 namespace this_actor {
240 /** Returns true if run from the kernel mode, and false if run from a real actor
242 * Everything that is run out of any actor (simulation setup before the engine is run,
243 * computing the model evolutions as a result to the actors' action, etc) is run in
244 * kernel mode, just as in any operating systems.
246 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
247 * because it is the one scheduling when the others should move or wait.
251 smx_actor_t process = SIMIX_process_self();
252 return process == nullptr || process == simix_global->maestro_process;
255 void sleep_for(double duration)
258 smx_actor_t actor = SIMIX_process_self();
259 simgrid::s4u::Actor::on_sleep(actor->iface());
261 simcall_process_sleep(duration);
263 simgrid::s4u::Actor::on_wake_up(actor->iface());
269 simgrid::simix::simcall([] { /* do nothing*/ });
272 XBT_PUBLIC void sleep_until(double timeout)
274 double now = SIMIX_get_clock();
276 sleep_for(timeout - now);
279 void execute(double flops)
281 get_host()->execute(flops);
284 void execute(double flops, double priority)
286 get_host()->execute(flops, priority);
289 void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
292 simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
293 simcall_execution_wait(s);
296 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
298 parallel_execute(host_nb, host_list, flops_amount, bytes_amount, /* timeout */ -1);
301 ExecPtr exec_init(double flops_amount)
303 ExecPtr res = ExecPtr(new Exec());
304 res->host_ = get_host();
305 res->flops_amount_ = flops_amount;
306 res->set_remaining(flops_amount);
310 ExecPtr exec_async(double flops)
312 ExecPtr res = exec_init(flops);
319 return SIMIX_process_self()->pid;
324 return SIMIX_process_self()->ppid;
327 std::string get_name()
329 return SIMIX_process_self()->get_name();
332 const char* get_cname()
334 return SIMIX_process_self()->get_cname();
339 return SIMIX_process_self()->host;
344 smx_actor_t actor = SIMIX_process_self();
345 simgrid::s4u::Actor::on_suspend(actor->iface());
347 simcall_process_suspend(actor);
352 smx_actor_t process = SIMIX_process_self();
353 simgrid::simix::simcall([process] { process->resume(); });
354 simgrid::s4u::Actor::on_resume(process->iface());
359 smx_actor_t process = SIMIX_process_self();
360 return simgrid::simix::simcall([process] { return process->suspended; });
365 smx_actor_t process = SIMIX_process_self();
366 simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
369 void on_exit(int_f_pvoid_pvoid_t fun, void* data)
371 SIMIX_process_self()->iface()->on_exit(fun, data);
374 /** @brief Moves the current actor to another host
376 * @see simgrid::s4u::Actor::migrate() for more information
378 void migrate(Host* new_host)
380 SIMIX_process_self()->iface()->migrate(new_host);
383 std::string getName() /* deprecated */
387 const char* getCname() /* deprecated */
391 bool isMaestro() /* deprecated */
395 aid_t getPid() /* deprecated */
399 aid_t getPpid() /* deprecated */
403 Host* getHost() /* deprecated */
407 bool isSuspended() /* deprecated */
409 return is_suspended();
411 void onExit /* deprecated */ (int_f_pvoid_pvoid_t fun, void* data)
416 } // namespace this_actor
418 } // namespace simgrid
420 /* **************************** Public C interface *************************** */
422 /** \ingroup m_actor_management
423 * \brief Returns the process ID of \a actor.
425 * This function checks whether \a actor is a valid pointer and return its PID (or 0 in case of problem).
427 int sg_actor_get_PID(sg_actor_t actor)
429 /* Do not raise an exception here: this function is called by the logs
430 * and the exceptions, so it would be called back again and again */
431 if (actor == nullptr || actor->get_impl() == nullptr)
433 return actor->get_pid();
436 /** \ingroup m_actor_management
437 * \brief Returns the process ID of the parent of \a actor.
439 * This function checks whether \a actor is a valid pointer and return its parent's PID.
440 * Returns -1 if the actor has not been created by any other actor.
442 int sg_actor_get_PPID(sg_actor_t actor)
444 return actor->get_ppid();
447 /** \ingroup m_actor_management
449 * \brief Return a #sg_actor_t given its PID.
451 * 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.
452 * If none is found, \c nullptr is returned.
453 Note that the PID are unique in the whole simulation, not only on a given host.
455 sg_actor_t sg_actor_by_PID(aid_t pid)
457 return simgrid::s4u::Actor::by_pid(pid).get();
460 /** \ingroup m_actor_management
461 * \brief Return the name of an actor.
463 const char* sg_actor_get_name(sg_actor_t actor)
465 return actor->get_cname();
468 sg_host_t sg_actor_get_host(sg_actor_t actor)
470 return actor->get_host();
473 /** \ingroup m_actor_management
474 * \brief Returns the value of a given actor property
476 * \param actor an actor
477 * \param name a property name
478 * \return value of a property (or nullptr if the property is not set)
480 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
482 return actor->get_property(name);
485 /** \ingroup m_actor_management
486 * \brief Return the list of properties
488 * This function returns all the parameters associated with an actor
490 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
492 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
493 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
494 std::map<std::string, std::string>* props = actor->get_properties();
495 if (props == nullptr)
497 for (auto const& elm : *props) {
498 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
503 /** \ingroup m_actor_management
504 * \brief Suspend the actor.
506 * This function suspends the actor by suspending the task on which it was waiting for the completion.
508 void sg_actor_suspend(sg_actor_t actor)
510 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
514 /** \ingroup m_actor_management
515 * \brief Resume a suspended actor.
517 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
519 void sg_actor_resume(sg_actor_t actor)
521 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
525 /** \ingroup m_actor_management
526 * \brief Returns true if the actor is suspended .
528 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
530 int sg_actor_is_suspended(sg_actor_t actor)
532 return actor->is_suspended();
536 * \ingroup m_actor_management
537 * \brief Restarts an actor from the beginning.
539 sg_actor_t sg_actor_restart(sg_actor_t actor)
541 return actor->restart();
545 * \ingroup m_actor_management
546 * \brief Sets the "auto-restart" flag of the actor.
547 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
549 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
551 actor->set_auto_restart(auto_restart);
554 /** @ingroup m_actor_management
555 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
557 void sg_actor_daemonize(sg_actor_t actor)
562 /** \ingroup m_actor_management
563 * \brief Migrates an actor to another location.
565 * This function changes the value of the #sg_host_t on which \a actor is running.
567 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
569 process->migrate(host);
572 /** \ingroup m_actor_management
573 * \brief Wait for the completion of a #sg_actor_t.
575 * \param actor the actor to wait for
576 * \param timeout wait until the actor is over, or the timeout expires
578 void sg_actor_join(sg_actor_t actor, double timeout)
580 actor->join(timeout);
583 void sg_actor_kill(sg_actor_t actor)
588 void sg_actor_kill_all()
590 simgrid::s4u::Actor::kill_all();
593 /** \ingroup m_actor_management
594 * \brief Set the kill time of an actor.
596 * \param actor an actor
597 * \param kill_time the time when the actor is killed.
599 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
601 actor->set_kill_time(kill_time);
604 /** Yield the current actor; let the other actors execute first */
605 void sg_actor_yield()
607 simgrid::s4u::this_actor::yield();