#include <utility>
#include <vector>
-#include <boost/intrusive_ptr.hpp>
-
#include <xbt/Extendable.hpp>
-#include <xbt/base.h>
#include <xbt/functional.hpp>
#include <xbt/string.hpp>
#include <simgrid/chrono.hpp>
-#include <simgrid/simix.h>
#include <simgrid/s4u/forward.hpp>
namespace simgrid {
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 */
*/
static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
+ static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
+ std::vector<std::string>* args)
+ {
+ return createActor(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
+ }
+
/** Create an actor using code
*
* Using this constructor, move-only type can be used. The consequence is
static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
// ***** Methods *****
+ /** This actor will be automatically terminated when the last non-daemon process finishes **/
+ void daemonize();
/** Retrieves the name of that actor as a C string */
- const char* cname();
+ const char* getCname();
/** Retrieves the name of that actor as a C++ string */
- simgrid::xbt::string name();
+ simgrid::xbt::string getName();
/** Retrieves the host on which that actor is running */
- s4u::Host* host();
- /** Retrieves the PID of that actor */
- int pid();
- /** Retrieves the PPID of that actor */
- int ppid();
+ 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 killTime();
+ 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.
+ * 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 void kill(aid_t pid);
/** Retrieves the actor that have the given PID (or nullptr if not existing) */
- static ActorPtr byPid(int pid);
+ 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);
/** Returns the internal implementation of this actor */
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();
- template<class Rep, class Period>
- inline void sleep_for(std::chrono::duration<Rep, Period> duration)
- {
- auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
- this_actor::sleep_for(seconds.count());
+/** 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 <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
+{
+ auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
+ this_actor::sleep_for(seconds.count());
}
template<class Duration>
inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
this_actor::sleep_until(timeout_native.time_since_epoch().count());
}
- XBT_ATTRIB_DEPRECATED("Use sleep_for()")
- inline void sleep(double duration)
+ 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(e_smx_state_t) execute(double flop);
+ XBT_PUBLIC(void) execute(double flop);
/** 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);
+ XBT_PUBLIC(void*)
+ XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") recv(MailboxPtr chan);
+ XBT_PUBLIC(void*)
+ XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.")
+ recv(MailboxPtr chan, double timeout);
+ XBT_PUBLIC(CommPtr)
+ XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.")
+ 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_PUBLIC(void) send(MailboxPtr chan, void* payload, double simulatedSize);
+ XBT_PUBLIC(void)
+ XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.")
+ send(MailboxPtr chan, void* payload, double simulatedSize); // 3.17
+ XBT_PUBLIC(void)
+ XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.")
+ send(MailboxPtr chan, void* payload, double simulatedSize, double timeout); // 3.17
+
+ XBT_PUBLIC(CommPtr)
+ XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.")
+ isend(MailboxPtr chan, void* payload, double simulatedSize);
- /** @brief Returns the PID of the current actor. */
- XBT_PUBLIC(int) pid();
+ /** @brief Returns the actor ID of the current actor (same as pid). */
+ XBT_PUBLIC(aid_t) getPid();
- /** @brief Returns the PPID of the current actor. */
- XBT_PUBLIC(int) ppid();
+ /** @brief Returns the ancestor's actor ID of the current actor (same as ppid). */
+ XBT_PUBLIC(aid_t) getPpid();
/** @brief Returns the name of the current actor. */
- XBT_PUBLIC(std::string) name();
+ XBT_PUBLIC(std::string) getName();
/** @brief Returns the name of the host on which the process is running. */
- XBT_PUBLIC(Host*) host();
+ 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
