X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c57842fe897f53b46f0be3da87f7c996674be7d6..8465282253954c58d16cb5dae9a5d064eada3329:/src/msg/msg_host.c

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 4940e295c1..7da0e29d98 100644
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -26,9 +26,9 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
  */
 
 /********************************* Host **************************************/
-msg_host_t __MSG_host_create(smx_host_t workstation)
+msg_host_t __MSG_host_create(smx_host_t host)
 {
-  const char *name = SIMIX_host_get_name(workstation);
+  const char *name = SIMIX_host_get_name(host);
   msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
 
 #ifdef MSG_USE_DEPRECATED
@@ -61,7 +61,7 @@ msg_host_t __MSG_host_create(smx_host_t workstation)
 }
 
 
-/** \ingroup msg_host_management
+/** \ingroup m_host_management
  * \brief Finds a msg_host_t using its name.
  *
  * This is a name directory service
@@ -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)
 {
@@ -201,6 +207,7 @@ msg_host_t *MSG_get_host_table(void)
 
 /** \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)
  */
 xbt_dynar_t MSG_hosts_as_dynar(void) {
   xbt_lib_cursor_t cursor;
@@ -307,17 +314,31 @@ void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,
 }
 
 
-/** \ingroup msg_gos_functions
- * \brief Determine if a host is available.
+/** @ingroup m_host_management
+ *
+ * @brief Determine if a host is up and running.
  *
- * \param host host to test
- * \return Returns 1 if host is available, 0 otherwise
+ * 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
  */
-int MSG_host_is_avail(msg_host_t host)
+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 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 !(simcall_host_get_state(host));
+}
 
 /** \ingroup m_host_management
  * \brief Set the parameters of a given host
@@ -342,13 +363,13 @@ 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
  * \return Returns the processor speed associated with pstate_index
  */
-double MSG_get_host_power_peak_at(msg_host_t host, int 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 (simcall_host_get_power_peak_at(host, pstate_index));
 }
@@ -359,44 +380,72 @@ double MSG_get_host_power_peak_at(msg_host_t host, int pstate_index) {
  * \param  host host to test
  * \return Returns the current processor speed
  */
-double MSG_get_host_current_power_peak(msg_host_t host) {
+double MSG_host_get_current_power_peak(msg_host_t host) {
 	  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 	  return simcall_host_get_current_power_peak(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_get_host_nb_pstates(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
  */
-void MSG_set_host_power_peak_at(msg_host_t host, int pstate_index) {
+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
  */
-double MSG_get_host_consumed_energy(msg_host_t host) {
+double MSG_host_get_consumed_energy(msg_host_t host) {
 	  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 	  return simcall_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 simcall_host_get_wattmin_at(host, 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 simcall_host_get_wattmax_at(host, pstate);
+}
+/** \ingroup m_host_management
+ * \brief Set the parameters of a given host
+ *
+ * \param host a host
+ * \param params a prameter object
+ */
 
 /** \ingroup m_host_management
  * \brief Return the list of mount point names on an host.
@@ -420,7 +469,7 @@ xbt_dynar_t MSG_host_get_attached_storage_list(msg_host_t host)
   return (simcall_host_get_attached_storage_list(host));
 }
 
-/** \ingroup msg_host_management
+/** \ingroup m_host_management
  * \brief Return the content of mounted storages on an host.
  * \param host a host
  * \return a dict containing content (as a dict) of all storages mounted on the host