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   host->on();
 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   host->off();
 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 /** \ingroup m_host_management
 167  * \brief Return the current number MSG hosts.
 168  */
 169 int MSG_get_host_number(void)
 170 {
 171   return xbt_dict_length(host_list);
 172 }
 173
 174 #ifdef MSG_USE_DEPRECATED
 175 msg_host_t *MSG_get_host_table(void)
 176 {
 177   if (xbt_dict_is_empty(host_list))
 178     return nullptr;
 179
 180   void **array = xbt_new0(void *, xbt_dict_length(host_list));
 181
 182     xbt_lib_cursor_t cursor;
 183     const char *id;
 184     simgrid::Host* host;
 185     xbt_dict_foreach(host_list, cursor, id, host)
 186       if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
 187         array[i++] = host->facet(MSG_HOST_LEVEL);
 188
 189     return (msg_host_t *)array;
 190 }
 191 #endif
 192
 193 /** \ingroup m_host_management
 194  * \brief Return a dynar containing all the hosts declared at a given point of time
 195  * \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)
 196  */
 197 xbt_dynar_t MSG_hosts_as_dynar(void) {
 198   return sg_hosts_as_dynar();
 199 }
 200
 201 /** \ingroup m_host_management
 202  * \brief Return the speed of the processor (in flop/s), regardless of
 203     the current load on the machine.
 204  */
 205 double MSG_get_host_speed(msg_host_t host) {
 206   return host->getSpeed();
 207 }
 208
 209
 210 /** \ingroup m_host_management
 211  * \brief Return the number of cores.
 212  *
 213  * \param host a host
 214  * \return the number of cores
 215  */
 216 int MSG_host_get_core_number(msg_host_t host) {
 217   return host->getCoreAmount();
 218 }
 219
 220 /** \ingroup m_host_management
 221  * \brief Return the list of processes attached to an host.
 222  *
 223  * \param host a host
 224  * \return a swag with the attached processes
 225  */
 226 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 227 {
 228   xbt_assert((host != NULL), "Invalid parameters");
 229   return host->getProcessList();
 230 }
 231
 232
 233 /** \ingroup m_host_management
 234  * \brief Returns the value of a given host property
 235  *
 236  * \param host a host
 237  * \param name a property name
 238  * \return value of a property (or NULL if property not set)
 239  */
 240 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 241 {
 242   return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 243 }
 244
 245 /** \ingroup m_host_management
 246  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 247  *
 248  * \param host a host
 249  * \return a dict containing the properties
 250  */
 251 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 252 {
 253   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 254   return host->getProperties();
 255 }
 256
 257 /** \ingroup m_host_management
 258  * \brief Change the value of a given host property
 259  *
 260  * \param host a host
 261  * \param name a property name
 262  * \param value what to change the property to
 263  * \param free_ctn the freeing function to use to kill the value on need
 264  */
 265 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 266
 267   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 268 }
 269
 270
 271 /** @ingroup m_host_management
 272  *
 273  * @brief Determine if a host is up and running.
 274  *
 275  * 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.
 276  *
 277  * @param host host to test
 278  * @return Returns true if the host is up and running, and false if it's currently down
 279  */
 280 int MSG_host_is_on(msg_host_t host)
 281 {
 282   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 283   return sg_host_is_on(host);
 284 }
 285 /** @ingroup m_host_management
 286  *
 287  * @brief Determine if a host is currently off.
 288  *
 289  * 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.
 290  */
 291 int MSG_host_is_off(msg_host_t host)
 292 {
 293   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 294   return !(sg_host_is_on(host));
 295 }
 296
 297 /** \ingroup m_host_management
 298  * \brief Set the parameters of a given host
 299  *
 300  * \param host a host
 301  * \param params a prameter object
 302  */
 303 void MSG_host_set_params(msg_host_t host, vm_params_t params)
 304 {
 305   host->setParams(params);
 306 }
 307
 308 /** \ingroup m_host_management
 309  * \brief Get the parameters of a given host
 310  *
 311  * \param host a host
 312  * \param params a prameter object
 313  */
 314 void MSG_host_get_params(msg_host_t host, vm_params_t params)
 315 {
 316   host->getParams(params);
 317 }
 318
 319 /** \ingroup m_host_management
 320  * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 321  *
 322  * \param  host host to test
 323  * \param pstate_index pstate to test
 324  * \return Returns the processor speed associated with pstate_index
 325  */
 326 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
 327           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 328           return host->getPowerPeakAt(pstate_index);
 329 }
 330
 331 /** \ingroup m_host_management
 332  * \brief Return the current speed of the processor (in flop/s)
 333  *
 334  * \param  host host to test
 335  * \return Returns the current processor speed
 336  */
 337 double MSG_host_get_current_power_peak(msg_host_t host) {
 338           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 339           return host->getCurrentPowerPeak();
 340 }
 341
 342 /** \ingroup m_host_management
 343  * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
 344  *
 345  * \param  host host to test
 346  */
 347 int MSG_host_get_nb_pstates(msg_host_t host) {
 348           return sg_host_get_nb_pstates(host);
 349 }
 350
 351 /** \ingroup m_host_management
 352  * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 353  *
 354  * \param  host host to test
 355  * \param pstate_index pstate to switch to
 356  */
 357 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
 358           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 359     host->setPstate(pstate_index);
 360 }
 361 /** \ingroup m_host_management
 362  * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
 363  *
 364  * \param  host host to test
 365  */
 366 int MSG_host_get_pstate(msg_host_t host) {
 367           return sg_host_get_pstate(host);
 368 }
 369
 370 /** \ingroup m_host_management
 371  * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
 372  *
 373  * \param  host host to test
 374  * \return Returns the consumed energy
 375  */
 376 double MSG_host_get_consumed_energy(msg_host_t host) {
 377           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 378           return sg_host_get_consumed_energy(host);
 379 }
 380 /** \ingroup m_host_management
 381  * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
 382  *
 383  */
 384 double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
 385         return host->getWattMinAt(pstate);
 386 }
 387 /** \ingroup m_host_management
 388  * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
 389  *
 390  */
 391 double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
 392         return host->getWattMaxAt(pstate);
 393 }
 394
 395 /** \ingroup m_host_management
 396  * \brief Return the list of mount point names on an host.
 397  * \param host a host
 398  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 399  */
 400 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 401 {
 402   xbt_assert((host != NULL), "Invalid parameters");
 403   return host->getMountedStorageList();
 404 }
 405
 406 /** \ingroup m_host_management
 407  * \brief Return the list of storages attached to an host.
 408  * \param host a host
 409  * \return a dynar containing all storages (name) attached to the host
 410  */
 411 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 412 {
 413   xbt_assert((host != NULL), "Invalid parameters");
 414   return host->getAttachedStorageList();
 415 }
 416
 417 /** \ingroup m_host_management
 418  * \brief Return the content of mounted storages on an host.
 419  * \param host a host
 420  * \return a dict containing content (as a dict) of all storages mounted on the host
 421  */
 422 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 423 {
 424   xbt_assert((host != NULL), "Invalid parameters");
 425   xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
 426   msg_storage_t storage;
 427   char* storage_name;
 428   char* mount_name;
 429   xbt_dict_cursor_t cursor = NULL;
 430
 431   xbt_dict_t storage_list = host->getMountedStorageList();
 432
 433   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 434     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 435     xbt_dict_t content = simcall_storage_get_content(storage);
 436     xbt_dict_set(contents,mount_name, content,NULL);
 437   }
 438   xbt_dict_free(&storage_list);
 439   return contents;
 440 }
 441
 442 int __MSG_host_get_file_descriptor_id(msg_host_t host){
 443   msg_host_priv_t priv = sg_host_msg(host);
 444   xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
 445     "Too much files are opened! Some have to be closed.");
 446   return xbt_dynar_pop_as(priv->file_descriptor_table, int);
 447 }
 448
 449 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
 450   msg_host_priv_t priv = sg_host_msg(host);
 451   xbt_dynar_push_as(priv->file_descriptor_table, int, id);
 452 }