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