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