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