1 /* Copyright (c) 2013-2015. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "src/surf/trace_mgr.hpp"
11 #ifndef SURF_MODEL_CPUTI_H_
12 #define SURF_MODEL_CPUTI_H_
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu_ti, surf_cpu, "Logging specific to the SURF CPU TRACE INTEGRATION module");
20 void cpu_ti_action_update_index_heap(void *action, int i)
22 (static_cast<simgrid::surf::CpuTiAction*>(action))->updateIndexHeap(i);
29 CpuTiTrace::CpuTiTrace(tmgr_trace_t speedTrace)
34 nbPoints_ = speedTrace->event_list.size() + 1;
35 timePoints_ = new double[nbPoints_];
36 integral_ = new double[nbPoints_];
37 for (auto val : speedTrace->event_list) {
38 timePoints_[i] = time;
39 integral_[i] = integral;
40 integral += val.delta * val.value;
44 timePoints_[i] = time;
45 integral_[i] = integral;
48 CpuTiTrace::~CpuTiTrace()
50 delete [] timePoints_;
54 CpuTiTgmr::~CpuTiTgmr()
61 * \brief Integrate trace
63 * Wrapper around surf_cpu_integrate_trace_simple() to get
66 * \param a Begin of interval
67 * \param b End of interval
68 * \return the integrate value. -1 if an error occurs.
70 double CpuTiTgmr::integrate(double a, double b)
78 if ((a < 0.0) || (a > b)) {
79 xbt_die("Error, invalid integration interval [%.2f,%.2f]. "
80 "You probably have a task executing with negative computation amount. Check your code.", a, b);
82 if (fabs(a -b) < EPSILON)
85 if (type_ == TRACE_FIXED) {
86 return ((b - a) * value_);
89 if (fabs(ceil(a / lastTime_) - a / lastTime_) < EPSILON)
90 a_index = 1 + static_cast<int>(ceil(a / lastTime_));
92 a_index = static_cast<int> (ceil(a / lastTime_));
94 b_index = static_cast<int> (floor(b / lastTime_));
96 if (a_index > b_index) { /* Same chunk */
97 return trace_->integrateSimple(a - (a_index - 1) * lastTime_, b - (b_index) * lastTime_);
100 first_chunk = trace_->integrateSimple(a - (a_index - 1) * lastTime_, lastTime_);
101 middle_chunk = (b_index - a_index) * total_;
102 last_chunk = trace_->integrateSimple(0.0, b - (b_index) * lastTime_);
104 XBT_DEBUG("first_chunk=%.2f middle_chunk=%.2f last_chunk=%.2f\n", first_chunk, middle_chunk, last_chunk);
106 return (first_chunk + middle_chunk + last_chunk);
110 * \brief Auxiliary function to compute the integral between a and b.
111 * It simply computes the integrals at point a and b and returns the difference between them.
112 * \param a Initial point
113 * \param b Final point
115 double CpuTiTrace::integrateSimple(double a, double b)
117 return integrateSimplePoint(b) - integrateSimplePoint(a);
121 * \brief Auxiliary function to compute the integral at point a.
124 double CpuTiTrace::integrateSimplePoint(double a)
129 ind = binarySearch(timePoints_, a, 0, nbPoints_ - 1);
130 integral += integral_[ind];
131 XBT_DEBUG("a %f ind %d integral %f ind + 1 %f ind %f time +1 %f time %f",
132 a, ind, integral, integral_[ind + 1], integral_[ind], timePoints_[ind + 1], timePoints_[ind]);
133 double_update(&a_aux, timePoints_[ind], sg_maxmin_precision*sg_surf_precision);
135 integral += ((integral_[ind + 1] - integral_[ind]) / (timePoints_[ind + 1] - timePoints_[ind])) *
136 (a - timePoints_[ind]);
137 XBT_DEBUG("Integral a %f = %f", a, integral);
143 * \brief Computes the time needed to execute "amount" on cpu.
145 * Here, amount can span multiple trace periods
147 * \param a Initial time
148 * \param amount Amount to be executed
151 double CpuTiTgmr::solve(double a, double amount)
153 /* Fix very small negative numbers */
154 if ((a < 0.0) && (a > -EPSILON)) {
157 if ((amount < 0.0) && (amount > -EPSILON)) {
162 if ((a < 0.0) || (amount < 0.0)) {
163 XBT_CRITICAL ("Error, invalid parameters [a = %.2f, amount = %.2f]. "
164 "You probably have a task executing with negative computation amount. Check your code.", a, amount);
168 /* At this point, a and amount are positive */
169 if (amount < EPSILON)
172 /* Is the trace fixed ? */
173 if (type_ == TRACE_FIXED) {
174 return (a + (amount / value_));
177 XBT_DEBUG("amount %f total %f", amount, total_);
178 /* Reduce the problem to one where amount <= trace_total */
179 int quotient = static_cast<int>(floor(amount / total_));
180 double reduced_amount = (total_) * ((amount / total_) - floor(amount / total_));
181 double reduced_a = a - (lastTime_) * static_cast<int>(floor(a / lastTime_));
183 XBT_DEBUG("Quotient: %d reduced_amount: %f reduced_a: %f", quotient, reduced_amount, reduced_a);
185 /* Now solve for new_amount which is <= trace_total */
186 double reduced_b = solveSomewhatSimple(reduced_a, reduced_amount);
188 /* Re-map to the original b and amount */
189 double b = (lastTime_) * static_cast<int>(floor(a / lastTime_)) + (quotient * lastTime_) + reduced_b;
194 * \brief Auxiliary function to solve integral
196 * Here, amount is <= trace->total
197 * and a <=trace->last_time
200 double CpuTiTgmr::solveSomewhatSimple(double a, double amount)
204 XBT_DEBUG("Solve integral: [%.2f, amount=%.2f]", a, amount);
205 double amount_till_end = integrate(a, lastTime_);
207 if (amount_till_end > amount) {
208 b = trace_->solveSimple(a, amount);
210 b = lastTime_ + trace_->solveSimple(0.0, amount - amount_till_end);
216 * \brief Auxiliary function to solve integral.
217 * It returns the date when the requested amount of flops is available
218 * \param a Initial point
219 * \param amount Amount of flops
220 * \return The date when amount is available.
222 double CpuTiTrace::solveSimple(double a, double amount)
224 double integral_a = integrateSimplePoint(a);
225 int ind = binarySearch(integral_, integral_a + amount, 0, nbPoints_ - 1);
226 double time = timePoints_[ind];
227 time += (integral_a + amount - integral_[ind]) /
228 ((integral_[ind + 1] - integral_[ind]) / (timePoints_[ind + 1] - timePoints_[ind]));
234 * \brief Auxiliary function to update the CPU speed scale.
236 * This function uses the trace structure to return the speed scale at the determined time a.
238 * \return CPU speed scale
240 double CpuTiTgmr::getPowerScale(double a)
242 double reduced_a = a - floor(a / lastTime_) * lastTime_;
243 int point = trace_->binarySearch(trace_->timePoints_, reduced_a, 0, trace_->nbPoints_ - 1);
244 s_tmgr_event_t val = speedTrace_->event_list.at(point);
249 * \brief Creates a new integration trace from a tmgr_trace_t
251 * \param speedTrace CPU availability trace
252 * \param value Percentage of CPU speed available (useful to fixed tracing)
253 * \return Integration trace structure
255 CpuTiTgmr::CpuTiTgmr(tmgr_trace_t speedTrace, double value)
257 double total_time = 0.0;
260 /* no availability file, fixed trace */
264 XBT_DEBUG("No availability trace. Constant value = %f", value);
268 /* only one point available, fixed trace */
269 if (speedTrace->event_list.size() == 1) {
270 s_tmgr_event_t val = speedTrace->event_list.front();
276 type_ = TRACE_DYNAMIC;
277 speedTrace_ = speedTrace;
279 /* count the total time of trace file */
280 for (auto val: speedTrace->event_list) {
281 total_time += val.delta;
283 trace_ = new CpuTiTrace(speedTrace);
284 lastTime_ = total_time;
285 total_ = trace_->integrateSimple(0, total_time);
287 XBT_DEBUG("Total integral %f, last_time %f ", total_, lastTime_);
291 * \brief Binary search in array.
292 * It returns the first point of the interval in which "a" is.
294 * \param a Value to search
295 * \param low Low bound to search in array
296 * \param high Upper bound to search in array
297 * \return Index of point
299 int CpuTiTrace::binarySearch(double *array, double a, int low, int high)
301 xbt_assert(low < high, "Wrong parameters: low (%d) should be smaller than high (%d)", low, high);
305 mid = low + (high - low) / 2;
306 XBT_DEBUG("a %f low %d high %d mid %d value %f", a, low, high, mid, array[mid]);
313 while (low < high - 1);
325 void surf_cpu_model_init_ti()
327 xbt_assert(!surf_cpu_model_pm,"CPU model already initialized. This should not happen.");
328 xbt_assert(!surf_cpu_model_vm,"CPU model already initialized. This should not happen.");
330 surf_cpu_model_pm = new simgrid::surf::CpuTiModel();
331 all_existing_models->push_back(surf_cpu_model_pm);
333 surf_cpu_model_vm = new simgrid::surf::CpuTiModel();
334 all_existing_models->push_back(surf_cpu_model_vm);
340 CpuTiModel::CpuTiModel() : CpuModel()
342 runningActionSetThatDoesNotNeedBeingChecked_ = new ActionList();
344 modifiedCpu_ = new CpuTiList();
346 tiActionHeap_ = xbt_heap_new(8, nullptr);
347 xbt_heap_set_update_callback(tiActionHeap_, cpu_ti_action_update_index_heap);
350 CpuTiModel::~CpuTiModel()
352 surf_cpu_model_pm = nullptr;
353 delete runningActionSetThatDoesNotNeedBeingChecked_;
355 xbt_heap_free(tiActionHeap_);
358 Cpu *CpuTiModel::createCpu(simgrid::s4u::Host *host, std::vector<double>* speedPerPstate, int core)
360 return new CpuTi(this, host, speedPerPstate, core);
363 double CpuTiModel::nextOccuringEvent(double now)
365 double min_action_duration = -1;
367 /* iterates over modified cpus to update share resources */
368 for(CpuTiList::iterator it(modifiedCpu_->begin()), itend(modifiedCpu_->end()) ; it != itend ;) {
371 ti->updateActionsFinishTime(now);
374 /* get the min next event if heap not empty */
375 if (xbt_heap_size(tiActionHeap_) > 0)
376 min_action_duration = xbt_heap_maxkey(tiActionHeap_) - now;
378 XBT_DEBUG("Share resources, min next event date: %f", min_action_duration);
380 return min_action_duration;
383 void CpuTiModel::updateActionsState(double now, double /*delta*/)
385 while ((xbt_heap_size(tiActionHeap_) > 0) && (xbt_heap_maxkey(tiActionHeap_) <= now)) {
386 CpuTiAction *action = static_cast<CpuTiAction*>(xbt_heap_pop(tiActionHeap_));
387 XBT_DEBUG("Action %p: finish", action);
389 /* set the remains to 0 due to precision problems when updating the remaining amount */
390 action->setRemains(0);
391 action->setState(Action::State::done);
392 /* update remaining amount of all actions */
393 action->cpu_->updateRemainingAmount(surf_get_clock());
400 CpuTi::CpuTi(CpuTiModel *model, simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)
401 : Cpu(model, host, speedPerPstate, core)
403 xbt_assert(core==1,"Multi-core not handled by this model yet");
406 actionSet_ = new ActionTiList();
408 speed_.peak = speedPerPstate->front();
409 XBT_DEBUG("CPU create: peak=%f", speed_.peak);
411 speedIntegratedTrace_ = new CpuTiTgmr(nullptr, 1/*scale*/);
417 delete speedIntegratedTrace_;
420 void CpuTi::setSpeedTrace(tmgr_trace_t trace)
422 if (speedIntegratedTrace_)
423 delete speedIntegratedTrace_;
425 speedIntegratedTrace_ = new CpuTiTgmr(trace, speed_.scale);
427 /* add a fake trace event if periodicity == 0 */
428 if (trace && trace->event_list.size() > 1) {
429 s_tmgr_event_t val = trace->event_list.back();
430 if (val.delta < 1e-12)
431 speed_.event = future_evt_set->add_trace(tmgr_empty_trace_new(), 0.0, this);
435 void CpuTi::apply_event(tmgr_trace_iterator_t event, double value)
437 if (event == speed_.event) {
438 tmgr_trace_t speedTrace;
441 XBT_DEBUG("Finish trace date: value %f", value);
442 /* update remaining of actions and put in modified cpu swag */
443 updateRemainingAmount(surf_get_clock());
447 speedTrace = speedIntegratedTrace_->speedTrace_;
448 s_tmgr_event_t val = speedTrace->event_list.back();
449 delete speedIntegratedTrace_;
450 speed_.scale = val.value;
452 trace = new CpuTiTgmr(TRACE_FIXED, val.value);
453 XBT_DEBUG("value %f", val.value);
455 speedIntegratedTrace_ = trace;
457 tmgr_trace_event_unref(&speed_.event);
459 } else if (event == stateEvent_) {
462 host_that_restart.push_back(getHost());
466 double date = surf_get_clock();
468 /* put all action running on cpu to failed */
469 for(ActionTiList::iterator it(actionSet_->begin()), itend(actionSet_->end()); it != itend ; ++it) {
471 CpuTiAction *action = &*it;
472 if (action->getState() == Action::State::running
473 || action->getState() == Action::State::ready
474 || action->getState() == Action::State::not_in_the_system) {
475 action->setFinishTime(date);
476 action->setState(Action::State::failed);
477 if (action->indexHeap_ >= 0) {
478 CpuTiAction *heap_act =
479 static_cast<CpuTiAction*>(xbt_heap_remove(static_cast<CpuTiModel*>(getModel())->tiActionHeap_, action->indexHeap_));
480 if (heap_act != action)
486 tmgr_trace_event_unref(&stateEvent_);
489 xbt_die("Unknown event!\n");
493 void CpuTi::updateActionsFinishTime(double now)
496 double sum_priority = 0.0;
498 double min_finish = -1;
500 /* update remaining amount of actions */
501 updateRemainingAmount(now);
503 for(ActionTiList::iterator it(actionSet_->begin()), itend(actionSet_->end()) ; it != itend ; ++it) {
505 /* action not running, skip it */
506 if (action->getStateSet() != surf_cpu_model_pm->getRunningActionSet())
509 /* bogus priority, skip it */
510 if (action->getPriority() <= 0)
513 /* action suspended, skip it */
514 if (action->suspended_ != 0)
517 sum_priority += 1.0 / action->getPriority();
519 sumPriority_ = sum_priority;
521 for(ActionTiList::iterator it(actionSet_->begin()), itend(actionSet_->end()) ; it != itend ; ++it) {
524 /* action not running, skip it */
525 if (action->getStateSet() != surf_cpu_model_pm->getRunningActionSet())
528 /* verify if the action is really running on cpu */
529 if (action->suspended_ == 0 && action->getPriority() > 0) {
530 /* total area needed to finish the action. Used in trace integration */
531 total_area = (action->getRemains()) * sum_priority * action->getPriority();
533 total_area /= speed_.peak;
535 action->setFinishTime(speedIntegratedTrace_->solve(now, total_area));
536 /* verify which event will happen before (max_duration or finish time) */
537 if (action->getMaxDuration() > NO_MAX_DURATION &&
538 action->getStartTime() + action->getMaxDuration() < action->finishTime_)
539 min_finish = action->getStartTime() + action->getMaxDuration();
541 min_finish = action->finishTime_;
543 /* put the max duration time on heap */
544 if (action->getMaxDuration() > NO_MAX_DURATION)
545 min_finish = action->getStartTime() + action->getMaxDuration();
547 /* add in action heap */
548 XBT_DEBUG("action(%p) index %d", action, action->indexHeap_);
549 if (action->indexHeap_ >= 0) {
550 CpuTiAction *heap_act =
551 static_cast<CpuTiAction*>(xbt_heap_remove(static_cast<CpuTiModel*>(getModel())->tiActionHeap_, action->indexHeap_));
552 if (heap_act != action)
555 if (min_finish > NO_MAX_DURATION)
556 xbt_heap_push(static_cast<CpuTiModel*>(getModel())->tiActionHeap_, action, min_finish);
558 XBT_DEBUG("Update finish time: Cpu(%s) Action: %p, Start Time: %f Finish Time: %f Max duration %f",
559 getName(), action, action->getStartTime(), action->finishTime_, action->getMaxDuration());
561 /* remove from modified cpu */
567 return !actionSet_->empty();
570 double CpuTi::getAvailableSpeed()
572 speed_.scale = speedIntegratedTrace_->getPowerScale(surf_get_clock());
573 return Cpu::getAvailableSpeed();
576 /** @brief Update the remaining amount of actions */
577 void CpuTi::updateRemainingAmount(double now)
580 /* already updated */
581 if (lastUpdate_ >= now)
584 /* compute the integration area */
585 double area_total = speedIntegratedTrace_->integrate(lastUpdate_, now) * speed_.peak;
586 XBT_DEBUG("Flops total: %f, Last update %f", area_total, lastUpdate_);
588 for(ActionTiList::iterator it(actionSet_->begin()), itend(actionSet_->end()) ; it != itend ; ++it) {
589 CpuTiAction *action = &*it;
590 /* action not running, skip it */
591 if (action->getStateSet() != getModel()->getRunningActionSet())
594 /* bogus priority, skip it */
595 if (action->getPriority() <= 0)
598 /* action suspended, skip it */
599 if (action->suspended_ != 0)
602 /* action don't need update */
603 if (action->getStartTime() >= now)
606 /* skip action that are finishing now */
607 if (action->finishTime_ >= 0 && action->finishTime_ <= now)
610 /* update remaining */
611 action->updateRemains(area_total / (sumPriority_ * action->getPriority()));
612 XBT_DEBUG("Update remaining action(%p) remaining %f", action, action->remains_);
617 CpuAction *CpuTi::execution_start(double size)
619 XBT_IN("(%s,%g)", getName(), size);
620 CpuTiAction *action = new CpuTiAction(static_cast<CpuTiModel*>(getModel()), size, isOff(), this);
622 actionSet_->push_back(*action);
629 CpuAction *CpuTi::sleep(double duration)
632 duration = MAX(duration, sg_surf_precision);
634 XBT_IN("(%s,%g)", getName(), duration);
635 CpuTiAction *action = new CpuTiAction(static_cast<CpuTiModel*>(getModel()), 1.0, isOff(), this);
637 action->maxDuration_ = duration;
638 action->suspended_ = 2;
639 if (duration == NO_MAX_DURATION) {
640 /* Move to the *end* of the corresponding action set. This convention
641 is used to speed up update_resource_state */
642 action->getStateSet()->erase(action->getStateSet()->iterator_to(*action));
643 action->stateSet_ = static_cast<CpuTiModel*>(getModel())->runningActionSetThatDoesNotNeedBeingChecked_;
644 action->getStateSet()->push_back(*action);
647 actionSet_->push_back(*action);
653 void CpuTi::modified(bool modified){
654 CpuTiList *modifiedCpu = static_cast<CpuTiModel*>(getModel())->modifiedCpu_;
656 if (!cpu_ti_hook.is_linked()) {
657 modifiedCpu->push_back(*this);
660 if (cpu_ti_hook.is_linked()) {
661 modifiedCpu->erase(modifiedCpu->iterator_to(*this));
670 CpuTiAction::CpuTiAction(CpuTiModel *model_, double cost, bool failed, CpuTi *cpu)
671 : CpuAction(model_, cost, failed)
675 cpu_->modified(true);
678 void CpuTiAction::updateIndexHeap(int i)
683 void CpuTiAction::setState(Action::State state)
685 CpuAction::setState(state);
686 cpu_->modified(true);
689 int CpuTiAction::unref()
693 if (action_hook.is_linked())
694 getStateSet()->erase(getStateSet()->iterator_to(*this));
695 /* remove from action_set */
696 if (action_ti_hook.is_linked())
697 cpu_->actionSet_->erase(cpu_->actionSet_->iterator_to(*this));
698 /* remove from heap */
699 xbt_heap_remove(static_cast<CpuTiModel*>(getModel())->tiActionHeap_, this->indexHeap_);
700 cpu_->modified(true);
707 void CpuTiAction::cancel()
709 this->setState(Action::State::failed);
710 xbt_heap_remove(getModel()->getActionHeap(), this->indexHeap_);
711 cpu_->modified(true);
715 void CpuTiAction::suspend()
717 XBT_IN("(%p)", this);
718 if (suspended_ != 2) {
720 xbt_heap_remove(getModel()->getActionHeap(), indexHeap_);
721 cpu_->modified(true);
726 void CpuTiAction::resume()
728 XBT_IN("(%p)", this);
729 if (suspended_ != 2) {
731 cpu_->modified(true);
736 void CpuTiAction::setMaxDuration(double duration)
740 XBT_IN("(%p,%g)", this, duration);
742 maxDuration_ = duration;
745 min_finish = (getStartTime() + getMaxDuration()) < getFinishTime() ?
746 (getStartTime() + getMaxDuration()) : getFinishTime();
748 min_finish = getFinishTime();
750 /* add in action heap */
751 if (indexHeap_ >= 0) {
752 CpuTiAction *heap_act = static_cast<CpuTiAction*>(xbt_heap_remove(getModel()->getActionHeap(), indexHeap_));
753 if (heap_act != this)
756 xbt_heap_push(getModel()->getActionHeap(), this, min_finish);
761 void CpuTiAction::setPriority(double priority)
763 XBT_IN("(%p,%g)", this, priority);
764 priority_ = priority;
765 cpu_->modified(true);
769 double CpuTiAction::getRemains()
771 XBT_IN("(%p)", this);
772 cpu_->updateRemainingAmount(surf_get_clock());
780 #endif /* SURF_MODEL_CPUTI_H_ */