src/msg/msg_host.cpp

   1 /* Copyright (c) 2004-2015. 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 "src/msg/msg_private.h"
   8 #include "xbt/sysdep.h"
   9 #include "xbt/log.h"
  10 #include "simgrid/simix.h"
  11 #include <simgrid/s4u/host.hpp>
  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(sg_host_t host) // FIXME: don't return our parameter
  30 {
  31   msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
  32
  33   priv->dp_objs = xbt_dict_new();
  34   priv->dp_enabled = 0;
  35   priv->dp_updated_by_deleted_tasks = 0;
  36   priv->is_migrating = 0;
  37
  38   priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
  39
  40   priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
  41   for (int i=1023; i>=0;i--)
  42     xbt_dynar_push_as(priv->file_descriptor_table, int, i);
  43
  44   sg_host_msg_set(host,priv);
  45
  46   return host;
  47 }
  48
  49 /** \ingroup m_host_management
  50  * \brief Finds a msg_host_t using its name.
  51  *
  52  * This is a name directory service
  53  * \param name the name of an host.
  54  * \return the corresponding host
  55  */
  56 msg_host_t MSG_host_by_name(const char *name)
  57 {
  58   return simgrid::s4u::Host::by_name_or_null(name);
  59 }
  60
  61 /** \ingroup m_host_management
  62  *
  63  * \brief Set the user data of a #msg_host_t.
  64  *
  65  * This functions checks whether some data has already been associated to \a host
  66    or not and attach \a data to \a host if it is possible.
  67  */
  68 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
  69   sg_host_user_set(host, data);
  70   return MSG_OK;
  71 }
  72
  73 /** \ingroup m_host_management
  74  *
  75  * \brief Return the user data of a #msg_host_t.
  76  *
  77  * This functions checks whether \a host is a valid pointer or not and return
  78    the user data associated to \a host if it is possible.
  79  */
  80 void *MSG_host_get_data(msg_host_t host) {
  81   return sg_host_user(host);
  82 }
  83
  84 /** \ingroup m_host_management
  85  *
  86  * \brief Return the location on which the current process is executed.
  87  */
  88 msg_host_t MSG_host_self(void)
  89 {
  90   return MSG_process_get_host(NULL);
  91 }
  92
  93
  94 /** \ingroup m_host_management
  95  *
  96  * \brief Start the host if it is off
  97  *
  98  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
  99  */
 100 void MSG_host_on(msg_host_t host)
 101 {
 102   host->turnOn();
 103 }
 104
 105 /** \ingroup m_host_management
 106  *
 107  * \brief Stop the host if it is on
 108  *
 109  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
 110  */
 111 void MSG_host_off(msg_host_t host)
 112 {
 113   host->turnOff();
 114 }
 115
 116 /*
 117  * \brief Frees private data of a host (internal call only)
 118  */
 119 void __MSG_host_priv_free(msg_host_priv_t priv)
 120 {
 121
 122   if (priv == NULL)
 123     return;
 124   unsigned int size = xbt_dict_size(priv->dp_objs);
 125   if (size > 0)
 126     XBT_WARN("dp_objs: %u pending task?", size);
 127   xbt_dict_free(&priv->dp_objs);
 128   xbt_dict_free(&priv->affinity_mask_db);
 129   xbt_dynar_free(&priv->file_descriptor_table);
 130
 131   free(priv);
 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_dict_length(host_list);
 140 }
 141
 142 /** \ingroup m_host_management
 143  * \brief Return a dynar containing all the hosts declared at a given point of time
 144  * \remark The host order in the returned array is generally different from the host creation/declaration order in the XML platform (we use a hash table internally)
 145  */
 146 xbt_dynar_t MSG_hosts_as_dynar(void) {
 147   return sg_hosts_as_dynar();
 148 }
 149
 150 /** \ingroup m_host_management
 151  * \brief Return the speed of the processor (in flop/s), regardless of
 152     the current load on the machine.
 153  */
 154 double MSG_get_host_speed(msg_host_t host) {
 155   return host->speed();
 156 }
 157
 158
 159 /** \ingroup m_host_management
 160  * \brief Return the number of cores.
 161  *
 162  * \param host a host
 163  * \return the number of cores
 164  */
 165 int MSG_host_get_core_number(msg_host_t host) {
 166   return host->core_count();
 167 }
 168
 169 /** \ingroup m_host_management
 170  * \brief Return the list of processes attached to an host.
 171  *
 172  * \param host a host
 173  * \return a swag with the attached processes
 174  */
 175 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 176 {
 177   xbt_assert((host != NULL), "Invalid parameters");
 178   return host->processes();
 179 }
 180
 181
 182 /** \ingroup m_host_management
 183  * \brief Returns the value of a given host property
 184  *
 185  * \param host a host
 186  * \param name a property name
 187  * \return value of a property (or NULL if property not set)
 188  */
 189 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 190 {
 191   return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 192 }
 193
 194 /** \ingroup m_host_management
 195  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 196  *
 197  * \param host a host
 198  * \return a dict containing the properties
 199  */
 200 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 201 {
 202   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 203   return host->properties();
 204 }
 205
 206 /** \ingroup m_host_management
 207  * \brief Change the value of a given host property
 208  *
 209  * \param host a host
 210  * \param name a property name
 211  * \param value what to change the property to
 212  * \param free_ctn the freeing function to use to kill the value on need
 213  */
 214 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 215
 216   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 217 }
 218
 219
 220 /** @ingroup m_host_management
 221  *
 222  * @brief Determine if a host is up and running.
 223  *
 224  * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
 225  *
 226  * @param host host to test
 227  * @return Returns true if the host is up and running, and false if it's currently down
 228  */
 229 int MSG_host_is_on(msg_host_t host)
 230 {
 231   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 232   return sg_host_is_on(host);
 233 }
 234 /** @ingroup m_host_management
 235  *
 236  * @brief Determine if a host is currently off.
 237  *
 238  * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref SURF_plugin_energy for more info on DVFS.
 239  */
 240 int MSG_host_is_off(msg_host_t host)
 241 {
 242   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 243   return !(sg_host_is_on(host));
 244 }
 245
 246 /** \ingroup m_host_management
 247  * \brief Set the parameters of a given host
 248  *
 249  * \param host a host
 250  * \param params a prameter object
 251  */
 252 void MSG_host_set_params(msg_host_t host, vm_params_t params)
 253 {
 254   host->setParameters(params);
 255 }
 256
 257 /** \ingroup m_host_management
 258  * \brief Get the parameters of a given host
 259  *
 260  * \param host a host
 261  * \param params a prameter object
 262  */
 263 void MSG_host_get_params(msg_host_t host, vm_params_t params)
 264 {
 265   host->parameters(params);
 266 }
 267
 268 /** \ingroup m_host_management
 269  * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 270  *
 271  * \param  host host to test
 272  * \param pstate_index pstate to test
 273  * \return Returns the processor speed associated with pstate_index
 274  */
 275 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
 276     xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 277     return host->powerPeakAt(pstate_index);
 278 }
 279
 280 /** \ingroup m_host_management
 281  * \brief Return the current speed of the processor (in flop/s)
 282  *
 283  * \param  host host to test
 284  * \return Returns the current processor speed
 285  */
 286 double MSG_host_get_current_power_peak(msg_host_t host) {
 287     xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 288     return host->currentPowerPeak();
 289 }
 290
 291 /** \ingroup m_host_management
 292  * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
 293  *
 294  * \param  host host to test
 295  */
 296 int MSG_host_get_nb_pstates(msg_host_t host) {
 297     return sg_host_get_nb_pstates(host);
 298 }
 299
 300 /** \ingroup m_host_management
 301  * \brief Return the list of mount point names on an host.
 302  * \param host a host
 303  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 304  */
 305 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 306 {
 307   xbt_assert((host != NULL), "Invalid parameters");
 308   return host->mountedStoragesAsDict();
 309 }
 310
 311 /** \ingroup m_host_management
 312  * \brief Return the list of storages attached to an host.
 313  * \param host a host
 314  * \return a dynar containing all storages (name) attached to the host
 315  */
 316 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 317 {
 318   xbt_assert((host != NULL), "Invalid parameters");
 319   return host->attachedStorages();
 320 }
 321
 322 /** \ingroup m_host_management
 323  * \brief Return the content of mounted storages on an host.
 324  * \param host a host
 325  * \return a dict containing content (as a dict) of all storages mounted on the host
 326  */
 327 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 328 {
 329   xbt_assert((host != NULL), "Invalid parameters");
 330   xbt_dict_t contents = xbt_dict_new_homogeneous(NULL);
 331   msg_storage_t storage;
 332   char* storage_name;
 333   char* mount_name;
 334   xbt_dict_cursor_t cursor = NULL;
 335
 336   xbt_dict_t storage_list = host->mountedStoragesAsDict();
 337
 338   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 339     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 340     xbt_dict_t content = simcall_storage_get_content(storage);
 341     xbt_dict_set(contents,mount_name, content,NULL);
 342   }
 343   xbt_dict_free(&storage_list);
 344   return contents;
 345 }
 346
 347 int __MSG_host_get_file_descriptor_id(msg_host_t host){
 348   msg_host_priv_t priv = sg_host_msg(host);
 349   xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
 350     "Too much files are opened! Some have to be closed.");
 351   return xbt_dynar_pop_as(priv->file_descriptor_table, int);
 352 }
 353
 354 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
 355   msg_host_priv_t priv = sg_host_msg(host);
 356   xbt_dynar_push_as(priv->file_descriptor_table, int, id);
 357 }