crypto/lock.c

   1 /* ====================================================================
   2  * Copyright (c) 1998-2006 The OpenSSL Project.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * 3. All advertising materials mentioning features or use of this
  17  *    software must display the following acknowledgment:
  18  *    "This product includes software developed by the OpenSSL Project
  19  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  20  *
  21  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  22  *    endorse or promote products derived from this software without
  23  *    prior written permission. For written permission, please contact
  24  *    openssl-core@openssl.org.
  25  *
  26  * 5. Products derived from this software may not be called "OpenSSL"
  27  *    nor may "OpenSSL" appear in their names without prior written
  28  *    permission of the OpenSSL Project.
  29  *
  30  * 6. Redistributions of any form whatsoever must retain the following
  31  *    acknowledgment:
  32  *    "This product includes software developed by the OpenSSL Project
  33  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  36  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This product includes cryptographic software written by Eric Young
  50  * (eay@cryptsoft.com).  This product includes software written by Tim
  51  * Hudson (tjh@cryptsoft.com).
  52  *
  53  */
  54 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  55  * All rights reserved.
  56  *
  57  * This package is an SSL implementation written
  58  * by Eric Young (eay@cryptsoft.com).
  59  * The implementation was written so as to conform with Netscapes SSL.
  60  *
  61  * This library is free for commercial and non-commercial use as long as
  62  * the following conditions are aheared to.  The following conditions
  63  * apply to all code found in this distribution, be it the RC4, RSA,
  64  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  65  * included with this distribution is covered by the same copyright terms
  66  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  67  *
  68  * Copyright remains Eric Young's, and as such any Copyright notices in
  69  * the code are not to be removed.
  70  * If this package is used in a product, Eric Young should be given attribution
  71  * as the author of the parts of the library used.
  72  * This can be in the form of a textual message at program startup or
  73  * in documentation (online or textual) provided with the package.
  74  *
  75  * Redistribution and use in source and binary forms, with or without
  76  * modification, are permitted provided that the following conditions
  77  * are met:
  78  * 1. Redistributions of source code must retain the copyright
  79  *    notice, this list of conditions and the following disclaimer.
  80  * 2. Redistributions in binary form must reproduce the above copyright
  81  *    notice, this list of conditions and the following disclaimer in the
  82  *    documentation and/or other materials provided with the distribution.
  83  * 3. All advertising materials mentioning features or use of this software
  84  *    must display the following acknowledgement:
  85  *    "This product includes cryptographic software written by
  86  *     Eric Young (eay@cryptsoft.com)"
  87  *    The word 'cryptographic' can be left out if the rouines from the library
  88  *    being used are not cryptographic related :-).
  89  * 4. If you include any Windows specific code (or a derivative thereof) from
  90  *    the apps directory (application code) you must include an acknowledgement:
  91  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  92  *
  93  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  94  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  95  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  96  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  97  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  98  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  99  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 101  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 102  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 103  * SUCH DAMAGE.
 104  *
 105  * The licence and distribution terms for any publically available version or
 106  * derivative of this code cannot be changed.  i.e. this code cannot simply be
 107  * copied and put under another distribution licence
 108  * [including the GNU Public Licence.]
 109  */
 110 /* ====================================================================
 111  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
 112  * ECDH support in OpenSSL originally developed by
 113  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
 114  */
 115
 116 #include "internal/cryptlib.h"
 117 #include <openssl/safestack.h>
 118
 119 #if defined(OPENSSL_SYS_WIN32)
 120 static double OpenSSL_MSVC5_hack = 0.0; /* and for VC1.5 */
 121 #endif
 122
 123 /* real #defines in crypto.h, keep these upto date */
 124 static const char *const lock_names[CRYPTO_NUM_LOCKS] = {
 125     "<<ERROR>>",
 126     "err",
 127     "ex_data",
 128     "x509",
 129     "x509_info",
 130     "x509_pkey",
 131     "x509_crl",
 132     "x509_req",
 133     "dsa",
 134     "rsa",
 135     "evp_pkey",
 136     "x509_store",
 137     "ssl_ctx",
 138     "ssl_cert",
 139     "ssl_session",
 140     "ssl_sess_cert",
 141     "ssl",
 142     "ssl_method",
 143     "rand",
 144     "rand2",
 145     "debug_malloc",
 146     "BIO",
 147     "gethostbyname",
 148     "getservbyname",
 149     "readdir",
 150     "RSA_blinding",
 151     "dh",
 152     "debug_malloc2",
 153     "dso",
 154     "dynlock",
 155     "engine",
 156     "ui",
 157     "ecdsa",
 158     "ec",
 159     "ecdh",
 160     "bn",
 161     "ec_pre_comp",
 162     "store",
 163     "comp",
 164     "fips",
 165     "fips2",
 166     "init",
 167 #if CRYPTO_NUM_LOCKS != 42
 168 # error "Inconsistency between crypto.h and cryptlib.c"
 169 #endif
 170 };
 171
 172 /*
 173  * This is for applications to allocate new type names in the non-dynamic
 174  * array of lock names.  These are numbered with positive numbers.
 175  */
 176 static STACK_OF(OPENSSL_STRING) *app_locks = NULL;
 177
 178 /*
 179  * For applications that want a more dynamic way of handling threads, the
 180  * following stack is used.  These are externally numbered with negative
 181  * numbers.
 182  */
 183 static STACK_OF(CRYPTO_dynlock) *dyn_locks = NULL;
 184
 185 static void (*locking_callback) (int mode, int type,
 186                                  const char *file, int line) = 0;
 187 static int (*add_lock_callback) (int *pointer, int amount,
 188                                  int type, const char *file, int line) = 0;
 189 static struct CRYPTO_dynlock_value *(*dynlock_create_callback)
 190  (const char *file, int line) = 0;
 191 static void (*dynlock_lock_callback) (int mode,
 192                                       struct CRYPTO_dynlock_value *l,
 193                                       const char *file, int line) = 0;
 194 static void (*dynlock_destroy_callback) (struct CRYPTO_dynlock_value *l,
 195                                          const char *file, int line) = 0;
 196
 197 int CRYPTO_get_new_lockid(char *name)
 198 {
 199     char *str;
 200     int i;
 201
 202 #if defined(OPENSSL_SYS_WIN32)
 203     /*
 204      * A hack to make Visual C++ 5.0 work correctly when linking as a DLL
 205      * using /MT. Without this, the application cannot use any floating point
 206      * printf's. It also seems to be needed for Visual C 1.5 (win16)
 207      */
 208     OpenSSL_MSVC5_hack = (double)name[0] * (double)name[1];
 209 #endif
 210
 211     if ((app_locks == NULL)
 212         && ((app_locks = sk_OPENSSL_STRING_new_null()) == NULL)) {
 213         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID, ERR_R_MALLOC_FAILURE);
 214         return (0);
 215     }
 216     if ((str = OPENSSL_strdup(name)) == NULL) {
 217         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID, ERR_R_MALLOC_FAILURE);
 218         return (0);
 219     }
 220     i = sk_OPENSSL_STRING_push(app_locks, str);
 221     if (!i)
 222         OPENSSL_free(str);
 223     else
 224         i += CRYPTO_NUM_LOCKS;  /* gap of one :-) */
 225     return (i);
 226 }
 227
 228 int CRYPTO_num_locks(void)
 229 {
 230     return CRYPTO_NUM_LOCKS;
 231 }
 232
 233 int CRYPTO_get_new_dynlockid(void)
 234 {
 235     int i = 0;
 236     CRYPTO_dynlock *pointer = NULL;
 237
 238     if (dynlock_create_callback == NULL) {
 239         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,
 240                   CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK);
 241         return (0);
 242     }
 243     CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
 244     if ((dyn_locks == NULL)
 245         && ((dyn_locks = sk_CRYPTO_dynlock_new_null()) == NULL)) {
 246         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 247         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID, ERR_R_MALLOC_FAILURE);
 248         return (0);
 249     }
 250     CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 251
 252     pointer = OPENSSL_malloc(sizeof(*pointer));
 253     if (pointer == NULL) {
 254         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID, ERR_R_MALLOC_FAILURE);
 255         return (0);
 256     }
 257     pointer->references = 1;
 258     pointer->data = dynlock_create_callback(__FILE__, __LINE__);
 259     if (pointer->data == NULL) {
 260         OPENSSL_free(pointer);
 261         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID, ERR_R_MALLOC_FAILURE);
 262         return (0);
 263     }
 264
 265     CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
 266     /* First, try to find an existing empty slot */
 267     i = sk_CRYPTO_dynlock_find(dyn_locks, NULL);
 268     /* If there was none, push, thereby creating a new one */
 269     if (i == -1)
 270         /*
 271          * Since sk_push() returns the number of items on the stack, not the
 272          * location of the pushed item, we need to transform the returned
 273          * number into a position, by decreasing it.
 274          */
 275         i = sk_CRYPTO_dynlock_push(dyn_locks, pointer) - 1;
 276     else
 277         /*
 278          * If we found a place with a NULL pointer, put our pointer in it.
 279          */
 280         (void)sk_CRYPTO_dynlock_set(dyn_locks, i, pointer);
 281     CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 282
 283     if (i == -1) {
 284         dynlock_destroy_callback(pointer->data, __FILE__, __LINE__);
 285         OPENSSL_free(pointer);
 286     } else
 287         i += 1;                 /* to avoid 0 */
 288     return -i;
 289 }
 290
 291 void CRYPTO_destroy_dynlockid(int i)
 292 {
 293     CRYPTO_dynlock *pointer = NULL;
 294     if (i)
 295         i = -i - 1;
 296     if (dynlock_destroy_callback == NULL)
 297         return;
 298
 299     CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
 300
 301     if (dyn_locks == NULL || i >= sk_CRYPTO_dynlock_num(dyn_locks)) {
 302         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 303         return;
 304     }
 305     pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
 306     if (pointer != NULL) {
 307         --pointer->references;
 308 #ifdef REF_DEBUG
 309         if (pointer->references < 0) {
 310             OPENSSL_showfatal("CRYPTO_destroy_dynlockid, bad reference count\n");
 311             abort();
 312         } else
 313 #endif
 314         if (pointer->references <= 0) {
 315             (void)sk_CRYPTO_dynlock_set(dyn_locks, i, NULL);
 316         } else
 317             pointer = NULL;
 318     }
 319     CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 320
 321     if (pointer) {
 322         dynlock_destroy_callback(pointer->data, __FILE__, __LINE__);
 323         OPENSSL_free(pointer);
 324     }
 325 }
 326
 327 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i)
 328 {
 329     CRYPTO_dynlock *pointer = NULL;
 330     if (i)
 331         i = -i - 1;
 332
 333     CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
 334
 335     if (dyn_locks != NULL && i < sk_CRYPTO_dynlock_num(dyn_locks))
 336         pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
 337     if (pointer)
 338         pointer->references++;
 339
 340     CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 341
 342     if (pointer)
 343         return pointer->data;
 344     return NULL;
 345 }
 346
 347 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))
 348  (const char *file, int line) {
 349     return (dynlock_create_callback);
 350 }
 351
 352 void (*CRYPTO_get_dynlock_lock_callback(void)) (int mode,
 353                                                 struct CRYPTO_dynlock_value
 354                                                 *l, const char *file,
 355                                                 int line) {
 356     return (dynlock_lock_callback);
 357 }
 358
 359 void (*CRYPTO_get_dynlock_destroy_callback(void))
 360  (struct CRYPTO_dynlock_value *l, const char *file, int line) {
 361     return (dynlock_destroy_callback);
 362 }
 363
 364 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*func)
 365                                          (const char *file, int line))
 366 {
 367     dynlock_create_callback = func;
 368 }
 369
 370 void CRYPTO_set_dynlock_lock_callback(void (*func) (int mode,
 371                                                     struct
 372                                                     CRYPTO_dynlock_value *l,
 373                                                     const char *file,
 374                                                     int line))
 375 {
 376 #ifdef OPENSSL_FIPS
 377     FIPS_set_locking_callbacks(CRYPTO_lock, CRYPTO_add_lock);
 378 #endif
 379     dynlock_lock_callback = func;
 380 }
 381
 382 void CRYPTO_set_dynlock_destroy_callback(void (*func)
 383                                           (struct CRYPTO_dynlock_value *l,
 384                                            const char *file, int line))
 385 {
 386     dynlock_destroy_callback = func;
 387 }
 388
 389 void (*CRYPTO_get_locking_callback(void)) (int mode, int type,
 390                                            const char *file, int line) {
 391     return (locking_callback);
 392 }
 393
 394 int (*CRYPTO_get_add_lock_callback(void)) (int *num, int mount, int type,
 395                                            const char *file, int line) {
 396     return (add_lock_callback);
 397 }
 398
 399 void CRYPTO_set_locking_callback(void (*func) (int mode, int type,
 400                                                const char *file, int line))
 401 {
 402 #ifdef OPENSSL_FIPS
 403     FIPS_set_locking_callbacks(CRYPTO_lock, CRYPTO_add_lock);
 404 #endif
 405     locking_callback = func;
 406 }
 407
 408 void CRYPTO_set_add_lock_callback(int (*func) (int *num, int mount, int type,
 409                                                const char *file, int line))
 410 {
 411     add_lock_callback = func;
 412 }
 413
 414 void CRYPTO_lock(int mode, int type, const char *file, int line)
 415 {
 416 #ifdef LOCK_DEBUG
 417     {
 418         CRYPTO_THREADID id;
 419         char *rw_text, *operation_text;
 420
 421         if (mode & CRYPTO_LOCK)
 422             operation_text = "lock  ";
 423         else if (mode & CRYPTO_UNLOCK)
 424             operation_text = "unlock";
 425         else
 426             operation_text = "ERROR ";
 427
 428         if (mode & CRYPTO_READ)
 429             rw_text = "r";
 430         else if (mode & CRYPTO_WRITE)
 431             rw_text = "w";
 432         else
 433             rw_text = "ERROR";
 434
 435         CRYPTO_THREADID_current(&id);
 436         fprintf(stderr, "lock:%08lx:(%s)%s %-18s %s:%d\n",
 437                 CRYPTO_THREADID_hash(&id), rw_text, operation_text,
 438                 CRYPTO_get_lock_name(type), file, line);
 439     }
 440 #endif
 441     if (type < 0) {
 442         if (dynlock_lock_callback != NULL) {
 443             struct CRYPTO_dynlock_value *pointer
 444                 = CRYPTO_get_dynlock_value(type);
 445
 446             OPENSSL_assert(pointer != NULL);
 447
 448             dynlock_lock_callback(mode, pointer, file, line);
 449
 450             CRYPTO_destroy_dynlockid(type);
 451         }
 452     } else if (locking_callback != NULL)
 453         locking_callback(mode, type, file, line);
 454 }
 455
 456 int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
 457                     int line)
 458 {
 459     int ret = 0;
 460
 461     if (add_lock_callback != NULL) {
 462 #ifdef LOCK_DEBUG
 463         int before = *pointer;
 464 #endif
 465
 466         ret = add_lock_callback(pointer, amount, type, file, line);
 467 #ifdef LOCK_DEBUG
 468         {
 469             CRYPTO_THREADID id;
 470             CRYPTO_THREADID_current(&id);
 471             fprintf(stderr, "ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
 472                     CRYPTO_THREADID_hash(&id), before, amount, ret,
 473                     CRYPTO_get_lock_name(type), file, line);
 474         }
 475 #endif
 476     } else {
 477         CRYPTO_lock(CRYPTO_LOCK | CRYPTO_WRITE, type, file, line);
 478
 479         ret = *pointer + amount;
 480 #ifdef LOCK_DEBUG
 481         {
 482             CRYPTO_THREADID id;
 483             CRYPTO_THREADID_current(&id);
 484             fprintf(stderr, "ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
 485                     CRYPTO_THREADID_hash(&id),
 486                     *pointer, amount, ret,
 487                     CRYPTO_get_lock_name(type), file, line);
 488         }
 489 #endif
 490         *pointer = ret;
 491         CRYPTO_lock(CRYPTO_UNLOCK | CRYPTO_WRITE, type, file, line);
 492     }
 493     return (ret);
 494 }
 495
 496 const char *CRYPTO_get_lock_name(int type)
 497 {
 498     if (type < 0)
 499         return ("dynamic");
 500     else if (type < CRYPTO_NUM_LOCKS)
 501         return (lock_names[type]);
 502     else if (type - CRYPTO_NUM_LOCKS > sk_OPENSSL_STRING_num(app_locks))
 503         return ("ERROR");
 504     else
 505         return (sk_OPENSSL_STRING_value(app_locks, type - CRYPTO_NUM_LOCKS));
 506 }