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_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 = SIMIX_context_self();
35 if (self_context == nullptr)
36 return simgrid::s4u::ActorPtr();
38 return self_context->process()->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 simgrid::simix::ActorCode code = factory(std::move(args));
51 simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
52 return actor->iface();
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_->auto_restart_); // FIXME: handle all cases
80 pimpl_->set_auto_restart(autorestart);
82 simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->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_->host_->pimpl_->actors_at_boot_.emplace_back(arg);
88 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
90 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
93 void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
95 simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
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(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
297 std::vector<double> bytes_amounts)
299 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
301 void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
302 std::vector<double> bytes_amounts, double timeout)
304 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
305 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
306 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
307 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
308 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
309 hosts.size(), hosts.size(), flops_amounts.size());
311 /* The vectors live as parameter of parallel_execute. No copy is created for simcall_execution_parallel_start(),
312 * but that's OK because simcall_execution_wait() is called from here too.
314 smx_activity_t s = simcall_execution_parallel_start("", hosts.size(), hosts.data(),
315 (flops_amounts.empty() ? nullptr : flops_amounts.data()),
316 (bytes_amounts.empty() ? nullptr : bytes_amounts.data()),
317 /* rate */ -1, timeout);
318 simcall_execution_wait(s);
321 void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
324 simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
325 simcall_execution_wait(s);
326 delete[] flops_amount;
327 delete[] bytes_amount;
330 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
332 parallel_execute(host_nb, host_list, flops_amount, bytes_amount, /* timeout */ -1);
335 ExecPtr exec_init(double flops_amount)
337 ExecPtr res = ExecPtr(new Exec());
338 res->host_ = get_host();
339 res->flops_amount_ = flops_amount;
340 res->set_remaining(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 return simgrid::simix::simcall([process] { return process->suspended_; });
399 smx_actor_t process = SIMIX_process_self();
400 simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
403 void on_exit(std::function<void(int, void*)> fun, void* data)
405 SIMIX_process_self()->iface()->on_exit(fun, data);
408 /** @brief Moves the current actor to another host
410 * @see simgrid::s4u::Actor::migrate() for more information
412 void migrate(Host* new_host)
414 SIMIX_process_self()->iface()->migrate(new_host);
417 std::string getName() /* deprecated */
421 const char* getCname() /* deprecated */
425 bool isMaestro() /* deprecated */
429 aid_t getPid() /* deprecated */
433 aid_t getPpid() /* deprecated */
437 Host* getHost() /* deprecated */
441 bool isSuspended() /* deprecated */
443 return is_suspended();
445 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
447 SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
449 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
451 on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
453 void kill() /* deprecated */
458 } // namespace this_actor
460 } // namespace simgrid
462 /* **************************** Public C interface *************************** */
464 /** @ingroup m_actor_management
465 * @brief Returns the process ID of @a actor.
467 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
469 int sg_actor_get_PID(sg_actor_t actor)
471 /* Do not raise an exception here: this function is called by the logs
472 * and the exceptions, so it would be called back again and again */
473 if (actor == nullptr || actor->get_impl() == nullptr)
475 return actor->get_pid();
478 /** @ingroup m_actor_management
479 * @brief Returns the process ID of the parent of @a actor.
481 * This function checks whether @a actor is a valid pointer and return its parent's PID.
482 * Returns -1 if the actor has not been created by any other actor.
484 int sg_actor_get_PPID(sg_actor_t actor)
486 return actor->get_ppid();
489 /** @ingroup m_actor_management
491 * @brief Return a #sg_actor_t given its PID.
493 * 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.
494 * If none is found, @c nullptr is returned.
495 Note that the PID are unique in the whole simulation, not only on a given host.
497 sg_actor_t sg_actor_by_PID(aid_t pid)
499 return simgrid::s4u::Actor::by_pid(pid).get();
502 /** @ingroup m_actor_management
503 * @brief Return the name of an actor.
505 const char* sg_actor_get_name(sg_actor_t actor)
507 return actor->get_cname();
510 sg_host_t sg_actor_get_host(sg_actor_t actor)
512 return actor->get_host();
515 /** @ingroup m_actor_management
516 * @brief Returns the value of a given actor property
518 * @param actor an actor
519 * @param name a property name
520 * @return value of a property (or nullptr if the property is not set)
522 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
524 return actor->get_property(name);
527 /** @ingroup m_actor_management
528 * @brief Return the list of properties
530 * This function returns all the parameters associated with an actor
532 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
534 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
535 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
536 std::unordered_map<std::string, std::string>* props = actor->get_properties();
537 if (props == nullptr)
539 for (auto const& kv : *props) {
540 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
545 /** @ingroup m_actor_management
546 * @brief Suspend the actor.
548 * This function suspends the actor by suspending the task on which it was waiting for the completion.
550 void sg_actor_suspend(sg_actor_t actor)
552 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
556 /** @ingroup m_actor_management
557 * @brief Resume a suspended actor.
559 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
561 void sg_actor_resume(sg_actor_t actor)
563 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
567 /** @ingroup m_actor_management
568 * @brief Returns true if the actor is suspended .
570 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
572 int sg_actor_is_suspended(sg_actor_t actor)
574 return actor->is_suspended();
578 * @ingroup m_actor_management
579 * @brief Restarts an actor from the beginning.
581 sg_actor_t sg_actor_restart(sg_actor_t actor)
583 return actor->restart();
587 * @ingroup m_actor_management
588 * @brief Sets the "auto-restart" flag of the actor.
589 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
591 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
593 actor->set_auto_restart(auto_restart);
596 /** @ingroup m_actor_management
597 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
599 void sg_actor_daemonize(sg_actor_t actor)
604 /** @ingroup m_actor_management
605 * @brief Migrates an actor to another location.
607 * This function changes the value of the #sg_host_t on which @a actor is running.
609 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
611 process->migrate(host);
614 /** @ingroup m_actor_management
615 * @brief Wait for the completion of a #sg_actor_t.
617 * @param actor the actor to wait for
618 * @param timeout wait until the actor is over, or the timeout expires
620 void sg_actor_join(sg_actor_t actor, double timeout)
622 actor->join(timeout);
625 void sg_actor_kill(sg_actor_t actor)
630 void sg_actor_kill_all()
632 simgrid::s4u::Actor::kill_all();
635 /** @ingroup m_actor_management
636 * @brief Set the kill time of an actor.
638 * @param actor an actor
639 * @param kill_time the time when the actor is killed.
641 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
643 actor->set_kill_time(kill_time);
646 /** Yield the current actor; let the other actors execute first */
647 void sg_actor_yield()
649 simgrid::s4u::this_actor::yield();