1 /* Copyright (c) 2006-2020. 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/Engine.hpp"
10 #include "simgrid/s4u/Exec.hpp"
11 #include "simgrid/s4u/VirtualMachine.hpp"
12 #include "src/plugins/vm/VirtualMachineImpl.hpp"
13 #include "src/surf/HostImpl.hpp"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
19 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
23 template class xbt::Extendable<s4u::Host>;
27 xbt::signal<void(Host&)> Host::on_creation;
28 xbt::signal<void(Host const&)> Host::on_destruction;
29 xbt::signal<void(Host const&)> Host::on_state_change;
30 xbt::signal<void(Host const&)> Host::on_speed_change;
32 Host::Host(const std::string& name) : name_(name)
34 xbt_assert(Host::by_name_or_null(name_) == nullptr, "Refusing to create a second host named '%s'.", get_cname());
35 Engine::get_instance()->host_register(name_, this);
36 new surf::HostImpl(this);
41 xbt_assert(currently_destroying_, "Please call h->destroy() instead of manually deleting it.");
44 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
45 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 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 ActivityPtr Host::sendto_async(Host* dest, double byte_amount)
185 std::vector<Host*> m_host_list = {this, dest};
186 std::vector<double> flops_amount = {0, 0};
187 std::vector<double> bytes_amount = {0, byte_amount, 0, 0};
188 return this_actor::exec_init(m_host_list, flops_amount, bytes_amount)->start();
191 /** Get the properties assigned to a host */
192 const std::unordered_map<std::string, std::string>* Host::get_properties() const
194 return this->pimpl_->get_properties();
197 /** Retrieve the property value (or nullptr if not set) */
198 const char* Host::get_property(const std::string& key) const
200 return this->pimpl_->get_property(key);
203 void Host::set_property(const std::string& key, const std::string& value)
205 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
208 void Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
210 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
213 /** Specify a profile turning the host on and off according to an exhaustive list or a stochastic law.
214 * The profile must contain boolean values. */
215 void Host::set_state_profile(kernel::profile::Profile* p)
217 return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
219 /** Specify a profile modeling the external load according to an exhaustive list or a stochastic law.
221 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
222 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
223 * at this pstate level) by the rate coming from the profile.
225 void Host::set_speed_profile(kernel::profile::Profile* p)
227 return kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
230 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
231 double Host::get_pstate_speed(int pstate_index) const
233 return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
236 double Host::get_speed() const
238 return this->pimpl_cpu->get_speed(1.0);
240 double Host::get_load() const
242 return this->pimpl_cpu->get_load();
244 double Host::get_available_speed() const
246 return this->pimpl_cpu->get_speed_ratio();
249 int Host::get_core_count() const
251 return this->pimpl_cpu->get_core_count();
254 /** @brief Set the pstate at which the host should run */
255 void Host::set_pstate(int pstate_index)
257 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
259 /** @brief Retrieve the pstate at which the host is currently running */
260 int Host::get_pstate() const
262 return this->pimpl_cpu->get_pstate();
265 std::vector<Disk*> Host::get_disks() const
267 return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
270 void Host::add_disk(Disk* disk)
272 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
275 void Host::remove_disk(const std::string& disk_name)
277 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
280 * @ingroup simix_storage_management
281 * @brief Returns the list of storages attached to a host.
282 * @return a vector containing all storages attached to the host
284 std::vector<const char*> Host::get_attached_storages() const
286 return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
289 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
291 kernel::actor::simcall([this] {
292 if (mounts_ == nullptr)
293 mounts_ = pimpl_->get_mounted_storages();
298 ExecPtr Host::exec_async(double flops) const
300 return this_actor::exec_init(flops);
303 void Host::execute(double flops) const
305 execute(flops, 1.0 /* priority */);
308 void Host::execute(double flops, double priority) const
310 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
314 } // namespace simgrid
316 /* **************************** Public C interface *************************** */
317 size_t sg_host_count()
319 return simgrid::s4u::Engine::get_instance()->get_host_count();
321 sg_host_t* sg_host_list()
323 const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
324 size_t host_count = e->get_host_count();
325 xbt_assert(host_count > 0, "There is no host!");
326 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
328 sg_host_t* res = xbt_new(sg_host_t, hosts.size());
329 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
334 const char* sg_host_get_name(const_sg_host_t host)
336 return host->get_cname();
339 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
341 return host->extension(ext);
344 size_t sg_host_extension_create(void (*deleter)(void*))
346 return simgrid::s4u::Host::extension_create(deleter);
349 sg_host_t sg_host_by_name(const char* name)
351 return simgrid::s4u::Host::by_name_or_null(name);
354 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
356 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
358 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
359 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
361 std::sort(begin(list), last,
362 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
364 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
365 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
369 // ========= Layering madness ==============*
371 // ========== User data Layer ==========
372 void* sg_host_get_data(const_sg_host_t host)
374 return host->get_data();
376 void sg_host_set_data(sg_host_t host, void* userdata)
378 host->set_data(userdata);
380 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
382 return sg_host_get_data(host);
384 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
386 sg_host_set_data(host, userdata);
388 void* sg_host_user(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
390 return host->get_data();
392 void sg_host_user_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v328
394 host->set_data(userdata);
396 void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
398 host->set_data(nullptr);
401 // ========= storage related functions ============
402 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
404 std::vector<sg_disk_t> list = host->get_disks();
405 *disk_count = list.size();
406 *disks = static_cast<sg_disk_t*>(xbt_malloc(sizeof(sg_disk_t) * (*disk_count)));
407 for (size_t i = 0; i < *disk_count; i++)
408 (*disks)[i] = list[i];
411 void sg_host_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks) // XBT_ATTRIB_DEPRECATED_v330
413 sg_host_get_disks(host, disk_count, disks);
416 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
418 xbt_assert((host != nullptr), "Invalid parameters");
419 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
420 for (auto const& elm : host->get_mounted_storages()) {
421 const char* mount_name = elm.first.c_str();
422 const simgrid::s4u::Storage* storage = elm.second;
423 xbt_dict_set(res, mount_name, (void*)storage->get_cname());
429 xbt_dynar_t sg_host_get_attached_storage_list(const_sg_host_t host)
431 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
432 std::vector<const char*> storage_vector = host->get_attached_storages();
433 for (auto const& name : storage_vector)
434 xbt_dynar_push(storage_dynar, &name);
435 return storage_dynar;
438 // =========== user-level functions ===============
439 // ================================================
440 /** @brief Returns the total speed of a host */
441 double sg_host_get_speed(const_sg_host_t host)
443 return host->get_speed();
446 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
448 return sg_host_get_speed(host);
451 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
453 * @param host host to test
454 * @param pstate_index pstate to test
455 * @return Returns the processor speed associated with pstate_index
457 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
459 return host->get_pstate_speed(pstate_index);
462 /** @ingroup m_host_management
463 * @brief Return the number of cores.
466 * @return the number of cores
468 int sg_host_core_count(const_sg_host_t host)
470 return host->get_core_count();
473 double sg_host_get_available_speed(const_sg_host_t host)
475 return host->get_available_speed();
478 /** @brief Returns the number of power states for a host.
480 * See also @ref plugin_energy.
482 int sg_host_get_nb_pstates(const_sg_host_t host)
484 return host->get_pstate_count();
487 /** @brief Gets the pstate at which that host currently runs.
489 * See also @ref plugin_energy.
491 int sg_host_get_pstate(const_sg_host_t host)
493 return host->get_pstate();
495 /** @brief Sets the pstate at which that host should run.
497 * See also @ref plugin_energy.
499 void sg_host_set_pstate(sg_host_t host, int pstate)
501 host->set_pstate(pstate);
504 /** @ingroup m_host_management
506 * @brief Start the host if it is off
508 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
509 * for more info on DVFS.
511 void sg_host_turn_on(sg_host_t host)
516 /** @ingroup m_host_management
518 * @brief Stop the host if it is on
520 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
521 * for more info on DVFS.
523 void sg_host_turn_off(sg_host_t host)
528 /** @ingroup m_host_management
529 * @brief Determine if a host is up and running.
531 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
534 * @param host host to test
535 * @return Returns true if the host is up and running, and false if it's currently down
537 int sg_host_is_on(const_sg_host_t host)
539 return host->is_on();
542 /** @brief Get the properties of a host */
543 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
545 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
546 const std::unordered_map<std::string, std::string>* props = host->get_properties();
547 if (props == nullptr)
549 for (auto const& elm : *props) {
550 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
555 /** @ingroup m_host_management
556 * @brief Returns the value of a given host property
559 * @param name a property name
560 * @return value of a property (or nullptr if property not set)
562 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
564 return host->get_property(name);
567 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
569 host->set_property(name, value);
573 * @brief Find a route between two hosts
575 * @param from where from
577 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
579 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
581 std::vector<simgrid::s4u::Link*> vlinks;
582 from->route_to(to, vlinks, nullptr);
583 for (auto const& link : vlinks)
584 xbt_dynar_push(links, &link);
587 * @brief Find the latency of the route between two hosts
589 * @param from where from
592 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
594 std::vector<simgrid::s4u::Link*> vlinks;
596 from->route_to(to, vlinks, &res);
600 * @brief Find the bandwidth of the route between two hosts
602 * @param from where from
605 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
607 double min_bandwidth = -1.0;
609 std::vector<simgrid::s4u::Link*> vlinks;
610 from->route_to(to, vlinks, nullptr);
611 for (auto const& link : vlinks) {
612 double bandwidth = link->get_bandwidth();
613 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
614 min_bandwidth = bandwidth;
616 return min_bandwidth;
619 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
621 sg_host_get_route(from, to, links);
624 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
626 return sg_host_get_route_latency(from, to);
629 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
631 return sg_host_get_route_bandwidth(from, to);
634 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
636 from->sendto(to, byte_amount);
639 /** @brief Displays debugging information about a host */
640 void sg_host_dump(const_sg_host_t host)
642 XBT_INFO("Displaying host %s", host->get_cname());
643 XBT_INFO(" - speed: %.0f", host->get_speed());
644 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
645 const std::unordered_map<std::string, std::string>* props = host->get_properties();
647 if (not props->empty()) {
648 XBT_INFO(" - properties:");
649 for (auto const& elm : *props) {
650 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
655 /** @brief Return the list of actors attached to a host.
658 * @param whereto a dynar in which we should push actors living on that host
660 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
662 auto const actors = host->get_all_actors();
663 for (auto const& actor : actors)
664 xbt_dynar_push(whereto, &actor);
667 sg_host_t sg_host_self()
669 return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
672 /* needs to be public and without simcall for exceptions and logging events */
673 const char* sg_host_self_get_name()
675 const char* res = "";
676 if (not SIMIX_is_maestro()) {
677 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
679 res = host->get_cname();
684 double sg_host_get_load(const_sg_host_t host)
686 return host->get_load();
689 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
691 return sg_host_get_load(host);