code is now splint'able

[simgrid.git] / include / gras / process.h

diff --git a/include/gras/process.h b/include/gras/process.h
index 5c7047b..ca99dac 100644 (file)
--- a/include/gras/process.h
+++ b/include/gras/process.h
@@ -1,19 +1,19 @@
-/* $Id$                     */
+/* $Id$ */

 
 

-/* gras/core.h - Unsorted part of the GRAS public interface                 */
+/* gras/process.h - Manipulating data related to an host.                   */

 
 

-/* Authors: Martin Quinson                                                  */
-/* Copyright (C) 2003,2004 the OURAGAN project.                             */
+/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */

 
 /* This program is free software; you can redistribute it and/or modify it
 
 /* 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. */
+ * under the terms of the license (GNU LGPL) which comes with this package. */

 
 #ifndef GRAS_PROCESS_H
 #define GRAS_PROCESS_H
 
 
 #ifndef GRAS_PROCESS_H
 #define GRAS_PROCESS_H
 

-#include "xbt/misc.h" /* BEGIN_DECL */
+#include "xbt/misc.h"  /* BEGIN_DECL */
+#include "xbt/error.h" /* xbt_error_t */

 
 

-BEGIN_DECL
+BEGIN_DECL()

 
 /* **************************************************************************
  * Initializing the processes
 
 /* **************************************************************************
  * Initializing the processes


@@ -35,29 +35,38 @@ xbt_error_t gras_process_exit(void);
 /****************************************************************************/
 /* Manipulating User Data                                                   */
 /****************************************************************************/
 /****************************************************************************/
 /* Manipulating User Data                                                   */
 /****************************************************************************/

-/**
- * gras_userdata_get:
- *
- * Get the data associated with the current process.
+
+/** \addtogroup GRAS_globals
+ *  \brief Handling global variables so that it works on simulator (Virtualization).
+ * 
+ * In GRAS, using globals is forbidden since the "processes" will
+ * sometimes run as a thread inside the same process (namely, in
+ * simulation mode). So, you have to put all globals in a structure, and
+ * let GRAS handle it.
+ * 
+ * Use the \ref gras_userdata_new macro to create a new user data (or malloc it
+ * and use \ref gras_userdata_set yourself), and \ref gras_userdata_get to
+ * retrive a reference to it. 

  */
  */

-void *gras_userdata_get(void);
+/* @{ */

 
 /**
 
 /**

- * gras_userdata_set:
- *
- * Set the data associated with the current process.
+ * \brief Get the data associated with the current process.
+ * \ingroup GRAS_globals

  */
  */

-void gras_userdata_set(void *ud);
+void *gras_userdata_get(void);

 
 /**
 
 /**

- * gras_userdata_new:
- *
- * Malloc and set the data associated with the current process.
+ * \brief Set the data associated with the current process.
+ * \ingroup GRAS_globals

  */
  */

+void gras_userdata_set(void *ud);

 
 

+/** \brief Malloc and set the data associated with the current process. */

 #define gras_userdata_new(type) (gras_userdata_set(xbt_new0(type,1)),gras_userdata_get())
 #define gras_userdata_new(type) (gras_userdata_set(xbt_new0(type,1)),gras_userdata_get())

+/* @} */

 
 

-END_DECL
+END_DECL()

 
 #endif /* GRAS_PROCESS_H */
 
 
 #endif /* GRAS_PROCESS_H */