X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/67fe7b9d6c00b390a8598bc1e72d42d8343cb218..a4c8f1898670317d0fa33bf1b1a904ea922b78cc:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 65d9bd6a14..3b847f249f 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,19 +6,22 @@ #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 { -/** @ingroup s4u_api +/** * * An actor is an independent stream of execution in your distributed application. * @@ -98,8 +101,8 @@ namespace s4u { * * @code{.xml} * - * - * + * + * * * * @@ -120,21 +123,13 @@ namespace s4u { */ /** @brief Simulation Agent */ -class XBT_PUBLIC Actor : public simgrid::xbt::Extendable { +class XBT_PUBLIC Actor : public xbt::Extendable { friend Exec; friend Mailbox; - friend simgrid::kernel::actor::ActorImpl; - friend simgrid::kernel::activity::MailboxImpl; - kernel::actor::ActorImpl* pimpl_ = nullptr; + friend kernel::actor::ActorImpl; + friend kernel::activity::MailboxImpl; - /** 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::make_task(std::move(f), std::move(args)...)); - return [task] { (*task)(); }; - } + kernel::actor::ActorImpl* const pimpl_; explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {} @@ -147,57 +142,62 @@ public: // ***** Reference count ***** friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor); friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor); + 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; + 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 the given actor is about to disappear */ - static simgrid::xbt::signal on_destruction; + static 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 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 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); - static ActorPtr create(std::string 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(const std::string& name, s4u::Host* host, F code) { - return create(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. - */ + * 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) + static ActorPtr create(const std::string& name, s4u::Host* host, F code, Args... args) { - return create(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 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 **/ @@ -211,24 +211,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(); @@ -237,14 +231,31 @@ 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); /** Retrieves the time at which that actor will be killed (or -1 if not set) */ 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. @@ -257,99 +268,42 @@ public: */ void kill(); - 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); - /** @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(); + + /** 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); + 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); - 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); - } - 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); - } - 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)...); - } - 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); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const; - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const - { - return get_name(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a) - { - set_auto_restart(a); - } - XBT_ATTRIB_DEPRECATED_v323("Please use a std::function for first parameter.") void on_exit( - int_f_pvoid_pvoid_t fun, void* data); - 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); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll( - int XBT_ATTRIB_UNUSED resetPid) - { - kill_all(); - } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key) - { - return get_property(key); - } - 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; - } - XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value) - { - set_property(key, value); - } +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v325("Please use Actor::on_exit(fun) instead") void on_exit( + const std::function& fun, void* data); + + XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid); +#endif }; /** @ingroup s4u_api @@ -358,9 +312,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) { @@ -368,27 +323,99 @@ 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); -XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount); -XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, - double timeout); +/** + * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp + */ + +/** Block the current actor until the built parallel execution terminates + * + * \rst + * .. _API_s4u_parallel_execute: + * + * **Example of use:** `examples/s4u/exec-ptask/s4u-exec-ptask.cpp + * `_ + * + * 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_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. */ @@ -399,43 +426,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_ATTRIB_DEPRECATED_v323("Please use std::function for first parameter.") XBT_PUBLIC - void on_exit(int_f_pvoid_pvoid_t fun, void* data); -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. + */ -/** @brief Migrate the actor to a new host. */ +XBT_PUBLIC void on_exit(const std::function& fun); + +/** @brief Migrate the current actor to a new host. */ XBT_PUBLIC void migrate(Host* new_host); -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName(); -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname(); -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_maestro()") XBT_PUBLIC bool isMaestro(); -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t getPid(); -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid(); -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost(); -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended(); -XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data); -XBT_ATTRIB_DEPRECATED_v324("Please use this_actor::exit()") XBT_PUBLIC void kill(); +/** @} */ + +#ifndef DOXYGEN +XBT_ATTRIB_DEPRECATED_v325("Please use std::function for first parameter.") XBT_PUBLIC + void on_exit(const std::function& fun, void* data); +#endif } -/** @} */ }} // namespace simgrid::s4u