1 /* Copyright (c) 2004-2014. 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 "msg/msg_private.h"
8 #include "msg/msg_mailbox.h"
9 #include "xbt/sysdep.h"
11 #include "simgrid/simix.h"
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
20 * a process may run. Thus it may be represented as a
21 * <em>physical resource with computing capabilities</em>, some
22 * <em>mailboxes</em> to enable running process to communicate with
23 * remote ones, and some <em>private data</em> that can be only
24 * accessed by local process.
28 /********************************* Host **************************************/
29 msg_host_t __MSG_host_create(smx_host_t workstation)
31 const char *name = SIMIX_host_get_name(workstation);
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 xbt_lib_set(host_lib, name, MSG_HOST_LEVEL, priv);
60 return xbt_lib_get_elm_or_null(host_lib, name);
64 /** \ingroup msg_host_management
65 * \brief Finds a msg_host_t using its name.
67 * This is a name directory service
68 * \param name the name of an host.
69 * \return the corresponding host
71 msg_host_t MSG_get_host_by_name(const char *name)
73 return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
76 static const char *msg_data = "data";
77 /** \ingroup m_host_management
79 * \brief Set the user data of a #msg_host_t.
81 * This functions checks whether some data has already been associated to \a host
82 or not and attach \a data to \a host if it is possible.
84 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
86 MSG_host_set_property_value(host, msg_data, data, NULL);
90 /** \ingroup m_host_management
92 * \brief Return the user data of a #msg_host_t.
94 * This functions checks whether \a host is a valid pointer or not and return
95 the user data associated to \a host if it is possible.
97 void *MSG_host_get_data(msg_host_t host)
99 return (void *)MSG_host_get_property_value(host, msg_data);
102 /** \ingroup m_host_management
104 * \brief Return the name of the #msg_host_t.
106 * This functions checks whether \a host is a valid pointer or not and return
109 const char *MSG_host_get_name(msg_host_t host) {
110 return SIMIX_host_get_name(host);
113 /** \ingroup m_host_management
115 * \brief Return the location on which the current process is executed.
117 msg_host_t MSG_host_self(void)
119 return MSG_process_get_host(NULL);
124 * \brief Start the host if it is off
126 void MSG_host_on(msg_host_t host)
128 simcall_host_on(host);
132 * \brief Stop the host if it is on
134 void MSG_host_off(msg_host_t host)
136 simcall_host_off(host);
140 * \brief Frees private data of a host (internal call only)
142 void __MSG_host_priv_free(msg_host_priv_t priv)
144 unsigned int size = xbt_dict_size(priv->dp_objs);
146 XBT_WARN("dp_objs: %u pending task?", size);
147 xbt_dict_free(&priv->dp_objs);
148 xbt_dict_free(&priv->affinity_mask_db);
150 #ifdef MSG_USE_DEPRECATED
151 free(priv->mailboxes);
158 * \brief Destroys a host (internal call only)
160 void __MSG_host_destroy(msg_host_t host)
162 const char *name = MSG_host_get_name(host);
164 * What happens if VMs still remain on this host?
165 * Revisit here after the surf layer gets stable.
168 xbt_lib_unset(host_lib, name, MSG_HOST_LEVEL, 1);
171 /** \ingroup m_host_management
172 * \brief Return the current number MSG hosts.
174 int MSG_get_host_number(void)
176 return xbt_lib_length(host_lib);
179 #ifdef MSG_USE_DEPRECATED
180 msg_host_t *MSG_get_host_table(void)
184 xbt_lib_cursor_t cursor;
188 if (xbt_lib_length(host_lib) == 0)
191 array = xbt_new0(void *, xbt_lib_length(host_lib));
193 xbt_lib_foreach(host_lib, cursor, key, data) {
194 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
195 array[i++] = data[MSG_HOST_LEVEL];
198 return (msg_host_t *)array;
202 /** \ingroup m_host_management
203 * \brief Return a dynar containing all the hosts declared at a given point of time
205 xbt_dynar_t MSG_hosts_as_dynar(void) {
206 xbt_lib_cursor_t cursor;
209 xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
211 xbt_lib_foreach(host_lib, cursor, key, data) {
212 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
213 xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
214 xbt_dynar_push(res, &elm);
220 /** \ingroup m_host_management
221 * \brief Return the number of MSG tasks currently running on a
222 * #msg_host_t. The external load is not taken in account.
224 int MSG_get_host_msgload(msg_host_t h)
226 xbt_assert((h != NULL), "Invalid parameters");
227 xbt_die( "Not implemented yet");
232 /** \ingroup m_host_management
233 * \brief Return the speed of the processor (in flop/s), regardless of
234 the current load on the machine.
236 double MSG_get_host_speed(msg_host_t h)
238 xbt_assert((h != NULL), "Invalid parameters");
240 return (simcall_host_get_speed(h));
244 /** \ingroup m_host_management
245 * \brief Return the number of cores.
248 * \return the number of cores
250 int MSG_host_get_core_number(msg_host_t host)
252 xbt_assert((host != NULL), "Invalid parameters");
254 return (simcall_host_get_core(host));
257 /** \ingroup m_host_management
258 * \brief Return the list of processes attached to an host.
261 * \return a swag with the attached processes
263 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
265 xbt_assert((host != NULL), "Invalid parameters");
267 return (simcall_host_get_process_list(host));
271 /** \ingroup m_host_management
272 * \brief Returns the value of a given host property
275 * \param name a property name
276 * \return value of a property (or NULL if property not set)
278 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
280 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
283 /** \ingroup m_host_management
284 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
287 * \return a dict containing the properties
289 xbt_dict_t MSG_host_get_properties(msg_host_t host)
291 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
293 return (simcall_host_get_properties(host));
296 /** \ingroup m_host_management
297 * \brief Change the value of a given host property
300 * \param name a property name
301 * \param value what to change the property to
302 * \param free_ctn the freeing function to use to kill the value on need
304 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
306 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
310 /** @ingroup msg_gos_functions
311 * @brief Determine if a host is up and running.
313 * @param host host to test
314 * @return Returns true if the host is up and running, and false if it's currently down
316 int MSG_host_is_on(msg_host_t host)
318 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
319 return (simcall_host_get_state(host));
321 /** @ingroup msg_gos_functions
322 * @brief Determine if a host is currently off.
324 int MSG_host_is_off(msg_host_t host)
326 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
327 return !(simcall_host_get_state(host));
330 /** \ingroup m_host_management
331 * \brief Set the parameters of a given host
334 * \param params a prameter object
336 void MSG_host_set_params(msg_host_t host, ws_params_t params)
338 simcall_host_set_params(host, params);
341 /** \ingroup m_host_management
342 * \brief Get the parameters of a given host
345 * \param params a prameter object
347 void MSG_host_get_params(msg_host_t host, ws_params_t params)
349 simcall_host_get_params(host, params);
352 /** \ingroup m_host_management
353 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
355 * \param host host to test
356 * \param pstate_index pstate to test
357 * \return Returns the processor speed associated with pstate_index
359 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
360 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
361 return (simcall_host_get_power_peak_at(host, pstate_index));
364 /** \ingroup m_host_management
365 * \brief Return the current speed of the processor (in flop/s)
367 * \param host host to test
368 * \return Returns the current processor speed
370 double MSG_host_get_current_power_peak(msg_host_t host) {
371 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
372 return simcall_host_get_current_power_peak(host);
375 /** \ingroup m_host_management
376 * \brief Return the number of pstates defined for a host. See also @ref SURF_plugin_energy.
378 * \param host host to test
380 int MSG_host_get_pstate_number(msg_host_t host) {
382 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
383 return (simcall_host_get_nb_pstates(host));
386 /** \ingroup m_host_management
387 * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
389 * \param host host to test
390 * \param pstate_index pstate to switch to
392 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
393 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
395 simcall_host_set_power_peak_at(host, pstate_index);
398 /** \ingroup m_host_management
399 * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
401 * \param host host to test
402 * \return Returns the consumed energy
404 double MSG_host_get_consumed_energy(msg_host_t host) {
405 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
406 return simcall_host_get_consumed_energy(host);
409 /** \ingroup m_host_management
410 * \brief Return the list of mount point names on an host.
412 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
414 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
416 xbt_assert((host != NULL), "Invalid parameters");
417 return (simcall_host_get_mounted_storage_list(host));
420 /** \ingroup m_host_management
421 * \brief Return the list of storages attached to an host.
423 * \return a dynar containing all storages (name) attached to the host
425 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
427 xbt_assert((host != NULL), "Invalid parameters");
428 return (simcall_host_get_attached_storage_list(host));
431 /** \ingroup msg_host_management
432 * \brief Return the content of mounted storages on an host.
434 * \return a dict containing content (as a dict) of all storages mounted on the host
436 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
438 xbt_assert((host != NULL), "Invalid parameters");
439 xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
440 msg_storage_t storage;
443 xbt_dict_cursor_t cursor = NULL;
445 xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
447 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
448 storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
449 xbt_dict_t content = simcall_storage_get_content(storage);
450 xbt_dict_set(contents,mount_name, content,NULL);
452 xbt_dict_free(&storage_list);