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"
12 /** @addtogroup m_host_management
13 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
14 * (#m_host_t) and the functions for managing it.
16 * A <em>location</em> (or <em>host</em>) is any possible place where
17 * a process may run. Thus it may be represented as a
18 * <em>physical resource with computing capabilities</em>, some
19 * <em>mailboxes</em> to enable running process to communicate with
20 * remote ones, and some <em>private data</em> that can be only
21 * accessed by local process.
25 /********************************* Host **************************************/
26 m_host_t __MSG_host_create(smx_host_t workstation, void *data)
29 simdata_host_t simdata = xbt_new0(s_simdata_host_t, 1);
30 m_host_t host = xbt_new0(s_m_host_t, 1);
32 name = SIMIX_host_get_name(workstation);
34 host->name = xbt_strdup(name);
35 host->simdata = simdata;
38 simdata->smx_host = workstation;
40 #ifdef MSG_USE_DEPRECATED
42 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
44 if (msg_global->max_channel > 0)
45 simdata->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
47 for (i = 0; i < msg_global->max_channel; i++) {
48 sprintf(alias, "%s:%d", name, i);
50 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
51 simdata->mailboxes[i] = MSG_mailbox_new(alias);
52 memset(alias, 0, MAX_ALIAS_NAME + 1);
56 simcall_host_set_data(workstation, host);
57 xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
62 /** \ingroup m_host_management
64 * \brief Set the user data of a #m_host_t.
66 * This functions checks whether some data has already been associated to \a host
67 or not and attach \a data to \a host if it is possible.
69 MSG_error_t MSG_host_set_data(m_host_t host, void *data)
71 xbt_assert((host != NULL), "Invalid parameters");
72 xbt_assert((host->data == NULL), "Data already set");
80 /** \ingroup m_host_management
82 * \brief Return the user data of a #m_host_t.
84 * This functions checks whether \a host is a valid pointer or not and return
85 the user data associated to \a host if it is possible.
87 void *MSG_host_get_data(m_host_t host)
90 xbt_assert((host != NULL), "Invalid parameters");
96 /** \ingroup m_host_management
98 * \brief Return the name of the #m_host_t.
100 * This functions checks whether \a host is a valid pointer or not and return
103 const char *MSG_host_get_name(m_host_t host)
106 xbt_assert((host != NULL)
107 && (host->simdata != NULL), "Invalid parameters");
113 /** \ingroup m_host_management
115 * \brief Return the location on which the current process is executed.
117 m_host_t MSG_host_self(void)
119 return MSG_process_get_host(NULL);
122 /** \ingroup m_host_management
124 * \brief Destroys a host
126 void __MSG_host_destroy(m_host_t host)
128 simdata_host_t simdata = NULL;
130 xbt_assert((host != NULL), "Invalid parameters");
132 /* Clean simulator data */
133 simdata = (host)->simdata;
135 #ifdef MSG_USE_DEPRECATED
136 if (msg_global->max_channel > 0)
137 free(simdata->mailboxes);
142 /* Clean host structure */
147 #ifdef MSG_USE_DEPRECATED
148 int MSG_get_host_number(void)
150 return xbt_lib_length(host_lib);
153 m_host_t *MSG_get_host_table(void)
157 xbt_lib_cursor_t cursor;
161 if (xbt_lib_length(host_lib) == 0)
164 array = xbt_new0(void *, xbt_lib_length(host_lib));
166 xbt_lib_foreach(host_lib, cursor, key, data) {
167 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
168 array[i++] = data[MSG_HOST_LEVEL];
171 return (m_host_t *)array;
175 /** \ingroup m_host_management
176 * \brief Return a dynar containing all the hosts declared at a given point of time
178 xbt_dynar_t MSG_hosts_as_dynar(void) {
179 xbt_lib_cursor_t cursor;
182 xbt_dynar_t res = xbt_dynar_new(sizeof(m_host_t),NULL);
184 xbt_lib_foreach(host_lib, cursor, key, data) {
185 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
186 xbt_dynar_push(res, data + MSG_HOST_LEVEL);
191 /** \ingroup m_host_management
192 * \brief Return the number of MSG tasks currently running on a
193 * #m_host_t. The external load is not taken in account.
195 int MSG_get_host_msgload(m_host_t h)
197 xbt_assert((h != NULL), "Invalid parameters");
198 xbt_die( "Not implemented yet");
203 /** \ingroup m_host_management
204 * \brief Return the speed of the processor (in flop/s), regardless of
205 the current load on the machine.
207 double MSG_get_host_speed(m_host_t h)
209 xbt_assert((h != NULL), "Invalid parameters");
211 return (simcall_host_get_speed(h->simdata->smx_host));
214 /** \ingroup m_host_management
215 * \brief Returns the value of a given host property
218 * \param name a property name
219 * \return value of a property (or NULL if property not set)
221 const char *MSG_host_get_property_value(m_host_t host, const char *name)
223 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
226 /** \ingroup m_host_management
227 * \brief Returns a xbt_dynar_t consisting of the list of properties assigned to this host
230 * \return a dict containing the properties
232 xbt_dict_t MSG_host_get_properties(m_host_t host)
234 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
236 return (simcall_host_get_properties(host->simdata->smx_host));
240 /** \ingroup msg_gos_functions
241 * \brief Determine if a host is available.
243 * \param h host to test
245 int MSG_host_is_avail(m_host_t h)
247 xbt_assert((h != NULL), "Invalid parameters (host is NULL)");
248 return (simcall_host_get_state(h->simdata->smx_host));