src/kernel/resource/DiskImpl.cpp

   1 /* Copyright (c) 2019-2022. 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 "DiskImpl.hpp"
   7
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "src/kernel/EngineImpl.hpp"
  10 #include "src/kernel/lmm/maxmin.hpp"
  11 #include "src/kernel/resource/profile/Profile.hpp"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_disk, ker_resource, "Disk resources, that fuel I/O activities");
  14 namespace simgrid::kernel::resource {
  15
  16 xbt::signal<void(DiskAction const&, Action::State, Action::State)> DiskAction::on_state_change;
  17
  18 /************
  19  * Resource *
  20  ************/
  21 DiskImpl::DiskImpl(const std::string& name, double read_bandwidth, double write_bandwidth)
  22     : Resource_T(name), piface_(this)
  23 {
  24   read_bw_.peak   = read_bandwidth;
  25   read_bw_.scale  = 1.0;
  26   write_bw_.peak  = write_bandwidth;
  27   write_bw_.scale = 1.0;
  28 }
  29
  30 DiskImpl* DiskImpl::set_host(s4u::Host* host)
  31 {
  32   xbt_assert(host, "Cannot set host, none given");
  33   host_ = host;
  34   return this;
  35 }
  36
  37 DiskImpl* DiskImpl::set_read_constraint(lmm::Constraint* constraint_read)
  38 {
  39   constraint_read_ = constraint_read;
  40   return this;
  41 }
  42
  43 DiskImpl* DiskImpl::set_write_constraint(lmm::Constraint* constraint_write)
  44 {
  45   constraint_write_ = constraint_write;
  46   return this;
  47 }
  48
  49 /** @brief Fire the required callbacks and destroy the object
  50  *
  51  * Don't delete directly a Disk, call d->destroy() instead.
  52  */
  53 void DiskImpl::destroy()
  54 {
  55   s4u::Disk::on_destruction(piface_);
  56   delete this;
  57 }
  58
  59 void DiskImpl::turn_on()
  60 {
  61   if (not is_on()) {
  62     Resource::turn_on();
  63     s4u::Disk::on_state_change(piface_);
  64   }
  65 }
  66 void DiskImpl::turn_off()
  67 {
  68   if (is_on()) {
  69     Resource::turn_off();
  70     s4u::Disk::on_state_change(piface_);
  71   }
  72 }
  73
  74 DiskImpl* DiskImpl::set_read_bandwidth_profile(profile::Profile* profile)
  75 {
  76   if (profile) {
  77     xbt_assert(read_bw_.event == nullptr, "Cannot set a second read bandwidth profile to Disk %s", get_cname());
  78     read_bw_.event = profile->schedule(&profile::future_evt_set, this);
  79   }
  80   return this;
  81 }
  82
  83 DiskImpl* DiskImpl::set_write_bandwidth_profile(profile::Profile* profile)
  84 {
  85   if (profile) {
  86     xbt_assert(write_bw_.event == nullptr, "Cannot set a second read bandwidth profile to Disk %s", get_cname());
  87     write_bw_.event = profile->schedule(&profile::future_evt_set, this);
  88   }
  89   return this;
  90 }
  91
  92 void DiskImpl::seal()
  93 {
  94   if (is_sealed())
  95     return;
  96
  97   xbt_assert(this->get_model(), "Cannot seal Disk (%s) without setting the model first", get_cname());
  98   lmm::System* maxmin_system = get_model()->get_maxmin_system();
  99   /* set readwrite constraint if not configured by user */
 100   if (readwrite_bw_ == -1) {
 101     readwrite_bw_ = std::max(read_bw_.peak, write_bw_.peak);
 102   }
 103   this->set_read_constraint(maxmin_system->constraint_new(this, read_bw_.peak * read_bw_.scale))
 104       ->set_write_constraint(maxmin_system->constraint_new(this, write_bw_.peak * write_bw_.scale))
 105       ->set_constraint(maxmin_system->constraint_new(this, readwrite_bw_));
 106   apply_sharing_policy_cfg();
 107   XBT_DEBUG("Create resource with read_bw '%f' write_bw '%f'", read_bw_.peak, write_bw_.peak);
 108   Resource::seal();
 109   turn_on();
 110 }
 111
 112 constexpr kernel::lmm::Constraint::SharingPolicy to_maxmin_policy(s4u::Disk::SharingPolicy policy)
 113 {
 114   kernel::lmm::Constraint::SharingPolicy lmm_policy = kernel::lmm::Constraint::SharingPolicy::SHARED;
 115   if (policy == s4u::Disk::SharingPolicy::NONLINEAR)
 116     lmm_policy = kernel::lmm::Constraint::SharingPolicy::NONLINEAR;
 117   return lmm_policy;
 118 }
 119
 120 void DiskImpl::set_read_bandwidth(double value)
 121 {
 122   read_bw_.peak = value;
 123   if (constraint_read_)
 124     get_model()->get_maxmin_system()->update_constraint_bound(constraint_read_, read_bw_.peak * read_bw_.scale);
 125 }
 126
 127 void DiskImpl::set_write_bandwidth(double value)
 128 {
 129   write_bw_.peak = value;
 130   if (constraint_write_) {
 131     get_model()->get_maxmin_system()->update_constraint_bound(constraint_write_, write_bw_.peak* write_bw_.scale);
 132   }
 133 }
 134
 135 void DiskImpl::set_readwrite_bandwidth(double value)
 136 {
 137    readwrite_bw_ = value;
 138    if (get_constraint()) {
 139     get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), readwrite_bw_);
 140   }
 141 }
 142
 143 void DiskImpl::set_sharing_policy(s4u::Disk::Operation op, s4u::Disk::SharingPolicy policy,
 144                                   const s4u::NonLinearResourceCb& cb)
 145 {
 146   sharing_policy_[op]    = policy;
 147   sharing_policy_cb_[op] = cb;
 148   apply_sharing_policy_cfg();
 149 }
 150
 151 s4u::Disk::SharingPolicy DiskImpl::get_sharing_policy(s4u::Disk::Operation op) const
 152 {
 153   return sharing_policy_.at(op);
 154 }
 155
 156 void DiskImpl::apply_sharing_policy_cfg()
 157 {
 158   if (get_constraint())
 159     get_constraint()->set_sharing_policy(to_maxmin_policy(sharing_policy_[s4u::Disk::Operation::READWRITE]),
 160                                          sharing_policy_cb_[s4u::Disk::Operation::READWRITE]);
 161   if (constraint_read_)
 162     constraint_read_->set_sharing_policy(to_maxmin_policy(sharing_policy_[s4u::Disk::Operation::READ]),
 163                                          sharing_policy_cb_[s4u::Disk::Operation::READ]);
 164   if (constraint_write_)
 165     constraint_write_->set_sharing_policy(to_maxmin_policy(sharing_policy_[s4u::Disk::Operation::WRITE]),
 166                                           sharing_policy_cb_[s4u::Disk::Operation::WRITE]);
 167 }
 168
 169 void DiskImpl::set_factor_cb(const std::function<s4u::Disk::IoFactorCb>& cb)
 170 {
 171   xbt_assert(not is_sealed(), "Cannot set I/O factor callback in an already sealed disk(%s)", get_cname());
 172   factor_cb_ = cb;
 173 }
 174
 175 /**********
 176  * Action *
 177  **********/
 178 void DiskAction::set_state(Action::State new_state)
 179 {
 180   Action::State previous_state = get_state();
 181   if (new_state != previous_state) { // Trigger only if the state changed
 182     Action::set_state(new_state);
 183     on_state_change(*this, previous_state, new_state);
 184   }
 185 }
 186
 187 void DiskAction::update_remains_lazy(double /*now*/)
 188 {
 189   THROW_IMPOSSIBLE;
 190 }
 191 } // namespace simgrid::kernel::resource