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/surf/HostImpl.hpp"
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_host, s4u, "Logging specific to the S4U hosts");
15 XBT_LOG_EXTERNAL_CATEGORY(surf_route);
17 int USER_HOST_LEVEL = -1;
22 template class Extendable<simgrid::s4u::Host>;
27 simgrid::xbt::signal<void(Host&)> Host::on_creation;
28 simgrid::xbt::signal<void(Host&)> Host::on_destruction;
29 simgrid::xbt::signal<void(Host&)> Host::on_state_change;
30 simgrid::xbt::signal<void(Host&)> Host::on_speed_change;
32 Host::Host(std::string name) : name_(std::move(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(std::string(name_), this);
36 new simgrid::surf::HostImpl(this);
41 xbt_assert(currentlyDestroying_, "Please call h->destroy() instead of manually deleting it.");
44 if (pimpl_netpoint != nullptr) // not removed yet by a children class
45 simgrid::s4u::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
55 * onDestruction() callback receives a valid object (because of the destructor
56 * order in a class hierarchy).
60 if (not currentlyDestroying_) {
61 currentlyDestroying_ = 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 smx_actor_t self = SIMIX_process_self();
81 xbt_die("Cannot call Host::current() from the maestro context");
82 return self->get_host();
88 simgrid::simix::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 simgrid::simix::simcall([this] {
101 this->pimpl_cpu->turn_off();
102 this->pimpl_->turn_off();
104 on_state_change(*this);
109 bool Host::is_on() const
111 return this->pimpl_cpu->is_on();
114 int Host::get_pstate_count() const
116 return this->pimpl_cpu->get_pstate_count();
120 * @brief Return a copy of the list of actors that are executing on this host.
122 * Daemons and regular actors are all mixed in this list.
124 std::vector<ActorPtr> Host::get_all_actors()
126 return pimpl_->get_all_actors();
129 /** @brief Returns how many actors (daemonized or not) have been launched on this host */
130 int Host::get_actor_count()
132 return pimpl_->get_actor_count();
136 void Host::getProcesses(std::vector<ActorPtr>* list)
138 auto actors = get_all_actors();
139 for (auto& actor : actors)
140 list->push_back(actor);
144 void Host::actorList(std::vector<ActorPtr>* whereto)
146 auto actors = get_all_actors();
147 for (auto& actor : actors)
148 whereto->push_back(actor);
152 * @brief Find a route toward another host
154 * @param dest [IN] where to
155 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
156 * @param latency [OUT] where to store the latency experienced on the path (or nullptr if not interested)
157 * It is the caller responsibility to initialize latency to 0 (we add to provided route)
158 * @pre links!=nullptr
160 * walk through the routing components tree and find a route between hosts
161 * by calling each "get_route" function in each routing component.
163 void Host::route_to(Host* dest, std::vector<Link*>& links, double* latency)
165 std::vector<kernel::resource::LinkImpl*> linkImpls;
166 this->route_to(dest, linkImpls, latency);
167 for (kernel::resource::LinkImpl* const& l : linkImpls)
168 links.push_back(&l->piface_);
171 /** @brief Just like Host::routeTo, but filling an array of link implementations */
172 void Host::route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
174 simgrid::kernel::routing::NetZoneImpl::get_global_route(pimpl_netpoint, dest->pimpl_netpoint, links, latency);
175 if (XBT_LOG_ISENABLED(surf_route, xbt_log_priority_debug)) {
176 XBT_CDEBUG(surf_route, "Route from '%s' to '%s' (latency: %f):", get_cname(), dest->get_cname(),
177 (latency == nullptr ? -1 : *latency));
178 for (auto const& link : links)
179 XBT_CDEBUG(surf_route, "Link %s", link->get_cname());
183 /** Get the properties assigned to a host */
184 std::unordered_map<std::string, std::string>* Host::get_properties()
186 return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
189 /** Retrieve the property value (or nullptr if not set) */
190 const char* Host::get_property(const std::string& key) const
192 return this->pimpl_->get_property(key);
195 void Host::set_property(const std::string& key, std::string value)
197 simgrid::simix::simcall([this, key, value] { this->pimpl_->set_property(key, std::move(value)); });
199 /** Specify a profile turning the host on and off according to a exhaustive list or a stochastic law.
200 * The profile must contain boolean values. */
201 void Host::set_state_profile(kernel::profile::Profile* p)
203 return simgrid::simix::simcall([this, p] { pimpl_cpu->set_state_profile(p); });
205 /** Specify a profile modeling the external load according to a exhaustive list or a stochastic law.
207 * Each event of the profile represent a peak speed change that is due to external load. The values are given as a rate
208 * of the initial value. This means that the actual value is obtained by multiplying the initial value (the peek speed
209 * at this pstate level) by the rate coming from the profile.
211 void Host::set_speed_profile(kernel::profile::Profile* p)
213 return simgrid::simix::simcall([this, p] { pimpl_cpu->set_speed_profile(p); });
216 /** @brief Get the peak processor speed (in flops/s), at the specified pstate */
217 double Host::get_pstate_speed(int pstate_index) const
219 return simgrid::simix::simcall([this, pstate_index] { return this->pimpl_cpu->get_pstate_peak_speed(pstate_index); });
222 /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
224 * The amount of flops per second available for computing depends on several things:
225 * - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
226 * computing speed you would get at another pstate)
227 * - If you declared an external load (with @ref simgrid::surf::Cpu::set_speed_profile()), you must multiply the
228 * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
230 * The remaining speed is then shared between the executions located on this host.
231 * You can retrieve the amount of tasks currently running on this host with @ref get_load().
233 * The host may have multiple cores, and your executions may be able to use more than a single core.
235 * Finally, executions of priority 2 get twice the amount of flops than executions of priority 1.
237 double Host::get_speed() const
239 return this->pimpl_cpu->get_speed(1.0);
241 /** @brief Returns the current computation load (in flops per second)
243 * The external load (coming from an availability trace) is not taken in account.
244 * You may also be interested in the load plugin.
246 double Host::get_load() const
248 return this->pimpl_cpu->get_load();
250 /** @brief Get the available speed ratio, between 0 and 1.
252 * This accounts for external load (see @ref simgrid::surf::Cpu::set_speed_profile()).
254 double Host::get_available_speed() const
256 return this->pimpl_cpu->get_speed_ratio();
259 /** @brief Returns the number of core of the processor. */
260 int Host::get_core_count() const
262 return this->pimpl_cpu->get_core_count();
265 /** @brief Set the pstate at which the host should run */
266 void Host::set_pstate(int pstate_index)
268 simgrid::simix::simcall([this, pstate_index] { this->pimpl_cpu->set_pstate(pstate_index); });
270 /** @brief Retrieve the pstate at which the host is currently running */
271 int Host::get_pstate() const
273 return this->pimpl_cpu->get_pstate();
277 * @ingroup simix_storage_management
278 * @brief Returns the list of storages attached to a host.
279 * @return a vector containing all storages attached to the host
281 std::vector<const char*> Host::get_attached_storages() const
283 return simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
286 void Host::getAttachedStorages(std::vector<const char*>* storages)
288 std::vector<const char*> local_storages =
289 simgrid::simix::simcall([this] { return this->pimpl_->get_attached_storages(); });
290 for (auto elm : local_storages)
291 storages->push_back(elm);
294 std::unordered_map<std::string, Storage*> const& Host::get_mounted_storages()
296 if (mounts_ == nullptr) {
297 mounts_ = new std::unordered_map<std::string, Storage*>();
298 for (auto const& m : this->pimpl_->storage_) {
299 mounts_->insert({m.first, &m.second->piface_});
305 ExecPtr Host::exec_async(double flops)
307 return this_actor::exec_init(flops)->set_host(this);
310 void Host::execute(double flops)
312 execute(flops, 1.0 /* priority */);
315 void Host::execute(double flops, double priority)
317 this_actor::exec_init(flops)->set_host(this)->set_priority(1 / priority)->start()->wait();
321 } // namespace simgrid
323 /* **************************** Public C interface *************************** */
324 size_t sg_host_count()
326 return simgrid::s4u::Engine::get_instance()->get_host_count();
328 /** @brief Returns the host list
330 * Uses sg_host_count() to know the array size.
332 * @return an array of @ref sg_host_t containing all the hosts in the platform.
333 * @remark The host order in this array is generally different from the
334 * creation/declaration order in the XML platform (we use a hash table
336 * @see sg_host_count()
338 sg_host_t* sg_host_list()
340 xbt_assert(sg_host_count() > 0, "There is no host!");
341 std::vector<simgrid::s4u::Host*> hosts = simgrid::s4u::Engine::get_instance()->get_all_hosts();
343 sg_host_t* res = (sg_host_t*)malloc(sizeof(sg_host_t) * hosts.size());
344 memcpy(res, hosts.data(), sizeof(sg_host_t) * hosts.size());
349 const char* sg_host_get_name(sg_host_t host)
351 return host->get_cname();
354 void* sg_host_extension_get(sg_host_t host, size_t ext)
356 return host->extension(ext);
359 size_t sg_host_extension_create(void (*deleter)(void*))
361 return simgrid::s4u::Host::extension_create(deleter);
364 sg_host_t sg_host_by_name(const char* name)
366 return simgrid::s4u::Host::by_name_or_null(name);
369 xbt_dynar_t sg_hosts_as_dynar()
371 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), nullptr);
373 std::vector<simgrid::s4u::Host*> list = simgrid::s4u::Engine::get_instance()->get_all_hosts();
375 for (auto const& host : list) {
376 if (host && host->pimpl_netpoint && host->pimpl_netpoint->is_host())
377 xbt_dynar_push(res, &host);
379 xbt_dynar_sort(res, [](const void* pa, const void* pb) {
380 const std::string& na = (*static_cast<simgrid::s4u::Host* const*>(pa))->get_name();
381 const std::string& nb = (*static_cast<simgrid::s4u::Host* const*>(pb))->get_name();
382 return na.compare(nb);
387 // ========= Layering madness ==============*
389 // ========== User data Layer ==========
390 void* sg_host_user(sg_host_t host)
392 return host->extension(USER_HOST_LEVEL);
394 void sg_host_user_set(sg_host_t host, void* userdata)
396 host->extension_set(USER_HOST_LEVEL, userdata);
398 void sg_host_user_destroy(sg_host_t host)
400 host->extension_set(USER_HOST_LEVEL, nullptr);
403 // ========= storage related functions ============
404 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host)
406 xbt_assert((host != nullptr), "Invalid parameters");
407 xbt_dict_t res = xbt_dict_new_homogeneous(nullptr);
408 for (auto const& elm : host->get_mounted_storages()) {
409 const char* mount_name = elm.first.c_str();
410 sg_storage_t storage = elm.second;
411 xbt_dict_set(res, mount_name, (void*)storage->get_cname(), nullptr);
417 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host)
419 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
420 std::vector<const char*> storage_vector = host->get_attached_storages();
421 for (auto const& name : storage_vector)
422 xbt_dynar_push(storage_dynar, &name);
423 return storage_dynar;
426 // =========== user-level functions ===============
427 // ================================================
428 /** @brief Returns the total speed of a host */
429 double sg_host_speed(sg_host_t host)
431 return host->get_speed();
434 /** @brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref plugin_energy.
436 * @param host host to test
437 * @param pstate_index pstate to test
438 * @return Returns the processor speed associated with pstate_index
440 double sg_host_get_pstate_speed(sg_host_t host, int pstate_index)
442 return host->get_pstate_speed(pstate_index);
445 /** @ingroup m_host_management
446 * @brief Return the number of cores.
449 * @return the number of cores
451 int sg_host_core_count(sg_host_t host)
453 return host->get_core_count();
456 double sg_host_get_available_speed(sg_host_t host)
458 return host->get_available_speed();
461 /** @brief Returns the number of power states for a host.
463 * See also @ref plugin_energy.
465 int sg_host_get_nb_pstates(sg_host_t host)
467 return host->get_pstate_count();
470 /** @brief Gets the pstate at which that host currently runs.
472 * See also @ref plugin_energy.
474 int sg_host_get_pstate(sg_host_t host)
476 return host->get_pstate();
478 /** @brief Sets the pstate at which that host should run.
480 * See also @ref plugin_energy.
482 void sg_host_set_pstate(sg_host_t host, int pstate)
484 host->set_pstate(pstate);
487 /** @ingroup m_host_management
489 * @brief Start the host if it is off
491 * See also #sg_host_is_on() to test the current state of the host and @ref plugin_energy
492 * for more info on DVFS.
494 void sg_host_turn_on(sg_host_t host)
499 /** @ingroup m_host_management
501 * @brief Stop the host if it is on
503 * See also #MSG_host_is_on() to test the current state of the host and @ref plugin_energy
504 * for more info on DVFS.
506 void sg_host_turn_off(sg_host_t host)
511 /** @ingroup m_host_management
512 * @brief Determine if a host is up and running.
514 * See also #sg_host_turn_on() and #sg_host_turn_off() to switch the host ON and OFF and @ref plugin_energy for more
517 * @param host host to test
518 * @return Returns true if the host is up and running, and false if it's currently down
520 int sg_host_is_on(sg_host_t host)
522 return host->is_on();
526 int sg_host_is_off(sg_host_t host)
528 return not host->is_on();
531 /** @brief Get the properties of a host */
532 xbt_dict_t sg_host_get_properties(sg_host_t host)
534 xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
535 std::unordered_map<std::string, std::string>* props = host->get_properties();
536 if (props == nullptr)
538 for (auto const& elm : *props) {
539 xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
544 /** @ingroup m_host_management
545 * @brief Returns the value of a given host property
548 * @param name a property name
549 * @return value of a property (or nullptr if property not set)
551 const char* sg_host_get_property_value(sg_host_t host, const char* name)
553 return host->get_property(name);
556 void sg_host_set_property_value(sg_host_t host, const char* name, const char* value)
558 host->set_property(name, value);
562 * @brief Find a route between two hosts
564 * @param from where from
566 * @param links [OUT] where to store the list of links (must exist, cannot be nullptr).
568 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
570 std::vector<simgrid::s4u::Link*> vlinks;
571 from->route_to(to, vlinks, nullptr);
572 for (auto const& link : vlinks)
573 xbt_dynar_push(links, &link);
576 * @brief Find the latency of the route between two hosts
578 * @param from where from
581 double sg_host_route_latency(sg_host_t from, sg_host_t to)
583 std::vector<simgrid::s4u::Link*> vlinks;
585 from->route_to(to, vlinks, &res);
589 * @brief Find the bandwitdh of the route between two hosts
591 * @param from where from
594 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
596 double min_bandwidth = -1.0;
598 std::vector<simgrid::s4u::Link*> vlinks;
599 from->route_to(to, vlinks, nullptr);
600 for (auto const& link : vlinks) {
601 double bandwidth = link->get_bandwidth();
602 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
603 min_bandwidth = bandwidth;
605 return min_bandwidth;
608 /** @brief Displays debugging information about a host */
609 void sg_host_dump(sg_host_t host)
611 XBT_INFO("Displaying host %s", host->get_cname());
612 XBT_INFO(" - speed: %.0f", host->get_speed());
613 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
614 std::unordered_map<std::string, std::string>* props = host->get_properties();
616 if (not props->empty()) {
617 XBT_INFO(" - properties:");
618 for (auto const& elm : *props) {
619 XBT_INFO(" %s->%s", elm.first.c_str(), elm.second.c_str());
624 /** @brief Return the list of actors attached to a host.
627 * @param whereto a dynar in which we should push actors living on that host
629 void sg_host_get_actor_list(sg_host_t host, xbt_dynar_t whereto)
631 auto actors = host->get_all_actors();
632 for (auto& actor : actors)
633 xbt_dynar_push(whereto, &actor);
636 sg_host_t sg_host_self()
638 smx_actor_t process = SIMIX_process_self();
639 return (process == nullptr) ? nullptr : process->get_host();
642 double sg_host_load(sg_host_t host)
644 return host->get_load();