X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d6ba60ce19ac593de280c8dd791ee33d1df81bb9..39c935d6d5ee86d153f6f7e6a10d723ae7c57f6f:/include/simgrid/s4u/Actor.hpp?ds=sidebyside diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 725c8ec7a0..1e79607f07 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,18 +10,21 @@ #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. + * + * \rst * It is located on a (simulated) :cpp:class:`host `, but can interact * with the whole simulated platform. * @@ -45,7 +48,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 +57,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 */ @@ -82,9 +85,12 @@ public: #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. @@ -97,8 +103,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); @@ -148,7 +155,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); @@ -169,7 +176,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 * @@ -180,7 +187,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. * @@ -197,14 +207,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(); @@ -281,17 +291,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 @@ -305,12 +316,13 @@ XBT_PUBLIC void execute(double flop, double priority); * * \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); @@ -340,9 +352,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(); @@ -356,16 +365,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 }