src/surf/cpu_interface.cpp

   1 /* Copyright (c) 2013-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <xbt/dynar.h>
   8 #include "cpu_interface.hpp"
   9 #include "plugins/energy.hpp"
  10
  11 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu, surf,
  13                                 "Logging specific to the SURF cpu module");
  14
  15 int autoload_surf_cpu_model = 1;
  16 void_f_void_t surf_cpu_model_init_preparse = NULL;
  17
  18 simgrid::surf::CpuModel *surf_cpu_model_pm;
  19 simgrid::surf::CpuModel *surf_cpu_model_vm;
  20
  21 namespace simgrid {
  22 namespace surf {
  23
  24 /*************
  25  * Callbacks *
  26  *************/
  27
  28 Cpu *getActionCpu(CpuAction *action) {
  29   return static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var
  30                        (action->getModel()->getMaxminSystem(),
  31                        action->getVariable(), 0)));
  32 }
  33
  34 simgrid::xbt::signal<void(CpuAction*, e_surf_action_state_t, e_surf_action_state_t)> cpuActionStateChangedCallbacks;
  35
  36 /*********
  37  * Model *
  38  *********/
  39
  40 void CpuModel::updateActionsStateLazy(double now, double /*delta*/)
  41 {
  42   CpuAction *action;
  43   while ((xbt_heap_size(getActionHeap()) > 0)
  44          && (double_equals(xbt_heap_maxkey(getActionHeap()), now, sg_surf_precision))) {
  45     action = static_cast<CpuAction*>(xbt_heap_pop(getActionHeap()));
  46     XBT_CDEBUG(surf_kernel, "Something happened to action %p", action);
  47     if (TRACE_is_enabled()) {
  48       Cpu *cpu = static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var(getMaxminSystem(), action->getVariable(), 0)));
  49       TRACE_surf_host_set_utilization(cpu->getName(), action->getCategory(),
  50                                       lmm_variable_getvalue(action->getVariable()),
  51                                       action->getLastUpdate(),
  52                                       now - action->getLastUpdate());
  53     }
  54
  55     action->finish();
  56     XBT_CDEBUG(surf_kernel, "Action %p finished", action);
  57
  58     /* set the remains to 0 due to precision problems when updating the remaining amount */
  59     action->setRemains(0);
  60     action->setState(SURF_ACTION_DONE);
  61     action->heapRemove(getActionHeap()); //FIXME: strange call since action was already popped
  62   }
  63   if (TRACE_is_enabled()) {
  64     //defining the last timestamp that we can safely dump to trace file
  65     //without losing the event ascending order (considering all CPU's)
  66     double smaller = -1;
  67     ActionList *actionSet = getRunningActionSet();
  68     for(ActionList::iterator it(actionSet->begin()), itend(actionSet->end())
  69        ; it != itend ; ++it) {
  70       action = static_cast<CpuAction*>(&*it);
  71         if (smaller < 0) {
  72           smaller = action->getLastUpdate();
  73           continue;
  74         }
  75         if (action->getLastUpdate() < smaller) {
  76           smaller = action->getLastUpdate();
  77         }
  78     }
  79     if (smaller > 0) {
  80       TRACE_last_timestamp_to_dump = smaller;
  81     }
  82   }
  83   return;
  84 }
  85
  86 void CpuModel::updateActionsStateFull(double now, double delta)
  87 {
  88   CpuAction *action = NULL;
  89   ActionList *running_actions = getRunningActionSet();
  90
  91   for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
  92      ; it != itend ; it=itNext) {
  93   ++itNext;
  94     action = static_cast<CpuAction*>(&*it);
  95     if (TRACE_is_enabled()) {
  96       Cpu *x = static_cast<Cpu*> (lmm_constraint_id(lmm_get_cnst_from_var(getMaxminSystem(), action->getVariable(), 0)) );
  97
  98       TRACE_surf_host_set_utilization(x->getName(),
  99                                       action->getCategory(),
 100                                       lmm_variable_getvalue(action->getVariable()),
 101                                       now - delta,
 102                                       delta);
 103       TRACE_last_timestamp_to_dump = now - delta;
 104     }
 105
 106     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 107
 108
 109     if (action->getMaxDuration() != NO_MAX_DURATION)
 110       action->updateMaxDuration(delta);
 111
 112
 113     if ((action->getRemainsNoUpdate() <= 0) &&
 114         (lmm_get_variable_weight(action->getVariable()) > 0)) {
 115       action->finish();
 116       action->setState(SURF_ACTION_DONE);
 117     } else if ((action->getMaxDuration() != NO_MAX_DURATION) &&
 118                (action->getMaxDuration() <= 0)) {
 119       action->finish();
 120       action->setState(SURF_ACTION_DONE);
 121     }
 122   }
 123
 124   return;
 125 }
 126
 127 /************
 128  * Resource *
 129  ************/
 130 Cpu::Cpu(Model *model, simgrid::s4u::Host *host,
 131        xbt_dynar_t speedPeakList, int pstate,
 132      int core, double speedPeak, double speedScale,
 133      int initiallyOn)
 134  : Cpu(model, host, NULL/*constraint*/, speedPeakList, pstate, core, speedPeak, speedScale, initiallyOn)
 135 {
 136 }
 137
 138 Cpu::Cpu(Model *model, simgrid::s4u::Host *host, lmm_constraint_t constraint,
 139         xbt_dynar_t speedPeakList, int pstate,
 140       int core, double speedPeak,
 141         double speedScale, int initiallyOn)
 142  : Resource(model, host->name().c_str(), constraint, initiallyOn)
 143  , m_core(core)
 144  , m_host(host)
 145 {
 146   p_speed.peak = speedPeak;
 147   p_speed.scale = speedScale;
 148   host->pimpl_cpu = this;
 149   xbt_assert(p_speed.scale > 0, "Available speed has to be >0");
 150
 151   // Copy the power peak array:
 152   p_speedPeakList = xbt_dynar_new(sizeof(double), nullptr);
 153   unsigned long n = xbt_dynar_length(speedPeakList);
 154   for (unsigned long i = 0; i != n; ++i) {
 155     double value = xbt_dynar_get_as(speedPeakList, i, double);
 156     xbt_dynar_push(p_speedPeakList, &value);
 157   }
 158
 159   m_pstate = pstate;
 160
 161   /* Currently, we assume that a VM does not have a multicore CPU. */
 162   if (core > 1)
 163     xbt_assert(model == surf_cpu_model_pm);
 164
 165   if (model->getUpdateMechanism() != UM_UNDEFINED) {
 166   p_constraintCore = xbt_new(lmm_constraint_t, core);
 167   p_constraintCoreId = xbt_new(void*, core);
 168
 169     int i;
 170     for (i = 0; i < core; i++) {
 171       /* just for a unique id, never used as a string. */
 172       p_constraintCoreId[i] = bprintf("%s:%i", host->name().c_str(), i);
 173       p_constraintCore[i] = lmm_constraint_new(model->getMaxminSystem(), p_constraintCoreId[i], p_speed.scale * p_speed.peak);
 174     }
 175   }
 176 }
 177
 178 Cpu::~Cpu()
 179 {
 180   if (p_constraintCoreId){
 181     for (int i = 0; i < m_core; i++) {
 182     xbt_free(p_constraintCoreId[i]);
 183     }
 184     xbt_free(p_constraintCore);
 185   }
 186   if (p_constraintCoreId)
 187     xbt_free(p_constraintCoreId);
 188   if (p_speedPeakList)
 189     xbt_dynar_free(&p_speedPeakList);
 190 }
 191
 192 double Cpu::getCurrentPowerPeak()
 193 {
 194   return p_speed.peak;
 195 }
 196
 197 int Cpu::getNbPStates()
 198 {
 199   return xbt_dynar_length(p_speedPeakList);
 200 }
 201
 202 void Cpu::setPState(int pstate_index)
 203 {
 204   xbt_dynar_t plist = p_speedPeakList;
 205   xbt_assert(pstate_index <= (int)xbt_dynar_length(plist),
 206       "Invalid parameters for CPU %s (pstate %d > length of pstates %d)", getName(), pstate_index, (int)xbt_dynar_length(plist));
 207
 208   double new_peak_speed = xbt_dynar_get_as(plist, pstate_index, double);
 209   m_pstate = pstate_index;
 210   p_speed.peak = new_peak_speed;
 211
 212   onSpeedChange();
 213 }
 214
 215 int Cpu::getPState()
 216 {
 217   return m_pstate;
 218 }
 219
 220 double Cpu::getPowerPeakAt(int pstate_index)
 221 {
 222   xbt_dynar_t plist = p_speedPeakList;
 223   xbt_assert((pstate_index <= (int)xbt_dynar_length(plist)), "Invalid parameters (pstate index out of bounds)");
 224
 225   return xbt_dynar_get_as(plist, pstate_index, double);
 226 }
 227
 228 double Cpu::getSpeed(double load)
 229 {
 230   return load * p_speed.peak;
 231 }
 232
 233 double Cpu::getAvailableSpeed()
 234 {
 235 /* number between 0 and 1 */
 236   return p_speed.scale;
 237 }
 238
 239 void Cpu::onSpeedChange() {
 240   TRACE_surf_host_set_speed(surf_get_clock(), getName(),
 241       m_core * p_speed.scale * p_speed.peak);
 242 }
 243
 244
 245 int Cpu::getCore()
 246 {
 247   return m_core;
 248 }
 249
 250 void Cpu::set_state_trace(tmgr_trace_t trace)
 251 {
 252   xbt_assert(p_stateEvent==NULL,"Cannot set a second state trace to Host %s", m_host->name().c_str());
 253
 254   p_stateEvent = future_evt_set->add_trace(trace, 0.0, this);
 255 }
 256 void Cpu::set_speed_trace(tmgr_trace_t trace)
 257 {
 258   xbt_assert(p_speed.event==NULL,"Cannot set a second speed trace to Host %s", m_host->name().c_str());
 259
 260   p_speed.event = future_evt_set->add_trace(trace, 0.0, this);
 261 }
 262
 263
 264 /**********
 265  * Action *
 266  **********/
 267
 268 void CpuAction::updateRemainingLazy(double now)
 269 {
 270   double delta = 0.0;
 271
 272   xbt_assert(getStateSet() == getModel()->getRunningActionSet(),
 273       "You're updating an action that is not running.");
 274
 275   /* bogus priority, skip it */
 276   xbt_assert(getPriority() > 0,
 277       "You're updating an action that seems suspended.");
 278
 279   delta = now - m_lastUpdate;
 280
 281   if (m_remains > 0) {
 282     XBT_CDEBUG(surf_kernel, "Updating action(%p): remains was %f, last_update was: %f", this, m_remains, m_lastUpdate);
 283     double_update(&(m_remains), m_lastValue * delta, sg_maxmin_precision*sg_surf_precision);
 284
 285     if (TRACE_is_enabled()) {
 286       Cpu *cpu = static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var(getModel()->getMaxminSystem(), getVariable(), 0)));
 287       TRACE_surf_host_set_utilization(cpu->getName(), getCategory(), m_lastValue, m_lastUpdate, now - m_lastUpdate);
 288     }
 289     XBT_CDEBUG(surf_kernel, "Updating action(%p): remains is now %f", this, m_remains);
 290   }
 291
 292   m_lastUpdate = now;
 293   m_lastValue = lmm_variable_getvalue(getVariable());
 294 }
 295
 296 /*
 297  *
 298  * This function formulates a constraint problem that pins a given task to
 299  * particular cores. Currently, it is possible to pin a task to an exactly one
 300  * specific core. The system links the variable object of the task to the
 301  * per-core constraint object.
 302  *
 303  * But, the taskset command on Linux takes a mask value specifying a CPU
 304  * affinity setting of a given task. If the mask value is 0x03, the given task
 305  * will be executed on the first core (CPU0) or the second core (CPU1) on the
 306  * given PM. The schedular will determine appropriate placements of tasks,
 307  * considering given CPU affinities and task activities.
 308  *
 309  * How should the system formulate constraint problems for an affinity to
 310  * multiple cores?
 311  *
 312  * The cpu argument must be the host where the task is being executed. The
 313  * action object does not have the information about the location where the
 314  * action is being executed.
 315  */
 316 void CpuAction::setAffinity(Cpu *cpu, unsigned long mask)
 317 {
 318   lmm_variable_t var_obj = getVariable();
 319   XBT_IN("(%p,%lx)", this, mask);
 320
 321   {
 322     unsigned long nbits = 0;
 323
 324     /* FIXME: There is much faster algorithms doing this. */
 325     for (int i = 0; i < cpu->m_core; i++) {
 326       unsigned long has_affinity = (1UL << i) & mask;
 327       if (has_affinity)
 328         nbits += 1;
 329     }
 330
 331     if (nbits > 1) {
 332       XBT_CRITICAL("Do not specify multiple cores for an affinity mask.");
 333       XBT_CRITICAL("See the comment in cpu_action_set_affinity().");
 334       DIE_IMPOSSIBLE;
 335     }
 336   }
 337
 338   for (int i = 0; i < cpu->m_core; i++) {
 339     XBT_DEBUG("clear affinity %p to cpu-%d@%s", this, i,  cpu->getName());
 340     lmm_shrink(cpu->getModel()->getMaxminSystem(), cpu->p_constraintCore[i], var_obj);
 341
 342     unsigned long has_affinity = (1UL << i) & mask;
 343     if (has_affinity) {
 344       /* This function only accepts an affinity setting on the host where the
 345        * task is now running. In future, a task might move to another host.
 346        * But, at this moment, this function cannot take an affinity setting on
 347        * that future host.
 348        *
 349        * It might be possible to extend the code to allow this function to
 350        * accept affinity settings on a future host. We might be able to assign
 351        * zero to elem->value to maintain such inactive affinity settings in the
 352        * system. But, this will make the system complex. */
 353       XBT_DEBUG("set affinity %p to cpu-%d@%s", this, i, cpu->getName());
 354       lmm_expand(cpu->getModel()->getMaxminSystem(), cpu->p_constraintCore[i], var_obj, 1.0);
 355     }
 356   }
 357
 358   if (cpu->getModel()->getUpdateMechanism() == UM_LAZY) {
 359     /* FIXME (hypervisor): Do we need to do something for the LAZY mode? */
 360   }
 361   XBT_OUT();
 362 }
 363
 364 simgrid::xbt::signal<void(simgrid::surf::CpuAction*, e_surf_action_state_t)> CpuAction::onStateChange;
 365
 366 void CpuAction::setState(e_surf_action_state_t state){
 367   e_surf_action_state_t previous = getState();
 368   Action::setState(state);
 369   onStateChange(this, previous);
 370 }
 371
 372 }
 373 }