Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
hide some cruft from the doc
[simgrid.git] / include / simgrid / s4u / Actor.hpp
1 /* Copyright (c) 2006-2019. 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 <simgrid/forward.h>
10
11 #include <simgrid/chrono.hpp>
12 #include <xbt/Extendable.hpp>
13 #include <xbt/functional.hpp>
14 #include <xbt/signal.hpp>
15 #include <xbt/string.hpp>
16
17 #include <functional>
18 #include <map> // deprecated wrappers
19 #include <unordered_map>
20
21 namespace simgrid {
22 namespace s4u {
23
24 /**
25  *
26  * An actor is an independent stream of execution in your distributed application.
27  *
28  * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
29  * This is the only component in SimGrid that actually does something on its own, executing its own code.
30  * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
31  * schedule these activities.
32  *
33  * An actor is located on a (simulated) host, but it can interact
34  * with the whole simulated platform.
35  *
36  * The s4u::Actor API is strongly inspired from the C++11 threads.
37  * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
38  * of this standard</a> may help to understand the philosophy of the S4U
39  * Actors.
40  *
41  * @section s4u_actor_def Defining the skeleton of an Actor
42  *
43  * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
44  * standard</a>, you can declare the code of your actor either as a
45  * pure function or as an object. It is very simple with functions:
46  *
47  * @code{.cpp}
48  * #include <simgrid/s4u/actor.hpp>
49  *
50  * // Declare the code of your worker
51  * void worker() {
52  *   printf("Hello s4u");
53  *   simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
54  * };
55  *
56  * // From your main or from another actor, create your actor on the host Jupiter
57  * // The following line actually creates a new actor, even if there is no "new".
58  * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
59  * @endcode
60  *
61  * But some people prefer to encapsulate their actors in classes and
62  * objects to save the actor state in a cleanly dedicated location.
63  * The syntax is slightly more complicated, but not much.
64  *
65  * @code{.cpp}
66  * #include <simgrid/s4u/actor.hpp>
67  *
68  * // Declare the class representing your actors
69  * class Worker {
70  * public:
71  *   void operator()() { // Two pairs of () because this defines the method called ()
72  *     printf("Hello s4u");
73  *     simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
74  *   }
75  * };
76  *
77  * // From your main or from another actor, create your actor. Note the () after Worker
78  * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
79  * @endcode
80  *
81  * @section s4u_actor_flesh Fleshing your actor
82  *
83  * The body of your actor can use the functions of the
84  * simgrid::s4u::this_actor namespace to interact with the world.
85  * This namespace contains the methods to start new activities
86  * (executions, communications, etc), and to get informations about
87  * the currently running thread (its location, etc).
88  *
89  * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
90  *
91  *
92  * @section s4u_actor_deploy Using a deployment file
93  *
94  * @warning This is currently not working with S4U. Sorry about that.
95  *
96  * The best practice is to use an external deployment file as
97  * follows, because it makes it easier to test your application in
98  * differing settings. Load this file with
99  * s4u::Engine::loadDeployment() before the simulation starts.
100  * Refer to the @ref deployment section for more information.
101  *
102  * @code{.xml}
103  * <?xml version='1.0'?>
104  * <!DOCTYPE platform SYSTEM "https://simgrid.org/simgrid.dtd">
105  * <platform version="4.1">
106  *
107  *   <!-- Start an actor called 'master' on the host called 'Tremblay' -->
108  *   <actor host="Tremblay" function="master">
109  *      <!-- Here come the parameter that you want to feed to this instance of master -->
110  *      <argument value="20"/>        <!-- argv[1] -->
111  *      <argument value="50000000"/>  <!-- argv[2] -->
112  *      <argument value="1000000"/>   <!-- argv[3] -->
113  *      <argument value="5"/>         <!-- argv[4] -->
114  *   </actor>
115  *
116  *   <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
117  *   <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
118  *
119  * </platform>
120  * @endcode
121  *
122  *  @{
123  */
124
125 /** @brief Simulation Agent */
126 class XBT_PUBLIC Actor : public xbt::Extendable<Actor> {
127 #ifndef DOXYGEN
128   friend Exec;
129   friend Mailbox;
130   friend kernel::actor::ActorImpl;
131   friend kernel::activity::MailboxImpl;
132
133   kernel::actor::ActorImpl* const pimpl_;
134 #endif
135
136   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
137
138 public:
139 #ifndef DOXYGEN
140   // ***** No copy *****
141   Actor(Actor const&) = delete;
142   Actor& operator=(Actor const&) = delete;
143
144   // ***** Reference count *****
145   friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor);
146   friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor);
147 #endif
148   /** Retrive the amount of references on that object. Useful to debug the automatic refcounting */
149   int get_refcount();
150
151   // ***** Actor creation *****
152   /** Retrieve a reference to myself */
153   static Actor* self();
154
155   /** Fired when a new actor has been created **/
156   static xbt::signal<void(Actor&)> on_creation;
157   /** Signal to others that an actor has been suspended**/
158   static xbt::signal<void(Actor const&)> on_suspend;
159   /** Signal to others that an actor has been resumed **/
160   static xbt::signal<void(Actor const&)> on_resume;
161   /** Signal to others that an actor is sleeping **/
162   static xbt::signal<void(Actor const&)> on_sleep;
163   /** Signal to others that an actor wakes up for a sleep **/
164   static xbt::signal<void(Actor const&)> on_wake_up;
165   /** Signal to others that an actor is going to migrated to another host**/
166   static xbt::signal<void(Actor const&)> on_migration_start;
167   /** Signal to others that an actor is has been migrated to another host **/
168   static xbt::signal<void(Actor const&)> on_migration_end;
169   /** Signal indicating that an actor terminated its code.
170    *  The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore.
171    *  If you want to free extra data when the actor's destructor is called, use Actor::on_destruction.
172    *  If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/
173   static xbt::signal<void(Actor const&)> on_termination;
174   /** Signal indicating that an actor is about to disappear (its destructor was called).
175    *  This signal is fired for any destructed actor, which is mostly useful when designing plugins and extensions.
176    *  If you want to react to the end of the actor's code, use Actor::on_termination instead.
177    *  If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/
178   static xbt::signal<void(Actor const&)> on_destruction;
179
180   /** Create an actor from a std::function<void()>
181    *
182    *  If the actor is restarted, the actor has a fresh copy of the function.
183    */
184   static ActorPtr create(const std::string& name, s4u::Host* host, const std::function<void()>& code);
185   static ActorPtr init(const std::string& name, s4u::Host* host);
186   ActorPtr start(const std::function<void()>& code);
187
188   /** Create an actor from a std::function
189    *
190    *  If the actor is restarted, the actor has a fresh copy of the function.
191    */
192   template <class F> static ActorPtr create(const std::string& name, s4u::Host* host, F code)
193   {
194     return create(name, host, std::function<void()>(std::move(code)));
195   }
196
197   /** Create an actor using a callable thing and its arguments.
198    *
199    * Note that the arguments will be copied, so move-only parameters are forbidden */
200   template <class F, class... Args,
201             // This constructor is enabled only if the call code(args...) is valid:
202             typename = typename std::result_of<F(Args...)>::type>
203   static ActorPtr create(const std::string& name, s4u::Host* host, F code, Args... args)
204   {
205     return create(name, host, std::bind(std::move(code), std::move(args)...));
206   }
207
208   // Create actor from function name:
209   static ActorPtr create(const std::string& name, s4u::Host* host, const std::string& function,
210                          std::vector<std::string> args);
211
212   // ***** Methods *****
213   /** This actor will be automatically terminated when the last non-daemon actor finishes **/
214   void daemonize();
215
216   /** Returns whether or not this actor has been daemonized or not **/
217   bool is_daemon() const;
218
219   /** Retrieves the name of that actor as a C++ string */
220   const simgrid::xbt::string& get_name() const;
221   /** Retrieves the name of that actor as a C string */
222   const char* get_cname() const;
223   /** Retrieves the host on which that actor is running */
224   Host* get_host() const;
225   /** Retrieves the actor ID of that actor */
226   aid_t get_pid() const;
227   /** Retrieves the actor ID of that actor's creator */
228   aid_t get_ppid() const;
229
230   /** Suspend an actor, that is blocked until resume()ed by another actor */
231   void suspend();
232
233   /** Resume an actor that was previously suspend()ed */
234   void resume();
235
236   /** Returns true if the actor is suspended. */
237   bool is_suspended();
238
239   /** If set to true, the actor will automatically restart when its host reboots */
240   void set_auto_restart(bool autorestart);
241
242   /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
243    * executed when your actor is killed. You should use them to free the data used by your actor.
244    *
245    * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
246    * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
247    * blocking functions forbidden in this setting, but also modifications to the global state.
248    *
249    * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
250    * It will be set to true if the actor was killed or failed because of an exception,
251    * while it will remain to false if the actor terminated gracefully.
252    */
253   void on_exit(const std::function<void(bool /*failed*/)>& fun) const;
254
255   /** Sets the time at which that actor should be killed */
256   void set_kill_time(double time);
257   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
258   double get_kill_time();
259
260   /** @brief Moves the actor to another host
261    *
262    * If the actor is currently blocked on an execution activity, the activity is also
263    * migrated to the new host. If it's blocked on another kind of activity, an error is
264    * raised as the mandated code is not written yet. Please report that bug if you need it.
265    *
266    * Asynchronous activities started by the actor are not migrated automatically, so you have
267    * to take care of this yourself (only you knows which ones should be migrated).
268    */
269   void migrate(Host * new_host);
270
271   /** Ask the actor to die.
272    *
273    * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
274    * Being killed is not something that actors can defer or avoid.
275    *
276    * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
277    * Still. Please report any bug that you may encounter with a minimal working example.
278    */
279   void kill();
280
281   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
282   static ActorPtr by_pid(aid_t pid);
283
284   /** Wait for the actor to finish.
285    *
286    * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
287    * blocked until bob terminates.
288    */
289   void join();
290
291   /** Wait for the actor to finish, or for the timeout to elapse.
292    *
293    * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
294    * blocked until bob terminates.
295    */
296   void join(double timeout);
297   Actor* restart();
298
299   /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */
300   static void kill_all();
301
302   /** Returns the internal implementation of this actor */
303   kernel::actor::ActorImpl* get_impl() const { return pimpl_; }
304
305   /** Retrieve the property value (or nullptr if not set) */
306   const std::unordered_map<std::string, std::string>*
307   get_properties() const; // FIXME: do not export the map, but only the keys or something
308   const char* get_property(const std::string& key) const;
309   void set_property(const std::string& key, const std::string& value);
310 };
311
312 /** @ingroup s4u_api
313  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
314 namespace this_actor {
315
316 XBT_PUBLIC bool is_maestro();
317
318 /** Block the current actor sleeping for that amount of seconds */
319 XBT_PUBLIC void sleep_for(double duration);
320 /** Block the current actor sleeping until the specified timestamp */
321 XBT_PUBLIC void sleep_until(double wakeup_time);
322
323 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
324 {
325   auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
326   this_actor::sleep_for(seconds.count());
327 }
328
329 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& wakeup_time)
330 {
331   auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(wakeup_time);
332   this_actor::sleep_until(timeout_native.time_since_epoch().count());
333 }
334
335 /** Block the current actor, computing the given amount of flops */
336 XBT_PUBLIC void execute(double flop);
337
338 /** Block the current actor, computing the given amount of flops at the given priority.
339  *  An execution of priority 2 computes twice as fast as an execution at priority 1. */
340 XBT_PUBLIC void execute(double flop, double priority);
341
342 /**
343  * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
344  */
345
346 /** Block the current actor until the built parallel execution terminates
347  *
348  * \rst
349  * .. _API_s4u_parallel_execute:
350  *
351  * **Example of use:** `examples/s4u/exec-ptask/s4u-exec-ptask.cpp
352  * <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-ptask/s4u-exec-ptask.cpp>`_
353  *
354  * Parallel executions convenient abstractions of parallel computational kernels that span over several machines,
355  * such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel
356  * on the platform (e.g. to schedule them wisely), there is no need to model them in all details of their internal
357  * execution and communications. It is much more convenient to model them as a single execution activity that spans
358  * over several hosts. This is exactly what s4u's Parallel Executions are.
359  *
360  * To build such an object, you need to provide a list of hosts that are involved in the parallel kernel (the
361  * actor's own host may or may not be in this list) and specify the amount of computations that should be done by
362  * each host, using a vector of flops amount. Then, you should specify the amount of data exchanged between each
363  * hosts during the parallel kernel. For that, a matrix of values is expected.
364  *
365  * It is OK to build a parallel execution without any computation and/or without any communication.
366  * Just pass an empty vector to the corresponding parameter.
367  *
368  * For example, if your list of hosts is ``[host0, host1]``, passing a vector ``[1000, 2000]`` as a `flops_amount`
369  * vector means that `host0` should compute 1000 flops while `host1` will compute 2000 flops. A matrix of
370  * communications' sizes of ``[0, 1, 2, 3]`` specifies the following data exchanges:
371  *
372  *   +-----------+-------+------+
373  *   |from \\ to | host0 | host1|
374  *   +===========+=======+======+
375  *   |host0      |   0   |  1   |
376  *   +-----------+-------+------+
377  *   |host1      |   2   |  3   |
378  *   +-----------+-------+------+
379  *
380  * - From host0 to host0: 0 bytes are exchanged
381  * - From host0 to host1: 1 byte is exchanged
382  * - From host1 to host0: 2 bytes are exchanged
383  * - From host1 to host1: 3 bytes are exchanged
384  *
385  * In a parallel execution, all parts (all executions on each hosts, all communications) progress exactly at the
386  * same pace, so they all terminate at the exact same pace. If one part is slow because of a slow resource or
387  * because of contention, this slows down the parallel execution as a whole.
388  *
389  * These objects are somewhat surprising from a modeling point of view. For example, the unit of their speed is
390  * somewhere between flop/sec and byte/sec. Arbitrary parallel executions will simply not work with the usual platform
391  * models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
392  * regular executions and communications with parallel executions, provided that the host model is ptask_L07.
393  *
394  * \endrst
395  */
396 XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
397                                  const std::vector<double>& bytes_amounts);
398
399 /** \rst
400  * Block the current actor until the built :ref:`parallel execution <API_s4u_parallel_execute>` completes, or until the
401  * timeout. \endrst
402  */
403 XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
404                                  const std::vector<double>& bytes_amounts, double timeout);
405
406 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
407 XBT_PUBLIC ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
408                              const std::vector<double>& bytes_amounts);
409
410 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
411
412 /** @brief Returns the actor ID of the current actor. */
413 XBT_PUBLIC aid_t get_pid();
414
415 /** @brief Returns the ancestor's actor ID of the current actor. */
416 XBT_PUBLIC aid_t get_ppid();
417
418 /** @brief Returns the name of the current actor. */
419 XBT_PUBLIC std::string get_name();
420 /** @brief Returns the name of the current actor as a C string. */
421 XBT_PUBLIC const char* get_cname();
422
423 /** @brief Returns the name of the host on which the current actor is running. */
424 XBT_PUBLIC Host* get_host();
425
426 /** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */
427 XBT_PUBLIC void suspend();
428
429 /** @brief Yield the current actor. */
430 XBT_PUBLIC void yield();
431
432 /** @brief Resume the current actor, that was suspend()ed previously. */
433 XBT_PUBLIC void resume();
434
435 /** @brief kill the current actor. */
436 XBT_PUBLIC void exit();
437
438 /** @brief Add a function to the list of "on_exit" functions of the current actor.
439  *
440  * The on_exit functions are the functions executed when your actor is killed. You should use them to free the data used
441  * by your actor.
442  *
443  * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
444  * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
445  * blocking functions forbidden in this setting, but also modifications to the global state.
446  *
447  * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
448  * It will be set to true if the actor was killed or failed because of an exception,
449  * while it will remain to false if the actor terminated gracefully.
450  */
451
452 XBT_PUBLIC void on_exit(const std::function<void(bool)>& fun);
453
454 /** @brief Migrate the current actor to a new host. */
455 XBT_PUBLIC void migrate(Host* new_host);
456
457 /** @} */
458 }
459
460
461 }} // namespace simgrid::s4u
462
463
464 #endif /* SIMGRID_S4U_ACTOR_HPP */