X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2807fde4fd1f59c230d69a934634c5dfb77905f2..cdac506670725ae4fe40b3b1a31ceeb9488ce53a:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 92fc4852ce..f0c41432db 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2017. 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,27 +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 - namespace simgrid { namespace s4u { -/** @ingroup s4u_api +/** * * An actor is an independent stream of execution in your distributed application. * @@ -50,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() { @@ -68,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 { @@ -106,8 +98,8 @@ namespace s4u { * * @code{.xml} * - * - * + * + * * * * @@ -128,22 +120,13 @@ namespace s4u { */ /** @brief Simulation Agent */ -XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable -{ - friend Mailbox; - friend simgrid::simix::ActorImpl; +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; - simix::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)...)); - return [task] { (*task)(); }; - } + kernel::actor::ActorImpl* pimpl_ = nullptr; explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {} @@ -154,88 +137,115 @@ public: Actor& operator=(Actor const&) = delete; // ***** Reference count ***** - friend void intrusive_ptr_add_ref(Actor * actor); - friend void intrusive_ptr_release(Actor * actor); + friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor); + friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor); // ***** Actor creation ***** /** Retrieve a reference to myself */ static ActorPtr self(); - /** Create an actor using a function + /** Signal to others that a new actor has been created **/ + 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 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 * * 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. + */ + template static ActorPtr create(std::string name, s4u::Host* host, F code) { - return createActor(name, host, [code](std::vector* args) { code(args); }, args); + return create(name, host, std::function(std::move(code))); } - /** Create an actor using code + /** Create an actor using a callable thing and its arguments. * - * Using this constructor, move-only type can be used. The consequence is - * that we cannot copy the value and restart the actor in its initial - * 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) + * Note that the arguments will be copied, so move-only parameters are forbidden */ + 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, std::bind(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 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(); - /** Retrieves the PID of that actor - * - * actor_id_t is an alias for unsigned long */ - aid_t getPid(); - /** Retrieves the PPID of that actor - * - * actor_id_t is an alias for unsigned long */ - aid_t getPpid(); + s4u::Host* get_host(); + /** Retrieves the actor ID of that actor */ + aid_t get_pid() const; + /** 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. */ - 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. + * + * 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. */ - 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. @@ -248,41 +258,143 @@ public: */ void kill(); - 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 + * 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(); - // Static methods on all actors: + /** 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. */ - static void killAll(); - static void killAll(int resetPid); + /** 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 */ - simix::ActorImpl* getImpl(); + kernel::actor::ActorImpl* get_impl(); /** Retrieve the property value (or nullptr if not set) */ - 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 + 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) + { + 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 }; /** @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); -XBT_PUBLIC(void) sleep_until(double timeout); +/** 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) { @@ -296,78 +408,145 @@ 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(std::vector hosts, std::vector flops_amounts, + 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(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_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr) - isend(MailboxPtr chan, void* payload, double simulatedSize); +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). */ -XBT_PUBLIC(aid_t) getPid(); +/** @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. */ -XBT_PUBLIC(aid_t) getPpid(); +XBT_PUBLIC aid_t get_ppid(); /** @brief Returns the name of the current actor. */ -XBT_PUBLIC(std::string) getName(); - +XBT_PUBLIC std::string get_name(); /** @brief Returns the name of the current actor as a C string. */ -XBT_PUBLIC(const char*) getCname(); +XBT_PUBLIC const char* get_cname(); + +/** @brief Returns the name of the host on which the curret actor is running. */ +XBT_PUBLIC Host* get_host(); -/** @brief Returns the name of the host on which the actor is running. */ -XBT_PUBLIC(Host*) getHost(); +/** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */ +XBT_PUBLIC void suspend(); -/** @brief Suspend the actor. */ -XBT_PUBLIC(void) suspend(); +/** @brief Yield the current actor. */ +XBT_PUBLIC void yield(); -/** @brief yield the actor. */ -XBT_PUBLIC(void) yield(); +/** @brief Resume the current actor, that was suspend()ed previously. */ +XBT_PUBLIC void resume(); -/** @brief Resume the actor. */ -XBT_PUBLIC(void) resume(); +/** @brief kill the current actor. */ +XBT_PUBLIC void exit(); -XBT_PUBLIC(bool) isSuspended(); +/** @brief Add a function to the list of "on_exit" functions of the current actor. */ +XBT_PUBLIC void on_exit(std::function fun, void* data); -/** @brief kill the actor. */ -XBT_PUBLIC(void) kill(); +/** @brief Migrate the current actor to a new host. */ +XBT_PUBLIC void migrate(Host* new_host); -/** @brief Add a function to the list of "on_exit" functions. */ -XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data); +/** @} */ -/** @brief Migrate the 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::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 } -/** @} */ }} // namespace simgrid::s4u