Logo AND Algorithmique Numérique Distribuée

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