PTHREAD.H(7) Miscellaneous Information Manual PTHREAD.H(7)

pthread.h — threads


#include <pthread.h>

The <pthread.h> header shall define the following symbols:

[BAR] PTHREAD_BARRIER_SERIAL_THREAD PTHREAD_CANCEL_ASYNCHRONOUS PTHREAD_CANCEL_ENABLE PTHREAD_CANCEL_DEFERRED PTHREAD_CANCEL_DISABLE PTHREAD_CANCELED PTHREAD_COND_INITIALIZER PTHREAD_CREATE_DETACHED PTHREAD_CREATE_JOINABLE PTHREAD_EXPLICIT_SCHED PTHREAD_INHERIT_SCHED [XSI] PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_ERRORCHECK PTHREAD_MUTEX_INITIALIZER [XSI] PTHREAD_MUTEX_NORMAL PTHREAD_MUTEX_RECURSIVE PTHREAD_ONCE_INIT PTHREAD_PRIO_INHERIT PTHREAD_PRIO_NONE PTHREAD_PRIO_PROTECT PTHREAD_PROCESS_SHARED PTHREAD_PROCESS_PRIVATE PTHREAD_SCOPE_PROCESS PTHREAD_SCOPE_SYSTEM

The following types shall be defined as described in <sys/types.h> :

[BAR]

The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.

int   pthread_atfork(void (*)(void), void (*)(void),
          void(*)(void));
int   pthread_attr_destroy(pthread_attr_t *);
int   pthread_attr_getdetachstate(const pthread_attr_t *, int *);
[XSI]
int   pthread_attr_getguardsize(const pthread_attr_t *restrict,
          size_t *restrict);

[TPS]
int   pthread_attr_getinheritsched(const pthread_attr_t *restrict,
          int *restrict);

int   pthread_attr_getschedparam(const pthread_attr_t *restrict,
          struct sched_param *restrict);
[TPS]
int   pthread_attr_getschedpolicy(const pthread_attr_t *restrict,
          int *restrict);

[TPS]
int   pthread_attr_getscope(const pthread_attr_t *restrict,
          int *restrict);

[TSA TSS]
int   pthread_attr_getstack(const pthread_attr_t *restrict,
          void **restrict, size_t *restrict);

[TSA]
int   pthread_attr_getstackaddr(const pthread_attr_t *restrict,
          void **restrict);

[TSS]
int   pthread_attr_getstacksize(const pthread_attr_t *restrict,
          size_t *restrict);

int   pthread_attr_init(pthread_attr_t *);
int   pthread_attr_setdetachstate(pthread_attr_t *, int);
[XSI]
int   pthread_attr_setguardsize(pthread_attr_t *, size_t);

[TPS]
int   pthread_attr_setinheritsched(pthread_attr_t *, int);

int   pthread_attr_setschedparam(pthread_attr_t *restrict,
          const struct sched_param *restrict);
[TPS]
int   pthread_attr_setschedpolicy(pthread_attr_t *, int);
int   pthread_attr_setscope(pthread_attr_t *, int);

[TSA TSS]
int   pthread_attr_setstack(pthread_attr_t *, void *, size_t);

[TSA]
int   pthread_attr_setstackaddr(pthread_attr_t *, void *);

[TSS]
int   pthread_attr_setstacksize(pthread_attr_t *, size_t);

[BAR]
int   pthread_barrier_destroy(pthread_barrier_t *);
int   pthread_barrier_init(pthread_barrier_t *restrict,
          const pthread_barrierattr_t *restrict, unsigned);
int   pthread_barrier_wait(pthread_barrier_t *);
int   pthread_barrierattr_destroy(pthread_barrierattr_t *);

[BAR TSH]
int   pthread_barrierattr_getpshared(
          const pthread_barrierattr_t *restrict, int *restrict);

[BAR]
int   pthread_barrierattr_init(pthread_barrierattr_t *);

[BAR TSH]
int   pthread_barrierattr_setpshared(pthread_barrierattr_t *, int);

int   pthread_cancel(pthread_t);
void  pthread_cleanup_push(void (*)(void *), void *);
void  pthread_cleanup_pop(int);
int   pthread_cond_broadcast(pthread_cond_t *);
int   pthread_cond_destroy(pthread_cond_t *);
int   pthread_cond_init(pthread_cond_t *restrict,
          const pthread_condattr_t *restrict);
int   pthread_cond_signal(pthread_cond_t *);
int   pthread_cond_timedwait(pthread_cond_t *restrict,
          pthread_mutex_t *restrict, const struct timespec *restrict);
int   pthread_cond_wait(pthread_cond_t *restrict,
          pthread_mutex_t *restrict);
int   pthread_condattr_destroy(pthread_condattr_t *);
[CS]
int   pthread_condattr_getclock(const pthread_condattr_t *restrict,
          clockid_t *restrict);

[TSH]
int   pthread_condattr_getpshared(const pthread_condattr_t *restrict,
          int *restrict);

int   pthread_condattr_init(pthread_condattr_t *);
[CS]
int   pthread_condattr_setclock(pthread_condattr_t *, clockid_t);

