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