Logo AND Algorithmique Numérique Distribuée

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