/* Copyright (C) 2002-2018 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; if not, see

   <http://www.gnu.org/licenses/>.  */

#ifndef _PTHREAD_H

#define _PTHREAD_H	1

#include <features.h>

#include <endian.h>

#include <sched.h>

#include <time.h>

#include <bits/pthreadtypes.h>

#include <bits/setjmp.h>

#include <bits/wordsize.h>

#include <bits/types/struct_timespec.h>

/* Detach state.  */

enum

{

  PTHREAD_CREATE_JOINABLE,

#define PTHREAD_CREATE_JOINABLE	PTHREAD_CREATE_JOINABLE

  PTHREAD_CREATE_DETACHED

#define PTHREAD_CREATE_DETACHED	PTHREAD_CREATE_DETACHED

};

/* Mutex types.  */

enum

{

  PTHREAD_MUTEX_TIMED_NP,

  PTHREAD_MUTEX_RECURSIVE_NP,

  PTHREAD_MUTEX_ERRORCHECK_NP,

  PTHREAD_MUTEX_ADAPTIVE_NP

#if defined __USE_UNIX98 || defined __USE_XOPEN2K8

  ,

  PTHREAD_MUTEX_NORMAL = PTHREAD_MUTEX_TIMED_NP,

  PTHREAD_MUTEX_RECURSIVE = PTHREAD_MUTEX_RECURSIVE_NP,

  PTHREAD_MUTEX_ERRORCHECK = PTHREAD_MUTEX_ERRORCHECK_NP,

  PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL

#endif

#ifdef __USE_GNU

  /* For compatibility.  */

  , PTHREAD_MUTEX_FAST_NP = PTHREAD_MUTEX_TIMED_NP

#endif

};

#ifdef __USE_XOPEN2K

/* Robust mutex or not flags.  */

enum

{

  PTHREAD_MUTEX_STALLED,

  PTHREAD_MUTEX_STALLED_NP = PTHREAD_MUTEX_STALLED,

  PTHREAD_MUTEX_ROBUST,

  PTHREAD_MUTEX_ROBUST_NP = PTHREAD_MUTEX_ROBUST

};

#endif

#if defined __USE_POSIX199506 || defined __USE_UNIX98

/* Mutex protocols.  */

enum

{

  PTHREAD_PRIO_NONE,

  PTHREAD_PRIO_INHERIT,

  PTHREAD_PRIO_PROTECT

};

#endif

#if __PTHREAD_MUTEX_HAVE_PREV

# define PTHREAD_MUTEX_INITIALIZER \

  { { 0, 0, 0, 0, 0, __PTHREAD_SPINS, { 0, 0 } } }

# ifdef __USE_GNU

#  define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP \

  { { 0, 0, 0, 0, PTHREAD_MUTEX_RECURSIVE_NP, __PTHREAD_SPINS, { 0, 0 } } }

#  define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP \

  { { 0, 0, 0, 0, PTHREAD_MUTEX_ERRORCHECK_NP, __PTHREAD_SPINS, { 0, 0 } } }

#  define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP \

  { { 0, 0, 0, 0, PTHREAD_MUTEX_ADAPTIVE_NP, __PTHREAD_SPINS, { 0, 0 } } }

# endif

#else

# define PTHREAD_MUTEX_INITIALIZER \

  { { 0, 0, 0, 0, 0, { __PTHREAD_SPINS } } }

# ifdef __USE_GNU

#  define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP \

  { { 0, 0, 0, PTHREAD_MUTEX_RECURSIVE_NP, 0, { __PTHREAD_SPINS } } }

#  define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP \

  { { 0, 0, 0, PTHREAD_MUTEX_ERRORCHECK_NP, 0, { __PTHREAD_SPINS } } }

#  define PTHREAD_ADAPTIVE_MUTEX_INITIALIZER_NP \

  { { 0, 0, 0, PTHREAD_MUTEX_ADAPTIVE_NP, 0, { __PTHREAD_SPINS } } }

# endif

#endif

/* Read-write lock types.  */

#if defined __USE_UNIX98 || defined __USE_XOPEN2K

enum

{

  PTHREAD_RWLOCK_PREFER_READER_NP,

  PTHREAD_RWLOCK_PREFER_WRITER_NP,

  PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP,

  PTHREAD_RWLOCK_DEFAULT_NP = PTHREAD_RWLOCK_PREFER_READER_NP

};

/* Define __PTHREAD_RWLOCK_INT_FLAGS_SHARED to 1 if pthread_rwlock_t

   has the shared field.  All 64-bit architectures have the shared field

   in pthread_rwlock_t.  */

