nuttx/nuttx-update
1
2
Fork 1
Code Issues 1 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Add some clarification comments on the mutex api

Browse source
This commit is contained in:
YAMAMOTO Takashi 2024-12-24 10:49:00 +09:00 committed by Xiang Xiao
parent 28937fed4d
commit 958e30b3e2
2 changed files with 30 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
include/nuttx/mutex.h
View file

@ -124,7 +124,7 @@ int nxmutex_destroy(FAR mutex_t *mutex);
* Name: nxmutex_is_hold
*
* Description:
* This function check whether the caller hold the mutex
* This function check whether the calling thread hold the mutex
* referenced by 'mutex'.
*
* Parameters:
@ -141,6 +141,8 @@ bool nxmutex_is_hold(FAR mutex_t *mutex);
*
* Description:
* This function get the holder of the mutex referenced by 'mutex'.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* mutex - mutex descriptor.
@ -156,6 +158,8 @@ int nxmutex_get_holder(FAR mutex_t *mutex);
*
* Description:
* This function get the lock state the mutex referenced by 'mutex'.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* mutex - mutex descriptor.
@ -444,7 +448,7 @@ int nxrmutex_destroy(FAR rmutex_t *rmutex);
* Name: nxrmutex_is_hold
*
* Description:
* This function check whether the caller hold the recursive mutex
* This function check whether the calling thread hold the recursive mutex
* referenced by 'rmutex'.
*
* Parameters:
@ -460,7 +464,11 @@ bool nxrmutex_is_hold(FAR rmutex_t *rmutex);
* Name: nxrmutex_is_recursive
*
* Description:
* This function check whether the recursive mutex is recursive
* This function check whether the recursive mutex is currently held
* recursively. That is, whether it's locked more than once by the
* current holder.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* rmutex - Recursive mutex descriptor.
@ -477,6 +485,8 @@ bool nxrmutex_is_recursive(FAR rmutex_t *rmutex);
*
* Description:
* This function get the holder of the mutex referenced by 'mutex'.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* rmutex - Rmutex descriptor.
@ -493,6 +503,8 @@ int nxrmutex_get_holder(FAR rmutex_t *rmutex);
* Description:
* This function get the lock state the recursive mutex
* referenced by 'rmutex'.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* rmutex - Recursive mutex descriptor.

18
libs/libc/misc/lib_mutex.c
View file

@ -165,7 +165,7 @@ int nxmutex_destroy(FAR mutex_t *mutex)
* Name: nxmutex_is_hold
*
* Description:
* This function check whether the caller hold the mutex
* This function check whether the calling thread hold the mutex
* referenced by 'mutex'.
*
* Parameters:
@ -185,6 +185,8 @@ bool nxmutex_is_hold(FAR mutex_t *mutex)
*
* Description:
* This function get the holder of the mutex referenced by 'mutex'.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* mutex - mutex descriptor.
@ -203,6 +205,8 @@ int nxmutex_get_holder(FAR mutex_t *mutex)
*
* Description:
* This function get the lock state the mutex referenced by 'mutex'.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* mutex - mutex descriptor.
@ -645,7 +649,7 @@ int nxrmutex_destroy(FAR rmutex_t *rmutex)
* Name: nxrmutex_is_hold
*
* Description:
* This function check whether the caller hold the recursive mutex
* This function check whether the calling thread hold the recursive mutex
* referenced by 'rmutex'.
*
* Parameters:
@ -664,7 +668,11 @@ bool nxrmutex_is_hold(FAR rmutex_t *rmutex)
* Name: nxrmutex_is_recursive
*
* Description:
* This function check whether the recursive mutex is recursive
* This function check whether the recursive mutex is currently held
* recursively. That is, whether it's locked more than once by the
* current holder.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* rmutex - Recursive mutex descriptor.
@ -684,6 +692,8 @@ bool nxrmutex_is_recursive(FAR rmutex_t *rmutex)
*
* Description:
* This function get the holder of the mutex referenced by 'mutex'.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* rmutex - Rmutex descriptor.
@ -703,6 +713,8 @@ int nxrmutex_get_holder(FAR rmutex_t *rmutex)
* Description:
* This function get the lock state the recursive mutex
* referenced by 'rmutex'.
* Note that this is inherently racy unless the calling thread is
* holding the mutex.
*
* Parameters:
* rmutex - Recursive mutex descriptor.