1 /* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
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. */
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"
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
22 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
26 template class xbt::Extendable<s4u::Host>;
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;
35 Host* Host::set_cpu(kernel::resource::CpuImpl* cpu)
42 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
44 pimpl_netpoint_ = netpoint;
50 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
51 Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
56 /** @brief Fire the required callbacks and destroy the object
58 * Don't delete directly a host, call h->destroy() instead.
60 * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
61 * object (because of the destructor order in a class hierarchy).
65 kernel::actor::simcall([this] { this->pimpl_->destroy(); });
68 Host* Host::by_name(const std::string& name)
70 return Engine::get_instance()->host_by_name(name);
72 Host* Host::by_name_or_null(const std::string& name)
74 return Engine::get_instance()->host_by_name_or_null(name);
79 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
80 xbt_assert(self != nullptr, "Cannot call Host::current() from the maestro context");
81 return self->get_host();
84 xbt::string const& Host::get_name() const
86 return this->pimpl_->get_name();
89 const char* Host::get_cname() const
91 return this->pimpl_->get_cname();
97 kernel::actor::simcall([this] {
98 this->pimpl_cpu_->turn_on();
99 this->pimpl_->turn_on();
100 on_state_change(*this);
105 /** @brief Stop the host if it is on */
106 void Host::turn_off()
109 const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
110 kernel::actor::simcall([this, self] {
111 for (VirtualMachine* const& vm : vm::VirtualMachineImpl::allVms_)
112 if (vm->get_pm() == this) {
116 this->pimpl_cpu_->turn_off();
117 this->pimpl_->turn_off(self);
119 on_state_change(*this);
124 bool Host::is_on() const
126 return this->pimpl_cpu_->is_on();
129 int Host::get_pstate_count() const
131 return this->pimpl_cpu_->get_pstate_count();
135 * @brief Return a copy of the list of actors that are executing on this host.
137 * Daemons and regular actors are all mixed in this list.
139 std::vector<ActorPtr> Host::get_all_actors() const
141 return pimpl_->get_all_actors();
144 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
145 size_t Host::get_actor_count() const
147 return pimpl_->get_actor_count();
151 * @brief Find a route toward another host
153 * @param dest [IN] where to
154 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
155 * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
156 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
157 * @pre links!=nullptr
159 * walk through the routing components tree and find a route between hosts
160 * by calling each "get_route" function in each routing component.
162 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
164 std::vector<kernel::resource::LinkImpl*> linkImpls;
165 this->route_to(dest, linkImpls, latency);
166 for (auto* l : linkImpls)
167 links.push_back(l->get_iface());
170 /** @brief Just like Host::routeTo, but filling an array of link implementations */
171 void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const
173 kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
174 if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
175 XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
176 (latency == nullptr ? -1 : *latency));
177 for (auto const* link : links)
178 XBT_CDEBUG(surf_route, " Link '%s'", link->get_cname());
182 /** @brief Returns the networking zone englobing that host */
183 NetZone* Host::get_englobing_zone() const
185 return pimpl_netpoint_->get_englobing_zone()->get_iface();
189 void Host::sendto(Host* dest, double byte_amount) // XBT_ATTRIB_DEPRECATED_v331
191 Comm::sendto_async(this, dest, byte_amount)->wait();
194 CommPtr Host::sendto_async(Host* dest, double byte_amount) // XBT_ATTRIB_DEPRECATED_v331
196 return Comm::sendto_async(this, dest, byte_amount);
199 void Host::send_to(Host* dest, double byte_amount) // XBT_ATTRIB_DEPRECATED_v330
201 Comm::sendto(this, dest, byte_amount);
205 /** Get the properties assigned to a host */
206 const std::unordered_map<std::string, std::string>* Host::get_properties() const
208 return this->pimpl_->get_properties();
211 /** Retrieve the property value (or nullptr if not set) */
212 const char* Host::get_property(const std::string& key) const
214 return this->pimpl_->get_property(key);
217 Host* Host::set_property(const std::string& key, const std::string& value)
219 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
223 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
225 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
229 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
230 * The profile must contain boolean values. */
231 Host* Host::set_state_profile(kernel::profile::Profile* p)
233 kernel::actor::simcall([this, p] { pimpl_cpu_->set_state_profile(p); });
236 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
238 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
239 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
240 * at this pstate level) by the rate coming from the profile.
242 Host* Host::set_speed_profile(kernel::profile::Profile* p)
244 kernel::actor::simcall([this, p] { pimpl_cpu_->set_speed_profile(p); });
248 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
249 double Host::get_pstate_speed(int pstate_index) const
251 return this->pimpl_cpu_->get_pstate_peak_speed(pstate_index);
254 double Host::get_speed() const
256 return this->pimpl_cpu_->get_speed(1.0);
258 double Host::get_load() const
260 return this->pimpl_cpu_->get_load();
262 double Host::get_available_speed() const
264 return this->pimpl_cpu_->get_speed_ratio();
267 int Host::get_core_count() const
269 return this->pimpl_cpu_->get_core_count();
272 Host* Host::set_core_count(int core_count)
274 kernel::actor::simcall([this, core_count] { this->pimpl_cpu_->set_core_count(core_count); });
278 Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
280 kernel::actor::simcall([this, &speed_per_state] { pimpl_cpu_->set_pstate_speed(speed_per_state); });
284 std::vector<double> Host::convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state)
286 std::vector<double> speed_list;
287 speed_list.reserve(speed_per_state.size());
288 for (const auto& speed_str : speed_per_state) {
290 double speed = xbt_parse_get_speed("", 0, speed_str, "");
291 speed_list.push_back(speed);
292 } catch (const simgrid::ParseError&) {
293 throw std::invalid_argument(std::string("Invalid speed value: ") + speed_str);
299 Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
301 set_pstate_speed(Host::convert_pstate_speed_vector(speed_per_state));
305 /** @brief Set the pstate at which the host should run */
306 Host* Host::set_pstate(int pstate_index)
308 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu_->set_pstate(pstate_index); });
312 /** @brief Retrieve the pstate at which the host is currently running */
313 int Host::get_pstate() const
315 return this->pimpl_cpu_->get_pstate();
318 Host* Host::set_coordinates(const std::string& coords)
320 if (not coords.empty())
321 kernel::actor::simcall([this, coords] { this->pimpl_netpoint_->set_coordinates(coords); });
324 std::vector<Disk*> Host::get_disks() const
326 return this->pimpl_->get_disks();
329 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
331 return kernel::actor::simcall([this, &name, read_bandwidth, write_bandwidth] {
332 auto* disk = pimpl_->create_disk(name, read_bandwidth, write_bandwidth);
333 pimpl_->add_disk(disk);
338 Disk* Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
342 d_read = xbt_parse_get_bandwidth("", 0, read_bandwidth, "");
343 } catch (const simgrid::ParseError&) {
344 throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
345 std::string(". Invalid read bandwidth: ") + read_bandwidth);
349 d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth, "");
350 } catch (const simgrid::ParseError&) {
351 throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
352 std::string(". Invalid write bandwidth: ") + write_bandwidth);
354 return create_disk(name, d_read, d_write);
357 void Host::add_disk(const Disk* disk)
359 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
362 void Host::remove_disk(const std::string& disk_name)
364 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
367 ExecPtr Host::exec_init(double flops) const
369 return this_actor::exec_init(flops);
372 ExecPtr Host::exec_async(double flops) const
374 return this_actor::exec_async(flops);
377 void Host::execute(double flops) const
379 execute(flops, 1.0 /* priority */);
382 void Host::execute(double flops, double priority) const
384 this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
389 kernel::actor::simcall([this]() { this->pimpl_->seal(); });
390 simgrid::s4u::Host::on_creation(*this); // notify the signal
395 } // namespace simgrid
397 /* **************************** Public C interface *************************** */
398 size_t sg_host_count()
400 return simgrid::s4u::Engine::get_instance()->get_host_count();
402 sg_host_t* sg_host_list()
404 const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
405 size_t host_count = e->get_host_count();
407 xbt_assert(host_count > 0, "There is no host!");
408 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
410 auto* res = xbt_new(sg_host_t, hosts.size());
411 std::copy(begin(hosts), end(hosts), res);
416 const char* sg_host_get_name(const_sg_host_t host)
418 return host->get_cname();
421 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
423 return host->extension(ext);
426 size_t sg_host_extension_create(void (*deleter)(void*))
428 return simgrid::s4u::Host::extension_create(deleter);
431 sg_host_t sg_host_by_name(const char* name)
433 return simgrid::s4u::Host::by_name_or_null(name);
436 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
438 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
440 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
441 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
443 std::sort(begin(list), last,
444 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
446 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
447 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
451 // ========= Layering madness ==============*
453 // ========== User data Layer ==========
454 void* sg_host_get_data(const_sg_host_t host)
456 return host->get_data();
458 void sg_host_set_data(sg_host_t host, void* userdata)
460 host->set_data(userdata);
462 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
464 return sg_host_get_data(host);
466 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
468 sg_host_set_data(host, userdata);
471 // ========= Disk related functions ============
472 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
474 std::vector<sg_disk_t> list = host->get_disks();
475 *disk_count = list.size();
476 *disks = xbt_new(sg_disk_t, list.size());
477 std::copy(begin(list), end(list), *disks);
480 // =========== user-level functions ===============
481 // ================================================
482 /** @brief Returns the total speed of a host */
483 double sg_host_get_speed(const_sg_host_t host)
485 return host->get_speed();
488 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
490 return sg_host_get_speed(host);
493 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_host_energy.
495 * @param host host to test
496 * @param pstate_index pstate to test
497 * @return Returns the processor speed associated with pstate_index
499 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
501 return host->get_pstate_speed(pstate_index);
504 /** @ingroup m_host_management
505 * @brief Return the number of cores.
508 * @return the number of cores
510 int sg_host_core_count(const_sg_host_t host)
512 return host->get_core_count();
515 double sg_host_get_available_speed(const_sg_host_t host)
517 return host->get_available_speed();
520 /** @brief Returns the number of power states for a host.
522 * See also @ref plugin_host_energy.
524 int sg_host_get_nb_pstates(const_sg_host_t host)
526 return host->get_pstate_count();
529 /** @brief Gets the pstate at which that host currently runs.
531 * See also @ref plugin_host_energy.
533 int sg_host_get_pstate(const_sg_host_t host)
535 return host->get_pstate();
537 /** @brief Sets the pstate at which that host should run.
539 * See also @ref plugin_host_energy.
541 void sg_host_set_pstate(sg_host_t host, int pstate)
543 host->set_pstate(pstate);
546 /** @ingroup m_host_management
548 * @brief Start the host if it is off
550 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
551 * for more info on DVFS.
553 void sg_host_turn_on(sg_host_t host)
558 /** @ingroup m_host_management
560 * @brief Stop the host if it is on
562 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_host_energy
563 * for more info on DVFS.
565 void sg_host_turn_off(sg_host_t host)
570 /** @ingroup m_host_management
571 * @brief Determine if a host is up and running.
573 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_host_energy for
576 * @param host host to test
577 * @return Returns true if the host is up and running, and false if it's currently down
579 int sg_host_is_on(const_sg_host_t host)
581 return host->is_on();
584 /** @brief Get the properties of a host */
585 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
587 const std::unordered_map<std::string, std::string>* props = host->get_properties();
588 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
590 if (props == nullptr)
592 for (auto const& elm : *props) {
593 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
598 /** @ingroup m_host_management
599 * @brief Returns the value of a given host property
602 * @param name a property name
603 * @return value of a property (or nullptr if property not set)
605 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
607 return host->get_property(name);
610 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
612 host->set_property(name, value);
616 * @brief Find a route between two hosts
618 * @param from where from
620 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
622 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
624 std::vector<simgrid::s4u::Link*> vlinks;
625 from->route_to(to, vlinks, nullptr);
626 for (auto const& link : vlinks)
627 xbt_dynar_push(links, &link);
630 * @brief Find the latency of the route between two hosts
632 * @param from where from
635 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
637 std::vector<simgrid::s4u::Link*> vlinks;
639 from->route_to(to, vlinks, &res);
643 * @brief Find the bandwidth of the route between two hosts
645 * @param from where from
648 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
650 double min_bandwidth = -1.0;
652 std::vector<simgrid::s4u::Link*> vlinks;
653 from->route_to(to, vlinks, nullptr);
654 for (auto const& link : vlinks) {
655 double bandwidth = link->get_bandwidth();
656 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
657 min_bandwidth = bandwidth;
659 return min_bandwidth;
662 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
664 sg_host_get_route(from, to, links);
667 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
669 return sg_host_get_route_latency(from, to);
672 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
674 return sg_host_get_route_bandwidth(from, to);
677 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
679 simgrid::s4u::Comm::sendto(from, to, byte_amount);
682 /** @brief Displays debugging information about a host */
683 void sg_host_dump(const_sg_host_t host)
685 XBT_INFO("Displaying host %s", host->get_cname());
686 XBT_INFO(" - speed: %.0f", host->get_speed());
687 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
688 const std::unordered_map<std::string, std::string>* props = host->get_properties();
690 if (not props->empty()) {
691 XBT_INFO(" - properties:");
692 for (auto const& elm : *props) {
693 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
698 /** @brief Return the list of actors attached to a host.
701 * @param whereto a dynar in which we should push actors living on that host
703 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
705 auto const actors = host->get_all_actors();
706 for (auto const& actor : actors)
707 xbt_dynar_push(whereto, &actor);
710 sg_host_t sg_host_self()
712 return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
715 /* needs to be public and without simcall for exceptions and logging events */
716 const char* sg_host_self_get_name()
718 const char* res = "";
719 if (not SIMIX_is_maestro()) {
720 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
722 res = host->get_cname();
727 double sg_host_get_load(const_sg_host_t host)
729 return host->get_load();
732 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
734 return sg_host_get_load(host);