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/kernel/activity/ExecImpl.hpp"
11 #include "src/simix/smx_private.hpp"
15 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
20 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
21 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_suspend;
22 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_resume;
23 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_sleep;
24 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_wake_up;
25 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_start;
26 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
27 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
29 // ***** Actor creation *****
30 ActorPtr Actor::self()
32 smx_context_t self_context = SIMIX_context_self();
33 if (self_context == nullptr)
34 return simgrid::s4u::ActorPtr();
36 return self_context->process()->iface();
39 ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
41 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
42 return actor->iface();
45 ActorPtr Actor::create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args)
47 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
48 simgrid::simix::ActorCode code = factory(std::move(args));
49 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
50 return actor->iface();
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]() { pimpl_->set_auto_restart(autorestart); });
79 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
81 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
84 void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
86 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
89 /** @brief Moves the actor to another host
91 * If the actor is currently blocked on an execution activity, the activity is also
92 * migrated to the new host. If it's blocked on another kind of activity, an error is
93 * raised as the mandated code is not written yet. Please report that bug if you need it.
95 * Asynchronous activities started by the actor are not migrated automatically, so you have
96 * to take care of this yourself (only you knows which ones should be migrated).
98 void Actor::migrate(Host* new_host)
100 s4u::Actor::on_migration_start(this);
102 simgrid::simix::simcall([this, new_host]() {
103 if (pimpl_->waiting_synchro != nullptr) {
104 // The actor is blocked on an activity. If it's an exec, migrate it too.
105 // FIXME: implement the migration of other kind of activities
106 simgrid::kernel::activity::ExecImplPtr exec =
107 boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
108 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
109 exec->migrate(new_host);
111 SIMIX_process_change_host(this->pimpl_, new_host);
114 s4u::Actor::on_migration_end(this);
117 s4u::Host* Actor::get_host()
119 return this->pimpl_->host_;
122 void Actor::daemonize()
124 simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
127 bool Actor::is_daemon() const
129 return this->pimpl_->is_daemon();
132 const simgrid::xbt::string& Actor::get_name() const
134 return this->pimpl_->get_name();
137 const char* Actor::get_cname() const
139 return this->pimpl_->get_cname();
142 aid_t Actor::get_pid() const
144 return this->pimpl_->pid_;
147 aid_t Actor::get_ppid() const
149 return this->pimpl_->ppid_;
152 void Actor::suspend()
154 s4u::Actor::on_suspend(this);
155 simcall_process_suspend(pimpl_);
160 simgrid::simix::simcall([this] { pimpl_->resume(); });
161 s4u::Actor::on_resume(this);
164 bool Actor::is_suspended()
166 return simgrid::simix::simcall([this] { return pimpl_->suspended_; });
169 void Actor::set_kill_time(double time)
171 simcall_process_set_kill_time(pimpl_, time);
174 /** @brief Get the kill time of an actor(or 0 if unset). */
175 double Actor::get_kill_time()
177 return SIMIX_timer_get_date(pimpl_->kill_timer);
180 void Actor::kill(aid_t pid)
182 smx_actor_t killer = SIMIX_process_self();
183 smx_actor_t process = SIMIX_process_from_PID(pid);
184 if (process != nullptr) {
185 simgrid::simix::simcall([killer, process] { SIMIX_process_kill(process, killer); });
187 std::ostringstream oss;
188 oss << "kill: (" << pid << ") - No such actor" << std::endl;
189 throw std::runtime_error(oss.str());
195 smx_actor_t process = SIMIX_process_self();
196 simgrid::simix::simcall(
197 [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
200 smx_actor_t Actor::get_impl()
205 // ***** Static functions *****
207 ActorPtr Actor::by_pid(aid_t pid)
209 smx_actor_t process = SIMIX_process_from_PID(pid);
210 if (process != nullptr)
211 return process->iface();
216 void Actor::kill_all()
218 smx_actor_t self = SIMIX_process_self();
219 simgrid::simix::simcall([&self] { SIMIX_process_killall(self); });
222 std::unordered_map<std::string, std::string>* Actor::get_properties()
224 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
227 /** Retrieve the property value (or nullptr if not set) */
228 const char* Actor::get_property(std::string key)
230 return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
233 void Actor::set_property(std::string key, std::string value)
235 simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
238 Actor* Actor::restart()
240 return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
243 // ***** this_actor *****
245 namespace this_actor {
247 /** Returns true if run from the kernel mode, and false if run from a real actor
249 * Everything that is run out of any actor (simulation setup before the engine is run,
250 * computing the model evolutions as a result to the actors' action, etc) is run in
251 * kernel mode, just as in any operating systems.
253 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
254 * because it is the one scheduling when the others should move or wait.
258 smx_actor_t process = SIMIX_process_self();
259 return process == nullptr || process == simix_global->maestro_process;
262 void sleep_for(double duration)
265 smx_actor_t actor = SIMIX_process_self();
266 simgrid::s4u::Actor::on_sleep(actor->iface());
268 simcall_process_sleep(duration);
270 simgrid::s4u::Actor::on_wake_up(actor->iface());
276 simgrid::simix::simcall([] { /* do nothing*/ });
279 XBT_PUBLIC void sleep_until(double timeout)
281 double now = SIMIX_get_clock();
283 sleep_for(timeout - now);
286 void execute(double flops)
288 execute(flops, 1.0 /* priority */);
291 void execute(double flops, double priority)
293 exec_init(flops)->set_priority(priority)->start()->wait();
296 void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
299 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
300 simcall_execution_wait(s);
303 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
305 parallel_execute(host_nb, host_list, flops_amount, bytes_amount, /* timeout */ -1);
308 ExecPtr exec_init(double flops_amount)
310 ExecPtr res = ExecPtr(new Exec());
311 res->host_ = get_host();
312 res->flops_amount_ = flops_amount;
313 res->set_remaining(flops_amount);
317 ExecPtr exec_async(double flops)
319 ExecPtr res = exec_init(flops);
326 return SIMIX_process_self()->pid_;
331 return SIMIX_process_self()->ppid_;
334 std::string get_name()
336 return SIMIX_process_self()->get_name();
339 const char* get_cname()
341 return SIMIX_process_self()->get_cname();
346 return SIMIX_process_self()->host_;
351 smx_actor_t actor = SIMIX_process_self();
352 simgrid::s4u::Actor::on_suspend(actor->iface());
354 simcall_process_suspend(actor);
359 smx_actor_t process = SIMIX_process_self();
360 simgrid::simix::simcall([process] { process->resume(); });
361 simgrid::s4u::Actor::on_resume(process->iface());
366 smx_actor_t process = SIMIX_process_self();
367 return simgrid::simix::simcall([process] { return process->suspended_; });
372 smx_actor_t process = SIMIX_process_self();
373 simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
376 void on_exit(std::function<void(int, void*)> fun, void* data)
378 SIMIX_process_self()->iface()->on_exit(fun, data);
381 /** @brief Moves the current actor to another host
383 * @see simgrid::s4u::Actor::migrate() for more information
385 void migrate(Host* new_host)
387 SIMIX_process_self()->iface()->migrate(new_host);
390 std::string getName() /* deprecated */
394 const char* getCname() /* deprecated */
398 bool isMaestro() /* deprecated */
402 aid_t getPid() /* deprecated */
406 aid_t getPpid() /* deprecated */
410 Host* getHost() /* deprecated */
414 bool isSuspended() /* deprecated */
416 return is_suspended();
418 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
420 SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
422 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
424 on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
426 void kill() /* deprecated */
431 } // namespace this_actor
433 } // namespace simgrid
435 /* **************************** Public C interface *************************** */
437 /** @ingroup m_actor_management
438 * @brief Returns the process ID of @a actor.
440 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
442 int sg_actor_get_PID(sg_actor_t actor)
444 /* Do not raise an exception here: this function is called by the logs
445 * and the exceptions, so it would be called back again and again */
446 if (actor == nullptr || actor->get_impl() == nullptr)
448 return actor->get_pid();
451 /** @ingroup m_actor_management
452 * @brief Returns the process ID of the parent of @a actor.
454 * This function checks whether @a actor is a valid pointer and return its parent's PID.
455 * Returns -1 if the actor has not been created by any other actor.
457 int sg_actor_get_PPID(sg_actor_t actor)
459 return actor->get_ppid();
462 /** @ingroup m_actor_management
464 * @brief Return a #sg_actor_t given its PID.
466 * 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.
467 * If none is found, @c nullptr is returned.
468 Note that the PID are unique in the whole simulation, not only on a given host.
470 sg_actor_t sg_actor_by_PID(aid_t pid)
472 return simgrid::s4u::Actor::by_pid(pid).get();
475 /** @ingroup m_actor_management
476 * @brief Return the name of an actor.
478 const char* sg_actor_get_name(sg_actor_t actor)
480 return actor->get_cname();
483 sg_host_t sg_actor_get_host(sg_actor_t actor)
485 return actor->get_host();
488 /** @ingroup m_actor_management
489 * @brief Returns the value of a given actor property
491 * @param actor an actor
492 * @param name a property name
493 * @return value of a property (or nullptr if the property is not set)
495 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
497 return actor->get_property(name);
500 /** @ingroup m_actor_management
501 * @brief Return the list of properties
503 * This function returns all the parameters associated with an actor
505 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
507 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
508 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
509 std::unordered_map<std::string, std::string>* props = actor->get_properties();
510 if (props == nullptr)
512 for (auto const& kv : *props) {
513 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
518 /** @ingroup m_actor_management
519 * @brief Suspend the actor.
521 * This function suspends the actor by suspending the task on which it was waiting for the completion.
523 void sg_actor_suspend(sg_actor_t actor)
525 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
529 /** @ingroup m_actor_management
530 * @brief Resume a suspended actor.
532 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
534 void sg_actor_resume(sg_actor_t actor)
536 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
540 /** @ingroup m_actor_management
541 * @brief Returns true if the actor is suspended .
543 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
545 int sg_actor_is_suspended(sg_actor_t actor)
547 return actor->is_suspended();
551 * @ingroup m_actor_management
552 * @brief Restarts an actor from the beginning.
554 sg_actor_t sg_actor_restart(sg_actor_t actor)
556 return actor->restart();
560 * @ingroup m_actor_management
561 * @brief Sets the "auto-restart" flag of the actor.
562 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
564 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
566 actor->set_auto_restart(auto_restart);
569 /** @ingroup m_actor_management
570 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
572 void sg_actor_daemonize(sg_actor_t actor)
577 /** @ingroup m_actor_management
578 * @brief Migrates an actor to another location.
580 * This function changes the value of the #sg_host_t on which @a actor is running.
582 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
584 process->migrate(host);
587 /** @ingroup m_actor_management
588 * @brief Wait for the completion of a #sg_actor_t.
590 * @param actor the actor to wait for
591 * @param timeout wait until the actor is over, or the timeout expires
593 void sg_actor_join(sg_actor_t actor, double timeout)
595 actor->join(timeout);
598 void sg_actor_kill(sg_actor_t actor)
603 void sg_actor_kill_all()
605 simgrid::s4u::Actor::kill_all();
608 /** @ingroup m_actor_management
609 * @brief Set the kill time of an actor.
611 * @param actor an actor
612 * @param kill_time the time when the actor is killed.
614 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
616 actor->set_kill_time(kill_time);
619 /** Yield the current actor; let the other actors execute first */
620 void sg_actor_yield()
622 simgrid::s4u::this_actor::yield();