src/msg/host.c

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