[TSH]
int   pthread_condattr_setpshared(pthread_condattr_t *, int);

int   pthread_create(pthread_t *restrict, const pthread_attr_t *restrict,
          void *(*)(void *), void *restrict);
int   pthread_detach(pthread_t);
int   pthread_equal(pthread_t, pthread_t);
void  pthread_exit(void *);
[XSI]
int   pthread_getconcurrency(void);

[TCT]
int   pthread_getcpuclockid(pthread_t, clockid_t *);

[TPS]
int   pthread_getschedparam(pthread_t, int *restrict,
          struct sched_param *restrict);

void *pthread_getspecific(pthread_key_t);
int   pthread_join(pthread_t, void **);
int   pthread_key_create(pthread_key_t *, void (*)(void *));
int   pthread_key_delete(pthread_key_t);
int   pthread_mutex_destroy(pthread_mutex_t *);
[TPP]
int   pthread_mutex_getprioceiling(const pthread_mutex_t *restrict,
          int *restrict);

int   pthread_mutex_init(pthread_mutex_t *restrict,
          const pthread_mutexattr_t *restrict);
int   pthread_mutex_lock(pthread_mutex_t *);
[TPP]
int   pthread_mutex_setprioceiling(pthread_mutex_t *restrict, int,
          int *restrict);

[TMO]
int   pthread_mutex_timedlock(pthread_mutex_t *,
          const struct timespec *);

int   pthread_mutex_trylock(pthread_mutex_t *);
int   pthread_mutex_unlock(pthread_mutex_t *);
int   pthread_mutexattr_destroy(pthread_mutexattr_t *);
[TPP]
int   pthread_mutexattr_getprioceiling(
          const pthread_mutexattr_t *restrict, int *restrict);

[TPP|TPI]
int   pthread_mutexattr_getprotocol(const pthread_mutexattr_t *restrict,
          int *restrict);

[TSH]
int   pthread_mutexattr_getpshared(const pthread_mutexattr_t *restrict,
          int *restrict);

[XSI]
int   pthread_mutexattr_gettype(const pthread_mutexattr_t *restrict,
          int *restrict);

int   pthread_mutexattr_init(pthread_mutexattr_t *);
[TPP]
int   pthread_mutexattr_setprioceiling(pthread_mutexattr_t *, int);

[TPP|TPI]
int   pthread_mutexattr_setprotocol(pthread_mutexattr_t *, int);

[TSH]
int   pthread_mutexattr_setpshared(pthread_mutexattr_t *, int);

[XSI]
int   pthread_mutexattr_settype(pthread_mutexattr_t *, int);

int   pthread_once(pthread_once_t *, void (*)(void));
int   pthread_rwlock_destroy(pthread_rwlock_t *);
int   pthread_rwlock_init(pthread_rwlock_t *restrict,
          const pthread_rwlockattr_t *restrict);
int   pthread_rwlock_rdlock(pthread_rwlock_t *);
[TMO]
int   pthread_rwlock_timedrdlock(pthread_rwlock_t *restrict,
          const struct timespec *restrict);
int   pthread_rwlock_timedwrlock(pthread_rwlock_t *restrict,
          const struct timespec *restrict);

int   pthread_rwlock_tryrdlock(pthread_rwlock_t *);
int   pthread_rwlock_trywrlock(pthread_rwlock_t *);
int   pthread_rwlock_unlock(pthread_rwlock_t *);
int   pthread_rwlock_wrlock(pthread_rwlock_t *);
int   pthread_rwlockattr_destroy(pthread_rwlockattr_t *);
[TSH]
int   pthread_rwlockattr_getpshared(
          const pthread_rwlockattr_t *restrict, int *restrict);

int   pthread_rwlockattr_init(pthread_rwlockattr_t *);
[TSH]
int   pthread_rwlockattr_setpshared(pthread_rwlockattr_t *, int);

pthread_t
      pthread_self(void);
int   pthread_setcancelstate(int, int *);
int   pthread_setcanceltype(int, int *);
[XSI]
int   pthread_setconcurrency(int);

[TPS]
int   pthread_setschedparam(pthread_t, int,
          const struct sched_param *);

[TPS]
int   pthread_setschedprio(pthread_t, int);

int   pthread_setspecific(pthread_key_t, const void *);
[SPI]
int   pthread_spin_destroy(pthread_spinlock_t *);
int   pthread_spin_init(pthread_spinlock_t *, int);
int   pthread_spin_lock(pthread_spinlock_t *);
int   pthread_spin_trylock(pthread_spinlock_t *);
int   pthread_spin_unlock(pthread_spinlock_t *);

void  pthread_testcancel(void);

Inclusion of the <pthread.h> header shall make symbols defined in the headers <sched.h> and <time.h> visible.

None.

None.

None.

