/* libc-internal interface for mutex locks.  NPTL version.   Copyright (C) 1996-2003, 2005, 2007 Free Software Foundation, Inc.   This file is part of the GNU C Library.   The GNU C Library is free software; you can redistribute it and/or   modify it under the terms of the GNU Lesser General Public License as   published by the Free Software Foundation; either version 2.1 of the   License, or (at your option) any later version.   The GNU C Library is distributed in the hope that it will be useful,   but WITHOUT ANY WARRANTY; without even the implied warranty of   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU   Lesser General Public License for more details.   You should have received a copy of the GNU Lesser General Public   License along with the GNU C Library; see the file COPYING.LIB.  If not,   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,   Boston, MA 02111-1307, USA.  */#ifndef _BITS_LIBC_LOCK_H#define _BITS_LIBC_LOCK_H 1#include <pthread.h>#define __need_NULL#include <stddef.h>/* Fortunately Linux now has a mean to do locking which is realtime   safe without the aid of the thread library.  We also need no fancy   options like error checking mutexes etc.  We only need simple   locks, maybe recursive.  This can be easily and cheaply implemented   using futexes.  We will use them everywhere except in ld.so since   ld.so might be used on old kernels with a different libc.so.  */#ifdef _LIBC# include <lowlevellock.h># include <tls.h># include <pthread-functions.h>#endif/* Mutex type.  */#if defined _LIBC || defined _IO_MTSAFE_IO# if (defined NOT_IN_libc && !defined IS_IN_libpthread) || !defined _LIBCtypedef pthread_mutex_t __libc_lock_t;typedef struct { pthread_mutex_t mutex; } __libc_lock_recursive_t;# elsetypedef int __libc_lock_t;typedef struct { int lock; int cnt; void *owner; } __libc_lock_recursive_t;# endiftypedef struct { pthread_mutex_t mutex; } __rtld_lock_recursive_t;# ifdef __USE_UNIX98typedef pthread_rwlock_t __libc_rwlock_t;# elsetypedef struct __libc_rwlock_opaque__ __libc_rwlock_t;# endif#elsetypedef struct __libc_lock_opaque__ __libc_lock_t;typedef struct __libc_lock_recursive_opaque__ __libc_lock_recursive_t;typedef struct __libc_rwlock_opaque__ __libc_rwlock_t;#endif/* Type for key to thread-specific data.  */typedef pthread_key_t __libc_key_t;/* Define a lock variable NAME with storage class CLASS.  The lock must be   initialized with __libc_lock_init before it can be used (or define it   with __libc_lock_define_initialized, below).  Use `extern' for CLASS to   declare a lock defined in another module.  In public structure   definitions you must use a pointer to the lock structure (i.e., NAME   begins with a `*'), because its storage size will not be known outside   of libc.  */#define __libc_lock_define(CLASS,NAME) \  CLASS __libc_lock_t NAME;#define __libc_rwlock_define(CLASS,NAME) \  CLASS __libc_rwlock_t NAME;#define __libc_lock_define_recursive(CLASS,NAME) \  CLASS __libc_lock_recursive_t NAME;#define __rtld_lock_define_recursive(CLASS,NAME) \  CLASS __rtld_lock_recursive_t NAME;/* Define an initialized lock variable NAME with storage class CLASS.   For the C library we take a deeper look at the initializer.  For   this implementation all fields are initialized to zero.  Therefore   we don't initialize the variable which allows putting it into the   BSS section.  (Except on PA-RISC and other odd architectures, where   initialized locks must be set to one due to the lack of normal   atomic operations.) */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# if LLL_LOCK_INITIALIZER == 0#  define __libc_lock_define_initialized(CLASS,NAME) \  CLASS __libc_lock_t NAME;# else#  define __libc_lock_define_initialized(CLASS,NAME) \  CLASS __libc_lock_t NAME = LLL_LOCK_INITIALIZER;# endif#else# if __LT_SPINLOCK_INIT == 0#  define __libc_lock_define_initialized(CLASS,NAME) \  CLASS __libc_lock_t NAME;# else#  define __libc_lock_define_initialized(CLASS,NAME) \  CLASS __libc_lock_t NAME = PTHREAD_MUTEX_INITIALIZER;# endif#endif#define __libc_rwlock_define_initialized(CLASS,NAME) \  CLASS __libc_rwlock_t NAME = PTHREAD_RWLOCK_INITIALIZER;/* Define an initialized recursive lock variable NAME with storage   class CLASS.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# if LLL_LOCK_INITIALIZER == 0#  define __libc_lock_define_initialized_recursive(CLASS,NAME) \  CLASS __libc_lock_recursive_t NAME;# else#  define __libc_lock_define_initialized_recursive(CLASS,NAME) \  CLASS __libc_lock_recursive_t NAME = _LIBC_LOCK_RECURSIVE_INITIALIZER;# endif# define _LIBC_LOCK_RECURSIVE_INITIALIZER \  { LLL_LOCK_INITIALIZER, 0, NULL }#else# define __libc_lock_define_initialized_recursive(CLASS,NAME) \  CLASS __libc_lock_recursive_t NAME = _LIBC_LOCK_RECURSIVE_INITIALIZER;# define _LIBC_LOCK_RECURSIVE_INITIALIZER \  {PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP}#endif#define __rtld_lock_define_initialized_recursive(CLASS,NAME) \  CLASS __rtld_lock_recursive_t NAME = _RTLD_LOCK_RECURSIVE_INITIALIZER;#define _RTLD_LOCK_RECURSIVE_INITIALIZER \  {PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP}#define __rtld_lock_initialize(NAME) \  (void) ((NAME) = (__rtld_lock_recursive_t) _RTLD_LOCK_RECURSIVE_INITIALIZER)/* If we check for a weakly referenced symbol and then perform a   normal jump to it te code generated for some platforms in case of   PIC is unnecessarily slow.  What would happen is that the function   is first referenced as data and then it is called indirectly   through the PLT.  We can make this a direct jump.  */#ifdef __PIC__# define __libc_maybe_call(FUNC, ARGS, ELSE) \  (__extension__ ({ __typeof (FUNC) *_fn = (FUNC); \                    _fn != NULL ? (*_fn) ARGS : ELSE; }))#else# define __libc_maybe_call(FUNC, ARGS, ELSE) \  (FUNC != NULL ? FUNC ARGS : ELSE)#endif/* Call thread functions through the function pointer table.  */#if defined SHARED && !defined NOT_IN_libc# define PTFAVAIL(NAME) __libc_pthread_functions_init# define __libc_ptf_call(FUNC, ARGS, ELSE) \  (__libc_pthread_functions_init ? PTHFCT_CALL (ptr_##FUNC, ARGS) : ELSE)# define __libc_ptf_call_always(FUNC, ARGS) \  PTHFCT_CALL (ptr_##FUNC, ARGS)#else# define PTFAVAIL(NAME) (NAME != NULL)# define __libc_ptf_call(FUNC, ARGS, ELSE) \  __libc_maybe_call (FUNC, ARGS, ELSE)# define __libc_ptf_call_always(FUNC, ARGS) \  FUNC ARGS#endif/* Initialize the named lock variable, leaving it in a consistent, unlocked   state.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# define __libc_lock_init(NAME) ((NAME) = LLL_LOCK_INITIALIZER, 0)#else# define __libc_lock_init(NAME) \  __libc_maybe_call (__pthread_mutex_init, (&(NAME), NULL), 0)#endif#if defined SHARED && !defined NOT_IN_libc/* ((NAME) = (__libc_rwlock_t) PTHREAD_RWLOCK_INITIALIZER, 0) is   inefficient.  */# define __libc_rwlock_init(NAME) \  (__builtin_memset (&(NAME), '\0', sizeof (NAME)), 0)#else# define __libc_rwlock_init(NAME) \  __libc_maybe_call (__pthread_rwlock_init, (&(NAME), NULL), 0)#endif/* Same as last but this time we initialize a recursive mutex.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# define __libc_lock_init_recursive(NAME) \  ((NAME) = (__libc_lock_recursive_t) _LIBC_LOCK_RECURSIVE_INITIALIZER, 0)#else# define __libc_lock_init_recursive(NAME) \  do {									      \    if (__pthread_mutex_init != NULL)					      \      {									      \	pthread_mutexattr_t __attr;					      \	__pthread_mutexattr_init (&__attr);				      \	__pthread_mutexattr_settype (&__attr, PTHREAD_MUTEX_RECURSIVE_NP);    \	__pthread_mutex_init (&(NAME).mutex, &__attr);			      \	__pthread_mutexattr_destroy (&__attr);				      \      }									      \  } while (0)#endif#define __rtld_lock_init_recursive(NAME) \  do {									      \    if (__pthread_mutex_init != NULL)					      \      {									      \	pthread_mutexattr_t __attr;					      \	__pthread_mutexattr_init (&__attr);				      \	__pthread_mutexattr_settype (&__attr, PTHREAD_MUTEX_RECURSIVE_NP);    \	__pthread_mutex_init (&(NAME).mutex, &__attr);			      \	__pthread_mutexattr_destroy (&__attr);				      \      }									      \  } while (0)/* Finalize the named lock variable, which must be locked.  It cannot be   used again until __libc_lock_init is called again on it.  This must be   called on a lock variable before the containing storage is reused.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# define __libc_lock_fini(NAME) ((void) 0)#else# define __libc_lock_fini(NAME) \  __libc_maybe_call (__pthread_mutex_destroy, (&(NAME)), 0)#endif#if defined SHARED && !defined NOT_IN_libc# define __libc_rwlock_fini(NAME) ((void) 0)#else# define __libc_rwlock_fini(NAME) \  __libc_maybe_call (__pthread_rwlock_destroy, (&(NAME)), 0)#endif/* Finalize recursive named lock.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# define __libc_lock_fini_recursive(NAME) ((void) 0)#else# define __libc_lock_fini_recursive(NAME) \  __libc_maybe_call (__pthread_mutex_destroy, (&(NAME)), 0)#endif/* Lock the named lock variable.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# define __libc_lock_lock(NAME) \  ({ lll_lock (NAME, LLL_PRIVATE); 0; })#else# define __libc_lock_lock(NAME) \  __libc_maybe_call (__pthread_mutex_lock, (&(NAME)), 0)#endif#define __libc_rwlock_rdlock(NAME) \  __libc_ptf_call (__pthread_rwlock_rdlock, (&(NAME)), 0)#define __libc_rwlock_wrlock(NAME) \  __libc_ptf_call (__pthread_rwlock_wrlock, (&(NAME)), 0)/* Lock the recursive named lock variable.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# define __libc_lock_lock_recursive(NAME) \  do {									      \    void *self = THREAD_SELF;						      \    if ((NAME).owner != self)						      \      {									      \	lll_lock ((NAME).lock, LLL_PRIVATE);				      \	(NAME).owner = self;						      \      }									      \    ++(NAME).cnt;							      \  } while (0)#else# define __libc_lock_lock_recursive(NAME) \  __libc_maybe_call (__pthread_mutex_lock, (&(NAME).mutex), 0)#endif/* Try to lock the named lock variable.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# define __libc_lock_trylock(NAME) \  lll_trylock (NAME)#else# define __libc_lock_trylock(NAME) \  __libc_maybe_call (__pthread_mutex_trylock, (&(NAME)), 0)#endif#define __libc_rwlock_tryrdlock(NAME) \  __libc_maybe_call (__pthread_rwlock_tryrdlock, (&(NAME)), 0)#define __libc_rwlock_trywrlock(NAME) \  __libc_maybe_call (__pthread_rwlock_trywrlock, (&(NAME)), 0)/* Try to lock the recursive named lock variable.  */#if defined _LIBC && (!defined NOT_IN_libc || defined IS_IN_libpthread)# define __libc_lock_trylock_recursive(NAME) \  ({									      \    int result = 0;							      \    void *self = THREAD_SELF;						      \    if ((NAME).owner != self)						      \      {									      \	if (lll_trylock ((NAME).lock) == 0)				      \	  {								      \	    (NAME).owner = self;					      \	    (NAME).cnt = 1;						      \