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 /** \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);
35 name = SIMIX_host_get_name(workstation);
37 host->name = xbt_strdup(name);
38 host->simdata = simdata;
41 simdata->smx_host = workstation;
43 #ifdef MSG_USE_DEPRECATED
45 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
47 if (msg_global->max_channel > 0)
48 simdata->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
50 for (i = 0; i < msg_global->max_channel; i++) {
51 sprintf(alias, "%s:%d", name, i);
53 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
54 simdata->mailboxes[i] = MSG_mailbox_new(alias);
55 memset(alias, 0, MAX_ALIAS_NAME + 1);
59 simcall_host_set_data(workstation, host);
60 xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
65 /** \ingroup m_host_management
67 * \brief Set the user data of a #m_host_t.
69 * This functions checks whether some data has already been associated to \a host
70 or not and attach \a data to \a host if it is possible.
72 MSG_error_t MSG_host_set_data(m_host_t host, void *data)
74 xbt_assert((host != NULL), "Invalid parameters");
75 xbt_assert((host->data == NULL), "Data already set");
83 /** \ingroup m_host_management
85 * \brief Return the user data of a #m_host_t.
87 * This functions checks whether \a host is a valid pointer or not and return
88 the user data associated to \a host if it is possible.
90 void *MSG_host_get_data(m_host_t host)
93 xbt_assert((host != NULL), "Invalid parameters");
99 /** \ingroup m_host_management
101 * \brief Return the name of the #m_host_t.
103 * This functions checks whether \a host is a valid pointer or not and return
106 const char *MSG_host_get_name(m_host_t host)
109 xbt_assert((host != NULL)
110 && (host->simdata != NULL), "Invalid parameters");
116 /** \ingroup m_host_management
118 * \brief Return the location on which the current process is executed.
120 m_host_t MSG_host_self(void)
122 return MSG_process_get_host(NULL);
125 /** \ingroup m_host_management
127 * \brief Destroys a host
129 void __MSG_host_destroy(m_host_t host)
131 simdata_host_t simdata = NULL;
133 xbt_assert((host != NULL), "Invalid parameters");
135 /* Clean simulator data */
136 simdata = (host)->simdata;
138 #ifdef MSG_USE_DEPRECATED
139 if (msg_global->max_channel > 0)
140 free(simdata->mailboxes);
145 /* Clean host structure */
150 /** \ingroup m_host_management
151 * \brief Return the current number of #m_host_t.
153 int MSG_get_host_number(void)
155 return xbt_lib_length(host_lib);
158 /** \ingroup m_host_management
159 * \brief Return a array of all the #m_host_t.
161 m_host_t *MSG_get_host_table(void)
165 xbt_lib_cursor_t cursor;
169 if (xbt_lib_length(host_lib) == 0)
172 array = xbt_new0(void *, xbt_lib_length(host_lib));
174 xbt_lib_foreach(host_lib, cursor, key, data) {
175 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
176 array[i++] = data[MSG_HOST_LEVEL];
179 return (m_host_t *)array;
182 /** \ingroup m_host_management
183 * \brief Return the number of MSG tasks currently running on a
184 * #m_host_t. The external load is not taken in account.
186 int MSG_get_host_msgload(m_host_t h)
188 xbt_assert((h != NULL), "Invalid parameters");
189 xbt_die( "Not implemented yet");
194 /** \ingroup m_host_management
195 * \brief Return the speed of the processor (in flop/s), regardless of
196 the current load on the machine.
198 double MSG_get_host_speed(m_host_t h)
200 xbt_assert((h != NULL), "Invalid parameters");
202 return (simcall_host_get_speed(h->simdata->smx_host));
205 /** \ingroup m_host_management
206 * \brief Returns the value of a given host property
209 * \param name a property name
210 * \return value of a property (or NULL if property not set)
212 const char *MSG_host_get_property_value(m_host_t host, const char *name)
214 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
217 /** \ingroup m_host_management
218 * \brief Returns a xbt_dynar_t consisting of the list of properties assigned to this host
221 * \return a dict containing the properties
223 xbt_dict_t MSG_host_get_properties(m_host_t host)
225 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
227 return (simcall_host_get_properties(host->simdata->smx_host));
231 /** \ingroup msg_gos_functions
232 * \brief Determine if a host is available.
234 * \param h host to test
236 int MSG_host_is_avail(m_host_t h)
238 xbt_assert((h != NULL), "Invalid parameters (host is NULL)");
239 return (simcall_host_get_state(h->simdata->smx_host));