src/kernel/resource/DiskImpl.hpp

   1 /* Copyright (c) 2019-2023. 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::kernel::resource {
  24 /***********
  25  * Classes *
  26  ***********/
  27
  28 class DiskAction;
  29
  30 /*********
  31  * Model *
  32  *********/
  33 class DiskModel : public Model {
  34 public:
  35   using Model::Model;
  36
  37   virtual DiskImpl* create_disk(const std::string& name, double read_bandwidth, double write_bandwidth) = 0;
  38 };
  39
  40 /************
  41  * Resource *
  42  ************/
  43 class DiskImpl : public Resource_T<DiskImpl>, public xbt::PropertyHolder {
  44   s4u::Disk piface_;
  45   s4u::Host* host_                   = nullptr;
  46   lmm::Constraint* constraint_write_ = nullptr; /* Constraint for maximum write bandwidth*/
  47   lmm::Constraint* constraint_read_  = nullptr; /* Constraint for maximum read bandwidth*/
  48   std::unordered_map<s4u::Disk::Operation, s4u::Disk::SharingPolicy> sharing_policy_ = {
  49       {s4u::Disk::Operation::READ, s4u::Disk::SharingPolicy::LINEAR},
  50       {s4u::Disk::Operation::WRITE, s4u::Disk::SharingPolicy::LINEAR},
  51       {s4u::Disk::Operation::READWRITE, s4u::Disk::SharingPolicy::LINEAR}};
  52   std::unordered_map<s4u::Disk::Operation, s4u::NonLinearResourceCb> sharing_policy_cb_ = {};
  53   std::function<s4u::Disk::IoFactorCb> factor_cb_                                       = {};
  54
  55   Metric read_bw_      = {0.0, 0, nullptr};
  56   Metric write_bw_     = {0.0, 0, nullptr};
  57   double readwrite_bw_ = -1; /* readwrite constraint bound, usually max(read, write) */
  58
  59   void apply_sharing_policy_cfg();
  60
  61 protected:
  62   ~DiskImpl() override = default; // Disallow direct deletion. Call destroy() instead.
  63
  64 public:
  65   explicit DiskImpl(const std::string& name, double read_bandwidth, double write_bandwidth);
  66   DiskImpl(const DiskImpl&) = delete;
  67   DiskImpl& operator=(const DiskImpl&) = delete;
  68
  69   /** @brief Public interface */
  70   const s4u::Disk* get_iface() const { return &piface_; }
  71   s4u::Disk* get_iface() { return &piface_; }
  72   DiskImpl* set_host(s4u::Host* host);
  73   s4u::Host* get_host() const { return host_; }
  74
  75   void set_read_bandwidth(double value);
  76   double get_read_bandwidth() const { return read_bw_.peak * read_bw_.scale; }
  77
  78   void set_write_bandwidth(double value);
  79   double get_write_bandwidth() const { return write_bw_.peak * write_bw_.scale; }
  80
  81   void set_readwrite_bandwidth(double value);
  82   double get_readwrite_bandwidth() const { return readwrite_bw_; }
  83
  84   DiskImpl* set_read_constraint(lmm::Constraint* constraint_read);
  85   lmm::Constraint* get_read_constraint() const { return constraint_read_; }
  86
  87   DiskImpl* set_write_constraint(lmm::Constraint* constraint_write);
  88   lmm::Constraint* get_write_constraint() const { return constraint_write_; }
  89
  90   profile::Event* get_read_event() const { return read_bw_.event; }
  91   void unref_read_event() { tmgr_trace_event_unref(&read_bw_.event); }
  92
  93   profile::Event* get_write_event() const { return write_bw_.event; }
  94   void unref_write_event() { tmgr_trace_event_unref(&write_bw_.event); }
  95
  96   DiskImpl* set_read_bandwidth_profile(profile::Profile* profile);
  97   DiskImpl* set_write_bandwidth_profile(profile::Profile* profile);
  98
  99   void set_sharing_policy(s4u::Disk::Operation op, s4u::Disk::SharingPolicy policy, const s4u::NonLinearResourceCb& cb);
 100   s4u::Disk::SharingPolicy get_sharing_policy(s4u::Disk::Operation op) const;
 101
 102   void set_factor_cb(const std::function<s4u::Disk::IoFactorCb>& cb);
 103   const std::function<s4u::Disk::IoFactorCb>& get_factor_cb() const { return factor_cb_; }
 104
 105   void turn_on() override;
 106   void turn_off() override;
 107
 108   void seal() override;
 109   void destroy(); // Must be called instead of the destructor
 110
 111   virtual DiskAction* io_start(sg_size_t size, s4u::Io::OpType type) = 0;
 112 };
 113
 114 /**********
 115  * Action *
 116  **********/
 117
 118 class DiskAction : public Action {
 119 public:
 120   static xbt::signal<void(DiskAction const&, Action::State, Action::State)> on_state_change;
 121
 122   using Action::Action;
 123   void set_state(simgrid::kernel::resource::Action::State state) override;
 124   void update_remains_lazy(double now) override;
 125 };
 126
 127 } // namespace simgrid::kernel::resource
 128 #endif /* DISK_IMPL_HPP_ */