crypto/threads_pthread.c

   1 /*
   2  * Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 /* We need to use the OPENSSL_fork_*() deprecated APIs */
  11 #define OPENSSL_SUPPRESS_DEPRECATED
  12
  13 #include <openssl/crypto.h>
  14 #include "internal/cryptlib.h"
  15
  16 #if defined(__sun)
  17 # include <atomic.h>
  18 #endif
  19
  20 #if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG) && !defined(OPENSSL_SYS_WINDOWS)
  21
  22 # if defined(OPENSSL_SYS_UNIX)
  23 #  include <sys/types.h>
  24 #  include <unistd.h>
  25 #endif
  26
  27 # ifdef PTHREAD_RWLOCK_INITIALIZER
  28 #  define USE_RWLOCK
  29 # endif
  30
  31 CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void)
  32 {
  33 # ifdef USE_RWLOCK
  34     CRYPTO_RWLOCK *lock;
  35
  36     if ((lock = OPENSSL_zalloc(sizeof(pthread_rwlock_t))) == NULL) {
  37         /* Don't set error, to avoid recursion blowup. */
  38         return NULL;
  39     }
  40
  41     if (pthread_rwlock_init(lock, NULL) != 0) {
  42         OPENSSL_free(lock);
  43         return NULL;
  44     }
  45 # else
  46     pthread_mutexattr_t attr;
  47     CRYPTO_RWLOCK *lock;
  48
  49     if ((lock = OPENSSL_zalloc(sizeof(pthread_mutex_t))) == NULL) {
  50         /* Don't set error, to avoid recursion blowup. */
  51         return NULL;
  52     }
  53
  54     pthread_mutexattr_init(&attr);
  55     #if defined(__TANDEM) && defined(_SPT_MODEL_)
  56       pthread_mutexattr_setkind_np(&attr,MUTEX_RECURSIVE_NP);
  57     #else
  58       pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
  59     #endif
  60
  61     if (pthread_mutex_init(lock, &attr) != 0) {
  62         pthread_mutexattr_destroy(&attr);
  63         OPENSSL_free(lock);
  64         return NULL;
  65     }
  66
  67     pthread_mutexattr_destroy(&attr);
  68 # endif
  69
  70     return lock;
  71 }
  72
  73 int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock)
  74 {
  75 # ifdef USE_RWLOCK
  76     if (pthread_rwlock_rdlock(lock) != 0)
  77         return 0;
  78 # else
  79     if (pthread_mutex_lock(lock) != 0)
  80         return 0;
  81 # endif
  82
  83     return 1;
  84 }
  85
  86 int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock)
  87 {
  88 # ifdef USE_RWLOCK
  89     if (pthread_rwlock_wrlock(lock) != 0)
  90         return 0;
  91 # else
  92     if (pthread_mutex_lock(lock) != 0)
  93         return 0;
  94 # endif
  95
  96     return 1;
  97 }
  98
  99 int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock)
 100 {
 101 # ifdef USE_RWLOCK
 102     if (pthread_rwlock_unlock(lock) != 0)
 103         return 0;
 104 # else
 105     if (pthread_mutex_unlock(lock) != 0)
 106         return 0;
 107 # endif
 108
 109     return 1;
 110 }
 111
 112 void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock)
 113 {
 114     if (lock == NULL)
 115         return;
 116
 117 # ifdef USE_RWLOCK
 118     pthread_rwlock_destroy(lock);
 119 # else
 120     pthread_mutex_destroy(lock);
 121 # endif
 122     OPENSSL_free(lock);
 123
 124     return;
 125 }
 126
 127 int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void))
 128 {
 129     if (pthread_once(once, init) != 0)
 130         return 0;
 131
 132     return 1;
 133 }
 134
 135 int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *))
 136 {
 137     if (pthread_key_create(key, cleanup) != 0)
 138         return 0;
 139
 140     return 1;
 141 }
 142
 143 void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key)
 144 {
 145     return pthread_getspecific(*key);
 146 }
 147
 148 int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val)
 149 {
 150     if (pthread_setspecific(*key, val) != 0)
 151         return 0;
 152
 153     return 1;
 154 }
 155
 156 int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key)
 157 {
 158     if (pthread_key_delete(*key) != 0)
 159         return 0;
 160
 161     return 1;
 162 }
 163
 164 CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void)
 165 {
 166     return pthread_self();
 167 }
 168
 169 int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b)
 170 {
 171     return pthread_equal(a, b);
 172 }
 173
 174 int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock)
 175 {
 176 # if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL)
 177     if (__atomic_is_lock_free(sizeof(*val), val)) {
 178         *ret = __atomic_add_fetch(val, amount, __ATOMIC_ACQ_REL);
 179         return 1;
 180     }
 181 # elif defined(__sun) && (defined(__SunOS_5_10) || defined(__SunOS_5_11))
 182     /* This will work for all future Solaris versions. */
 183     if (ret != NULL) {
 184         *ret = atomic_add_int_nv((volatile unsigned int *)val, amount);
 185         return 1;
 186     }
 187 # endif
 188     if (lock == NULL || !CRYPTO_THREAD_write_lock(lock))
 189         return 0;
 190
 191     *val += amount;
 192     *ret  = *val;
 193
 194     if (!CRYPTO_THREAD_unlock(lock))
 195         return 0;
 196
 197     return 1;
 198 }
 199
 200 int CRYPTO_atomic_or(uint64_t *val, uint64_t op, uint64_t *ret,
 201                      CRYPTO_RWLOCK *lock)
 202 {
 203 # if defined(__GNUC__) && defined(__ATOMIC_ACQ_REL)
 204     if (__atomic_is_lock_free(sizeof(*val), val)) {
 205         *ret = __atomic_or_fetch(val, op, __ATOMIC_ACQ_REL);
 206         return 1;
 207     }
 208 # elif defined(__sun) && (defined(__SunOS_5_10) || defined(__SunOS_5_11))
 209     /* This will work for all future Solaris versions. */
 210     if (ret != NULL) {
 211         *ret = atomic_or_64_nv(val, op);
 212         return 1;
 213     }
 214 # endif
 215     if (lock == NULL || !CRYPTO_THREAD_write_lock(lock))
 216         return 0;
 217     *val |= op;
 218     *ret  = *val;
 219
 220     if (!CRYPTO_THREAD_unlock(lock))
 221         return 0;
 222
 223     return 1;
 224 }
 225
 226 int CRYPTO_atomic_load(uint64_t *val, uint64_t *ret, CRYPTO_RWLOCK *lock)
 227 {
 228 # if defined(__GNUC__) && defined(__ATOMIC_ACQUIRE)
 229     if (__atomic_is_lock_free(sizeof(*val), val)) {
 230         __atomic_load(val, ret, __ATOMIC_ACQUIRE);
 231         return 1;
 232     }
 233 # elif defined(__sun) && (defined(__SunOS_5_10) || defined(__SunOS_5_11))
 234     /* This will work for all future Solaris versions. */
 235     if (ret != NULL) {
 236         *ret = atomic_or_64_nv(val, 0);
 237         return 1;
 238     }
 239 # endif
 240     if (lock == NULL || !CRYPTO_THREAD_read_lock(lock))
 241         return 0;
 242     *ret  = *val;
 243     if (!CRYPTO_THREAD_unlock(lock))
 244         return 0;
 245
 246     return 1;
 247 }
 248 # ifndef FIPS_MODULE
 249 #  ifdef OPENSSL_SYS_UNIX
 250
 251 static pthread_once_t fork_once_control = PTHREAD_ONCE_INIT;
 252
 253 static void fork_once_func(void)
 254 {
 255 #   ifndef OPENSSL_NO_DEPRECATED_3_0
 256     pthread_atfork(OPENSSL_fork_prepare,
 257                    OPENSSL_fork_parent, OPENSSL_fork_child);
 258 #   endif
 259 }
 260 #  endif
 261
 262 int openssl_init_fork_handlers(void)
 263 {
 264 #  ifdef OPENSSL_SYS_UNIX
 265     if (pthread_once(&fork_once_control, fork_once_func) == 0)
 266         return 1;
 267 #  endif
 268     return 0;
 269 }
 270 # endif /* FIPS_MODULE */
 271
 272 int openssl_get_fork_id(void)
 273 {
 274     return getpid();
 275 }
 276 #endif