include/simgrid/s4u/Actor.hpp

   1 /* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_S4U_ACTOR_HPP
   7 #define SIMGRID_S4U_ACTOR_HPP
   8
   9 #include <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 "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
 102  * <platform version="4">
 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 #ifndef DOXYGEN
 125   friend Exec;
 126   friend Mailbox;
 127   friend simgrid::kernel::actor::ActorImpl;
 128   friend simgrid::kernel::activity::MailboxImpl;
 129 #endif
 130   kernel::actor::ActorImpl* pimpl_ = nullptr;
 131
 132   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
 133
 134   typedef std::function<void()> callback_type;
 135
 136 public:
 137
 138   // ***** No copy *****
 139   Actor(Actor const&) = delete;
 140   Actor& operator=(Actor const&) = delete;
 141
 142   // ***** Reference count *****
 143   friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor);
 144   friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor);
 145
 146   // ***** Actor creation *****
 147   /** Retrieve a reference to myself */
 148   static ActorPtr self();
 149
 150   /** Signal to others that a new actor has been created **/
 151   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_creation;
 152   /** Signal to others that an actor has been suspended**/
 153   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_suspend;
 154   /** Signal to others that an actor has been resumed **/
 155   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_resume;
 156   /** Signal to others that an actor is sleeping **/
 157   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_sleep;
 158   /** Signal to others that an actor wakes up for a sleep **/
 159   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_wake_up;
 160   /** Signal to others that an actor is going to migrated to another host**/
 161   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_start;
 162   /** Signal to others that an actor is has been migrated to another host **/
 163   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_end;
 164   /** Signal indicating that the given actor is about to disappear */
 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(std::string name, s4u::Host* host, callback_type code);
 172
 173   /** Create an actor from a std::function
 174    *
 175    *  If the actor is restarted, the actor has a fresh copy of the function.
 176    */
 177   template <class F> static ActorPtr create(std::string name, s4u::Host* host, F code)
 178   {
 179     return create(name, host, callback_type(std::move(code)));
 180   }
 181
 182   /** Create an actor using a callable thing and its arguments.
 183    *
 184    * Note that the arguments will be copied, so move-only parameters are forbidden */
 185   template <class F, class... Args,
 186             // This constructor is enabled only if the call code(args...) is valid:
 187             typename = typename std::result_of<F(Args...)>::type>
 188   static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args)
 189   {
 190     return create(name, host, std::bind(std::move(code), std::move(args)...));
 191   }
 192
 193   // Create actor from function name:
 194   static ActorPtr create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args);
 195
 196   // ***** Methods *****
 197   /** This actor will be automatically terminated when the last non-daemon actor finishes **/
 198   void daemonize();
 199
 200   /** Returns whether or not this actor has been daemonized or not **/
 201   bool is_daemon() const;
 202
 203   /** Retrieves the name of that actor as a C++ string */
 204   const simgrid::xbt::string& get_name() const;
 205   /** Retrieves the name of that actor as a C string */
 206   const char* get_cname() const;
 207   /** Retrieves the host on which that actor is running */
 208   s4u::Host* get_host();
 209   /** Retrieves the PID of that actor
 210    *
 211    * aid_t is an alias for long */
 212   aid_t get_pid() const;
 213   /** Retrieves the PPID of that actor
 214    *
 215    * aid_t is an alias for long */
 216   aid_t get_ppid() const;
 217
 218   /** Suspend an actor by suspending the task on which it was waiting for the completion. */
 219   void suspend();
 220
 221   /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
 222   void resume();
 223
 224   void yield();
 225
 226   /** Returns true if the actor is suspended. */
 227   bool is_suspended();
 228
 229   /** If set to true, the actor will automatically restart when its host reboots */
 230   void set_auto_restart(bool autorestart);
 231
 232   /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
 233    * executed when your actor is killed. You should use them to free the data used by your actor.
 234    */
 235   void on_exit(std::function<void(int, void*)> fun, void* data);
 236
 237   /** Sets the time at which that actor should be killed */
 238   void set_kill_time(double time);
 239   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
 240   double get_kill_time();
 241
 242   /** @brief Moves the actor to another host
 243    *
 244    * If the actor is currently blocked on an execution activity, the activity is also
 245    * migrated to the new host. If it's blocked on another kind of activity, an error is
 246    * raised as the mandated code is not written yet. Please report that bug if you need it.
 247    *
 248    * Asynchronous activities started by the actor are not migrated automatically, so you have
 249    * to take care of this yourself (only you knows which ones should be migrated).
 250    */
 251   void migrate(Host * new_host);
 252
 253   /** Ask the actor to die.
 254    *
 255    * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
 256    * Being killed is not something that actors can defer or avoid.
 257    *
 258    * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
 259    * Still. Please report any bug that you may encounter with a minimal working example.
 260    */
 261   void kill();
 262
 263   static void kill(aid_t pid);
 264
 265   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
 266   static ActorPtr by_pid(aid_t pid);
 267
 268   /** Wait for the actor to finish.
 269    *
 270    * This blocks the calling actor until the actor on which we call join() is terminated
 271    */
 272   void join();
 273   void join(double timeout);
 274   Actor* restart();
 275
 276   /** Ask kindly to all actors to die. Only the issuer will survive. */
 277   static void kill_all();
 278
 279   /** Returns the internal implementation of this actor */
 280   kernel::actor::ActorImpl* get_impl();
 281
 282   /** Retrieve the property value (or nullptr if not set) */
 283   std::unordered_map<std::string, std::string>*
 284   get_properties(); // FIXME: do not export the map, but only the keys or something
 285   const char* get_property(std::string key);
 286   void set_property(std::string key, std::string value);
 287
 288 #ifndef DOXYGEN
 289   /** @deprecated See Actor::create() */
 290   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
 291       const char* name, s4u::Host* host, std::function<void()> code)
 292   {
 293     return create(name, host, code);
 294   }
 295   /** @deprecated See Actor::create() */
 296   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
 297       const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
 298       std::vector<std::string>* args)
 299   {
 300     return create(name, host, code, args);
 301   }
 302   /** @deprecated See Actor::create() */
 303   template <class F, class... Args, typename = typename std::result_of<F(Args...)>::type>
 304   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
 305       const char* name, s4u::Host* host, F code, Args... args)
 306   {
 307     return create(name, host, code, std::move(args)...);
 308   }
 309   /** @deprecated See Actor::create() */
 310   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
 311       const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
 312   {
 313     return create(name, host, function, args);
 314   }
 315   /** @deprecated See Actor::is_daemon() */
 316   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const;
 317   /** @deprecated See Actor::get_name() */
 318   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const
 319   {
 320     return get_name();
 321   }
 322   /** @deprecated See Actor::get_cname() */
 323   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); }
 324   /** @deprecated See Actor::get_host() */
 325   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); }
 326   /** @deprecated See Actor::get_pid() */
 327   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); }
 328   /** @deprecated See Actor::get_ppid() */
 329   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); }
 330   /** @deprecated See Actor::is_suspended() */
 331   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); }
 332   /** @deprecated See Actor::set_auto_restart() */
 333   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a)
 334   {
 335     set_auto_restart(a);
 336   }
 337   /** @deprecated Please use a std::function<void(int, void*)> for first parameter */
 338   XBT_ATTRIB_DEPRECATED_v323("Please use a std::function<void(int, void*)> for first parameter.") void on_exit(
 339       int_f_pvoid_pvoid_t fun, void* data);
 340   /** @deprecated See Actor::on_exit() */
 341   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data)
 342   {
 343     on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 344   }
 345   /** @deprecated See Actor::set_kill_time() */
 346   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); }
 347   /** @deprecated See Actor::get_kill_time() */
 348   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); }
 349   /** @deprecated See Actor::by_pid() */
 350   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); }
 351   /** @deprecated See Actor::kill_all() */
 352   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); }
 353   /** @deprecated See Actor::kill_all() */
 354   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll(
 355       int XBT_ATTRIB_UNUSED resetPid)
 356   {
 357     kill_all();
 358   }
 359   /** @deprecated See Actor::get_impl() */
 360   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); }
 361   /** @deprecated See Actor::get_property() */
 362   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key)
 363   {
 364     return get_property(key);
 365   }
 366   /** @deprecated See Actor::get_properties() */
 367   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") std::map<std::string, std::string>* getProperties()
 368   {
 369     std::map<std::string, std::string>* res             = new std::map<std::string, std::string>();
 370     std::unordered_map<std::string, std::string>* props = get_properties();
 371     for (auto const& kv : *props)
 372       res->insert(kv);
 373     return res;
 374   }
 375   /** @deprecated See Actor::get_properties() */
 376   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value)
 377   {
 378     set_property(key, value);
 379   }
 380 #endif
 381 };
 382
 383 /** @ingroup s4u_api
 384  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
 385 namespace this_actor {
 386
 387 XBT_PUBLIC bool is_maestro();
 388
 389 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
 390 XBT_PUBLIC void sleep_for(double duration);
 391 XBT_PUBLIC void sleep_until(double timeout);
 392
 393 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
 394 {
 395   auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
 396   this_actor::sleep_for(seconds.count());
 397 }
 398
 399 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
 400 {
 401   auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
 402   this_actor::sleep_until(timeout_native.time_since_epoch().count());
 403 }
 404
 405 /** Block the actor, computing the given amount of flops */
 406 XBT_PUBLIC void execute(double flop);
 407
 408 /** Block the actor, computing the given amount of flops at the given priority.
 409  *  An execution of priority 2 computes twice as fast as an execution at priority 1. */
 410 XBT_PUBLIC void execute(double flop, double priority);
 411
 412 XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
 413 XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
 414                                  double timeout);
 415
 416 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
 417 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
 418
 419 /** @brief Returns the actor ID of the current actor). */
 420 XBT_PUBLIC aid_t get_pid();
 421
 422 /** @brief Returns the ancestor's actor ID of the current actor. */
 423 XBT_PUBLIC aid_t get_ppid();
 424
 425 /** @brief Returns the name of the current actor. */
 426 XBT_PUBLIC std::string get_name();
 427 /** @brief Returns the name of the current actor as a C string. */
 428 XBT_PUBLIC const char* get_cname();
 429
 430 /** @brief Returns the name of the host on which the actor is running. */
 431 XBT_PUBLIC Host* get_host();
 432
 433 /** @brief Suspend the actor. */
 434 XBT_PUBLIC void suspend();
 435
 436 /** @brief yield the actor. */
 437 XBT_PUBLIC void yield();
 438
 439 /** @brief Resume the actor. */
 440 XBT_PUBLIC void resume();
 441
 442 XBT_PUBLIC bool is_suspended();
 443
 444 /** @brief kill the actor. */
 445 XBT_PUBLIC void exit();
 446
 447 #ifndef DOXYGEN
 448 /** @deprecated Please use std::function<void(int, void*)> for first parameter */
 449 XBT_ATTRIB_DEPRECATED_v323("Please use std::function<void(int, void*)> for first parameter.") XBT_PUBLIC
 450     void on_exit(int_f_pvoid_pvoid_t fun, void* data);
 451 /** @brief Add a function to the list of "on_exit" functions. */
 452 XBT_PUBLIC void on_exit(std::function<void(int, void*)> fun, void* data);
 453
 454 /** @brief Migrate the actor to a new host. */
 455 XBT_PUBLIC void migrate(Host* new_host);
 456
 457 /** @deprecated See this_actor::get_name() */
 458 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName();
 459 /** @deprecated See this_actor::get_cname() */
 460 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname();
 461 /** @deprecated See this_actor::is_maestro() */
 462 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_maestro()") XBT_PUBLIC bool isMaestro();
 463 /** @deprecated See this_actor::get_pid() */
 464 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t getPid();
 465 /** @deprecated See this_actor::get_ppid() */
 466 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid();
 467 /** @deprecated See this_actor::get_host() */
 468 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost();
 469 /** @deprecated See this_actor::is_suspended() */
 470 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended();
 471 /** @deprecated See this_actor::on_exit() */
 472 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data);
 473 /** @deprecated See this_actor::exit() */
 474 XBT_ATTRIB_DEPRECATED_v324("Please use this_actor::exit()") XBT_PUBLIC void kill();
 475 #endif
 476 }
 477
 478 /** @} */
 479
 480 }} // namespace simgrid::s4u
 481
 482
 483 #endif /* SIMGRID_S4U_ACTOR_HPP */