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