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(smx_host_t workstation)
31 const char *name = SIMIX_host_get_name(workstation);
32 msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
34 #ifdef MSG_USE_DEPRECATED
36 char alias[MAX_ALIAS_NAME + 1] = { 0 }; /* buffer used to build the key of the mailbox */
38 priv->mailboxes = (msg_global->max_channel > 0) ?
39 xbt_new0(msg_mailbox_t, msg_global->max_channel) : NULL;
41 for (i = 0; i < msg_global->max_channel; i++) {
42 sprintf(alias, "%s:%d", name, i);
44 /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
45 priv->mailboxes[i] = MSG_mailbox_new(alias);
46 memset(alias, 0, MAX_ALIAS_NAME + 1);
51 priv->dp_objs = xbt_dict_new();
53 priv->dp_updated_by_deleted_tasks = 0;
54 priv->is_migrating = 0;
56 priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
58 xbt_lib_set(host_lib, name, MSG_HOST_LEVEL, priv);
60 return xbt_lib_get_elm_or_null(host_lib, name);
64 /** \ingroup msg_host_management
65 * \brief Finds a msg_host_t using its name.
67 * This is a name directory service
68 * \param name the name of an host.
69 * \return the corresponding host
71 msg_host_t MSG_get_host_by_name(const char *name)
73 return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
76 static const char *msg_data = "data";
77 /** \ingroup m_host_management
79 * \brief Set the user data of a #msg_host_t.
81 * This functions checks whether some data has already been associated to \a host
82 or not and attach \a data to \a host if it is possible.
84 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
86 MSG_host_set_property_value(host, msg_data, data, NULL);
90 /** \ingroup m_host_management
92 * \brief Return the user data of a #msg_host_t.
94 * This functions checks whether \a host is a valid pointer or not and return
95 the user data associated to \a host if it is possible.
97 void *MSG_host_get_data(msg_host_t host)
99 return (void *)MSG_host_get_property_value(host, msg_data);
102 /** \ingroup m_host_management
104 * \brief Return the name of the #msg_host_t.
106 * This functions checks whether \a host is a valid pointer or not and return
109 const char *MSG_host_get_name(msg_host_t host) {
110 return SIMIX_host_get_name(host);
113 /** \ingroup m_host_management
115 * \brief Return the location on which the current process is executed.
117 msg_host_t MSG_host_self(void)
119 return MSG_process_get_host(NULL);
123 /** \ingroup m_host_management
125 * \brief Start the host if it is off
127 * 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.
129 void MSG_host_on(msg_host_t host)
131 simcall_host_on(host);
134 /** \ingroup m_host_management
136 * \brief Stop the host if it is on
138 * 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.
140 void MSG_host_off(msg_host_t host)
142 simcall_host_off(host);
146 * \brief Frees private data of a host (internal call only)
148 void __MSG_host_priv_free(msg_host_priv_t priv)
150 unsigned int size = xbt_dict_size(priv->dp_objs);
152 XBT_WARN("dp_objs: %u pending task?", size);
153 xbt_dict_free(&priv->dp_objs);
154 xbt_dict_free(&priv->affinity_mask_db);
156 #ifdef MSG_USE_DEPRECATED
157 free(priv->mailboxes);
164 * \brief Destroys a host (internal call only)
166 void __MSG_host_destroy(msg_host_t host)
168 const char *name = MSG_host_get_name(host);
170 * What happens if VMs still remain on this host?
171 * Revisit here after the surf layer gets stable.
174 xbt_lib_unset(host_lib, name, MSG_HOST_LEVEL, 1);
177 /** \ingroup m_host_management
178 * \brief Return the current number MSG hosts.
180 int MSG_get_host_number(void)
182 return xbt_lib_length(host_lib);
185 #ifdef MSG_USE_DEPRECATED
186 msg_host_t *MSG_get_host_table(void)
190 xbt_lib_cursor_t cursor;
194 if (xbt_lib_length(host_lib) == 0)
197 array = xbt_new0(void *, xbt_lib_length(host_lib));
199 xbt_lib_foreach(host_lib, cursor, key, data) {
200 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
201 array[i++] = data[MSG_HOST_LEVEL];
204 return (msg_host_t *)array;
208 /** \ingroup m_host_management
209 * \brief Return a dynar containing all the hosts declared at a given point of time
210 * \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)
212 xbt_dynar_t MSG_hosts_as_dynar(void) {
213 xbt_lib_cursor_t cursor;
216 xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
218 xbt_lib_foreach(host_lib, cursor, key, data) {
219 if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
220 xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
221 xbt_dynar_push(res, &elm);
227 /** \ingroup m_host_management
228 * \brief Return the number of MSG tasks currently running on a
229 * #msg_host_t. The external load is not taken in account.
231 int MSG_get_host_msgload(msg_host_t h)
233 xbt_assert((h != NULL), "Invalid parameters");
234 xbt_die( "Not implemented yet");
239 /** \ingroup m_host_management
240 * \brief Return the speed of the processor (in flop/s), regardless of
241 the current load on the machine.
243 double MSG_get_host_speed(msg_host_t h)
245 xbt_assert((h != NULL), "Invalid parameters");
247 return (simcall_host_get_speed(h));
251 /** \ingroup m_host_management
252 * \brief Return the number of cores.
255 * \return the number of cores
257 int MSG_host_get_core_number(msg_host_t host)
259 xbt_assert((host != NULL), "Invalid parameters");
261 return (simcall_host_get_core(host));
264 /** \ingroup m_host_management
265 * \brief Return the list of processes attached to an host.
268 * \return a swag with the attached processes
270 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
272 xbt_assert((host != NULL), "Invalid parameters");
274 return (simcall_host_get_process_list(host));
278 /** \ingroup m_host_management
279 * \brief Returns the value of a given host property
282 * \param name a property name
283 * \return value of a property (or NULL if property not set)
285 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
287 return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
290 /** \ingroup m_host_management
291 * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
294 * \return a dict containing the properties
296 xbt_dict_t MSG_host_get_properties(msg_host_t host)
298 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
300 return (simcall_host_get_properties(host));
303 /** \ingroup m_host_management
304 * \brief Change the value of a given host property
307 * \param name a property name
308 * \param value what to change the property to
309 * \param free_ctn the freeing function to use to kill the value on need
311 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
313 xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
317 /** @ingroup m_host_management
319 * @brief Determine if a host is up and running.
321 * 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.
323 * @param host host to test
324 * @return Returns true if the host is up and running, and false if it's currently down
326 int MSG_host_is_on(msg_host_t host)
328 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
329 return (simcall_host_get_state(host));
331 /** @ingroup m_host_management
333 * @brief Determine if a host is currently off.
335 * 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.
337 int MSG_host_is_off(msg_host_t host)
339 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
340 return !(simcall_host_get_state(host));
343 /** \ingroup m_host_management
344 * \brief Set the parameters of a given host
347 * \param params a prameter object
349 void MSG_host_set_params(msg_host_t host, ws_params_t params)
351 simcall_host_set_params(host, params);
354 /** \ingroup m_host_management
355 * \brief Get the parameters of a given host
358 * \param params a prameter object
360 void MSG_host_get_params(msg_host_t host, ws_params_t params)
362 simcall_host_get_params(host, params);
365 /** \ingroup m_host_management
366 * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
368 * \param host host to test
369 * \param pstate_index pstate to test
370 * \return Returns the processor speed associated with pstate_index
372 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
373 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
374 return (simcall_host_get_power_peak_at(host, pstate_index));
377 /** \ingroup m_host_management
378 * \brief Return the current speed of the processor (in flop/s)
380 * \param host host to test
381 * \return Returns the current processor speed
383 double MSG_host_get_current_power_peak(msg_host_t host) {
384 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
385 return simcall_host_get_current_power_peak(host);
388 /** \ingroup m_host_management
389 * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
391 * \param host host to test
393 int MSG_host_get_nb_pstates(msg_host_t host) {
395 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
396 return (simcall_host_get_nb_pstates(host));
399 /** \ingroup m_host_management
400 * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
402 * \param host host to test
403 * \param pstate_index pstate to switch to
405 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
406 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
408 simcall_host_set_pstate(host, pstate_index);
410 /** \ingroup m_host_management
411 * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
413 * \param host host to test
415 int MSG_host_get_pstate(msg_host_t host) {
416 return simcall_host_get_pstate(host);
419 /** \ingroup m_host_management
420 * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
422 * \param host host to test
423 * \return Returns the consumed energy
425 double MSG_host_get_consumed_energy(msg_host_t host) {
426 xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
427 return simcall_host_get_consumed_energy(host);
429 /** \ingroup m_host_management
430 * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
433 double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
434 return simcall_host_get_wattmin_at(host, pstate);
436 /** \ingroup m_host_management
437 * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
440 double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
441 return simcall_host_get_wattmax_at(host, pstate);
443 /** \ingroup m_host_management
444 * \brief Set the parameters of a given host
447 * \param params a prameter object
450 /** \ingroup m_host_management
451 * \brief Return the list of mount point names on an host.
453 * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
455 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
457 xbt_assert((host != NULL), "Invalid parameters");
458 return (simcall_host_get_mounted_storage_list(host));
461 /** \ingroup m_host_management
462 * \brief Return the list of storages attached to an host.
464 * \return a dynar containing all storages (name) attached to the host
466 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
468 xbt_assert((host != NULL), "Invalid parameters");
469 return (simcall_host_get_attached_storage_list(host));
472 /** \ingroup msg_host_management
473 * \brief Return the content of mounted storages on an host.
475 * \return a dict containing content (as a dict) of all storages mounted on the host
477 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
479 xbt_assert((host != NULL), "Invalid parameters");
480 xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
481 msg_storage_t storage;
484 xbt_dict_cursor_t cursor = NULL;
486 xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
488 xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
489 storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
490 xbt_dict_t content = simcall_storage_get_content(storage);
491 xbt_dict_set(contents,mount_name, content,NULL);
493 xbt_dict_free(&storage_list);