src/msg/msg_host.c

   1 /* Copyright (c) 2004-2015. 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 "src/msg/msg_private.h"
   8 #include "src/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   priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
  58   for (int i=1023; i>=0;i--)
  59     xbt_dynar_push_as(priv->file_descriptor_table, int, i);
  60
  61   sg_host_msg_set(host,priv);
  62
  63   return host;
  64 }
  65
  66 /** \ingroup m_host_management
  67  * \brief Finds a msg_host_t using its name.
  68  *
  69  * This is a name directory service
  70  * \param name the name of an host.
  71  * \return the corresponding host
  72  */
  73 msg_host_t MSG_host_by_name(const char *name)
  74 {
  75   return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
  76 }
  77
  78 /** \ingroup m_host_management
  79  *
  80  * \brief Set the user data of a #msg_host_t.
  81  *
  82  * This functions checks whether some data has already been associated to \a host
  83    or not and attach \a data to \a host if it is possible.
  84  */
  85 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
  86   sg_host_user_set(host, data);
  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   return sg_host_user(host);
  99 }
 100
 101 /** \ingroup m_host_management
 102  *
 103  * \brief Return the name of the #msg_host_t.
 104  *
 105  * This functions checks whether \a host is a valid pointer or not and return
 106    its name.
 107  */
 108 const char *MSG_host_get_name(msg_host_t host) {
 109   return SIMIX_host_get_name(host);
 110 }
 111
 112 /** \ingroup m_host_management
 113  *
 114  * \brief Return the location on which the current process is executed.
 115  */
 116 msg_host_t MSG_host_self(void)
 117 {
 118   return MSG_process_get_host(NULL);
 119 }
 120
 121
 122 /** \ingroup m_host_management
 123  *
 124  * \brief Start the host if it is off
 125  *
 126  * 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  */
 128 void MSG_host_on(msg_host_t host)
 129 {
 130   simcall_host_on(host);
 131 }
 132
 133 /** \ingroup m_host_management
 134  *
 135  * \brief Stop the host if it is on
 136  *
 137  * 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  */
 139 void MSG_host_off(msg_host_t host)
 140 {
 141   simcall_host_off(host);
 142 }
 143
 144 /*
 145  * \brief Frees private data of a host (internal call only)
 146  */
 147 void __MSG_host_priv_free(msg_host_priv_t priv)
 148 {
 149
 150   if (priv == NULL)
 151           return;
 152   unsigned int size = xbt_dict_size(priv->dp_objs);
 153   if (size > 0)
 154     XBT_WARN("dp_objs: %u pending task?", size);
 155   xbt_dict_free(&priv->dp_objs);
 156   xbt_dict_free(&priv->affinity_mask_db);
 157   xbt_dynar_free(&priv->file_descriptor_table);
 158 #ifdef MSG_USE_DEPRECATED
 159   free(priv->mailboxes);
 160 #endif
 161
 162   free(priv);
 163 }
 164
 165 /*
 166  * \brief Destroys a host (internal call only)
 167  */
 168 void __MSG_host_destroy(msg_host_t host) //FIXME: killme?
 169 {
 170   /* TODO:
 171    * What happens if VMs still remain on this host?
 172    * Revisit here after the surf layer gets stable.
 173    **/
 174   sg_host_msg_destroy(host);
 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  * \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)
 211  */
 212 xbt_dynar_t MSG_hosts_as_dynar(void) {
 213   return sg_hosts_as_dynar();
 214 }
 215
 216 /** \ingroup m_host_management
 217  * \brief Return the number of MSG tasks currently running on a
 218  * #msg_host_t. The external load is not taken in account.
 219  */
 220 int MSG_get_host_msgload(msg_host_t h)
 221 {
 222   xbt_assert((h != NULL), "Invalid parameters");
 223   xbt_die( "Not implemented yet");
 224
 225   return (0);
 226 }
 227
 228 /** \ingroup m_host_management
 229  * \brief Return the speed of the processor (in flop/s), regardless of
 230     the current load on the machine.
 231  */
 232 double MSG_get_host_speed(msg_host_t h)
 233 {
 234   xbt_assert((h != NULL), "Invalid parameters");
 235
 236   return sg_host_get_speed(h);
 237 }
 238
 239
 240 /** \ingroup m_host_management
 241  * \brief Return the number of cores.
 242  *
 243  * \param host a host
 244  * \return the number of cores
 245  */
 246 int MSG_host_get_core_number(msg_host_t host)
 247 {
 248   xbt_assert((host != NULL), "Invalid parameters");
 249
 250   return sg_host_get_core(host);
 251 }
 252
 253 /** \ingroup m_host_management
 254  * \brief Return the list of processes attached to an host.
 255  *
 256  * \param host a host
 257  * \return a swag with the attached processes
 258  */
 259 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 260 {
 261   xbt_assert((host != NULL), "Invalid parameters");
 262
 263   return (simcall_host_get_process_list(host));
 264 }
 265
 266
 267 /** \ingroup m_host_management
 268  * \brief Returns the value of a given host property
 269  *
 270  * \param host a host
 271  * \param name a property name
 272  * \return value of a property (or NULL if property not set)
 273  */
 274 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 275 {
 276   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 277 }
 278
 279 /** \ingroup m_host_management
 280  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 281  *
 282  * \param host a host
 283  * \return a dict containing the properties
 284  */
 285 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 286 {
 287   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 288
 289   return (simcall_host_get_properties(host));
 290 }
 291
 292 /** \ingroup m_host_management
 293  * \brief Change the value of a given host property
 294  *
 295  * \param host a host
 296  * \param name a property name
 297  * \param value what to change the property to
 298  * \param free_ctn the freeing function to use to kill the value on need
 299  */
 300 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 301
 302   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 303 }
 304
 305
 306 /** @ingroup m_host_management
 307  *
 308  * @brief Determine if a host is up and running.
 309  *
 310  * 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.
 311  *
 312  * @param host host to test
 313  * @return Returns true if the host is up and running, and false if it's currently down
 314  */
 315 int MSG_host_is_on(msg_host_t host)
 316 {
 317   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 318   return sg_host_get_state(host);
 319 }
 320 /** @ingroup m_host_management
 321  *
 322  * @brief Determine if a host is currently off.
 323  *
 324  * 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.
 325  */
 326 int MSG_host_is_off(msg_host_t host)
 327 {
 328   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 329   return !(sg_host_get_state(host));
 330 }
 331
 332 /** \ingroup m_host_management
 333  * \brief Set the parameters of a given host
 334  *
 335  * \param host a host
 336  * \param params a prameter object
 337  */
 338 void MSG_host_set_params(msg_host_t host, vm_params_t params)
 339 {
 340   simcall_host_set_params(host, params);
 341 }
 342
 343 /** \ingroup m_host_management
 344  * \brief Get the parameters of a given host
 345  *
 346  * \param host a host
 347  * \param params a prameter object
 348  */
 349 void MSG_host_get_params(msg_host_t host, vm_params_t params)
 350 {
 351   simcall_host_get_params(host, params);
 352 }
 353
 354 /** \ingroup m_host_management
 355  * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 356  *
 357  * \param  host host to test
 358  * \param pstate_index pstate to test
 359  * \return Returns the processor speed associated with pstate_index
 360  */
 361 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
 362           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 363           return (simcall_host_get_power_peak_at(host, pstate_index));
 364 }
 365
 366 /** \ingroup m_host_management
 367  * \brief Return the current speed of the processor (in flop/s)
 368  *
 369  * \param  host host to test
 370  * \return Returns the current processor speed
 371  */
 372 double MSG_host_get_current_power_peak(msg_host_t host) {
 373           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 374           return simcall_host_get_current_power_peak(host);
 375 }
 376
 377 /** \ingroup m_host_management
 378  * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
 379  *
 380  * \param  host host to test
 381  */
 382 int MSG_host_get_nb_pstates(msg_host_t host) {
 383           return sg_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. See also @ref SURF_plugin_energy.
 388  *
 389  * \param  host host to test
 390  * \param pstate_index pstate to switch to
 391  */
 392 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
 393           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 394
 395           simcall_host_set_pstate(host, pstate_index);
 396 }
 397 /** \ingroup m_host_management
 398  * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
 399  *
 400  * \param  host host to test
 401  */
 402 int MSG_host_get_pstate(msg_host_t host) {
 403           return sg_host_get_pstate(host);
 404 }
 405
 406 /** \ingroup m_host_management
 407  * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
 408  *
 409  * \param  host host to test
 410  * \return Returns the consumed energy
 411  */
 412 double MSG_host_get_consumed_energy(msg_host_t host) {
 413           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 414           return sg_host_get_consumed_energy(host);
 415 }
 416 /** \ingroup m_host_management
 417  * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
 418  *
 419  */
 420 double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
 421         return simcall_host_get_wattmin_at(host, pstate);
 422 }
 423 /** \ingroup m_host_management
 424  * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
 425  *
 426  */
 427 double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
 428         return simcall_host_get_wattmax_at(host, pstate);
 429 }
 430
 431 /** \ingroup m_host_management
 432  * \brief Return the list of mount point names on an host.
 433  * \param host a host
 434  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 435  */
 436 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 437 {
 438   xbt_assert((host != NULL), "Invalid parameters");
 439   return (simcall_host_get_mounted_storage_list(host));
 440 }
 441
 442 /** \ingroup m_host_management
 443  * \brief Return the list of storages attached to an host.
 444  * \param host a host
 445  * \return a dynar containing all storages (name) attached to the host
 446  */
 447 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 448 {
 449   xbt_assert((host != NULL), "Invalid parameters");
 450   return (simcall_host_get_attached_storage_list(host));
 451 }
 452
 453 /** \ingroup m_host_management
 454  * \brief Return the content of mounted storages on an host.
 455  * \param host a host
 456  * \return a dict containing content (as a dict) of all storages mounted on the host
 457  */
 458 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 459 {
 460   xbt_assert((host != NULL), "Invalid parameters");
 461   xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
 462   msg_storage_t storage;
 463   char* storage_name;
 464   char* mount_name;
 465   xbt_dict_cursor_t cursor = NULL;
 466
 467   xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
 468
 469   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 470     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 471     xbt_dict_t content = simcall_storage_get_content(storage);
 472     xbt_dict_set(contents,mount_name, content,NULL);
 473   }
 474   xbt_dict_free(&storage_list);
 475   return contents;
 476 }
 477
 478 int __MSG_host_get_file_descriptor_id(msg_host_t host){
 479   msg_host_priv_t priv = sg_host_msg(host);
 480   xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
 481     "Too much files are opened! Some have to be closed.");
 482   return xbt_dynar_pop_as(priv->file_descriptor_table, int);
 483 }
 484
 485 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
 486   msg_host_priv_t priv = sg_host_msg(host);
 487   xbt_dynar_push_as(priv->file_descriptor_table, int, id);
 488 }