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
  15 SG_BEGIN_DECL()
  16
  17 void gras_agent_spawn(const char *name, void *data, xbt_main_func_t code, int argc, char *argv[]);
  18
  19
  20 /****************************************************************************/
  21 /* Manipulating User Data                                                   */
  22 /****************************************************************************/
  23
  24 /** \addtogroup GRAS_globals
  25  *  \brief Handling global variables so that it works on simulator.
  26  *
  27  * In GRAS, using globals is forbidden since the "processes" will
  28  * sometimes run as a thread inside the same process (namely, in
  29  * simulation mode). So, you have to put all globals in a structure, and
  30  * let GRAS handle it.
  31  *
  32  * Use the \ref gras_userdata_new macro to create a new user data (or malloc it
  33  * and use \ref gras_userdata_set yourself), and \ref gras_userdata_get to
  34  * retrieve a reference to it.
  35  */
  36 /* @{ */
  37
  38 /**
  39  * \brief Get the data associated with the current process.
  40  * \ingroup GRAS_globals
  41  */
  42 XBT_PUBLIC(void*) gras_userdata_get(void);
  43
  44 /**
  45  * \brief Set the data associated with the current process.
  46  * \ingroup GRAS_globals
  47  */
  48 XBT_PUBLIC(void) gras_userdata_set(void *ud);
  49
  50 /** \brief Malloc and set the data associated with the current process. */
  51 #define gras_userdata_new(type) (gras_userdata_set(xbt_new0(type,1)),gras_userdata_get())
  52 /* @} */
  53
  54 SG_END_DECL()
  55
  56 #endif /* GRAS_PROCESS_H */
  57