#ifndef __PTHREAD_RWLOCK_INT_FLAGS_SHARED

# if __WORDSIZE == 64

#  define __PTHREAD_RWLOCK_INT_FLAGS_SHARED 1

# endif

#endif

/* Read-write lock initializers.  */

# define PTHREAD_RWLOCK_INITIALIZER \

  { { 0, 0, 0, 0, 0, 0, 0, 0, __PTHREAD_RWLOCK_ELISION_EXTRA, 0, 0 } }

# ifdef __USE_GNU

#  ifdef __PTHREAD_RWLOCK_INT_FLAGS_SHARED

#   define PTHREAD_RWLOCK_WRITER_NONRECURSIVE_INITIALIZER_NP \

  { { 0, 0, 0, 0, 0, 0, 0, 0, __PTHREAD_RWLOCK_ELISION_EXTRA, 0,					      \

	PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP } }

#  else

#   if __BYTE_ORDER == __LITTLE_ENDIAN

#    define PTHREAD_RWLOCK_WRITER_NONRECURSIVE_INITIALIZER_NP \

  { { 0, 0, 0, 0, 0, 0, PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP, \

      0, __PTHREAD_RWLOCK_ELISION_EXTRA, 0, 0 } }

#   else

#    define PTHREAD_RWLOCK_WRITER_NONRECURSIVE_INITIALIZER_NP \

  { { 0, 0, 0, 0, 0, 0, 0, 0, 0, PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP,\

      0 } }

#   endif

#  endif

# endif

#endif  /* Unix98 or XOpen2K */

/* Scheduler inheritance.  */

enum

{

  PTHREAD_INHERIT_SCHED,

#define PTHREAD_INHERIT_SCHED   PTHREAD_INHERIT_SCHED

  PTHREAD_EXPLICIT_SCHED

#define PTHREAD_EXPLICIT_SCHED  PTHREAD_EXPLICIT_SCHED

};

/* Scope handling.  */

enum

{

  PTHREAD_SCOPE_SYSTEM,

#define PTHREAD_SCOPE_SYSTEM    PTHREAD_SCOPE_SYSTEM

  PTHREAD_SCOPE_PROCESS

#define PTHREAD_SCOPE_PROCESS   PTHREAD_SCOPE_PROCESS

};

/* Process shared or private flag.  */

enum

{

  PTHREAD_PROCESS_PRIVATE,

#define PTHREAD_PROCESS_PRIVATE PTHREAD_PROCESS_PRIVATE

  PTHREAD_PROCESS_SHARED

#define PTHREAD_PROCESS_SHARED  PTHREAD_PROCESS_SHARED

};

/* Conditional variable handling.  */

#define PTHREAD_COND_INITIALIZER { { {0}, {0}, {0, 0}, {0, 0}, 0, 0, {0, 0} } }

/* Cleanup buffers */

struct _pthread_cleanup_buffer

{

  void (*__routine) (void *);             /* Function to call.  */

  void *__arg;                            /* Its argument.  */

  int __canceltype;                       /* Saved cancellation type. */

  struct _pthread_cleanup_buffer *__prev; /* Chaining of cleanup functions.  */

};

/* Cancellation */

enum

{

  PTHREAD_CANCEL_ENABLE,

#define PTHREAD_CANCEL_ENABLE   PTHREAD_CANCEL_ENABLE

  PTHREAD_CANCEL_DISABLE

#define PTHREAD_CANCEL_DISABLE  PTHREAD_CANCEL_DISABLE

};

enum

{

  PTHREAD_CANCEL_DEFERRED,

#define PTHREAD_CANCEL_DEFERRED	PTHREAD_CANCEL_DEFERRED

  PTHREAD_CANCEL_ASYNCHRONOUS

#define PTHREAD_CANCEL_ASYNCHRONOUS	PTHREAD_CANCEL_ASYNCHRONOUS

};

#define PTHREAD_CANCELED ((void *) -1)

/* Single execution handling.  */

#define PTHREAD_ONCE_INIT 0

#ifdef __USE_XOPEN2K

/* Value returned by 'pthread_barrier_wait' for one of the threads after

   the required number of threads have called this function.

   -1 is distinct from 0 and all errno constants */

# define PTHREAD_BARRIER_SERIAL_THREAD -1

#endif

__BEGIN_DECLS

/* Create a new thread, starting with execution of START-ROUTINE

   getting passed ARG.  Creation attributed come from ATTR.  The new

   handle is stored in *NEWTHREAD.  */

