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