Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / src / msg / msg_host.cpp
index ee9ac40..917421d 100644 (file)
@@ -5,24 +5,19 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 #include "simgrid/simix.h"
-#include "simgrid/Host.hpp"
+#include <simgrid/s4u/host.hpp>
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
 
 /** @addtogroup m_host_management
- * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
  * (#msg_host_t) and the functions for managing it.
  *  
- *  A <em>location</em> (or <em>host</em>) is any possible place where
- *  a process may run. Thus it may be represented as a
- *  <em>physical resource with computing capabilities</em>, some
- *  <em>mailboxes</em> to enable running process to communicate with
- *  remote ones, and some <em>private data</em> that can be only
- *  accessed by local process.
+ *  A <em>location</em> (or <em>host</em>) is any possible place where  a process may run. Thus it may be represented
+ *  as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
+ *  communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
  *  \see msg_host_t
  */
 
@@ -31,23 +26,6 @@ msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our paramete
 {
   msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
 
-#ifdef MSG_USE_DEPRECATED
-  int i;
-  char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
-
-  priv->mailboxes = (msg_global->max_channel > 0) ?
-    xbt_new0(msg_mailbox_t, msg_global->max_channel) : NULL;
-
-  for (i = 0; i < msg_global->max_channel; i++) {
-    sprintf(alias, "%s:%d", name, i);
-
-    /* the key of the mailbox (in this case) is build from the name of the host and the channel number */
-    priv->mailboxes[i] = MSG_mailbox_new(alias);
-    memset(alias, 0, MAX_ALIAS_NAME + 1);
-  }
-#endif
-
-
   priv->dp_objs = xbt_dict_new();
   priv->dp_enabled = 0;
   priv->dp_updated_by_deleted_tasks = 0;
@@ -60,7 +38,7 @@ msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our paramete
     xbt_dynar_push_as(priv->file_descriptor_table, int, i);
 
   sg_host_msg_set(host,priv);
-  
+
   return host;
 }
 
@@ -73,15 +51,14 @@ msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our paramete
  */
 msg_host_t MSG_host_by_name(const char *name)
 {
-  return simgrid::Host::by_name_or_null(name);
+  return simgrid::s4u::Host::by_name_or_null(name);
 }
 
 /** \ingroup m_host_management
  *
  * \brief Set the user data of a #msg_host_t.
  *
- * This functions checks whether some data has already been associated to \a host
-   or not and attach \a data to \a host if it is possible.
+ * This functions attach \a data to \a host if it is possible.
  */
 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
   sg_host_user_set(host, data);
@@ -92,24 +69,12 @@ msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
  *
  * \brief Return the user data of a #msg_host_t.
  *
- * This functions checks whether \a host is a valid pointer or not and return
-   the user data associated to \a host if it is possible.
+ * This functions returns the user data associated to \a host if it is possible.
  */
 void *MSG_host_get_data(msg_host_t host) {
   return sg_host_user(host);
 }
 
-/** \ingroup m_host_management
- *
- * \brief Return the name of the #msg_host_t.
- *
- * This functions checks whether \a host is a valid pointer or not and return
-   its name.
- */
-const char *MSG_host_get_name(msg_host_t host) {
-  return SIMIX_host_get_name(host);
-}
-
 /** \ingroup m_host_management
  *
  * \brief Return the location on which the current process is executed.
@@ -119,27 +84,28 @@ msg_host_t MSG_host_self(void)
   return MSG_process_get_host(NULL);
 }
 
-
 /** \ingroup m_host_management
  *
  * \brief Start the host if it is off
  *
- * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
+ * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
+ * for more info on DVFS.
  */
 void MSG_host_on(msg_host_t host)
 {
-  host->on();
+  host->turnOn();
 }
 
 /** \ingroup m_host_management
  *
  * \brief Stop the host if it is on
  *
- * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy for more info on DVFS.
+ * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy
+ * for more info on DVFS.
  */
 void MSG_host_off(msg_host_t host)
 {
-  host->off();
+  host->turnOff();
 }
 
 /*
@@ -147,18 +113,14 @@ void MSG_host_off(msg_host_t host)
  */
 void __MSG_host_priv_free(msg_host_priv_t priv)
 {
-
   if (priv == NULL)
-         return;
+    return;
   unsigned int size = xbt_dict_size(priv->dp_objs);
   if (size > 0)
     XBT_WARN("dp_objs: %u pending task?", size);
   xbt_dict_free(&priv->dp_objs);
   xbt_dict_free(&priv->affinity_mask_db);
   xbt_dynar_free(&priv->file_descriptor_table);
-#ifdef MSG_USE_DEPRECATED
-  free(priv->mailboxes);
-#endif
 
   free(priv);
 }
