Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
New function: sg_hosts_as_dynar
[simgrid.git] / src / msg / msg_host.c
index 14aff6c..27aa5e9 100644 (file)
@@ -26,9 +26,8 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
  */
 
 /********************************* Host **************************************/
-msg_host_t __MSG_host_create(smx_host_t workstation)
+msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our parameter
 {
-  const char *name = SIMIX_host_get_name(workstation);
   msg_host_priv_t priv = xbt_new0(s_msg_host_priv_t, 1);
 
 #ifdef MSG_USE_DEPRECATED
@@ -55,20 +54,19 @@ msg_host_t __MSG_host_create(smx_host_t workstation)
 
   priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
 
-  xbt_lib_set(host_lib, name, MSG_HOST_LEVEL, priv);
+  sg_host_msg_set(host,priv);
   
-  return xbt_lib_get_elm_or_null(host_lib, name);
+  return host;
 }
 
-
-/** \ingroup msg_host_management
+/** \ingroup m_host_management
  * \brief Finds a msg_host_t using its name.
  *
  * This is a name directory service
  * \param name the name of an host.
  * \return the corresponding host
  */
-msg_host_t MSG_get_host_by_name(const char *name)
+msg_host_t MSG_host_by_name(const char *name)
 {
   return (msg_host_t) xbt_lib_get_elm_or_null(host_lib,name);
 }
@@ -120,16 +118,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)
 {
@@ -159,13 +163,11 @@ void __MSG_host_priv_free(msg_host_priv_t priv)
  */
 void __MSG_host_destroy(msg_host_t host)
 {
-  const char *name = MSG_host_get_name(host);
   /* TODO:
    * What happens if VMs still remain on this host?
    * Revisit here after the surf layer gets stable.
    **/
-
-  xbt_lib_unset(host_lib, name, MSG_HOST_LEVEL, 1);
+  sg_host_msg_destroy(host);
 }
 
 /** \ingroup m_host_management
@@ -201,20 +203,10 @@ 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;
-  char *key;
-  void **data;
-  xbt_dynar_t res = xbt_dynar_new(sizeof(msg_host_t),NULL);
-
-  xbt_lib_foreach(host_lib, cursor, key, data) {
-    if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST) {
-      xbt_dictelm_t elm = xbt_dict_cursor_get_elm(cursor);
-      xbt_dynar_push(res, &elm);
-    }
-  }
-  return res;
+  return sg_hosts_as_dynar();
 }
 
 /** \ingroup m_host_management
@@ -307,9 +299,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 +313,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 +348,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 +371,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 +390,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
@@ -405,6 +411,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.
@@ -428,7 +454,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