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/kernel/routing/NetPoint.hpp"
7 #include "simgrid/s4u/Actor.hpp"
8 #include "simgrid/s4u/Engine.hpp"
9 #include "simgrid/s4u/Exec.hpp"
10 #include "simgrid/s4u/VirtualMachine.hpp"
11 #include "src/plugins/vm/VirtualMachineImpl.hpp"
12 #include "src/surf/HostImpl.hpp"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
18 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
22 template class xbt::Extendable<s4u::Host>;
26 xbt::signal<void(Host&)> Host::on_creation;
27 xbt::signal<void(Host const&)> Host::on_destruction;
28 xbt::signal<void(Host const&)> Host::on_state_change;
29 xbt::signal<void(Host const&)> Host::on_speed_change;
31 Host::Host(const std::string& name) : name_(name)
33 xbt_assert(Host::by_name_or_null(name_) == nullptr, "Refusing to create a second host named '%s'.", get_cname());
34 Engine::get_instance()->host_register(name_, this);
35 new surf::HostImpl(this);
40 xbt_assert(currently_destroying_, "Please call h->destroy() instead of manually deleting it.");
43 if (pimpl_netpoint_ != nullptr) // not removed yet by a children class
44 Engine::get_instance()->netpoint_unregister(pimpl_netpoint_);
49 /** @brief Fire the required callbacks and destroy the object
51 * Don't delete directly a host, call h->destroy() instead.
53 * This is cumbersome but this is the simplest solution to ensure that the onDestruction() callback receives a valid
54 * object (because of the destructor order in a class hierarchy).
58 if (not currently_destroying_) {
59 currently_destroying_ = true;
60 on_destruction(*this);
61 Engine::get_instance()->host_unregister(std::string(name_));
66 Host* Host::by_name(const std::string& name)
68 return Engine::get_instance()->host_by_name(name);
70 Host* Host::by_name_or_null(const std::string& name)
72 return Engine::get_instance()->host_by_name_or_null(name);
77 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
79 xbt_die("Cannot call Host::current() from the maestro context");
80 return self->get_host();
86 kernel::actor::simcall([this] {
87 this->pimpl_cpu->turn_on();
88 this->pimpl_->turn_on();
89 on_state_change(*this);
94 /** @brief Stop the host if it is on */
98 kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
99 kernel::actor::simcall([this, self] {
100 for (VirtualMachine* const& vm : vm::VirtualMachineImpl::allVms_)
101 if (vm->get_pm() == this) {
105 this->pimpl_cpu->turn_off();
106 this->pimpl_->turn_off(self);
108 on_state_change(*this);
113 bool Host::is_on() const
115 return this->pimpl_cpu->is_on();
118 int Host::get_pstate_count() const
120 return this->pimpl_cpu->get_pstate_count();
124 * @brief Return a copy of the list of actors that are executing on this host.
126 * Daemons and regular actors are all mixed in this list.
128 std::vector<ActorPtr> Host::get_all_actors() const
130 return pimpl_->get_all_actors();
133 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
134 int Host::get_actor_count() const
136 return pimpl_->get_actor_count();
140 * @brief Find a route toward another host
142 * @param dest [IN] where to
143 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
144 * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
145 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
146 * @pre links!=nullptr
148 * walk through the routing components tree and find a route between hosts
149 * by calling each "get_route" function in each routing component.
151 void Host::route_to(const Host* dest, std::vector<Link*>& links, double* latency) const
153 std::vector<kernel::resource::LinkImpl*> linkImpls;
154 this->route_to(dest, linkImpls, latency);
155 for (kernel::resource::LinkImpl* const& l : linkImpls)
156 links.push_back(l->get_iface());
159 /** @brief Just like Host::routeTo, but filling an array of link implementations */
160 void Host::route_to(const Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency) const
162 kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint_, dest->get_netpoint(), links, latency);
163 if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
164 XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
165 (latency == nullptr ? -1 : *latency));
166 for (auto const& link : links)
167 XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
171 /** @brief Returns the networking zone englobing that host */
172 NetZone* Host::get_englobing_zone()
174 return pimpl_netpoint_->get_englobing_zone()->get_iface();
177 void Host::send_to(Host* dest, double byte_amount)
179 std::vector<Host*> m_host_list = {this, dest};
180 std::vector<double> flops_amount = {0, 0};
181 std::vector<double> bytes_amount = {0, byte_amount, 0, 0};
182 this_actor::parallel_execute(m_host_list, flops_amount, bytes_amount);
185 /** Get the properties assigned to a host */
186 const std::unordered_map<std::string, std::string>* Host::get_properties() const
188 return this->pimpl_->get_properties();
191 /** Retrieve the property value (or nullptr if not set) */
192 const char* Host::get_property(const std::string& key) const
194 return this->pimpl_->get_property(key);
197 void Host::set_property(const std::string& key, const std::string& value)
199 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
202 void Host::set_properties(const std::map<std::string, std::string>& properties)
204 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
207 /** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law.
208 * The profile must contain boolean values. */
209 void Host::set_state_profile(kernel::profile::Profile* p)
211 return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
213 /** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
215 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
216 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
217 * at this pstate level) by the rate coming from the profile.
219 void Host::set_speed_profile(kernel::profile::Profile* p)
221 return kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
224 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
225 double Host::get_pstate_speed(int pstate_index) const
227 return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
230 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
232 * The amount of flops per second available for computing depends on several things:
233 * - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
234 * computing speed you would get at another pstate)
235 * - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
236 * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
238 * The remaining speed is then shared between the executions located on this host.
239 * You can retrieve the amount of tasks currently running on this host with @ref get_load().
241 * The host may have multiple cores, and your executions may be able to use more than a single core.
243 * Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
245 double Host::get_speed() const
247 return this->pimpl_cpu->get_speed(1.0);
249 /** @brief Returns the current computation load (in flops per second)
251 * The external load (coming from an availability trace) is not taken in account.
252 * You may also be interested in the load plugin.
254 double Host::get_load() const
256 return this->pimpl_cpu->get_load();
258 /** @brief Get the available speed ratio, between 0 and 1.
260 * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
262 double Host::get_available_speed() const
264 return this->pimpl_cpu->get_speed_ratio();
267 /** @brief Returns the number of core of the processor. */
268 int Host::get_core_count() const
270 return this->pimpl_cpu->get_core_count();
273 /** @brief Set the pstate at which the host should run */
274 void Host::set_pstate(int pstate_index)
276 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
278 /** @brief Retrieve the pstate at which the host is currently running */
279 int Host::get_pstate() const
281 return this->pimpl_cpu->get_pstate();
284 std::vector<Disk*> Host::get_disks() const
286 return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
289 void Host::add_disk(Disk* disk)
291 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
294 void Host::remove_disk(const std::string& disk_name)
296 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
299 * @ingroup simix_storage_management
300 * @brief Returns the list of storages attached to a host.
301 * @return a vector containing all storages attached to the host
303 std::vector<const char*> Host::get_attached_storages() const
305 return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
308 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
310 if (mounts_ == nullptr) {
311 mounts_ = new std::unordered_map<std::string, Storage*>();
312 for (auto const& m : this->pimpl_->storage_) {
313 mounts_->insert({m.first, m.second->get_iface()});
319 ExecPtr Host::exec_async(double flops)
321 return this_actor::exec_init(flops);
324 void Host::execute(double flops)
326 execute(flops, 1.0 /* priority */);
329 void Host::execute(double flops, double priority)
331 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
335 } // namespace simgrid
337 /* **************************** Public C interface *************************** */
338 size_t sg_host_count()
340 return simgrid::s4u::Engine::get_instance()->get_host_count();
342 /** @brief Returns the host list
344 * Uses sg_host_count() to know the array size.
346 * @return an array of @ref sg_host_t containing all the hosts in the platform.
347 * @remark The host order in this array is generally different from the
348 * creation/declaration order in the XML platform (we use a hash table
350 * @see sg_host_count()
352 sg_host_t* sg_host_list()
354 xbt_assert(sg_host_count() > 0, "There is no host!");
355 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
357 sg_host_t* res = xbt_new(sg_host_t, hosts.size());
358 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
363 const char* sg_host_get_name(const_sg_host_t host)
365 return host->get_cname();
368 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
370 return host->extension(ext);
373 size_t sg_host_extension_create(void (*deleter)(void*))
375 return simgrid::s4u::Host::extension_create(deleter);
378 sg_host_t sg_host_by_name(const char* name)
380 return simgrid::s4u::Host::by_name_or_null(name);
383 xbt_dynar_t sg_hosts_as_dynar()
385 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
387 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
388 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
390 std::sort(begin(list), last,
391 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
393 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
394 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
398 // ========= Layering madness ==============*
400 // ========== User data Layer ==========
401 void* sg_host_data(const_sg_host_t host)
403 return host->get_data();
405 void sg_host_data_set(sg_host_t host, void* userdata)
407 host->set_data(userdata);
409 void* sg_host_user(sg_host_t host) // deprecated
411 return host->get_data();
413 void sg_host_user_set(sg_host_t host, void* userdata) // deprecated
415 host->set_data(userdata);
417 void sg_host_user_destroy(sg_host_t host) // deprecated
419 host->set_data(nullptr);
422 // ========= storage related functions ============
423 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
425 xbt_assert((host != nullptr), "Invalid parameters");
426 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
427 for (auto const& elm : host->get_mounted_storages()) {
428 const char* mount_name = elm.first.c_str();
429 const simgrid::s4u::Storage* storage = elm.second;
430 xbt_dict_set(res, mount_name, (void*)storage->get_cname());
436 xbt_dynar_t sg_host_get_attached_storage_list(const_sg_host_t host)
438 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
439 std::vector<const char*> storage_vector = host->get_attached_storages();
440 for (auto const& name : storage_vector)
441 xbt_dynar_push(storage_dynar, &name);
442 return storage_dynar;
445 // =========== user-level functions ===============
446 // ================================================
447 /** @brief Returns the total speed of a host */
448 double sg_host_speed(const_sg_host_t host)
450 return host->get_speed();
453 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
455 * @param host host to test
456 * @param pstate_index pstate to test
457 * @return Returns the processor speed associated with pstate_index
459 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
461 return host->get_pstate_speed(pstate_index);
464 /** @ingroup m_host_management
465 * @brief Return the number of cores.
468 * @return the number of cores
470 int sg_host_core_count(const_sg_host_t host)
472 return host->get_core_count();
475 double sg_host_get_available_speed(const_sg_host_t host)
477 return host->get_available_speed();
480 /** @brief Returns the number of power states for a host.
482 * See also @ref plugin_energy.
484 int sg_host_get_nb_pstates(const_sg_host_t host)
486 return host->get_pstate_count();
489 /** @brief Gets the pstate at which that host currently runs.
491 * See also @ref plugin_energy.
493 int sg_host_get_pstate(const_sg_host_t host)
495 return host->get_pstate();
497 /** @brief Sets the pstate at which that host should run.
499 * See also @ref plugin_energy.
501 void sg_host_set_pstate(sg_host_t host, int pstate)
503 host->set_pstate(pstate);
506 /** @ingroup m_host_management
508 * @brief Start the host if it is off
510 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
511 * for more info on DVFS.
513 void sg_host_turn_on(sg_host_t host)
518 /** @ingroup m_host_management
520 * @brief Stop the host if it is on
522 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
523 * for more info on DVFS.
525 void sg_host_turn_off(sg_host_t host)
530 /** @ingroup m_host_management
531 * @brief Determine if a host is up and running.
533 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
536 * @param host host to test
537 * @return Returns true if the host is up and running, and false if it's currently down
539 int sg_host_is_on(const_sg_host_t host)
541 return host->is_on();
544 /** @brief Get the properties of a host */
545 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
547 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
548 const std::unordered_map<std::string, std::string>* props = host->get_properties();
549 if (props == nullptr)
551 for (auto const& elm : *props) {
552 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
557 /** @ingroup m_host_management
558 * @brief Returns the value of a given host property
561 * @param name a property name
562 * @return value of a property (or nullptr if property not set)
564 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
566 return host->get_property(name);
569 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
571 host->set_property(name, value);
575 * @brief Find a route between two hosts
577 * @param from where from
579 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
581 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
583 std::vector<simgrid::s4u::Link*> vlinks;
584 from->route_to(to, vlinks, nullptr);
585 for (auto const& link : vlinks)
586 xbt_dynar_push(links, &link);
589 * @brief Find the latency of the route between two hosts
591 * @param from where from
594 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
596 std::vector<simgrid::s4u::Link*> vlinks;
598 from->route_to(to, vlinks, &res);
602 * @brief Find the bandwidth of the route between two hosts
604 * @param from where from
607 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
609 double min_bandwidth = -1.0;
611 std::vector<simgrid::s4u::Link*> vlinks;
612 from->route_to(to, vlinks, nullptr);
613 for (auto const& link : vlinks) {
614 double bandwidth = link->get_bandwidth();
615 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
616 min_bandwidth = bandwidth;
618 return min_bandwidth;
621 void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
623 from->send_to(to, byte_amount);
626 /** @brief Displays debugging information about a host */
627 void sg_host_dump(const_sg_host_t host)
629 XBT_INFO("Displaying host %s", host->get_cname());
630 XBT_INFO(" - speed: %.0f", host->get_speed());
631 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
632 const std::unordered_map<std::string, std::string>* props = host->get_properties();
634 if (not props->empty()) {
635 XBT_INFO(" - properties:");
636 for (auto const& elm : *props) {
637 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
642 /** @brief Return the list of actors attached to a host.
645 * @param whereto a dynar in which we should push actors living on that host
647 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
649 auto const actors = host->get_all_actors();
650 for (auto const& actor : actors)
651 xbt_dynar_push(whereto, &actor);
654 sg_host_t sg_host_self()
656 return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
659 /* needs to be public and without simcall for exceptions and logging events */
660 const char* sg_host_self_get_name()
662 const char* res = "";
663 if (not SIMIX_is_maestro()) {
664 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
666 res = host->get_cname();
671 double sg_host_load(const_sg_host_t host)
673 return host->get_load();