1 /* Copyright (c) 2006-2022. 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 "src/kernel/resource/StandardLinkImpl.hpp"
17 #include "src/kernel/resource/VirtualMachineImpl.hpp"
18 #include "src/surf/HostImpl.hpp"
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
23 XBT_LOG_EXTERNAL_CATEGORY(ker_routing);
27 template class xbt::Extendable<s4u::Host>;
32 xbt::signal<void(Host&)> Host::on_creation;
33 xbt::signal<void(Host const&)> Host::on_destruction;
34 xbt::signal<void(Host const&)> Host::on_state_change;
35 xbt::signal<void(Host const&)> Host::on_speed_change;
38 Host* Host::set_cpu(kernel::resource::CpuImpl* cpu)
45 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
47 pimpl_netpoint_ = netpoint;
53 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
54 Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
59 /** @brief Fire the required callbacks and destroy the object
61 * Don't delete directly a host, call h->destroy() instead.
63 * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
64 * object (because of the destructor order in a class hierarchy).
68 kernel::actor::simcall([this] { this->pimpl_->destroy(); });
71 Host* Host::by_name(const std::string& name)
73 return Engine::get_instance()->host_by_name(name);
75 Host* Host::by_name_or_null(const std::string& name)
77 return Engine::get_instance()->host_by_name_or_null(name);
82 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
83 xbt_assert(self != nullptr, "Cannot call Host::current() from the maestro context");
84 return self->get_host();
87 xbt::string const& Host::get_name() const
89 return this->pimpl_->get_name();
92 const char* Host::get_cname() const
94 return this->pimpl_->get_cname();
100 kernel::actor::simcall([this] {
101 this->pimpl_cpu_->turn_on();
102 this->pimpl_->turn_on();
103 on_state_change(*this);
108 /** @brief Stop the host if it is on */
109 void Host::turn_off()
112 const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
113 kernel::actor::simcall([this, self] {
114 for (VirtualMachine* const& vm : kernel::resource::VirtualMachineImpl::allVms_)
115 if (vm->get_pm() == this) {
119 this->pimpl_cpu_->turn_off();
120 this->pimpl_->turn_off(self);
122 on_state_change(*this);
127 bool Host::is_on() const
129 return this->pimpl_cpu_->is_on();
132 unsigned long Host::get_pstate_count() const
134 return this->pimpl_cpu_->get_pstate_count();
138 * @brief Return a copy of the list of actors that are executing on this host.
140 * Daemons and regular actors are all mixed in this list.
142 std::vector<ActorPtr> Host::get_all_actors() const
144 return pimpl_->get_all_actors();
147 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
148 size_t Host::get_actor_count() const
150 return pimpl_->get_actor_count();
154 * @brief Find a route toward another host
156 * @param dest [IN] where to
157 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
158 * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
159 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
161 * walk through the routing components tree and find a route between hosts
162 * by calling each "get_route" function in each routing component.
164 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
166 std::vector<kernel::resource::StandardLinkImpl*> linkImpls;
167 this->route_to(dest, linkImpls, latency);
168 for (auto* l : linkImpls)
169 links.push_back(l->get_iface());
172 /** @brief Just like Host::routeTo, but filling an array of link implementations */
173 void Host::route_to(const Host* dest, std::vector<kernel::resource::StandardLinkImpl*>& links, double* latency) const
175 kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
176 if (XBT_LOG_ISENABLED(ker_routing, xbt_log_priority_debug)) {
177 XBT_CDEBUG(ker_routing, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
178 (latency == nullptr ? -1 : *latency));
179 for (auto const* link : links)
180 XBT_CDEBUG(ker_routing, " Link '%s'", link->get_cname());
184 /** @brief Returns the networking zone englobing that host */
185 NetZone* Host::get_englobing_zone() const
187 return pimpl_netpoint_->get_englobing_zone()->get_iface();
190 /** Get the properties assigned to a host */
191 const std::unordered_map<std::string, std::string>* Host::get_properties() const
193 return this->pimpl_->get_properties();
196 /** Retrieve the property value (or nullptr if not set) */
197 const char* Host::get_property(const std::string& key) const
199 return this->pimpl_->get_property(key);
202 Host* Host::set_property(const std::string& key, const std::string& value)
204 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
208 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
210 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
214 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
215 * The profile must contain boolean values. */
216 Host* Host::set_state_profile(kernel::profile::Profile* p)
218 kernel::actor::simcall([this, p] { pimpl_cpu_->set_state_profile(p); });
221 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
223 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
224 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
225 * at this pstate level) by the rate coming from the profile.
227 Host* Host::set_speed_profile(kernel::profile::Profile* p)
229 kernel::actor::simcall([this, p] { pimpl_cpu_->set_speed_profile(p); });
233 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
234 double Host::get_pstate_speed(unsigned long pstate_index) const
236 return this->pimpl_cpu_->get_pstate_peak_speed(pstate_index);
239 double Host::get_speed() const
241 return this->pimpl_cpu_->get_speed(1.0);
243 double Host::get_load() const
245 return this->pimpl_cpu_->get_load();
247 double Host::get_available_speed() const
249 return this->pimpl_cpu_->get_speed_ratio();
252 Host* Host::set_sharing_policy(SharingPolicy policy, const s4u::NonLinearResourceCb& cb)
254 kernel::actor::simcall([this, policy, &cb] { pimpl_cpu_->set_sharing_policy(policy, cb); });
258 Host::SharingPolicy Host::get_sharing_policy() const
260 return this->pimpl_cpu_->get_sharing_policy();
263 int Host::get_core_count() const
265 return this->pimpl_cpu_->get_core_count();
268 Host* Host::set_core_count(int core_count)
270 kernel::actor::simcall([this, core_count] { this->pimpl_cpu_->set_core_count(core_count); });
274 Host* Host::set_pstate_speed(const std::vector<double>& speed_per_state)
276 kernel::actor::simcall([this, &speed_per_state] { pimpl_cpu_->set_pstate_speed(speed_per_state); });
280 std::vector<double> Host::convert_pstate_speed_vector(const std::vector<std::string>& speed_per_state)
282 std::vector<double> speed_list;
283 speed_list.reserve(speed_per_state.size());
284 for (const auto& speed_str : speed_per_state) {
286 double speed = xbt_parse_get_speed("", 0, speed_str, "");
287 speed_list.push_back(speed);
288 } catch (const simgrid::ParseError&) {
289 throw std::invalid_argument(std::string("Invalid speed value: ") + speed_str);
295 Host* Host::set_pstate_speed(const std::vector<std::string>& speed_per_state)
297 set_pstate_speed(Host::convert_pstate_speed_vector(speed_per_state));
301 /** @brief Set the pstate at which the host should run */
302 Host* Host::set_pstate(unsigned long pstate_index)
304 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu_->set_pstate(pstate_index); });
308 /** @brief Retrieve the pstate at which the host is currently running */
309 unsigned long Host::get_pstate() const
311 return this->pimpl_cpu_->get_pstate();
314 Host* Host::set_factor_cb(const std::function<CpuFactorCb>& cb)
316 kernel::actor::simcall([this, &cb] { pimpl_cpu_->set_factor_cb(cb); });
320 Host* Host::set_coordinates(const std::string& coords)
322 if (not coords.empty())
323 kernel::actor::simcall([this, coords] { this->pimpl_netpoint_->set_coordinates(coords); });
326 std::vector<Disk*> Host::get_disks() const
328 return this->pimpl_->get_disks();
331 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
333 return kernel::actor::simcall([this, &name, read_bandwidth, write_bandwidth] {
334 auto* disk = pimpl_->create_disk(name, read_bandwidth, write_bandwidth);
335 pimpl_->add_disk(disk);
340 Disk* Host::create_disk(const std::string& name, const std::string& read_bandwidth, const std::string& write_bandwidth)
344 d_read = xbt_parse_get_bandwidth("", 0, read_bandwidth, "");
345 } catch (const simgrid::ParseError&) {
346 throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
347 std::string(". Invalid read bandwidth: ") + read_bandwidth);
351 d_write = xbt_parse_get_bandwidth("", 0, write_bandwidth, "");
352 } catch (const simgrid::ParseError&) {
353 throw std::invalid_argument(std::string("Impossible to create disk: ") + name +
354 std::string(". Invalid write bandwidth: ") + write_bandwidth);
356 return create_disk(name, d_read, d_write);
359 void Host::add_disk(const Disk* disk)
361 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
364 void Host::remove_disk(const std::string& disk_name)
366 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
369 VirtualMachine* Host::create_vm(const std::string& name, int core_amount)
371 return new VirtualMachine(name, this, core_amount);
374 VirtualMachine* Host::create_vm(const std::string& name, int core_amount, size_t ramsize)
376 return new VirtualMachine(name, this, core_amount, ramsize);
379 ExecPtr Host::exec_init(double flops) const
381 return this_actor::exec_init(flops);
384 ExecPtr Host::exec_async(double flops) const
386 return this_actor::exec_async(flops);
389 void Host::execute(double flops) const
391 execute(flops, 1.0 /* priority */);
394 void Host::execute(double flops, double priority) const
396 this_actor::exec_init(flops)->set_priority(1 / priority)->vetoable_start()->wait();
401 kernel::actor::simcall([this]() { this->pimpl_->seal(); });
402 simgrid::s4u::Host::on_creation(*this); // notify the signal
407 } // namespace simgrid
409 /* **************************** Public C interface *************************** */
410 size_t sg_host_count()
412 return simgrid::s4u::Engine::get_instance()->get_host_count();
414 sg_host_t* sg_host_list()
416 const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
417 size_t host_count = e->get_host_count();
419 xbt_assert(host_count > 0, "There is no host!");
420 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
422 auto* res = xbt_new(sg_host_t, hosts.size());
423 std::copy(begin(hosts), end(hosts), res);
428 const char* sg_host_get_name(const_sg_host_t host)
430 return host->get_cname();
433 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
435 return host->extension(ext);
438 size_t sg_host_extension_create(void (*deleter)(void*))
440 return simgrid::s4u::Host::extension_create(deleter);
443 sg_host_t sg_host_by_name(const char* name)
445 return simgrid::s4u::Host::by_name_or_null(name);
448 // ========= Layering madness ==============*
450 // ========== User data Layer ==========
451 void* sg_host_get_data(const_sg_host_t host)
453 return host->get_data<void>();
455 void sg_host_set_data(sg_host_t host, void* userdata)
457 host->set_data(userdata);
460 // ========= Disk related functions ============
461 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
463 std::vector<sg_disk_t> list = host->get_disks();
464 *disk_count = list.size();
465 *disks = xbt_new(sg_disk_t, list.size());
466 std::copy(begin(list), end(list), *disks);
469 // =========== user-level functions ===============
470 // ================================================
471 /** @brief Returns the total speed of a host */
472 double sg_host_get_speed(const_sg_host_t host)
474 return host->get_speed();
477 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_host_energy.
479 * @param host host to test
480 * @param pstate_index pstate to test
481 * @return Returns the processor speed associated with pstate_index
483 double sg_host_get_pstate_speed(const_sg_host_t host, unsigned long pstate_index)
485 return host->get_pstate_speed(pstate_index);
488 /** @ingroup m_host_management
489 * @brief Return the number of cores.
492 * @return the number of cores
494 int sg_host_core_count(const_sg_host_t host)
496 return host->get_core_count();
499 double sg_host_get_available_speed(const_sg_host_t host)
501 return host->get_available_speed();
504 /** @brief Returns the number of power states for a host.
506 * See also @ref plugin_host_energy.
508 unsigned long sg_host_get_nb_pstates(const_sg_host_t host)
510 return host->get_pstate_count();
513 /** @brief Gets the pstate at which that host currently runs.
515 * See also @ref plugin_host_energy.
517 unsigned long sg_host_get_pstate(const_sg_host_t host)
519 return host->get_pstate();
521 /** @brief Sets the pstate at which that host should run.
523 * See also @ref plugin_host_energy.
525 void sg_host_set_pstate(sg_host_t host, unsigned long pstate)
527 host->set_pstate(pstate);
530 /** @ingroup m_host_management
532 * @brief Start the host if it is off
534 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_host_energy
535 * for more info on DVFS.
537 void sg_host_turn_on(sg_host_t host)
542 /** @ingroup m_host_management
544 * @brief Stop the host if it is on
546 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_host_energy
547 * for more info on DVFS.
549 void sg_host_turn_off(sg_host_t host)
554 /** @ingroup m_host_management
555 * @brief Determine if a host is up and running.
557 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_host_energy for
560 * @param host host to test
561 * @return Returns true if the host is up and running, and false if it's currently down
563 int sg_host_is_on(const_sg_host_t host)
565 return host->is_on();
568 /** @brief Get the properties of a host */
569 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
571 const std::unordered_map<std::string, std::string>* props = host->get_properties();
572 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
574 if (props == nullptr)
576 for (auto const& elm : *props) {
577 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
582 /** @ingroup m_host_management
583 * @brief Returns the value of a given host property
586 * @param name a property name
587 * @return value of a property (or nullptr if property not set)
589 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
591 return host->get_property(name);
594 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
596 host->set_property(name, value);
600 * @brief Find a route between two hosts
602 * @param from where from
604 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
606 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
608 std::vector<simgrid::s4u::Link*> vlinks;
609 from->route_to(to, vlinks, nullptr);
610 for (auto const& link : vlinks)
611 xbt_dynar_push(links, &link);
614 * @brief Find the latency of the route between two hosts
616 * @param from where from
619 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
621 std::vector<simgrid::s4u::Link*> vlinks;
623 from->route_to(to, vlinks, &res);
627 * @brief Find the bandwidth of the route between two hosts
629 * @param from where from
632 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
634 double min_bandwidth = -1.0;
636 std::vector<simgrid::s4u::Link*> vlinks;
637 from->route_to(to, vlinks, nullptr);
638 for (auto const& link : vlinks) {
639 double bandwidth = link->get_bandwidth();
640 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
641 min_bandwidth = bandwidth;
643 return min_bandwidth;
646 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
648 simgrid::s4u::Comm::sendto(from, to, byte_amount);
651 /** @brief Displays debugging information about a host */
652 void sg_host_dump(const_sg_host_t host)
654 XBT_INFO("Displaying host %s", host->get_cname());
655 XBT_INFO(" - speed: %.0f", host->get_speed());
656 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
657 const std::unordered_map<std::string, std::string>* props = host->get_properties();
659 if (not props->empty()) {
660 XBT_INFO(" - properties:");
661 for (auto const& elm : *props) {
662 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
667 /** @brief Return the list of actors attached to a host.
670 * @param whereto a dynar in which we should push actors living on that host
672 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
674 auto const actors = host->get_all_actors();
675 for (auto const& actor : actors)
676 xbt_dynar_push(whereto, &actor);
679 sg_host_t sg_host_self()
681 return simgrid::s4u::Actor::is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
684 /* needs to be public and without simcall for exceptions and logging events */
685 const char* sg_host_self_get_name()
687 const char* res = "";
688 if (not simgrid::s4u::Actor::is_maestro()) {
689 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
691 res = host->get_cname();
696 double sg_host_get_load(const_sg_host_t host)
698 return host->get_load();