Logo AND Algorithmique Numérique Distribuée

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