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 "src/msg/msg_mailbox.h"
9 #include "xbt/sysdep.h"
11 #include "simgrid/simix.h"
12 #include <simgrid/s4u/host.hpp>
14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
16 /** @addtogroup m_host_management
17 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
18 * (#msg_host_t) and the functions for managing it.
20 * A <em>location</em> (or <em>host</em>) is any possible place where
21 * a process may run. Thus it may be represented as a
22 * <em>physical resource with computing capabilities</em>, some
23 * <em>mailboxes</em> to enable running process to communicate with
24 * remote ones, and some <em>private data</em> that can be only
25 * accessed by local process.
29 /********************************* Host **************************************/
30 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
32 msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
34 #ifdef MSG_USE_DEPRECATED
36 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
38 priv->mailboxes = (msg_global->max_channel > 0) ?
39 xbt_new0(msg_mailbox_t, msg_global->max_channel) : NULL;
41 for (i = 0; i < msg_global->max_channel; i++) {
42 sprintf(alias, "%s:%d", name, i);
44 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
45 priv->mailboxes[i] = MSG_mailbox_new(alias);
46 memset(alias, 0, MAX_ALIAS_NAME + 1);
51 priv->dp_objs = xbt_dict_new();
53 priv->dp_updated_by_deleted_tasks = 0;
54 priv->is_migrating = 0;
56 priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
58 priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
59 for (int i=1023; i>=0;i--)
60 xbt_dynar_push_as(priv->file_descriptor_table, int, i);
62 sg_host_msg_set(host,priv);
67 /** \ingroup m_host_management
68 * \brief Finds a msg_host_t using its name.
70 * This is a name directory service
71 * \param name the name of an host.
72 * \return the corresponding host
74 msg_host_t MSG_host_by_name(const char *name)
76 return simgrid::s4u::Host::by_name_or_null(name);
79 /** \ingroup m_host_management
81 * \brief Set the user data of a #msg_host_t.
83 * This functions checks whether some data has already been associated to \a host
84 or not and attach \a data to \a host if it is possible.
86 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
87 sg_host_user_set(host, data);
91 /** \ingroup m_host_management
93 * \brief Return the user data of a #msg_host_t.
95 * This functions checks whether \a host is a valid pointer or not and return
96 the user data associated to \a host if it is possible.
98 void *MSG_host_get_data(msg_host_t host) {
99 return sg_host_user(host);
102 /** \ingroup m_host_management
104 * \brief Return the location on which the current process is executed.
106 msg_host_t MSG_host_self(void)
108 return MSG_process_get_host(NULL);
112 /** \ingroup m_host_management
114 * \brief Start the host if it is off
116 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
118 void MSG_host_on(msg_host_t host)
123 /** \ingroup m_host_management
125 * \brief Stop the host if it is on
127 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
129 void MSG_host_off(msg_host_t host)
135 * \brief Frees private data of a host (internal call only)
137 void __MSG_host_priv_free(msg_host_priv_t priv)
142 unsigned int size = xbt_dict_size(priv->dp_objs);
144 XBT_WARN("dp_objs: %u pending task?", size);
145 xbt_dict_free(&priv->dp_objs);
146 xbt_dict_free(&priv->affinity_mask_db);
147 xbt_dynar_free(&priv->file_descriptor_table);
148 #ifdef MSG_USE_DEPRECATED
149 free(priv->mailboxes);
155 /** \ingroup m_host_management
156 * \brief Return the current number MSG hosts.
158 int MSG_get_host_number(void)
160 return xbt_dict_length(host_list);
163 #ifdef MSG_USE_DEPRECATED
164 msg_host_t *MSG_get_host_table(void)
166 if (xbt_dict_is_empty(host_list))
169 void **array = xbt_new0(void *, xbt_dict_length(host_list));
171 xbt_lib_cursor_t cursor;
173 simgrid::s4u::Host* host;
174 xbt_dict_foreach(host_list, cursor, id, host)
175 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
176 array[i++] = host->facet(MSG_HOST_LEVEL);
178 return (msg_host_t *)array;
182 /** \ingroup m_host_management
183 * \brief Return a dynar containing all the hosts declared at a given point of time
184 * \remark The host order in the returned array is generally different from the host creation/declaration order in the XML platform (we use a hash table internally)
186 xbt_dynar_t MSG_hosts_as_dynar(void) {
187 return sg_hosts_as_dynar();
190 /** \ingroup m_host_management
191 * \brief Return the speed of the processor (in flop/s), regardless of
192 the current load on the machine.
194 double MSG_get_host_speed(msg_host_t host) {
195 return host->speed();
199 /** \ingroup m_host_management
200 * \brief Return the number of cores.
203 * \return the number of cores
205 int MSG_host_get_core_number(msg_host_t host) {
206 return host->core_count();
209 /** \ingroup m_host_management
210 * \brief Return the list of processes attached to an host.
213 * \return a swag with the attached processes
215 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
217 xbt_assert((host != NULL), "Invalid parameters");
218 return host->processes();
222 /** \ingroup m_host_management
223 * \brief Returns the value of a given host property
226 * \param name a property name
227 * \return value of a property (or NULL if property not set)
229 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
231 return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
234 /** \ingroup m_host_management
235 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
238 * \return a dict containing the properties
240 xbt_dict_t MSG_host_get_properties(msg_host_t host)
242 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
243 return host->properties();
246 /** \ingroup m_host_management
247 * \brief Change the value of a given host property
250 * \param name a property name
251 * \param value what to change the property to
252 * \param free_ctn the freeing function to use to kill the value on need
254 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
256 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
260 /** @ingroup m_host_management
262 * @brief Determine if a host is up and running.
264 * 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.
266 * @param host host to test
267 * @return Returns true if the host is up and running, and false if it's currently down
269 int MSG_host_is_on(msg_host_t host)
271 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
272 return sg_host_is_on(host);
274 /** @ingroup m_host_management
276 * @brief Determine if a host is currently off.
278 * 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.
280 int MSG_host_is_off(msg_host_t host)
282 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
283 return !(sg_host_is_on(host));
286 /** \ingroup m_host_management
287 * \brief Set the parameters of a given host
290 * \param params a prameter object
292 void MSG_host_set_params(msg_host_t host, vm_params_t params)
294 host->set_parameters(params);
297 /** \ingroup m_host_management
298 * \brief Get the parameters of a given host
301 * \param params a prameter object
303 void MSG_host_get_params(msg_host_t host, vm_params_t params)
305 host->get_parameters(params);
308 /** \ingroup m_host_management
309 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
311 * \param host host to test
312 * \param pstate_index pstate to test
313 * \return Returns the processor speed associated with pstate_index
315 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
316 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
317 return host->power_peak_at(pstate_index);
320 /** \ingroup m_host_management
321 * \brief Return the current speed of the processor (in flop/s)
323 * \param host host to test
324 * \return Returns the current processor speed
326 double MSG_host_get_current_power_peak(msg_host_t host) {
327 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
328 return host->current_power_peak();
331 /** \ingroup m_host_management
332 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
334 * \param host host to test
336 int MSG_host_get_nb_pstates(msg_host_t host) {
337 return sg_host_get_nb_pstates(host);
340 /** \ingroup m_host_management
341 * \brief Return the list of mount point names on an host.
343 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
345 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
347 xbt_assert((host != NULL), "Invalid parameters");
348 return host->mounted_storages_as_dict();
351 /** \ingroup m_host_management
352 * \brief Return the list of storages attached to an host.
354 * \return a dynar containing all storages (name) attached to the host
356 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
358 xbt_assert((host != NULL), "Invalid parameters");
359 return host->attached_storages();
362 /** \ingroup m_host_management
363 * \brief Return the content of mounted storages on an host.
365 * \return a dict containing content (as a dict) of all storages mounted on the host
367 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
369 xbt_assert((host != NULL), "Invalid parameters");
370 xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
371 msg_storage_t storage;
374 xbt_dict_cursor_t cursor = NULL;
376 xbt_dict_t storage_list = host->mounted_storages_as_dict();
378 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
379 storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
380 xbt_dict_t content = simcall_storage_get_content(storage);
381 xbt_dict_set(contents,mount_name, content,NULL);
383 xbt_dict_free(&storage_list);
387 int __MSG_host_get_file_descriptor_id(msg_host_t host){
388 msg_host_priv_t priv = sg_host_msg(host);
389 xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
390 "Too much files are opened! Some have to be closed.");
391 return xbt_dynar_pop_as(priv->file_descriptor_table, int);
394 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
395 msg_host_priv_t priv = sg_host_msg(host);
396 xbt_dynar_push_as(priv->file_descriptor_table, int, id);