/src/openssl/crypto/threads_pthread.c

Source (jump to first uncovered line)
/*
 * Copyright 2016-2023 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

/* We need to use the OPENSSL_fork_*() deprecated APIs */
#define OPENSSL_SUPPRESS_DEPRECATED

#include <openssl/crypto.h>
#include "internal/cryptlib.h"

#if defined(__sun)
# include <atomic.h>
#endif

#if defined(__apple_build_version__) && __apple_build_version__ < 6000000
/*
 * OS/X 10.7 and 10.8 had a weird version of clang which has __ATOMIC_ACQUIRE and
 * __ATOMIC_ACQ_REL but which expects only one parameter for __atomic_is_lock_free()
 * rather than two which has signature __atomic_is_lock_free(sizeof(_Atomic(T))).
 * All of this makes impossible to use __atomic_is_lock_free here.
 *
 * See: https://github.com/llvm/llvm-project/commit/a4c2602b714e6c6edb98164550a5ae829b2de760
 */
#define BROKEN_CLANG_ATOMICS
#endif

#if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG) && !defined(OPENSSL_SYS_WINDOWS)

# if defined(OPENSSL_SYS_UNIX)
#  include <sys/types.h>
#  include <unistd.h>
#endif

# include <assert.h>

# ifdef PTHREAD_RWLOCK_INITIALIZER
#  define USE_RWLOCK
# endif

CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void)
{
# ifdef USE_RWLOCK
    CRYPTO_RWLOCK *lock;

    if ((lock = CRYPTO_zalloc(sizeof(pthread_rwlock_t), NULL, 0)) == NULL)
        /* Don't set error, to avoid recursion blowup. */
        return NULL;

    if (pthread_rwlock_init(lock, NULL) != 0) {
        OPENSSL_free(lock);
        return NULL;
    }
# else
    pthread_mutexattr_t attr;
    CRYPTO_RWLOCK *lock;

    if ((lock = CRYPTO_zalloc(sizeof(pthread_mutex_t), NULL, 0)) == NULL)
        /* Don't set error, to avoid recursion blowup. */
        return NULL;

    /*
     * We don't use recursive mutexes, but try to catch errors if we do.
     */
    pthread_mutexattr_init(&attr);
#  if !defined (__TANDEM) && !defined (_SPT_MODEL_)
#   if !defined(NDEBUG) && !defined(OPENSSL_NO_MUTEX_ERRORCHECK)
    pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK);
#   endif
#  else
    /* The SPT Thread Library does not define MUTEX attributes. */
#  endif

    if (pthread_mutex_init(lock, &attr) != 0) {
        pthread_mutexattr_destroy(&attr);
        OPENSSL_free(lock);
        return NULL;
    }

    pthread_mutexattr_destroy(&attr);
# endif

    return lock;
}

__owur int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock)
{
# ifdef USE_RWLOCK
    if (pthread_rwlock_rdlock(lock) != 0)
        return 0;
# else
    if (pthread_mutex_lock(lock) != 0) {
        assert(errno != EDEADLK && errno != EBUSY);
        return 0;
    }
# endif

    return 1;
}

__owur int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock)
{
# ifdef USE_RWLOCK
    if (pthread_rwlock_wrlock(lock) != 0)
        return 0;
# else
    if (pthread_mutex_lock(lock) != 0) {
        assert(errno != EDEADLK && errno != EBUSY);
        return 0;
    }
# endif

    return 1;
}

int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock)
{
# ifdef USE_RWLOCK
    if (pthread_rwlock_unlock(lock) != 0)
        return 0;
# else
    if (pthread_mutex_unlock(lock) != 0) {
        assert(errno != EPERM);
        return 0;
    }
# endif

    return 1;
}

void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock)
{
    if (lock == NULL)
        return;

# ifdef USE_RWLOCK
    pthread_rwlock_destroy(lock);
# else
    pthread_mutex_destroy(lock);
# endif
    OPENSSL_free(lock);

    return;
}

int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void))
{
    if (pthread_once(once, init) != 0)
        return 0;

    return 1;
}

int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *))
{
    if (pthread_key_create(key, cleanup) != 0)
        return 0;

    return 1;
}

void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key)
{
    return pthread_getspecific(*key);
}

int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val)
{
    if (pthread_setspecific(*key, val) != 0)
        return 0;

    return 1;
}

int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key)
{
    if (pthread_key_delete(*key) != 0)
        return 0;

    return 1;
}

CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void)
{
    return pthread_self();
}

int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b)
{
    return pthread_equal(a, b);
}

