1 /* Copyright (c) 2006-2021. 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
9 #include <simgrid/forward.h>
11 #include <simgrid/chrono.hpp>
12 #include <xbt/Extendable.hpp>
13 #include <xbt/signal.hpp>
14 #include <xbt/string.hpp>
17 #include <unordered_map>
21 extern template class XBT_PUBLIC xbt::Extendable<s4u::Actor>;
25 /** An actor is an independent stream of execution in your distributed application.
28 * It is located on a (simulated) :cpp:class:`host <simgrid::s4u::Host>`, but can interact
29 * with the whole simulated platform.
31 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
32 * This is the only component in SimGrid that actually does something on its own, executing its own code.
33 * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
34 * schedule these activities. **Please refer to the** :ref:`examples <s4u_ex_actors>` **for more information.**
36 * This API is strongly inspired from the C++11 threads.
37 * The `documentation of this standard <http://en.cppreference.com/w/cpp/thread>`_
38 * may help to understand the philosophy of the SimGrid actors.
41 class XBT_PUBLIC Actor : public xbt::Extendable<Actor> {
45 friend kernel::actor::ActorImpl;
46 friend kernel::activity::MailboxImpl;
48 kernel::actor::ActorImpl* const pimpl_;
51 explicit Actor(kernel::actor::ActorImpl* pimpl) : pimpl_(pimpl) {}
55 // ***** No copy *****
56 Actor(Actor const&) = delete;
57 Actor& operator=(Actor const&) = delete;
59 // ***** Reference count *****
60 friend XBT_PUBLIC void intrusive_ptr_add_ref(const Actor* actor);
61 friend XBT_PUBLIC void intrusive_ptr_release(const Actor* actor);
63 /** Retrieve the amount of references on that object. Useful to debug the automatic refcounting */
64 int get_refcount() const;
66 // ***** Actor creation *****
67 /** Retrieve a reference to myself */
70 /** Fired when a new actor has been created **/
71 static xbt::signal<void(Actor&)> on_creation;
72 /** Signal to others that an actor has been suspended**/
73 static xbt::signal<void(Actor const&)> on_suspend;
74 /** Signal to others that an actor has been resumed **/
75 static xbt::signal<void(Actor const&)> on_resume;
76 /** Signal to others that an actor is sleeping **/
77 static xbt::signal<void(Actor const&)> on_sleep;
78 /** Signal to others that an actor wakes up for a sleep **/
79 static xbt::signal<void(Actor const&)> on_wake_up;
80 /** Signal to others that an actor is has been migrated to another host **/
81 static xbt::signal<void(const Actor&, const Host& previous_location)> on_host_change;
83 static xbt::signal<void(Actor const&)> on_migration_start; // XBT_ATTRIB_DEPRECATED_v329
84 static xbt::signal<void(Actor const&)> on_migration_end; // XBT_ATTRIB_DEPRECATED_v329
87 /** Signal indicating that an actor terminated its code.
89 * The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore.
90 * If you want to free extra data when the actor's destructor is called, use :cpp:var:`Actor::on_destruction`.
91 * If you want to register to the termination of a given actor, use :cpp:func:`this_actor::on_exit()` instead.
94 static xbt::signal<void(Actor const&)> on_termination;
95 /** Signal indicating that an actor is about to disappear (its destructor was called).
96 * This signal is fired for any destructed actor, which is mostly useful when designing plugins and extensions.
97 * If you want to react to the end of the actor's code, use Actor::on_termination instead.
98 * If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/
99 static xbt::signal<void(Actor const&)> on_destruction;
101 /** Create an actor from a std::function<void()>.
102 * If the actor is restarted, it gets a fresh copy of the function. */
103 static ActorPtr create(const std::string& name, s4u::Host* host, const std::function<void()>& code);
104 /** Create an actor, but don't start it yet.
106 * This is useful to set some properties or extension before actually starting it */
107 static ActorPtr init(const std::string& name, s4u::Host* host);
108 ActorPtr set_stacksize(unsigned stacksize);
109 /** Start a previously initialized actor */
110 ActorPtr start(const std::function<void()>& code);
112 /** Create an actor from a callable thing. */
113 template <class F> static ActorPtr create(const std::string& name, s4u::Host* host, F code)
115 return create(name, host, std::function<void()>(std::move(code)));
118 /** Create an actor using a callable thing and its arguments.
120 * Note that the arguments will be copied, so move-only parameters are forbidden */
122 template <class F, class... Args,
123 // This constructor is enabled only if the call code(args...) is valid:
124 #ifndef DOXYGEN /* breathe seem to choke on function signatures in template parameter, see breathe#611 */
125 typename = typename std::result_of_t<F(Args...)>
128 static ActorPtr create(const std::string& name, s4u::Host* host, F code, Args... args)
130 return create(name, host, std::bind(std::move(code), std::move(args)...));
133 /** Create actor from function name and a vector of strings as arguments. */
134 static ActorPtr create(const std::string& name, s4u::Host* host, const std::string& function,
135 std::vector<std::string> args);
137 // ***** Methods *****
138 /** This actor will be automatically terminated when the last non-daemon actor finishes **/
141 /** Returns whether or not this actor has been daemonized or not **/
142 bool is_daemon() const;
144 /** Retrieves the name of that actor as a C++ string */
145 const simgrid::xbt::string& get_name() const;
146 /** Retrieves the name of that actor as a C string */
147 const char* get_cname() const;
148 /** Retrieves the host on which that actor is running */
149 Host* get_host() const;
150 /** Retrieves the actor ID of that actor */
151 aid_t get_pid() const;
152 /** Retrieves the actor ID of that actor's creator */
153 aid_t get_ppid() const;
155 /** Suspend an actor, that is blocked until resumeed by another actor */
158 /** Resume an actor that was previously suspended */
161 /** Returns true if the actor is suspended. */
162 bool is_suspended() const;
164 /** If set to true, the actor will automatically restart when its host reboots */
165 void set_auto_restart(bool autorestart);
167 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
168 * executed when your actor is killed. You should use them to free the data used by your actor.
170 * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
171 * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
172 * blocking functions forbidden in this setting, but also modifications to the global state.
174 * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
175 * It will be set to true if the actor was killed or failed because of an exception,
176 * while it will remain to false if the actor terminated gracefully.
178 void on_exit(const std::function<void(bool /*failed*/)>& fun) const;
180 /** Sets the time at which that actor should be killed */
181 void set_kill_time(double time);
182 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
183 double get_kill_time() const;
185 /** @brief Moves the actor to another host
187 * If the actor is currently blocked on an execution activity, the activity is also
188 * migrated to the new host. If it's blocked on another kind of activity, an error is
189 * raised as the mandated code is not written yet. Please report that bug if you need it.
191 * Asynchronous activities started by the actor are not migrated automatically, so you have
192 * to take care of this yourself (only you knows which ones should be migrated).
194 void set_host(Host* new_host);
196 XBT_ATTRIB_DEPRECATED_v329("Please use set_host() instead") void migrate(Host* new_host) { set_host(new_host); }
199 /** Ask the actor to die.
201 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
202 * Being killed is not something that actors can defer or avoid.
206 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
207 static ActorPtr by_pid(aid_t pid);
209 /** Wait for the actor to finish.
211 * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
212 * blocked until bob terminates.
216 /** Wait for the actor to finish, or for the timeout to elapse.
218 * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
219 * blocked until bob terminates.
221 void join(double timeout) const;
222 /** Kill that actor and restart it from start. */
225 /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */
226 static void kill_all();
228 /** Returns the internal implementation of this actor */
229 kernel::actor::ActorImpl* get_impl() const { return pimpl_; }
231 /** Retrieve the list of properties for that actor */
232 const std::unordered_map<std::string, std::string>*
233 get_properties() const; // FIXME: do not export the map, but only the keys or something
235 /** Retrieve the property value (or nullptr if not set) */
236 const char* get_property(const std::string& key) const;
238 /** Set a property (old values will be overwritten) */
239 void set_property(const std::string& key, const std::string& value);
243 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
244 namespace this_actor {
246 XBT_PUBLIC bool is_maestro();
248 /** Block the current actor sleeping for that amount of seconds */
249 XBT_PUBLIC void sleep_for(double duration);
250 /** Block the current actor sleeping until the specified timestamp */
251 XBT_PUBLIC void sleep_until(double wakeup_time);
253 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
255 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
256 this_actor::sleep_for(seconds.count());
259 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& wakeup_time)
261 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(wakeup_time);
262 this_actor::sleep_until(timeout_native.time_since_epoch().count());
265 /** Block the current actor, computing the given amount of flops */
266 XBT_PUBLIC void execute(double flop);
268 /** Block the current actor, computing the given amount of flops at the given priority.
269 * An execution of priority 2 computes twice as fast as an execution at priority 1. */
270 XBT_PUBLIC void execute(double flop, double priority);
273 * @example examples/cpp/exec-ptask/s4u-exec-ptask.cpp
276 /** Block the current actor until the built parallel execution terminates
279 * .. _API_s4u_parallel_execute:
281 * **Example of use:** `examples/cpp/exec-ptask/s4u-exec-ptask.cpp
282 * <https://framagit.org/simgrid/simgrid/tree/master/examples/cpp/exec-ptask/s4u-exec-ptask.cpp>`_
284 * Parallel executions convenient abstractions of parallel computational kernels that span over several machines,
285 * such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel
286 * on the platform (e.g. to schedule them wisely), there is no need to model them in all details of their internal
287 * execution and communications. It is much more convenient to model them as a single execution activity that spans
288 * over several hosts. This is exactly what s4u's Parallel Executions are.
290 * To build such an object, you need to provide a list of hosts that are involved in the parallel kernel (the
291 * actor's own host may or may not be in this list) and specify the amount of computations that should be done by
292 * each host, using a vector of flops amount. Then, you should specify the amount of data exchanged between each
293 * hosts during the parallel kernel. For that, a matrix of values is expected.
295 * It is OK to build a parallel execution without any computation and/or without any communication.
296 * Just pass an empty vector to the corresponding parameter.
298 * For example, if your list of hosts is ``[host0, host1]``, passing a vector ``[1000, 2000]`` as a `flops_amount`
299 * vector means that `host0` should compute 1000 flops while `host1` will compute 2000 flops. A matrix of
300 * communications' sizes of ``[0, 1, 2, 3]`` specifies the following data exchanges:
302 * - from host0: [ to host0: 0 bytes; to host1: 1 byte ]
304 * - from host1: [ to host0: 2 bytes; to host1: 3 bytes ]
306 * Or, in other words:
308 * - From host0 to host0: 0 bytes are exchanged
310 * - From host0 to host1: 1 byte is exchanged
312 * - From host1 to host0: 2 bytes are exchanged
314 * - From host1 to host1: 3 bytes are exchanged
316 * In a parallel execution, all parts (all executions on each hosts, all communications) progress exactly at the
317 * same pace, so they all terminate at the exact same pace. If one part is slow because of a slow resource or
318 * because of contention, this slows down the parallel execution as a whole.
320 * These objects are somewhat surprising from a modeling point of view. For example, the unit of their speed is
321 * somewhere between flop/sec and byte/sec. Arbitrary parallel executions will simply not work with the usual platform
322 * models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
323 * regular executions and communications with parallel executions, provided that the host model is ptask_L07.
327 /** Block the current actor until the built parallel execution completes */
328 XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
329 const std::vector<double>& bytes_amounts);
331 XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") XBT_PUBLIC
332 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
333 const std::vector<double>& bytes_amounts, double timeout);
335 /** Initialize a sequential execution that must then be started manually */
336 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
337 /** Initialize a parallel execution that must then be started manually */
338 XBT_PUBLIC ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
339 const std::vector<double>& bytes_amounts);
341 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
343 /** @brief Returns the actor ID of the current actor. */
344 XBT_PUBLIC aid_t get_pid();
346 /** @brief Returns the ancestor's actor ID of the current actor. */
347 XBT_PUBLIC aid_t get_ppid();
349 /** @brief Returns the name of the current actor. */
350 XBT_PUBLIC std::string get_name();
351 /** @brief Returns the name of the current actor as a C string. */
352 XBT_PUBLIC const char* get_cname();
354 /** @brief Returns the name of the host on which the current actor is running. */
355 XBT_PUBLIC Host* get_host();
357 /** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */
358 XBT_PUBLIC void suspend();
360 /** @brief Yield the current actor. */
361 XBT_PUBLIC void yield();
363 /** @brief kill the current actor. */
364 XBT_PUBLIC void exit();
366 /** @brief Add a function to the list of "on_exit" functions of the current actor.
368 * The on_exit functions are the functions executed when your actor is killed. You should use them to free the data used
371 * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
372 * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
373 * blocking functions forbidden in this setting, but also modifications to the global state.
375 * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
376 * It will be set to true if the actor was killed or failed because of an exception or if the simulation deadlocked,
377 * while it will remain to false if the actor terminated gracefully.
380 XBT_PUBLIC void on_exit(const std::function<void(bool)>& fun);
382 /** @brief Migrate the current actor to a new host. */
383 XBT_PUBLIC void set_host(Host* new_host);
385 XBT_ATTRIB_DEPRECATED_v329("Please use set_host() instead") XBT_PUBLIC void migrate(Host* new_host);
390 }} // namespace simgrid::s4u
393 #endif /* SIMGRID_S4U_ACTOR_HPP */