Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / src / msg / msg_host.cpp
index 15a78c1..917421d 100644 (file)
@@ -5,7 +5,6 @@
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/msg/msg_private.h"
-#include "src/msg/msg_mailbox.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 #include "simgrid/simix.h"
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(msg);
 
 /** @addtogroup m_host_management
- * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
  * (#msg_host_t) and the functions for managing it.
  *  
- *  A <em>location</em> (or <em>host</em>) is any possible place where
- *  a process may run. Thus it may be represented as a
- *  <em>physical resource with computing capabilities</em>, some
- *  <em>mailboxes</em> to enable running process to communicate with
- *  remote ones, and some <em>private data</em> that can be only
- *  accessed by local process.
+ *  A <em>location</em> (or <em>host</em>) is any possible place where  a process may run. Thus it may be represented
+ *  as a <em>physical resource with computing capabilities</em>, some <em>mailboxes</em> to enable running process to
+ *  communicate with remote ones, and some <em>private data</em> that can be only accessed by local process.
  *  \see msg_host_t
  */
 
@@ -43,7 +38,7 @@ msg_host_t __MSG_host_create(sg_host_t host) // FIXME: don't return our paramete
     xbt_dynar_push_as(priv->file_descriptor_table, int, i);
 
   sg_host_msg_set(host,priv);
-  
+
   return host;
 }
 
@@ -63,8 +58,7 @@ msg_host_t MSG_host_by_name(const char *name)
  *
  * \brief Set the user data of a #msg_host_t.
  *
- * This functions checks whether some data has already been associated to \a host
-   or not and attach \a data to \a host if it is possible.
+ * This functions attach \a data to \a host if it is possible.
  */
 msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
   sg_host_user_set(host, data);
