include/xbt/xbt_os_thread.h

   1 /* xbt/xbt_os_thread.h -- Thread portability layer                          */
   2
   3 /* Copyright (c) 2007-2012. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef _XBT_OS_THREAD_H
   9 #define _XBT_OS_THREAD_H
  10
  11 #include "simgrid_config.h" /* Windows or Posix */
  12 #include "xbt/function_types.h"
  13
  14 SG_BEGIN_DECL()
  15
  16 /** @addtogroup XBT_thread
  17  *  @brief Thread portability layer
  18  *
  19  *  This section describes the thread portability layer. It defines types and
  20  *  functions very close to the pthread API, but it's portable to windows too.
  21  *
  22  *  @{
  23  */
  24   /** \brief Thread data type (opaque structure) */
  25 typedef struct xbt_os_thread_ *xbt_os_thread_t;
  26
  27 #include <pthread.h>
  28
  29 #ifdef _XBT_WIN32 /* defined if this is a windows system, 32bits or 64bits) */
  30 #include <WinDef.h>
  31 typedef DWORD xbt_os_thread_key_t;
  32 #else /* assume that every non-windows system is POSIX-compatible */
  33 typedef pthread_key_t xbt_os_thread_key_t;
  34 #endif
  35
  36 /** Calls pthread_atfork() if present, and raise an exception otherwise.
  37  *
  38  * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
  39  * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
  40  * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
  41  */
  42 XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void),
  43                                      void (*parent)(void),
  44                                      void (*child)(void));
  45
  46 XBT_PUBLIC(int) xbt_os_get_numcores(void);
  47
  48 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name,
  49                                                  pvoid_f_pvoid_t start_routine,
  50                                                  void *param,
  51                                                  void *data);
  52
  53 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
  54 XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread);
  55 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
  56 XBT_PUBLIC(const char *) xbt_os_thread_self_name(void);
  57 XBT_PUBLIC(const char *) xbt_os_thread_name(xbt_os_thread_t);
  58 XBT_PUBLIC(void) xbt_os_thread_set_extra_data(void *data);
  59 XBT_PUBLIC(void *) xbt_os_thread_get_extra_data(void);
  60 XBT_PUBLIC(void) xbt_os_thread_key_create(xbt_os_thread_key_t* key);
  61 XBT_PUBLIC(void) xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value);
  62 XBT_PUBLIC(void*) xbt_os_thread_get_specific(xbt_os_thread_key_t key);
  63   /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
  64 XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread,
  65                                     void **thread_return);
  66 XBT_PUBLIC(void) xbt_os_thread_yield(void);
  67 XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);
  68 XBT_PUBLIC(void *) xbt_os_thread_getparam(void);
  69
  70
  71   /** \brief Thread mutex data type (opaque structure) */
  72 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
  73
  74 XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
  75 XBT_PUBLIC(void) xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
  76 XBT_PUBLIC(void) xbt_os_mutex_timedacquire(xbt_os_mutex_t mutex,
  77                                            double delay);
  78 XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
  79 XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
  80
  81 /** \brief Thread reentrant mutex data type (opaque structure) */
  82 typedef struct xbt_os_rmutex_ *xbt_os_rmutex_t;
  83
  84 XBT_PUBLIC(xbt_os_rmutex_t) xbt_os_rmutex_init(void);
  85 XBT_PUBLIC(void) xbt_os_rmutex_acquire(xbt_os_rmutex_t rmutex);
  86 XBT_PUBLIC(void) xbt_os_rmutex_release(xbt_os_rmutex_t rmutex);
  87 XBT_PUBLIC(void) xbt_os_rmutex_destroy(xbt_os_rmutex_t rmutex);
  88
  89
  90   /** \brief Thread condition data type (opaque structure) */
  91 typedef struct xbt_os_cond_ *xbt_os_cond_t;
  92
  93 XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
  94 XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond,
  95                                   xbt_os_mutex_t mutex);
  96 XBT_PUBLIC(void) xbt_os_cond_timedwait(xbt_os_cond_t cond,
  97                                        xbt_os_mutex_t mutex, double delay);
  98 XBT_PUBLIC(void) xbt_os_cond_signal(xbt_os_cond_t cond);
  99 XBT_PUBLIC(void) xbt_os_cond_broadcast(xbt_os_cond_t cond);
 100 XBT_PUBLIC(void) xbt_os_cond_destroy(xbt_os_cond_t cond);
 101
 102    /** \brief Semaphore data type (opaque structure) */
 103 typedef struct xbt_os_sem_ *xbt_os_sem_t;
 104
 105 XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);
 106 XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem);
 107 XBT_PUBLIC(void) xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout);
 108 XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem);
 109 XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem);
 110 XBT_PUBLIC(void) xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue);
 111
 112
 113 /** @} */
 114
 115 SG_END_DECL()
 116 #endif                          /* _XBT_OS_THREAD_H */