X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/06dc26d9e82ea6389984033a42114b7604fe20f0..2d30a417c2362b797b83c98f038a47a655a07180:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 210d2526c3..f26e7e238e 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2021. 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. */ @@ -10,31 +10,35 @@ #include #include -#include #include #include #include -#include // deprecated wrappers #include namespace simgrid { + +extern template class XBT_PUBLIC xbt::Extendable; + namespace s4u { -/** \beginrst An actor is an independent stream of execution in your distributed application. +/** An actor is an independent stream of execution in your distributed application. + * + * @beginrst * It is located on a (simulated) :cpp:class:`host `, but can interact * with the whole simulated platform. * * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program. * This is the only component in SimGrid that actually does something on its own, executing its own code. * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and - * schedule these activities. Please refer to the :ref:`examples ` for more information. + * schedule these activities. **Please refer to the** :ref:`examples ` **for more information.** * * This API is strongly inspired from the C++11 threads. * The `documentation of this standard `_ * may help to understand the philosophy of the SimGrid actors. * - * \endrst */ + * @endrst + */ class XBT_PUBLIC Actor : public xbt::Extendable { #ifndef DOXYGEN friend Exec; @@ -45,7 +49,7 @@ class XBT_PUBLIC Actor : public xbt::Extendable { kernel::actor::ActorImpl* const pimpl_; #endif - explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {} + explicit Actor(kernel::actor::ActorImpl* pimpl) : pimpl_(pimpl) {} public: #ifndef DOXYGEN @@ -54,11 +58,11 @@ public: Actor& operator=(Actor const&) = delete; // ***** Reference count ***** - friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor); - friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor); + friend XBT_PUBLIC void intrusive_ptr_add_ref(const Actor* actor); + friend XBT_PUBLIC void intrusive_ptr_release(const Actor* actor); #endif /** Retrieve the amount of references on that object. Useful to debug the automatic refcounting */ - int get_refcount(); + int get_refcount() const; // ***** Actor creation ***** /** Retrieve a reference to myself */ @@ -74,14 +78,20 @@ public: static xbt::signal on_sleep; /** Signal to others that an actor wakes up for a sleep **/ static xbt::signal on_wake_up; - /** Signal to others that an actor is going to migrated to another host**/ - static xbt::signal on_migration_start; /** Signal to others that an actor is has been migrated to another host **/ - static xbt::signal on_migration_end; + static xbt::signal on_host_change; +#ifndef DOXYGEN + static xbt::signal on_migration_start; // XBT_ATTRIB_DEPRECATED_v329 + static xbt::signal on_migration_end; // XBT_ATTRIB_DEPRECATED_v329 +#endif + /** Signal indicating that an actor terminated its code. + * @beginrst * 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.*/ + * If you want to free extra data when the actor's destructor is called, use :cpp:var:`Actor::on_destruction`. + * If you want to register to the termination of a given actor, use :cpp:func:`this_actor::on_exit()` instead. + * @endrst + */ 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. @@ -94,8 +104,9 @@ public: static ActorPtr create(const std::string& name, s4u::Host* host, const std::function& code); /** Create an actor, but don't start it yet. * - * This is usefull to set some properties or extension before actually starting it */ + * This is useful to set some properties or extension before actually starting it */ static ActorPtr init(const std::string& name, s4u::Host* host); + ActorPtr set_stacksize(unsigned stacksize); /** Start a previously initialized actor */ ActorPtr start(const std::function& code); @@ -108,9 +119,13 @@ public: /** Create an actor using a callable thing and its arguments. * * Note that the arguments will be copied, so move-only parameters are forbidden */ + template ::type> +#ifndef DOXYGEN /* breathe seem to choke on function signatures in template parameter, see breathe#611 */ + typename = typename std::result_of_t +#endif + > 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)...)); @@ -145,7 +160,7 @@ public: void resume(); /** Returns true if the actor is suspended. */ - bool is_suspended(); + bool is_suspended() const; /** If set to true, the actor will automatically restart when its host reboots */ void set_auto_restart(bool autorestart); @@ -166,7 +181,7 @@ public: /** 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(); + double get_kill_time() const; /** @brief Moves the actor to another host * @@ -177,7 +192,10 @@ public: * 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); + void set_host(Host* new_host); +#ifndef DOXYGEN + XBT_ATTRIB_DEPRECATED_v329("Please use set_host() instead") void migrate(Host* new_host) { set_host(new_host); } +#endif /** Ask the actor to die. * @@ -194,14 +212,14 @@ public: * 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(); + void join() const; /** 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); + void join(double timeout) const; /** Kill that actor and restart it from start. */ Actor* restart(); @@ -211,10 +229,14 @@ public: /** Returns the internal implementation of this actor */ kernel::actor::ActorImpl* get_impl() const { return pimpl_; } - /** Retrieve the property value (or nullptr if not set) */ + /** Retrieve the list of properties for that actor */ const std::unordered_map* get_properties() const; // FIXME: do not export the map, but only the keys or something + + /** Retrieve the property value (or nullptr if not set) */ const char* get_property(const std::string& key) const; + + /** Set a property (old values will be overwritten) */ void set_property(const std::string& key, const std::string& value); }; @@ -249,16 +271,16 @@ XBT_PUBLIC void execute(double flop); XBT_PUBLIC void execute(double flop, double priority); /** - * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp + * @example examples/cpp/exec-ptask/s4u-exec-ptask.cpp */ /** Block the current actor until the built parallel execution terminates * - * \rst + * @beginrst * .. _API_s4u_parallel_execute: * - * **Example of use:** `examples/s4u/exec-ptask/s4u-exec-ptask.cpp - * `_ + * **Example of use:** `examples/cpp/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 @@ -278,17 +300,18 @@ XBT_PUBLIC void execute(double flop, double priority); * 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; to host1: 1 byte ] + * + * - from host1: [ to host0: 2 bytes; to host1: 3 bytes ] + * + * Or, in other words: * * - 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 @@ -300,14 +323,15 @@ XBT_PUBLIC void execute(double flop, double priority); * 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 + * @endrst */ +/** Block the current actor until the built parallel execution completes */ XBT_PUBLIC void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, const std::vector& bytes_amounts); -/** Block the current actor until the built parallel execution completes, or until the timeout. */ -XBT_PUBLIC void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, - const std::vector& bytes_amounts, double timeout); +XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") XBT_PUBLIC + void parallel_execute(const std::vector& hosts, const std::vector& flops_amounts, + const std::vector& bytes_amounts, double timeout); /** Initialize a sequential execution that must then be started manually */ XBT_PUBLIC ExecPtr exec_init(double flops_amounts); @@ -337,9 +361,6 @@ XBT_PUBLIC void suspend(); /** @brief Yield the current actor. */ XBT_PUBLIC void yield(); -/** @brief Resume the current actor, that was suspend()ed previously. */ -XBT_PUBLIC void resume(); - /** @brief kill the current actor. */ XBT_PUBLIC void exit(); @@ -353,16 +374,17 @@ XBT_PUBLIC void exit(); * 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, + * It will be set to true if the actor was killed or failed because of an exception or if the simulation deadlocked, * while it will remain to false if the actor terminated gracefully. */ 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_PUBLIC void set_host(Host* new_host); +#ifndef DOXYGEN +XBT_ATTRIB_DEPRECATED_v329("Please use set_host() instead") XBT_PUBLIC void migrate(Host* new_host); +#endif }