Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
allow to declare an actor with parameter without going for a full class object
[simgrid.git] / include / simgrid / s4u / Actor.hpp
1 /* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #ifndef SIMGRID_S4U_ACTOR_HPP
7 #define SIMGRID_S4U_ACTOR_HPP
8
9 #include <atomic>
10 #include <chrono>
11 #include <functional>
12 #include <memory>
13 #include <stdexcept>
14 #include <string>
15 #include <type_traits>
16 #include <utility>
17 #include <vector>
18
19 #include <xbt/Extendable.hpp>
20 #include <xbt/functional.hpp>
21 #include <xbt/string.hpp>
22
23 #include <simgrid/chrono.hpp>
24 #include <simgrid/s4u/forward.hpp>
25
26 namespace simgrid {
27 namespace s4u {
28
29 /** @ingroup s4u_api
30  *
31  * An actor is an independent stream of execution in your distributed application.
32  *
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.
37  *
38  * An actor is located on a (simulated) host, but it can interact
39  * with the whole simulated platform.
40  *
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
44  * Actors.
45  *
46  * @section s4u_actor_def Defining the skeleton of an Actor
47  *
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:
51  *
52  * @code{.cpp}
53  * #include "s4u/actor.hpp"
54  *
55  * // Declare the code of your worker
56  * void worker() {
57  *   printf("Hello s4u");
58  *   simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
59  * };
60  *
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);
64  * @endcode
65  *
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.
69  *
70  * @code{.cpp}
71  * #include "s4u/actor.hpp"
72  *
73  * // Declare the class representing your actors
74  * class Worker {
75  * public:
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
79  *   }
80  * };
81  *
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());
84  * @endcode
85  *
86  * @section s4u_actor_flesh Fleshing your actor
87  *
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).
93  *
94  * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
95  *
96  *
97  * @section s4u_actor_deploy Using a deployment file
98  *
99  * @warning This is currently not working with S4U. Sorry about that.
100  *
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.
106  *
107  * @code{.xml}
108  * <?xml version='1.0'?>
109  * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
110  * <platform version="4">
111  *
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] -->
119  *   </process>
120  *
121  *   <!-- Start a process called 'worker' on the host called 'Jupiter' -->
122  *   <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
123  *
124  * </platform>
125  * @endcode
126  *
127  *  @{
128  */
129
130 /** @brief Simulation Agent */
131 XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
132 {
133   friend Mailbox;
134   friend simgrid::simix::ActorImpl;
135   friend simgrid::kernel::activity::MailboxImpl;
136   simix::ActorImpl* pimpl_ = nullptr;
137
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)
141   {
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)(); };
146   }
147
148   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
149
150 public:
151
152   // ***** No copy *****
153   Actor(Actor const&) = delete;
154   Actor& operator=(Actor const&) = delete;
155
156   // ***** Reference count (delegated to pimpl_) *****
157   friend void intrusive_ptr_add_ref(Actor* actor)
158   {
159     xbt_assert(actor != nullptr);
160     SIMIX_process_ref(actor->pimpl_);
161   }
162   friend void intrusive_ptr_release(Actor* actor)
163   {
164     xbt_assert(actor != nullptr);
165     SIMIX_process_unref(actor->pimpl_);
166   }
167
168   // ***** Actor creation *****
169   /** Retrieve a reference to myself */
170   static ActorPtr self();
171
172   /** Create an actor using a function
173    *
174    *  If the actor is restarted, the actor has a fresh copy of the function.
175    */
176   static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
177
178   static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>)> code,
179                               std::vector<std::string> args)
180   {
181     return createActor(name, host, [code](std::vector<std::string> args) { code(args); }, args);
182   }
183
184   /** Create an actor using code
185    *
186    *  Using this constructor, move-only type can be used. The consequence is
187    *  that we cannot copy the value and restart the process in its initial
188    *  state. In order to use auto-restart, an explicit `function` must be passed
189    *  instead.
190    */
191   template<class F, class... Args,
192     // This constructor is enabled only if the call code(args...) is valid:
193     typename = typename std::result_of<F(Args...)>::type
194     >
195   static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args)
196   {
197     return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
198   }
199
200   // Create actor from function name:
201
202   static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
203
204   // ***** Methods *****
205
206   /** Retrieves the name of that actor as a C string */
207   const char* cname();
208   /** Retrieves the name of that actor as a C++ string */
209   simgrid::xbt::string name();
210   /** Retrieves the host on which that actor is running */
211   s4u::Host* host();
212   /** Retrieves the PID of that actor
213    *
214    * actor_id_t is an alias for unsigned long */
215   aid_t pid();
216   /** Retrieves the PPID of that actor
217    *
218    * actor_id_t is an alias for unsigned long */
219   aid_t ppid();
220
221   /** Suspend an actor by suspending the task on which it was waiting for the completion. */
222   void suspend();
223
224   /** Resume a suspended process by resuming the task on which it was waiting for the completion. */
225   void resume();
226
227   /** Returns true if the process is suspended. */
228   int isSuspended();
229
230   /** If set to true, the actor will automatically restart when its host reboots */
231   void setAutoRestart(bool autorestart);
232
233   /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
234    * executed when your actor is killed. You should use them to free the data used by your process.
235    */
236   void onExit(int_f_pvoid_pvoid_t fun, void* data);
237
238   /** Sets the time at which that actor should be killed */
239   void setKillTime(double time);
240   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
241   double killTime();
242
243   void migrate(Host * new_host);
244
245   /** Ask the actor to die.
246    *
247    * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
248    * Being killed is not something that actors can defer or avoid.
249    *
250    * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
251    * Still. Please report any bug that you may encounter with a minimal working example.
252    */
253   void kill();
254
255   static void kill(aid_t pid);
256
257   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
258   static ActorPtr byPid(aid_t pid);
259
260   /** @brief Wait for the actor to finish.
261    *
262    * This blocks the calling actor until the actor on which we call join() is terminated
263    */
264   void join();
265   
266   // Static methods on all actors:
267
268   /** Ask kindly to all actors to die. Only the issuer will survive. */
269   static void killAll();
270   static void killAll(int resetPid);
271
272   /** Returns the internal implementation of this actor */
273   simix::ActorImpl* getImpl();
274
275   /** Retrieve the property value (or nullptr if not set) */
276   const char* property(const char* key);
277   void setProperty(const char* key, const char* value);
278 };
279
280 /** @ingroup s4u_api
281  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
282 namespace this_actor {
283
284   /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
285   XBT_PUBLIC(void) sleep_for(double duration);
286   XBT_PUBLIC(void) sleep_until(double timeout);
287
288   template<class Rep, class Period>
289   inline void sleep_for(std::chrono::duration<Rep, Period> duration)
290   {
291     auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
292     this_actor::sleep_for(seconds.count());
293   }
294   template<class Duration>
295   inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
296   {
297     auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
298     this_actor::sleep_until(timeout_native.time_since_epoch().count());
299   }
300
301   XBT_ATTRIB_DEPRECATED("Use sleep_for()")
302   inline void sleep(double duration)
303   {
304     return sleep_for(duration);
305   }
306
307   /** Block the actor, computing the given amount of flops */
308   XBT_PUBLIC(e_smx_state_t) execute(double flop);
309
310   /** Block the actor until it gets a message from the given mailbox.
311    *
312    * See \ref Comm for the full communication API (including non blocking communications).
313    */
314   XBT_PUBLIC(void*) recv(MailboxPtr chan);
315   XBT_PUBLIC(CommPtr) irecv(MailboxPtr chan, void** data);
316
317   /** Block the actor until it delivers a message of the given simulated size to the given mailbox
318    *
319    * See \ref Comm for the full communication API (including non blocking communications).
320   */
321   XBT_PUBLIC(void) send(MailboxPtr chan, void* payload, double simulatedSize);
322   XBT_PUBLIC(void) send(MailboxPtr chan, void* payload, double simulatedSize, double timeout);
323
324   XBT_PUBLIC(CommPtr) isend(MailboxPtr chan, void* payload, double simulatedSize);
325   XBT_PUBLIC(void) dsend(MailboxPtr chan, void* payload, double simulatedSize);
326
327   /** @brief Returns the actor ID of the current actor (same as pid). */
328   XBT_PUBLIC(aid_t) pid();
329
330   /** @brief Returns the ancestor's actor ID of the current actor (same as ppid). */
331   XBT_PUBLIC(aid_t) ppid();
332
333   /** @brief Returns the name of the current actor. */
334   XBT_PUBLIC(std::string) name();
335
336   /** @brief Returns the name of the host on which the process is running. */
337   XBT_PUBLIC(Host*) host();
338
339   /** @brief Suspend the actor. */
340   XBT_PUBLIC(void) suspend();
341
342   /** @brief Resume the actor. */
343   XBT_PUBLIC(void) resume();
344
345   XBT_PUBLIC(int) isSuspended();
346
347   /** @brief kill the actor. */
348   XBT_PUBLIC(void) kill();
349
350   /** @brief Add a function to the list of "on_exit" functions. */
351   XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data);
352
353   /** @brief Migrate the actor to a new host. */
354   XBT_PUBLIC(void) migrate(Host* new_host);
355 };
356
357 /** @} */
358
359 }} // namespace simgrid::s4u
360
361
362 #endif /* SIMGRID_S4U_ACTOR_HPP */