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/host.h"
7 #include "simgrid/kernel/routing/NetPoint.hpp"
8 #include "simgrid/s4u/Actor.hpp"
9 #include "simgrid/s4u/Comm.hpp"
10 #include "simgrid/s4u/Engine.hpp"
11 #include "simgrid/s4u/Exec.hpp"
12 #include "simgrid/s4u/VirtualMachine.hpp"
13 #include "src/plugins/vm/VirtualMachineImpl.hpp"
14 #include "src/surf/HostImpl.hpp"
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
20 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
24 template class xbt::Extendable<s4u::Host>;
28 xbt::signal<void(Host&)> Host::on_creation;
29 xbt::signal<void(Host const&)> Host::on_destruction;
30 xbt::signal<void(Host const&)> Host::on_state_change;
31 xbt::signal<void(Host const&)> Host::on_speed_change;
33 Host::Host(const std::string& name) : name_(name)
35 xbt_assert(Host::by_name_or_null(name_) == nullptr, "Refusing to create a second host named '%s'.", get_cname());
36 Engine::get_instance()->host_register(name_, this);
37 new surf::HostImpl(this);
42 xbt_assert(currently_destroying_, "Please call h->destroy() instead of manually deleting it.");
45 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
46 Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
50 /** @brief Fire the required callbacks and destroy the object
52 * Don't delete directly a host, call h->destroy() instead.
54 * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
55 * object (because of the destructor order in a class hierarchy).
59 if (not currently_destroying_) {
60 currently_destroying_ = true;
61 on_destruction(*this);
62 Engine::get_instance()->host_unregister(std::string(name_));
67 Host* Host::by_name(const std::string& name)
69 return Engine::get_instance()->host_by_name(name);
71 Host* Host::by_name_or_null(const std::string& name)
73 return Engine::get_instance()->host_by_name_or_null(name);
78 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
80 xbt_die("Cannot call Host::current() from the maestro context");
81 return self->get_host();
87 kernel::actor::simcall([this] {
88 this->pimpl_cpu->turn_on();
89 this->pimpl_->turn_on();
90 on_state_change(*this);
95 /** @brief Stop the host if it is on */
99 const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
100 kernel::actor::simcall([this, self] {
101 for (VirtualMachine* const& vm : vm::VirtualMachineImpl::allVms_)
102 if (vm->get_pm() == this) {
106 this->pimpl_cpu->turn_off();
107 this->pimpl_->turn_off(self);
109 on_state_change(*this);
114 bool Host::is_on() const
116 return this->pimpl_cpu->is_on();
119 int Host::get_pstate_count() const
121 return this->pimpl_cpu->get_pstate_count();
125 * @brief Return a copy of the list of actors that are executing on this host.
127 * Daemons and regular actors are all mixed in this list.
129 std::vector<ActorPtr> Host::get_all_actors() const
131 return pimpl_->get_all_actors();
134 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
135 int Host::get_actor_count() const
137 return pimpl_->get_actor_count();
141 * @brief Find a route toward another host
143 * @param dest [IN] where to
144 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
145 * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
146 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
147 * @pre links!=nullptr
149 * walk through the routing components tree and find a route between hosts
150 * by calling each "get_route" function in each routing component.
152 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
154 std::vector<kernel::resource::LinkImpl*> linkImpls;
155 this->route_to(dest, linkImpls, latency);
156 for (auto* l : linkImpls)
157 links.push_back(l->get_iface());
160 /** @brief Just like Host::routeTo, but filling an array of link implementations */
161 void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const
163 kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
164 if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
165 XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
166 (latency == nullptr ? -1 : *latency));
167 for (auto const* link : links)
168 XBT_CDEBUG(surf_route, " Link '%s'", link->get_cname());
172 /** @brief Returns the networking zone englobing that host */
173 NetZone* Host::get_englobing_zone()
175 return pimpl_netpoint_->get_englobing_zone()->get_iface();
178 void Host::sendto(Host* dest, double byte_amount)
180 sendto_async(dest, byte_amount)->wait();
183 CommPtr Host::sendto_async(Host* dest, double byte_amount)
185 return Comm::sendto_async(this, dest, byte_amount);
188 /** Get the properties assigned to a host */
189 const std::unordered_map<std::string, std::string>* Host::get_properties() const
191 return this->pimpl_->get_properties();
194 /** Retrieve the property value (or nullptr if not set) */
195 const char* Host::get_property(const std::string& key) const
197 return this->pimpl_->get_property(key);
200 void Host::set_property(const std::string& key, const std::string& value)
202 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
205 void Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
207 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
210 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
211 * The profile must contain boolean values. */
212 void Host::set_state_profile(kernel::profile::Profile* p)
214 return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
216 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
218 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
219 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
220 * at this pstate level) by the rate coming from the profile.
222 void Host::set_speed_profile(kernel::profile::Profile* p)
224 return kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
227 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
228 double Host::get_pstate_speed(int pstate_index) const
230 return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
233 double Host::get_speed() const
235 return this->pimpl_cpu->get_speed(1.0);
237 double Host::get_load() const
239 return this->pimpl_cpu->get_load();
241 double Host::get_available_speed() const
243 return this->pimpl_cpu->get_speed_ratio();
246 int Host::get_core_count() const
248 return this->pimpl_cpu->get_core_count();
251 /** @brief Set the pstate at which the host should run */
252 void Host::set_pstate(int pstate_index)
254 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
256 /** @brief Retrieve the pstate at which the host is currently running */
257 int Host::get_pstate() const
259 return this->pimpl_cpu->get_pstate();
262 std::vector<Disk*> Host::get_disks() const
264 return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
267 void Host::add_disk(const Disk* disk)
269 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
272 void Host::remove_disk(const std::string& disk_name)
274 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
277 ExecPtr Host::exec_async(double flops) const
279 return this_actor::exec_init(flops);
282 void Host::execute(double flops) const
284 execute(flops, 1.0 /* priority */);
287 void Host::execute(double flops, double priority) const
289 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
293 } // namespace simgrid
295 /* **************************** Public C interface *************************** */
296 size_t sg_host_count()
298 return simgrid::s4u::Engine::get_instance()->get_host_count();
300 sg_host_t* sg_host_list()
302 const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
303 size_t host_count = e->get_host_count();
304 xbt_assert(host_count > 0, "There is no host!");
305 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
307 sg_host_t* res = xbt_new(sg_host_t, hosts.size());
308 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
313 const char* sg_host_get_name(const_sg_host_t host)
315 return host->get_cname();
318 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
320 return host->extension(ext);
323 size_t sg_host_extension_create(void (*deleter)(void*))
325 return simgrid::s4u::Host::extension_create(deleter);
328 sg_host_t sg_host_by_name(const char* name)
330 return simgrid::s4u::Host::by_name_or_null(name);
333 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
335 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
337 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
338 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
340 std::sort(begin(list), last,
341 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
343 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
344 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
348 // ========= Layering madness ==============*
350 // ========== User data Layer ==========
351 void* sg_host_get_data(const_sg_host_t host)
353 return host->get_data();
355 void sg_host_set_data(sg_host_t host, void* userdata)
357 host->set_data(userdata);
359 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
361 return sg_host_get_data(host);
363 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
365 sg_host_set_data(host, userdata);
367 void* sg_host_user(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
369 return host->get_data();
371 void sg_host_user_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v328
373 host->set_data(userdata);
375 void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
377 host->set_data(nullptr);
380 // ========= Disk related functions ============
381 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
383 std::vector<sg_disk_t> list = host->get_disks();
384 *disk_count = list.size();
385 *disks = static_cast<sg_disk_t*>(xbt_malloc(sizeof(sg_disk_t) * (*disk_count)));
386 for (size_t i = 0; i < *disk_count; i++)
387 (*disks)[i] = list[i];
390 // =========== user-level functions ===============
391 // ================================================
392 /** @brief Returns the total speed of a host */
393 double sg_host_get_speed(const_sg_host_t host)
395 return host->get_speed();
398 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
400 return sg_host_get_speed(host);
403 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
405 * @param host host to test
406 * @param pstate_index pstate to test
407 * @return Returns the processor speed associated with pstate_index
409 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
411 return host->get_pstate_speed(pstate_index);
414 /** @ingroup m_host_management
415 * @brief Return the number of cores.
418 * @return the number of cores
420 int sg_host_core_count(const_sg_host_t host)
422 return host->get_core_count();
425 double sg_host_get_available_speed(const_sg_host_t host)
427 return host->get_available_speed();
430 /** @brief Returns the number of power states for a host.
432 * See also @ref plugin_energy.
434 int sg_host_get_nb_pstates(const_sg_host_t host)
436 return host->get_pstate_count();
439 /** @brief Gets the pstate at which that host currently runs.
441 * See also @ref plugin_energy.
443 int sg_host_get_pstate(const_sg_host_t host)
445 return host->get_pstate();
447 /** @brief Sets the pstate at which that host should run.
449 * See also @ref plugin_energy.
451 void sg_host_set_pstate(sg_host_t host, int pstate)
453 host->set_pstate(pstate);
456 /** @ingroup m_host_management
458 * @brief Start the host if it is off
460 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
461 * for more info on DVFS.
463 void sg_host_turn_on(sg_host_t host)
468 /** @ingroup m_host_management
470 * @brief Stop the host if it is on
472 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
473 * for more info on DVFS.
475 void sg_host_turn_off(sg_host_t host)
480 /** @ingroup m_host_management
481 * @brief Determine if a host is up and running.
483 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
486 * @param host host to test
487 * @return Returns true if the host is up and running, and false if it's currently down
489 int sg_host_is_on(const_sg_host_t host)
491 return host->is_on();
494 /** @brief Get the properties of a host */
495 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
497 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
498 const std::unordered_map<std::string, std::string>* props = host->get_properties();
499 if (props == nullptr)
501 for (auto const& elm : *props) {
502 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
507 /** @ingroup m_host_management
508 * @brief Returns the value of a given host property
511 * @param name a property name
512 * @return value of a property (or nullptr if property not set)
514 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
516 return host->get_property(name);
519 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
521 host->set_property(name, value);
525 * @brief Find a route between two hosts
527 * @param from where from
529 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
531 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
533 std::vector<simgrid::s4u::Link*> vlinks;
534 from->route_to(to, vlinks, nullptr);
535 for (auto const& link : vlinks)
536 xbt_dynar_push(links, &link);
539 * @brief Find the latency of the route between two hosts
541 * @param from where from
544 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
546 std::vector<simgrid::s4u::Link*> vlinks;
548 from->route_to(to, vlinks, &res);
552 * @brief Find the bandwidth of the route between two hosts
554 * @param from where from
557 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
559 double min_bandwidth = -1.0;
561 std::vector<simgrid::s4u::Link*> vlinks;
562 from->route_to(to, vlinks, nullptr);
563 for (auto const& link : vlinks) {
564 double bandwidth = link->get_bandwidth();
565 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
566 min_bandwidth = bandwidth;
568 return min_bandwidth;
571 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
573 sg_host_get_route(from, to, links);
576 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
578 return sg_host_get_route_latency(from, to);
581 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
583 return sg_host_get_route_bandwidth(from, to);
586 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
588 from->sendto(to, byte_amount);
591 /** @brief Displays debugging information about a host */
592 void sg_host_dump(const_sg_host_t host)
594 XBT_INFO("Displaying host %s", host->get_cname());
595 XBT_INFO(" - speed: %.0f", host->get_speed());
596 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
597 const std::unordered_map<std::string, std::string>* props = host->get_properties();
599 if (not props->empty()) {
600 XBT_INFO(" - properties:");
601 for (auto const& elm : *props) {
602 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
607 /** @brief Return the list of actors attached to a host.
610 * @param whereto a dynar in which we should push actors living on that host
612 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
614 auto const actors = host->get_all_actors();
615 for (auto const& actor : actors)
616 xbt_dynar_push(whereto, &actor);
619 sg_host_t sg_host_self()
621 return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
624 /* needs to be public and without simcall for exceptions and logging events */
625 const char* sg_host_self_get_name()
627 const char* res = "";
628 if (not SIMIX_is_maestro()) {
629 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
631 res = host->get_cname();
636 double sg_host_get_load(const_sg_host_t host)
638 return host->get_load();
641 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
643 return sg_host_get_load(host);