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