/src/openssl30/crypto/threads_pthread.c

Source
/*
 * Copyright 2016-2025 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>

/*
 * The Non-Stop KLT thread model currently seems broken in its rwlock
 * implementation
 * Likewise is there a problem with the glibc implementation on riscv.
 */
#if defined(PTHREAD_RWLOCK_INITIALIZER) && !defined(_KLT_MODEL_) \
    && !defined(__riscv)
#define USE_RWLOCK
#endif

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

    if ((lock = OPENSSL_zalloc(sizeof(pthread_rwlock_t))) == 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 = OPENSSL_zalloc(sizeof(pthread_mutex_t))) == 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_ACQ_REL) && !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;
}
#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: 2025-12-31 06:58

Line	Count	Source
1		/*
2		* Copyright 2016-2025 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		/*
42		* The Non-Stop KLT thread model currently seems broken in its rwlock
43		* implementation
44		* Likewise is there a problem with the glibc implementation on riscv.
45		*/
46		#if defined(PTHREAD_RWLOCK_INITIALIZER) && !defined(_KLT_MODEL_) \
47		&& !defined(__riscv)
48		#define USE_RWLOCK
49		#endif
50
51		CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void)
52	10.3M	{
53	10.3M	#ifdef USE_RWLOCK
54	10.3M	CRYPTO_RWLOCK *lock;
55
56	10.3M	if ((lock = OPENSSL_zalloc(sizeof(pthread_rwlock_t))) == NULL) {
57		/* Don't set error, to avoid recursion blowup. */
58	0	return NULL;
59	0	}
60
61	10.3M	if (pthread_rwlock_init(lock, NULL) != 0) {
62	0	OPENSSL_free(lock);
63	0	return NULL;
64	0	}
65		#else
66		pthread_mutexattr_t attr;
67		CRYPTO_RWLOCK *lock;
68
69		if ((lock = OPENSSL_zalloc(sizeof(pthread_mutex_t))) == NULL) {
70		/* Don't set error, to avoid recursion blowup. */
71		return NULL;
72		}
73
74		/*
75		* We don't use recursive mutexes, but try to catch errors if we do.
76		*/
77		pthread_mutexattr_init(&attr);
78		#if !defined(__TANDEM) && !defined(_SPT_MODEL_)
79		#if !defined(NDEBUG) && !defined(OPENSSL_NO_MUTEX_ERRORCHECK)
80		pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK);
81		#endif
82		#else
83		/* The SPT Thread Library does not define MUTEX attributes. */
84		#endif
85
86		if (pthread_mutex_init(lock, &attr) != 0) {
87		pthread_mutexattr_destroy(&attr);
88		OPENSSL_free(lock);
89		return NULL;
90		}
91
92		pthread_mutexattr_destroy(&attr);
93		#endif
94
95	10.3M	return lock;
96	10.3M	}
97
98		__owur int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock)
99	1.11G	{
100	1.11G	#ifdef USE_RWLOCK
101	1.11G	if (pthread_rwlock_rdlock(lock) != 0)
102	0	return 0;
103		#else
104		if (pthread_mutex_lock(lock) != 0) {
105		assert(errno != EDEADLK && errno != EBUSY);
106		return 0;
107		}
108		#endif
109
110	1.11G	return 1;
111	1.11G	}
112
113		__owur int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock)
114	57.1M	{
115	57.1M	#ifdef USE_RWLOCK
116	57.1M	if (pthread_rwlock_wrlock(lock) != 0)
117	0	return 0;
118		#else
119		if (pthread_mutex_lock(lock) != 0) {
120		assert(errno != EDEADLK && errno != EBUSY);
121		return 0;
122		}
123		#endif
124
125	57.1M	return 1;
126	57.1M	}
127
128		int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock)
129	1.31G	{
130	1.31G	#ifdef USE_RWLOCK
131	1.31G	if (pthread_rwlock_unlock(lock) != 0)
132	0	return 0;
133		#else
134		if (pthread_mutex_unlock(lock) != 0) {
135		assert(errno != EPERM);
136		return 0;
137		}
138		#endif
139
140	1.31G	return 1;
141	1.31G	}
142
143		void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock)
144	10.3M	{
145	10.3M	if (lock == NULL)
146	2.35k	return;
147
148	10.3M	#ifdef USE_RWLOCK
149	10.3M	pthread_rwlock_destroy(lock);
150		#else
151		pthread_mutex_destroy(lock);
152		#endif
153	10.3M	OPENSSL_free(lock);
154
155	10.3M	return;
156	10.3M	}
157
158		int CRYPTO_THREAD_run_once(CRYPTO_ONCE once, void (init)(void))
159	2.67G	{
160	2.67G	if (pthread_once(once, init) != 0)
161	0	return 0;
162
163	2.67G	return 1;
164	2.67G	}
165
166		int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL key, void (cleanup)(void *))
167	333	{
168	333	if (pthread_key_create(key, cleanup) != 0)
169	0	return 0;
170
171	333	return 1;
172	333	}
173
174		void CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL key)
175	2.30G	{
176	2.30G	return pthread_getspecific(*key);
177	2.30G	}
178
179		int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL key, void val)
180	1.78k	{
181	1.78k	if (pthread_setspecific(*key, val) != 0)
182	0	return 0;
183
184	1.78k	return 1;
185	1.78k	}
186
187		int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key)
188	1.38k	{
189	1.38k	if (pthread_key_delete(*key) != 0)
190	0	return 0;
191
192	1.38k	return 1;
193	1.38k	}
194
195		CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void)
196	208k	{
197	208k	return pthread_self();
198	208k	}
199
200		int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b)
201	12.5k	{
202	12.5k	return pthread_equal(a, b);
203	12.5k	}
204
205		int CRYPTO_atomic_add(int val, int amount, int ret, CRYPTO_RWLOCK *lock)
206	11.7M	{
207	11.7M	#if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL) && !defined(BROKEN_CLANG_ATOMICS)
208	11.7M	if (__atomic_is_lock_free(sizeof(*val), val)) {
209	11.7M	*ret = __atomic_add_fetch(val, amount, __ATOMIC_ACQ_REL);
210	11.7M	return 1;
211	11.7M	}
212		#elif defined(__sun) && (defined(__SunOS_5_10) \|\| defined(__SunOS_5_11))
213		/* This will work for all future Solaris versions. */
214		if (ret != NULL) {
215		ret = atomic_add_int_nv((volatile unsigned int )val, amount);
216		return 1;
217		}
218		#endif
219	0	if (lock == NULL \|\| !CRYPTO_THREAD_write_lock(lock))
220	0	return 0;
221
222	0	*val += amount;
223	0	ret = val;
224
225	0	if (!CRYPTO_THREAD_unlock(lock))
226	0	return 0;
227
228	0	return 1;
229	0	}
230
231		int CRYPTO_atomic_or(uint64_t val, uint64_t op, uint64_t ret,
232		CRYPTO_RWLOCK *lock)
233	712	{
234	712	#if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL) && !defined(BROKEN_CLANG_ATOMICS)
235	712	if (__atomic_is_lock_free(sizeof(*val), val)) {
236	712	*ret = __atomic_or_fetch(val, op, __ATOMIC_ACQ_REL);
237	712	return 1;
238	712	}
239		#elif defined(__sun) && (defined(__SunOS_5_10) \|\| defined(__SunOS_5_11))
240		/* This will work for all future Solaris versions. */
241		if (ret != NULL) {
242		*ret = atomic_or_64_nv(val, op);
243		return 1;
244		}
245		#endif
246	0	if (lock == NULL \|\| !CRYPTO_THREAD_write_lock(lock))
247	0	return 0;
248	0	*val \|= op;
249	0	ret = val;
250
251	0	if (!CRYPTO_THREAD_unlock(lock))
252	0	return 0;
253
254	0	return 1;
255	0	}
256
257		int CRYPTO_atomic_load(uint64_t val, uint64_t ret, CRYPTO_RWLOCK *lock)
258	3.12G	{
259	3.12G	#if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL) && !defined(BROKEN_CLANG_ATOMICS)
260	3.12G	if (__atomic_is_lock_free(sizeof(*val), val)) {
261	3.12G	__atomic_load(val, ret, __ATOMIC_ACQUIRE);
262	3.12G	return 1;
263	3.12G	}
264		#elif defined(__sun) && (defined(__SunOS_5_10) \|\| defined(__SunOS_5_11))
265		/* This will work for all future Solaris versions. */
266		if (ret != NULL) {
267		*ret = atomic_or_64_nv(val, 0);
268		return 1;
269		}
270		#endif
271	0	if (lock == NULL \|\| !CRYPTO_THREAD_read_lock(lock))
272	0	return 0;
273	0	ret = val;
274	0	if (!CRYPTO_THREAD_unlock(lock))
275	0	return 0;
276
277	0	return 1;
278	0	}
279		#ifndef FIPS_MODULE
280		int openssl_init_fork_handlers(void)
281	0	{
282	0	return 1;
283	0	}
284		#endif /* FIPS_MODULE */
285
286		int openssl_get_fork_id(void)
287	116k	{
288	116k	return getpid();
289	116k	}
290		#endif