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