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 /** @addtogroup m_host_management
  16  * (#msg_host_t) and the functions for managing it.
  17  *
  18  *  A <em>location</em> (or <em>host</em>) is any possible place where  a process may run. Thus it may be represented
  19  *  as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
  20  *  communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
  21  *  \see msg_host_t
  22  */
  23
  24 /********************************* Host **************************************/
  25 msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
  26 {
  27   msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
  28
  29   priv->dp_objs = xbt_dict_new();
  30   priv->dp_enabled = 0;
  31   priv->dp_updated_by_deleted_tasks = 0;
  32   priv->is_migrating = 0;
  33
  34   priv->affinity_mask_db = xbt_dict_new_homogeneous(nullptr);
  35
  36   priv->file_descriptor_table = xbt_dynar_new(sizeof(int), nullptr);
  37   for (int i=1023; 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(void)
  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_dict_free(&priv->affinity_mask_db);
 123   xbt_dynar_free(&priv->file_descriptor_table);
 124
 125   free(priv);
 126 }
 127
 128 /** \ingroup m_host_management
 129  * \brief Return the current number MSG hosts.
 130  */
 131 int MSG_get_host_number(void)
 132 {
 133   return xbt_dict_length(host_list);
 134 }
 135
 136 /** \ingroup m_host_management
 137  * \brief Return a dynar containing all the hosts declared at a given point of time
 138  * \remark The host order in the returned array is generally different from the host creation/declaration order in the
 139  *         XML platform (we use a hash table internally)
 140  */
 141 xbt_dynar_t MSG_hosts_as_dynar(void) {
 142   return sg_hosts_as_dynar();
 143 }
 144
 145 /** \ingroup m_host_management
 146  * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
 147  */
 148 double MSG_host_get_speed(msg_host_t host) {
 149   return host->speed();
 150 }
 151
 152 /** \ingroup m_host_management
 153  * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
 154  * Deprecated: use MSG_host_get_speed
 155  */
 156 double MSG_get_host_speed(msg_host_t host) {
 157   XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
 158   return MSG_host_get_speed(host);
 159 }
 160
 161
 162 /** \ingroup m_host_management
 163  * \brief Return the number of cores.
 164  *
 165  * \param host a host
 166  * \return the number of cores
 167  */
 168 int MSG_host_get_core_number(msg_host_t host) {
 169   return host->core_count();
 170 }
 171
 172 /** \ingroup m_host_management
 173  * \brief Return the list of processes attached to an host.
 174  *
 175  * \param host a host
 176  * \return a swag with the attached processes
 177  */
 178 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 179 {
 180   xbt_assert((host != nullptr), "Invalid parameters");
 181   return host->processes();
 182 }
 183
 184 /** \ingroup m_host_management
 185  * \brief Returns the value of a given host property
 186  *
 187  * \param host a host
 188  * \param name a property name
 189  * \return value of a property (or nullptr if property not set)
 190  */
 191 const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 192 {
 193   return (const char*) xbt_dict_get_or_null(MSG_host_get_properties(host), name);
 194 }
 195
 196 /** \ingroup m_host_management
 197  * \brief Returns a xbt_dict_t consisting of the list of properties assigned to this host
 198  *
 199  * \param host a host
 200  * \return a dict containing the properties
 201  */
 202 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 203 {
 204   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
 205   return host->properties();
 206 }
 207
 208 /** \ingroup m_host_management
 209  * \brief Change the value of a given host property
 210  *
 211  * \param host a host
 212  * \param name a property name
 213  * \param value what to change the property to
 214  * \param free_ctn the freeing function to use to kill the value on need
 215  */
 216 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
 217   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 218 }
 219
 220 /** @ingroup m_host_management
 221  * @brief Determine if a host is up and running.
 222  *
 223  * 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.
 224  *
 225  * @param host host to test
 226  * @return Returns true if the host is up and running, and false if it's currently down
 227  */
 228 int MSG_host_is_on(msg_host_t host)
 229 {
 230   return host->isOn();
 231 }
 232
 233 /** @ingroup m_host_management
 234  * @brief Determine if a host is currently off.
 235  *
 236  * 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.
 237  */
 238 int MSG_host_is_off(msg_host_t host)
 239 {
 240   return host->isOff();
 241 }
 242
 243 /** \ingroup m_host_management
 244  * \brief Set the parameters of a given host
 245  *
 246  * \param host a host
 247  * \param params a prameter object
 248  */
 249 void MSG_host_set_params(msg_host_t host, vm_params_t params)
 250 {
 251   host->setParameters(params);
 252 }
 253
 254 /** \ingroup m_host_management
 255  * \brief Get the parameters of a given host
 256  *
 257  * \param host a host
 258  * \param params a prameter object
 259  */
 260 void MSG_host_get_params(msg_host_t host, vm_params_t params)
 261 {
 262   host->parameters(params);
 263 }
 264
 265 /** \ingroup m_host_management
 266  * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
 267  *
 268  * \param  host host to test
 269  * \param pstate_index pstate to test
 270  * \return Returns the processor speed associated with pstate_index
 271  */
 272 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
 273   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
 274   return host->powerPeakAt(pstate_index);
 275 }
 276
 277 /** \ingroup m_host_management
 278  * \brief Return the current speed of the processor (in flop/s)
 279  *
 280  * \param  host host to test
 281  * \return Returns the current processor speed
 282  */
 283 double MSG_host_get_current_power_peak(msg_host_t host) {
 284   xbt_assert((host != nullptr), "Invalid parameters (host is nullptr)");
 285   return host->currentPowerPeak();
 286 }
 287
 288 /** \ingroup m_host_management
 289  * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
 290  *
 291  * \param  host host to test
 292  */
 293 int MSG_host_get_nb_pstates(msg_host_t host) {
 294   return sg_host_get_nb_pstates(host);
 295 }
 296
 297 /** \ingroup m_host_management
 298  * \brief Return the list of mount point names on an host.
 299  * \param host a host
 300  * \return a dict containing all mount point on the host (mount_name => msg_storage_t)
 301  */
 302 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 303 {
 304   xbt_assert((host != nullptr), "Invalid parameters");
 305   return host->mountedStoragesAsDict();
 306 }
 307
 308 /** \ingroup m_host_management
 309  * \brief Return the list of storages attached to an host.
 310  * \param host a host
 311  * \return a dynar containing all storages (name) attached to the host
 312  */
 313 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 314 {
 315   xbt_assert((host != nullptr), "Invalid parameters");
 316   return host->attachedStorages();
 317 }
 318
 319 /** \ingroup m_host_management
 320  * \brief Return the content of mounted storages on an host.
 321  * \param host a host
 322  * \return a dict containing content (as a dict) of all storages mounted on the host
 323  */
 324 xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 325 {
 326   xbt_assert((host != nullptr), "Invalid parameters");
 327   xbt_dict_t contents = xbt_dict_new_homogeneous(nullptr);
 328   msg_storage_t storage;
 329   char* storage_name;
 330   char* mount_name;
 331   xbt_dict_cursor_t cursor = nullptr;
 332
 333   xbt_dict_t storage_list = host->mountedStoragesAsDict();
 334
 335   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
 336     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
 337     xbt_dict_t content = simcall_storage_get_content(storage);
 338     xbt_dict_set(contents,mount_name, content,nullptr);
 339   }
 340   xbt_dict_free(&storage_list);
 341   return contents;
 342 }
 343
 344 int __MSG_host_get_file_descriptor_id(msg_host_t host){
 345   msg_host_priv_t priv = sg_host_msg(host);
 346   xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table), "Too much files are opened! Some have to be closed.");
 347   return xbt_dynar_pop_as(priv->file_descriptor_table, int);
 348 }
 349
 350 void __MSG_host_release_file_descriptor_id(msg_host_t host, int id){
 351   msg_host_priv_t priv = sg_host_msg(host);
 352   xbt_dynar_push_as(priv->file_descriptor_table, int, id);
 353 }