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   /** \brief Thread data type (opaque structure) */
  32      typedef struct s_xbt_thread_ *xbt_thread_t;
  33
  34 XBT_PUBLIC(xbt_thread_t) xbt_thread_create(const char *name,
  35                                            void_f_pvoid_t start_routine,
  36                                            void *param);
  37 XBT_PUBLIC(void) xbt_thread_exit();
  38 XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void);
  39 XBT_PUBLIC(const char *) xbt_thread_name(xbt_thread_t t);
  40 XBT_PUBLIC(const char *) xbt_thread_self_name(void);
  41   /* xbt_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
  42 XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread);
  43   /* Ends the life of the poor victim (not always working if it's computing, but working if it's blocked in the OS) */
  44 XBT_PUBLIC(void) xbt_thread_cancel(xbt_thread_t thread);
  45   /* suicide */
  46 XBT_PUBLIC(void) xbt_thread_exit(void);
  47   /* current thread pass control to any possible thread wanting it */
  48 XBT_PUBLIC(void) xbt_thread_yield(void);
  49
  50
  51   /** \brief Thread mutex data type (opaque structure) */
  52      typedef struct s_xbt_mutex_ *xbt_mutex_t;
  53
  54 XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
  55 XBT_PUBLIC(void) xbt_mutex_acquire(xbt_mutex_t mutex);
  56 XBT_PUBLIC(void) xbt_mutex_release(xbt_mutex_t mutex);
  57 XBT_PUBLIC(void) xbt_mutex_timedacquire(xbt_mutex_t mutex, double delay);
  58 XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex);
  59
  60
  61   /** \brief Thread condition data type (opaque structure) */
  62      typedef struct s_xbt_cond_ *xbt_cond_t;
  63
  64 XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
  65 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
  66 XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond,
  67                                     xbt_mutex_t mutex, double delay);
  68 XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond);
  69 XBT_PUBLIC(void) xbt_cond_broadcast(xbt_cond_t cond);
  70 XBT_PUBLIC(void) xbt_cond_destroy(xbt_cond_t cond);
  71
  72 /** @} */
  73
  74 SG_END_DECL()
  75 #endif /* _XBT_THREAD_H */