1 /* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved. */
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. */
6 #ifndef SIMGRID_S4U_ACTOR_HPP
7 #define SIMGRID_S4U_ACTOR_HPP
15 #include <type_traits>
19 #include <boost/intrusive_ptr.hpp>
22 #include <xbt/functional.hpp>
24 #include <simgrid/chrono.hpp>
25 #include <simgrid/simix.h>
26 #include <simgrid/s4u/forward.hpp>
33 * An actor is an independent stream of execution in your distributed application.
35 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
36 * This is the only component in SimGrid that actually does something on its own, executing its own code.
37 * 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 * An actor is located on a (simulated) host, but it can interact
40 * with the whole simulated platform.
42 * The s4u::Actor API is strongly inspired from the C++11 threads.
43 * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
44 * of this standard</a> may help to understand the philosophy of the S4U
47 * @section s4u_actor_def Defining the skeleton of an Actor
49 * %As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
50 * standard</a>, you can declare the code of your actor either as a
51 * pure function or as an object. It is very simple with functions:
54 * #include "s4u/actor.hpp"
56 * // Declare the code of your worker
58 * printf("Hello s4u");
59 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
62 * // From your main or from another actor, create your actor on the host Jupiter
63 * // The following line actually creates a new actor, even if there is no "new".
64 * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
67 * But some people prefer to encapsulate their actors in classes and
68 * objects to save the actor state in a cleanly dedicated location.
69 * The syntax is slightly more complicated, but not much.
72 * #include "s4u/actor.hpp"
74 * // Declare the class representing your actors
77 * void operator()() { // Two pairs of () because this defines the method called ()
78 * printf("Hello s4u");
79 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
83 * // From your main or from another actor, create your actor. Note the () after Worker
84 * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
87 * @section s4u_actor_flesh Fleshing your actor
89 * The body of your actor can use the functions of the
90 * simgrid::s4u::this_actor namespace to interact with the world.
91 * This namespace contains the methods to start new activities
92 * (executions, communications, etc), and to get informations about
93 * the currently running thread (its location, etc).
95 * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
98 * @section s4u_actor_deploy Using a deployment file
100 * @warning This is currently not working with S4U. Sorry about that.
102 * The best practice is to use an external deployment file as
103 * follows, because it makes it easier to test your application in
104 * differing settings. Load this file with
105 * s4u::Engine::loadDeployment() before the simulation starts.
106 * Refer to the @ref deployment section for more information.
109 * <?xml version='1.0'?>
110 * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
111 * <platform version="4">
113 * <!-- Start a process called 'master' on the host called 'Tremblay' -->
114 * <process host="Tremblay" function="master">
115 * <!-- Here come the parameter that you want to feed to this instance of master -->
116 * <argument value="20"/> <!-- argv[1] -->
117 * <argument value="50000000"/> <!-- argv[2] -->
118 * <argument value="1000000"/> <!-- argv[3] -->
119 * <argument value="5"/> <!-- argv[4] -->
122 * <!-- Start a process called 'worker' on the host called 'Jupiter' -->
123 * <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
131 /** @brief Simulation Agent (see \ref s4u_actor)*/
132 XBT_PUBLIC_CLASS Actor {
134 friend simgrid::simix::Process;
135 smx_process_t pimpl_ = nullptr;
137 /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
138 template<class F, class... Args>
139 static std::function<void()> wrap_task(F f, Args... args)
141 typedef decltype(f(std::move(args)...)) R;
142 auto task = std::make_shared<simgrid::xbt::Task<R()>>(
143 simgrid::xbt::makeTask(std::move(f), std::move(args)...));
149 explicit Actor(smx_process_t pimpl) : pimpl_(pimpl) {}
153 // ***** No copy *****
155 Actor(Actor const&) = delete;
156 Actor& operator=(Actor const&) = delete;
158 // ***** Reference count (delegated to pimpl_) *****
160 friend void intrusive_ptr_add_ref(Actor* actor)
162 xbt_assert(actor != nullptr);
163 SIMIX_process_ref(actor->pimpl_);
165 friend void intrusive_ptr_release(Actor* actor)
167 xbt_assert(actor != nullptr);
168 SIMIX_process_unref(actor->pimpl_);
170 using Ptr = boost::intrusive_ptr<Actor>;
172 // ***** Actor creation *****
173 /** Retrieve a reference to myself */
176 /** Create an actor using a function
178 * If the actor is restarted, the actor has a fresh copy of the function.
180 static Ptr createActor(const char* name, s4u::Host *host, double killTime, std::function<void()> code);
182 static Ptr createActor(const char* name, s4u::Host *host, std::function<void()> code)
184 return createActor(name, host, -1.0, std::move(code));
187 /** Create an actor using code
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
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
198 static Ptr createActor(const char* name, s4u::Host *host, F code, Args... args)
200 return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
203 // Create actor from function name:
205 static Ptr createActor(const char* name, s4u::Host *host, double killTime,
206 const char* function, std::vector<std::string> args);
208 static Ptr createActor(const char* name, s4u::Host *host, const char* function,
209 std::vector<std::string> args)
211 return createActor(name, host, -1.0, function, std::move(args));
214 // ***** Methods *****
216 /** Retrieves the actor that have the given PID (or NULL if not existing) */
217 //static Actor *byPid(int pid); not implemented
219 /** Retrieves the name of that actor */
220 const char* getName();
221 /** Retrieves the host on which that actor is running */
222 s4u::Host *getHost();
223 /** Retrieves the PID of that actor */
226 /** If set to true, the actor will automatically restart when its host reboots */
227 void setAutoRestart(bool autorestart);
228 /** Sets the time at which that actor should be killed */
229 void setKillTime(double time);
230 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
231 double getKillTime();
233 /** Ask the actor to die.
235 * It will only notice your request when doing a simcall next time (a communication or similar).
236 * SimGrid sometimes have issues when you kill actors that are currently communicating and such. We are working on it to fix the issues.
240 static void kill(int pid);
241 static Ptr forPid(int pid);
244 * Wait for the actor to finish.
248 // Static methods on all actors:
250 /** Ask kindly to all actors to die. Only the issuer will survive. */
251 static void killAll();
254 /** Returns the internal implementation of this actor */
255 smx_process_t getImpl();
258 using ActorPtr = Actor::Ptr;
261 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
262 namespace this_actor {
264 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
265 XBT_PUBLIC(void) sleep_for(double duration);
266 XBT_PUBLIC(void) sleep_until(double timeout);
268 template<class Rep, class Period>
269 inline void sleep_for(std::chrono::duration<Rep, Period> duration)
271 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
272 this_actor::sleep_for(seconds.count());
274 template<class Duration>
275 inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
277 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
278 this_actor::sleep_until(timeout_native.time_since_epoch().count());
281 XBT_ATTRIB_DEPRECATED("Use sleep_for()")
282 inline void sleep(double duration)
284 return sleep_for(duration);
287 /** Block the actor, computing the given amount of flops */
288 XBT_PUBLIC(e_smx_state_t) execute(double flop);
290 /** Block the actor until it gets a message from the given mailbox.
292 * See \ref Comm for the full communication API (including non blocking communications).
294 XBT_PUBLIC(void*) recv(Mailbox &chan);
296 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
298 * See \ref Comm for the full communication API (including non blocking communications).
300 XBT_PUBLIC(void) send(Mailbox &chan, void*payload, size_t simulatedSize);
303 * Return the PID of the current actor.
305 XBT_PUBLIC(int) getPid();
311 }} // namespace simgrid::s4u
314 #endif /* SIMGRID_S4U_ACTOR_HPP */