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 #if CRYPTO_NUM_LOCKS != 41
 167 # error "Inconsistency between crypto.h and cryptlib.c"
 168 #endif
 169 };
 170
 171 /*
 172  * This is for applications to allocate new type names in the non-dynamic
 173  * array of lock names.  These are numbered with positive numbers.
 174  */
 175 static STACK_OF(OPENSSL_STRING) *app_locks = NULL;
 176
 177 /*
 178  * For applications that want a more dynamic way of handling threads, the
 179  * following stack is used.  These are externally numbered with negative
 180  * numbers.
 181  */
 182 static STACK_OF(CRYPTO_dynlock) *dyn_locks = NULL;
 183
 184 static void (*locking_callback) (int mode, int type,
 185                                  const char *file, int line) = 0;
 186 static int (*add_lock_callback) (int *pointer, int amount,
 187                                  int type, const char *file, int line) = 0;
 188 static struct CRYPTO_dynlock_value *(*dynlock_create_callback)
 189  (const char *file, int line) = 0;
 190 static void (*dynlock_lock_callback) (int mode,
 191                                       struct CRYPTO_dynlock_value *l,
 192                                       const char *file, int line) = 0;
 193 static void (*dynlock_destroy_callback) (struct CRYPTO_dynlock_value *l,
 194                                          const char *file, int line) = 0;
 195
 196 int CRYPTO_get_new_lockid(char *name)
 197 {
 198     char *str;
 199     int i;
 200
 201 #if defined(OPENSSL_SYS_WIN32)
 202     /*
 203      * A hack to make Visual C++ 5.0 work correctly when linking as a DLL
 204      * using /MT. Without this, the application cannot use any floating point
 205      * printf's. It also seems to be needed for Visual C 1.5 (win16)
 206      */
 207     OpenSSL_MSVC5_hack = (double)name[0] * (double)name[1];
 208 #endif
 209
 210     if ((app_locks == NULL)
 211         && ((app_locks = sk_OPENSSL_STRING_new_null()) == NULL)) {
 212         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID, ERR_R_MALLOC_FAILURE);
 213         return (0);
 214     }
 215     if ((str = OPENSSL_strdup(name)) == NULL) {
 216         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_LOCKID, ERR_R_MALLOC_FAILURE);
 217         return (0);
 218     }
 219     i = sk_OPENSSL_STRING_push(app_locks, str);
 220     if (!i)
 221         OPENSSL_free(str);
 222     else
 223         i += CRYPTO_NUM_LOCKS;  /* gap of one :-) */
 224     return (i);
 225 }
 226
 227 int CRYPTO_num_locks(void)
 228 {
 229     return CRYPTO_NUM_LOCKS;
 230 }
 231
 232 int CRYPTO_get_new_dynlockid(void)
 233 {
 234     int i = 0;
 235     CRYPTO_dynlock *pointer = NULL;
 236
 237     if (dynlock_create_callback == NULL) {
 238         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID,
 239                   CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK);
 240         return (0);
 241     }
 242     CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
 243     if ((dyn_locks == NULL)
 244         && ((dyn_locks = sk_CRYPTO_dynlock_new_null()) == NULL)) {
 245         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 246         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID, ERR_R_MALLOC_FAILURE);
 247         return (0);
 248     }
 249     CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 250
 251     pointer = OPENSSL_zalloc(sizeof(*pointer));
 252     if (pointer == NULL) {
 253         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID, ERR_R_MALLOC_FAILURE);
 254         return (0);
 255     }
 256     pointer->references = 1;
 257     pointer->data = dynlock_create_callback(OPENSSL_FILE, OPENSSL_LINE);
 258     if (pointer->data == NULL) {
 259         OPENSSL_free(pointer);
 260         CRYPTOerr(CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID, ERR_R_MALLOC_FAILURE);
 261         return (0);
 262     }
 263
 264     CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
 265     /* First, try to find an existing empty slot */
 266     i = sk_CRYPTO_dynlock_find(dyn_locks, NULL);
 267     /* If there was none, push, thereby creating a new one */
 268     if (i == -1)
 269         /*
 270          * Since sk_push() returns the number of items on the stack, not the
 271          * location of the pushed item, we need to transform the returned
 272          * number into a position, by decreasing it.
 273          */
 274         i = sk_CRYPTO_dynlock_push(dyn_locks, pointer) - 1;
 275     else
 276         /*
 277          * If we found a place with a NULL pointer, put our pointer in it.
 278          */
 279         (void)sk_CRYPTO_dynlock_set(dyn_locks, i, pointer);
 280     CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 281
 282     if (i == -1) {
 283         dynlock_destroy_callback(pointer->data, OPENSSL_FILE, OPENSSL_LINE);
 284         OPENSSL_free(pointer);
 285     } else
 286         i += 1;                 /* to avoid 0 */
 287     return -i;
 288 }
 289
 290 void CRYPTO_destroy_dynlockid(int i)
 291 {
 292     CRYPTO_dynlock *pointer = NULL;
 293     if (i)
 294         i = -i - 1;
 295     if (dynlock_destroy_callback == NULL)
 296         return;
 297
 298     CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
 299
 300     if (dyn_locks == NULL || i >= sk_CRYPTO_dynlock_num(dyn_locks)) {
 301         CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 302         return;
 303     }
 304     pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
 305     if (pointer != NULL) {
 306         --pointer->references;
 307 #ifdef REF_DEBUG
 308         if (pointer->references < 0) {
 309             OPENSSL_showfatal("CRYPTO_destroy_dynlockid, bad reference count\n");
 310             abort();
 311         } else
 312 #endif
 313         if (pointer->references <= 0) {
 314             (void)sk_CRYPTO_dynlock_set(dyn_locks, i, NULL);
 315         } else
 316             pointer = NULL;
 317     }
 318     CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 319
 320     if (pointer) {
 321         dynlock_destroy_callback(pointer->data, OPENSSL_FILE, OPENSSL_LINE);
 322         OPENSSL_free(pointer);
 323     }
 324 }
 325
 326 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i)
 327 {
 328     CRYPTO_dynlock *pointer = NULL;
 329     if (i)
 330         i = -i - 1;
 331
 332     CRYPTO_w_lock(CRYPTO_LOCK_DYNLOCK);
 333
 334     if (dyn_locks != NULL && i < sk_CRYPTO_dynlock_num(dyn_locks))
 335         pointer = sk_CRYPTO_dynlock_value(dyn_locks, i);
 336     if (pointer)
 337         pointer->references++;
 338
 339     CRYPTO_w_unlock(CRYPTO_LOCK_DYNLOCK);
 340
 341     if (pointer)
 342         return pointer->data;
 343     return NULL;
 344 }
 345
 346 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))
 347  (const char *file, int line) {
 348     return (dynlock_create_callback);
 349 }
 350
 351 void (*CRYPTO_get_dynlock_lock_callback(void)) (int mode,
 352                                                 struct CRYPTO_dynlock_value
 353                                                 *l, const char *file,
 354                                                 int line) {
 355     return (dynlock_lock_callback);
 356 }
 357
 358 void (*CRYPTO_get_dynlock_destroy_callback(void))
 359  (struct CRYPTO_dynlock_value *l, const char *file, int line) {
 360     return (dynlock_destroy_callback);
 361 }
 362
 363 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*func)
 364                                          (const char *file, int line))
 365 {
 366     dynlock_create_callback = func;
 367 }
 368
 369 void CRYPTO_set_dynlock_lock_callback(void (*func) (int mode,
 370                                                     struct
 371                                                     CRYPTO_dynlock_value *l,
 372                                                     const char *file,
 373                                                     int line))
 374 {
 375 #ifdef OPENSSL_FIPS
 376     FIPS_set_locking_callbacks(CRYPTO_lock, CRYPTO_add_lock);
 377 #endif
 378     dynlock_lock_callback = func;
 379 }
 380
 381 void CRYPTO_set_dynlock_destroy_callback(void (*func)
 382                                           (struct CRYPTO_dynlock_value *l,
 383                                            const char *file, int line))
 384 {
 385     dynlock_destroy_callback = func;
 386 }
 387
 388 void (*CRYPTO_get_locking_callback(void)) (int mode, int type,
 389                                            const char *file, int line) {
 390     return (locking_callback);
 391 }
 392
 393 int (*CRYPTO_get_add_lock_callback(void)) (int *num, int mount, int type,
 394                                            const char *file, int line) {
 395     return (add_lock_callback);
 396 }
 397
 398 void CRYPTO_set_locking_callback(void (*func) (int mode, int type,
 399                                                const char *file, int line))
 400 {
 401 #ifdef OPENSSL_FIPS
 402     FIPS_set_locking_callbacks(CRYPTO_lock, CRYPTO_add_lock);
 403 #endif
 404     locking_callback = func;
 405 }
 406
 407 void CRYPTO_set_add_lock_callback(int (*func) (int *num, int mount, int type,
 408                                                const char *file, int line))
 409 {
 410     add_lock_callback = func;
 411 }
 412
 413 void CRYPTO_lock(int mode, int type, const char *file, int line)
 414 {
 415 #ifdef LOCK_DEBUG
 416     {
 417         CRYPTO_THREADID id;
 418         char *rw_text, *operation_text;
 419
 420         if (mode & CRYPTO_LOCK)
 421             operation_text = "lock  ";
 422         else if (mode & CRYPTO_UNLOCK)
 423             operation_text = "unlock";
 424         else
 425             operation_text = "ERROR ";
 426
 427         if (mode & CRYPTO_READ)
 428             rw_text = "r";
 429         else if (mode & CRYPTO_WRITE)
 430             rw_text = "w";
 431         else
 432             rw_text = "ERROR";
 433
 434         CRYPTO_THREADID_current(&id);
 435         fprintf(stderr, "lock:%08lx:(%s)%s %-18s %s:%d\n",
 436                 CRYPTO_THREADID_hash(&id), rw_text, operation_text,
 437                 CRYPTO_get_lock_name(type), file, line);
 438     }
 439 #endif
 440     if (type < 0) {
 441         if (dynlock_lock_callback != NULL) {
 442             struct CRYPTO_dynlock_value *pointer
 443                 = CRYPTO_get_dynlock_value(type);
 444
 445             OPENSSL_assert(pointer != NULL);
 446
 447             dynlock_lock_callback(mode, pointer, file, line);
 448
 449             CRYPTO_destroy_dynlockid(type);
 450         }
 451     } else if (locking_callback != NULL)
 452         locking_callback(mode, type, file, line);
 453 }
 454
 455 int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
 456                     int line)
 457 {
 458     int ret = 0;
 459
 460     if (add_lock_callback != NULL) {
 461 #ifdef LOCK_DEBUG
 462         int before = *pointer;
 463 #endif
 464
 465         ret = add_lock_callback(pointer, amount, type, file, line);
 466 #ifdef LOCK_DEBUG
 467         {
 468             CRYPTO_THREADID id;
 469             CRYPTO_THREADID_current(&id);
 470             fprintf(stderr, "ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
 471                     CRYPTO_THREADID_hash(&id), before, amount, ret,
 472                     CRYPTO_get_lock_name(type), file, line);
 473         }
 474 #endif
 475     } else {
 476         CRYPTO_lock(CRYPTO_LOCK | CRYPTO_WRITE, type, file, line);
 477
 478         ret = *pointer + amount;
 479 #ifdef LOCK_DEBUG
 480         {
 481             CRYPTO_THREADID id;
 482             CRYPTO_THREADID_current(&id);
 483             fprintf(stderr, "ladd:%08lx:%2d+%2d->%2d %-18s %s:%d\n",
 484                     CRYPTO_THREADID_hash(&id),
 485                     *pointer, amount, ret,
 486                     CRYPTO_get_lock_name(type), file, line);
 487         }
 488 #endif
 489         *pointer = ret;
 490         CRYPTO_lock(CRYPTO_UNLOCK | CRYPTO_WRITE, type, file, line);
 491     }
 492     return (ret);
 493 }
 494
 495 const char *CRYPTO_get_lock_name(int type)
 496 {
 497     if (type < 0)
 498         return ("dynamic");
 499     else if (type < CRYPTO_NUM_LOCKS)
 500         return (lock_names[type]);
 501     else if (type - CRYPTO_NUM_LOCKS > sk_OPENSSL_STRING_num(app_locks))
 502         return ("ERROR");
 503     else
 504         return (sk_OPENSSL_STRING_value(app_locks, type - CRYPTO_NUM_LOCKS));
 505 }