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