Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Minor Sonar smells.
[simgrid.git] / src / s4u / s4u_Host.cpp
1 /* Copyright (c) 2006-2021. 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/Exception.hpp"
7 #include "simgrid/host.h"
8 #include "simgrid/kernel/routing/NetPoint.hpp"
9 #include "simgrid/s4u/Actor.hpp"
10 #include "simgrid/s4u/Comm.hpp"
11 #include "simgrid/s4u/Engine.hpp"
12 #include "simgrid/s4u/Exec.hpp"
13 #include "simgrid/s4u/VirtualMachine.hpp"
14 #include "src/plugins/vm/VirtualMachineImpl.hpp"
15 #include "src/surf/HostImpl.hpp"
16 #include "xbt/parse_units.hpp"
17
18 #include <algorithm>
19 #include <string>
20
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
22 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
23
24 namespace simgrid {
25
26 template class xbt::Extendable<s4u::Host>;
27
28 namespace s4u {
29
30 xbt::signal<void(Host&)> Host::on_creation;
31 xbt::signal<void(Host const&)> Host::on_destruction;
32 xbt::signal<void(Host const&)> Host::on_state_change;
33 xbt::signal<void(Host const&)> Host::on_speed_change;
34
35 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
36 {
37   pimpl_netpoint_ = netpoint;
38   return this;
39 }
40
41 Host::~Host()
42 {
43   if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
44     Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
45   delete pimpl_cpu;
46 }
47
48 /** @brief Fire the required callbacks and destroy the object
49  *
50  * Don't delete directly a host, call h->destroy() instead.
51  *
52  * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
53  * object (because of the destructor order in a class hierarchy).
54  */
55 void Host::destroy()
56 {
57   kernel::actor::simcall([this] { this->pimpl_->destroy(); });
58 }
59
60 Host* Host::by_name(const std::string& name)
61 {
62   return Engine::get_instance()->host_by_name(name);
63 }
64 Host* Host::by_name_or_null(const std::string& name)
65 {
66   return Engine::get_instance()->host_by_name_or_null(name);
67 }
68
69 Host* Host::current()
70 {
71   kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
72   xbt_assert(self != nullptr, "Cannot call Host::current() from the maestro context");
73   return self->get_host();
74 }
75
76 xbt::string const& Host::get_name() const
77 {
78   return this->pimpl_->get_name();
79 }
80
81 const char* Host::get_cname() const
82 {
83   return this->pimpl_->get_cname();
84 }
85
86 void Host::turn_on()
87 {
88   if (not is_on()) {
89     kernel::actor::simcall([this] {
90       this->pimpl_cpu->turn_on();
91       this->pimpl_->turn_on();
92       on_state_change(*this);
93     });
94   }
95 }
96
97 /** @brief Stop the host if it is on */
98 void Host::turn_off()
99 {
100   if (is_on()) {
101     const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
102     kernel::actor::simcall([this, self] {
103       for (VirtualMachine* const& vm : vm::VirtualMachineImpl::allVms_)
104         if (vm->get_pm() == this) {
105           vm->shutdown();
106           vm->turn_off();
107         }
108       this->pimpl_cpu->turn_off();
109       this->pimpl_->turn_off(self);
110
111       on_state_change(*this);
112     });
113   }
114 }
115
116 bool Host::is_on() const
117 {
118   return this->pimpl_cpu->is_on();
119 }
120
121 int Host::get_pstate_count() const
122 {
123   return this->pimpl_cpu->get_pstate_count();
124 }
125
126 /**
127  * @brief Return a copy of the list of actors that are executing on this host.
128  *
129  * Daemons and regular actors are all mixed in this list.
130  */
131 std::vector<ActorPtr> Host::get_all_actors() const
132 {
133   return pimpl_->get_all_actors();
134 }
135
136 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
137 int Host::get_actor_count() const
138 {
139   return pimpl_->get_actor_count();
140 }
141
142 /**
143  * @brief Find a route toward another host
144  *
145  * @param dest [IN] where to
146  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
147  * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
148  *                It is the caller responsibility to initialize latency to 0 (we add to provided route)
149  * @pre links!=nullptr
150  *
151  * walk through the routing components tree and find a route between hosts
152  * by calling each "get_route" function in each routing component.
153  */
154 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
155 {
156   std::vector<kernel::resource::LinkImpl*> linkImpls;
157   this->route_to(dest, linkImpls, latency);
158   for (auto* l : linkImpls)
159     links.push_back(l->get_iface());
160 }
161
162 /** @brief Just like Host::routeTo, but filling an array of link implementations */
163 void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const
164 {
165   kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
166   if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
167     XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
168                (latency == nullptr ? -1 : *latency));
169     for (auto const* link : links)
170       XBT_CDEBUG(surf_route, "  Link '%s'", link->get_cname());
171   }
172 }
173
174 /** @brief Returns the networking zone englobing that host */
175 NetZone* Host::get_englobing_zone()
176 {
177   return pimpl_netpoint_->get_englobing_zone()->get_iface();
178 }
179
180 void Host::sendto(Host* dest, double byte_amount) // deprecated 331
181 {
182   Comm::sendto_async(this, dest, byte_amount)->wait();
183 }
184
185 CommPtr Host::sendto_async(Host* dest, double byte_amount) // deprecated 331
186 {
187   return Comm::sendto_async(this, dest, byte_amount);
188 }
189
190 void Host::send_to(Host* dest, double byte_amount) // deprecated 330
191 {
192   Comm::sendto(this, dest, byte_amount);
193 }
194
195 /** Get the properties assigned to a host */
196 const std::unordered_map<std::string, std::string>* Host::get_properties() const
197 {
198   return this->pimpl_->get_properties();
199 }
200
201 /** Retrieve the property value (or nullptr if not set) */
202 const char* Host::get_property(const std::string& key) const
203 {
204   return this->pimpl_->get_property(key);
205 }
206
207 Host* Host::set_property(const std::string& key, const std::string& value)
208 {
209   kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
210   return this;
211 }
212
213 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
214 {
215   kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
216   return this;
217 }
218
219 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
220  * The profile must contain boolean values. */
221 Host* Host::set_state_profile(kernel::profile::Profile* p)
222 {
223   kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
224   return this;
225 }
226 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
227  *
228  * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
229  * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
230  * at this pstate level) by the rate coming from the profile.
231  */
232 Host* Host::set_speed_profile(kernel::profile::Profile* p)
233 {
234   kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
235   return this;
236 }
237
238 /** @brief Get the peak processor speed (in flops/s), at the specified pstate  */
239 double Host::get_pstate_speed(int pstate_index) const
240 {
241   return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
242 }
243
244 double Host::get_speed() const
245 {
246   return this->pimpl_cpu->get_speed(1.0);
247 }
248 double Host::get_load() const
249 {
250   return this->pimpl_cpu->get_load();
251 }
252 double Host::get_available_speed() const
253 {
254   return this->pimpl_cpu->get_speed_ratio();
255 }
256
257 int Host::get_core_count() const
258 {
259   return this->pimpl_cpu->get_core_count();
260 }
261
262 Host* Host::set_core_count(int core_count)
263 {
264   kernel::actor::simcall([this, core_count] { this->pimpl_cpu->set_core_count(core_count); });
265   return this;
266 }
267
268 Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
269 {
270   kernel::actor::simcall([this, &speed_per_state] { pimpl_cpu->set_pstate_speed(speed_per_state); });
271   return this;
272 }
273
274 std::vector<double> Host::convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state)
275 {
276   std::vector<double> speed_list;
277   speed_list.reserve(speed_per_state.size());
278   for (const auto& speed_str : speed_per_state) {
279     try {
280       double speed = xbt_parse_get_speed("", 0, speed_str.c_str(), nullptr, "");
281       speed_list.push_back(speed);
282     } catch (const simgrid::ParseError&) {
283       throw std::invalid_argument(std::string("Invalid speed value: ") + speed_str);
284     }
285   }
286   return speed_list;
287 }
288
289 Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
290 {
291   set_pstate_speed(Host::convert_pstate_speed_vector(speed_per_state));
292   return this;
293 }
294
295 /** @brief Set the pstate at which the host should run */
296 Host* Host::set_pstate(int pstate_index)
297 {
298   kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
299   return this;
300 }
301
302 /** @brief Retrieve the pstate at which the host is currently running */
303 int Host::get_pstate() const
304 {
305   return this->pimpl_cpu->get_pstate();
306 }
307
308 std::vector<Disk*> Host::get_disks() const
309 {
310   return this->pimpl_->get_disks();
311 }
312
313 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
314 {
315   return kernel::actor::simcall([this, &name, read_bandwidth, write_bandwidth] {
316     return this->pimpl_->create_disk(name, read_bandwidth, write_bandwidth);
317   });
318 }
319
320 Disk* Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
321 {
322   double d_read;
323   try {
324     d_read = xbt_parse_get_bandwidth("", 0, read_bandwidth.c_str(), nullptr, "");
325   } catch (const simgrid::ParseError&) {
326     throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
327                                 std::string(". Invalid read bandwidth: ") + read_bandwidth);
328   }
329   double d_write;
330   try {
331     d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth.c_str(), nullptr, "");
332   } catch (const simgrid::ParseError&) {
333     throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
334                                 std::string(". Invalid write bandwidth: ") + write_bandwidth);
335   }
336   return create_disk(name, d_read, d_write);
337 }
338
339 void Host::add_disk(const Disk* disk)
340 {
341   kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
342 }
343
344 void Host::remove_disk(const std::string& disk_name)
345 {
346   kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
347 }
348
349 ExecPtr Host::exec_init(double flops) const
350 {
351   return this_actor::exec_init(flops);
352 }
353
354 ExecPtr Host::exec_async(double flops) const
355 {
356   return this_actor::exec_async(flops);
357 }
358
359 void Host::execute(double flops) const
360 {
361   execute(flops, 1.0 /* priority */);
362 }
363
364 void Host::execute(double flops, double priority) const
365 {
366   this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
367 }
368
369 Host* Host::seal()
370 {
371   kernel::actor::simcall([this]() { this->pimpl_->seal(); });
372   simgrid::s4u::Host::on_creation(*this); // notify the signal
373   return this;
374 }
375
376 } // namespace s4u
377 } // namespace simgrid
378
379 /* **************************** Public C interface *************************** */
380 size_t sg_host_count()
381 {
382   return simgrid::s4u::Engine::get_instance()->get_host_count();
383 }
384 sg_host_t* sg_host_list()
385 {
386   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
387   size_t host_count             = e->get_host_count();
388
389   xbt_assert(host_count > 0, "There is no host!");
390   std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
391
392   sg_host_t* res = xbt_new(sg_host_t, hosts.size());
393   std::copy(begin(hosts), end(hosts), res);
394
395   return res;
396 }
397
398 const char* sg_host_get_name(const_sg_host_t host)
399 {
400   return host->get_cname();
401 }
402
403 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
404 {
405   return host->extension(ext);
406 }
407
408 size_t sg_host_extension_create(void (*deleter)(void*))
409 {
410   return simgrid::s4u::Host::extension_create(deleter);
411 }
412
413 sg_host_t sg_host_by_name(const char* name)
414 {
415   return simgrid::s4u::Host::by_name_or_null(name);
416 }
417
418 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
419 {
420   std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
421
422   auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
423     return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
424   });
425   std::sort(begin(list), last,
426             [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
427
428   xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
429   std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
430   return res;
431 }
432
433 // ========= Layering madness ==============*
434
435 // ========== User data Layer ==========
436 void* sg_host_get_data(const_sg_host_t host)
437 {
438   return host->get_data();
439 }
440 void sg_host_set_data(sg_host_t host, void* userdata)
441 {
442   host->set_data(userdata);
443 }
444 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
445 {
446   return sg_host_get_data(host);
447 }
448 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
449 {
450   sg_host_set_data(host, userdata);
451 }
452
453 // ========= Disk related functions ============
454 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
455 {
456   std::vector<sg_disk_t> list = host->get_disks();
457   *disk_count                 = list.size();
458   *disks                      = xbt_new(sg_disk_t, list.size());
459   std::copy(begin(list), end(list), *disks);
460 }
461
462 // =========== user-level functions ===============
463 // ================================================
464 /** @brief Returns the total speed of a host */
465 double sg_host_get_speed(const_sg_host_t host)
466 {
467   return host->get_speed();
468 }
469
470 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
471 {
472   return sg_host_get_speed(host);
473 }
474
475 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
476  *
477  * @param  host host to test
478  * @param pstate_index pstate to test
479  * @return Returns the processor speed associated with pstate_index
480  */
481 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
482 {
483   return host->get_pstate_speed(pstate_index);
484 }
485
486 /** @ingroup m_host_management
487  * @brief Return the number of cores.
488  *
489  * @param host a host
490  * @return the number of cores
491  */
492 int sg_host_core_count(const_sg_host_t host)
493 {
494   return host->get_core_count();
495 }
496
497 double sg_host_get_available_speed(const_sg_host_t host)
498 {
499   return host->get_available_speed();
500 }
501
502 /** @brief Returns the number of power states for a host.
503  *
504  *  See also @ref plugin_energy.
505  */
506 int sg_host_get_nb_pstates(const_sg_host_t host)
507 {
508   return host->get_pstate_count();
509 }
510
511 /** @brief Gets the pstate at which that host currently runs.
512  *
513  *  See also @ref plugin_energy.
514  */
515 int sg_host_get_pstate(const_sg_host_t host)
516 {
517   return host->get_pstate();
518 }
519 /** @brief Sets the pstate at which that host should run.
520  *
521  *  See also @ref plugin_energy.
522  */
523 void sg_host_set_pstate(sg_host_t host, int pstate)
524 {
525   host->set_pstate(pstate);
526 }
527
528 /** @ingroup m_host_management
529  *
530  * @brief Start the host if it is off
531  *
532  * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
533  * for more info on DVFS.
534  */
535 void sg_host_turn_on(sg_host_t host)
536 {
537   host->turn_on();
538 }
539
540 /** @ingroup m_host_management
541  *
542  * @brief Stop the host if it is on
543  *
544  * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
545  * for more info on DVFS.
546  */
547 void sg_host_turn_off(sg_host_t host)
548 {
549   host->turn_off();
550 }
551
552 /** @ingroup m_host_management
553  * @brief Determine if a host is up and running.
554  *
555  * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
556  * info on DVFS.
557  *
558  * @param host host to test
559  * @return Returns true if the host is up and running, and false if it's currently down
560  */
561 int sg_host_is_on(const_sg_host_t host)
562 {
563   return host->is_on();
564 }
565
566 /** @brief Get the properties of a host */
567 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
568 {
569   const std::unordered_map<std::string, std::string>* props = host->get_properties();
570   xbt_dict_t as_dict                                        = xbt_dict_new_homogeneous(xbt_free_f);
571
572   if (props == nullptr)
573     return nullptr;
574   for (auto const& elm : *props) {
575     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
576   }
577   return as_dict;
578 }
579
580 /** @ingroup m_host_management
581  * @brief Returns the value of a given host property
582  *
583  * @param host a host
584  * @param name a property name
585  * @return value of a property (or nullptr if property not set)
586  */
587 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
588 {
589   return host->get_property(name);
590 }
591
592 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
593 {
594   host->set_property(name, value);
595 }
596
597 /**
598  * @brief Find a route between two hosts
599  *
600  * @param from where from
601  * @param to where to
602  * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
603  */
604 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
605 {
606   std::vector<simgrid::s4u::Link*> vlinks;
607   from->route_to(to, vlinks, nullptr);
608   for (auto const& link : vlinks)
609     xbt_dynar_push(links, &link);
610 }
611 /**
612  * @brief Find the latency of the route between two hosts
613  *
614  * @param from where from
615  * @param to where to
616  */
617 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
618 {
619   std::vector<simgrid::s4u::Link*> vlinks;
620   double res = 0;
621   from->route_to(to, vlinks, &res);
622   return res;
623 }
624 /**
625  * @brief Find the bandwidth of the route between two hosts
626  *
627  * @param from where from
628  * @param to where to
629  */
630 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
631 {
632   double min_bandwidth = -1.0;
633
634   std::vector<simgrid::s4u::Link*> vlinks;
635   from->route_to(to, vlinks, nullptr);
636   for (auto const& link : vlinks) {
637     double bandwidth = link->get_bandwidth();
638     if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
639       min_bandwidth = bandwidth;
640   }
641   return min_bandwidth;
642 }
643
644 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
645 {
646   sg_host_get_route(from, to, links);
647 }
648
649 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
650 {
651   return sg_host_get_route_latency(from, to);
652 }
653
654 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
655 {
656   return sg_host_get_route_bandwidth(from, to);
657 }
658
659 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
660 {
661   simgrid::s4u::Comm::sendto(from, to, byte_amount);
662 }
663
664 /** @brief Displays debugging information about a host */
665 void sg_host_dump(const_sg_host_t host)
666 {
667   XBT_INFO("Displaying host %s", host->get_cname());
668   XBT_INFO("  - speed: %.0f", host->get_speed());
669   XBT_INFO("  - available speed: %.2f", sg_host_get_available_speed(host));
670   const std::unordered_map<std::string, std::string>* props = host->get_properties();
671
672   if (not props->empty()) {
673     XBT_INFO("  - properties:");
674     for (auto const& elm : *props) {
675       XBT_INFO("    %s->%s", elm.first.c_str(), elm.second.c_str());
676     }
677   }
678 }
679
680 /** @brief Return the list of actors attached to a host.
681  *
682  * @param host a host
683  * @param whereto a dynar in which we should push actors living on that host
684  */
685 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
686 {
687   auto const actors = host->get_all_actors();
688   for (auto const& actor : actors)
689     xbt_dynar_push(whereto, &actor);
690 }
691
692 sg_host_t sg_host_self()
693 {
694   return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
695 }
696
697 /* needs to be public and without simcall for exceptions and logging events */
698 const char* sg_host_self_get_name()
699 {
700   const char* res = "";
701   if (not SIMIX_is_maestro()) {
702     const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
703     if (host != nullptr)
704       res = host->get_cname();
705   }
706   return res;
707 }
708
709 double sg_host_get_load(const_sg_host_t host)
710 {
711   return host->get_load();
712 }
713
714 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
715 {
716   return sg_host_get_load(host);
717 }