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_migration_start;
22 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
23 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
25 // ***** Actor creation *****
26 ActorPtr Actor::self()
28 smx_context_t self_context = SIMIX_context_self();
29 if (self_context == nullptr)
30 return simgrid::s4u::ActorPtr();
32 return self_context->process()->iface();
35 ActorPtr Actor::create(const char* name, s4u::Host* host, std::function<void()> code)
37 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
38 return actor->iface();
41 ActorPtr Actor::create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
43 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
44 simgrid::simix::ActorCode code = factory(std::move(args));
45 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
46 return actor->iface();
49 void intrusive_ptr_add_ref(Actor* actor)
51 intrusive_ptr_add_ref(actor->pimpl_);
53 void intrusive_ptr_release(Actor* actor)
55 intrusive_ptr_release(actor->pimpl_);
58 // ***** Actor methods *****
62 simcall_process_join(this->pimpl_, -1);
65 void Actor::join(double timeout)
67 simcall_process_join(this->pimpl_, timeout);
70 void Actor::set_auto_restart(bool autorestart)
72 simgrid::simix::kernelImmediate([this, autorestart]() { pimpl_->auto_restart = autorestart; });
75 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data)
77 simgrid::simix::kernelImmediate([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
80 /** @brief Moves the actor to another host
82 * If the actor is currently blocked on an execution activity, the activity is also
83 * migrated to the new host. If it's blocked on another kind of activity, an error is
84 * raised as the mandated code is not written yet. Please report that bug if you need it.
86 * Asynchronous activities started by the actor are not migrated automatically, so you have
87 * to take care of this yourself (only you knows which ones should be migrated).
89 void Actor::migrate(Host* new_host)
91 s4u::Actor::on_migration_start(this);
93 simgrid::simix::kernelImmediate([this, new_host]() {
94 if (pimpl_->waiting_synchro != nullptr) {
95 // The actor is blocked on an activity. If it's an exec, migrate it too.
96 // FIXME: implement the migration of other kind of activities
97 simgrid::kernel::activity::ExecImplPtr exec =
98 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
99 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
100 exec->migrate(new_host);
102 SIMIX_process_change_host(this->pimpl_, new_host);
105 s4u::Actor::on_migration_end(this);
108 s4u::Host* Actor::get_host()
110 return this->pimpl_->host;
113 void Actor::daemonize()
115 simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
118 bool Actor::is_daemon() const
120 return this->pimpl_->isDaemon();
123 const simgrid::xbt::string& Actor::get_name() const
125 return this->pimpl_->get_name();
128 const char* Actor::get_cname() const
130 return this->pimpl_->get_cname();
133 aid_t Actor::get_pid() const
135 return this->pimpl_->pid;
138 aid_t Actor::get_ppid() const
140 return this->pimpl_->ppid;
143 void Actor::suspend()
145 s4u::Actor::on_suspend(this);
146 simcall_process_suspend(pimpl_);
151 simgrid::simix::kernelImmediate([this] { pimpl_->resume(); });
152 s4u::Actor::on_resume(this);
155 int Actor::is_suspended()
157 return simgrid::simix::kernelImmediate([this] { return pimpl_->suspended; });
160 void Actor::set_kill_time(double time)
162 simcall_process_set_kill_time(pimpl_, time);
165 /** \brief Get the kill time of an actor(or 0 if unset). */
166 double Actor::get_kill_time()
168 return SIMIX_timer_get_date(pimpl_->kill_timer);
171 void Actor::kill(aid_t pid)
173 smx_actor_t killer = SIMIX_process_self();
174 smx_actor_t process = SIMIX_process_from_PID(pid);
175 if (process != nullptr) {
176 simgrid::simix::kernelImmediate([killer, process] { SIMIX_process_kill(process, killer); });
178 std::ostringstream oss;
179 oss << "kill: (" << pid << ") - No such actor" << std::endl;
180 throw std::runtime_error(oss.str());
186 smx_actor_t process = SIMIX_process_self();
187 simgrid::simix::kernelImmediate(
188 [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
191 smx_actor_t Actor::get_impl()
196 // ***** Static functions *****
198 ActorPtr Actor::by_pid(aid_t pid)
200 smx_actor_t process = SIMIX_process_from_PID(pid);
201 if (process != nullptr)
202 return process->iface();
207 void Actor::kill_all()
209 smx_actor_t self = SIMIX_process_self();
210 simgrid::simix::kernelImmediate([&self] { SIMIX_process_killall(self); });
213 std::map<std::string, std::string>* Actor::get_properties()
215 return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
218 /** Retrieve the property value (or nullptr if not set) */
219 const char* Actor::get_property(const char* key)
221 return simgrid::simix::kernelImmediate([this, key] { return pimpl_->getProperty(key); });
224 void Actor::set_property(const char* key, const char* value)
226 simgrid::simix::kernelImmediate([this, key, value] { pimpl_->setProperty(key, value); });
229 Actor* Actor::restart()
231 return simgrid::simix::kernelImmediate([this]() { return pimpl_->restart(); });
234 // ***** this_actor *****
236 namespace this_actor {
238 /** Returns true if run from the kernel mode, and false if run from a real actor
240 * Everything that is run out of any actor (simulation setup before the engine is run,
241 * computing the model evolutions as a result to the actors' action, etc) is run in
242 * kernel mode, just as in any operating systems.
244 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
245 * because it is the one scheduling when the others should move or wait.
249 smx_actor_t process = SIMIX_process_self();
250 return process == nullptr || process == simix_global->maestro_process;
253 void sleep_for(double duration)
256 simcall_process_sleep(duration);
261 simgrid::simix::kernelImmediate([] { /* do nothing*/ });
264 XBT_PUBLIC void sleep_until(double timeout)
266 double now = SIMIX_get_clock();
268 simcall_process_sleep(timeout - now);
271 void execute(double flops)
273 smx_activity_t s = simcall_execution_start(nullptr, flops, 1.0 /*priority*/, 0. /*bound*/, get_host());
274 simcall_execution_wait(s);
277 void execute(double flops, double priority)
279 smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, get_host());
280 simcall_execution_wait(s);
283 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout)
286 simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, timeout);
287 simcall_execution_wait(s);
290 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
292 smx_activity_t s = simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, -1);
293 simcall_execution_wait(s);
296 ExecPtr exec_init(double flops_amount)
298 ExecPtr res = ExecPtr(new Exec());
299 res->host_ = get_host();
300 res->flops_amount_ = flops_amount;
301 res->set_remaining(flops_amount);
305 ExecPtr exec_async(double flops)
307 ExecPtr res = exec_init(flops);
314 return SIMIX_process_self()->pid;
319 return SIMIX_process_self()->ppid;
322 std::string get_name()
324 return SIMIX_process_self()->get_name();
327 const char* get_cname()
329 return SIMIX_process_self()->get_cname();
334 return SIMIX_process_self()->host;
339 smx_actor_t actor = SIMIX_process_self();
340 simgrid::s4u::Actor::on_suspend(actor->iface());
342 simcall_process_suspend(actor);
347 smx_actor_t process = SIMIX_process_self();
348 simgrid::simix::kernelImmediate([process] { process->resume(); });
349 simgrid::s4u::Actor::on_resume(process->iface());
354 smx_actor_t process = SIMIX_process_self();
355 return simgrid::simix::kernelImmediate([process] { return process->suspended; });
360 smx_actor_t process = SIMIX_process_self();
361 simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
364 void on_exit(int_f_pvoid_pvoid_t fun, void* data)
366 SIMIX_process_self()->iface()->on_exit(fun, data);
369 /** @brief Moves the current actor to another host
371 * @see simgrid::s4u::Actor::migrate() for more information
373 void migrate(Host* new_host)
375 SIMIX_process_self()->iface()->migrate(new_host);
378 std::string getName() /* deprecated */
382 const char* getCname() /* deprecated */
386 bool isMaestro() /* deprecated */
390 aid_t getPid() /* deprecated */
394 aid_t getPpid() /* deprecated */
398 Host* getHost() /* deprecated */
402 bool isSuspended() /* deprecated */
404 return is_suspended();
406 void onExit /* deprecated */ (int_f_pvoid_pvoid_t fun, void* data)
411 } // namespace this_actor
413 } // namespace simgrid
415 /* **************************** Public C interface *************************** */
417 /** \ingroup m_actor_management
418 * \brief Returns the process ID of \a actor.
420 * This function checks whether \a actor is a valid pointer and return its PID (or 0 in case of problem).
422 int sg_actor_get_PID(sg_actor_t actor)
424 /* Do not raise an exception here: this function is called by the logs
425 * and the exceptions, so it would be called back again and again */
426 if (actor == nullptr || actor->get_impl() == nullptr)
428 return actor->get_pid();
431 /** \ingroup m_actor_management
432 * \brief Returns the process ID of the parent of \a actor.
434 * This function checks whether \a actor is a valid pointer and return its parent's PID.
435 * Returns -1 if the actor has not been created by any other actor.
437 int sg_actor_get_PPID(sg_actor_t actor)
439 return actor->get_ppid();
442 /** \ingroup m_actor_management
444 * \brief Return a #sg_actor_t given its PID.
446 * 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.
447 * If none is found, \c nullptr is returned.
448 Note that the PID are unique in the whole simulation, not only on a given host.
450 sg_actor_t sg_actor_by_PID(aid_t pid)
452 return simgrid::s4u::Actor::by_pid(pid).get();
455 /** \ingroup m_actor_management
456 * \brief Return the name of an actor.
458 const char* sg_actor_get_name(sg_actor_t actor)
460 return actor->get_cname();
463 sg_host_t sg_actor_get_host(sg_actor_t actor)
465 return actor->get_host();
468 /** \ingroup m_actor_management
469 * \brief Returns the value of a given actor property
471 * \param actor an actor
472 * \param name a property name
473 * \return value of a property (or nullptr if the property is not set)
475 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
477 return actor->get_property(name);
480 /** \ingroup m_actor_management
481 * \brief Return the list of properties
483 * This function returns all the parameters associated with an actor
485 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
487 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
488 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
489 std::map<std::string, std::string>* props = actor->get_properties();
490 if (props == nullptr)
492 for (auto const& elm : *props) {
493 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
498 /** \ingroup m_actor_management
499 * \brief Suspend the actor.
501 * This function suspends the actor by suspending the task on which it was waiting for the completion.
503 void sg_actor_suspend(sg_actor_t actor)
505 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
509 /** \ingroup m_actor_management
510 * \brief Resume a suspended actor.
512 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
514 void sg_actor_resume(sg_actor_t actor)
516 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
520 /** \ingroup m_actor_management
521 * \brief Returns true if the actor is suspended .
523 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
525 int sg_actor_is_suspended(sg_actor_t actor)
527 return actor->is_suspended();
531 * \ingroup m_actor_management
532 * \brief Restarts an actor from the beginning.
534 sg_actor_t sg_actor_restart(sg_actor_t actor)
536 return actor->restart();
539 /** @ingroup m_actor_management
540 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
542 void sg_actor_daemonize(sg_actor_t actor)
547 /** \ingroup m_actor_management
548 * \brief Migrates an actor to another location.
550 * This function changes the value of the #sg_host_t on which \a actor is running.
552 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
554 process->migrate(host);
557 /** \ingroup m_actor_management
558 * \brief Wait for the completion of a #sg_actor_t.
560 * \param actor the actor to wait for
561 * \param timeout wait until the actor is over, or the timeout expires
563 void sg_actor_join(sg_actor_t actor, double timeout)
565 actor->join(timeout);
568 void sg_actor_kill(sg_actor_t actor)
573 /** \ingroup m_actor_management
574 * \brief Set the kill time of an actor.
576 * \param actor an actor
577 * \param kill_time the time when the actor is killed.
579 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
581 actor->set_kill_time(kill_time);