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