Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[project-description] Fix extraction of the ns-3 version.
[simgrid.git] / src / surf / cpu_cas01.cpp
1 /* Copyright (c) 2009-2022. 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 "simgrid/sg_config.hpp"
10 #include "src/kernel/EngineImpl.hpp"
11 #include "src/kernel/resource/profile/Event.hpp"
12 #include "src/surf/cpu_cas01.hpp"
13 #include "src/surf/cpu_ti.hpp"
14 #include "src/surf/surf_interface.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 void surf_cpu_model_init_Cas01()
44 {
45   if (cpu_optim_opt == "TI") {
46     simgrid::kernel::resource::CpuTiModel::create_pm_models();
47     return;
48   }
49
50   auto cpu_model_pm = std::make_shared<simgrid::kernel::resource::CpuCas01Model>("Cpu_Cas01");
51   auto* engine      = simgrid::kernel::EngineImpl::get_instance();
52   engine->add_model(cpu_model_pm);
53   engine->get_netzone_root()->set_cpu_pm_model(cpu_model_pm);
54 }
55
56 namespace simgrid::kernel::resource {
57
58 CpuCas01Model::CpuCas01Model(const std::string& name) : CpuModel(name)
59 {
60   if (config::get_value<std::string>("cpu/optim") == "Lazy")
61     set_update_algorithm(Model::UpdateAlgo::LAZY);
62
63   bool select = config::get_value<bool>("cpu/maxmin-selective-update");
64
65   if (is_update_lazy()) {
66     xbt_assert(select || config::is_default("cpu/maxmin-selective-update"),
67                "You cannot disable cpu selective update when using the lazy update mechanism");
68     select = true;
69   }
70
71   set_maxmin_system(lmm::System::build(cfg_cpu_solver, select));
72 }
73
74 CpuImpl* CpuCas01Model::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate)
75 {
76   return (new CpuCas01(host, speed_per_pstate))->set_model(this);
77 }
78
79 /************
80  * Resource *
81  ************/
82 /** @brief take into account changes of speed (either load or max) */
83 void CpuCas01::on_speed_change()
84 {
85   const lmm::Element* elem = nullptr;
86
87   get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(),
88                                                             get_core_count() * speed_.scale * speed_.peak);
89
90   while (const auto* var = get_constraint()->get_variable(&elem)) {
91     const auto* action = static_cast<CpuCas01Action*>(var->get_id());
92     double bound       = action->requested_core() * speed_.scale * speed_.peak;
93     if (action->get_user_bound() > 0) {
94       bound = std::min(bound, action->get_user_bound());
95     }
96
97     get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), bound);
98   }
99
100   CpuImpl::on_speed_change();
101 }
102
103 void CpuCas01::apply_event(profile::Event* event, double value)
104 {
105   if (event == speed_.event) {
106     speed_.scale = value;
107     on_speed_change();
108
109     tmgr_trace_event_unref(&speed_.event);
110   } else if (event == get_state_event()) {
111     if (value > 0) {
112       if (not is_on()) {
113         XBT_VERB("Restart actors on host %s", get_iface()->get_cname());
114         get_iface()->turn_on();
115       }
116     } else {
117       const lmm::Element* elem = nullptr;
118       double date              = EngineImpl::get_clock();
119
120       get_iface()->turn_off();
121
122       while (const auto* var = get_constraint()->get_variable(&elem)) {
123         Action* action = var->get_id();
124
125         if (action->get_state() == Action::State::INITED || action->get_state() == Action::State::STARTED ||
126             action->get_state() == Action::State::IGNORED) {
127           action->set_finish_time(date);
128           action->set_state(Action::State::FAILED);
129         }
130       }
131     }
132     unref_state_event();
133
134   } else {
135     xbt_die("Unknown event!\n");
136   }
137 }
138
139 /** @brief Start a new execution on this CPU lasting @param size flops and using one core */
140 CpuAction* CpuCas01::execution_start(double size, double user_bound)
141 {
142   return execution_start(size, 1, user_bound);
143 }
144
145 CpuAction* CpuCas01::execution_start(double size, int requested_cores, double user_bound)
146 {
147   auto* action =
148       new CpuCas01Action(get_model(), size, not is_on(), speed_.scale * speed_.peak, get_constraint(), requested_cores);
149   action->set_user_bound(user_bound);
150   if (user_bound > 0 && user_bound < action->get_bound()) {
151     get_model()->get_maxmin_system()->update_variable_bound(action->get_variable(), user_bound);
152   }
153   if (factor_cb_) {
154     action->set_rate_factor(factor_cb_(size));
155   }
156
157   return action;
158 }
159
160 CpuAction* CpuCas01::sleep(double duration)
161 {
162   if (duration > 0)
163     duration = std::max(duration, sg_surf_precision);
164
165   XBT_IN("(%s, %g)", get_cname(), duration);
166   auto* action = new CpuCas01Action(get_model(), 1.0, not is_on(), speed_.scale * speed_.peak, get_constraint(), 1);
167
168   // FIXME: sleep variables should not consume 1.0 in System::expand()
169   action->set_max_duration(duration);
170   action->set_suspend_state(Action::SuspendStates::SLEEPING);
171   if (duration == NO_MAX_DURATION)
172     action->set_state(Action::State::IGNORED);
173
174   get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), 0.0);
175   if (get_model()->is_update_lazy()) { // remove action from the heap
176     get_model()->get_action_heap().remove(action);
177     // this is necessary for a variable with weight 0 since such variables are ignored in lmm and we need to set its
178     // max_duration correctly at the next call to share_resources
179     get_model()->get_modified_set()->push_front(*action);
180   }
181
182   XBT_OUT();
183   return action;
184 }
185
186 void CpuCas01::set_factor_cb(const std::function<s4u::Host::CpuFactorCb>& cb)
187 {
188   xbt_assert(not is_sealed(), "Cannot set CPU factor callback in an already sealed CPU(%s)", get_cname());
189   factor_cb_ = cb;
190 }
191
192 /**********
193  * Action *
194  **********/
195 CpuCas01Action::CpuCas01Action(Model* model, double cost, bool failed, double speed, lmm::Constraint* constraint,
196                                int requested_core)
197     : CpuAction(model, cost, failed,
198                 model->get_maxmin_system()->variable_new(this, 1.0 / requested_core, requested_core * speed, 1))
199     , requested_core_(requested_core)
200 {
201   if (model->is_update_lazy())
202     set_last_update();
203   model->get_maxmin_system()->expand(constraint, get_variable(), 1.0);
204 }
205
206 } // namespace simgrid::kernel::resource