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