extern int pthread_create (pthread_t *__restrict __newthread,

			   const pthread_attr_t *__restrict __attr,

			   void *(*__start_routine) (void *),

			   void *__restrict __arg) __THROWNL __nonnull ((1, 3));

/* Terminate calling thread.

   The registered cleanup handlers are called via exception handling

   so we cannot mark this function with __THROW.*/

extern void pthread_exit (void *__retval) __attribute__ ((__noreturn__));

/* Make calling thread wait for termination of the thread TH.  The

   exit status of the thread is stored in *THREAD_RETURN, if THREAD_RETURN

   is not NULL.

   This function is a cancellation point and therefore not marked with

   __THROW.  */

extern int pthread_join (pthread_t __th, void **__thread_return);

#ifdef __USE_GNU

/* Check whether thread TH has terminated.  If yes return the status of

   the thread in *THREAD_RETURN, if THREAD_RETURN is not NULL.  */

extern int pthread_tryjoin_np (pthread_t __th, void **__thread_return) __THROW;

/* Make calling thread wait for termination of the thread TH, but only

   until TIMEOUT.  The exit status of the thread is stored in

   *THREAD_RETURN, if THREAD_RETURN is not NULL.

   This function is a cancellation point and therefore not marked with

   __THROW.  */

extern int pthread_timedjoin_np (pthread_t __th, void **__thread_return,

				 const struct timespec *__abstime);

#endif

/* Indicate that the thread TH is never to be joined with PTHREAD_JOIN.

   The resources of TH will therefore be freed immediately when it

   terminates, instead of waiting for another thread to perform PTHREAD_JOIN

   on it.  */

extern int pthread_detach (pthread_t __th) __THROW;

/* Obtain the identifier of the current thread.  */

extern pthread_t pthread_self (void) __THROW __attribute__ ((__const__));

/* Compare two thread identifiers.  */

extern int pthread_equal (pthread_t __thread1, pthread_t __thread2)

  __THROW __attribute__ ((__const__));

/* Thread attribute handling.  */

/* Initialize thread attribute *ATTR with default attributes

   (detachstate is PTHREAD_JOINABLE, scheduling policy is SCHED_OTHER,

    no user-provided stack).  */

extern int pthread_attr_init (pthread_attr_t *__attr) __THROW __nonnull ((1));

/* Destroy thread attribute *ATTR.  */

extern int pthread_attr_destroy (pthread_attr_t *__attr)

     __THROW __nonnull ((1));

/* Get detach state attribute.  */

extern int pthread_attr_getdetachstate (const pthread_attr_t *__attr,

					int *__detachstate)

     __THROW __nonnull ((1, 2));

/* Set detach state attribute.  */

extern int pthread_attr_setdetachstate (pthread_attr_t *__attr,

					int __detachstate)

     __THROW __nonnull ((1));

/* Get the size of the guard area created for stack overflow protection.  */

extern int pthread_attr_getguardsize (const pthread_attr_t *__attr,

				      size_t *__guardsize)

     __THROW __nonnull ((1, 2));

/* Set the size of the guard area created for stack overflow protection.  */

extern int pthread_attr_setguardsize (pthread_attr_t *__attr,

				      size_t __guardsize)

     __THROW __nonnull ((1));

/* Return in *PARAM the scheduling parameters of *ATTR.  */

extern int pthread_attr_getschedparam (const pthread_attr_t *__restrict __attr,

				       struct sched_param *__restrict __param)

     __THROW __nonnull ((1, 2));

/* Set scheduling parameters (priority, etc) in *ATTR according to PARAM.  */

extern int pthread_attr_setschedparam (pthread_attr_t *__restrict __attr,

				       const struct sched_param *__restrict

				       __param) __THROW __nonnull ((1, 2));

/* Return in *POLICY the scheduling policy of *ATTR.  */

extern int pthread_attr_getschedpolicy (const pthread_attr_t *__restrict

					__attr, int *__restrict __policy)

     __THROW __nonnull ((1, 2));

/* Set scheduling policy in *ATTR according to POLICY.  */

extern int pthread_attr_setschedpolicy (pthread_attr_t *__attr, int __policy)

     __THROW __nonnull ((1));

/* Return in *INHERIT the scheduling inheritance mode of *ATTR.  */

extern int pthread_attr_getinheritsched (const pthread_attr_t *__restrict

					 __attr, int *__restrict __inherit)

     __THROW __nonnull ((1, 2));

/* Set scheduling inheritance mode in *ATTR according to INHERIT.  */

