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