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