extern int pthread_attr_setinheritsched (pthread_attr_t *__attr,

					 int __inherit)

     __THROW __nonnull ((1));

/* Return in *SCOPE the scheduling contention scope of *ATTR.  */

extern int pthread_attr_getscope (const pthread_attr_t *__restrict __attr,

				  int *__restrict __scope)

     __THROW __nonnull ((1, 2));

/* Set scheduling contention scope in *ATTR according to SCOPE.  */

extern int pthread_attr_setscope (pthread_attr_t *__attr, int __scope)

     __THROW __nonnull ((1));

/* Return the previously set address for the stack.  */

extern int pthread_attr_getstackaddr (const pthread_attr_t *__restrict

				      __attr, void **__restrict __stackaddr)

     __THROW __nonnull ((1, 2)) __attribute_deprecated__;

/* Set the starting address of the stack of the thread to be created.

   Depending on whether the stack grows up or down the value must either

   be higher or lower than all the address in the memory block.  The

   minimal size of the block must be PTHREAD_STACK_MIN.  */

extern int pthread_attr_setstackaddr (pthread_attr_t *__attr,

				      void *__stackaddr)

     __THROW __nonnull ((1)) __attribute_deprecated__;

/* Return the currently used minimal stack size.  */

extern int pthread_attr_getstacksize (const pthread_attr_t *__restrict

				      __attr, size_t *__restrict __stacksize)

     __THROW __nonnull ((1, 2));

/* Add information about the minimum stack size needed for the thread

   to be started.  This size must never be less than PTHREAD_STACK_MIN

   and must also not exceed the system limits.  */

extern int pthread_attr_setstacksize (pthread_attr_t *__attr,

				      size_t __stacksize)

     __THROW __nonnull ((1));

#ifdef __USE_XOPEN2K

/* Return the previously set address for the stack.  */

extern int pthread_attr_getstack (const pthread_attr_t *__restrict __attr,

				  void **__restrict __stackaddr,

				  size_t *__restrict __stacksize)

     __THROW __nonnull ((1, 2, 3));

/* The following two interfaces are intended to replace the last two.  They

   require setting the address as well as the size since only setting the

   address will make the implementation on some architectures impossible.  */

extern int pthread_attr_setstack (pthread_attr_t *__attr, void *__stackaddr,

				  size_t __stacksize) __THROW __nonnull ((1));

#endif

#ifdef __USE_GNU

/* Thread created with attribute ATTR will be limited to run only on

   the processors represented in CPUSET.  */

extern int pthread_attr_setaffinity_np (pthread_attr_t *__attr,

					size_t __cpusetsize,

					const cpu_set_t *__cpuset)

     __THROW __nonnull ((1, 3));

/* Get bit set in CPUSET representing the processors threads created with

   ATTR can run on.  */

extern int pthread_attr_getaffinity_np (const pthread_attr_t *__attr,

					size_t __cpusetsize,

					cpu_set_t *__cpuset)

     __THROW __nonnull ((1, 3));

/* Get the default attributes used by pthread_create in this process.  */

extern int pthread_getattr_default_np (pthread_attr_t *__attr)

     __THROW __nonnull ((1));

/* Set the default attributes to be used by pthread_create in this

   process.  */

extern int pthread_setattr_default_np (const pthread_attr_t *__attr)

     __THROW __nonnull ((1));

/* Initialize thread attribute *ATTR with attributes corresponding to the

   already running thread TH.  It shall be called on uninitialized ATTR

   and destroyed with pthread_attr_destroy when no longer needed.  */

extern int pthread_getattr_np (pthread_t __th, pthread_attr_t *__attr)

     __THROW __nonnull ((2));

#endif

/* Functions for scheduling control.  */

/* Set the scheduling parameters for TARGET_THREAD according to POLICY

   and *PARAM.  */

extern int pthread_setschedparam (pthread_t __target_thread, int __policy,

				  const struct sched_param *__param)

     __THROW __nonnull ((3));

/* Return in *POLICY and *PARAM the scheduling parameters for TARGET_THREAD. */

extern int pthread_getschedparam (pthread_t __target_thread,

				  int *__restrict __policy,

				  struct sched_param *__restrict __param)

     __THROW __nonnull ((2, 3));

/* Set the scheduling priority for TARGET_THREAD.  */

extern int pthread_setschedprio (pthread_t __target_thread, int __prio)

     __THROW;

#ifdef __USE_GNU

/* Get thread name visible in the kernel and its interfaces.  */

