src/msg/msg_host.cpp

   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 #include "simgrid/Host.hpp"
  13
  14 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
  15
  16 /** @addtogroup m_host_management
  17  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
  18  * (#msg_host_t) and the functions for managing it.
  19  *
  20  *  A <em>location</em> (or <em>host</em>) is any possible place where
  21  *  a process may run. Thus it may be represented as a
  22  *  <em>physical resource with computing capabilities</em>, some
  23  *  <em>mailboxes</em> to enable running process to communicate with
  24  *  remote ones, and some <em>private data</em> that can be only
  25  *  accessed by local process.
  26  *  \see msg_host_t
  27  */
  28
  29 /********************************* Host **************************************/
  30 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
  31 {
  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   priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
  59   for (int i=1023; i>=0;i--)
  60     xbt_dynar_push_as(priv->file_descriptor_table, int, i);
  61
  62   sg_host_msg_set(host,priv);
  63
  64   return host;
  65 }
  66
  67 /** \ingroup m_host_management
  68  * \brief Finds a msg_host_t using its name.
  69  *
  70  * This is a name directory service
  71  * \param name the name of an host.
  72  * \return the corresponding host
  73  */
  74 msg_host_t MSG_host_by_name(const char *name)
  75 {
  76   return simgrid::Host::by_name_or_null(name);
  77 }
  78
  79 /** \ingroup m_host_management
  80  *
  81  * \brief Set the user data of a #msg_host_t.
  82  *
  83  * This functions checks whether some data has already been associated to \a host
  84    or not and attach \a data to \a host if it is possible.
  85  */
  86 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
  87   sg_host_user_set(host, data);
  88   return MSG_OK;
  89 }
  90
  91 /** \ingroup m_host_management
  92  *
  93  * \brief Return the user data of a #msg_host_t.
  94  *
  95  * This functions checks whether \a host is a valid pointer or not and return
  96    the user data associated to \a host if it is possible.
  97  */
  98 void *MSG_host_get_data(msg_host_t host) {
  99   return sg_host_user(host);
 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
 151   if (priv == NULL)
 152           return;
 153   unsigned int size = xbt_dict_size(priv->dp_objs);
 154   if (size > 0)
 155     XBT_WARN("dp_objs: %u pending task?", size);
 156   xbt_dict_free(&priv->dp_objs);
 157   xbt_dict_free(&priv->affinity_mask_db);
 158   xbt_dynar_free(&priv->file_descriptor_table);
 159 #ifdef MSG_USE_DEPRECATED
 160   free(priv->mailboxes);
 161 #endif
 162
 163   free(priv);
 164 }
 165
 166 /*
 167  * \brief Destroys a host (internal call only)
 168  */
 169 void __MSG_host_destroy(msg_host_t host) //FIXME: killme?
 170 {
 171   /* TODO:
 172    * What happens if VMs still remain on this host?
 173    * Revisit here after the surf layer gets stable.
 174    **/
 175   sg_host_msg_destroy(host);
 176 }
 177
 178 /** \ingroup m_host_management
 179  * \brief Return the current number MSG hosts.
 180  */
 181 int MSG_get_host_number(void)
 182 {
 183   return xbt_dict_length(host_list);
 184 }
 185
 186 #ifdef MSG_USE_DEPRECATED
 187 msg_host_t *MSG_get_host_table(void)
 188 {
 189   if (xbt_dict_is_empty(host_list))
 190     return nullptr;
 191
 192   void **array = xbt_new0(void *, xbt_dict_length(host_list));
 193
 194     xbt_lib_cursor_t cursor;
 195     const char *id;
 196     simgrid::Host* host;
 197     xbt_dict_foreach(host_list, cursor, id, host)
 198       if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
 199         array[i++] = host->facet(MSG_HOST_LEVEL);
 200
 201     return (msg_host_t *)array;
 202 }
 203 #endif
 204
 205 /** \ingroup m_host_management
 206  * \brief Return a dynar containing all the hosts declared at a given point of time
 207  * \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)
 208  */
 209 xbt_dynar_t MSG_hosts_as_dynar(void) {
 210   return sg_hosts_as_dynar();
 211 }
 212
 213 /** \ingroup m_host_management
 214  * \brief Return the speed of the processor (in flop/s), regardless of
 215     the current load on the machine.
 216  */
 217 double MSG_get_host_speed(msg_host_t h)
 218 {
 219   xbt_assert((h != NULL), "Invalid parameters");
 220
 221   return sg_host_get_speed(h);
 222 }
 223
 224
 225 /** \ingroup m_host_management
 226  * \brief Return the number of cores.
 227  *
 228  * \param host a host
 229  * \return the number of cores
 230  */
 231 int MSG_host_get_core_number(msg_host_t host)
 232 {
 233   xbt_assert((host != NULL), "Invalid parameters");
 234
 235   return sg_host_get_core(host);
 236 }
 237
 238 /** \ingroup m_host_management
 239  * \brief Return the list of processes attached to an host.
 240  *
 241  * \param host a host
 242  * \return a swag with the attached processes
 243  */
 244 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 245 {
 246   xbt_assert((host != NULL), "Invalid parameters");
 247
 248   return (simcall_host_get_process_list(host));
 249 }
 250
 251
 252 /** \ingroup m_host_management
 253  * \brief Returns the value of a given host property
 254  *
 255  * \param host a host
 256  * \param name a property name
 257  * \return value of a property (or NULL if property not set)
 258  */
 259 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 260 {
 261   return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 262 }
 263
 264 /** \ingroup m_host_management
 265  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 266  *
 267  * \param host a host
 268  * \return a dict containing the properties
 269  */
 270 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 271 {
 272   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 273
 274   return (simcall_host_get_properties(host));
 275 }
 276
 277 /** \ingroup m_host_management
 278  * \brief Change the value of a given host property
 279  *
 280  * \param host a host
 281  * \param name a property name
 282  * \param value what to change the property to
 283  * \param free_ctn the freeing function to use to kill the value on need
 284  */
 285 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 286
 287   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 288 }
 289
 290
 291 /** @ingroup m_host_management
 292  *
 293  * @brief Determine if a host is up and running.
 294  *
 295  * 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.
 296  *
 297  * @param host host to test
 298  * @return Returns true if the host is up and running, and false if it's currently down
 299  */
 300 int MSG_host_is_on(msg_host_t host)
 301 {
 302   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 303   return sg_host_get_state(host);
 304 }
 305 /** @ingroup m_host_management
 306  *
 307  * @brief Determine if a host is currently off.
 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 int MSG_host_is_off(msg_host_t host)
 312 {
 313   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 314   return !(sg_host_get_state(host));
 315 }
 316
 317 /** \ingroup m_host_management
 318  * \brief Set the parameters of a given host
 319  *
 320  * \param host a host
 321  * \param params a prameter object
 322  */
 323 void MSG_host_set_params(msg_host_t host, vm_params_t params)
 324 {
 325   simcall_host_set_params(host, params);
 326 }
 327
 328 /** \ingroup m_host_management
 329  * \brief Get the parameters of a given host
 330  *
 331  * \param host a host
 332  * \param params a prameter object
 333  */
 334 void MSG_host_get_params(msg_host_t host, vm_params_t params)
 335 {
 336   simcall_host_get_params(host, params);
 337 }
 338
 339 /** \ingroup m_host_management
 340  * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 341  *
 342  * \param  host host to test
 343  * \param pstate_index pstate to test
 344  * \return Returns the processor speed associated with pstate_index
 345  */
 346 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
 347           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 348           return (simcall_host_get_power_peak_at(host, pstate_index));
 349 }
 350
 351 /** \ingroup m_host_management
 352  * \brief Return the current speed of the processor (in flop/s)
 353  *
 354  * \param  host host to test
 355  * \return Returns the current processor speed
 356  */
 357 double MSG_host_get_current_power_peak(msg_host_t host) {
 358           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 359           return simcall_host_get_current_power_peak(host);
 360 }
 361
 362 /** \ingroup m_host_management
 363  * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
 364  *
 365  * \param  host host to test
 366  */
 367 int MSG_host_get_nb_pstates(msg_host_t host) {
 368           return sg_host_get_nb_pstates(host);
 369 }
 370
 371 /** \ingroup m_host_management
 372  * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 373  *
 374  * \param  host host to test
 375  * \param pstate_index pstate to switch to
 376  */
 377 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
 378           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 379
 380           simcall_host_set_pstate(host, pstate_index);
 381 }
 382 /** \ingroup m_host_management
 383  * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
 384  *
 385  * \param  host host to test
 386  */
 387 int MSG_host_get_pstate(msg_host_t host) {
 388           return sg_host_get_pstate(host);
 389 }
 390
 391 /** \ingroup m_host_management
 392  * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
 393  *
 394  * \param  host host to test
 395  * \return Returns the consumed energy
 396  */
 397 double MSG_host_get_consumed_energy(msg_host_t host) {
 398           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 399           return sg_host_get_consumed_energy(host);
 400 }
 401 /** \ingroup m_host_management
 402  * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
 403  *
 404  */
 405 double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
 406         return simcall_host_get_wattmin_at(host, pstate);
 407 }
 408 /** \ingroup m_host_management
 409  * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
 410  *
 411  */
 412 double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
 413         return simcall_host_get_wattmax_at(host, pstate);
 414 }
 415
 416 /** \ingroup m_host_management
 417  * \brief Return the list of mount point names on an host.
 418  * \param host a host
 419  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 420  */
 421 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 422 {
 423   xbt_assert((host != NULL), "Invalid parameters");
 424   return (simcall_host_get_mounted_storage_list(host));
 425 }
 426
 427 /** \ingroup m_host_management
 428  * \brief Return the list of storages attached to an host.
 429  * \param host a host
 430  * \return a dynar containing all storages (name) attached to the host
 431  */
 432 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 433 {
 434   xbt_assert((host != NULL), "Invalid parameters");
 435   return (simcall_host_get_attached_storage_list(host));
 436 }
 437
 438 /** \ingroup m_host_management
 439  * \brief Return the content of mounted storages on an host.
 440  * \param host a host
 441  * \return a dict containing content (as a dict) of all storages mounted on the host
 442  */
 443 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 444 {
 445   xbt_assert((host != NULL), "Invalid parameters");
 446   xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
 447   msg_storage_t storage;
 448   char* storage_name;
 449   char* mount_name;
 450   xbt_dict_cursor_t cursor = NULL;
 451
 452   xbt_dict_t storage_list = simcall_host_get_mounted_storage_list(host);
 453
 454   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 455     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 456     xbt_dict_t content = simcall_storage_get_content(storage);
 457     xbt_dict_set(contents,mount_name, content,NULL);
 458   }
 459   xbt_dict_free(&storage_list);
 460   return contents;
 461 }
 462
 463 int __MSG_host_get_file_descriptor_id(msg_host_t host){
 464   msg_host_priv_t priv = sg_host_msg(host);
 465   xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
 466     "Too much files are opened! Some have to be closed.");
 467   return xbt_dynar_pop_as(priv->file_descriptor_table, int);
 468 }
 469
 470 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
 471   msg_host_priv_t priv = sg_host_msg(host);
 472   xbt_dynar_push_as(priv->file_descriptor_table, int, id);
 473 }