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>
21 #include <xbt/Extendable.hpp>
23 #include <xbt/functional.hpp>
24 #include <xbt/string.hpp>
26 #include <simgrid/chrono.hpp>
27 #include <simgrid/simix.h>
28 #include <simgrid/s4u/forward.hpp>
35 * An actor is an independent stream of execution in your distributed application.
37 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
38 * This is the only component in SimGrid that actually does something on its own, executing its own code.
39 * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
40 * schedule these activities.
42 * An actor is located on a (simulated) host, but it can interact
43 * with the whole simulated platform.
45 * The s4u::Actor API is strongly inspired from the C++11 threads.
46 * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
47 * of this standard</a> may help to understand the philosophy of the S4U
50 * @section s4u_actor_def Defining the skeleton of an Actor
52 * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
53 * standard</a>, you can declare the code of your actor either as a
54 * pure function or as an object. It is very simple with functions:
57 * #include "s4u/actor.hpp"
59 * // Declare the code of your worker
61 * printf("Hello s4u");
62 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
65 * // From your main or from another actor, create your actor on the host Jupiter
66 * // The following line actually creates a new actor, even if there is no "new".
67 * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
70 * But some people prefer to encapsulate their actors in classes and
71 * objects to save the actor state in a cleanly dedicated location.
72 * The syntax is slightly more complicated, but not much.
75 * #include "s4u/actor.hpp"
77 * // Declare the class representing your actors
80 * void operator()() { // Two pairs of () because this defines the method called ()
81 * printf("Hello s4u");
82 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
86 * // From your main or from another actor, create your actor. Note the () after Worker
87 * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
90 * @section s4u_actor_flesh Fleshing your actor
92 * The body of your actor can use the functions of the
93 * simgrid::s4u::this_actor namespace to interact with the world.
94 * This namespace contains the methods to start new activities
95 * (executions, communications, etc), and to get informations about
96 * the currently running thread (its location, etc).
98 * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
101 * @section s4u_actor_deploy Using a deployment file
103 * @warning This is currently not working with S4U. Sorry about that.
105 * The best practice is to use an external deployment file as
106 * follows, because it makes it easier to test your application in
107 * differing settings. Load this file with
108 * s4u::Engine::loadDeployment() before the simulation starts.
109 * Refer to the @ref deployment section for more information.
112 * <?xml version='1.0'?>
113 * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
114 * <platform version="4">
116 * <!-- Start a process called 'master' on the host called 'Tremblay' -->
117 * <process host="Tremblay" function="master">
118 * <!-- Here come the parameter that you want to feed to this instance of master -->
119 * <argument value="20"/> <!-- argv[1] -->
120 * <argument value="50000000"/> <!-- argv[2] -->
121 * <argument value="1000000"/> <!-- argv[3] -->
122 * <argument value="5"/> <!-- argv[4] -->
125 * <!-- Start a process called 'worker' on the host called 'Jupiter' -->
126 * <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
134 /** @brief Simulation Agent */
135 XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
138 friend simgrid::simix::ActorImpl;
139 friend simgrid::kernel::activity::MailboxImpl;
140 simix::ActorImpl* pimpl_ = nullptr;
142 /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
143 template<class F, class... Args>
144 static std::function<void()> wrap_task(F f, Args... args)
146 typedef decltype(f(std::move(args)...)) R;
147 auto task = std::make_shared<simgrid::xbt::Task<R()>>(
148 simgrid::xbt::makeTask(std::move(f), std::move(args)...));
149 return [task] { (*task)(); };
152 explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
156 // ***** No copy *****
157 Actor(Actor const&) = delete;
158 Actor& operator=(Actor const&) = delete;
160 // ***** Reference count (delegated to pimpl_) *****
161 friend void intrusive_ptr_add_ref(Actor* actor)
163 xbt_assert(actor != nullptr);
164 SIMIX_process_ref(actor->pimpl_);
166 friend void intrusive_ptr_release(Actor* actor)
168 xbt_assert(actor != nullptr);
169 SIMIX_process_unref(actor->pimpl_);
172 // ***** Actor creation *****
173 /** Retrieve a reference to myself */
174 static ActorPtr self();
176 /** Create an actor using a function
178 * If the actor is restarted, the actor has a fresh copy of the function.
180 static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
182 /** Create an actor using code
184 * Using this constructor, move-only type can be used. The consequence is
185 * that we cannot copy the value and restart the process in its initial
186 * state. In order to use auto-restart, an explicit `function` must be passed
189 template<class F, class... Args,
190 // This constructor is enabled only if the call code(args...) is valid:
191 typename = typename std::result_of<F(Args...)>::type
193 static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args)
195 return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
198 // Create actor from function name:
200 static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
202 // ***** Methods *****
204 /** Retrieves the name of that actor as a C string */
206 /** Retrieves the name of that actor as a C++ string */
207 simgrid::xbt::string name();
208 /** Retrieves the host on which that actor is running */
210 /** Retrieves the PID of that actor
212 * actor_id_t is an alias for unsigned long */
214 /** Retrieves the PPID of that actor
216 * actor_id_t is an alias for unsigned long */
219 /** Suspend an actor by suspending the task on which it was waiting for the completion. */
222 /** Resume a suspended process by resuming the task on which it was waiting for the completion. */
225 /** Returns true if the process is suspended. */
228 /** If set to true, the actor will automatically restart when its host reboots */
229 void setAutoRestart(bool autorestart);
231 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
232 * executed when your actor is killed. You should use them to free the data used by your process.
234 void onExit(int_f_pvoid_pvoid_t fun, void* data);
236 /** Sets the time at which that actor should be killed */
237 void setKillTime(double time);
238 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
241 void migrate(Host * new_host);
243 /** Ask the actor to die.
245 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
246 * Being killed is not something that actors can defer or avoid.
248 * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
249 * Still. Please report any bug that you may encounter with a minimal working example.
253 static void kill(aid_t pid);
255 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
256 static ActorPtr byPid(aid_t pid);
258 /** @brief Wait for the actor to finish.
260 * This blocks the calling actor until the actor on which we call join() is terminated
264 // Static methods on all actors:
266 /** Ask kindly to all actors to die. Only the issuer will survive. */
267 static void killAll();
268 static void killAll(int resetPid);
270 /** Returns the internal implementation of this actor */
271 simix::ActorImpl* getImpl();
273 /** Retrieve the property value (or nullptr if not set) */
274 const char* property(const char* key);
275 void setProperty(const char* key, const char* value);
279 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
280 namespace this_actor {
282 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
283 XBT_PUBLIC(void) sleep_for(double duration);
284 XBT_PUBLIC(void) sleep_until(double timeout);
286 template<class Rep, class Period>
287 inline void sleep_for(std::chrono::duration<Rep, Period> duration)
289 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
290 this_actor::sleep_for(seconds.count());
292 template<class Duration>
293 inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
295 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
296 this_actor::sleep_until(timeout_native.time_since_epoch().count());
299 XBT_ATTRIB_DEPRECATED("Use sleep_for()")
300 inline void sleep(double duration)
302 return sleep_for(duration);
305 /** Block the actor, computing the given amount of flops */
306 XBT_PUBLIC(e_smx_state_t) execute(double flop);
308 /** Block the actor until it gets a message from the given mailbox.
310 * See \ref Comm for the full communication API (including non blocking communications).
312 XBT_PUBLIC(void*) recv(MailboxPtr chan);
313 XBT_PUBLIC(CommPtr) irecv(MailboxPtr chan, void** data);
315 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
317 * See \ref Comm for the full communication API (including non blocking communications).
319 XBT_PUBLIC(void) send(MailboxPtr chan, void* payload, double simulatedSize);
320 XBT_PUBLIC(void) send(MailboxPtr chan, void* payload, double simulatedSize, double timeout);
322 XBT_PUBLIC(CommPtr) isend(MailboxPtr chan, void* payload, double simulatedSize);
323 XBT_PUBLIC(void) dsend(MailboxPtr chan, void* payload, double simulatedSize);
325 /** @brief Returns the actor ID of the current actor (same as pid). */
326 XBT_PUBLIC(aid_t) pid();
328 /** @brief Returns the ancestor's actor ID of the current actor (same as ppid). */
329 XBT_PUBLIC(aid_t) ppid();
331 /** @brief Returns the name of the current actor. */
332 XBT_PUBLIC(std::string) name();
334 /** @brief Returns the name of the host on which the process is running. */
335 XBT_PUBLIC(Host*) host();
337 /** @brief Suspend the actor. */
338 XBT_PUBLIC(void) suspend();
340 /** @brief Resume the actor. */
341 XBT_PUBLIC(void) resume();
343 XBT_PUBLIC(int) isSuspended();
345 /** @brief kill the actor. */
346 XBT_PUBLIC(void) kill();
348 /** @brief Add a function to the list of "on_exit" functions. */
349 XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data);
351 /** @brief Migrate the actor to a new host. */
352 XBT_PUBLIC(void) migrate(Host* new_host);
357 }} // namespace simgrid::s4u
360 #endif /* SIMGRID_S4U_ACTOR_HPP */