1 /* Copyright (c) 2006-2019. 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/simix/smx_private.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 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 onDestruction() 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 = SIMIX_process_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 kernel::actor::ActorImpl* self = SIMIX_process_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()
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()
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(Host* dest, std::vector<Link*>& links, double* latency)
155 std::vector<kernel::resource::LinkImpl*> linkImpls;
156 this->route_to(dest, linkImpls, latency);
157 for (kernel::resource::LinkImpl* const& l : linkImpls)
158 links.push_back(&l->piface_);
161 /** @brief Just like Host::routeTo, but filling an array of link implementations */
162 void Host::route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
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::send_to(Host* dest, double byte_amount)
181 std::vector<Host*> m_host_list = {this, dest};
182 std::vector<double> flops_amount = {0, 0};
183 std::vector<double> bytes_amount = {0, byte_amount, 0, 0};
184 this_actor::parallel_execute(m_host_list, flops_amount, bytes_amount);
187 /** Get the properties assigned to a host */
188 const std::unordered_map<std::string, std::string>* Host::get_properties() const
190 return this->pimpl_->get_properties();
193 /** Retrieve the property value (or nullptr if not set) */
194 const char* Host::get_property(const std::string& key) const
196 return this->pimpl_->get_property(key);
199 void Host::set_property(const std::string& key, const std::string& value)
201 kernel::actor::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
204 void Host::set_properties(const std::map<std::string, std::string>& properties)
206 kernel::actor::simcall([this, &properties] { this->pimpl_->set_properties(properties); });
209 /** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law.
210 * The profile must contain boolean values. */
211 void Host::set_state_profile(kernel::profile::Profile* p)
213 return kernel::actor::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
215 /** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
217 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
218 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
219 * at this pstate level) by the rate coming from the profile.
221 void Host::set_speed_profile(kernel::profile::Profile* p)
223 return kernel::actor::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
226 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
227 double Host::get_pstate_speed(int pstate_index) const
229 return this->pimpl_cpu->get_pstate_peak_speed(pstate_index);
232 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
234 * The amount of flops per second available for computing depends on several things:
235 * - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
236 * computing speed you would get at another pstate)
237 * - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
238 * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
240 * The remaining speed is then shared between the executions located on this host.
241 * You can retrieve the amount of tasks currently running on this host with @ref get_load().
243 * The host may have multiple cores, and your executions may be able to use more than a single core.
245 * Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
247 double Host::get_speed() const
249 return this->pimpl_cpu->get_speed(1.0);
251 /** @brief Returns the current computation load (in flops per second)
253 * The external load (coming from an availability trace) is not taken in account.
254 * You may also be interested in the load plugin.
256 double Host::get_load() const
258 return this->pimpl_cpu->get_load();
260 /** @brief Get the available speed ratio, between 0 and 1.
262 * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
264 double Host::get_available_speed() const
266 return this->pimpl_cpu->get_speed_ratio();
269 /** @brief Returns the number of core of the processor. */
270 int Host::get_core_count() const
272 return this->pimpl_cpu->get_core_count();
275 /** @brief Set the pstate at which the host should run */
276 void Host::set_pstate(int pstate_index)
278 kernel::actor::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
280 /** @brief Retrieve the pstate at which the host is currently running */
281 int Host::get_pstate() const
283 return this->pimpl_cpu->get_pstate();
286 std::vector<Disk*> Host::get_disks() const
288 return kernel::actor::simcall([this] { return this->pimpl_->get_disks(); });
291 void Host::add_disk(Disk* disk)
293 kernel::actor::simcall([this, disk] { this->pimpl_->add_disk(disk); });
296 void Host::remove_disk(const std::string& disk_name)
298 kernel::actor::simcall([this, disk_name] { this->pimpl_->remove_disk(disk_name); });
301 * @ingroup simix_storage_management
302 * @brief Returns the list of storages attached to a host.
303 * @return a vector containing all storages attached to the host
305 std::vector<const char*> Host::get_attached_storages() const
307 return kernel::actor::simcall([this] { return this->pimpl_->get_attached_storages(); });
310 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
312 if (mounts_ == nullptr) {
313 mounts_ = new std::unordered_map<std::string, Storage*>();
314 for (auto const& m : this->pimpl_->storage_) {
315 mounts_->insert({m.first, &m.second->piface_});
321 ExecPtr Host::exec_async(double flops)
323 return this_actor::exec_init(flops);
326 void Host::execute(double flops)
328 execute(flops, 1.0 /* priority */);
331 void Host::execute(double flops, double priority)
333 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
337 } // namespace simgrid
339 /* **************************** Public C interface *************************** */
340 size_t sg_host_count()
342 return simgrid::s4u::Engine::get_instance()->get_host_count();
344 /** @brief Returns the host list
346 * Uses sg_host_count() to know the array size.
348 * @return an array of @ref sg_host_t containing all the hosts in the platform.
349 * @remark The host order in this array is generally different from the
350 * creation/declaration order in the XML platform (we use a hash table
352 * @see sg_host_count()
354 sg_host_t* sg_host_list()
356 xbt_assert(sg_host_count() > 0, "There is no host!");
357 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
359 sg_host_t* res = xbt_new(sg_host_t, hosts.size());
360 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
365 const char* sg_host_get_name(sg_host_t host)
367 return host->get_cname();
370 void* sg_host_extension_get(sg_host_t host, size_t ext)
372 return host->extension(ext);
375 size_t sg_host_extension_create(void (*deleter)(void*))
377 return simgrid::s4u::Host::extension_create(deleter);
380 sg_host_t sg_host_by_name(const char* name)
382 return simgrid::s4u::Host::by_name_or_null(name);
385 xbt_dynar_t sg_hosts_as_dynar()
387 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
389 auto last = std::remove_if(begin(list), end(list), [](const simgrid::s4u::Host* host) {
390 return not host || not host->get_netpoint() || not host->get_netpoint()->is_host();
392 std::sort(begin(list), last,
393 [](const simgrid::s4u::Host* a, const simgrid::s4u::Host* b) { return a->get_name() < b->get_name(); });
395 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
396 std::for_each(begin(list), last, [res](sg_host_t host) { xbt_dynar_push_as(res, sg_host_t, host); });
400 // ========= Layering madness ==============*
402 // ========== User data Layer ==========
403 void* sg_host_data(sg_host_t host)
405 return host->get_data();
407 void sg_host_data_set(sg_host_t host, void* userdata)
409 host->set_data(userdata);
411 void* sg_host_user(sg_host_t host) // deprecated
413 return host->get_data();
415 void sg_host_user_set(sg_host_t host, void* userdata) // deprecated
417 host->set_data(userdata);
419 void sg_host_user_destroy(sg_host_t host) // deprecated
421 host->set_data(nullptr);
424 // ========= storage related functions ============
425 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
427 xbt_assert((host != nullptr), "Invalid parameters");
428 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
429 for (auto const& elm : host->get_mounted_storages()) {
430 const char* mount_name = elm.first.c_str();
431 sg_storage_t storage = elm.second;
432 xbt_dict_set(res, mount_name, (void*)storage->get_cname());
438 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
440 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
441 std::vector<const char*> storage_vector = host->get_attached_storages();
442 for (auto const& name : storage_vector)
443 xbt_dynar_push(storage_dynar, &name);
444 return storage_dynar;
447 // =========== user-level functions ===============
448 // ================================================
449 /** @brief Returns the total speed of a host */
450 double sg_host_speed(sg_host_t host)
452 return host->get_speed();
455 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
457 * @param host host to test
458 * @param pstate_index pstate to test
459 * @return Returns the processor speed associated with pstate_index
461 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
463 return host->get_pstate_speed(pstate_index);
466 /** @ingroup m_host_management
467 * @brief Return the number of cores.
470 * @return the number of cores
472 int sg_host_core_count(sg_host_t host)
474 return host->get_core_count();
477 double sg_host_get_available_speed(sg_host_t host)
479 return host->get_available_speed();
482 /** @brief Returns the number of power states for a host.
484 * See also @ref plugin_energy.
486 int sg_host_get_nb_pstates(sg_host_t host)
488 return host->get_pstate_count();
491 /** @brief Gets the pstate at which that host currently runs.
493 * See also @ref plugin_energy.
495 int sg_host_get_pstate(sg_host_t host)
497 return host->get_pstate();
499 /** @brief Sets the pstate at which that host should run.
501 * See also @ref plugin_energy.
503 void sg_host_set_pstate(sg_host_t host, int pstate)
505 host->set_pstate(pstate);
508 /** @ingroup m_host_management
510 * @brief Start the host if it is off
512 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
513 * for more info on DVFS.
515 void sg_host_turn_on(sg_host_t host)
520 /** @ingroup m_host_management
522 * @brief Stop the host if it is on
524 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
525 * for more info on DVFS.
527 void sg_host_turn_off(sg_host_t host)
532 /** @ingroup m_host_management
533 * @brief Determine if a host is up and running.
535 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
538 * @param host host to test
539 * @return Returns true if the host is up and running, and false if it's currently down
541 int sg_host_is_on(sg_host_t host)
543 return host->is_on();
546 /** @brief Get the properties of a host */
547 xbt_dict_t sg_host_get_properties(sg_host_t host)
549 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
550 const std::unordered_map<std::string, std::string>* props = host->get_properties();
551 if (props == nullptr)
553 for (auto const& elm : *props) {
554 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()));
559 /** @ingroup m_host_management
560 * @brief Returns the value of a given host property
563 * @param name a property name
564 * @return value of a property (or nullptr if property not set)
566 const char* sg_host_get_property_value(sg_host_t host, const char* name)
568 return host->get_property(name);
571 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
573 host->set_property(name, value);
577 * @brief Find a route between two hosts
579 * @param from where from
581 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
583 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
585 std::vector<simgrid::s4u::Link*> vlinks;
586 from->route_to(to, vlinks, nullptr);
587 for (auto const& link : vlinks)
588 xbt_dynar_push(links, &link);
591 * @brief Find the latency of the route between two hosts
593 * @param from where from
596 double sg_host_route_latency(sg_host_t from, sg_host_t to)
598 std::vector<simgrid::s4u::Link*> vlinks;
600 from->route_to(to, vlinks, &res);
604 * @brief Find the bandwidth of the route between two hosts
606 * @param from where from
609 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
611 double min_bandwidth = -1.0;
613 std::vector<simgrid::s4u::Link*> vlinks;
614 from->route_to(to, vlinks, nullptr);
615 for (auto const& link : vlinks) {
616 double bandwidth = link->get_bandwidth();
617 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
618 min_bandwidth = bandwidth;
620 return min_bandwidth;
623 void sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
625 from->send_to(to, byte_amount);
628 /** @brief Displays debugging information about a host */
629 void sg_host_dump(sg_host_t host)
631 XBT_INFO("Displaying host %s", host->get_cname());
632 XBT_INFO(" - speed: %.0f", host->get_speed());
633 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
634 const std::unordered_map<std::string, std::string>* props = host->get_properties();
636 if (not props->empty()) {
637 XBT_INFO(" - properties:");
638 for (auto const& elm : *props) {
639 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
644 /** @brief Return the list of actors attached to a host.
647 * @param whereto a dynar in which we should push actors living on that host
649 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
651 auto actors = host->get_all_actors();
652 for (auto& actor : actors)
653 xbt_dynar_push(whereto, &actor);
656 sg_host_t sg_host_self()
658 simgrid::kernel::actor::ActorImpl* self = SIMIX_process_self();
659 return (self == nullptr) ? nullptr : self->get_host();
662 /* needs to be public and without simcall for exceptions and logging events */
663 const char* sg_host_self_get_name()
665 sg_host_t host = sg_host_self();
666 if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
669 return host->get_cname();
672 double sg_host_load(sg_host_t host)
674 return host->get_load();