Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further snake_case Actor (::this_actor remains)
[simgrid.git] / include / simgrid / s4u / Actor.hpp
1 /* Copyright (c) 2006-2018. 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 #include <xbt/signal.hpp>
23
24 #include <simgrid/chrono.hpp>
25 #include <simgrid/s4u/forward.hpp>
26
27 namespace simgrid {
28 namespace s4u {
29
30 /** @ingroup s4u_api
31  *
32  * An actor is an independent stream of execution in your distributed application.
33  *
34  * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
35  * This is the only component in SimGrid that actually does something on its own, executing its own code.
36  * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
37  * schedule these activities.
38  *
39  * An actor is located on a (simulated) host, but it can interact
40  * with the whole simulated platform.
41  *
42  * The s4u::Actor API is strongly inspired from the C++11 threads.
43  * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
44  * of this standard</a> may help to understand the philosophy of the S4U
45  * Actors.
46  *
47  * @section s4u_actor_def Defining the skeleton of an Actor
48  *
49  * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
50  * standard</a>, you can declare the code of your actor either as a
51  * pure function or as an object. It is very simple with functions:
52  *
53  * @code{.cpp}
54  * #include <simgrid/s4u/actor.hpp>
55  *
56  * // Declare the code of your worker
57  * void worker() {
58  *   printf("Hello s4u");
59  *   simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
60  * };
61  *
62  * // From your main or from another actor, create your actor on the host Jupiter
63  * // The following line actually creates a new actor, even if there is no "new".
64  * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
65  * @endcode
66  *
67  * But some people prefer to encapsulate their actors in classes and
68  * objects to save the actor state in a cleanly dedicated location.
69  * The syntax is slightly more complicated, but not much.
70  *
71  * @code{.cpp}
72  * #include <simgrid/s4u/actor.hpp>
73  *
74  * // Declare the class representing your actors
75  * class Worker {
76  * public:
77  *   void operator()() { // Two pairs of () because this defines the method called ()
78  *     printf("Hello s4u");
79  *     simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
80  *   }
81  * };
82  *
83  * // From your main or from another actor, create your actor. Note the () after Worker
84  * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
85  * @endcode
86  *
87  * @section s4u_actor_flesh Fleshing your actor
88  *
89  * The body of your actor can use the functions of the
90  * simgrid::s4u::this_actor namespace to interact with the world.
91  * This namespace contains the methods to start new activities
92  * (executions, communications, etc), and to get informations about
93  * the currently running thread (its location, etc).
94  *
95  * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
96  *
97  *
98  * @section s4u_actor_deploy Using a deployment file
99  *
100  * @warning This is currently not working with S4U. Sorry about that.
101  *
102  * The best practice is to use an external deployment file as
103  * follows, because it makes it easier to test your application in
104  * differing settings. Load this file with
105  * s4u::Engine::loadDeployment() before the simulation starts.
106  * Refer to the @ref deployment section for more information.
107  *
108  * @code{.xml}
109  * <?xml version='1.0'?>
110  * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
111  * <platform version="4">
112  *
113  *   <!-- Start an actor called 'master' on the host called 'Tremblay' -->
114  *   <actor host="Tremblay" function="master">
115  *      <!-- Here come the parameter that you want to feed to this instance of master -->
116  *      <argument value="20"/>        <!-- argv[1] -->
117  *      <argument value="50000000"/>  <!-- argv[2] -->
118  *      <argument value="1000000"/>   <!-- argv[3] -->
119  *      <argument value="5"/>         <!-- argv[4] -->
120  *   </actor>
121  *
122  *   <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
123  *   <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
124  *
125  * </platform>
126  * @endcode
127  *
128  *  @{
129  */
130
131 /** @brief Simulation Agent */
132 class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
133   friend Exec;
134   friend Mailbox;
135   friend simgrid::kernel::actor::ActorImpl;
136   friend simgrid::kernel::activity::MailboxImpl;
137   kernel::actor::ActorImpl* pimpl_ = nullptr;
138
139   /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
140   template<class F, class... Args>
141   static std::function<void()> wrap_task(F f, Args... args)
142   {
143     typedef decltype(f(std::move(args)...)) R;
144     auto task = std::make_shared<simgrid::xbt::Task<R()>>(
145       simgrid::xbt::makeTask(std::move(f), std::move(args)...));
146     return [task] { (*task)(); };
147   }
148
149   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
150
151 public:
152
153   // ***** No copy *****
154   Actor(Actor const&) = delete;
155   Actor& operator=(Actor const&) = delete;
156
157   // ***** Reference count *****
158   friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor);
159   friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor);
160
161   // ***** Actor creation *****
162   /** Retrieve a reference to myself */
163   static ActorPtr self();
164
165   /** Signal to others that a new actor has been created **/
166   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_creation;
167   /** Signal indicating that the given actor is about to disappear */
168   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_destruction;
169
170   /** Create an actor using a function
171    *
172    *  If the actor is restarted, the actor has a fresh copy of the function.
173    */
174   static ActorPtr create(const char* name, s4u::Host* host, std::function<void()> code);
175
176   static ActorPtr create(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
177                          std::vector<std::string>* args)
178   {
179     return create(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
180   }
181
182   /** Create an actor using code
183    *
184    *  Using this constructor, move-only type can be used. The consequence is
185    *  that we cannot copy the value and restart the actor in its initial
186    *  state. In order to use auto-restart, an explicit `function` must be passed
187    *  instead.
188    */
189   template <class F, class... Args,
190             // This constructor is enabled only if the call code(args...) is valid:
191             typename = typename std::result_of<F(Args...)>::type>
192   static ActorPtr create(const char* name, s4u::Host* host, F code, Args... args)
193   {
194     return create(name, host, wrap_task(std::move(code), std::move(args)...));
195   }
196
197   // Create actor from function name:
198   static ActorPtr create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
199
200   // ***** Methods *****
201   /** This actor will be automatically terminated when the last non-daemon actor finishes **/
202   void daemonize();
203
204   /** Returns whether or not this actor has been daemonized or not **/
205   bool is_daemon() const;
206
207   /** Retrieves the name of that actor as a C++ string */
208   const simgrid::xbt::string& get_name() const;
209   /** Retrieves the name of that actor as a C string */
210   const char* get_cname() const;
211   /** Retrieves the host on which that actor is running */
212   s4u::Host* get_host();
213   /** Retrieves the PID of that actor
214    *
215    * aid_t is an alias for long */
216   aid_t get_pid() const;
217   /** Retrieves the PPID of that actor
218    *
219    * aid_t is an alias for long */
220   aid_t get_ppid() const;
221
222   /** Suspend an actor by suspending the task on which it was waiting for the completion. */
223   void suspend();
224
225   /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
226   void resume();
227
228   void yield();
229
230   /** Returns true if the actor is suspended. */
231   int is_suspended();
232
233   /** If set to true, the actor will automatically restart when its host reboots */
234   void set_auto_restart(bool autorestart);
235
236   /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
237    * executed when your actor is killed. You should use them to free the data used by your actor.
238    */
239   void on_exit(int_f_pvoid_pvoid_t fun, void* data);
240
241   /** Sets the time at which that actor should be killed */
242   void set_kill_time(double time);
243   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
244   double get_kill_time();
245
246   void migrate(Host * new_host);
247
248   /** Ask the actor to die.
249    *
250    * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
251    * Being killed is not something that actors can defer or avoid.
252    *
253    * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
254    * Still. Please report any bug that you may encounter with a minimal working example.
255    */
256   void kill();
257
258   static void kill(aid_t pid);
259
260   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
261   static ActorPtr by_pid(aid_t pid);
262
263   /** @brief Wait for the actor to finish.
264    *
265    * This blocks the calling actor until the actor on which we call join() is terminated
266    */
267   void join();
268   void join(double timeout);
269   Actor* restart();
270
271   /** Ask kindly to all actors to die. Only the issuer will survive. */
272   static void kill_all();
273
274   /** Returns the internal implementation of this actor */
275   kernel::actor::ActorImpl* get_impl();
276
277   /** Retrieve the property value (or nullptr if not set) */
278   std::map<std::string, std::string>* get_properties(); // FIXME: do not export the map, but only the keys or something
279   const char* get_property(const char* key);
280   void set_property(const char* key, const char* value);
281
282   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
283       createActor(const char* name, s4u::Host* host, std::function<void()> code)
284   {
285     return create(name, host, code);
286   }
287   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
288       createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
289                   std::vector<std::string>* args)
290   {
291     return create(name, host, code, args);
292   }
293   template <class F, class... Args, typename = typename std::result_of<F(Args...)>::type>
294   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
295       createActor(const char* name, s4u::Host* host, F code, Args... args)
296   {
297     return create(name, host, code, std::move(args)...);
298   }
299   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
300       createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
301   {
302     return create(name, host, function, args);
303   }
304   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const;
305   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const
306   {
307     return get_name();
308   }
309   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); }
310   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); }
311   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); }
312   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); }
313   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); }
314   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a)
315   {
316     set_auto_restart(a);
317   }
318   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data)
319   {
320     on_exit(fun, data);
321   }
322   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); }
323   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); }
324   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); }
325   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); }
326   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll(int resetPid)
327   {
328     kill_all();
329   }
330   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); }
331   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key)
332   {
333     return get_property(key);
334   }
335   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") std::map<std::string, std::string>* getProperties()
336   {
337     return get_properties();
338   }
339   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value)
340   {
341     set_property(key, value);
342   }
343 };
344
345 /** @ingroup s4u_api
346  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
347 namespace this_actor {
348
349 XBT_PUBLIC bool isMaestro();
350
351 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
352 XBT_PUBLIC void sleep_for(double duration);
353 XBT_PUBLIC void sleep_until(double timeout);
354
355 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
356 {
357   auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
358   this_actor::sleep_for(seconds.count());
359 }
360
361 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
362 {
363   auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
364   this_actor::sleep_until(timeout_native.time_since_epoch().count());
365 }
366
367 /** Block the actor, computing the given amount of flops */
368 XBT_PUBLIC void execute(double flop);
369
370 /** Block the actor, computing the given amount of flops at the given priority.
371  *  An execution of priority 2 computes twice as fast as an execution at priority 1. */
372 XBT_PUBLIC void execute(double flop, double priority);
373
374 XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
375 XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
376                                  double timeout);
377
378 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
379 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
380
381 /** @brief Returns the actor ID of the current actor). */
382 XBT_PUBLIC aid_t getPid();
383
384 /** @brief Returns the ancestor's actor ID of the current actor. */
385 XBT_PUBLIC aid_t getPpid();
386
387 /** @brief Returns the name of the current actor. */
388 XBT_PUBLIC std::string get_name();
389 /** @brief Returns the name of the current actor as a C string. */
390 XBT_PUBLIC const char* get_cname();
391
392 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName();
393 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname();
394
395 /** @brief Returns the name of the host on which the actor is running. */
396 XBT_PUBLIC Host* getHost();
397
398 /** @brief Suspend the actor. */
399 XBT_PUBLIC void suspend();
400
401 /** @brief yield the actor. */
402 XBT_PUBLIC void yield();
403
404 /** @brief Resume the actor. */
405 XBT_PUBLIC void resume();
406
407 XBT_PUBLIC bool isSuspended();
408
409 /** @brief kill the actor. */
410 XBT_PUBLIC void kill();
411
412 /** @brief Add a function to the list of "on_exit" functions. */
413 XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data);
414
415 /** @brief Migrate the actor to a new host. */
416 XBT_PUBLIC void migrate(Host* new_host);
417 }
418
419 /** @} */
420
421 }} // namespace simgrid::s4u
422
423
424 #endif /* SIMGRID_S4U_ACTOR_HPP */