improve documentation for MSG_host_is_avail

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

diff --git a/src/msg/msg_host.c b/src/msg/msg_host.c
index 9b6688c..4518064 100644 (file)
--- a/src/msg/msg_host.c
+++ b/src/msg/msg_host.c
@@ -9,9 +9,6 @@
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 
-/** \defgroup m_host_management Management functions of Hosts
- *  \brief This section describes the host structure of MSG
- */
 /** @addtogroup m_host_management
  *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
  * (#m_host_t) and the functions for managing it.
@@ -31,9 +28,6 @@ m_host_t __MSG_host_create(smx_host_t workstation, void *data)
   const char *name;
   simdata_host_t simdata = xbt_new0(s_simdata_host_t, 1);
   m_host_t host = xbt_new0(s_m_host_t, 1);
-  int i;
-
-  char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
 
   name = SIMIX_host_get_name(workstation);
   /* Host structure */
@@ -43,6 +37,10 @@ m_host_t __MSG_host_create(smx_host_t workstation, void *data)
 
   simdata->smx_host = workstation;
 
+#ifdef MSG_USE_DEPRECATED
+  int i;
+  char alias[MAX_ALIAS_NAME + 1] = { 0 };       /* buffer used to build the key of the mailbox */
+
   if (msg_global->max_channel > 0)
     simdata->mailboxes = xbt_new0(msg_mailbox_t, msg_global->max_channel);
 
@@ -53,8 +51,9 @@ m_host_t __MSG_host_create(smx_host_t workstation, void *data)
     simdata->mailboxes[i] = MSG_mailbox_new(alias);
     memset(alias, 0, MAX_ALIAS_NAME + 1);
   }
+#endif
 
-  SIMIX_req_host_set_data(workstation, host);
+  simcall_host_set_data(workstation, host);
   xbt_lib_set(host_lib,name,MSG_HOST_LEVEL,host);
 
   return host;
@@ -117,7 +116,7 @@ const char *MSG_host_get_name(m_host_t host)
  */
 m_host_t MSG_host_self(void)
 {
-  return MSG_process_get_host(MSG_process_self());
+  return MSG_process_get_host(NULL);
 }
 
 /** \ingroup m_host_management
@@ -133,8 +132,10 @@ void __MSG_host_destroy(m_host_t host)
   /* Clean simulator data */
   simdata = (host)->simdata;
 
+#ifdef MSG_USE_DEPRECATED
   if (msg_global->max_channel > 0)
     free(simdata->mailboxes);
+#endif
 
   free(simdata);
 
@@ -143,17 +144,12 @@ void __MSG_host_destroy(m_host_t host)
   free(host);
 }
 
-/** \ingroup m_host_management
- * \brief Return the current number of #m_host_t.
- */
+#ifdef MSG_USE_DEPRECATED
 int MSG_get_host_number(void)
 {
-  return host_lib->count;
+  return xbt_lib_length(host_lib);
 }
 
-/** \ingroup m_host_management
- * \brief Return a array of all the #m_host_t.
- */
 m_host_t *MSG_get_host_table(void)
 {
       void **array;
@@ -162,10 +158,10 @@ m_host_t *MSG_get_host_table(void)
          char *key;
          void **data;
 
-         if (host_lib->count == 0)
+         if (xbt_lib_length(host_lib) == 0)
                return NULL;
          else
-               array = xbt_new0(void *, host_lib->count);
+               array = xbt_new0(void *, xbt_lib_length(host_lib));
 
          xbt_lib_foreach(host_lib, cursor, key, data) {
            if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
@@ -174,6 +170,23 @@ m_host_t *MSG_get_host_table(void)
 
          return (m_host_t *)array;
 }
+#endif
+
+/** \ingroup m_host_management
+ * \brief Return a dynar containing all the hosts declared at a given point of time
+ */
+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(m_host_t),NULL);
+
+  xbt_lib_foreach(host_lib, cursor, key, data) {
+    if(routing_get_network_element_type(key) == SURF_NETWORK_ELEMENT_HOST)
+      xbt_dynar_push(res, data + MSG_HOST_LEVEL);
+  }
+  return res;
+}
 
 /** \ingroup m_host_management
  * \brief Return the number of MSG tasks currently running on a
@@ -195,7 +208,7 @@ double MSG_get_host_speed(m_host_t h)
 {
   xbt_assert((h != NULL), "Invalid parameters");
 
-  return (SIMIX_req_host_get_speed(h->simdata->smx_host));
+  return (simcall_host_get_speed(h->simdata->smx_host));
 }
 
 /** \ingroup m_host_management
@@ -220,17 +233,18 @@ xbt_dict_t MSG_host_get_properties(m_host_t host)
 {
   xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 
-  return (SIMIX_req_host_get_properties(host->simdata->smx_host));
+  return (simcall_host_get_properties(host->simdata->smx_host));
 }
 
 
 /** \ingroup msg_gos_functions
  * \brief Determine if a host is available.
  *
- * \param h host to test
+ * \param host host to test
+ * \return Returns 1 if host is available, 0 otherwise
  */
-int MSG_host_is_avail(m_host_t h)
+int MSG_host_is_avail(m_host_t host)
 {
   xbt_assert((h != NULL), "Invalid parameters (host is NULL)");
-  return (SIMIX_req_host_get_state(h->simdata->smx_host));
+  return (simcall_host_get_state(h->simdata->smx_host));
 }