pthread_rwlock_rdlock()--Get Shared Read Lock


  Syntax:
 #include <pthread.h>
 int pthread_rwlock_rdlock(pthread_rwlock_t *rwlock);   
  Service Program Name: QP0WPTHR

  Default Public Authority: *USE

  Threadsafe: Yes

  Signal Safe: Yes

The pthread_rwlock_rdlock() function attempts to acquire a shared read lock on the read/write lock specified by rwlock.

Any number of threads can hold shared read locks on the same read/write lock object. If any thread holds an exclusive write lock on a read/write lock object, no other threads are allowed to hold a shared read or exclusive write lock.

If no threads are holding an exclusive write lock on the read/write lock, the calling thread successfully acquires the shared read lock.

If the calling thread already holds a shared read lock on the read/write lock, another read lock can be successfully acquired by the calling thread. If more than one shared read lock is successfully acquired by a thread on a read/write lock object, that thread is required to successfully call pthread_rwlock_unlock() a matching number of times.

With a large number of readers and relatively few writers, there is the possibility of writer starvation. If threads are waiting for an exclusive write lock on the read/write lock and there are threads that currently hold a shared read lock, the shared read lock request is granted.

If the read/write lock is destroyed while pthread_rwlock_rdlock() is waiting for the shared read lock, the EDESTROYED error is returned.

If a signal is delivered to the thread while it is waiting for the lock, the signal handler (if any) runs, and the thread resumes waiting.


Read/Write Lock Deadlocks

If a thread ends while holding a write lock, the attempt by another thread to acquire a shared read or exclusive write lock will not be successful. In this case, the attempt to acquire the lock will deadlock. If a thread ends while holding a read lock, the system automatically releases the read lock.

For the pthread_rwlock_rdlock() function, the pthreads run-time simulates the deadlock that has occurred in your application. When you are attempting to debug these deadlock scenarios, the CL command WRKJOB, option 20, shows the thread as in a condition wait. Displaying the call stack shows that the function deadlockOnOrphanedRWLock is in the call stack.


Upgrade / Downgrade a Lock

If the calling thread currently holds an exclusive write lock on the read/write lock object, the shared read lock request is granted. After the shared read lock request is granted, the calling thread holds both the shared read and the exclusive write lock for the specified read/write lock object. If the thread calls pthread_rwlock_unlock() while holding one or more shared read locks and one or more exclusive write locks, the exclusive write locks are unlocked first. If more than one outstanding exclusive write lock was held by the thread, a matching number of successful calls to pthread_rwlock_unlock() must be done before all write locks are unlocked. At that time, subsequent calls to pthread_rwlock_unlock() unlock the shared read locks.

This behavior can be used to allow your application to upgrade or downgrade one lock type to another. See Read/write locks can be upgraded/downgraded.


Authorities and Locks

None.


Parameters

rwlock
(Input) The address of the read/write lock

Return Value

0
pthread_rwlock_rdlock() was successful.
value
pthread_rwlock_rdlock() was not successful. value is set to indicate the error condition.

Error Conditions

If pthread_rwlock_rdlock() was not successful, the error condition returned usually indicates one of the following errors. Under some conditions, the value returned could indicate an error other than those listed here.

[EINVAL]

The value specified for the argument is not correct.

[EDESTROYED]

The lock was destroyed while waiting.


Related Information


Example

See Code disclaimer information for information pertaining to code examples.

See the pthread_rwlock_init() example.


API introduced: V4R3
Top | Pthread APIs | APIs by category