1 /* Copyright (c) 2006-2019. 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
10 #include <map> // deprecated wrappers
11 #include <simgrid/chrono.hpp>
12 #include <unordered_map>
13 #include <xbt/Extendable.hpp>
14 #include <xbt/functional.hpp>
15 #include <xbt/signal.hpp>
16 #include <xbt/string.hpp>
23 * An actor is an independent stream of execution in your distributed application.
25 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
26 * This is the only component in SimGrid that actually does something on its own, executing its own code.
27 * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
28 * schedule these activities.
30 * An actor is located on a (simulated) host, but it can interact
31 * with the whole simulated platform.
33 * The s4u::Actor API is strongly inspired from the C++11 threads.
34 * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
35 * of this standard</a> may help to understand the philosophy of the S4U
38 * @section s4u_actor_def Defining the skeleton of an Actor
40 * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
41 * standard</a>, you can declare the code of your actor either as a
42 * pure function or as an object. It is very simple with functions:
45 * #include <simgrid/s4u/actor.hpp>
47 * // Declare the code of your worker
49 * printf("Hello s4u");
50 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
53 * // From your main or from another actor, create your actor on the host Jupiter
54 * // The following line actually creates a new actor, even if there is no "new".
55 * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
58 * But some people prefer to encapsulate their actors in classes and
59 * objects to save the actor state in a cleanly dedicated location.
60 * The syntax is slightly more complicated, but not much.
63 * #include <simgrid/s4u/actor.hpp>
65 * // Declare the class representing your actors
68 * void operator()() { // Two pairs of () because this defines the method called ()
69 * printf("Hello s4u");
70 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
74 * // From your main or from another actor, create your actor. Note the () after Worker
75 * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
78 * @section s4u_actor_flesh Fleshing your actor
80 * The body of your actor can use the functions of the
81 * simgrid::s4u::this_actor namespace to interact with the world.
82 * This namespace contains the methods to start new activities
83 * (executions, communications, etc), and to get informations about
84 * the currently running thread (its location, etc).
86 * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
89 * @section s4u_actor_deploy Using a deployment file
91 * @warning This is currently not working with S4U. Sorry about that.
93 * The best practice is to use an external deployment file as
94 * follows, because it makes it easier to test your application in
95 * differing settings. Load this file with
96 * s4u::Engine::loadDeployment() before the simulation starts.
97 * Refer to the @ref deployment section for more information.
100 * <?xml version='1.0'?>
101 * <!DOCTYPE platform SYSTEM "https://simgrid.org/simgrid.dtd">
102 * <platform version="4.1">
104 * <!-- Start an actor called 'master' on the host called 'Tremblay' -->
105 * <actor host="Tremblay" function="master">
106 * <!-- Here come the parameter that you want to feed to this instance of master -->
107 * <argument value="20"/> <!-- argv[1] -->
108 * <argument value="50000000"/> <!-- argv[2] -->
109 * <argument value="1000000"/> <!-- argv[3] -->
110 * <argument value="5"/> <!-- argv[4] -->
113 * <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
114 * <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
122 /** @brief Simulation Agent */
123 class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
124 friend simgrid::s4u::Exec;
125 friend simgrid::s4u::Mailbox;
126 friend simgrid::kernel::actor::ActorImpl;
127 friend simgrid::kernel::activity::MailboxImpl;
129 kernel::actor::ActorImpl* const pimpl_ = nullptr;
131 explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
135 // ***** No copy *****
136 Actor(Actor const&) = delete;
137 Actor& operator=(Actor const&) = delete;
139 // ***** Reference count *****
140 friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor);
141 friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor);
143 // ***** Actor creation *****
144 /** Retrieve a reference to myself */
145 static ActorPtr self();
147 /** Signal to others that a new actor has been created **/
148 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_creation;
149 /** Signal to others that an actor has been suspended**/
150 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_suspend;
151 /** Signal to others that an actor has been resumed **/
152 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_resume;
153 /** Signal to others that an actor is sleeping **/
154 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_sleep;
155 /** Signal to others that an actor wakes up for a sleep **/
156 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_wake_up;
157 /** Signal to others that an actor is going to migrated to another host**/
158 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_start;
159 /** Signal to others that an actor is has been migrated to another host **/
160 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_end;
161 /** Signal indicating that an actor is about to disappear.
162 * This signal is fired for any dying actor, which is mostly useful when
163 * designing plugins and extensions. If you want to register to the
164 * termination of a given actor, use this_actor::on_exit() instead.*/
165 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_destruction;
167 /** Create an actor from a std::function<void()>
169 * If the actor is restarted, the actor has a fresh copy of the function.
171 static ActorPtr create(std::string name, s4u::Host* host, std::function<void()> code);
173 /** Create an actor from a std::function
175 * If the actor is restarted, the actor has a fresh copy of the function.
177 template <class F> static ActorPtr create(std::string name, s4u::Host* host, F code)
179 return create(name, host, std::function<void()>(std::move(code)));
182 /** Create an actor using a callable thing and its arguments.
184 * Note that the arguments will be copied, so move-only parameters are forbidden */
185 template <class F, class... Args,
186 // This constructor is enabled only if the call code(args...) is valid:
187 typename = typename std::result_of<F(Args...)>::type>
188 static ActorPtr create(std::string name, s4u::Host* host, F code, Args... args)
190 return create(name, host, std::bind(std::move(code), std::move(args)...));
193 // Create actor from function name:
194 static ActorPtr create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args);
196 // ***** Methods *****
197 /** This actor will be automatically terminated when the last non-daemon actor finishes **/
200 /** Returns whether or not this actor has been daemonized or not **/
201 bool is_daemon() const;
203 /** Retrieves the name of that actor as a C++ string */
204 const simgrid::xbt::string& get_name() const;
205 /** Retrieves the name of that actor as a C string */
206 const char* get_cname() const;
207 /** Retrieves the host on which that actor is running */
208 s4u::Host* get_host();
209 /** Retrieves the actor ID of that actor */
210 aid_t get_pid() const;
211 /** Retrieves the actor ID of that actor's creator */
212 aid_t get_ppid() const;
214 /** Suspend an actor, that is blocked until resume()ed by another actor */
217 /** Resume an actor that was previously suspend()ed */
220 /** Returns true if the actor is suspended. */
223 /** If set to true, the actor will automatically restart when its host reboots */
224 void set_auto_restart(bool autorestart);
226 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
227 * executed when your actor is killed. You should use them to free the data used by your actor.
229 * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
230 * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
231 * blocking functions forbidden in this setting, but also modifications to the global state.
233 void on_exit(std::function<void(int, void*)> fun, void* data);
235 /** Sets the time at which that actor should be killed */
236 void set_kill_time(double time);
237 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
238 double get_kill_time();
240 /** @brief Moves the actor to another host
242 * If the actor is currently blocked on an execution activity, the activity is also
243 * migrated to the new host. If it's blocked on another kind of activity, an error is
244 * raised as the mandated code is not written yet. Please report that bug if you need it.
246 * Asynchronous activities started by the actor are not migrated automatically, so you have
247 * to take care of this yourself (only you knows which ones should be migrated).
249 void migrate(Host * new_host);
251 /** Ask the actor to die.
253 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
254 * Being killed is not something that actors can defer or avoid.
256 * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
257 * Still. Please report any bug that you may encounter with a minimal working example.
261 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
262 static ActorPtr by_pid(aid_t pid);
264 /** Wait for the actor to finish.
266 * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
267 * blocked until bob terminates.
271 /** Wait for the actor to finish, or for the timeout to elapse.
273 * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
274 * blocked until bob terminates.
276 void join(double timeout);
279 /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */
280 static void kill_all();
282 /** Returns the internal implementation of this actor */
283 kernel::actor::ActorImpl* get_impl();
285 /** Retrieve the property value (or nullptr if not set) */
286 std::unordered_map<std::string, std::string>*
287 get_properties(); // FIXME: do not export the map, but only the keys or something
288 const char* get_property(std::string key);
289 void set_property(std::string key, std::string value);
292 XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid);
294 /** @deprecated See Actor::create() */
295 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
296 const char* name, s4u::Host* host, std::function<void()> code)
298 return create(name, host, code);
300 /** @deprecated See Actor::create() */
301 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
302 const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
303 std::vector<std::string>* args)
305 return create(name, host, code, args);
307 /** @deprecated See Actor::create() */
308 template <class F, class... Args, typename = typename std::result_of<F(Args...)>::type>
309 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
310 const char* name, s4u::Host* host, F code, Args... args)
312 return create(name, host, code, std::move(args)...);
314 /** @deprecated See Actor::create() */
315 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
316 const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
318 return create(name, host, function, args);
320 /** @deprecated See Actor::is_daemon() */
321 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const;
322 /** @deprecated See Actor::get_name() */
323 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const
327 /** @deprecated See Actor::get_cname() */
328 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); }
329 /** @deprecated See Actor::get_host() */
330 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); }
331 /** @deprecated See Actor::get_pid() */
332 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); }
333 /** @deprecated See Actor::get_ppid() */
334 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); }
335 /** @deprecated See Actor::is_suspended() */
336 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); }
337 /** @deprecated See Actor::set_auto_restart() */
338 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a)
342 /** @deprecated Please use a std::function<void(int, void*)> for first parameter */
343 XBT_ATTRIB_DEPRECATED_v323("Please use a std::function<void(int, void*)> for first parameter.") void on_exit(
344 int_f_pvoid_pvoid_t fun, void* data);
345 /** @deprecated See Actor::on_exit() */
346 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data)
348 on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
350 /** @deprecated See Actor::set_kill_time() */
351 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); }
352 /** @deprecated See Actor::get_kill_time() */
353 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); }
354 /** @deprecated See Actor::by_pid() */
355 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); }
356 /** @deprecated See Actor::kill_all() */
357 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); }
358 /** @deprecated See Actor::kill_all() */
359 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll(
360 int XBT_ATTRIB_UNUSED resetPid)
364 /** @deprecated See Actor::get_impl() */
365 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); }
366 /** @deprecated See Actor::get_property() */
367 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key)
369 return get_property(key);
371 /** @deprecated See Actor::get_properties() */
372 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") std::map<std::string, std::string>* getProperties()
374 std::map<std::string, std::string>* res = new std::map<std::string, std::string>();
375 std::unordered_map<std::string, std::string>* props = get_properties();
376 for (auto const& kv : *props)
380 /** @deprecated See Actor::get_properties() */
381 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_property()") void setProperty(const char* key, const char* value)
383 set_property(key, value);
389 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
390 namespace this_actor {
392 XBT_PUBLIC bool is_maestro();
394 /** Block the current actor sleeping for that amount of seconds (may throw hostFailure) */
395 XBT_PUBLIC void sleep_for(double duration);
396 /** Block the current actor sleeping until the specified timestamp (may throw hostFailure) */
397 XBT_PUBLIC void sleep_until(double timeout);
399 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
401 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
402 this_actor::sleep_for(seconds.count());
405 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
407 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
408 this_actor::sleep_until(timeout_native.time_since_epoch().count());
411 /** Block the current actor, computing the given amount of flops */
412 XBT_PUBLIC void execute(double flop);
414 /** Block the current actor, computing the given amount of flops at the given priority.
415 * An execution of priority 2 computes twice as fast as an execution at priority 1. */
416 XBT_PUBLIC void execute(double flop, double priority);
419 * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
422 /** Block the current actor until the built parallel execution terminates
425 * .. _API_s4u_parallel_execute:
427 * **Example of use:** `examples/s4u/exec-ptask/s4u-exec-ptask.cpp
428 * <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-ptask/s4u-exec-ptask.cpp>`_
430 * Parallel executions convenient abstractions of parallel computational kernels that span over several machines,
431 * such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel
432 * on the platform (e.g. to schedule them wisely), there is no need to model them in all details of their internal
433 * execution and communications. It is much more convenient to model them as a single execution activity that spans
434 * over several hosts. This is exactly what s4u's Parallel Executions are.
436 * To build such an object, you need to provide a list of hosts that are involved in the parallel kernel (the
437 * actor's own host may or may not be in this list) and specify the amount of computations that should be done by
438 * each host, using a vector of flops amount. Then, you should specify the amount of data exchanged between each
439 * hosts during the parallel kernel. For that, a matrix of values is expected.
441 * It is OK to build a parallel execution without any computation and/or without any communication.
442 * Just pass an empty vector to the corresponding parameter.
444 * For example, if your list of hosts is ``[host0, host1]``, passing a vector ``[1000, 2000]`` as a `flops_amount`
445 * vector means that `host0` should compute 1000 flops while `host1` will compute 2000 flops. A matrix of
446 * communications' sizes of ``[0, 1, 2, 3]`` specifies the following data exchanges:
448 * +-----------+-------+------+
449 * |from \\ to | host0 | host1|
450 * +===========+=======+======+
452 * +-----------+-------+------+
454 * +-----------+-------+------+
456 * - From host0 to host0: 0 bytes are exchanged
457 * - From host0 to host1: 1 byte is exchanged
458 * - From host1 to host0: 2 bytes are exchanged
459 * - From host1 to host1: 3 bytes are exchanged
461 * In a parallel execution, all parts (all executions on each hosts, all communications) progress exactly at the
462 * same pace, so they all terminate at the exact same pace. If one part is slow because of a slow resource or
463 * because of contention, this slows down the parallel execution as a whole.
465 * These objects are somewhat surprising from a modeling point of view. For example, the unit of their speed is
466 * somewhere between flop/sec and byte/sec. Arbitrary parallel executions will simply not work with the usual platform
467 * models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
468 * regular executions and communications with parallel executions, provided that the host model is ptask_L07.
472 XBT_PUBLIC void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
473 std::vector<double> bytes_amounts);
476 * Block the current actor until the built :ref:`parallel execution <API_s4u_parallel_execute>` completes, or until the
479 XBT_PUBLIC void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
480 std::vector<double> bytes_amounts, double timeout);
483 XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
484 void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount);
485 XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
486 void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount,
490 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
491 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
493 /** @brief Returns the actor ID of the current actor. */
494 XBT_PUBLIC aid_t get_pid();
496 /** @brief Returns the ancestor's actor ID of the current actor. */
497 XBT_PUBLIC aid_t get_ppid();
499 /** @brief Returns the name of the current actor. */
500 XBT_PUBLIC std::string get_name();
501 /** @brief Returns the name of the current actor as a C string. */
502 XBT_PUBLIC const char* get_cname();
504 /** @brief Returns the name of the host on which the curret actor is running. */
505 XBT_PUBLIC Host* get_host();
507 /** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */
508 XBT_PUBLIC void suspend();
510 /** @brief Yield the current actor. */
511 XBT_PUBLIC void yield();
513 /** @brief Resume the current actor, that was suspend()ed previously. */
514 XBT_PUBLIC void resume();
516 /** @brief kill the current actor. */
517 XBT_PUBLIC void exit();
519 /** @brief Add a function to the list of "on_exit" functions of the current actor. */
520 XBT_PUBLIC void on_exit(std::function<void(int, void*)> fun, void* data);
522 /** @brief Migrate the current actor to a new host. */
523 XBT_PUBLIC void migrate(Host* new_host);
528 /** @deprecated Please use std::function<void(int, void*)> for first parameter */
529 XBT_ATTRIB_DEPRECATED_v323("Please use std::function<void(int, void*)> for first parameter.") XBT_PUBLIC
530 void on_exit(int_f_pvoid_pvoid_t fun, void* data);
531 /** @deprecated See this_actor::get_name() */
532 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName();
533 /** @deprecated See this_actor::get_cname() */
534 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname();
535 /** @deprecated See this_actor::is_maestro() */
536 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_maestro()") XBT_PUBLIC bool isMaestro();
537 /** @deprecated See this_actor::get_pid() */
538 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t getPid();
539 /** @deprecated See this_actor::get_ppid() */
540 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid();
541 /** @deprecated See this_actor::get_host() */
542 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost();
543 /** @deprecated See this_actor::on_exit() */
544 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data);
545 /** @deprecated See this_actor::exit() */
546 XBT_ATTRIB_DEPRECATED_v324("Please use this_actor::exit()") XBT_PUBLIC void kill();
551 }} // namespace simgrid::s4u
554 #endif /* SIMGRID_S4U_ACTOR_HPP */