1 /* Copyright (c) 2013-2018. The SimGrid Team. All rights reserved. */
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. */
7 #include "src/surf/trace_mgr.hpp"
8 #include "xbt/utility.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");
23 CpuTiTrace::CpuTiTrace(tmgr_trace_t speedTrace)
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_;
38 timePoints_[i] = time;
39 integral_[i] = integral;
42 CpuTiTrace::~CpuTiTrace()
44 delete [] timePoints_;
48 CpuTiTgmr::~CpuTiTgmr()
55 * \brief Integrate trace
57 * Wrapper around surf_cpu_integrate_trace_simple() to get
60 * \param a Begin of interval
61 * \param b End of interval
62 * \return the integrate value. -1 if an error occurs.
64 double CpuTiTgmr::integrate(double a, double b)
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);
72 if (fabs(a -b) < EPSILON)
75 if (type_ == TRACE_FIXED) {
76 return ((b - a) * value_);
79 if (fabs(ceil(a / lastTime_) - a / lastTime_) < EPSILON)
80 a_index = 1 + static_cast<int>(ceil(a / lastTime_));
82 a_index = static_cast<int> (ceil(a / lastTime_));
84 int b_index = static_cast<int> (floor(b / lastTime_));
86 if (a_index > b_index) { /* Same chunk */
87 return trace_->integrateSimple(a - (a_index - 1) * lastTime_, b - (b_index) * lastTime_);
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_);
94 XBT_DEBUG("first_chunk=%.2f middle_chunk=%.2f last_chunk=%.2f\n", first_chunk, middle_chunk, last_chunk);
96 return (first_chunk + middle_chunk + last_chunk);
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
105 double CpuTiTrace::integrateSimple(double a, double b)
107 return integrateSimplePoint(b) - integrateSimplePoint(a);
111 * \brief Auxiliary function to compute the integral at point a.
114 double CpuTiTrace::integrateSimplePoint(double a)
118 int ind = binarySearch(timePoints_, a, 0, nbPoints_ - 1);
119 integral += integral_[ind];
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);
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);
133 * \brief Computes the time needed to execute "amount" on cpu.
135 * Here, amount can span multiple trace periods
137 * \param a Initial time
138 * \param amount Amount to be executed
141 double CpuTiTgmr::solve(double a, double amount)
143 /* Fix very small negative numbers */
144 if ((a < 0.0) && (a > -EPSILON)) {
147 if ((amount < 0.0) && (amount > -EPSILON)) {
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);
158 /* At this point, a and amount are positive */
159 if (amount < EPSILON)
162 /* Is the trace fixed ? */
163 if (type_ == TRACE_FIXED) {
164 return (a + (amount / value_));
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_));
173 XBT_DEBUG("Quotient: %d reduced_amount: %f reduced_a: %f", quotient, reduced_amount, reduced_a);
175 /* Now solve for new_amount which is <= trace_total */
176 double reduced_b = solveSomewhatSimple(reduced_a, reduced_amount);
178 /* Re-map to the original b and amount */
179 double b = (lastTime_) * static_cast<int>(floor(a / lastTime_)) + (quotient * lastTime_) + reduced_b;
184 * \brief Auxiliary function to solve integral
186 * Here, amount is <= trace->total
187 * and a <=trace->last_time
190 double CpuTiTgmr::solveSomewhatSimple(double a, double amount)
194 XBT_DEBUG("Solve integral: [%.2f, amount=%.2f]", a, amount);
195 double amount_till_end = integrate(a, lastTime_);
197 if (amount_till_end > amount) {
198 b = trace_->solveSimple(a, amount);
200 b = lastTime_ + trace_->solveSimple(0.0, amount - amount_till_end);
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.
212 double CpuTiTrace::solveSimple(double a, double amount)
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]));
224 * \brief Auxiliary function to update the CPU speed scale.
226 * This function uses the trace structure to return the speed scale at the determined time a.
228 * \return CPU speed scale
230 double CpuTiTgmr::getPowerScale(double a)
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);
239 * \brief Creates a new integration trace from a tmgr_trace_t
241 * \param speedTrace CPU availability trace
242 * \param value Percentage of CPU speed available (useful to fixed tracing)
243 * \return Integration trace structure
245 CpuTiTgmr::CpuTiTgmr(tmgr_trace_t speedTrace, double value) :
246 speedTrace_(speedTrace)
248 double total_time = 0.0;
251 /* no availability file, fixed trace */
252 if (not speedTrace) {
255 XBT_DEBUG("No availability trace. Constant value = %f", value);
259 /* only one point available, fixed trace */
260 if (speedTrace->event_list.size() == 1) {
261 trace_mgr::DatedValue val = speedTrace->event_list.front();
267 type_ = TRACE_DYNAMIC;
269 /* count the total time of trace file */
270 for (auto const& val : speedTrace->event_list)
271 total_time += val.date_;
273 trace_ = new CpuTiTrace(speedTrace);
274 lastTime_ = total_time;
275 total_ = trace_->integrateSimple(0, total_time);
277 XBT_DEBUG("Total integral %f, last_time %f ", total_, lastTime_);
281 * \brief Binary search in array.
282 * It returns the first point of the interval in which "a" is.
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
289 int CpuTiTrace::binarySearch(double *array, double a, int low, int high)
291 xbt_assert(low < high, "Wrong parameters: low (%d) should be smaller than high (%d)", low, high);
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]);
302 while (low < high - 1);
314 void surf_cpu_model_init_ti()
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.");
319 surf_cpu_model_pm = new simgrid::surf::CpuTiModel();
320 all_existing_models->push_back(surf_cpu_model_pm);
322 surf_cpu_model_vm = new simgrid::surf::CpuTiModel();
323 all_existing_models->push_back(surf_cpu_model_vm);
329 CpuTiModel::~CpuTiModel()
331 surf_cpu_model_pm = nullptr;
334 Cpu *CpuTiModel::createCpu(simgrid::s4u::Host *host, std::vector<double>* speedPerPstate, int core)
336 return new CpuTi(this, host, speedPerPstate, core);
339 double CpuTiModel::nextOccuringEvent(double now)
341 double min_action_duration = -1;
343 /* iterates over modified cpus to update share resources */
344 for (auto it = std::begin(modifiedCpu_); it != std::end(modifiedCpu_);) {
346 ++it; // increment iterator here since the following call to ti.updateActionsFinishTime() may invalidate it
347 ti.updateActionsFinishTime(now);
350 /* get the min next event if heap not empty */
351 if (not actionHeapIsEmpty())
352 min_action_duration = actionHeapTopDate() - now;
354 XBT_DEBUG("Share resources, min next event date: %f", min_action_duration);
356 return min_action_duration;
359 void CpuTiModel::updateActionsState(double now, double /*delta*/)
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 /* set the remains to 0 due to precision problems when updating the remaining amount */
366 action->set_remains(0);
367 /* update remaining amount of all actions */
368 action->cpu_->updateRemainingAmount(surf_get_clock());
375 CpuTi::CpuTi(CpuTiModel *model, simgrid::s4u::Host *host, std::vector<double> *speedPerPstate, int core)
376 : Cpu(model, host, speedPerPstate, core)
378 xbt_assert(core==1,"Multi-core not handled by this model yet");
381 speed_.peak = speedPerPstate->front();
382 XBT_DEBUG("CPU create: peak=%f", speed_.peak);
384 speedIntegratedTrace_ = new CpuTiTgmr(nullptr, 1/*scale*/);
390 delete speedIntegratedTrace_;
392 void CpuTi::setSpeedTrace(tmgr_trace_t trace)
394 if (speedIntegratedTrace_)
395 delete speedIntegratedTrace_;
397 speedIntegratedTrace_ = new CpuTiTgmr(trace, speed_.scale);
399 /* add a fake trace event if periodicity == 0 */
400 if (trace && trace->event_list.size() > 1) {
401 trace_mgr::DatedValue val = trace->event_list.back();
402 if (val.date_ < 1e-12)
403 speed_.event = future_evt_set->add_trace(new simgrid::trace_mgr::trace(), this);
407 void CpuTi::apply_event(tmgr_trace_event_t event, double value)
409 if (event == speed_.event) {
410 tmgr_trace_t speedTrace;
413 XBT_DEBUG("Finish trace date: value %f", value);
414 /* update remaining of actions and put in modified cpu list */
415 updateRemainingAmount(surf_get_clock());
419 speedTrace = speedIntegratedTrace_->speedTrace_;
420 trace_mgr::DatedValue val = speedTrace->event_list.back();
421 delete speedIntegratedTrace_;
422 speed_.scale = val.value_;
424 trace = new CpuTiTgmr(TRACE_FIXED, val.value_);
425 XBT_DEBUG("value %f", val.value_);
427 speedIntegratedTrace_ = trace;
429 tmgr_trace_event_unref(&speed_.event);
431 } else if (event == stateEvent_) {
434 host_that_restart.push_back(getHost());
438 double date = surf_get_clock();
440 /* put all action running on cpu to failed */
441 for (CpuTiAction& action : actionSet_) {
442 if (action.get_state() == kernel::resource::Action::State::running ||
443 action.get_state() == kernel::resource::Action::State::ready ||
444 action.get_state() == kernel::resource::Action::State::not_in_the_system) {
445 action.set_finish_time(date);
446 action.set_state(kernel::resource::Action::State::failed);
447 action.heapRemove(model()->getActionHeap());
451 tmgr_trace_event_unref(&stateEvent_);
454 xbt_die("Unknown event!\n");
458 void CpuTi::updateActionsFinishTime(double now)
460 double sum_priority = 0.0;
463 /* update remaining amount of actions */
464 updateRemainingAmount(now);
466 for (CpuTiAction const& action : actionSet_) {
467 /* action not running, skip it */
468 if (action.get_state_set() != surf_cpu_model_pm->getRunningActionSet())
471 /* bogus priority, skip it */
472 if (action.get_priority() <= 0)
475 /* action suspended, skip it */
476 if (action.suspended_ != kernel::resource::Action::SuspendStates::not_suspended)
479 sum_priority += 1.0 / action.get_priority();
481 sumPriority_ = sum_priority;
483 for (CpuTiAction& action : actionSet_) {
484 double min_finish = -1;
485 /* action not running, skip it */
486 if (action.get_state_set() != surf_cpu_model_pm->getRunningActionSet())
489 /* verify if the action is really running on cpu */
490 if (action.suspended_ == kernel::resource::Action::SuspendStates::not_suspended && action.get_priority() > 0) {
491 /* total area needed to finish the action. Used in trace integration */
492 total_area = (action.get_remains()) * sum_priority * action.get_priority();
494 total_area /= speed_.peak;
496 action.set_finish_time(speedIntegratedTrace_->solve(now, total_area));
497 /* verify which event will happen before (max_duration or finish time) */
498 if (action.get_max_duration() > NO_MAX_DURATION &&
499 action.get_start_time() + action.get_max_duration() < action.getFinishTime())
500 min_finish = action.get_start_time() + action.get_max_duration();
502 min_finish = action.getFinishTime();
504 /* put the max duration time on heap */
505 if (action.get_max_duration() > NO_MAX_DURATION)
506 min_finish = action.get_start_time() + action.get_max_duration();
508 /* add in action heap */
509 if (min_finish > NO_MAX_DURATION)
510 action.heapUpdate(model()->getActionHeap(), min_finish, kernel::resource::Action::Type::NOTSET);
512 action.heapRemove(model()->getActionHeap());
514 XBT_DEBUG("Update finish time: Cpu(%s) Action: %p, Start Time: %f Finish Time: %f Max duration %f", getCname(),
515 &action, action.get_start_time(), action.getFinishTime(), action.get_max_duration());
517 /* remove from modified cpu */
523 return not actionSet_.empty();
526 double CpuTi::getAvailableSpeed()
528 speed_.scale = speedIntegratedTrace_->getPowerScale(surf_get_clock());
529 return Cpu::getAvailableSpeed();
532 /** @brief Update the remaining amount of actions */
533 void CpuTi::updateRemainingAmount(double now)
536 /* already updated */
537 if (lastUpdate_ >= now)
540 /* compute the integration area */
541 double area_total = speedIntegratedTrace_->integrate(lastUpdate_, now) * speed_.peak;
542 XBT_DEBUG("Flops total: %f, Last update %f", area_total, lastUpdate_);
543 for (CpuTiAction& action : actionSet_) {
544 /* action not running, skip it */
545 if (action.get_state_set() != model()->getRunningActionSet())
548 /* bogus priority, skip it */
549 if (action.get_priority() <= 0)
552 /* action suspended, skip it */
553 if (action.suspended_ != kernel::resource::Action::SuspendStates::not_suspended)
556 /* action don't need update */
557 if (action.get_start_time() >= now)
560 /* skip action that are finishing now */
561 if (action.getFinishTime() >= 0 && action.getFinishTime() <= now)
564 /* update remaining */
565 action.update_remains(area_total / (sumPriority_ * action.get_priority()));
566 XBT_DEBUG("Update remaining action(%p) remaining %f", &action, action.get_remains_no_update());
571 CpuAction *CpuTi::execution_start(double size)
573 XBT_IN("(%s,%g)", getCname(), size);
574 CpuTiAction* action = new CpuTiAction(static_cast<CpuTiModel*>(model()), size, isOff(), this);
576 actionSet_.push_back(*action);
583 CpuAction *CpuTi::sleep(double duration)
586 duration = std::max(duration, sg_surf_precision);
588 XBT_IN("(%s,%g)", getCname(), duration);
589 CpuTiAction* action = new CpuTiAction(static_cast<CpuTiModel*>(model()), 1.0, isOff(), this);
591 action->set_max_duration(duration);
592 action->suspended_ = kernel::resource::Action::SuspendStates::sleeping;
593 if (duration == NO_MAX_DURATION) {
594 /* Move to the *end* of the corresponding action set. This convention is used to speed up update_resource_state */
595 simgrid::xbt::intrusive_erase(*action->get_state_set(), *action);
596 action->state_set_ = &static_cast<CpuTiModel*>(model())->runningActionSetThatDoesNotNeedBeingChecked_;
597 action->get_state_set()->push_back(*action);
600 actionSet_.push_back(*action);
606 void CpuTi::modified(bool modified){
607 CpuTiList& modifiedCpu = static_cast<CpuTiModel*>(model())->modifiedCpu_;
609 if (not cpu_ti_hook.is_linked()) {
610 modifiedCpu.push_back(*this);
613 if (cpu_ti_hook.is_linked())
614 simgrid::xbt::intrusive_erase(modifiedCpu, *this);
622 CpuTiAction::CpuTiAction(CpuTiModel *model_, double cost, bool failed, CpuTi *cpu)
623 : CpuAction(model_, cost, failed)
626 cpu_->modified(true);
629 void CpuTiAction::set_state(Action::State state)
631 CpuAction::set_state(state);
632 cpu_->modified(true);
635 int CpuTiAction::unref()
639 if (state_set_hook_.is_linked())
640 simgrid::xbt::intrusive_erase(*get_state_set(), *this);
641 /* remove from action_set */
642 if (action_ti_hook.is_linked())
643 simgrid::xbt::intrusive_erase(cpu_->actionSet_, *this);
644 /* remove from heap */
645 heapRemove(get_model()->getActionHeap());
646 cpu_->modified(true);
653 void CpuTiAction::cancel()
655 this->set_state(Action::State::failed);
656 heapRemove(get_model()->getActionHeap());
657 cpu_->modified(true);
660 void CpuTiAction::suspend()
662 XBT_IN("(%p)", this);
663 if (suspended_ != Action::SuspendStates::sleeping) {
664 suspended_ = Action::SuspendStates::suspended;
665 heapRemove(get_model()->getActionHeap());
666 cpu_->modified(true);
671 void CpuTiAction::resume()
673 XBT_IN("(%p)", this);
674 if (suspended_ != Action::SuspendStates::sleeping) {
675 suspended_ = Action::SuspendStates::not_suspended;
676 cpu_->modified(true);
681 void CpuTiAction::set_max_duration(double duration)
685 XBT_IN("(%p,%g)", this, duration);
687 Action::set_max_duration(duration);
690 min_finish = (get_start_time() + get_max_duration()) < getFinishTime() ? (get_start_time() + get_max_duration())
693 min_finish = getFinishTime();
695 /* add in action heap */
696 heapUpdate(get_model()->getActionHeap(), min_finish, Action::Type::NOTSET);
701 void CpuTiAction::set_priority(double priority)
703 XBT_IN("(%p,%g)", this, priority);
704 set_priority_no_update(priority);
705 cpu_->modified(true);
709 double CpuTiAction::get_remains()
711 XBT_IN("(%p)", this);
712 cpu_->updateRemainingAmount(surf_get_clock());
714 return get_remains_no_update();
720 #endif /* SURF_MODEL_CPUTI_H_ */