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. */
8 #include "simgrid/host.h"
9 #include <xbt/Extendable.hpp>
10 #include <simgrid/s4u/host.hpp>
12 #include "src/surf/HostImpl.hpp"
13 #include "surf/surf.h" // routing_get_network_element_type FIXME:killme
15 #include "src/simix/smx_private.hpp"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(sg_host, sd, "Logging specific to sg_hosts");
19 size_t sg_host_count()
21 return xbt_dict_length(host_list);
23 /** @brief Returns the host list
25 * Uses sg_host_count() to know the array size.
27 * \return an array of \ref sg_host_t containing all the hosts in the platform.
28 * \remark The host order in this array is generally different from the
29 * creation/declaration order in the XML platform (we use a hash table
31 * \see sg_host_count()
33 sg_host_t *sg_host_list(void) {
34 xbt_assert(sg_host_count() > 0, "There is no host!");
35 return (sg_host_t*)xbt_dynar_to_array(sg_hosts_as_dynar());
38 const char *sg_host_get_name(sg_host_t host)
40 return host->name().c_str();
43 void* sg_host_extension_get(sg_host_t host, size_t ext)
45 return host->extension(ext);
48 size_t sg_host_extension_create(void(*deleter)(void*))
50 return simgrid::s4u::Host::extension_create(deleter);
53 sg_host_t sg_host_by_name(const char *name)
55 return simgrid::s4u::Host::by_name_or_null(name);
58 sg_host_t sg_host_by_name_or_create(const char *name)
60 return simgrid::s4u::Host::by_name_or_create(name);
63 xbt_dynar_t sg_hosts_as_dynar(void)
65 xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t),NULL);
67 xbt_dict_cursor_t cursor = nullptr;
68 const char* name = nullptr;
69 simgrid::s4u::Host* host = nullptr;
70 xbt_dict_foreach(host_list, cursor, name, host)
71 if (host && host->pimpl_netcard && host->pimpl_netcard->getRcType() == SURF_NETWORK_ELEMENT_HOST)
72 xbt_dynar_push(res, &host);
76 // ========= Layering madness ==============*
78 #include "src/msg/msg_private.h" // MSG_host_priv_free. FIXME: killme by initializing that level in msg when used
79 #include "src/simix/smx_host_private.h" // SIMIX_host_destroy. FIXME: killme by initializing that level in simix when used
80 #include "src/surf/cpu_interface.hpp"
81 #include "src/surf/surf_routing.hpp"
85 MSG_HOST_LEVEL = simgrid::s4u::Host::extension_create([](void *p) {
86 __MSG_host_priv_free((msg_host_priv_t) p);
89 ROUTING_HOST_LEVEL = simgrid::s4u::Host::extension_create([](void *p) {
90 delete static_cast<simgrid::surf::NetCard*>(p);
93 SIMIX_HOST_LEVEL = simgrid::s4u::Host::extension_create(SIMIX_host_destroy);
94 USER_HOST_LEVEL = simgrid::s4u::Host::extension_create(NULL);
97 // ========== User data Layer ==========
98 void *sg_host_user(sg_host_t host) {
99 return host->extension(USER_HOST_LEVEL);
101 void sg_host_user_set(sg_host_t host, void* userdata) {
102 host->extension_set(USER_HOST_LEVEL,userdata);
104 void sg_host_user_destroy(sg_host_t host) {
105 host->extension_set(USER_HOST_LEVEL, nullptr);
108 // ========== MSG Layer ==============
109 msg_host_priv_t sg_host_msg(sg_host_t host) {
110 return (msg_host_priv_t) host->extension(MSG_HOST_LEVEL);
112 void sg_host_msg_set(sg_host_t host, msg_host_priv_t smx_host) {
113 host->extension_set(MSG_HOST_LEVEL, smx_host);
116 // ========== Simix layer =============
117 smx_host_priv_t sg_host_simix(sg_host_t host){
118 return (smx_host_priv_t) host->extension(SIMIX_HOST_LEVEL);
120 void sg_host_simix_set(sg_host_t host, smx_host_priv_t smx_host) {
121 host->extension_set(SIMIX_HOST_LEVEL, smx_host);
123 void sg_host_simix_destroy(sg_host_t host) {
124 host->extension_set(SIMIX_HOST_LEVEL, nullptr);
127 // ========= storage related functions ============
128 xbt_dict_t sg_host_get_mounted_storage_list(sg_host_t host){
129 return host->extension<simgrid::surf::HostImpl>()->getMountedStorageList();
132 xbt_dynar_t sg_host_get_attached_storage_list(sg_host_t host){
133 return host->extension<simgrid::surf::HostImpl>()->getAttachedStorageList();
137 // =========== user-level functions ===============
138 // ================================================
140 /** @brief Returns the total speed of a host
142 double sg_host_speed(sg_host_t host)
144 return host->speed();
147 double sg_host_get_available_speed(sg_host_t host){
148 return surf_host_get_available_speed(host);
150 /** @brief Returns the number of cores of a host
152 int sg_host_core_count(sg_host_t host) {
153 return host->core_count();
156 /** @brief Returns the state of a host.
157 * @return 1 if the host is active or 0 if it has crashed.
159 int sg_host_is_on(sg_host_t host) {
163 /** @brief Returns the number of power states for a host.
165 * See also @ref SURF_plugin_energy.
167 int sg_host_get_nb_pstates(sg_host_t host) {
168 return host->pstatesCount();
171 /** @brief Gets the pstate at which that host currently runs.
173 * See also @ref SURF_plugin_energy.
175 int sg_host_get_pstate(sg_host_t host) {
176 return host->pstate();
178 /** @brief Sets the pstate at which that host should run.
180 * See also @ref SURF_plugin_energy.
182 void sg_host_set_pstate(sg_host_t host,int pstate) {
183 host->setPstate(pstate);
186 /** @brief Get the properties of an host */
187 xbt_dict_t sg_host_get_properties(sg_host_t host) {
188 return host->properties();
191 /** \ingroup m_host_management
192 * \brief Returns the value of a given host property
195 * \param name a property name
196 * \return value of a property (or NULL if property not set)
198 const char *sg_host_get_property_value(sg_host_t host, const char *name)
200 return (const char*) xbt_dict_get_or_null(sg_host_get_properties(host), name);
203 /** @brief Displays debugging informations about a host */
204 void sg_host_dump(sg_host_t host)
207 xbt_dict_cursor_t cursor=NULL;
210 XBT_INFO("Displaying host %s", sg_host_get_name(host));
211 XBT_INFO(" - speed: %.0f", sg_host_speed(host));
212 XBT_INFO(" - available speed: %.2f", sg_host_get_available_speed(host));
213 props = sg_host_get_properties(host);
215 if (!xbt_dict_is_empty(props)){
216 XBT_INFO(" - properties:");
218 xbt_dict_foreach(props,cursor,key,data) {
219 XBT_INFO(" %s->%s",key,data);