Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove old #define/#undef.
[simgrid.git] / include / simgrid / s4u / Actor.hpp
1 /* Copyright (c) 2006-2017. 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 *****
157   friend void intrusive_ptr_add_ref(Actor * actor);
158   friend void intrusive_ptr_release(Actor * actor);
159
160   // ***** Actor creation *****
161   /** Retrieve a reference to myself */
162   static ActorPtr self();
163
164   /** Create an actor using a function
165    *
166    *  If the actor is restarted, the actor has a fresh copy of the function.
167    */
168   static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
169
170   static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
171                               std::vector<std::string>* args)
172   {
173     return createActor(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
174   }
175
176   /** Create an actor using code
177    *
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
181    *  instead.
182    */
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
186     >
187   static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args)
188   {
189     return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
190   }
191
192   // Create actor from function name:
193
194   static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
195
196   // ***** Methods *****
197   /** This actor will be automatically terminated when the last non-daemon process finishes **/
198   void daemonize();
199
200   /** Retrieves the name of that actor as a C++ string */
201   const simgrid::xbt::string& getName() const;
202   /** Retrieves the name of that actor as a C string */
203   const char* getCname() const;
204   /** Retrieves the host on which that actor is running */
205   s4u::Host* getHost();
206   /** Retrieves the PID of that actor
207    *
208    * actor_id_t is an alias for unsigned long */
209   aid_t getPid();
210   /** Retrieves the PPID of that actor
211    *
212    * actor_id_t is an alias for unsigned long */
213   aid_t getPpid();
214
215   /** Suspend an actor by suspending the task on which it was waiting for the completion. */
216   void suspend();
217
218   /** Resume a suspended process by resuming the task on which it was waiting for the completion. */
219   void resume();
220
221   /** Returns true if the process is suspended. */
222   int isSuspended();
223
224   /** If set to true, the actor will automatically restart when its host reboots */
225   void setAutoRestart(bool autorestart);
226
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.
229    */
230   void onExit(int_f_pvoid_pvoid_t fun, void* data);
231
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();
236
237   void migrate(Host * new_host);
238
239   /** Ask the actor to die.
240    *
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.
243    *
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.
246    */
247   void kill();
248
249   static void kill(aid_t pid);
250
251   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
252   static ActorPtr byPid(aid_t pid);
253
254   /** @brief Wait for the actor to finish.
255    *
256    * This blocks the calling actor until the actor on which we call join() is terminated
257    */
258   void join();
259
260   // Static methods on all actors:
261
262   /** Ask kindly to all actors to die. Only the issuer will survive. */
263   static void killAll();
264   static void killAll(int resetPid);
265
266   /** Returns the internal implementation of this actor */
267   simix::ActorImpl* getImpl();
268
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);
272   Actor* restart();
273 };
274
275 /** @ingroup s4u_api
276  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
277 namespace this_actor {
278
279 XBT_PUBLIC(bool) isMaestro();
280
281 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
282 XBT_PUBLIC(void) sleep_for(double duration);
283 XBT_PUBLIC(void) sleep_until(double timeout);
284
285 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
286 {
287   auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
288   this_actor::sleep_for(seconds.count());
289 }
290
291 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
292 {
293   auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
294   this_actor::sleep_until(timeout_native.time_since_epoch().count());
295 }
296
297 XBT_ATTRIB_DEPRECATED_v320("Use sleep_for(): v3.20 will turn this warning into an error.") inline void sleep(
298     double duration)
299 {
300   return sleep_for(duration);
301 }
302
303 /** Block the actor, computing the given amount of flops */
304 XBT_PUBLIC(void) execute(double flop);
305
306 /** Block the actor until it gets a message from the given mailbox.
307  *
308  * See \ref Comm for the full communication API (including non blocking communications).
309  */
310 XBT_PUBLIC(void*)
311 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") recv(MailboxPtr chan);
312 XBT_PUBLIC(void*)
313 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.")
314     recv(MailboxPtr chan, double timeout);
315 XBT_PUBLIC(CommPtr)
316 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.")
317     irecv(MailboxPtr chan, void** data);
318
319 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
320  *
321  * See \ref Comm for the full communication API (including non blocking communications).
322 */
323 XBT_PUBLIC(void)
324 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.")
325     send(MailboxPtr chan, void* payload, double simulatedSize); // 3.17
326 XBT_PUBLIC(void)
327 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.")
328     send(MailboxPtr chan, void* payload, double simulatedSize, double timeout); // 3.17
329
330 XBT_PUBLIC(CommPtr)
331 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.")
332     isend(MailboxPtr chan, void* payload, double simulatedSize);
333
334 /** @brief Returns the actor ID of the current actor (same as pid). */
335 XBT_PUBLIC(aid_t) getPid();
336
337 /** @brief Returns the ancestor's actor ID of the current actor (same as ppid). */
338 XBT_PUBLIC(aid_t) getPpid();
339
340 /** @brief Returns the name of the current actor. */
341 XBT_PUBLIC(std::string) getName();
342
343 /** @brief Returns the name of the current actor as a C string. */
344 XBT_PUBLIC(const char*) getCname();
345
346 /** @brief Returns the name of the host on which the process is running. */
347 XBT_PUBLIC(Host*) getHost();
348
349 /** @brief Suspend the actor. */
350 XBT_PUBLIC(void) suspend();
351
352 /** @brief Resume the actor. */
353 XBT_PUBLIC(void) resume();
354
355 XBT_PUBLIC(bool) isSuspended();
356
357 /** @brief kill the actor. */
358 XBT_PUBLIC(void) kill();
359
360 /** @brief Add a function to the list of "on_exit" functions. */
361 XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data);
362
363 /** @brief Migrate the actor to a new host. */
364 XBT_PUBLIC(void) migrate(Host* new_host);
365 }
366
367 /** @} */
368
369 }} // namespace simgrid::s4u
370
371
372 #endif /* SIMGRID_S4U_ACTOR_HPP */