legacy-libs/grpc-cloned/deps/grpc/third_party/boringssl/include/openssl/thread.h

   1 /* 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 #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 #if defined(OPENSSL_NO_THREADS)
  70 typedef struct crypto_mutex_st {
  71   char padding;  // Empty structs have different sizes in C and C++.
  72 } CRYPTO_MUTEX;
  73 #elif defined(OPENSSL_WINDOWS)
  74 // CRYPTO_MUTEX can appear in public header files so we really don't want to
  75 // pull in windows.h. It's statically asserted that this structure is large
  76 // enough to contain a Windows SRWLOCK by thread_win.c.
  77 typedef union crypto_mutex_st {
  78   void *handle;
  79 } CRYPTO_MUTEX;
  80 #elif defined(__MACH__) && defined(__APPLE__)
  81 typedef pthread_rwlock_t CRYPTO_MUTEX;
  82 #else
  83 // It is reasonable to include pthread.h on non-Windows systems, however the
  84 // |pthread_rwlock_t| that we need is hidden under feature flags, and we can't
  85 // ensure that we'll be able to get it. It's statically asserted that this
  86 // structure is large enough to contain a |pthread_rwlock_t| by
  87 // thread_pthread.c.
  88 typedef union crypto_mutex_st {
  89   double alignment;
  90   uint8_t padding[3*sizeof(int) + 5*sizeof(unsigned) + 16 + 8];
  91 } CRYPTO_MUTEX;
  92 #endif
  93
  94 // CRYPTO_refcount_t is the type of a reference count.
  95 //
  96 // Since some platforms use C11 atomics to access this, it should have the
  97 // _Atomic qualifier. However, this header is included by C++ programs as well
  98 // as C code that might not set -std=c11. So, in practice, it's not possible to
  99 // do that. Instead we statically assert that the size and native alignment of
 100 // a plain uint32_t and an _Atomic uint32_t are equal in refcount_c11.c.
 101 typedef uint32_t CRYPTO_refcount_t;
 102
 103
 104 // Deprecated functions.
 105 //
 106 // Historically, OpenSSL required callers to provide locking callbacks.
 107 // BoringSSL is thread-safe by default, but some old code calls these functions
 108 // and so no-op implementations are provided.
 109
 110 // These defines do nothing but are provided to make old code easier to
 111 // compile.
 112 #define CRYPTO_LOCK 1
 113 #define CRYPTO_UNLOCK 2
 114 #define CRYPTO_READ 4
 115 #define CRYPTO_WRITE 8
 116
 117 // CRYPTO_num_locks returns one. (This is non-zero that callers who allocate
 118 // sizeof(lock) times this value don't get zero and then fail because malloc(0)
 119 // returned NULL.)
 120 OPENSSL_EXPORT int CRYPTO_num_locks(void);
 121
 122 // CRYPTO_set_locking_callback does nothing.
 123 OPENSSL_EXPORT void CRYPTO_set_locking_callback(
 124     void (*func)(int mode, int lock_num, const char *file, int line));
 125
 126 // CRYPTO_set_add_lock_callback does nothing.
 127 OPENSSL_EXPORT void CRYPTO_set_add_lock_callback(int (*func)(
 128     int *num, int amount, int lock_num, const char *file, int line));
 129
 130 // CRYPTO_get_locking_callback returns NULL.
 131 OPENSSL_EXPORT void (*CRYPTO_get_locking_callback(void))(int mode, int lock_num,
 132                                                          const char *file,
 133                                                          int line);
 134
 135 // CRYPTO_get_lock_name returns a fixed, dummy string.
 136 OPENSSL_EXPORT const char *CRYPTO_get_lock_name(int lock_num);
 137
 138 // CRYPTO_THREADID_set_callback returns one.
 139 OPENSSL_EXPORT int CRYPTO_THREADID_set_callback(
 140     void (*threadid_func)(CRYPTO_THREADID *threadid));
 141
 142 // CRYPTO_THREADID_set_numeric does nothing.
 143 OPENSSL_EXPORT void CRYPTO_THREADID_set_numeric(CRYPTO_THREADID *id,
 144                                                 unsigned long val);
 145
 146 // CRYPTO_THREADID_set_pointer does nothing.
 147 OPENSSL_EXPORT void CRYPTO_THREADID_set_pointer(CRYPTO_THREADID *id, void *ptr);
 148
 149 // CRYPTO_THREADID_current does nothing.
 150 OPENSSL_EXPORT void CRYPTO_THREADID_current(CRYPTO_THREADID *id);
 151
 152 // CRYPTO_set_id_callback does nothing.
 153 OPENSSL_EXPORT void CRYPTO_set_id_callback(unsigned long (*func)(void));
 154
 155 typedef struct {
 156   int references;
 157   struct CRYPTO_dynlock_value *data;
 158 } CRYPTO_dynlock;
 159
 160 // CRYPTO_set_dynlock_create_callback does nothing.
 161 OPENSSL_EXPORT void CRYPTO_set_dynlock_create_callback(
 162     struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file,
 163                                                         int line));
 164
 165 // CRYPTO_set_dynlock_lock_callback does nothing.
 166 OPENSSL_EXPORT void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(
 167     int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
 168
 169 // CRYPTO_set_dynlock_destroy_callback does nothing.
 170 OPENSSL_EXPORT void CRYPTO_set_dynlock_destroy_callback(
 171     void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l,
 172                                  const char *file, int line));
 173
 174 // CRYPTO_get_dynlock_create_callback returns NULL.
 175 OPENSSL_EXPORT struct CRYPTO_dynlock_value *(
 176     *CRYPTO_get_dynlock_create_callback(void))(const char *file, int line);
 177
 178 // CRYPTO_get_dynlock_lock_callback returns NULL.
 179 OPENSSL_EXPORT void (*CRYPTO_get_dynlock_lock_callback(void))(
 180     int mode, struct CRYPTO_dynlock_value *l, const char *file, int line);
 181
 182 // CRYPTO_get_dynlock_destroy_callback returns NULL.
 183 OPENSSL_EXPORT void (*CRYPTO_get_dynlock_destroy_callback(void))(
 184     struct CRYPTO_dynlock_value *l, const char *file, int line);
 185
 186
 187 #if defined(__cplusplus)
 188 }  // extern C
 189 #endif
 190
 191 #endif  // OPENSSL_HEADER_THREAD_H