src/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/private.h"
   8 #include "xbt/sysdep.h"
   9 #include "xbt/log.h"
  10 #include "mailbox.h"
  11
  12 /** \defgroup m_host_management Management functions of Hosts
  13  *  \brief This section describes the host structure of MSG
  14  */
  15 /** @addtogroup m_host_management
  16  *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
  17  * (#m_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 m_host_t
  26  */
  27
  28 /********************************* Host **************************************/
  29 m_host_t __MSG_host_create(smx_host_t workstation, void *data)
  30 {
  31   const char *name;
  32   simdata_host_t simdata = xbt_new0(s_simdata_host_t, 1);
  33   m_host_t host = xbt_new0(s_m_host_t, 1);
  34   int i;
  35
  36   char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
  37
  38   name = SIMIX_host_get_name(workstation);
  39   /* Host structure */
  40   host->name = xbt_strdup(name);
  41   host->simdata = simdata;
  42   host->data = data;
  43
  44   simdata->smx_host = workstation;
  45
  46   if (msg_global->max_channel > 0)
  47     simdata->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
  48
  49   for (i = 0; i < msg_global->max_channel; i++) {
  50     sprintf(alias, "%s:%d", name, i);
  51
  52     /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
  53     simdata->mailboxes[i] = MSG_mailbox_create(alias);
  54     memset(alias, 0, MAX_ALIAS_NAME + 1);
  55   }
  56
  57   simdata->mutex = SIMIX_mutex_init();
  58   SIMIX_host_set_data(workstation, host);
  59
  60   /* Update global variables */
  61   xbt_fifo_unshift(msg_global->host, host);
  62
  63   return host;
  64 }
  65
  66 /** \ingroup m_host_management
  67  *
  68  * \brief Set the user data of a #m_host_t.
  69  *
  70  * This functions checks whether some data has already been associated to \a host
  71    or not and attach \a data to \a host if it is possible.
  72  */
  73 MSG_error_t MSG_host_set_data(m_host_t host, void *data)
  74 {
  75   xbt_assert0((host != NULL), "Invalid parameters");
  76   xbt_assert0((host->data == NULL), "Data already set");
  77
  78   /* Assign data */
  79   host->data = data;
  80
  81   return MSG_OK;
  82 }
  83
  84 /** \ingroup m_host_management
  85  *
  86  * \brief Return the user data of a #m_host_t.
  87  *
  88  * This functions checks whether \a host is a valid pointer or not and return
  89    the user data associated to \a host if it is possible.
  90  */
  91 void *MSG_host_get_data(m_host_t host)
  92 {
  93
  94   xbt_assert0((host != NULL), "Invalid parameters");
  95
  96   /* Return data */
  97   return (host->data);
  98 }
  99
 100 /** \ingroup m_host_management
 101  *
 102  * \brief Return the name of the #m_host_t.
 103  *
 104  * This functions checks whether \a host is a valid pointer or not and return
 105    its name.
 106  */
 107 const char *MSG_host_get_name(m_host_t host)
 108 {
 109
 110   xbt_assert0((host != NULL)
 111               && (host->simdata != NULL), "Invalid parameters");
 112
 113   /* Return data */
 114   return (host->name);
 115 }
 116
 117 /** \ingroup m_host_management
 118  *
 119  * \brief Return the location on which the current process is executed.
 120  */
 121 m_host_t MSG_host_self(void)
 122 {
 123   return MSG_process_get_host(MSG_process_self());
 124 }
 125
 126 /*
 127  * Real function to destroy a host.
 128  * MSG_host_destroy is just  a front_end that also removes it from
 129  * msg_global->host
 130  */
 131 void __MSG_host_destroy(m_host_t host)
 132 {
 133   simdata_host_t simdata = NULL;
 134   int i = 0;
 135   char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
 136
 137   xbt_assert0((host != NULL), "Invalid parameters");
 138
 139   /* Clean Simulator data */
 140   /* SIMIX host will be cleaned when MSG_clean calls SIMIX_clean */
 141   simdata = (host)->simdata;
 142
 143   for (i = 0; i < msg_global->max_channel; i++) {
 144     sprintf(alias, "%s:%d", host->name, i);
 145     MSG_mailbox_free((void *) (simdata->mailboxes[i]));
 146     memset(alias, 0, MAX_ALIAS_NAME + 1);
 147   }
 148
 149   if (msg_global->max_channel > 0)
 150     free(simdata->mailboxes);
 151   SIMIX_mutex_destroy(simdata->mutex);
 152   free(simdata);
 153
 154   /* Clean host structure */
 155   free(host->name);
 156   free(host);
 157
 158
 159 }
 160
 161 /** \ingroup m_host_management
 162  * \brief Return the current number of #m_host_t.
 163  */
 164 int MSG_get_host_number(void)
 165 {
 166   return (xbt_fifo_size(msg_global->host));
 167 }
 168
 169 /** \ingroup m_host_management
 170  * \brief Return a array of all the #m_host_t.
 171  */
 172 m_host_t *MSG_get_host_table(void)
 173 {
 174   return ((m_host_t *) xbt_fifo_to_array(msg_global->host));
 175 }
 176
 177 /** \ingroup m_host_management
 178  * \brief Return the number of MSG tasks currently running on a
 179  * #m_host_t. The external load is not taken in account.
 180  */
 181 int MSG_get_host_msgload(m_host_t h)
 182 {
 183   xbt_assert0((h != NULL), "Invalid parameters");
 184   xbt_assert0(0, "Not implemented yet");
 185
 186   return (0);
 187 }
 188
 189 /** \ingroup m_host_management
 190  * \brief Return the speed of the processor (in flop/s), regardless of
 191     the current load on the machine.
 192  */
 193 double MSG_get_host_speed(m_host_t h)
 194 {
 195   xbt_assert0((h != NULL), "Invalid parameters");
 196
 197   return (SIMIX_host_get_speed(h->simdata->smx_host));
 198 }
 199
 200 /** \ingroup m_host_management
 201  * \brief Returns the value of a given host property
 202  *
 203  * \param host a host
 204  * \param name a property name
 205  * \return value of a property (or NULL if property not set)
 206  */
 207 const char *MSG_host_get_property_value(m_host_t host, const char *name)
 208 {
 209   return xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 210 }
 211
 212 /** \ingroup m_host_management
 213  * \brief Returns a xbt_dynar_t consisting of the list of properties assigned to this host
 214  *
 215  * \param host a host
 216  * \return a dict containing the properties
 217  */
 218 xbt_dict_t MSG_host_get_properties(m_host_t host)
 219 {
 220   xbt_assert0((host != NULL), "Invalid parameters (host is NULL)");
 221
 222   return (SIMIX_host_get_properties(host->simdata->smx_host));
 223 }
 224
 225
 226 /** \ingroup msg_gos_functions
 227  * \brief Determine if a host is available.
 228  *
 229  * \param h host to test
 230  */
 231 int MSG_host_is_avail(m_host_t h)
 232 {
 233   xbt_assert0((h != NULL), "Invalid parameters (host is NULL)");
 234   return (SIMIX_host_get_state(h->simdata->smx_host));
 235 }