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