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);
40 Host* Host::set_netpoint(kernel::routing::NetPoint* netpoint)
42 pimpl_netpoint_ = netpoint;
49 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
50 Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
54 /** @brief Fire the required callbacks and destroy the object
56 * Don't delete directly a host, call h->destroy() instead.
58 * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid
59 * object (because of the destructor order in a class hierarchy).
63 on_destruction(*this);
64 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 Host* Host::set_property(const std::string& key, const std::string& value)
203 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
207 Host* Host::set_properties(const std::unordered_map<std::string, std::string>& properties)
209 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 Host* Host::set_core_count(int core_count)
256 this->pimpl_cpu->set_core_count(core_count);
260 /** @brief Set the pstate at which the host should run */
261 void Host::set_pstate(int pstate_index)
263 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
265 /** @brief Retrieve the pstate at which the host is currently running */
266 int Host::get_pstate() const
268 return this->pimpl_cpu->get_pstate();
271 std::vector<Disk*> Host::get_disks() const
273 return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
276 Disk* Host::create_disk(const std::string& name, double read_bandwidth, double write_bandwidth)
279 this->get_netpoint()->get_englobing_zone()->get_disk_model()->create_disk(name, read_bandwidth, write_bandwidth);
280 return disk->set_host(this)->get_iface();
283 void Host::add_disk(const Disk* disk)
285 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
288 void Host::remove_disk(const std::string& disk_name)
290 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
293 ExecPtr Host::exec_init(double flops) const
295 return this_actor::exec_init(flops);
298 ExecPtr Host::exec_async(double flops) const
300 return this_actor::exec_async(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)->vetoable_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();
326 xbt_assert(host_count > 0, "There is no host!");
327 std::vector<simgrid::s4u::Host*> hosts = e->get_all_hosts();
329 sg_host_t* res = xbt_new(sg_host_t, hosts.size());
330 std::copy(begin(hosts), end(hosts), res);
335 const char* sg_host_get_name(const_sg_host_t host)
337 return host->get_cname();
340 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
342 return host->extension(ext);
345 size_t sg_host_extension_create(void (*deleter)(void*))
347 return simgrid::s4u::Host::extension_create(deleter);
350 sg_host_t sg_host_by_name(const char* name)
352 return simgrid::s4u::Host::by_name_or_null(name);
355 xbt_dynar_t sg_hosts_as_dynar() // XBT_ATTRIB_DEPRECATED_v330
357 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
359 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
360 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
362 std::sort(begin(list), last,
363 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
365 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
366 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
370 // ========= Layering madness ==============*
372 // ========== User data Layer ==========
373 void* sg_host_get_data(const_sg_host_t host)
375 return host->get_data();
377 void sg_host_set_data(sg_host_t host, void* userdata)
379 host->set_data(userdata);
381 void* sg_host_data(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
383 return sg_host_get_data(host);
385 void sg_host_data_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
387 sg_host_set_data(host, userdata);
389 void* sg_host_user(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
391 return host->get_data();
393 void sg_host_user_set(sg_host_t host, void* userdata) // XBT_ATTRIB_DEPRECATED_v328
395 host->set_data(userdata);
397 void sg_host_user_destroy(sg_host_t host) // XBT_ATTRIB_DEPRECATED_v328
399 host->set_data(nullptr);
402 // ========= Disk related functions ============
403 void sg_host_get_disks(const_sg_host_t host, unsigned int* disk_count, sg_disk_t** disks)
405 std::vector<sg_disk_t> list = host->get_disks();
406 *disk_count = list.size();
407 *disks = xbt_new(sg_disk_t, list.size());
408 std::copy(begin(list), end(list), *disks);
411 // =========== user-level functions ===============
412 // ================================================
413 /** @brief Returns the total speed of a host */
414 double sg_host_get_speed(const_sg_host_t host)
416 return host->get_speed();
419 double sg_host_speed(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
421 return sg_host_get_speed(host);
424 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
426 * @param host host to test
427 * @param pstate_index pstate to test
428 * @return Returns the processor speed associated with pstate_index
430 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
432 return host->get_pstate_speed(pstate_index);
435 /** @ingroup m_host_management
436 * @brief Return the number of cores.
439 * @return the number of cores
441 int sg_host_core_count(const_sg_host_t host)
443 return host->get_core_count();
446 double sg_host_get_available_speed(const_sg_host_t host)
448 return host->get_available_speed();
451 /** @brief Returns the number of power states for a host.
453 * See also @ref plugin_energy.
455 int sg_host_get_nb_pstates(const_sg_host_t host)
457 return host->get_pstate_count();
460 /** @brief Gets the pstate at which that host currently runs.
462 * See also @ref plugin_energy.
464 int sg_host_get_pstate(const_sg_host_t host)
466 return host->get_pstate();
468 /** @brief Sets the pstate at which that host should run.
470 * See also @ref plugin_energy.
472 void sg_host_set_pstate(sg_host_t host, int pstate)
474 host->set_pstate(pstate);
477 /** @ingroup m_host_management
479 * @brief Start the host if it is off
481 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
482 * for more info on DVFS.
484 void sg_host_turn_on(sg_host_t host)
489 /** @ingroup m_host_management
491 * @brief Stop the host if it is on
493 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
494 * for more info on DVFS.
496 void sg_host_turn_off(sg_host_t host)
501 /** @ingroup m_host_management
502 * @brief Determine if a host is up and running.
504 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
507 * @param host host to test
508 * @return Returns true if the host is up and running, and false if it's currently down
510 int sg_host_is_on(const_sg_host_t host)
512 return host->is_on();
515 /** @brief Get the properties of a host */
516 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
518 const std::unordered_map<std::string, std::string>* props = host->get_properties();
519 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
521 if (props == nullptr)
523 for (auto const& elm : *props) {
524 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
529 /** @ingroup m_host_management
530 * @brief Returns the value of a given host property
533 * @param name a property name
534 * @return value of a property (or nullptr if property not set)
536 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
538 return host->get_property(name);
541 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
543 host->set_property(name, value);
547 * @brief Find a route between two hosts
549 * @param from where from
551 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
553 void sg_host_get_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
555 std::vector<simgrid::s4u::Link*> vlinks;
556 from->route_to(to, vlinks, nullptr);
557 for (auto const& link : vlinks)
558 xbt_dynar_push(links, &link);
561 * @brief Find the latency of the route between two hosts
563 * @param from where from
566 double sg_host_get_route_latency(const_sg_host_t from, const_sg_host_t to)
568 std::vector<simgrid::s4u::Link*> vlinks;
570 from->route_to(to, vlinks, &res);
574 * @brief Find the bandwidth of the route between two hosts
576 * @param from where from
579 double sg_host_get_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
581 double min_bandwidth = -1.0;
583 std::vector<simgrid::s4u::Link*> vlinks;
584 from->route_to(to, vlinks, nullptr);
585 for (auto const& link : vlinks) {
586 double bandwidth = link->get_bandwidth();
587 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
588 min_bandwidth = bandwidth;
590 return min_bandwidth;
593 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links) // XBT_ATTRIB_DEPRECATED_v330
595 sg_host_get_route(from, to, links);
598 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
600 return sg_host_get_route_latency(from, to);
603 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to) // XBT_ATTRIB_DEPRECATED_v330
605 return sg_host_get_route_bandwidth(from, to);
608 void sg_host_sendto(sg_host_t from, sg_host_t to, double byte_amount)
610 from->sendto(to, byte_amount);
613 /** @brief Displays debugging information about a host */
614 void sg_host_dump(const_sg_host_t host)
616 XBT_INFO("Displaying host %s", host->get_cname());
617 XBT_INFO(" - speed: %.0f", host->get_speed());
618 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
619 const std::unordered_map<std::string, std::string>* props = host->get_properties();
621 if (not props->empty()) {
622 XBT_INFO(" - properties:");
623 for (auto const& elm : *props) {
624 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
629 /** @brief Return the list of actors attached to a host.
632 * @param whereto a dynar in which we should push actors living on that host
634 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
636 auto const actors = host->get_all_actors();
637 for (auto const& actor : actors)
638 xbt_dynar_push(whereto, &actor);
641 sg_host_t sg_host_self()
643 return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
646 /* needs to be public and without simcall for exceptions and logging events */
647 const char* sg_host_self_get_name()
649 const char* res = "";
650 if (not SIMIX_is_maestro()) {
651 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
653 res = host->get_cname();
658 double sg_host_get_load(const_sg_host_t host)
660 return host->get_load();
663 double sg_host_load(const_sg_host_t host) // XBT_ATTRIB_DEPRECATED_v330
665 return sg_host_get_load(host);