1 /* Copyright (c) 2006-2018. 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/chrono.hpp>
10 #include <xbt/Extendable.hpp>
11 #include <xbt/functional.hpp>
12 #include <xbt/signal.hpp>
13 #include <xbt/string.hpp>
20 * An actor is an independent stream of execution in your distributed application.
22 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
23 * This is the only component in SimGrid that actually does something on its own, executing its own code.
24 * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
25 * schedule these activities.
27 * An actor is located on a (simulated) host, but it can interact
28 * with the whole simulated platform.
30 * The s4u::Actor API is strongly inspired from the C++11 threads.
31 * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
32 * of this standard</a> may help to understand the philosophy of the S4U
35 * @section s4u_actor_def Defining the skeleton of an Actor
37 * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
38 * standard</a>, you can declare the code of your actor either as a
39 * pure function or as an object. It is very simple with functions:
42 * #include <simgrid/s4u/actor.hpp>
44 * // Declare the code of your worker
46 * printf("Hello s4u");
47 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
50 * // From your main or from another actor, create your actor on the host Jupiter
51 * // The following line actually creates a new actor, even if there is no "new".
52 * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
55 * But some people prefer to encapsulate their actors in classes and
56 * objects to save the actor state in a cleanly dedicated location.
57 * The syntax is slightly more complicated, but not much.
60 * #include <simgrid/s4u/actor.hpp>
62 * // Declare the class representing your actors
65 * void operator()() { // Two pairs of () because this defines the method called ()
66 * printf("Hello s4u");
67 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
71 * // From your main or from another actor, create your actor. Note the () after Worker
72 * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
75 * @section s4u_actor_flesh Fleshing your actor
77 * The body of your actor can use the functions of the
78 * simgrid::s4u::this_actor namespace to interact with the world.
79 * This namespace contains the methods to start new activities
80 * (executions, communications, etc), and to get informations about
81 * the currently running thread (its location, etc).
83 * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
86 * @section s4u_actor_deploy Using a deployment file
88 * @warning This is currently not working with S4U. Sorry about that.
90 * The best practice is to use an external deployment file as
91 * follows, because it makes it easier to test your application in
92 * differing settings. Load this file with
93 * s4u::Engine::loadDeployment() before the simulation starts.
94 * Refer to the @ref deployment section for more information.
97 * <?xml version='1.0'?>
98 * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
99 * <platform version="4">
101 * <!-- Start an actor called 'master' on the host called 'Tremblay' -->
102 * <actor host="Tremblay" function="master">
103 * <!-- Here come the parameter that you want to feed to this instance of master -->
104 * <argument value="20"/> <!-- argv[1] -->
105 * <argument value="50000000"/> <!-- argv[2] -->
106 * <argument value="1000000"/> <!-- argv[3] -->
107 * <argument value="5"/> <!-- argv[4] -->
110 * <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
111 * <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
119 /** @brief Simulation Agent */
120 class XBT_PUBLIC Actor : public simgrid::xbt::Extendable<Actor> {
123 friend simgrid::kernel::actor::ActorImpl;
124 friend simgrid::kernel::activity::MailboxImpl;
125 kernel::actor::ActorImpl* pimpl_ = nullptr;
127 /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
128 template<class F, class... Args>
129 static std::function<void()> wrap_task(F f, Args... args)
131 typedef decltype(f(std::move(args)...)) R;
132 auto task = std::make_shared<simgrid::xbt::Task<R()>>(
133 simgrid::xbt::makeTask(std::move(f), std::move(args)...));
134 return [task] { (*task)(); };
137 explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
141 // ***** No copy *****
142 Actor(Actor const&) = delete;
143 Actor& operator=(Actor const&) = delete;
145 // ***** Reference count *****
146 friend XBT_PUBLIC void intrusive_ptr_add_ref(Actor * actor);
147 friend XBT_PUBLIC void intrusive_ptr_release(Actor * actor);
149 // ***** Actor creation *****
150 /** Retrieve a reference to myself */
151 static ActorPtr self();
153 /** Signal to others that a new actor has been created **/
154 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_creation;
155 /** Signal to others that an actor has been suspended**/
156 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_suspend;
157 /** Signal to others that an actor has been resumed **/
158 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_resume;
159 /** Signal to others that an actor is sleeping **/
160 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_sleep;
161 /** Signal to others that an actor wakes up for a sleep **/
162 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_wake_up;
163 /** Signal to others that an actor is going to migrated to another host**/
164 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_start;
165 /** Signal to others that an actor is has been migrated to another host **/
166 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_end;
167 /** Signal indicating that the given actor is about to disappear */
168 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_destruction;
170 /** Create an actor using a function
172 * If the actor is restarted, the actor has a fresh copy of the function.
174 static ActorPtr create(const char* name, s4u::Host* host, std::function<void()> code);
176 static ActorPtr create(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
177 std::vector<std::string>* args)
179 return create(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
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 actor 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>
192 static ActorPtr create(const char* name, s4u::Host* host, F code, Args... args)
194 return create(name, host, wrap_task(std::move(code), std::move(args)...));
197 // Create actor from function name:
198 static ActorPtr create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
200 // ***** Methods *****
201 /** This actor will be automatically terminated when the last non-daemon actor finishes **/
204 /** Returns whether or not this actor has been daemonized or not **/
205 bool is_daemon() const;
207 /** Retrieves the name of that actor as a C++ string */
208 const simgrid::xbt::string& get_name() const;
209 /** Retrieves the name of that actor as a C string */
210 const char* get_cname() const;
211 /** Retrieves the host on which that actor is running */
212 s4u::Host* get_host();
213 /** Retrieves the PID of that actor
215 * aid_t is an alias for long */
216 aid_t get_pid() const;
217 /** Retrieves the PPID of that actor
219 * aid_t is an alias for long */
220 aid_t get_ppid() const;
222 /** Suspend an actor by suspending the task on which it was waiting for the completion. */
225 /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
230 /** Returns true if the actor is suspended. */
233 /** If set to true, the actor will automatically restart when its host reboots */
234 void set_auto_restart(bool autorestart);
236 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
237 * executed when your actor is killed. You should use them to free the data used by your actor.
239 void on_exit(int_f_pvoid_pvoid_t fun, void* data);
241 /** Sets the time at which that actor should be killed */
242 void set_kill_time(double time);
243 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
244 double get_kill_time();
246 void migrate(Host * new_host);
248 /** Ask the actor to die.
250 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
251 * Being killed is not something that actors can defer or avoid.
253 * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
254 * Still. Please report any bug that you may encounter with a minimal working example.
258 static void kill(aid_t pid);
260 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
261 static ActorPtr by_pid(aid_t pid);
263 /** @brief Wait for the actor to finish.
265 * This blocks the calling actor until the actor on which we call join() is terminated
268 void join(double timeout);
271 /** Ask kindly to all actors to die. Only the issuer will survive. */
272 static void kill_all();
274 /** Returns the internal implementation of this actor */
275 kernel::actor::ActorImpl* get_impl();
277 /** Retrieve the property value (or nullptr if not set) */
278 std::map<std::string, std::string>* get_properties(); // FIXME: do not export the map, but only the keys or something
279 const char* get_property(const char* key);
280 void set_property(const char* key, const char* value);
282 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
283 createActor(const char* name, s4u::Host* host, std::function<void()> code)
285 return create(name, host, code);
287 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
288 createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
289 std::vector<std::string>* args)
291 return create(name, host, code, args);
293 template <class F, class... Args, typename = typename std::result_of<F(Args...)>::type>
294 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
295 createActor(const char* name, s4u::Host* host, F code, Args... args)
297 return create(name, host, code, std::move(args)...);
299 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr
300 createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
302 return create(name, host, function, args);
304 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_daemon()") bool isDaemon() const;
305 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_name()") const simgrid::xbt::string& getName() const
309 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_cname()") const char* getCname() const { return get_cname(); }
310 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_host()") Host* getHost() { return get_host(); }
311 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_pid()") aid_t getPid() { return get_pid(); }
312 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_ppid()") aid_t getPpid() { return get_ppid(); }
313 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::is_suspended()") int isSuspended() { return is_suspended(); }
314 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_auto_restart()") void setAutoRestart(bool a)
318 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::on_exit()") void onExit(int_f_pvoid_pvoid_t fun, void* data)
322 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_kill_time()") void setKillTime(double time) { set_kill_time(time); }
323 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_kill_time()") double getKillTime() { return get_kill_time(); }
324 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::by_pid()") static ActorPtr byPid(aid_t pid) { return by_pid(pid); }
325 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all()") static void killAll() { kill_all(); }
326 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::kill_all() with no parameter") static void killAll(int resetPid)
330 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_impl()") kernel::actor::ActorImpl* getImpl() { return get_impl(); }
331 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_property()") const char* getProperty(const char* key)
333 return get_property(key);
335 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") std::map<std::string, std::string>* getProperties()
337 return get_properties();
339 XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value)
341 set_property(key, value);
346 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
347 namespace this_actor {
349 XBT_PUBLIC bool is_maestro();
351 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
352 XBT_PUBLIC void sleep_for(double duration);
353 XBT_PUBLIC void sleep_until(double timeout);
355 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
357 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
358 this_actor::sleep_for(seconds.count());
361 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
363 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
364 this_actor::sleep_until(timeout_native.time_since_epoch().count());
367 /** Block the actor, computing the given amount of flops */
368 XBT_PUBLIC void execute(double flop);
370 /** Block the actor, computing the given amount of flops at the given priority.
371 * An execution of priority 2 computes twice as fast as an execution at priority 1. */
372 XBT_PUBLIC void execute(double flop, double priority);
374 XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
375 XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
378 XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
379 XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
381 /** @brief Returns the actor ID of the current actor). */
382 XBT_PUBLIC aid_t get_pid();
384 /** @brief Returns the ancestor's actor ID of the current actor. */
385 XBT_PUBLIC aid_t get_ppid();
387 /** @brief Returns the name of the current actor. */
388 XBT_PUBLIC std::string get_name();
389 /** @brief Returns the name of the current actor as a C string. */
390 XBT_PUBLIC const char* get_cname();
392 /** @brief Returns the name of the host on which the actor is running. */
393 XBT_PUBLIC Host* get_host();
395 /** @brief Suspend the actor. */
396 XBT_PUBLIC void suspend();
398 /** @brief yield the actor. */
399 XBT_PUBLIC void yield();
401 /** @brief Resume the actor. */
402 XBT_PUBLIC void resume();
404 XBT_PUBLIC bool is_suspended();
406 /** @brief kill the actor. */
407 XBT_PUBLIC void kill();
409 /** @brief Add a function to the list of "on_exit" functions. */
410 XBT_PUBLIC void on_exit(int_f_pvoid_pvoid_t fun, void* data);
412 /** @brief Migrate the actor to a new host. */
413 XBT_PUBLIC void migrate(Host* new_host);
415 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_name()") XBT_PUBLIC std::string getName();
416 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_cname()") XBT_PUBLIC const char* getCname();
417 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_maestro()") XBT_PUBLIC bool isMaestro();
418 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_pid()") XBT_PUBLIC aid_t getPid();
419 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid();
420 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost();
421 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended();
422 XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC
423 void onExit(int_f_pvoid_pvoid_t fun, void* data);
428 }} // namespace simgrid::s4u
431 #endif /* SIMGRID_S4U_ACTOR_HPP */