*
* @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">
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. */
/** 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);
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);
}
* An execution of priority 2 computes twice as fast as an execution at priority 1. */
XBT_PUBLIC void execute(double flop, double priority);
+/**
+ * @example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
+ */
+
/** Block the 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
* 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:
* 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. It is **strongly advised** to only use the LV08 host model when using
- * parallel executions. Note that you can mix regular executions and communications with parallel executions,
- * provided that the platform model is LV08.
+ * 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);
-XBT_PUBLIC void parallel_execute(int host_nb, s4u::Host* host_list, double* flops_amount, double* bytes_amount);
/** \rst
* Block the actor until the built :ref:`parallel execution <API_s4u_parallel_execute>` completes, or until the timeout.
- * \endrst*/
-XBT_PUBLIC void parallel_execute(int host_nb, s4u::Host* host_list, double* flops_amount, double* bytes_amount,
- double 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 Suspend the actor. */
XBT_PUBLIC void suspend();
-/** @brief yield the actor. */
+/** @brief Yield the actor. */
XBT_PUBLIC void yield();
/** @brief Resume the actor. */
