From: Adrien Gougeon Date: Mon, 20 Nov 2023 13:33:14 +0000 (+0100) Subject: fix missing doc for Tasks X-Git-Tag: v3.35~7^2~1^2 X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/ebec9c6104a6bbe60b7bf4586baeaf0b88f53505 fix missing doc for Tasks --- diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 8c5a6e8ffe..84c2a706e5 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -2711,12 +2711,12 @@ Querying info .. doxygenfunction:: simgrid::s4u::Task::get_cname() const .. doxygenfunction:: simgrid::s4u::Task::get_name() const - .. doxygenfunction:: simgrid::s4u::Task::get_count() const - .. doxygenfunction:: simgrid::s4u::Task::get_amount() const - .. doxygenfunction:: simgrid::s4u::Task::get_parallelism_degree() const + .. doxygenfunction:: simgrid::s4u::Task::get_count(std::string instance) const + .. doxygenfunction:: simgrid::s4u::Task::get_amount(std::string instance) const + .. doxygenfunction:: simgrid::s4u::Task::get_queued_firings(std::string instance) const + .. doxygenfunction:: simgrid::s4u::Task::get_running_count(std::string instance) const + .. doxygenfunction:: simgrid::s4u::Task::get_parallelism_degree(std::string instance) const .. doxygenfunction:: simgrid::s4u::Task::set_name(std::string name) - .. doxygenfunction:: simgrid::s4u::Task::set_amount(double amount) - .. doxygenfunction:: simgrid::s4u::Task::set_parallelism_degree(int n) Life cycle ---------- @@ -2725,9 +2725,12 @@ Life cycle .. group-tab:: C++ .. doxygenfunction:: simgrid::s4u::Task::enqueue_firings(int n) + .. doxygenfunction:: simgrid::s4u::Task::set_amount(double amount, std::string instance) + .. doxygenfunction:: simgrid::s4u::Task::set_parallelism_degree(int n, std::string instance) Managing Dependencies --------------------- + .. tabs:: .. group-tab:: C++ @@ -2738,12 +2741,15 @@ Managing Dependencies Managing Tokens --------------- + .. doxygenclass:: simgrid::s4u::Token .. tabs:: .. group-tab:: C++ - .. doxygenfunction:: simgrid::s4u::Task::get_next_token_from(TaskPtr t) + .. doxygenfunction:: simgrid::s4u::Task::get_token_from(TaskPtr t) const + .. doxygenfunction:: simgrid::s4u::Task::get_tokens_from(TaskPtr t) const + .. doxygenfunction:: simgrid::s4u::Task::deque_token_from(TaskPtr t) .. doxygenfunction:: simgrid::s4u::Task::set_token(std::shared_ptr token) Signals @@ -2827,10 +2833,12 @@ Querying info .. group-tab:: C++ - .. doxygenfunction:: simgrid::s4u::ExecTask::get_host() const - .. doxygenfunction:: simgrid::s4u::ExecTask::get_flops() const - .. doxygenfunction:: simgrid::s4u::ExecTask::set_host(Host* host); - .. doxygenfunction:: simgrid::s4u::ExecTask::set_flops(double flops); + .. doxygenfunction:: simgrid::s4u::ExecTask::get_host(std::string instance) const + .. doxygenfunction:: simgrid::s4u::ExecTask::get_flops(std::string instance) const + .. doxygenfunction:: simgrid::s4u::ExecTask::set_host(Host* host, std::string instance); + .. doxygenfunction:: simgrid::s4u::ExecTask::set_flops(double flops, std::string instance); + .. doxygenfunction:: simgrid::s4u::ExecTask::add_instances(int n); + .. doxygenfunction:: simgrid::s4u::ExecTask::remove_instances(int n); .. _API_s4u_IoTask: diff --git a/include/simgrid/forward.h b/include/simgrid/forward.h index fc38085051..e2a0606227 100644 --- a/include/simgrid/forward.h +++ b/include/simgrid/forward.h @@ -105,6 +105,19 @@ XBT_PUBLIC void intrusive_ptr_release(const Semaphore* m); XBT_PUBLIC void intrusive_ptr_add_ref(const Semaphore* m); class Disk; + +class Task; +/** Smart pointer to a simgrid::s4u::Task */ +using TaskPtr = boost::intrusive_ptr; +XBT_PUBLIC void intrusive_ptr_release(Task* o); +XBT_PUBLIC void intrusive_ptr_add_ref(Task* o); +class ExecTask; +using ExecTaskPtr = boost::intrusive_ptr; +class CommTask; +using CommTaskPtr = boost::intrusive_ptr; +class IoTask; +using IoTaskPtr = boost::intrusive_ptr; + /** * @brief Callback to dynamically change the resource's capacity * diff --git a/include/simgrid/s4u/Task.hpp b/include/simgrid/s4u/Task.hpp index 03ee2653ba..28a9211376 100644 --- a/include/simgrid/s4u/Task.hpp +++ b/include/simgrid/s4u/Task.hpp @@ -1,6 +1,7 @@ #ifndef SIMGRID_S4U_TASK_H_ #define SIMGRID_S4U_TASK_H_ +#include #include #include #include @@ -14,20 +15,10 @@ namespace simgrid::s4u { -class Task; -using TaskPtr = boost::intrusive_ptr; -XBT_PUBLIC void intrusive_ptr_release(Task* o); -XBT_PUBLIC void intrusive_ptr_add_ref(Task* o); -class ExecTask; -using ExecTaskPtr = boost::intrusive_ptr; -class CommTask; -using CommTaskPtr = boost::intrusive_ptr; -class IoTask; -using IoTaskPtr = boost::intrusive_ptr; - class XBT_PUBLIC Token : public xbt::Extendable {}; -class Task { +/** Task class */ +class XBT_PUBLIC Task { std::string name_; @@ -70,32 +61,63 @@ protected: virtual void remove_instances(int n); public: + /** @param name The new name of this Task */ void set_name(std::string name); + /** Retrieves the name of that Task as a C++ string */ const std::string& get_name() const { return name_; } + /** Retrieves the name of that Task as a C string */ const char* get_cname() const { return name_.c_str(); } + /** @param amount The new amount of work this instance of this Task has to do + * @note In flops for ExecTasks instances and in bytes for CommTasks instances. In flops for dispatcher and collector + * instances */ void set_amount(double amount, std::string instance = "instance_0"); + /** @return Amout of work this instance of this Task has to process */ double get_amount(std::string instance = "instance_0") const { return amount_.at(instance); } - int get_queued_firings(std::string instance = "instance_0") { return queued_firings_.at(instance); } - int get_running_count(std::string instance = "instance_0") { return running_instances_.at(instance); } + /** @return Amount of queued firings for this instance of this Task */ + int get_queued_firings(std::string instance = "instance_0") const { return queued_firings_.at(instance); } + /** @return Amount currently running of this instance of this Task */ + int get_running_count(std::string instance = "instance_0") const { return running_instances_.at(instance); } + /** @return Number of times this instance of this Task has been completed */ int get_count(std::string instance = "collector") const { return count_.at(instance); } + /** @param n The parallelism degree to set + * @brief The parallelism degree defines how many of this instance can run in parallel. */ void set_parallelism_degree(int n, std::string instance = "all"); + /** @return Parallelism degree of this instance of this Task */ int get_parallelism_degree(std::string instance = "instance_0") const { return parallelism_degree_.at(instance); } + /** @param bytes The amount of bytes this instance has to send to the next instance of this Task + * @note This amount is used when the host is different between the dispatcher and the instance doing the work of the + * Task, or between the instance and the collector. */ void set_internal_bytes(int bytes, std::string instance = "instance_0"); + /** @return Amount of bytes this instance of the Task has to send to the next instance */ double get_internal_bytes(std::string instance = "instance_0") const { return internal_bytes_to_send_.at(instance); } + /** @param func The new balancing function + * @note This function is used by the dispatcher to determine which instance will effectively do the work. This + * function must return the name of the instance as a string. The default balancing function always returns + * "instance_0" */ void set_load_balancing_function(std::function func); - + /** @param token The new token */ void set_token(std::shared_ptr token); + /** @param t A Smart pointer to a Task + * @return Oldest token received by this Task that was sent by Task t */ std::shared_ptr get_token_from(TaskPtr t) const { return tokens_received_.at(t).front(); } + /** @param t A Smart pointer to a Task + * @return All tokens received by this Task that were sent by Task t */ std::deque> get_tokens_from(TaskPtr t) const { return tokens_received_.at(t); } + /** @param t A Smart pointer to a Task + * @brief Pop the oldest token received by this Task that was sent by Task t */ void deque_token_from(TaskPtr t); - + /** @param t A Smart pointer to a Task + * @brief Add t as a successor of this Task */ void add_successor(TaskPtr t); + /** @param t A Smart pointer to a Task + * @brief Remove t from the successors of this Task */ void remove_successor(TaskPtr t); + /** @brief Remove all successors from this Task */ void remove_all_successors(); + /** @return All successors of this Task */ const std::set& get_successors() const { return successors_; } - + /** @param n The number of firings to enqueue */ void enqueue_firings(int n); - /** Add a callback fired before this task activity starts */ void on_this_start_cb(const std::function& func) { on_this_start.connect(func); } /** Add a callback fired before a task activity starts. @@ -119,6 +141,7 @@ public: #endif }; +/** CommTask class */ class CommTask : public Task { Host* source_; Host* destination_; @@ -130,14 +153,23 @@ public: static CommTaskPtr init(const std::string& name); static CommTaskPtr init(const std::string& name, double bytes, Host* source, Host* destination); + /** @param source The new source Host of this CommTask + * @return A Smart pointer to this CommTask */ CommTaskPtr set_source(Host* source); + /** @return A pointer to the source Host of this CommTask */ Host* get_source() const { return source_; } + /** @param destination The new destination of this CommTask + * @return A Smart pointer to the destination Host of this CommTask */ CommTaskPtr set_destination(Host* destination); + /** @return A pointer to the destination Host of this CommTask */ Host* get_destination() const { return destination_; } + /** @param bytes The amount of bytes this CommTask has to send */ CommTaskPtr set_bytes(double bytes); + /** @return The amout of bytes this CommTask has to send */ double get_bytes() const { return get_amount("instance_0"); } }; +/** ExecTask class */ class ExecTask : public Task { std::map host_ = {{"instance_0", nullptr}, {"dispatcher", nullptr}, {"collector", nullptr}}; @@ -148,15 +180,23 @@ public: static ExecTaskPtr init(const std::string& name); static ExecTaskPtr init(const std::string& name, double flops, Host* host); + /** @param host The new host of this instance of this ExecTask + * @return a Smart pointer to this ExecTask */ ExecTaskPtr set_host(Host* host, std::string instance = "all"); + /** @return A pointer to the host of this instance of this ExecTask */ Host* get_host(std::string instance = "instance_0") const { return host_.at(instance); } + /** @param flops The new amount of flops this instance of this Task has to execute + * @return A Smart pointer to this ExecTask */ ExecTaskPtr set_flops(double flops, std::string instance = "instance_0"); + /** @return The amount of flops this instance of this ExecTask has to execute */ double get_flops(std::string instance = "instance_0") const { return get_amount(instance); } - + /** @param n The number of instances to add to this ExecTask */ void add_instances(int n) override; + /** @param n The number of isntances to remove from this ExecTask */ void remove_instances(int n) override; }; +/** IoTask class */ class IoTask : public Task { Disk* disk_; Io::OpType type_; @@ -167,11 +207,20 @@ public: static IoTaskPtr init(const std::string& name); static IoTaskPtr init(const std::string& name, double bytes, Disk* disk, Io::OpType type); + /** @param disk The new disk of this IoTask + * @return A Smart pointer to this IoTask */ IoTaskPtr set_disk(Disk* disk); + /** @return A pointer to the disk of this IoTask */ Disk* get_disk() const { return disk_; } + /** @param bytes The new amount of bytes this IoTask has to write or read + * @return A Smart pointer to this IoTask */ IoTaskPtr set_bytes(double bytes); + /** @return The amount of bytes this IoTask has to write or read */ double get_bytes() const { return get_amount("instance_0"); } + /** @param type The type of operation this IoTask has to do + * @return A Smart pointer to this IoTask */ IoTaskPtr set_op_type(Io::OpType type); + /** @return The type of operation this IoTask has to to */ Io::OpType get_op_type() const { return type_; } }; } // namespace simgrid::s4u