src/include/xbt/xbt_os_thread.h

   1 /* xbt/xbt_thread.h -- Thread portability layer                             */
   2
   3 /* Copyright (c) 2007, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9
  10 #ifndef _XBT_OS_THREAD_H
  11 #define _XBT_OS_THREAD_H
  12
  13 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  14 #include "xbt/function_types.h"
  15
  16 SG_BEGIN_DECL()
  17
  18 /** @addtogroup XBT_thread
  19  *  @brief Thread portability layer
  20  *
  21  *  This section describes the thread portability layer. It defines types and
  22  *  functions very close to the pthread API, but it's portable to windows too.
  23  *
  24  *  @{
  25  */
  26   /** \brief Thread data type (opaque structure) */
  27 typedef struct xbt_os_thread_ *xbt_os_thread_t;
  28
  29 /* Calls pthread_atfork() if present, and else does nothing.
  30  * The only known user of this wrapper is mmalloc_preinit().
  31  */
  32 XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void),
  33                                      void (*parent)(void),
  34                                      void (*child)(void));
  35
  36 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name,
  37                                                  pvoid_f_pvoid_t
  38                                                  start_routine,
  39                                                  void *param);
  40 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
  41 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
  42 XBT_PUBLIC(const char *) xbt_os_thread_self_name(void);
  43 XBT_PUBLIC(const char *) xbt_os_thread_name(xbt_os_thread_t);
  44   /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
  45 XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread,
  46                                     void **thread_return);
  47 XBT_PUBLIC(void) xbt_os_thread_yield(void);
  48 XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);
  49 XBT_PUBLIC(void *) xbt_os_thread_getparam(void);
  50
  51
  52   /** \brief Thread mutex data type (opaque structure) */
  53 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
  54
  55 XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
  56 XBT_PUBLIC(void) xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
  57 XBT_PUBLIC(void) xbt_os_mutex_timedacquire(xbt_os_mutex_t mutex,
  58                                            double delay);
  59 XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
  60 XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
  61
  62
  63   /** \brief Thread condition data type (opaque structure) */
  64 typedef struct xbt_os_cond_ *xbt_os_cond_t;
  65
  66 XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
  67 XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond,
  68                                   xbt_os_mutex_t mutex);
  69 XBT_PUBLIC(void) xbt_os_cond_timedwait(xbt_os_cond_t cond,
  70                                        xbt_os_mutex_t mutex, double delay);
  71 XBT_PUBLIC(void) xbt_os_cond_signal(xbt_os_cond_t cond);
  72 XBT_PUBLIC(void) xbt_os_cond_broadcast(xbt_os_cond_t cond);
  73 XBT_PUBLIC(void) xbt_os_cond_destroy(xbt_os_cond_t cond);
  74
  75    /** \brief Semaphore data type (opaque structure) */
  76 typedef struct xbt_os_sem_ *xbt_os_sem_t;
  77
  78 XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);
  79 XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem);
  80 XBT_PUBLIC(void) xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout);
  81 XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem);
  82 XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem);
  83 XBT_PUBLIC(void) xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue);
  84
  85
  86 /** @} */
  87
  88 SG_END_DECL()
  89 #endif                          /* _XBT_OS_THREAD_H */