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"
11 #include "simgrid/simix.h"
13 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(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)
31 const char *name = SIMIX_host_get_name(workstation);
32 m_host_t host = xbt_new0(s_m_host_t, 1);
33 s_msg_vm_t vm; // simply to compute the offset
35 host->smx_host = workstation;
36 host->vms = xbt_swag_new(xbt_swag_offset(vm,host_vms_hookup));
38 #ifdef MSG_USE_DEPRECATED
40 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
42 if (msg_global->max_channel > 0)
43 host->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
45 for (i = 0; i < msg_global->max_channel; i++) {
46 sprintf(alias, "%s:%d", name, i);
48 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
49 host->mailboxes[i] = MSG_mailbox_new(alias);
50 memset(alias, 0, MAX_ALIAS_NAME + 1);
54 xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
59 /** \ingroup msg_host_management
60 * \brief Finds a m_host_t using its name.
62 * This is a name directory service
63 * \param name the name of an host.
64 * \return the corresponding host
66 m_host_t MSG_get_host_by_name(const char *name)
68 return (m_host_t) xbt_lib_get_or_null(host_lib,name,MSG_HOST_LEVEL);
71 /** \ingroup m_host_management
73 * \brief Set the user data of a #m_host_t.
75 * This functions checks whether some data has already been associated to \a host
76 or not and attach \a data to \a host if it is possible.
78 MSG_error_t MSG_host_set_data(m_host_t host, void *data)
80 SIMIX_host_set_data(host->smx_host,data);
85 /** \ingroup m_host_management
87 * \brief Return the user data of a #m_host_t.
89 * This functions checks whether \a host is a valid pointer or not and return
90 the user data associated to \a host if it is possible.
92 void *MSG_host_get_data(m_host_t host)
94 return SIMIX_host_get_data(host->smx_host);
97 /** \ingroup m_host_management
99 * \brief Return the name of the #m_host_t.
101 * This functions checks whether \a host is a valid pointer or not and return
104 const char *MSG_host_get_name(m_host_t host) {
105 return SIMIX_host_get_name(host->smx_host);
108 /** \ingroup m_host_management
110 * \brief Return the location on which the current process is executed.
112 m_host_t MSG_host_self(void)
114 return MSG_process_get_host(NULL);
117 /** \ingroup m_host_management
119 * \brief Destroys a host (internal call only)
121 void __MSG_host_destroy(m_host_t host) {
123 #ifdef MSG_USE_DEPRECATED
124 if (msg_global->max_channel > 0)
125 free(host->mailboxes);
127 if (xbt_swag_size(host->vms) > 0 ) {
128 XBT_VERB("Host %s shut down, but it still hosts %d VMs. They will be leaked.",
129 MSG_host_get_name(host),xbt_swag_size(host->vms));
131 xbt_swag_free(host->vms);
135 #ifdef MSG_USE_DEPRECATED
136 int MSG_get_host_number(void)
138 return xbt_lib_length(host_lib);
141 m_host_t *MSG_get_host_table(void)
145 xbt_lib_cursor_t cursor;
149 if (xbt_lib_length(host_lib) == 0)
152 array = xbt_new0(void *, xbt_lib_length(host_lib));
154 xbt_lib_foreach(host_lib, cursor, key, data) {
155 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
156 array[i++] = data[MSG_HOST_LEVEL];
159 return (m_host_t *)array;
163 /** \ingroup m_host_management
164 * \brief Return a dynar containing all the hosts declared at a given point of time
166 xbt_dynar_t MSG_hosts_as_dynar(void) {
167 xbt_lib_cursor_t cursor;
170 xbt_dynar_t res = xbt_dynar_new(sizeof(m_host_t),NULL);
172 xbt_lib_foreach(host_lib, cursor, key, data) {
173 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
174 xbt_dynar_push(res, data + MSG_HOST_LEVEL);
179 /** \ingroup m_host_management
180 * \brief Return the number of MSG tasks currently running on a
181 * #m_host_t. The external load is not taken in account.
183 int MSG_get_host_msgload(m_host_t h)
185 xbt_assert((h != NULL), "Invalid parameters");
186 xbt_die( "Not implemented yet");
191 /** \ingroup m_host_management
192 * \brief Return the speed of the processor (in flop/s), regardless of
193 the current load on the machine.
195 double MSG_get_host_speed(m_host_t h)
197 xbt_assert((h != NULL), "Invalid parameters");
199 return (simcall_host_get_speed(h->smx_host));
202 /** \ingroup m_host_management
203 * \brief Returns the value of a given host property
206 * \param name a property name
207 * \return value of a property (or NULL if property not set)
209 const char *MSG_host_get_property_value(m_host_t host, const char *name)
211 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
214 /** \ingroup m_host_management
215 * \brief Returns a xbt_dynar_t consisting of the list of properties assigned to this host
218 * \return a dict containing the properties
220 xbt_dict_t MSG_host_get_properties(m_host_t host)
222 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
224 return (simcall_host_get_properties(host->smx_host));
227 /** \ingroup m_host_management
228 * \brief Change the value of a given host property
231 * \param name a property name
232 * \param value what to change the property to
233 * \param free_ctn the freeing function to use to kill the value on need
235 void MSG_host_set_property_value(m_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
237 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
241 /** \ingroup msg_gos_functions
242 * \brief Determine if a host is available.
244 * \param host host to test
245 * \return Returns 1 if host is available, 0 otherwise
247 int MSG_host_is_avail(m_host_t host)
249 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
250 return (simcall_host_get_state(host->smx_host));