X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9dec3b0501e4464e246196d29dce6d03a6cbd2d7..65c0d8a136e324c1ae8ba2d5a9d8082c21370239:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 61a78a005e..44b9301984 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2019. 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. */ @@ -6,15 +6,18 @@ #ifndef SIMGRID_S4U_ACTOR_HPP #define SIMGRID_S4U_ACTOR_HPP -#include -#include // deprecated wrappers +#include + #include -#include #include #include #include #include +#include +#include // deprecated wrappers +#include + namespace simgrid { namespace s4u { @@ -120,18 +123,20 @@ namespace s4u { */ /** @brief Simulation Agent */ -class XBT_PUBLIC Actor : public simgrid::xbt::Extendable { - friend simgrid::s4u::Exec; - friend simgrid::s4u::Mailbox; - friend simgrid::kernel::actor::ActorImpl; - friend simgrid::kernel::activity::MailboxImpl; +class XBT_PUBLIC Actor : public xbt::Extendable { +#ifndef DOXYGEN + friend Exec; + friend Mailbox; + friend kernel::actor::ActorImpl; + friend kernel::activity::MailboxImpl; - kernel::actor::ActorImpl* pimpl_ = nullptr; + kernel::actor::ActorImpl* const pimpl_; +#endif explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {} public: - +#ifndef DOXYGEN // ***** No copy ***** Actor(Actor const&) = delete; Actor& operator=(Actor const&) = delete; @@ -139,42 +144,52 @@ public: // ***** Reference count ***** friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor); friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor); +#endif + /** Retrive the amount of references on that object. Useful to debug the automatic refcounting */ + int get_refcount(); // ***** Actor creation ***** /** Retrieve a reference to myself */ - static ActorPtr self(); + static Actor* self(); - /** Signal to others that a new actor has been created **/ - static simgrid::xbt::signal on_creation; + /** Fired when a new actor has been created **/ + static xbt::signal on_creation; /** Signal to others that an actor has been suspended**/ - static simgrid::xbt::signal on_suspend; + static xbt::signal on_suspend; /** Signal to others that an actor has been resumed **/ - static simgrid::xbt::signal on_resume; + static xbt::signal on_resume; /** Signal to others that an actor is sleeping **/ - static simgrid::xbt::signal on_sleep; + static xbt::signal on_sleep; /** Signal to others that an actor wakes up for a sleep **/ - static simgrid::xbt::signal on_wake_up; + static 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; + static 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 an actor is about to disappear. - * This signal is fired for any dying actor, which is mostly useful when - * designing plugins and extensions. If you want to register to the - * termination of a given actor, use this_actor::on_exit() instead.*/ - static simgrid::xbt::signal on_destruction; + static xbt::signal on_migration_end; + /** Signal indicating that an actor terminated its code. + * The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore. + * If you want to free extra data when the actor's destructor is called, use Actor::on_destruction. + * If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/ + static xbt::signal on_termination; + /** Signal indicating that an actor is about to disappear (its destructor was called). + * This signal is fired for any destructed actor, which is mostly useful when designing plugins and extensions. + * If you want to react to the end of the actor's code, use Actor::on_termination instead. + * If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/ + static xbt::signal on_destruction; /** 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); + static ActorPtr create(const std::string& name, s4u::Host* host, const std::function& code); + static ActorPtr init(const std::string& name, s4u::Host* host); + ActorPtr start(const std::function& code); /** Create an actor from a std::function * * If the actor is restarted, the actor has a fresh copy of the function. */ - template static ActorPtr create(std::string name, s4u::Host* host, F code) + template static ActorPtr create(const std::string& name, s4u::Host* host, F code) { return create(name, host, std::function(std::move(code))); } @@ -185,13 +200,14 @@ public: template ::type> - static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args) + static ActorPtr create(const std::string& name, s4u::Host* host, F code, Args... args) { return create(name, host, std::bind(std::move(code), std::move(args)...)); } // Create actor from function name: - static ActorPtr create(std::string name, s4u::Host* host, std::string function, std::vector args); + static ActorPtr create(const std::string& name, s4u::Host* host, const std::string& function, + std::vector args); // ***** Methods ***** /** This actor will be automatically terminated when the last non-daemon actor finishes **/ @@ -205,24 +221,18 @@ public: /** Retrieves the name of that actor as a C string */ const char* get_cname() const; /** Retrieves the host on which that actor is running */ - s4u::Host* get_host(); - /** Retrieves the PID of that actor - * - * aid_t is an alias for long */ + Host* get_host() const; + /** Retrieves the actor ID of that actor */ aid_t get_pid() const; - /** Retrieves the PPID of that actor - * - * aid_t is an alias for long */ + /** Retrieves the actor ID of that actor's creator */ aid_t get_ppid() const; - /** Suspend an actor by suspending the task on which it was waiting for the completion. */ + /** Suspend an actor, that is blocked until resume()ed by another actor */ void suspend(); - /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */ + /** Resume an actor that was previously suspend()ed */ void resume(); - void yield(); - /** Returns true if the actor is suspended. */ bool is_suspended(); @@ -231,8 +241,16 @@ public: /** 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. + * + * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot + * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are + * blocking functions forbidden in this setting, but also modifications to the global state. + * + * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed. + * It will be set to true if the actor was killed or failed because of an exception, + * while it will remain to false if the actor terminated gracefully. */ - void on_exit(std::function fun, void* data); + void on_exit(const std::function& fun) const; /** Sets the time at which that actor should be killed */ void set_kill_time(double time); @@ -260,125 +278,35 @@ public: */ void kill(); - /** Kill an actor from its ID */ - static void kill(aid_t pid); - /** Retrieves the actor that have the given PID (or nullptr if not existing) */ static ActorPtr by_pid(aid_t pid); /** Wait for the actor to finish. * - * This blocks the calling actor until the actor on which we call join() is terminated + * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is + * blocked until bob terminates. */ void join(); + + /** Wait for the actor to finish, or for the timeout to elapse. + * + * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is + * blocked until bob terminates. + */ void join(double timeout); Actor* restart(); - /** Ask kindly to all actors to die. Only the issuer will survive. */ + /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */ static void kill_all(); /** Returns the internal implementation of this actor */ - kernel::actor::ActorImpl* get_impl(); + kernel::actor::ActorImpl* get_impl() const { return pimpl_; } /** Retrieve the property value (or nullptr if not set) */ - 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::set_property()") void setProperty(const char* key, const char* value) - { - set_property(key, value); - } -#endif + const std::unordered_map* + get_properties() const; // FIXME: do not export the map, but only the keys or something + const char* get_property(const std::string& key) const; + void set_property(const std::string& key, const std::string& value); }; /** @ingroup s4u_api @@ -387,9 +315,10 @@ namespace this_actor { XBT_PUBLIC bool is_maestro(); -/** Block the actor sleeping for that amount of seconds (may throws hostFailure) */ +/** Block the current actor sleeping for that amount of seconds */ XBT_PUBLIC void sleep_for(double duration); -XBT_PUBLIC void sleep_until(double timeout); +/** Block the current actor sleeping until the specified timestamp */ +XBT_PUBLIC void sleep_until(double wakeup_time); template inline void sleep_for(std::chrono::duration duration) { @@ -397,16 +326,16 @@ template inline void sleep_for(std::chrono::duration inline void sleep_until(const SimulationTimePoint& timeout_time) +template inline void sleep_until(const SimulationTimePoint& wakeup_time) { - auto timeout_native = std::chrono::time_point_cast(timeout_time); + auto timeout_native = std::chrono::time_point_cast(wakeup_time); this_actor::sleep_until(timeout_native.time_since_epoch().count()); } -/** Block the actor, computing the given amount of flops */ +/** Block the current actor, computing the given amount of flops */ XBT_PUBLIC void execute(double flop); -/** Block the actor, computing the given amount of flops at the given priority. +/** Block the current actor, computing the given amount of flops at the given priority. * An execution of priority 2 computes twice as fast as an execution at priority 1. */ XBT_PUBLIC void execute(double flop, double priority); @@ -414,7 +343,7 @@ XBT_PUBLIC void execute(double flop, double priority); * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp */ -/** Block the actor until the built parallel execution terminates +/** Block the current actor until the built parallel execution terminates * * \rst * .. _API_s4u_parallel_execute: @@ -464,28 +393,23 @@ XBT_PUBLIC void execute(double flop, double priority); * * \endrst */ -XBT_PUBLIC void parallel_execute(std::vector hosts, std::vector flops_amounts, - std::vector bytes_amounts); +XBT_PUBLIC void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, + const std::vector& bytes_amounts); /** \rst - * Block the actor until the built :ref:`parallel execution ` completes, or until the timeout. - * \endrst + * Block the current actor until the built :ref:`parallel execution ` completes, or until the + * timeout. \endrst */ -XBT_PUBLIC void parallel_execute(std::vector hosts, std::vector flops_amounts, - std::vector bytes_amounts, double timeout); - -#ifndef DOXYGEN -XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC - void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount); -XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC - void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, - double timeout); -#endif +XBT_PUBLIC void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, + const std::vector& bytes_amounts, double timeout); XBT_PUBLIC ExecPtr exec_init(double flops_amounts); +XBT_PUBLIC ExecPtr exec_init(const std::vector& hosts, const std::vector& flops_amounts, + const std::vector& bytes_amounts); + XBT_PUBLIC ExecPtr exec_async(double flops_amounts); -/** @brief Returns the actor ID of the current actor). */ +/** @brief Returns the actor ID of the current actor. */ XBT_PUBLIC aid_t get_pid(); /** @brief Returns the ancestor's actor ID of the current actor. */ @@ -496,54 +420,41 @@ XBT_PUBLIC std::string get_name(); /** @brief Returns the name of the current actor as a C string. */ XBT_PUBLIC const char* get_cname(); -/** @brief Returns the name of the host on which the actor is running. */ +/** @brief Returns the name of the host on which the current actor is running. */ XBT_PUBLIC Host* get_host(); -/** @brief Suspend the actor. */ +/** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */ XBT_PUBLIC void suspend(); -/** @brief yield the actor. */ +/** @brief Yield the current actor. */ XBT_PUBLIC void yield(); -/** @brief Resume the actor. */ +/** @brief Resume the current actor, that was suspend()ed previously. */ XBT_PUBLIC void resume(); -XBT_PUBLIC bool is_suspended(); - -/** @brief kill the actor. */ +/** @brief kill the current actor. */ XBT_PUBLIC void exit(); -/** @brief Add a function to the list of "on_exit" functions. */ -XBT_PUBLIC void on_exit(std::function fun, void* data); +/** @brief Add a function to the list of "on_exit" functions of 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. + * + * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot + * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are + * blocking functions forbidden in this setting, but also modifications to the global state. + * + * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed. + * It will be set to true if the actor was killed or failed because of an exception, + * while it will remain to false if the actor terminated gracefully. + */ + +XBT_PUBLIC void on_exit(const std::function& fun); -/** @brief Migrate the actor to a new host. */ +/** @brief Migrate the current actor to a new host. */ XBT_PUBLIC void migrate(Host* new_host); /** @} */ - -#ifndef DOXYGEN -/** @deprecated Please use std::function 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); -/** @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 }