src/msg/msg_host.c

   1 /* Copyright (c) 2004-2013. 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 host = xbt_new0(s_msg_host_priv_t, 1);
  33   s_msg_vm_t vm; // simply to compute the offset
  34
  35   host->vms = xbt_swag_new(xbt_swag_offset(vm,host_vms_hookup));
  36
  37 #ifdef MSG_USE_DEPRECATED
  38   int i;
  39   char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
  40
  41   host->mailboxes = (msg_global->max_channel > 0) ?
  42     xbt_new0(msg_mailbox_t, msg_global->max_channel) : NULL;
  43
  44   for (i = 0; i < msg_global->max_channel; i++) {
  45     sprintf(alias, "%s:%d", name, i);
  46
  47     /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
  48     host->mailboxes[i] = MSG_mailbox_new(alias);
  49     memset(alias, 0, MAX_ALIAS_NAME + 1);
  50   }
  51 #endif
  52
  53   xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
  54
  55   return xbt_lib_get_elm_or_null(host_lib, name);
  56 }
  57
  58
  59 /** \ingroup msg_host_management
  60  * \brief Finds a msg_host_t using its name.
  61  *
  62  * This is a name directory service
  63  * \param name the name of an host.
  64  * \return the corresponding host
  65  */
  66 msg_host_t MSG_get_host_by_name(const char *name)
  67 {
  68   return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
  69 }
  70
  71 /** \ingroup m_host_management
  72  *
  73  * \brief Set the user data of a #msg_host_t.
  74  *
  75  * This functions checks whether some data has already been associated to \a host
  76    or not and attach \a data to \a host if it is possible.
  77  */
  78 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
  79 {
  80   SIMIX_host_set_data(host,data);
  81
  82   return MSG_OK;
  83 }
  84
  85 /** \ingroup m_host_management
  86  *
  87  * \brief Return the user data of a #msg_host_t.
  88  *
  89  * This functions checks whether \a host is a valid pointer or not and return
  90    the user data associated to \a host if it is possible.
  91  */
  92 void *MSG_host_get_data(msg_host_t host)
  93 {
  94   return SIMIX_host_get_data(host);
  95 }
  96
  97 /** \ingroup m_host_management
  98  *
  99  * \brief Return the name of the #msg_host_t.
 100  *
 101  * This functions checks whether \a host is a valid pointer or not and return
 102    its name.
 103  */
 104 const char *MSG_host_get_name(msg_host_t host) {
 105   return SIMIX_host_get_name(host);
 106 }
 107
 108 /** \ingroup m_host_management
 109  *
 110  * \brief Return the location on which the current process is executed.
 111  */
 112 msg_host_t MSG_host_self(void)
 113 {
 114   return MSG_process_get_host(NULL);
 115 }
 116
 117 /*
 118  * \brief Destroys a host (internal call only)
 119  */
 120 void __MSG_host_destroy(msg_host_priv_t host) {
 121
 122 #ifdef MSG_USE_DEPRECATED
 123   free(host->mailboxes);
 124 #endif
 125   if (xbt_swag_size(host->vms) > 0 ) {
 126     XBT_VERB("Host shut down, but it still hosts %d VMs. They will be leaked.",xbt_swag_size(host->vms));
 127   }
 128   xbt_swag_free(host->vms);
 129   free(host);
 130 }
 131
 132 /** \ingroup m_host_management
 133  * \brief Return the current number MSG hosts.
 134  */
 135 int MSG_get_host_number(void)
 136 {
 137   return xbt_lib_length(host_lib);
 138 }
 139
 140 #ifdef MSG_USE_DEPRECATED
 141 msg_host_t *MSG_get_host_table(void)
 142 {
 143       void **array;
 144     int i = 0;
 145     xbt_lib_cursor_t cursor;
 146     char *key;
 147     void **data;
 148
 149     if (xbt_lib_length(host_lib) == 0)
 150     return NULL;
 151     else
 152     array = xbt_new0(void *, xbt_lib_length(host_lib));
 153
 154     xbt_lib_foreach(host_lib, cursor, key, data) {
 155       if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
 156         array[i++] = data[MSG_HOST_LEVEL];
 157     }
 158
 159     return (msg_host_t *)array;
 160 }
 161 #endif
 162
 163 /** \ingroup m_host_management
 164  * \brief Return a dynar containing all the hosts declared at a given point of time
 165  */
 166 xbt_dynar_t MSG_hosts_as_dynar(void) {
 167   xbt_lib_cursor_t cursor;
 168   char *key;
 169   void **data;
 170   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
 171
 172   xbt_lib_foreach(host_lib, cursor, key, data) {
 173     if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
 174       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
 175       xbt_dynar_push(res, &elm);
 176     }
 177   }
 178   return res;
 179 }
 180
 181 /** \ingroup m_host_management
 182  * \brief Return the number of MSG tasks currently running on a
 183  * #msg_host_t. The external load is not taken in account.
 184  */
 185 int MSG_get_host_msgload(msg_host_t h)
 186 {
 187   xbt_assert((h != NULL), "Invalid parameters");
 188   xbt_die( "Not implemented yet");
 189
 190   return (0);
 191 }
 192
 193 /** \ingroup m_host_management
 194  * \brief Return the speed of the processor (in flop/s), regardless of
 195     the current load on the machine.
 196  */
 197 double MSG_get_host_speed(msg_host_t h)
 198 {
 199   xbt_assert((h != NULL), "Invalid parameters");
 200
 201   return (simcall_host_get_speed(h));
 202 }
 203
 204
 205 /** \ingroup m_host_management
 206  * \brief Return the number of cores.
 207  *
 208  * \param host a host
 209  * \return the number of cores
 210  */
 211 int MSG_host_get_core_number(msg_host_t host)
 212 {
 213   xbt_assert((host != NULL), "Invalid parameters");
 214
 215   return (simcall_host_get_core(host));
 216 }
 217
 218 /** \ingroup m_host_management
 219  * \brief Return the list of processes attached to an host.
 220  *
 221  * \param host a host
 222  * \return a swag with the attached processes
 223  */
 224 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 225 {
 226   xbt_assert((host != NULL), "Invalid parameters");
 227
 228   return (simcall_host_get_process_list(host));
 229 }
 230
 231
 232 /** \ingroup m_host_management
 233  * \brief Returns the value of a given host property
 234  *
 235  * \param host a host
 236  * \param name a property name
 237  * \return value of a property (or NULL if property not set)
 238  */
 239 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 240 {
 241   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 242 }
 243
 244 /** \ingroup m_host_management
 245  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 246  *
 247  * \param host a host
 248  * \return a dict containing the properties
 249  */
 250 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 251 {
 252   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 253
 254   return (simcall_host_get_properties(host));
 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 msg_gos_functions
 272  * \brief Determine if a host is available.
 273  *
 274  * \param host host to test
 275  * \return Returns 1 if host is available, 0 otherwise
 276  */
 277 int MSG_host_is_avail(msg_host_t host)
 278 {
 279   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 280   return (simcall_host_get_state(host));
 281 }
 282
 283 /** \ingroup m_host_management
 284  * \brief Return the speed of the processor (in flop/s) at a given pstate
 285  *
 286  * \param  host host to test
 287  * \param pstate_index pstate to test
 288  * \return Returns the processor speed associated with pstate_index
 289  */
 290 double MSG_get_host_power_peak_at(msg_host_t host, int pstate_index) {
 291           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 292           return (simcall_host_get_power_peak_at(host, pstate_index));
 293 }
 294
 295 /** \ingroup m_host_management
 296  * \brief Return the current speed of the processor (in flop/s)
 297  *
 298  * \param  host host to test
 299  * \return Returns the current processor speed
 300  */
 301 double MSG_get_host_current_power_peak(msg_host_t host) {
 302           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 303           return simcall_host_get_current_power_peak(host);
 304 }
 305
 306 /** \ingroup m_host_management
 307  * \brief Return the number of pstates defined for a host
 308  *
 309  * \param  host host to test
 310  */
 311 int MSG_get_host_nb_pstates(msg_host_t host) {
 312
 313           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 314           return (simcall_host_get_nb_pstates(host));
 315 }
 316
 317 /** \ingroup m_host_management
 318  * \brief Sets 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 switch to
 322  */
 323 void MSG_set_host_power_peak_at(msg_host_t host, int pstate_index) {
 324           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 325
 326           simcall_host_set_power_peak_at(host, pstate_index);
 327 }
 328
 329 /** \ingroup m_host_management
 330  * \brief Return the total energy consumed by a host (in Joules)
 331  *
 332  * \param  host host to test
 333  * \return Returns the consumed energy
 334  */
 335 double MSG_get_host_consumed_energy(msg_host_t host) {
 336           xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 337           return simcall_host_get_consumed_energy(host);
 338 }
 339
 340 /** \ingroup m_host_management
 341  * \brief Return the list of mount point names on an host.
 342  * \param host a host
 343  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 344  */
 345 xbt_dict_t MSG_host_get_storage_list(msg_host_t host)
 346 {
 347   xbt_assert((host != NULL), "Invalid parameters");
 348   return (simcall_host_get_storage_list(host));
 349 }
 350
 351 /** \ingroup msg_host_management
 352  * \brief Return the content of mounted storages on an host.
 353  * \param host a host
 354  * \return a dict containing content (as a dict) of all storages mounted on the host
 355  */
 356 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 357 {
 358   xbt_assert((host != NULL), "Invalid parameters");
 359   xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
 360   msg_storage_t storage;
 361   char* storage_name;
 362   char* mount_name;
 363   xbt_dict_cursor_t cursor = NULL;
 364
 365   xbt_dict_t storage_list = simcall_host_get_storage_list(host);
 366
 367   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 368     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 369     xbt_dict_t content = simcall_storage_get_content(storage);
 370     xbt_dict_set(contents,mount_name, content,NULL);
 371   }
 372   xbt_dict_free(&storage_list);
 373   return contents;
 374 }