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 host = xbt_new0(s_msg_host_priv_t, 1);
34 host->vms = xbt_dynar_new(sizeof(msg_vm_t),NULL);
36 #ifdef MSG_USE_DEPRECATED
38 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
40 if (msg_global->max_channel > 0)
41 host->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
43 for (i = 0; i < msg_global->max_channel; i++) {
44 sprintf(alias, "%s:%d", name, i);
46 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
47 host->mailboxes[i] = MSG_mailbox_new(alias);
48 memset(alias, 0, MAX_ALIAS_NAME + 1);
52 xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
54 return xbt_lib_get_elm_or_null(host_lib, name);
58 /** \ingroup msg_host_management
59 * \brief Finds a msg_host_t using its name.
61 * This is a name directory service
62 * \param name the name of an host.
63 * \return the corresponding host
65 msg_host_t MSG_get_host_by_name(const char *name)
67 return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
70 /** \ingroup m_host_management
72 * \brief Set the user data of a #msg_host_t.
74 * This functions checks whether some data has already been associated to \a host
75 or not and attach \a data to \a host if it is possible.
77 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
79 SIMIX_host_set_data(host,data);
84 /** \ingroup m_host_management
86 * \brief Return the user data of a #msg_host_t.
88 * This functions checks whether \a host is a valid pointer or not and return
89 the user data associated to \a host if it is possible.
91 void *MSG_host_get_data(msg_host_t host)
93 return SIMIX_host_get_data(host);
96 /** \ingroup m_host_management
98 * \brief Return the name of the #msg_host_t.
100 * This functions checks whether \a host is a valid pointer or not and return
103 const char *MSG_host_get_name(msg_host_t host) {
104 return SIMIX_host_get_name(host);
107 /** \ingroup m_host_management
109 * \brief Return the location on which the current process is executed.
111 msg_host_t MSG_host_self(void)
113 return MSG_process_get_host(NULL);
117 * \brief Destroys a host (internal call only)
119 void __MSG_host_destroy(msg_host_priv_t host) {
121 #ifdef MSG_USE_DEPRECATED
122 if (msg_global->max_channel > 0)
123 free(host->mailboxes);
125 if (xbt_swag_size(host->vms) > 0 ) {
126 XBT_VERB("Host shut down, but it still hosts %d VMs. They will be leaked.",xbt_swag_size(host->vms));
128 xbt_swag_free(host->vms);
132 /** \ingroup m_host_management
133 * \brief Return the current number MSG hosts.
135 int MSG_get_host_number(void)
137 return xbt_lib_length(host_lib);
140 #ifdef MSG_USE_DEPRECATED
141 msg_host_t *MSG_get_host_table(void)
145 xbt_lib_cursor_t cursor;
149 if (xbt_lib_length(host_lib) == 0)
152 array = xbt_new0(void *, xbt_lib_length(host_lib));
154 xbt_lib_foreach(host_lib, cursor, key, data) {
155 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
156 array[i++] = data[MSG_HOST_LEVEL];
159 return (msg_host_t *)array;
163 /** \ingroup m_host_management
164 * \brief Return a dynar containing all the hosts declared at a given point of time
166 xbt_dynar_t MSG_hosts_as_dynar(void) {
167 xbt_lib_cursor_t cursor;
170 xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
172 xbt_lib_foreach(host_lib, cursor, key, data) {
173 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
174 xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
175 xbt_dynar_push(res, &elm);
181 /** \ingroup m_host_management
182 * \brief Return the number of MSG tasks currently running on a
183 * #msg_host_t. The external load is not taken in account.
185 int MSG_get_host_msgload(msg_host_t h)
187 xbt_assert((h != NULL), "Invalid parameters");
188 xbt_die( "Not implemented yet");
193 /** \ingroup m_host_management
194 * \brief Return the speed of the processor (in flop/s), regardless of
195 the current load on the machine.
197 double MSG_get_host_speed(msg_host_t h)
199 xbt_assert((h != NULL), "Invalid parameters");
201 return (simcall_host_get_speed(h));
204 /** \ingroup m_host_management
205 * \brief Returns the value of a given host property
208 * \param name a property name
209 * \return value of a property (or NULL if property not set)
211 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
213 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
216 /** \ingroup m_host_management
217 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
220 * \return a dict containing the properties
222 xbt_dict_t MSG_host_get_properties(msg_host_t host)
224 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
226 return (simcall_host_get_properties(host));
229 /** \ingroup m_host_management
230 * \brief Change the value of a given host property
233 * \param name a property name
234 * \param value what to change the property to
235 * \param free_ctn the freeing function to use to kill the value on need
237 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
239 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
243 /** \ingroup msg_gos_functions
244 * \brief Determine if a host is available.
246 * \param host host to test
247 * \return Returns 1 if host is available, 0 otherwise
249 int MSG_host_is_avail(msg_host_t host)
251 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
252 return (simcall_host_get_state(host));