Fix the doc!

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

diff --git a/src/msg/host.c b/src/msg/host.c
index a38cfe1..8764477 100644 (file)
--- a/src/msg/host.c
+++ b/src/msg/host.c
@@ -5,11 +5,24 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include"private.h"
-#include"xbt/sysdep.h"
-#include "xbt/error.h"
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(host, msg,
-                               "Logging specific to MSG (host)");
+#include "private.h"
+#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
+ * 
+ *     \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Hosts" --> \endhtmlonly
+ * (#m_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.
+ *  \see m_host_t
+ */
 
 /********************************* Host **************************************/
 m_host_t __MSG_host_create(const char *name,
@@ -34,7 +47,9 @@ m_host_t __MSG_host_create(const char *name,
   simdata->process_list = xbt_fifo_new();
   /* Update global variables */
 
-  xbt_fifo_push(msg_global->host, host);
+  xbt_fifo_unshift(msg_global->host, host);
+
+  PAJE_HOST_NEW(host);
 
   return host;
 }
@@ -98,7 +113,7 @@ m_host_t MSG_host_self(void)
   return MSG_process_get_host(MSG_process_self());
 }
 
-/**
+/*
  * Real function for destroy a host.
  * MSG_host_destroy is just  a front_end that also removes it from 
  * msg_global->host
@@ -110,21 +125,24 @@ void __MSG_host_destroy(m_host_t host)
 
   xbt_assert0((host != NULL), "Invalid parameters");
 
+  PAJE_HOST_FREE(host);
+ 
   /* Clean Simulator data */
   simdata = (host)->simdata;
 
   for (i = 0; i < msg_global->max_channel; i++)
     xbt_fifo_free(simdata->mbox[i]);
-  xbt_free(simdata->mbox);
-  xbt_free(simdata->sleeping);
+  free(simdata->mbox);
+  free(simdata->sleeping);
   xbt_assert0((xbt_fifo_size(simdata->process_list)==0),
              "Some process are still running on this host");
+  xbt_fifo_free(simdata->process_list);
 
-  xbt_free(simdata);
+  free(simdata);
 
   /* Clean host structure */
-  xbt_free(host->name);
-  xbt_free(host);
+  free(host->name);
+  free(host);
 
   return;
 }
@@ -157,3 +175,34 @@ int MSG_get_host_msgload(m_host_t h)
   return(0);
 /*   return(surf_workstation_resource->extension_public->get_load(h->simdata->host)); */
 }
+
+/** \ingroup m_host_management
+ * \brief Return the speed of the processor (in flop/s), regardless of 
+    the current load on the machine.
+ */
+double MSG_get_host_speed(m_host_t h)
+{
+  xbt_assert0((h!= NULL), "Invalid parameters");
+
+  return(surf_workstation_resource->
+        extension_public->get_speed(h->simdata->host,1.0));
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Determine if a host is available.
+ *
+ * \param h host to test
+ */
+int MSG_host_is_avail (m_host_t h)
+{
+  e_surf_cpu_state_t cpustate;
+  xbt_assert0((h!= NULL), "Invalid parameters");
+
+  cpustate =
+    surf_workstation_resource->extension_public->get_state(h->simdata->host);
+
+  xbt_assert0((cpustate == SURF_CPU_ON || cpustate == SURF_CPU_OFF),
+             "Invalid cpu state");
+
+  return (cpustate==SURF_CPU_ON);
+}