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