X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/aa3595ed3c903167f52eeeab8e636bec96b258dd..55c213429acfbb56f761aadbbf4f5144a2e7d5c2:/include/simgrid/s4u/Actor.hpp diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 7bc02e7e37..17df5019df 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -1,4 +1,4 @@ -/* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2006-2017. 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. */ @@ -16,14 +16,11 @@ #include #include -#include - -#include +#include #include #include #include -#include #include namespace simgrid { @@ -130,11 +127,13 @@ namespace s4u { * @{ */ -/** @brief Simulation Agent (see \ref s4u_actor)*/ -XBT_PUBLIC_CLASS Actor { +/** @brief Simulation Agent */ +XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable +{ friend Mailbox; friend simgrid::simix::ActorImpl; - smx_actor_t pimpl_ = nullptr; + friend simgrid::kernel::activity::MailboxImpl; + simix::ActorImpl* pimpl_ = nullptr; /** Wrap a (possibly non-copyable) single-use task into a `std::function` */ template @@ -143,9 +142,7 @@ XBT_PUBLIC_CLASS Actor { typedef decltype(f(std::move(args)...)) R; auto task = std::make_shared>( simgrid::xbt::makeTask(std::move(f), std::move(args)...)); - return [=] { - (*task)(); - }; + return [task] { (*task)(); }; } explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {} @@ -153,22 +150,12 @@ XBT_PUBLIC_CLASS Actor { public: // ***** No copy ***** - Actor(Actor const&) = delete; Actor& operator=(Actor const&) = delete; - // ***** Reference count (delegated to pimpl_) ***** - - friend void intrusive_ptr_add_ref(Actor* actor) - { - xbt_assert(actor != nullptr); - SIMIX_process_ref(actor->pimpl_); - } - friend void intrusive_ptr_release(Actor* actor) - { - xbt_assert(actor != nullptr); - SIMIX_process_unref(actor->pimpl_); - } + // ***** Reference count ***** + friend void intrusive_ptr_add_ref(Actor * actor); + friend void intrusive_ptr_release(Actor * actor); // ***** Actor creation ***** /** Retrieve a reference to myself */ @@ -178,11 +165,12 @@ public: * * If the actor is restarted, the actor has a fresh copy of the function. */ - static ActorPtr createActor(const char* name, s4u::Host *host, double killTime, std::function code); + static ActorPtr createActor(const char* name, s4u::Host* host, std::function code); - static ActorPtr createActor(const char* name, s4u::Host *host, std::function code) + static ActorPtr createActor(const char* name, s4u::Host* host, std::function*)> code, + std::vector* args) { - return createActor(name, host, -1.0, std::move(code)); + return createActor(name, host, [code](std::vector* args) { code(args); }, args); } /** Create an actor using code @@ -203,117 +191,178 @@ public: // Create actor from function name: - static ActorPtr createActor(const char* name, s4u::Host *host, double killTime, - const char* function, std::vector args); - - static ActorPtr createActor(const char* name, s4u::Host *host, const char* function, - std::vector args) - { - return createActor(name, host, -1.0, function, std::move(args)); - } + static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector args); // ***** Methods ***** + /** This actor will be automatically terminated when the last non-daemon process finishes **/ + void daemonize(); - /** Retrieves the actor that have the given PID (or NULL if not existing) */ - //static Actor *byPid(int pid); not implemented - - /** Retrieves the name of that actor */ - simgrid::xbt::string getName(); + /** Retrieves the name of that actor as a C++ string */ + const simgrid::xbt::string& getName() const; + /** Retrieves the name of that actor as a C string */ + const char* getCname() const; /** Retrieves the host on which that actor is running */ - s4u::Host *getHost(); - /** Retrieves the PID of that actor */ - int getPid(); - /** Retrieves the PPID of that actor */ - int getPpid(); + s4u::Host* getHost(); + /** Retrieves the PID of that actor + * + * actor_id_t is an alias for unsigned long */ + aid_t getPid(); + /** Retrieves the PPID of that actor + * + * actor_id_t is an alias for unsigned long */ + aid_t getPpid(); + + /** Suspend an actor by suspending the task on which it was waiting for the completion. */ + void suspend(); + + /** Resume a suspended process by resuming the task on which it was waiting for the completion. */ + void resume(); + + /** Returns true if the process is suspended. */ + int isSuspended(); /** If set to true, the actor will automatically restart when its host reboots */ void setAutoRestart(bool autorestart); + + /** 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 process. + */ + void onExit(int_f_pvoid_pvoid_t fun, void* data); + /** Sets the time at which that actor should be killed */ void setKillTime(double time); /** Retrieves the time at which that actor will be killed (or -1 if not set) */ double getKillTime(); + void migrate(Host * new_host); + /** Ask the actor to die. * - * It will only notice your request when doing a simcall next time (a communication or similar). - * SimGrid sometimes have issues when you kill actors that are currently communicating and such. - * We are working on it to fix the issues. + * Any blocking activity will be canceled, and it will be rescheduled to free its memory. + * Being killed is not something that actors can defer or avoid. + * + * SimGrid still have sometimes issues when you kill actors that are currently communicating and such. + * Still. Please report any bug that you may encounter with a minimal working example. */ void kill(); - static void kill(int pid); - static ActorPtr forPid(int pid); - - /** - * Wait for the actor to finish. - */ + static void kill(aid_t pid); + + /** Retrieves the actor that have the given PID (or nullptr if not existing) */ + static ActorPtr byPid(aid_t pid); + + /** @brief Wait for the actor to finish. + * + * This blocks the calling actor until the actor on which we call join() is terminated + */ void join(); - + // Static methods on all actors: /** Ask kindly to all actors to die. Only the issuer will survive. */ static void killAll(); + static void killAll(int resetPid); -protected: /** Returns the internal implementation of this actor */ - smx_actor_t getImpl(); + simix::ActorImpl* getImpl(); + + /** Retrieve the property value (or nullptr if not set) */ + const char* getProperty(const char* key); + void setProperty(const char* key, const char* value); + Actor* restart(); }; /** @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) */ - XBT_PUBLIC(void) sleep_for(double duration); - XBT_PUBLIC(void) sleep_until(double timeout); +XBT_PUBLIC(bool) isMaestro(); + +/** Block the actor sleeping for that amount of seconds (may throws hostFailure) */ +XBT_PUBLIC(void) sleep_for(double duration); +XBT_PUBLIC(void) sleep_until(double timeout); + +template inline void sleep_for(std::chrono::duration duration) +{ + auto seconds = std::chrono::duration_cast(duration); + this_actor::sleep_for(seconds.count()); +} + +template inline void sleep_until(const SimulationTimePoint& timeout_time) +{ + auto timeout_native = std::chrono::time_point_cast(timeout_time); + this_actor::sleep_until(timeout_native.time_since_epoch().count()); +} + +XBT_ATTRIB_DEPRECATED_v320("Use sleep_for(): v3.20 will turn this warning into an error.") inline void sleep( + double duration) +{ + return sleep_for(duration); +} + +/** Block the 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. + * An execution of priority 2 computes twice as fast as an execution at priority 1. */ +XBT_PUBLIC(void) execute(double flop, double priority); + +/** Block the actor until it gets a message from the given mailbox. + * + * See \ref Comm for the full communication API (including non blocking communications). + */ +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*) + recv(MailboxPtr chan); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*) + recv(MailboxPtr chan, double timeout); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr) + irecv(MailboxPtr chan, void** data); + +/** Block the actor until it delivers a message of the given simulated size to the given mailbox + * + * See \ref Comm for the full communication API (including non blocking communications). +*/ +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void) + send(MailboxPtr chan, void* payload, double simulatedSize); +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void) + send(MailboxPtr chan, void* payload, double simulatedSize, double timeout); - template - inline void sleep_for(std::chrono::duration duration) - { - auto seconds = std::chrono::duration_cast(duration); - this_actor::sleep_for(seconds.count()); - } - template - inline void sleep_until(const SimulationTimePoint& timeout_time) - { - auto timeout_native = std::chrono::time_point_cast(timeout_time); - this_actor::sleep_until(timeout_native.time_since_epoch().count()); - } +XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr) + isend(MailboxPtr chan, void* payload, double simulatedSize); - XBT_ATTRIB_DEPRECATED("Use sleep_for()") - inline void sleep(double duration) - { - return sleep_for(duration); - } +/** @brief Returns the actor ID of the current actor). */ +XBT_PUBLIC(aid_t) getPid(); - /** Block the actor, computing the given amount of flops */ - XBT_PUBLIC(e_smx_state_t) execute(double flop); +/** @brief Returns the ancestor's actor ID of the current actor. */ +XBT_PUBLIC(aid_t) getPpid(); - /** Block the actor until it gets a message from the given mailbox. - * - * See \ref Comm for the full communication API (including non blocking communications). - */ - XBT_PUBLIC(void*) recv(MailboxPtr chan); +/** @brief Returns the name of the current actor. */ +XBT_PUBLIC(std::string) getName(); - /** Block the actor until it delivers a message of the given simulated size to the given mailbox - * - * See \ref Comm for the full communication API (including non blocking communications). - */ - XBT_PUBLIC(void) send(MailboxPtr chan, void*payload, size_t simulatedSize); - - /** - * Return the PID of the current actor. - */ - XBT_PUBLIC(int) getPid(); - - /** - * Return the PPID of the current actor. - */ - int getPpid(); +/** @brief Returns the name of the current actor as a C string. */ +XBT_PUBLIC(const char*) getCname(); -}; +/** @brief Returns the name of the host on which the process is running. */ +XBT_PUBLIC(Host*) getHost(); + +/** @brief Suspend the actor. */ +XBT_PUBLIC(void) suspend(); + +/** @brief Resume the actor. */ +XBT_PUBLIC(void) resume(); + +XBT_PUBLIC(bool) isSuspended(); + +/** @brief kill the actor. */ +XBT_PUBLIC(void) kill(); + +/** @brief Add a function to the list of "on_exit" functions. */ +XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data); + +/** @brief Migrate the actor to a new host. */ +XBT_PUBLIC(void) migrate(Host* new_host); +} -/** @} */ +/** @} */ }} // namespace simgrid::s4u