Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
simplify writing in model setup + may fix issue with unit-tests
[simgrid.git] / src / surf / cpu_interface.cpp
index bbac0ef..d9a6e9f 100644 (file)
@@ -1,20 +1,19 @@
-/* Copyright (c) 2013-2018. 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_interface.hpp"
-#include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
-#include <xbt/dynar.h>
+#include "cpu_ti.hpp"
+#include "src/kernel/resource/profile/Profile.hpp"
+#include "src/surf/surf_interface.hpp"
+#include "surf/surf.hpp"
 
-XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu, surf, "Logging specific to the SURF cpu module");
-
-simgrid::surf::CpuModel *surf_cpu_model_pm;
-simgrid::surf::CpuModel *surf_cpu_model_vm;
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(res_cpu, ker_resource, "CPU resource, fueling execution activites");
 
 namespace simgrid {
-namespace surf {
+namespace kernel {
+namespace resource {
 
 /*********
  * Model *
@@ -22,53 +21,27 @@ namespace surf {
 
 void CpuModel::update_actions_state_lazy(double now, double /*delta*/)
 {
-  while (not actionHeapIsEmpty() && double_equals(actionHeapTopDate(), now, sg_surf_precision)) {
-
-    CpuAction* action = static_cast<CpuAction*>(actionHeapPop());
-    XBT_CDEBUG(surf_kernel, "Something happened to action %p", action);
-    if (TRACE_is_enabled()) {
-      Cpu* cpu = static_cast<Cpu*>(action->get_variable()->get_constraint(0)->get_id());
-      TRACE_surf_host_set_utilization(cpu->getCname(), action->get_category(), action->get_variable()->get_value(),
-                                      action->get_last_update(), now - action->get_last_update());
-    }
+  while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
+    auto* action = static_cast<CpuAction*>(get_action_heap().pop());
+    XBT_DEBUG("Something happened to action %p", action);
 
-    action->finish(kernel::resource::Action::State::done);
-    XBT_CDEBUG(surf_kernel, "Action %p finished", action);
-  }
-  if (TRACE_is_enabled()) {
-    //defining the last timestamp that we can safely dump to trace file
-    //without losing the event ascending order (considering all CPU's)
-    double smaller = -1;
-    for (kernel::resource::Action const& action : *get_running_action_set()) {
-      if (smaller < 0 || action.get_last_update() < smaller)
-        smaller = action.get_last_update();
-    }
-    if (smaller > 0) {
-      TRACE_last_timestamp_to_dump = smaller;
-    }
+    action->finish(kernel::resource::Action::State::FINISHED);
+    XBT_DEBUG("Action %p finished", action);
   }
 }
 
