Logo AND Algorithmique Numérique Distribuée

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