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
  12 /** @addtogroup m_host_management
  13  *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
  14  * (#m_host_t) and the functions for managing it.
  15  *
  16  *  A <em>location</em> (or <em>host</em>) is any possible place where
  17  *  a process may run. Thus it may be represented as a
  18  *  <em>physical resource with computing capabilities</em>, some
  19  *  <em>mailboxes</em> to enable running process to communicate with
  20  *  remote ones, and some <em>private data</em> that can be only
  21  *  accessed by local process.
  22  *  \see m_host_t
  23  */
  24
  25 /********************************* Host **************************************/
  26 m_host_t __MSG_host_create(smx_host_t workstation, void *data)
  27 {
  28   const char *name;
  29   simdata_host_t simdata = xbt_new0(s_simdata_host_t, 1);
  30   m_host_t host = xbt_new0(s_m_host_t, 1);
  31
  32   name = SIMIX_host_get_name(workstation);
  33   /* Host structure */
  34   host->name = xbt_strdup(name);
  35   host->simdata = simdata;
  36   host->data = data;
  37
  38   simdata->smx_host = workstation;
  39
  40 #ifdef MSG_USE_DEPRECATED
  41   int i;
  42   char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
  43
  44   if (msg_global->max_channel > 0)
  45     simdata->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
  46
  47   for (i = 0; i < msg_global->max_channel; i++) {
  48     sprintf(alias, "%s:%d", name, i);
  49
  50     /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
  51     simdata->mailboxes[i] = MSG_mailbox_new(alias);
  52     memset(alias, 0, MAX_ALIAS_NAME + 1);
  53   }
  54 #endif
  55
  56   simcall_host_set_data(workstation, host);
  57   xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
  58
  59   return host;
  60 }
  61
  62 /** \ingroup msg_host_management
  63  * \brief Finds a m_host_t using its name.
  64  *
  65  * This is a name directory service
  66  * \param name the name of an host.
  67  * \return the corresponding host
  68  */
  69 m_host_t MSG_get_host_by_name(const char *name)
  70 {
  71   smx_host_t simix_h = NULL;
  72   simix_h = simcall_host_get_by_name(name);
  73
  74   if (simix_h == NULL)
  75     return NULL;
  76
  77   return (m_host_t) simcall_host_get_data(simix_h);
  78 }
  79
  80
  81 /** \ingroup m_host_management
  82  *
  83  * \brief Set the user data of a #m_host_t.
  84  *
  85  * This functions checks whether some data has already been associated to \a host
  86    or not and attach \a data to \a host if it is possible.
  87  */
  88 MSG_error_t MSG_host_set_data(m_host_t host, void *data)
  89 {
  90   xbt_assert((host != NULL), "Invalid parameters");
  91   xbt_assert((host->data == NULL), "Data already set");
  92
  93   /* Assign data */
  94   host->data = data;
  95
  96   return MSG_OK;
  97 }
  98
  99 /** \ingroup m_host_management
 100  *
 101  * \brief Return the user data of a #m_host_t.
 102  *
 103  * This functions checks whether \a host is a valid pointer or not and return
 104    the user data associated to \a host if it is possible.
 105  */
 106 void *MSG_host_get_data(m_host_t host)
 107 {
 108
 109   xbt_assert((host != NULL), "Invalid parameters");
 110
 111   /* Return data */
 112   return (host->data);
 113 }
 114
 115 /** \ingroup m_host_management
 116  *
 117  * \brief Return the name of the #m_host_t.
 118  *
 119  * This functions checks whether \a host is a valid pointer or not and return
 120    its name.
 121  */
 122 const char *MSG_host_get_name(m_host_t host)
 123 {
 124
 125   xbt_assert((host != NULL)
 126               && (host->simdata != NULL), "Invalid parameters");
 127
 128   /* Return data */
 129   return (host->name);
 130 }
 131
 132 /** \ingroup m_host_management
 133  *
 134  * \brief Return the location on which the current process is executed.
 135  */
 136 m_host_t MSG_host_self(void)
 137 {
 138   return MSG_process_get_host(NULL);
 139 }
 140
 141 /** \ingroup m_host_management
 142  *
 143  * \brief Destroys a host
 144  */
 145 void __MSG_host_destroy(m_host_t host)
 146 {
 147   simdata_host_t simdata = NULL;
 148
 149   xbt_assert((host != NULL), "Invalid parameters");
 150
 151   /* Clean simulator data */
 152   simdata = (host)->simdata;
 153
 154 #ifdef MSG_USE_DEPRECATED
 155   if (msg_global->max_channel > 0)
 156     free(simdata->mailboxes);
 157 #endif
 158
 159   free(simdata);
 160
 161   /* Clean host structure */
 162   free(host->name);
 163   free(host);
 164 }
 165
 166 #ifdef MSG_USE_DEPRECATED
 167 int MSG_get_host_number(void)
 168 {
 169   return xbt_lib_length(host_lib);
 170 }
 171
 172 m_host_t *MSG_get_host_table(void)
 173 {
 174       void **array;
 175           int i = 0;
 176           xbt_lib_cursor_t cursor;
 177           char *key;
 178           void **data;
 179
 180           if (xbt_lib_length(host_lib) == 0)
 181                 return NULL;
 182           else
 183                 array = xbt_new0(void *, xbt_lib_length(host_lib));
 184
 185           xbt_lib_foreach(host_lib, cursor, key, data) {
 186             if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
 187                 array[i++] = data[MSG_HOST_LEVEL];
 188           }
 189
 190           return (m_host_t *)array;
 191 }
 192 #endif
 193
 194 /** \ingroup m_host_management
 195  * \brief Return a dynar containing all the hosts declared at a given point of time
 196  */
 197 xbt_dynar_t MSG_hosts_as_dynar(void) {
 198   xbt_lib_cursor_t cursor;
 199   char *key;
 200   void **data;
 201   xbt_dynar_t res = xbt_dynar_new(sizeof(m_host_t),NULL);
 202
 203   xbt_lib_foreach(host_lib, cursor, key, data) {
 204     if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
 205       xbt_dynar_push(res, data + MSG_HOST_LEVEL);
 206   }
 207   return res;
 208 }
 209
 210 /** \ingroup m_host_management
 211  * \brief Return the number of MSG tasks currently running on a
 212  * #m_host_t. The external load is not taken in account.
 213  */
 214 int MSG_get_host_msgload(m_host_t h)
 215 {
 216   xbt_assert((h != NULL), "Invalid parameters");
 217   xbt_die( "Not implemented yet");
 218
 219   return (0);
 220 }
 221
 222 /** \ingroup m_host_management
 223  * \brief Return the speed of the processor (in flop/s), regardless of
 224     the current load on the machine.
 225  */
 226 double MSG_get_host_speed(m_host_t h)
 227 {
 228   xbt_assert((h != NULL), "Invalid parameters");
 229
 230   return (simcall_host_get_speed(h->simdata->smx_host));
 231 }
 232
 233 /** \ingroup m_host_management
 234  * \brief Returns the value of a given host property
 235  *
 236  * \param host a host
 237  * \param name a property name
 238  * \return value of a property (or NULL if property not set)
 239  */
 240 const char *MSG_host_get_property_value(m_host_t host, const char *name)
 241 {
 242   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 243 }
 244
 245 /** \ingroup m_host_management
 246  * \brief Returns a xbt_dynar_t consisting of the list of properties assigned to this host
 247  *
 248  * \param host a host
 249  * \return a dict containing the properties
 250  */
 251 xbt_dict_t MSG_host_get_properties(m_host_t host)
 252 {
 253   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 254
 255   return (simcall_host_get_properties(host->simdata->smx_host));
 256 }
 257
 258
 259 /** \ingroup msg_gos_functions
 260  * \brief Determine if a host is available.
 261  *
 262  * \param host host to test
 263  * \return Returns 1 if host is available, 0 otherwise
 264  */
 265 int MSG_host_is_avail(m_host_t host)
 266 {
 267   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 268   return (simcall_host_get_state(host->simdata->smx_host));
 269 }