@@ -75,8 +69,7 @@ msg_error_t MSG_host_set_data(msg_host_t host, void *data) {
  *
  * \brief Return the user data of a #msg_host_t.
  *
- * This functions checks whether \a host is a valid pointer or not and return
-   the user data associated to \a host if it is possible.
+ * This functions returns the user data associated to \a host if it is possible.
  */
 void *MSG_host_get_data(msg_host_t host) {
   return sg_host_user(host);
@@ -91,27 +84,28 @@ msg_host_t MSG_host_self(void)
   return MSG_process_get_host(NULL);
 }
 
-
 /** \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.
+ * 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)
 {
-  host->turn_on();
+  host->turnOn();
 }
 
 /** \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.
+ * 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)
 {
-  host->turn_off();
+  host->turnOff();
 }
 
 /*
@@ -119,7 +113,6 @@ void MSG_host_off(msg_host_t host)
  */
 void __MSG_host_priv_free(msg_host_priv_t priv)
 {
-
   if (priv == NULL)
     return;
   unsigned int size = xbt_dict_size(priv->dp_objs);
@@ -142,20 +135,29 @@ int MSG_get_host_number(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)
+ * \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) {
   return sg_hosts_as_dynar();
 }
 
 /** \ingroup m_host_management
- * \brief Return the speed of the processor (in flop/s), regardless of 
-    the current load on the machine.
+ * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
  */
-double MSG_get_host_speed(msg_host_t host) {
+double MSG_host_get_speed(msg_host_t host) {
   return host->speed();
 }
 
+/** \ingroup m_host_management
+ * \brief Return the speed of the processor (in flop/s), regardless of the current load on the machine.
+ * Deprecated: use MSG_host_get_speed
+ */
+double MSG_get_host_speed(msg_host_t host) {
+  XBT_WARN("MSG_get_host_speed is deprecated: use MSG_host_get_speed");
+  return MSG_host_get_speed(host);
+}
+
 
 /** \ingroup m_host_management
  * \brief Return the number of cores.
@@ -179,7 +181,6 @@ xbt_swag_t MSG_host_get_process_list(msg_host_t host)
   return host->processes();
 }
 
-
 /** \ingroup m_host_management
  * \brief Returns the value of a given host property
  *
@@ -213,13 +214,10 @@ xbt_dict_t MSG_host_get_properties(msg_host_t host)
  * \param free_ctn the freeing function to use to kill the value on need
  */
 void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,void_f_pvoid_t free_ctn) {
-
   xbt_dict_set(MSG_host_get_properties(host), name, value,free_ctn);
 }
 
-
 /** @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.
@@ -229,19 +227,17 @@ void MSG_host_set_property_value(msg_host_t host, const char *name, char *value,
  */
 int MSG_host_is_on(msg_host_t host)
 {
-  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-  return sg_host_is_on(host);
+  return host->isOn();
 }
+
 /** @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 !(sg_host_is_on(host));
+  return host->isOff();
 }
 
 /** \ingroup m_host_management
@@ -252,7 +248,7 @@ int MSG_host_is_off(msg_host_t host)
  */
 void MSG_host_set_params(msg_host_t host, vm_params_t params)
 {
-  host->set_parameters(params);
+  host->setParameters(params);
 }
 
 /** \ingroup m_host_management
@@ -263,7 +259,7 @@ void MSG_host_set_params(msg_host_t host, vm_params_t params)
  */
 void MSG_host_get_params(msg_host_t host, vm_params_t params)
 {
-  host->get_parameters(params);
+  host->parameters(params);
 }
 
 /** \ingroup m_host_management
@@ -274,8 +270,8 @@ void MSG_host_get_params(msg_host_t host, vm_params_t params)
  * \return Returns the processor speed associated with 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 host->power_peak_at(pstate_index);
+  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
+  return host->powerPeakAt(pstate_index);
 }
 
 /** \ingroup m_host_management
@@ -285,8 +281,8 @@ double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
  * \return Returns the current processor speed
  */
 double MSG_host_get_current_power_peak(msg_host_t host) {
-    xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
-    return host->current_power_peak();
+  xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
+  return host->currentPowerPeak();
 }
 
 /** \ingroup m_host_management
@@ -295,7 +291,7 @@ double MSG_host_get_current_power_peak(msg_host_t host) {
  * \param  host host to test
  */
 int MSG_host_get_nb_pstates(msg_host_t host) {
-    return sg_host_get_nb_pstates(host);
+  return sg_host_get_nb_pstates(host);
 }
 
 /** \ingroup m_host_management
@@ -306,7 +302,7 @@ int MSG_host_get_nb_pstates(msg_host_t host) {
 xbt_dict_t MSG_host_get_mounted_storage_list(msg_host_t host)
 {
   xbt_assert((host != NULL), "Invalid parameters");
-  return host->mounted_storages_as_dict();
+  return host->mountedStoragesAsDict();
 }
 
 /** \ingroup m_host_management
@@ -317,7 +313,7 @@ xbt_dict_t MSG_host_get_mounted_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 host->attached_storages();
+  return host->attachedStorages();
 }
 
 /** \ingroup m_host_management
@@ -334,7 +330,7 @@ xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
   char* mount_name;
   xbt_dict_cursor_t cursor = NULL;
 
-  xbt_dict_t storage_list = host->mounted_storages_as_dict();
+  xbt_dict_t storage_list = host->mountedStoragesAsDict();
 
   xbt_dict_foreach(storage_list,cursor,mount_name,storage_name){
     storage = (msg_storage_t)xbt_lib_get_elm_or_null(storage_lib,storage_name);
@@ -347,8 +343,7 @@ xbt_dict_t MSG_host_get_storage_content(msg_host_t host)
 
 int __MSG_host_get_file_descriptor_id(msg_host_t host){
   msg_host_priv_t priv = sg_host_msg(host);
-  xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table),
-    "Too much files are opened! Some have to be closed.");
+  xbt_assert(!xbt_dynar_is_empty(priv->file_descriptor_table), "Too much files are opened! Some have to be closed.");
   return xbt_dynar_pop_as(priv->file_descriptor_table, int);
 }