mirror of
https://github.com/torvalds/linux.git
synced 2026-11-20 21:12:43 +00:00
Add thread safety annotations to struct mutex so that when compiled with clang's -Wthread-safety warnings are generated for erroneous lock patterns. NO_THREAD_SAFETY_ANALYSIS is needed for mutex_lock/mutex_unlock as the analysis doesn't under pthread calls. Signed-off-by: Ian Rogers <[email protected]> Reviewed-by: Adrian Hunter <[email protected]> Cc: Alexander Shishkin <[email protected]> Cc: Alexandre Truong <[email protected]> Cc: Alexey Bayduraev <[email protected]> Cc: Andi Kleen <[email protected]> Cc: Andres Freund <[email protected]> Cc: Andrii Nakryiko <[email protected]> Cc: André Almeida <[email protected]> Cc: Athira Jajeev <[email protected]> Cc: Christophe JAILLET <[email protected]> Cc: Colin Ian King <[email protected]> Cc: Dario Petrillo <[email protected]> Cc: Darren Hart <[email protected]> Cc: Dave Marchevsky <[email protected]> Cc: Davidlohr Bueso <[email protected]> Cc: Fangrui Song <[email protected]> Cc: Hewenliang <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: James Clark <[email protected]> Cc: Jason Wang <[email protected]> Cc: Jiri Olsa <[email protected]> Cc: Kajol Jain <[email protected]> Cc: Kim Phillips <[email protected]> Cc: Leo Yan <[email protected]> Cc: Mark Rutland <[email protected]> Cc: Martin Liška <[email protected]> Cc: Masami Hiramatsu <[email protected]> Cc: Nathan Chancellor <[email protected]> Cc: Nick Desaulniers <[email protected]> Cc: Pavithra Gurushankar <[email protected]> Cc: Peter Zijlstra <[email protected]> Cc: Quentin Monnet <[email protected]> Cc: Ravi Bangoria <[email protected]> Cc: Remi Bernon <[email protected]> Cc: Riccardo Mancini <[email protected]> Cc: Song Liu <[email protected]> Cc: Stephane Eranian <[email protected]> Cc: Thomas Gleixner <[email protected]> Cc: Thomas Richter <[email protected]> Cc: Tom Rix <[email protected]> Cc: Weiguo Li <[email protected]> Cc: Wenyu Liu <[email protected]> Cc: William Cohen <[email protected]> Cc: Zechuan Chen <[email protected]> Cc: [email protected] Cc: [email protected] Cc: yaowenbin <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Arnaldo Carvalho de Melo <[email protected]>
120 lines
2.4 KiB
C
120 lines
2.4 KiB
C
// SPDX-License-Identifier: GPL-2.0
|
|
#include "mutex.h"
|
|
|
|
#include "debug.h"
|
|
#include <linux/string.h>
|
|
#include <errno.h>
|
|
|
|
static void check_err(const char *fn, int err)
|
|
{
|
|
char sbuf[STRERR_BUFSIZE];
|
|
|
|
if (err == 0)
|
|
return;
|
|
|
|
pr_err("%s error: '%s'\n", fn, str_error_r(err, sbuf, sizeof(sbuf)));
|
|
}
|
|
|
|
#define CHECK_ERR(err) check_err(__func__, err)
|
|
|
|
static void __mutex_init(struct mutex *mtx, bool pshared)
|
|
{
|
|
pthread_mutexattr_t attr;
|
|
|
|
CHECK_ERR(pthread_mutexattr_init(&attr));
|
|
|
|
#ifndef NDEBUG
|
|
/* In normal builds enable error checking, such as recursive usage. */
|
|
CHECK_ERR(pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK));
|
|
#endif
|
|
if (pshared)
|
|
CHECK_ERR(pthread_mutexattr_setpshared(&attr, PTHREAD_PROCESS_SHARED));
|
|
|
|
CHECK_ERR(pthread_mutex_init(&mtx->lock, &attr));
|
|
CHECK_ERR(pthread_mutexattr_destroy(&attr));
|
|
}
|
|
|
|
void mutex_init(struct mutex *mtx)
|
|
{
|
|
__mutex_init(mtx, /*pshared=*/false);
|
|
}
|
|
|
|
void mutex_init_pshared(struct mutex *mtx)
|
|
{
|
|
__mutex_init(mtx, /*pshared=*/true);
|
|
}
|
|
|
|
void mutex_destroy(struct mutex *mtx)
|
|
{
|
|
CHECK_ERR(pthread_mutex_destroy(&mtx->lock));
|
|
}
|
|
|
|
void mutex_lock(struct mutex *mtx)
|
|
NO_THREAD_SAFETY_ANALYSIS
|
|
{
|
|
CHECK_ERR(pthread_mutex_lock(&mtx->lock));
|
|
}
|
|
|
|
void mutex_unlock(struct mutex *mtx)
|
|
NO_THREAD_SAFETY_ANALYSIS
|
|
{
|
|
CHECK_ERR(pthread_mutex_unlock(&mtx->lock));
|
|
}
|
|
|
|
bool mutex_trylock(struct mutex *mtx)
|
|
{
|
|
int ret = pthread_mutex_trylock(&mtx->lock);
|
|
|
|
if (ret == 0)
|
|
return true; /* Lock acquired. */
|
|
|
|
if (ret == EBUSY)
|
|
return false; /* Lock busy. */
|
|
|
|
/* Print error. */
|
|
CHECK_ERR(ret);
|
|
return false;
|
|
}
|
|
|
|
static void __cond_init(struct cond *cnd, bool pshared)
|
|
{
|
|
pthread_condattr_t attr;
|
|
|
|
CHECK_ERR(pthread_condattr_init(&attr));
|
|
if (pshared)
|
|
CHECK_ERR(pthread_condattr_setpshared(&attr, PTHREAD_PROCESS_SHARED));
|
|
|
|
CHECK_ERR(pthread_cond_init(&cnd->cond, &attr));
|
|
CHECK_ERR(pthread_condattr_destroy(&attr));
|
|
}
|
|
|
|
void cond_init(struct cond *cnd)
|
|
{
|
|
__cond_init(cnd, /*pshared=*/false);
|
|
}
|
|
|
|
void cond_init_pshared(struct cond *cnd)
|
|
{
|
|
__cond_init(cnd, /*pshared=*/true);
|
|
}
|
|
|
|
void cond_destroy(struct cond *cnd)
|
|
{
|
|
CHECK_ERR(pthread_cond_destroy(&cnd->cond));
|
|
}
|
|
|
|
void cond_wait(struct cond *cnd, struct mutex *mtx)
|
|
{
|
|
CHECK_ERR(pthread_cond_wait(&cnd->cond, &mtx->lock));
|
|
}
|
|
|
|
void cond_signal(struct cond *cnd)
|
|
{
|
|
CHECK_ERR(pthread_cond_signal(&cnd->cond));
|
|
}
|
|
|
|
void cond_broadcast(struct cond *cnd)
|
|
{
|
|
CHECK_ERR(pthread_cond_broadcast(&cnd->cond));
|
|
}
|