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 msg_host_management
63 * \brief Finds a m_host_t using its name.
65 * This is a name directory service
66 * \param name the name of an host.
67 * \return the corresponding host
69 m_host_t MSG_get_host_by_name(const char *name)
71 smx_host_t simix_h = NULL;
72 simix_h = simcall_host_get_by_name(name);
77 return (m_host_t) simcall_host_get_data(simix_h);
81 /** \ingroup m_host_management
83 * \brief Set the user data of a #m_host_t.
85 * This functions checks whether some data has already been associated to \a host
86 or not and attach \a data to \a host if it is possible.
88 MSG_error_t MSG_host_set_data(m_host_t host, void *data)
90 xbt_assert((host != NULL), "Invalid parameters");
91 xbt_assert((host->data == NULL), "Data already set");
99 /** \ingroup m_host_management
101 * \brief Return the user data of a #m_host_t.
103 * This functions checks whether \a host is a valid pointer or not and return
104 the user data associated to \a host if it is possible.
106 void *MSG_host_get_data(m_host_t host)
109 xbt_assert((host != NULL), "Invalid parameters");
115 /** \ingroup m_host_management
117 * \brief Return the name of the #m_host_t.
119 * This functions checks whether \a host is a valid pointer or not and return
122 const char *MSG_host_get_name(m_host_t host)
125 xbt_assert((host != NULL)
126 && (host->simdata != NULL), "Invalid parameters");
132 /** \ingroup m_host_management
134 * \brief Return the location on which the current process is executed.
136 m_host_t MSG_host_self(void)
138 return MSG_process_get_host(NULL);
141 /** \ingroup m_host_management
143 * \brief Destroys a host
145 void __MSG_host_destroy(m_host_t host)
147 simdata_host_t simdata = NULL;
149 xbt_assert((host != NULL), "Invalid parameters");
151 /* Clean simulator data */
152 simdata = (host)->simdata;
154 #ifdef MSG_USE_DEPRECATED
155 if (msg_global->max_channel > 0)
156 free(simdata->mailboxes);
161 /* Clean host structure */
166 #ifdef MSG_USE_DEPRECATED
167 int MSG_get_host_number(void)
169 return xbt_lib_length(host_lib);
172 m_host_t *MSG_get_host_table(void)
176 xbt_lib_cursor_t cursor;
180 if (xbt_lib_length(host_lib) == 0)
183 array = xbt_new0(void *, xbt_lib_length(host_lib));
185 xbt_lib_foreach(host_lib, cursor, key, data) {
186 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
187 array[i++] = data[MSG_HOST_LEVEL];
190 return (m_host_t *)array;
194 /** \ingroup m_host_management
195 * \brief Return a dynar containing all the hosts declared at a given point of time
197 xbt_dynar_t MSG_hosts_as_dynar(void) {
198 xbt_lib_cursor_t cursor;
201 xbt_dynar_t res = xbt_dynar_new(sizeof(m_host_t),NULL);
203 xbt_lib_foreach(host_lib, cursor, key, data) {
204 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
205 xbt_dynar_push(res, data + MSG_HOST_LEVEL);
210 /** \ingroup m_host_management
211 * \brief Return the number of MSG tasks currently running on a
212 * #m_host_t. The external load is not taken in account.
214 int MSG_get_host_msgload(m_host_t h)
216 xbt_assert((h != NULL), "Invalid parameters");
217 xbt_die( "Not implemented yet");
222 /** \ingroup m_host_management
223 * \brief Return the speed of the processor (in flop/s), regardless of
224 the current load on the machine.
226 double MSG_get_host_speed(m_host_t h)
228 xbt_assert((h != NULL), "Invalid parameters");
230 return (simcall_host_get_speed(h->simdata->smx_host));
233 /** \ingroup m_host_management
234 * \brief Returns the value of a given host property
237 * \param name a property name
238 * \return value of a property (or NULL if property not set)
240 const char *MSG_host_get_property_value(m_host_t host, const char *name)
242 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
245 /** \ingroup m_host_management
246 * \brief Returns a xbt_dynar_t consisting of the list of properties assigned to this host
249 * \return a dict containing the properties
251 xbt_dict_t MSG_host_get_properties(m_host_t host)
253 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
255 return (simcall_host_get_properties(host->simdata->smx_host));
259 /** \ingroup msg_gos_functions
260 * \brief Determine if a host is available.
262 * \param host host to test
263 * \return Returns 1 if host is available, 0 otherwise
265 int MSG_host_is_avail(m_host_t host)
267 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
268 return (simcall_host_get_state(host->simdata->smx_host));