Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'dvfs'
[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 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
14
15 /** @addtogroup m_host_management
16  *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
17  * (#msg_host_t) and the functions for managing it.
18  *  
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.
25  *  \see msg_host_t
26  */
27
28 /********************************* Host **************************************/
29 msg_host_t __MSG_host_create(smx_host_t workstation)
30 {
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
34
35   host->vms = xbt_swag_new(xbt_swag_offset(vm,host_vms_hookup));
36
37 #ifdef MSG_USE_DEPRECATED
38   int i;
39   char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
40
41   if (msg_global->max_channel > 0)
42     host->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
43
44   for (i = 0; i < msg_global->max_channel; i++) {
45     sprintf(alias, "%s:%d", name, i);
46
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);
50   }
51 #endif
52
53   xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
54   
55   return xbt_lib_get_elm_or_null(host_lib, name);
56 }
57
58
59 /** \ingroup msg_host_management
60  * \brief Finds a msg_host_t using its name.
61  *
62  * This is a name directory service
63  * \param name the name of an host.
64  * \return the corresponding host
65  */
66 msg_host_t MSG_get_host_by_name(const char *name)
67 {
68   return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
69 }
70
71 /** \ingroup m_host_management
72  *
73  * \brief Set the user data of a #msg_host_t.
74  *
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.
77  */
78 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
79 {
80   SIMIX_host_set_data(host,data);
81
82   return MSG_OK;
83 }
84
85 /** \ingroup m_host_management
86  *
87  * \brief Return the user data of a #msg_host_t.
88  *
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.
91  */
92 void *MSG_host_get_data(msg_host_t host)
93 {
94   return SIMIX_host_get_data(host);
95 }
96
97 /** \ingroup m_host_management
98  *
99  * \brief Return the name of the #msg_host_t.
100  *
101  * This functions checks whether \a host is a valid pointer or not and return
102    its name.
103  */
104 const char *MSG_host_get_name(msg_host_t host) {
105   return SIMIX_host_get_name(host);
106 }
107
108 /** \ingroup m_host_management
109  *
110  * \brief Return the location on which the current process is executed.
111  */
112 msg_host_t MSG_host_self(void)
113 {
114   return MSG_process_get_host(NULL);
115 }
116
117 /*
118  * \brief Destroys a host (internal call only)
119  */
120 void __MSG_host_destroy(msg_host_priv_t host) {
121
122 #ifdef MSG_USE_DEPRECATED
123   if (msg_global->max_channel > 0)
124     free(host->mailboxes);
125 #endif
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));
128   }
129   xbt_swag_free(host->vms);
130   free(host);
131 }
132
133 /** \ingroup m_host_management
134  * \brief Return the current number MSG hosts.
135  */
136 int MSG_get_host_number(void)
137 {
138   return xbt_lib_length(host_lib);
139 }
140
141 #ifdef MSG_USE_DEPRECATED
142 msg_host_t *MSG_get_host_table(void)
143 {
144       void **array;
145     int i = 0;
146     xbt_lib_cursor_t cursor;
147     char *key;
148     void **data;
149
150     if (xbt_lib_length(host_lib) == 0)
151     return NULL;
152     else
153     array = xbt_new0(void *, xbt_lib_length(host_lib));
154
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];
158     }
159
160     return (msg_host_t *)array;
161 }
162 #endif
163
164 /** \ingroup m_host_management
165  * \brief Return a dynar containing all the hosts declared at a given point of time
166  */
167 xbt_dynar_t MSG_hosts_as_dynar(void) {
168   xbt_lib_cursor_t cursor;
169   char *key;
170   void **data;
171   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
172
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);
177     }
178   }
179   return res;
180 }
181
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.
185  */
186 int MSG_get_host_msgload(msg_host_t h)
187 {
188   xbt_assert((h != NULL), "Invalid parameters");
189   xbt_die( "Not implemented yet");
190
191   return (0);
192 }
193
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.
197  */
198 double MSG_get_host_speed(msg_host_t h)
199 {
200   xbt_assert((h != NULL), "Invalid parameters");
201
202   return (simcall_host_get_speed(h));
203 }
204
205
206 /** \ingroup m_host_management
207  * \brief Return the number of cores.
208  *
209  * \param host a host
210  * \return the number of cores
211  */
212 int MSG_host_get_core_number(msg_host_t h)
213 {
214   xbt_assert((h != NULL), "Invalid parameters");
215
216   return (simcall_host_get_core(h));
217 }
218
219 /** \ingroup m_host_management
220  * \brief Return the list of processes attached to an host.
221  *
222  * \param host a host
223  * \return a swag with the attached processes
224  */
225 xbt_swag_t MSG_host_get_process_list(msg_host_t h)
226 {
227   xbt_assert((h != NULL), "Invalid parameters");
228
229   return (simcall_host_get_process_list(h));
230 }
231
232
233 /** \ingroup m_host_management
234  * \brief Returns the value of a given host property
235  *
236  * \param host a host
237  * \param name a property name
238  * \return value of a property (or NULL if property not set)
239  */
240 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
241 {
242   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
243 }
244
245 /** \ingroup m_host_management
246  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
247  *
248  * \param host a host
249  * \return a dict containing the properties
250  */
251 xbt_dict_t MSG_host_get_properties(msg_host_t host)
252 {
253   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
254
255   return (simcall_host_get_properties(host));
256 }
257
258 /** \ingroup m_host_management
259  * \brief Change the value of a given host property
260  *
261  * \param host a host
262  * \param name a property name
263  * \param value what to change the property to
264  * \param free_ctn the freeing function to use to kill the value on need
265  */
266 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
267
268   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
269 }
270
271
272 /** \ingroup msg_gos_functions
273  * \brief Determine if a host is available.
274  *
275  * \param host host to test
276  * \return Returns 1 if host is available, 0 otherwise
277  */
278 int MSG_host_is_avail(msg_host_t host)
279 {
280   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
281   return (simcall_host_get_state(host));
282 }
283
284 /** \ingroup m_host_management
285  * \brief Return the speed of the processor (in flop/s) at a given pstate
286  *
287  * \param  host host to test
288  * \param pstate_index pstate to test
289  * \return Returns the processor speed associated with pstate_index
290  */
291 double MSG_get_host_power_peak_at(msg_host_t host, int pstate_index) {
292           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
293           return (simcall_host_get_power_peak_at(host, pstate_index));
294 }
295
296 /** \ingroup m_host_management
297  * \brief Return the current speed of the processor (in flop/s)
298  *
299  * \param  host host to test
300  * \return Returns the current processor speed
301  */
302 double MSG_get_host_current_power_peak(msg_host_t host) {
303           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
304           return simcall_host_get_current_power_peak(host);
305 }
306
307 /** \ingroup m_host_management
308  * \brief Return the number of pstates defined for a host
309  *
310  * \param  host host to test
311  */
312 int MSG_get_host_nb_pstates(msg_host_t host) {
313
314           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
315           return (simcall_host_get_nb_pstates(host));
316 }
317
318 /** \ingroup m_host_management
319  * \brief Sets the speed of the processor (in flop/s) at a given pstate
320  *
321  * \param  host host to test
322  * \param pstate_index pstate to switch to
323  */
324 void MSG_set_host_power_peak_at(msg_host_t host, int pstate_index) {
325           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
326
327           simcall_host_set_power_peak_at(host, pstate_index);
328 }
329
330 /** \ingroup m_host_management
331  * \brief Return the total energy consumed by a host (in Joules)
332  *
333  * \param  host host to test
334  * \return Returns the consumed energy
335  */
336 double MSG_get_host_consumed_energy(msg_host_t host) {
337           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
338           return simcall_host_get_consumed_energy(host);
339 }
340
341