int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock)
{
# if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL) && !defined(BROKEN_CLANG_ATOMICS)
    if (__atomic_is_lock_free(sizeof(*val), val)) {
        *ret = __atomic_add_fetch(val, amount, __ATOMIC_ACQ_REL);
        return 1;
    }
# elif defined(__sun) && (defined(__SunOS_5_10) || defined(__SunOS_5_11))
    /* This will work for all future Solaris versions. */
    if (ret != NULL) {
        *ret = atomic_add_int_nv((volatile unsigned int *)val, amount);
        return 1;
    }
# endif
    if (lock == NULL || !CRYPTO_THREAD_write_lock(lock))
        return 0;

    *val += amount;
    *ret  = *val;

    if (!CRYPTO_THREAD_unlock(lock))
        return 0;

    return 1;
}

int CRYPTO_atomic_or(uint64_t *val, uint64_t op, uint64_t *ret,
                     CRYPTO_RWLOCK *lock)
{
# if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL) && !defined(BROKEN_CLANG_ATOMICS)
    if (__atomic_is_lock_free(sizeof(*val), val)) {
        *ret = __atomic_or_fetch(val, op, __ATOMIC_ACQ_REL);
        return 1;
    }
# elif defined(__sun) && (defined(__SunOS_5_10) || defined(__SunOS_5_11))
    /* This will work for all future Solaris versions. */
    if (ret != NULL) {
        *ret = atomic_or_64_nv(val, op);
        return 1;
    }
# endif
    if (lock == NULL || !CRYPTO_THREAD_write_lock(lock))
        return 0;
    *val |= op;
    *ret  = *val;

    if (!CRYPTO_THREAD_unlock(lock))
        return 0;

    return 1;
}

int CRYPTO_atomic_load(uint64_t *val, uint64_t *ret, CRYPTO_RWLOCK *lock)
{
# if defined(__GNUC__) && defined(__ATOMIC_ACQUIRE) && !defined(BROKEN_CLANG_ATOMICS)
    if (__atomic_is_lock_free(sizeof(*val), val)) {
        __atomic_load(val, ret, __ATOMIC_ACQUIRE);
        return 1;
    }
# elif defined(__sun) && (defined(__SunOS_5_10) || defined(__SunOS_5_11))
    /* This will work for all future Solaris versions. */
    if (ret != NULL) {
        *ret = atomic_or_64_nv(val, 0);
        return 1;
    }
# endif
    if (lock == NULL || !CRYPTO_THREAD_read_lock(lock))
        return 0;
    *ret  = *val;
    if (!CRYPTO_THREAD_unlock(lock))
        return 0;

    return 1;
}

int CRYPTO_atomic_load_int(int *val, int *ret, CRYPTO_RWLOCK *lock)
{
# if defined(__GNUC__) && defined(__ATOMIC_ACQUIRE) && !defined(BROKEN_CLANG_ATOMICS)
    if (__atomic_is_lock_free(sizeof(*val), val)) {
        __atomic_load(val, ret, __ATOMIC_ACQUIRE);
        return 1;
    }
# elif defined(__sun) && (defined(__SunOS_5_10) || defined(__SunOS_5_11))
    /* This will work for all future Solaris versions. */
    if (ret != NULL) {
        *ret = (int *)atomic_or_uint_nv((unsigned int *)val, 0);
        return 1;
    }
# endif
    if (lock == NULL || !CRYPTO_THREAD_read_lock(lock))
        return 0;
    *ret  = *val;
    if (!CRYPTO_THREAD_unlock(lock))
        return 0;

    return 1;
}

# ifndef FIPS_MODULE
int openssl_init_fork_handlers(void)
{
    return 1;
}
# endif /* FIPS_MODULE */

int openssl_get_fork_id(void)
{
    return getpid();
}
#endif

Coverage Report

