include/simgrid/s4u/Actor.hpp

   1 /* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #ifndef SIMGRID_S4U_ACTOR_HPP
   7 #define SIMGRID_S4U_ACTOR_HPP
   8
   9 #include <atomic>
  10 #include <chrono>
  11 #include <functional>
  12 #include <memory>
  13 #include <stdexcept>
  14 #include <string>
  15 #include <type_traits>
  16 #include <utility>
  17 #include <vector>
  18
  19 #include <xbt/Extendable.hpp>
  20 #include <xbt/functional.hpp>
  21 #include <xbt/string.hpp>
  22 #include <xbt/signal.hpp>
  23
  24 #include <simgrid/chrono.hpp>
  25 #include <simgrid/s4u/forward.hpp>
  26
  27 namespace simgrid {
  28 namespace s4u {
  29
  30 /** @ingroup s4u_api
  31  *
  32  * An actor is an independent stream of execution in your distributed application.
  33  *
  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.
  38  *
  39  * An actor is located on a (simulated) host, but it can interact
  40  * with the whole simulated platform.
  41  *
  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
  45  * Actors.
  46  *
  47  * @section s4u_actor_def Defining the skeleton of an Actor
  48  *
  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:
  52  *
  53  * @code{.cpp}
  54  * #include "s4u/actor.hpp"
  55  *
  56  * // Declare the code of your worker
  57  * void worker() {
  58  *   printf("Hello s4u");
  59  *   simgrid::s4u::this_actor::execute(5*1024*1024); // Get the worker executing a task of 5 MFlops
  60  * };
  61  *
  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);
  65  * @endcode
  66  *
  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.
  70  *
  71  * @code{.cpp}
  72  * #include "s4u/actor.hpp"
  73  *
  74  * // Declare the class representing your actors
  75  * class Worker {
  76  * public:
  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
  80  *   }
  81  * };
  82  *
  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());
  85  * @endcode
  86  *
  87  * @section s4u_actor_flesh Fleshing your actor
  88  *
  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).
  94  *
  95  * Please refer to the @link simgrid::s4u::this_actor full API @endlink.
  96  *
  97  *
  98  * @section s4u_actor_deploy Using a deployment file
  99  *
 100  * @warning This is currently not working with S4U. Sorry about that.
 101  *
 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.
 107  *
 108  * @code{.xml}
 109  * <?xml version='1.0'?>
 110  * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
 111  * <platform version="4">
 112  *
 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] -->
 120  *   </actor>
 121  *
 122  *   <!-- Start an actor called 'worker' on the host called 'Jupiter' -->
 123  *   <actor host="Jupiter" function="worker"/> <!-- Don't provide any parameter ->>
 124  *
 125  * </platform>
 126  * @endcode
 127  *
 128  *  @{
 129  */
 130
 131 /** @brief Simulation Agent */
 132 XBT_PUBLIC_CLASS Actor : public simgrid::xbt::Extendable<Actor>
 133 {
 134   friend Exec;
 135   friend Mailbox;
 136   friend simgrid::simix::ActorImpl;
 137   friend simgrid::kernel::activity::MailboxImpl;
 138   simix::ActorImpl* pimpl_ = nullptr;
 139
 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)
 143   {
 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)(); };
 148   }
 149
 150   explicit Actor(smx_actor_t pimpl) : pimpl_(pimpl) {}
 151
 152 public:
 153
 154   // ***** No copy *****
 155   Actor(Actor const&) = delete;
 156   Actor& operator=(Actor const&) = delete;
 157
 158   // ***** Reference count *****
 159   friend XBT_PUBLIC(void) intrusive_ptr_add_ref(Actor * actor);
 160   friend XBT_PUBLIC(void) intrusive_ptr_release(Actor * actor);
 161
 162   // ***** Actor creation *****
 163   /** Retrieve a reference to myself */
 164   static ActorPtr self();
 165
 166   /** Signal to others that a new actor has been created **/
 167   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> onCreation;
 168   /** Signal indicating that the given actor is about to disappear */
 169   static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> onDestruction;
 170
 171   /** Create an actor using a function
 172    *
 173    *  If the actor is restarted, the actor has a fresh copy of the function.
 174    */
 175   static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void()> code);
 176
 177   static ActorPtr createActor(const char* name, s4u::Host* host, std::function<void(std::vector<std::string>*)> code,
 178                               std::vector<std::string>* args)
 179   {
 180     return createActor(name, host, [code](std::vector<std::string>* args) { code(args); }, args);
 181   }
 182
 183   /** Create an actor using code
 184    *
 185    *  Using this constructor, move-only type can be used. The consequence is
 186    *  that we cannot copy the value and restart the actor in its initial
 187    *  state. In order to use auto-restart, an explicit `function` must be passed
 188    *  instead.
 189    */
 190   template<class F, class... Args,
 191     // This constructor is enabled only if the call code(args...) is valid:
 192     typename = typename std::result_of<F(Args...)>::type
 193     >
 194   static ActorPtr createActor(const char* name, s4u::Host *host, F code, Args... args)
 195   {
 196     return createActor(name, host, wrap_task(std::move(code), std::move(args)...));
 197   }
 198
 199   // Create actor from function name:
 200
 201   static ActorPtr createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args);
 202
 203   // ***** Methods *****
 204   /** This actor will be automatically terminated when the last non-daemon actor finishes **/
 205   void daemonize();
 206
 207   /** Retrieves the name of that actor as a C++ string */
 208   const simgrid::xbt::string& getName() const;
 209   /** Retrieves the name of that actor as a C string */
 210   const char* getCname() const;
 211   /** Retrieves the host on which that actor is running */
 212   s4u::Host* getHost();
 213   /** Retrieves the PID of that actor
 214    *
 215    * actor_id_t is an alias for unsigned long */
 216   aid_t getPid();
 217   /** Retrieves the PPID of that actor
 218    *
 219    * actor_id_t is an alias for unsigned long */
 220   aid_t getPpid();
 221
 222   /** Suspend an actor by suspending the task on which it was waiting for the completion. */
 223   void suspend();
 224
 225   /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
 226   void resume();
 227
 228   void yield();
 229
 230   /** Returns true if the actor is suspended. */
 231   int isSuspended();
 232
 233   /** If set to true, the actor will automatically restart when its host reboots */
 234   void setAutoRestart(bool autorestart);
 235
 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.
 238    */
 239   void onExit(int_f_pvoid_pvoid_t fun, void* data);
 240
 241   /** Sets the time at which that actor should be killed */
 242   void setKillTime(double time);
 243   /** Retrieves the time at which that actor will be killed (or -1 if not set) */
 244   double getKillTime();
 245
 246   void migrate(Host * new_host);
 247
 248   /** Ask the actor to die.
 249    *
 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.
 252    *
 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.
 255    */
 256   void kill();
 257
 258   static void kill(aid_t pid);
 259
 260   /** Retrieves the actor that have the given PID (or nullptr if not existing) */
 261   static ActorPtr byPid(aid_t pid);
 262
 263   /** @brief Wait for the actor to finish.
 264    *
 265    * This blocks the calling actor until the actor on which we call join() is terminated
 266    */
 267   void join();
 268   void join(double timeout);
 269
 270   // Static methods on all actors:
 271
 272   /** Ask kindly to all actors to die. Only the issuer will survive. */
 273   static void killAll();
 274   static void killAll(int resetPid);
 275
 276   /** Returns the internal implementation of this actor */
 277   simix::ActorImpl* getImpl();
 278
 279   /** Retrieve the property value (or nullptr if not set) */
 280   std::map<std::string, std::string>* getProperties();
 281   const char* getProperty(const char* key);
 282   void setProperty(const char* key, const char* value);
 283   Actor* restart();
 284 };
 285
 286 /** @ingroup s4u_api
 287  *  @brief Static methods working on the current actor (see @ref s4u::Actor) */
 288 namespace this_actor {
 289
 290 XBT_PUBLIC(bool) isMaestro();
 291
 292 /** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
 293 XBT_PUBLIC(void) sleep_for(double duration);
 294 XBT_PUBLIC(void) sleep_until(double timeout);
 295
 296 template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
 297 {
 298   auto seconds = std::chrono::duration_cast<SimulationClockDuration>(duration);
 299   this_actor::sleep_for(seconds.count());
 300 }
 301
 302 template <class Duration> inline void sleep_until(const SimulationTimePoint<Duration>& timeout_time)
 303 {
 304   auto timeout_native = std::chrono::time_point_cast<SimulationClockDuration>(timeout_time);
 305   this_actor::sleep_until(timeout_native.time_since_epoch().count());
 306 }
 307
 308 XBT_ATTRIB_DEPRECATED_v320("Use sleep_for(): v3.20 will turn this warning into an error.") inline void sleep(
 309     double duration)
 310 {
 311   return sleep_for(duration);
 312 }
 313
 314 /** Block the actor, computing the given amount of flops */
 315 XBT_PUBLIC(void) execute(double flop);
 316
 317 /** Block the actor, computing the given amount of flops at the given priority.
 318  *  An execution of priority 2 computes twice as fast as an execution at priority 1. */
 319 XBT_PUBLIC(void) execute(double flop, double priority);
 320
 321 XBT_PUBLIC(void) parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
 322 XBT_PUBLIC(void)
 323 parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout);
 324
 325 XBT_PUBLIC(ExecPtr) exec_init(double flops_amounts);
 326 XBT_PUBLIC(ExecPtr) exec_async(double flops_amounts);
 327
 328 /** Block the actor until it gets a message from the given mailbox.
 329  *
 330  * See \ref Comm for the full communication API (including non blocking communications).
 331  */
 332 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*)
 333     recv(MailboxPtr chan);
 334 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::get(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void*)
 335     recv(MailboxPtr chan, double timeout);
 336 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::recv_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr)
 337     irecv(MailboxPtr chan, void** data);
 338
 339 /** Block the actor until it delivers a message of the given simulated size to the given mailbox
 340  *
 341  * See \ref Comm for the full communication API (including non blocking communications).
 342 */
 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);
 345 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put(): v3.20 will turn this warning into an error.") XBT_PUBLIC(void)
 346     send(MailboxPtr chan, void* payload, double simulatedSize, double timeout);
 347
 348 XBT_ATTRIB_DEPRECATED_v320("Use Mailbox::put_async(): v3.20 will turn this warning into an error.") XBT_PUBLIC(CommPtr)
 349     isend(MailboxPtr chan, void* payload, double simulatedSize);
 350
 351 /** @brief Returns the actor ID of the current actor). */
 352 XBT_PUBLIC(aid_t) getPid();
 353
 354 /** @brief Returns the ancestor's actor ID of the current actor. */
 355 XBT_PUBLIC(aid_t) getPpid();
 356
 357 /** @brief Returns the name of the current actor. */
 358 XBT_PUBLIC(std::string) getName();
 359
 360 /** @brief Returns the name of the current actor as a C string. */
 361 XBT_PUBLIC(const char*) getCname();
 362
 363 /** @brief Returns the name of the host on which the actor is running. */
 364 XBT_PUBLIC(Host*) getHost();
 365
 366 /** @brief Suspend the actor. */
 367 XBT_PUBLIC(void) suspend();
 368
 369 /** @brief yield the actor. */
 370 XBT_PUBLIC(void) yield();
 371
 372 /** @brief Resume the actor. */
 373 XBT_PUBLIC(void) resume();
 374
 375 XBT_PUBLIC(bool) isSuspended();
 376
 377 /** @brief kill the actor. */
 378 XBT_PUBLIC(void) kill();
 379
 380 /** @brief Add a function to the list of "on_exit" functions. */
 381 XBT_PUBLIC(void) onExit(int_f_pvoid_pvoid_t fun, void* data);
 382
 383 /** @brief Migrate the actor to a new host. */
 384 XBT_PUBLIC(void) migrate(Host* new_host);
 385 }
 386
 387 /** @} */
 388
 389 }} // namespace simgrid::s4u
 390
 391
 392 #endif /* SIMGRID_S4U_ACTOR_HPP */