X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/be3155e24d0c71e2bbd31dd282cfd49bff7290fa..1cce0801abcad7c884f9e72ceda87e36d6635104:/include/simgrid/s4u/actor.hpp diff --git a/include/simgrid/s4u/actor.hpp b/include/simgrid/s4u/actor.hpp index aa5877d5d1..4f3a1a9f5d 100644 --- a/include/simgrid/s4u/actor.hpp +++ b/include/simgrid/s4u/actor.hpp @@ -6,17 +6,22 @@ #ifndef SIMGRID_S4U_ACTOR_HPP #define SIMGRID_S4U_ACTOR_HPP +#include +#include +#include #include +#include + #include +#include + #include #include namespace simgrid { namespace s4u { -/** @addtogroup s4u_actor - * - * @tableofcontents +/** @ingroup s4u_api * * An actor is an independent stream of execution in your distributed application. * @@ -32,8 +37,6 @@ namespace s4u { * of this standard may help to understand the philosophy of the S4U * Actors. * - * (back to the @ref s4u_api "S4U documentation") - * * @section s4u_actor_def Defining the skeleton of an Actor * * %As in the C++11 @@ -41,6 +44,8 @@ namespace s4u { * pure function or as an object. It is very simple with functions: * * @code{.cpp} + * #include "s4u/actor.hpp" + * * // Declare the code of your worker * void worker() { * printf("Hello s4u"); @@ -48,7 +53,8 @@ namespace s4u { * }; * * // From your main or from another actor, create your actor on the host Jupiter - * Actor("worker", simgrid::s4u::Host::by_name("Jupiter"), worker); + * // The following line actually creates a new actor, even if there is no "new". + * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker); * @endcode * * But some people prefer to encapsulate their actors in classes and @@ -68,7 +74,7 @@ namespace s4u { * }; * * // From your main or from another actor, create your actor. Note the () after Worker - * Actor("worker", simgrid::s4u::Host::by_name("Jupiter"), Worker()); + * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker()); * @endcode * * @section s4u_actor_flesh Fleshing your actor @@ -114,9 +120,41 @@ namespace s4u { * * @{ */ - + /** @brief Simulation Agent (see \ref s4u_actor)*/ XBT_PUBLIC_CLASS Actor { +private: + /** Wrap a (possibly non-copyable) single-use task into a `std::function` */ + template + class Task { + public: + Task(F&& code, Args&&... args) : + code_(std::forward(code)), + args_(std::forward(args)...) + { + done_.clear(); + } + void operator()() + { + if (done_.test_and_set()) + throw std::logic_error("Actor task already executed"); + simgrid::xbt::apply(std::move(code_), std::move(args_)); + } + private: + std::atomic_flag done_; + F code_; + std::tuple args_; + }; + /** Wrap a (possibly non-copyable) single-use task into a `std::function` */ + template + static std::function wrap_task(F f, Args... args) + { + std::shared_ptr> task( + new Task(std::move(f), std::move(args)...)); + return [=] { + (*task)(); + }; + } public: Actor() : pimpl_(nullptr) {} Actor(smx_process_t smx_proc) : @@ -143,12 +181,38 @@ public: swap(*this, actor); } + /** Create an actor using a function + * + * If the actor is restarted, the actor has a fresh copy of the function. + */ Actor(const char* name, s4u::Host *host, double killTime, std::function code); + Actor(const char* name, s4u::Host *host, std::function code) - : Actor(name, host, -1, std::move(code)) {}; - template - Actor(const char* name, s4u::Host *host, C code) - : Actor(name, host, -1, std::function(std::move(code))) {} + : Actor(name, host, -1.0, std::move(code)) {}; + + /** Create an actor using code + * + * Using this constructor, move-only type can be used. The consequence is + * that we cannot copy the value and restart the process in its initial + * state. In order to use auto-restart, an explicit `function` must be passed + * instead. + */ + template::type + > + Actor(const char* name, s4u::Host *host, F code, Args... args) : + Actor(name, host, wrap_task(std::move(code), std::move(args)...)) + {} + + // Create actor from function name: + + Actor(const char* name, s4u::Host *host, double killTime, + const char* function, std::vector args); + + Actor(const char* name, s4u::Host *host, const char* function, + std::vector args) + : Actor(name, host, -1.0, function, std::move(args)) {} /** Retrieves the actor that have the given PID (or NULL if not existing) */ //static Actor *byPid(int pid); not implemented @@ -175,6 +239,7 @@ public: void kill(); static void kill(int pid); + static Actor forPid(int pid); /** * Wait for the actor to finish. @@ -186,11 +251,14 @@ public: /** Ask kindly to all actors to die. Only the issuer will survive. */ static void killAll(); + bool valid() const { return pimpl_ != nullptr; } + private: smx_process_t pimpl_ = nullptr; }; -/** @brief Static methods working on the current actor (see @ref s4u_actor) */ +/** @ingroup s4u_api + * @brief Static methods working on the current actor (see @ref s4u::Actor) */ namespace this_actor { /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */ @@ -210,6 +278,11 @@ namespace this_actor { * See \ref Comm for the full communication API (including non blocking communications). */ XBT_PUBLIC(void) send(Mailbox &chan, void*payload, size_t simulatedSize); + + /** + * Return the PID of the current actor. + */ + XBT_PUBLIC(int) getPid(); };