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