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
  55   priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
  56
  57   xbt_lib_set(host_lib, name, MSG_HOST_LEVEL, priv);
  58
  59   return xbt_lib_get_elm_or_null(host_lib, name);
  60 }
  61
  62
  63 /** \ingroup msg_host_management
  64  * \brief Finds a msg_host_t using its name.
  65  *
  66  * This is a name directory service
  67  * \param name the name of an host.
  68  * \return the corresponding host
  69  */
  70 msg_host_t MSG_get_host_by_name(const char *name)
  71 {
  72   return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
  73 }
  74
  75 /** \ingroup m_host_management
  76  *
  77  * \brief Return the name of the #msg_host_t.
  78  *
  79  * This functions checks whether \a host is a valid pointer or not and return
  80    its name.
  81  */
  82 const char *MSG_host_get_name(msg_host_t host) {
  83   return SIMIX_host_get_name(host);
  84 }
  85
  86 /** \ingroup m_host_management
  87  *
  88  * \brief Return the location on which the current process is executed.
  89  */
  90 msg_host_t MSG_host_self(void)
  91 {
  92   return MSG_process_get_host(NULL);
  93 }
  94
  95
  96 /*
  97  * \brief Start the host if it is off
  98  */
  99 void MSG_host_on(msg_host_t host)
 100 {
 101   simcall_host_on(host);
 102 }
 103
 104 /*
 105  * \brief Stop the host if it is on
 106  */
 107 void MSG_host_off(msg_host_t host)
 108 {
 109   simcall_host_off(host);
 110 }
 111
 112 /*
 113  * \brief Frees private data of a host (internal call only)
 114  */
 115 void __MSG_host_priv_free(msg_host_priv_t priv)
 116 {
 117   unsigned int size = xbt_dict_size(priv->dp_objs);
 118   if (size > 0)
 119     XBT_WARN("dp_objs: %u pending task?", size);
 120   xbt_dict_free(&priv->dp_objs);
 121   xbt_dict_free(&priv->affinity_mask_db);
 122
 123 #ifdef MSG_USE_DEPRECATED
 124   free(priv->mailboxes);
 125 #endif
 126
 127   free(priv);
 128 }
 129
 130 /*
 131  * \brief Destroys a host (internal call only)
 132  */
 133 void __MSG_host_destroy(msg_host_t host)
 134 {
 135   const char *name = MSG_host_get_name(host);
 136   /* TODO:
 137    * What happens if VMs still remain on this host?
 138    * Revisit here after the surf layer gets stable.
 139    **/
 140
 141   xbt_lib_unset(host_lib, name, MSG_HOST_LEVEL, 1);
 142 }
 143
 144 /** \ingroup m_host_management
 145  * \brief Return the current number MSG hosts.
 146  */
 147 int MSG_get_host_number(void)
 148 {
 149   return xbt_lib_length(host_lib);
 150 }
 151
 152 #ifdef MSG_USE_DEPRECATED
 153 msg_host_t *MSG_get_host_table(void)
 154 {
 155       void **array;
 156     int i = 0;
 157     xbt_lib_cursor_t cursor;
 158     char *key;
 159     void **data;
 160
 161     if (xbt_lib_length(host_lib) == 0)
 162     return NULL;
 163     else
 164     array = xbt_new0(void *, xbt_lib_length(host_lib));
 165
 166     xbt_lib_foreach(host_lib, cursor, key, data) {
 167       if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
 168         array[i++] = data[MSG_HOST_LEVEL];
 169     }
 170
 171     return (msg_host_t *)array;
 172 }
 173 #endif
 174
 175 /** \ingroup m_host_management
 176  * \brief Return a dynar containing all the hosts declared at a given point of time
 177  */
 178 xbt_dynar_t MSG_hosts_as_dynar(void) {
 179   xbt_lib_cursor_t cursor;
 180   char *key;
 181   void **data;
 182   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
 183
 184   xbt_lib_foreach(host_lib, cursor, key, data) {
 185     if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
 186       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
 187       xbt_dynar_push(res, &elm);
 188     }
 189   }
 190   return res;
 191 }
 192
 193 /** \ingroup m_host_management
 194  * \brief Return the number of MSG tasks currently running on a
 195  * #msg_host_t. The external load is not taken in account.
 196  */
 197 int MSG_get_host_msgload(msg_host_t h)
 198 {
 199   xbt_assert((h != NULL), "Invalid parameters");
 200   xbt_die( "Not implemented yet");
 201
 202   return (0);
 203 }
 204
 205 /** \ingroup m_host_management
 206  * \brief Return the speed of the processor (in flop/s), regardless of
 207     the current load on the machine.
 208  */
 209 double MSG_get_host_speed(msg_host_t h)
 210 {
 211   xbt_assert((h != NULL), "Invalid parameters");
 212
 213   return (simcall_host_get_speed(h));
 214 }
 215
 216
 217 /** \ingroup m_host_management
 218  * \brief Return the number of cores.
 219  *
 220  * \param host a host
 221  * \return the number of cores
 222  */
 223 int MSG_host_get_core_number(msg_host_t host)
 224 {
 225   xbt_assert((host != NULL), "Invalid parameters");
 226
 227   return (simcall_host_get_core(host));
 228 }
 229
 230 /** \ingroup m_host_management
 231  * \brief Return the list of processes attached to an host.
 232  *
 233  * \param host a host
 234  * \return a swag with the attached processes
 235  */
 236 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 237 {
 238   xbt_assert((host != NULL), "Invalid parameters");
 239
 240   return (simcall_host_get_process_list(host));
 241 }
 242
 243
 244 /** \ingroup m_host_management
 245  * \brief Returns the value of a given host property
 246  *
 247  * \param host a host
 248  * \param name a property name
 249  * \return value of a property (or NULL if property not set)
 250  */
 251 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 252 {
 253   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 254 }
 255
 256 /** \ingroup m_host_management
 257  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 258  *
 259  * \param host a host
 260  * \return a dict containing the properties
 261  */
 262 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 263 {
 264   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 265
 266   return (simcall_host_get_properties(host));
 267 }
 268
 269 /** \ingroup m_host_management
 270  * \brief Change the value of a given host property
 271  *
 272  * \param host a host
 273  * \param name a property name
 274  * \param value what to change the property to
 275  * \param free_ctn the freeing function to use to kill the value on need
 276  */
 277 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 278
 279   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 280 }
 281
 282
 283 /** \ingroup msg_gos_functions
 284  * \brief Determine if a host is available.
 285  *
 286  * \param host host to test
 287  * \return Returns 1 if host is available, 0 otherwise
 288  */
 289 int MSG_host_is_avail(msg_host_t host)
 290 {
 291   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 292   return (simcall_host_get_state(host));
 293 }
 294
 295 /** \ingroup m_host_management
 296  * \brief Set the parameters of a given host
 297  *
 298  * \param host a host
 299  * \param params a prameter object
 300  */
 301 void MSG_host_set_params(msg_host_t host, ws_params_t params)
 302 {
 303   simcall_host_set_params(host, params);
 304 }
 305
 306 /** \ingroup m_host_management
 307  * \brief Get the parameters of a given host
 308  *
 309  * \param host a host
 310  * \param params a prameter object
 311  */
 312 void MSG_host_get_params(msg_host_t host, ws_params_t params)
 313 {
 314   simcall_host_get_params(host, params);
 315 }
 316
 317 /** \ingroup m_host_management
 318  * \brief Return the speed of the processor (in flop/s) at a given pstate
 319  *
 320  * \param  host host to test
 321  * \param pstate_index pstate to test
 322  * \return Returns the processor speed associated with pstate_index
 323  */
 324 double MSG_get_host_power_peak_at(msg_host_t host, int pstate_index) {
 325           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 326           return (simcall_host_get_power_peak_at(host, pstate_index));
 327 }
 328
 329 /** \ingroup m_host_management
 330  * \brief Return the current speed of the processor (in flop/s)
 331  *
 332  * \param  host host to test
 333  * \return Returns the current processor speed
 334  */
 335 double MSG_get_host_current_power_peak(msg_host_t host) {
 336           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 337           return simcall_host_get_current_power_peak(host);
 338 }
 339
 340 /** \ingroup m_host_management
 341  * \brief Return the number of pstates defined for a host
 342  *
 343  * \param  host host to test
 344  */
 345 int MSG_get_host_nb_pstates(msg_host_t host) {
 346
 347           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 348           return (simcall_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
 353  *
 354  * \param  host host to test
 355  * \param pstate_index pstate to switch to
 356  */
 357 void MSG_set_host_power_peak_at(msg_host_t host, int pstate_index) {
 358           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 359
 360           simcall_host_set_power_peak_at(host, pstate_index);
 361 }
 362
 363 /** \ingroup m_host_management
 364  * \brief Return the total energy consumed by a host (in Joules)
 365  *
 366  * \param  host host to test
 367  * \return Returns the consumed energy
 368  */
 369 double MSG_get_host_consumed_energy(msg_host_t host) {
 370           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 371           return simcall_host_get_consumed_energy(host);
 372 }
 373
 374 /** \ingroup m_host_management
 375  * \brief Return the list of mount point names on an host.
 376  * \param host a host
 377  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 378  */
 379 xbt_dict_t MSG_host_get_storage_list(msg_host_t host)
 380 {
 381   xbt_assert((host != NULL), "Invalid parameters");
 382   return (simcall_host_get_storage_list(host));
 383 }
 384
 385 /** \ingroup msg_host_management
 386  * \brief Return the content of mounted storages on an host.
 387  * \param host a host
 388  * \return a dict containing content (as a dict) of all storages mounted on the host
 389  */
 390 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 391 {
 392   xbt_assert((host != NULL), "Invalid parameters");
 393   xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
 394   msg_storage_t storage;
 395   char* storage_name;
 396   char* mount_name;
 397   xbt_dict_cursor_t cursor = NULL;
 398
 399   xbt_dict_t storage_list = simcall_host_get_storage_list(host);
 400
 401   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 402     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 403     xbt_dict_t content = simcall_storage_get_content(storage);
 404     xbt_dict_set(contents,mount_name, content,NULL);
 405   }
 406   xbt_dict_free(&storage_list);
 407   return contents;
 408 }