xref: /linux/tools/perf/util/mutex.c (revision 4f2c0a4acffbec01079c28f839422e64ddeff004)
1e57d8977SPavithra Gurushankar // SPDX-License-Identifier: GPL-2.0
2e57d8977SPavithra Gurushankar #include "mutex.h"
3e57d8977SPavithra Gurushankar 
4e57d8977SPavithra Gurushankar #include "debug.h"
5e57d8977SPavithra Gurushankar #include <linux/string.h>
6e57d8977SPavithra Gurushankar #include <errno.h>
7e57d8977SPavithra Gurushankar 
check_err(const char * fn,int err)8e57d8977SPavithra Gurushankar static void check_err(const char *fn, int err)
9e57d8977SPavithra Gurushankar {
10e57d8977SPavithra Gurushankar 	char sbuf[STRERR_BUFSIZE];
11e57d8977SPavithra Gurushankar 
12e57d8977SPavithra Gurushankar 	if (err == 0)
13e57d8977SPavithra Gurushankar 		return;
14e57d8977SPavithra Gurushankar 
15e57d8977SPavithra Gurushankar 	pr_err("%s error: '%s'\n", fn, str_error_r(err, sbuf, sizeof(sbuf)));
16e57d8977SPavithra Gurushankar }
17e57d8977SPavithra Gurushankar 
18e57d8977SPavithra Gurushankar #define CHECK_ERR(err) check_err(__func__, err)
19e57d8977SPavithra Gurushankar 
__mutex_init(struct mutex * mtx,bool pshared)20e57d8977SPavithra Gurushankar static void __mutex_init(struct mutex *mtx, bool pshared)
21e57d8977SPavithra Gurushankar {
22e57d8977SPavithra Gurushankar 	pthread_mutexattr_t attr;
23e57d8977SPavithra Gurushankar 
24e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_mutexattr_init(&attr));
25e57d8977SPavithra Gurushankar 
26e57d8977SPavithra Gurushankar #ifndef NDEBUG
27e57d8977SPavithra Gurushankar 	/* In normal builds enable error checking, such as recursive usage. */
28e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK));
29e57d8977SPavithra Gurushankar #endif
30e57d8977SPavithra Gurushankar 	if (pshared)
31e57d8977SPavithra Gurushankar 		CHECK_ERR(pthread_mutexattr_setpshared(&attr, PTHREAD_PROCESS_SHARED));
32e57d8977SPavithra Gurushankar 
33e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_mutex_init(&mtx->lock, &attr));
34e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_mutexattr_destroy(&attr));
35e57d8977SPavithra Gurushankar }
36e57d8977SPavithra Gurushankar 
mutex_init(struct mutex * mtx)37e57d8977SPavithra Gurushankar void mutex_init(struct mutex *mtx)
38e57d8977SPavithra Gurushankar {
39e57d8977SPavithra Gurushankar 	__mutex_init(mtx, /*pshared=*/false);
40e57d8977SPavithra Gurushankar }
41e57d8977SPavithra Gurushankar 
mutex_init_pshared(struct mutex * mtx)42e57d8977SPavithra Gurushankar void mutex_init_pshared(struct mutex *mtx)
43e57d8977SPavithra Gurushankar {
44e57d8977SPavithra Gurushankar 	__mutex_init(mtx, /*pshared=*/true);
45e57d8977SPavithra Gurushankar }
46e57d8977SPavithra Gurushankar 
mutex_destroy(struct mutex * mtx)47e57d8977SPavithra Gurushankar void mutex_destroy(struct mutex *mtx)
48e57d8977SPavithra Gurushankar {
49e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_mutex_destroy(&mtx->lock));
50e57d8977SPavithra Gurushankar }
51e57d8977SPavithra Gurushankar 
mutex_lock(struct mutex * mtx)52e57d8977SPavithra Gurushankar void mutex_lock(struct mutex *mtx)
53*bfa339ceSIan Rogers 	NO_THREAD_SAFETY_ANALYSIS
54e57d8977SPavithra Gurushankar {
55e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_mutex_lock(&mtx->lock));
56e57d8977SPavithra Gurushankar }
57e57d8977SPavithra Gurushankar 
mutex_unlock(struct mutex * mtx)58e57d8977SPavithra Gurushankar void mutex_unlock(struct mutex *mtx)
59*bfa339ceSIan Rogers 	NO_THREAD_SAFETY_ANALYSIS
60e57d8977SPavithra Gurushankar {
61e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_mutex_unlock(&mtx->lock));
62e57d8977SPavithra Gurushankar }
63e57d8977SPavithra Gurushankar 
mutex_trylock(struct mutex * mtx)64e57d8977SPavithra Gurushankar bool mutex_trylock(struct mutex *mtx)
65e57d8977SPavithra Gurushankar {
66e57d8977SPavithra Gurushankar 	int ret = pthread_mutex_trylock(&mtx->lock);
67e57d8977SPavithra Gurushankar 
68e57d8977SPavithra Gurushankar 	if (ret == 0)
69e57d8977SPavithra Gurushankar 		return true; /* Lock acquired. */
70e57d8977SPavithra Gurushankar 
71e57d8977SPavithra Gurushankar 	if (ret == EBUSY)
72e57d8977SPavithra Gurushankar 		return false; /* Lock busy. */
73e57d8977SPavithra Gurushankar 
74e57d8977SPavithra Gurushankar 	/* Print error. */
75e57d8977SPavithra Gurushankar 	CHECK_ERR(ret);
76e57d8977SPavithra Gurushankar 	return false;
77e57d8977SPavithra Gurushankar }
78e57d8977SPavithra Gurushankar 
__cond_init(struct cond * cnd,bool pshared)79e57d8977SPavithra Gurushankar static void __cond_init(struct cond *cnd, bool pshared)
80e57d8977SPavithra Gurushankar {
81e57d8977SPavithra Gurushankar 	pthread_condattr_t attr;
82e57d8977SPavithra Gurushankar 
83e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_condattr_init(&attr));
84e57d8977SPavithra Gurushankar 	if (pshared)
85e57d8977SPavithra Gurushankar 		CHECK_ERR(pthread_condattr_setpshared(&attr, PTHREAD_PROCESS_SHARED));
86e57d8977SPavithra Gurushankar 
87e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_cond_init(&cnd->cond, &attr));
88e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_condattr_destroy(&attr));
89e57d8977SPavithra Gurushankar }
90e57d8977SPavithra Gurushankar 
cond_init(struct cond * cnd)91e57d8977SPavithra Gurushankar void cond_init(struct cond *cnd)
92e57d8977SPavithra Gurushankar {
93e57d8977SPavithra Gurushankar 	__cond_init(cnd, /*pshared=*/false);
94e57d8977SPavithra Gurushankar }
95e57d8977SPavithra Gurushankar 
cond_init_pshared(struct cond * cnd)96e57d8977SPavithra Gurushankar void cond_init_pshared(struct cond *cnd)
97e57d8977SPavithra Gurushankar {
98e57d8977SPavithra Gurushankar 	__cond_init(cnd, /*pshared=*/true);
99e57d8977SPavithra Gurushankar }
100e57d8977SPavithra Gurushankar 
cond_destroy(struct cond * cnd)101e57d8977SPavithra Gurushankar void cond_destroy(struct cond *cnd)
102e57d8977SPavithra Gurushankar {
103e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_cond_destroy(&cnd->cond));
104e57d8977SPavithra Gurushankar }
105e57d8977SPavithra Gurushankar 
cond_wait(struct cond * cnd,struct mutex * mtx)106e57d8977SPavithra Gurushankar void cond_wait(struct cond *cnd, struct mutex *mtx)
107e57d8977SPavithra Gurushankar {
108e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_cond_wait(&cnd->cond, &mtx->lock));
109e57d8977SPavithra Gurushankar }
110e57d8977SPavithra Gurushankar 
cond_signal(struct cond * cnd)111e57d8977SPavithra Gurushankar void cond_signal(struct cond *cnd)
112e57d8977SPavithra Gurushankar {
113e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_cond_signal(&cnd->cond));
114e57d8977SPavithra Gurushankar }
115e57d8977SPavithra Gurushankar 
cond_broadcast(struct cond * cnd)116e57d8977SPavithra Gurushankar void cond_broadcast(struct cond *cnd)
117e57d8977SPavithra Gurushankar {
118e57d8977SPavithra Gurushankar 	CHECK_ERR(pthread_cond_broadcast(&cnd->cond));
119e57d8977SPavithra Gurushankar }
120