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