Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
these functions always take exactly the same parameter, thus inlining it
[simgrid.git] / src / surf / cpu_ti.cpp
1 /* Copyright (c) 2013-2018. 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/surf/trace_mgr.hpp"
8 #include "xbt/utility.hpp"
9 #include <algorithm>
10
11 #ifndef SURF_MODEL_CPUTI_H_
12 #define SURF_MODEL_CPUTI_H_
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu_ti, surf_cpu, "Logging specific to the SURF CPU TRACE INTEGRATION module");
15
16 namespace simgrid {
17 namespace surf {
18
19 /*********
20  * Trace *
21  *********/
22
23 CpuTiTrace::CpuTiTrace(tmgr_trace_t speedTrace)
24 {
25   double integral = 0;
26   double time = 0;
27   int i = 0;
28   nbPoints_ = speedTrace->event_list.size() + 1;
29   timePoints_ = new double[nbPoints_];
30   integral_ =  new double[nbPoints_];
31   for (auto const& val : speedTrace->event_list) {
32     timePoints_[i] = time;
33     integral_[i] = integral;
34     integral += val.date_ * val.value_;
35     time += val.date_;
36     i++;
37   }
38   timePoints_[i] = time;
39   integral_[i] = integral;
40 }
41
42 CpuTiTrace::~CpuTiTrace()
43 {
44   delete [] timePoints_;
45   delete [] integral_;
46 }
47
48 CpuTiTgmr::~CpuTiTgmr()
49 {
50   if (trace_)
51     delete trace_;
52 }
53
54 /**
55 * \brief Integrate trace
56 *
57 * Wrapper around surf_cpu_integrate_trace_simple() to get
58 * the cyclic effect.
59 *
60 * \param a      Begin of interval
61 * \param b      End of interval
62 * \return the integrate value. -1 if an error occurs.
63 */
64 double CpuTiTgmr::integrate(double a, double b)
65 {
66   int a_index;
67
68   if ((a < 0.0) || (a > b)) {
69     xbt_die("Error, invalid integration interval [%.2f,%.2f]. "
70         "You probably have a task executing with negative computation amount. Check your code.", a, b);
71   }
72   if (fabs(a -b) < EPSILON)
73     return 0.0;
74
75   if (type_ == TRACE_FIXED) {
76     return ((b - a) * value_);
77   }
78
79   if (fabs(ceil(a / lastTime_) - a / lastTime_) < EPSILON)
80     a_index = 1 + static_cast<int>(ceil(a / lastTime_));
81   else
82     a_index = static_cast<int> (ceil(a / lastTime_));
83
84   int b_index = static_cast<int> (floor(b / lastTime_));
85
86   if (a_index > b_index) {      /* Same chunk */
87     return trace_->integrateSimple(a - (a_index - 1) * lastTime_, b - (b_index) * lastTime_);
88   }
89
90   double first_chunk = trace_->integrateSimple(a - (a_index - 1) * lastTime_, lastTime_);
91   double middle_chunk = (b_index - a_index) * total_;
92   double last_chunk = trace_->integrateSimple(0.0, b - (b_index) * lastTime_);
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 CpuTiTrace::integrateSimple(double a, double b)
106 {
107   return integrateSimplePoint(b) - integrateSimplePoint(a);
108 }
109
110 /**
111  * \brief Auxiliary function to compute the integral at point a.
112  * \param a        point
113  */
114 double CpuTiTrace::integrateSimplePoint(double a)
115 {
116   double integral = 0;
117   double a_aux = a;
118   int ind = binarySearch(timePoints_, a, 0, nbPoints_ - 1);
119   integral += integral_[ind];
120
121   XBT_DEBUG("a %f ind %d integral %f ind + 1 %f ind %f time +1 %f time %f",
122        a, ind, integral, integral_[ind + 1], integral_[ind], timePoints_[ind + 1], timePoints_[ind]);
123   double_update(&a_aux, timePoints_[ind], sg_maxmin_precision*sg_surf_precision);
124   if (a_aux > 0)
125     integral += ((integral_[ind + 1] - integral_[ind]) / (timePoints_[ind + 1] - timePoints_[ind])) *
126                 (a - timePoints_[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 CpuTiTgmr::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_ == TRACE_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 - (lastTime_) * static_cast<int>(floor(a / lastTime_));
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 = solveSomewhatSimple(reduced_a, reduced_amount);
177
178 /* Re-map to the original b and amount */
179   double b = (lastTime_) * static_cast<int>(floor(a / lastTime_)) + (quotient * lastTime_) + reduced_b;
180   return b;
181 }
182
183 /**
184 * \brief Auxiliary function to solve integral
185 *
186 * Here, amount is <= trace->total
187 * and a <=trace->last_time
188 *
189 */
190 double CpuTiTgmr::solveSomewhatSimple(double a, double amount)
191 {
192   double b;
193
194   XBT_DEBUG("Solve integral: [%.2f, amount=%.2f]", a, amount);
195   double amount_till_end = integrate(a, lastTime_);
196
197   if (amount_till_end > amount) {
198     b = trace_->solveSimple(a, amount);
199   } else {
200     b = lastTime_ + trace_->solveSimple(0.0, amount - amount_till_end);
201   }
202   return b;
203 }
204
205 /**
206  * \brief Auxiliary function to solve integral.
207  *  It returns the date when the requested amount of flops is available
208  * \param a        Initial point
209  * \param amount  Amount of flops
210  * \return The date when amount is available.
211 */
212 double CpuTiTrace::solveSimple(double a, double amount)
213 {
214   double integral_a = integrateSimplePoint(a);
215   int ind = binarySearch(integral_, integral_a + amount, 0, nbPoints_ - 1);
216   double time = timePoints_[ind];
217   time += (integral_a + amount - integral_[ind]) /
218            ((integral_[ind + 1] - integral_[ind]) / (timePoints_[ind + 1] - timePoints_[ind]));
219
220   return time;
221 }
222
223 /**
224 * \brief Auxiliary function to update the CPU speed scale.
225 *
226 *  This function uses the trace structure to return the speed scale at the determined time a.
227 * \param a        Time
228 * \return CPU speed scale
229 */
230 double CpuTiTgmr::getPowerScale(double a)
231 {
232   double reduced_a = a - floor(a / lastTime_) * lastTime_;
233   int point = trace_->binarySearch(trace_->timePoints_, reduced_a, 0, trace_->nbPoints_ - 1);
234   trace_mgr::DatedValue val = speedTrace_->event_list.at(point);
235   return val.value_;
236 }
237
238 /**
239 * \brief Creates a new integration trace from a tmgr_trace_t
240 *
241 * \param  speedTrace    CPU availability trace
242 * \param  value          Percentage of CPU speed available (useful to fixed tracing)
243 * \return  Integration trace structure
244 */
245 CpuTiTgmr::CpuTiTgmr(tmgr_trace_t speedTrace, double value) :
246     speedTrace_(speedTrace)
247 {
248   double total_time = 0.0;
249   trace_ = 0;
250
251 /* no availability file, fixed trace */
252   if (not speedTrace) {
253     type_ = TRACE_FIXED;
254     value_ = value;
255     XBT_DEBUG("No availability trace. Constant value = %f", value);
256     return;
257   }
258
259   /* only one point available, fixed trace */
260   if (speedTrace->event_list.size() == 1) {
261     trace_mgr::DatedValue val = speedTrace->event_list.front();
262     type_ = TRACE_FIXED;
263     value_                    = val.value_;
264     return;
265   }
266
267   type_ = TRACE_DYNAMIC;
268
269   /* count the total time of trace file */
270   for (auto const& val : speedTrace->event_list)
271     total_time += val.date_;
272
273   trace_ = new CpuTiTrace(speedTrace);
274   lastTime_ = total_time;
275   total_ = trace_->integrateSimple(0, total_time);
276
277   XBT_DEBUG("Total integral %f, last_time %f ", total_, lastTime_);
278 }
279
280 /**
281  * \brief Binary search in array.
282  *  It returns the first point of the interval in which "a" is.
283  * \param array    Array
284  * \param a        Value to search
285  * \param low     Low bound to search in array
286  * \param high    Upper bound to search in array
287  * \return Index of point
288 */
289 int CpuTiTrace::binarySearch(double *array, double a, int low, int high)
290 {
291   xbt_assert(low < high, "Wrong parameters: low (%d) should be smaller than high (%d)", low, high);
292
293   do {
294     int mid = low + (high - low) / 2;
295     XBT_DEBUG("a %f low %d high %d mid %d value %f", a, low, high, mid, array[mid]);
296
297     if (array[mid] > a)
298       high = mid;
299     else
300       low = mid;
301   }
302   while (low < high - 1);
303
304   return low;
305 }
306
307 }
308 }
309
310 /*********
311  * Model *
312  *********/
313
314 void surf_cpu_model_init_ti()
315 {
316   xbt_assert(not surf_cpu_model_pm, "CPU model already initialized. This should not happen.");
317   xbt_assert(not surf_cpu_model_vm, "CPU model already initialized. This should not happen.");
318
319   surf_cpu_model_pm = new simgrid::surf::CpuTiModel();
320   all_existing_models->push_back(surf_cpu_model_pm);
321
322   surf_cpu_model_vm = new simgrid::surf::CpuTiModel();
323   all_existing_models->push_back(surf_cpu_model_vm);
324 }
325
326 namespace simgrid {
327 namespace surf {
328
329 CpuTiModel::~CpuTiModel()
330 {
331   surf_cpu_model_pm = nullptr;
332 }
333
334 Cpu *CpuTiModel::createCpu(simgrid::s4u::Host *host, std::vector<double>* speedPerPstate, int core)
335 {
336   return new CpuTi(this, host, speedPerPstate, core);
337 }
338
339 double CpuTiModel::nextOccuringEvent(double now)
340 {
341   double min_action_duration = -1;
342
343   /* iterates over modified cpus to update share resources */
344   for (auto it = std::begin(modifiedCpu_); it != std::end(modifiedCpu_);) {
345     CpuTi& ti = *it;
346     ++it; // increment iterator here since the following call to ti.updateActionsFinishTime() may invalidate it
347     ti.updateActionsFinishTime(now);
348   }
349
350   /* get the min next event if heap not empty */
351   if (not actionHeapIsEmpty())
352     min_action_duration = actionHeapTopDate() - now;
353
354   XBT_DEBUG("Share resources, min next event date: %f", min_action_duration);
355
356   return min_action_duration;
357 }
358
359 void CpuTiModel::updateActionsState(double now, double /*delta*/)
360 {
361   while (not actionHeapIsEmpty() && actionHeapTopDate() <= now) {
362     CpuTiAction* action = static_cast<CpuTiAction*>(actionHeapPop());
363     XBT_DEBUG("Action %p: finish", action);
364     action->finish(kernel::resource::Action::State::done);
365     /* update remaining amount of all actions */
366     action->cpu_->updateRemainingAmount(surf_get_clock());
367   }
368 }
369
370 /************
371  * Resource *
372  ************/
373 CpuTi::CpuTi(CpuTiModel *model, simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)
374   : Cpu(model, host, speedPerPstate, core)
375 {
376   xbt_assert(core==1,"Multi-core not handled by this model yet");
377   coresAmount_ = core;
378
379   speed_.peak = speedPerPstate->front();
380   XBT_DEBUG("CPU create: peak=%f", speed_.peak);
381
382   speedIntegratedTrace_ = new CpuTiTgmr(nullptr, 1/*scale*/);
383 }
384
385 CpuTi::~CpuTi()
386 {
387   modified(false);
388   delete speedIntegratedTrace_;
389 }
390 void CpuTi::setSpeedTrace(tmgr_trace_t trace)
391 {
392   if (speedIntegratedTrace_)
393     delete speedIntegratedTrace_;
394
395   speedIntegratedTrace_ = new CpuTiTgmr(trace, speed_.scale);
396
397   /* add a fake trace event if periodicity == 0 */
398   if (trace && trace->event_list.size() > 1) {
399     trace_mgr::DatedValue val = trace->event_list.back();
400     if (val.date_ < 1e-12)
401       speed_.event = future_evt_set->add_trace(new simgrid::trace_mgr::trace(), this);
402   }
403 }
404
405 void CpuTi::apply_event(tmgr_trace_event_t event, double value)
406 {
407   if (event == speed_.event) {
408     tmgr_trace_t speedTrace;
409     CpuTiTgmr *trace;
410
411     XBT_DEBUG("Finish trace date: value %f", value);
412     /* update remaining of actions and put in modified cpu list */
413     updateRemainingAmount(surf_get_clock());
414
415     modified(true);
416
417     speedTrace = speedIntegratedTrace_->speedTrace_;
418     trace_mgr::DatedValue val = speedTrace->event_list.back();
419     delete speedIntegratedTrace_;
420     speed_.scale = val.value_;
421
422     trace = new CpuTiTgmr(TRACE_FIXED, val.value_);
423     XBT_DEBUG("value %f", val.value_);
424
425     speedIntegratedTrace_ = trace;
426
427     tmgr_trace_event_unref(&speed_.event);
428
429   } else if (event == stateEvent_) {
430     if (value > 0) {
431       if(isOff())
432         host_that_restart.push_back(getHost());
433       turnOn();
434     } else {
435       turnOff();
436       double date = surf_get_clock();
437
438       /* put all action running on cpu to failed */
439       for (CpuTiAction& action : actionSet_) {
440         if (action.get_state() == kernel::resource::Action::State::running ||
441             action.get_state() == kernel::resource::Action::State::ready ||
442             action.get_state() == kernel::resource::Action::State::not_in_the_system) {
443           action.set_finish_time(date);
444           action.set_state(kernel::resource::Action::State::failed);
445           action.heapRemove();
446         }
447       }
448     }
449     tmgr_trace_event_unref(&stateEvent_);
450
451   } else {
452     xbt_die("Unknown event!\n");
453   }
454 }
455
456 void CpuTi::updateActionsFinishTime(double now)
457 {
458   double sum_priority = 0.0;
459   double total_area;
460
461   /* update remaining amount of actions */
462   updateRemainingAmount(now);
463
464   for (CpuTiAction const& action : actionSet_) {
465     /* action not running, skip it */
466     if (action.get_state_set() != surf_cpu_model_pm->getRunningActionSet())
467       continue;
468
469     /* bogus priority, skip it */
470     if (action.get_priority() <= 0)
471       continue;
472
473     /* action suspended, skip it */
474     if (action.suspended_ != kernel::resource::Action::SuspendStates::not_suspended)
475       continue;
476
477     sum_priority += 1.0 / action.get_priority();
478   }
479   sumPriority_ = sum_priority;
480
481   for (CpuTiAction& action : actionSet_) {
482     double min_finish = -1;
483     /* action not running, skip it */
484     if (action.get_state_set() != surf_cpu_model_pm->getRunningActionSet())
485       continue;
486
487     /* verify if the action is really running on cpu */
488     if (action.suspended_ == kernel::resource::Action::SuspendStates::not_suspended && action.get_priority() > 0) {
489       /* total area needed to finish the action. Used in trace integration */
490       total_area = (action.get_remains()) * sum_priority * action.get_priority();
491
492       total_area /= speed_.peak;
493
494       action.set_finish_time(speedIntegratedTrace_->solve(now, total_area));
495       /* verify which event will happen before (max_duration or finish time) */
496       if (action.get_max_duration() > NO_MAX_DURATION &&
497           action.get_start_time() + action.get_max_duration() < action.get_finish_time())
498         min_finish = action.get_start_time() + action.get_max_duration();
499       else
500         min_finish = action.get_finish_time();
501     } else {
502       /* put the max duration time on heap */
503       if (action.get_max_duration() > NO_MAX_DURATION)
504         min_finish = action.get_start_time() + action.get_max_duration();
505     }
506     /* add in action heap */
507     if (min_finish > NO_MAX_DURATION)
508       action.heapUpdate(min_finish, kernel::resource::Action::Type::NOTSET);
509     else
510       action.heapRemove();
511
512     XBT_DEBUG("Update finish time: Cpu(%s) Action: %p, Start Time: %f Finish Time: %f Max duration %f", getCname(),
513               &action, action.get_start_time(), action.get_finish_time(), action.get_max_duration());
514   }
515   /* remove from modified cpu */
516   modified(false);
517 }
518
519 bool CpuTi::isUsed()
520 {
521   return not actionSet_.empty();
522 }
523
524 double CpuTi::getAvailableSpeed()
525 {
526   speed_.scale = speedIntegratedTrace_->getPowerScale(surf_get_clock());
527   return Cpu::getAvailableSpeed();
528 }
529
530 /** @brief Update the remaining amount of actions */
531 void CpuTi::updateRemainingAmount(double now)
532 {
533
534   /* already updated */
535   if (lastUpdate_ >= now)
536     return;
537
538   /* compute the integration area */
539   double area_total = speedIntegratedTrace_->integrate(lastUpdate_, now) * speed_.peak;
540   XBT_DEBUG("Flops total: %f, Last update %f", area_total, lastUpdate_);
541   for (CpuTiAction& action : actionSet_) {
542     /* action not running, skip it */
543     if (action.get_state_set() != model()->getRunningActionSet())
544       continue;
545
546     /* bogus priority, skip it */
547     if (action.get_priority() <= 0)
548       continue;
549
550     /* action suspended, skip it */
551     if (action.suspended_ != kernel::resource::Action::SuspendStates::not_suspended)
552       continue;
553
554     /* action don't need update */
555     if (action.get_start_time() >= now)
556       continue;
557
558     /* skip action that are finishing now */
559     if (action.get_finish_time() >= 0 && action.get_finish_time() <= now)
560       continue;
561
562     /* update remaining */
563     action.update_remains(area_total / (sumPriority_ * action.get_priority()));
564     XBT_DEBUG("Update remaining action(%p) remaining %f", &action, action.get_remains_no_update());
565   }
566   lastUpdate_ = now;
567 }
568
569 CpuAction *CpuTi::execution_start(double size)
570 {
571   XBT_IN("(%s,%g)", getCname(), size);
572   CpuTiAction* action = new CpuTiAction(static_cast<CpuTiModel*>(model()), size, isOff(), this);
573
574   actionSet_.push_back(*action);
575
576   XBT_OUT();
577   return action;
578 }
579
580
581 CpuAction *CpuTi::sleep(double duration)
582 {
583   if (duration > 0)
584     duration = std::max(duration, sg_surf_precision);
585
586   XBT_IN("(%s,%g)", getCname(), duration);
587   CpuTiAction* action = new CpuTiAction(static_cast<CpuTiModel*>(model()), 1.0, isOff(), this);
588
589   action->set_max_duration(duration);
590   action->suspended_ = kernel::resource::Action::SuspendStates::sleeping;
591   if (duration == NO_MAX_DURATION) {
592     /* Move to the *end* of the corresponding action set. This convention is used to speed up update_resource_state */
593     simgrid::xbt::intrusive_erase(*action->get_state_set(), *action);
594     action->state_set_ = &static_cast<CpuTiModel*>(model())->runningActionSetThatDoesNotNeedBeingChecked_;
595     action->get_state_set()->push_back(*action);
596   }
597
598   actionSet_.push_back(*action);
599
600   XBT_OUT();
601   return action;
602 }
603
604 void CpuTi::modified(bool modified){
605   CpuTiList& modifiedCpu = static_cast<CpuTiModel*>(model())->modifiedCpu_;
606   if (modified) {
607     if (not cpu_ti_hook.is_linked()) {
608       modifiedCpu.push_back(*this);
609     }
610   } else {
611     if (cpu_ti_hook.is_linked())
612       simgrid::xbt::intrusive_erase(modifiedCpu, *this);
613   }
614 }
615
616 /**********
617  * Action *
618  **********/
619
620 CpuTiAction::CpuTiAction(CpuTiModel *model_, double cost, bool failed, CpuTi *cpu)
621  : CpuAction(model_, cost, failed)
622  , cpu_(cpu)
623 {
624   cpu_->modified(true);
625 }
626 CpuTiAction::~CpuTiAction()
627 {
628   /* remove from action_set */
629   if (action_ti_hook.is_linked())
630     simgrid::xbt::intrusive_erase(cpu_->actionSet_, *this);
631   /* remove from heap */
632   heapRemove();
633   cpu_->modified(true);
634 }
635
636 void CpuTiAction::set_state(Action::State state)
637 {
638   CpuAction::set_state(state);
639   cpu_->modified(true);
640 }
641
642 void CpuTiAction::cancel()
643 {
644   this->set_state(Action::State::failed);
645   heapRemove();
646   cpu_->modified(true);
647 }
648
649 void CpuTiAction::suspend()
650 {
651   XBT_IN("(%p)", this);
652   if (suspended_ != Action::SuspendStates::sleeping) {
653     suspended_ = Action::SuspendStates::suspended;
654     heapRemove();
655     cpu_->modified(true);
656   }
657   XBT_OUT();
658 }
659
660 void CpuTiAction::resume()
661 {
662   XBT_IN("(%p)", this);
663   if (suspended_ != Action::SuspendStates::sleeping) {
664     suspended_ = Action::SuspendStates::not_suspended;
665     cpu_->modified(true);
666   }
667   XBT_OUT();
668 }
669
670 void CpuTiAction::set_max_duration(double duration)
671 {
672   double min_finish;
673
674   XBT_IN("(%p,%g)", this, duration);
675
676   Action::set_max_duration(duration);
677
678   if (duration >= 0)
679     min_finish = (get_start_time() + get_max_duration()) < get_finish_time() ? (get_start_time() + get_max_duration())
680                                                                              : get_finish_time();
681   else
682     min_finish = get_finish_time();
683
684   /* add in action heap */
685   heapUpdate(min_finish, Action::Type::NOTSET);
686
687   XBT_OUT();
688 }
689
690 void CpuTiAction::set_priority(double priority)
691 {
692   XBT_IN("(%p,%g)", this, priority);
693   set_priority_no_update(priority);
694   cpu_->modified(true);
695   XBT_OUT();
696 }
697
698 double CpuTiAction::get_remains()
699 {
700   XBT_IN("(%p)", this);
701   cpu_->updateRemainingAmount(surf_get_clock());
702   XBT_OUT();
703   return get_remains_no_update();
704 }
705
706 }
707 }
708
709 #endif /* SURF_MODEL_CPUTI_H_ */