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;
37 xbt::signal<void(kernel::resource::CpuAction&, kernel::resource::Action::State)> Host::on_exec_state_change;
40 Host* Host::set_cpu(kernel::resource::CpuImpl* cpu)
47 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
49 pimpl_netpoint_ = netpoint;
55 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
56 Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
61 /** @brief Fire the required callbacks and destroy the object
63 * Don't delete directly a host, call h->destroy() instead.
65 * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
66 * object (because of the destructor order in a class hierarchy).
70 kernel::actor::simcall_answered([this] { this->pimpl_->destroy(); });
73 Host* Host::by_name(const std::string& name)
75 return Engine::get_instance()->host_by_name(name);
77 Host* Host::by_name_or_null(const std::string& name)
79 return Engine::get_instance()->host_by_name_or_null(name);
84 const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
85 xbt_assert(self != nullptr, "Cannot call Host::current() from the maestro context");
86 return self->get_host();
89 std::string const& Host::get_name() const
91 return this->pimpl_->get_name();
94 const char* Host::get_cname() const
96 return this->pimpl_->get_cname();
102 kernel::actor::simcall_answered([this] {
103 this->pimpl_cpu_->turn_on();
104 this->pimpl_->turn_on();
105 on_state_change(*this);
110 /** @brief Stop the host if it is on */
111 void Host::turn_off()
114 const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
115 kernel::actor::simcall_answered([this, self] {
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 unsigned long 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)
158 * walk through the routing components tree and find a route between hosts
159 * by calling each "get_route" function in each routing component.
161 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
163 std::vector<kernel::resource::StandardLinkImpl*> linkImpls;
164 this->route_to(dest, linkImpls, latency);
165 for (auto* l : linkImpls)
166 links.push_back(l->get_iface());
168 std::pair<std::vector<Link*>, double> Host::route_to(const Host* dest) const
170 std::vector<kernel::resource::StandardLinkImpl*> linkImpls;
171 std::vector<Link*> links;
173 this->route_to(dest, linkImpls, &latency);
174 for (auto* l : linkImpls)
175 links.push_back(l->get_iface());
176 return std::make_pair(links, latency);
179 /** @brief Just like Host::routeTo, but filling an array of link implementations */
180 void Host::route_to(const Host* dest, std::vector<kernel::resource::StandardLinkImpl*>& links, double* latency) const
182 kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
183 if (XBT_LOG_ISENABLED(ker_platform, xbt_log_priority_debug)) {
184 XBT_CDEBUG(ker_platform, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
185 (latency == nullptr ? -1 : *latency));
186 for (auto const* link : links)
187 XBT_CDEBUG(ker_platform, " Link '%s'", link->get_cname());
191 /** @brief Returns the networking zone englobing that host */
192 NetZone* Host::get_englobing_zone() const
194 return pimpl_netpoint_->get_englobing_zone()->get_iface();
197 /** Get the properties assigned to a host */
198 const std::unordered_map<std::string, std::string>* Host::get_properties() const
200 return this->pimpl_->get_properties();
203 /** Retrieve the property value (or nullptr if not set) */
204 const char* Host::get_property(const std::string& key) const
206 return this->pimpl_->get_property(key);
209 Host* Host::set_property(const std::string& key, const std::string& value)
211 kernel::actor::simcall_object_access(pimpl_, [this, &key, &value] { this->pimpl_->set_property(key, value); });
215 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
217 kernel::actor::simcall_object_access(pimpl_, [this, &properties] { this->pimpl_->set_properties(properties); });
221 int Host::get_concurrency_limit() const
223 return pimpl_cpu_->get_concurrency_limit();
226 Host* Host::set_concurrency_limit(int limit)
228 kernel::actor::simcall_object_access(pimpl_cpu_, [this, limit] { pimpl_cpu_->set_concurrency_limit(limit); });
232 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
233 * The profile must contain boolean values. */
234 Host* Host::set_state_profile(kernel::profile::Profile* p)
236 kernel::actor::simcall_object_access(pimpl_, [this, p] { pimpl_cpu_->set_state_profile(p); });
239 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
241 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
242 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
243 * at this pstate level) by the rate coming from the profile.
245 Host* Host::set_speed_profile(kernel::profile::Profile* p)
247 kernel::actor::simcall_object_access(pimpl_, [this, p] { pimpl_cpu_->set_speed_profile(p); });
251 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
252 double Host::get_pstate_speed(unsigned long pstate_index) const
254 return this->pimpl_cpu_->get_pstate_peak_speed(pstate_index);
257 double Host::get_speed() const
259 return this->pimpl_cpu_->get_speed(1.0);
261 double Host::get_load() const
263 return this->pimpl_cpu_->get_load();
265 double Host::get_available_speed() const
267 return this->pimpl_cpu_->get_speed_ratio();
270 Host* Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
272 kernel::actor::simcall_object_access(pimpl_, [this, policy, &cb] { pimpl_cpu_->set_sharing_policy(policy, cb); });
276 Host::SharingPolicy Host::get_sharing_policy() const
278 return this->pimpl_cpu_->get_sharing_policy();
281 int Host::get_core_count() const
283 return this->pimpl_cpu_->get_core_count();
286 Host* Host::set_core_count(int core_count)
288 kernel::actor::simcall_object_access(pimpl_, [this, core_count] { this->pimpl_cpu_->set_core_count(core_count); });
292 Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
294 kernel::actor::simcall_object_access(pimpl_,
295 [this, &speed_per_state] { pimpl_cpu_->set_pstate_speed(speed_per_state); });
299 std::vector<double> Host::convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state)
301 std::vector<double> speed_list;
302 speed_list.reserve(speed_per_state.size());
303 for (const auto& speed_str : speed_per_state) {
305 double speed = xbt_parse_get_speed("", 0, speed_str, "");
306 speed_list.push_back(speed);
307 } catch (const simgrid::ParseError&) {
308 throw std::invalid_argument("Invalid speed value: " + speed_str);
314 Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
316 set_pstate_speed(Host::convert_pstate_speed_vector(speed_per_state));
320 /** @brief Set the pstate at which the host should run */
321 Host* Host::set_pstate(unsigned long pstate_index)
323 kernel::actor::simcall_object_access(pimpl_, [this, pstate_index] { this->pimpl_cpu_->set_pstate(pstate_index); });
327 /** @brief Retrieve the pstate at which the host is currently running */
328 unsigned long Host::get_pstate() const
330 return this->pimpl_cpu_->get_pstate();
333 Host* Host::set_factor_cb(const std::function<CpuFactorCb>& cb)
335 kernel::actor::simcall_object_access(pimpl_, [this, &cb] { pimpl_cpu_->set_factor_cb(cb); });
339 Host* Host::set_coordinates(const std::string& coords)
341 if (not coords.empty())
342 kernel::actor::simcall_object_access(pimpl_, [this, coords] { this->pimpl_netpoint_->set_coordinates(coords); });
345 std::vector<Disk*> Host::get_disks() const
347 return this->pimpl_->get_disks();
350 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
352 return kernel::actor::simcall_answered([this, &name, read_bandwidth, write_bandwidth] {
353 auto* disk = pimpl_->create_disk(name, read_bandwidth, write_bandwidth);
354 pimpl_->add_disk(disk);
359 Disk* Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
363 d_read = xbt_parse_get_bandwidth("", 0, read_bandwidth, "");
364 } catch (const simgrid::ParseError&) {
365 throw std::invalid_argument("Impossible to create disk: " + name + ". Invalid read bandwidth: " + read_bandwidth);
369 d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth, "");
370 } catch (const simgrid::ParseError&) {
371 throw std::invalid_argument("Impossible to create disk: " + name + ". Invalid write bandwidth: " + write_bandwidth);
373 return create_disk(name, d_read, d_write);
376 void Host::add_disk(const Disk* disk)
378 kernel::actor::simcall_answered([this, disk] { this->pimpl_->add_disk(disk); });
381 void Host::remove_disk(const std::string& disk_name)
383 kernel::actor::simcall_answered([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
386 VirtualMachine* Host::create_vm(const std::string& name, int core_amount)
388 return kernel::actor::simcall_answered(
389 [this, &name, core_amount] { return this->pimpl_->create_vm(name, core_amount); });
392 VirtualMachine* Host::create_vm(const std::string& name, int core_amount, size_t ramsize)
394 return kernel::actor::simcall_answered(
395 [this, &name, core_amount, ramsize] { return this->pimpl_->create_vm(name, core_amount, ramsize); });
398 VirtualMachine* Host::vm_by_name_or_null(const std::string& name)
400 simgrid::kernel::resource::VirtualMachineImpl* vm = this->pimpl_->get_vm_by_name_or_null(name);
401 return vm ? vm->get_iface() : nullptr;
404 ExecPtr Host::exec_init(double flops) const
406 return this_actor::exec_init(flops);
409 ExecPtr Host::exec_async(double flops) const
411 return this_actor::exec_async(flops);
414 void Host::execute(double flops) const
416 execute(flops, 1.0 /* priority */);
419 void Host::execute(double flops, double priority) const
421 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
426 kernel::actor::simcall_answered([this]() { this->pimpl_->seal(); });
427 simgrid::s4u::Host::on_creation(*this); // notify the signal
432 } // namespace simgrid
434 /* **************************** Public C interface *************************** */
435 size_t sg_host_count()
437 return simgrid::s4u::Engine::get_instance()->get_host_count();
439 sg_host_t* sg_host_list()
441 const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
442 size_t host_count = e->get_host_count();
444 xbt_assert(host_count > 0, "There is no host!");
445 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
447 auto* res = xbt_new(sg_host_t, hosts.size());
448 std::copy(begin(hosts), end(hosts), res);
453 const char* sg_host_get_name(const_sg_host_t host)
455 return host->get_cname();
458 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
460 return host->extension(ext);
463 size_t sg_host_extension_create(void (*deleter)(void*))
465 return simgrid::s4u::Host::extension_create(deleter);
468 sg_host_t sg_host_by_name(const char* name)
470 return simgrid::s4u::Host::by_name_or_null(name);
473 /** @brief Retrieve a VM running on a given host from its name, or return NULL if no VM matches*/
474 sg_vm_t sg_vm_by_name(sg_host_t host, const char* name)
476 return host->vm_by_name_or_null(name);
479 // ========= Layering madness ==============*
481 // ========== User data Layer ==========
482 void* sg_host_get_data(const_sg_host_t host)
484 return host->get_data<void>();
486 void sg_host_set_data(sg_host_t host, void* userdata)
488 host->set_data(userdata);
491 // ========= Disk related functions ============
492 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
494 std::vector<sg_disk_t> list = host->get_disks();
495 *disk_count = list.size();
496 *disks = xbt_new(sg_disk_t, list.size());
497 std::copy(begin(list), end(list), *disks);
500 // =========== user-level functions ===============
501 // ================================================
502 /** @brief Returns the total speed of a host */
503 double sg_host_get_speed(const_sg_host_t host)
505 return host->get_speed();
508 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_host_energy.
510 * @param host host to test
511 * @param pstate_index pstate to test
512 * @return Returns the processor speed associated with pstate_index
514 double sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
516 return host->get_pstate_speed(pstate_index);
519 /** @ingroup m_host_management
520 * @brief Return the number of cores.
523 * @return the number of cores
525 int sg_host_core_count(const_sg_host_t host)
527 return host->get_core_count();
530 double sg_host_get_available_speed(const_sg_host_t host)
532 return host->get_available_speed();
535 /** @brief Returns the number of power states for a host.
537 * See also @ref plugin_host_energy.
539 unsigned long sg_host_get_nb_pstates(const_sg_host_t host)
541 return host->get_pstate_count();
544 /** @brief Gets the pstate at which that host currently runs.
546 * See also @ref plugin_host_energy.
548 unsigned long sg_host_get_pstate(const_sg_host_t host)
550 return host->get_pstate();
552 /** @brief Sets the pstate at which that host should run.
554 * See also @ref plugin_host_energy.
556 void sg_host_set_pstate(sg_host_t host, unsigned long pstate)
558 host->set_pstate(pstate);
561 /** @ingroup m_host_management
563 * @brief Start the host if it is off
565 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
566 * for more info on DVFS.
568 void sg_host_turn_on(sg_host_t host)
573 /** @ingroup m_host_management
575 * @brief Stop the host if it is on
577 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
578 * for more info on DVFS.
580 void sg_host_turn_off(sg_host_t host)
585 /** @ingroup m_host_management
586 * @brief Determine if a host is up and running.
588 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_host_energy for
591 * @param host host to test
592 * @return Returns true if the host is up and running, and false if it's currently down
594 int sg_host_is_on(const_sg_host_t host)
596 return host->is_on();
599 /** @brief Get the properties of a host */
600 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
602 const std::unordered_map<std::string, std::string>* props = host->get_properties();
603 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
605 if (props == nullptr)
607 for (auto const& [key, value] : *props) {
608 xbt_dict_set(as_dict, key.c_str(), xbt_strdup(value.c_str()));
613 /** @ingroup m_host_management
614 * @brief Returns the value of a given host property
617 * @param name a property name
618 * @return value of a property (or nullptr if property not set)
620 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
622 return host->get_property(name);
625 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
627 host->set_property(name, value);
631 * @brief Find a route between two hosts
633 * @param from where from
635 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
637 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
639 std::vector<simgrid::s4u::Link*> vlinks;
640 from->route_to(to, vlinks, nullptr);
641 for (auto const& link : vlinks)
642 xbt_dynar_push(links, &link);
645 * @brief Find the latency of the route between two hosts
647 * @param from where from
650 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
652 std::vector<simgrid::s4u::Link*> vlinks;
654 from->route_to(to, vlinks, &res);
658 * @brief Find the bandwidth of the route between two hosts
660 * @param from where from
663 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
665 double min_bandwidth = -1.0;
667 std::vector<simgrid::s4u::Link*> vlinks;
668 from->route_to(to, vlinks, nullptr);
669 for (auto const& link : vlinks) {
670 double bandwidth = link->get_bandwidth();
671 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
672 min_bandwidth = bandwidth;
674 return min_bandwidth;
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) // XBT_ATTRIB_DEPRECATED_v335
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& [key, value] : *props) {
693 XBT_INFO(" %s->%s", key.c_str(), value.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 simgrid::s4u::Actor::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 simgrid::s4u::Actor::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();