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