include/simgrid/s4u/Task.hpp

   1 #ifndef SIMGRID_S4U_TASK_H_
   2 #define SIMGRID_S4U_TASK_H_
   3
   4 #include <simgrid/s4u/Activity.hpp>
   5 #include <simgrid/s4u/Io.hpp>
   6 #include <xbt/Extendable.hpp>
   7
   8 #include <atomic>
   9 #include <deque>
  10 #include <map>
  11 #include <memory>
  12 #include <set>
  13 #include <xbt/asserts.h>
  14
  15 namespace simgrid::s4u {
  16
  17 class Task;
  18 using TaskPtr = boost::intrusive_ptr<Task>;
  19 XBT_PUBLIC void intrusive_ptr_release(Task* o);
  20 XBT_PUBLIC void intrusive_ptr_add_ref(Task* o);
  21 class ExecTask;
  22 using ExecTaskPtr = boost::intrusive_ptr<ExecTask>;
  23 class CommTask;
  24 using CommTaskPtr = boost::intrusive_ptr<CommTask>;
  25 class IoTask;
  26 using IoTaskPtr = boost::intrusive_ptr<IoTask>;
  27
  28 class XBT_PUBLIC Token : public xbt::Extendable<Token> {};
  29
  30 class Task {
  31
  32   std::string name_;
  33
  34   std::map<std::string, double> amount_              = {{"instance_0", 0}, {"dispatcher", 0}, {"collector", 0}};
  35   std::map<std::string, int> queued_firings_         = {{"instance_0", 0}, {"dispatcher", 0}, {"collector", 0}};
  36   std::map<std::string, int> running_instances_      = {{"instance_0", 0}, {"dispatcher", 0}, {"collector", 0}};
  37   std::map<std::string, int> count_                  = {{"instance_0", 0}, {"dispatcher", 0}, {"collector", 0}};
  38   std::map<std::string, int> parallelism_degree_     = {{"instance_0", 1}, {"dispatcher", 1}, {"collector", 1}};
  39   std::map<std::string, int> internal_bytes_to_send_ = {{"instance_0", 0}, {"dispatcher", 0}};
  40
  41   std::function<std::string()> load_balancing_function_;
  42
  43   std::set<Task*> successors_                 = {};
  44   std::map<Task*, unsigned int> predecessors_ = {};
  45   std::atomic_int_fast32_t refcount_{0};
  46
  47   bool ready_to_run(std::string instance);
  48   void receive(Task* source);
  49
  50   std::shared_ptr<Token> token_ = nullptr;
  51   std::deque<std::map<TaskPtr, std::shared_ptr<Token>>> tokens_received_;
  52   std::map<std::string, std::deque<ActivityPtr>> current_activities_ = {
  53       {"instance_0", {}}, {"dispatcher", {}}, {"collector", {}}};
  54
  55   inline static xbt::signal<void(Task*)> on_start;
  56   xbt::signal<void(Task*)> on_this_start;
  57   inline static xbt::signal<void(Task*)> on_completion;
  58   xbt::signal<void(Task*)> on_this_completion;
  59
  60 protected:
  61   explicit Task(const std::string& name);
  62   virtual ~Task() = default;
  63
  64   virtual void fire(std::string instance);
  65   void complete(std::string instance);
  66
  67   void store_activity(ActivityPtr a, std::string instance) { current_activities_[instance].push_back(a); }
  68
  69   virtual void add_instances(int n);
  70   virtual void remove_instances(int n);
  71
  72 public:
  73   void set_name(std::string name);
  74   const std::string& get_name() const { return name_; }
  75   const char* get_cname() const { return name_.c_str(); }
  76   void set_amount(double amount, std::string instance = "instance_0");
  77   double get_amount(std::string instance = "instance_0") const { return amount_.at(instance); }
  78   int get_count(std::string instance = "collector") const { return count_.at(instance); }
  79   void set_parallelism_degree(int n, std::string instance = "all");
  80   int get_parallelism_degree(std::string instance = "instance_0") const { return parallelism_degree_.at(instance); }
  81   void set_internal_bytes(int bytes, std::string instance = "instance_0");
  82   double get_internal_bytes(std::string instance = "instance_0") const { return internal_bytes_to_send_.at(instance); }
  83   void set_load_balancing_function(std::function<std::string()> func);
  84
  85   void set_token(std::shared_ptr<Token> token);
  86   std::shared_ptr<Token> get_next_token_from(TaskPtr t) const { return tokens_received_.front().at(t); }
  87
  88   void add_successor(TaskPtr t);
  89   void remove_successor(TaskPtr t);
  90   void remove_all_successors();
  91   const std::set<Task*>& get_successors() const { return successors_; }
  92
  93   void enqueue_firings(int n);
  94
  95   /** Add a callback fired before this task activity starts */
  96   void on_this_start_cb(const std::function<void(Task*)>& func) { on_this_start.connect(func); }
  97   /** Add a callback fired before a task activity starts.
  98    * Triggered after the on_this_start function**/
  99   static void on_start_cb(const std::function<void(Task*)>& cb) { on_start.connect(cb); }
 100   /** Add a callback fired before this task activity ends */
 101   void on_this_completion_cb(const std::function<void(Task*)>& func) { on_this_completion.connect(func); };
 102   /** Add a callback fired after a task activity ends.
 103    * Triggered after the on_this_end function, but before sending tokens to successors.**/
 104   static void on_completion_cb(const std::function<void(Task*)>& cb) { on_completion.connect(cb); }
 105
 106 #ifndef DOXYGEN
 107   friend void intrusive_ptr_release(Task* o)
 108   {
 109     if (o->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
 110       std::atomic_thread_fence(std::memory_order_acquire);
 111       delete o;
 112     }
 113   }
 114   friend void intrusive_ptr_add_ref(Task* o) { o->refcount_.fetch_add(1, std::memory_order_relaxed); }
 115 #endif
 116 };
 117
 118 class CommTask : public Task {
 119   Host* source_;
 120   Host* destination_;
 121
 122   explicit CommTask(const std::string& name);
 123   void fire(std::string instance) override;
 124
 125 public:
 126   static CommTaskPtr init(const std::string& name);
 127   static CommTaskPtr init(const std::string& name, double bytes, Host* source, Host* destination);
 128
 129   CommTaskPtr set_source(Host* source);
 130   Host* get_source() const { return source_; }
 131   CommTaskPtr set_destination(Host* destination);
 132   Host* get_destination() const { return destination_; }
 133   CommTaskPtr set_bytes(double bytes);
 134   double get_bytes() const { return get_amount("instance_0"); }
 135 };
 136
 137 class ExecTask : public Task {
 138   std::map<std::string, Host*> host_ = {{"instance_0", nullptr}, {"dispatcher", nullptr}, {"collector", nullptr}};
 139
 140   explicit ExecTask(const std::string& name);
 141   void fire(std::string instance) override;
 142
 143 public:
 144   static ExecTaskPtr init(const std::string& name);
 145   static ExecTaskPtr init(const std::string& name, double flops, Host* host);
 146
 147   ExecTaskPtr set_host(Host* host, std::string instance = "all");
 148   Host* get_host(std::string instance = "instance_0") const { return host_.at(instance); }
 149   ExecTaskPtr set_flops(double flops, std::string instance = "instance_0");
 150   double get_flops(std::string instance = "instance_0") const { return get_amount(instance); }
 151
 152   void add_instances(int n) override;
 153   void remove_instances(int n) override;
 154 };
 155
 156 class IoTask : public Task {
 157   Disk* disk_;
 158   Io::OpType type_;
 159   explicit IoTask(const std::string& name);
 160   void fire(std::string instance) override;
 161
 162 public:
 163   static IoTaskPtr init(const std::string& name);
 164   static IoTaskPtr init(const std::string& name, double bytes, Disk* disk, Io::OpType type);
 165
 166   IoTaskPtr set_disk(Disk* disk);
 167   Disk* get_disk() const { return disk_; }
 168   IoTaskPtr set_bytes(double bytes);
 169   double get_bytes() const { return get_amount("instance_0"); }
 170   IoTaskPtr set_op_type(Io::OpType type);
 171   Io::OpType get_op_type() const { return type_; }
 172 };
 173 } // namespace simgrid::s4u
 174 #endif