Created: 2023-09-25 06:41

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2016-2023 The OpenSSL Project Authors. All Rights Reserved.
3		*
4		* Licensed under the Apache License 2.0 (the "License"). You may not use
5		* this file except in compliance with the License. You can obtain a copy
6		* in the file LICENSE in the source distribution or at
7		* https://www.openssl.org/source/license.html
8		*/
9
10		/* We need to use the OPENSSL_fork_() deprecated APIs /
11		#define OPENSSL_SUPPRESS_DEPRECATED
12
13		#include <openssl/crypto.h>
14		#include "internal/cryptlib.h"
15
16		#if defined(__sun)
17		# include <atomic.h>
18		#endif
19
20		#if defined(__apple_build_version__) && __apple_build_version__ < 6000000
21		/*
22		* OS/X 10.7 and 10.8 had a weird version of clang which has __ATOMIC_ACQUIRE and
23		* __ATOMIC_ACQ_REL but which expects only one parameter for __atomic_is_lock_free()
24		* rather than two which has signature __atomic_is_lock_free(sizeof(_Atomic(T))).
25		* All of this makes impossible to use __atomic_is_lock_free here.
26		*
27		* See: https://github.com/llvm/llvm-project/commit/a4c2602b714e6c6edb98164550a5ae829b2de760
28		*/
29		#define BROKEN_CLANG_ATOMICS
30		#endif
31
32		#if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG) && !defined(OPENSSL_SYS_WINDOWS)
33
34		# if defined(OPENSSL_SYS_UNIX)
35		# include <sys/types.h>
36		# include <unistd.h>
37		#endif
38
39		# include <assert.h>
40
41		# ifdef PTHREAD_RWLOCK_INITIALIZER
42		# define USE_RWLOCK
43		# endif
44
45		CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void)
46	49	{
47	49	# ifdef USE_RWLOCK
48	49	CRYPTO_RWLOCK *lock;
49
50	49	if ((lock = CRYPTO_zalloc(sizeof(pthread_rwlock_t), NULL, 0)) == NULL)
51		/* Don't set error, to avoid recursion blowup. */
52	0	return NULL;
53
54	49	if (pthread_rwlock_init(lock, NULL) != 0) {
55	0	OPENSSL_free(lock);
56	0	return NULL;
57	0	}
58		# else
59		pthread_mutexattr_t attr;
60		CRYPTO_RWLOCK *lock;
61
62		if ((lock = CRYPTO_zalloc(sizeof(pthread_mutex_t), NULL, 0)) == NULL)
63		/* Don't set error, to avoid recursion blowup. */
64		return NULL;
65
66		/*
67		* We don't use recursive mutexes, but try to catch errors if we do.
68		*/
69		pthread_mutexattr_init(&attr);
70		# if !defined (__TANDEM) && !defined (_SPT_MODEL_)
71		# if !defined(NDEBUG) && !defined(OPENSSL_NO_MUTEX_ERRORCHECK)
72		pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK);
73		# endif
74		# else
75		/* The SPT Thread Library does not define MUTEX attributes. */
76		# endif
77
78		if (pthread_mutex_init(lock, &attr) != 0) {
79		pthread_mutexattr_destroy(&attr);
80		OPENSSL_free(lock);
81		return NULL;
82		}
83
84		pthread_mutexattr_destroy(&attr);
85		# endif
86
87	49	return lock;
88	49	}
89
90		__owur int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock)
91	121k	{
92	121k	# ifdef USE_RWLOCK
93	121k	if (pthread_rwlock_rdlock(lock) != 0)
94	0	return 0;
95		# else
96		if (pthread_mutex_lock(lock) != 0) {
97		assert(errno != EDEADLK && errno != EBUSY);
98		return 0;
99		}
100		# endif
101
102	121k	return 1;
103	121k	}
104
105		__owur int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock)
106	236	{
107	236	# ifdef USE_RWLOCK
108	236	if (pthread_rwlock_wrlock(lock) != 0)
109	0	return 0;
110		# else
111		if (pthread_mutex_lock(lock) != 0) {
112		assert(errno != EDEADLK && errno != EBUSY);
113		return 0;
114		}
115		# endif
116
117	236	return 1;
118	236	}
119
120		int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock)
121	121k	{
122	121k	# ifdef USE_RWLOCK
123	121k	if (pthread_rwlock_unlock(lock) != 0)
124	0	return 0;
125		# else
126		if (pthread_mutex_unlock(lock) != 0) {
127		assert(errno != EPERM);
128		return 0;
129		}
130		# endif
131
132	121k	return 1;
133	121k	}
134
135		void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock)
136	62	{
137	62	if (lock == NULL)
138	13	return;
139
140	49	# ifdef USE_RWLOCK
141	49	pthread_rwlock_destroy(lock);
142		# else
143		pthread_mutex_destroy(lock);
144		# endif
145	49	OPENSSL_free(lock);
146
147	49	return;
148	62	}
149
150		int CRYPTO_THREAD_run_once(CRYPTO_ONCE once, void (init)(void))
151	305k	{
152	305k	if (pthread_once(once, init) != 0)
153	0	return 0;
154
155	305k	return 1;
156	305k	}
157
158		int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL key, void (cleanup)(void *))
159	12	{
160	12	if (pthread_key_create(key, cleanup) != 0)
161	0	return 0;
162
163	12	return 1;
164	12	}
165
166		void CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL key)
167	197k	{
168	197k	return pthread_getspecific(*key);
169	197k	}
170
171		int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL key, void val)
172	15	{
173	15	if (pthread_setspecific(*key, val) != 0)
174	0	return 0;
175
176	15	return 1;
177	15	}
178
179		int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key)
180	12	{
181	12	if (pthread_key_delete(*key) != 0)
182	0	return 0;
183
184	12	return 1;
185	12	}
186
187		CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void)
188	0	{
189	0	return pthread_self();
190	0	}
191
192		int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b)
193	0	{
194	0	return pthread_equal(a, b);
195	0	}
196
197		int CRYPTO_atomic_add(int val, int amount, int ret, CRYPTO_RWLOCK *lock)
198	0	{
199	0	# if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL) && !defined(BROKEN_CLANG_ATOMICS)
200	0	if (__atomic_is_lock_free(sizeof(*val), val)) {
201	0	*ret = __atomic_add_fetch(val, amount, __ATOMIC_ACQ_REL);
202	0	return 1;
203	0	}
204		# elif defined(__sun) && (defined(__SunOS_5_10) \|\| defined(__SunOS_5_11))
205		/* This will work for all future Solaris versions. */
206		if (ret != NULL) {
207		ret = atomic_add_int_nv((volatile unsigned int )val, amount);
208		return 1;
209		}
210		# endif
211	0	if (lock == NULL \|\| !CRYPTO_THREAD_write_lock(lock))
212	0	return 0;
213
214	0	*val += amount;
215	0	ret = val;
216
217	0	if (!CRYPTO_THREAD_unlock(lock))
218	0	return 0;
219
220	0	return 1;
221	0	}
222
223		int CRYPTO_atomic_or(uint64_t val, uint64_t op, uint64_t ret,
224		CRYPTO_RWLOCK *lock)
225	3	{
226	3	# if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL) && !defined(BROKEN_CLANG_ATOMICS)
227	3	if (__atomic_is_lock_free(sizeof(*val), val)) {
228	3	*ret = __atomic_or_fetch(val, op, __ATOMIC_ACQ_REL);
229	3	return 1;
230	3	}
231		# elif defined(__sun) && (defined(__SunOS_5_10) \|\| defined(__SunOS_5_11))
232		/* This will work for all future Solaris versions. */
233		if (ret != NULL) {
234		*ret = atomic_or_64_nv(val, op);
235		return 1;
236		}
237		# endif
238	0	if (lock == NULL \|\| !CRYPTO_THREAD_write_lock(lock))
239	0	return 0;
240	0	*val \|= op;
241	0	ret = val;
242
243	0	if (!CRYPTO_THREAD_unlock(lock))
244	0	return 0;
245
246	0	return 1;
247	0	}
248
249		int CRYPTO_atomic_load(uint64_t val, uint64_t ret, CRYPTO_RWLOCK *lock)
250	107k	{
251	107k	# if defined(__GNUC__) && defined(__ATOMIC_ACQUIRE) && !defined(BROKEN_CLANG_ATOMICS)
252	107k	if (__atomic_is_lock_free(sizeof(*val), val)) {
253	107k	__atomic_load(val, ret, __ATOMIC_ACQUIRE);
254	107k	return 1;
255	107k	}
256		# elif defined(__sun) && (defined(__SunOS_5_10) \|\| defined(__SunOS_5_11))
257		/* This will work for all future Solaris versions. */
258		if (ret != NULL) {
259		*ret = atomic_or_64_nv(val, 0);
260		return 1;
261		}
262		# endif
263	0	if (lock == NULL \|\| !CRYPTO_THREAD_read_lock(lock))
264	0	return 0;
265	0	ret = val;
266	0	if (!CRYPTO_THREAD_unlock(lock))
267	0	return 0;
268
269	0	return 1;
270	0	}
271
272		int CRYPTO_atomic_load_int(int val, int ret, CRYPTO_RWLOCK *lock)
273	0	{
274	0	# if defined(__GNUC__) && defined(__ATOMIC_ACQUIRE) && !defined(BROKEN_CLANG_ATOMICS)
275	0	if (__atomic_is_lock_free(sizeof(*val), val)) {
276	0	__atomic_load(val, ret, __ATOMIC_ACQUIRE);
277	0	return 1;
278	0	}
279		# elif defined(__sun) && (defined(__SunOS_5_10) \|\| defined(__SunOS_5_11))
280		/* This will work for all future Solaris versions. */
281		if (ret != NULL) {
282		ret = (int )atomic_or_uint_nv((unsigned int *)val, 0);
283		return 1;
284		}
285		# endif
286	0	if (lock == NULL \|\| !CRYPTO_THREAD_read_lock(lock))
287	0	return 0;
288	0	ret = val;
289	0	if (!CRYPTO_THREAD_unlock(lock))
290	0	return 0;
291
292	0	return 1;
293	0	}
294
295		# ifndef FIPS_MODULE
296		int openssl_init_fork_handlers(void)
297	0	{
298	0	return 1;
299	0	}
300		# endif /* FIPS_MODULE */
301
302		int openssl_get_fork_id(void)
303	0	{
304	0	return getpid();
305	0	}
306		#endif