src/surf/cpu_ti.cpp

   1 /* Copyright (c) 2013-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "cpu_ti.hpp"
   7 #include "simgrid/kernel/routing/NetZoneImpl.hpp"
   8 #include "simgrid/s4u/Engine.hpp"
   9 #include "xbt/asserts.h"
  10 #include "src/kernel/EngineImpl.hpp"
  11 #include "src/kernel/resource/profile/Event.hpp"
  12 #include "src/kernel/resource/profile/Profile.hpp"
  13 #include "src/surf/surf_interface.hpp"
  14
  15 #include <algorithm>
  16 #include <memory>
  17
  18 constexpr double EPSILON = 0.000000001;
  19
  20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cpu_ti, res_cpu, "CPU resource, Trace Integration model");
  21
  22 namespace simgrid {
  23 namespace kernel {
  24 namespace resource {
  25
  26 /*********
  27  * Trace *
  28  *********/
  29
  30 CpuTiProfile::CpuTiProfile(const profile::Profile* profile)
  31 {
  32   double integral    = 0;
  33   double time        = 0;
  34   double prev_value  = 1;
  35   const std::vector<profile::DatedValue>& events=profile->get_event_list();
  36   xbt_assert(not events.empty());
  37   unsigned long nb_points = events.size() + 1;
  38   time_points_.reserve(nb_points);
  39   integral_.reserve(nb_points);
  40   for (auto const& val :  events) {
  41     time += val.date_;
  42     integral += val.date_ * prev_value;
  43     time_points_.push_back(time);
  44     integral_.push_back(integral);
  45     prev_value = val.value_;
  46   }
  47
  48   double delay=profile->get_repeat_delay()+ events.at(0).date_;
  49
  50   xbt_assert( events.back().value_==prev_value,"Profiles need to end as they start");
  51   time += delay;
  52   integral += delay*prev_value;
  53
  54   time_points_.push_back(time);
  55   integral_.push_back(integral);
  56 }
  57
  58 /**
  59  * @brief Integrate trace
  60  *
  61  * Wrapper around surf_cpu_integrate_trace_simple() to get
  62  * the cyclic effect.
  63  *
  64  * @param a      Begin of interval
  65  * @param b      End of interval
  66  * @return the integrate value. -1 if an error occurs.
  67  */
  68 double CpuTiTmgr::integrate(double a, double b) const
  69 {
  70   xbt_assert(a >= 0.0 && a <= b,
  71              "Error, invalid integration interval [%.2f,%.2f]. You probably have a task executing with negative "
  72              "computation amount. Check your code.",
  73              a, b);
  74   if (fabs(a - b) < EPSILON)
  75     return 0.0;
  76
  77   if (type_ == Type::FIXED) {
  78     return (b - a) * value_;
  79   }
  80
  81   double a_index;
  82   if (fabs(ceil(a / last_time_) - a / last_time_) < EPSILON)
  83     a_index = 1 + ceil(a / last_time_);
  84   else
  85     a_index = ceil(a / last_time_);
  86   double b_index = floor(b / last_time_);
  87
  88   if (a_index > b_index) { /* Same chunk */
  89     return profile_->integrate_simple(a - (a_index - 1) * last_time_, b - b_index * last_time_);
  90   }
  91
  92   double first_chunk  = profile_->integrate_simple(a - (a_index - 1) * last_time_, last_time_);
  93   double middle_chunk = (b_index - a_index) * total_;
  94   double last_chunk   = profile_->integrate_simple(0.0, b - b_index * last_time_);
  95
  96   XBT_DEBUG("first_chunk=%.2f  middle_chunk=%.2f  last_chunk=%.2f\n", first_chunk, middle_chunk, last_chunk);
  97
  98   return (first_chunk + middle_chunk + last_chunk);
  99 }
 100
 101 /**
 102  * @brief Auxiliary function to compute the integral between a and b.
 103  *     It simply computes the integrals at point a and b and returns the difference between them.
 104  * @param a  Initial point
 105  * @param b  Final point
 106  */
 107 double CpuTiProfile::integrate_simple(double a, double b) const
 108 {
 109   return integrate_simple_point(b) - integrate_simple_point(a);
 110 }
 111
 112 /**
 113  * @brief Auxiliary function to compute the integral at point a.
 114  * @param a        point
 115  */
 116 double CpuTiProfile::integrate_simple_point(double a) const
 117 {
 118   double integral = 0;
 119   double a_aux    = a;
 120   long ind        = binary_search(time_points_, a);
 121   integral += integral_[ind];
 122
 123   XBT_DEBUG("a %f ind %ld integral %f ind + 1 %f ind %f time +1 %f time %f", a, ind, integral, integral_[ind + 1],
 124             integral_[ind], time_points_[ind + 1], time_points_[ind]);
 125   double_update(&a_aux, time_points_[ind], sg_maxmin_precision * sg_surf_precision);
 126   if (a_aux > 0)
 127     integral +=
 128         ((integral_[ind + 1] - integral_[ind]) / (time_points_[ind + 1] - time_points_[ind])) * (a - time_points_[ind]);
 129   XBT_DEBUG("Integral a %f = %f", a, integral);
 130
 131   return integral;
 132 }
 133
 134 /**
 135  * @brief Computes the time needed to execute "amount" on cpu.
 136  *
 137  * Here, amount can span multiple trace periods
 138  *
 139  * @param a        Initial time
 140  * @param amount  Amount to be executed
 141  * @return  End time
 142  */
 143 double CpuTiTmgr::solve(double a, double amount) const
 144 {
 145   /* Fix very small negative numbers */
 146   if ((a < 0.0) && (a > -EPSILON)) {
 147     a = 0.0;
 148   }
 149   if ((amount < 0.0) && (amount > -EPSILON)) {
 150     amount = 0.0;
 151   }
 152
 153   /* Sanity checks */
 154   xbt_assert(a >= 0.0 && amount >= 0.0,
 155              "Error, invalid parameters [a = %.2f, amount = %.2f]. "
 156              "You probably have a task executing with negative computation amount. Check your code.",
 157              a, amount);
 158
 159   /* At this point, a and amount are positive */
 160   if (amount < EPSILON)
 161     return a;
 162
 163   /* Is the trace fixed ? */
 164   if (type_ == Type::FIXED) {
 165     return (a + (amount / value_));
 166   }
 167
 168   XBT_DEBUG("amount %f total %f", amount, total_);
 169   /* Reduce the problem to one where amount <= trace_total */
 170   double quotient       = floor(amount / total_);
 171   double reduced_amount = total_ * ((amount / total_) - floor(amount / total_));
 172   double reduced_a      = a - last_time_ * static_cast<int>(floor(a / last_time_));
 173
 174   XBT_DEBUG("Quotient: %g reduced_amount: %f reduced_a: %f", quotient, reduced_amount, reduced_a);
 175
 176   /* Now solve for new_amount which is <= trace_total */
 177   XBT_DEBUG("Solve integral: [%.2f, amount=%.2f]", reduced_a, reduced_amount);
 178
 179   double amount_till_end = integrate(reduced_a, last_time_);
 180   double reduced_b       = amount_till_end > reduced_amount
 181                                ? profile_->solve_simple(reduced_a, reduced_amount)
 182                                : last_time_ + profile_->solve_simple(0.0, reduced_amount - amount_till_end);
 183
 184   /* Re-map to the original b and amount */
 185   return last_time_ * floor(a / last_time_) + (quotient * last_time_) + reduced_b;
 186 }
 187
 188 /**
 189  * @brief Auxiliary function to solve integral.
 190  *  It returns the date when the requested amount of flops is available
 191  * @param a        Initial point
 192  * @param amount  Amount of flops
 193  * @return The date when amount is available.
 194  */
 195 double CpuTiProfile::solve_simple(double a, double amount) const
 196 {
 197   double integral_a = integrate_simple_point(a);
 198   long ind          = binary_search(integral_, integral_a + amount);
 199   double time       = time_points_[ind];
 200   time += (integral_a + amount - integral_[ind]) /
 201           ((integral_[ind + 1] - integral_[ind]) / (time_points_[ind + 1] - time_points_[ind]));
 202
 203   return time;
 204 }
 205
 206 /**
 207  * @brief Auxiliary function to update the CPU speed scale.
 208  *
 209  *  This function uses the trace structure to return the speed scale at the determined time a.
 210  * @param a        Time
 211  * @return CPU speed scale
 212  */
 213 double CpuTiTmgr::get_power_scale(double a) const
 214 {
 215   double reduced_a        = a - floor(a / last_time_) * last_time_;
 216   long point              = CpuTiProfile::binary_search(profile_->get_time_points(), reduced_a);
 217   profile::DatedValue val = speed_profile_->get_event_list().at(point);
 218   return val.value_;
 219 }
 220
 221 /**
 222  * @brief Creates a new integration trace from a tmgr_trace_t
 223  *
 224  * @param  speed_trace    CPU availability trace
 225  * @param  value          Percentage of CPU speed available (useful to fixed tracing)
 226  * @return  Integration trace structure
 227  */
 228 CpuTiTmgr::CpuTiTmgr(kernel::profile::Profile* speed_profile, double value) : speed_profile_(speed_profile)
 229 {
 230   double total_time = 0.0;
 231   profile_.reset(nullptr);
 232
 233   /* no availability file, fixed trace */
 234   if (not speed_profile) {
 235     value_ = value;
 236     XBT_DEBUG("No availability trace. Constant value = %f", value);
 237     return;
 238   }
 239
 240   xbt_assert(speed_profile->is_repeating());
 241
 242   /* only one point available, fixed trace */
 243   if (speed_profile->get_event_list().size() == 1) {
 244     value_ = speed_profile->get_event_list().front().value_;
 245     return;
 246   }
 247
 248   type_ = Type::DYNAMIC;
 249
 250   /* count the total time of trace file */
 251   for (auto const& val : speed_profile->get_event_list())
 252     total_time += val.date_;
 253   total_time += speed_profile->get_repeat_delay();
 254
 255   profile_   = std::make_unique<CpuTiProfile>(speed_profile);
 256   last_time_ = total_time;
 257   total_     = profile_->integrate_simple(0, total_time);
 258
 259   XBT_DEBUG("Total integral %f, last_time %f ", total_, last_time_);
 260 }
 261
 262 /**
 263  * @brief Binary search in array.
 264  *  It returns the last point of the interval in which "a" is.
 265  * @param array    Array
 266  * @param a        Value to search
 267  * @return Index of point
 268  */
 269 long CpuTiProfile::binary_search(const std::vector<double>& array, double a)
 270 {
 271   if (array[0] > a)
 272     return 0;
 273   auto pos = std::upper_bound(begin(array), end(array), a);
 274   return std::distance(begin(array), pos) - 1;
 275 }
 276
 277 /*********
 278  * Model *
 279  *********/
 280
 281 void CpuTiModel::create_pm_models()
 282 {
 283   auto cpu_model_pm = std::make_shared<CpuTiModel>("Cpu_TI");
 284   auto* engine      = EngineImpl::get_instance();
 285   engine->add_model(cpu_model_pm);
 286   engine->get_netzone_root()->set_cpu_pm_model(cpu_model_pm);
 287 }
 288
 289 CpuImpl* CpuTiModel::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate)
 290 {
 291   return (new CpuTi(host, speed_per_pstate))->set_model(this);
 292 }
 293
 294 double CpuTiModel::next_occurring_event(double now)
 295 {
 296   double min_action_duration = -1;
 297
 298   /* iterates over modified cpus to update share resources */
 299   for (auto it = std::begin(modified_cpus_); it != std::end(modified_cpus_);) {
 300     CpuTi& cpu = *it;
 301     ++it; // increment iterator here since the following call to ti.update_actions_finish_time() may invalidate it
 302     cpu.update_actions_finish_time(now);
 303   }
 304
 305   /* get the min next event if heap not empty */
 306   if (not get_action_heap().empty())
 307     min_action_duration = get_action_heap().top_date() - now;
 308
 309   XBT_DEBUG("Share resources, min next event date: %f", min_action_duration);
 310
 311   return min_action_duration;
 312 }
 313
 314 void CpuTiModel::update_actions_state(double now, double /*delta*/)
 315 {
 316   while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
 317     auto* action = static_cast<CpuTiAction*>(get_action_heap().pop());
 318     XBT_DEBUG("Action %p: finish", action);
 319     action->finish(Action::State::FINISHED);
 320     /* update remaining amount of all actions */
 321     action->cpu_->update_remaining_amount(EngineImpl::get_clock());
 322   }
 323 }
 324
 325 /************
 326  * Resource *
 327  ************/
 328 CpuTi::CpuTi(s4u::Host* host, const std::vector<double>& speed_per_pstate) : CpuImpl(host, speed_per_pstate)
 329 {
 330   speed_.peak = speed_per_pstate.front();
 331   XBT_DEBUG("CPU create: peak=%f", speed_.peak);
 332
 333   speed_integrated_trace_ = new CpuTiTmgr(nullptr, 1 /*scale*/);
 334 }
 335
 336 CpuTi::~CpuTi()
 337 {
 338   set_modified(false);
 339   delete speed_integrated_trace_;
 340 }
 341
 342 CpuImpl* CpuTi::set_speed_profile(kernel::profile::Profile* profile)
 343 {
 344   delete speed_integrated_trace_;
 345   speed_integrated_trace_ = new CpuTiTmgr(profile, speed_.scale);
 346
 347   /* add a fake trace event if periodicity == 0 */
 348   if (profile && profile->get_event_list().size() > 1) {
 349     kernel::profile::DatedValue val = profile->get_event_list().back();
 350     if (val.date_ < 1e-12) {
 351       auto* prof   = profile::ProfileBuilder::from_void();
 352       speed_.event = prof->schedule(&profile::future_evt_set, this);
 353     }
 354   }
 355   return this;
 356 }
 357
 358 void CpuTi::apply_event(kernel::profile::Event* event, double value)
 359 {
 360   if (event == speed_.event) {
 361     XBT_DEBUG("Speed changed in trace! New fixed value: %f", value);
 362
 363     /* update remaining of actions and put in modified cpu list */
 364     update_remaining_amount(EngineImpl::get_clock());
 365
 366     set_modified(true);
 367
 368     delete speed_integrated_trace_;
 369     speed_integrated_trace_ = new CpuTiTmgr(value);
 370
 371     speed_.scale = value;
 372     tmgr_trace_event_unref(&speed_.event);
 373
 374   } else if (event == get_state_event()) {
 375     if (value > 0) {
 376       if (not is_on()) {
 377         XBT_VERB("Restart actors on host %s", get_iface()->get_cname());
 378         get_iface()->turn_on();
 379       }
 380     } else {
 381       get_iface()->turn_off();
 382       double date = EngineImpl::get_clock();
 383
 384       /* put all action running on cpu to failed */
 385       for (CpuTiAction& action : action_set_) {
 386         if (action.get_state() == Action::State::INITED || action.get_state() == Action::State::STARTED ||
 387             action.get_state() == Action::State::IGNORED) {
 388           action.set_finish_time(date);
 389           action.set_state(Action::State::FAILED);
 390           get_model()->get_action_heap().remove(&action);
 391         }
 392       }
 393     }
 394     unref_state_event();
 395
 396   } else {
 397     xbt_die("Unknown event!\n");
 398   }
 399 }
 400
 401 /** Update the actions that are running on this CPU (which was modified recently) */
 402 void CpuTi::update_actions_finish_time(double now)
 403 {
 404   /* update remaining amount of actions */
 405   update_remaining_amount(now);
 406
 407   /* Compute the sum of priorities for the actions running on that CPU */
 408   sum_priority_ = 0.0;
 409   for (CpuTiAction const& action : action_set_) {
 410     /* action not running, skip it */
 411     if (action.get_state_set() != get_model()->get_started_action_set())
 412       continue;
 413
 414     /* bogus priority, skip it */
 415     if (action.get_sharing_penalty() <= 0)
 416       continue;
 417
 418     /* action suspended, skip it */
 419     if (not action.is_running())
 420       continue;
 421
 422     sum_priority_ += 1.0 / action.get_sharing_penalty();
 423   }
 424
 425   for (CpuTiAction& action : action_set_) {
 426     double min_finish = NO_MAX_DURATION;
 427     /* action not running, skip it */
 428     if (action.get_state_set() != get_model()->get_started_action_set())
 429       continue;
 430
 431     /* verify if the action is really running on cpu */
 432     if (action.is_running() && action.get_sharing_penalty() > 0) {
 433       /* total area needed to finish the action. Used in trace integration */
 434       double total_area = (action.get_remains() * sum_priority_ * action.get_sharing_penalty()) / speed_.peak;
 435
 436       action.set_finish_time(speed_integrated_trace_->solve(now, total_area));
 437       /* verify which event will happen before (max_duration or finish time) */
 438       if (action.get_max_duration() != NO_MAX_DURATION &&
 439           action.get_start_time() + action.get_max_duration() < action.get_finish_time())
 440         min_finish = action.get_start_time() + action.get_max_duration();
 441       else
 442         min_finish = action.get_finish_time();
 443     } else {
 444       /* put the max duration time on heap */
 445       if (action.get_max_duration() != NO_MAX_DURATION)
 446         min_finish = action.get_start_time() + action.get_max_duration();
 447     }
 448     /* add in action heap */
 449     if (min_finish != NO_MAX_DURATION)
 450       get_model()->get_action_heap().update(&action, min_finish, ActionHeap::Type::unset);
 451     else
 452       get_model()->get_action_heap().remove(&action);
 453
 454     XBT_DEBUG("Update finish time: Cpu(%s) Action: %p, Start Time: %f Finish Time: %f Max duration %f", get_cname(),
 455               &action, action.get_start_time(), action.get_finish_time(), action.get_max_duration());
 456   }
 457   /* remove from modified cpu */
 458   set_modified(false);
 459 }
 460
 461 bool CpuTi::is_used() const
 462 {
 463   return not action_set_.empty();
 464 }
 465
 466 double CpuTi::get_speed_ratio()
 467 {
 468   speed_.scale = speed_integrated_trace_->get_power_scale(EngineImpl::get_clock());
 469   return CpuImpl::get_speed_ratio();
 470 }
 471
 472 /** @brief Update the remaining amount of actions */
 473 void CpuTi::update_remaining_amount(double now)
 474 {
 475   /* already up to date */
 476   if (last_update_ >= now)
 477     return;
 478
 479   /* compute the integration area */
 480   double area_total = speed_integrated_trace_->integrate(last_update_, now) * speed_.peak;
 481   XBT_DEBUG("Flops total: %f, Last update %f", area_total, last_update_);
 482   for (CpuTiAction& action : action_set_) {
 483     /* action not running, skip it */
 484     if (action.get_state_set() != get_model()->get_started_action_set())
 485       continue;
 486
 487     /* bogus priority, skip it */
 488     if (action.get_sharing_penalty() <= 0)
 489       continue;
 490
 491     /* action suspended, skip it */
 492     if (not action.is_running())
 493       continue;
 494
 495     /* action don't need update */
 496     if (action.get_start_time() >= now)
 497       continue;
 498
 499     /* skip action that are finishing now */
 500     if (action.get_finish_time() >= 0 && action.get_finish_time() <= now)
 501       continue;
 502
 503     /* update remaining */
 504     action.update_remains(area_total / (sum_priority_ * action.get_sharing_penalty()));
 505     XBT_DEBUG("Update remaining action(%p) remaining %f", &action, action.get_remains_no_update());
 506   }
 507   last_update_ = now;
 508 }
 509
 510 CpuAction* CpuTi::execution_start(double size, double user_bound)
 511 {
 512   XBT_IN("(%s,%g)", get_cname(), size);
 513   xbt_assert(user_bound <= 0, "Invalid user bound (%lf) in CPU TI model", user_bound);
 514   auto* action = new CpuTiAction(this, size);
 515
 516   action_set_.push_back(*action); // Actually start the action
 517
 518   XBT_OUT();
 519   return action;
 520 }
 521
 522 CpuAction* CpuTi::sleep(double duration)
 523 {
 524   if (duration > 0)
 525     duration = std::max(duration, sg_surf_precision);
 526
 527   XBT_IN("(%s,%g)", get_cname(), duration);
 528   auto* action = new CpuTiAction(this, 1.0);
 529
 530   action->set_max_duration(duration);
 531   action->set_suspend_state(Action::SuspendStates::SLEEPING);
 532   if (duration == NO_MAX_DURATION)
 533     action->set_state(Action::State::IGNORED);
 534
 535   action_set_.push_back(*action);
 536
 537   XBT_OUT();
 538   return action;
 539 }
 540
 541 void CpuTi::set_modified(bool modified)
 542 {
 543   CpuTiList& modified_cpus = static_cast<CpuTiModel*>(get_model())->modified_cpus_;
 544   if (modified) {
 545     if (not cpu_ti_hook.is_linked()) {
 546       modified_cpus.push_back(*this);
 547     }
 548   } else {
 549     if (cpu_ti_hook.is_linked())
 550       xbt::intrusive_erase(modified_cpus, *this);
 551   }
 552 }
 553
 554 /**********
 555  * Action *
 556  **********/
 557
 558 CpuTiAction::CpuTiAction(CpuTi* cpu, double cost) : CpuAction(cpu->get_model(), cost, not cpu->is_on()), cpu_(cpu)
 559 {
 560   cpu_->set_modified(true);
 561 }
 562 CpuTiAction::~CpuTiAction()
 563 {
 564   /* remove from action_set */
 565   if (action_ti_hook.is_linked())
 566     xbt::intrusive_erase(cpu_->action_set_, *this);
 567   /* remove from heap */
 568   get_model()->get_action_heap().remove(this);
 569   cpu_->set_modified(true);
 570 }
 571
 572 void CpuTiAction::set_state(Action::State state)
 573 {
 574   CpuAction::set_state(state);
 575   cpu_->set_modified(true);
 576 }
 577
 578 void CpuTiAction::cancel()
 579 {
 580   this->set_state(Action::State::FAILED);
 581   get_model()->get_action_heap().remove(this);
 582   cpu_->set_modified(true);
 583 }
 584
 585 void CpuTiAction::suspend()
 586 {
 587   XBT_IN("(%p)", this);
 588   if (is_running()) {
 589     set_suspend_state(Action::SuspendStates::SUSPENDED);
 590     get_model()->get_action_heap().remove(this);
 591     cpu_->set_modified(true);
 592   }
 593   XBT_OUT();
 594 }
 595
 596 void CpuTiAction::resume()
 597 {
 598   XBT_IN("(%p)", this);
 599   if (is_suspended()) {
 600     set_suspend_state(Action::SuspendStates::RUNNING);
 601     cpu_->set_modified(true);
 602   }
 603   XBT_OUT();
 604 }
 605
 606 void CpuTiAction::set_sharing_penalty(double sharing_penalty)
 607 {
 608   XBT_IN("(%p,%g)", this, sharing_penalty);
 609   set_sharing_penalty_no_update(sharing_penalty);
 610   cpu_->set_modified(true);
 611   XBT_OUT();
 612 }
 613
 614 double CpuTiAction::get_remains()
 615 {
 616   XBT_IN("(%p)", this);
 617   cpu_->update_remaining_amount(EngineImpl::get_clock());
 618   XBT_OUT();
 619   return get_remains_no_update();
 620 }
 621
 622 } // namespace resource
 623 } // namespace kernel
 624 } // namespace simgrid