Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
snake_case some parts of kernel::resource::Cpu
[simgrid.git] / src / surf / cpu_interface.cpp
index c1ab0e1..727c602 100644 (file)
-/* Copyright (c) 2013-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2013-2018. 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 <xbt/dynar.h>
 #include "cpu_interface.hpp"
-#include "plugins/energy.hpp"
-#include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
+#include "src/instr/instr_private.hpp" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
+#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");
 
-void_f_void_t surf_cpu_model_init_preparse = nullptr;
-
 simgrid::surf::CpuModel *surf_cpu_model_pm;
 simgrid::surf::CpuModel *surf_cpu_model_vm;
 
 namespace simgrid {
 namespace surf {
 
-/*************
- * Callbacks *
- *************/
-
-simgrid::xbt::signal<void(CpuAction*, Action::State, Action::State)> cpuActionStateChangedCallbacks;
-
 /*********
  * Model *
  *********/
 
-CpuModel::~CpuModel() {}
-
-void CpuModel::updateActionsStateLazy(double now, double /*delta*/)
+void CpuModel::update_actions_state_lazy(double now, double /*delta*/)
 {
-  CpuAction *action;
-  while ((xbt_heap_size(getActionHeap()) > 0)
-         && (double_equals(xbt_heap_maxkey(getActionHeap()), now, sg_surf_precision))) {
-    action = static_cast<CpuAction*>(xbt_heap_pop(getActionHeap()));
+  while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
+
+    CpuAction* action = static_cast<CpuAction*>(get_action_heap().pop());
     XBT_CDEBUG(surf_kernel, "Something happened to action %p", action);
-    if (TRACE_is_enabled()) {
-      Cpu *cpu = static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var(getMaxminSystem(), action->getVariable(), 0)));
-      TRACE_surf_host_set_utilization(cpu->getName(), action->getCategory(),
-                                      lmm_variable_getvalue(action->getVariable()),
-                                      action->getLastUpdate(),
-                                      now - action->getLastUpdate());
-    }
 
-    action->finish();
+    action->finish(kernel::resource::Action::State::FINISHED);
     XBT_CDEBUG(surf_kernel, "Action %p finished", action);
-
-    /* set the remains to 0 due to precision problems when updating the remaining amount */
-    action->setRemains(0);
-    action->setState(Action::State::done);
-    action->heapRemove(getActionHeap()); //FIXME: strange call since action was already popped
   }
   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;
-    ActionList *actionSet = getRunningActionSet();
-    for(ActionList::iterator it(actionSet->begin()), itend(actionSet->end())
-       ; it != itend ; ++it) {
-      action = static_cast<CpuAction*>(&*it);
-        if (smaller < 0) {
-          smaller = action->getLastUpdate();
-          continue;
-        }
-        if (action->getLastUpdate() < smaller) {
-          smaller = action->getLastUpdate();
-        }
+    for (kernel::resource::Action const& action : *get_started_action_set()) {
+      if (smaller < 0 || action.get_last_update() < smaller)
+        smaller = action.get_last_update();
     }
     if (smaller > 0) {
       TRACE_last_timestamp_to_dump = smaller;
     }
   }
-  return;
 }
 
-void CpuModel::updateActionsStateFull(double now, double delta)
+void CpuModel::update_actions_state_full(double now, double delta)
 {
-  CpuAction *action = nullptr;
-  ActionList *running_actions = getRunningActionSet();
-
-  for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
-     ; it != itend ; it=itNext) {
-    ++itNext;
-    action = static_cast<CpuAction*>(&*it);
-    if (TRACE_is_enabled()) {
-      Cpu *cpu = static_cast<Cpu*> (lmm_constraint_id(lmm_get_cnst_from_var(getMaxminSystem(), action->getVariable(), 0)) );
-
-      TRACE_surf_host_set_utilization(cpu->getName(),
-                                      action->getCategory(),
-                                      lmm_variable_getvalue(action->getVariable()),
-                                      now - delta,
-                                      delta);
-      TRACE_last_timestamp_to_dump = now - delta;
-    }
+  for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
+    CpuAction& action = static_cast<CpuAction&>(*it);
+    ++it; // increment iterator here since the following calls to action.finish() may invalidate it
 
-    action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
+    action.update_remains(action.get_variable()->get_value() * delta);
 
+    if (action.get_max_duration() != NO_MAX_DURATION)
+      action.update_max_duration(delta);
 
-    if (action->getMaxDuration() != NO_MAX_DURATION)
-      action->updateMaxDuration(delta);
-
-
-    if ((action->getRemainsNoUpdate() <= 0) &&
-        (lmm_get_variable_weight(action->getVariable()) > 0)) {
-      action->finish();
-      action->setState(Action::State::done);
-    } else if ((action->getMaxDuration() != NO_MAX_DURATION) &&
-               (action->getMaxDuration() <= 0)) {
-      action->finish();
-      action->setState(Action::State::done);
+    if (((action.get_remains_no_update() <= 0) && (action.get_variable()->get_weight() > 0)) ||
+        ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
+      action.finish(kernel::resource::Action::State::FINISHED);
     }
   }
 }
 
