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 "src/simix/smx_private.hpp"
11 #include "src/surf/HostImpl.hpp"
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
16 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
18 int USER_HOST_LEVEL = -1;
22 template class Extendable<s4u::Host>;
27 xbt::signal<void(Host&)> Host::on_creation;
28 xbt::signal<void(Host&)> Host::on_destruction;
29 xbt::signal<void(Host&)> Host::on_state_change;
30 xbt::signal<void(Host&)> 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 onDestruction() 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 = SIMIX_process_self();
80 xbt_die("Cannot call Host::current() from the maestro context");
81 return self->get_host();
87 simix::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 simix::simcall([this] {
100 this->pimpl_cpu->turn_off();
101 this->pimpl_->turn_off();
103 on_state_change(*this);
108 bool Host::is_on() const
110 return this->pimpl_cpu->is_on();
113 int Host::get_pstate_count() const
115 return this->pimpl_cpu->get_pstate_count();
119 * @brief Return a copy of the list of actors that are executing on this host.
121 * Daemons and regular actors are all mixed in this list.
123 std::vector<ActorPtr> Host::get_all_actors()
125 return pimpl_->get_all_actors();
128 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
129 int Host::get_actor_count()
131 return pimpl_->get_actor_count();
135 void Host::getProcesses(std::vector<ActorPtr>* list)
137 auto actors = get_all_actors();
138 for (auto& actor : actors)
139 list->push_back(actor);
143 void Host::actorList(std::vector<ActorPtr>* whereto)
145 auto actors = get_all_actors();
146 for (auto& actor : actors)
147 whereto->push_back(actor);
151 * @brief Find a route toward another host
153 * @param dest [IN] where to
154 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
155 * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
156 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
157 * @pre links!=nullptr
159 * walk through the routing components tree and find a route between hosts
160 * by calling each "get_route" function in each routing component.
162 void Host::route_to(Host* dest, std::vector<Link*>& links, double* latency)
164 std::vector<kernel::resource::LinkImpl*> linkImpls;
165 this->route_to(dest, linkImpls, latency);
166 for (kernel::resource::LinkImpl* const& l : linkImpls)
167 links.push_back(&l->piface_);
170 /** @brief Just like Host::routeTo, but filling an array of link implementations */
171 void Host::route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
173 kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
174 if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
175 XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
176 (latency == nullptr ? -1 : *latency));
177 for (auto const& link : links)
178 XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
182 /** Get the properties assigned to a host */
183 std::unordered_map<std::string, std::string>* Host::get_properties()
185 return simix::simcall([this] { return this->pimpl_->get_properties(); });
188 /** Retrieve the property value (or nullptr if not set) */
189 const char* Host::get_property(const std::string& key) const
191 return this->pimpl_->get_property(key);
194 void Host::set_property(const std::string& key, const std::string& value)
196 simix::simcall([this, &key, &value] { this->pimpl_->set_property(key, value); });
198 /** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law.
199 * The profile must contain boolean values. */
200 void Host::set_state_profile(kernel::profile::Profile* p)
202 return simix::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
204 /** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
206 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
207 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
208 * at this pstate level) by the rate coming from the profile.
210 void Host::set_speed_profile(kernel::profile::Profile* p)
212 return simix::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
215 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
216 double Host::get_pstate_speed(int pstate_index) const
218 return simix::simcall([this, pstate_index] { return this->pimpl_cpu->get_pstate_peak_speed(pstate_index); });
221 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
223 * The amount of flops per second available for computing depends on several things:
224 * - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
225 * computing speed you would get at another pstate)
226 * - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
227 * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
229 * The remaining speed is then shared between the executions located on this host.
230 * You can retrieve the amount of tasks currently running on this host with @ref get_load().
232 * The host may have multiple cores, and your executions may be able to use more than a single core.
234 * Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
236 double Host::get_speed() const
238 return this->pimpl_cpu->get_speed(1.0);
240 /** @brief Returns the current computation load (in flops per second)
242 * The external load (coming from an availability trace) is not taken in account.
243 * You may also be interested in the load plugin.
245 double Host::get_load() const
247 return this->pimpl_cpu->get_load();
249 /** @brief Get the available speed ratio, between 0 and 1.
251 * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
253 double Host::get_available_speed() const
255 return this->pimpl_cpu->get_speed_ratio();
258 /** @brief Returns the number of core of the processor. */
259 int Host::get_core_count() const
261 return this->pimpl_cpu->get_core_count();
264 /** @brief Set the pstate at which the host should run */
265 void Host::set_pstate(int pstate_index)
267 simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
269 /** @brief Retrieve the pstate at which the host is currently running */
270 int Host::get_pstate() const
272 return this->pimpl_cpu->get_pstate();
276 * @ingroup simix_storage_management
277 * @brief Returns the list of storages attached to a host.
278 * @return a vector containing all storages attached to the host
280 std::vector<const char*> Host::get_attached_storages() const
282 return simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
285 void Host::getAttachedStorages(std::vector<const char*>* storages)
287 std::vector<const char*> local_storages = simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
288 for (auto elm : local_storages)
289 storages->push_back(elm);
292 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
294 if (mounts_ == nullptr) {
295 mounts_ = new std::unordered_map<std::string, Storage*>();
296 for (auto const& m : this->pimpl_->storage_) {
297 mounts_->insert({m.first, &m.second->piface_});
303 ExecPtr Host::exec_async(double flops)
305 return this_actor::exec_init(flops);
308 void Host::execute(double flops)
310 execute(flops, 1.0 /* priority */);
313 void Host::execute(double flops, double priority)
315 this_actor::exec_init(flops)->set_priority(1 / priority)->start()->wait();
319 } // namespace simgrid
321 /* **************************** Public C interface *************************** */
322 size_t sg_host_count()
324 return simgrid::s4u::Engine::get_instance()->get_host_count();
326 /** @brief Returns the host list
328 * Uses sg_host_count() to know the array size.
330 * @return an array of @ref sg_host_t containing all the hosts in the platform.
331 * @remark The host order in this array is generally different from the
332 * creation/declaration order in the XML platform (we use a hash table
334 * @see sg_host_count()
336 sg_host_t* sg_host_list()
338 xbt_assert(sg_host_count() > 0, "There is no host!");
339 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
341 sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
342 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
347 const char* sg_host_get_name(sg_host_t host)
349 return host->get_cname();
352 void* sg_host_extension_get(sg_host_t host, size_t ext)
354 return host->extension(ext);
357 size_t sg_host_extension_create(void (*deleter)(void*))
359 return simgrid::s4u::Host::extension_create(deleter);
362 sg_host_t sg_host_by_name(const char* name)
364 return simgrid::s4u::Host::by_name_or_null(name);
367 xbt_dynar_t sg_hosts_as_dynar()
369 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
371 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
373 for (auto const& host : list) {
374 if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
375 xbt_dynar_push(res, &host);
377 xbt_dynar_sort(res, [](const void* pa, const void* pb) {
378 const std::string& na = (*static_cast<simgrid::s4u::Host* const*>(pa))->get_name();
379 const std::string& nb = (*static_cast<simgrid::s4u::Host* const*>(pb))->get_name();
380 return na.compare(nb);
385 // ========= Layering madness ==============*
387 // ========== User data Layer ==========
388 void* sg_host_user(sg_host_t host)
390 return host->extension(USER_HOST_LEVEL);
392 void sg_host_user_set(sg_host_t host, void* userdata)
394 host->extension_set(USER_HOST_LEVEL, userdata);
396 void sg_host_user_destroy(sg_host_t host)
398 host->extension_set(USER_HOST_LEVEL, nullptr);
401 // ========= storage related functions ============
402 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
404 xbt_assert((host != nullptr), "Invalid parameters");
405 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
406 for (auto const& elm : host->get_mounted_storages()) {
407 const char* mount_name = elm.first.c_str();
408 sg_storage_t storage = elm.second;
409 xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
415 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
417 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
418 std::vector<const char*> storage_vector = host->get_attached_storages();
419 for (auto const& name : storage_vector)
420 xbt_dynar_push(storage_dynar, &name);
421 return storage_dynar;
424 // =========== user-level functions ===============
425 // ================================================
426 /** @brief Returns the total speed of a host */
427 double sg_host_speed(sg_host_t host)
429 return host->get_speed();
432 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
434 * @param host host to test
435 * @param pstate_index pstate to test
436 * @return Returns the processor speed associated with pstate_index
438 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
440 return host->get_pstate_speed(pstate_index);
443 /** @ingroup m_host_management
444 * @brief Return the number of cores.
447 * @return the number of cores
449 int sg_host_core_count(sg_host_t host)
451 return host->get_core_count();
454 double sg_host_get_available_speed(sg_host_t host)
456 return host->get_available_speed();
459 /** @brief Returns the number of power states for a host.
461 * See also @ref plugin_energy.
463 int sg_host_get_nb_pstates(sg_host_t host)
465 return host->get_pstate_count();
468 /** @brief Gets the pstate at which that host currently runs.
470 * See also @ref plugin_energy.
472 int sg_host_get_pstate(sg_host_t host)
474 return host->get_pstate();
476 /** @brief Sets the pstate at which that host should run.
478 * See also @ref plugin_energy.
480 void sg_host_set_pstate(sg_host_t host, int pstate)
482 host->set_pstate(pstate);
485 /** @ingroup m_host_management
487 * @brief Start the host if it is off
489 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
490 * for more info on DVFS.
492 void sg_host_turn_on(sg_host_t host)
497 /** @ingroup m_host_management
499 * @brief Stop the host if it is on
501 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
502 * for more info on DVFS.
504 void sg_host_turn_off(sg_host_t host)
509 /** @ingroup m_host_management
510 * @brief Determine if a host is up and running.
512 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
515 * @param host host to test
516 * @return Returns true if the host is up and running, and false if it's currently down
518 int sg_host_is_on(sg_host_t host)
520 return host->is_on();
524 int sg_host_is_off(sg_host_t host)
526 return not host->is_on();
529 /** @brief Get the properties of a host */
530 xbt_dict_t sg_host_get_properties(sg_host_t host)
532 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
533 std::unordered_map<std::string, std::string>* props = host->get_properties();
534 if (props == nullptr)
536 for (auto const& elm : *props) {
537 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
542 /** @ingroup m_host_management
543 * @brief Returns the value of a given host property
546 * @param name a property name
547 * @return value of a property (or nullptr if property not set)
549 const char* sg_host_get_property_value(sg_host_t host, const char* name)
551 return host->get_property(name);
554 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
556 host->set_property(name, value);
560 * @brief Find a route between two hosts
562 * @param from where from
564 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
566 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
568 std::vector<simgrid::s4u::Link*> vlinks;
569 from->route_to(to, vlinks, nullptr);
570 for (auto const& link : vlinks)
571 xbt_dynar_push(links, &link);
574 * @brief Find the latency of the route between two hosts
576 * @param from where from
579 double sg_host_route_latency(sg_host_t from, sg_host_t to)
581 std::vector<simgrid::s4u::Link*> vlinks;
583 from->route_to(to, vlinks, &res);
587 * @brief Find the bandwitdh of the route between two hosts
589 * @param from where from
592 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
594 double min_bandwidth = -1.0;
596 std::vector<simgrid::s4u::Link*> vlinks;
597 from->route_to(to, vlinks, nullptr);
598 for (auto const& link : vlinks) {
599 double bandwidth = link->get_bandwidth();
600 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
601 min_bandwidth = bandwidth;
603 return min_bandwidth;
606 /** @brief Displays debugging information about a host */
607 void sg_host_dump(sg_host_t host)
609 XBT_INFO("Displaying host %s", host->get_cname());
610 XBT_INFO(" - speed: %.0f", host->get_speed());
611 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
612 std::unordered_map<std::string, std::string>* props = host->get_properties();
614 if (not props->empty()) {
615 XBT_INFO(" - properties:");
616 for (auto const& elm : *props) {
617 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
622 /** @brief Return the list of actors attached to a host.
625 * @param whereto a dynar in which we should push actors living on that host
627 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
629 auto actors = host->get_all_actors();
630 for (auto& actor : actors)
631 xbt_dynar_push(whereto, &actor);
634 sg_host_t sg_host_self()
636 smx_actor_t process = SIMIX_process_self();
637 return (process == nullptr) ? nullptr : process->get_host();
640 /* needs to be public and without simcall for exceptions and logging events */
641 const char* sg_host_self_get_name()
643 sg_host_t host = sg_host_self();
644 if (host == nullptr || SIMIX_process_self() == simix_global->maestro_process)
647 return host->get_cname();
650 double sg_host_load(sg_host_t host)
652 return host->get_load();