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