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 * (#msg_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 msg_host_t __MSG_host_create(smx_host_t workstation)
31 const char *name = SIMIX_host_get_name(workstation);
32 msg_host_priv_t host = xbt_new0(s_msg_host_priv_t, 1);
33 s_msg_vm_t vm; // simply to compute the offset
35 host->vms = xbt_swag_new(xbt_swag_offset(vm,host_vms_hookup));
37 #ifdef MSG_USE_DEPRECATED
39 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
41 if (msg_global->max_channel > 0)
42 host->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
44 for (i = 0; i < msg_global->max_channel; i++) {
45 sprintf(alias, "%s:%d", name, i);
47 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
48 host->mailboxes[i] = MSG_mailbox_new(alias);
49 memset(alias, 0, MAX_ALIAS_NAME + 1);
53 xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
55 return xbt_lib_get_elm_or_null(host_lib, name);
59 /** \ingroup msg_host_management
60 * \brief Finds a msg_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 msg_host_t MSG_get_host_by_name(const char *name)
68 return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
71 /** \ingroup m_host_management
73 * \brief Set the user data of a #msg_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(msg_host_t host, void *data)
80 SIMIX_host_set_data(host,data);
85 /** \ingroup m_host_management
87 * \brief Return the user data of a #msg_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(msg_host_t host)
94 return SIMIX_host_get_data(host);
97 /** \ingroup m_host_management
99 * \brief Return the name of the #msg_host_t.
101 * This functions checks whether \a host is a valid pointer or not and return
104 const char *MSG_host_get_name(msg_host_t host) {
105 return SIMIX_host_get_name(host);
108 /** \ingroup m_host_management
110 * \brief Return the location on which the current process is executed.
112 msg_host_t MSG_host_self(void)
114 return MSG_process_get_host(NULL);
118 * \brief Destroys a host (internal call only)
120 void __MSG_host_destroy(msg_host_priv_t host) {
122 #ifdef MSG_USE_DEPRECATED
123 if (msg_global->max_channel > 0)
124 free(host->mailboxes);
126 if (xbt_swag_size(host->vms) > 0 ) {
127 XBT_VERB("Host shut down, but it still hosts %d VMs. They will be leaked.",xbt_swag_size(host->vms));
129 xbt_swag_free(host->vms);
133 /** \ingroup m_host_management
134 * \brief Return the current number MSG hosts.
136 int MSG_get_host_number(void)
138 return xbt_lib_length(host_lib);
141 #ifdef MSG_USE_DEPRECATED
142 msg_host_t *MSG_get_host_table(void)
146 xbt_lib_cursor_t cursor;
150 if (xbt_lib_length(host_lib) == 0)
153 array = xbt_new0(void *, xbt_lib_length(host_lib));
155 xbt_lib_foreach(host_lib, cursor, key, data) {
156 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
157 array[i++] = data[MSG_HOST_LEVEL];
160 return (msg_host_t *)array;
164 /** \ingroup m_host_management
165 * \brief Return a dynar containing all the hosts declared at a given point of time
167 xbt_dynar_t MSG_hosts_as_dynar(void) {
168 xbt_lib_cursor_t cursor;
171 xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
173 xbt_lib_foreach(host_lib, cursor, key, data) {
174 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
175 xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
176 xbt_dynar_push(res, &elm);
182 /** \ingroup m_host_management
183 * \brief Return the number of MSG tasks currently running on a
184 * #msg_host_t. The external load is not taken in account.
186 int MSG_get_host_msgload(msg_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(msg_host_t h)
200 xbt_assert((h != NULL), "Invalid parameters");
202 return (simcall_host_get_speed(h));
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(msg_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_dict_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(msg_host_t host)
225 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
227 return (simcall_host_get_properties(host));
230 /** \ingroup m_host_management
231 * \brief Change the value of a given host property
234 * \param name a property name
235 * \param value what to change the property to
236 * \param free_ctn the freeing function to use to kill the value on need
238 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
240 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
244 /** \ingroup msg_gos_functions
245 * \brief Determine if a host is available.
247 * \param host host to test
248 * \return Returns 1 if host is available, 0 otherwise
250 int MSG_host_is_avail(msg_host_t host)
252 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
253 return (simcall_host_get_state(host));