Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
dfa729e1cfe90497fef5cf196568648058256960
[simgrid.git] / src / msg / msg_host.c
1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "msg/msg_private.h"
8 #include "msg/msg_mailbox.h"
9 #include "xbt/sysdep.h"
10 #include "xbt/log.h"
11 #include "simgrid/simix.h"
12
13 /** @addtogroup m_host_management
14  *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
15  * (#m_host_t) and the functions for managing it.
16  *  
17  *  A <em>location</em> (or <em>host</em>) is any possible place where
18  *  a process may run. Thus it may be represented as a
19  *  <em>physical resource with computing capabilities</em>, some
20  *  <em>mailboxes</em> to enable running process to communicate with
21  *  remote ones, and some <em>private data</em> that can be only
22  *  accessed by local process.
23  *  \see m_host_t
24  */
25
26 /********************************* Host **************************************/
27 m_host_t __MSG_host_create(smx_host_t workstation)
28 {
29   const char *name = SIMIX_host_get_name(workstation);
30   m_host_t host = xbt_new0(s_m_host_t, 1);
31
32   host->smx_host = workstation;
33
34 #ifdef MSG_USE_DEPRECATED
35   int i;
36   char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
37
38   if (msg_global->max_channel > 0)
39     host->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
40
41   for (i = 0; i < msg_global->max_channel; i++) {
42     sprintf(alias, "%s:%d", name, i);
43
44     /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
45     host->mailboxes[i] = MSG_mailbox_new(alias);
46     memset(alias, 0, MAX_ALIAS_NAME + 1);
47   }
48 #endif
49
50   xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
51
52   return host;
53 }
54
55 /** \ingroup msg_host_management
56  * \brief Finds a m_host_t using its name.
57  *
58  * This is a name directory service
59  * \param name the name of an host.
60  * \return the corresponding host
61  */
62 m_host_t MSG_get_host_by_name(const char *name)
63 {
64   return (m_host_t) xbt_lib_get_or_null(host_lib,name,MSG_HOST_LEVEL);
65 }
66
67 /** \ingroup m_host_management
68  *
69  * \brief Set the user data of a #m_host_t.
70  *
71  * This functions checks whether some data has already been associated to \a host 
72    or not and attach \a data to \a host if it is possible.
73  */
74 MSG_error_t MSG_host_set_data(m_host_t host, void *data)
75 {
76   SIMIX_host_set_data(host->smx_host,data);
77
78   return MSG_OK;
79 }
80
81 /** \ingroup m_host_management
82  *
83  * \brief Return the user data of a #m_host_t.
84  *
85  * This functions checks whether \a host is a valid pointer or not and return
86    the user data associated to \a host if it is possible.
87  */
88 void *MSG_host_get_data(m_host_t host)
89 {
90   return SIMIX_host_get_data(host->smx_host);
91 }
92
93 /** \ingroup m_host_management
94  *
95  * \brief Return the name of the #m_host_t.
96  *
97  * This functions checks whether \a host is a valid pointer or not and return
98    its name.
99  */
100 const char *MSG_host_get_name(m_host_t host) {
101   return SIMIX_host_get_name(host->smx_host);
102 }
103
104 /** \ingroup m_host_management
105  *
106  * \brief Return the location on which the current process is executed.
107  */
108 m_host_t MSG_host_self(void)
109 {
110   return MSG_process_get_host(NULL);
111 }
112
113 /** \ingroup m_host_management
114  *
115  * \brief Destroys a host (internal call only)
116  */
117 void __MSG_host_destroy(m_host_t host) {
118
119 #ifdef MSG_USE_DEPRECATED
120   if (msg_global->max_channel > 0)
121     free(host->mailboxes);
122 #endif
123
124   free(host);
125 }
126
127 #ifdef MSG_USE_DEPRECATED
128 int MSG_get_host_number(void)
129 {
130   return xbt_lib_length(host_lib);
131 }
132
133 m_host_t *MSG_get_host_table(void)
134 {
135       void **array;
136           int i = 0;
137           xbt_lib_cursor_t cursor;
138           char *key;
139           void **data;
140
141           if (xbt_lib_length(host_lib) == 0)
142                 return NULL;
143           else
144                 array = xbt_new0(void *, xbt_lib_length(host_lib));
145
146           xbt_lib_foreach(host_lib, cursor, key, data) {
147             if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
148                 array[i++] = data[MSG_HOST_LEVEL];
149           }
150
151           return (m_host_t *)array;
152 }
153 #endif
154
155 /** \ingroup m_host_management
156  * \brief Return a dynar containing all the hosts declared at a given point of time
157  */
158 xbt_dynar_t MSG_hosts_as_dynar(void) {
159   xbt_lib_cursor_t cursor;
160   char *key;
161   void **data;
162   xbt_dynar_t res = xbt_dynar_new(sizeof(m_host_t),NULL);
163
164   xbt_lib_foreach(host_lib, cursor, key, data) {
165     if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
166       xbt_dynar_push(res, data + MSG_HOST_LEVEL);
167   }
168   return res;
169 }
170
171 /** \ingroup m_host_management
172  * \brief Return the number of MSG tasks currently running on a
173  * #m_host_t. The external load is not taken in account.
174  */
175 int MSG_get_host_msgload(m_host_t h)
176 {
177   xbt_assert((h != NULL), "Invalid parameters");
178   xbt_die( "Not implemented yet");
179
180   return (0);
181 }
182
183 /** \ingroup m_host_management
184  * \brief Return the speed of the processor (in flop/s), regardless of 
185     the current load on the machine.
186  */
187 double MSG_get_host_speed(m_host_t h)
188 {
189   xbt_assert((h != NULL), "Invalid parameters");
190
191   return (simcall_host_get_speed(h->smx_host));
192 }
193
194 /** \ingroup m_host_management
195  * \brief Returns the value of a given host property
196  *
197  * \param host a host
198  * \param name a property name
199  * \return value of a property (or NULL if property not set)
200  */
201 const char *MSG_host_get_property_value(m_host_t host, const char *name)
202 {
203   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
204 }
205
206 /** \ingroup m_host_management
207  * \brief Returns a xbt_dynar_t consisting of the list of properties assigned to this host
208  *
209  * \param host a host
210  * \return a dict containing the properties
211  */
212 xbt_dict_t MSG_host_get_properties(m_host_t host)
213 {
214   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
215
216   return (simcall_host_get_properties(host->smx_host));
217 }
218
219
220 /** \ingroup msg_gos_functions
221  * \brief Determine if a host is available.
222  *
223  * \param host host to test
224  * \return Returns 1 if host is available, 0 otherwise
225  */
226 int MSG_host_is_avail(m_host_t host)
227 {
228   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
229   return (simcall_host_get_state(host->smx_host));
230 }