X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4bb73cb3914b5f7b77a9ec1f8abe728e637cc016..6bc18b576fa4a890d8b9916d292ca67dfbf60dd3:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index b4cdc75136..cf5f0f10ef 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -6,28 +6,19 @@ #ifndef SIMGRID_S4U_ACTOR_HPP #define SIMGRID_S4U_ACTOR_HPP -#include -#include #include -#include -#include -#include -#include -#include -#include - +#include // deprecated wrappers +#include +#include #include #include -#include #include - -#include -#include +#include namespace simgrid { namespace s4u { -/** @ingroup s4u_api +/** * * An actor is an independent stream of execution in your distributed application. * @@ -51,7 +42,7 @@ namespace s4u { * pure function or as an object. It is very simple with functions: * * @code{.cpp} - * #include "s4u/actor.hpp" + * #include * * // Declare the code of your worker * void worker() { @@ -69,7 +60,7 @@ namespace s4u { * The syntax is slightly more complicated, but not much. * * @code{.cpp} - * #include "s4u/actor.hpp" + * #include * * // Declare the class representing your actors * class Worker { @@ -129,21 +120,21 @@ namespace s4u { */ /** @brief Simulation Agent */ -XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable -{ +class XBT_PUBLIC Actor : public simgrid::xbt::Extendable { +#ifndef DOXYGEN friend Exec; friend Mailbox; - friend simgrid::simix::ActorImpl; + friend simgrid::kernel::actor::ActorImpl; friend simgrid::kernel::activity::MailboxImpl; - simix::ActorImpl* pimpl_ = nullptr; +#endif + kernel::actor::ActorImpl* pimpl_ = nullptr; /** Wrap a (possibly non-copyable) single-use task into a `std::function` */ template static std::function wrap_task(F f, Args... args) { typedef decltype(f(std::move(args)...)) R; - auto task = std::make_shared>( - simgrid::xbt::makeTask(std::move(f), std::move(args)...)); + auto task = std::make_shared>(simgrid::xbt::make_task(std::move(f), std::move(args)...)); return [task] { (*task)(); }; } @@ -164,20 +155,36 @@ public: static ActorPtr self(); /** Signal to others that a new actor has been created **/ - static simgrid::xbt::signal onCreation; + static simgrid::xbt::signal on_creation; + /** Signal to others that an actor has been suspended**/ + static simgrid::xbt::signal on_suspend; + /** Signal to others that an actor has been resumed **/ + static simgrid::xbt::signal on_resume; + /** Signal to others that an actor is sleeping **/ + static simgrid::xbt::signal on_sleep; + /** Signal to others that an actor wakes up for a sleep **/ + static simgrid::xbt::signal on_wake_up; + /** Signal to others that an actor is going to migrated to another host**/ + static simgrid::xbt::signal on_migration_start; + /** Signal to others that an actor is has been migrated to another host **/ + static simgrid::xbt::signal on_migration_end; /** Signal indicating that the given actor is about to disappear */ - static simgrid::xbt::signal onDestruction; + static simgrid::xbt::signal on_destruction; - /** Create an actor using a function + /** Create an actor from a std::function * * If the actor is restarted, the actor has a fresh copy of the function. */ - static ActorPtr createActor(const char* name, s4u::Host* host, std::function code); + static ActorPtr create(std::string name, s4u::Host* host, std::function code); - static ActorPtr createActor(const char* name, s4u::Host* host, std::function*)> code, - std::vector* args) + /** Create an actor from a std::function + * + * If the actor is restarted, the actor has a fresh copy of the function. + */ + static ActorPtr create(std::string name, s4u::Host* host, std::function*)> code, + std::vector* args) { - return createActor(name, host, [code](std::vector* args) { code(args); }, args); + return create(name, host, [code](std::vector* args) { code(args); }, args); } /** Create an actor using code @@ -187,65 +194,72 @@ public: * state. In order to use auto-restart, an explicit `function` must be passed * instead. */ - template::type - > - static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args) + template ::type> + static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args) { - return createActor(name, host, wrap_task(std::move(code), std::move(args)...)); + return create(name, host, wrap_task(std::move(code), std::move(args)...)); } // Create actor from function name: - - static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector args); + static ActorPtr create(std::string name, s4u::Host* host, std::string function, std::vector args); // ***** Methods ***** /** This actor will be automatically terminated when the last non-daemon actor finishes **/ void daemonize(); /** Returns whether or not this actor has been daemonized or not **/ - bool isDaemon(); + bool is_daemon() const; /** Retrieves the name of that actor as a C++ string */ - const simgrid::xbt::string& getName() const; + const simgrid::xbt::string& get_name() const; /** Retrieves the name of that actor as a C string */ - const char* getCname() const; + const char* get_cname() const; /** Retrieves the host on which that actor is running */ - s4u::Host* getHost(); + s4u::Host* get_host(); /** Retrieves the PID of that actor * - * actor_id_t is an alias for unsigned long */ - aid_t getPid(); + * aid_t is an alias for long */ + aid_t get_pid() const; /** Retrieves the PPID of that actor * - * actor_id_t is an alias for unsigned long */ - aid_t getPpid(); + * aid_t is an alias for long */ + aid_t get_ppid() const; /** Suspend an actor by suspending the task on which it was waiting for the completion. */ void suspend(); /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */ void resume(); - + void yield(); - + /** Returns true if the actor is suspended. */ - int isSuspended(); + bool is_suspended(); /** If set to true, the actor will automatically restart when its host reboots */ - void setAutoRestart(bool autorestart); + void set_auto_restart(bool autorestart); /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions * executed when your actor is killed. You should use them to free the data used by your actor. */ - void onExit(int_f_pvoid_pvoid_t fun, void* data); + void on_exit(std::function fun, void* data); /** Sets the time at which that actor should be killed */ - void setKillTime(double time); + void set_kill_time(double time); /** Retrieves the time at which that actor will be killed (or -1 if not set) */ - double getKillTime(); + double get_kill_time(); + /** @brief Moves the actor to another host + * + * If the actor is currently blocked on an execution activity, the activity is also + * migrated to the new host. If it's blocked on another kind of activity, an error is + * raised as the mandated code is not written yet. Please report that bug if you need it. + * + * Asynchronous activities started by the actor are not migrated automatically, so you have + * to take care of this yourself (only you knows which ones should be migrated). + */ void migrate(Host * new_host); /** Ask the actor to die. @@ -261,36 +275,128 @@ public: static void kill(aid_t pid); /** Retrieves the actor that have the given PID (or nullptr if not existing) */ - static ActorPtr byPid(aid_t pid); + static ActorPtr by_pid(aid_t pid); - /** @brief Wait for the actor to finish. + /** Wait for the actor to finish. * * This blocks the calling actor until the actor on which we call join() is terminated */ void join(); void join(double timeout); - - // Static methods on all actors: + Actor* restart(); /** Ask kindly to all actors to die. Only the issuer will survive. */ - static void killAll(); - static void killAll(int resetPid); + static void kill_all(); /** Returns the internal implementation of this actor */ - simix::ActorImpl* getImpl(); + kernel::actor::ActorImpl* get_impl(); /** Retrieve the property value (or nullptr if not set) */ - std::map* getProperties(); - const char* getProperty(const char* key); - void setProperty(const char* key, const char* value); - Actor* restart(); + std::unordered_map* + get_properties(); // FIXME: do not export the map, but only the keys or something + const char* get_property(std::string key); + void set_property(std::string key, std::string value); + +#ifndef DOXYGEN + /** @deprecated See Actor::create() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( + const char* name, s4u::Host* host, std::function code) + { + return create(name, host, code); + } + /** @deprecated See Actor::create() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( + const char* name, s4u::Host* host, std::function*)> code, + std::vector* args) + { + return create(name, host, code, args); + } + /** @deprecated See Actor::create() */ + template ::type> + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( + const char* name, s4u::Host* host, F code, Args... args) + { + return create(name, host, code, std::move(args)...); + } + /** @deprecated See Actor::create() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( + const char* name, s4u::Host* host, const char* function, std::vector args) + { + return create(name, host, function, args); + } + /** @deprecated See Actor::is_daemon() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const; + /** @deprecated See Actor::get_name() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const + { + return get_name(); + } + /** @deprecated See Actor::get_cname() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); } + /** @deprecated See Actor::get_host() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); } + /** @deprecated See Actor::get_pid() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); } + /** @deprecated See Actor::get_ppid() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); } + /** @deprecated See Actor::is_suspended() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); } + /** @deprecated See Actor::set_auto_restart() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a) + { + set_auto_restart(a); + } + /** @deprecated Please use a std::function for first parameter */ + XBT_ATTRIB_DEPRECATED_v323("Please use a std::function for first parameter.") void on_exit( + int_f_pvoid_pvoid_t fun, void* data); + /** @deprecated See Actor::on_exit() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data) + { + on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data); + } + /** @deprecated See Actor::set_kill_time() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); } + /** @deprecated See Actor::get_kill_time() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); } + /** @deprecated See Actor::by_pid() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); } + /** @deprecated See Actor::kill_all() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); } + /** @deprecated See Actor::kill_all() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll( + int XBT_ATTRIB_UNUSED resetPid) + { + kill_all(); + } + /** @deprecated See Actor::get_impl() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); } + /** @deprecated See Actor::get_property() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key) + { + return get_property(key); + } + /** @deprecated See Actor::get_properties() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") std::map* getProperties() + { + std::map* res = new std::map(); + std::unordered_map* props = get_properties(); + for (auto const& kv : *props) + res->insert(kv); + return res; + } + /** @deprecated See Actor::get_properties() */ + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value) + { + set_property(key, value); + } +#endif }; /** @ingroup s4u_api * @brief Static methods working on the current actor (see @ref s4u::Actor) */ namespace this_actor { -XBT_PUBLIC bool isMaestro(); +XBT_PUBLIC bool is_maestro(); /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */ XBT_PUBLIC void sleep_for(double duration); @@ -308,12 +414,6 @@ template inline void sleep_until(const SimulationTimePoint for first parameter */ +XBT_ATTRIB_DEPRECATED_v323("Please use std::function for first parameter.") XBT_PUBLIC + void on_exit(int_f_pvoid_pvoid_t fun, void* data); /** @brief Add a function to the list of "on_exit" functions. */ -XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data); +XBT_PUBLIC void on_exit(std::function fun, void* data); /** @brief Migrate the actor to a new host. */ XBT_PUBLIC void migrate(Host* new_host); + +/** @deprecated See this_actor::get_name() */ +XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName(); +/** @deprecated See this_actor::get_cname() */ +XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname(); +/** @deprecated See this_actor::is_maestro() */ +XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_maestro()") XBT_PUBLIC bool isMaestro(); +/** @deprecated See this_actor::get_pid() */ +XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t getPid(); +/** @deprecated See this_actor::get_ppid() */ +XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid(); +/** @deprecated See this_actor::get_host() */ +XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost(); +/** @deprecated See this_actor::is_suspended() */ +XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended(); +/** @deprecated See this_actor::on_exit() */ +XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data); +/** @deprecated See this_actor::exit() */ +XBT_ATTRIB_DEPRECATED_v324("Please use this_actor::exit()") XBT_PUBLIC void kill(); +#endif } /** @} */