libgcc/gthr.h

   1 /* Threads compatibility routines for libgcc2.  */
   2 /* Compile this one with gcc.  */
   3 /* Copyright (C) 1997, 1998, 2004, 2008, 2009, 2011
   4    Free Software Foundation, Inc.
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 Under Section 7 of GPL version 3, you are granted additional
  19 permissions described in the GCC Runtime Library Exception, version
  20 3.1, as published by the Free Software Foundation.
  21
  22 You should have received a copy of the GNU General Public License and
  23 a copy of the GCC Runtime Library Exception along with this program;
  24 see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  25 <http://www.gnu.org/licenses/>.  */
  26
  27 #ifndef GCC_GTHR_H
  28 #define GCC_GTHR_H
  29
  30 #ifndef HIDE_EXPORTS
  31 #pragma GCC visibility push(default)
  32 #endif
  33
  34 /* If this file is compiled with threads support, it must
  35        #define __GTHREADS 1
  36    to indicate that threads support is present.  Also it has define
  37    function
  38      int __gthread_active_p ()
  39    that returns 1 if thread system is active, 0 if not.
  40
  41    The threads interface must define the following types:
  42      __gthread_key_t
  43      __gthread_once_t
  44      __gthread_mutex_t
  45      __gthread_recursive_mutex_t
  46
  47    The threads interface must define the following macros:
  48
  49      __GTHREAD_ONCE_INIT
  50                 to initialize __gthread_once_t
  51      __GTHREAD_MUTEX_INIT
  52                 to initialize __gthread_mutex_t to get a fast
  53                 non-recursive mutex.
  54      __GTHREAD_MUTEX_INIT_FUNCTION
  55                 to initialize __gthread_mutex_t to get a fast
  56                 non-recursive mutex.
  57                 Define this to a function which looks like this:
  58                   void __GTHREAD_MUTEX_INIT_FUNCTION (__gthread_mutex_t *)
  59                 Some systems can't initialize a mutex without a
  60                 function call.  Don't define __GTHREAD_MUTEX_INIT in this case.
  61      __GTHREAD_RECURSIVE_MUTEX_INIT
  62      __GTHREAD_RECURSIVE_MUTEX_INIT_FUNCTION
  63                 as above, but for a recursive mutex.
  64
  65    The threads interface must define the following static functions:
  66
  67      int __gthread_once (__gthread_once_t *once, void (*func) ())
  68
  69      int __gthread_key_create (__gthread_key_t *keyp, void (*dtor) (void *))
  70      int __gthread_key_delete (__gthread_key_t key)
  71
  72      void *__gthread_getspecific (__gthread_key_t key)
  73      int __gthread_setspecific (__gthread_key_t key, const void *ptr)
  74
  75      int __gthread_mutex_destroy (__gthread_mutex_t *mutex);
  76
  77      int __gthread_mutex_lock (__gthread_mutex_t *mutex);
  78      int __gthread_mutex_trylock (__gthread_mutex_t *mutex);
  79      int __gthread_mutex_unlock (__gthread_mutex_t *mutex);
  80
  81      int __gthread_recursive_mutex_lock (__gthread_recursive_mutex_t *mutex);
  82      int __gthread_recursive_mutex_trylock (__gthread_recursive_mutex_t *mutex);
  83      int __gthread_recursive_mutex_unlock (__gthread_recursive_mutex_t *mutex);
  84
  85    The following are supported in POSIX threads only. They are required to
  86    fix a deadlock in static initialization inside libsupc++. The header file
  87    gthr-posix.h defines a symbol __GTHREAD_HAS_COND to signify that these extra
  88    features are supported.
  89
  90    Types:
  91      __gthread_cond_t
  92
  93    Macros:
  94      __GTHREAD_COND_INIT
  95      __GTHREAD_COND_INIT_FUNCTION
  96
  97    Interface:
  98      int __gthread_cond_broadcast (__gthread_cond_t *cond);
  99      int __gthread_cond_wait (__gthread_cond_t *cond, __gthread_mutex_t *mutex);
 100      int __gthread_cond_wait_recursive (__gthread_cond_t *cond,
 101                                         __gthread_recursive_mutex_t *mutex);
 102
 103    All functions returning int should return zero on success or the error
 104    number.  If the operation is not supported, -1 is returned.
 105
 106    If the following are also defined, you should
 107      #define __GTHREADS_CXX0X 1
 108    to enable the c++0x thread library.
 109
 110    Types:
 111      __gthread_t
 112      __gthread_time_t
 113
 114    Interface:
 115      int __gthread_create (__gthread_t *thread, void *(*func) (void*),
 116                            void *args);
 117      int __gthread_join (__gthread_t thread, void **value_ptr);
 118      int __gthread_detach (__gthread_t thread);
 119      int __gthread_equal (__gthread_t t1, __gthread_t t2);
 120      __gthread_t __gthread_self (void);
 121      int __gthread_yield (void);
 122
 123      int __gthread_mutex_timedlock (__gthread_mutex_t *m,
 124                                     const __gthread_time_t *abs_timeout);
 125      int __gthread_recursive_mutex_timedlock (__gthread_recursive_mutex_t *m,
 126                                           const __gthread_time_t *abs_time);
 127
 128      int __gthread_cond_signal (__gthread_cond_t *cond);
 129      int __gthread_cond_timedwait (__gthread_cond_t *cond,
 130                                    __gthread_mutex_t *mutex,
 131                                    const __gthread_time_t *abs_timeout);
 132      int __gthread_cond_timedwait_recursive (__gthread_cond_t *cond,
 133                                              __gthread_recursive_mutex_t *mutex,
 134                                              const __gthread_time_t *abs_time)
 135
 136 */
 137
 138 #if SUPPORTS_WEAK
 139 /* The pe-coff weak support isn't fully compatible to ELF's weak.
 140    For static libraries it might would work, but as we need to deal
 141    with shared versions too, we disable it for mingw-targets.  */
 142 #ifdef __MINGW32__
 143 #undef GTHREAD_USE_WEAK
 144 #define GTHREAD_USE_WEAK 0
 145 #endif
 146
 147 #ifndef GTHREAD_USE_WEAK
 148 #define GTHREAD_USE_WEAK 1
 149 #endif
 150 #endif
 151 #include "gthr-default.h"
 152
 153 #ifndef HIDE_EXPORTS
 154 #pragma GCC visibility pop
 155 #endif
 156
 157 #endif /* ! GCC_GTHR_H */