5 CRYPTO_THREAD_run_once,
6 CRYPTO_THREAD_lock_new, CRYPTO_THREAD_read_lock, CRYPTO_THREAD_write_lock,
7 CRYPTO_THREAD_unlock, CRYPTO_THREAD_lock_free,
8 CRYPTO_atomic_add, CRYPTO_atomic_or, CRYPTO_atomic_load - OpenSSL thread support
12 #include <openssl/crypto.h>
14 CRYPTO_ONCE CRYPTO_ONCE_STATIC_INIT;
15 int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
17 CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void);
18 int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock);
19 int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock);
20 int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock);
21 void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
23 int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
24 int CRYPTO_atomic_or(uint64_t *val, uint64_t op, uint64_t *ret,
26 int CRYPTO_atomic_load(uint64_t *val, uint64_t *ret, CRYPTO_RWLOCK *lock);
30 OpenSSL can be safely used in multi-threaded applications provided that
31 support for the underlying OS threading API is built-in. Currently, OpenSSL
32 supports the pthread and Windows APIs. OpenSSL can also be built without
33 any multi-threading support, for example on platforms that don't provide
34 any threading support or that provide a threading API that is not yet
37 The following multi-threading function are provided:
43 CRYPTO_THREAD_run_once() can be used to perform one-time initialization.
44 The I<once> argument must be a pointer to a static object of type
45 B<CRYPTO_ONCE> that was statically initialized to the value
46 B<CRYPTO_ONCE_STATIC_INIT>.
47 The I<init> argument is a pointer to a function that performs the desired
48 exactly once initialization.
49 In particular, this can be used to allocate locks in a thread-safe manner,
50 which can then be used with the locking functions below.
54 CRYPTO_THREAD_lock_new() allocates, initializes and returns a new read/write
59 CRYPTO_THREAD_read_lock() locks the provided I<lock> for reading.
63 CRYPTO_THREAD_write_lock() locks the provided I<lock> for writing.
67 CRYPTO_THREAD_unlock() unlocks the previously locked I<lock>.
71 CRYPTO_THREAD_lock_free() frees the provided I<lock>.
75 CRYPTO_atomic_add() atomically adds I<amount> to I<*val> and returns the
76 result of the operation in I<*ret>. I<lock> will be locked, unless atomic
77 operations are supported on the specific platform. Because of this, if a
78 variable is modified by CRYPTO_atomic_add() then CRYPTO_atomic_add() must
79 be the only way that the variable is modified. If atomic operations are not
80 supported and I<lock> is NULL, then the function will fail.
84 CRYPTO_atomic_or() performs an atomic bitwise or of I<op> and I<*val> and stores
85 the result back in I<*val>. It also returns the result of the operation in
86 I<*ret>. I<lock> will be locked, unless atomic operations are supported on the
87 specific platform. Because of this, if a variable is modified by
88 CRYPTO_atomic_or() or read by CRYPTO_atomic_load() then CRYPTO_atomic_or() must
89 be the only way that the variable is modified. If atomic operations are not
90 supported and I<lock> is NULL, then the function will fail.
94 CRYPTO_atomic_load() atomically loads the contents of I<*val> into I<*ret>.
95 I<lock> will be locked, unless atomic operations are supported on the specific
96 platform. Because of this, if a variable is modified by CRYPTO_atomic_or() or
97 read by CRYPTO_atomic_load() then CRYPTO_atomic_load() must be the only way that
98 the variable is read. If atomic operations are not supported and I<lock> is
99 NULL, then the function will fail.
105 CRYPTO_THREAD_run_once() returns 1 on success, or 0 on error.
107 CRYPTO_THREAD_lock_new() returns the allocated lock, or NULL on error.
109 CRYPTO_THREAD_lock_free() returns no value.
111 The other functions return 1 on success, or 0 on error.
115 On Windows platforms the CRYPTO_THREAD_* types and functions in the
116 openssl/crypto.h header are dependent on some of the types customarily
117 made available by including windows.h. The application developer is
118 likely to require control over when the latter is included, commonly as
119 one of the first included headers. Therefore, it is defined as an
120 application developer's responsibility to include windows.h prior to
121 crypto.h where use of CRYPTO_THREAD_* types and functions is required.
125 You can find out if OpenSSL was configured with thread support:
127 #include <openssl/opensslconf.h>
128 #if defined(OPENSSL_THREADS)
129 /* thread support enabled */
131 /* no thread support */
134 This example safely initializes and uses a lock.
137 # include <windows.h>
139 #include <openssl/crypto.h>
141 static CRYPTO_ONCE once = CRYPTO_ONCE_STATIC_INIT;
142 static CRYPTO_RWLOCK *lock;
144 static void myinit(void)
146 lock = CRYPTO_THREAD_lock_new();
149 static int mylock(void)
151 if (!CRYPTO_THREAD_run_once(&once, void init) || lock == NULL)
153 return CRYPTO_THREAD_write_lock(lock);
156 static int myunlock(void)
158 return CRYPTO_THREAD_unlock(lock);
166 /* Your code here, do not return without releasing the lock! */
173 Finalization of locks is an advanced topic, not covered in this example.
174 This can only be done at process exit or when a dynamically loaded library is
175 no longer in use and is unloaded.
176 The simplest solution is to just "leak" the lock in applications and not
177 repeatedly load/unload shared libraries that allocate locks.
185 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
187 Licensed under the Apache License 2.0 (the "License"). You may not use
188 this file except in compliance with the License. You can obtain a copy
189 in the file LICENSE in the source distribution or at
190 L<https://www.openssl.org/source/license.html>.