extern int pthread_getname_np (pthread_t __target_thread, char *__buf,

			       size_t __buflen)

     __THROW __nonnull ((2));

/* Set thread name visible in the kernel and its interfaces.  */

extern int pthread_setname_np (pthread_t __target_thread, const char *__name)

     __THROW __nonnull ((2));

#endif

#ifdef __USE_UNIX98

/* Determine level of concurrency.  */

extern int pthread_getconcurrency (void) __THROW;

/* Set new concurrency level to LEVEL.  */

extern int pthread_setconcurrency (int __level) __THROW;

#endif

#ifdef __USE_GNU

/* Yield the processor to another thread or process.

   This function is similar to the POSIX `sched_yield' function but

   might be differently implemented in the case of a m-on-n thread

   implementation.  */

extern int pthread_yield (void) __THROW;

/* Limit specified thread TH to run only on the processors represented

   in CPUSET.  */

extern int pthread_setaffinity_np (pthread_t __th, size_t __cpusetsize,

				   const cpu_set_t *__cpuset)

     __THROW __nonnull ((3));

/* Get bit set in CPUSET representing the processors TH can run on.  */

extern int pthread_getaffinity_np (pthread_t __th, size_t __cpusetsize,

				   cpu_set_t *__cpuset)

     __THROW __nonnull ((3));

#endif

/* Functions for handling initialization.  */

/* Guarantee that the initialization function INIT_ROUTINE will be called

   only once, even if pthread_once is executed several times with the

   same ONCE_CONTROL argument. ONCE_CONTROL must point to a static or

   extern variable initialized to PTHREAD_ONCE_INIT.

   The initialization functions might throw exception which is why

   this function is not marked with __THROW.  */

extern int pthread_once (pthread_once_t *__once_control,

			 void (*__init_routine) (void)) __nonnull ((1, 2));

/* Functions for handling cancellation.

   Note that these functions are explicitly not marked to not throw an

   exception in C++ code.  If cancellation is implemented by unwinding

   this is necessary to have the compiler generate the unwind information.  */

/* Set cancelability state of current thread to STATE, returning old

   state in *OLDSTATE if OLDSTATE is not NULL.  */

extern int pthread_setcancelstate (int __state, int *__oldstate);

/* Set cancellation state of current thread to TYPE, returning the old

   type in *OLDTYPE if OLDTYPE is not NULL.  */

extern int pthread_setcanceltype (int __type, int *__oldtype);

/* Cancel THREAD immediately or at the next possibility.  */

extern int pthread_cancel (pthread_t __th);

/* Test for pending cancellation for the current thread and terminate

   the thread as per pthread_exit(PTHREAD_CANCELED) if it has been

   cancelled.  */

extern void pthread_testcancel (void);

/* Cancellation handling with integration into exception handling.  */

typedef struct

{

  struct

  {

    __jmp_buf __cancel_jmp_buf;

    int __mask_was_saved;

  } __cancel_jmp_buf[1];

  void *__pad[4];

} __pthread_unwind_buf_t __attribute__ ((__aligned__));

/* No special attributes by default.  */

#ifndef __cleanup_fct_attribute

# define __cleanup_fct_attribute

#endif

/* Structure to hold the cleanup handler information.  */

struct __pthread_cleanup_frame

{

  void (*__cancel_routine) (void *);

  void *__cancel_arg;

  int __do_it;

  int __cancel_type;

};

#if defined __GNUC__ && defined __EXCEPTIONS

# ifdef __cplusplus

/* Class to handle cancellation handler invocation.  */

class __pthread_cleanup_class

{

  void (*__cancel_routine) (void *);

  void *__cancel_arg;

  int __do_it;

  int __cancel_type;

 public:

  __pthread_cleanup_class (void (*__fct) (void *), void *__arg)

    : __cancel_routine (__fct), __cancel_arg (__arg), __do_it (1) { }

  ~__pthread_cleanup_class () { if (__do_it) __cancel_routine (__cancel_arg); }

  void __setdoit (int __newval) { __do_it = __newval; }

  void __defer () { pthread_setcanceltype (PTHREAD_CANCEL_DEFERRED,

					   &__cancel_type); }

  void __restore () const { pthread_setcanceltype (__cancel_type, 0); }

};

/* Install a cleanup handler: ROUTINE will be called with arguments ARG

   when the thread is canceled or calls pthread_exit.  ROUTINE will also

   be called with arguments ARG when the matching pthread_cleanup_pop

   is executed with non-zero EXECUTE argument.

   pthread_cleanup_push and pthread_cleanup_pop are macros and must always

   be used in matching pairs at the same nesting level of braces.  */

