1 /* Copyright (c) 2013-2019. 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/kernel/resource/profile/trace_mgr.hpp"
8 #include "src/surf/surf_interface.hpp"
9 #include "surf/surf.hpp"
13 constexpr double EPSILON = 0.000000001;
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_cpu_ti, surf_cpu, "Logging specific to the SURF CPU TRACE INTEGRATION module");
25 CpuTiProfile::CpuTiProfile(profile::Profile* profile)
29 unsigned nb_points = profile->event_list.size() + 1;
30 time_points_.reserve(nb_points);
31 integral_.reserve(nb_points);
32 for (auto const& val : profile->event_list) {
33 time_points_.push_back(time);
34 integral_.push_back(integral);
36 integral += val.date_ * val.value_;
38 time_points_.push_back(time);
39 integral_.push_back(integral);
42 CpuTiTmgr::~CpuTiTmgr()
48 * @brief Integrate trace
50 * Wrapper around surf_cpu_integrate_trace_simple() to get
53 * @param a Begin of interval
54 * @param b End of interval
55 * @return the integrate value. -1 if an error occurs.
57 double CpuTiTmgr::integrate(double a, double b)
59 if ((a < 0.0) || (a > b)) {
60 xbt_die("Error, invalid integration interval [%.2f,%.2f]. "
61 "You probably have a task executing with negative computation amount. Check your code.", a, b);
63 if (fabs(a - b) < EPSILON)
66 if (type_ == Type::FIXED) {
67 return (b - a) * value_;
71 if (fabs(ceil(a / last_time_) - a / last_time_) < EPSILON)
72 a_index = 1 + static_cast<int>(ceil(a / last_time_));
74 a_index = static_cast<int>(ceil(a / last_time_));
76 int b_index = static_cast<int>(floor(b / last_time_));
78 if (a_index > b_index) { /* Same chunk */
79 return profile_->integrate_simple(a - (a_index - 1) * last_time_, b - (b_index)*last_time_);
82 double first_chunk = profile_->integrate_simple(a - (a_index - 1) * last_time_, last_time_);
83 double middle_chunk = (b_index - a_index) * total_;
84 double last_chunk = profile_->integrate_simple(0.0, b - (b_index)*last_time_);
86 XBT_DEBUG("first_chunk=%.2f middle_chunk=%.2f last_chunk=%.2f\n", first_chunk, middle_chunk, last_chunk);
88 return (first_chunk + middle_chunk + last_chunk);
92 * @brief Auxiliary function to compute the integral between a and b.
93 * It simply computes the integrals at point a and b and returns the difference between them.
94 * @param a Initial point
95 * @param b Final point
97 double CpuTiProfile::integrate_simple(double a, double b)
99 return integrate_simple_point(b) - integrate_simple_point(a);
103 * @brief Auxiliary function to compute the integral at point a.
106 double CpuTiProfile::integrate_simple_point(double a)
110 int ind = binary_search(time_points_, a);
111 integral += integral_[ind];
113 XBT_DEBUG("a %f ind %d integral %f ind + 1 %f ind %f time +1 %f time %f", a, ind, integral, integral_[ind + 1],
114 integral_[ind], time_points_[ind + 1], time_points_[ind]);
115 double_update(&a_aux, time_points_[ind], sg_maxmin_precision * sg_surf_precision);
118 ((integral_[ind + 1] - integral_[ind]) / (time_points_[ind + 1] - time_points_[ind])) * (a - time_points_[ind]);
119 XBT_DEBUG("Integral a %f = %f", a, integral);
125 * @brief Computes the time needed to execute "amount" on cpu.
127 * Here, amount can span multiple trace periods
129 * @param a Initial time
130 * @param amount Amount to be executed
133 double CpuTiTmgr::solve(double a, double amount)
135 /* Fix very small negative numbers */
136 if ((a < 0.0) && (a > -EPSILON)) {
139 if ((amount < 0.0) && (amount > -EPSILON)) {
144 if ((a < 0.0) || (amount < 0.0)) {
145 XBT_CRITICAL ("Error, invalid parameters [a = %.2f, amount = %.2f]. "
146 "You probably have a task executing with negative computation amount. Check your code.", a, amount);
150 /* At this point, a and amount are positive */
151 if (amount < EPSILON)
154 /* Is the trace fixed ? */
155 if (type_ == Type::FIXED) {
156 return (a + (amount / value_));
159 XBT_DEBUG("amount %f total %f", amount, total_);
160 /* Reduce the problem to one where amount <= trace_total */
161 int quotient = static_cast<int>(floor(amount / total_));
162 double reduced_amount = (total_) * ((amount / total_) - floor(amount / total_));
163 double reduced_a = a - (last_time_) * static_cast<int>(floor(a / last_time_));
165 XBT_DEBUG("Quotient: %d reduced_amount: %f reduced_a: %f", quotient, reduced_amount, reduced_a);
167 /* Now solve for new_amount which is <= trace_total */
169 XBT_DEBUG("Solve integral: [%.2f, amount=%.2f]", reduced_a, reduced_amount);
170 double amount_till_end = integrate(reduced_a, last_time_);
172 if (amount_till_end > reduced_amount) {
173 reduced_b = profile_->solve_simple(reduced_a, reduced_amount);
175 reduced_b = last_time_ + profile_->solve_simple(0.0, reduced_amount - amount_till_end);
178 /* Re-map to the original b and amount */
179 return (last_time_) * static_cast<int>(floor(a / last_time_)) + (quotient * last_time_) + reduced_b;
183 * @brief Auxiliary function to solve integral.
184 * It returns the date when the requested amount of flops is available
185 * @param a Initial point
186 * @param amount Amount of flops
187 * @return The date when amount is available.
189 double CpuTiProfile::solve_simple(double a, double amount)
191 double integral_a = integrate_simple_point(a);
192 int ind = binary_search(integral_, integral_a + amount);
193 double time = time_points_[ind];
194 time += (integral_a + amount - integral_[ind]) /
195 ((integral_[ind + 1] - integral_[ind]) / (time_points_[ind + 1] - time_points_[ind]));
201 * @brief Auxiliary function to update the CPU speed scale.
203 * This function uses the trace structure to return the speed scale at the determined time a.
205 * @return CPU speed scale
207 double CpuTiTmgr::get_power_scale(double a)
209 double reduced_a = a - floor(a / last_time_) * last_time_;
210 int point = profile_->binary_search(profile_->time_points_, reduced_a);
211 kernel::profile::DatedValue val = speed_profile_->event_list.at(point);
216 * @brief Creates a new integration trace from a tmgr_trace_t
218 * @param speed_trace CPU availability trace
219 * @param value Percentage of CPU speed available (useful to fixed tracing)
220 * @return Integration trace structure
222 CpuTiTmgr::CpuTiTmgr(kernel::profile::Profile* speed_profile, double value) : speed_profile_(speed_profile)
224 double total_time = 0.0;
227 /* no availability file, fixed trace */
228 if (not speed_profile) {
231 XBT_DEBUG("No availability trace. Constant value = %f", value);
235 /* only one point available, fixed trace */
236 if (speed_profile->event_list.size() == 1) {
238 value_ = speed_profile->event_list.front().value_;
242 type_ = Type::DYNAMIC;
244 /* count the total time of trace file */
245 for (auto const& val : speed_profile->event_list)
246 total_time += val.date_;
248 profile_ = new CpuTiProfile(speed_profile);
249 last_time_ = total_time;
250 total_ = profile_->integrate_simple(0, total_time);
252 XBT_DEBUG("Total integral %f, last_time %f ", total_, last_time_);
256 * @brief Binary search in array.
257 * It returns the last point of the interval in which "a" is.
259 * @param a Value to search
260 * @return Index of point
262 int CpuTiProfile::binary_search(const std::vector<double>& array, double a)
266 auto pos = std::upper_bound(begin(array), end(array), a);
267 return std::distance(begin(array), pos) - 1;
274 void CpuTiModel::create_pm_vm_models()
276 xbt_assert(surf_cpu_model_pm == nullptr, "CPU model already initialized. This should not happen.");
277 xbt_assert(surf_cpu_model_vm == nullptr, "CPU model already initialized. This should not happen.");
279 surf_cpu_model_pm = new simgrid::kernel::resource::CpuTiModel();
280 surf_cpu_model_vm = new simgrid::kernel::resource::CpuTiModel();
283 CpuTiModel::CpuTiModel() : CpuModel(Model::UpdateAlgo::FULL)
285 all_existing_models.push_back(this);
288 CpuTiModel::~CpuTiModel()
290 surf_cpu_model_pm = nullptr;
293 kernel::resource::Cpu* CpuTiModel::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate, int core)
295 return new CpuTi(this, host, speed_per_pstate, core);
298 double CpuTiModel::next_occuring_event(double now)
300 double min_action_duration = -1;
302 /* iterates over modified cpus to update share resources */
303 for (auto it = std::begin(modified_cpus_); it != std::end(modified_cpus_);) {
305 ++it; // increment iterator here since the following call to ti.update_actions_finish_time() may invalidate it
306 cpu.update_actions_finish_time(now);
309 /* get the min next event if heap not empty */
310 if (not get_action_heap().empty())
311 min_action_duration = get_action_heap().top_date() - now;
313 XBT_DEBUG("Share resources, min next event date: %f", min_action_duration);
315 return min_action_duration;
318 void CpuTiModel::update_actions_state(double now, double /*delta*/)
320 while (not get_action_heap().empty() && double_equals(get_action_heap().top_date(), now, sg_surf_precision)) {
321 CpuTiAction* action = static_cast<CpuTiAction*>(get_action_heap().pop());
322 XBT_DEBUG("Action %p: finish", action);
323 action->finish(kernel::resource::Action::State::FINISHED);
324 /* update remaining amount of all actions */
325 action->cpu_->update_remaining_amount(surf_get_clock());
332 CpuTi::CpuTi(CpuTiModel* model, simgrid::s4u::Host* host, const std::vector<double>& speed_per_pstate, int core)
333 : Cpu(model, host, speed_per_pstate, core)
335 xbt_assert(core == 1, "Multi-core not handled by this model yet");
337 speed_.peak = speed_per_pstate.front();
338 XBT_DEBUG("CPU create: peak=%f", speed_.peak);
340 speed_integrated_trace_ = new CpuTiTmgr(nullptr, 1 /*scale*/);
346 delete speed_integrated_trace_;
348 void CpuTi::set_speed_profile(kernel::profile::Profile* profile)
350 delete speed_integrated_trace_;
351 speed_integrated_trace_ = new CpuTiTmgr(profile, speed_.scale);
353 /* add a fake trace event if periodicity == 0 */
354 if (profile && profile->event_list.size() > 1) {
355 kernel::profile::DatedValue val = profile->event_list.back();
356 if (val.date_ < 1e-12) {
357 simgrid::kernel::profile::Profile* prof = new simgrid::kernel::profile::Profile();
358 speed_.event = prof->schedule(&future_evt_set, this);
363 void CpuTi::apply_event(kernel::profile::Event* event, double value)
365 if (event == speed_.event) {
366 XBT_DEBUG("Speed changed in trace! New fixed value: %f", value);
368 /* update remaining of actions and put in modified cpu list */
369 update_remaining_amount(surf_get_clock());
373 delete speed_integrated_trace_;
374 speed_integrated_trace_ = new CpuTiTmgr(value);
376 speed_.scale = value;
377 tmgr_trace_event_unref(&speed_.event);
379 } else if (event == state_event_) {
382 XBT_VERB("Restart processes on host %s", get_host()->get_cname());
383 get_host()->turn_on();
386 get_host()->turn_off();
387 double date = surf_get_clock();
389 /* put all action running on cpu to failed */
390 for (CpuTiAction& action : action_set_) {
391 if (action.get_state() == kernel::resource::Action::State::INITED ||
392 action.get_state() == kernel::resource::Action::State::STARTED ||
393 action.get_state() == kernel::resource::Action::State::IGNORED) {
394 action.set_finish_time(date);
395 action.set_state(kernel::resource::Action::State::FAILED);
396 get_model()->get_action_heap().remove(&action);
400 tmgr_trace_event_unref(&state_event_);
403 xbt_die("Unknown event!\n");
407 /** Update the actions that are running on this CPU (which was modified recently) */
408 void CpuTi::update_actions_finish_time(double now)
410 /* update remaining amount of actions */
411 update_remaining_amount(now);
413 /* Compute the sum of priorities for the actions running on that CPU */
415 for (CpuTiAction const& action : action_set_) {
416 /* action not running, skip it */
417 if (action.get_state_set() != surf_cpu_model_pm->get_started_action_set())
420 /* bogus priority, skip it */
421 if (action.get_priority() <= 0)
424 /* action suspended, skip it */
425 if (not action.is_running())
428 sum_priority_ += 1.0 / action.get_priority();
431 for (CpuTiAction& action : action_set_) {
432 double min_finish = -1;
433 /* action not running, skip it */
434 if (action.get_state_set() != surf_cpu_model_pm->get_started_action_set())
437 /* verify if the action is really running on cpu */
438 if (action.is_running() && action.get_priority() > 0) {
439 /* total area needed to finish the action. Used in trace integration */
440 double total_area = (action.get_remains() * sum_priority_ * action.get_priority()) / speed_.peak;
442 action.set_finish_time(speed_integrated_trace_->solve(now, total_area));
443 /* verify which event will happen before (max_duration or finish time) */
444 if (action.get_max_duration() != NO_MAX_DURATION &&
445 action.get_start_time() + action.get_max_duration() < action.get_finish_time())
446 min_finish = action.get_start_time() + action.get_max_duration();
448 min_finish = action.get_finish_time();
450 /* put the max duration time on heap */
451 if (action.get_max_duration() != NO_MAX_DURATION)
452 min_finish = action.get_start_time() + action.get_max_duration();
454 /* add in action heap */
455 if (min_finish != NO_MAX_DURATION)
456 get_model()->get_action_heap().update(&action, min_finish, kernel::resource::ActionHeap::Type::unset);
458 get_model()->get_action_heap().remove(&action);
460 XBT_DEBUG("Update finish time: Cpu(%s) Action: %p, Start Time: %f Finish Time: %f Max duration %f", get_cname(),
461 &action, action.get_start_time(), action.get_finish_time(), action.get_max_duration());
463 /* remove from modified cpu */
467 bool CpuTi::is_used()
469 return not action_set_.empty();
472 double CpuTi::get_speed_ratio()
474 speed_.scale = speed_integrated_trace_->get_power_scale(surf_get_clock());
475 return Cpu::get_speed_ratio();
478 /** @brief Update the remaining amount of actions */
479 void CpuTi::update_remaining_amount(double now)
481 /* already up to date */
482 if (last_update_ >= now)
485 /* compute the integration area */
486 double area_total = speed_integrated_trace_->integrate(last_update_, now) * speed_.peak;
487 XBT_DEBUG("Flops total: %f, Last update %f", area_total, last_update_);
488 for (CpuTiAction& action : action_set_) {
489 /* action not running, skip it */
490 if (action.get_state_set() != get_model()->get_started_action_set())
493 /* bogus priority, skip it */
494 if (action.get_priority() <= 0)
497 /* action suspended, skip it */
498 if (not action.is_running())
501 /* action don't need update */
502 if (action.get_start_time() >= now)
505 /* skip action that are finishing now */
506 if (action.get_finish_time() >= 0 && action.get_finish_time() <= now)
509 /* update remaining */
510 action.update_remains(area_total / (sum_priority_ * action.get_priority()));
511 XBT_DEBUG("Update remaining action(%p) remaining %f", &action, action.get_remains_no_update());
516 kernel::resource::CpuAction* CpuTi::execution_start(double size)
518 XBT_IN("(%s,%g)", get_cname(), size);
519 CpuTiAction* action = new CpuTiAction(this, size);
521 action_set_.push_back(*action); // Actually start the action
527 kernel::resource::CpuAction* CpuTi::sleep(double duration)
530 duration = std::max(duration, sg_surf_precision);
532 XBT_IN("(%s,%g)", get_cname(), duration);
533 CpuTiAction* action = new CpuTiAction(this, 1.0);
535 action->set_max_duration(duration);
536 action->set_suspend_state(kernel::resource::Action::SuspendStates::SLEEPING);
537 if (duration == NO_MAX_DURATION)
538 action->set_state(simgrid::kernel::resource::Action::State::IGNORED);
540 action_set_.push_back(*action);
546 void CpuTi::set_modified(bool modified)
548 CpuTiList& modified_cpus = static_cast<CpuTiModel*>(get_model())->modified_cpus_;
550 if (not cpu_ti_hook.is_linked()) {
551 modified_cpus.push_back(*this);
554 if (cpu_ti_hook.is_linked())
555 simgrid::xbt::intrusive_erase(modified_cpus, *this);
563 CpuTiAction::CpuTiAction(CpuTi* cpu, double cost) : CpuAction(cpu->get_model(), cost, not cpu->is_on()), cpu_(cpu)
565 cpu_->set_modified(true);
567 CpuTiAction::~CpuTiAction()
569 /* remove from action_set */
570 if (action_ti_hook.is_linked())
571 simgrid::xbt::intrusive_erase(cpu_->action_set_, *this);
572 /* remove from heap */
573 get_model()->get_action_heap().remove(this);
574 cpu_->set_modified(true);
577 void CpuTiAction::set_state(Action::State state)
579 CpuAction::set_state(state);
580 cpu_->set_modified(true);
583 void CpuTiAction::cancel()
585 this->set_state(Action::State::FAILED);
586 get_model()->get_action_heap().remove(this);
587 cpu_->set_modified(true);
590 void CpuTiAction::suspend()
592 XBT_IN("(%p)", this);
594 set_suspend_state(Action::SuspendStates::SUSPENDED);
595 get_model()->get_action_heap().remove(this);
596 cpu_->set_modified(true);
601 void CpuTiAction::resume()
603 XBT_IN("(%p)", this);
604 if (is_suspended()) {
605 set_suspend_state(Action::SuspendStates::RUNNING);
606 cpu_->set_modified(true);
611 void CpuTiAction::set_max_duration(double duration)
615 XBT_IN("(%p,%g)", this, duration);
617 Action::set_max_duration(duration);
620 min_finish = (get_start_time() + get_max_duration()) < get_finish_time() ? (get_start_time() + get_max_duration())
623 min_finish = get_finish_time();
625 /* add in action heap */
626 get_model()->get_action_heap().update(this, min_finish, kernel::resource::ActionHeap::Type::unset);
631 void CpuTiAction::set_priority(double priority)
633 XBT_IN("(%p,%g)", this, priority);
634 set_priority_no_update(priority);
635 cpu_->set_modified(true);
639 double CpuTiAction::get_remains()
641 XBT_IN("(%p)", this);
642 cpu_->update_remaining_amount(surf_get_clock());
644 return get_remains_no_update();
647 } // namespace resource
648 } // namespace kernel
649 } // namespace simgrid