1 /* Copyright (c) 2006-2023. 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/Comm.hpp>
10 #include <simgrid/s4u/Engine.hpp>
11 #include <simgrid/s4u/Exec.hpp>
12 #include <simgrid/s4u/Host.hpp>
13 #include <simgrid/s4u/VirtualMachine.hpp>
14 #include <xbt/parse_units.hpp>
16 #include "simgrid/simix.hpp"
17 #include "src/kernel/resource/HostImpl.hpp"
18 #include "src/kernel/resource/StandardLinkImpl.hpp"
19 #include "src/kernel/resource/VirtualMachineImpl.hpp"
23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
24 XBT_LOG_EXTERNAL_CATEGORY(ker_platform);
28 template class xbt::Extendable<s4u::Host>;
33 xbt::signal<void(Host&)> Host::on_creation;
34 xbt::signal<void(Host const&)> Host::on_destruction;
35 xbt::signal<void(Host const&)> Host::on_state_change;
36 xbt::signal<void(Host const&)> Host::on_speed_change;
39 Host* Host::set_cpu(kernel::resource::CpuImpl* cpu)
46 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
48 pimpl_netpoint_ = netpoint;
54 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
55 Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
60 /** @brief Fire the required callbacks and destroy the object
62 * Don't delete directly a host, call h->destroy() instead.
64 * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
65 * object (because of the destructor order in a class hierarchy).
69 kernel::actor::simcall_answered([this] { this->pimpl_->destroy(); });
72 Host* Host::by_name(const std::string& name)
74 return Engine::get_instance()->host_by_name(name);
76 Host* Host::by_name_or_null(const std::string& name)
78 return Engine::get_instance()->host_by_name_or_null(name);
83 const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
84 xbt_assert(self != nullptr, "Cannot call Host::current() from the maestro context");
85 return self->get_host();
88 std::string const& Host::get_name() const
90 return this->pimpl_->get_name();
93 const char* Host::get_cname() const
95 return this->pimpl_->get_cname();
101 kernel::actor::simcall_answered([this] {
102 this->pimpl_cpu_->turn_on();
103 this->pimpl_->turn_on();
104 on_state_change(*this);
109 /** @brief Stop the host if it is on */
110 void Host::turn_off()
113 const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
114 kernel::actor::simcall_answered([this, self] {
115 this->pimpl_cpu_->turn_off();
116 this->pimpl_->turn_off(self);
118 on_state_change(*this);
123 bool Host::is_on() const
125 return this->pimpl_cpu_->is_on();
128 unsigned long Host::get_pstate_count() const
130 return this->pimpl_cpu_->get_pstate_count();
134 * @brief Return a copy of the list of actors that are executing on this host.
136 * Daemons and regular actors are all mixed in this list.
138 std::vector<ActorPtr> Host::get_all_actors() const
140 return pimpl_->get_all_actors();
143 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
144 size_t Host::get_actor_count() const
146 return pimpl_->get_actor_count();
150 * @brief Find a route toward another host
152 * @param dest [IN] where to
153 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
154 * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
155 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
157 * walk through the routing components tree and find a route between hosts
158 * by calling each "get_route" function in each routing component.
160 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
162 std::vector<kernel::resource::StandardLinkImpl*> linkImpls;
163 this->route_to(dest, linkImpls, latency);
164 for (auto* l : linkImpls)
165 links.push_back(l->get_iface());
168 /** @brief Just like Host::routeTo, but filling an array of link implementations */
169 void Host::route_to(const Host* dest, std::vector<kernel::resource::StandardLinkImpl*>& links, double* latency) const
171 kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
172 if (XBT_LOG_ISENABLED(ker_platform, xbt_log_priority_debug)) {
173 XBT_CDEBUG(ker_platform, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
174 (latency == nullptr ? -1 : *latency));
175 for (auto const* link : links)
176 XBT_CDEBUG(ker_platform, " Link '%s'", link->get_cname());
180 /** @brief Returns the networking zone englobing that host */
181 NetZone* Host::get_englobing_zone() const
183 return pimpl_netpoint_->get_englobing_zone()->get_iface();
186 /** Get the properties assigned to a host */
187 const std::unordered_map<std::string, std::string>* Host::get_properties() const
189 return this->pimpl_->get_properties();
192 /** Retrieve the property value (or nullptr if not set) */
193 const char* Host::get_property(const std::string& key) const
195 return this->pimpl_->get_property(key);
198 Host* Host::set_property(const std::string& key, const std::string& value)
200 kernel::actor::simcall_object_access(pimpl_, [this, &key, &value] { this->pimpl_->set_property(key, value); });
204 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
206 kernel::actor::simcall_object_access(pimpl_, [this, &properties] { this->pimpl_->set_properties(properties); });
210 int Host::get_concurrency_limit() const
212 return pimpl_cpu_->get_concurrency_limit();
215 Host* Host::set_concurrency_limit(int limit)
217 kernel::actor::simcall_object_access(pimpl_cpu_, [this, limit] { pimpl_cpu_->set_concurrency_limit(limit); });
221 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
222 * The profile must contain boolean values. */
223 Host* Host::set_state_profile(kernel::profile::Profile* p)
225 kernel::actor::simcall_object_access(pimpl_, [this, p] { pimpl_cpu_->set_state_profile(p); });
228 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
230 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
231 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
232 * at this pstate level) by the rate coming from the profile.
234 Host* Host::set_speed_profile(kernel::profile::Profile* p)
236 kernel::actor::simcall_object_access(pimpl_, [this, p] { pimpl_cpu_->set_speed_profile(p); });
240 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
241 double Host::get_pstate_speed(unsigned long pstate_index) const
243 return this->pimpl_cpu_->get_pstate_peak_speed(pstate_index);
246 double Host::get_speed() const
248 return this->pimpl_cpu_->get_speed(1.0);
250 double Host::get_load() const
252 return this->pimpl_cpu_->get_load();
254 double Host::get_available_speed() const
256 return this->pimpl_cpu_->get_speed_ratio();
259 Host* Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
261 kernel::actor::simcall_object_access(pimpl_, [this, policy, &cb] { pimpl_cpu_->set_sharing_policy(policy, cb); });
265 Host::SharingPolicy Host::get_sharing_policy() const
267 return this->pimpl_cpu_->get_sharing_policy();
270 int Host::get_core_count() const
272 return this->pimpl_cpu_->get_core_count();
275 Host* Host::set_core_count(int core_count)
277 kernel::actor::simcall_object_access(pimpl_, [this, core_count] { this->pimpl_cpu_->set_core_count(core_count); });
281 Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
283 kernel::actor::simcall_object_access(pimpl_,
284 [this, &speed_per_state] { pimpl_cpu_->set_pstate_speed(speed_per_state); });
288 std::vector<double> Host::convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state)
290 std::vector<double> speed_list;
291 speed_list.reserve(speed_per_state.size());
292 for (const auto& speed_str : speed_per_state) {
294 double speed = xbt_parse_get_speed("", 0, speed_str, "");
295 speed_list.push_back(speed);
296 } catch (const simgrid::ParseError&) {
297 throw std::invalid_argument("Invalid speed value: " + speed_str);
303 Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
305 set_pstate_speed(Host::convert_pstate_speed_vector(speed_per_state));
309 /** @brief Set the pstate at which the host should run */
310 Host* Host::set_pstate(unsigned long pstate_index)
312 kernel::actor::simcall_object_access(pimpl_, [this, pstate_index] { this->pimpl_cpu_->set_pstate(pstate_index); });
316 /** @brief Retrieve the pstate at which the host is currently running */
317 unsigned long Host::get_pstate() const
319 return this->pimpl_cpu_->get_pstate();
322 Host* Host::set_factor_cb(const std::function<CpuFactorCb>& cb)
324 kernel::actor::simcall_object_access(pimpl_, [this, &cb] { pimpl_cpu_->set_factor_cb(cb); });
328 Host* Host::set_coordinates(const std::string& coords)
330 if (not coords.empty())
331 kernel::actor::simcall_object_access(pimpl_, [this, coords] { this->pimpl_netpoint_->set_coordinates(coords); });
334 std::vector<Disk*> Host::get_disks() const
336 return this->pimpl_->get_disks();
339 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
341 return kernel::actor::simcall_answered([this, &name, read_bandwidth, write_bandwidth] {
342 auto* disk = pimpl_->create_disk(name, read_bandwidth, write_bandwidth);
343 pimpl_->add_disk(disk);
348 Disk* Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
352 d_read = xbt_parse_get_bandwidth("", 0, read_bandwidth, "");
353 } catch (const simgrid::ParseError&) {
354 throw std::invalid_argument("Impossible to create disk: " + name + ". Invalid read bandwidth: " + read_bandwidth);
358 d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth, "");
359 } catch (const simgrid::ParseError&) {
360 throw std::invalid_argument("Impossible to create disk: " + name + ". Invalid write bandwidth: " + write_bandwidth);
362 return create_disk(name, d_read, d_write);
365 void Host::add_disk(const Disk* disk)
367 kernel::actor::simcall_answered([this, disk] { this->pimpl_->add_disk(disk); });
370 void Host::remove_disk(const std::string& disk_name)
372 kernel::actor::simcall_answered([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
375 VirtualMachine* Host::create_vm(const std::string& name, int core_amount)
377 return kernel::actor::simcall_answered(
378 [this, &name, core_amount] { return this->pimpl_->create_vm(name, core_amount); });
381 VirtualMachine* Host::create_vm(const std::string& name, int core_amount, size_t ramsize)
383 return kernel::actor::simcall_answered(
384 [this, &name, core_amount, ramsize] { return this->pimpl_->create_vm(name, core_amount, ramsize); });
387 VirtualMachine* Host::vm_by_name_or_null(const std::string& name)
389 simgrid::kernel::resource::VirtualMachineImpl* vm = this->pimpl_->get_vm_by_name_or_null(name);
390 return vm ? vm->get_iface() : nullptr;
393 ExecPtr Host::exec_init(double flops) const
395 return this_actor::exec_init(flops);
398 ExecPtr Host::exec_async(double flops) const
400 return this_actor::exec_async(flops);
403 void Host::execute(double flops) const
405 execute(flops, 1.0 /* priority */);
408 void Host::execute(double flops, double priority) const
410 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
415 kernel::actor::simcall_answered([this]() { this->pimpl_->seal(); });
416 simgrid::s4u::Host::on_creation(*this); // notify the signal
421 } // namespace simgrid
423 /* **************************** Public C interface *************************** */
424 size_t sg_host_count()
426 return simgrid::s4u::Engine::get_instance()->get_host_count();
428 sg_host_t* sg_host_list()
430 const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
431 size_t host_count = e->get_host_count();
433 xbt_assert(host_count > 0, "There is no host!");
434 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
436 auto* res = xbt_new(sg_host_t, hosts.size());
437 std::copy(begin(hosts), end(hosts), res);
442 const char* sg_host_get_name(const_sg_host_t host)
444 return host->get_cname();
447 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
449 return host->extension(ext);
452 size_t sg_host_extension_create(void (*deleter)(void*))
454 return simgrid::s4u::Host::extension_create(deleter);
457 sg_host_t sg_host_by_name(const char* name)
459 return simgrid::s4u::Host::by_name_or_null(name);
462 /** @brief Retrieve a VM running on a given host from its name, or return NULL if no VM matches*/
463 sg_vm_t sg_vm_by_name(sg_host_t host, const char* name)
465 return host->vm_by_name_or_null(name);
468 // ========= Layering madness ==============*
470 // ========== User data Layer ==========
471 void* sg_host_get_data(const_sg_host_t host)
473 return host->get_data<void>();
475 void sg_host_set_data(sg_host_t host, void* userdata)
477 host->set_data(userdata);
480 // ========= Disk related functions ============
481 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
483 std::vector<sg_disk_t> list = host->get_disks();
484 *disk_count = list.size();
485 *disks = xbt_new(sg_disk_t, list.size());
486 std::copy(begin(list), end(list), *disks);
489 // =========== user-level functions ===============
490 // ================================================
491 /** @brief Returns the total speed of a host */
492 double sg_host_get_speed(const_sg_host_t host)
494 return host->get_speed();
497 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_host_energy.
499 * @param host host to test
500 * @param pstate_index pstate to test
501 * @return Returns the processor speed associated with pstate_index
503 double sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
505 return host->get_pstate_speed(pstate_index);
508 /** @ingroup m_host_management
509 * @brief Return the number of cores.
512 * @return the number of cores
514 int sg_host_core_count(const_sg_host_t host)
516 return host->get_core_count();
519 double sg_host_get_available_speed(const_sg_host_t host)
521 return host->get_available_speed();
524 /** @brief Returns the number of power states for a host.
526 * See also @ref plugin_host_energy.
528 unsigned long sg_host_get_nb_pstates(const_sg_host_t host)
530 return host->get_pstate_count();
533 /** @brief Gets the pstate at which that host currently runs.
535 * See also @ref plugin_host_energy.
537 unsigned long sg_host_get_pstate(const_sg_host_t host)
539 return host->get_pstate();
541 /** @brief Sets the pstate at which that host should run.
543 * See also @ref plugin_host_energy.
545 void sg_host_set_pstate(sg_host_t host, unsigned long pstate)
547 host->set_pstate(pstate);
550 /** @ingroup m_host_management
552 * @brief Start the host if it is off
554 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
555 * for more info on DVFS.
557 void sg_host_turn_on(sg_host_t host)
562 /** @ingroup m_host_management
564 * @brief Stop the host if it is on
566 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
567 * for more info on DVFS.
569 void sg_host_turn_off(sg_host_t host)
574 /** @ingroup m_host_management
575 * @brief Determine if a host is up and running.
577 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_host_energy for
580 * @param host host to test
581 * @return Returns true if the host is up and running, and false if it's currently down
583 int sg_host_is_on(const_sg_host_t host)
585 return host->is_on();
588 /** @brief Get the properties of a host */
589 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
591 const std::unordered_map<std::string, std::string>* props = host->get_properties();
592 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
594 if (props == nullptr)
596 for (auto const& [key, value] : *props) {
597 xbt_dict_set(as_dict, key.c_str(), xbt_strdup(value.c_str()));
602 /** @ingroup m_host_management
603 * @brief Returns the value of a given host property
606 * @param name a property name
607 * @return value of a property (or nullptr if property not set)
609 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
611 return host->get_property(name);
614 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
616 host->set_property(name, value);
620 * @brief Find a route between two hosts
622 * @param from where from
624 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
626 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
628 std::vector<simgrid::s4u::Link*> vlinks;
629 from->route_to(to, vlinks, nullptr);
630 for (auto const& link : vlinks)
631 xbt_dynar_push(links, &link);
634 * @brief Find the latency of the route between two hosts
636 * @param from where from
639 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
641 std::vector<simgrid::s4u::Link*> vlinks;
643 from->route_to(to, vlinks, &res);
647 * @brief Find the bandwidth of the route between two hosts
649 * @param from where from
652 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
654 double min_bandwidth = -1.0;
656 std::vector<simgrid::s4u::Link*> vlinks;
657 from->route_to(to, vlinks, nullptr);
658 for (auto const& link : vlinks) {
659 double bandwidth = link->get_bandwidth();
660 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
661 min_bandwidth = bandwidth;
663 return min_bandwidth;
666 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
668 simgrid::s4u::Comm::sendto(from, to, byte_amount);
671 /** @brief Displays debugging information about a host */
672 void sg_host_dump(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v335
674 XBT_INFO("Displaying host %s", host->get_cname());
675 XBT_INFO(" - speed: %.0f", host->get_speed());
676 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
677 const std::unordered_map<std::string, std::string>* props = host->get_properties();
679 if (not props->empty()) {
680 XBT_INFO(" - properties:");
681 for (auto const& [key, value] : *props) {
682 XBT_INFO(" %s->%s", key.c_str(), value.c_str());
687 /** @brief Return the list of actors attached to a host.
690 * @param whereto a dynar in which we should push actors living on that host
692 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
694 auto const actors = host->get_all_actors();
695 for (auto const& actor : actors)
696 xbt_dynar_push(whereto, &actor);
699 sg_host_t sg_host_self()
701 return simgrid::s4u::Actor::is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
704 /* needs to be public and without simcall for exceptions and logging events */
705 const char* sg_host_self_get_name()
707 const char* res = "";
708 if (not simgrid::s4u::Actor::is_maestro()) {
709 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
711 res = host->get_cname();
716 double sg_host_get_load(const_sg_host_t host)
718 return host->get_load();