1 /* Copyright (c) 2004-2014. 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(sg_host_t host) // FIXME: don't return our parameter
31 msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
33 #ifdef MSG_USE_DEPRECATED
35 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
37 priv->mailboxes = (msg_global->max_channel > 0) ?
38 xbt_new0(msg_mailbox_t, msg_global->max_channel) : NULL;
40 for (i = 0; i < msg_global->max_channel; i++) {
41 sprintf(alias, "%s:%d", name, i);
43 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
44 priv->mailboxes[i] = MSG_mailbox_new(alias);
45 memset(alias, 0, MAX_ALIAS_NAME + 1);
50 priv->dp_objs = xbt_dict_new();
52 priv->dp_updated_by_deleted_tasks = 0;
53 priv->is_migrating = 0;
55 priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
57 sg_host_msg_set(host,priv);
62 /** \ingroup m_host_management
63 * \brief Finds a msg_host_t using its name.
65 * This is a name directory service
66 * \param name the name of an host.
67 * \return the corresponding host
69 msg_host_t MSG_host_by_name(const char *name)
71 return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
74 static const char *msg_data = "data";
75 /** \ingroup m_host_management
77 * \brief Set the user data of a #msg_host_t.
79 * This functions checks whether some data has already been associated to \a host
80 or not and attach \a data to \a host if it is possible.
82 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
84 MSG_host_set_property_value(host, msg_data, data, NULL);
88 /** \ingroup m_host_management
90 * \brief Return the user data of a #msg_host_t.
92 * This functions checks whether \a host is a valid pointer or not and return
93 the user data associated to \a host if it is possible.
95 void *MSG_host_get_data(msg_host_t host)
97 return (void *)MSG_host_get_property_value(host, msg_data);
100 /** \ingroup m_host_management
102 * \brief Return the name of the #msg_host_t.
104 * This functions checks whether \a host is a valid pointer or not and return
107 const char *MSG_host_get_name(msg_host_t host) {
108 return SIMIX_host_get_name(host);
111 /** \ingroup m_host_management
113 * \brief Return the location on which the current process is executed.
115 msg_host_t MSG_host_self(void)
117 return MSG_process_get_host(NULL);
121 /** \ingroup m_host_management
123 * \brief Start the host if it is off
125 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
127 void MSG_host_on(msg_host_t host)
129 simcall_host_on(host);
132 /** \ingroup m_host_management
134 * \brief Stop the host if it is on
136 * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
138 void MSG_host_off(msg_host_t host)
140 simcall_host_off(host);
144 * \brief Frees private data of a host (internal call only)
146 void __MSG_host_priv_free(msg_host_priv_t priv)
148 unsigned int size = xbt_dict_size(priv->dp_objs);
150 XBT_WARN("dp_objs: %u pending task?", size);
151 xbt_dict_free(&priv->dp_objs);
152 xbt_dict_free(&priv->affinity_mask_db);
154 #ifdef MSG_USE_DEPRECATED
155 free(priv->mailboxes);
162 * \brief Destroys a host (internal call only)
164 void __MSG_host_destroy(msg_host_t host)
167 * What happens if VMs still remain on this host?
168 * Revisit here after the surf layer gets stable.
170 sg_host_msg_destroy(host);
173 /** \ingroup m_host_management
174 * \brief Return the current number MSG hosts.
176 int MSG_get_host_number(void)
178 return xbt_lib_length(host_lib);
181 #ifdef MSG_USE_DEPRECATED
182 msg_host_t *MSG_get_host_table(void)
186 xbt_lib_cursor_t cursor;
190 if (xbt_lib_length(host_lib) == 0)
193 array = xbt_new0(void *, xbt_lib_length(host_lib));
195 xbt_lib_foreach(host_lib, cursor, key, data) {
196 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
197 array[i++] = data[MSG_HOST_LEVEL];
200 return (msg_host_t *)array;
204 /** \ingroup m_host_management
205 * \brief Return a dynar containing all the hosts declared at a given point of time
206 * \remark The host order in the returned array is generally different from the host creation/declaration order in the XML platform (we use a hash table internally)
208 xbt_dynar_t MSG_hosts_as_dynar(void) {
209 xbt_lib_cursor_t cursor;
212 xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
214 xbt_lib_foreach(host_lib, cursor, key, data) {
215 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
216 xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
217 xbt_dynar_push(res, &elm);
223 /** \ingroup m_host_management
224 * \brief Return the number of MSG tasks currently running on a
225 * #msg_host_t. The external load is not taken in account.
227 int MSG_get_host_msgload(msg_host_t h)
229 xbt_assert((h != NULL), "Invalid parameters");
230 xbt_die( "Not implemented yet");
235 /** \ingroup m_host_management
236 * \brief Return the speed of the processor (in flop/s), regardless of
237 the current load on the machine.
239 double MSG_get_host_speed(msg_host_t h)
241 xbt_assert((h != NULL), "Invalid parameters");
243 return (simcall_host_get_speed(h));
247 /** \ingroup m_host_management
248 * \brief Return the number of cores.
251 * \return the number of cores
253 int MSG_host_get_core_number(msg_host_t host)
255 xbt_assert((host != NULL), "Invalid parameters");
257 return (simcall_host_get_core(host));
260 /** \ingroup m_host_management
261 * \brief Return the list of processes attached to an host.
264 * \return a swag with the attached processes
266 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
268 xbt_assert((host != NULL), "Invalid parameters");
270 return (simcall_host_get_process_list(host));
274 /** \ingroup m_host_management
275 * \brief Returns the value of a given host property
278 * \param name a property name
279 * \return value of a property (or NULL if property not set)
281 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
283 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
286 /** \ingroup m_host_management
287 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
290 * \return a dict containing the properties
292 xbt_dict_t MSG_host_get_properties(msg_host_t host)
294 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
296 return (simcall_host_get_properties(host));
299 /** \ingroup m_host_management
300 * \brief Change the value of a given host property
303 * \param name a property name
304 * \param value what to change the property to
305 * \param free_ctn the freeing function to use to kill the value on need
307 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
309 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
313 /** @ingroup m_host_management
315 * @brief Determine if a host is up and running.
317 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
319 * @param host host to test
320 * @return Returns true if the host is up and running, and false if it's currently down
322 int MSG_host_is_on(msg_host_t host)
324 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
325 return (simcall_host_get_state(host));
327 /** @ingroup m_host_management
329 * @brief Determine if a host is currently off.
331 * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
333 int MSG_host_is_off(msg_host_t host)
335 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
336 return !(simcall_host_get_state(host));
339 /** \ingroup m_host_management
340 * \brief Set the parameters of a given host
343 * \param params a prameter object
345 void MSG_host_set_params(msg_host_t host, ws_params_t params)
347 simcall_host_set_params(host, params);
350 /** \ingroup m_host_management
351 * \brief Get the parameters of a given host
354 * \param params a prameter object
356 void MSG_host_get_params(msg_host_t host, ws_params_t params)
358 simcall_host_get_params(host, params);
361 /** \ingroup m_host_management
362 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
364 * \param host host to test
365 * \param pstate_index pstate to test
366 * \return Returns the processor speed associated with pstate_index
368 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
369 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
370 return (simcall_host_get_power_peak_at(host, pstate_index));
373 /** \ingroup m_host_management
374 * \brief Return the current speed of the processor (in flop/s)
376 * \param host host to test
377 * \return Returns the current processor speed
379 double MSG_host_get_current_power_peak(msg_host_t host) {
380 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
381 return simcall_host_get_current_power_peak(host);
384 /** \ingroup m_host_management
385 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
387 * \param host host to test
389 int MSG_host_get_nb_pstates(msg_host_t host) {
391 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
392 return (simcall_host_get_nb_pstates(host));
395 /** \ingroup m_host_management
396 * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
398 * \param host host to test
399 * \param pstate_index pstate to switch to
401 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
402 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
404 simcall_host_set_pstate(host, pstate_index);
406 /** \ingroup m_host_management
407 * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
409 * \param host host to test
411 int MSG_host_get_pstate(msg_host_t host) {
412 return simcall_host_get_pstate(host);
415 /** \ingroup m_host_management
416 * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
418 * \param host host to test
419 * \return Returns the consumed energy
421 double MSG_host_get_consumed_energy(msg_host_t host) {
422 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
423 return simcall_host_get_consumed_energy(host);
425 /** \ingroup m_host_management
426 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
429 double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
430 return simcall_host_get_wattmin_at(host, pstate);
432 /** \ingroup m_host_management
433 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
436 double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
437 return simcall_host_get_wattmax_at(host, pstate);
439 /** \ingroup m_host_management
440 * \brief Set the parameters of a given host
443 * \param params a prameter object
446 /** \ingroup m_host_management
447 * \brief Return the list of mount point names on an host.
449 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
451 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
453 xbt_assert((host != NULL), "Invalid parameters");
454 return (simcall_host_get_mounted_storage_list(host));
457 /** \ingroup m_host_management
458 * \brief Return the list of storages attached to an host.
460 * \return a dynar containing all storages (name) attached to the host
462 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
464 xbt_assert((host != NULL), "Invalid parameters");
465 return (simcall_host_get_attached_storage_list(host));
468 /** \ingroup m_host_management
469 * \brief Return the content of mounted storages on an host.
471 * \return a dict containing content (as a dict) of all storages mounted on the host
473 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
475 xbt_assert((host != NULL), "Invalid parameters");
476 xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
477 msg_storage_t storage;
480 xbt_dict_cursor_t cursor = NULL;
482 xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
484 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
485 storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
486 xbt_dict_t content = simcall_storage_get_content(storage);
487 xbt_dict_set(contents,mount_name, content,NULL);
489 xbt_dict_free(&storage_list);