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 <functional>
  11 #include <memory>
  12 #include <stdexcept>
  13 #include <type_traits>
  14
  15 #include <xbt/base.h>
  16 #include <xbt/functional.hpp>
  17
  18 #include <simgrid/simix.h>
  19 #include <simgrid/s4u/forward.hpp>
  20
  21 namespace simgrid {
  22 namespace s4u {
  23
  24 /** @ingroup s4u_api
  25  *
  26  * An actor is an independent stream of execution in your distributed application.
  27  *
  28  * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
  29  * This is the only component in SimGrid that actually does something on its own, executing its own code.
  30  * 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.
  31  *
  32  * An actor is located on a (simulated) host, but it can interact
  33  * with the whole simulated platform.
  34  *
  35  * The s4u::Actor API is strongly inspired from the C++11 threads.
  36  * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
  37  * of this standard</a> may help to understand the philosophy of the S4U
  38  * Actors.
  39  *
  40  * @section s4u_actor_def Defining the skeleton of an Actor
  41  *
  42  * %As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
  43  * standard</a>, you can declare the code of your actor either as a
  44  * pure function or as an object. It is very simple with functions:
  45  *
  46  * @code{.cpp}
  47  * #include "s4u/actor.hpp"
  48  *
  49  * // Declare the code of your worker
  50  * void worker() {
  51  *   printf("Hello s4u");
  52  *   simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
  53  * };
  54  *
  55  * // From your main or from another actor, create your actor on the host Jupiter
  56  * // The following line actually creates a new actor, even if there is no "new".
  57  * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
  58  * @endcode
  59  *
  60  * But some people prefer to encapsulate their actors in classes and
  61  * objects to save the actor state in a cleanly dedicated location.
  62  * The syntax is slightly more complicated, but not much.
  63  *
  64  * @code{.cpp}
  65  * #include "s4u/actor.hpp"
  66  *
  67  * // Declare the class representing your actors
  68  * class Worker {
  69  * public:
  70  *   void operator()() { // Two pairs of () because this defines the method called ()
  71  *     printf("Hello s4u");
  72  *     simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
  73  *   }
  74  * };
  75  *
  76  * // From your main or from another actor, create your actor. Note the () after Worker
  77  * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
  78  * @endcode
  79  *
  80  * @section s4u_actor_flesh Fleshing your actor
  81  *
  82  * The body of your actor can use the functions of the
  83  * simgrid::s4u::this_actor namespace to interact with the world.
  84  * This namespace contains the methods to start new activities
  85  * (executions, communications, etc), and to get informations about
  86  * the currently running thread (its location, etc).
  87  *
  88  * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
  89  *
  90  *
  91  * @section s4u_actor_deploy Using a deployment file
  92  *
  93  * @warning This is currently not working with S4U. Sorry about that.
  94  *
  95  * The best practice is to use an external deployment file as
  96  * follows, because it makes it easier to test your application in
  97  * differing settings. Load this file with
  98  * s4u::Engine::loadDeployment() before the simulation starts.
  99  * Refer to the @ref deployment section for more information.
 100  *
 101  * @code{.xml}
 102  * <?xml version='1.0'?>
 103  * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
 104  * <platform version="4">
 105  *
 106  *   <!-- Start a process called 'master' on the host called 'Tremblay' -->
 107  *   <process host="Tremblay" function="master">
 108  *      <!-- Here come the parameter that you want to feed to this instance of master -->
 109  *      <argument value="20"/>        <!-- argv[1] -->
 110  *      <argument value="50000000"/>  <!-- argv[2] -->
 111  *      <argument value="1000000"/>   <!-- argv[3] -->
 112  *      <argument value="5"/>         <!-- argv[4] -->
 113  *   </process>
 114  *
 115  *   <!-- Start a process called 'worker' on the host called 'Jupiter' -->
 116  *   <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
 117  *
 118  * </platform>
 119  * @endcode
 120  *
 121  *  @{
 122  */
 123
 124 /** @brief Simulation Agent (see \ref s4u_actor)*/
 125 XBT_PUBLIC_CLASS Actor {
 126 private:
 127   /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
 128   template<class F, class... Args>
 129   class Task {
 130   public:
 131     Task(F&& code, Args&&... args) :
 132       code_(std::forward<F>(code)),
 133       args_(std::forward<Args>(args)...)
 134     {
 135       done_.clear();
 136     }
 137     void operator()()
 138     {
 139       if (done_.test_and_set())
 140         throw std::logic_error("Actor task already executed");
 141       simgrid::xbt::apply(std::move(code_), std::move(args_));
 142     }
 143   private:
 144     std::atomic_flag done_;
 145     F code_;
 146     std::tuple<Args...> args_;
 147   };
 148   /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
 149   template<class F, class... Args>
 150   static std::function<void()> wrap_task(F f, Args... args)
 151   {
 152     std::shared_ptr<Task<F, Args...>> task(
 153       new Task<F, Args...>(std::move(f), std::move(args)...));
 154     return [=] {
 155       (*task)();
 156     };
 157   }
 158 public:
 159   Actor() : pimpl_(nullptr) {}
 160   Actor(smx_process_t smx_proc) :
 161     pimpl_(SIMIX_process_ref(smx_proc)) {}
 162   ~Actor()
 163   {
 164     SIMIX_process_unref(pimpl_);
 165   }
 166
 167   // Copy+move (with the copy-and-swap idiom):
 168   Actor(Actor const& actor) : pimpl_(SIMIX_process_ref(actor.pimpl_)) {}
 169   friend void swap(Actor& first, Actor& second)
 170   {
 171     using std::swap;
 172     swap(first.pimpl_, second.pimpl_);
 173   }
 174   Actor& operator=(Actor actor)
 175   {
 176     swap(*this, actor);
 177     return *this;
 178   }
 179   Actor(Actor&& actor) : pimpl_(nullptr)
 180   {
 181     swap(*this, actor);
 182   }
 183
 184   /** Create an actor using a function
 185    *
 186    *  If the actor is restarted, the actor has a fresh copy of the function.
 187    */
 188   Actor(const char* name, s4u::Host *host, double killTime, std::function<void()> code);
 189
 190   Actor(const char* name, s4u::Host *host, std::function<void()> code)
 191     : Actor(name, host, -1.0, std::move(code)) {};
 192
 193   /** Create an actor using code
 194    *
 195    *  Using this constructor, move-only type can be used. The consequence is
 196    *  that we cannot copy the value and restart the process in its initial
 197    *  state. In order to use auto-restart, an explicit `function` must be passed
 198    *  instead.
 199    */
 200   template<class F, class... Args,
 201     // This constructor is enabled only if the call code(args...) is valid:
 202     typename = typename std::result_of<F(Args...)>::type
 203     >
 204   Actor(const char* name, s4u::Host *host, F code, Args... args) :
 205     Actor(name, host, wrap_task(std::move(code), std::move(args)...))
 206   {}
 207
 208   // Create actor from function name:
 209
 210   Actor(const char* name, s4u::Host *host, double killTime, const char* function, simgrid::xbt::args args);
 211
 212   Actor(const char* name, s4u::Host *host, const char* function, simgrid::xbt::args args) :
 213     Actor(name, host, -1.0, function, std::move(args)) {}
 214
 215   /** Retrieves the actor that have the given PID (or NULL if not existing) */
 216   //static Actor *byPid(int pid); not implemented
 217
 218   /** Retrieves the name of that actor */
 219   const char* getName();
 220   /** Retrieves the host on which that actor is running */
 221   s4u::Host *getHost();
 222   /** Retrieves the PID of that actor */
 223   int getPid();
 224
 225   /** If set to true, the actor will automatically restart when its host reboots */
 226   void setAutoRestart(bool autorestart);
 227   /** Sets the time at which that actor should be killed */
 228   void setKillTime(double time);
 229   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
 230   double getKillTime();
 231
 232   /** Ask the actor to die.
 233    *
 234    * It will only notice your request when doing a simcall next time (a communication or similar).
 235    * SimGrid sometimes have issues when you kill actors that are currently communicating and such. We are working on it to fix the issues.
 236    */
 237   void kill();
 238
 239   static void kill(int pid);
 240   static Actor forPid(int pid);
 241
 242   /**
 243    * Wait for the actor to finish.
 244    */
 245   void join();
 246
 247   // Static methods on all actors:
 248
 249   /** Ask kindly to all actors to die. Only the issuer will survive. */
 250   static void killAll();
 251
 252   bool valid() const { return pimpl_ != nullptr; }
 253
 254 private:
 255   smx_process_t pimpl_ = nullptr;
 256 };
 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(double duration);
 264
 265   /** Block the actor, computing the given amount of flops */
 266   XBT_PUBLIC(e_smx_state_t) execute(double flop);
 267
 268   /** Block the actor until it gets a message from the given mailbox.
 269    *
 270    * See \ref Comm for the full communication API (including non blocking communications).
 271    */
 272   XBT_PUBLIC(void*) recv(Mailbox &chan);
 273
 274   /** Block the actor until it delivers a message of the given simulated size to the given mailbox
 275    *
 276    * See \ref Comm for the full communication API (including non blocking communications).
 277   */
 278   XBT_PUBLIC(void) send(Mailbox &chan, void*payload, size_t simulatedSize);
 279
 280   /**
 281    * Return the PID of the current actor.
 282    */
 283   XBT_PUBLIC(int) getPid();
 284
 285 };
 286
 287 /** @} */
 288
 289 }} // namespace simgrid::s4u
 290
 291
 292 #endif /* SIMGRID_S4U_ACTOR_HPP */