thread.h 8.4 KB

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