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