X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/420e2b268738e54f8a1a5b64979502a805943a70..08e94eb0482589e4b287cbea301b84daf52635bd:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 2d2c7e5346..1d875c8f78 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. */ @@ -98,8 +98,8 @@ namespace s4u { * * @code{.xml} * - * - * + * + * * * * @@ -121,13 +121,12 @@ namespace s4u { /** @brief Simulation Agent */ class XBT_PUBLIC Actor : public simgrid::xbt::Extendable { -#ifndef DOXYGEN - friend Exec; - friend Mailbox; + friend simgrid::s4u::Exec; + friend simgrid::s4u::Mailbox; friend simgrid::kernel::actor::ActorImpl; friend simgrid::kernel::activity::MailboxImpl; -#endif - kernel::actor::ActorImpl* pimpl_ = nullptr; + + kernel::actor::ActorImpl* const pimpl_ = nullptr; explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {} @@ -159,7 +158,10 @@ public: 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 */ + /** 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; /** Create an actor from a std::function @@ -174,7 +176,7 @@ public: */ template static ActorPtr create(std::string name, s4u::Host* host, F code) { - return create(name, host, std::function(std::move(code))); + return create(std::move(name), host, std::function(std::move(code))); } /** Create an actor using a callable thing and its arguments. @@ -185,11 +187,11 @@ public: typename = typename std::result_of::type> static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args) { - return create(name, host, std::bind(std::move(code), std::move(args)...)); + return create(std::move(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(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 **/ @@ -204,23 +206,17 @@ public: 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 */ + /** 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(); @@ -229,8 +225,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(std::function fun); /** Sets the time at which that actor should be killed */ void set_kill_time(double time); @@ -258,21 +262,25 @@ 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 */ @@ -281,10 +289,15 @@ public: /** 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); + const char* get_property(const std::string& key); + void set_property(const std::string& key, std::string value); #ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v325("Please use Actor::on_exit(fun) instead") void on_exit(std::function fun, + void* data); + + XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid); + /** @deprecated See Actor::create() */ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor( const char* name, s4u::Host* host, std::function code) @@ -339,7 +352,7 @@ public: /** @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); + on_exit([fun, data](bool a) { fun((void*)(uintptr_t)a, 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); } @@ -372,7 +385,7 @@ public: return res; } /** @deprecated See Actor::get_properties() */ - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value) + XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_property()") void setProperty(const char* key, const char* value) { set_property(key, value); } @@ -385,8 +398,9 @@ 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 (may throw hostFailure) */ XBT_PUBLIC void sleep_for(double duration); +/** Block the current actor sleeping until the specified timestamp (may throw hostFailure) */ XBT_PUBLIC void sleep_until(double timeout); template inline void sleep_for(std::chrono::duration duration) @@ -401,21 +415,90 @@ template inline void sleep_until(const SimulationTimePoint`_ + * + * Parallel executions convenient abstractions of parallel computational kernels that span over several machines, + * such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel + * on the platform (e.g. to schedule them wisely), there is no need to model them in all details of their internal + * execution and communications. It is much more convenient to model them as a single execution activity that spans + * over several hosts. This is exactly what s4u's Parallel Executions are. + * + * To build such an object, you need to provide a list of hosts that are involved in the parallel kernel (the + * actor's own host may or may not be in this list) and specify the amount of computations that should be done by + * each host, using a vector of flops amount. Then, you should specify the amount of data exchanged between each + * hosts during the parallel kernel. For that, a matrix of values is expected. + * + * It is OK to build a parallel execution without any computation and/or without any communication. + * Just pass an empty vector to the corresponding parameter. + * + * For example, if your list of hosts is ``[host0, host1]``, passing a vector ``[1000, 2000]`` as a `flops_amount` + * vector means that `host0` should compute 1000 flops while `host1` will compute 2000 flops. A matrix of + * communications' sizes of ``[0, 1, 2, 3]`` specifies the following data exchanges: + * + * +-----------+-------+------+ + * |from \\ to | host0 | host1| + * +===========+=======+======+ + * |host0 | 0 | 1 | + * +-----------+-------+------+ + * |host1 | 2 | 3 | + * +-----------+-------+------+ + * + * - From host0 to host0: 0 bytes are exchanged + * - From host0 to host1: 1 byte is exchanged + * - From host1 to host0: 2 bytes are exchanged + * - From host1 to host1: 3 bytes are exchanged + * + * In a parallel execution, all parts (all executions on each hosts, all communications) progress exactly at the + * same pace, so they all terminate at the exact same pace. If one part is slow because of a slow resource or + * because of contention, this slows down the parallel execution as a whole. + * + * These objects are somewhat surprising from a modeling point of view. For example, the unit of their speed is + * somewhere between flop/sec and byte/sec. Arbitrary parallel executions will simply not work with the usual platform + * models, and you must :ref:`use the ptask_L07 host model ` for that. Note that you can mix + * regular executions and communications with parallel executions, provided that the host model is ptask_L07. + * + * \endrst + */ +XBT_PUBLIC void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, + const std::vector& bytes_amounts); + +/** \rst + * Block the current actor until the built :ref:`parallel execution ` completes, or until the + * timeout. \endrst + */ +XBT_PUBLIC void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, + const 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* const* host_list, const double* flops_amount, + const double* bytes_amount); +XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC + void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, + const double* bytes_amount, double timeout); +#endif XBT_PUBLIC ExecPtr exec_init(double flops_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. */ @@ -426,34 +509,48 @@ 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 curret 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(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 +XBT_ATTRIB_DEPRECATED_v325("Please use std::function for first parameter.") XBT_PUBLIC + void on_exit(std::function fun, void* data); + /** @deprecated Please use std::function for first parameter */ -XBT_ATTRIB_DEPRECATED_v323("Please use std::function for first parameter.") XBT_PUBLIC +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(); @@ -467,8 +564,6 @@ XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t 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() */