[mc] Cleanup mc_hash

[simgrid.git] / src / msg / msg_host.c

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 21d7ee2..7da0e29 100644 (file)
--- 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,9 +314,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 +328,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)
 {
@@ -413,6 +426,26 @@ 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.
@@ -436,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