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_);
51 /** @brief Fire the required callbacks and destroy the object
53 * Don't delete directly a host, call h->destroy() instead.
55 * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
56 * object (because of the destructor order in a class hierarchy).
60 if (not currently_destroying_) {
61 currently_destroying_ = true;
62 on_destruction(*this);
63 Engine::get_instance()->host_unregister(std::string(name_));
68 Host* Host::by_name(const std::string& name)
70 return Engine::get_instance()->host_by_name(name);
72 Host* Host::by_name_or_null(const std::string& name)
74 return Engine::get_instance()->host_by_name_or_null(name);
79 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
81 xbt_die("Cannot call Host::current() from the maestro context");
82 return self->get_host();
88 kernel::actor::simcall([this] {
89 this->pimpl_cpu->turn_on();
90 this->pimpl_->turn_on();
91 on_state_change(*this);
96 /** @brief Stop the host if it is on */
100 const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
101 kernel::actor::simcall([this, self] {
102 for (VirtualMachine* const& vm : vm::VirtualMachineImpl::allVms_)
103 if (vm->get_pm() == this) {
107 this->pimpl_cpu->turn_off();
108 this->pimpl_->turn_off(self);
110 on_state_change(*this);
115 bool Host::is_on() const
117 return this->pimpl_cpu->is_on();
120 int Host::get_pstate_count() const
122 return this->pimpl_cpu->get_pstate_count();
126 * @brief Return a copy of the list of actors that are executing on this host.
128 * Daemons and regular actors are all mixed in this list.
130 std::vector<ActorPtr> Host::get_all_actors() const
132 return pimpl_->get_all_actors();
135 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
136 int Host::get_actor_count() const
138 return pimpl_->get_actor_count();
142 * @brief Find a route toward another host
144 * @param dest [IN] where to
145 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
146 * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
147 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
148 * @pre links!=nullptr
150 * walk through the routing components tree and find a route between hosts
151 * by calling each "get_route" function in each routing component.
153 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
155 std::vector<kernel::resource::LinkImpl*> linkImpls;
156 this->route_to(dest, linkImpls, latency);
157 for (auto* l : linkImpls)
158 links.push_back(l->get_iface());
161 /** @brief Just like Host::routeTo, but filling an array of link implementations */
162 void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const
164 kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
165 if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
166 XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
167 (latency == nullptr ? -1 : *latency));
168 for (auto const* link : links)
169 XBT_CDEBUG(surf_route, " Link '%s'", link->get_cname());
173 /** @brief Returns the networking zone englobing that host */
174 NetZone* Host::get_englobing_zone()
176 return pimpl_netpoint_->get_englobing_zone()->get_iface();
179 void Host::sendto(Host* dest, double byte_amount)
181 sendto_async(dest, byte_amount)->wait();
184 CommPtr Host::sendto_async(Host* dest, double byte_amount)
186 return Comm::sendto_async(this, dest, byte_amount);
189 /** Get the properties assigned to a host */
190 const std::unordered_map<std::string, std::string>* Host::get_properties() const
192 return this->pimpl_->get_properties();
195 /** Retrieve the property value (or nullptr if not set) */
196 const char* Host::get_property(const std::string& key) const
198 return this->pimpl_->get_property(key);
201 void Host::set_property(const std::string& key, const std::string& value)
203 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
206 void Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
208 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
211 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
212 * The profile must contain boolean values. */
213 void Host::set_state_profile(kernel::profile::Profile* p)
215 return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
217 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
219 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
220 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
221 * at this pstate level) by the rate coming from the profile.
223 void Host::set_speed_profile(kernel::profile::Profile* p)
225 return kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
228 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
229 double Host::get_pstate_speed(int pstate_index) const
231 return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
234 double Host::get_speed() const
236 return this->pimpl_cpu->get_speed(1.0);
238 double Host::get_load() const
240 return this->pimpl_cpu->get_load();
242 double Host::get_available_speed() const
244 return this->pimpl_cpu->get_speed_ratio();
247 int Host::get_core_count() const
249 return this->pimpl_cpu->get_core_count();
252 /** @brief Set the pstate at which the host should run */
253 void Host::set_pstate(int pstate_index)
255 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
257 /** @brief Retrieve the pstate at which the host is currently running */
258 int Host::get_pstate() const
260 return this->pimpl_cpu->get_pstate();
263 std::vector<Disk*> Host::get_disks() const
265 return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
268 void Host::add_disk(const Disk* disk)
270 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
273 void Host::remove_disk(const std::string& disk_name)
275 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
278 * @ingroup simix_storage_management
279 * @brief Returns the list of storages attached to a host.
280 * @return a vector containing all storages attached to the host
282 std::vector<const char*> Host::get_attached_storages() const
284 return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
287 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
289 kernel::actor::simcall([this] {
290 if (mounts_ == nullptr)
291 mounts_ = pimpl_->get_mounted_storages();
296 ExecPtr Host::exec_async(double flops) const
298 return this_actor::exec_init(flops);
301 void Host::execute(double flops) const
303 execute(flops, 1.0 /* priority */);
306 void Host::execute(double flops, double priority) const
308 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
312 } // namespace simgrid
314 /* **************************** Public C interface *************************** */
315 size_t sg_host_count()
317 return simgrid::s4u::Engine::get_instance()->get_host_count();
319 sg_host_t* sg_host_list()
321 const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
322 size_t host_count = e->get_host_count();
323 xbt_assert(host_count > 0, "There is no host!");
324 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
326 sg_host_t* res = xbt_new(sg_host_t, hosts.size());
327 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
332 const char* sg_host_get_name(const_sg_host_t host)
334 return host->get_cname();
337 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
339 return host->extension(ext);
342 size_t sg_host_extension_create(void (*deleter)(void*))
344 return simgrid::s4u::Host::extension_create(deleter);
347 sg_host_t sg_host_by_name(const char* name)
349 return simgrid::s4u::Host::by_name_or_null(name);
352 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
354 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
356 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
357 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
359 std::sort(begin(list), last,
360 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
362 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
363 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
367 // ========= Layering madness ==============*
369 // ========== User data Layer ==========
370 void* sg_host_get_data(const_sg_host_t host)
372 return host->get_data();
374 void sg_host_set_data(sg_host_t host, void* userdata)
376 host->set_data(userdata);
378 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
380 return sg_host_get_data(host);
382 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
384 sg_host_set_data(host, userdata);
386 void* sg_host_user(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
388 return host->get_data();
390 void sg_host_user_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v328
392 host->set_data(userdata);
394 void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
396 host->set_data(nullptr);
399 // ========= storage related functions ============
400 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
402 std::vector<sg_disk_t> list = host->get_disks();
403 *disk_count = list.size();
404 *disks = static_cast<sg_disk_t*>(xbt_malloc(sizeof(sg_disk_t) * (*disk_count)));
405 for (size_t i = 0; i < *disk_count; i++)
406 (*disks)[i] = list[i];
409 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
411 xbt_assert((host != nullptr), "Invalid parameters");
412 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
413 for (auto const& elm : host->get_mounted_storages()) {
414 const char* mount_name = elm.first.c_str();
415 const simgrid::s4u::Storage* storage = elm.second;
416 xbt_dict_set(res, mount_name, (void*)storage->get_cname());
422 xbt_dynar_t sg_host_get_attached_storage_list(const_sg_host_t host)
424 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
425 std::vector<const char*> storage_vector = host->get_attached_storages();
426 for (auto const& name : storage_vector)
427 xbt_dynar_push(storage_dynar, &name);
428 return storage_dynar;
431 // =========== user-level functions ===============
432 // ================================================
433 /** @brief Returns the total speed of a host */
434 double sg_host_get_speed(const_sg_host_t host)
436 return host->get_speed();
439 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
441 return sg_host_get_speed(host);
444 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
446 * @param host host to test
447 * @param pstate_index pstate to test
448 * @return Returns the processor speed associated with pstate_index
450 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
452 return host->get_pstate_speed(pstate_index);
455 /** @ingroup m_host_management
456 * @brief Return the number of cores.
459 * @return the number of cores
461 int sg_host_core_count(const_sg_host_t host)
463 return host->get_core_count();
466 double sg_host_get_available_speed(const_sg_host_t host)
468 return host->get_available_speed();
471 /** @brief Returns the number of power states for a host.
473 * See also @ref plugin_energy.
475 int sg_host_get_nb_pstates(const_sg_host_t host)
477 return host->get_pstate_count();
480 /** @brief Gets the pstate at which that host currently runs.
482 * See also @ref plugin_energy.
484 int sg_host_get_pstate(const_sg_host_t host)
486 return host->get_pstate();
488 /** @brief Sets the pstate at which that host should run.
490 * See also @ref plugin_energy.
492 void sg_host_set_pstate(sg_host_t host, int pstate)
494 host->set_pstate(pstate);
497 /** @ingroup m_host_management
499 * @brief Start the host if it is off
501 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
502 * for more info on DVFS.
504 void sg_host_turn_on(sg_host_t host)
509 /** @ingroup m_host_management
511 * @brief Stop the host if it is on
513 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
514 * for more info on DVFS.
516 void sg_host_turn_off(sg_host_t host)
521 /** @ingroup m_host_management
522 * @brief Determine if a host is up and running.
524 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
527 * @param host host to test
528 * @return Returns true if the host is up and running, and false if it's currently down
530 int sg_host_is_on(const_sg_host_t host)
532 return host->is_on();
535 /** @brief Get the properties of a host */
536 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
538 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
539 const std::unordered_map<std::string, std::string>* props = host->get_properties();
540 if (props == nullptr)
542 for (auto const& elm : *props) {
543 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
548 /** @ingroup m_host_management
549 * @brief Returns the value of a given host property
552 * @param name a property name
553 * @return value of a property (or nullptr if property not set)
555 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
557 return host->get_property(name);
560 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
562 host->set_property(name, value);
566 * @brief Find a route between two hosts
568 * @param from where from
570 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
572 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
574 std::vector<simgrid::s4u::Link*> vlinks;
575 from->route_to(to, vlinks, nullptr);
576 for (auto const& link : vlinks)
577 xbt_dynar_push(links, &link);
580 * @brief Find the latency of the route between two hosts
582 * @param from where from
585 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
587 std::vector<simgrid::s4u::Link*> vlinks;
589 from->route_to(to, vlinks, &res);
593 * @brief Find the bandwidth of the route between two hosts
595 * @param from where from
598 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
600 double min_bandwidth = -1.0;
602 std::vector<simgrid::s4u::Link*> vlinks;
603 from->route_to(to, vlinks, nullptr);
604 for (auto const& link : vlinks) {
605 double bandwidth = link->get_bandwidth();
606 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
607 min_bandwidth = bandwidth;
609 return min_bandwidth;
612 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
614 sg_host_get_route(from, to, links);
617 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
619 return sg_host_get_route_latency(from, to);
622 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
624 return sg_host_get_route_bandwidth(from, to);
627 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
629 from->sendto(to, byte_amount);
632 /** @brief Displays debugging information about a host */
633 void sg_host_dump(const_sg_host_t host)
635 XBT_INFO("Displaying host %s", host->get_cname());
636 XBT_INFO(" - speed: %.0f", host->get_speed());
637 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
638 const std::unordered_map<std::string, std::string>* props = host->get_properties();
640 if (not props->empty()) {
641 XBT_INFO(" - properties:");
642 for (auto const& elm : *props) {
643 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
648 /** @brief Return the list of actors attached to a host.
651 * @param whereto a dynar in which we should push actors living on that host
653 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
655 auto const actors = host->get_all_actors();
656 for (auto const& actor : actors)
657 xbt_dynar_push(whereto, &actor);
660 sg_host_t sg_host_self()
662 return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
665 /* needs to be public and without simcall for exceptions and logging events */
666 const char* sg_host_self_get_name()
668 const char* res = "";
669 if (not SIMIX_is_maestro()) {
670 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
672 res = host->get_cname();
677 double sg_host_get_load(const_sg_host_t host)
679 return host->get_load();
682 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
684 return sg_host_get_load(host);