src/kernel/resource/Action.cpp

   1 /* Copyright (c) 2004-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 "src/kernel/EngineImpl.hpp"
   9 #include "src/kernel/lmm/maxmin.hpp"
  10 #include "src/simgrid/math_utils.h"
  11
  12 XBT_LOG_NEW_CATEGORY(kernel, "SimGrid internals");
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_resource, kernel, "Resources, modeling the platform performance");
  14
  15 namespace simgrid::kernel::resource {
  16
  17 Action::Action(Model* model, double cost, bool failed) : Action(model, cost, failed, nullptr) {}
  18
  19 Action::Action(Model* model, double cost, bool failed, lmm::Variable* var)
  20     : remains_(cost), start_time_(EngineImpl::get_clock()), cost_(cost), model_(model), variable_(var)
  21 {
  22   if (failed)
  23     state_set_ = model_->get_failed_action_set();
  24   else
  25     state_set_ = model_->get_started_action_set();
  26
  27   state_set_->push_back(*this);
  28 }
  29
  30 Action::~Action()
  31 {
  32   if (state_set_hook_.is_linked())
  33     xbt::intrusive_erase(*state_set_, *this);
  34   if (get_variable())
  35     model_->get_maxmin_system()->variable_free(get_variable());
  36
  37   /* remove from heap on need (ie, if selective update) */
  38   model_->get_action_heap().remove(this);
  39   if (modified_set_hook_.is_linked())
  40     xbt::intrusive_erase(*model_->get_modified_set(), *this);
  41 }
  42
  43 void Action::finish(Action::State state)
  44 {
  45   finish_time_ = EngineImpl::get_clock();
  46   set_remains(0);
  47   set_state(state);
  48 }
  49
  50 Action::State Action::get_state() const
  51 {
  52   if (state_set_ == model_->get_inited_action_set())
  53     return Action::State::INITED;
  54   if (state_set_ == model_->get_started_action_set())
  55     return Action::State::STARTED;
  56   if (state_set_ == model_->get_failed_action_set())
  57     return Action::State::FAILED;
  58   if (state_set_ == model_->get_finished_action_set())
  59     return Action::State::FINISHED;
  60   if (state_set_ == model_->get_ignored_action_set())
  61     return Action::State::IGNORED;
  62   THROW_IMPOSSIBLE;
  63 }
  64
  65 void Action::set_state(Action::State state)
  66 {
  67   xbt::intrusive_erase(*state_set_, *this);
  68   switch (state) {
  69     case Action::State::INITED:
  70       state_set_ = model_->get_inited_action_set();
  71       break;
  72     case Action::State::STARTED:
  73       state_set_ = model_->get_started_action_set();
  74       break;
  75     case Action::State::FAILED:
  76       state_set_ = model_->get_failed_action_set();
  77       break;
  78     case Action::State::FINISHED:
  79       state_set_ = model_->get_finished_action_set();
  80       break;
  81     case Action::State::IGNORED:
  82       state_set_ = model_->get_ignored_action_set();
  83       break;
  84     default:
  85       state_set_ = nullptr;
  86       break;
  87   }
  88   if (state_set_)
  89     state_set_->push_back(*this);
  90 }
  91
  92 double Action::get_bound() const
  93 {
  94   return variable_ ? variable_->get_bound() : 0;
  95 }
  96
  97 double Action::get_rate() const
  98 {
  99   return variable_ ? variable_->get_value() * factor_ : 0;
 100 }
 101
 102 void Action::set_bound(double bound)
 103 {
 104   XBT_IN("(%p,%g)", this, bound);
 105   if (variable_)
 106     model_->get_maxmin_system()->update_variable_bound(variable_, bound);
 107
 108   if (model_->is_update_lazy() && get_last_update() != EngineImpl::get_clock())
 109     model_->get_action_heap().remove(this);
 110   XBT_OUT();
 111 }
 112
 113 void Action::ref()
 114 {
 115   refcount_++;
 116 }
 117
 118 void Action::set_max_duration(double duration)
 119 {
 120   max_duration_ = duration;
 121   if (model_->is_update_lazy()) // remove action from the heap
 122     model_->get_action_heap().remove(this);
 123 }
 124
 125 void Action::set_sharing_penalty(double sharing_penalty)
 126 {
 127   XBT_IN("(%p,%g)", this, sharing_penalty);
 128   sharing_penalty_ = sharing_penalty;
 129   model_->get_maxmin_system()->update_variable_penalty(get_variable(), sharing_penalty);
 130   if (model_->is_update_lazy())
 131     model_->get_action_heap().remove(this);
 132   XBT_OUT();
 133 }
 134
 135 void Action::cancel()
 136 {
 137   set_state(Action::State::FAILED);
 138   if (model_->is_update_lazy()) {
 139     if (modified_set_hook_.is_linked())
 140       xbt::intrusive_erase(*model_->get_modified_set(), *this);
 141     model_->get_action_heap().remove(this);
 142   }
 143 }
 144
 145 bool Action::unref()
 146 {
 147   refcount_--;
 148   if (not refcount_) {
 149     delete this;
 150     return true;
 151   }
 152   return false;
 153 }
 154
 155 void Action::suspend()
 156 {
 157   XBT_IN("(%p)", this);
 158   if (suspended_ != SuspendStates::SLEEPING) {
 159     model_->get_maxmin_system()->update_variable_penalty(get_variable(), 0.0);
 160     if (model_->is_update_lazy()) {
 161       model_->get_action_heap().remove(this);
 162       if (state_set_ == model_->get_started_action_set() && sharing_penalty_ > 0) {
 163         // If we have a lazy model, we need to update the remaining value accordingly
 164         update_remains_lazy(EngineImpl::get_clock());
 165       }
 166     }
 167     suspended_ = SuspendStates::SUSPENDED;
 168   }
 169   XBT_OUT();
 170 }
 171
 172 void Action::resume()
 173 {
 174   XBT_IN("(%p)", this);
 175   if (suspended_ != SuspendStates::SLEEPING) {
 176     model_->get_maxmin_system()->update_variable_penalty(get_variable(), get_sharing_penalty());
 177     suspended_ = SuspendStates::RUNNING;
 178     if (model_->is_update_lazy())
 179       model_->get_action_heap().remove(this);
 180   }
 181   XBT_OUT();
 182 }
 183
 184 double Action::get_remains()
 185 {
 186   XBT_IN("(%p)", this);
 187   /* update remains before returning it */
 188   if (model_->is_update_lazy()) /* update remains before return it */
 189     update_remains_lazy(EngineImpl::get_clock());
 190   XBT_OUT();
 191   return remains_;
 192 }
 193
 194 void Action::update_max_duration(double delta)
 195 {
 196   if (max_duration_ != NO_MAX_DURATION)
 197     double_update(&max_duration_, delta, sg_precision_timing);
 198 }
 199
 200 void Action::update_remains(double delta)
 201 {
 202   double_update(&remains_, delta, sg_precision_workamount * sg_precision_timing);
 203 }
 204
 205 void Action::set_last_update()
 206 {
 207   last_update_ = EngineImpl::get_clock();
 208 }
 209
 210 double ActionHeap::top_date() const
 211 {
 212   return top().first;
 213 }
 214
 215 void ActionHeap::insert(Action* action, double date, ActionHeap::Type type)
 216 {
 217   action->type_      = type;
 218   action->heap_hook_ = emplace(std::make_pair(date, action));
 219 }
 220
 221 void ActionHeap::remove(Action* action)
 222 {
 223   action->type_ = ActionHeap::Type::unset;
 224   if (action->heap_hook_) {
 225     erase(*action->heap_hook_);
 226     action->heap_hook_ = boost::none;
 227   }
 228 }
 229
 230 void ActionHeap::update(Action* action, double date, ActionHeap::Type type)
 231 {
 232   action->type_ = type;
 233   if (action->heap_hook_) {
 234     heap_type::update(*action->heap_hook_, std::make_pair(date, action));
 235   } else {
 236     action->heap_hook_ = emplace(std::make_pair(date, action));
 237   }
 238 }
 239
 240 Action* ActionHeap::pop()
 241 {
 242   Action* action = top().second;
 243   heap_type::pop();
 244   action->heap_hook_ = boost::none;
 245   return action;
 246 }
 247
 248 } // namespace simgrid::kernel::resource