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 #include "src/instr/instr_private.h" // TRACE_is_enabled(). FIXME: remove by subscribing tracing to the surf signals
  11
  12 XBT_LOG_EXTERNAL_CATEGORY(surf_kernel);
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu, surf,
  14                                 "Logging specific to the SURF cpu module");
  15
  16 int autoload_surf_cpu_model = 1;
  17 void_f_void_t surf_cpu_model_init_preparse = NULL;
  18
  19 simgrid::surf::CpuModel *surf_cpu_model_pm;
  20 simgrid::surf::CpuModel *surf_cpu_model_vm;
  21
  22 namespace simgrid {
  23 namespace surf {
  24
  25 /*************
  26  * Callbacks *
  27  *************/
  28
  29 std::list<Cpu*> getActionCpus(CpuAction *action) {
  30   std::list<Cpu*> retlist;
  31   lmm_system_t sys = action->getModel()->getMaxminSystem();
  32   int llen = lmm_get_number_of_cnst_from_var(sys, action->getVariable());
  33
  34   for(int i = 0; i<llen; i++) {
  35     retlist.push_back( (Cpu*)(lmm_constraint_id( lmm_get_cnst_from_var(sys, action->getVariable(), i) )) );
  36   }
  37   return retlist;
  38 }
  39
  40 simgrid::xbt::signal<void(CpuAction*, e_surf_action_state_t, e_surf_action_state_t)> cpuActionStateChangedCallbacks;
  41
  42 /*********
  43  * Model *
  44  *********/
  45
  46 void CpuModel::updateActionsStateLazy(double now, double /*delta*/)
  47 {
  48   CpuAction *action;
  49   while ((xbt_heap_size(getActionHeap()) > 0)
  50          && (double_equals(xbt_heap_maxkey(getActionHeap()), now, sg_surf_precision))) {
  51     action = static_cast<CpuAction*>(xbt_heap_pop(getActionHeap()));
  52     XBT_CDEBUG(surf_kernel, "Something happened to action %p", action);
  53     if (TRACE_is_enabled()) {
  54       Cpu *cpu = static_cast<Cpu*>(lmm_constraint_id(lmm_get_cnst_from_var(getMaxminSystem(), action->getVariable(), 0)));
  55       TRACE_surf_host_set_utilization(cpu->getName(), action->getCategory(),
  56                                       lmm_variable_getvalue(action->getVariable()),
  57                                       action->getLastUpdate(),
  58                                       now - action->getLastUpdate());
  59     }
  60
  61     action->finish();
  62     XBT_CDEBUG(surf_kernel, "Action %p finished", action);
  63
  64     /* set the remains to 0 due to precision problems when updating the remaining amount */
  65     action->setRemains(0);
  66     action->setState(SURF_ACTION_DONE);
  67     action->heapRemove(getActionHeap()); //FIXME: strange call since action was already popped
  68   }
  69   if (TRACE_is_enabled()) {
  70     //defining the last timestamp that we can safely dump to trace file
  71     //without losing the event ascending order (considering all CPU's)
  72     double smaller = -1;
  73     ActionList *actionSet = getRunningActionSet();
  74     for(ActionList::iterator it(actionSet->begin()), itend(actionSet->end())
  75        ; it != itend ; ++it) {
  76       action = static_cast<CpuAction*>(&*it);
  77         if (smaller < 0) {
  78           smaller = action->getLastUpdate();
  79           continue;
  80         }
  81         if (action->getLastUpdate() < smaller) {
  82           smaller = action->getLastUpdate();
  83         }
  84     }
  85     if (smaller > 0) {
  86       TRACE_last_timestamp_to_dump = smaller;
  87     }
  88   }
  89   return;
  90 }
  91
  92 void CpuModel::updateActionsStateFull(double now, double delta)
  93 {
  94   CpuAction *action = NULL;
  95   ActionList *running_actions = getRunningActionSet();
  96
  97   for(ActionList::iterator it(running_actions->begin()), itNext=it, itend(running_actions->end())
  98      ; it != itend ; it=itNext) {
  99   ++itNext;
 100     action = static_cast<CpuAction*>(&*it);
 101     if (TRACE_is_enabled()) {
 102       Cpu *x = static_cast<Cpu*> (lmm_constraint_id(lmm_get_cnst_from_var(getMaxminSystem(), action->getVariable(), 0)) );
 103
 104       TRACE_surf_host_set_utilization(x->getName(),
 105                                       action->getCategory(),
 106                                       lmm_variable_getvalue(action->getVariable()),
 107                                       now - delta,
 108                                       delta);
 109       TRACE_last_timestamp_to_dump = now - delta;
 110     }
 111
 112     action->updateRemains(lmm_variable_getvalue(action->getVariable()) * delta);
 113
 114
 115     if (action->getMaxDuration() != NO_MAX_DURATION)
 116       action->updateMaxDuration(delta);
 117
 118
 119     if ((action->getRemainsNoUpdate() <= 0) &&
 120         (lmm_get_variable_weight(action->getVariable()) > 0)) {
 121       action->finish();
 122       action->setState(SURF_ACTION_DONE);
 123     } else if ((action->getMaxDuration() != NO_MAX_DURATION) &&
 124                (action->getMaxDuration() <= 0)) {
 125       action->finish();
 126       action->setState(SURF_ACTION_DONE);
 127     }
 128   }
 129
 130   return;
 131 }
 132
 133 /************
 134  * Resource *
 135  ************/
 136 Cpu::Cpu(Model *model, simgrid::s4u::Host *host,
 137     xbt_dynar_t speedPerPstate, int core, double speedPeak)
 138  : Cpu(model, host, NULL/*constraint*/, speedPerPstate, core, speedPeak)
 139 {
 140 }
 141
 142 Cpu::Cpu(Model *model, simgrid::s4u::Host *host, lmm_constraint_t constraint,
 143     xbt_dynar_t speedPerPstate, int core, double speedPeak)
 144  : Resource(model, host->name().c_str(), constraint)
 145  , coresAmount_(core)
 146  , host_(host)
 147 {
 148   speed_.peak = speedPeak;
 149   speed_.scale = 1;
 150   host->pimpl_cpu = this;
 151   xbt_assert(speed_.scale > 0, "Available speed has to be >0");
 152
 153   // Copy the power peak array:
 154   speedPerPstate_ = xbt_dynar_new(sizeof(double), nullptr);
 155   unsigned long n = xbt_dynar_length(speedPerPstate);
 156   for (unsigned long i = 0; i != n; ++i) {
 157     double value = xbt_dynar_get_as(speedPerPstate, i, double);
 158     xbt_dynar_push(speedPerPstate_, &value);
 159   }
 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], speed_.scale * speed_.peak);
 174     }
 175   }
 176 }
 177
 178 Cpu::~Cpu()
 179 {
 180   if (p_constraintCoreId){
 181     for (int i = 0; i < coresAmount_; 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 (speedPerPstate_)
 189     xbt_dynar_free(&speedPerPstate_);
 190 }
 191
 192 double Cpu::getCurrentPowerPeak()
 193 {
 194   return speed_.peak;
 195 }
 196
 197 int Cpu::getNbPStates()
 198 {
 199   return xbt_dynar_length(speedPerPstate_);
 200 }
 201
 202 void Cpu::setPState(int pstate_index)
 203 {
 204   xbt_dynar_t plist = speedPerPstate_;
 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   pstate_ = pstate_index;
 210   speed_.peak = new_peak_speed;
 211
 212   onSpeedChange();
 213 }
 214
 215 int Cpu::getPState()
 216 {
 217   return pstate_;
 218 }
 219
 220 double Cpu::getPowerPeakAt(int pstate_index)
 221 {
 222   xbt_dynar_t plist = speedPerPstate_;
 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 * speed_.peak;
 231 }
 232
 233 double Cpu::getAvailableSpeed()
 234 {
 235 /* number between 0 and 1 */
 236   return speed_.scale;
 237 }
 238
 239 void Cpu::onSpeedChange() {
 240   TRACE_surf_host_set_speed(surf_get_clock(), getName(),
 241       coresAmount_ * speed_.scale * speed_.peak);
 242 }
 243
 244
 245 int Cpu::getCore()
 246 {
 247   return coresAmount_;
 248 }
 249
 250 void Cpu::setStateTrace(tmgr_trace_t trace)
 251 {
 252   xbt_assert(stateEvent_==NULL,"Cannot set a second state trace to Host %s", host_->name().c_str());
 253
 254   stateEvent_ = future_evt_set->add_trace(trace, 0.0, this);
 255 }
 256 void Cpu::setSpeedTrace(tmgr_trace_t trace)
 257 {
 258   xbt_assert(speed_.event==NULL,"Cannot set a second speed trace to Host %s", host_->name().c_str());
 259
 260   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->coresAmount_; 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->coresAmount_; 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 }