Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
plug leaks
[simgrid.git] / src / surf / cpu_ti.cpp
1 /* Copyright (c) 2013-2020. 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 "src/kernel/resource/profile/Event.hpp"
8 #include "src/kernel/resource/profile/Profile.hpp"
9 #include "src/surf/surf_interface.hpp"
10 #include "surf/surf.hpp"
11
12 #include <algorithm>
13
14 constexpr double EPSILON = 0.000000001;
15
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu_ti, surf_cpu, "Logging specific to the SURF CPU TRACE INTEGRATION module");
17
18 namespace simgrid {
19 namespace kernel {
20 namespace resource {
21
22 /*********
23  * Trace *
24  *********/
25
26 CpuTiProfile::CpuTiProfile(const profile::Profile* profile)
27 {
28   double integral = 0;
29   double time = 0;
30   unsigned nb_points = profile->event_list.size() + 1;
31   time_points_.reserve(nb_points);
32   integral_.reserve(nb_points);
33   for (auto const& val : profile->event_list) {
34     time_points_.push_back(time);
35     integral_.push_back(integral);
36     time += val.date_;
37     integral += val.date_ * val.value_;
38   }
39   time_points_.push_back(time);
40   integral_.push_back(integral);
41 }
42
43 /**
44  * @brief Integrate trace
45  *
46  * Wrapper around surf_cpu_integrate_trace_simple() to get
47  * the cyclic effect.
48  *
49  * @param a      Begin of interval
50  * @param b      End of interval
51  * @return the integrate value. -1 if an error occurs.
52  */
53 double CpuTiTmgr::integrate(double a, double b)
54 {
55   if ((a < 0.0) || (a > b)) {
56     xbt_die("Error, invalid integration interval [%.2f,%.2f]. "
57         "You probably have a task executing with negative computation amount. Check your code.", a, b);
58   }
59   if (fabs(a - b) < EPSILON)
60     return 0.0;
61
62   if (type_ == Type::FIXED) {
63     return (b - a) * value_;
64   }
65
66   int a_index;
67   if (fabs(ceil(a / last_time_) - a / last_time_) < EPSILON)
68     a_index = 1 + static_cast<int>(ceil(a / last_time_));
69   else
70     a_index = static_cast<int>(ceil(a / last_time_));
71
72   int b_index = static_cast<int>(floor(b / last_time_));
73
74   if (a_index > b_index) {      /* Same chunk */
75     return profile_->integrate_simple(a - (a_index - 1) * last_time_, b - (b_index)*last_time_);
76   }
77
78   double first_chunk  = profile_->integrate_simple(a - (a_index - 1) * last_time_, last_time_);
79   double middle_chunk = (b_index - a_index) * total_;
80   double last_chunk   = profile_->integrate_simple(0.0, b - (b_index)*last_time_);
81
82   XBT_DEBUG("first_chunk=%.2f  middle_chunk=%.2f  last_chunk=%.2f\n", first_chunk, middle_chunk, last_chunk);
83
84   return (first_chunk + middle_chunk + last_chunk);
85 }
86
87 /**
88  * @brief Auxiliary function to compute the integral between a and b.
89  *     It simply computes the integrals at point a and b and returns the difference between them.
90  * @param a  Initial point
91  * @param b  Final point
92  */
93 double CpuTiProfile::integrate_simple(double a, double b)
94 {
95   return integrate_simple_point(b) - integrate_simple_point(a);
96 }
97
98 /**
99  * @brief Auxiliary function to compute the integral at point a.
100  * @param a        point
101  */
102 double CpuTiProfile::integrate_simple_point(double a)
103 {
104   double integral = 0;
105   double a_aux = a;
106   int ind         = binary_search(time_points_, a);
107   integral += integral_[ind];
108
109   XBT_DEBUG("a %f ind %d integral %f ind + 1 %f ind %f time +1 %f time %f", a, ind, integral, integral_[ind + 1],
110             integral_[ind], time_points_[ind + 1], time_points_[ind]);
111   double_update(&a_aux, time_points_[ind], sg_maxmin_precision * sg_surf_precision);
112   if (a_aux > 0)
113     integral +=
114         ((integral_[ind + 1] - integral_[ind]) / (time_points_[ind + 1] - time_points_[ind])) * (a - time_points_[ind]);
115   XBT_DEBUG("Integral a %f = %f", a, integral);
116
117   return integral;
118 }
119
120 /**
121  * @brief Computes the time needed to execute "amount" on cpu.
122  *
123  * Here, amount can span multiple trace periods
124  *
125  * @param a        Initial time
126  * @param amount  Amount to be executed
127  * @return  End time
128  */
129 double CpuTiTmgr::solve(double a, double amount)
130 {
131   /* Fix very small negative numbers */
132   if ((a < 0.0) && (a > -EPSILON)) {
133     a = 0.0;
134   }
135   if ((amount < 0.0) && (amount > -EPSILON)) {
136     amount = 0.0;
137   }
138
139   /* Sanity checks */
140   if ((a < 0.0) || (amount < 0.0)) {
141     XBT_CRITICAL ("Error, invalid parameters [a = %.2f, amount = %.2f]. "
142         "You probably have a task executing with negative computation amount. Check your code.", a, amount);
143     xbt_abort();
144   }
145
146   /* At this point, a and amount are positive */
147   if (amount < EPSILON)
148     return a;
149
150   /* Is the trace fixed ? */
151   if (type_ == Type::FIXED) {
152     return (a + (amount / value_));
153   }
154
155   XBT_DEBUG("amount %f total %f", amount, total_);
156   /* Reduce the problem to one where amount <= trace_total */
157   int quotient = static_cast<int>(floor(amount / total_));
158   double reduced_amount = (total_) * ((amount / total_) - floor(amount / total_));
159   double reduced_a      = a - (last_time_) * static_cast<int>(floor(a / last_time_));
160
161   XBT_DEBUG("Quotient: %d reduced_amount: %f reduced_a: %f", quotient, reduced_amount, reduced_a);
162
163   /* Now solve for new_amount which is <= trace_total */
164   double reduced_b;
165   XBT_DEBUG("Solve integral: [%.2f, amount=%.2f]", reduced_a, reduced_amount);
166   double amount_till_end = integrate(reduced_a, last_time_);
167
168   if (amount_till_end > reduced_amount) {
169     reduced_b = profile_->solve_simple(reduced_a, reduced_amount);
170   } else {
171     reduced_b = last_time_ + profile_->solve_simple(0.0, reduced_amount - amount_till_end);
172   }
173
174   /* Re-map to the original b and amount */
175   return (last_time_) * static_cast<int>(floor(a / last_time_)) + (quotient * last_time_) + reduced_b;
176 }
177
178 /**
179  * @brief Auxiliary function to solve integral.
180  *  It returns the date when the requested amount of flops is available
181  * @param a        Initial point
182  * @param amount  Amount of flops
183  * @return The date when amount is available.
184  */
185 double CpuTiProfile::solve_simple(double a, double amount)
186 {
187   double integral_a = integrate_simple_point(a);
188   int ind           = binary_search(integral_, integral_a + amount);
189   double time       = time_points_[ind];
190   time += (integral_a + amount - integral_[ind]) /
191           ((integral_[ind + 1] - integral_[ind]) / (time_points_[ind + 1] - time_points_[ind]));
192
193   return time;
194 }
195
196 /**
197  * @brief Auxiliary function to update the CPU speed scale.
198  *
199  *  This function uses the trace structure to return the speed scale at the determined time a.
200  * @param a        Time
201  * @return CPU speed scale
202  */
203 double CpuTiTmgr::get_power_scale(double a)
204 {
205   double reduced_a          = a - floor(a / last_time_) * last_time_;
206   int point                       = CpuTiProfile::binary_search(profile_->time_points_, reduced_a);
207   kernel::profile::DatedValue val = speed_profile_->event_list.at(point);
208   return val.value_;
209 }
210
211 /**
212  * @brief Creates a new integration trace from a tmgr_trace_t
213  *
214  * @param  speed_trace    CPU availability trace
215  * @param  value          Percentage of CPU speed available (useful to fixed tracing)
216  * @return  Integration trace structure
217  */
218 CpuTiTmgr::CpuTiTmgr(kernel::profile::Profile* speed_profile, double value) : speed_profile_(speed_profile)
219 {
220   double total_time = 0.0;
221   profile_.reset(nullptr);
222
223   /* no availability file, fixed trace */
224   if (not speed_profile) {
225     value_ = value;
226     XBT_DEBUG("No availability trace. Constant value = %f", value);
227     return;
228   }
229
230   /* only one point available, fixed trace */
231   if (speed_profile->event_list.size() == 1) {
232     value_ = speed_profile->event_list.front().value_;
233     return;
234   }
235
236   type_ = Type::DYNAMIC;
237
238   /* count the total time of trace file */
239   for (auto const& val : speed_profile->event_list)
240     total_time += val.date_;
241
242   profile_.reset(new CpuTiProfile(speed_profile));
243   last_time_ = total_time;
244   total_     = profile_->integrate_simple(0, total_time);
245
246   XBT_DEBUG("Total integral %f, last_time %f ", total_, last_time_);
247 }
248
249 /**
250  * @brief Binary search in array.
251  *  It returns the last point of the interval in which "a" is.
252  * @param array    Array
253  * @param a        Value to search
254  * @return Index of point
255  */
256 int CpuTiProfile::binary_search(const std::vector<double>& array, double a)
257 {
258   if (array[0] > a)
259     return 0;
260   auto pos = std::upper_bound(begin(array), end(array), a);
261   return std::distance(begin(array), pos) - 1;
262 }
263
264 /*********
265  * Model *
266  *********/
267
268 void CpuTiModel::create_pm_vm_models()
269 {
270   xbt_assert(surf_cpu_model_pm == nullptr, "CPU model already initialized. This should not happen.");
271   xbt_assert(surf_cpu_model_vm == nullptr, "CPU model already initialized. This should not happen.");
272
273   surf_cpu_model_pm = new CpuTiModel();
274   surf_cpu_model_vm = new CpuTiModel();
275 }
276
277 CpuTiModel::CpuTiModel() : CpuModel(Model::UpdateAlgo::FULL)
278 {
279   all_existing_models.push_back(this);
280 }
281
282 CpuTiModel::~CpuTiModel()
283 {
284   surf_cpu_model_pm = nullptr;
285 }
286
287 Cpu* CpuTiModel::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate, int core)
288 {
289   return new CpuTi(this, host, speed_per_pstate, core);
290 }
291
292 double CpuTiModel::next_occurring_event(double now)
293 {
294   double min_action_duration = -1;
295
296   /* iterates over modified cpus to update share resources */
297   for (auto it = std::begin(modified_cpus_); it != std::end(modified_cpus_);) {
298     CpuTi& cpu = *it;
299     ++it; // increment iterator here since the following call to ti.update_actions_finish_time() may invalidate it
300     cpu.update_actions_finish_time(now);
301   }
302
303   /* get the min next event if heap not empty */
304   if (not get_action_heap().empty())
305     min_action_duration = get_action_heap().top_date() - now;
306
307   XBT_DEBUG("Share resources, min next event date: %f", min_action_duration);
308
309   return min_action_duration;
310 }
311
312 void CpuTiModel::update_actions_state(double now, double /*delta*/)
313 {
314   while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
315     auto* action = static_cast<CpuTiAction*>(get_action_heap().pop());
316     XBT_DEBUG("Action %p: finish", action);
317     action->finish(Action::State::FINISHED);
318     /* update remaining amount of all actions */
319     action->cpu_->update_remaining_amount(surf_get_clock());
320   }
321 }
322
323 /************
324  * Resource *
325  ************/
326 CpuTi::CpuTi(CpuTiModel* model, s4u::Host* host, const std::vector<double>& speed_per_pstate, int core)
327     : Cpu(model, host, speed_per_pstate, core)
328 {
329   xbt_assert(core == 1, "Multi-core not handled by this model yet");
330
331   speed_.peak = speed_per_pstate.front();
332   XBT_DEBUG("CPU create: peak=%f", speed_.peak);
333
334   speed_integrated_trace_ = new CpuTiTmgr(nullptr, 1 /*scale*/);
335 }
336
337 CpuTi::~CpuTi()
338 {
339   set_modified(false);
340   delete speed_integrated_trace_;
341 }
342
343 void CpuTi::set_speed_profile(kernel::profile::Profile* profile)
344 {
345   delete speed_integrated_trace_;
346   speed_integrated_trace_ = new CpuTiTmgr(profile, speed_.scale);
347
348   /* add a fake trace event if periodicity == 0 */
349   if (profile && profile->event_list.size() > 1) {
350     kernel::profile::DatedValue val = profile->event_list.back();
351     if (val.date_ < 1e-12) {
352       auto* prof   = new kernel::profile::Profile();
353       speed_.event = prof->schedule(&profile::future_evt_set, this);
354     }
355   }
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(surf_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 == state_event_) {
375     if (value > 0) {
376       if (not is_on()) {
377         XBT_VERB("Restart actors on host %s", get_host()->get_cname());
378         get_host()->turn_on();
379       }
380     } else {
381       get_host()->turn_off();
382       double date = surf_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     tmgr_trace_event_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() != surf_cpu_model_pm->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 = -1;
427     /* action not running, skip it */
428     if (action.get_state_set() != surf_cpu_model_pm->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()
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(surf_get_clock());
469   return Cpu::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)
511 {
512   XBT_IN("(%s,%g)", get_cname(), size);
513   auto* action = new CpuTiAction(this, size);
514
515   action_set_.push_back(*action); // Actually start the action
516
517   XBT_OUT();
518   return action;
519 }
520
521 CpuAction* CpuTi::sleep(double duration)
522 {
523   if (duration > 0)
524     duration = std::max(duration, sg_surf_precision);
525
526   XBT_IN("(%s,%g)", get_cname(), duration);
527   auto* action = new CpuTiAction(this, 1.0);
528
529   action->set_max_duration(duration);
530   action->set_suspend_state(Action::SuspendStates::SLEEPING);
531   if (duration == NO_MAX_DURATION)
532     action->set_state(Action::State::IGNORED);
533
534   action_set_.push_back(*action);
535
536   XBT_OUT();
537   return action;
538 }
539
540 void CpuTi::set_modified(bool modified)
541 {
542   CpuTiList& modified_cpus = static_cast<CpuTiModel*>(get_model())->modified_cpus_;
543   if (modified) {
544     if (not cpu_ti_hook.is_linked()) {
545       modified_cpus.push_back(*this);
546     }
547   } else {
548     if (cpu_ti_hook.is_linked())
549       xbt::intrusive_erase(modified_cpus, *this);
550   }
551 }
552
553 /**********
554  * Action *
555  **********/
556
557 CpuTiAction::CpuTiAction(CpuTi* cpu, double cost) : CpuAction(cpu->get_model(), cost, not cpu->is_on()), cpu_(cpu)
558 {
559   cpu_->set_modified(true);
560 }
561 CpuTiAction::~CpuTiAction()
562 {
563   /* remove from action_set */
564   if (action_ti_hook.is_linked())
565     xbt::intrusive_erase(cpu_->action_set_, *this);
566   /* remove from heap */
567   get_model()->get_action_heap().remove(this);
568   cpu_->set_modified(true);
569 }
570
571 void CpuTiAction::set_state(Action::State state)
572 {
573   CpuAction::set_state(state);
574   cpu_->set_modified(true);
575 }
576
577 void CpuTiAction::cancel()
578 {
579   this->set_state(Action::State::FAILED);
580   get_model()->get_action_heap().remove(this);
581   cpu_->set_modified(true);
582 }
583
584 void CpuTiAction::suspend()
585 {
586   XBT_IN("(%p)", this);
587   if (is_running()) {
588     set_suspend_state(Action::SuspendStates::SUSPENDED);
589     get_model()->get_action_heap().remove(this);
590     cpu_->set_modified(true);
591   }
592   XBT_OUT();
593 }
594
595 void CpuTiAction::resume()
596 {
597   XBT_IN("(%p)", this);
598   if (is_suspended()) {
599     set_suspend_state(Action::SuspendStates::RUNNING);
600     cpu_->set_modified(true);
601   }
602   XBT_OUT();
603 }
604
605 void CpuTiAction::set_max_duration(double duration)
606 {
607   double min_finish;
608
609   XBT_IN("(%p,%g)", this, duration);
610
611   Action::set_max_duration(duration);
612
613   if (duration >= 0)
614     min_finish = (get_start_time() + get_max_duration()) < get_finish_time() ? (get_start_time() + get_max_duration())
615                                                                              : get_finish_time();
616   else
617     min_finish = get_finish_time();
618
619   /* add in action heap */
620   get_model()->get_action_heap().update(this, min_finish, ActionHeap::Type::unset);
621
622   XBT_OUT();
623 }
624
625 void CpuTiAction::set_sharing_penalty(double sharing_penalty)
626 {
627   XBT_IN("(%p,%g)", this, sharing_penalty);
628   set_sharing_penalty_no_update(sharing_penalty);
629   cpu_->set_modified(true);
630   XBT_OUT();
631 }
632
633 double CpuTiAction::get_remains()
634 {
635   XBT_IN("(%p)", this);
636   cpu_->update_remaining_amount(surf_get_clock());
637   XBT_OUT();
638   return get_remains_no_update();
639 }
640
641 } // namespace resource
642 } // namespace kernel
643 } // namespace simgrid