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