1 /* Copyright (C) 1995-1998 Eric Young ([email protected]) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young ([email protected]). 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 ([email protected]). 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 ([email protected])" 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 ([email protected])" 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 #ifndef OPENSSL_HEADER_THREAD_H 58 #define OPENSSL_HEADER_THREAD_H 59 60 #include <sys/types.h> 61 62 #include <openssl/base.h> 63 64 #if defined(__cplusplus) 65 extern "C" { 66 #endif 67 68 69 // CRYPTO_refcount_t is the type of a reference count. 70 // 71 // Since some platforms use C11 atomics to access this, it should have the 72 // _Atomic qualifier. However, this header is included by C++ programs as well 73 // as C code that might not set -std=c11. So, in practice, it's not possible to 74 // do that. Instead we statically assert that the size and native alignment of 75 // a plain uint32_t and an _Atomic uint32_t are equal in refcount.c. 76 typedef uint32_t CRYPTO_refcount_t; 77 78 79 // Deprecated functions. 80 // 81 // Historically, OpenSSL required callers to provide locking callbacks. 82 // BoringSSL is thread-safe by default, but some old code calls these functions 83 // and so no-op implementations are provided. 84 85 // These defines do nothing but are provided to make old code easier to 86 // compile. 87 #define CRYPTO_LOCK 1 88 #define CRYPTO_UNLOCK 2 89 #define CRYPTO_READ 4 90 #define CRYPTO_WRITE 8 91 92 // CRYPTO_num_locks returns one. (This is non-zero that callers who allocate 93 // sizeof(lock) times this value don't get zero and then fail because malloc(0) 94 // returned NULL.) 95 OPENSSL_EXPORT int CRYPTO_num_locks(void); 96 97 // CRYPTO_set_locking_callback does nothing. 98 OPENSSL_EXPORT void CRYPTO_set_locking_callback( 99 void (*func)(int mode, int lock_num, const char *file, int line)); 100 101 // CRYPTO_set_add_lock_callback does nothing. 102 OPENSSL_EXPORT void CRYPTO_set_add_lock_callback(int (*func)( 103 int *num, int amount, int lock_num, const char *file, int line)); 104 105 // CRYPTO_get_locking_callback returns NULL. 106 OPENSSL_EXPORT void (*CRYPTO_get_locking_callback(void))(int mode, int lock_num, 107 const char *file, 108 int line); 109 110 // CRYPTO_get_lock_name returns a fixed, dummy string. 111 OPENSSL_EXPORT const char *CRYPTO_get_lock_name(int lock_num); 112 113 // CRYPTO_THREADID_set_callback returns one. 114 OPENSSL_EXPORT int CRYPTO_THREADID_set_callback( 115 void (*threadid_func)(CRYPTO_THREADID *threadid)); 116 117 // CRYPTO_THREADID_set_numeric does nothing. 118 OPENSSL_EXPORT void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id, 119 unsigned long val); 120 121 // CRYPTO_THREADID_set_pointer does nothing. 122 OPENSSL_EXPORT void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr); 123 124 // CRYPTO_THREADID_current does nothing. 125 OPENSSL_EXPORT void CRYPTO_THREADID_current(CRYPTO_THREADID *id); 126 127 // CRYPTO_set_id_callback does nothing. 128 OPENSSL_EXPORT void CRYPTO_set_id_callback(unsigned long (*func)(void)); 129 130 typedef struct { 131 int references; 132 struct CRYPTO_dynlock_value *data; 133 } CRYPTO_dynlock; 134 135 // CRYPTO_set_dynlock_create_callback does nothing. 136 OPENSSL_EXPORT void CRYPTO_set_dynlock_create_callback( 137 struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, 138 int line)); 139 140 // CRYPTO_set_dynlock_lock_callback does nothing. 141 OPENSSL_EXPORT void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)( 142 int mode, struct CRYPTO_dynlock_value *l, const char *file, int line)); 143 144 // CRYPTO_set_dynlock_destroy_callback does nothing. 145 OPENSSL_EXPORT void CRYPTO_set_dynlock_destroy_callback( 146 void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, 147 const char *file, int line)); 148 149 // CRYPTO_get_dynlock_create_callback returns NULL. 150 OPENSSL_EXPORT struct CRYPTO_dynlock_value *( 151 *CRYPTO_get_dynlock_create_callback(void))(const char *file, int line); 152 153 // CRYPTO_get_dynlock_lock_callback returns NULL. 154 OPENSSL_EXPORT void (*CRYPTO_get_dynlock_lock_callback(void))( 155 int mode, struct CRYPTO_dynlock_value *l, const char *file, int line); 156 157 // CRYPTO_get_dynlock_destroy_callback returns NULL. 158 OPENSSL_EXPORT void (*CRYPTO_get_dynlock_destroy_callback(void))( 159 struct CRYPTO_dynlock_value *l, const char *file, int line); 160 161 162 #if defined(__cplusplus) 163 } // extern C 164 #endif 165 166 #endif // OPENSSL_HEADER_THREAD_H 167