blob: 896cc3ba38afca8c0ea2a3eb7f13e09f2dc6fef8 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
7 *
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14 *
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
21 *
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
51 *
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57/* ====================================================================
58 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
59 *
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
62 * are met:
63 *
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
66 *
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 *
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
81 *
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
85 *
86 * 6. Redistributions of any form whatsoever must retain the following
87 * acknowledgment:
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 *
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
104 *
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com). */
108
109#ifndef OPENSSL_HEADER_CRYPTO_INTERNAL_H
110#define OPENSSL_HEADER_CRYPTO_INTERNAL_H
111
Adam Langley98ad22e2014-08-26 13:38:19 -0700112#include <openssl/ex_data.h>
Adam Langleydf1f5e72015-04-13 11:04:08 -0700113#include <openssl/thread.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700114
Brian Smith7cae9f52016-01-17 20:12:57 -1000115#if defined(_MSC_VER)
116#if !defined(__cplusplus) || _MSC_VER < 1900
117#define alignas(x) __declspec(align(x))
118#define alignof __alignof
119#endif
120#else
121#include <stdalign.h>
122#endif
123
David Benjamin84759bd2016-09-20 17:35:09 -0400124#if !defined(OPENSSL_NO_THREADS) && \
125 (!defined(OPENSSL_WINDOWS) || defined(__MINGW32__))
126#include <pthread.h>
127#define OPENSSL_PTHREADS
128#endif
129
130#if !defined(OPENSSL_NO_THREADS) && !defined(OPENSSL_PTHREADS) && \
131 defined(OPENSSL_WINDOWS)
132#define OPENSSL_WINDOWS_THREADS
David Benjamina353cdb2016-06-09 16:48:33 -0400133OPENSSL_MSVC_PRAGMA(warning(push, 3))
Adam Langleydf1f5e72015-04-13 11:04:08 -0700134#include <windows.h>
David Benjamina353cdb2016-06-09 16:48:33 -0400135OPENSSL_MSVC_PRAGMA(warning(pop))
Adam Langleyd7c5dfb2015-03-16 12:48:56 -0700136#endif
137
Adam Langleyb2cb0ec2014-09-02 14:28:49 -0700138#if defined(__cplusplus)
139extern "C" {
140#endif
141
Adam Langley95c29f32014-06-20 12:00:00 -0700142
Adam Langley3e652652015-01-09 15:44:37 -0800143#if defined(OPENSSL_X86) || defined(OPENSSL_X86_64) || defined(OPENSSL_ARM) || \
Adam Langley4467e592016-09-23 12:47:24 -0700144 defined(OPENSSL_AARCH64) || defined(OPENSSL_PPC64LE)
145/* OPENSSL_cpuid_setup initializes the platform-specific feature cache. */
David Benjamina70c75c2014-09-11 19:11:15 -0400146void OPENSSL_cpuid_setup(void);
147#endif
Adam Langley98ad22e2014-08-26 13:38:19 -0700148
Adam Langleyb15d8132014-11-03 18:51:20 -0800149
David Benjamin647cd022016-01-27 17:26:48 -0500150#if !defined(_MSC_VER) && defined(OPENSSL_64_BIT)
Brian Smith24e42882016-01-26 15:16:37 -1000151typedef __int128_t int128_t;
152typedef __uint128_t uint128_t;
153#endif
154
Steven Valdezcb966542016-08-17 16:56:14 -0400155#define OPENSSL_ARRAY_SIZE(array) (sizeof(array) / sizeof((array)[0]))
Brian Smith24e42882016-01-26 15:16:37 -1000156
David Benjamin1a01e1f2016-06-08 18:31:24 -0400157/* buffers_alias returns one if |a| and |b| alias and zero otherwise. */
158static inline int buffers_alias(const uint8_t *a, size_t a_len,
159 const uint8_t *b, size_t b_len) {
160 /* Cast |a| and |b| to integers. In C, pointer comparisons between unrelated
161 * objects are undefined whereas pointer to integer conversions are merely
162 * implementation-defined. We assume the implementation defined it in a sane
163 * way. */
164 uintptr_t a_u = (uintptr_t)a;
165 uintptr_t b_u = (uintptr_t)b;
166 return a_u + a_len > b_u && b_u + b_len > a_u;
167}
168
169
Adam Langleyb15d8132014-11-03 18:51:20 -0800170/* Constant-time utility functions.
171 *
172 * The following methods return a bitmask of all ones (0xff...f) for true and 0
173 * for false. This is useful for choosing a value based on the result of a
174 * conditional in constant time. For example,
175 *
176 * if (a < b) {
177 * c = a;
178 * } else {
179 * c = b;
180 * }
181 *
182 * can be written as
183 *
184 * unsigned int lt = constant_time_lt(a, b);
Adam Langleya952d962014-11-03 19:15:40 -0800185 * c = constant_time_select(lt, a, b); */
Adam Langleyb15d8132014-11-03 18:51:20 -0800186
187/* constant_time_msb returns the given value with the MSB copied to all the
Adam Langley9ed9dae2014-11-04 11:22:01 -0800188 * other bits. */
Adam Langleyb15d8132014-11-03 18:51:20 -0800189static inline unsigned int constant_time_msb(unsigned int a) {
190 return (unsigned int)((int)(a) >> (sizeof(int) * 8 - 1));
191}
192
193/* constant_time_lt returns 0xff..f if a < b and 0 otherwise. */
194static inline unsigned int constant_time_lt(unsigned int a, unsigned int b) {
Adam Langley9ed9dae2014-11-04 11:22:01 -0800195 /* Consider the two cases of the problem:
196 * msb(a) == msb(b): a < b iff the MSB of a - b is set.
197 * msb(a) != msb(b): a < b iff the MSB of b is set.
198 *
199 * If msb(a) == msb(b) then the following evaluates as:
200 * msb(a^((a^b)|((a-b)^a))) ==
201 * msb(a^((a-b) ^ a)) == (because msb(a^b) == 0)
202 * msb(a^a^(a-b)) == (rearranging)
203 * msb(a-b) (because ∀x. x^x == 0)
204 *
205 * Else, if msb(a) != msb(b) then the following evaluates as:
206 * msb(a^((a^b)|((a-b)^a))) ==
207 * msb(a^(𝟙 | ((a-b)^a))) == (because msb(a^b) == 1 and 𝟙
208 * represents a value s.t. msb(𝟙) = 1)
209 * msb(a^𝟙) == (because ORing with 1 results in 1)
210 * msb(b)
211 *
212 *
213 * Here is an SMT-LIB verification of this formula:
214 *
215 * (define-fun lt ((a (_ BitVec 32)) (b (_ BitVec 32))) (_ BitVec 32)
216 * (bvxor a (bvor (bvxor a b) (bvxor (bvsub a b) a)))
217 * )
218 *
219 * (declare-fun a () (_ BitVec 32))
220 * (declare-fun b () (_ BitVec 32))
221 *
222 * (assert (not (= (= #x00000001 (bvlshr (lt a b) #x0000001f)) (bvult a b))))
223 * (check-sat)
224 * (get-model)
225 */
226 return constant_time_msb(a^((a^b)|((a-b)^a)));
Adam Langleyb15d8132014-11-03 18:51:20 -0800227}
228
229/* constant_time_lt_8 acts like |constant_time_lt| but returns an 8-bit mask. */
230static inline uint8_t constant_time_lt_8(unsigned int a, unsigned int b) {
231 return (uint8_t)(constant_time_lt(a, b));
232}
233
234/* constant_time_gt returns 0xff..f if a >= b and 0 otherwise. */
235static inline unsigned int constant_time_ge(unsigned int a, unsigned int b) {
Adam Langley9ed9dae2014-11-04 11:22:01 -0800236 return ~constant_time_lt(a, b);
Adam Langleyb15d8132014-11-03 18:51:20 -0800237}
238
239/* constant_time_ge_8 acts like |constant_time_ge| but returns an 8-bit mask. */
240static inline uint8_t constant_time_ge_8(unsigned int a, unsigned int b) {
241 return (uint8_t)(constant_time_ge(a, b));
242}
243
244/* constant_time_is_zero returns 0xff..f if a == 0 and 0 otherwise. */
245static inline unsigned int constant_time_is_zero(unsigned int a) {
Adam Langley9ed9dae2014-11-04 11:22:01 -0800246 /* Here is an SMT-LIB verification of this formula:
247 *
248 * (define-fun is_zero ((a (_ BitVec 32))) (_ BitVec 32)
249 * (bvand (bvnot a) (bvsub a #x00000001))
250 * )
251 *
252 * (declare-fun a () (_ BitVec 32))
253 *
254 * (assert (not (= (= #x00000001 (bvlshr (is_zero a) #x0000001f)) (= a #x00000000))))
255 * (check-sat)
256 * (get-model)
257 */
Adam Langleyb15d8132014-11-03 18:51:20 -0800258 return constant_time_msb(~a & (a - 1));
259}
260
261/* constant_time_is_zero_8 acts like constant_time_is_zero but returns an 8-bit
262 * mask. */
263static inline uint8_t constant_time_is_zero_8(unsigned int a) {
264 return (uint8_t)(constant_time_is_zero(a));
265}
266
267/* constant_time_eq returns 0xff..f if a == b and 0 otherwise. */
268static inline unsigned int constant_time_eq(unsigned int a, unsigned int b) {
269 return constant_time_is_zero(a ^ b);
270}
271
Adam Langleyaf6e45b2014-11-03 19:34:49 -0800272/* constant_time_eq_8 acts like |constant_time_eq| but returns an 8-bit mask. */
Adam Langleyb15d8132014-11-03 18:51:20 -0800273static inline uint8_t constant_time_eq_8(unsigned int a, unsigned int b) {
274 return (uint8_t)(constant_time_eq(a, b));
275}
276
Adam Langleyaf6e45b2014-11-03 19:34:49 -0800277/* constant_time_eq_int acts like |constant_time_eq| but works on int values. */
278static inline unsigned int constant_time_eq_int(int a, int b) {
279 return constant_time_eq((unsigned)(a), (unsigned)(b));
280}
281
282/* constant_time_eq_int_8 acts like |constant_time_eq_int| but returns an 8-bit
283 * mask. */
284static inline uint8_t constant_time_eq_int_8(int a, int b) {
285 return constant_time_eq_8((unsigned)(a), (unsigned)(b));
286}
287
Adam Langleya952d962014-11-03 19:15:40 -0800288/* constant_time_select returns (mask & a) | (~mask & b). When |mask| is all 1s
289 * or all 0s (as returned by the methods above), the select methods return
290 * either |a| (if |mask| is nonzero) or |b| (if |mask| is zero). */
291static inline unsigned int constant_time_select(unsigned int mask,
292 unsigned int a, unsigned int b) {
293 return (mask & a) | (~mask & b);
294}
295
296/* constant_time_select_8 acts like |constant_time_select| but operates on
297 * 8-bit values. */
298static inline uint8_t constant_time_select_8(uint8_t mask, uint8_t a,
299 uint8_t b) {
300 return (uint8_t)(constant_time_select(mask, a, b));
301}
302
303/* constant_time_select_int acts like |constant_time_select| but operates on
304 * ints. */
305static inline int constant_time_select_int(unsigned int mask, int a, int b) {
306 return (int)(constant_time_select(mask, (unsigned)(a), (unsigned)(b)));
307}
308
Adam Langleyb15d8132014-11-03 18:51:20 -0800309
Adam Langleyd7c5dfb2015-03-16 12:48:56 -0700310/* Thread-safe initialisation. */
311
Adam Langley65a7e942015-05-07 18:28:27 -0700312#if defined(OPENSSL_NO_THREADS)
313typedef uint32_t CRYPTO_once_t;
314#define CRYPTO_ONCE_INIT 0
David Benjamin84759bd2016-09-20 17:35:09 -0400315#elif defined(OPENSSL_WINDOWS_THREADS)
David Benjamin9dadc3b2016-03-30 19:04:28 -0400316typedef INIT_ONCE CRYPTO_once_t;
317#define CRYPTO_ONCE_INIT INIT_ONCE_STATIC_INIT
David Benjamin84759bd2016-09-20 17:35:09 -0400318#elif defined(OPENSSL_PTHREADS)
Adam Langley65a7e942015-05-07 18:28:27 -0700319typedef pthread_once_t CRYPTO_once_t;
320#define CRYPTO_ONCE_INIT PTHREAD_ONCE_INIT
David Benjamin84759bd2016-09-20 17:35:09 -0400321#else
322#error "Unknown threading library"
Adam Langleyd7c5dfb2015-03-16 12:48:56 -0700323#endif
324
325/* CRYPTO_once calls |init| exactly once per process. This is thread-safe: if
326 * concurrent threads call |CRYPTO_once| with the same |CRYPTO_once_t| argument
327 * then they will block until |init| completes, but |init| will have only been
328 * called once.
329 *
330 * The |once| argument must be a |CRYPTO_once_t| that has been initialised with
331 * the value |CRYPTO_ONCE_INIT|. */
David Benjamin4d787182015-04-02 16:34:42 -0400332OPENSSL_EXPORT void CRYPTO_once(CRYPTO_once_t *once, void (*init)(void));
Adam Langleyd7c5dfb2015-03-16 12:48:56 -0700333
334
Adam Langley6f2e7332015-05-15 12:01:29 -0700335/* Reference counting. */
336
Adam Langley6f2e7332015-05-15 12:01:29 -0700337/* CRYPTO_REFCOUNT_MAX is the value at which the reference count saturates. */
338#define CRYPTO_REFCOUNT_MAX 0xffffffff
339
340/* CRYPTO_refcount_inc atomically increments the value at |*count| unless the
341 * value would overflow. It's safe for multiple threads to concurrently call
342 * this or |CRYPTO_refcount_dec_and_test_zero| on the same
343 * |CRYPTO_refcount_t|. */
344OPENSSL_EXPORT void CRYPTO_refcount_inc(CRYPTO_refcount_t *count);
345
346/* CRYPTO_refcount_dec_and_test_zero tests the value at |*count|:
347 * if it's zero, it crashes the address space.
348 * if it's the maximum value, it returns zero.
349 * otherwise, it atomically decrements it and returns one iff the resulting
350 * value is zero.
351 *
352 * It's safe for multiple threads to concurrently call this or
353 * |CRYPTO_refcount_inc| on the same |CRYPTO_refcount_t|. */
354OPENSSL_EXPORT int CRYPTO_refcount_dec_and_test_zero(CRYPTO_refcount_t *count);
355
356
Adam Langleydf1f5e72015-04-13 11:04:08 -0700357/* Locks.
358 *
359 * Two types of locks are defined: |CRYPTO_MUTEX|, which can be used in
360 * structures as normal, and |struct CRYPTO_STATIC_MUTEX|, which can be used as
361 * a global lock. A global lock must be initialised to the value
362 * |CRYPTO_STATIC_MUTEX_INIT|.
363 *
364 * |CRYPTO_MUTEX| can appear in public structures and so is defined in
David Benjamin156edfe2016-05-24 15:41:11 +0000365 * thread.h as a structure large enough to fit the real type. The global lock is
366 * a different type so it may be initialized with platform initializer macros.*/
Adam Langleydf1f5e72015-04-13 11:04:08 -0700367
Adam Langley65a7e942015-05-07 18:28:27 -0700368#if defined(OPENSSL_NO_THREADS)
David Benjaminc25d2e62016-04-26 18:04:36 -0400369struct CRYPTO_STATIC_MUTEX {
370 char padding; /* Empty structs have different sizes in C and C++. */
371};
David Benjamin992c20a2016-04-28 12:56:35 -0400372#define CRYPTO_STATIC_MUTEX_INIT { 0 }
David Benjamin84759bd2016-09-20 17:35:09 -0400373#elif defined(OPENSSL_WINDOWS_THREADS)
Adam Langleydf1f5e72015-04-13 11:04:08 -0700374struct CRYPTO_STATIC_MUTEX {
David Benjamin156edfe2016-05-24 15:41:11 +0000375 SRWLOCK lock;
Adam Langleydf1f5e72015-04-13 11:04:08 -0700376};
David Benjamin156edfe2016-05-24 15:41:11 +0000377#define CRYPTO_STATIC_MUTEX_INIT { SRWLOCK_INIT }
David Benjamin84759bd2016-09-20 17:35:09 -0400378#elif defined(OPENSSL_PTHREADS)
Adam Langley65a7e942015-05-07 18:28:27 -0700379struct CRYPTO_STATIC_MUTEX {
380 pthread_rwlock_t lock;
381};
382#define CRYPTO_STATIC_MUTEX_INIT { PTHREAD_RWLOCK_INITIALIZER }
David Benjamin84759bd2016-09-20 17:35:09 -0400383#else
384#error "Unknown threading library"
Adam Langleydf1f5e72015-04-13 11:04:08 -0700385#endif
386
387/* CRYPTO_MUTEX_init initialises |lock|. If |lock| is a static variable, use a
388 * |CRYPTO_STATIC_MUTEX|. */
Adam Langley04edcc82015-05-20 13:14:44 -0700389OPENSSL_EXPORT void CRYPTO_MUTEX_init(CRYPTO_MUTEX *lock);
Adam Langleydf1f5e72015-04-13 11:04:08 -0700390
391/* CRYPTO_MUTEX_lock_read locks |lock| such that other threads may also have a
David Benjamin156edfe2016-05-24 15:41:11 +0000392 * read lock, but none may have a write lock. */
Adam Langley04edcc82015-05-20 13:14:44 -0700393OPENSSL_EXPORT void CRYPTO_MUTEX_lock_read(CRYPTO_MUTEX *lock);
Adam Langleydf1f5e72015-04-13 11:04:08 -0700394
395/* CRYPTO_MUTEX_lock_write locks |lock| such that no other thread has any type
396 * of lock on it. */
Adam Langley04edcc82015-05-20 13:14:44 -0700397OPENSSL_EXPORT void CRYPTO_MUTEX_lock_write(CRYPTO_MUTEX *lock);
Adam Langleydf1f5e72015-04-13 11:04:08 -0700398
David Benjamin29270de2016-05-24 15:28:36 +0000399/* CRYPTO_MUTEX_unlock_read unlocks |lock| for reading. */
400OPENSSL_EXPORT void CRYPTO_MUTEX_unlock_read(CRYPTO_MUTEX *lock);
401
402/* CRYPTO_MUTEX_unlock_write unlocks |lock| for writing. */
403OPENSSL_EXPORT void CRYPTO_MUTEX_unlock_write(CRYPTO_MUTEX *lock);
Adam Langleydf1f5e72015-04-13 11:04:08 -0700404
405/* CRYPTO_MUTEX_cleanup releases all resources held by |lock|. */
Adam Langley04edcc82015-05-20 13:14:44 -0700406OPENSSL_EXPORT void CRYPTO_MUTEX_cleanup(CRYPTO_MUTEX *lock);
Adam Langleydf1f5e72015-04-13 11:04:08 -0700407
408/* CRYPTO_STATIC_MUTEX_lock_read locks |lock| such that other threads may also
409 * have a read lock, but none may have a write lock. The |lock| variable does
410 * not need to be initialised by any function, but must have been statically
411 * initialised with |CRYPTO_STATIC_MUTEX_INIT|. */
Adam Langley04edcc82015-05-20 13:14:44 -0700412OPENSSL_EXPORT void CRYPTO_STATIC_MUTEX_lock_read(
413 struct CRYPTO_STATIC_MUTEX *lock);
Adam Langleydf1f5e72015-04-13 11:04:08 -0700414
415/* CRYPTO_STATIC_MUTEX_lock_write locks |lock| such that no other thread has
416 * any type of lock on it. The |lock| variable does not need to be initialised
417 * by any function, but must have been statically initialised with
418 * |CRYPTO_STATIC_MUTEX_INIT|. */
Adam Langley04edcc82015-05-20 13:14:44 -0700419OPENSSL_EXPORT void CRYPTO_STATIC_MUTEX_lock_write(
420 struct CRYPTO_STATIC_MUTEX *lock);
Adam Langleydf1f5e72015-04-13 11:04:08 -0700421
David Benjamin29270de2016-05-24 15:28:36 +0000422/* CRYPTO_STATIC_MUTEX_unlock_read unlocks |lock| for reading. */
423OPENSSL_EXPORT void CRYPTO_STATIC_MUTEX_unlock_read(
424 struct CRYPTO_STATIC_MUTEX *lock);
425
426/* CRYPTO_STATIC_MUTEX_unlock_write unlocks |lock| for writing. */
427OPENSSL_EXPORT void CRYPTO_STATIC_MUTEX_unlock_write(
Adam Langley04edcc82015-05-20 13:14:44 -0700428 struct CRYPTO_STATIC_MUTEX *lock);
Adam Langleydf1f5e72015-04-13 11:04:08 -0700429
430
Adam Langleyd7c5dfb2015-03-16 12:48:56 -0700431/* Thread local storage. */
432
433/* thread_local_data_t enumerates the types of thread-local data that can be
434 * stored. */
435typedef enum {
436 OPENSSL_THREAD_LOCAL_ERR = 0,
Adam Langley310d4dd2015-04-13 11:04:21 -0700437 OPENSSL_THREAD_LOCAL_RAND,
Matt Braithwaitecc2c7aa2015-09-03 14:18:08 -0700438 OPENSSL_THREAD_LOCAL_URANDOM_BUF,
Adam Langleyd7c5dfb2015-03-16 12:48:56 -0700439 OPENSSL_THREAD_LOCAL_TEST,
440 NUM_OPENSSL_THREAD_LOCALS,
441} thread_local_data_t;
442
443/* thread_local_destructor_t is the type of a destructor function that will be
444 * called when a thread exits and its thread-local storage needs to be freed. */
445typedef void (*thread_local_destructor_t)(void *);
446
447/* CRYPTO_get_thread_local gets the pointer value that is stored for the
448 * current thread for the given index, or NULL if none has been set. */
David Benjamin4d787182015-04-02 16:34:42 -0400449OPENSSL_EXPORT void *CRYPTO_get_thread_local(thread_local_data_t value);
Adam Langleyd7c5dfb2015-03-16 12:48:56 -0700450
451/* CRYPTO_set_thread_local sets a pointer value for the current thread at the
452 * given index. This function should only be called once per thread for a given
453 * |index|: rather than update the pointer value itself, update the data that
454 * is pointed to.
455 *
456 * The destructor function will be called when a thread exits to free this
457 * thread-local data. All calls to |CRYPTO_set_thread_local| with the same
458 * |index| should have the same |destructor| argument. The destructor may be
459 * called with a NULL argument if a thread that never set a thread-local
460 * pointer for |index|, exits. The destructor may be called concurrently with
461 * different arguments.
462 *
463 * This function returns one on success or zero on error. If it returns zero
464 * then |destructor| has been called with |value| already. */
David Benjamin4d787182015-04-02 16:34:42 -0400465OPENSSL_EXPORT int CRYPTO_set_thread_local(
466 thread_local_data_t index, void *value,
467 thread_local_destructor_t destructor);
Adam Langleyd7c5dfb2015-03-16 12:48:56 -0700468
469
David Benjamin546f1a52015-04-15 16:46:09 -0400470/* ex_data */
471
David Benjamin9f33fc62015-04-15 17:29:53 -0400472typedef struct crypto_ex_data_func_st CRYPTO_EX_DATA_FUNCS;
473
474/* CRYPTO_EX_DATA_CLASS tracks the ex_indices registered for a type which
475 * supports ex_data. It should defined as a static global within the module
476 * which defines that type. */
477typedef struct {
478 struct CRYPTO_STATIC_MUTEX lock;
479 STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth;
David Benjaminaa585132015-06-29 23:36:17 -0400480 /* num_reserved is one if the ex_data index zero is reserved for legacy
481 * |TYPE_get_app_data| functions. */
482 uint8_t num_reserved;
David Benjamin9f33fc62015-04-15 17:29:53 -0400483} CRYPTO_EX_DATA_CLASS;
484
David Benjaminaa585132015-06-29 23:36:17 -0400485#define CRYPTO_EX_DATA_CLASS_INIT {CRYPTO_STATIC_MUTEX_INIT, NULL, 0}
486#define CRYPTO_EX_DATA_CLASS_INIT_WITH_APP_DATA \
487 {CRYPTO_STATIC_MUTEX_INIT, NULL, 1}
David Benjamin9f33fc62015-04-15 17:29:53 -0400488
489/* CRYPTO_get_ex_new_index allocates a new index for |ex_data_class| and writes
490 * it to |*out_index|. Each class of object should provide a wrapper function
491 * that uses the correct |CRYPTO_EX_DATA_CLASS|. It returns one on success and
492 * zero otherwise. */
493OPENSSL_EXPORT int CRYPTO_get_ex_new_index(CRYPTO_EX_DATA_CLASS *ex_data_class,
494 int *out_index, long argl,
David Benjamin8a589332015-12-04 23:14:35 -0500495 void *argp, CRYPTO_EX_dup *dup_func,
David Benjamin546f1a52015-04-15 16:46:09 -0400496 CRYPTO_EX_free *free_func);
497
David Benjamin9f33fc62015-04-15 17:29:53 -0400498/* CRYPTO_set_ex_data sets an extra data pointer on a given object. Each class
499 * of object should provide a wrapper function. */
David Benjamin546f1a52015-04-15 16:46:09 -0400500OPENSSL_EXPORT int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int index, void *val);
501
David Benjamin9f33fc62015-04-15 17:29:53 -0400502/* CRYPTO_get_ex_data returns an extra data pointer for a given object, or NULL
503 * if no such index exists. Each class of object should provide a wrapper
504 * function. */
David Benjamin546f1a52015-04-15 16:46:09 -0400505OPENSSL_EXPORT void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int index);
506
David Benjamin8a589332015-12-04 23:14:35 -0500507/* CRYPTO_new_ex_data initialises a newly allocated |CRYPTO_EX_DATA|. */
508OPENSSL_EXPORT void CRYPTO_new_ex_data(CRYPTO_EX_DATA *ad);
David Benjamin546f1a52015-04-15 16:46:09 -0400509
510/* CRYPTO_dup_ex_data duplicates |from| into a freshly allocated
511 * |CRYPTO_EX_DATA|, |to|. Both of which are inside objects of the given
512 * class. It returns one on success and zero otherwise. */
David Benjamin9f33fc62015-04-15 17:29:53 -0400513OPENSSL_EXPORT int CRYPTO_dup_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class,
514 CRYPTO_EX_DATA *to,
David Benjamin546f1a52015-04-15 16:46:09 -0400515 const CRYPTO_EX_DATA *from);
516
517/* CRYPTO_free_ex_data frees |ad|, which is embedded inside |obj|, which is an
518 * object of the given class. */
David Benjamin9f33fc62015-04-15 17:29:53 -0400519OPENSSL_EXPORT void CRYPTO_free_ex_data(CRYPTO_EX_DATA_CLASS *ex_data_class,
520 void *obj, CRYPTO_EX_DATA *ad);
David Benjamin546f1a52015-04-15 16:46:09 -0400521
522
Adam Langley95c29f32014-06-20 12:00:00 -0700523#if defined(__cplusplus)
524} /* extern C */
525#endif
526
527#endif /* OPENSSL_HEADER_CRYPTO_INTERNAL_H */