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 "src/msg/msg_private.h"
8 #include "xbt/sysdep.h"
10 #include "simgrid/simix.h"
11 #include <simgrid/s4u/host.hpp>
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
15 /** @addtogroup m_host_management
16 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
17 * (#msg_host_t) and the functions for managing it.
19 * A <em>location</em> (or <em>host</em>) is any possible place where a process may run. Thus it may be represented
20 * as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
21 * communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
25 /********************************* Host **************************************/
26 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
28 msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
30 priv->dp_objs = xbt_dict_new();
32 priv->dp_updated_by_deleted_tasks = 0;
33 priv->is_migrating = 0;
35 priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
37 priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
38 for (int i=1023; i>=0;i--)
39 xbt_dynar_push_as(priv->file_descriptor_table, int, i);
41 sg_host_msg_set(host,priv);
46 /** \ingroup m_host_management
47 * \brief Finds a msg_host_t using its name.
49 * This is a name directory service
50 * \param name the name of an host.
51 * \return the corresponding host
53 msg_host_t MSG_host_by_name(const char *name)
55 return simgrid::s4u::Host::by_name_or_null(name);
58 /** \ingroup m_host_management
60 * \brief Set the user data of a #msg_host_t.
62 * This functions attach \a data to \a host if it is possible.
64 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
65 sg_host_user_set(host, data);
69 /** \ingroup m_host_management
71 * \brief Return the user data of a #msg_host_t.
73 * This functions returns the user data associated to \a host if it is possible.
75 void *MSG_host_get_data(msg_host_t host) {
76 return sg_host_user(host);
79 /** \ingroup m_host_management
81 * \brief Return the location on which the current process is executed.
83 msg_host_t MSG_host_self(void)
85 return MSG_process_get_host(NULL);
88 /** \ingroup m_host_management
90 * \brief Start the host if it is off
92 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
93 * for more info on DVFS.
95 void MSG_host_on(msg_host_t host)
100 /** \ingroup m_host_management
102 * \brief Stop the host if it is on
104 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
105 * for more info on DVFS.
107 void MSG_host_off(msg_host_t host)
113 * \brief Frees private data of a host (internal call only)
115 void __MSG_host_priv_free(msg_host_priv_t priv)
119 unsigned int size = xbt_dict_size(priv->dp_objs);
121 XBT_WARN("dp_objs: %u pending task?", size);
122 xbt_dict_free(&priv->dp_objs);
123 xbt_dict_free(&priv->affinity_mask_db);
124 xbt_dynar_free(&priv->file_descriptor_table);
129 /** \ingroup m_host_management
130 * \brief Return the current number MSG hosts.
132 int MSG_get_host_number(void)
134 return xbt_dict_length(host_list);
137 /** \ingroup m_host_management
138 * \brief Return a dynar containing all the hosts declared at a given point of time
139 * \remark The host order in the returned array is generally different from the host creation/declaration order in the
140 * XML platform (we use a hash table internally)
142 xbt_dynar_t MSG_hosts_as_dynar(void) {
143 return sg_hosts_as_dynar();
146 /** \ingroup m_host_management
147 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
149 double MSG_host_get_speed(msg_host_t host) {
150 return host->speed();
153 /** \ingroup m_host_management
154 * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
155 * Deprecated: use MSG_host_get_speed
157 double MSG_get_host_speed(msg_host_t host) {
158 XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
159 return MSG_host_get_speed(host);
163 /** \ingroup m_host_management
164 * \brief Return the number of cores.
167 * \return the number of cores
169 int MSG_host_get_core_number(msg_host_t host) {
170 return host->core_count();
173 /** \ingroup m_host_management
174 * \brief Return the list of processes attached to an host.
177 * \return a swag with the attached processes
179 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
181 xbt_assert((host != NULL), "Invalid parameters");
182 return host->processes();
185 /** \ingroup m_host_management
186 * \brief Returns the value of a given host property
189 * \param name a property name
190 * \return value of a property (or NULL if property not set)
192 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
194 return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
197 /** \ingroup m_host_management
198 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
201 * \return a dict containing the properties
203 xbt_dict_t MSG_host_get_properties(msg_host_t host)
205 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
206 return host->properties();
209 /** \ingroup m_host_management
210 * \brief Change the value of a given host property
213 * \param name a property name
214 * \param value what to change the property to
215 * \param free_ctn the freeing function to use to kill the value on need
217 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
218 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
221 /** @ingroup m_host_management
222 * @brief Determine if a host is up and running.
224 * 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.
226 * @param host host to test
227 * @return Returns true if the host is up and running, and false if it's currently down
229 int MSG_host_is_on(msg_host_t host)
234 /** @ingroup m_host_management
235 * @brief Determine if a host is currently off.
237 * 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.
239 int MSG_host_is_off(msg_host_t host)
241 return host->isOff();
244 /** \ingroup m_host_management
245 * \brief Set the parameters of a given host
248 * \param params a prameter object
250 void MSG_host_set_params(msg_host_t host, vm_params_t params)
252 host->setParameters(params);
255 /** \ingroup m_host_management
256 * \brief Get the parameters of a given host
259 * \param params a prameter object
261 void MSG_host_get_params(msg_host_t host, vm_params_t params)
263 host->parameters(params);
266 /** \ingroup m_host_management
267 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
269 * \param host host to test
270 * \param pstate_index pstate to test
271 * \return Returns the processor speed associated with pstate_index
273 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
274 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
275 return host->powerPeakAt(pstate_index);
278 /** \ingroup m_host_management
279 * \brief Return the current speed of the processor (in flop/s)
281 * \param host host to test
282 * \return Returns the current processor speed
284 double MSG_host_get_current_power_peak(msg_host_t host) {
285 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
286 return host->currentPowerPeak();
289 /** \ingroup m_host_management
290 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
292 * \param host host to test
294 int MSG_host_get_nb_pstates(msg_host_t host) {
295 return sg_host_get_nb_pstates(host);
298 /** \ingroup m_host_management
299 * \brief Return the list of mount point names on an host.
301 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
303 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
305 xbt_assert((host != NULL), "Invalid parameters");
306 return host->mountedStoragesAsDict();
309 /** \ingroup m_host_management
310 * \brief Return the list of storages attached to an host.
312 * \return a dynar containing all storages (name) attached to the host
314 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
316 xbt_assert((host != NULL), "Invalid parameters");
317 return host->attachedStorages();
320 /** \ingroup m_host_management
321 * \brief Return the content of mounted storages on an host.
323 * \return a dict containing content (as a dict) of all storages mounted on the host
325 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
327 xbt_assert((host != NULL), "Invalid parameters");
328 xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
329 msg_storage_t storage;
332 xbt_dict_cursor_t cursor = NULL;
334 xbt_dict_t storage_list = host->mountedStoragesAsDict();
336 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
337 storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
338 xbt_dict_t content = simcall_storage_get_content(storage);
339 xbt_dict_set(contents,mount_name, content,NULL);
341 xbt_dict_free(&storage_list);
345 int __MSG_host_get_file_descriptor_id(msg_host_t host){
346 msg_host_priv_t priv = sg_host_msg(host);
347 xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table), "Too much files are opened! Some have to be closed.");
348 return xbt_dynar_pop_as(priv->file_descriptor_table, int);
351 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
352 msg_host_priv_t priv = sg_host_msg(host);
353 xbt_dynar_push_as(priv->file_descriptor_table, int, id);