src/msg/msg_host.c

   1 /* Copyright (c) 2004-2014. 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 priv = xbt_new0(s_msg_host_priv_t, 1);
  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   priv->mailboxes = (msg_global->max_channel > 0) ?
  39     xbt_new0(msg_mailbox_t, msg_global->max_channel) : NULL;
  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     priv->mailboxes[i] = MSG_mailbox_new(alias);
  46     memset(alias, 0, MAX_ALIAS_NAME + 1);
  47   }
  48 #endif
  49
  50
  51   priv->dp_objs = xbt_dict_new();
  52   priv->dp_enabled = 0;
  53   priv->dp_updated_by_deleted_tasks = 0;
  54   priv->is_migrating = 0;
  55
  56   priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
  57
  58   xbt_lib_set(host_lib, name, MSG_HOST_LEVEL, priv);
  59
  60   return xbt_lib_get_elm_or_null(host_lib, name);
  61 }
  62
  63
  64 /** \ingroup msg_host_management
  65  * \brief Finds a msg_host_t using its name.
  66  *
  67  * This is a name directory service
  68  * \param name the name of an host.
  69  * \return the corresponding host
  70  */
  71 msg_host_t MSG_get_host_by_name(const char *name)
  72 {
  73   return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
  74 }
  75
  76 static const char *msg_data = "data";
  77 /** \ingroup m_host_management
  78  *
  79  * \brief Set the user data of a #msg_host_t.
  80  *
  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.
  83  */
  84 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
  85 {
  86   MSG_host_set_property_value(host, msg_data, data, NULL);
  87   return MSG_OK;
  88 }
  89
  90 /** \ingroup m_host_management
  91  *
  92  * \brief Return the user data of a #msg_host_t.
  93  *
  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.
  96  */
  97 void *MSG_host_get_data(msg_host_t host)
  98 {
  99   return (void *)MSG_host_get_property_value(host, msg_data);
 100 }
 101
 102 /** \ingroup m_host_management
 103  *
 104  * \brief Return the name of the #msg_host_t.
 105  *
 106  * This functions checks whether \a host is a valid pointer or not and return
 107    its name.
 108  */
 109 const char *MSG_host_get_name(msg_host_t host) {
 110   return SIMIX_host_get_name(host);
 111 }
 112
 113 /** \ingroup m_host_management
 114  *
 115  * \brief Return the location on which the current process is executed.
 116  */
 117 msg_host_t MSG_host_self(void)
 118 {
 119   return MSG_process_get_host(NULL);
 120 }
 121
 122
 123 /** \ingroup m_host_management
 124  *
 125  * \brief Start the host if it is off
 126  *
 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.
 128  */
 129 void MSG_host_on(msg_host_t host)
 130 {
 131   simcall_host_on(host);
 132 }
 133
 134 /** \ingroup m_host_management
 135  *
 136  * \brief Stop the host if it is on
 137  *
 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.
 139  */
 140 void MSG_host_off(msg_host_t host)
 141 {
 142   simcall_host_off(host);
 143 }
 144
 145 /*
 146  * \brief Frees private data of a host (internal call only)
 147  */
 148 void __MSG_host_priv_free(msg_host_priv_t priv)
 149 {
 150   unsigned int size = xbt_dict_size(priv->dp_objs);
 151   if (size > 0)
 152     XBT_WARN("dp_objs: %u pending task?", size);
 153   xbt_dict_free(&priv->dp_objs);
 154   xbt_dict_free(&priv->affinity_mask_db);
 155
 156 #ifdef MSG_USE_DEPRECATED
 157   free(priv->mailboxes);
 158 #endif
 159
 160   free(priv);
 161 }
 162
 163 /*
 164  * \brief Destroys a host (internal call only)
 165  */
 166 void __MSG_host_destroy(msg_host_t host)
 167 {
 168   const char *name = MSG_host_get_name(host);
 169   /* TODO:
 170    * What happens if VMs still remain on this host?
 171    * Revisit here after the surf layer gets stable.
 172    **/
 173
 174   xbt_lib_unset(host_lib, name, MSG_HOST_LEVEL, 1);
 175 }
 176
 177 /** \ingroup m_host_management
 178  * \brief Return the current number MSG hosts.
 179  */
 180 int MSG_get_host_number(void)
 181 {
 182   return xbt_lib_length(host_lib);
 183 }
 184
 185 #ifdef MSG_USE_DEPRECATED
 186 msg_host_t *MSG_get_host_table(void)
 187 {
 188       void **array;
 189     int i = 0;
 190     xbt_lib_cursor_t cursor;
 191     char *key;
 192     void **data;
 193
 194     if (xbt_lib_length(host_lib) == 0)
 195     return NULL;
 196     else
 197     array = xbt_new0(void *, xbt_lib_length(host_lib));
 198
 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];
 202     }
 203
 204     return (msg_host_t *)array;
 205 }
 206 #endif
 207
 208 /** \ingroup m_host_management
 209  * \brief Return a dynar containing all the hosts declared at a given point of time
 210  */
 211 xbt_dynar_t MSG_hosts_as_dynar(void) {
 212   xbt_lib_cursor_t cursor;
 213   char *key;
 214   void **data;
 215   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
 216
 217   xbt_lib_foreach(host_lib, cursor, key, data) {
 218     if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
 219       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
 220       xbt_dynar_push(res, &elm);
 221     }
 222   }
 223   return res;
 224 }
 225
 226 /** \ingroup m_host_management
 227  * \brief Return the number of MSG tasks currently running on a
 228  * #msg_host_t. The external load is not taken in account.
 229  */
 230 int MSG_get_host_msgload(msg_host_t h)
 231 {
 232   xbt_assert((h != NULL), "Invalid parameters");
 233   xbt_die( "Not implemented yet");
 234
 235   return (0);
 236 }
 237
 238 /** \ingroup m_host_management
 239  * \brief Return the speed of the processor (in flop/s), regardless of
 240     the current load on the machine.
 241  */
 242 double MSG_get_host_speed(msg_host_t h)
 243 {
 244   xbt_assert((h != NULL), "Invalid parameters");
 245
 246   return (simcall_host_get_speed(h));
 247 }
 248
 249
 250 /** \ingroup m_host_management
 251  * \brief Return the number of cores.
 252  *
 253  * \param host a host
 254  * \return the number of cores
 255  */
 256 int MSG_host_get_core_number(msg_host_t host)
 257 {
 258   xbt_assert((host != NULL), "Invalid parameters");
 259
 260   return (simcall_host_get_core(host));
 261 }
 262
 263 /** \ingroup m_host_management
 264  * \brief Return the list of processes attached to an host.
 265  *
 266  * \param host a host
 267  * \return a swag with the attached processes
 268  */
 269 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 270 {
 271   xbt_assert((host != NULL), "Invalid parameters");
 272
 273   return (simcall_host_get_process_list(host));
 274 }
 275
 276
 277 /** \ingroup m_host_management
 278  * \brief Returns the value of a given host property
 279  *
 280  * \param host a host
 281  * \param name a property name
 282  * \return value of a property (or NULL if property not set)
 283  */
 284 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 285 {
 286   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 287 }
 288
 289 /** \ingroup m_host_management
 290  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 291  *
 292  * \param host a host
 293  * \return a dict containing the properties
 294  */
 295 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 296 {
 297   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 298
 299   return (simcall_host_get_properties(host));
 300 }
 301
 302 /** \ingroup m_host_management
 303  * \brief Change the value of a given host property
 304  *
 305  * \param host a host
 306  * \param name a property name
 307  * \param value what to change the property to
 308  * \param free_ctn the freeing function to use to kill the value on need
 309  */
 310 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 311
 312   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 313 }
 314
 315
 316 /** @ingroup m_host_management
 317  *
 318  * @brief Determine if a host is up and running.
 319  *
 320  * 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.
 321  *
 322  * @param host host to test
 323  * @return Returns true if the host is up and running, and false if it's currently down
 324  */
 325 int MSG_host_is_on(msg_host_t host)
 326 {
 327   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 328   return (simcall_host_get_state(host));
 329 }
 330 /** @ingroup m_host_management
 331  *
 332  * @brief Determine if a host is currently off.
 333  *
 334  * 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.
 335  */
 336 int MSG_host_is_off(msg_host_t host)
 337 {
 338   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 339   return !(simcall_host_get_state(host));
 340 }
 341
 342 /** \ingroup m_host_management
 343  * \brief Set the parameters of a given host
 344  *
 345  * \param host a host
 346  * \param params a prameter object
 347  */
 348 void MSG_host_set_params(msg_host_t host, ws_params_t params)
 349 {
 350   simcall_host_set_params(host, params);
 351 }
 352
 353 /** \ingroup m_host_management
 354  * \brief Get the parameters of a given host
 355  *
 356  * \param host a host
 357  * \param params a prameter object
 358  */
 359 void MSG_host_get_params(msg_host_t host, ws_params_t params)
 360 {
 361   simcall_host_get_params(host, params);
 362 }
 363
 364 /** \ingroup m_host_management
 365  * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 366  *
 367  * \param  host host to test
 368  * \param pstate_index pstate to test
 369  * \return Returns the processor speed associated with pstate_index
 370  */
 371 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
 372           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 373           return (simcall_host_get_power_peak_at(host, pstate_index));
 374 }
 375
 376 /** \ingroup m_host_management
 377  * \brief Return the current speed of the processor (in flop/s)
 378  *
 379  * \param  host host to test
 380  * \return Returns the current processor speed
 381  */
 382 double MSG_host_get_current_power_peak(msg_host_t host) {
 383           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 384           return simcall_host_get_current_power_peak(host);
 385 }
 386
 387 /** \ingroup m_host_management
 388  * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
 389  *
 390  * \param  host host to test
 391  */
 392 int MSG_host_get_nb_pstates(msg_host_t host) {
 393
 394           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 395           return (simcall_host_get_nb_pstates(host));
 396 }
 397
 398 /** \ingroup m_host_management
 399  * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 400  *
 401  * \param  host host to test
 402  * \param pstate_index pstate to switch to
 403  */
 404 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
 405           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 406
 407           simcall_host_set_pstate(host, pstate_index);
 408 }
 409 /** \ingroup m_host_management
 410  * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
 411  *
 412  * \param  host host to test
 413  */
 414 int MSG_host_get_pstate(msg_host_t host) {
 415           return simcall_host_get_pstate(host);
 416 }
 417
 418 /** \ingroup m_host_management
 419  * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
 420  *
 421  * \param  host host to test
 422  * \return Returns the consumed energy
 423  */
 424 double MSG_host_get_consumed_energy(msg_host_t host) {
 425           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 426           return simcall_host_get_consumed_energy(host);
 427 }
 428 /** \ingroup m_host_management
 429  * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
 430  *
 431  */
 432 double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
 433         return simcall_host_get_wattmin_at(host, pstate);
 434 }
 435 /** \ingroup m_host_management
 436  * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
 437  *
 438  */
 439 double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
 440         return simcall_host_get_wattmax_at(host, pstate);
 441 }
 442 /** \ingroup m_host_management
 443  * \brief Set the parameters of a given host
 444  *
 445  * \param host a host
 446  * \param params a prameter object
 447  */
 448
 449 /** \ingroup m_host_management
 450  * \brief Return the list of mount point names on an host.
 451  * \param host a host
 452  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 453  */
 454 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 455 {
 456   xbt_assert((host != NULL), "Invalid parameters");
 457   return (simcall_host_get_mounted_storage_list(host));
 458 }
 459
 460 /** \ingroup m_host_management
 461  * \brief Return the list of storages attached to an host.
 462  * \param host a host
 463  * \return a dynar containing all storages (name) attached to the host
 464  */
 465 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 466 {
 467   xbt_assert((host != NULL), "Invalid parameters");
 468   return (simcall_host_get_attached_storage_list(host));
 469 }
 470
 471 /** \ingroup msg_host_management
 472  * \brief Return the content of mounted storages on an host.
 473  * \param host a host
 474  * \return a dict containing content (as a dict) of all storages mounted on the host
 475  */
 476 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 477 {
 478   xbt_assert((host != NULL), "Invalid parameters");
 479   xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
 480   msg_storage_t storage;
 481   char* storage_name;
 482   char* mount_name;
 483   xbt_dict_cursor_t cursor = NULL;
 484
 485   xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
 486
 487   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 488     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 489     xbt_dict_t content = simcall_storage_get_content(storage);
 490     xbt_dict_set(contents,mount_name, content,NULL);
 491   }
 492   xbt_dict_free(&storage_list);
 493   return contents;
 494 }