linux/tools/perf/util/mutex.c
Ian Rogers bfa339ceda perf mutex: Add thread safety annotations
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 <irogers@google.com>
Reviewed-by: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Alexandre Truong <alexandre.truong@arm.com>
Cc: Alexey Bayduraev <alexey.v.bayduraev@linux.intel.com>
Cc: Andi Kleen <ak@linux.intel.com>
Cc: Andres Freund <andres@anarazel.de>
Cc: Andrii Nakryiko <andrii@kernel.org>
Cc: André Almeida <andrealmeid@igalia.com>
Cc: Athira Jajeev <atrajeev@linux.vnet.ibm.com>
Cc: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
Cc: Colin Ian King <colin.king@intel.com>
Cc: Dario Petrillo <dario.pk1@gmail.com>
Cc: Darren Hart <dvhart@infradead.org>
Cc: Dave Marchevsky <davemarchevsky@fb.com>
Cc: Davidlohr Bueso <dave@stgolabs.net>
Cc: Fangrui Song <maskray@google.com>
Cc: Hewenliang <hewenliang4@huawei.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: James Clark <james.clark@arm.com>
Cc: Jason Wang <wangborong@cdjrlc.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Kajol Jain <kjain@linux.ibm.com>
Cc: Kim Phillips <kim.phillips@amd.com>
Cc: Leo Yan <leo.yan@linaro.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Martin Liška <mliska@suse.cz>
Cc: Masami Hiramatsu <mhiramat@kernel.org>
Cc: Nathan Chancellor <nathan@kernel.org>
Cc: Nick Desaulniers <ndesaulniers@google.com>
Cc: Pavithra Gurushankar <gpavithrasha@gmail.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Quentin Monnet <quentin@isovalent.com>
Cc: Ravi Bangoria <ravi.bangoria@amd.com>
Cc: Remi Bernon <rbernon@codeweavers.com>
Cc: Riccardo Mancini <rickyman7@gmail.com>
Cc: Song Liu <songliubraving@fb.com>
Cc: Stephane Eranian <eranian@google.com>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Thomas Richter <tmricht@linux.ibm.com>
Cc: Tom Rix <trix@redhat.com>
Cc: Weiguo Li <liwg06@foxmail.com>
Cc: Wenyu Liu <liuwenyu7@huawei.com>
Cc: William Cohen <wcohen@redhat.com>
Cc: Zechuan Chen <chenzechuan1@huawei.com>
Cc: bpf@vger.kernel.org
Cc: llvm@lists.linux.dev
Cc: yaowenbin <yaowenbin1@huawei.com>
Link: https://lore.kernel.org/r/20220826164242.43412-16-irogers@google.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2022-10-04 08:55:20 -03:00

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));
}