Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Constify pointer and reference local variables in src/surf/.
[simgrid.git] / src / surf / cpu_cas01.cpp
index 52d7f2c..48ba787 100644 (file)
@@ -1,60 +1,76 @@
-/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2019. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "cpu_cas01.hpp"
-#include "cpu_ti.hpp"
-#include "simgrid/sg_config.h"
-#include "src/kernel/lmm/maxmin.hpp"
-#include "xbt/utility.hpp"
-#include <algorithm>
+#include "simgrid/sg_config.hpp"
+#include "src/kernel/resource/profile/Event.hpp"
+#include "src/surf/cpu_ti.hpp"
+#include "src/surf/surf_interface.hpp"
+#include "surf/surf.hpp"
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu_cas, surf_cpu, "Logging specific to the SURF CPU IMPROVED module");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu_cas, surf_cpu, "Logging specific to the SURF CPU module");
+
+/***********
+ * Options *
+ ***********/
+
+static simgrid::config::Flag<std::string>
+    cpu_optim_opt("cpu/optim", "Optimization algorithm to use for CPU resources. ", "Lazy",
+
+                  std::map<std::string, std::string>({
+                      {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining)."},
+                      {"TI", "Trace integration. Highly optimized mode when using availability traces (only available "
+                             "for the Cas01 CPU model for now)."},
+                      {"Full", "Full update of remaining and variables. Slow but may be useful when debugging."},
+                  }),
+
+                  [](std::string const&) {
+                    xbt_assert(_sg_cfg_init_status < 2,
+                               "Cannot change the optimization algorithm after the initialization");
+                  });
 
 /*********
  * Model *
  *********/
 void surf_cpu_model_init_Cas01()
 {
-  xbt_assert(not surf_cpu_model_pm);
-  xbt_assert(not surf_cpu_model_vm);
+  xbt_assert(surf_cpu_model_pm == nullptr, "CPU model already initialized. This should not happen.");
+  xbt_assert(surf_cpu_model_vm == nullptr, "CPU model already initialized. This should not happen.");
 
-  if (xbt_cfg_get_string("cpu/optim") == "TI") {
-    surf_cpu_model_init_ti();
+  if (cpu_optim_opt == "TI") {
+    simgrid::kernel::resource::CpuTiModel::create_pm_vm_models();
     return;
   }
 
-  surf_cpu_model_pm = new simgrid::surf::CpuCas01Model();
-  all_existing_models->push_back(surf_cpu_model_pm);
+  simgrid::kernel::resource::Model::UpdateAlgo algo;
+  if (cpu_optim_opt == "Lazy")
+    algo = simgrid::kernel::resource::Model::UpdateAlgo::LAZY;
+  else
+    algo = simgrid::kernel::resource::Model::UpdateAlgo::FULL;
 
-  surf_cpu_model_vm  = new simgrid::surf::CpuCas01Model();
-  all_existing_models->push_back(surf_cpu_model_vm);
+  surf_cpu_model_pm = new simgrid::kernel::resource::CpuCas01Model(algo);
+  surf_cpu_model_vm = new simgrid::kernel::resource::CpuCas01Model(algo);
 }
 
 namespace simgrid {
-namespace surf {
+namespace kernel {
+namespace resource {
 
-CpuCas01Model::CpuCas01Model() : simgrid::surf::CpuModel()
+CpuCas01Model::CpuCas01Model(Model::UpdateAlgo algo) : CpuModel(algo)
 {
-  std::string optim = xbt_cfg_get_string("cpu/optim");
-  bool select = xbt_cfg_get_boolean("cpu/maxmin-selective-update");
+  all_existing_models.push_back(this);
+
+  bool select = config::get_value<bool>("cpu/maxmin-selective-update");
 
-  if (optim == "Full") {
-    setUpdateMechanism(UM_FULL);
-  } else if (optim == "Lazy") {
-    setUpdateMechanism(UM_LAZY);
+  if (algo == Model::UpdateAlgo::LAZY) {
+    xbt_assert(select || config::is_default("cpu/maxmin-selective-update"),
+               "You cannot disable cpu selective update when using the lazy update mechanism");
     select = true;
-    xbt_assert(select || (xbt_cfg_is_default_value("cpu/maxmin-selective-update")),
-               "Disabling selective update while using the lazy update mechanism is dumb!");
-  } else {
-    xbt_die("Unsupported optimization (%s) for this model", optim.c_str());
   }
 
-  maxmin_system_ = new simgrid::kernel::lmm::System(select);
-
-  if (getUpdateMechanism() == UM_LAZY)
-    maxmin_system_->modified_set_ = new kernel::resource::Action::ModifiedSet();
+  set_maxmin_system(new lmm::System(select));
 }
 
 CpuCas01Model::~CpuCas01Model()
@@ -62,89 +78,83 @@ CpuCas01Model::~CpuCas01Model()
   surf_cpu_model_pm = nullptr;
 }
 
-Cpu *CpuCas01Model::createCpu(simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)
+Cpu* CpuCas01Model::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate, int core)
 {
-  return new CpuCas01(this, host, speedPerPstate, core);
+  return new CpuCas01(this, host, speed_per_pstate, core);
 }
 
 /************
  * Resource *
  ************/
-CpuCas01::CpuCas01(CpuCas01Model* model, simgrid::s4u::Host* host, std::vector<double>* speedPerPstate, int core)
-    : Cpu(model, host, model->get_maxmin_system()->constraint_new(this, core * speedPerPstate->front()), speedPerPstate,
-          core)
+CpuCas01::CpuCas01(CpuCas01Model* model, s4u::Host* host, const std::vector<double>& speed_per_pstate, int core)
+    : Cpu(model, host, model->get_maxmin_system()->constraint_new(this, core * speed_per_pstate.front()),
+          speed_per_pstate, core)
 {
 }
 
-CpuCas01::~CpuCas01()
-{
-  if (model() == surf_cpu_model_pm)
-    speedPerPstate_.clear();
-}
+CpuCas01::~CpuCas01() = default;
 
-std::vector<double> * CpuCas01::getSpeedPeakList(){
-  return &speedPerPstate_;
-}
-
-bool CpuCas01::isUsed()
+bool CpuCas01::is_used()
 {
-  return model()->get_maxmin_system()->constraint_used(constraint());
+  return get_model()->get_maxmin_system()->constraint_used(get_constraint());
 }
 
 /** @brief take into account changes of speed (either load or max) */
-void CpuCas01::onSpeedChange() {
-  kernel::lmm::Variable* var = nullptr;
-  const_lmm_element_t elem = nullptr;
+void CpuCas01::on_speed_change()
+{
+  const lmm::Variable* var;
+  const lmm::Element* elem = nullptr;
 
-  model()->get_maxmin_system()->update_constraint_bound(constraint(), coresAmount_ * speed_.scale * speed_.peak);
-  while ((var = constraint()->get_variable(&elem))) {
-    CpuCas01Action* action = static_cast<CpuCas01Action*>(var->get_id());
+  get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
+                                                            get_core_count() * speed_.scale * speed_.peak);
+  while ((var = get_constraint()->get_variable(&elem))) {
+    auto* action = static_cast<CpuCas01Action*>(var->get_id());
 
-    model()->get_maxmin_system()->update_variable_bound(action->get_variable(),
-                                                        action->requestedCore() * speed_.scale * speed_.peak);
+    get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(),
+                                                            action->requested_core() * speed_.scale * speed_.peak);
   }
 
-  Cpu::onSpeedChange();
+  Cpu::on_speed_change();
 }
 
-void CpuCas01::apply_event(tmgr_trace_event_t event, double value)
+void CpuCas01::apply_event(profile::Event* event, double value)
 {
   if (event == speed_.event) {
     /* TODO (Hypervisor): do the same thing for constraint_core[i] */
-    xbt_assert(coresAmount_ == 1, "FIXME: add speed scaling code also for constraint_core[i]");
+    xbt_assert(get_core_count() == 1, "FIXME: add speed scaling code also for constraint_core[i]");
 
     speed_.scale = value;
-    onSpeedChange();
+    on_speed_change();
 
     tmgr_trace_event_unref(&speed_.event);
-  } else if (event == stateEvent_) {
+  } else if (event == state_event_) {
     /* TODO (Hypervisor): do the same thing for constraint_core[i] */
-    xbt_assert(coresAmount_ == 1, "FIXME: add state change code also for constraint_core[i]");
+    xbt_assert(get_core_count() == 1, "FIXME: add state change code also for constraint_core[i]");
 
     if (value > 0) {
-      if(isOff())
-        host_that_restart.push_back(getHost());
-      turnOn();
+      if (not is_on()) {
+        XBT_VERB("Restart processes on host %s", get_host()->get_cname());
+        get_host()->turn_on();
+      }
     } else {
-      kernel::lmm::Constraint* cnst = constraint();
-      kernel::lmm::Variable* var    = nullptr;
-      const_lmm_element_t elem = nullptr;
+      const lmm::Constraint* cnst = get_constraint();
+      const lmm::Variable* var;
+      const lmm::Element* elem = nullptr;
       double date              = surf_get_clock();
 
-      turnOff();
+      get_host()->turn_off();
 
       while ((var = cnst->get_variable(&elem))) {
-        kernel::resource::Action* action = static_cast<kernel::resource::Action*>(var->get_id());
+        auto* action = static_cast<Action*>(var->get_id());
 
-        if (action->get_state() == kernel::resource::Action::State::running ||
-            action->get_state() == kernel::resource::Action::State::ready ||
-            action->get_state() == kernel::resource::Action::State::not_in_the_system) {
+        if (action->get_state() == Action::State::INITED || action->get_state() == Action::State::STARTED ||
+            action->get_state() == Action::State::IGNORED) {
           action->set_finish_time(date);
-          action->set_state(kernel::resource::Action::State::failed);
+          action->set_state(Action::State::FAILED);
         }
       }
     }
-    tmgr_trace_event_unref(&stateEvent_);
+    tmgr_trace_event_unref(&state_event_);
 
   } else {
     xbt_die("Unknown event!\n");
@@ -154,38 +164,35 @@ void CpuCas01::apply_event(tmgr_trace_event_t event, double value)
 /** @brief Start a new execution on this CPU lasting @param size flops and using one core */
 CpuAction* CpuCas01::execution_start(double size)
 {
-  return new CpuCas01Action(model(), size, isOff(), speed_.scale * speed_.peak, constraint());
+  return new CpuCas01Action(get_model(), size, not is_on(), speed_.scale * speed_.peak, get_constraint());
 }
 
-CpuAction* CpuCas01::execution_start(double size, int requestedCores)
+CpuAction* CpuCas01::execution_start(double size, int requested_cores)
 {
-  return new CpuCas01Action(model(), size, isOff(), speed_.scale * speed_.peak, constraint(), requestedCores);
+  return new CpuCas01Action(get_model(), size, not is_on(), speed_.scale * speed_.peak, get_constraint(),
+                            requested_cores);
 }
 
-CpuAction *CpuCas01::sleep(double duration)
+CpuActionCpuCas01::sleep(double duration)
 {
   if (duration > 0)
     duration = std::max(duration, sg_surf_precision);
 
-  XBT_IN("(%s,%g)", getCname(), duration);
-  CpuCas01Action* action = new CpuCas01Action(model(), 1.0, isOff(), speed_.scale * speed_.peak, constraint());
+  XBT_IN("(%s,%g)", get_cname(), duration);
+  auto* action = new CpuCas01Action(get_model(), 1.0, not is_on(), speed_.scale * speed_.peak, get_constraint());
 
   // FIXME: sleep variables should not consume 1.0 in System::expand()
   action->set_max_duration(duration);
-  action->suspended_ = kernel::resource::Action::SuspendStates::sleeping;
-  if (duration < 0) { // NO_MAX_DURATION
-    /* Move to the *end* of the corresponding action set. This convention is used to speed up update_resource_state */
-    simgrid::xbt::intrusive_erase(*action->get_state_set(), *action);
-    action->state_set_ = &static_cast<CpuCas01Model*>(model())->cpuRunningActionSetThatDoesNotNeedBeingChecked_;
-    action->get_state_set()->push_back(*action);
-  }
+  action->set_suspend_state(Action::SuspendStates::SLEEPING);
+  if (duration == NO_MAX_DURATION)
+    action->set_state(Action::State::IGNORED);
 
-  model()->get_maxmin_system()->update_variable_weight(action->get_variable(), 0.0);
-  if (model()->getUpdateMechanism() == UM_LAZY) { // remove action from the heap
-    action->heapRemove();
+  get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), 0.0);
+  if (get_model()->get_update_algorithm() == Model::UpdateAlgo::LAZY) { // remove action from the heap
+    get_model()->get_action_heap().remove(action);
     // this is necessary for a variable with weight 0 since such variables are ignored in lmm and we need to set its
     // max_duration correctly at the next call to share_resources
-    model()->get_modified_set()->push_front(*action);
+    get_model()->get_modified_set()->push_front(*action);
   }
 
   XBT_OUT();
@@ -195,31 +202,29 @@ CpuAction *CpuCas01::sleep(double duration)
 /**********
  * Action *
  **********/
-CpuCas01Action::CpuCas01Action(kernel::resource::Model* model, double cost, bool failed, double speed,
-                               kernel::lmm::Constraint* constraint, int requestedCore)
+CpuCas01Action::CpuCas01Action(Model* model, double cost, bool failed, double speed, lmm::Constraint* constraint,
+                               int requested_core)
     : CpuAction(model, cost, failed,
-                model->get_maxmin_system()->variable_new(this, 1.0 / requestedCore, requestedCore * speed, 1))
-    , requestedCore_(requestedCore)
+                model->get_maxmin_system()->variable_new(this, 1.0 / requested_core, requested_core * speed, 1))
+    , requested_core_(requested_core)
 {
-  if (model->getUpdateMechanism() == UM_LAZY) {
+  if (model->get_update_algorithm() == Model::UpdateAlgo::LAZY)
     set_last_update();
-    set_last_value(0.0);
-  }
   model->get_maxmin_system()->expand(constraint, get_variable(), 1.0);
 }
 
-CpuCas01Action::CpuCas01Action(kernel::resource::Model* model, double cost, bool failed, double speed,
-                               kernel::lmm::Constraint* constraint)
-    : CpuCas01Action(model, cost, failed, speed, constraint, 1)
+CpuCas01Action::CpuCas01Action(Model* model, double cost, bool failed, double speed, lmm::Constraint* constraint)
+    : CpuCas01Action(model, cost, failed, speed, constraint, /* requested_core */ 1)
 {
 }
 
-int CpuCas01Action::requestedCore()
+int CpuCas01Action::requested_core()
 {
-  return requestedCore_;
+  return requested_core_;
 }
 
 CpuCas01Action::~CpuCas01Action()=default;
 
-}
-}
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid