#include <utility>
#include <vector>
-#include <boost/intrusive_ptr.hpp>
-
-#include <xbt/base.h>
+#include <xbt/Extendable.hpp>
#include <xbt/functional.hpp>
#include <xbt/string.hpp>
#include <simgrid/chrono.hpp>
-#include <simgrid/simix.h>
#include <simgrid/s4u/forward.hpp>
namespace simgrid {
*/
/** @brief Simulation Agent */
-XBT_PUBLIC_CLASS Actor {
+XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
+{
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<class F, class... Args>
typedef decltype(f(std::move(args)...)) R;
auto task = std::make_shared<simgrid::xbt::Task<R()>>(
simgrid::xbt::makeTask(std::move(f), std::move(args)...));
- return [=] {
- (*task)();
- };
+ return [task] { (*task)(); };
}
explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
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);
*
* 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<void()> code);
+ 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()> 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, -1.0, std::move(code));
+ return createActor(name, host, [code](std::vector<std::string> args) { code(args); }, args);
}
/** Create an actor using code
// Create actor from function name:
- static ActorPtr createActor(const char* name, s4u::Host *host, double killTime,
- const char* function, std::vector<std::string> args);
-
- static ActorPtr createActor(const char* name, s4u::Host *host, const char* function,
- std::vector<std::string> 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<std::string> args);
// ***** Methods *****
- /** 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 char* cname();
+ /** Retrieves the name of that actor as a C++ string */
+ simgrid::xbt::string name();
/** 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* host();
+ /** Retrieves the PID of that actor
+ *
+ * actor_id_t is an alias for unsigned long */
+ aid_t pid();
+ /** Retrieves the PPID of that actor
+ *
+ * actor_id_t is an alias for unsigned long */
+ aid_t ppid();
+
+ /** 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();
+ double killTime();
+
+ 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* property(const char* key);
+ void setProperty(const char* key, const char* value);
};
/** @ingroup s4u_api
* See \ref Comm for the full communication API (including non blocking communications).
*/
XBT_PUBLIC(void*) recv(MailboxPtr chan);
+ 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) 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();
+ XBT_PUBLIC(void) send(MailboxPtr chan, void* payload, double simulatedSize);
+ XBT_PUBLIC(void) send(MailboxPtr chan, void* payload, double simulatedSize, double timeout);
+
+ XBT_PUBLIC(CommPtr) isend(MailboxPtr chan, void* payload, double simulatedSize);
+ XBT_PUBLIC(void) dsend(MailboxPtr chan, void* payload, double simulatedSize);
+
+ /** @brief Returns the actor ID of the current actor (same as pid). */
+ XBT_PUBLIC(aid_t) pid();
+
+ /** @brief Returns the ancestor's actor ID of the current actor (same as ppid). */
+ XBT_PUBLIC(aid_t) ppid();
+
+ /** @brief Returns the name of the current actor. */
+ XBT_PUBLIC(std::string) name();
+
+ /** @brief Returns the name of the host on which the process is running. */
+ XBT_PUBLIC(Host*) host();
+
+ /** @brief Suspend the actor. */
+ XBT_PUBLIC(void) suspend();
+
+ /** @brief Resume the actor. */
+ XBT_PUBLIC(void) resume();
+
+ XBT_PUBLIC(int) 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
