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