src/kernel/resource/DiskImpl.cpp

   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 "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     const kernel::lmm::Element* elem = nullptr;
  73     double now                       = EngineImpl::get_clock();
  74     while (const auto* var = get_constraint()->get_variable(&elem)) {
  75       Action* action = var->get_id();
  76       if (action->get_state() == Action::State::INITED || action->get_state() == Action::State::STARTED) {
  77         action->set_finish_time(now);
  78         action->set_state(Action::State::FAILED);
  79       }
  80     }
  81   }
  82 }
  83
  84 DiskImpl* DiskImpl::set_read_bandwidth_profile(profile::Profile* profile)
  85 {
  86   if (profile) {
  87     xbt_assert(read_bw_.event == nullptr, "Cannot set a second read bandwidth profile to Disk %s", get_cname());
  88     read_bw_.event = profile->schedule(&profile::future_evt_set, this);
  89   }
  90   return this;
  91 }
  92
  93 DiskImpl* DiskImpl::set_write_bandwidth_profile(profile::Profile* profile)
  94 {
  95   if (profile) {
  96     xbt_assert(write_bw_.event == nullptr, "Cannot set a second read bandwidth profile to Disk %s", get_cname());
  97     write_bw_.event = profile->schedule(&profile::future_evt_set, this);
  98   }
  99   return this;
 100 }
 101
 102 void DiskImpl::seal()
 103 {
 104   if (is_sealed())
 105     return;
 106
 107   xbt_assert(this->get_model(), "Cannot seal Disk (%s) without setting the model first", get_cname());
 108   lmm::System* maxmin_system = get_model()->get_maxmin_system();
 109   /* set readwrite constraint if not configured by user */
 110   if (readwrite_bw_ == -1) {
 111     readwrite_bw_ = std::max(read_bw_.peak, write_bw_.peak);
 112   }
 113   this->set_read_constraint(maxmin_system->constraint_new(this, read_bw_.peak * read_bw_.scale))
 114       ->set_write_constraint(maxmin_system->constraint_new(this, write_bw_.peak * write_bw_.scale))
 115       ->set_constraint(maxmin_system->constraint_new(this, readwrite_bw_));
 116   apply_sharing_policy_cfg();
 117   XBT_DEBUG("Create resource with read_bw '%f' write_bw '%f'", read_bw_.peak, write_bw_.peak);
 118   Resource::seal();
 119   turn_on();
 120 }
 121
 122 constexpr kernel::lmm::Constraint::SharingPolicy to_maxmin_policy(s4u::Disk::SharingPolicy policy)
 123 {
 124   kernel::lmm::Constraint::SharingPolicy lmm_policy = kernel::lmm::Constraint::SharingPolicy::SHARED;
 125   if (policy == s4u::Disk::SharingPolicy::NONLINEAR)
 126     lmm_policy = kernel::lmm::Constraint::SharingPolicy::NONLINEAR;
 127   return lmm_policy;
 128 }
 129
 130 void DiskImpl::set_read_bandwidth(double value)
 131 {
 132   read_bw_.peak = value;
 133   if (constraint_read_)
 134     get_model()->get_maxmin_system()->update_constraint_bound(constraint_read_, read_bw_.peak * read_bw_.scale);
 135 }
 136
 137 void DiskImpl::set_write_bandwidth(double value)
 138 {
 139   write_bw_.peak = value;
 140   if (constraint_write_) {
 141     get_model()->get_maxmin_system()->update_constraint_bound(constraint_write_, write_bw_.peak* write_bw_.scale);
 142   }
 143 }
 144
 145 void DiskImpl::set_readwrite_bandwidth(double value)
 146 {
 147    readwrite_bw_ = value;
 148    if (get_constraint()) {
 149     get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), readwrite_bw_);
 150   }
 151 }
 152
 153 void DiskImpl::set_sharing_policy(s4u::Disk::Operation op, s4u::Disk::SharingPolicy policy,
 154                                   const s4u::NonLinearResourceCb& cb)
 155 {
 156   sharing_policy_[op]    = policy;
 157   sharing_policy_cb_[op] = cb;
 158   apply_sharing_policy_cfg();
 159 }
 160
 161 s4u::Disk::SharingPolicy DiskImpl::get_sharing_policy(s4u::Disk::Operation op) const
 162 {
 163   return sharing_policy_.at(op);
 164 }
 165
 166 void DiskImpl::apply_sharing_policy_cfg()
 167 {
 168   if (get_constraint())
 169     get_constraint()->set_sharing_policy(to_maxmin_policy(sharing_policy_[s4u::Disk::Operation::READWRITE]),
 170                                          sharing_policy_cb_[s4u::Disk::Operation::READWRITE]);
 171   if (constraint_read_)
 172     constraint_read_->set_sharing_policy(to_maxmin_policy(sharing_policy_[s4u::Disk::Operation::READ]),
 173                                          sharing_policy_cb_[s4u::Disk::Operation::READ]);
 174   if (constraint_write_)
 175     constraint_write_->set_sharing_policy(to_maxmin_policy(sharing_policy_[s4u::Disk::Operation::WRITE]),
 176                                           sharing_policy_cb_[s4u::Disk::Operation::WRITE]);
 177 }
 178
 179 void DiskImpl::set_factor_cb(const std::function<s4u::Disk::IoFactorCb>& cb)
 180 {
 181   xbt_assert(not is_sealed(), "Cannot set I/O factor callback in an already sealed disk(%s)", get_cname());
 182   factor_cb_ = cb;
 183 }
 184
 185 /**********
 186  * Action *
 187  **********/
 188 void DiskAction::set_state(Action::State new_state)
 189 {
 190   Action::State previous_state = get_state();
 191   if (new_state != previous_state) { // Trigger only if the state changed
 192     Action::set_state(new_state);
 193     on_state_change(*this, previous_state, new_state);
 194   }
 195 }
 196
 197 void DiskAction::update_remains_lazy(double /*now*/)
 198 {
 199   THROW_IMPOSSIBLE;
 200 }
 201 } // namespace simgrid::kernel::resource