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 /*
 124  * \brief Start the host if it is off
 125  */
 126 void MSG_host_on(msg_host_t host)
 127 {
 128   simcall_host_on(host);
 129 }
 130
 131 /*
 132  * \brief Stop the host if it is on
 133  */
 134 void MSG_host_off(msg_host_t host)
 135 {
 136   simcall_host_off(host);
 137 }
 138
 139 /*
 140  * \brief Frees private data of a host (internal call only)
 141  */
 142 void __MSG_host_priv_free(msg_host_priv_t priv)
 143 {
 144   unsigned int size = xbt_dict_size(priv->dp_objs);
 145   if (size > 0)
 146     XBT_WARN("dp_objs: %u pending task?", size);
 147   xbt_dict_free(&priv->dp_objs);
 148   xbt_dict_free(&priv->affinity_mask_db);
 149
 150 #ifdef MSG_USE_DEPRECATED
 151   free(priv->mailboxes);
 152 #endif
 153
 154   free(priv);
 155 }
 156
 157 /*
 158  * \brief Destroys a host (internal call only)
 159  */
 160 void __MSG_host_destroy(msg_host_t host)
 161 {
 162   const char *name = MSG_host_get_name(host);
 163   /* TODO:
 164    * What happens if VMs still remain on this host?
 165    * Revisit here after the surf layer gets stable.
 166    **/
 167
 168   xbt_lib_unset(host_lib, name, MSG_HOST_LEVEL, 1);
 169 }
 170
 171 /** \ingroup m_host_management
 172  * \brief Return the current number MSG hosts.
 173  */
 174 int MSG_get_host_number(void)
 175 {
 176   return xbt_lib_length(host_lib);
 177 }
 178
 179 #ifdef MSG_USE_DEPRECATED
 180 msg_host_t *MSG_get_host_table(void)
 181 {
 182       void **array;
 183     int i = 0;
 184     xbt_lib_cursor_t cursor;
 185     char *key;
 186     void **data;
 187
 188     if (xbt_lib_length(host_lib) == 0)
 189     return NULL;
 190     else
 191     array = xbt_new0(void *, xbt_lib_length(host_lib));
 192
 193     xbt_lib_foreach(host_lib, cursor, key, data) {
 194       if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
 195         array[i++] = data[MSG_HOST_LEVEL];
 196     }
 197
 198     return (msg_host_t *)array;
 199 }
 200 #endif
 201
 202 /** \ingroup m_host_management
 203  * \brief Return a dynar containing all the hosts declared at a given point of time
 204  */
 205 xbt_dynar_t MSG_hosts_as_dynar(void) {
 206   xbt_lib_cursor_t cursor;
 207   char *key;
 208   void **data;
 209   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
 210
 211   xbt_lib_foreach(host_lib, cursor, key, data) {
 212     if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
 213       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
 214       xbt_dynar_push(res, &elm);
 215     }
 216   }
 217   return res;
 218 }
 219
 220 /** \ingroup m_host_management
 221  * \brief Return the number of MSG tasks currently running on a
 222  * #msg_host_t. The external load is not taken in account.
 223  */
 224 int MSG_get_host_msgload(msg_host_t h)
 225 {
 226   xbt_assert((h != NULL), "Invalid parameters");
 227   xbt_die( "Not implemented yet");
 228
 229   return (0);
 230 }
 231
 232 /** \ingroup m_host_management
 233  * \brief Return the speed of the processor (in flop/s), regardless of
 234     the current load on the machine.
 235  */
 236 double MSG_get_host_speed(msg_host_t h)
 237 {
 238   xbt_assert((h != NULL), "Invalid parameters");
 239
 240   return (simcall_host_get_speed(h));
 241 }
 242
 243
 244 /** \ingroup m_host_management
 245  * \brief Return the number of cores.
 246  *
 247  * \param host a host
 248  * \return the number of cores
 249  */
 250 int MSG_host_get_core_number(msg_host_t host)
 251 {
 252   xbt_assert((host != NULL), "Invalid parameters");
 253
 254   return (simcall_host_get_core(host));
 255 }
 256
 257 /** \ingroup m_host_management
 258  * \brief Return the list of processes attached to an host.
 259  *
 260  * \param host a host
 261  * \return a swag with the attached processes
 262  */
 263 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 264 {
 265   xbt_assert((host != NULL), "Invalid parameters");
 266
 267   return (simcall_host_get_process_list(host));
 268 }
 269
 270
 271 /** \ingroup m_host_management
 272  * \brief Returns the value of a given host property
 273  *
 274  * \param host a host
 275  * \param name a property name
 276  * \return value of a property (or NULL if property not set)
 277  */
 278 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 279 {
 280   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 281 }
 282
 283 /** \ingroup m_host_management
 284  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 285  *
 286  * \param host a host
 287  * \return a dict containing the properties
 288  */
 289 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 290 {
 291   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 292
 293   return (simcall_host_get_properties(host));
 294 }
 295
 296 /** \ingroup m_host_management
 297  * \brief Change the value of a given host property
 298  *
 299  * \param host a host
 300  * \param name a property name
 301  * \param value what to change the property to
 302  * \param free_ctn the freeing function to use to kill the value on need
 303  */
 304 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 305
 306   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 307 }
 308
 309
 310 /** @ingroup msg_gos_functions
 311  * @brief Determine if a host is up and running.
 312  *
 313  * @param host host to test
 314  * @return Returns true if the host is up and running, and false if it's currently down
 315  */
 316 int MSG_host_is_on(msg_host_t host)
 317 {
 318   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 319   return (simcall_host_get_state(host));
 320 }
 321 /** @ingroup msg_gos_functions
 322  * @brief Determine if a host is currently off.
 323  */
 324 int MSG_host_is_off(msg_host_t host)
 325 {
 326   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 327   return !(simcall_host_get_state(host));
 328 }
 329
 330 /** \ingroup m_host_management
 331  * \brief Set the parameters of a given host
 332  *
 333  * \param host a host
 334  * \param params a prameter object
 335  */
 336 void MSG_host_set_params(msg_host_t host, ws_params_t params)
 337 {
 338   simcall_host_set_params(host, params);
 339 }
 340
 341 /** \ingroup m_host_management
 342  * \brief Get the parameters of a given host
 343  *
 344  * \param host a host
 345  * \param params a prameter object
 346  */
 347 void MSG_host_get_params(msg_host_t host, ws_params_t params)
 348 {
 349   simcall_host_get_params(host, params);
 350 }
 351
 352 /** \ingroup m_host_management
 353  * \brief Return the speed of the processor (in flop/s) at a given pstate
 354  *
 355  * \param  host host to test
 356  * \param pstate_index pstate to test
 357  * \return Returns the processor speed associated with pstate_index
 358  */
 359 double MSG_get_host_power_peak_at(msg_host_t host, int pstate_index) {
 360           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 361           return (simcall_host_get_power_peak_at(host, pstate_index));
 362 }
 363
 364 /** \ingroup m_host_management
 365  * \brief Return the current speed of the processor (in flop/s)
 366  *
 367  * \param  host host to test
 368  * \return Returns the current processor speed
 369  */
 370 double MSG_get_host_current_power_peak(msg_host_t host) {
 371           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 372           return simcall_host_get_current_power_peak(host);
 373 }
 374
 375 /** \ingroup m_host_management
 376  * \brief Return the number of pstates defined for a host
 377  *
 378  * \param  host host to test
 379  */
 380 int MSG_get_host_nb_pstates(msg_host_t host) {
 381
 382           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 383           return (simcall_host_get_nb_pstates(host));
 384 }
 385
 386 /** \ingroup m_host_management
 387  * \brief Sets the speed of the processor (in flop/s) at a given pstate
 388  *
 389  * \param  host host to test
 390  * \param pstate_index pstate to switch to
 391  */
 392 void MSG_set_host_power_peak_at(msg_host_t host, int pstate_index) {
 393           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 394
 395           simcall_host_set_power_peak_at(host, pstate_index);
 396 }
 397
 398 /** \ingroup m_host_management
 399  * \brief Return the total energy consumed by a host (in Joules)
 400  *
 401  * \param  host host to test
 402  * \return Returns the consumed energy
 403  */
 404 double MSG_get_host_consumed_energy(msg_host_t host) {
 405           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 406           return simcall_host_get_consumed_energy(host);
 407 }
 408
 409 /** \ingroup m_host_management
 410  * \brief Return the list of mount point names on an host.
 411  * \param host a host
 412  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 413  */
 414 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 415 {
 416   xbt_assert((host != NULL), "Invalid parameters");
 417   return (simcall_host_get_mounted_storage_list(host));
 418 }
 419
 420 /** \ingroup m_host_management
 421  * \brief Return the list of storages attached to an host.
 422  * \param host a host
 423  * \return a dynar containing all storages (name) attached to the host
 424  */
 425 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 426 {
 427   xbt_assert((host != NULL), "Invalid parameters");
 428   return (simcall_host_get_attached_storage_list(host));
 429 }
 430
 431 /** \ingroup msg_host_management
 432  * \brief Return the content of mounted storages on an host.
 433  * \param host a host
 434  * \return a dict containing content (as a dict) of all storages mounted on the host
 435  */
 436 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 437 {
 438   xbt_assert((host != NULL), "Invalid parameters");
 439   xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
 440   msg_storage_t storage;
 441   char* storage_name;
 442   char* mount_name;
 443   xbt_dict_cursor_t cursor = NULL;
 444
 445   xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
 446
 447   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 448     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 449     xbt_dict_t content = simcall_storage_get_content(storage);
 450     xbt_dict_set(contents,mount_name, content,NULL);
 451   }
 452   xbt_dict_free(&storage_list);
 453   return contents;
 454 }