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>
23 #include <simgrid/chrono.hpp>
24 #include <simgrid/s4u/forward.hpp>
31 * An actor is an independent stream of execution in your distributed application.
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.
38 * An actor is located on a (simulated) host, but it can interact
39 * with the whole simulated platform.
41 * The s4u::Actor API is strongly inspired from the C++11 threads.
42 * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
43 * of this standard</a> may help to understand the philosophy of the S4U
46 * @section s4u_actor_def Defining the skeleton of an Actor
48 * As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
49 * standard</a>, you can declare the code of your actor either as a
50 * pure function or as an object. It is very simple with functions:
53 * #include "s4u/actor.hpp"
55 * // Declare the code of your worker
57 * printf("Hello s4u");
58 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
61 * // From your main or from another actor, create your actor on the host Jupiter
62 * // The following line actually creates a new actor, even if there is no "new".
63 * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
66 * But some people prefer to encapsulate their actors in classes and
67 * objects to save the actor state in a cleanly dedicated location.
68 * The syntax is slightly more complicated, but not much.
71 * #include "s4u/actor.hpp"
73 * // Declare the class representing your actors
76 * void operator()() { // Two pairs of () because this defines the method called ()
77 * printf("Hello s4u");
78 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
82 * // From your main or from another actor, create your actor. Note the () after Worker
83 * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
86 * @section s4u_actor_flesh Fleshing your actor
88 * The body of your actor can use the functions of the
89 * simgrid::s4u::this_actor namespace to interact with the world.
90 * This namespace contains the methods to start new activities
91 * (executions, communications, etc), and to get informations about
92 * the currently running thread (its location, etc).
94 * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
97 * @section s4u_actor_deploy Using a deployment file
99 * @warning This is currently not working with S4U. Sorry about that.
101 * The best practice is to use an external deployment file as
102 * follows, because it makes it easier to test your application in
103 * differing settings. Load this file with
104 * s4u::Engine::loadDeployment() before the simulation starts.
105 * Refer to the @ref deployment section for more information.
108 * <?xml version='1.0'?>
109 * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
110 * <platform version="4">
112 * <!-- Start an actor called 'master' on the host called 'Tremblay' -->
113 * <actor host="Tremblay" function="master">
114 * <!-- Here come the parameter that you want to feed to this instance of master -->
115 * <argument value="20"/> <!-- argv[1] -->
116 * <argument value="50000000"/> <!-- argv[2] -->
117 * <argument value="1000000"/> <!-- argv[3] -->
118 * <argument value="5"/> <!-- argv[4] -->
121 * <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
122 * <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
130 /** @brief Simulation Agent */
131 XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
135 friend simgrid::simix::ActorImpl;
136 friend simgrid::kernel::activity::MailboxImpl;
137 simix::ActorImpl* pimpl_ = nullptr;
139 /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
140 template<class F, class... Args>
141 static std::function<void()> wrap_task(F f, Args... args)
143 typedef decltype(f(std::move(args)...)) R;
144 auto task = std::make_shared<simgrid::xbt::Task<R()>>(
145 simgrid::xbt::makeTask(std::move(f), std::move(args)...));
146 return [task] { (*task)(); };
149 explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
153 // ***** No copy *****
154 Actor(Actor const&) = delete;
155 Actor& operator=(Actor const&) = delete;
157 // ***** Reference count *****
158 friend XBT_PUBLIC(void) intrusive_ptr_add_ref(Actor * actor);
159 friend XBT_PUBLIC(void) intrusive_ptr_release(Actor * actor);
161 // ***** Actor creation *****
162 /** Retrieve a reference to myself */
163 static ActorPtr self();
165 /** Create an actor using a function
167 * If the actor is restarted, the actor has a fresh copy of the function.
169 static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
171 static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
172 std::vector<std::string>* args)
174 return createActor(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
177 /** Create an actor using code
179 * Using this constructor, move-only type can be used. The consequence is
180 * that we cannot copy the value and restart the actor in its initial
181 * state. In order to use auto-restart, an explicit `function` must be passed
184 template<class F, class... Args,
185 // This constructor is enabled only if the call code(args...) is valid:
186 typename = typename std::result_of<F(Args...)>::type
188 static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args)
190 return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
193 // Create actor from function name:
195 static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
197 // ***** Methods *****
198 /** This actor will be automatically terminated when the last non-daemon actor finishes **/
201 /** Retrieves the name of that actor as a C++ string */
202 const simgrid::xbt::string& getName() const;
203 /** Retrieves the name of that actor as a C string */
204 const char* getCname() const;
205 /** Retrieves the host on which that actor is running */
206 s4u::Host* getHost();
207 /** Retrieves the PID of that actor
209 * actor_id_t is an alias for unsigned long */
211 /** Retrieves the PPID of that actor
213 * actor_id_t is an alias for unsigned long */
216 /** Suspend an actor by suspending the task on which it was waiting for the completion. */
219 /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
224 /** Returns true if the actor is suspended. */
227 /** If set to true, the actor will automatically restart when its host reboots */
228 void setAutoRestart(bool autorestart);
230 /** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
231 * executed when your actor is killed. You should use them to free the data used by your actor.
233 void onExit(int_f_pvoid_pvoid_t fun, void* data);
235 /** Sets the time at which that actor should be killed */
236 void setKillTime(double time);
237 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
238 double getKillTime();
240 void migrate(Host * new_host);
242 /** Ask the actor to die.
244 * Any blocking activity will be canceled, and it will be rescheduled to free its memory.
245 * Being killed is not something that actors can defer or avoid.
247 * SimGrid still have sometimes issues when you kill actors that are currently communicating and such.
248 * Still. Please report any bug that you may encounter with a minimal working example.
252 static void kill(aid_t pid);
254 /** Retrieves the actor that have the given PID (or nullptr if not existing) */
255 static ActorPtr byPid(aid_t pid);
257 /** @brief Wait for the actor to finish.
259 * This blocks the calling actor until the actor on which we call join() is terminated
262 void join(double timeout);
264 // Static methods on all actors:
266 /** Ask kindly to all actors to die. Only the issuer will survive. */
267 static void killAll();
268 static void killAll(int resetPid);
270 /** Returns the internal implementation of this actor */
271 simix::ActorImpl* getImpl();
273 /** Retrieve the property value (or nullptr if not set) */
274 std::map<std::string, std::string>* getProperties();
275 const char* getProperty(const char* key);
276 void setProperty(const char* key, const char* value);
281 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
282 namespace this_actor {
284 XBT_PUBLIC(bool) isMaestro();
286 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
287 XBT_PUBLIC(void) sleep_for(double duration);
288 XBT_PUBLIC(void) sleep_until(double timeout);
290 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
292 auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
293 this_actor::sleep_for(seconds.count());
296 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
298 auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
299 this_actor::sleep_until(timeout_native.time_since_epoch().count());
302 XBT_ATTRIB_DEPRECATED_v320("Use sleep_for(): v3.20 will turn this warning into an error.") inline void sleep(
305 return sleep_for(duration);
308 /** Block the actor, computing the given amount of flops */
309 XBT_PUBLIC(void) execute(double flop);
311 /** Block the actor, computing the given amount of flops at the given priority.
312 * An execution of priority 2 computes twice as fast as an execution at priority 1. */
313 XBT_PUBLIC(void) execute(double flop, double priority);
315 XBT_PUBLIC(void) parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
317 parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout);
319 XBT_PUBLIC(ExecPtr) exec_init(double flops_amounts);
320 XBT_PUBLIC(ExecPtr) exec_async(double flops_amounts);
322 /** Block the actor until it gets a message from the given mailbox.
324 * See \ref Comm for the full communication API (including non blocking communications).
326 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*)
327 recv(MailboxPtr chan);
328 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*)
329 recv(MailboxPtr chan, double timeout);
330 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr)
331 irecv(MailboxPtr chan, void** data);
333 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
335 * See \ref Comm for the full communication API (including non blocking communications).
337 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void)
338 send(MailboxPtr chan, void* payload, double simulatedSize);
339 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void)
340 send(MailboxPtr chan, void* payload, double simulatedSize, double timeout);
342 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr)
343 isend(MailboxPtr chan, void* payload, double simulatedSize);
345 /** @brief Returns the actor ID of the current actor). */
346 XBT_PUBLIC(aid_t) getPid();
348 /** @brief Returns the ancestor's actor ID of the current actor. */
349 XBT_PUBLIC(aid_t) getPpid();
351 /** @brief Returns the name of the current actor. */
352 XBT_PUBLIC(std::string) getName();
354 /** @brief Returns the name of the current actor as a C string. */
355 XBT_PUBLIC(const char*) getCname();
357 /** @brief Returns the name of the host on which the actor is running. */
358 XBT_PUBLIC(Host*) getHost();
360 /** @brief Suspend the actor. */
361 XBT_PUBLIC(void) suspend();
363 /** @brief yield the actor. */
364 XBT_PUBLIC(void) yield();
366 /** @brief Resume the actor. */
367 XBT_PUBLIC(void) resume();
369 XBT_PUBLIC(bool) isSuspended();
371 /** @brief kill the actor. */
372 XBT_PUBLIC(void) kill();
374 /** @brief Add a function to the list of "on_exit" functions. */
375 XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data);
377 /** @brief Migrate the actor to a new host. */
378 XBT_PUBLIC(void) migrate(Host* new_host);
383 }} // namespace simgrid::s4u
386 #endif /* SIMGRID_S4U_ACTOR_HPP */