1 /* Copyright (c) 2006-2016. 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
14 #include <type_traits>
19 #include <xbt/functional.hpp>
21 #include <simgrid/simix.h>
22 #include <simgrid/s4u/forward.hpp>
29 * An actor is an independent stream of execution in your distributed application.
31 * You can think of an actor as a process in your distributed application, or as a thread in a multithreaded program.
32 * This is the only component in SimGrid that actually does something on its own, executing its own code.
33 * A resource will not get used if you don't schedule activities on them. This is the code of Actors that create and schedule these activities.
35 * An actor is located on a (simulated) host, but it can interact
36 * with the whole simulated platform.
38 * The s4u::Actor API is strongly inspired from the C++11 threads.
39 * The <a href="http://en.cppreference.com/w/cpp/thread">documentation
40 * of this standard</a> may help to understand the philosophy of the S4U
43 * @section s4u_actor_def Defining the skeleton of an Actor
45 * %As in the <a href="http://en.cppreference.com/w/cpp/thread">C++11
46 * standard</a>, you can declare the code of your actor either as a
47 * pure function or as an object. It is very simple with functions:
50 * #include "s4u/actor.hpp"
52 * // Declare the code of your worker
54 * printf("Hello s4u");
55 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
58 * // From your main or from another actor, create your actor on the host Jupiter
59 * // The following line actually creates a new actor, even if there is no "new".
60 * Actor("Alice", simgrid::s4u::Host::by_name("Jupiter"), worker);
63 * But some people prefer to encapsulate their actors in classes and
64 * objects to save the actor state in a cleanly dedicated location.
65 * The syntax is slightly more complicated, but not much.
68 * #include "s4u/actor.hpp"
70 * // Declare the class representing your actors
73 * void operator()() { // Two pairs of () because this defines the method called ()
74 * printf("Hello s4u");
75 * simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
79 * // From your main or from another actor, create your actor. Note the () after Worker
80 * Actor("Bob", simgrid::s4u::Host::by_name("Jupiter"), Worker());
83 * @section s4u_actor_flesh Fleshing your actor
85 * The body of your actor can use the functions of the
86 * simgrid::s4u::this_actor namespace to interact with the world.
87 * This namespace contains the methods to start new activities
88 * (executions, communications, etc), and to get informations about
89 * the currently running thread (its location, etc).
91 * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
94 * @section s4u_actor_deploy Using a deployment file
96 * @warning This is currently not working with S4U. Sorry about that.
98 * The best practice is to use an external deployment file as
99 * follows, because it makes it easier to test your application in
100 * differing settings. Load this file with
101 * s4u::Engine::loadDeployment() before the simulation starts.
102 * Refer to the @ref deployment section for more information.
105 * <?xml version='1.0'?>
106 * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
107 * <platform version="4">
109 * <!-- Start a process called 'master' on the host called 'Tremblay' -->
110 * <process host="Tremblay" function="master">
111 * <!-- Here come the parameter that you want to feed to this instance of master -->
112 * <argument value="20"/> <!-- argv[1] -->
113 * <argument value="50000000"/> <!-- argv[2] -->
114 * <argument value="1000000"/> <!-- argv[3] -->
115 * <argument value="5"/> <!-- argv[4] -->
118 * <!-- Start a process called 'worker' on the host called 'Jupiter' -->
119 * <process host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
127 /** @brief Simulation Agent (see \ref s4u_actor)*/
128 XBT_PUBLIC_CLASS Actor {
132 /** Wrap a (possibly non-copyable) single-use task into a `std::function` */
133 template<class F, class... Args>
134 static std::function<void()> wrap_task(F f, Args... args)
136 typedef decltype(f(std::move(args)...)) R;
137 auto task = std::make_shared<simgrid::xbt::Task<R()>>(
138 simgrid::xbt::makeTask(std::move(f), std::move(args)...));
144 Actor() : pimpl_(nullptr) {}
145 Actor(smx_process_t smx_proc) :
146 pimpl_(SIMIX_process_ref(smx_proc)) {}
149 SIMIX_process_unref(pimpl_);
152 // Copy+move (with the copy-and-swap idiom):
153 Actor(Actor const& actor) : pimpl_(SIMIX_process_ref(actor.pimpl_)) {}
154 friend void swap(Actor& first, Actor& second)
157 swap(first.pimpl_, second.pimpl_);
159 Actor& operator=(Actor actor)
164 Actor(Actor&& actor) : pimpl_(nullptr)
169 /** Create an actor using a function
171 * If the actor is restarted, the actor has a fresh copy of the function.
173 Actor(const char* name, s4u::Host *host, double killTime, std::function<void()> code);
175 Actor(const char* name, s4u::Host *host, std::function<void()> code)
176 : Actor(name, host, -1.0, std::move(code)) {};
178 /** Create an actor using code
180 * Using this constructor, move-only type can be used. The consequence is
181 * that we cannot copy the value and restart the process in its initial
182 * state. In order to use auto-restart, an explicit `function` must be passed
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
189 Actor(const char* name, s4u::Host *host, F code, Args... args) :
190 Actor(name, host, wrap_task(std::move(code), std::move(args)...))
193 // Create actor from function name:
195 Actor(const char* name, s4u::Host *host, double killTime,
196 const char* function, std::vector<std::string> args);
198 Actor(const char* name, s4u::Host *host, const char* function,
199 std::vector<std::string> args)
200 : Actor(name, host, -1.0, function, std::move(args)) {}
202 /** Retrieves the actor that have the given PID (or NULL if not existing) */
203 //static Actor *byPid(int pid); not implemented
205 /** Retrieves the name of that actor */
206 const char* getName();
207 /** Retrieves the host on which that actor is running */
208 s4u::Host *getHost();
209 /** Retrieves the PID of that actor */
212 /** If set to true, the actor will automatically restart when its host reboots */
213 void setAutoRestart(bool autorestart);
214 /** Sets the time at which that actor should be killed */
215 void setKillTime(double time);
216 /** Retrieves the time at which that actor will be killed (or -1 if not set) */
217 double getKillTime();
219 /** Ask the actor to die.
221 * It will only notice your request when doing a simcall next time (a communication or similar).
222 * SimGrid sometimes have issues when you kill actors that are currently communicating and such. We are working on it to fix the issues.
226 static void kill(int pid);
227 static Actor forPid(int pid);
230 * Wait for the actor to finish.
234 // Static methods on all actors:
236 /** Ask kindly to all actors to die. Only the issuer will survive. */
237 static void killAll();
239 bool valid() const { return pimpl_ != nullptr; }
241 smx_process_t getInferior();
243 smx_process_t pimpl_ = nullptr;
247 * @brief Static methods working on the current actor (see @ref s4u::Actor) */
248 namespace this_actor {
250 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
251 XBT_PUBLIC(void) sleep(double duration);
253 /** Block the actor, computing the given amount of flops */
254 XBT_PUBLIC(e_smx_state_t) execute(double flop);
256 /** Block the actor until it gets a message from the given mailbox.
258 * See \ref Comm for the full communication API (including non blocking communications).
260 XBT_PUBLIC(void*) recv(Mailbox &chan);
262 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
264 * See \ref Comm for the full communication API (including non blocking communications).
266 XBT_PUBLIC(void) send(Mailbox &chan, void*payload, size_t simulatedSize);
269 * Return the PID of the current actor.
271 XBT_PUBLIC(int) getPid();
277 }} // namespace simgrid::s4u
280 #endif /* SIMGRID_S4U_ACTOR_HPP */