-bool CpuModel::next_occuring_event_isIdempotent()
-{
-  return true;
-}
-
 /************
  * Resource *
  ************/
-Cpu::Cpu(Model *model, simgrid::s4u::Host *host, xbt_dynar_t speedPerPstate, int core)
: Cpu(model, host, nullptr/*constraint*/, speedPerPstate, core)
+Cpu::Cpu(kernel::resource::Model* model, simgrid::s4u::Host* host, std::vector<double>* speedPerPstate, int core)
   : Cpu(model, host, nullptr /*constraint*/, speedPerPstate, core)
 {
 }
 
-Cpu::Cpu(Model *model, simgrid::s4u::Host *host, lmm_constraint_t constraint,
-    xbt_dynar_t speedPerPstate, int core)
- : Resource(model, host->name().c_str(), constraint)
- , coresAmount_(core)
- , host_(host)
+Cpu::Cpu(kernel::resource::Model* model, simgrid::s4u::Host* host, kernel::lmm::Constraint* constraint,
+         std::vector<double>* speedPerPstate, int core)
+    : Resource(model, host->get_cname(), constraint), cores_count_(core), host_(host)
 {
-  xbt_assert(core > 0, "Host %s must have at least one core, not 0.", host->name().c_str());
+  xbt_assert(core > 0, "Host %s must have at least one core, not 0.", host->get_cname());
 
-  speed_.peak = xbt_dynar_get_as(speedPerPstate, 0/*pstate*/, double);
+  speed_.peak = speedPerPstate->front();
   speed_.scale = 1;
   host->pimpl_cpu = this;
-  xbt_assert(speed_.scale > 0, "Speed of host %s must be >0", host->name().c_str());
+  xbt_assert(speed_.scale > 0, "Speed of host %s must be >0", host->get_cname());
 
   // Copy the power peak array:
-  speedPerPstate_ = xbt_dynar_new(sizeof(double), nullptr);
-  unsigned long n = xbt_dynar_length(speedPerPstate);
-  for (unsigned long i = 0; i != n; ++i) {
-    double value = xbt_dynar_get_as(speedPerPstate, i, double);
-    xbt_dynar_push(speedPerPstate_, &value);
-  }
-
-  xbt_assert(model == surf_cpu_model_pm || core==1, "Currently, VM cannot be multicore");
-
-  if (model->getUpdateMechanism() != UM_UNDEFINED) {
-    p_constraintCore = xbt_new(lmm_constraint_t, core);
-    p_constraintCoreId = xbt_new(void*, core);
-
-    for (int i = 0; i < core; i++) {
-      /* just for a unique id, never used as a string. */
-      p_constraintCoreId[i] = bprintf("%s:%i", host->name().c_str(), i);
-      p_constraintCore[i] = lmm_constraint_new(model->getMaxminSystem(), p_constraintCoreId[i], speed_.scale * speed_.peak);
-    }
-  }
-}
-
-Cpu::~Cpu()
-{
-  if (p_constraintCoreId){
-    for (int i = 0; i < coresAmount_; i++)
-      xbt_free(p_constraintCoreId[i]);
-    xbt_free(p_constraintCore);
+  for (double const& value : *speedPerPstate) {
+    speed_per_pstate_.push_back(value);
   }
-  xbt_free(p_constraintCoreId);
-  xbt_dynar_free(&speedPerPstate_);
 }
 
-double Cpu::getPstateSpeedCurrent()
-{
-  return speed_.peak;
-}
+Cpu::~Cpu() = default;
 
-int Cpu::getNbPStates()
+int Cpu::get_pstates_count()
 {
-  return xbt_dynar_length(speedPerPstate_);
+  return speed_per_pstate_.size();
 }
 
-void Cpu::setPState(int pstate_index)
+void Cpu::set_pstate(int pstate_index)
 {
-  xbt_dynar_t plist = speedPerPstate_;
-  xbt_assert(pstate_index <= (int)xbt_dynar_length(plist),
-      "Invalid parameters for CPU %s (pstate %d > length of pstates %d)", getName(), pstate_index, (int)xbt_dynar_length(plist));
+  xbt_assert(pstate_index <= static_cast<int>(speed_per_pstate_.size()),
+             "Invalid parameters for CPU %s (pstate %d > 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()));
 
-  double new_peak_speed = xbt_dynar_get_as(plist, pstate_index, double);
+  double new_peak_speed = speed_per_pstate_[pstate_index];
   pstate_ = pstate_index;
   speed_.peak = new_peak_speed;
 
   onSpeedChange();
 }
 
-int Cpu::getPState()
+int Cpu::get_pstate()
 {
   return pstate_;
 }
 
 double Cpu::getPstateSpeed(int pstate_index)
 {
-  xbt_dynar_t plist = speedPerPstate_;
-  xbt_assert((pstate_index <= (int)xbt_dynar_length(plist)), "Invalid parameters (pstate index out of bounds)");
+  xbt_assert((pstate_index <= static_cast<int>(speed_per_pstate_.size())),
+             "Invalid parameters (pstate index out of bounds)");
 
-  return xbt_dynar_get_as(plist, pstate_index, double);
+  return speed_per_pstate_[pstate_index];
 }
 
 double Cpu::getSpeed(double load)
@@ -217,33 +127,32 @@ double Cpu::getSpeed(double load)
   return load * speed_.peak;
 }
 
-double Cpu::getAvailableSpeed()
+double Cpu::get_available_speed()
 {
 /* number between 0 and 1 */
   return speed_.scale;
 }
 
 void Cpu::onSpeedChange() {
-  TRACE_surf_host_set_speed(surf_get_clock(), getName(), coresAmount_ * speed_.scale * speed_.peak);
+  s4u::Host::on_speed_change(*host_);
 }
 
-
-int Cpu::getCore()
+int Cpu::get_cores_count()
 {
-  return coresAmount_;
+  return cores_count_;
 }
 
 void Cpu::setStateTrace(tmgr_trace_t trace)
 {
-  xbt_assert(stateEvent_==nullptr,"Cannot set a second state trace to Host %s", host_->name().c_str());
+  xbt_assert(state_event_ == nullptr, "Cannot set a second state trace to Host %s", host_->get_cname());
 
-  stateEvent_ = future_evt_set->add_trace(trace, 0.0, this);
+  state_event_ = future_evt_set->add_trace(trace, this);
 }
-void Cpu::setSpeedTrace(tmgr_trace_t trace)
+void Cpu::set_speed_trace(tmgr_trace_t trace)
 {
-  xbt_assert(speed_.event==nullptr,"Cannot set a second speed trace to Host %s", host_->name().c_str());
+  xbt_assert(speed_.event == nullptr, "Cannot set a second speed trace to Host %s", host_->get_cname());
 
-  speed_.event = future_evt_set->add_trace(trace, 0.0, this);
+  speed_.event = future_evt_set->add_trace(trace, this);
 }
 
 
@@ -251,106 +160,65 @@ void Cpu::setSpeedTrace(tmgr_trace_t trace)
  * Action *
  **********/
 
-void CpuAction::updateRemainingLazy(double now)
+void CpuAction::update_remains_lazy(double now)
 {
-  xbt_assert(getStateSet() == getModel()->getRunningActionSet(), "You're updating an action that is not running.");
-  xbt_assert(getPriority() > 0, "You're updating an action that seems suspended.");
+  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.");
 
-  double delta = now - lastUpdate_;
+  double delta = now - get_last_update();
 
-  if (remains_ > 0) {
-    XBT_CDEBUG(surf_kernel, "Updating action(%p): remains was %f, last_update was: %f", this, remains_, lastUpdate_);
-    double_update(&(remains_), lastValue_ * delta, sg_maxmin_precision*sg_surf_precision);
+  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());
+    update_remains(get_last_value() * delta);
 
     if (TRACE_is_enabled()) {
-      Cpu *cpu = static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
-      TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), lastValue_, lastUpdate_, now - lastUpdate_);
+      Cpu* cpu = static_cast<Cpu*>(get_variable()->get_constraint(0)->get_id());
+      TRACE_surf_resource_set_utilization("HOST", "power_used", cpu->get_cname(), get_category(), get_last_value(),
+                                          get_last_update(), now - get_last_update());
     }
