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