1 /* Copyright (c) 2004-2015. 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. */
7 #include "simgrid/s4u/host.hpp"
8 #include "src/msg/msg_private.h"
10 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
12 simgrid::xbt::Extension<simgrid::s4u::Host, simgrid::MsgHostExt> simgrid::MsgHostExt::EXTENSION_ID;
16 int sg_storage_max_file_descriptors = 1024;
18 /** @addtogroup m_host_management
19 * (#msg_host_t) and the functions for managing it.
21 * A <em>location</em> (or <em>host</em>) is any possible place where a process may run. Thus it may be represented
22 * as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
23 * communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
27 /********************************* Host **************************************/
28 /** \ingroup m_host_management
29 * \brief Finds a msg_host_t using its name.
31 * This is a name directory service
32 * \param name the name of an host.
33 * \return the corresponding host
35 msg_host_t MSG_host_by_name(const char *name)
37 return simgrid::s4u::Host::by_name_or_null(name);
40 /** \ingroup m_host_management
42 * \brief Set the user data of a #msg_host_t.
44 * This functions attach \a data to \a host if it is possible.
46 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
47 sg_host_user_set(host, data);
51 /** \ingroup m_host_management
53 * \brief Return the user data of a #msg_host_t.
55 * This functions returns the user data associated to \a host if it is possible.
57 void *MSG_host_get_data(msg_host_t host) {
58 return sg_host_user(host);
61 /** \ingroup m_host_management
63 * \brief Return the location on which the current process is executed.
65 msg_host_t MSG_host_self()
67 return MSG_process_get_host(nullptr);
70 /** \ingroup m_host_management
72 * \brief Start the host if it is off
74 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
75 * for more info on DVFS.
77 void MSG_host_on(msg_host_t host)
82 /** \ingroup m_host_management
84 * \brief Stop the host if it is on
86 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
87 * for more info on DVFS.
89 void MSG_host_off(msg_host_t host)
94 /** \ingroup m_host_management
95 * \brief Return the current number MSG hosts.
97 int MSG_get_host_number()
99 return sg_host_count();
102 /** \ingroup m_host_management
103 * \brief Return a dynar containing all the hosts declared at a given point of time
104 * \remark The host order in the returned array is generally different from the host creation/declaration order in the
105 * XML platform (we use a hash table internally)
107 xbt_dynar_t MSG_hosts_as_dynar() {
108 return sg_hosts_as_dynar();
111 /** \ingroup m_host_management
112 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
114 double MSG_host_get_speed(msg_host_t host) {
115 return host->speed();
118 /** \ingroup m_host_management
119 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
120 * Deprecated: use MSG_host_get_speed
122 double MSG_get_host_speed(msg_host_t host) {
123 XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
124 return MSG_host_get_speed(host);
127 /** \ingroup m_host_management
128 * \brief Return the number of cores.
131 * \return the number of cores
133 int MSG_host_get_core_number(msg_host_t host) {
134 return host->coreCount();
137 /** \ingroup m_host_management
138 * \brief Return the list of processes attached to an host.
141 * \return a swag with the attached processes
143 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
145 xbt_assert((host != nullptr), "Invalid parameters");
146 return host->processes();
149 /** \ingroup m_host_management
150 * \brief Returns the value of a given host property
153 * \param name a property name
154 * \return value of a property (or nullptr if property not set)
156 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
158 return static_cast<const char*>(xbt_dict_get_or_null(MSG_host_get_properties(host), name));
161 /** \ingroup m_host_management
162 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
165 * \return a dict containing the properties
167 xbt_dict_t MSG_host_get_properties(msg_host_t host)
169 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
170 return host->properties();
173 /** \ingroup m_host_management
174 * \brief Change the value of a given host property
177 * \param name a property name
178 * \param value what to change the property to
180 void MSG_host_set_property_value(msg_host_t host, const char* name, char* value)
182 xbt_dict_set(MSG_host_get_properties(host), name, value, nullptr);
185 /** @ingroup m_host_management
186 * @brief Determine if a host is up and running.
188 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
190 * @param host host to test
191 * @return Returns true if the host is up and running, and false if it's currently down
193 int MSG_host_is_on(msg_host_t host)
198 /** @ingroup m_host_management
199 * @brief Determine if a host is currently off.
201 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
203 int MSG_host_is_off(msg_host_t host)
205 return host->isOff();
208 /** \ingroup m_host_management
209 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
211 * \param host host to test
212 * \param pstate_index pstate to test
213 * \return Returns the processor speed associated with pstate_index
215 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
216 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
217 return host->getPstateSpeed(pstate_index);
220 /** \ingroup m_host_management
221 * \brief Return the current speed of the processor (in flop/s)
223 * \param host host to test
224 * \return Returns the current processor speed
226 double MSG_host_get_current_power_peak(msg_host_t host) {
227 xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
228 return host->getPstateSpeedCurrent();
231 /** \ingroup m_host_management
232 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
234 * \param host host to test
236 int MSG_host_get_nb_pstates(msg_host_t host) {
237 return sg_host_get_nb_pstates(host);
240 /** \ingroup m_host_management
241 * \brief Return the list of mount point names on an host.
243 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
245 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
247 xbt_assert((host != nullptr), "Invalid parameters");
248 return host->mountedStoragesAsDict();
251 /** \ingroup m_host_management
252 * \brief Return the list of storages attached to an host.
254 * \return a dynar containing all storages (name) attached to the host
256 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
258 xbt_assert((host != nullptr), "Invalid parameters");
259 return host->attachedStorages();
262 /** \ingroup m_host_management
263 * \brief Return the content of mounted storages on an host.
265 * \return a dict containing content (as a dict) of all storages mounted on the host
267 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
269 xbt_assert((host != nullptr), "Invalid parameters");
270 xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
271 msg_storage_t storage;
274 xbt_dict_cursor_t cursor = nullptr;
276 xbt_dict_t storage_list = host->mountedStoragesAsDict();
278 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
279 storage = static_cast<msg_storage_t>(xbt_lib_get_elm_or_null(storage_lib,storage_name));
280 xbt_dict_t content = simcall_storage_get_content(storage);
281 xbt_dict_set(contents,mount_name, content,nullptr);
283 xbt_dict_free(&storage_list);