-    XBT_CDEBUG(surf_kernel, "Updating action(%p): remains is now %f", this, remains_);
+    XBT_CDEBUG(surf_kernel, "Updating action(%p): remains is now %f", this, get_remains_no_update());
   }
 
-  lastUpdate_ = now;
-  lastValue_ = lmm_variable_getvalue(getVariable());
+  set_last_update();
+  set_last_value(get_variable()->get_value());
 }
 
-/*
- *
- * This function formulates a constraint problem that pins a given task to
- * particular cores. Currently, it is possible to pin a task to an exactly one
- * specific core. The system links the variable object of the task to the
- * per-core constraint object.
- *
- * But, the taskset command on Linux takes a mask value specifying a CPU
- * affinity setting of a given task. If the mask value is 0x03, the given task
- * will be executed on the first core (CPU0) or the second core (CPU1) on the
- * given PM. The schedular will determine appropriate placements of tasks,
- * considering given CPU affinities and task activities.
- *
- * How should the system formulate constraint problems for an affinity to
- * multiple cores?
- *
- * The cpu argument must be the host where the task is being executed. The
- * action object does not have the information about the location where the
- * action is being executed.
- */
-void CpuAction::setAffinity(Cpu *cpu, unsigned long mask)
-{
-  lmm_variable_t var_obj = getVariable();
-  XBT_IN("(%p,%lx)", this, mask);
-
-  {
-    unsigned long nbits = 0;
-
-    /* FIXME: There is much faster algorithms doing this. */
-    for (int i = 0; i < cpu->coresAmount_; i++) {
-      unsigned long has_affinity = (1UL << i) & mask;
-      if (has_affinity)
-        nbits += 1;
-    }
-
-    xbt_assert(nbits <= 1, "Affinity mask cannot span over multiple cores.");
-  }
-
-  for (int i = 0; i < cpu->coresAmount_; i++) {
-    XBT_DEBUG("clear affinity %p to cpu-%d@%s", this, i,  cpu->getName());
-    lmm_shrink(cpu->getModel()->getMaxminSystem(), cpu->p_constraintCore[i], var_obj);
-
-    unsigned long has_affinity = (1UL << i) & mask;
-    if (has_affinity) {
-      /* This function only accepts an affinity setting on the host where the
-       * task is now running. In future, a task might move to another host.
-       * But, at this moment, this function cannot take an affinity setting on
-       * that future host.
-       *
-       * It might be possible to extend the code to allow this function to
-       * accept affinity settings on a future host. We might be able to assign
-       * zero to elem->value to maintain such inactive affinity settings in the
-       * system. But, this will make the system complex. */
-      XBT_DEBUG("set affinity %p to cpu-%d@%s", this, i, cpu->getName());
-      lmm_expand(cpu->getModel()->getMaxminSystem(), cpu->p_constraintCore[i], var_obj, 1.0);
-    }
-  }
+simgrid::xbt::signal<void(simgrid::surf::CpuAction*, kernel::resource::Action::State)> CpuAction::onStateChange;
 
-  if (cpu->getModel()->getUpdateMechanism() == UM_LAZY) {
-    /* FIXME (hypervisor): Do we need to do something for the LAZY mode? */
-  }
-  XBT_OUT();
+void CpuAction::suspend(){
+  Action::State previous = get_state();
+  onStateChange(this, previous);
+  Action::suspend();
 }
 
-simgrid::xbt::signal<void(simgrid::surf::CpuAction*, Action::State)> CpuAction::onStateChange;
+void CpuAction::resume(){
+  Action::State previous = get_state();
+  onStateChange(this, previous);
+  Action::resume();
+}
 
-void CpuAction::setState(Action::State state){
-  Action::State previous = getState();
-  Action::setState(state);
+void CpuAction::set_state(Action::State state)
+{
+  Action::State previous = get_state();
+  Action::set_state(state);
   onStateChange(this, previous);
 }
+/** @brief returns a list of all CPUs that this action is using */
 std::list<Cpu*> CpuAction::cpus() {
   std::list<Cpu*> retlist;
-  lmm_system_t sys = getModel()->getMaxminSystem();
-  int llen = lmm_get_number_of_cnst_from_var(sys, getVariable());
-
-  for(int i = 0; i<llen; i++)
-    retlist.push_back( (Cpu*)(lmm_constraint_id( lmm_get_cnst_from_var(sys, getVariable(), i) )) );
+  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);
+    if (cpu != nullptr)
+      retlist.push_back(cpu);
+  }
 
   return retlist;
 }