include/simgrid/s4u/Actor.hpp

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