MSG_host_get_pstate_number() -> MSG_host_get_pstate_count()

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

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 57fd96c..6254436 100644 (file)
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -51,6 +51,7 @@ msg_host_t __MSG_host_create(smx_host_t workstation)
   priv->dp_objs = xbt_dict_new();
   priv->dp_enabled = 0;
   priv->dp_updated_by_deleted_tasks = 0;
+  priv->is_migrating = 0;
 
   priv->affinity_mask_db = xbt_dict_new_homogeneous(NULL);
 
@@ -306,17 +307,25 @@ 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 msg_gos_functions
+ * @brief Determine if a host is up and running.
  *
- * \param host host to test
- * \return Returns 1 if host is available, 0 otherwise
+ * @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 msg_gos_functions
+ * @brief Determine if a host is currently off.
+ */
+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
@@ -341,13 +350,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));
 }
@@ -358,41 +367,41 @@ 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_pstate_count(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);
 }
 
 /** \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);
 }
@@ -411,9 +420,9 @@ xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 /** \ingroup m_host_management
  * \brief Return the list of storages attached to an host.
  * \param host a host
- * \return a dict containing all storages attached to the host (storage name => msg_storage_t)
+ * \return a dynar containing all storages (name) attached to the host
  */
-xbt_dict_t MSG_host_get_attached_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 (simcall_host_get_attached_storage_list(host));