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  a process may run. Thus it may be represented
  20  *  as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
  21  *  communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
  22  *  \see msg_host_t
  23  */
  24
  25 /********************************* Host **************************************/
  26 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
  27 {
  28   msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
  29
  30   priv->dp_objs = xbt_dict_new();
  31   priv->dp_enabled = 0;
  32   priv->dp_updated_by_deleted_tasks = 0;
  33   priv->is_migrating = 0;
  34
  35   priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
  36
  37   priv->file_descriptor_table = xbt_dynar_new(sizeof(int), NULL);
  38   for (int i=1023; i>=0;i--)
  39     xbt_dynar_push_as(priv->file_descriptor_table, int, i);
  40
  41   sg_host_msg_set(host,priv);
  42
  43   return host;
  44 }
  45
  46 /** \ingroup m_host_management
  47  * \brief Finds a msg_host_t using its name.
  48  *
  49  * This is a name directory service
  50  * \param name the name of an host.
  51  * \return the corresponding host
  52  */
  53 msg_host_t MSG_host_by_name(const char *name)
  54 {
  55   return simgrid::s4u::Host::by_name_or_null(name);
  56 }
  57
  58 /** \ingroup m_host_management
  59  *
  60  * \brief Set the user data of a #msg_host_t.
  61  *
  62  * This functions attach \a data to \a host if it is possible.
  63  */
  64 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
  65   sg_host_user_set(host, data);
  66   return MSG_OK;
  67 }
  68
  69 /** \ingroup m_host_management
  70  *
  71  * \brief Return the user data of a #msg_host_t.
  72  *
  73  * This functions returns the user data associated to \a host if it is possible.
  74  */
  75 void *MSG_host_get_data(msg_host_t host) {
  76   return sg_host_user(host);
  77 }
  78
  79 /** \ingroup m_host_management
  80  *
  81  * \brief Return the location on which the current process is executed.
  82  */
  83 msg_host_t MSG_host_self(void)
  84 {
  85   return MSG_process_get_host(NULL);
  86 }
  87
  88 /** \ingroup m_host_management
  89  *
  90  * \brief Start the host if it is off
  91  *
  92  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
  93  * for more info on DVFS.
  94  */
  95 void MSG_host_on(msg_host_t host)
  96 {
  97   host->turnOn();
  98 }
  99
 100 /** \ingroup m_host_management
 101  *
 102  * \brief Stop the host if it is on
 103  *
 104  * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
 105  * for more info on DVFS.
 106  */
 107 void MSG_host_off(msg_host_t host)
 108 {
 109   host->turnOff();
 110 }
 111
 112 /*
 113  * \brief Frees private data of a host (internal call only)
 114  */
 115 void __MSG_host_priv_free(msg_host_priv_t priv)
 116 {
 117   if (priv == NULL)
 118     return;
 119   unsigned int size = xbt_dict_size(priv->dp_objs);
 120   if (size > 0)
 121     XBT_WARN("dp_objs: %u pending task?", size);
 122   xbt_dict_free(&priv->dp_objs);
 123   xbt_dict_free(&priv->affinity_mask_db);
 124   xbt_dynar_free(&priv->file_descriptor_table);
 125
 126   free(priv);
 127 }
 128
 129 /** \ingroup m_host_management
 130  * \brief Return the current number MSG hosts.
 131  */
 132 int MSG_get_host_number(void)
 133 {
 134   return xbt_dict_length(host_list);
 135 }
 136
 137 /** \ingroup m_host_management
 138  * \brief Return a dynar containing all the hosts declared at a given point of time
 139  * \remark The host order in the returned array is generally different from the host creation/declaration order in the
 140  *         XML platform (we use a hash table internally)
 141  */
 142 xbt_dynar_t MSG_hosts_as_dynar(void) {
 143   return sg_hosts_as_dynar();
 144 }
 145
 146 /** \ingroup m_host_management
 147  * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
 148  */
 149 double MSG_host_get_speed(msg_host_t host) {
 150   return host->speed();
 151 }
 152
 153 /** \ingroup m_host_management
 154  * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
 155  * Deprecated: use MSG_host_get_speed
 156  */
 157 double MSG_get_host_speed(msg_host_t host) {
 158   XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
 159   return MSG_host_get_speed(host);
 160 }
 161
 162
 163 /** \ingroup m_host_management
 164  * \brief Return the number of cores.
 165  *
 166  * \param host a host
 167  * \return the number of cores
 168  */
 169 int MSG_host_get_core_number(msg_host_t host) {
 170   return host->core_count();
 171 }
 172
 173 /** \ingroup m_host_management
 174  * \brief Return the list of processes attached to an host.
 175  *
 176  * \param host a host
 177  * \return a swag with the attached processes
 178  */
 179 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 180 {
 181   xbt_assert((host != NULL), "Invalid parameters");
 182   return host->processes();
 183 }
 184
 185 /** \ingroup m_host_management
 186  * \brief Returns the value of a given host property
 187  *
 188  * \param host a host
 189  * \param name a property name
 190  * \return value of a property (or NULL if property not set)
 191  */
 192 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 193 {
 194   return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 195 }
 196
 197 /** \ingroup m_host_management
 198  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 199  *
 200  * \param host a host
 201  * \return a dict containing the properties
 202  */
 203 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 204 {
 205   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 206   return host->properties();
 207 }
 208
 209 /** \ingroup m_host_management
 210  * \brief Change the value of a given host property
 211  *
 212  * \param host a host
 213  * \param name a property name
 214  * \param value what to change the property to
 215  * \param free_ctn the freeing function to use to kill the value on need
 216  */
 217 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 218   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 219 }
 220
 221 /** @ingroup m_host_management
 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
 235 /** @ingroup m_host_management
 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), "Too much files are opened! Some have to be closed.");
 350   return xbt_dynar_pop_as(priv->file_descriptor_table, int);
 351 }
 352
 353 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
 354   msg_host_priv_t priv = sg_host_msg(host);
 355   xbt_dynar_push_as(priv->file_descriptor_table, int, id);
 356 }