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 <simgrid/chrono.hpp>
  11 #include <xbt/Extendable.hpp>
  12 #include <xbt/functional.hpp>
  13 #include <xbt/signal.hpp>
  14 #include <xbt/string.hpp>
  15
  16 namespace simgrid {
  17 namespace s4u {
  18
  19 /** @ingroup s4u_api
  20  *
  21  * An actor is an independent stream of execution in your distributed application.
  22  *
  23  * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
  24  * This is the only component in SimGrid that actually does something on its own, executing its own code.
  25  * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
  26  * schedule these activities.
  27  *
  28  * An actor is located on a (simulated) host, but it can interact
  29  * with the whole simulated platform.
  30  *
  31  * The s4u::Actor API is strongly inspired from the C++11 threads.
  32  * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
  33  * of this standard</a> may help to understand the philosophy of the S4U
  34  * Actors.
  35  *
  36  * @section s4u_actor_def Defining the skeleton of an Actor
  37  *
  38  * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
  39  * standard</a>, you can declare the code of your actor either as a
  40  * pure function or as an object. It is very simple with functions:
  41  *
  42  * @code{.cpp}
  43  * #include <simgrid/s4u/actor.hpp>
  44  *
  45  * // Declare the code of your worker
  46  * void worker() {
  47  *   printf("Hello s4u");
  48  *   simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
  49  * };
  50  *
  51  * // From your main or from another actor, create your actor on the host Jupiter
  52  * // The following line actually creates a new actor, even if there is no "new".
  53  * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
  54  * @endcode
  55  *
  56  * But some people prefer to encapsulate their actors in classes and
  57  * objects to save the actor state in a cleanly dedicated location.
  58  * The syntax is slightly more complicated, but not much.
  59  *
  60  * @code{.cpp}
  61  * #include <simgrid/s4u/actor.hpp>
  62  *
  63  * // Declare the class representing your actors
  64  * class Worker {
  65  * public:
  66  *   void operator()() { // Two pairs of () because this defines the method called ()
  67  *     printf("Hello s4u");
  68  *     simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
  69  *   }
  70  * };
  71  *
  72  * // From your main or from another actor, create your actor. Note the () after Worker
  73  * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
  74  * @endcode
  75  *
  76  * @section s4u_actor_flesh Fleshing your actor
  77  *
  78  * The body of your actor can use the functions of the
  79  * simgrid::s4u::this_actor namespace to interact with the world.
  80  * This namespace contains the methods to start new activities
  81  * (executions, communications, etc), and to get informations about
  82  * the currently running thread (its location, etc).
  83  *
  84  * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
  85  *
  86  *
  87  * @section s4u_actor_deploy Using a deployment file
  88  *
  89  * @warning This is currently not working with S4U. Sorry about that.
  90  *
  91  * The best practice is to use an external deployment file as
  92  * follows, because it makes it easier to test your application in
  93  * differing settings. Load this file with
  94  * s4u::Engine::loadDeployment() before the simulation starts.
  95  * Refer to the @ref deployment section for more information.
  96  *
  97  * @code{.xml}
  98  * <?xml version='1.0'?>
  99  * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
 100  * <platform version="4">
 101  *
 102  *   <!-- Start an actor called 'master' on the host called 'Tremblay' -->
 103  *   <actor host="Tremblay" function="master">
 104  *      <!-- Here come the parameter that you want to feed to this instance of master -->
 105  *      <argument value="20"/>        <!-- argv[1] -->
 106  *      <argument value="50000000"/>  <!-- argv[2] -->
 107  *      <argument value="1000000"/>   <!-- argv[3] -->
 108  *      <argument value="5"/>         <!-- argv[4] -->
 109  *   </actor>
 110  *
 111  *   <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
 112  *   <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
 113  *
 114  * </platform>
 115  * @endcode
 116  *
 117  *  @{
 118  */
 119
 120 /** @brief Simulation Agent */
 121 class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
 122   friend Exec;
 123   friend Mailbox;
 124   friend simgrid::kernel::actor::ActorImpl;
 125   friend simgrid::kernel::activity::MailboxImpl;
 126   kernel::actor::ActorImpl* pimpl_ = nullptr;
 127
 128   /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
 129   template<class F, class... Args>
 130   static std::function<void()> wrap_task(F f, Args... args)
 131   {
 132     typedef decltype(f(std::move(args)...)) R;
 133     auto task = std::make_shared<simgrid::xbt::Task<R()>>(
 134       simgrid::xbt::makeTask(std::move(f), std::move(args)...));
 135     return [task] { (*task)(); };
 136   }
 137
 138   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
 139
 140 public:
 141
 142   // ***** No copy *****
 143   Actor(Actor const&) = delete;
 144   Actor& operator=(Actor const&) = delete;
 145
 146   // ***** Reference count *****
 147   friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor);
 148   friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor);
 149
 150   // ***** Actor creation *****
 151   /** Retrieve a reference to myself */
 152   static ActorPtr self();
 153
 154   /** Signal to others that a new actor has been created **/
 155   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_creation;
 156   /** Signal to others that an actor has been suspended**/
 157   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_suspend;
 158   /** Signal to others that an actor has been resumed **/
 159   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_resume;
 160   /** Signal to others that an actor is sleeping **/
 161   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_sleep;
 162   /** Signal to others that an actor wakes up for a sleep **/
 163   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_wake_up;
 164   /** Signal to others that an actor is going to migrated to another host**/
 165   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_start;
 166   /** Signal to others that an actor is has been migrated to another host **/
 167   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_end;
 168   /** Signal indicating that the given actor is about to disappear */
 169   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_destruction;
 170
 171   /** Create an actor using a function
 172    *
 173    *  If the actor is restarted, the actor has a fresh copy of the function.
 174    */
 175   static ActorPtr create(const char* name, s4u::Host* host, std::function<void()> code);
 176
 177   static ActorPtr create(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
 178                          std::vector<std::string>* args)
 179   {
 180     return create(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
 181   }
 182
 183   /** Create an actor using code
 184    *
 185    *  Using this constructor, move-only type can be used. The consequence is
 186    *  that we cannot copy the value and restart the actor in its initial
 187    *  state. In order to use auto-restart, an explicit `function` must be passed
 188    *  instead.
 189    */
 190   template <class F, class... Args,
 191             // This constructor is enabled only if the call code(args...) is valid:
 192             typename = typename std::result_of<F(Args...)>::type>
 193   static ActorPtr create(const char* name, s4u::Host* host, F code, Args... args)
 194   {
 195     return create(name, host, wrap_task(std::move(code), std::move(args)...));
 196   }
 197
 198   // Create actor from function name:
 199   static ActorPtr create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
 200
 201   // ***** Methods *****
 202   /** This actor will be automatically terminated when the last non-daemon actor finishes **/
 203   void daemonize();
 204
 205   /** Returns whether or not this actor has been daemonized or not **/
 206   bool is_daemon() const;
 207
 208   /** Retrieves the name of that actor as a C++ string */
 209   const simgrid::xbt::string& get_name() const;
 210   /** Retrieves the name of that actor as a C string */
 211   const char* get_cname() const;
 212   /** Retrieves the host on which that actor is running */
 213   s4u::Host* get_host();
 214   /** Retrieves the PID of that actor
 215    *
 216    * aid_t is an alias for long */
 217   aid_t get_pid() const;
 218   /** Retrieves the PPID of that actor
 219    *
 220    * aid_t is an alias for long */
 221   aid_t get_ppid() const;
 222
 223   /** Suspend an actor by suspending the task on which it was waiting for the completion. */
 224   void suspend();
 225
 226   /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
 227   void resume();
 228
 229   void yield();
 230
 231   /** Returns true if the actor is suspended. */
 232   int is_suspended();
 233
 234   /** If set to true, the actor will automatically restart when its host reboots */
 235   void set_auto_restart(bool autorestart);
 236
 237   /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
 238    * executed when your actor is killed. You should use them to free the data used by your actor.
 239    */
 240   void on_exit(std::function<void(int, void*)> fun, void* data);
 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   void migrate(Host * new_host);
 248
 249   /** Ask the actor to die.
 250    *
 251    * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
 252    * Being killed is not something that actors can defer or avoid.
 253    *
 254    * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
 255    * Still. Please report any bug that you may encounter with a minimal working example.
 256    */
 257   void kill();
 258
 259   static void kill(aid_t pid);
 260
 261   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
 262   static ActorPtr by_pid(aid_t pid);
 263
 264   /** @brief Wait for the actor to finish.
 265    *
 266    * This blocks the calling actor until the actor on which we call join() is terminated
 267    */
 268   void join();
 269   void join(double timeout);
 270   Actor* restart();
 271
 272   /** Ask kindly to all actors to die. Only the issuer will survive. */
 273   static void kill_all();
 274
 275   /** Returns the internal implementation of this actor */
 276   kernel::actor::ActorImpl* get_impl();
 277
 278   /** Retrieve the property value (or nullptr if not set) */
 279   std::map<std::string, std::string>* get_properties(); // FIXME: do not export the map, but only the keys or something
 280   const char* get_property(const char* key);
 281   void set_property(const char* key, const char* value);
 282
 283   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
 284       createActor(const char* name, s4u::Host* host, std::function<void()> code)
 285   {
 286     return create(name, host, code);
 287   }
 288   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
 289       createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
 290                   std::vector<std::string>* args)
 291   {
 292     return create(name, host, code, args);
 293   }
 294   template <class F, class... Args, typename = typename std::result_of<F(Args...)>::type>
 295   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
 296       createActor(const char* name, s4u::Host* host, F code, Args... args)
 297   {
 298     return create(name, host, code, std::move(args)...);
 299   }
 300   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
 301       createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
 302   {
 303     return create(name, host, function, args);
 304   }
 305   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const;
 306   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const
 307   {
 308     return get_name();
 309   }
 310   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); }
 311   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); }
 312   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); }
 313   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); }
 314   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); }
 315   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a)
 316   {
 317     set_auto_restart(a);
 318   }
 319   XBT_ATTRIB_DEPRECATED_v323("Please use a std::function<void(int, void*)> for first parameter.") void on_exit(
 320       int_f_pvoid_pvoid_t fun, void* data);
 321   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data)
 322   {
 323     on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 324   }
 325   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); }
 326   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); }
 327   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); }
 328   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); }
 329   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll(int resetPid)
 330   {
 331     kill_all();
 332   }
 333   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); }
 334   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key)
 335   {
 336     return get_property(key);
 337   }
 338   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") std::map<std::string, std::string>* getProperties()
 339   {
 340     return get_properties();
 341   }
 342   XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value)
 343   {
 344     set_property(key, value);
 345   }
 346 };
 347
 348 /** @ingroup s4u_api
 349  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
 350 namespace this_actor {
 351
 352 XBT_PUBLIC bool is_maestro();
 353
 354 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
 355 XBT_PUBLIC void sleep_for(double duration);
 356 XBT_PUBLIC void sleep_until(double timeout);
 357
 358 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
 359 {
 360   auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
 361   this_actor::sleep_for(seconds.count());
 362 }
 363
 364 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
 365 {
 366   auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
 367   this_actor::sleep_until(timeout_native.time_since_epoch().count());
 368 }
 369
 370 /** Block the actor, computing the given amount of flops */
 371 XBT_PUBLIC void execute(double flop);
 372
 373 /** Block the actor, computing the given amount of flops at the given priority.
 374  *  An execution of priority 2 computes twice as fast as an execution at priority 1. */
 375 XBT_PUBLIC void execute(double flop, double priority);
 376
 377 XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
 378 XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
 379                                  double timeout);
 380
 381 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
 382 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
 383
 384 /** @brief Returns the actor ID of the current actor). */
 385 XBT_PUBLIC aid_t get_pid();
 386
 387 /** @brief Returns the ancestor's actor ID of the current actor. */
 388 XBT_PUBLIC aid_t get_ppid();
 389
 390 /** @brief Returns the name of the current actor. */
 391 XBT_PUBLIC std::string get_name();
 392 /** @brief Returns the name of the current actor as a C string. */
 393 XBT_PUBLIC const char* get_cname();
 394
 395 /** @brief Returns the name of the host on which the actor is running. */
 396 XBT_PUBLIC Host* get_host();
 397
 398 /** @brief Suspend the actor. */
 399 XBT_PUBLIC void suspend();
 400
 401 /** @brief yield the actor. */
 402 XBT_PUBLIC void yield();
 403
 404 /** @brief Resume the actor. */
 405 XBT_PUBLIC void resume();
 406
 407 XBT_PUBLIC bool is_suspended();
 408
 409 /** @brief kill the actor. */
 410 XBT_PUBLIC void kill();
 411
 412 /** @brief Add a function to the list of "on_exit" functions. */
 413 XBT_ATTRIB_DEPRECATED_v323("Please use std::function<void(int, void*)> for first parameter.") XBT_PUBLIC
 414     void on_exit(int_f_pvoid_pvoid_t fun, void* data);
 415 XBT_PUBLIC void on_exit(std::function<void(int, void*)> fun, void* data);
 416
 417 /** @brief Migrate the actor to a new host. */
 418 XBT_PUBLIC void migrate(Host* new_host);
 419
 420 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName();
 421 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname();
 422 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_maestro()") XBT_PUBLIC bool isMaestro();
 423 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t getPid();
 424 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid();
 425 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost();
 426 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended();
 427 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC
 428     void onExit(int_f_pvoid_pvoid_t fun, void* data);
 429 }
 430
 431 /** @} */
 432
 433 }} // namespace simgrid::s4u
 434
 435
 436 #endif /* SIMGRID_S4U_ACTOR_HPP */