src/kernel/resource/DiskImpl.hpp

   1 /* Copyright (c) 2019-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/kernel/resource/Action.hpp"
   7 #include "simgrid/kernel/resource/Model.hpp"
   8 #include "simgrid/s4u/Disk.hpp"
   9 #include "simgrid/s4u/Io.hpp"
  10 #include "src/kernel/resource/Resource.hpp"
  11 #include "src/surf/surf_interface.hpp"
  12 #include "xbt/PropertyHolder.hpp"
  13
  14 #include <map>
  15
  16 #ifndef DISK_IMPL_HPP_
  17 #define DISK_IMPL_HPP_
  18
  19 /*********
  20  * Model *
  21  *********/
  22
  23 namespace simgrid {
  24 namespace kernel {
  25 namespace resource {
  26 /***********
  27  * Classes *
  28  ***********/
  29
  30 class DiskAction;
  31
  32 /*********
  33  * Model *
  34  *********/
  35 class DiskModel : public Model {
  36 public:
  37   explicit DiskModel(const std::string& name);
  38   DiskModel(const DiskModel&) = delete;
  39   DiskModel& operator=(const DiskModel&) = delete;
  40
  41   virtual DiskImpl* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth) = 0;
  42
  43   virtual DiskAction* io_start(const DiskImpl* disk, sg_size_t size, s4u::Io::OpType type) = 0;
  44 };
  45
  46 /************
  47  * Resource *
  48  ************/
  49 class DiskImpl : public Resource_T<DiskImpl>, public xbt::PropertyHolder {
  50   s4u::Disk piface_;
  51   s4u::Host* host_                   = nullptr;
  52   lmm::Constraint* constraint_write_ = nullptr; /* Constraint for maximum write bandwidth*/
  53   lmm::Constraint* constraint_read_  = nullptr; /* Constraint for maximum read bandwidth*/
  54   std::unordered_map<s4u::Disk::Operation, s4u::Disk::SharingPolicy> sharing_policy_ = {
  55       {s4u::Disk::Operation::READ, s4u::Disk::SharingPolicy::LINEAR},
  56       {s4u::Disk::Operation::WRITE, s4u::Disk::SharingPolicy::LINEAR},
  57       {s4u::Disk::Operation::READWRITE, s4u::Disk::SharingPolicy::LINEAR}};
  58   std::unordered_map<s4u::Disk::Operation, s4u::NonLinearResourceCb> sharing_policy_cb_ = {};
  59   std::function<s4u::Disk::IoFactorCb> factor_cb_                                       = {};
  60
  61   void apply_sharing_policy_cfg();
  62
  63 protected:
  64   ~DiskImpl() override = default; // Disallow direct deletion. Call destroy() instead.
  65
  66 public:
  67   Metric read_bw_  = {0.0, 0, nullptr};
  68   Metric write_bw_ = {0.0, 0, nullptr};
  69   double readwrite_bw_ = -1; /* readwrite constraint bound, usually max(read, write) */
  70
  71   explicit DiskImpl(const std::string& name, double read_bandwidth, double write_bandwidth);
  72   DiskImpl(const DiskImpl&) = delete;
  73   DiskImpl& operator=(const DiskImpl&) = delete;
  74
  75   /** @brief Public interface */
  76   const s4u::Disk* get_iface() const { return &piface_; }
  77   s4u::Disk* get_iface() { return &piface_; }
  78   DiskImpl* set_host(s4u::Host* host);
  79   s4u::Host* get_host() const { return host_; }
  80
  81   virtual void set_read_bandwidth(double read_bw) = 0;
  82   double get_read_bandwidth() const { return read_bw_.peak * read_bw_.scale; }
  83
  84   virtual void set_write_bandwidth(double write_bw) = 0;
  85   double get_write_bandwidth() const { return write_bw_.peak * write_bw_.scale; }
  86
  87   virtual void set_readwrite_bandwidth(double bw) = 0;
  88
  89   DiskImpl* set_read_constraint(lmm::Constraint* constraint_read);
  90   lmm::Constraint* get_read_constraint() const { return constraint_read_; }
  91
  92   DiskImpl* set_write_constraint(lmm::Constraint* constraint_write);
  93   lmm::Constraint* get_write_constraint() const { return constraint_write_; }
  94
  95   DiskImpl* set_read_bandwidth_profile(profile::Profile* profile);
  96   DiskImpl* set_write_bandwidth_profile(profile::Profile* profile);
  97
  98   void set_sharing_policy(s4u::Disk::Operation op, s4u::Disk::SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
  99   s4u::Disk::SharingPolicy get_sharing_policy(s4u::Disk::Operation op) const;
 100
 101   void set_factor_cb(const std::function<s4u::Disk::IoFactorCb>& cb);
 102   const std::function<s4u::Disk::IoFactorCb>& get_factor_cb() const { return factor_cb_; }
 103
 104   void turn_on() override;
 105   void turn_off() override;
 106
 107   void seal() override;
 108   void destroy(); // Must be called instead of the destructor
 109 };
 110
 111 /**********
 112  * Action *
 113  **********/
 114
 115 class DiskAction : public Action {
 116 public:
 117   static xbt::signal<void(DiskAction const&, Action::State, Action::State)> on_state_change;
 118
 119   using Action::Action;
 120   void set_state(simgrid::kernel::resource::Action::State state) override;
 121 };
 122
 123 } // namespace resource
 124 } // namespace kernel
 125 } // namespace simgrid
 126 #endif /* DISK_IMPL_HPP_ */