include/simgrid/s4u/Actor.hpp

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