crypto/lock.c

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