1 /* Copyright (c) 2006-2017. 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
15 #include <type_traits>
19 #include <xbt/Extendable.hpp>
20 #include <xbt/functional.hpp>
21 #include <xbt/string.hpp>
22 #include <xbt/signal.hpp>
24 #include <simgrid/chrono.hpp>
25 #include <simgrid/s4u/forward.hpp>
32 * An actor is an independent stream of execution in your distributed application.
34 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
35 * This is the only component in SimGrid that actually does something on its own, executing its own code.
36 * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and
37 * schedule these activities.
39 * An actor is located on a (simulated) host, but it can interact
40 * with the whole simulated platform.
42 * The s4u::Actor API is strongly inspired from the C++11 threads.
43 * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
44 * of this standard</a> may help to understand the philosophy of the S4U
47 * @section s4u_actor_def Defining the skeleton of an Actor
49 * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
50 * standard</a>, you can declare the code of your actor either as a
51 * pure function or as an object. It is very simple with functions:
54 * #include "s4u/actor.hpp"
56 * // Declare the code of your worker
58 * printf("Hello s4u");
59 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
62 * // From your main or from another actor, create your actor on the host Jupiter
63 * // The following line actually creates a new actor, even if there is no "new".
64 * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
67 * But some people prefer to encapsulate their actors in classes and
68 * objects to save the actor state in a cleanly dedicated location.
69 * The syntax is slightly more complicated, but not much.
72 * #include "s4u/actor.hpp"
74 * // Declare the class representing your actors
77 * void operator()() { // Two pairs of () because this defines the method called ()
78 * printf("Hello s4u");
79 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
83 * // From your main or from another actor, create your actor. Note the () after Worker
84 * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
87 * @section s4u_actor_flesh Fleshing your actor
89 * The body of your actor can use the functions of the
90 * simgrid::s4u::this_actor namespace to interact with the world.
91 * This namespace contains the methods to start new activities
92 * (executions, communications, etc), and to get informations about
93 * the currently running thread (its location, etc).
95 * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
98 * @section s4u_actor_deploy Using a deployment file
100 * @warning This is currently not working with S4U. Sorry about that.
102 * The best practice is to use an external deployment file as
103 * follows, because it makes it easier to test your application in
104 * differing settings. Load this file with
105 * s4u::Engine::loadDeployment() before the simulation starts.
106 * Refer to the @ref deployment section for more information.
109 * <?xml version='1.0'?>
110 * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
111 * <platform version="4">
113 * <!-- Start an actor called 'master' on the host called 'Tremblay' -->
114 * <actor host="Tremblay" function="master">
115 * <!-- Here come the parameter that you want to feed to this instance of master -->
116 * <argument value="20"/> <!-- argv[1] -->
117 * <argument value="50000000"/> <!-- argv[2] -->
118 * <argument value="1000000"/> <!-- argv[3] -->
119 * <argument value="5"/> <!-- argv[4] -->
122 * <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
123 * <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
131 /** @brief Simulation Agent */
132 XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
136 friend simgrid::simix::ActorImpl;
137 friend simgrid::kernel::activity::MailboxImpl;
138 simix::ActorImpl* pimpl_ = nullptr;
140 /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
141 template<class F, class... Args>
142 static std::function<void()> wrap_task(F f, Args... args)
144 typedef decltype(f(std::move(args)...)) R;
145 auto task = std::make_shared<simgrid::xbt::Task<R()>>(
146 simgrid::xbt::makeTask(std::move(f), std::move(args)...));
147 return [task] { (*task)(); };
150 explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
154 // ***** No copy *****
155 Actor(Actor const&) = delete;
156 Actor& operator=(Actor const&) = delete;
158 // ***** Reference count *****
159 friend XBT_PUBLIC(void) intrusive_ptr_add_ref(Actor * actor);
160 friend XBT_PUBLIC(void) intrusive_ptr_release(Actor * actor);
162 // ***** Actor creation *****
163 /** Retrieve a reference to myself */
164 static ActorPtr self();
166 /** Signal to others that a new actor has been created **/
167 static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> onCreation;
169 /** Create an actor using a function
171 * If the actor is restarted, the actor has a fresh copy of the function.
173 static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
175 static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
176 std::vector<std::string>* args)
178 return createActor(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
181 /** Create an actor using code
183 * Using this constructor, move-only type can be used. The consequence is
184 * that we cannot copy the value and restart the actor in its initial
185 * state. In order to use auto-restart, an explicit `function` must be passed
188 template<class F, class... Args,
189 // This constructor is enabled only if the call code(args...) is valid:
190 typename = typename std::result_of<F(Args...)>::type
192 static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args)
194 return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
197 // Create actor from function name:
199 static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
201 // ***** Methods *****
202 /** This actor will be automatically terminated when the last non-daemon actor finishes **/
205 /** Retrieves the name of that actor as a C++ string */
206 const simgrid::xbt::string& getName() const;
207 /** Retrieves the name of that actor as a C string */
208 const char* getCname() const;
209 /** Retrieves the host on which that actor is running */
210 s4u::Host* getHost();
211 /** Retrieves the PID of that actor
213 * actor_id_t is an alias for unsigned long */
215 /** Retrieves the PPID of that actor
217 * actor_id_t is an alias for unsigned long */
220 /** Suspend an actor by suspending the task on which it was waiting for the completion. */
223 /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
228 /** Returns true if the actor is suspended. */
231 /** If set to true, the actor will automatically restart when its host reboots */
232 void setAutoRestart(bool autorestart);
234 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
235 * executed when your actor is killed. You should use them to free the data used by your actor.
237 void onExit(int_f_pvoid_pvoid_t fun, void* data);
239 /** Sets the time at which that actor should be killed */
240 void setKillTime(double time);
241 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
242 double getKillTime();
244 void migrate(Host * new_host);
246 /** Ask the actor to die.
248 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
249 * Being killed is not something that actors can defer or avoid.
251 * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
252 * Still. Please report any bug that you may encounter with a minimal working example.
256 static void kill(aid_t pid);
258 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
259 static ActorPtr byPid(aid_t pid);
261 /** @brief Wait for the actor to finish.
263 * This blocks the calling actor until the actor on which we call join() is terminated
266 void join(double timeout);
268 // Static methods on all actors:
270 /** Ask kindly to all actors to die. Only the issuer will survive. */
271 static void killAll();
272 static void killAll(int resetPid);
274 /** Returns the internal implementation of this actor */
275 simix::ActorImpl* getImpl();
277 /** Retrieve the property value (or nullptr if not set) */
278 std::map<std::string, std::string>* getProperties();
279 const char* getProperty(const char* key);
280 void setProperty(const char* key, const char* value);
285 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
286 namespace this_actor {
288 XBT_PUBLIC(bool) isMaestro();
290 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
291 XBT_PUBLIC(void) sleep_for(double duration);
292 XBT_PUBLIC(void) sleep_until(double timeout);
294 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
296 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
297 this_actor::sleep_for(seconds.count());
300 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
302 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
303 this_actor::sleep_until(timeout_native.time_since_epoch().count());
306 XBT_ATTRIB_DEPRECATED_v320("Use sleep_for(): v3.20 will turn this warning into an error.") inline void sleep(
309 return sleep_for(duration);
312 /** Block the actor, computing the given amount of flops */
313 XBT_PUBLIC(void) execute(double flop);
315 /** Block the actor, computing the given amount of flops at the given priority.
316 * An execution of priority 2 computes twice as fast as an execution at priority 1. */
317 XBT_PUBLIC(void) execute(double flop, double priority);
319 XBT_PUBLIC(void) parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
321 parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout);
323 XBT_PUBLIC(ExecPtr) exec_init(double flops_amounts);
324 XBT_PUBLIC(ExecPtr) exec_async(double flops_amounts);
326 /** Block the actor until it gets a message from the given mailbox.
328 * See \ref Comm for the full communication API (including non blocking communications).
330 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*)
331 recv(MailboxPtr chan);
332 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*)
333 recv(MailboxPtr chan, double timeout);
334 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr)
335 irecv(MailboxPtr chan, void** data);
337 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
339 * See \ref Comm for the full communication API (including non blocking communications).
341 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void)
342 send(MailboxPtr chan, void* payload, double simulatedSize);
343 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void)
344 send(MailboxPtr chan, void* payload, double simulatedSize, double timeout);
346 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr)
347 isend(MailboxPtr chan, void* payload, double simulatedSize);
349 /** @brief Returns the actor ID of the current actor). */
350 XBT_PUBLIC(aid_t) getPid();
352 /** @brief Returns the ancestor's actor ID of the current actor. */
353 XBT_PUBLIC(aid_t) getPpid();
355 /** @brief Returns the name of the current actor. */
356 XBT_PUBLIC(std::string) getName();
358 /** @brief Returns the name of the current actor as a C string. */
359 XBT_PUBLIC(const char*) getCname();
361 /** @brief Returns the name of the host on which the actor is running. */
362 XBT_PUBLIC(Host*) getHost();
364 /** @brief Suspend the actor. */
365 XBT_PUBLIC(void) suspend();
367 /** @brief yield the actor. */
368 XBT_PUBLIC(void) yield();
370 /** @brief Resume the actor. */
371 XBT_PUBLIC(void) resume();
373 XBT_PUBLIC(bool) isSuspended();
375 /** @brief kill the actor. */
376 XBT_PUBLIC(void) kill();
378 /** @brief Add a function to the list of "on_exit" functions. */
379 XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data);
381 /** @brief Migrate the actor to a new host. */
382 XBT_PUBLIC(void) migrate(Host* new_host);
387 }} // namespace simgrid::s4u
390 #endif /* SIMGRID_S4U_ACTOR_HPP */