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.
42 class XBT_PUBLIC Actor : public xbt::Extendable<Actor> {
46 friend kernel::actor::ActorImpl;
47 friend kernel::activity::MailboxImpl;
49 kernel::actor::ActorImpl* const pimpl_;
52 explicit Actor(kernel::actor::ActorImpl* pimpl) : pimpl_(pimpl) {}
56 // ***** No copy *****
57 Actor(Actor const&) = delete;
58 Actor& operator=(Actor const&) = delete;
60 // ***** Reference count *****
61 friend XBT_PUBLIC void intrusive_ptr_add_ref(const Actor* actor);
62 friend XBT_PUBLIC void intrusive_ptr_release(const Actor* actor);
64 /** Retrieve the amount of references on that object. Useful to debug the automatic refcounting */
65 int get_refcount() const;
67 // ***** Actor creation *****
68 /** Retrieve a reference to myself */
71 /** Fired when a new actor has been created **/
72 static xbt::signal<void(Actor&)> on_creation;
73 /** Signal to others that an actor has been suspended**/
74 static xbt::signal<void(Actor const&)> on_suspend;
75 /** Signal to others that an actor has been resumed **/
76 static xbt::signal<void(Actor const&)> on_resume;
77 /** Signal to others that an actor is sleeping **/
78 static xbt::signal<void(Actor const&)> on_sleep;
79 /** Signal to others that an actor wakes up for a sleep **/
80 static xbt::signal<void(Actor const&)> on_wake_up;
81 /** Signal to others that an actor is has been migrated to another host **/
82 static xbt::signal<void(const Actor&, const Host& previous_location)> on_host_change;
84 /** Signal indicating that an actor terminated its code.
86 * The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore.
87 * If you want to free extra data when the actor's destructor is called, use :cpp:var:`Actor::on_destruction`.
88 * If you want to register to the termination of a given actor, use :cpp:func:`this_actor::on_exit()` instead.
91 static xbt::signal<void(Actor const&)> on_termination;
92 /** Signal indicating that an actor is about to disappear (its destructor was called).
93 * This signal is fired for any destructed actor, which is mostly useful when designing plugins and extensions.
94 * If you want to react to the end of the actor's code, use Actor::on_termination instead.
95 * If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/
96 static xbt::signal<void(Actor const&)> on_destruction;
98 /** Create an actor from a std::function<void()>.
99 * If the actor is restarted, it gets a fresh copy of the function. */
100 static ActorPtr create(const std::string& name, s4u::Host* host, const std::function<void()>& code);
101 /** Create an actor, but don't start it yet.
103 * This is useful to set some properties or extension before actually starting it */
104 static ActorPtr init(const std::string& name, s4u::Host* host);
105 ActorPtr set_stacksize(unsigned stacksize);
106 /** Start a previously initialized actor */
107 ActorPtr start(const std::function<void()>& code);
109 template <class F> ActorPtr start(F code) { return start(std::function<void()>(std::move(code))); }
111 template <class F, class... Args,
112 // This constructor is enabled only if the call code(args...) is valid:
113 #ifndef DOXYGEN /* breathe seem to choke on function signatures in template parameter, see breathe#611 */
114 typename = typename std::result_of_t<F(Args...)>
117 ActorPtr start(F code, Args... args)
119 return start(std::bind(std::move(code), std::move(args)...));
122 ActorPtr start(const std::function<void()>& code, std::vector<std::string> args);
124 /** Create an actor from a callable thing. */
125 template <class F> static ActorPtr create(const std::string& name, s4u::Host* host, F code)
127 return create(name, host, std::function<void()>(std::move(code)));
130 /** Create an actor using a callable thing and its arguments.
132 * Note that the arguments will be copied, so move-only parameters are forbidden */
134 template <class F, class... Args,
135 // This constructor is enabled only if the call code(args...) is valid:
136 #ifndef DOXYGEN /* breathe seem to choke on function signatures in template parameter, see breathe#611 */
137 typename = typename std::result_of_t<F(Args...)>
140 static ActorPtr create(const std::string& name, s4u::Host* host, F code, Args... args)
142 return create(name, host, std::bind(std::move(code), std::move(args)...));
145 /** Create actor from function name and a vector of strings as arguments. */
146 static ActorPtr create(const std::string& name, s4u::Host* host, const std::string& function,
147 std::vector<std::string> args);
149 // ***** Methods *****
150 /** This actor will be automatically terminated when the last non-daemon actor finishes **/
153 /** Returns whether or not this actor has been daemonized or not **/
154 bool is_daemon() const;
156 /** Retrieves the name of that actor as a C++ string */
157 const simgrid::xbt::string& get_name() const;
158 /** Retrieves the name of that actor as a C string */
159 const char* get_cname() const;
160 /** Retrieves the host on which that actor is running */
161 Host* get_host() const;
162 /** Retrieves the actor ID of that actor */
163 aid_t get_pid() const;
164 /** Retrieves the actor ID of that actor's creator */
165 aid_t get_ppid() const;
167 /** Suspend an actor, that is blocked until resumeed by another actor */
170 /** Resume an actor that was previously suspended */
173 /** Returns true if the actor is suspended. */
174 bool is_suspended() const;
176 /** If set to true, the actor will automatically restart when its host reboots */
177 void set_auto_restart(bool autorestart);
179 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
180 * executed when your actor is killed. You should use them to free the data used by your actor.
182 * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
183 * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
184 * blocking functions forbidden in this setting, but also modifications to the global state.
186 * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
187 * It will be set to true if the actor was killed or failed because of an exception,
188 * while it will remain to false if the actor terminated gracefully.
190 void on_exit(const std::function<void(bool /*failed*/)>& fun) const;
192 /** Sets the time at which that actor should be killed */
193 void set_kill_time(double time);
194 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
195 double get_kill_time() const;
197 /** @brief Moves the actor to another host
199 * If the actor is currently blocked on an execution activity, the activity is also
200 * migrated to the new host. If it's blocked on another kind of activity, an error is
201 * raised as the mandated code is not written yet. Please report that bug if you need it.
203 * Asynchronous activities started by the actor are not migrated automatically, so you have
204 * to take care of this yourself (only you knows which ones should be migrated).
206 void set_host(Host* new_host);
208 /** Ask the actor to die.
210 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
211 * Being killed is not something that actors can defer or avoid.
215 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
216 static ActorPtr by_pid(aid_t pid);
218 /** Wait for the actor to finish.
220 * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
221 * blocked until bob terminates.
225 /** Wait for the actor to finish, or for the timeout to elapse.
227 * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
228 * blocked until bob terminates.
230 void join(double timeout) const;
231 /** Kill that actor and restart it from start. */
234 /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */
235 static void kill_all();
237 /** Returns the internal implementation of this actor */
238 kernel::actor::ActorImpl* get_impl() const { return pimpl_; }
240 /** Retrieve the list of properties for that actor */
241 const std::unordered_map<std::string, std::string>*
242 get_properties() const; // FIXME: do not export the map, but only the keys or something
244 /** Retrieve the property value (or nullptr if not set) */
245 const char* get_property(const std::string& key) const;
247 /** Set a property (old values will be overwritten) */
248 void set_property(const std::string& key, const std::string& value);
252 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
253 namespace this_actor {
255 XBT_PUBLIC bool is_maestro();
257 /** Block the current actor sleeping for that amount of seconds */
258 XBT_PUBLIC void sleep_for(double duration);
259 /** Block the current actor sleeping until the specified timestamp */
260 XBT_PUBLIC void sleep_until(double wakeup_time);
262 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
264 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
265 this_actor::sleep_for(seconds.count());
268 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& wakeup_time)
270 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(wakeup_time);
271 this_actor::sleep_until(timeout_native.time_since_epoch().count());
274 /** Block the current actor, computing the given amount of flops */
275 XBT_PUBLIC void execute(double flop);
277 /** Block the current actor, computing the given amount of flops at the given priority.
278 * An execution of priority 2 computes twice as fast as an execution at priority 1. */
279 XBT_PUBLIC void execute(double flop, double priority);
282 * @example examples/cpp/exec-ptask/s4u-exec-ptask.cpp
285 /** Block the current actor until the built parallel execution terminates
288 * .. _API_s4u_parallel_execute:
290 * **Example of use:** `examples/cpp/exec-ptask/s4u-exec-ptask.cpp
291 * <https://framagit.org/simgrid/simgrid/tree/master/examples/cpp/exec-ptask/s4u-exec-ptask.cpp>`_
293 * Parallel executions convenient abstractions of parallel computational kernels that span over several machines,
294 * such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel
295 * on the platform (e.g. to schedule them wisely), there is no need to model them in all details of their internal
296 * execution and communications. It is much more convenient to model them as a single execution activity that spans
297 * over several hosts. This is exactly what s4u's Parallel Executions are.
299 * To build such an object, you need to provide a list of hosts that are involved in the parallel kernel (the
300 * actor's own host may or may not be in this list) and specify the amount of computations that should be done by
301 * each host, using a vector of flops amount. Then, you should specify the amount of data exchanged between each
302 * hosts during the parallel kernel. For that, a matrix of values is expected.
304 * It is OK to build a parallel execution without any computation and/or without any communication.
305 * Just pass an empty vector to the corresponding parameter.
307 * For example, if your list of hosts is ``[host0, host1]``, passing a vector ``[1000, 2000]`` as a `flops_amount`
308 * vector means that `host0` should compute 1000 flops while `host1` will compute 2000 flops. A matrix of
309 * communications' sizes of ``[0, 1, 2, 3]`` specifies the following data exchanges:
311 * - from host0: [ to host0: 0 bytes; to host1: 1 byte ]
313 * - from host1: [ to host0: 2 bytes; to host1: 3 bytes ]
315 * Or, in other words:
317 * - From host0 to host0: 0 bytes are exchanged
319 * - From host0 to host1: 1 byte is exchanged
321 * - From host1 to host0: 2 bytes are exchanged
323 * - From host1 to host1: 3 bytes are exchanged
325 * In a parallel execution, all parts (all executions on each hosts, all communications) progress exactly at the
326 * same pace, so they all terminate at the exact same pace. If one part is slow because of a slow resource or
327 * because of contention, this slows down the parallel execution as a whole.
329 * These objects are somewhat surprising from a modeling point of view. For example, the unit of their speed is
330 * somewhere between flop/sec and byte/sec. Arbitrary parallel executions will simply not work with the usual platform
331 * models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
332 * regular executions and communications with parallel executions, provided that the host model is ptask_L07.
336 /** Block the current actor until the built parallel execution completes */
337 XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
338 const std::vector<double>& bytes_amounts);
340 /** Initialize a sequential execution that must then be started manually */
341 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
342 /** Initialize a parallel execution that must then be started manually */
343 XBT_PUBLIC ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
344 const std::vector<double>& bytes_amounts);
346 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
348 /** @brief Returns the actor ID of the current actor. */
349 XBT_PUBLIC aid_t get_pid();
351 /** @brief Returns the ancestor's actor ID of the current actor. */
352 XBT_PUBLIC aid_t get_ppid();
354 /** @brief Returns the name of the current actor. */
355 XBT_PUBLIC std::string get_name();
356 /** @brief Returns the name of the current actor as a C string. */
357 XBT_PUBLIC const char* get_cname();
359 /** @brief Returns the name of the host on which the current actor is running. */
360 XBT_PUBLIC Host* get_host();
362 /** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */
363 XBT_PUBLIC void suspend();
365 /** @brief Yield the current actor. */
366 XBT_PUBLIC void yield();
368 /** @brief kill the current actor. */
369 XBT_PUBLIC void exit();
371 /** @brief Add a function to the list of "on_exit" functions of the current actor.
373 * The on_exit functions are the functions executed when your actor is killed. You should use them to free the data used
376 * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
377 * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
378 * blocking functions forbidden in this setting, but also modifications to the global state.
380 * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
381 * It will be set to true if the actor was killed or failed because of an exception or if the simulation deadlocked,
382 * while it will remain to false if the actor terminated gracefully.
385 XBT_PUBLIC void on_exit(const std::function<void(bool)>& fun);
387 /** @brief Migrate the current actor to a new host. */
388 XBT_PUBLIC void set_host(Host* new_host);
392 }} // namespace simgrid::s4u
395 #endif /* SIMGRID_S4U_ACTOR_HPP */