include/xbt/synchro.h

   1 /* $Id$ */
   2
   3 /* xbt/synchro.h -- Synchronization tools                                   */
   4 /* Usable in simulator, (or in real life when mixing with GRAS)             */
   5
   6 /* Copyright (c) 2007 Martin Quinson. All rights reserved.                  */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11
  12 #ifndef _XBT_THREAD_H
  13 #define _XBT_THREAD_H
  14
  15 #include "xbt/misc.h" /* SG_BEGIN_DECL */
  16 #include "xbt/function_types.h"
  17
  18 SG_BEGIN_DECL()
  19
  20 /** @addtogroup XBT_synchro
  21  *  @brief XBT synchronization tools
  22  *
  23  *  This section describes the XBT synchronization tools. It defines types and
  24  *  functions very close to the pthread API, but widly usable. When used from
  25  *  the simulator, you will lock simulated processes as expected. When used
  26  *  from GRAS programs compiled for in-situ execution, you have synchronization
  27  *  mecanism portable to windows and UNIX. Nice, isn't it?
  28  *
  29  *  @{
  30  */
  31
  32   /** \brief Thread data type (opaque structure) */
  33   typedef struct s_xbt_thread_ *xbt_thread_t;
  34
  35   XBT_PUBLIC(xbt_thread_t) xbt_thread_create(pvoid_f_pvoid_t start_routine,void* param);
  36   XBT_PUBLIC(void) xbt_thread_exit(int *retcode);
  37   XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void);
  38   /* xbt_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
  39   XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread,void ** thread_return);
  40   XBT_PUBLIC(void) xbt_thread_yield(void);
  41
  42
  43   /** \brief Thread mutex data type (opaque structure) */
  44   typedef struct s_xbt_mutex_ *xbt_mutex_t;
  45
  46   XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
  47   XBT_PUBLIC(void)        xbt_mutex_lock(xbt_mutex_t mutex);
  48   XBT_PUBLIC(void)        xbt_mutex_unlock(xbt_mutex_t mutex);
  49   XBT_PUBLIC(void)        xbt_mutex_destroy(xbt_mutex_t mutex);
  50
  51
  52   /** \brief Thread condition data type (opaque structure) */
  53   typedef struct s_xbt_cond_ *xbt_cond_t;
  54
  55   XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
  56   XBT_PUBLIC(void)       xbt_cond_wait(xbt_cond_t cond,
  57                                        xbt_mutex_t mutex);
  58   XBT_PUBLIC(void)       xbt_cond_timedwait(xbt_cond_t cond,
  59                                             xbt_mutex_t mutex,
  60                                             double delay);
  61   XBT_PUBLIC(void)       xbt_cond_signal(xbt_cond_t cond);
  62   XBT_PUBLIC(void)       xbt_cond_broadcast(xbt_cond_t cond);
  63   XBT_PUBLIC(void)       xbt_cond_destroy(xbt_cond_t cond);
  64
  65 /** @} */
  66
  67 SG_END_DECL()
  68
  69 #endif /* _XBT_THREAD_H */