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