#  define pthread_cleanup_push(routine, arg) \

  do {									      \

    __pthread_cleanup_class __clframe (routine, arg)

/* Remove a cleanup handler installed by the matching pthread_cleanup_push.

   If EXECUTE is non-zero, the handler function is called. */

#  define pthread_cleanup_pop(execute) \

    __clframe.__setdoit (execute);					      \

  } while (0)

#  ifdef __USE_GNU

/* Install a cleanup handler as pthread_cleanup_push does, but also

   saves the current cancellation type and sets it to deferred

   cancellation.  */

#   define pthread_cleanup_push_defer_np(routine, arg) \

  do {									      \

    __pthread_cleanup_class __clframe (routine, arg);			      \

    __clframe.__defer ()

/* Remove a cleanup handler as pthread_cleanup_pop does, but also

   restores the cancellation type that was in effect when the matching

   pthread_cleanup_push_defer was called.  */

#   define pthread_cleanup_pop_restore_np(execute) \

    __clframe.__restore ();						      \

    __clframe.__setdoit (execute);					      \

  } while (0)

#  endif

# else

/* Function called to call the cleanup handler.  As an extern inline

   function the compiler is free to decide inlining the change when

   needed or fall back on the copy which must exist somewhere

   else.  */

__extern_inline void

__pthread_cleanup_routine (struct __pthread_cleanup_frame *__frame)

{

  if (__frame->__do_it)

    __frame->__cancel_routine (__frame->__cancel_arg);

}

/* Install a cleanup handler: ROUTINE will be called with arguments ARG

   when the thread is canceled or calls pthread_exit.  ROUTINE will also

   be called with arguments ARG when the matching pthread_cleanup_pop

   is executed with non-zero EXECUTE argument.

   pthread_cleanup_push and pthread_cleanup_pop are macros and must always

   be used in matching pairs at the same nesting level of braces.  */

#  define pthread_cleanup_push(routine, arg) \

  do {									      \

    struct __pthread_cleanup_frame __clframe				      \

      __attribute__ ((__cleanup__ (__pthread_cleanup_routine)))		      \

      = { .__cancel_routine = (routine), .__cancel_arg = (arg),	 	      \

	  .__do_it = 1 };

/* Remove a cleanup handler installed by the matching pthread_cleanup_push.

   If EXECUTE is non-zero, the handler function is called. */

#  define pthread_cleanup_pop(execute) \

    __clframe.__do_it = (execute);					      \

  } while (0)

#  ifdef __USE_GNU

/* Install a cleanup handler as pthread_cleanup_push does, but also

   saves the current cancellation type and sets it to deferred

   cancellation.  */

#   define pthread_cleanup_push_defer_np(routine, arg) \

  do {									      \

    struct __pthread_cleanup_frame __clframe				      \

      __attribute__ ((__cleanup__ (__pthread_cleanup_routine)))		      \

      = { .__cancel_routine = (routine), .__cancel_arg = (arg),		      \

	  .__do_it = 1 };						      \

    (void) pthread_setcanceltype (PTHREAD_CANCEL_DEFERRED,		      \

				  &__clframe.__cancel_type)

/* Remove a cleanup handler as pthread_cleanup_pop does, but also

   restores the cancellation type that was in effect when the matching

   pthread_cleanup_push_defer was called.  */

#   define pthread_cleanup_pop_restore_np(execute) \

    (void) pthread_setcanceltype (__clframe.__cancel_type, NULL);	      \

    __clframe.__do_it = (execute);					      \

  } while (0)

#  endif

# endif

#else

/* Install a cleanup handler: ROUTINE will be called with arguments ARG

   when the thread is canceled or calls pthread_exit.  ROUTINE will also

   be called with arguments ARG when the matching pthread_cleanup_pop

   is executed with non-zero EXECUTE argument.

   pthread_cleanup_push and pthread_cleanup_pop are macros and must always

   be used in matching pairs at the same nesting level of braces.  */