@@ -171,39 +133,29 @@ int MSG_get_host_number(void)
   return xbt_dict_length(host_list);
 }
 
-#ifdef MSG_USE_DEPRECATED
-msg_host_t *MSG_get_host_table(void)
-{
-  if (xbt_dict_is_empty(host_list))
-    return nullptr;
-
-  void **array = xbt_new0(void *, xbt_dict_length(host_list));
-
-    xbt_lib_cursor_t cursor;
-    const char *id;
-    simgrid::Host* host;
-    xbt_dict_foreach(host_list, cursor, id, host)
-      if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
-        array[i++] = host->facet(MSG_HOST_LEVEL);
-
-    return (msg_host_t *)array;
-}
-#endif
-
 /** \ingroup m_host_management
  * \brief Return a dynar containing all the hosts declared at a given point of time
- * \remark The host order in the returned array is generally different from the host creation/declaration order in the XML platform (we use a hash table internally)
+ * \remark The host order in the returned array is generally different from the host creation/declaration order in the
+ *         XML platform (we use a hash table internally)
  */
 xbt_dynar_t MSG_hosts_as_dynar(void) {
   return sg_hosts_as_dynar();
 }
 
 /** \ingroup m_host_management
- * \brief Return the speed of the processor (in flop/s), regardless of 
-    the current load on the machine.
+ * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
+ */
+double MSG_host_get_speed(msg_host_t host) {
+  return host->speed();
+}
+
+/** \ingroup m_host_management
+ * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
+ * Deprecated: use MSG_host_get_speed
  */
 double MSG_get_host_speed(msg_host_t host) {
-  return host->getSpeed();
+  XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
+  return MSG_host_get_speed(host);
 }
 
 
@@ -214,7 +166,7 @@ double MSG_get_host_speed(msg_host_t host) {
  * \return the number of cores
  */
 int MSG_host_get_core_number(msg_host_t host) {
-  return host->getCoreAmount();
+  return host->core_count();
 }
 
 /** \ingroup m_host_management
@@ -226,10 +178,9 @@ int MSG_host_get_core_number(msg_host_t host) {
 xbt_swag_t MSG_host_get_process_list(msg_host_t host)
 {
   xbt_assert((host != NULL), "Invalid parameters");
-  return host->getProcessList();
+  return host->processes();
 }
 
-
 /** \ingroup m_host_management
  * \brief Returns the value of a given host property
  *
@@ -251,7 +202,7 @@ const char *MSG_host_get_property_value(msg_host_t host, const char *name)
 xbt_dict_t MSG_host_get_properties(msg_host_t host)
 {
   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-  return host->getProperties();
+  return host->properties();
 }
 
 /** \ingroup m_host_management
@@ -263,13 +214,10 @@ xbt_dict_t MSG_host_get_properties(msg_host_t host)
  * \param free_ctn the freeing function to use to kill the value on need
  */
 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
-
   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 }
 
-
 /** @ingroup m_host_management
- *
  * @brief Determine if a host is up and running.
  *
  * 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.
@@ -279,19 +227,17 @@ void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,
  */
 int MSG_host_is_on(msg_host_t host)
 {
-  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-  return sg_host_get_state(host);
+  return host->isOn();
 }