<sched.h>, <sys/types.h>, <time.h>, the System Interfaces volume of IEEE Std 1003.1-2001 (“POSIX.1”), pthread_attr_getguardsize(3), pthread_attr_init(3), pthread_attr_setscope(3), pthread_barrier_destroy(3), pthread_barrier_init(3), pthread_barrier_wait(3), pthread_barrierattr_destroy(3), pthread_barrierattr_getpshared(3), pthread_barrierattr_init(3), pthread_barrierattr_setpshared(3), pthread_cancel(3), pthread_cleanup_pop(3), pthread_cond_init(3), pthread_cond_signal(3), pthread_cond_wait(3), pthread_condattr_getclock(3), pthread_condattr_init(3), pthread_condattr_setclock(3), pthread_create(3), pthread_detach(3), pthread_equal(3), pthread_exit(3), pthread_getconcurrency(3), pthread_getcpuclockid(3), pthread_getschedparam(3), pthread_join(3), pthread_key_create(3), pthread_key_delete(3), pthread_mutex_init(3), pthread_mutex_lock(3), pthread_mutex_setprioceiling(3), pthread_mutex_timedlock(3), pthread_mutexattr_init(3), pthread_mutexattr_gettype(3), pthread_mutexattr_setprotocol(3), pthread_once(3), pthread_rwlock_destroy(3), pthread_rwlock_init(3), pthread_rwlock_rdlock(3), pthread_rwlock_timedrdlock(3), pthread_rwlock_timedwrlock(3), pthread_rwlock_tryrdlock(3), pthread_rwlock_trywrlock(3), pthread_rwlock_unlock(3), pthread_rwlock_wrlock(3), pthread_rwlockattr_destroy(3), pthread_rwlockattr_getpshared(3), pthread_rwlockattr_init(3), pthread_rwlockattr_setpshared(3), pthread_self(3), pthread_setcancelstate(3), pthread_setspecific(3), pthread_spin_destroy(3), pthread_spin_init(3), pthread_spin_lock(3), pthread_spin_trylock(3), pthread_spin_unlock(3)

First released in Issue 5. Included for alignment with the POSIX Threads Extension.

The RTT margin markers are broken out into their POSIX options.

The Open Group Corrigendum U021/9 is applied, correcting the prototype for the pthread_cond_wait(3) function.

The Open Group Corrigendum U026/2 is applied, correcting the prototype for the pthread_setschedparam(3) function so that its second argument is of type .

The pthread_getcpuclockid(3) and pthread_mutex_timedlock(3) functions are added for alignment with IEEE Std 1003.1d-1999.

The following functions are added for alignment with IEEE Std 1003.1j-2000: pthread_barrier_destroy(3), pthread_barrier_init(3), pthread_barrier_wait(3), pthread_barrierattr_destroy(3), pthread_barrierattr_getpshared(3), pthread_barrierattr_init(3), pthread_barrierattr_setpshared(3), pthread_condattr_getclock(3), pthread_condattr_setclock(3), pthread_rwlock_timedrdlock(3), pthread_rwlock_timedwrlock(3), pthread_spin_destroy(3), pthread_spin_init(3), pthread_spin_lock(3), pthread_spin_trylock(3), and pthread_spin_unlock(3).

PTHREAD_RWLOCK_INITIALIZER is deleted for alignment with IEEE Std 1003.1j-2000.

Functions previously marked as part of the Read-Write Locks option are now moved to the Threads option.

The keyword is added to the prototypes for pthread_attr_getguardsize(3), pthread_attr_getinheritsched(3), pthread_attr_getschedparam(3), pthread_attr_getschedpolicy(3), pthread_attr_getscope(3), pthread_attr_getstackaddr(3), pthread_attr_getstacksize(3), pthread_attr_setschedparam(3), pthread_barrier_init(3), pthread_barrierattr_getpshared(3), pthread_cond_init(3), pthread_cond_signal(3), pthread_cond_timedwait(3), pthread_cond_wait(3), pthread_condattr_getclock(3), pthread_condattr_getpshared(3), pthread_create(3), pthread_getschedparam(3), pthread_mutex_getprioceiling(3), pthread_mutex_init(3), pthread_mutex_setprioceiling(3), pthread_mutexattr_getprioceiling(3), pthread_mutexattr_getprotocol(3), pthread_mutexattr_getpshared(3), pthread_mutexattr_gettype(3), pthread_rwlock_init(3), pthread_rwlock_timedrdlock(3), pthread_rwlock_timedwrlock(3), pthread_rwlockattr_getpshared(3), and pthread_sigmask(3).

IEEE PASC Interpretation 1003.1 #86 is applied, allowing the symbols from <sched.h> and <time.h> to be made visible when <pthread.h> is included. Previously this was an XSI extension.

IEEE PASC Interpretation 1003.1c #42 is applied, removing the requirement for prototypes for the pthread_kill(3) and pthread_sigmask(3) functions. These are required to be in the <signal.h> header. They are allowed here through the name space rules.

IEEE PASC Interpretation 1003.1 #96 is applied, adding the pthread_setschedprio(3) function.

IEEE Std 1003.1-2001 (“POSIX.1”)/Cor 1-2002, item XBD/TC1/D6/13 is applied, correcting shading errors that were in contradiction with the System Interfaces volume of IEEE Std 1003.1-2001 (“POSIX.1”).

footer end

January 1, 2004 posix.fail