1 /* Copyright (c) 2013-2016. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "simgrid/host.h"
11 #include <xbt/Extendable.hpp>
12 #include <simgrid/s4u/host.hpp>
14 #include "src/kernel/routing/NetPoint.hpp"
15 #include "src/simix/smx_host_private.h"
16 #include "src/surf/HostImpl.hpp"
17 #include "src/surf/cpu_interface.hpp"
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sg_host, sd, "Logging specific to sg_hosts");
21 // FIXME: The following duplicates the content of s4u::Host
24 extern std::map<std::string, simgrid::s4u::Host*> host_list;
32 /* copy all names to not modify the map while iterating over it.
34 * Plus, the hosts are destroyed in the lexicographic order to ensure
35 * that the output is reproducible: we don't want to kill them in the
36 * pointer order as it could be platform-dependent, which would break
39 std::vector<std::string> names = std::vector<std::string>();
40 for (auto kv : simgrid::s4u::host_list)
41 names.push_back(kv.second->name());
43 std::sort(names.begin(), names.end());
45 for (auto name : names)
46 simgrid::s4u::host_list.at(name)->destroy();
48 // host_list.clear(); This would be sufficient if the dict would contain smart_ptr. It's now useless
51 size_t sg_host_count()
53 return simgrid::s4u::host_list.size();
55 /** @brief Returns the host list
57 * Uses sg_host_count() to know the array size.
59 * \return an array of \ref sg_host_t containing all the hosts in the platform.
60 * \remark The host order in this array is generally different from the
61 * creation/declaration order in the XML platform (we use a hash table
63 * \see sg_host_count()
65 sg_host_t *sg_host_list() {
66 xbt_assert(sg_host_count() > 0, "There is no host!");
67 return (sg_host_t*)xbt_dynar_to_array(sg_hosts_as_dynar());
70 const char *sg_host_get_name(sg_host_t host)
75 void* sg_host_extension_get(sg_host_t host, size_t ext)
77 return host->extension(ext);
80 size_t sg_host_extension_create(void(*deleter)(void*))
82 return simgrid::s4u::Host::extension_create(deleter);
85 sg_host_t sg_host_by_name(const char *name)
87 return simgrid::s4u::Host::by_name_or_null(name);
90 static int hostcmp_voidp(const void* pa, const void* pb)
92 return strcmp((*static_cast<simgrid::s4u::Host* const*>(pa))->cname(),
93 (*static_cast<simgrid::s4u::Host* const*>(pb))->cname());
96 xbt_dynar_t sg_hosts_as_dynar()
98 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t),nullptr);
100 for (auto kv : simgrid::s4u::host_list) {
101 simgrid::s4u::Host* host = kv.second;
102 if (host && host->pimpl_netpoint && host->pimpl_netpoint->isHost())
103 xbt_dynar_push(res, &host);
105 xbt_dynar_sort(res, hostcmp_voidp);
109 // ========= Layering madness ==============*
111 // ========== User data Layer ==========
112 void *sg_host_user(sg_host_t host) {
113 return host->extension(USER_HOST_LEVEL);
115 void sg_host_user_set(sg_host_t host, void* userdata) {
116 host->extension_set(USER_HOST_LEVEL,userdata);
118 void sg_host_user_destroy(sg_host_t host) {
119 host->extension_set(USER_HOST_LEVEL, nullptr);
122 // ========= storage related functions ============
123 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host){
124 return host->pimpl_->getMountedStorageList();
127 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host){
128 std::vector<const char*>* storage_vector = new std::vector<const char*>();
129 xbt_dynar_t storage_dynar = xbt_dynar_new(sizeof(const char*), nullptr);
130 host->attachedStorages(storage_vector);
131 for (auto name : *storage_vector)
132 xbt_dynar_push(storage_dynar, &name);
133 delete storage_vector;
134 return storage_dynar;
137 // =========== user-level functions ===============
138 // ================================================
139 /** @brief Returns the total speed of a host */
140 double sg_host_speed(sg_host_t host)
142 return host->speed();
145 double sg_host_get_available_speed(sg_host_t host)
147 return host->pimpl_cpu->getAvailableSpeed();
150 /** @brief Returns the number of power states for a host.
152 * See also @ref SURF_plugin_energy.
154 int sg_host_get_nb_pstates(sg_host_t host) {
155 return host->pstatesCount();
158 /** @brief Gets the pstate at which that host currently runs.
160 * See also @ref SURF_plugin_energy.
162 int sg_host_get_pstate(sg_host_t host) {
163 return host->pstate();
165 /** @brief Sets the pstate at which that host should run.
167 * See also @ref SURF_plugin_energy.
169 void sg_host_set_pstate(sg_host_t host,int pstate) {
170 host->setPstate(pstate);
173 /** @brief Get the properties of an host */
174 xbt_dict_t sg_host_get_properties(sg_host_t host) {
175 return host->properties();
178 /** \ingroup m_host_management
179 * \brief Returns the value of a given host property
182 * \param name a property name
183 * \return value of a property (or nullptr if property not set)
185 const char *sg_host_get_property_value(sg_host_t host, const char *name)
187 return (const char*) xbt_dict_get_or_null(sg_host_get_properties(host), name);
190 * \brief Find a route between two hosts
192 * \param from where from
194 * \param links [OUT] where to store the list of links (must exist, cannot be nullptr).
196 void sg_host_route(sg_host_t from, sg_host_t to, xbt_dynar_t links)
198 std::vector<simgrid::s4u::Link*> vlinks;
199 from->routeTo(to, &vlinks, nullptr);
200 for (auto link : vlinks)
201 xbt_dynar_push(links, &link);
204 * \brief Find the latency of the route between two hosts
206 * \param from where from
209 double sg_host_route_latency(sg_host_t from, sg_host_t to)
211 std::vector<simgrid::s4u::Link*> vlinks;
213 from->routeTo(to, &vlinks, &res);
217 * \brief Find the bandwitdh of the route between two hosts
219 * \param from where from
222 double sg_host_route_bandwidth(sg_host_t from, sg_host_t to)
224 double min_bandwidth = -1.0;
226 std::vector<simgrid::s4u::Link*> vlinks;
227 from->routeTo(to, &vlinks, nullptr);
228 for (auto link : vlinks) {
229 double bandwidth = link->bandwidth();
230 if (bandwidth < min_bandwidth || min_bandwidth < 0.0)
231 min_bandwidth = bandwidth;
233 return min_bandwidth;
236 /** @brief Displays debugging information about a host */
237 void sg_host_dump(sg_host_t host)
240 xbt_dict_cursor_t cursor=nullptr;
243 XBT_INFO("Displaying host %s", host->cname());
244 XBT_INFO(" - speed: %.0f", host->speed());
245 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
246 props = host->properties();
248 if (!xbt_dict_is_empty(props)){
249 XBT_INFO(" - properties:");
251 xbt_dict_foreach(props,cursor,key,data) {
252 XBT_INFO(" %s->%s",key,data);