+
 /** @ingroup m_host_management
- *
  * @brief Determine if a host is currently off.
  *
  * 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.
  */
 int MSG_host_is_off(msg_host_t host)
 {
-  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-  return !(sg_host_get_state(host));
+  return host->isOff();
 }
 
 /** \ingroup m_host_management
@@ -302,7 +248,7 @@ int MSG_host_is_off(msg_host_t host)
  */
 void MSG_host_set_params(msg_host_t host, vm_params_t params)
 {
-  host->setParams(params);
+  host->setParameters(params);
 }
 
 /** \ingroup m_host_management
@@ -313,7 +259,7 @@ void MSG_host_set_params(msg_host_t host, vm_params_t params)
  */
 void MSG_host_get_params(msg_host_t host, vm_params_t params)
 {
-  host->getParams(params);
+  host->parameters(params);
 }
 
 /** \ingroup m_host_management
@@ -324,8 +270,8 @@ void MSG_host_get_params(msg_host_t host, vm_params_t params)
  * \return Returns the processor speed associated with pstate_index
  */
 double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
-         xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-         return host->getPowerPeakAt(pstate_index);
+  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
+  return host->powerPeakAt(pstate_index);
 }
 
 /** \ingroup m_host_management
@@ -335,8 +281,8 @@ double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
  * \return Returns the current processor speed
  */
 double MSG_host_get_current_power_peak(msg_host_t host) {
-         xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-         return host->getCurrentPowerPeak();
+  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
+  return host->currentPowerPeak();
 }
 
 /** \ingroup m_host_management
@@ -345,51 +291,7 @@ double MSG_host_get_current_power_peak(msg_host_t host) {
  * \param  host host to test
  */
 int MSG_host_get_nb_pstates(msg_host_t host) {
-         return sg_host_get_nb_pstates(host);
-}
-
-/** \ingroup m_host_management
- * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
- *
- * \param  host host to test
- * \param pstate_index pstate to switch to
- */
-void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
-         xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-    host->setPstate(pstate_index);
-}
-/** \ingroup m_host_management
- * \brief Gets the pstate at which the given host is currently running. See also @ref SURF_plugin_energy.
- *
- * \param  host host to test
- */
-int MSG_host_get_pstate(msg_host_t host) {
-         return sg_host_get_pstate(host);
-}
-
-/** \ingroup m_host_management
- * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
- *
- * \param  host host to test
- * \return Returns the consumed energy
- */
-double MSG_host_get_consumed_energy(msg_host_t host) {
-         xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-         return sg_host_get_consumed_energy(host);
-}
-/** \ingroup m_host_management
- * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
- *
- */
-double MSG_host_get_wattmin_at(msg_host_t host, int pstate){
-       return host->getWattMinAt(pstate);
-}
-/** \ingroup m_host_management
- * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
- *
- */
-double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
-       return host->getWattMaxAt(pstate);
+  return sg_host_get_nb_pstates(host);
 }
 
 /** \ingroup m_host_management
@@ -400,7 +302,7 @@ double MSG_host_get_wattmax_at(msg_host_t host, int pstate){
 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 {
   xbt_assert((host != NULL), "Invalid parameters");
-  return host->getMountedStorageList();
+  return host->mountedStoragesAsDict();
 }
 
 /** \ingroup m_host_management
@@ -411,7 +313,7 @@ xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
 {
   xbt_assert((host != NULL), "Invalid parameters");
-  return host->getAttachedStorageList();
+  return host->attachedStorages();
 }
 
 /** \ingroup m_host_management
@@ -428,7 +330,7 @@ xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
   char* mount_name;
   xbt_dict_cursor_t cursor = NULL;
 
-  xbt_dict_t storage_list = host->getMountedStorageList();
+  xbt_dict_t storage_list = host->mountedStoragesAsDict();
 
   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
@@ -441,8 +343,7 @@ xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 
 int __MSG_host_get_file_descriptor_id(msg_host_t host){
   msg_host_priv_t priv = sg_host_msg(host);
-  xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
-    "Too much files are opened! Some have to be closed.");
+  xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table), "Too much files are opened! Some have to be closed.");
   return xbt_dynar_pop_as(priv->file_descriptor_table, int);
 }