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