pthread_rwlock_init(3)

pthread_rwlock_init3

Initialize a read/write lock

Usage

#include <pthread.h>

int

pthread_rwlock_init(pthread_rwlock_t *lock, const pthread_rwlockattr_t *attr);

Overview

The pthread_rwlock_init() function is used to initialize a read/write lock, with attributes specified by attr. If attr is NULL, the default read/write lock attributes are used.

The results of calling pthread_rwlock_init() with an already initialized lock are undefined.

Return values

If successful, the pthread_rwlock_init() function will return zero. Otherwise an error number will be returned to indicate the error.

Errors

The pthread_rwlock_init() function will fail if:

[EAGAIN]

The system lacked the necessary resources (other than memory) to initialize the lock.

[ENOMEM]

Insufficient memory exists to initialize the lock.

[EPERM]

The caller does not have sufficient privilege to perform the operation.

The pthread_rwlock_init() function may fail if:

[EBUSY]

The system has detected an attempt to re-initialize the object referenced by lock, a previously initialized but not yet destroyed read/write lock.

[EINVAL]

The value specified by attr is invalid.

Releases

149 releases since Mac OS X 10.2; the text changed 2 times.

  1. 10.2–10.4.11
  2. 10.5–10.11.6
  3. 10.12–26.5

Standards

The pthread_rwlock_init() function is expected to conform to Version 2 of the Single UNIX Specification (“SUSv2”).

History

The pthread_rwlock_init() function first appeared in FreeBSD 3.0.

Bugs

The PTHREAD_PROCESS_SHARED attribute is not supported.

From libpthread 539.100.4 in macOS 26.5. Parsed by carta from the page's mdoc source.