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
 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   int get_refcount();
 148
 149   // ***** Actor creation *****
 150   /** Retrieve a reference to myself */
 151   static Actor* self();
 152
 153   /** Fired when a new actor has been created **/
 154   static xbt::signal<void(Actor&)> on_creation;
 155   /** Signal to others that an actor has been suspended**/
 156   static xbt::signal<void(Actor const&)> on_suspend;
 157   /** Signal to others that an actor has been resumed **/
 158   static xbt::signal<void(Actor const&)> on_resume;
 159   /** Signal to others that an actor is sleeping **/
 160   static xbt::signal<void(Actor const&)> on_sleep;
 161   /** Signal to others that an actor wakes up for a sleep **/
 162   static xbt::signal<void(Actor const&)> on_wake_up;
 163   /** Signal to others that an actor is going to migrated to another host**/
 164   static xbt::signal<void(Actor const&)> on_migration_start;
 165   /** Signal to others that an actor is has been migrated to another host **/
 166   static xbt::signal<void(Actor const&)> on_migration_end;
 167   /** Signal indicating that an actor terminated its code.
 168    *  The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore.
 169    *  If you want to free extra data when the actor's destructor is called, use Actor::on_destruction.
 170    *  If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/
 171   static xbt::signal<void(Actor const&)> on_termination;
 172   /** Signal indicating that an actor is about to disappear (its destructor was called).
 173    *  This signal is fired for any destructed actor, which is mostly useful when designing plugins and extensions.
 174    *  If you want to react to the end of the actor's code, use Actor::on_termination instead.
 175    *  If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/
 176   static xbt::signal<void(Actor const&)> on_destruction;
 177
 178   /** Create an actor from a std::function<void()>
 179    *
 180    *  If the actor is restarted, the actor has a fresh copy of the function.
 181    */
 182   static ActorPtr create(const std::string& name, s4u::Host* host, const std::function<void()>& code);
 183   static ActorPtr init(const std::string& name, s4u::Host* host);
 184   ActorPtr start(const std::function<void()>& code);
 185
 186   /** Create an actor from a std::function
 187    *
 188    *  If the actor is restarted, the actor has a fresh copy of the function.
 189    */
 190   template <class F> static ActorPtr create(const std::string& name, s4u::Host* host, F code)
 191   {
 192     return create(name, host, std::function<void()>(std::move(code)));
 193   }
 194
 195   /** Create an actor using a callable thing and its arguments.
 196    *
 197    * Note that the arguments will be copied, so move-only parameters are forbidden */
 198   template <class F, class... Args,
 199             // This constructor is enabled only if the call code(args...) is valid:
 200             typename = typename std::result_of<F(Args...)>::type>
 201   static ActorPtr create(const std::string& name, s4u::Host* host, F code, Args... args)
 202   {
 203     return create(name, host, std::bind(std::move(code), std::move(args)...));
 204   }
 205
 206   // Create actor from function name:
 207   static ActorPtr create(const std::string& name, s4u::Host* host, const std::string& function,
 208                          std::vector<std::string> args);
 209
 210   // ***** Methods *****
 211   /** This actor will be automatically terminated when the last non-daemon actor finishes **/
 212   void daemonize();
 213
 214   /** Returns whether or not this actor has been daemonized or not **/
 215   bool is_daemon() const;
 216
 217   /** Retrieves the name of that actor as a C++ string */
 218   const simgrid::xbt::string& get_name() const;
 219   /** Retrieves the name of that actor as a C string */
 220   const char* get_cname() const;
 221   /** Retrieves the host on which that actor is running */
 222   Host* get_host() const;
 223   /** Retrieves the actor ID of that actor */
 224   aid_t get_pid() const;
 225   /** Retrieves the actor ID of that actor's creator */
 226   aid_t get_ppid() const;
 227
 228   /** Suspend an actor, that is blocked until resume()ed by another actor */
 229   void suspend();
 230
 231   /** Resume an actor that was previously suspend()ed */
 232   void resume();
 233
 234   /** Returns true if the actor is suspended. */
 235   bool is_suspended();
 236
 237   /** If set to true, the actor will automatically restart when its host reboots */
 238   void set_auto_restart(bool autorestart);
 239
 240   /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
 241    * executed when your actor is killed. You should use them to free the data used by your actor.
 242    *
 243    * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
 244    * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
 245    * blocking functions forbidden in this setting, but also modifications to the global state.
 246    *
 247    * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
 248    * It will be set to true if the actor was killed or failed because of an exception,
 249    * while it will remain to false if the actor terminated gracefully.
 250    */
 251   void on_exit(const std::function<void(bool /*failed*/)>& fun) const;
 252
 253   /** Sets the time at which that actor should be killed */
 254   void set_kill_time(double time);
 255   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
 256   double get_kill_time();
 257
 258   /** @brief Moves the actor to another host
 259    *
 260    * If the actor is currently blocked on an execution activity, the activity is also
 261    * migrated to the new host. If it's blocked on another kind of activity, an error is
 262    * raised as the mandated code is not written yet. Please report that bug if you need it.
 263    *
 264    * Asynchronous activities started by the actor are not migrated automatically, so you have
 265    * to take care of this yourself (only you knows which ones should be migrated).
 266    */
 267   void migrate(Host * new_host);
 268
 269   /** Ask the actor to die.
 270    *
 271    * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
 272    * Being killed is not something that actors can defer or avoid.
 273    *
 274    * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
 275    * Still. Please report any bug that you may encounter with a minimal working example.
 276    */
 277   void kill();
 278
 279   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
 280   static ActorPtr by_pid(aid_t pid);
 281
 282   /** Wait for the actor to finish.
 283    *
 284    * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
 285    * blocked until bob terminates.
 286    */
 287   void join();
 288
 289   /** Wait for the actor to finish, or for the timeout to elapse.
 290    *
 291    * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
 292    * blocked until bob terminates.
 293    */
 294   void join(double timeout);
 295   Actor* restart();
 296
 297   /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */
 298   static void kill_all();
 299
 300   /** Returns the internal implementation of this actor */
 301   kernel::actor::ActorImpl* get_impl() const { return pimpl_; }
 302
 303   /** Retrieve the property value (or nullptr if not set) */
 304   const std::unordered_map<std::string, std::string>*
 305   get_properties() const; // FIXME: do not export the map, but only the keys or something
 306   const char* get_property(const std::string& key) const;
 307   void set_property(const std::string& key, const std::string& value);
 308
 309 #ifndef DOXYGEN
 310   XBT_ATTRIB_DEPRECATED_v325("Please use Actor::on_exit(fun) instead") void on_exit(
 311       const std::function<void(int, void*)>& fun, void* data);
 312
 313   XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid);
 314 #endif
 315 };
 316
 317 /** @ingroup s4u_api
 318  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
 319 namespace this_actor {
 320
 321 XBT_PUBLIC bool is_maestro();
 322
 323 /** Block the current actor sleeping for that amount of seconds */
 324 XBT_PUBLIC void sleep_for(double duration);
 325 /** Block the current actor sleeping until the specified timestamp */
 326 XBT_PUBLIC void sleep_until(double wakeup_time);
 327
 328 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
 329 {
 330   auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
 331   this_actor::sleep_for(seconds.count());
 332 }
 333
 334 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& wakeup_time)
 335 {
 336   auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(wakeup_time);
 337   this_actor::sleep_until(timeout_native.time_since_epoch().count());
 338 }
 339
 340 /** Block the current actor, computing the given amount of flops */
 341 XBT_PUBLIC void execute(double flop);
 342
 343 /** Block the current actor, computing the given amount of flops at the given priority.
 344  *  An execution of priority 2 computes twice as fast as an execution at priority 1. */
 345 XBT_PUBLIC void execute(double flop, double priority);
 346
 347 /**
 348  * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
 349  */
 350
 351 /** Block the current actor until the built parallel execution terminates
 352  *
 353  * \rst
 354  * .. _API_s4u_parallel_execute:
 355  *
 356  * **Example of use:** `examples/s4u/exec-ptask/s4u-exec-ptask.cpp
 357  * <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-ptask/s4u-exec-ptask.cpp>`_
 358  *
 359  * Parallel executions convenient abstractions of parallel computational kernels that span over several machines,
 360  * such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel
 361  * on the platform (e.g. to schedule them wisely), there is no need to model them in all details of their internal
 362  * execution and communications. It is much more convenient to model them as a single execution activity that spans
 363  * over several hosts. This is exactly what s4u's Parallel Executions are.
 364  *
 365  * To build such an object, you need to provide a list of hosts that are involved in the parallel kernel (the
 366  * actor's own host may or may not be in this list) and specify the amount of computations that should be done by
 367  * each host, using a vector of flops amount. Then, you should specify the amount of data exchanged between each
 368  * hosts during the parallel kernel. For that, a matrix of values is expected.
 369  *
 370  * It is OK to build a parallel execution without any computation and/or without any communication.
 371  * Just pass an empty vector to the corresponding parameter.
 372  *
 373  * For example, if your list of hosts is ``[host0, host1]``, passing a vector ``[1000, 2000]`` as a `flops_amount`
 374  * vector means that `host0` should compute 1000 flops while `host1` will compute 2000 flops. A matrix of
 375  * communications' sizes of ``[0, 1, 2, 3]`` specifies the following data exchanges:
 376  *
 377  *   +-----------+-------+------+
 378  *   |from \\ to | host0 | host1|
 379  *   +===========+=======+======+
 380  *   |host0      |   0   |  1   |
 381  *   +-----------+-------+------+
 382  *   |host1      |   2   |  3   |
 383  *   +-----------+-------+------+
 384  *
 385  * - From host0 to host0: 0 bytes are exchanged
 386  * - From host0 to host1: 1 byte is exchanged
 387  * - From host1 to host0: 2 bytes are exchanged
 388  * - From host1 to host1: 3 bytes are exchanged
 389  *
 390  * In a parallel execution, all parts (all executions on each hosts, all communications) progress exactly at the
 391  * same pace, so they all terminate at the exact same pace. If one part is slow because of a slow resource or
 392  * because of contention, this slows down the parallel execution as a whole.
 393  *
 394  * These objects are somewhat surprising from a modeling point of view. For example, the unit of their speed is
 395  * somewhere between flop/sec and byte/sec. Arbitrary parallel executions will simply not work with the usual platform
 396  * models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
 397  * regular executions and communications with parallel executions, provided that the host model is ptask_L07.
 398  *
 399  * \endrst
 400  */
 401 XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
 402                                  const std::vector<double>& bytes_amounts);
 403
 404 /** \rst
 405  * Block the current actor until the built :ref:`parallel execution <API_s4u_parallel_execute>` completes, or until the
 406  * timeout. \endrst
 407  */
 408 XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
 409                                  const std::vector<double>& bytes_amounts, double timeout);
 410
 411 #ifndef DOXYGEN
 412 XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
 413     void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount,
 414                           const double* bytes_amount);
 415 XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
 416     void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount,
 417                           const double* bytes_amount, double timeout);
 418 #endif
 419
 420 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
 421 XBT_PUBLIC ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
 422                              const std::vector<double>& bytes_amounts);
 423
 424 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
 425
 426 /** @brief Returns the actor ID of the current actor. */
 427 XBT_PUBLIC aid_t get_pid();
 428
 429 /** @brief Returns the ancestor's actor ID of the current actor. */
 430 XBT_PUBLIC aid_t get_ppid();
 431
 432 /** @brief Returns the name of the current actor. */
 433 XBT_PUBLIC std::string get_name();
 434 /** @brief Returns the name of the current actor as a C string. */
 435 XBT_PUBLIC const char* get_cname();
 436
 437 /** @brief Returns the name of the host on which the current actor is running. */
 438 XBT_PUBLIC Host* get_host();
 439
 440 /** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */
 441 XBT_PUBLIC void suspend();
 442
 443 /** @brief Yield the current actor. */
 444 XBT_PUBLIC void yield();
 445
 446 /** @brief Resume the current actor, that was suspend()ed previously. */
 447 XBT_PUBLIC void resume();
 448
 449 /** @brief kill the current actor. */
 450 XBT_PUBLIC void exit();
 451
 452 /** @brief Add a function to the list of "on_exit" functions of the current actor.
 453  *
 454  * The on_exit functions are the functions executed when your actor is killed. You should use them to free the data used
 455  * by your actor.
 456  *
 457  * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
 458  * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
 459  * blocking functions forbidden in this setting, but also modifications to the global state.
 460  *
 461  * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
 462  * It will be set to true if the actor was killed or failed because of an exception,
 463  * while it will remain to false if the actor terminated gracefully.
 464  */
 465
 466 XBT_PUBLIC void on_exit(const std::function<void(bool)>& fun);
 467
 468 /** @brief Migrate the current actor to a new host. */
 469 XBT_PUBLIC void migrate(Host* new_host);
 470
 471 /** @} */
 472
 473 #ifndef DOXYGEN
 474 XBT_ATTRIB_DEPRECATED_v325("Please use std::function<void(bool)> for first parameter.") XBT_PUBLIC
 475     void on_exit(const std::function<void(int, void*)>& fun, void* data);
 476 #endif
 477 }
 478
 479
 480 }} // namespace simgrid::s4u
 481
 482
 483 #endif /* SIMGRID_S4U_ACTOR_HPP */