X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5a15c64d854f8f8ecc35732c0534bd6cb4fb0bb8..cfcdf2e0866cb50cace1db634430d0861af5f0a1:/src/s4u/s4u_Actor.cpp diff --git a/src/s4u/s4u_Actor.cpp b/src/s4u/s4u_Actor.cpp index 5f75e2a1fd..70e3706975 100644 --- a/src/s4u/s4u_Actor.cpp +++ b/src/s4u/s4u_Actor.cpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -11,17 +11,20 @@ #include "simgrid/s4u/Host.hpp" #include "simgrid/s4u/VirtualMachine.hpp" #include "src/include/mc/mc.h" +#include "src/kernel/EngineImpl.hpp" #include "src/kernel/activity/ExecImpl.hpp" #include "src/mc/mc_replay.hpp" -#include "src/simix/smx_private.hpp" #include "src/surf/HostImpl.hpp" #include #include -XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors"); +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_actor, s4u, "S4U actors"); namespace simgrid { + +template class xbt::Extendable; + namespace s4u { xbt::signal s4u::Actor::on_creation; @@ -29,8 +32,9 @@ xbt::signal s4u::Actor::on_suspend; xbt::signal s4u::Actor::on_resume; xbt::signal s4u::Actor::on_sleep; xbt::signal s4u::Actor::on_wake_up; -xbt::signal s4u::Actor::on_migration_start; -xbt::signal s4u::Actor::on_migration_end; +xbt::signal s4u::Actor::on_migration_start; // deprecated +xbt::signal s4u::Actor::on_migration_end; // deprecated +xbt::signal s4u::Actor::on_host_change; xbt::signal s4u::Actor::on_termination; xbt::signal s4u::Actor::on_destruction; @@ -43,9 +47,10 @@ Actor* Actor::self() return self_context->get_actor()->ciface(); } + ActorPtr Actor::init(const std::string& name, s4u::Host* host) { - smx_actor_t self = SIMIX_process_self(); + kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self(); kernel::actor::ActorImpl* actor = kernel::actor::simcall([self, &name, host] { return self->init(name, host).get(); }); return actor->iface(); @@ -59,7 +64,7 @@ ActorPtr Actor::start(const std::function& code) ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::function& code) { - smx_actor_t self = SIMIX_process_self(); + kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self(); kernel::actor::ActorImpl* actor = kernel::actor::simcall([self, &name, host, &code] { return self->init(name, host)->start(code); }); @@ -69,15 +74,16 @@ ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::func ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function, std::vector args) { - simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function); + const simgrid::kernel::actor::ActorCodeFactory& factory = + simgrid::kernel::EngineImpl::get_instance()->get_function(function); return create(name, host, factory(std::move(args))); } -void intrusive_ptr_add_ref(Actor* actor) +void intrusive_ptr_add_ref(const Actor* actor) { intrusive_ptr_add_ref(actor->pimpl_); } -void intrusive_ptr_release(Actor* actor) +void intrusive_ptr_release(const Actor* actor) { intrusive_ptr_release(actor->pimpl_); } @@ -95,14 +101,14 @@ void Actor::join() void Actor::join(double timeout) { - auto issuer = SIMIX_process_self(); - auto target = pimpl_; + kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self(); + kernel::actor::ActorImpl* target = pimpl_; kernel::actor::simcall_blocking([issuer, target, timeout] { if (target->finished_) { // The joined process is already finished, just wake up the issuer right away issuer->simcall_answer(); } else { - smx_activity_t sync = issuer->join(target, timeout); + kernel::activity::ActivityImplPtr sync = issuer->join(target, timeout); sync->register_simcall(&issuer->simcall); } }); @@ -115,24 +121,29 @@ void Actor::set_auto_restart(bool autorestart) pimpl_->set_auto_restart(autorestart); kernel::actor::ProcessArg* arg = new kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_); - XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname()); - pimpl_->get_host()->pimpl_->actors_at_boot_.emplace_back(arg); + XBT_DEBUG("Adding %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname()); + pimpl_->get_host()->pimpl_->add_actor_at_boot(arg); }); } -void Actor::on_exit(const std::function& fun, void* data) /* deprecated */ -{ - on_exit([fun, data](bool failed) { fun(failed ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS, data); }); -} - void Actor::on_exit(const std::function& fun) const { - kernel::actor::simcall([this, &fun] { SIMIX_process_on_exit(pimpl_, fun); }); + kernel::actor::simcall([this, &fun] { pimpl_->on_exit->emplace_back(fun); }); } -void Actor::migrate(Host* new_host) +void Actor::set_host(Host* new_host) { - s4u::Actor::on_migration_start(*this); + if (s4u::Actor::on_migration_start.get_slot_count() > 0) { // XBT_ATTRIB_DEPRECATED_v329 + static bool already_warned = false; + if (not already_warned) { + XBT_INFO("Please use s4u::Actor::on_host_change instead of s4u::Actor::on_migration_start. This will be removed " + "in v3.29"); + already_warned = true; + } + s4u::Actor::on_migration_start(*this); + } + + const s4u::Host* previous_location = get_host(); kernel::actor::simcall([this, new_host]() { if (pimpl_->waiting_synchro != nullptr) { @@ -146,7 +157,17 @@ void Actor::migrate(Host* new_host) this->pimpl_->set_host(new_host); }); - s4u::Actor::on_migration_end(*this); + if (s4u::Actor::on_migration_end.get_slot_count() > 0) { // XBT_ATTRIB_DEPRECATED_v329 + static bool already_warned = false; + if (not already_warned) { + XBT_INFO("Please use s4u::Actor::on_host_change instead of s4u::Actor::on_migration_end. This will be removed in " + "v3.29"); + already_warned = true; + } + s4u::Actor::on_migration_end(*this); + } + + s4u::Actor::on_host_change(*this, *previous_location); } s4u::Host* Actor::get_host() const @@ -186,8 +207,8 @@ aid_t Actor::get_ppid() const void Actor::suspend() { - auto issuer = SIMIX_process_self(); - auto target = pimpl_; + kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self(); + kernel::actor::ActorImpl* target = pimpl_; s4u::Actor::on_suspend(*this); kernel::actor::simcall_blocking([issuer, target]() { target->suspend(); @@ -220,42 +241,26 @@ double Actor::get_kill_time() return pimpl_->get_kill_time(); } -void Actor::kill(aid_t pid) // deprecated -{ - kernel::actor::ActorImpl* killer = SIMIX_process_self(); - kernel::actor::ActorImpl* victim = SIMIX_process_from_PID(pid); - if (victim != nullptr) { - kernel::actor::simcall([killer, victim] { killer->kill(victim); }); - } else { - std::ostringstream oss; - oss << "kill: (" << pid << ") - No such actor" << std::endl; - throw std::runtime_error(oss.str()); - } -} - void Actor::kill() { - kernel::actor::ActorImpl* process = SIMIX_process_self(); - kernel::actor::simcall([this, process] { - xbt_assert(pimpl_ != simix_global->maestro_process, "Killing maestro is a rather bad idea"); - process->kill(pimpl_); - }); + kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self(); + kernel::actor::simcall([this, self] { self->kill(pimpl_); }); } // ***** Static functions ***** ActorPtr Actor::by_pid(aid_t pid) { - kernel::actor::ActorImpl* process = SIMIX_process_from_PID(pid); - if (process != nullptr) - return process->iface(); + kernel::actor::ActorImpl* actor = SIMIX_process_from_PID(pid); + if (actor != nullptr) + return actor->iface(); else return ActorPtr(); } void Actor::kill_all() { - kernel::actor::ActorImpl* self = SIMIX_process_self(); + kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self(); kernel::actor::simcall([self] { self->kill_all(); }); } @@ -295,8 +300,7 @@ namespace this_actor { */ bool is_maestro() { - kernel::actor::ActorImpl* process = SIMIX_process_self(); - return process == nullptr || process == simix_global->maestro_process; + return SIMIX_is_maestro(); } void sleep_for(double duration) @@ -304,7 +308,7 @@ void sleep_for(double duration) xbt_assert(std::isfinite(duration), "duration is not finite!"); if (duration > 0) { - kernel::actor::ActorImpl* issuer = SIMIX_process_self(); + kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self(); Actor::on_sleep(*issuer->ciface()); kernel::actor::simcall_blocking([issuer, duration]() { @@ -313,7 +317,7 @@ void sleep_for(double duration) issuer->simcall_answer(); return; } - smx_activity_t sync = issuer->sleep(duration); + kernel::activity::ActivityImplPtr sync = issuer->sleep(duration); sync->register_simcall(&issuer->simcall); }); @@ -346,11 +350,24 @@ void execute(double flops, double priority) void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, const std::vector& bytes_amounts) { - parallel_execute(hosts, flops_amounts, bytes_amounts, -1); + exec_init(hosts, flops_amounts, bytes_amounts)->wait(); } void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, - const std::vector& bytes_amounts, double timeout) + const std::vector& bytes_amounts, double timeout) // XBT_ATTRIB_DEPRECATED_v329 +{ + exec_init(hosts, flops_amounts, bytes_amounts)->wait_for(timeout); +} + +ExecPtr exec_init(double flops_amount) +{ + ExecPtr exec = ExecPtr(new Exec()); + exec->set_flops_amount(flops_amount)->set_host(get_host()); + return exec; +} + +ExecPtr exec_init(const std::vector& hosts, const std::vector& flops_amounts, + const std::vector& bytes_amounts) { xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host."); xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(), @@ -372,39 +389,9 @@ void parallel_execute(const std::vector& hosts, const std::vectorset_timeout(timeout)->wait(); -} - -// deprecated -void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount, - double timeout) -{ - smx_activity_t s = - simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout); - simcall_execution_wait(s); - delete[] flops_amount; - delete[] bytes_amount; -} - -// deprecated -void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount) -{ - smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, - /* rate */ -1, /*timeout*/ -1); - simcall_execution_wait(s); - delete[] flops_amount; - delete[] bytes_amount; -} - -ExecPtr exec_init(double flops_amount) -{ - return ExecPtr(new ExecSeq(get_host(), flops_amount)); -} - -ExecPtr exec_init(const std::vector& hosts, const std::vector& flops_amounts, - const std::vector& bytes_amounts) -{ - return ExecPtr(new ExecPar(hosts, flops_amounts, bytes_amounts)); + ExecPtr exec = ExecPtr(new Exec()); + exec->set_flops_amounts(flops_amounts)->set_bytes_amounts(bytes_amounts)->set_hosts(hosts); + return exec; } ExecPtr exec_async(double flops) @@ -416,66 +403,58 @@ ExecPtr exec_async(double flops) aid_t get_pid() { - return SIMIX_process_self()->get_pid(); + return simgrid::kernel::actor::ActorImpl::self()->get_pid(); } aid_t get_ppid() { - return SIMIX_process_self()->get_ppid(); + return simgrid::kernel::actor::ActorImpl::self()->get_ppid(); } std::string get_name() { - return SIMIX_process_self()->get_name(); + return simgrid::kernel::actor::ActorImpl::self()->get_name(); } const char* get_cname() { - return SIMIX_process_self()->get_cname(); + return simgrid::kernel::actor::ActorImpl::self()->get_cname(); } Host* get_host() { - return SIMIX_process_self()->get_host(); + return simgrid::kernel::actor::ActorImpl::self()->get_host(); } void suspend() { - kernel::actor::ActorImpl* self = SIMIX_process_self(); + kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self(); s4u::Actor::on_suspend(*self->ciface()); kernel::actor::simcall_blocking([self] { self->suspend(); }); } -void resume() -{ - kernel::actor::ActorImpl* self = SIMIX_process_self(); - kernel::actor::simcall([self] { self->resume(); }); - Actor::on_resume(*self->ciface()); -} - void exit() { - kernel::actor::ActorImpl* self = SIMIX_process_self(); + kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self(); simgrid::kernel::actor::simcall([self] { self->exit(); }); } void on_exit(const std::function& fun) { - SIMIX_process_self()->iface()->on_exit(fun); -} - -void on_exit(const std::function& fun, void* data) /* deprecated */ -{ - SIMIX_process_self()->iface()->on_exit([fun, data](bool exit) { fun(exit, data); }); + simgrid::kernel::actor::ActorImpl::self()->iface()->on_exit(fun); } /** @brief Moves the current actor to another host * * @see simgrid::s4u::Actor::migrate() for more information */ -void migrate(Host* new_host) +void set_host(Host* new_host) +{ + simgrid::kernel::actor::ActorImpl::self()->iface()->set_host(new_host); +} +void migrate(Host* new_host) // deprecated { - SIMIX_process_self()->iface()->migrate(new_host); + set_host(new_host); } } // namespace this_actor @@ -484,12 +463,31 @@ void migrate(Host* new_host) /* **************************** Public C interface *************************** */ -/** @ingroup m_actor_management +sg_actor_t sg_actor_init(const char* name, sg_host_t host) +{ + return simgrid::s4u::Actor::init(name, host).get(); +} + +void sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char* const* argv) +{ + simgrid::kernel::actor::ActorCode function; + if (code) + function = simgrid::xbt::wrap_main(code, argc, argv); + actor->start(std::move(function)); +} + +void sg_actor_exit() +{ + simgrid::s4u::this_actor::exit(); +} + +/** * @brief Returns the process ID of @a actor. * * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem). */ -aid_t sg_actor_get_PID(sg_actor_t actor) + +aid_t sg_actor_get_PID(const_sg_actor_t actor) { /* Do not raise an exception here: this function is called by the logs * and the exceptions, so it would be called back again and again */ @@ -498,19 +496,18 @@ aid_t sg_actor_get_PID(sg_actor_t actor) return actor->get_pid(); } -/** @ingroup m_actor_management +/** * @brief Returns the process ID of the parent of @a actor. * * This function checks whether @a actor is a valid pointer and return its parent's PID. * Returns -1 if the actor has not been created by any other actor. */ -aid_t sg_actor_get_PPID(sg_actor_t actor) +aid_t sg_actor_get_PPID(const_sg_actor_t actor) { return actor->get_ppid(); } -/** @ingroup m_actor_management - * +/** * @brief Return a #sg_actor_t given its PID. * * 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. @@ -522,37 +519,35 @@ sg_actor_t sg_actor_by_PID(aid_t pid) return simgrid::s4u::Actor::by_pid(pid).get(); } -/** @ingroup m_actor_management - * @brief Return the name of an actor. - */ -const char* sg_actor_get_name(sg_actor_t actor) +/** @brief Return the name of an actor. */ +const char* sg_actor_get_name(const_sg_actor_t actor) { return actor->get_cname(); } -sg_host_t sg_actor_get_host(sg_actor_t actor) +sg_host_t sg_actor_get_host(const_sg_actor_t actor) { return actor->get_host(); } -/** @ingroup m_actor_management +/** * @brief Returns the value of a given actor property * * @param actor an actor * @param name a property name * @return value of a property (or nullptr if the property is not set) */ -const char* sg_actor_get_property_value(sg_actor_t actor, const char* name) +const char* sg_actor_get_property_value(const_sg_actor_t actor, const char* name) { return actor->get_property(name); } -/** @ingroup m_actor_management +/** * @brief Return the list of properties * * This function returns all the parameters associated with an actor */ -xbt_dict_t sg_actor_get_properties(sg_actor_t actor) +xbt_dict_t sg_actor_get_properties(const_sg_actor_t actor) { xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr"); xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f); @@ -560,12 +555,12 @@ xbt_dict_t sg_actor_get_properties(sg_actor_t actor) if (props == nullptr) return nullptr; for (auto const& kv : *props) { - xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr); + xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str())); } return as_dict; } -/** @ingroup m_actor_management +/** * @brief Suspend the actor. * * This function suspends the actor by suspending the task on which it was waiting for the completion. @@ -576,7 +571,7 @@ void sg_actor_suspend(sg_actor_t actor) actor->suspend(); } -/** @ingroup m_actor_management +/** * @brief Resume a suspended actor. * * This function resumes a suspended actor by resuming the task on which it was waiting for the completion. @@ -587,7 +582,7 @@ void sg_actor_resume(sg_actor_t actor) actor->resume(); } -/** @ingroup m_actor_management +/** * @brief Returns true if the actor is suspended . * * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion. @@ -597,17 +592,13 @@ int sg_actor_is_suspended(sg_actor_t actor) return actor->is_suspended(); } -/** - * @ingroup m_actor_management - * @brief Restarts an actor from the beginning. - */ +/** @brief Restarts an actor from the beginning. */ sg_actor_t sg_actor_restart(sg_actor_t actor) { return actor->restart(); } /** - * @ingroup m_actor_management * @brief Sets the "auto-restart" flag of the actor. * If the flag is set to 1, the actor will be automatically restarted when its host comes back up. */ @@ -616,25 +607,33 @@ void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart) actor->set_auto_restart(auto_restart); } -/** @ingroup m_actor_management - * @brief This actor will be terminated automatically when the last non-daemon actor finishes - */ +/** @brief This actor will be terminated automatically when the last non-daemon actor finishes */ void sg_actor_daemonize(sg_actor_t actor) { actor->daemonize(); } -/** @ingroup m_actor_management +/** Returns whether or not this actor has been daemonized or not */ +int sg_actor_is_daemon(sg_actor_t actor) +{ + return actor->is_daemon(); +} + +/** * @brief Migrates an actor to another location. * * This function changes the value of the #sg_host_t on which @a actor is running. */ -void sg_actor_migrate(sg_actor_t process, sg_host_t host) +void sg_actor_set_host(sg_actor_t actor, sg_host_t host) { - process->migrate(host); + actor->set_host(host); +} +void sg_actor_migrate(sg_actor_t process, sg_host_t host) // deprecated +{ + process->set_host(host); } -/** @ingroup m_actor_management +/** * @brief Wait for the completion of a #sg_actor_t. * * @param actor the actor to wait for @@ -655,7 +654,7 @@ void sg_actor_kill_all() simgrid::s4u::Actor::kill_all(); } -/** @ingroup m_actor_management +/** * @brief Set the kill time of an actor. * * @param actor an actor @@ -677,6 +676,11 @@ void sg_actor_sleep_for(double duration) simgrid::s4u::this_actor::sleep_for(duration); } +void sg_actor_sleep_until(double wakeup_time) +{ + simgrid::s4u::this_actor::sleep_until(wakeup_time); +} + sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties) { xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr"); @@ -720,6 +724,16 @@ const char* sg_actor_self_get_name() return simgrid::s4u::this_actor::get_cname(); } +void* sg_actor_self_data() +{ + return simgrid::s4u::Actor::self()->get_data(); +} + +void sg_actor_self_data_set(void* userdata) +{ + simgrid::s4u::Actor::self()->set_data(userdata); +} + sg_actor_t sg_actor_self() { return simgrid::s4u::Actor::self(); @@ -731,12 +745,31 @@ void sg_actor_self_execute(double flops) } /** @brief Take an extra reference on that actor to prevent it to be garbage-collected */ -void sg_actor_ref(sg_actor_t actor) +void sg_actor_ref(const_sg_actor_t actor) { intrusive_ptr_add_ref(actor); } /** @brief Release a reference on that actor so that it can get be garbage-collected */ -void sg_actor_unref(sg_actor_t actor) +void sg_actor_unref(const_sg_actor_t actor) { intrusive_ptr_release(actor); } + +/** @brief Return the user data of a #sg_actor_t */ +void* sg_actor_data(const_sg_actor_t actor) +{ + return actor->get_data(); +} +/** @brief Set the user data of a #sg_actor_t */ +void sg_actor_data_set(sg_actor_t actor, void* userdata) +{ + actor->set_data(userdata); +} +/** @brief Add a function to the list of "on_exit" functions for the current process. + * The on_exit functions are the functions executed when your process is killed. + * You should use them to free the data used by your process. + */ +void sg_actor_on_exit(int_f_int_pvoid_t fun, void* data) +{ + simgrid::s4u::this_actor::on_exit([fun, data](bool failed) { fun(failed ? 1 /*FAILURE*/ : 0 /*SUCCESS*/, data); }); +}