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/Exception.hpp"
7 #include "simgrid/actor.h"
8 #include "simgrid/modelchecker.h"
9 #include "simgrid/s4u/Actor.hpp"
10 #include "simgrid/s4u/Exec.hpp"
11 #include "simgrid/s4u/Host.hpp"
12 #include "simgrid/s4u/VirtualMachine.hpp"
13 #include "src/include/mc/mc.h"
14 #include "src/kernel/activity/ExecImpl.hpp"
15 #include "src/mc/mc_replay.hpp"
16 #include "src/surf/HostImpl.hpp"
21 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
26 xbt::signal<void(Actor&)> s4u::Actor::on_creation;
27 xbt::signal<void(Actor const&)> s4u::Actor::on_suspend;
28 xbt::signal<void(Actor const&)> s4u::Actor::on_resume;
29 xbt::signal<void(Actor const&)> s4u::Actor::on_sleep;
30 xbt::signal<void(Actor const&)> s4u::Actor::on_wake_up;
31 xbt::signal<void(Actor const&)> s4u::Actor::on_migration_start;
32 xbt::signal<void(Actor const&)> s4u::Actor::on_migration_end;
33 xbt::signal<void(Actor const&)> s4u::Actor::on_termination;
34 xbt::signal<void(Actor const&)> s4u::Actor::on_destruction;
36 // ***** Actor creation *****
39 kernel::context::Context* self_context = kernel::context::Context::self();
40 if (self_context == nullptr)
43 return self_context->get_actor()->ciface();
46 ActorPtr Actor::init(const std::string& name, s4u::Host* host)
48 kernel::actor::ActorImpl* self = SIMIX_process_self();
49 kernel::actor::ActorImpl* actor =
50 kernel::actor::simcall([self, &name, host] { return self->init(name, host).get(); });
51 return actor->iface();
54 ActorPtr Actor::start(const std::function<void()>& code)
56 simgrid::kernel::actor::simcall([this, &code] { pimpl_->start(code); });
60 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::function<void()>& code)
62 kernel::actor::ActorImpl* self = SIMIX_process_self();
63 kernel::actor::ActorImpl* actor =
64 kernel::actor::simcall([self, &name, host, &code] { return self->init(name, host)->start(code); });
66 return actor->iface();
69 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function,
70 std::vector<std::string> args)
72 simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
73 return create(name, host, factory(std::move(args)));
76 void intrusive_ptr_add_ref(Actor* actor)
78 intrusive_ptr_add_ref(actor->pimpl_);
80 void intrusive_ptr_release(Actor* actor)
82 intrusive_ptr_release(actor->pimpl_);
84 int Actor::get_refcount()
86 return pimpl_->get_refcount();
89 // ***** Actor methods *****
96 void Actor::join(double timeout)
98 kernel::actor::ActorImpl* issuer = SIMIX_process_self();
99 kernel::actor::ActorImpl* target = pimpl_;
100 kernel::actor::simcall_blocking<void>([issuer, target, timeout] {
101 if (target->finished_) {
102 // The joined process is already finished, just wake up the issuer right away
103 issuer->simcall_answer();
105 smx_activity_t sync = issuer->join(target, timeout);
106 sync->register_simcall(&issuer->simcall);
111 void Actor::set_auto_restart(bool autorestart)
113 kernel::actor::simcall([this, autorestart]() {
114 xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
115 pimpl_->set_auto_restart(autorestart);
117 kernel::actor::ProcessArg* arg = new kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
118 XBT_DEBUG("Adding %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
119 pimpl_->get_host()->pimpl_->add_actor_at_boot(arg);
123 void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun) const
125 kernel::actor::simcall([this, &fun] { SIMIX_process_on_exit(pimpl_, fun); });
128 void Actor::migrate(Host* new_host)
130 s4u::Actor::on_migration_start(*this);
132 kernel::actor::simcall([this, new_host]() {
133 if (pimpl_->waiting_synchro != nullptr) {
134 // The actor is blocked on an activity. If it's an exec, migrate it too.
135 // FIXME: implement the migration of other kinds of activities
136 kernel::activity::ExecImplPtr exec =
137 boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
138 xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
139 exec->migrate(new_host);
141 this->pimpl_->set_host(new_host);
144 s4u::Actor::on_migration_end(*this);
147 s4u::Host* Actor::get_host() const
149 return this->pimpl_->get_host();
152 void Actor::daemonize()
154 kernel::actor::simcall([this]() { pimpl_->daemonize(); });
157 bool Actor::is_daemon() const
159 return this->pimpl_->is_daemon();
162 const simgrid::xbt::string& Actor::get_name() const
164 return this->pimpl_->get_name();
167 const char* Actor::get_cname() const
169 return this->pimpl_->get_cname();
172 aid_t Actor::get_pid() const
174 return this->pimpl_->get_pid();
177 aid_t Actor::get_ppid() const
179 return this->pimpl_->get_ppid();
182 void Actor::suspend()
184 kernel::actor::ActorImpl* issuer = SIMIX_process_self();
185 kernel::actor::ActorImpl* target = pimpl_;
186 s4u::Actor::on_suspend(*this);
187 kernel::actor::simcall_blocking<void>([issuer, target]() {
189 if (target != issuer) {
190 /* If we are suspending ourselves, then just do not finish the simcall now */
191 issuer->simcall_answer();
198 kernel::actor::simcall([this] { pimpl_->resume(); });
199 s4u::Actor::on_resume(*this);
202 bool Actor::is_suspended()
204 return pimpl_->is_suspended();
207 void Actor::set_kill_time(double kill_time)
209 kernel::actor::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
212 /** @brief Get the kill time of an actor(or 0 if unset). */
213 double Actor::get_kill_time()
215 return pimpl_->get_kill_time();
220 kernel::actor::ActorImpl* self = SIMIX_process_self();
221 kernel::actor::simcall([this, self] { self->kill(pimpl_); });
224 // ***** Static functions *****
226 ActorPtr Actor::by_pid(aid_t pid)
228 kernel::actor::ActorImpl* actor = SIMIX_process_from_PID(pid);
229 if (actor != nullptr)
230 return actor->iface();
235 void Actor::kill_all()
237 kernel::actor::ActorImpl* self = SIMIX_process_self();
238 kernel::actor::simcall([self] { self->kill_all(); });
241 const std::unordered_map<std::string, std::string>* Actor::get_properties() const
243 return pimpl_->get_properties();
246 /** Retrieve the property value (or nullptr if not set) */
247 const char* Actor::get_property(const std::string& key) const
249 return pimpl_->get_property(key);
252 void Actor::set_property(const std::string& key, const std::string& value)
254 kernel::actor::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
257 Actor* Actor::restart()
259 return kernel::actor::simcall([this]() { return pimpl_->restart(); });
262 // ***** this_actor *****
264 namespace this_actor {
266 /** Returns true if run from the kernel mode, and false if run from a real actor
268 * Everything that is run out of any actor (simulation setup before the engine is run,
269 * computing the model evolutions as a result to the actors' action, etc) is run in
270 * kernel mode, just as in any operating systems.
272 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
273 * because it is the one scheduling when the others should move or wait.
277 return SIMIX_is_maestro();
280 void sleep_for(double duration)
282 xbt_assert(std::isfinite(duration), "duration is not finite!");
285 kernel::actor::ActorImpl* issuer = SIMIX_process_self();
286 Actor::on_sleep(*issuer->ciface());
288 kernel::actor::simcall_blocking<void>([issuer, duration]() {
289 if (MC_is_active() || MC_record_replay_is_active()) {
290 MC_process_clock_add(issuer, duration);
291 issuer->simcall_answer();
294 smx_activity_t sync = issuer->sleep(duration);
295 sync->register_simcall(&issuer->simcall);
298 Actor::on_wake_up(*issuer->ciface());
304 kernel::actor::simcall([] { /* do nothing*/ });
307 XBT_PUBLIC void sleep_until(double wakeup_time)
309 double now = SIMIX_get_clock();
310 if (wakeup_time > now)
311 sleep_for(wakeup_time - now);
314 void execute(double flops)
316 execute(flops, 1.0 /* priority */);
319 void execute(double flops, double priority)
321 exec_init(flops)->set_priority(priority)->start()->wait();
324 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
325 const std::vector<double>& bytes_amounts)
327 parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
330 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
331 const std::vector<double>& bytes_amounts, double timeout)
333 xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
334 xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
335 "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
336 xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
337 "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
338 hosts.size(), hosts.size(), flops_amounts.size());
339 /* Check that we are not mixing VMs and PMs in the parallel task */
340 bool is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(hosts.front()));
341 xbt_assert(std::all_of(hosts.begin(), hosts.end(),
342 [is_a_vm](s4u::Host* elm) {
343 bool tmp_is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(elm));
344 return is_a_vm == tmp_is_a_vm;
346 "parallel_execute: mixing VMs and PMs is not supported (yet).");
347 /* checking for infinite values */
348 xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
349 "flops_amounts comprises infinite values!");
350 xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
351 "flops_amounts comprises infinite values!");
353 exec_init(hosts, flops_amounts, bytes_amounts)->set_timeout(timeout)->wait();
356 ExecPtr exec_init(double flops_amount)
358 return ExecPtr(new ExecSeq(get_host(), flops_amount));
361 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
362 const std::vector<double>& bytes_amounts)
364 return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts));
367 ExecPtr exec_async(double flops)
369 ExecPtr res = exec_init(flops);
376 return SIMIX_process_self()->get_pid();
381 return SIMIX_process_self()->get_ppid();
384 std::string get_name()
386 return SIMIX_process_self()->get_name();
389 const char* get_cname()
391 return SIMIX_process_self()->get_cname();
396 return SIMIX_process_self()->get_host();
401 kernel::actor::ActorImpl* self = SIMIX_process_self();
402 s4u::Actor::on_suspend(*self->ciface());
403 kernel::actor::simcall_blocking<void>([self] { self->suspend(); });
408 kernel::actor::ActorImpl* self = SIMIX_process_self();
409 kernel::actor::simcall([self] { self->resume(); });
410 Actor::on_resume(*self->ciface());
415 kernel::actor::ActorImpl* self = SIMIX_process_self();
416 simgrid::kernel::actor::simcall([self] { self->exit(); });
419 void on_exit(const std::function<void(bool)>& fun)
421 SIMIX_process_self()->iface()->on_exit(fun);
424 /** @brief Moves the current actor to another host
426 * @see simgrid::s4u::Actor::migrate() for more information
428 void migrate(Host* new_host)
430 SIMIX_process_self()->iface()->migrate(new_host);
433 } // namespace this_actor
435 } // namespace simgrid
437 /* **************************** Public C interface *************************** */
439 sg_actor_t sg_actor_init(const char* name, sg_host_t host)
441 return simgrid::s4u::Actor::init(name, host).get();
444 void sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, char** argv)
446 simgrid::simix::ActorCode function;
448 function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
449 actor->start(std::move(function));
452 /** @ingroup m_actor_management
453 * @brief Returns the process ID of @a actor.
455 * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
457 aid_t sg_actor_get_PID(sg_actor_t actor)
459 /* Do not raise an exception here: this function is called by the logs
460 * and the exceptions, so it would be called back again and again */
461 if (actor == nullptr || actor->get_impl() == nullptr)
463 return actor->get_pid();
466 /** @ingroup m_actor_management
467 * @brief Returns the process ID of the parent of @a actor.
469 * This function checks whether @a actor is a valid pointer and return its parent's PID.
470 * Returns -1 if the actor has not been created by any other actor.
472 aid_t sg_actor_get_PPID(sg_actor_t actor)
474 return actor->get_ppid();
477 /** @ingroup m_actor_management
479 * @brief Return a #sg_actor_t given its PID.
481 * 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.
482 * If none is found, @c nullptr is returned.
483 Note that the PID are unique in the whole simulation, not only on a given host.
485 sg_actor_t sg_actor_by_PID(aid_t pid)
487 return simgrid::s4u::Actor::by_pid(pid).get();
490 /** @ingroup m_actor_management
491 * @brief Return the name of an actor.
493 const char* sg_actor_get_name(sg_actor_t actor)
495 return actor->get_cname();
498 sg_host_t sg_actor_get_host(sg_actor_t actor)
500 return actor->get_host();
503 /** @ingroup m_actor_management
504 * @brief Returns the value of a given actor property
506 * @param actor an actor
507 * @param name a property name
508 * @return value of a property (or nullptr if the property is not set)
510 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
512 return actor->get_property(name);
515 /** @ingroup m_actor_management
516 * @brief Return the list of properties
518 * This function returns all the parameters associated with an actor
520 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
522 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
523 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
524 const std::unordered_map<std::string, std::string>* props = actor->get_properties();
525 if (props == nullptr)
527 for (auto const& kv : *props) {
528 xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()));
533 /** @ingroup m_actor_management
534 * @brief Suspend the actor.
536 * This function suspends the actor by suspending the task on which it was waiting for the completion.
538 void sg_actor_suspend(sg_actor_t actor)
540 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
544 /** @ingroup m_actor_management
545 * @brief Resume a suspended actor.
547 * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
549 void sg_actor_resume(sg_actor_t actor)
551 xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
555 /** @ingroup m_actor_management
556 * @brief Returns true if the actor is suspended .
558 * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
560 int sg_actor_is_suspended(sg_actor_t actor)
562 return actor->is_suspended();
566 * @ingroup m_actor_management
567 * @brief Restarts an actor from the beginning.
569 sg_actor_t sg_actor_restart(sg_actor_t actor)
571 return actor->restart();
575 * @ingroup m_actor_management
576 * @brief Sets the "auto-restart" flag of the actor.
577 * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
579 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
581 actor->set_auto_restart(auto_restart);
584 /** @ingroup m_actor_management
585 * @brief This actor will be terminated automatically when the last non-daemon actor finishes
587 void sg_actor_daemonize(sg_actor_t actor)
592 /** @ingroup m_actor_management
593 * @brief Migrates an actor to another location.
595 * This function changes the value of the #sg_host_t on which @a actor is running.
597 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
599 process->migrate(host);
602 /** @ingroup m_actor_management
603 * @brief Wait for the completion of a #sg_actor_t.
605 * @param actor the actor to wait for
606 * @param timeout wait until the actor is over, or the timeout expires
608 void sg_actor_join(sg_actor_t actor, double timeout)
610 actor->join(timeout);
613 void sg_actor_kill(sg_actor_t actor)
618 void sg_actor_kill_all()
620 simgrid::s4u::Actor::kill_all();
623 /** @ingroup m_actor_management
624 * @brief Set the kill time of an actor.
626 * @param actor an actor
627 * @param kill_time the time when the actor is killed.
629 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
631 actor->set_kill_time(kill_time);
634 /** Yield the current actor; let the other actors execute first */
635 void sg_actor_yield()
637 simgrid::s4u::this_actor::yield();
640 void sg_actor_sleep_for(double duration)
642 simgrid::s4u::this_actor::sleep_for(duration);
645 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
647 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
648 std::unordered_map<std::string, std::string> props;
649 xbt_dict_cursor_t cursor = nullptr;
652 xbt_dict_foreach (properties, cursor, key, value)
654 xbt_dict_free(&properties);
656 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
657 smx_actor_t actor = nullptr;
659 actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
660 } catch (simgrid::HostFailureException const&) {
661 xbt_die("Could not attach");
664 simgrid::s4u::this_actor::yield();
665 return actor->ciface();
668 void sg_actor_detach()
670 simgrid::kernel::actor::ActorImpl::detach();
673 aid_t sg_actor_self_get_pid()
675 return simgrid::s4u::this_actor::get_pid();
678 aid_t sg_actor_self_get_ppid()
680 return simgrid::s4u::this_actor::get_ppid();
683 const char* sg_actor_self_get_name()
685 return simgrid::s4u::this_actor::get_cname();
688 sg_actor_t sg_actor_self()
690 return simgrid::s4u::Actor::self();
693 void sg_actor_self_execute(double flops)
695 simgrid::s4u::this_actor::execute(flops);
698 /** @brief Take an extra reference on that actor to prevent it to be garbage-collected */
699 void sg_actor_ref(sg_actor_t actor)
701 intrusive_ptr_add_ref(actor);
703 /** @brief Release a reference on that actor so that it can get be garbage-collected */
704 void sg_actor_unref(sg_actor_t actor)
706 intrusive_ptr_release(actor);
709 /** @brief Return the user data of a #sg_actor_t */
710 void* sg_actor_data(const_sg_actor_t actor)
712 return actor->get_data();
714 /** @brief Set the user data of a #sg_actor_t */
715 void sg_actor_data_set(sg_actor_t actor, void* userdata)
717 actor->set_data(userdata);