1 /* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_S4U_ACTOR_HPP
7 #define SIMGRID_S4U_ACTOR_HPP
15 #include <type_traits>
19 #include <xbt/Extendable.hpp>
20 #include <xbt/functional.hpp>
21 #include <xbt/string.hpp>
23 #include <simgrid/chrono.hpp>
24 #include <simgrid/s4u/forward.hpp>
31 * An actor is an independent stream of execution in your distributed application.
33 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
34 * This is the only component in SimGrid that actually does something on its own, executing its own code.
35 * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
36 * schedule these activities.
38 * An actor is located on a (simulated) host, but it can interact
39 * with the whole simulated platform.
41 * The s4u::Actor API is strongly inspired from the C++11 threads.
42 * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
43 * of this standard</a> may help to understand the philosophy of the S4U
46 * @section s4u_actor_def Defining the skeleton of an Actor
48 * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
49 * standard</a>, you can declare the code of your actor either as a
50 * pure function or as an object. It is very simple with functions:
53 * #include "s4u/actor.hpp"
55 * // Declare the code of your worker
57 * printf("Hello s4u");
58 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
61 * // From your main or from another actor, create your actor on the host Jupiter
62 * // The following line actually creates a new actor, even if there is no "new".
63 * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
66 * But some people prefer to encapsulate their actors in classes and
67 * objects to save the actor state in a cleanly dedicated location.
68 * The syntax is slightly more complicated, but not much.
71 * #include "s4u/actor.hpp"
73 * // Declare the class representing your actors
76 * void operator()() { // Two pairs of () because this defines the method called ()
77 * printf("Hello s4u");
78 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
82 * // From your main or from another actor, create your actor. Note the () after Worker
83 * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
86 * @section s4u_actor_flesh Fleshing your actor
88 * The body of your actor can use the functions of the
89 * simgrid::s4u::this_actor namespace to interact with the world.
90 * This namespace contains the methods to start new activities
91 * (executions, communications, etc), and to get informations about
92 * the currently running thread (its location, etc).
94 * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
97 * @section s4u_actor_deploy Using a deployment file
99 * @warning This is currently not working with S4U. Sorry about that.
101 * The best practice is to use an external deployment file as
102 * follows, because it makes it easier to test your application in
103 * differing settings. Load this file with
104 * s4u::Engine::loadDeployment() before the simulation starts.
105 * Refer to the @ref deployment section for more information.
108 * <?xml version='1.0'?>
109 * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
110 * <platform version="4">
112 * <!-- Start a process called 'master' on the host called 'Tremblay' -->
113 * <process host="Tremblay" function="master">
114 * <!-- Here come the parameter that you want to feed to this instance of master -->
115 * <argument value="20"/> <!-- argv[1] -->
116 * <argument value="50000000"/> <!-- argv[2] -->
117 * <argument value="1000000"/> <!-- argv[3] -->
118 * <argument value="5"/> <!-- argv[4] -->
121 * <!-- Start a process called 'worker' on the host called 'Jupiter' -->
122 * <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
130 /** @brief Simulation Agent */
131 XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
134 friend simgrid::simix::ActorImpl;
135 friend simgrid::kernel::activity::MailboxImpl;
136 simix::ActorImpl* pimpl_ = nullptr;
138 /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
139 template<class F, class... Args>
140 static std::function<void()> wrap_task(F f, Args... args)
142 typedef decltype(f(std::move(args)...)) R;
143 auto task = std::make_shared<simgrid::xbt::Task<R()>>(
144 simgrid::xbt::makeTask(std::move(f), std::move(args)...));
145 return [task] { (*task)(); };
148 explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
152 // ***** No copy *****
153 Actor(Actor const&) = delete;
154 Actor& operator=(Actor const&) = delete;
156 // ***** Reference count *****
157 friend void intrusive_ptr_add_ref(Actor * actor);
158 friend void intrusive_ptr_release(Actor * actor);
160 // ***** Actor creation *****
161 /** Retrieve a reference to myself */
162 static ActorPtr self();
164 /** Create an actor using a function
166 * If the actor is restarted, the actor has a fresh copy of the function.
168 static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
170 static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
171 std::vector<std::string>* args)
173 return createActor(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
176 /** Create an actor using code
178 * Using this constructor, move-only type can be used. The consequence is
179 * that we cannot copy the value and restart the process in its initial
180 * state. In order to use auto-restart, an explicit `function` must be passed
183 template<class F, class... Args,
184 // This constructor is enabled only if the call code(args...) is valid:
185 typename = typename std::result_of<F(Args...)>::type
187 static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args)
189 return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
192 // Create actor from function name:
194 static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
196 // ***** Methods *****
197 /** This actor will be automatically terminated when the last non-daemon process finishes **/
200 /** Retrieves the name of that actor as a C string */
201 const char* getCname();
202 /** Retrieves the name of that actor as a C++ string */
203 simgrid::xbt::string getName();
204 /** Retrieves the host on which that actor is running */
205 s4u::Host* getHost();
206 /** Retrieves the PID of that actor
208 * actor_id_t is an alias for unsigned long */
210 /** Retrieves the PPID of that actor
212 * actor_id_t is an alias for unsigned long */
215 /** Suspend an actor by suspending the task on which it was waiting for the completion. */
218 /** Resume a suspended process by resuming the task on which it was waiting for the completion. */
221 /** Returns true if the process is suspended. */
224 /** If set to true, the actor will automatically restart when its host reboots */
225 void setAutoRestart(bool autorestart);
227 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
228 * executed when your actor is killed. You should use them to free the data used by your process.
230 void onExit(int_f_pvoid_pvoid_t fun, void* data);
232 /** Sets the time at which that actor should be killed */
233 void setKillTime(double time);
234 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
235 double getKillTime();
237 void migrate(Host * new_host);
239 /** Ask the actor to die.
241 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
242 * Being killed is not something that actors can defer or avoid.
244 * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
245 * Still. Please report any bug that you may encounter with a minimal working example.
249 static void kill(aid_t pid);
251 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
252 static ActorPtr byPid(aid_t pid);
254 /** @brief Wait for the actor to finish.
256 * This blocks the calling actor until the actor on which we call join() is terminated
260 // Static methods on all actors:
262 /** Ask kindly to all actors to die. Only the issuer will survive. */
263 static void killAll();
264 static void killAll(int resetPid);
266 /** Returns the internal implementation of this actor */
267 simix::ActorImpl* getImpl();
269 /** Retrieve the property value (or nullptr if not set) */
270 const char* getProperty(const char* key);
271 void setProperty(const char* key, const char* value);
275 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
276 namespace this_actor {
278 XBT_PUBLIC(bool) isMaestro();
280 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
281 XBT_PUBLIC(void) sleep_for(double duration);
282 XBT_PUBLIC(void) sleep_until(double timeout);
284 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
286 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
287 this_actor::sleep_for(seconds.count());
289 template<class Duration>
290 inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
292 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
293 this_actor::sleep_until(timeout_native.time_since_epoch().count());
296 XBT_ATTRIB_DEPRECATED_v320("Use sleep_for(): v3.20 will drop sleep() completely.") inline void sleep(double duration)
298 return sleep_for(duration);
301 /** Block the actor, computing the given amount of flops */
302 XBT_PUBLIC(void) execute(double flop);
304 /** Block the actor until it gets a message from the given mailbox.
306 * See \ref Comm for the full communication API (including non blocking communications).
309 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will remove Actor::recv() completely.") recv(MailboxPtr chan);
311 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will remove Actor::recv() completely.")
312 recv(MailboxPtr chan, double timeout);
314 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will remove Actor::irecv() completely.")
315 irecv(MailboxPtr chan, void** data);
317 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
319 * See \ref Comm for the full communication API (including non blocking communications).
322 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will remove Actor::send() completely.")
323 send(MailboxPtr chan, void* payload, double simulatedSize); // 3.17
325 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will remove Actor::send() completely.")
326 send(MailboxPtr chan, void* payload, double simulatedSize, double timeout); // 3.17
329 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will remove Actor::isend() completely.")
330 isend(MailboxPtr chan, void* payload, double simulatedSize);
332 /** @brief Returns the actor ID of the current actor (same as pid). */
333 XBT_PUBLIC(aid_t) getPid();
335 /** @brief Returns the ancestor's actor ID of the current actor (same as ppid). */
336 XBT_PUBLIC(aid_t) getPpid();
338 /** @brief Returns the name of the current actor. */
339 XBT_PUBLIC(std::string) getName();
341 /** @brief Returns the name of the host on which the process is running. */
342 XBT_PUBLIC(Host*) getHost();
344 /** @brief Suspend the actor. */
345 XBT_PUBLIC(void) suspend();
347 /** @brief Resume the actor. */
348 XBT_PUBLIC(void) resume();
350 XBT_PUBLIC(bool) isSuspended();
352 /** @brief kill the actor. */
353 XBT_PUBLIC(void) kill();
355 /** @brief Add a function to the list of "on_exit" functions. */
356 XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data);
358 /** @brief Migrate the actor to a new host. */
359 XBT_PUBLIC(void) migrate(Host* new_host);
364 }} // namespace simgrid::s4u
367 #endif /* SIMGRID_S4U_ACTOR_HPP */