#ifndef SIMGRID_S4U_TASK_H_
#define SIMGRID_S4U_TASK_H_
+#include <simgrid/forward.h>
#include <simgrid/s4u/Activity.hpp>
#include <simgrid/s4u/Io.hpp>
#include <xbt/Extendable.hpp>
#include <map>
#include <memory>
#include <set>
+#include <xbt/asserts.h>
namespace simgrid::s4u {
-class Task;
-using TaskPtr = boost::intrusive_ptr<Task>;
-XBT_PUBLIC void intrusive_ptr_release(Task* o);
-XBT_PUBLIC void intrusive_ptr_add_ref(Task* o);
-class ExecTask;
-using ExecTaskPtr = boost::intrusive_ptr<ExecTask>;
-class CommTask;
-using CommTaskPtr = boost::intrusive_ptr<CommTask>;
-class IoTask;
-using IoTaskPtr = boost::intrusive_ptr<IoTask>;
-
class XBT_PUBLIC Token : public xbt::Extendable<Token> {};
-class Task {
+/** Task class */
+class XBT_PUBLIC Task {
+
std::string name_;
- double amount_;
- int queued_firings_ = 0;
- int count_ = 0;
- bool working_ = false;
+
+ std::map<std::string, double> amount_ = {{"instance_0", 0}, {"dispatcher", 0}, {"collector", 0}};
+ std::map<std::string, int> queued_firings_ = {{"instance_0", 0}, {"dispatcher", 0}, {"collector", 0}};
+ std::map<std::string, int> running_instances_ = {{"instance_0", 0}, {"dispatcher", 0}, {"collector", 0}};
+ std::map<std::string, int> count_ = {{"instance_0", 0}, {"dispatcher", 0}, {"collector", 0}};
+ std::map<std::string, int> parallelism_degree_ = {{"instance_0", 1}, {"dispatcher", 1}, {"collector", 1}};
+ std::map<std::string, int> internal_bytes_to_send_ = {{"instance_0", 0}, {"dispatcher", 0}};
+
+ std::function<std::string()> load_balancing_function_;
std::set<Task*> successors_ = {};
std::map<Task*, unsigned int> predecessors_ = {};
std::atomic_int_fast32_t refcount_{0};
- bool ready_to_run() const;
+ bool ready_to_run(std::string instance);
void receive(Task* source);
std::shared_ptr<Token> token_ = nullptr;
- std::deque<std::map<TaskPtr, std::shared_ptr<Token>>> tokens_received_;
- ActivityPtr previous_activity_;
- ActivityPtr current_activity_;
+ std::map<TaskPtr, std::deque<std::shared_ptr<Token>>> tokens_received_;
+ std::map<std::string, std::deque<ActivityPtr>> current_activities_ = {
+ {"instance_0", {}}, {"dispatcher", {}}, {"collector", {}}};
inline static xbt::signal<void(Task*)> on_start;
xbt::signal<void(Task*)> on_this_start;
protected:
explicit Task(const std::string& name);
- virtual ~Task() = default;
+ virtual ~Task() = default;
+
+ virtual void fire(std::string instance);
+ void complete(std::string instance);
- virtual void fire();
- void complete();
+ void store_activity(ActivityPtr a, const std::string& instance) { current_activities_[instance].push_back(a); }
- void set_current_activity (ActivityPtr a) { current_activity_ = a; }
+ virtual void add_instances(int n);
+ 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(); }
- void set_amount(double amount);
- double get_amount() const { return amount_; }
- int get_count() const { return count_; }
-
+ /** @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); }
+ /** @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<std::string()> func);
+ /** @param token The new token */
void set_token(std::shared_ptr<Token> token);
- std::shared_ptr<Token> get_next_token_from(TaskPtr t);
-
+ /** @param t A Smart pointer to a Task
+ * @return Oldest token received by this Task that was sent by Task t */
+ std::shared_ptr<Token> 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<std::shared_ptr<Token>> 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<Task*>& 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<void(Task*)>& func){ on_this_start.connect(func); }
+ void on_this_start_cb(const std::function<void(Task*)>& func) { on_this_start.connect(func); }
/** Add a callback fired before a task activity starts.
* Triggered after the on_this_start function**/
static void on_start_cb(const std::function<void(Task*)>& cb) { on_start.connect(cb); }
#endif
};
+/** CommTask class */
class CommTask : public Task {
Host* source_;
Host* destination_;
explicit CommTask(const std::string& name);
- void fire() override;
+ void fire(std::string instance) override;
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);
- double get_bytes() const { return get_amount(); }
+ /** @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 {
- Host* host_;
+ std::map<std::string, Host*> host_ = {{"instance_0", nullptr}, {"dispatcher", nullptr}, {"collector", nullptr}};
explicit ExecTask(const std::string& name);
- void fire() override;
+ void fire(std::string instance) override;
public:
static ExecTaskPtr init(const std::string& name);
static ExecTaskPtr init(const std::string& name, double flops, Host* host);
- ExecTaskPtr set_host(Host* host);
- Host* get_host() const { return host_; }
- ExecTaskPtr set_flops(double flops);
- double get_flops() const { return get_amount(); }
+ /** @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_;
explicit IoTask(const std::string& name);
- void fire() override;
+ void fire(std::string instance) override;
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);
- double get_bytes() const { return get_amount(); }
+ /** @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
