-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2019. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
*
* @code{.xml}
* <?xml version='1.0'?>
- * <!DOCTYPE platform SYSTEM "http://simgrid.gforge.inria.fr/simgrid/simgrid.dtd">
- * <platform version="4">
+ * <!DOCTYPE platform SYSTEM "https://simgrid.org/simgrid.dtd">
+ * <platform version="4.1">
*
* <!-- Start an actor called 'master' on the host called 'Tremblay' -->
* <actor host="Tremblay" function="master">
static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_start;
/** Signal to others that an actor is has been migrated to another host **/
static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_migration_end;
- /** Signal indicating that the given actor is about to disappear */
+ /** Signal indicating that an actor is about to disappear.
+ * This signal is fired for any dying actor, which is mostly useful when
+ * designing plugins and extensions. If you want to register to the
+ * termination of a given actor, use this_actor::on_exit() instead.*/
static simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> on_destruction;
/** Create an actor from a std::function<void()>
const char* get_cname() const;
/** Retrieves the host on which that actor is running */
s4u::Host* get_host();
- /** Retrieves the PID of that actor
- *
- * aid_t is an alias for long */
+ /** Retrieves the actor ID of that actor */
aid_t get_pid() const;
- /** Retrieves the PPID of that actor
- *
- * aid_t is an alias for long */
+ /** Retrieves the actor ID of that actor's creator */
aid_t get_ppid() const;
- /** Suspend an actor by suspending the task on which it was waiting for the completion. */
+ /** Suspend an actor, that is blocked until resume()ed by another actor */
void suspend();
- /** Resume a suspended actor by resuming the task on which it was waiting for the completion. */
+ /** Resume an actor that was previously suspend()ed */
void resume();
- void yield();
-
/** Returns true if the actor is suspended. */
bool is_suspended();
/** Add a function to the list of "on_exit" functions for the current actor. The on_exit functions are the functions
* executed when your actor is killed. You should use them to free the data used by your actor.
+ *
+ * Please note that functions registered in this signal cannot do any simcall themselves. It means that they cannot
+ * send or receive messages, acquire or release mutexes, nor even modify a host property or something. Not only are
+ * blocking functions forbidden in this setting, but also modifications to the global state.
*/
void on_exit(std::function<void(int, void*)> fun, void* data);
*/
void kill();
- /** Kill an actor from its ID */
- static void kill(aid_t pid);
-
/** Retrieves the actor that have the given PID (or nullptr if not existing) */
static ActorPtr by_pid(aid_t pid);
/** Wait for the actor to finish.
*
- * This blocks the calling actor until the actor on which we call join() is terminated
+ * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
+ * blocked until bob terminates.
*/
void join();
+
+ /** Wait for the actor to finish, or for the timeout to elapse.
+ *
+ * Blocks the calling actor until the joined actor is terminated. If actor alice executes bob.join(), then alice is
+ * blocked until bob terminates.
+ */
void join(double timeout);
Actor* restart();
- /** Ask kindly to all actors to die. Only the issuer will survive. */
+ /** Kill all actors (but the issuer). Being killed is not something that actors can delay or avoid. */
static void kill_all();
/** Returns the internal implementation of this actor */
void set_property(std::string key, std::string value);
#ifndef DOXYGEN
+ XBT_ATTRIB_DEPRECATED_v325("Please use Actor::by_pid(pid).kill() instead") static void kill(aid_t pid);
+
/** @deprecated See Actor::create() */
XBT_ATTRIB_DEPRECATED_v323("Please use Actor::create()") static ActorPtr createActor(
const char* name, s4u::Host* host, std::function<void()> code)
return res;
}
/** @deprecated See Actor::get_properties() */
- XBT_ATTRIB_DEPRECATED_v323("Please use Actor::get_properties()") void setProperty(const char* key, const char* value)
+ XBT_ATTRIB_DEPRECATED_v323("Please use Actor::set_property()") void setProperty(const char* key, const char* value)
{
set_property(key, value);
}
XBT_PUBLIC bool is_maestro();
-/** Block the actor sleeping for that amount of seconds (may throws hostFailure) */
+/** Block the current actor sleeping for that amount of seconds (may throw hostFailure) */
XBT_PUBLIC void sleep_for(double duration);
+/** Block the current actor sleeping until the specified timestamp (may throw hostFailure) */
XBT_PUBLIC void sleep_until(double timeout);
template <class Rep, class Period> inline void sleep_for(std::chrono::duration<Rep, Period> duration)
this_actor::sleep_until(timeout_native.time_since_epoch().count());
}
-/** Block the actor, computing the given amount of flops */
+/** Block the current actor, computing the given amount of flops */
XBT_PUBLIC void execute(double flop);
-/** Block the actor, computing the given amount of flops at the given priority.
+/** Block the current actor, computing the given amount of flops at the given priority.
* An execution of priority 2 computes twice as fast as an execution at priority 1. */
XBT_PUBLIC void execute(double flop, double priority);
-XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount);
-XBT_PUBLIC void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount,
- double timeout);
+/**
+ * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
+ */
+
+/** Block the current actor until the built parallel execution terminates
+ *
+ * \rst
+ * .. _API_s4u_parallel_execute:
+ *
+ * **Example of use:** `examples/s4u/exec-ptask/s4u-exec-ptask.cpp
+ * <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-ptask/s4u-exec-ptask.cpp>`_
+ *
+ * Parallel executions convenient abstractions of parallel computational kernels that span over several machines,
+ * such as a PDGEM and the other ScaLAPACK routines. If you are interested in the effects of such parallel kernel
+ * on the platform (e.g. to schedule them wisely), there is no need to model them in all details of their internal
+ * execution and communications. It is much more convenient to model them as a single execution activity that spans
+ * over several hosts. This is exactly what s4u's Parallel Executions are.
+ *
+ * To build such an object, you need to provide a list of hosts that are involved in the parallel kernel (the
+ * actor's own host may or may not be in this list) and specify the amount of computations that should be done by
+ * each host, using a vector of flops amount. Then, you should specify the amount of data exchanged between each
+ * hosts during the parallel kernel. For that, a matrix of values is expected.
+ *
+ * It is OK to build a parallel execution without any computation and/or without any communication.
+ * Just pass an empty vector to the corresponding parameter.
+ *
+ * For example, if your list of hosts is ``[host0, host1]``, passing a vector ``[1000, 2000]`` as a `flops_amount`
+ * vector means that `host0` should compute 1000 flops while `host1` will compute 2000 flops. A matrix of
+ * communications' sizes of ``[0, 1, 2, 3]`` specifies the following data exchanges:
+ *
+ * +-----------+-------+------+
+ * |from \\ to | host0 | host1|
+ * +===========+=======+======+
+ * |host0 | 0 | 1 |
+ * +-----------+-------+------+
+ * |host1 | 2 | 3 |
+ * +-----------+-------+------+
+ *
+ * - From host0 to host0: 0 bytes are exchanged
+ * - From host0 to host1: 1 byte is exchanged
+ * - From host1 to host0: 2 bytes are exchanged
+ * - From host1 to host1: 3 bytes are exchanged
+ *
+ * In a parallel execution, all parts (all executions on each hosts, all communications) progress exactly at the
+ * same pace, so they all terminate at the exact same pace. If one part is slow because of a slow resource or
+ * because of contention, this slows down the parallel execution as a whole.
+ *
+ * These objects are somewhat surprising from a modeling point of view. For example, the unit of their speed is
+ * somewhere between flop/sec and byte/sec. Arbitrary parallel executions will simply not work with the usual platform
+ * models, and you must :ref:`use the ptask_L07 host model <options_model_select>` for that. Note that you can mix
+ * regular executions and communications with parallel executions, provided that the host model is ptask_L07.
+ *
+ * \endrst
+ */
+XBT_PUBLIC void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
+ std::vector<double> bytes_amounts);
+
+/** \rst
+ * Block the current actor until the built :ref:`parallel execution <API_s4u_parallel_execute>` completes, or until the
+ * timeout. \endrst
+ */
+XBT_PUBLIC void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
+ std::vector<double> bytes_amounts, double timeout);
+
+#ifndef DOXYGEN
+XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
+ void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount);
+XBT_ATTRIB_DEPRECATED_v325("Please use std::vectors as parameters") XBT_PUBLIC
+ void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount,
+ double timeout);
+#endif
XBT_PUBLIC ExecPtr exec_init(double flops_amounts);
XBT_PUBLIC ExecPtr exec_async(double flops_amounts);
-/** @brief Returns the actor ID of the current actor). */
+/** @brief Returns the actor ID of the current actor. */
XBT_PUBLIC aid_t get_pid();
/** @brief Returns the ancestor's actor ID of the current actor. */
/** @brief Returns the name of the current actor as a C string. */
XBT_PUBLIC const char* get_cname();
-/** @brief Returns the name of the host on which the actor is running. */
+/** @brief Returns the name of the host on which the curret actor is running. */
XBT_PUBLIC Host* get_host();
-/** @brief Suspend the actor. */
+/** @brief Suspend the current actor, that is blocked until resume()ed by another actor. */
XBT_PUBLIC void suspend();
-/** @brief yield the actor. */
+/** @brief Yield the current actor. */
XBT_PUBLIC void yield();
-/** @brief Resume the actor. */
+/** @brief Resume the current actor, that was suspend()ed previously. */
XBT_PUBLIC void resume();
-XBT_PUBLIC bool is_suspended();
-
-/** @brief kill the actor. */
+/** @brief kill the current actor. */
XBT_PUBLIC void exit();
-/** @brief Add a function to the list of "on_exit" functions. */
+/** @brief Add a function to the list of "on_exit" functions of the current actor. */
XBT_PUBLIC void on_exit(std::function<void(int, void*)> fun, void* data);
-/** @brief Migrate the actor to a new host. */
+/** @brief Migrate the current actor to a new host. */
XBT_PUBLIC void migrate(Host* new_host);
/** @} */
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_ppid()") XBT_PUBLIC aid_t getPpid();
/** @deprecated See this_actor::get_host() */
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::get_host()") XBT_PUBLIC Host* getHost();
-/** @deprecated See this_actor::is_suspended() */
-XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::is_suspended()") XBT_PUBLIC bool isSuspended();
/** @deprecated See this_actor::on_exit() */
XBT_ATTRIB_DEPRECATED_v323("Please use this_actor::on_exit()") XBT_PUBLIC void onExit(int_f_pvoid_pvoid_t fun, void* data);
/** @deprecated See this_actor::exit() */
