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_netpoint(kernel::routing::NetPoint* netpoint)
37 pimpl_netpoint_ = netpoint;
43 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
44 Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
48 /** @brief Fire the required callbacks and destroy the object
50 * Don't delete directly a host, call h->destroy() instead.
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).
57 kernel::actor::simcall([this] { this->pimpl_->destroy(); });
60 Host* Host::by_name(const std::string& name)
62 return Engine::get_instance()->host_by_name(name);
64 Host* Host::by_name_or_null(const std::string& name)
66 return Engine::get_instance()->host_by_name_or_null(name);
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();
76 xbt::string const& Host::get_name() const
78 return this->pimpl_->get_name();
81 const char* Host::get_cname() const
83 return this->pimpl_->get_cname();
89 kernel::actor::simcall([this] {
90 this->pimpl_cpu->turn_on();
91 this->pimpl_->turn_on();
92 on_state_change(*this);
97 /** @brief Stop the host if it 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) {
108 this->pimpl_cpu->turn_off();
109 this->pimpl_->turn_off(self);
111 on_state_change(*this);
116 bool Host::is_on() const
118 return this->pimpl_cpu->is_on();
121 int Host::get_pstate_count() const
123 return this->pimpl_cpu->get_pstate_count();
127 * @brief Return a copy of the list of actors that are executing on this host.
129 * Daemons and regular actors are all mixed in this list.
131 std::vector<ActorPtr> Host::get_all_actors() const
133 return pimpl_->get_all_actors();
136 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
137 size_t Host::get_actor_count() const
139 return pimpl_->get_actor_count();
143 * @brief Find a route toward another host
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
151 * walk through the routing components tree and find a route between hosts
152 * by calling each "get_route" function in each routing component.
154 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
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());
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
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());
174 /** @brief Returns the networking zone englobing that host */
175 NetZone* Host::get_englobing_zone() const
177 return pimpl_netpoint_->get_englobing_zone()->get_iface();
180 void Host::sendto(Host* dest, double byte_amount) // deprecated 331
182 Comm::sendto_async(this, dest, byte_amount)->wait();
185 CommPtr Host::sendto_async(Host* dest, double byte_amount) // deprecated 331
187 return Comm::sendto_async(this, dest, byte_amount);
190 void Host::send_to(Host* dest, double byte_amount) // deprecated 330
192 Comm::sendto(this, dest, byte_amount);
195 /** Get the properties assigned to a host */
196 const std::unordered_map<std::string, std::string>* Host::get_properties() const
198 return this->pimpl_->get_properties();
201 /** Retrieve the property value (or nullptr if not set) */
202 const char* Host::get_property(const std::string& key) const
204 return this->pimpl_->get_property(key);
207 Host* Host::set_property(const std::string& key, const std::string& value)
209 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
213 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
215 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
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)
223 kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
226 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
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.
232 Host* Host::set_speed_profile(kernel::profile::Profile* p)
234 kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
238 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
239 double Host::get_pstate_speed(int pstate_index) const
241 return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
244 double Host::get_speed() const
246 return this->pimpl_cpu->get_speed(1.0);
248 double Host::get_load() const
250 return this->pimpl_cpu->get_load();
252 double Host::get_available_speed() const
254 return this->pimpl_cpu->get_speed_ratio();
257 int Host::get_core_count() const
259 return this->pimpl_cpu->get_core_count();
262 Host* Host::set_core_count(int core_count)
264 kernel::actor::simcall([this, core_count] { this->pimpl_cpu->set_core_count(core_count); });
268 Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
270 kernel::actor::simcall([this, &speed_per_state] { pimpl_cpu->set_pstate_speed(speed_per_state); });
274 std::vector<double> Host::convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state)
276 std::vector<double> speed_list;
277 speed_list.reserve(speed_per_state.size());
278 for (const auto& speed_str : speed_per_state) {
280 double speed = xbt_parse_get_speed("", 0, speed_str, "");
281 speed_list.push_back(speed);
282 } catch (const simgrid::ParseError&) {
283 throw std::invalid_argument(std::string("Invalid speed value: ") + speed_str);
289 Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
291 set_pstate_speed(Host::convert_pstate_speed_vector(speed_per_state));
295 /** @brief Set the pstate at which the host should run */
296 Host* Host::set_pstate(int pstate_index)
298 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
302 /** @brief Retrieve the pstate at which the host is currently running */
303 int Host::get_pstate() const
305 return this->pimpl_cpu->get_pstate();
308 Host* Host::set_coordinates(const std::string& coords)
310 if (not coords.empty())
311 kernel::actor::simcall([this, coords] { this->pimpl_netpoint_->set_coordinates(coords); });
314 std::vector<Disk*> Host::get_disks() const
316 return this->pimpl_->get_disks();
319 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
321 return kernel::actor::simcall([this, &name, read_bandwidth, write_bandwidth] {
322 auto* disk = pimpl_->create_disk(name, read_bandwidth, write_bandwidth);
323 pimpl_->add_disk(disk);
328 Disk* Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
332 d_read = xbt_parse_get_bandwidth("", 0, read_bandwidth, "");
333 } catch (const simgrid::ParseError&) {
334 throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
335 std::string(". Invalid read bandwidth: ") + read_bandwidth);
339 d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth, "");
340 } catch (const simgrid::ParseError&) {
341 throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
342 std::string(". Invalid write bandwidth: ") + write_bandwidth);
344 return create_disk(name, d_read, d_write);
347 void Host::add_disk(const Disk* disk)
349 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
352 void Host::remove_disk(const std::string& disk_name)
354 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
357 ExecPtr Host::exec_init(double flops) const
359 return this_actor::exec_init(flops);
362 ExecPtr Host::exec_async(double flops) const
364 return this_actor::exec_async(flops);
367 void Host::execute(double flops) const
369 execute(flops, 1.0 /* priority */);
372 void Host::execute(double flops, double priority) const
374 this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
379 kernel::actor::simcall([this]() { this->pimpl_->seal(); });
380 simgrid::s4u::Host::on_creation(*this); // notify the signal
385 } // namespace simgrid
387 /* **************************** Public C interface *************************** */
388 size_t sg_host_count()
390 return simgrid::s4u::Engine::get_instance()->get_host_count();
392 sg_host_t* sg_host_list()
394 const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
395 size_t host_count = e->get_host_count();
397 xbt_assert(host_count > 0, "There is no host!");
398 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
400 auto* res = xbt_new(sg_host_t, hosts.size());
401 std::copy(begin(hosts), end(hosts), res);
406 const char* sg_host_get_name(const_sg_host_t host)
408 return host->get_cname();
411 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
413 return host->extension(ext);
416 size_t sg_host_extension_create(void (*deleter)(void*))
418 return simgrid::s4u::Host::extension_create(deleter);
421 sg_host_t sg_host_by_name(const char* name)
423 return simgrid::s4u::Host::by_name_or_null(name);
426 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
428 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
430 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
431 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
433 std::sort(begin(list), last,
434 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
436 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
437 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
441 // ========= Layering madness ==============*
443 // ========== User data Layer ==========
444 void* sg_host_get_data(const_sg_host_t host)
446 return host->get_data();
448 void sg_host_set_data(sg_host_t host, void* userdata)
450 host->set_data(userdata);
452 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
454 return sg_host_get_data(host);
456 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
458 sg_host_set_data(host, userdata);
461 // ========= Disk related functions ============
462 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
464 std::vector<sg_disk_t> list = host->get_disks();
465 *disk_count = list.size();
466 *disks = xbt_new(sg_disk_t, list.size());
467 std::copy(begin(list), end(list), *disks);
470 // =========== user-level functions ===============
471 // ================================================
472 /** @brief Returns the total speed of a host */
473 double sg_host_get_speed(const_sg_host_t host)
475 return host->get_speed();
478 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
480 return sg_host_get_speed(host);
483 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
485 * @param host host to test
486 * @param pstate_index pstate to test
487 * @return Returns the processor speed associated with pstate_index
489 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
491 return host->get_pstate_speed(pstate_index);
494 /** @ingroup m_host_management
495 * @brief Return the number of cores.
498 * @return the number of cores
500 int sg_host_core_count(const_sg_host_t host)
502 return host->get_core_count();
505 double sg_host_get_available_speed(const_sg_host_t host)
507 return host->get_available_speed();
510 /** @brief Returns the number of power states for a host.
512 * See also @ref plugin_energy.
514 int sg_host_get_nb_pstates(const_sg_host_t host)
516 return host->get_pstate_count();
519 /** @brief Gets the pstate at which that host currently runs.
521 * See also @ref plugin_energy.
523 int sg_host_get_pstate(const_sg_host_t host)
525 return host->get_pstate();
527 /** @brief Sets the pstate at which that host should run.
529 * See also @ref plugin_energy.
531 void sg_host_set_pstate(sg_host_t host, int pstate)
533 host->set_pstate(pstate);
536 /** @ingroup m_host_management
538 * @brief Start the host if it is off
540 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
541 * for more info on DVFS.
543 void sg_host_turn_on(sg_host_t host)
548 /** @ingroup m_host_management
550 * @brief Stop the host if it is on
552 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
553 * for more info on DVFS.
555 void sg_host_turn_off(sg_host_t host)
560 /** @ingroup m_host_management
561 * @brief Determine if a host is up and running.
563 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
566 * @param host host to test
567 * @return Returns true if the host is up and running, and false if it's currently down
569 int sg_host_is_on(const_sg_host_t host)
571 return host->is_on();
574 /** @brief Get the properties of a host */
575 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
577 const std::unordered_map<std::string, std::string>* props = host->get_properties();
578 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
580 if (props == nullptr)
582 for (auto const& elm : *props) {
583 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
588 /** @ingroup m_host_management
589 * @brief Returns the value of a given host property
592 * @param name a property name
593 * @return value of a property (or nullptr if property not set)
595 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
597 return host->get_property(name);
600 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
602 host->set_property(name, value);
606 * @brief Find a route between two hosts
608 * @param from where from
610 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
612 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
614 std::vector<simgrid::s4u::Link*> vlinks;
615 from->route_to(to, vlinks, nullptr);
616 for (auto const& link : vlinks)
617 xbt_dynar_push(links, &link);
620 * @brief Find the latency of the route between two hosts
622 * @param from where from
625 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
627 std::vector<simgrid::s4u::Link*> vlinks;
629 from->route_to(to, vlinks, &res);
633 * @brief Find the bandwidth of the route between two hosts
635 * @param from where from
638 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
640 double min_bandwidth = -1.0;
642 std::vector<simgrid::s4u::Link*> vlinks;
643 from->route_to(to, vlinks, nullptr);
644 for (auto const& link : vlinks) {
645 double bandwidth = link->get_bandwidth();
646 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
647 min_bandwidth = bandwidth;
649 return min_bandwidth;
652 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
654 sg_host_get_route(from, to, links);
657 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
659 return sg_host_get_route_latency(from, to);
662 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
664 return sg_host_get_route_bandwidth(from, to);
667 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
669 simgrid::s4u::Comm::sendto(from, to, byte_amount);
672 /** @brief Displays debugging information about a host */
673 void sg_host_dump(const_sg_host_t host)
675 XBT_INFO("Displaying host %s", host->get_cname());
676 XBT_INFO(" - speed: %.0f", host->get_speed());
677 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
678 const std::unordered_map<std::string, std::string>* props = host->get_properties();
680 if (not props->empty()) {
681 XBT_INFO(" - properties:");
682 for (auto const& elm : *props) {
683 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
688 /** @brief Return the list of actors attached to a host.
691 * @param whereto a dynar in which we should push actors living on that host
693 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
695 auto const actors = host->get_all_actors();
696 for (auto const& actor : actors)
697 xbt_dynar_push(whereto, &actor);
700 sg_host_t sg_host_self()
702 return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
705 /* needs to be public and without simcall for exceptions and logging events */
706 const char* sg_host_self_get_name()
708 const char* res = "";
709 if (not SIMIX_is_maestro()) {
710 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
712 res = host->get_cname();
717 double sg_host_get_load(const_sg_host_t host)
719 return host->get_load();
722 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
724 return sg_host_get_load(host);