1 /* Copyright (c) 2006-2020. 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/functional.hpp>
14 #include <xbt/signal.hpp>
15 #include <xbt/string.hpp>
18 #include <map> // deprecated wrappers
19 #include <unordered_map>
23 extern template class XBT_PUBLIC xbt::Extendable<s4u::Actor>;
27 /** An actor is an independent stream of execution in your distributed application.
30 * It is located on a (simulated) :cpp:class:`host <simgrid::s4u::Host>`, but can interact
31 * with the whole simulated platform.
33 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
34 * This is the only component in SimGrid that actually does something on its own, executing its own code.
35 * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
36 * schedule these activities. **Please refer to the** :ref:`examples <s4u_ex_actors>` **for more information.**
38 * This API is strongly inspired from the C++11 threads.
39 * The `documentation of this standard <http://en.cppreference.com/w/cpp/thread>`_
40 * may help to understand the philosophy of the SimGrid actors.
43 class XBT_PUBLIC Actor : public xbt::Extendable<Actor> {
47 friend kernel::actor::ActorImpl;
48 friend kernel::activity::MailboxImpl;
50 kernel::actor::ActorImpl* const pimpl_;
53 explicit Actor(kernel::actor::ActorImpl* pimpl) : pimpl_(pimpl) {}
57 // ***** No copy *****
58 Actor(Actor const&) = delete;
59 Actor& operator=(Actor const&) = delete;
61 // ***** Reference count *****
62 friend XBT_PUBLIC void intrusive_ptr_add_ref(const Actor* actor);
63 friend XBT_PUBLIC void intrusive_ptr_release(const Actor* actor);
65 /** Retrieve the amount of references on that object. Useful to debug the automatic refcounting */
68 // ***** Actor creation *****
69 /** Retrieve a reference to myself */
72 /** Fired when a new actor has been created **/
73 static xbt::signal<void(Actor&)> on_creation;
74 /** Signal to others that an actor has been suspended**/
75 static xbt::signal<void(Actor const&)> on_suspend;
76 /** Signal to others that an actor has been resumed **/
77 static xbt::signal<void(Actor const&)> on_resume;
78 /** Signal to others that an actor is sleeping **/
79 static xbt::signal<void(Actor const&)> on_sleep;
80 /** Signal to others that an actor wakes up for a sleep **/
81 static xbt::signal<void(Actor const&)> on_wake_up;
82 /** Signal to others that an actor is has been migrated to another host **/
83 static xbt::signal<void(Actor const&, Host const& previous_location)> on_host_change;
85 static xbt::signal<void(Actor const&)> on_migration_start; // XBT_ATTRIB_DEPRECATED_v329
86 static xbt::signal<void(Actor const&)> on_migration_end; // XBT_ATTRIB_DEPRECATED_v329
89 /** Signal indicating that an actor terminated its code.
91 * The actor may continue to exist if it is still referenced in the simulation, but it's not active anymore.
92 * If you want to free extra data when the actor's destructor is called, use :cpp:var:`Actor::on_destruction`.
93 * If you want to register to the termination of a given actor, use :cpp:func:`this_actor::on_exit()` instead.
96 static xbt::signal<void(Actor const&)> on_termination;
97 /** Signal indicating that an actor is about to disappear (its destructor was called).
98 * This signal is fired for any destructed actor, which is mostly useful when designing plugins and extensions.
99 * If you want to react to the end of the actor's code, use Actor::on_termination instead.
100 * If you want to register to the termination of a given actor, use this_actor::on_exit() instead.*/
101 static xbt::signal<void(Actor const&)> on_destruction;
103 /** Create an actor from a std::function<void()>.
104 * If the actor is restarted, it gets a fresh copy of the function. */
105 static ActorPtr create(const std::string& name, s4u::Host* host, const std::function<void()>& code);
106 /** Create an actor, but don't start it yet.
108 * This is useful to set some properties or extension before actually starting it */
109 static ActorPtr init(const std::string& name, s4u::Host* host);
110 ActorPtr set_stacksize(unsigned stacksize);
111 /** Start a previously initialized actor */
112 ActorPtr start(const std::function<void()>& code);
114 /** Create an actor from a callable thing. */
115 template <class F> static ActorPtr create(const std::string& name, s4u::Host* host, F code)
117 return create(name, host, std::function<void()>(std::move(code)));
120 /** Create an actor using a callable thing and its arguments.
122 * Note that the arguments will be copied, so move-only parameters are forbidden */
123 template <class F, class... Args,
124 // This constructor is enabled only if the call code(args...) is valid:
125 typename = typename std::result_of<F(Args...)>::type>
126 static ActorPtr create(const std::string& name, s4u::Host* host, F code, Args... args)
128 return create(name, host, std::bind(std::move(code), std::move(args)...));
131 /** Create actor from function name and a vector of strings as arguments. */
132 static ActorPtr create(const std::string& name, s4u::Host* host, const std::string& function,
133 std::vector<std::string> args);
135 // ***** Methods *****
136 /** This actor will be automatically terminated when the last non-daemon actor finishes **/
139 /** Returns whether or not this actor has been daemonized or not **/
140 bool is_daemon() const;
142 /** Retrieves the name of that actor as a C++ string */
143 const simgrid::xbt::string& get_name() const;
144 /** Retrieves the name of that actor as a C string */
145 const char* get_cname() const;
146 /** Retrieves the host on which that actor is running */
147 Host* get_host() const;
148 /** Retrieves the actor ID of that actor */
149 aid_t get_pid() const;
150 /** Retrieves the actor ID of that actor's creator */
151 aid_t get_ppid() const;
153 /** Suspend an actor, that is blocked until resumeed by another actor */
156 /** Resume an actor that was previously suspended */
159 /** Returns true if the actor is suspended. */
162 /** If set to true, the actor will automatically restart when its host reboots */
163 void set_auto_restart(bool autorestart);
165 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
166 * executed when your actor is killed. You should use them to free the data used by your actor.
168 * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
169 * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
170 * blocking functions forbidden in this setting, but also modifications to the global state.
172 * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
173 * It will be set to true if the actor was killed or failed because of an exception,
174 * while it will remain to false if the actor terminated gracefully.
176 void on_exit(const std::function<void(bool /*failed*/)>& fun) const;
178 /** Sets the time at which that actor should be killed */
179 void set_kill_time(double time);
180 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
181 double get_kill_time();
183 /** @brief Moves the actor to another host
185 * If the actor is currently blocked on an execution activity, the activity is also
186 * migrated to the new host. If it's blocked on another kind of activity, an error is
187 * raised as the mandated code is not written yet. Please report that bug if you need it.
189 * Asynchronous activities started by the actor are not migrated automatically, so you have
190 * to take care of this yourself (only you knows which ones should be migrated).
192 void set_host(Host* new_host);
194 XBT_ATTRIB_DEPRECATED_v329("Please use set_host() instead") void migrate(Host* new_host) { set_host(new_host); }
197 /** Ask the actor to die.
199 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
200 * Being killed is not something that actors can defer or avoid.
204 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
205 static ActorPtr by_pid(aid_t pid);
207 /** Wait for the actor to finish.
209 * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
210 * blocked until bob terminates.
214 /** Wait for the actor to finish, or for the timeout to elapse.
216 * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
217 * blocked until bob terminates.
219 void join(double timeout);
220 /** Kill that actor and restart it from start. */
223 /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */
224 static void kill_all();
226 /** Returns the internal implementation of this actor */
227 kernel::actor::ActorImpl* get_impl() const { return pimpl_; }
229 /** Retrieve the property value (or nullptr if not set) */
230 const std::unordered_map<std::string, std::string>*
231 get_properties() const; // FIXME: do not export the map, but only the keys or something
232 const char* get_property(const std::string& key) const;
233 void set_property(const std::string& key, const std::string& value);
237 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
238 namespace this_actor {
240 XBT_PUBLIC bool is_maestro();
242 /** Block the current actor sleeping for that amount of seconds */
243 XBT_PUBLIC void sleep_for(double duration);
244 /** Block the current actor sleeping until the specified timestamp */
245 XBT_PUBLIC void sleep_until(double wakeup_time);
247 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
249 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
250 this_actor::sleep_for(seconds.count());
253 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& wakeup_time)
255 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(wakeup_time);
256 this_actor::sleep_until(timeout_native.time_since_epoch().count());
259 /** Block the current actor, computing the given amount of flops */
260 XBT_PUBLIC void execute(double flop);
262 /** Block the current actor, computing the given amount of flops at the given priority.
263 * An execution of priority 2 computes twice as fast as an execution at priority 1. */
264 XBT_PUBLIC void execute(double flop, double priority);
267 * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
270 /** Block the current actor until the built parallel execution terminates
273 * .. _API_s4u_parallel_execute:
275 * **Example of use:** `examples/s4u/exec-ptask/s4u-exec-ptask.cpp
276 * <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-ptask/s4u-exec-ptask.cpp>`_
278 * Parallel executions convenient abstractions of parallel computational kernels that span over several machines,
279 * such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel
280 * on the platform (e.g. to schedule them wisely), there is no need to model them in all details of their internal
281 * execution and communications. It is much more convenient to model them as a single execution activity that spans
282 * over several hosts. This is exactly what s4u's Parallel Executions are.
284 * To build such an object, you need to provide a list of hosts that are involved in the parallel kernel (the
285 * actor's own host may or may not be in this list) and specify the amount of computations that should be done by
286 * each host, using a vector of flops amount. Then, you should specify the amount of data exchanged between each
287 * hosts during the parallel kernel. For that, a matrix of values is expected.
289 * It is OK to build a parallel execution without any computation and/or without any communication.
290 * Just pass an empty vector to the corresponding parameter.
292 * For example, if your list of hosts is ``[host0, host1]``, passing a vector ``[1000, 2000]`` as a `flops_amount`
293 * vector means that `host0` should compute 1000 flops while `host1` will compute 2000 flops. A matrix of
294 * communications' sizes of ``[0, 1, 2, 3]`` specifies the following data exchanges:
296 * - from host0: [ to host0: 0 bytes; to host1: 1 byte ]
298 * - from host1: [ to host0: 2 bytes; to host1: 3 bytes ]
300 * Or, in other words:
302 * - From host0 to host0: 0 bytes are exchanged
304 * - From host0 to host1: 1 byte is exchanged
306 * - From host1 to host0: 2 bytes are exchanged
308 * - From host1 to host1: 3 bytes are exchanged
310 * In a parallel execution, all parts (all executions on each hosts, all communications) progress exactly at the
311 * same pace, so they all terminate at the exact same pace. If one part is slow because of a slow resource or
312 * because of contention, this slows down the parallel execution as a whole.
314 * These objects are somewhat surprising from a modeling point of view. For example, the unit of their speed is
315 * somewhere between flop/sec and byte/sec. Arbitrary parallel executions will simply not work with the usual platform
316 * models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
317 * regular executions and communications with parallel executions, provided that the host model is ptask_L07.
321 /** Block the current actor until the built parallel execution completes */
322 XBT_PUBLIC void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
323 const std::vector<double>& bytes_amounts);
325 XBT_ATTRIB_DEPRECATED_v329("Please use exec_init(...)->wait_for(timeout)") XBT_PUBLIC
326 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
327 const std::vector<double>& bytes_amounts, double timeout);
329 /** Initialize a sequential execution that must then be started manually */
330 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
331 /** Initialize a parallel execution that must then be started manually */
332 XBT_PUBLIC ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
333 const std::vector<double>& bytes_amounts);
335 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
337 /** @brief Returns the actor ID of the current actor. */
338 XBT_PUBLIC aid_t get_pid();
340 /** @brief Returns the ancestor's actor ID of the current actor. */
341 XBT_PUBLIC aid_t get_ppid();
343 /** @brief Returns the name of the current actor. */
344 XBT_PUBLIC std::string get_name();
345 /** @brief Returns the name of the current actor as a C string. */
346 XBT_PUBLIC const char* get_cname();
348 /** @brief Returns the name of the host on which the current actor is running. */
349 XBT_PUBLIC Host* get_host();
351 /** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */
352 XBT_PUBLIC void suspend();
354 /** @brief Yield the current actor. */
355 XBT_PUBLIC void yield();
357 /** @brief kill the current actor. */
358 XBT_PUBLIC void exit();
360 /** @brief Add a function to the list of "on_exit" functions of the current actor.
362 * The on_exit functions are the functions executed when your actor is killed. You should use them to free the data used
365 * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
366 * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
367 * blocking functions forbidden in this setting, but also modifications to the global state.
369 * The parameter of on_exit's callbacks denotes whether or not the actor's execution failed.
370 * It will be set to true if the actor was killed or failed because of an exception or if the simulation deadlocked,
371 * while it will remain to false if the actor terminated gracefully.
374 XBT_PUBLIC void on_exit(const std::function<void(bool)>& fun);
376 /** @brief Migrate the current actor to a new host. */
377 XBT_PUBLIC void set_host(Host* new_host);
379 XBT_ATTRIB_DEPRECATED_v329("Please use set_host() instead") XBT_PUBLIC void migrate(Host* new_host);
384 }} // namespace simgrid::s4u
387 #endif /* SIMGRID_S4U_ACTOR_HPP */