Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Factorize common code to cancel actions when a resource is turned off.
[simgrid.git] / src / kernel / resource / models / cpu_cas01.cpp
1 /* Copyright (c) 2009-2023. 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 <simgrid/kernel/routing/NetZoneImpl.hpp>
7 #include <simgrid/s4u/Engine.hpp>
8
9 #include "src/kernel/EngineImpl.hpp"
10 #include "src/kernel/resource/models/cpu_cas01.hpp"
11 #include "src/kernel/resource/models/cpu_ti.hpp"
12 #include "src/kernel/resource/profile/Event.hpp"
13 #include "src/simgrid/module.hpp"
14 #include "src/simgrid/sg_config.hpp"
15
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cpu_cas, res_cpu, "CPU resource, CAS01 model (used by default)");
17
18 /***********
19  * Options *
20  ***********/
21
22 static simgrid::config::Flag<std::string>
23     cpu_optim_opt("cpu/optim", "Optimization algorithm to use for CPU resources. ", "Lazy",
24
25                   std::map<std::string, std::string, std::less<>>({
26                       {"Lazy", "Lazy action management (partial invalidation in lmm + heap in action remaining)."},
27                       {"TI", "Trace integration. Highly optimized mode when using availability traces (only available "
28                              "for the Cas01 CPU model for now)."},
29                       {"Full", "Full update of remaining and variables. Slow but may be useful when debugging."},
30                   }),
31
32                   [](std::string const&) {
33                     xbt_assert(_sg_cfg_init_status < 2,
34                                "Cannot change the optimization algorithm after the initialization");
35                   });
36
37 static simgrid::config::Flag<std::string> cfg_cpu_solver("cpu/solver", "Set linear equations solver used by CPU model",
38                                                          "maxmin", &simgrid::kernel::lmm::System::validate_solver);
39
40 /*********
41  * Model *
42  *********/
43 SIMGRID_REGISTER_CPU_MODEL(Cas01, "Simplistic CPU model (time=size/speed)", []() {
44   if (cpu_optim_opt == "TI") {
45     simgrid::kernel::resource::CpuTiModel::create_pm_models();
46     return;
47   }
48
49   auto cpu_model_pm = std::make_shared<simgrid::kernel::resource::CpuCas01Model>("Cpu_Cas01");
50   auto* engine      = simgrid::kernel::EngineImpl::get_instance();
51   engine->add_model(cpu_model_pm);
52   engine->get_netzone_root()->set_cpu_pm_model(cpu_model_pm);
53 });
54
55 namespace simgrid::kernel::resource {
56
57 CpuCas01Model::CpuCas01Model(const std::string& name) : CpuModel(name)
58 {
59   if (config::get_value<std::string>("cpu/optim") == "Lazy")
60     set_update_algorithm(Model::UpdateAlgo::LAZY);
61
62   bool select = config::get_value<bool>("cpu/maxmin-selective-update");
63
64   if (is_update_lazy()) {
65     xbt_assert(select || config::is_default("cpu/maxmin-selective-update"),
66                "You cannot disable cpu selective update when using the lazy update mechanism");
67     select = true;
68   }
69
70   set_maxmin_system(lmm::System::build(cfg_cpu_solver.get(), select));
71 }
72
73 CpuImpl* CpuCas01Model::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate)
74 {
75   return (new CpuCas01(host, speed_per_pstate))->set_model(this);
76 }
77
78 /************
79  * Resource *
80  ************/
81 /** @brief take into account changes of speed (either load or max) */
82 void CpuCas01::on_speed_change()
83 {
84   const lmm::Element* elem = nullptr;
85
86   get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
87                                                             get_core_count() * speed_.scale * speed_.peak);
88
89   while (const auto* var = get_constraint()->get_variable(&elem)) {
90     const auto* action = static_cast<CpuCas01Action*>(var->get_id());
91     double bound       = action->requested_core() * speed_.scale * speed_.peak;
92     if (action->get_user_bound() > 0) {
93       bound = std::min(bound, action->get_user_bound());
94     }
95
96     get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), bound);
97   }
98
99   CpuImpl::on_speed_change();
100 }
101
102 void CpuCas01::apply_event(profile::Event* event, double value)
103 {
104   if (event == speed_.event) {
105     speed_.scale = value;
106     on_speed_change();
107
108     tmgr_trace_event_unref(&speed_.event);
109   } else if (event == get_state_event()) {
110     if (value > 0) {
111       if (not is_on()) {
112         XBT_VERB("Restart actors on host %s", get_iface()->get_cname());
113         get_iface()->turn_on();
114       }
115     } else {
116       get_iface()->turn_off();
117       cancel_actions();
118     }
119     unref_state_event();
120
121   } else {
122     xbt_die("Unknown event!\n");
123   }
124 }
125
126 /** @brief Start a new execution on this CPU lasting @param size flops and using one core */
127 CpuAction* CpuCas01::execution_start(double size, double user_bound)
128 {
129   return execution_start(size, 1, user_bound);
130 }
131
132 CpuAction* CpuCas01::execution_start(double size, int requested_cores, double user_bound)
133 {
134   auto* action =
135       new CpuCas01Action(get_model(), size, not is_on(), speed_.scale * speed_.peak, get_constraint(), requested_cores);
136   action->set_user_bound(user_bound);
137   if (user_bound > 0 && user_bound < action->get_bound()) {
138     get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), user_bound);
139   }
140   if (factor_cb_) {
141     action->set_rate_factor(factor_cb_(size));
142   }
143
144   return action;
145 }
146
147 CpuAction* CpuCas01::sleep(double duration)
148 {
149   if (duration > 0)
150     duration = std::max(duration, sg_precision_timing);
151
152   XBT_IN("(%s, %g)", get_cname(), duration);
153   auto* action = new CpuCas01Action(get_model(), 1.0, not is_on(), speed_.scale * speed_.peak, get_constraint(), 1);
154
155   // FIXME: sleep variables should not consume 1.0 in System::expand()
156   action->set_max_duration(duration);
157   action->set_suspend_state(Action::SuspendStates::SLEEPING);
158   if (duration == NO_MAX_DURATION)
159     action->set_state(Action::State::IGNORED);
160
161   get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), 0.0);
162   if (get_model()->is_update_lazy()) { // remove action from the heap
163     get_model()->get_action_heap().remove(action);
164     // this is necessary for a variable with weight 0 since such variables are ignored in lmm and we need to set its
165     // max_duration correctly at the next call to share_resources
166     get_model()->get_modified_set()->push_front(*action);
167   }
168
169   XBT_OUT();
170   return action;
171 }
172
173 void CpuCas01::set_factor_cb(const std::function<s4u::Host::CpuFactorCb>& cb)
174 {
175   xbt_assert(not is_sealed(), "Cannot set CPU factor callback in an already sealed CPU(%s)", get_cname());
176   factor_cb_ = cb;
177 }
178
179 /**********
180  * Action *
181  **********/
182 CpuCas01Action::CpuCas01Action(Model* model, double cost, bool failed, double speed, lmm::Constraint* constraint,
183                                int requested_core)
184     : CpuAction(model, cost, failed,
185                 model->get_maxmin_system()->variable_new(this, 1.0 / requested_core, requested_core * speed, 1))
186     , requested_core_(requested_core)
187 {
188   if (model->is_update_lazy())
189     set_last_update();
190   model->get_maxmin_system()->expand(constraint, get_variable(), 1.0);
191 }
192
193 } // namespace simgrid::kernel::resource