X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5a97de8c98502af9f74cfceb924fa02e0fd80925..e966171888ad6e89634c621a5dc0d8b980d0db81:/src/msg/msg_host.c

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 14aff6cb60..f745ee81be 100644
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -120,16 +120,22 @@ msg_host_t MSG_host_self(void)
 }
 
 
-/*
+/** \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.
  */
 void MSG_host_on(msg_host_t host)
 {
   simcall_host_on(host);
 }
 
-/*
+/** \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.
  */
 void MSG_host_off(msg_host_t host)
 {
@@ -307,9 +313,12 @@ void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,
 }
 
 
-/** @ingroup msg_gos_functions
+/** @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.
+ *
  * @param host host to test
  * @return Returns true if the host is up and running, and false if it's currently down
  */
@@ -318,8 +327,11 @@ int MSG_host_is_on(msg_host_t host)
   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
   return (simcall_host_get_state(host));
 }
-/** @ingroup msg_gos_functions
+/** @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)
 {
@@ -350,7 +362,7 @@ void MSG_host_get_params(msg_host_t host, ws_params_t params)
 }
 
 /** \ingroup m_host_management
- * \brief Return the speed of the processor (in flop/s) at a given pstate
+ * \brief Return 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 test
@@ -373,18 +385,18 @@ double MSG_host_get_current_power_peak(msg_host_t host) {
 }
 
 /** \ingroup m_host_management
- * \brief Return the number of pstates defined for a host
+ * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
  *
  * \param  host host to test
  */
-int MSG_host_get_pstate_number(msg_host_t host) {
+int MSG_host_get_nb_pstates(msg_host_t host) {
 
 	  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 	  return (simcall_host_get_nb_pstates(host));
 }
 
 /** \ingroup m_host_management
- * \brief Sets the speed of the processor (in flop/s) at a given pstate
+ * \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
@@ -392,11 +404,19 @@ int MSG_host_get_pstate_number(msg_host_t host) {
 void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
 	  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 
-	  simcall_host_set_power_peak_at(host, pstate_index);
+	  simcall_host_set_pstate(host, 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 simcall_host_get_pstate(host);
 }
 
 /** \ingroup m_host_management
- * \brief Return the total energy consumed by a host (in Joules)
+ * \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