# define pthread_cleanup_push(routine, arg) \

  do {									      \

    __pthread_unwind_buf_t __cancel_buf;				      \

    void (*__cancel_routine) (void *) = (routine);			      \

    void *__cancel_arg = (arg);						      \

    int __not_first_call = __sigsetjmp ((struct __jmp_buf_tag *) (void *)     \

					__cancel_buf.__cancel_jmp_buf, 0);    \

    if (__glibc_unlikely (__not_first_call))				      \

      {									      \

	__cancel_routine (__cancel_arg);				      \

	__pthread_unwind_next (&__cancel_buf);				      \

	/* NOTREACHED */						      \

      }									      \

									      \

    __pthread_register_cancel (&__cancel_buf);				      \

    do {

extern void __pthread_register_cancel (__pthread_unwind_buf_t *__buf)

     __cleanup_fct_attribute;

/* Remove a cleanup handler installed by the matching pthread_cleanup_push.

   If EXECUTE is non-zero, the handler function is called. */

# define pthread_cleanup_pop(execute) \

      do { } while (0);/* Empty to allow label before pthread_cleanup_pop.  */\

    } while (0);							      \

    __pthread_unregister_cancel (&__cancel_buf);			      \

    if (execute)							      \

      __cancel_routine (__cancel_arg);					      \

  } while (0)

extern void __pthread_unregister_cancel (__pthread_unwind_buf_t *__buf)

  __cleanup_fct_attribute;

# ifdef __USE_GNU

/* Install a cleanup handler as pthread_cleanup_push does, but also

   saves the current cancellation type and sets it to deferred

   cancellation.  */

#  define pthread_cleanup_push_defer_np(routine, arg) \

  do {									      \

    __pthread_unwind_buf_t __cancel_buf;				      \

    void (*__cancel_routine) (void *) = (routine);			      \

    void *__cancel_arg = (arg);						      \

    int __not_first_call = __sigsetjmp ((struct __jmp_buf_tag *) (void *)     \

					__cancel_buf.__cancel_jmp_buf, 0);    \

    if (__glibc_unlikely (__not_first_call))				      \

      {									      \

	__cancel_routine (__cancel_arg);				      \

	__pthread_unwind_next (&__cancel_buf);				      \

	/* NOTREACHED */						      \

      }									      \

									      \

    __pthread_register_cancel_defer (&__cancel_buf);			      \

    do {

extern void __pthread_register_cancel_defer (__pthread_unwind_buf_t *__buf)

     __cleanup_fct_attribute;

/* Remove a cleanup handler as pthread_cleanup_pop does, but also

   restores the cancellation type that was in effect when the matching

   pthread_cleanup_push_defer was called.  */

#  define pthread_cleanup_pop_restore_np(execute) \

      do { } while (0);/* Empty to allow label before pthread_cleanup_pop.  */\

    } while (0);							      \

    __pthread_unregister_cancel_restore (&__cancel_buf);		      \

    if (execute)							      \

      __cancel_routine (__cancel_arg);					      \

  } while (0)

extern void __pthread_unregister_cancel_restore (__pthread_unwind_buf_t *__buf)

  __cleanup_fct_attribute;

# endif

/* Internal interface to initiate cleanup.  */

extern void __pthread_unwind_next (__pthread_unwind_buf_t *__buf)

     __cleanup_fct_attribute __attribute__ ((__noreturn__))

# ifndef SHARED

     __attribute__ ((__weak__))

# endif

     ;

#endif

/* Function used in the macros.  */

struct __jmp_buf_tag;

extern int __sigsetjmp (struct __jmp_buf_tag *__env, int __savemask) __THROWNL;

/* Mutex handling.  */

/* Initialize a mutex.  */

extern int pthread_mutex_init (pthread_mutex_t *__mutex,

			       const pthread_mutexattr_t *__mutexattr)

     __THROW __nonnull ((1));

/* Destroy a mutex.  */

extern int pthread_mutex_destroy (pthread_mutex_t *__mutex)

     __THROW __nonnull ((1));

/* Try locking a mutex.  */

extern int pthread_mutex_trylock (pthread_mutex_t *__mutex)

     __THROWNL __nonnull ((1));

/* Lock a mutex.  */

extern int pthread_mutex_lock (pthread_mutex_t *__mutex)

     __THROWNL __nonnull ((1));

#ifdef __USE_XOPEN2K

/* Wait until lock becomes available, or specified time passes. */

extern int pthread_mutex_timedlock (pthread_mutex_t *__restrict __mutex,

				    const struct timespec *__restrict

				    __abstime) __THROWNL __nonnull ((1, 2));

#endif

/* Unlock a mutex.  */

extern int pthread_mutex_unlock (pthread_mutex_t *__mutex)

     __THROWNL __nonnull ((1));

/* Get the priority ceiling of MUTEX.  */

extern int pthread_mutex_getprioceiling (const pthread_mutex_t *

					 __restrict __mutex,

					 int *__restrict __prioceiling)

     __THROW __nonnull ((1, 2));

