include/xbt/synchro_core.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 /* splited away from synchro.h since we areused by dynar.h, and synchro.h uses dynar */
  12
  13
  14 #ifndef _XBT_THREAD_H
  15 #define _XBT_THREAD_H
  16
  17 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  18 #include "xbt/function_types.h"
  19
  20 SG_BEGIN_DECL()
  21
  22 /** @addtogroup XBT_synchro
  23  *  @brief XBT synchronization tools
  24  *
  25  *  This section describes the XBT synchronization tools. It defines types and
  26  *  functions very close to the pthread API, but widly usable. When used from
  27  *  the simulator, you will lock simulated processes as expected. When used
  28  *  from GRAS programs compiled for in-situ execution, you have synchronization
  29  *  mecanism portable to windows and UNIX. Nice, isn't it?
  30  *
  31  *  @{
  32  */
  33   /** \brief Thread data type (opaque structure) */
  34      typedef struct s_xbt_thread_ *xbt_thread_t;
  35
  36 XBT_PUBLIC(xbt_thread_t) xbt_thread_create(const char *name,
  37                                            void_f_pvoid_t start_routine,
  38                                            void *param);
  39 XBT_PUBLIC(void) xbt_thread_exit();
  40 XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void);
  41 XBT_PUBLIC(const char *) xbt_thread_name(xbt_thread_t t);
  42 XBT_PUBLIC(const char *) xbt_thread_self_name(void);
  43   /* xbt_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
  44 XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread);
  45   /* Ends the life of the poor victim (not always working if it's computing, but working if it's blocked in the OS) */
  46 XBT_PUBLIC(void) xbt_thread_cancel(xbt_thread_t thread);
  47   /* suicide */
  48 XBT_PUBLIC(void) xbt_thread_exit(void);
  49   /* current thread pass control to any possible thread wanting it */
  50 XBT_PUBLIC(void) xbt_thread_yield(void);
  51
  52
  53   /** \brief Thread mutex data type (opaque structure) */
  54      typedef struct s_xbt_mutex_ *xbt_mutex_t;
  55
  56 XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
  57 XBT_PUBLIC(void) xbt_mutex_acquire(xbt_mutex_t mutex);
  58 XBT_PUBLIC(void) xbt_mutex_release(xbt_mutex_t mutex);
  59 XBT_PUBLIC(void) xbt_mutex_timedacquire(xbt_mutex_t mutex, double delay);
  60 XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex);
  61
  62
  63   /** \brief Thread condition data type (opaque structure) */
  64      typedef struct s_xbt_cond_ *xbt_cond_t;
  65
  66 XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
  67 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
  68 XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond,
  69                                     xbt_mutex_t mutex, double delay);
  70 XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond);
  71 XBT_PUBLIC(void) xbt_cond_broadcast(xbt_cond_t cond);
  72 XBT_PUBLIC(void) xbt_cond_destroy(xbt_cond_t cond);
  73
  74 /** @} */
  75
  76 SG_END_DECL()
  77 #endif /* _XBT_THREAD_H */