1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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 if (msg_global->max_channel > 0)
39 priv->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
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;
55 xbt_lib_set(host_lib, name, MSG_HOST_LEVEL, priv);
57 return xbt_lib_get_elm_or_null(host_lib, name);
61 /** \ingroup msg_host_management
62 * \brief Finds a msg_host_t using its name.
64 * This is a name directory service
65 * \param name the name of an host.
66 * \return the corresponding host
68 msg_host_t MSG_get_host_by_name(const char *name)
70 return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
73 /** \ingroup m_host_management
75 * \brief Set the user data of a #msg_host_t.
77 * This functions checks whether some data has already been associated to \a host
78 or not and attach \a data to \a host if it is possible.
80 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
82 SIMIX_host_set_data(host,data);
87 /** \ingroup m_host_management
89 * \brief Return the user data of a #msg_host_t.
91 * This functions checks whether \a host is a valid pointer or not and return
92 the user data associated to \a host if it is possible.
94 void *MSG_host_get_data(msg_host_t host)
96 return SIMIX_host_get_data(host);
99 /** \ingroup m_host_management
101 * \brief Return the name of the #msg_host_t.
103 * This functions checks whether \a host is a valid pointer or not and return
106 const char *MSG_host_get_name(msg_host_t host) {
107 return SIMIX_host_get_name(host);
110 /** \ingroup m_host_management
112 * \brief Return the location on which the current process is executed.
114 msg_host_t MSG_host_self(void)
116 return MSG_process_get_host(NULL);
121 * \brief Start the host if it is off
123 void MSG_host_on(msg_host_t host)
125 simcall_host_on(host);
129 * \brief Stop the host if it is on
131 void MSG_host_off(msg_host_t host)
133 simcall_host_off(host);
137 * \brief Frees private data of a host (internal call only)
139 void __MSG_host_priv_free(msg_host_priv_t priv)
141 unsigned int size = xbt_dict_size(priv->dp_objs);
143 XBT_WARN("dp_objs: %u pending task?", size);
144 xbt_dict_free(&priv->dp_objs);
146 #ifdef MSG_USE_DEPRECATED
147 if (msg_global->max_channel > 0)
148 free(priv->mailboxes);
155 * \brief Destroys a host (internal call only)
157 void __MSG_host_destroy(msg_host_t host)
159 const char *name = MSG_host_get_name(host);
161 * What happens if VMs still remain on this host?
162 * Revisit here after the surf layer gets stable.
165 xbt_lib_unset(host_lib, name, MSG_HOST_LEVEL, 1);
168 /** \ingroup m_host_management
169 * \brief Return the current number MSG hosts.
171 int MSG_get_host_number(void)
173 return xbt_lib_length(host_lib);
176 #ifdef MSG_USE_DEPRECATED
177 msg_host_t *MSG_get_host_table(void)
181 xbt_lib_cursor_t cursor;
185 if (xbt_lib_length(host_lib) == 0)
188 array = xbt_new0(void *, xbt_lib_length(host_lib));
190 xbt_lib_foreach(host_lib, cursor, key, data) {
191 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
192 array[i++] = data[MSG_HOST_LEVEL];
195 return (msg_host_t *)array;
199 /** \ingroup m_host_management
200 * \brief Return a dynar containing all the hosts declared at a given point of time
202 xbt_dynar_t MSG_hosts_as_dynar(void) {
203 xbt_lib_cursor_t cursor;
206 xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
208 xbt_lib_foreach(host_lib, cursor, key, data) {
209 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
210 xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
211 xbt_dynar_push(res, &elm);
217 /** \ingroup m_host_management
218 * \brief Return the number of MSG tasks currently running on a
219 * #msg_host_t. The external load is not taken in account.
221 int MSG_get_host_msgload(msg_host_t h)
223 xbt_assert((h != NULL), "Invalid parameters");
224 xbt_die( "Not implemented yet");
229 /** \ingroup m_host_management
230 * \brief Return the speed of the processor (in flop/s), regardless of
231 the current load on the machine.
233 double MSG_get_host_speed(msg_host_t h)
235 xbt_assert((h != NULL), "Invalid parameters");
237 return (simcall_host_get_speed(h));
241 /** \ingroup m_host_management
242 * \brief Return the number of core.
244 int MSG_get_host_core(msg_host_t h)
246 xbt_assert((h != NULL), "Invalid parameters");
248 return (simcall_host_get_core(h));
251 /** \ingroup m_host_management
252 * \brief Returns the value of a given host property
255 * \param name a property name
256 * \return value of a property (or NULL if property not set)
258 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
260 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
263 /** \ingroup m_host_management
264 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
267 * \return a dict containing the properties
269 xbt_dict_t MSG_host_get_properties(msg_host_t host)
271 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
273 return (simcall_host_get_properties(host));
276 /** \ingroup m_host_management
277 * \brief Change the value of a given host property
280 * \param name a property name
281 * \param value what to change the property to
282 * \param free_ctn the freeing function to use to kill the value on need
284 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
286 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
290 /** \ingroup msg_gos_functions
291 * \brief Determine if a host is available.
293 * \param host host to test
294 * \return Returns 1 if host is available, 0 otherwise
296 int MSG_host_is_avail(msg_host_t host)
298 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
299 return (simcall_host_get_state(host));
302 /** \ingroup m_host_management
303 * \brief Set the parameters of a given host
306 * \param params a prameter object
308 void MSG_host_set_params(msg_host_t ind_pm, ws_params_t params)
310 simcall_host_set_params(ind_pm, params);
313 /** \ingroup m_host_management
314 * \brief Get the parameters of a given host
317 * \param params a prameter object
319 void MSG_host_get_params(msg_host_t ind_pm, ws_params_t params)
321 simcall_host_get_params(ind_pm, params);