Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rename sg_surf_precision to sg_precision_timing for clarity
[simgrid.git] / src / surf / ptask_L07.cpp
1 /* Copyright (c) 2007-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 #include <xbt/asserts.hpp>
9 #include <xbt/config.hpp>
10
11 #include "simgrid/config.h"
12 #include "src/kernel/EngineImpl.hpp"
13 #if SIMGRID_HAVE_EIGEN3
14 #include "src/kernel/lmm/bmf.hpp"
15 #endif
16 #include "src/kernel/resource/profile/Event.hpp"
17 #include "src/surf/ptask_L07.hpp"
18
19 #include <unordered_set>
20
21 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(res_host);
22 XBT_LOG_EXTERNAL_CATEGORY(xbt_cfg);
23
24 /***********
25  * Options *
26  ***********/
27 static simgrid::config::Flag<std::string> cfg_ptask_solver("host/solver",
28                                                            "Set linear equations solver used by ptask model",
29                                                            "fairbottleneck",
30                                                            &simgrid::kernel::lmm::System::validate_solver);
31
32 /**************************************/
33 /*** Resource Creation & Destruction **/
34 /**************************************/
35 SIMGRID_REGISTER_HOST_MODEL(
36     ptask_L07, "Host model somehow similar to Cas01+CM02+S19 but allowing parallel tasks", []() {
37       XBT_CINFO(xbt_cfg, "Switching to the L07 model to handle parallel tasks.");
38       xbt_assert(cfg_ptask_solver != "maxmin", "Invalid configuration. Cannot use maxmin solver with parallel tasks.");
39
40       xbt_assert(simgrid::config::is_default("network/model") && simgrid::config::is_default("cpu/model"),
41                  "Changing the network or CPU model is not allowed when using the ptasks host model.");
42
43       auto* system    = simgrid::kernel::lmm::System::build(cfg_ptask_solver.get(), true /* selective update */);
44       auto host_model = std::make_shared<simgrid::kernel::resource::HostL07Model>("Host_Ptask", system);
45       auto* engine    = simgrid::kernel::EngineImpl::get_instance();
46       engine->add_model(host_model);
47       engine->get_netzone_root()->set_host_model(host_model);
48     });
49
50 namespace simgrid::kernel::resource {
51
52 HostL07Model::HostL07Model(const std::string& name, lmm::System* sys) : HostModel(name)
53 {
54   set_maxmin_system(sys);
55
56   auto net_model = std::make_shared<NetworkL07Model>("Network_Ptask", this, sys);
57   auto engine    = EngineImpl::get_instance();
58   engine->add_model(net_model);
59   engine->get_netzone_root()->set_network_model(net_model);
60
61   auto cpu_model = std::make_shared<CpuL07Model>("Cpu_Ptask", this, sys);
62   engine->add_model(cpu_model);
63   engine->get_netzone_root()->set_cpu_pm_model(cpu_model);
64
65   simgrid_disk_models().by_name("S19").init();
66 }
67
68 CpuL07Model::CpuL07Model(const std::string& name, HostL07Model* hmodel, lmm::System* sys)
69     : CpuModel(name), hostModel_(hmodel)
70 {
71   set_maxmin_system(sys);
72 }
73
74 CpuL07Model::~CpuL07Model()
75 {
76   set_maxmin_system(nullptr);
77 }
78
79 NetworkL07Model::NetworkL07Model(const std::string& name, HostL07Model* hmodel, lmm::System* sys)
80     : NetworkModel(name), hostModel_(hmodel)
81 {
82   set_maxmin_system(sys);
83   loopback_.reset(create_link("__loopback__", {simgrid::config::get_value<double>("network/loopback-bw")}));
84   loopback_->set_sharing_policy(s4u::Link::SharingPolicy::FATPIPE, {});
85   loopback_->set_latency(simgrid::config::get_value<double>("network/loopback-lat"));
86   loopback_->get_iface()->seal();
87 }
88
89 NetworkL07Model::~NetworkL07Model()
90 {
91   set_maxmin_system(nullptr);
92 }
93
94 double HostL07Model::next_occurring_event(double now)
95 {
96   double min = HostModel::next_occurring_event_full(now);
97   for (Action const& action : *get_started_action_set()) {
98     const auto& net_action = static_cast<const L07Action&>(action);
99     if (net_action.get_latency() > 0 && (min < 0 || net_action.get_latency() < min)) {
100       min = net_action.get_latency();
101       XBT_DEBUG("Updating min with %p (start %f): %f", &net_action, net_action.get_start_time(), min);
102     }
103   }
104   XBT_DEBUG("min value: %f", min);
105
106   return min;
107 }
108
109 void HostL07Model::update_actions_state(double /*now*/, double delta)
110 {
111   for (auto it = std::begin(*get_started_action_set()); it != std::end(*get_started_action_set());) {
112     auto& action = static_cast<L07Action&>(*it);
113     ++it; // increment iterator here since the following calls to action.finish() may invalidate it
114     if (action.get_latency() > 0) {
115       if (action.get_latency() > delta) {
116         action.update_latency(delta, sg_precision_timing);
117       } else {
118         action.set_latency(0.0);
119       }
120       if ((action.get_latency() <= 0.0) && (action.is_suspended() == 0)) {
121         action.update_bound();
122         get_maxmin_system()->update_variable_penalty(action.get_variable(), 1.0);
123         action.set_last_update();
124       }
125     }
126     XBT_DEBUG("Action (%p) : remains (%g) updated by %g.", &action, action.get_remains(), action.get_rate() * delta);
127     action.update_remains(action.get_rate() * delta);
128     action.update_max_duration(delta);
129
130     XBT_DEBUG("Action (%p) : remains (%g).", &action, action.get_remains());
131
132     /* In the next if cascade, the action can be finished either because:
133      *  - The amount of remaining work reached 0
134      *  - The max duration was reached
135      * If it's not done, it may have failed.
136      */
137
138     if (((action.get_remains() <= 0) && (action.get_variable()->get_penalty() > 0)) ||
139         ((action.get_max_duration() != NO_MAX_DURATION) && (action.get_max_duration() <= 0))) {
140       action.finish(Action::State::FINISHED);
141       continue;
142     }
143
144     /* Need to check that none of the model has failed */
145     int i                               = 0;
146     const lmm::Constraint* cnst         = action.get_variable()->get_constraint(i);
147     while (cnst != nullptr) {
148       i++;
149       if (not cnst->get_id()->is_on()) {
150         XBT_DEBUG("Action (%p) Failed!!", &action);
151         action.finish(Action::State::FAILED);
152         break;
153       }
154       cnst = action.get_variable()->get_constraint(i);
155     }
156   }
157 }
158
159 CpuAction* HostL07Model::execute_parallel(const std::vector<s4u::Host*>& host_list, const double* flops_amount,
160                                           const double* bytes_amount, double rate)
161 {
162   return new L07Action(this, host_list, flops_amount, bytes_amount, rate);
163 }
164
165 L07Action::L07Action(Model* model, const std::vector<s4u::Host*>& host_list, const double* flops_amount,
166                      const double* bytes_amount, double rate)
167     : CpuAction(model, 1.0, false)
168     , host_list_(host_list)
169     , computation_amount_(flops_amount)
170     , communication_amount_(bytes_amount)
171     , rate_(rate)
172 {
173   size_t link_nb       = 0;
174   const size_t host_nb = host_list_.size();
175   size_t used_host_nb  = 0; /* Only the hosts with something to compute (>0 flops) are counted) */
176   double latency       = 0.0;
177   this->set_last_update();
178
179   if (flops_amount != nullptr)
180     used_host_nb += std::count_if(flops_amount, flops_amount + host_nb, [](double x) { return x > 0.0; });
181
182   /* Compute the number of affected resources... */
183   if (bytes_amount != nullptr) {
184     std::unordered_set<const char*> affected_links;
185
186     for (size_t k = 0; k < host_nb * host_nb; k++) {
187       if (bytes_amount[k] <= 0)
188         continue;
189
190       double lat = 0.0;
191       std::vector<StandardLinkImpl*> route;
192       host_list_[k / host_nb]->route_to(host_list_[k % host_nb], route, &lat);
193       latency = std::max(latency, lat);
194
195       for (auto const& link : route)
196         affected_links.insert(link->get_cname());
197     }
198
199     link_nb = affected_links.size();
200   }
201
202   XBT_DEBUG("Creating a parallel task (%p) with %zu hosts and %zu unique links.", this, host_nb, link_nb);
203   latency_ = latency;
204
205   set_variable(model->get_maxmin_system()->variable_new(this, 1.0, (rate > 0 ? rate : -1.0), host_nb + link_nb));
206
207   if (latency_ > 0)
208     model->get_maxmin_system()->update_variable_penalty(get_variable(), 0.0);
209
210   /* Expand it for the CPUs even if there is nothing to compute, to make sure that it gets expended even if there is no
211    * communication either */
212   for (size_t i = 0; i < host_nb; i++) {
213     model->get_maxmin_system()->expand(host_list[i]->get_cpu()->get_constraint(), get_variable(),
214                                        (flops_amount == nullptr ? 0.0 : flops_amount[i]), true);
215   }
216
217   if (bytes_amount != nullptr) {
218     for (size_t k = 0; k < host_nb * host_nb; k++) {
219       if (bytes_amount[k] <= 0.0)
220         continue;
221       std::vector<StandardLinkImpl*> route;
222       host_list_[k / host_nb]->route_to(host_list_[k % host_nb], route, nullptr);
223
224       for (auto const& link : route)
225         model->get_maxmin_system()->expand(link->get_constraint(), this->get_variable(), bytes_amount[k]);
226     }
227   }
228
229   if (link_nb + used_host_nb == 0) {
230     this->set_cost(1.0);
231     this->set_remains(0.0);
232   }
233   /* finally calculate the initial bound value */
234   update_bound();
235 }
236
237 Action* NetworkL07Model::communicate(s4u::Host* src, s4u::Host* dst, double size, double rate, bool /* streamed */)
238 {
239   std::vector<s4u::Host*> host_list = {src, dst};
240   const auto* flops_amount          = new double[2]();
241   auto* bytes_amount                = new double[4]();
242
243   bytes_amount[1] = size;
244
245   Action* res = hostModel_->execute_parallel(host_list, flops_amount, bytes_amount, rate);
246   static_cast<L07Action*>(res)->free_arrays_ = true;
247   return res;
248 }
249
250 CpuImpl* CpuL07Model::create_cpu(s4u::Host* host, const std::vector<double>& speed_per_pstate)
251 {
252   return (new CpuL07(host, speed_per_pstate))->set_model(this);
253 }
254
255 StandardLinkImpl* NetworkL07Model::create_link(const std::string& name, const std::vector<double>& bandwidths)
256 {
257   xbt_assert(bandwidths.size() == 1, "Non WIFI link must have only 1 bandwidth.");
258   auto link = new LinkL07(name, bandwidths[0], get_maxmin_system());
259   link->set_model(this);
260   return link;
261 }
262
263 StandardLinkImpl* NetworkL07Model::create_wifi_link(const std::string& name, const std::vector<double>& bandwidths)
264 {
265   THROW_UNIMPLEMENTED;
266 }
267
268 /************
269  * Resource *
270  ************/
271
272 CpuAction* CpuL07::execution_start(double size, double user_bound)
273 {
274   std::vector<s4u::Host*> host_list = {get_iface()};
275   xbt_assert(user_bound <= 0, "User bound not supported by ptask model");
276
277   auto* flops_amount = new double[host_list.size()]();
278   flops_amount[0]    = size;
279
280   CpuAction* res =
281       static_cast<CpuL07Model*>(get_model())->hostModel_->execute_parallel(host_list, flops_amount, nullptr, -1);
282   static_cast<L07Action*>(res)->free_arrays_ = true;
283   return res;
284 }
285
286 CpuAction* CpuL07::sleep(double duration)
287 {
288   auto* action = static_cast<L07Action*>(execution_start(1.0, -1));
289   action->set_max_duration(duration);
290   action->set_suspend_state(Action::SuspendStates::SLEEPING);
291   get_model()->get_maxmin_system()->update_variable_penalty(action->get_variable(), 0.0);
292
293   return action;
294 }
295
296 /** @brief take into account changes of speed (either load or max) */
297 void CpuL07::on_speed_change()
298 {
299   const lmm::Element* elem = nullptr;
300
301   get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), get_core_count() * speed_.peak * speed_.scale);
302
303   while (const auto* var = get_constraint()->get_variable(&elem)) {
304     const auto* action = static_cast<L07Action*>(var->get_id());
305     action->update_bound();
306   }
307
308   CpuImpl::on_speed_change();
309 }
310
311 LinkL07::LinkL07(const std::string& name, double bandwidth, lmm::System* system) : StandardLinkImpl(name)
312 {
313   this->set_constraint(system->constraint_new(this, bandwidth));
314   bandwidth_.peak = bandwidth;
315 }
316
317 void CpuL07::apply_event(profile::Event* triggered, double value)
318 {
319   XBT_DEBUG("Updating cpu %s (%p) with value %g", get_cname(), this, value);
320   if (triggered == speed_.event) {
321     speed_.scale = value;
322     on_speed_change();
323     tmgr_trace_event_unref(&speed_.event);
324
325   } else if (triggered == get_state_event()) {
326     if (value > 0) {
327       if (not is_on()) {
328         XBT_VERB("Restart actors on host %s", get_iface()->get_cname());
329         get_iface()->turn_on();
330       }
331     } else
332       get_iface()->turn_off();
333
334     unref_state_event();
335   } else {
336     xbt_die("Unknown event!\n");
337   }
338 }
339
340 void LinkL07::apply_event(profile::Event* triggered, double value)
341 {
342   XBT_DEBUG("Updating link %s (%p) with value=%f", get_cname(), this, value);
343   if (triggered == bandwidth_.event) {
344     set_bandwidth(value);
345     tmgr_trace_event_unref(&bandwidth_.event);
346
347   } else if (triggered == latency_.event) {
348     set_latency(value);
349     tmgr_trace_event_unref(&latency_.event);
350
351   } else if (triggered == get_state_event()) {
352     if (value > 0)
353       turn_on();
354     else
355       turn_off();
356     unref_state_event();
357   } else {
358     xbt_die("Unknown event ! \n");
359   }
360 }
361
362 void LinkL07::set_bandwidth(double value)
363 {
364   bandwidth_.peak = value;
365   StandardLinkImpl::on_bandwidth_change();
366
367   get_model()->get_maxmin_system()->update_constraint_bound(get_constraint(), bandwidth_.peak * bandwidth_.scale);
368 }
369
370 void LinkL07::set_latency(double value)
371 {
372   latency_check(value);
373   const lmm::Element* elem = nullptr;
374
375   latency_.peak = value;
376   while (const auto* var = get_constraint()->get_variable(&elem)) {
377     const auto* action = static_cast<L07Action*>(var->get_id());
378     action->update_bound();
379   }
380 }
381 LinkL07::~LinkL07() = default;
382
383 /**********
384  * Action *
385  **********/
386
387 L07Action::~L07Action()
388 {
389   if (free_arrays_) {
390     delete[] computation_amount_;
391     delete[] communication_amount_;
392   }
393 }
394
395 double L07Action::calculate_network_bound() const
396 {
397   double lat_current = 0.0;
398   double lat_bound   = std::numeric_limits<double>::max();
399
400   size_t host_count = host_list_.size();
401
402   if (communication_amount_ == nullptr) {
403     return lat_bound;
404   }
405
406   for (size_t i = 0; i < host_count; i++) {
407     for (size_t j = 0; j < host_count; j++) {
408       if (communication_amount_[i * host_count + j] > 0) {
409         double lat = 0.0;
410         std::vector<StandardLinkImpl*> route;
411         host_list_.at(i)->route_to(host_list_.at(j), route, &lat);
412
413         lat_current = std::max(lat_current, lat * communication_amount_[i * host_count + j]);
414       }
415     }
416   }
417   if (lat_current > 0) {
418     lat_bound = NetworkModel::cfg_tcp_gamma / (2.0 * lat_current);
419   }
420   return lat_bound;
421 }
422
423 double L07Action::calculate_cpu_bound() const
424 {
425   double cpu_bound = std::numeric_limits<double>::max();
426
427   if (computation_amount_ == nullptr) {
428     return cpu_bound;
429   }
430
431   for (size_t i = 0; i < host_list_.size(); i++) {
432     if (computation_amount_[i] > 0) {
433       cpu_bound = std::min(cpu_bound, host_list_[i]->get_cpu()->get_speed(1.0) *
434                                           host_list_[i]->get_cpu()->get_speed_ratio() / computation_amount_[i]);
435     }
436   }
437   return cpu_bound;
438 }
439
440 void L07Action::update_bound() const
441 {
442   double bound = std::min(calculate_network_bound(), calculate_cpu_bound());
443
444   XBT_DEBUG("action (%p) : bound = %g", this, bound);
445
446   /* latency has been paid (or no latency), we can set the appropriate bound for multicore or network limit */
447   if ((bound < std::numeric_limits<double>::max()) && (latency_ <= 0.0)) {
448     if (rate_ < 0)
449       get_model()->get_maxmin_system()->update_variable_bound(get_variable(), bound);
450     else
451       get_model()->get_maxmin_system()->update_variable_bound(get_variable(), std::min(rate_, bound));
452   }
453 }
454
455 } // namespace simgrid::kernel::resource