/* Set the priority ceiling of MUTEX to PRIOCEILING, return old

   priority ceiling value in *OLD_CEILING.  */

extern int pthread_mutex_setprioceiling (pthread_mutex_t *__restrict __mutex,

					 int __prioceiling,

					 int *__restrict __old_ceiling)

     __THROW __nonnull ((1, 3));

#ifdef __USE_XOPEN2K8

/* Declare the state protected by MUTEX as consistent.  */

extern int pthread_mutex_consistent (pthread_mutex_t *__mutex)

     __THROW __nonnull ((1));

# ifdef __USE_GNU

extern int pthread_mutex_consistent_np (pthread_mutex_t *__mutex)

     __THROW __nonnull ((1));

# endif

#endif

/* Functions for handling mutex attributes.  */

/* Initialize mutex attribute object ATTR with default attributes

   (kind is PTHREAD_MUTEX_TIMED_NP).  */

extern int pthread_mutexattr_init (pthread_mutexattr_t *__attr)

     __THROW __nonnull ((1));

/* Destroy mutex attribute object ATTR.  */

extern int pthread_mutexattr_destroy (pthread_mutexattr_t *__attr)

     __THROW __nonnull ((1));

/* Get the process-shared flag of the mutex attribute ATTR.  */

extern int pthread_mutexattr_getpshared (const pthread_mutexattr_t *

					 __restrict __attr,

					 int *__restrict __pshared)

     __THROW __nonnull ((1, 2));

/* Set the process-shared flag of the mutex attribute ATTR.  */

extern int pthread_mutexattr_setpshared (pthread_mutexattr_t *__attr,

					 int __pshared)

     __THROW __nonnull ((1));

#if defined __USE_UNIX98 || defined __USE_XOPEN2K8

/* Return in *KIND the mutex kind attribute in *ATTR.  */

extern int pthread_mutexattr_gettype (const pthread_mutexattr_t *__restrict

				      __attr, int *__restrict __kind)

     __THROW __nonnull ((1, 2));

/* Set the mutex kind attribute in *ATTR to KIND (either PTHREAD_MUTEX_NORMAL,

   PTHREAD_MUTEX_RECURSIVE, PTHREAD_MUTEX_ERRORCHECK, or

   PTHREAD_MUTEX_DEFAULT).  */

extern int pthread_mutexattr_settype (pthread_mutexattr_t *__attr, int __kind)

     __THROW __nonnull ((1));

#endif

/* Return in *PROTOCOL the mutex protocol attribute in *ATTR.  */

extern int pthread_mutexattr_getprotocol (const pthread_mutexattr_t *

					  __restrict __attr,

					  int *__restrict __protocol)

     __THROW __nonnull ((1, 2));

/* Set the mutex protocol attribute in *ATTR to PROTOCOL (either

   PTHREAD_PRIO_NONE, PTHREAD_PRIO_INHERIT, or PTHREAD_PRIO_PROTECT).  */

extern int pthread_mutexattr_setprotocol (pthread_mutexattr_t *__attr,

					  int __protocol)

     __THROW __nonnull ((1));

/* Return in *PRIOCEILING the mutex prioceiling attribute in *ATTR.  */

extern int pthread_mutexattr_getprioceiling (const pthread_mutexattr_t *

					     __restrict __attr,

					     int *__restrict __prioceiling)

     __THROW __nonnull ((1, 2));

/* Set the mutex prioceiling attribute in *ATTR to PRIOCEILING.  */

extern int pthread_mutexattr_setprioceiling (pthread_mutexattr_t *__attr,

					     int __prioceiling)

     __THROW __nonnull ((1));

#ifdef __USE_XOPEN2K

/* Get the robustness flag of the mutex attribute ATTR.  */

extern int pthread_mutexattr_getrobust (const pthread_mutexattr_t *__attr,

					int *__robustness)

     __THROW __nonnull ((1, 2));

# ifdef __USE_GNU

extern int pthread_mutexattr_getrobust_np (const pthread_mutexattr_t *__attr,

					   int *__robustness)

     __THROW __nonnull ((1, 2));

# endif

/* Set the robustness flag of the mutex attribute ATTR.  */

extern int pthread_mutexattr_setrobust (pthread_mutexattr_t *__attr,

					int __robustness)

     __THROW __nonnull ((1));

# ifdef __USE_GNU

extern int pthread_mutexattr_setrobust_np (pthread_mutexattr_t *__attr,

					   int __robustness)

     __THROW __nonnull ((1));

# endif