-void CpuModel::update_actions_state_full(double now, double delta)
+void CpuModel::update_actions_state_full(double /*now*/, double delta)
 {
-  for (auto it = std::begin(*get_running_action_set()); it != std::end(*get_running_action_set());) {
-    CpuAction& action = static_cast<CpuAction&>(*it);
+  for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
+    auto& action = static_cast<CpuAction&>(*it);
     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
-    if (TRACE_is_enabled()) {
-      Cpu* cpu = static_cast<Cpu*>(action.get_variable()->get_constraint(0)->get_id());
-      TRACE_surf_host_set_utilization(cpu->getCname(), action.get_category(), action.get_variable()->get_value(),
-                                      now - delta, delta);
-      TRACE_last_timestamp_to_dump = now - delta;
-    }
-
-    action.update_remains(action.get_variable()->get_value() * delta);
 
-    if (action.get_max_duration() != NO_MAX_DURATION)
-      action.update_max_duration(delta);
+    action.update_remains(action.get_rate() * delta);
+    action.update_max_duration(delta);
 
-    if (((action.get_remains_no_update() <= 0) && (action.get_variable()->get_weight() > 0)) ||
+    if (((action.get_remains_no_update() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
         ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
-      action.finish(kernel::resource::Action::State::done);
+      action.finish(Action::State::FINISHED);
     }
   }
 }
@@ -76,136 +49,158 @@ void CpuModel::update_actions_state_full(double now, double delta)
 /************
  * Resource *
  ************/
-Cpu::Cpu(kernel::resource::Model* model, simgrid::s4u::Host* host, std::vector<double>* speedPerPstate, int core)
-    : Cpu(model, host, nullptr /*constraint*/, speedPerPstate, core)
+CpuImpl::CpuImpl(s4u::Host* host, const std::vector<double>& speed_per_pstate)
+    : Resource_T(host->get_cname()), piface_(host), speed_per_pstate_(speed_per_pstate)
 {
+  speed_.scale    = 1;
+  speed_.peak     = speed_per_pstate_.front();
+  host->set_cpu(this);
 }
 
-Cpu::Cpu(kernel::resource::Model* model, simgrid::s4u::Host* host, kernel::lmm::Constraint* constraint,
-         std::vector<double>* speedPerPstate, int core)
-    : Resource(model, host->getCname(), constraint), coresAmount_(core), host_(host)
+void CpuImpl::reset_vcpu(CpuImpl* that)
 {
-  xbt_assert(core > 0, "Host %s must have at least one core, not 0.", host->getCname());
+  this->pstate_ = that->pstate_;
+  this->speed_  = that->speed_;
+  this->speed_per_pstate_.clear();
+  this->speed_per_pstate_.assign(that->speed_per_pstate_.begin(), that->speed_per_pstate_.end());
+}
 
-  speed_.peak = speedPerPstate->front();
-  speed_.scale = 1;
-  host->pimpl_cpu = this;
-  xbt_assert(speed_.scale > 0, "Speed of host %s must be >0", host->getCname());
+CpuImpl* CpuImpl::set_pstate(unsigned long pstate_index)
+{
+  xbt_assert(
+      pstate_index <= speed_per_pstate_.size(),
+      "Invalid parameters for CPU %s (pstate %lu > length of pstates %d). Please fix your platform file, or your "
+      "call to change the pstate.",
+      get_cname(), pstate_index, static_cast<int>(speed_per_pstate_.size()));
 
-  // Copy the power peak array:
-  for (double const& value : *speedPerPstate) {
-    speedPerPstate_.push_back(value);
-  }
-}
+  double new_peak_speed = speed_per_pstate_[pstate_index];
+  pstate_               = pstate_index;
+  speed_.peak           = new_peak_speed;
 
-Cpu::~Cpu() = default;
+  on_speed_change();
+  return this;
+}
 
-int Cpu::getNbPStates()
+CpuImpl* CpuImpl::set_pstate_speed(const std::vector<double>& speed_per_state)
 {
-  return speedPerPstate_.size();
+  xbt_assert(not speed_per_state.empty(), "CPU %s: processor speed vector cannot be empty", get_cname());
+  xbt_assert(not is_sealed(), "CPU %s: processor speed cannot be changed once CPU has been sealed", get_cname());
+  speed_per_pstate_ = speed_per_state;
+  speed_.peak       = speed_per_pstate_.front();
+  return this;
 }
 
-void Cpu::setPState(int pstate_index)
+double CpuImpl::get_pstate_peak_speed(unsigned long pstate_index) const
 {
-  xbt_assert(pstate_index <= static_cast<int>(speedPerPstate_.size()),
-             "Invalid parameters for CPU %s (pstate %d > length of pstates %d). Please fix your platform file, or your "
-             "call to change the pstate.",
-             getCname(), pstate_index, static_cast<int>(speedPerPstate_.size()));
-
-  double new_peak_speed = speedPerPstate_[pstate_index];
-  pstate_ = pstate_index;
-  speed_.peak = new_peak_speed;
+  xbt_assert((pstate_index <= speed_per_pstate_.size()), "Invalid parameters (pstate index out of bounds)");
 
-  onSpeedChange();
+  return speed_per_pstate_[pstate_index];
 }
 
-int Cpu::getPState()
+void CpuImpl::on_speed_change()
 {
-  return pstate_;
+  s4u::Host::on_speed_change(*piface_);
 }
 
-double Cpu::getPstateSpeed(int pstate_index)
+CpuImpl* CpuImpl::set_core_count(int core_count)
 {
-  xbt_assert((pstate_index <= static_cast<int>(speedPerPstate_.size())), "Invalid parameters (pstate index out of bounds)");
+  xbt_assert(not is_sealed(), "Core count cannot be changed once CPU has been sealed");
+  xbt_assert(core_count > 0, "Host %s must have at least one core, not 0.", piface_->get_cname());
+  if (dynamic_cast<CpuTiModel*>(get_model()) != nullptr)
+    xbt_assert(core_count == 1, "Multi-core not handled by this model yet");
 
-  return speedPerPstate_[pstate_index];
+  core_count_ = core_count;
+  return this;
 }
 
-double Cpu::getSpeed(double load)
+void CpuImpl::apply_sharing_policy_cfg() const
 {
-  return load * speed_.peak;
+  if (!get_constraint())
+    return;
+
+  kernel::lmm::Constraint::SharingPolicy lmm_policy = kernel::lmm::Constraint::SharingPolicy::SHARED;
+  if (sharing_policy_ == s4u::Host::SharingPolicy::NONLINEAR)
+    lmm_policy = kernel::lmm::Constraint::SharingPolicy::NONLINEAR;
+
+  get_constraint()->set_sharing_policy(lmm_policy, sharing_policy_cb_);
 }
 
-double Cpu::getAvailableSpeed()
+void CpuImpl::set_sharing_policy(s4u::Host::SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
 {
-/* number between 0 and 1 */
-  return speed_.scale;
+  xbt_assert(dynamic_cast<CpuTiModel*>(get_model()) == nullptr, "Cannot change sharing policy with CPU:TI model");
+  sharing_policy_    = policy;
+  sharing_policy_cb_ = cb;
+  apply_sharing_policy_cfg();
 }
 
-void Cpu::onSpeedChange() {
-  TRACE_surf_host_set_speed(surf_get_clock(), getCname(), coresAmount_ * speed_.scale * speed_.peak);
-  s4u::Host::onSpeedChange(*host_);
+s4u::Host::SharingPolicy CpuImpl::get_sharing_policy() const
+{
+  return sharing_policy_;
 }
 
-int Cpu::coreCount()
+int CpuImpl::get_core_count()
 {
-  return coresAmount_;
+  return core_count_;
 }
 
-void Cpu::setStateTrace(tmgr_trace_t trace)
+CpuImpl* CpuImpl::set_speed_profile(kernel::profile::Profile* profile)
 {
-  xbt_assert(stateEvent_ == nullptr, "Cannot set a second state trace to Host %s", host_->getCname());
-
-  stateEvent_ = future_evt_set->add_trace(trace, this);
+  if (profile) {
+    xbt_assert(speed_.event == nullptr, "Cannot set a second speed trace to Host %s", piface_->get_cname());
+    speed_.event = profile->schedule(&profile::future_evt_set, this);
+  }
+  return this;
 }
-void Cpu::setSpeedTrace(tmgr_trace_t trace)
-{
-  xbt_assert(speed_.event == nullptr, "Cannot set a second speed trace to Host %s", host_->getCname());
 
-  speed_.event = future_evt_set->add_trace(trace, this);
+void CpuImpl::seal()
+{
+  if (is_sealed()) {
+    return;
+  }
+  lmm::System* lmm = get_model()->get_maxmin_system();
+  if (dynamic_cast<CpuTiModel*>(get_model()) == nullptr)
+    this->set_constraint(lmm->constraint_new(this, core_count_ * speed_per_pstate_.front()));
+  apply_sharing_policy_cfg();
+  Resource::seal();
 }
 
-
 /**********
  * Action *
  **********/
 
 void CpuAction::update_remains_lazy(double now)
 {
-  xbt_assert(get_state_set() == get_model()->get_running_action_set(),
+  xbt_assert(get_state_set() == get_model()->get_started_action_set(),
              "You're updating an action that is not running.");
-  xbt_assert(get_priority() > 0, "You're updating an action that seems suspended.");
+  xbt_assert(get_sharing_penalty() > 0, "You're updating an action that seems suspended.");
 
   double delta = now - get_last_update();
 
   if (get_remains_no_update() > 0) {
-    XBT_CDEBUG(surf_kernel, "Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
-               get_last_update());
+    XBT_DEBUG("Updating action(%p): remains was %f, last_update was: %f", this, get_remains_no_update(),
+              get_last_update());
     update_remains(get_last_value() * delta);
 
-    if (TRACE_is_enabled()) {
-      Cpu* cpu = static_cast<Cpu*>(get_variable()->get_constraint(0)->get_id());
-      TRACE_surf_host_set_utilization(cpu->getCname(), get_category(), get_last_value(), get_last_update(),
-                                      now - get_last_update());
-    }
-    XBT_CDEBUG(surf_kernel, "Updating action(%p): remains is now %f", this, get_remains_no_update());
+    XBT_DEBUG("Updating action(%p): remains is now %f", this, get_remains_no_update());
   }
 
   set_last_update();
-  set_last_value(get_variable()->get_value());
+  set_last_value(get_rate());
 }
 
-simgrid::xbt::signal<void(simgrid::surf::CpuAction*, kernel::resource::Action::State)> CpuAction::onStateChange;
+xbt::signal<void(CpuAction const&, Action::State)> CpuAction::on_state_change;
 
-void CpuAction::suspend(){
+void CpuAction::suspend()
+{
   Action::State previous = get_state();
-  onStateChange(this, previous);
+  on_state_change(*this, previous);
   Action::suspend();
 }
 
-void CpuAction::resume(){
+void CpuAction::resume()
+{
   Action::State previous = get_state();
-  onStateChange(this, previous);
+  on_state_change(*this, previous);
   Action::resume();
 }
 
@@ -213,25 +208,26 @@ void CpuAction::set_state(Action::State state)
 {
   Action::State previous = get_state();
   Action::set_state(state);
-  onStateChange(this, previous);
+  on_state_change(*this, previous);
 }
+
 /** @brief returns a list of all CPUs that this action is using */
-std::list<Cpu*> CpuAction::cpus() {
-  std::list<Cpu*> retlist;
+std::list<CpuImpl*> CpuAction::cpus() const
+{
+  std::list<CpuImpl*> retlist;
   int llen = get_variable()->get_number_of_constraint();
 
   for (int i = 0; i < llen; i++) {
     /* Beware of composite actions: ptasks put links and cpus together */
     // extra pb: we cannot dynamic_cast from void*...
-    kernel::resource::Resource* resource =
-        static_cast<kernel::resource::Resource*>(get_variable()->get_constraint(i)->get_id());
-    Cpu* cpu           = dynamic_cast<Cpu*>(resource);
+    Resource* resource = get_variable()->get_constraint(i)->get_id();
+    auto* cpu          = dynamic_cast<CpuImpl*>(resource);
     if (cpu != nullptr)
       retlist.push_back(cpu);
   }
 
   return retlist;
 }
-
-}
-}
+} // namespace resource
+} // namespace kernel
+} // namespace simgrid