From 8179e858a948be241b4d669ceaf0ffe7764fd8cc Mon Sep 17 00:00:00 2001 From: Jakob Hasse Date: Fri, 26 Nov 2021 16:21:03 +0800 Subject: [PATCH] docs(pthread): documentation about reader-writer-lock impl --- docs/en/api-reference/system/pthread.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/en/api-reference/system/pthread.rst b/docs/en/api-reference/system/pthread.rst index 1fb69f2e5f..ad50c8e0f3 100644 --- a/docs/en/api-reference/system/pthread.rst +++ b/docs/en/api-reference/system/pthread.rst @@ -98,6 +98,21 @@ Static initializer constant ``PTHREAD_COND_INITIALIZER`` is supported. .. note:: These functions can be called from tasks created using either pthread or FreeRTOS APIs +Read/Write Locks +^^^^^^^^^^^^^^^^ + +* ``pthread_rwlock_init()`` + - The ``attr`` argument is not implemented and is ignored. +* ``pthread_rwlock_destroy()`` +* ``pthread_rwlock_rdlock()`` +* ``pthread_rwlock_wrlock()`` +* ``pthread_rwlock_unlock()`` + +Static initializer constant ``PTHREAD_RWLOCK_INITIALIZER`` is supported. + + +.. note:: These functions can be called from tasks created using either pthread or FreeRTOS APIs. Note also that the current pthread reader-writer-locks implementation is based on the condition variable API. The performance is not optimal when locking only for a minimal amount of time like e.g. accessing a simple variable. In these cases with minimal locking time, a simple mutex might be faster. + Thread-Specific Data ^^^^^^^^^^^^^^^^^^^^