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