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/base.h>
  22 #include <xbt/functional.hpp>
  23
  24 #include <simgrid/chrono.hpp>
  25 #include <simgrid/simix.h>
  26 #include <simgrid/s4u/forward.hpp>
  27
  28 namespace simgrid {
  29 namespace s4u {
  30
  31 /** @ingroup s4u_api
  32  *
  33  * An actor is an independent stream of execution in your distributed application.
  34  *
  35  * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
  36  * This is the only component in SimGrid that actually does something on its own, executing its own code.
  37  * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and 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 "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 "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 a process called 'master' on the host called 'Tremblay' -->
 114  *   <process 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  *   </process>
 121  *
 122  *   <!-- Start a process called 'worker' on the host called 'Jupiter' -->
 123  *   <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
 124  *
 125  * </platform>
 126  * @endcode
 127  *
 128  *  @{
 129  */
 130
 131 /** @brief Simulation Agent (see \ref s4u_actor)*/
 132 XBT_PUBLIC_CLASS Actor {
 133   friend Mailbox;
 134   friend simgrid::simix::Process;
 135   smx_process_t pimpl_ = nullptr;
 136
 137   /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
 138   template<class F, class... Args>
 139   static std::function<void()> wrap_task(F f, Args... args)
 140   {
 141     typedef decltype(f(std::move(args)...)) R;
 142     auto task = std::make_shared<simgrid::xbt::Task<R()>>(
 143       simgrid::xbt::makeTask(std::move(f), std::move(args)...));
 144     return [=] {
 145       (*task)();
 146     };
 147   }
 148
 149   explicit Actor(smx_process_t pimpl) : pimpl_(pimpl) {}
 150
 151 public:
 152
 153   // ***** No copy *****
 154
 155   Actor(Actor const&) = delete;
 156   Actor& operator=(Actor const&) = delete;
 157
 158   // ***** Reference count (delegated to pimpl_) *****
 159
 160   friend void intrusive_ptr_add_ref(Actor* actor)
 161   {
 162     xbt_assert(actor != nullptr);
 163     SIMIX_process_ref(actor->pimpl_);
 164   }
 165   friend void intrusive_ptr_release(Actor* actor)
 166   {
 167     xbt_assert(actor != nullptr);
 168     SIMIX_process_unref(actor->pimpl_);
 169   }
 170   using Ptr = boost::intrusive_ptr<Actor>;
 171
 172   // ***** Actor creation *****
 173
 174   /** Create an actor using a function
 175    *
 176    *  If the actor is restarted, the actor has a fresh copy of the function.
 177    */
 178   static Ptr createActor(const char* name, s4u::Host *host, double killTime, std::function<void()> code);
 179
 180   static Ptr createActor(const char* name, s4u::Host *host, std::function<void()> code)
 181   {
 182     return createActor(name, host, -1.0, std::move(code));
 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 process 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     >
 196   static Ptr createActor(const char* name, s4u::Host *host, F code, Args... args)
 197   {
 198     return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
 199   }
 200
 201   // Create actor from function name:
 202
 203   static Ptr createActor(const char* name, s4u::Host *host, double killTime,
 204     const char* function, std::vector<std::string> args);
 205
 206   static Ptr createActor(const char* name, s4u::Host *host, const char* function,
 207       std::vector<std::string> args)
 208   {
 209     return createActor(name, host, -1.0, function, std::move(args));
 210   }
 211
 212   // ***** Methods *****
 213
 214   /** Retrieves the actor that have the given PID (or NULL if not existing) */
 215   //static Actor *byPid(int pid); not implemented
 216
 217   /** Retrieves the name of that actor */
 218   const char* getName();
 219   /** Retrieves the host on which that actor is running */
 220   s4u::Host *getHost();
 221   /** Retrieves the PID of that actor */
 222   int getPid();
 223
 224   /** If set to true, the actor will automatically restart when its host reboots */
 225   void setAutoRestart(bool autorestart);
 226   /** Sets the time at which that actor should be killed */
 227   void setKillTime(double time);
 228   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
 229   double getKillTime();
 230
 231   /** Ask the actor to die.
 232    *
 233    * It will only notice your request when doing a simcall next time (a communication or similar).
 234    * SimGrid sometimes have issues when you kill actors that are currently communicating and such. We are working on it to fix the issues.
 235    */
 236   void kill();
 237
 238   static void kill(int pid);
 239   static Ptr forPid(int pid);
 240
 241   /**
 242    * Wait for the actor to finish.
 243    */
 244   void join();
 245
 246   // Static methods on all actors:
 247
 248   /** Ask kindly to all actors to die. Only the issuer will survive. */
 249   static void killAll();
 250
 251 protected:
 252   /** Returns the internal implementation of this actor */
 253   smx_process_t getImpl();
 254 };
 255
 256 using ActorPtr = Actor::Ptr;
 257
 258 /** @ingroup s4u_api
 259  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
 260 namespace this_actor {
 261
 262   /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
 263   XBT_PUBLIC(void) sleep_for(double duration);
 264   XBT_PUBLIC(void) sleep_until(double timeout);
 265
 266   template<class Rep, class Period>
 267   inline void sleep_for(std::chrono::duration<Rep, Period> duration)
 268   {
 269     auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
 270     this_actor::sleep_for(seconds.count());
 271   }
 272   template<class Duration>
 273   inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
 274   {
 275     auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
 276     this_actor::sleep_until(timeout_native.time_since_epoch().count());
 277   }
 278
 279   XBT_ATTRIB_DEPRECATED("Use sleep_for()")
 280   inline void sleep(double duration)
 281   {
 282     return sleep_for(duration);
 283   }
 284
 285   /** Block the actor, computing the given amount of flops */
 286   XBT_PUBLIC(e_smx_state_t) execute(double flop);
 287
 288   /** Block the actor until it gets a message from the given mailbox.
 289    *
 290    * See \ref Comm for the full communication API (including non blocking communications).
 291    */
 292   XBT_PUBLIC(void*) recv(Mailbox &chan);
 293
 294   /** Block the actor until it delivers a message of the given simulated size to the given mailbox
 295    *
 296    * See \ref Comm for the full communication API (including non blocking communications).
 297   */
 298   XBT_PUBLIC(void) send(Mailbox &chan, void*payload, size_t simulatedSize);
 299
 300   /**
 301    * Return the PID of the current actor.
 302    */
 303   XBT_PUBLIC(int) getPid();
 304
 305 };
 306
 307 /** @} */
 308
 309 }} // namespace simgrid::s4u
 310
 311
 312 #endif /* SIMGRID_S4U_ACTOR_HPP */