Logo AND Algorithmique Numérique Distribuée

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