src/include/xbt/xbt_os_thread.h

   1 /* $Id$ */
   2
   3 /* xbt/xbt_thread.h -- Thread portability layer                             */
   4
   5 /* Copyright (c) 2007 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
  11 #ifndef _XBT_OS_THREAD_H
  12 #define _XBT_OS_THREAD_H
  13
  14 #include "xbt/misc.h" /* SG_BEGIN_DECL */
  15 #include "xbt/function_types.h"
  16
  17 SG_BEGIN_DECL()
  18
  19 /** @addtogroup XBT_thread
  20  *  @brief Thread portability layer
  21  *
  22  *  This section describes the thread portability layer. It defines types and
  23  *  functions very close to the pthread API, but it's portable to windows too.
  24  *
  25  *  @{
  26  */
  27
  28   /** \brief Thread data type (opaque structure) */
  29   typedef struct xbt_os_thread_       *xbt_os_thread_t;
  30
  31   XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name,pvoid_f_pvoid_t start_routine,void* param);
  32   XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
  33   XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
  34   XBT_PUBLIC(const char*) xbt_os_thread_self_name(void);
  35   XBT_PUBLIC(const char*) xbt_os_thread_name(xbt_os_thread_t);
  36   /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
  37   XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread,void ** thread_return);
  38   XBT_PUBLIC(void) xbt_os_thread_yield(void);
  39   XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);
  40   XBT_PUBLIC(void*) xbt_os_thread_getparam(void);
  41
  42
  43   /** \brief Thread mutex data type (opaque structure) */
  44   typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
  45
  46   XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
  47   XBT_PUBLIC(void)           xbt_os_mutex_lock(xbt_os_mutex_t mutex);
  48   XBT_PUBLIC(void)           xbt_os_mutex_unlock(xbt_os_mutex_t mutex);
  49   XBT_PUBLIC(void)           xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
  50
  51
  52   /** \brief Thread condition data type (opaque structure) */
  53   typedef struct xbt_os_cond_  *xbt_os_cond_t;
  54
  55   XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
  56   XBT_PUBLIC(void)          xbt_os_cond_wait(xbt_os_cond_t cond,
  57                                              xbt_os_mutex_t mutex);
  58   XBT_PUBLIC(void)          xbt_os_cond_timedwait(xbt_os_cond_t cond,
  59                                                   xbt_os_mutex_t mutex,
  60                                                   double delay);
  61   XBT_PUBLIC(void)          xbt_os_cond_signal(xbt_os_cond_t cond);
  62   XBT_PUBLIC(void)          xbt_os_cond_broadcast(xbt_os_cond_t cond);
  63   XBT_PUBLIC(void)          xbt_os_cond_destroy(xbt_os_cond_t cond);
  64
  65 /** @} */
  66
  67 SG_END_DECL()
  68
  69 #endif /* _XBT_OS_THREAD_H */