src/msg/msg_host.cpp

   1 /* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "simgrid/s4u/Host.hpp"
   7 #include "simgrid/s4u/Storage.hpp"
   8 #include "src/msg/msg_private.hpp"
   9 #include "src/simix/ActorImpl.hpp"
  10 #include "src/simix/smx_host_private.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 extern "C" {
  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 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 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 (including VMs)
 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->getSpeed();
 118 }
 119
 120 /** \ingroup m_host_management
 121  * \brief Return the number of cores.
 122  *
 123  * \param host a host
 124  * \return the number of cores
 125  */
 126 int MSG_host_get_core_number(msg_host_t host) {
 127   return host->getCoreCount();
 128 }
 129
 130 /** \ingroup m_host_management
 131  * \brief Return the list of processes attached to an host.
 132  *
 133  * \param host a host
 134  * \param whereto a dynar in which we should push processes living on that host
 135  */
 136 void MSG_host_get_process_list(msg_host_t host, xbt_dynar_t whereto)
 137 {
 138   xbt_assert((host != nullptr), "Invalid parameters");
 139   smx_actor_t actor = NULL;
 140   xbt_swag_foreach(actor, host->extension<simgrid::simix::Host>()->process_list) {
 141     msg_process_t p = actor->ciface();
 142     xbt_dynar_push(whereto, &p);
 143   }
 144 }
 145
 146 /** \ingroup m_host_management
 147  * \brief Returns the value of a given host property
 148  *
 149  * \param host a host
 150  * \param name a property name
 151  * \return value of a property (or nullptr if property not set)
 152  */
 153 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 154 {
 155   return host->getProperty(name);
 156 }
 157
 158 /** \ingroup m_host_management
 159  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 160  *
 161  * \param host a host
 162  * \return a dict containing the properties
 163  */
 164 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 165 {
 166   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
 167   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
 168   std::map<std::string, std::string>* props = host->getProperties();
 169   if (props == nullptr)
 170     return nullptr;
 171   for (auto const& elm : *props) {
 172     xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
 173   }
 174   return as_dict;
 175 }
 176
 177 /** \ingroup m_host_management
 178  * \brief Change the value of a given host property
 179  *
 180  * \param host a host
 181  * \param name a property name
 182  * \param value what to change the property to
 183  */
 184 void MSG_host_set_property_value(msg_host_t host, const char* name, char* value)
 185 {
 186   host->setProperty(name, value);
 187 }
 188
 189 /** @ingroup m_host_management
 190  * @brief Determine if a host is up and running.
 191  *
 192  * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref plugin_energy for more info on
 193  * DVFS.
 194  *
 195  * @param host host to test
 196  * @return Returns true if the host is up and running, and false if it's currently down
 197  */
 198 int MSG_host_is_on(msg_host_t host)
 199 {
 200   return host->isOn();
 201 }
 202
 203 /** @ingroup m_host_management
 204  * @brief Determine if a host is currently off.
 205  *
 206  * See also #MSG_host_on() and #MSG_host_off() to switch the host ON and OFF and @ref plugin_energy for more info on
 207  * 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 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 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   return sg_host_get_mounted_storage_list(host);
 243 }
 244
 245 /** \ingroup m_host_management
 246  * \brief Return the list of storages attached to an host.
 247  * \param host a host
 248  * \return a dynar containing all storages (name) attached to the host
 249  */
 250 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 251 {
 252   return sg_host_get_attached_storage_list(host);
 253 }
 254
 255 }