X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3f88afa7ab43c9ff2d4c4d0cece067863998ad68..36fccba5f4f2b4c32e97c4e56911eb5bd804f7c9:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 959673bcbb..067fdd7ded 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2020. 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,12 +10,10 @@ #include #include -#include #include #include #include -#include // deprecated wrappers #include namespace simgrid { @@ -26,7 +24,7 @@ namespace s4u { /** An actor is an independent stream of execution in your distributed application. * - * \rst + * @beginrst * It is located on a (simulated) :cpp:class:`host `, but can interact * with the whole simulated platform. * @@ -39,7 +37,8 @@ namespace s4u { * 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; @@ -63,7 +62,7 @@ public: 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 */ @@ -80,11 +79,7 @@ public: /** Signal to others that an actor wakes up for a sleep **/ static xbt::signal on_wake_up; /** Signal to others that an actor is has been migrated to another host **/ - 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 + static xbt::signal on_host_change; /** Signal indicating that an actor terminated its code. * @beginrst @@ -105,12 +100,27 @@ 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); + template ActorPtr start(F code) { return start(std::function(std::move(code))); } + + template +#endif + > + ActorPtr start(F code, Args... args) + { + return start(std::bind(std::move(code), std::move(args)...)); + } + + ActorPtr start(const std::function& code, std::vector args); + /** Create an actor from a callable thing. */ template static ActorPtr create(const std::string& name, s4u::Host* host, F code) { @@ -120,9 +130,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)...)); @@ -157,7 +171,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); @@ -178,7 +192,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 * @@ -190,9 +204,6 @@ public: * to take care of this yourself (only you knows which ones should be migrated). */ 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. * @@ -209,14 +220,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(); @@ -226,10 +237,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); }; @@ -264,16 +279,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 @@ -316,16 +331,12 @@ 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); -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); /** Initialize a parallel execution that must then be started manually */ @@ -375,9 +386,6 @@ XBT_PUBLIC void on_exit(const std::function& fun); /** @brief Migrate the current actor to a 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 }