Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
gras_userdata_new expects the pointed type, not the pointer type. Fix tutorial, and...
[simgrid.git] / include / gras / process.h
1 /* $Id$ */
2
3 /* gras/process.h - Manipulating data related to an host.                   */
4
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10 #ifndef GRAS_PROCESS_H
11 #define GRAS_PROCESS_H
12
13 #include "xbt/misc.h"  /* SG_BEGIN_DECL */
14 #include "xbt/dict.h"
15
16 SG_BEGIN_DECL()
17
18 void gras_agent_spawn(const char *name, void *data, xbt_main_func_t code, int argc, char *argv[], xbt_dict_t properties);
19   
20   
21 /****************************************************************************/
22 /* Manipulating User Data                                                   */
23 /****************************************************************************/
24
25 /** \addtogroup GRAS_globals
26  *  \brief Handling global variables so that it works on simulator.
27  * 
28  * In GRAS, using globals is forbidden since the "processes" will
29  * sometimes run as a thread inside the same process (namely, in
30  * simulation mode). So, you have to put all globals in a structure, and
31  * let GRAS handle it.
32  * 
33  * Use the \ref gras_userdata_new macro to create a new user data (or malloc it
34  * and use \ref gras_userdata_set yourself), and \ref gras_userdata_get to
35  * retrieve a reference to it.
36  * 
37  * 
38  * For more info on this, you may want to check the relevant lesson of the GRAS tutorial:
39  * \ref GRAS_tut_tour_globals
40  */
41 /* @{ */
42
43 /**
44  * \brief Get the data associated with the current process.
45  * \ingroup GRAS_globals
46  */
47 XBT_PUBLIC(void*) gras_userdata_get(void);
48
49 /**
50  * \brief Set the data associated with the current process.
51  * \ingroup GRAS_globals
52  */
53 XBT_PUBLIC(void) gras_userdata_set(void *ud);
54
55 /** \brief Malloc and set the data associated with the current process.
56  *
57  * @warnug gras_userdata_new() expects the pointed type, not the
58  * pointer type. We know it'a a bit troublesome, but it seems like
59  * the only solution since this macro has to compute the size to
60  * malloc and should thus know the pointed type. 
61  *
62  * You'll find an example in the tutorial:  \ref GRAS_tut_tour_globals
63  */
64 #define gras_userdata_new(type) (gras_userdata_set(xbt_new0(type,1)),gras_userdata_get())
65 /* @} */
66
67 SG_END_DECL()
68
69 #endif /* GRAS_PROCESS_H */
70