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/private.h"
8 #include "xbt/sysdep.h"
12 /** \defgroup m_host_management Management functions of Hosts
13 * \brief This section describes the host structure of MSG
15 /** @addtogroup m_host_management
16 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
17 * (#m_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 m_host_t __MSG_host_create(smx_host_t workstation, void *data)
32 simdata_host_t simdata = xbt_new0(s_simdata_host_t, 1);
33 m_host_t host = xbt_new0(s_m_host_t, 1);
36 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
38 name = SIMIX_host_get_name(workstation);
40 host->name = xbt_strdup(name);
41 host->simdata = simdata;
44 simdata->smx_host = workstation;
46 if (msg_global->max_channel > 0)
47 simdata->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
49 for (i = 0; i < msg_global->max_channel; i++) {
50 sprintf(alias, "%s:%d", name, i);
52 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
53 simdata->mailboxes[i] = MSG_mailbox_create(alias);
54 memset(alias, 0, MAX_ALIAS_NAME + 1);
57 simdata->mutex = SIMIX_mutex_init();
58 SIMIX_host_set_data(workstation, host);
60 /* Update global variables */
61 xbt_fifo_unshift(msg_global->host, host);
66 /** \ingroup m_host_management
68 * \brief Set the user data of a #m_host_t.
70 * This functions checks whether some data has already been associated to \a host
71 or not and attach \a data to \a host if it is possible.
73 MSG_error_t MSG_host_set_data(m_host_t host, void *data)
75 xbt_assert0((host != NULL), "Invalid parameters");
76 xbt_assert0((host->data == NULL), "Data already set");
84 /** \ingroup m_host_management
86 * \brief Return the user data of a #m_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(m_host_t host)
94 xbt_assert0((host != NULL), "Invalid parameters");
100 /** \ingroup m_host_management
102 * \brief Return the name of the #m_host_t.
104 * This functions checks whether \a host is a valid pointer or not and return
107 const char *MSG_host_get_name(m_host_t host)
110 xbt_assert0((host != NULL)
111 && (host->simdata != NULL), "Invalid parameters");
117 /** \ingroup m_host_management
119 * \brief Return the location on which the current process is executed.
121 m_host_t MSG_host_self(void)
123 return MSG_process_get_host(MSG_process_self());
127 * Real function to destroy a host.
128 * MSG_host_destroy is just a front_end that also removes it from
131 void __MSG_host_destroy(m_host_t host)
133 simdata_host_t simdata = NULL;
135 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
137 xbt_assert0((host != NULL), "Invalid parameters");
139 /* Clean Simulator data */
140 /* SIMIX host will be cleaned when MSG_clean calls SIMIX_clean */
141 simdata = (host)->simdata;
143 for (i = 0; i < msg_global->max_channel; i++) {
144 sprintf(alias, "%s:%d", host->name, i);
145 MSG_mailbox_free((void *) (simdata->mailboxes[i]));
146 memset(alias, 0, MAX_ALIAS_NAME + 1);
149 if (msg_global->max_channel > 0)
150 free(simdata->mailboxes);
151 SIMIX_mutex_destroy(simdata->mutex);
154 /* Clean host structure */
161 /** \ingroup m_host_management
162 * \brief Return the current number of #m_host_t.
164 int MSG_get_host_number(void)
166 return (xbt_fifo_size(msg_global->host));
169 /** \ingroup m_host_management
170 * \brief Return a array of all the #m_host_t.
172 m_host_t *MSG_get_host_table(void)
174 return ((m_host_t *) xbt_fifo_to_array(msg_global->host));
177 /** \ingroup m_host_management
178 * \brief Return the number of MSG tasks currently running on a
179 * #m_host_t. The external load is not taken in account.
181 int MSG_get_host_msgload(m_host_t h)
183 xbt_assert0((h != NULL), "Invalid parameters");
184 xbt_assert0(0, "Not implemented yet");
189 /** \ingroup m_host_management
190 * \brief Return the speed of the processor (in flop/s), regardless of
191 the current load on the machine.
193 double MSG_get_host_speed(m_host_t h)
195 xbt_assert0((h != NULL), "Invalid parameters");
197 return (SIMIX_host_get_speed(h->simdata->smx_host));
200 /** \ingroup m_host_management
201 * \brief Returns the value of a given host property
204 * \param name a property name
205 * \return value of a property (or NULL if property not set)
207 const char *MSG_host_get_property_value(m_host_t host, const char *name)
209 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
212 /** \ingroup m_host_management
213 * \brief Returns a xbt_dynar_t consisting of the list of properties assigned to this host
216 * \return a dict containing the properties
218 xbt_dict_t MSG_host_get_properties(m_host_t host)
220 xbt_assert0((host != NULL), "Invalid parameters (host is NULL)");
222 return (SIMIX_host_get_properties(host->simdata->smx_host));
226 /** \ingroup msg_gos_functions
227 * \brief Determine if a host is available.
229 * \param h host to test
231 int MSG_host_is_avail(m_host_t h)
233 xbt_assert0((h != NULL), "Invalid parameters (host is NULL)");
234 return (SIMIX_host_get_state(h->simdata->smx_host));