Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Continue documenting my changes
[simgrid.git] / include / gras / process.h
index 761647f..32eb803 100644 (file)
@@ -1,19 +1,18 @@
-/* $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
  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
 
-#include "xbt/misc.h" /* BEGIN_DECL */
+#include "xbt/misc.h"  /* SG_BEGIN_DECL */
 
-BEGIN_DECL
+SG_BEGIN_DECL()
 
 /* **************************************************************************
  * Initializing the processes
@@ -23,41 +22,50 @@ BEGIN_DECL
  * 
  * Perform the various intialisations needed by gras. Each process must run it
  */
-gras_error_t gras_process_init(void);
+XBT_PUBLIC(void) gras_process_init(void);
 
 /**
  * gras_process_exit:
  * 
  * Frees the memory allocated by gras. Processes should run it
  */
-gras_error_t gras_process_exit(void);
+XBT_PUBLIC(void) gras_process_exit(void);
 
 /****************************************************************************/
 /* 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.
+ * 
+ * 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
+ * retrieve 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);
+XBT_PUBLIC(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
  */
+XBT_PUBLIC(void) gras_userdata_set(void *ud);
 
-#define gras_userdata_new(type) (gras_userdata_set(malloc(sizeof(type))),gras_userdata_get())
+/** \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())
+/* @} */
 
-END_DECL
+SG_END_DECL()
 
 #endif /* GRAS_PROCESS_H */