1 /* gras/process.h - Manipulating data related to an host. */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #define GRAS_PROCESS_H
12 #include "xbt/misc.h" /* SG_BEGIN_DECL */
17 void gras_agent_spawn(const char *name, void *data, xbt_main_func_t code,
18 int argc, char *argv[], xbt_dict_t properties);
21 /****************************************************************************/
22 /* Manipulating User Data */
23 /****************************************************************************/
25 /** \addtogroup GRAS_globals
26 * \brief Handling global variables so that it works on simulator.
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
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.
38 * For more info on this, you may want to check the relevant lesson of the GRAS tutorial:
39 * \ref GRAS_tut_tour_globals
44 * \brief Get the data associated with the current process.
45 * \ingroup GRAS_globals
47 XBT_PUBLIC(void *) gras_userdata_get(void);
50 * \brief Set the data associated with the current process.
51 * \ingroup GRAS_globals
53 XBT_PUBLIC(void *) gras_userdata_set(void *ud);
55 /** \brief Malloc and set the data associated with the current process.
57 * @warning 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.
62 * You'll find an example in the tutorial: \ref GRAS_tut_tour_globals
64 #define gras_userdata_new(type) ((type*)gras_userdata_set(xbt_new0(type,1)))
68 #endif /* GRAS_PROCESS_H */