3 /* Copyright (c) 2002-2007 Arnaud Legrand. */
4 /* Copyright (c) 2007 Bruno Donassolo. */
5 /* All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #include "msg/private.h"
11 #include "xbt/sysdep.h"
15 /** \defgroup m_host_management Management functions of Hosts
16 * \brief This section describes the host structure of MSG
18 /** @addtogroup m_host_management
19 * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
20 * (#m_host_t) and the functions for managing it.
22 * A <em>location</em> (or <em>host</em>) is any possible place where
23 * a process may run. Thus it may be represented as a
24 * <em>physical resource with computing capabilities</em>, some
25 * <em>mailboxes</em> to enable running process to communicate with
26 * remote ones, and some <em>private data</em> that can be only
27 * accessed by local process.
31 /********************************* Host **************************************/
32 m_host_t __MSG_host_create(smx_host_t workstation, void *data)
35 simdata_host_t simdata = xbt_new0(s_simdata_host_t, 1);
36 m_host_t host = xbt_new0(s_m_host_t, 1);
39 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
41 name = SIMIX_host_get_name(workstation);
43 host->name = xbt_strdup(name);
44 host->simdata = simdata;
47 simdata->smx_host = workstation;
49 if (msg_global->max_channel > 0)
50 simdata->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
52 for (i = 0; i < msg_global->max_channel; i++) {
53 sprintf(alias, "%s:%d", name, i);
55 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
56 simdata->mailboxes[i] = MSG_mailbox_create(alias);
57 MSG_mailbox_set_hostname(simdata->mailboxes[i], name);
58 memset(alias, 0, MAX_ALIAS_NAME + 1);
61 simdata->mutex = SIMIX_mutex_init();
62 SIMIX_host_set_data(workstation, host);
64 /* Update global variables */
65 xbt_fifo_unshift(msg_global->host, host);
70 /** \ingroup m_host_management
72 * \brief Set the user data of a #m_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(m_host_t host, void *data)
79 xbt_assert0((host != NULL), "Invalid parameters");
80 xbt_assert0((host->data == NULL), "Data already set");
88 /** \ingroup m_host_management
90 * \brief Return the user data of a #m_host_t.
92 * This functions checks whether \a host is a valid pointer or not and return
93 the user data associated to \a host if it is possible.
95 void *MSG_host_get_data(m_host_t host)
98 xbt_assert0((host != NULL), "Invalid parameters");
104 /** \ingroup m_host_management
106 * \brief Return the name of the #m_host_t.
108 * This functions checks whether \a host is a valid pointer or not and return
111 const char *MSG_host_get_name(m_host_t host)
114 xbt_assert0((host != NULL)
115 && (host->simdata != NULL), "Invalid parameters");
121 /** \ingroup m_host_management
123 * \brief Return the location on which the current process is executed.
125 m_host_t MSG_host_self(void)
127 return MSG_process_get_host(MSG_process_self());
131 * Real function to destroy a host.
132 * MSG_host_destroy is just a front_end that also removes it from
135 void __MSG_host_destroy(m_host_t host)
137 simdata_host_t simdata = NULL;
139 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
141 xbt_assert0((host != NULL), "Invalid parameters");
143 /* Clean Simulator data */
144 /* SIMIX host will be cleaned when MSG_clean calls SIMIX_clean */
145 simdata = (host)->simdata;
147 for (i = 0; i < msg_global->max_channel; i++) {
148 sprintf(alias, "%s:%d", host->name, i);
149 MSG_mailbox_free((void *) (simdata->mailboxes[i]));
150 memset(alias, 0, MAX_ALIAS_NAME + 1);
153 if (msg_global->max_channel > 0)
154 free(simdata->mailboxes);
155 SIMIX_mutex_destroy(simdata->mutex);
158 /* Clean host structure */
165 /** \ingroup m_host_management
166 * \brief Return the current number of #m_host_t.
168 int MSG_get_host_number(void)
170 return (xbt_fifo_size(msg_global->host));
173 /** \ingroup m_host_management
174 * \brief Return a array of all the #m_host_t.
176 m_host_t *MSG_get_host_table(void)
178 return ((m_host_t *) xbt_fifo_to_array(msg_global->host));
181 /** \ingroup m_host_management
182 * \brief Return the number of MSG tasks currently running on a
183 * #m_host_t. The external load is not taken in account.
185 int MSG_get_host_msgload(m_host_t h)
187 xbt_assert0((h != NULL), "Invalid parameters");
188 xbt_assert0(0, "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(m_host_t h)
199 xbt_assert0((h != NULL), "Invalid parameters");
201 return (SIMIX_host_get_speed(h->simdata->smx_host));
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(m_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_dynar_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(m_host_t host)
224 xbt_assert0((host != NULL), "Invalid parameters");
226 return (SIMIX_host_get_properties(host->simdata->smx_host));
230 /** \ingroup msg_gos_functions
231 * \brief Determine if a host is available.
233 * \param h host to test
235 int MSG_host_is_avail(m_host_t h)
237 xbt_assert0((h != NULL), "Invalid parameters");
238 return (SIMIX_host_get_state(h->simdata->smx_host));