Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make model name constant
[simgrid.git] / src / surf / cpu_ti.cpp
index eb5574a..f030e46 100644 (file)
@@ -1,19 +1,23 @@
-/* Copyright (c) 2013-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2013-2021. 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_ti.hpp"
+#include "simgrid/kernel/routing/NetZoneImpl.hpp"
+#include "simgrid/s4u/Engine.hpp"
+#include "src/kernel/EngineImpl.hpp"
 #include "src/kernel/resource/profile/Event.hpp"
 #include "src/kernel/resource/profile/Profile.hpp"
 #include "src/surf/surf_interface.hpp"
 #include "surf/surf.hpp"
 
 #include <algorithm>
+#include <memory>
 
 constexpr double EPSILON = 0.000000001;
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu_ti, surf_cpu, "Logging specific to the SURF CPU TRACE INTEGRATION module");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cpu_ti, res_cpu, "CPU resource, Trace Integration model");
 
 namespace simgrid {
 namespace kernel {
@@ -23,14 +27,14 @@ namespace resource {
  * Trace *
  *********/
 
-CpuTiProfile::CpuTiProfile(profile::Profile* profile)
+CpuTiProfile::CpuTiProfile(const profile::Profile* profile)
 {
-  double integral = 0;
-  double time = 0;
-  unsigned nb_points = profile->event_list.size() + 1;
+  double integral    = 0;
+  double time        = 0;
+  unsigned nb_points = profile->get_event_list().size() + 1;
   time_points_.reserve(nb_points);
   integral_.reserve(nb_points);
-  for (auto const& val : profile->event_list) {
+  for (auto const& val : profile->get_event_list()) {
     time_points_.push_back(time);
     integral_.push_back(integral);
     time += val.date_;
@@ -50,11 +54,12 @@ CpuTiProfile::CpuTiProfile(profile::Profile* profile)
  * @param b      End of interval
  * @return the integrate value. -1 if an error occurs.
  */
-double CpuTiTmgr::integrate(double a, double b)
+double CpuTiTmgr::integrate(double a, double b) const
 {
   if ((a < 0.0) || (a > b)) {
     xbt_die("Error, invalid integration interval [%.2f,%.2f]. "
-        "You probably have a task executing with negative computation amount. Check your code.", a, b);
+            "You probably have a task executing with negative computation amount. Check your code.",
+            a, b);
   }
   if (fabs(a - b) < EPSILON)
     return 0.0;
@@ -63,21 +68,20 @@ double CpuTiTmgr::integrate(double a, double b)
     return (b - a) * value_;
   }
 
-  int a_index;
+  double a_index;
   if (fabs(ceil(a / last_time_) - a / last_time_) < EPSILON)
-    a_index = 1 + static_cast<int>(ceil(a / last_time_));
+    a_index = 1 + ceil(a / last_time_);
   else
-    a_index = static_cast<int>(ceil(a / last_time_));
-
-  int b_index = static_cast<int>(floor(b / last_time_));
+    a_index = ceil(a / last_time_);
+  double b_index = floor(b / last_time_);
 
-  if (a_index > b_index) {      /* Same chunk */
-    return profile_->integrate_simple(a - (a_index - 1) * last_time_, b - (b_index)*last_time_);
+  if (a_index > b_index) { /* Same chunk */
+    return profile_->integrate_simple(a - (a_index - 1) * last_time_, b - b_index * last_time_);
   }
 
   double first_chunk  = profile_->integrate_simple(a - (a_index - 1) * last_time_, last_time_);
   double middle_chunk = (b_index - a_index) * total_;
-  double last_chunk   = profile_->integrate_simple(0.0, b - (b_index)*last_time_);
+  double last_chunk   = profile_->integrate_simple(0.0, b - b_index * last_time_);
 
   XBT_DEBUG("first_chunk=%.2f  middle_chunk=%.2f  last_chunk=%.2f\n", first_chunk, middle_chunk, last_chunk);
 
@@ -90,7 +94,7 @@ double CpuTiTmgr::integrate(double a, double b)
  * @param a  Initial point
  * @param b  Final point
  */
-double CpuTiProfile::integrate_simple(double a, double b)
+double CpuTiProfile::integrate_simple(double a, double b) const
 {
   return integrate_simple_point(b) - integrate_simple_point(a);
 }
@@ -99,10 +103,10 @@ double CpuTiProfile::integrate_simple(double a, double b)
  * @brief Auxiliary function to compute the integral at point a.
  * @param a        point
  */
-double CpuTiProfile::integrate_simple_point(double a)
+double CpuTiProfile::integrate_simple_point(double a) const
 {
   double integral = 0;
-  double a_aux = a;
+  double a_aux    = a;
   int ind         = binary_search(time_points_, a);
   integral += integral_[ind];
 
@@ -126,7 +130,7 @@ double CpuTiProfile::integrate_simple_point(double a)
  * @param amount  Amount to be executed
  * @return  End time
  */
-double CpuTiTmgr::solve(double a, double amount)
+double CpuTiTmgr::solve(double a, double amount) const
 {
   /* Fix very small negative numbers */
   if ((a < 0.0) && (a > -EPSILON)) {
@@ -137,11 +141,10 @@ double CpuTiTmgr::solve(double a, double amount)
   }
 
   /* Sanity checks */
-  if ((a < 0.0) || (amount < 0.0)) {
-    XBT_CRITICAL ("Error, invalid parameters [a = %.2f, amount = %.2f]. "
-        "You probably have a task executing with negative computation amount. Check your code.", a, amount);
-    xbt_abort();
-  }
+  xbt_assert(a >= 0.0 && amount >= 0.0,
+             "Error, invalid parameters [a = %.2f, amount = %.2f]. "
+             "You probably have a task executing with negative computation amount. Check your code.",
+             a, amount);
 
   /* At this point, a and amount are positive */
   if (amount < EPSILON)
@@ -154,11 +157,11 @@ double CpuTiTmgr::solve(double a, double amount)
 
   XBT_DEBUG("amount %f total %f", amount, total_);
   /* Reduce the problem to one where amount <= trace_total */
-  int quotient = static_cast<int>(floor(amount / total_));
+  double quotient       = floor(amount / total_);
   double reduced_amount = (total_) * ((amount / total_) - floor(amount / total_));
   double reduced_a      = a - (last_time_) * static_cast<int>(floor(a / last_time_));
 
-  XBT_DEBUG("Quotient: %d reduced_amount: %f reduced_a: %f", quotient, reduced_amount, reduced_a);
+  XBT_DEBUG("Quotient: %g reduced_amount: %f reduced_a: %f", quotient, reduced_amount, reduced_a);
 
   /* Now solve for new_amount which is <= trace_total */
   double reduced_b;
@@ -172,7 +175,7 @@ double CpuTiTmgr::solve(double a, double amount)
   }
 
   /* Re-map to the original b and amount */
-  return (last_time_) * static_cast<int>(floor(a / last_time_)) + (quotient * last_time_) + reduced_b;
+  return last_time_ * floor(a / last_time_) + (quotient * last_time_) + reduced_b;
 }
 
 /**
@@ -182,7 +185,7 @@ double CpuTiTmgr::solve(double a, double amount)
  * @param amount  Amount of flops
  * @return The date when amount is available.
  */
-double CpuTiProfile::solve_simple(double a, double amount)
+double CpuTiProfile::solve_simple(double a, double amount) const
 {
   double integral_a = integrate_simple_point(a);
   int ind           = binary_search(integral_, integral_a + amount);
@@ -200,11 +203,11 @@ double CpuTiProfile::solve_simple(double a, double amount)
  * @param a        Time
  * @return CPU speed scale
  */
-double CpuTiTmgr::get_power_scale(double a)
+double CpuTiTmgr::get_power_scale(double a) const
 {
-  double reduced_a          = a - floor(a / last_time_) * last_time_;
+  double reduced_a                = a - floor(a / last_time_) * last_time_;
   int point                       = CpuTiProfile::binary_search(profile_->time_points_, reduced_a);
-  kernel::profile::DatedValue val = speed_profile_->event_list.at(point);
+  kernel::profile::DatedValue val = speed_profile_->get_event_list().at(point);
   return val.value_;
 }
 
@@ -222,26 +225,24 @@ CpuTiTmgr::CpuTiTmgr(kernel::profile::Profile* speed_profile, double value) : sp
 
   /* no availability file, fixed trace */
   if (not speed_profile) {
-    type_  = Type::FIXED;
     value_ = value;
     XBT_DEBUG("No availability trace. Constant value = %f", value);
     return;
   }
 
   /* only one point available, fixed trace */
-  if (speed_profile->event_list.size() == 1) {
-    type_  = Type::FIXED;
-    value_ = speed_profile->event_list.front().value_;
+  if (speed_profile->get_event_list().size() == 1) {
+    value_ = speed_profile->get_event_list().front().value_;
     return;
   }
 
   type_ = Type::DYNAMIC;
 
   /* count the total time of trace file */
-  for (auto const& val : speed_profile->event_list)
+  for (auto const& val : speed_profile->get_event_list())
     total_time += val.date_;
 
-  profile_.reset(new CpuTiProfile(speed_profile));
+  profile_   = std::make_unique<CpuTiProfile>(speed_profile);
   last_time_ = total_time;
   total_     = profile_->integrate_simple(0, total_time);
 
@@ -267,31 +268,19 @@ int CpuTiProfile::binary_search(const std::vector<double>& array, double a)
  * Model *
  *********/
 
-void CpuTiModel::create_pm_vm_models()
-{
-  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.");
-
-  surf_cpu_model_pm = new simgrid::kernel::resource::CpuTiModel();
-  surf_cpu_model_vm = new simgrid::kernel::resource::CpuTiModel();
-}
-
-CpuTiModel::CpuTiModel() : CpuModel(Model::UpdateAlgo::FULL)
+void CpuTiModel::create_pm_models()
 {
-  all_existing_models.push_back(this);
+  auto cpu_model_pm = std::make_shared<CpuTiModel>("Cpu_TI");
+  simgrid::kernel::EngineImpl::get_instance()->add_model(cpu_model_pm);
+  simgrid::s4u::Engine::get_instance()->get_netzone_root()->get_impl()->set_cpu_pm_model(cpu_model_pm);
 }
 
-CpuTiModel::~CpuTiModel()
+Cpu* CpuTiModel::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate)
 {
-  surf_cpu_model_pm = nullptr;
+  return (new CpuTi(host, speed_per_pstate))->set_model(this);
 }
 
-kernel::resource::Cpu* CpuTiModel::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate, int core)
-{
-  return new CpuTi(this, host, speed_per_pstate, core);
-}
-
-double CpuTiModel::next_occuring_event(double now)
+double CpuTiModel::next_occurring_event(double now)
 {
   double min_action_duration = -1;
 
@@ -314,9 +303,9 @@ double CpuTiModel::next_occuring_event(double now)
 void CpuTiModel::update_actions_state(double now, double /*delta*/)
 {
   while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
-    CpuTiAction* action = static_cast<CpuTiAction*>(get_action_heap().pop());
+    auto* action = static_cast<CpuTiAction*>(get_action_heap().pop());
     XBT_DEBUG("Action %p: finish", action);
-    action->finish(kernel::resource::Action::State::FINISHED);
+    action->finish(Action::State::FINISHED);
     /* update remaining amount of all actions */
     action->cpu_->update_remaining_amount(surf_get_clock());
   }
@@ -325,11 +314,8 @@ void CpuTiModel::update_actions_state(double now, double /*delta*/)
 /************
  * Resource *
  ************/
-CpuTi::CpuTi(CpuTiModel* model, simgrid::s4u::Host* host, const std::vector<double>& speed_per_pstate, int core)
-    : Cpu(model, host, speed_per_pstate, core)
+CpuTi::CpuTi(s4u::Host* host, const std::vector<double>& speed_per_pstate) : Cpu(host, speed_per_pstate)
 {
-  xbt_assert(core == 1, "Multi-core not handled by this model yet");
-
   speed_.peak = speed_per_pstate.front();
   XBT_DEBUG("CPU create: peak=%f", speed_.peak);
 
@@ -341,17 +327,18 @@ CpuTi::~CpuTi()
   set_modified(false);
   delete speed_integrated_trace_;
 }
+
 void CpuTi::set_speed_profile(kernel::profile::Profile* profile)
 {
   delete speed_integrated_trace_;
   speed_integrated_trace_ = new CpuTiTmgr(profile, speed_.scale);
 
   /* add a fake trace event if periodicity == 0 */
-  if (profile && profile->event_list.size() > 1) {
-    kernel::profile::DatedValue val = profile->event_list.back();
+  if (profile && profile->get_event_list().size() > 1) {
+    kernel::profile::DatedValue val = profile->get_event_list().back();
     if (val.date_ < 1e-12) {
-      simgrid::kernel::profile::Profile* prof = new simgrid::kernel::profile::Profile();
-      speed_.event                            = prof->schedule(&profile::future_evt_set, this);
+      auto* prof   = new kernel::profile::Profile();
+      speed_.event = prof->schedule(&profile::future_evt_set, this);
     }
   }
 }
@@ -375,20 +362,19 @@ void CpuTi::apply_event(kernel::profile::Event* event, double value)
   } else if (event == state_event_) {
     if (value > 0) {
       if (not is_on()) {
-        XBT_VERB("Restart processes on host %s", get_host()->get_cname());
-        get_host()->turn_on();
+        XBT_VERB("Restart actors on host %s", get_iface()->get_cname());
+        get_iface()->turn_on();
       }
     } else {
-      get_host()->turn_off();
+      get_iface()->turn_off();
       double date = surf_get_clock();
 
       /* put all action running on cpu to failed */
       for (CpuTiAction& action : action_set_) {
-        if (action.get_state() == kernel::resource::Action::State::INITED ||
-            action.get_state() == kernel::resource::Action::State::STARTED ||
-            action.get_state() == kernel::resource::Action::State::IGNORED) {
+        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);
           get_model()->get_action_heap().remove(&action);
         }
       }
@@ -410,30 +396,30 @@ void CpuTi::update_actions_finish_time(double now)
   sum_priority_ = 0.0;
   for (CpuTiAction const& action : action_set_) {
     /* action not running, skip it */
-    if (action.get_state_set() != surf_cpu_model_pm->get_started_action_set())
+    if (action.get_state_set() != get_model()->get_started_action_set())
       continue;
 
     /* bogus priority, skip it */
-    if (action.get_priority() <= 0)
+    if (action.get_sharing_penalty() <= 0)
       continue;
 
     /* action suspended, skip it */
     if (not action.is_running())
       continue;
 
-    sum_priority_ += 1.0 / action.get_priority();
+    sum_priority_ += 1.0 / action.get_sharing_penalty();
   }
 
   for (CpuTiAction& action : action_set_) {
     double min_finish = -1;
     /* action not running, skip it */
-    if (action.get_state_set() != surf_cpu_model_pm->get_started_action_set())
+    if (action.get_state_set() != get_model()->get_started_action_set())
       continue;
 
     /* verify if the action is really running on cpu */
-    if (action.is_running() && action.get_priority() > 0) {
+    if (action.is_running() && action.get_sharing_penalty() > 0) {
       /* total area needed to finish the action. Used in trace integration */
-      double total_area = (action.get_remains() * sum_priority_ * action.get_priority()) / speed_.peak;
+      double total_area = (action.get_remains() * sum_priority_ * action.get_sharing_penalty()) / speed_.peak;
 
       action.set_finish_time(speed_integrated_trace_->solve(now, total_area));
       /* verify which event will happen before (max_duration or finish time) */
@@ -449,7 +435,7 @@ void CpuTi::update_actions_finish_time(double now)
     }
     /* add in action heap */
     if (min_finish != NO_MAX_DURATION)
-      get_model()->get_action_heap().update(&action, min_finish, kernel::resource::ActionHeap::Type::unset);
+      get_model()->get_action_heap().update(&action, min_finish, ActionHeap::Type::unset);
     else
       get_model()->get_action_heap().remove(&action);
 
@@ -460,7 +446,7 @@ void CpuTi::update_actions_finish_time(double now)
   set_modified(false);
 }
 
-bool CpuTi::is_used()
+bool CpuTi::is_used() const
 {
   return not action_set_.empty();
 }
@@ -487,7 +473,7 @@ void CpuTi::update_remaining_amount(double now)
       continue;
 
     /* bogus priority, skip it */
-    if (action.get_priority() <= 0)
+    if (action.get_sharing_penalty() <= 0)
       continue;
 
     /* action suspended, skip it */
@@ -503,16 +489,16 @@ void CpuTi::update_remaining_amount(double now)
       continue;
 
     /* update remaining */
-    action.update_remains(area_total / (sum_priority_ * action.get_priority()));
+    action.update_remains(area_total / (sum_priority_ * action.get_sharing_penalty()));
     XBT_DEBUG("Update remaining action(%p) remaining %f", &action, action.get_remains_no_update());
   }
   last_update_ = now;
 }
 
-kernel::resource::CpuAction* CpuTi::execution_start(double size)
+CpuAction* CpuTi::execution_start(double size)
 {
   XBT_IN("(%s,%g)", get_cname(), size);
-  CpuTiAction* action = new CpuTiAction(this, size);
+  auto* action = new CpuTiAction(this, size);
 
   action_set_.push_back(*action); // Actually start the action
 
@@ -520,18 +506,18 @@ kernel::resource::CpuAction* CpuTi::execution_start(double size)
   return action;
 }
 
-kernel::resource::CpuAction* CpuTi::sleep(double duration)
+CpuAction* CpuTi::sleep(double duration)
 {
   if (duration > 0)
     duration = std::max(duration, sg_surf_precision);
 
   XBT_IN("(%s,%g)", get_cname(), duration);
-  CpuTiAction* action = new CpuTiAction(this, 1.0);
+  auto* action = new CpuTiAction(this, 1.0);
 
   action->set_max_duration(duration);
-  action->set_suspend_state(kernel::resource::Action::SuspendStates::SLEEPING);
+  action->set_suspend_state(Action::SuspendStates::SLEEPING);
   if (duration == NO_MAX_DURATION)
-    action->set_state(simgrid::kernel::resource::Action::State::IGNORED);
+    action->set_state(Action::State::IGNORED);
 
   action_set_.push_back(*action);
 
@@ -548,7 +534,7 @@ void CpuTi::set_modified(bool modified)
     }
   } else {
     if (cpu_ti_hook.is_linked())
-      simgrid::xbt::intrusive_erase(modified_cpus, *this);
+      xbt::intrusive_erase(modified_cpus, *this);
   }
 }
 
@@ -564,7 +550,7 @@ CpuTiAction::~CpuTiAction()
 {
   /* remove from action_set */
   if (action_ti_hook.is_linked())
-    simgrid::xbt::intrusive_erase(cpu_->action_set_, *this);
+    xbt::intrusive_erase(cpu_->action_set_, *this);
   /* remove from heap */
   get_model()->get_action_heap().remove(this);
   cpu_->set_modified(true);
@@ -619,15 +605,15 @@ void CpuTiAction::set_max_duration(double duration)
     min_finish = get_finish_time();
 
   /* add in action heap */
-  get_model()->get_action_heap().update(this, min_finish, kernel::resource::ActionHeap::Type::unset);
+  get_model()->get_action_heap().update(this, min_finish, ActionHeap::Type::unset);
 
   XBT_OUT();
 }
 
-void CpuTiAction::set_priority(double priority)
+void CpuTiAction::set_sharing_penalty(double sharing_penalty)
 {
-  XBT_IN("(%p,%g)", this, priority);
-  set_priority_no_update(priority);
+  XBT_IN("(%p,%g)", this, sharing_penalty);
+  set_sharing_penalty_no_update(sharing_penalty);
   cpu_->set_modified(true);
   XBT_OUT();
 }