-/* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2018. 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. */
#include <xbt/Extendable.hpp>
#include <xbt/functional.hpp>
#include <xbt/string.hpp>
+#include <xbt/signal.hpp>
#include <simgrid/chrono.hpp>
#include <simgrid/s4u/forward.hpp>
* pure function or as an object. It is very simple with functions:
*
* @code{.cpp}
- * #include "s4u/actor.hpp"
+ * #include <simgrid/s4u/actor.hpp>
*
* // Declare the code of your worker
* void worker() {
* The syntax is slightly more complicated, but not much.
*
* @code{.cpp}
- * #include "s4u/actor.hpp"
+ * #include <simgrid/s4u/actor.hpp>
*
* // Declare the class representing your actors
* class Worker {
* <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
* <platform version="4">
*
- * <!-- Start a process called 'master' on the host called 'Tremblay' -->
- * <process host="Tremblay" function="master">
+ * <!-- Start an actor called 'master' on the host called 'Tremblay' -->
+ * <actor host="Tremblay" function="master">
* <!-- Here come the parameter that you want to feed to this instance of master -->
* <argument value="20"/> <!-- argv[1] -->
* <argument value="50000000"/> <!-- argv[2] -->
* <argument value="1000000"/> <!-- argv[3] -->
* <argument value="5"/> <!-- argv[4] -->
- * </process>
+ * </actor>
*
- * <!-- Start a process called 'worker' on the host called 'Jupiter' -->
- * <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
+ * <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
+ * <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
*
* </platform>
* @endcode
*/
/** @brief Simulation Agent */
-XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
-{
+class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
+ friend Exec;
friend Mailbox;
friend simgrid::simix::ActorImpl;
friend simgrid::kernel::activity::MailboxImpl;
Actor& operator=(Actor const&) = delete;
// ***** Reference count *****
- friend void intrusive_ptr_add_ref(Actor * actor);
- friend void intrusive_ptr_release(Actor * actor);
+ friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor);
+ friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor);
// ***** Actor creation *****
/** Retrieve a reference to myself */
static ActorPtr self();
+ /** Signal to others that a new actor has been created **/
+ static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> onCreation;
+ /** Signal indicating that the given actor is about to disappear */
+ static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> onDestruction;
+
/** Create an actor using a function
*
* If the actor is restarted, the actor has a fresh copy of the function.
/** 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
+ * that we cannot copy the value and restart the actor in its initial
* state. In order to use auto-restart, an explicit `function` must be passed
* instead.
*/
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 **/
+ /** This actor will be automatically terminated when the last non-daemon actor finishes **/
void daemonize();
- /** Retrieves the name of that actor as a C string */
- const char* getCname();
+ /** Returns whether or not this actor has been daemonized or not **/
+ bool isDaemon();
+
/** Retrieves the name of that actor as a C++ string */
- simgrid::xbt::string getName();
+ 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
*
- * actor_id_t is an alias for unsigned long */
+ * aid_t is an alias for long */
aid_t getPid();
/** Retrieves the PPID of that actor
*
- * actor_id_t is an alias for unsigned long */
+ * aid_t is an alias for 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. */
+ /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
void resume();
-
- /** Returns true if the process is suspended. */
+
+ void yield();
+
+ /** Returns true if the actor 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.
+ * executed when your actor is killed. You should use them to free the data used by your actor.
*/
void onExit(int_f_pvoid_pvoid_t fun, void* data);
* This blocks the calling actor until the actor on which we call join() is terminated
*/
void join();
+ void join(double timeout);
// Static methods on all actors:
simix::ActorImpl* getImpl();
/** Retrieve the property value (or nullptr if not set) */
+ std::map<std::string, std::string>* getProperties();
const char* getProperty(const char* key);
void setProperty(const char* key, const char* value);
Actor* restart();
* @brief Static methods working on the current actor (see @ref s4u::Actor) */
namespace this_actor {
-XBT_PUBLIC(bool) isMaestro();
+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);
+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)
{
}
/** Block the actor, computing the given amount of flops */
-XBT_PUBLIC(void) execute(double flop);
+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);
+
+XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
+XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
+ double timeout);
+
+XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
+XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
/** 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*)
-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.")
+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_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.")
+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);
+
+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);
-/** @brief Returns the actor ID of the current actor (same as pid). */
-XBT_PUBLIC(aid_t) getPid();
+/** @brief Returns the actor ID of the current actor). */
+XBT_PUBLIC aid_t getPid();
-/** @brief Returns the ancestor's actor ID of the current actor (same as ppid). */
-XBT_PUBLIC(aid_t) getPpid();
+/** @brief Returns the ancestor's actor ID of the current actor. */
+XBT_PUBLIC aid_t getPpid();
/** @brief Returns the name of the current actor. */
-XBT_PUBLIC(std::string) getName();
+XBT_PUBLIC std::string getName();
+
+/** @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 Returns the name of the host on which the actor is running. */
+XBT_PUBLIC Host* getHost();
/** @brief Suspend the actor. */
-XBT_PUBLIC(void) suspend();
+XBT_PUBLIC void suspend();
+
+/** @brief yield the actor. */
+XBT_PUBLIC void yield();
/** @brief Resume the actor. */
-XBT_PUBLIC(void) resume();
+XBT_PUBLIC void resume();
-XBT_PUBLIC(bool) isSuspended();
+XBT_PUBLIC bool isSuspended();
/** @brief kill the actor. */
-XBT_PUBLIC(void) kill();
+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);
+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);
+XBT_PUBLIC void migrate(Host* new_host);
}
/** @} */
