src/msg/msg_host.c

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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
  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   if (msg_global->max_channel > 0)
  39     host->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
  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     host->mailboxes[i] = MSG_mailbox_new(alias);
  46     memset(alias, 0, MAX_ALIAS_NAME + 1);
  47   }
  48 #endif
  49
  50   xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
  51
  52   return xbt_lib_get_elm_or_null(host_lib, name);
  53 }
  54
  55
  56 /** \ingroup msg_host_management
  57  * \brief Finds a msg_host_t using its name.
  58  *
  59  * This is a name directory service
  60  * \param name the name of an host.
  61  * \return the corresponding host
  62  */
  63 msg_host_t MSG_get_host_by_name(const char *name)
  64 {
  65   return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
  66 }
  67
  68 /** \ingroup m_host_management
  69  *
  70  * \brief Set the user data of a #msg_host_t.
  71  *
  72  * This functions checks whether some data has already been associated to \a host
  73    or not and attach \a data to \a host if it is possible.
  74  */
  75 msg_error_t MSG_host_set_data(msg_host_t host, void *data)
  76 {
  77   SIMIX_host_set_data(host,data);
  78
  79   return MSG_OK;
  80 }
  81
  82 /** \ingroup m_host_management
  83  *
  84  * \brief Return the user data of a #msg_host_t.
  85  *
  86  * This functions checks whether \a host is a valid pointer or not and return
  87    the user data associated to \a host if it is possible.
  88  */
  89 void *MSG_host_get_data(msg_host_t host)
  90 {
  91   return SIMIX_host_get_data(host);
  92 }
  93
  94 /** \ingroup m_host_management
  95  *
  96  * \brief Return the name of the #msg_host_t.
  97  *
  98  * This functions checks whether \a host is a valid pointer or not and return
  99    its name.
 100  */
 101 const char *MSG_host_get_name(msg_host_t host) {
 102   return SIMIX_host_get_name(host);
 103 }
 104
 105 /** \ingroup m_host_management
 106  *
 107  * \brief Return the location on which the current process is executed.
 108  */
 109 msg_host_t MSG_host_self(void)
 110 {
 111   return MSG_process_get_host(NULL);
 112 }
 113
 114 /*
 115  * \brief Frees private data of a host (internal call only)
 116  */
 117 void __MSG_host_priv_free(msg_host_priv_t priv)
 118 {
 119 #ifdef MSG_USE_DEPRECATED
 120   if (msg_global->max_channel > 0)
 121     free(priv->mailboxes);
 122 #endif
 123
 124   free(priv);
 125 }
 126
 127 /*
 128  * \brief Destroys a host (internal call only)
 129  */
 130 void __MSG_host_destroy(msg_host_t host)
 131 {
 132   const char *name = MSG_host_get_name(host);
 133   /* TODO:
 134    * What happens if VMs still remain on this host?
 135    * Revisit here after the surf layer gets stable.
 136    **/
 137
 138   xbt_lib_unset(host_lib, name, MSG_HOST_LEVEL, 1);
 139 }
 140
 141 /** \ingroup m_host_management
 142  * \brief Return the current number MSG hosts.
 143  */
 144 int MSG_get_host_number(void)
 145 {
 146   return xbt_lib_length(host_lib);
 147 }
 148
 149 #ifdef MSG_USE_DEPRECATED
 150 msg_host_t *MSG_get_host_table(void)
 151 {
 152       void **array;
 153     int i = 0;
 154     xbt_lib_cursor_t cursor;
 155     char *key;
 156     void **data;
 157
 158     if (xbt_lib_length(host_lib) == 0)
 159     return NULL;
 160     else
 161     array = xbt_new0(void *, xbt_lib_length(host_lib));
 162
 163     xbt_lib_foreach(host_lib, cursor, key, data) {
 164       if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
 165         array[i++] = data[MSG_HOST_LEVEL];
 166     }
 167
 168     return (msg_host_t *)array;
 169 }
 170 #endif
 171
 172 /** \ingroup m_host_management
 173  * \brief Return a dynar containing all the hosts declared at a given point of time
 174  */
 175 xbt_dynar_t MSG_hosts_as_dynar(void) {
 176   xbt_lib_cursor_t cursor;
 177   char *key;
 178   void **data;
 179   xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
 180
 181   xbt_lib_foreach(host_lib, cursor, key, data) {
 182     if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
 183       xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
 184       xbt_dynar_push(res, &elm);
 185     }
 186   }
 187   return res;
 188 }
 189
 190 /** \ingroup m_host_management
 191  * \brief Return the number of MSG tasks currently running on a
 192  * #msg_host_t. The external load is not taken in account.
 193  */
 194 int MSG_get_host_msgload(msg_host_t h)
 195 {
 196   xbt_assert((h != NULL), "Invalid parameters");
 197   xbt_die( "Not implemented yet");
 198
 199   return (0);
 200 }
 201
 202 /** \ingroup m_host_management
 203  * \brief Return the speed of the processor (in flop/s), regardless of
 204     the current load on the machine.
 205  */
 206 double MSG_get_host_speed(msg_host_t h)
 207 {
 208   xbt_assert((h != NULL), "Invalid parameters");
 209
 210   return (simcall_host_get_speed(h));
 211 }
 212
 213 /** \ingroup m_host_management
 214  * \brief Returns the value of a given host property
 215  *
 216  * \param host a host
 217  * \param name a property name
 218  * \return value of a property (or NULL if property not set)
 219  */
 220 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 221 {
 222   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 223 }
 224
 225 /** \ingroup m_host_management
 226  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 227  *
 228  * \param host a host
 229  * \return a dict containing the properties
 230  */
 231 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 232 {
 233   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 234
 235   return (simcall_host_get_properties(host));
 236 }
 237
 238 /** \ingroup m_host_management
 239  * \brief Change the value of a given host property
 240  *
 241  * \param host a host
 242  * \param name a property name
 243  * \param value what to change the property to
 244  * \param free_ctn the freeing function to use to kill the value on need
 245  */
 246 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 247
 248   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 249 }
 250
 251
 252 /** \ingroup msg_gos_functions
 253  * \brief Determine if a host is available.
 254  *
 255  * \param host host to test
 256  * \return Returns 1 if host is available, 0 otherwise
 257  */
 258 int MSG_host_is_avail(msg_host_t host)
 259 {
 260   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 261   return (simcall_host_get_state(host));
 262 }