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 double Host::get_speed() const
232 return this->pimpl_cpu->get_speed(1.0);
234 double Host::get_load() const
236 return this->pimpl_cpu->get_load();
238 double Host::get_available_speed() const
240 return this->pimpl_cpu->get_speed_ratio();
243 int Host::get_core_count() const
245 return this->pimpl_cpu->get_core_count();
248 /** @brief Set the pstate at which the host should run */
249 void Host::set_pstate(int pstate_index)
251 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
253 /** @brief Retrieve the pstate at which the host is currently running */
254 int Host::get_pstate() const
256 return this->pimpl_cpu->get_pstate();
259 std::vector<Disk*> Host::get_disks() const
261 return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
264 void Host::add_disk(Disk* disk)
266 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
269 void Host::remove_disk(const std::string& disk_name)
271 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
274 * @ingroup simix_storage_management
275 * @brief Returns the list of storages attached to a host.
276 * @return a vector containing all storages attached to the host
278 std::vector<const char*> Host::get_attached_storages() const
280 return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
283 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
285 if (mounts_ == nullptr)
286 mounts_ = pimpl_->get_mounted_storages();
291 ExecPtr Host::exec_async(double flops)
293 return this_actor::exec_init(flops);
296 void Host::execute(double flops)
298 execute(flops, 1.0 /* priority */);
301 void Host::execute(double flops, double priority)
303 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
307 } // namespace simgrid
309 /* **************************** Public C interface *************************** */
310 size_t sg_host_count()
312 return simgrid::s4u::Engine::get_instance()->get_host_count();
314 sg_host_t* sg_host_list()
316 xbt_assert(sg_host_count() > 0, "There is no host!");
317 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
319 sg_host_t* res = xbt_new(sg_host_t, hosts.size());
320 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
325 const char* sg_host_get_name(const_sg_host_t host)
327 return host->get_cname();
330 void* sg_host_extension_get(const_sg_host_t host, size_t ext)
332 return host->extension(ext);
335 size_t sg_host_extension_create(void (*deleter)(void*))
337 return simgrid::s4u::Host::extension_create(deleter);
340 sg_host_t sg_host_by_name(const char* name)
342 return simgrid::s4u::Host::by_name_or_null(name);
345 xbt_dynar_t sg_hosts_as_dynar()
347 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
349 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
350 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
352 std::sort(begin(list), last,
353 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
355 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
356 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
360 // ========= Layering madness ==============*
362 // ========== User data Layer ==========
363 void* sg_host_data(const_sg_host_t host)
365 return host->get_data();
367 void sg_host_data_set(sg_host_t host, void* userdata)
369 host->set_data(userdata);
371 void* sg_host_user(sg_host_t host) // deprecated
373 return host->get_data();
375 void sg_host_user_set(sg_host_t host, void* userdata) // deprecated
377 host->set_data(userdata);
379 void sg_host_user_destroy(sg_host_t host) // deprecated
381 host->set_data(nullptr);
384 // ========= storage related functions ============
385 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
387 xbt_assert((host != nullptr), "Invalid parameters");
388 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
389 for (auto const& elm : host->get_mounted_storages()) {
390 const char* mount_name = elm.first.c_str();
391 const simgrid::s4u::Storage* storage = elm.second;
392 xbt_dict_set(res, mount_name, (void*)storage->get_cname());
398 xbt_dynar_t sg_host_get_attached_storage_list(const_sg_host_t host)
400 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
401 std::vector<const char*> storage_vector = host->get_attached_storages();
402 for (auto const& name : storage_vector)
403 xbt_dynar_push(storage_dynar, &name);
404 return storage_dynar;
407 // =========== user-level functions ===============
408 // ================================================
409 /** @brief Returns the total speed of a host */
410 double sg_host_speed(const_sg_host_t host)
412 return host->get_speed();
415 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
417 * @param host host to test
418 * @param pstate_index pstate to test
419 * @return Returns the processor speed associated with pstate_index
421 double sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
423 return host->get_pstate_speed(pstate_index);
426 /** @ingroup m_host_management
427 * @brief Return the number of cores.
430 * @return the number of cores
432 int sg_host_core_count(const_sg_host_t host)
434 return host->get_core_count();
437 double sg_host_get_available_speed(const_sg_host_t host)
439 return host->get_available_speed();
442 /** @brief Returns the number of power states for a host.
444 * See also @ref plugin_energy.
446 int sg_host_get_nb_pstates(const_sg_host_t host)
448 return host->get_pstate_count();
451 /** @brief Gets the pstate at which that host currently runs.
453 * See also @ref plugin_energy.
455 int sg_host_get_pstate(const_sg_host_t host)
457 return host->get_pstate();
459 /** @brief Sets the pstate at which that host should run.
461 * See also @ref plugin_energy.
463 void sg_host_set_pstate(sg_host_t host, int pstate)
465 host->set_pstate(pstate);
468 /** @ingroup m_host_management
470 * @brief Start the host if it is off
472 * See also #sg_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_on(sg_host_t host)
480 /** @ingroup m_host_management
482 * @brief Stop the host if it is on
484 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
485 * for more info on DVFS.
487 void sg_host_turn_off(sg_host_t host)
492 /** @ingroup m_host_management
493 * @brief Determine if a host is up and running.
495 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
498 * @param host host to test
499 * @return Returns true if the host is up and running, and false if it's currently down
501 int sg_host_is_on(const_sg_host_t host)
503 return host->is_on();
506 /** @brief Get the properties of a host */
507 xbt_dict_t sg_host_get_properties(const_sg_host_t host)
509 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
510 const std::unordered_map<std::string, std::string>* props = host->get_properties();
511 if (props == nullptr)
513 for (auto const& elm : *props) {
514 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
519 /** @ingroup m_host_management
520 * @brief Returns the value of a given host property
523 * @param name a property name
524 * @return value of a property (or nullptr if property not set)
526 const char* sg_host_get_property_value(const_sg_host_t host, const char* name)
528 return host->get_property(name);
531 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
533 host->set_property(name, value);
537 * @brief Find a route between two hosts
539 * @param from where from
541 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
543 void sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
545 std::vector<simgrid::s4u::Link*> vlinks;
546 from->route_to(to, vlinks, nullptr);
547 for (auto const& link : vlinks)
548 xbt_dynar_push(links, &link);
551 * @brief Find the latency of the route between two hosts
553 * @param from where from
556 double sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
558 std::vector<simgrid::s4u::Link*> vlinks;
560 from->route_to(to, vlinks, &res);
564 * @brief Find the bandwidth of the route between two hosts
566 * @param from where from
569 double sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
571 double min_bandwidth = -1.0;
573 std::vector<simgrid::s4u::Link*> vlinks;
574 from->route_to(to, vlinks, nullptr);
575 for (auto const& link : vlinks) {
576 double bandwidth = link->get_bandwidth();
577 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
578 min_bandwidth = bandwidth;
580 return min_bandwidth;
583 void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
585 from->send_to(to, byte_amount);
588 /** @brief Displays debugging information about a host */
589 void sg_host_dump(const_sg_host_t host)
591 XBT_INFO("Displaying host %s", host->get_cname());
592 XBT_INFO(" - speed: %.0f", host->get_speed());
593 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
594 const std::unordered_map<std::string, std::string>* props = host->get_properties();
596 if (not props->empty()) {
597 XBT_INFO(" - properties:");
598 for (auto const& elm : *props) {
599 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
604 /** @brief Return the list of actors attached to a host.
607 * @param whereto a dynar in which we should push actors living on that host
609 void sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
611 auto const actors = host->get_all_actors();
612 for (auto const& actor : actors)
613 xbt_dynar_push(whereto, &actor);
616 sg_host_t sg_host_self()
618 return SIMIX_is_maestro() ? nullptr : simgrid::kernel::actor::ActorImpl::self()->get_host();
621 /* needs to be public and without simcall for exceptions and logging events */
622 const char* sg_host_self_get_name()
624 const char* res = "";
625 if (not SIMIX_is_maestro()) {
626 const simgrid::s4u::Host* host = simgrid::kernel::actor::ActorImpl::self()->get_host();
628 res = host->get_cname();
633 double sg_host_load(const_sg_host_t host)
635 return host->get_load();