crypto/mem.c

   1 /* crypto/mem.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 #include <stdio.h>
  60 #include <stdlib.h>
  61 #include <openssl/crypto.h>
  62 #ifdef CRYPTO_MDEBUG_TIME
  63 # include <time.h>
  64 #endif
  65 #include <openssl/buffer.h>
  66 #include <openssl/bio.h>
  67 #include <openssl/lhash.h>
  68 #include "cryptlib.h"
  69
  70 /* #ifdef CRYPTO_MDEBUG */
  71 /* static int mh_mode=CRYPTO_MEM_CHECK_ON; */
  72 /* #else */
  73 static int mh_mode=CRYPTO_MEM_CHECK_OFF;
  74 static unsigned long disabling_thread = 0;
  75 /* #endif */
  76 /* State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
  77  * thinks that certain allocations should not be checked (e.g. the data
  78  * structures used for memory checking).  It is not suitable as an initial
  79  * state: the library will unexpectedly enable memory checking when it
  80  * executes one of those sections that want to disable checking
  81  * temporarily.
  82  *
  83  * State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes no sense whatsoever.
  84  */
  85
  86 static unsigned long order=0;
  87
  88 static LHASH *amih=NULL;
  89
  90 typedef struct app_mem_info_st
  91         {
  92         unsigned long thread;
  93         const char *file;
  94         int line;
  95         const char *info;
  96         struct app_mem_info_st *next;
  97         int references;
  98         } APP_INFO;
  99
 100 static LHASH *mh=NULL;
 101
 102 typedef struct mem_st
 103         {
 104         char *addr;
 105         int num;
 106         const char *file;
 107         int line;
 108 #ifdef CRYPTO_MDEBUG_THREAD
 109         unsigned long thread;
 110 #endif
 111         unsigned long order;
 112 #ifdef CRYPTO_MDEBUG_TIME
 113         time_t time;
 114 #endif
 115         APP_INFO *app_info;
 116         } MEM;
 117
 118 int CRYPTO_mem_ctrl(int mode)
 119         {
 120         int ret=mh_mode;
 121
 122         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 123         switch (mode)
 124                 {
 125         /* for applications: */
 126         case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
 127                 mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
 128                 disabling_thread = 0;
 129                 break;
 130         case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
 131                 mh_mode = 0;
 132                 disabling_thread = 0;
 133                 break;
 134
 135         /* switch off temporarily (for library-internal use): */
 136         case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
 137                 if (mh_mode & CRYPTO_MEM_CHECK_ON)
 138                         {
 139                         mh_mode&= ~CRYPTO_MEM_CHECK_ENABLE;
 140                         if (disabling_thread != CRYPTO_thread_id()) /* otherwise we already have the MALLOC2 lock */
 141                                 {
 142                                 /* Long-time lock CRYPTO_LOCK_MALLOC2 must not be claimed while
 143                                  * we're holding CRYPTO_LOCK_MALLOC, or we'll deadlock if
 144                                  * somebody else holds CRYPTO_LOCK_MALLOC2 (and cannot release it
 145                                  * because we block entry to this function).
 146                                  * Give them a chance, first, and then claim the locks in
 147                                  * appropriate order (long-time lock first).
 148                                  */
 149                                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 150                                 /* Note that after we have waited for CRYPTO_LOCK_MALLOC2
 151                                  * and CRYPTO_LOCK_MALLOC, we'll still be in the right
 152                                  * "case" and "if" branch because MemCheck_start and
 153                                  * MemCheck_stop may never be used while there are multiple
 154                                  * OpenSSL threads. */
 155                                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
 156                                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 157                                 disabling_thread=CRYPTO_thread_id();
 158                                 }
 159                         }
 160                 break;
 161         case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
 162                 if (mh_mode & CRYPTO_MEM_CHECK_ON)
 163                         {
 164                         mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
 165                         if (disabling_thread != 0)
 166                                 {
 167                                 disabling_thread=0;
 168                                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
 169                                 }
 170                         }
 171                 break;
 172
 173         default:
 174                 break;
 175                 }
 176         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 177         return(ret);
 178         }
 179
 180 static int is_MemCheck_On()
 181         {
 182         int ret = 0;
 183
 184         if (mh_mode & CRYPTO_MEM_CHECK_ON)
 185                 {
 186                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 187
 188                 ret = (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
 189                         && disabling_thread != CRYPTO_thread_id();
 190
 191                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 192                 }
 193         return(ret);
 194         }
 195
 196 static int mem_cmp(MEM *a, MEM *b)
 197         {
 198         return(a->addr - b->addr);
 199         }
 200
 201 static unsigned long mem_hash(MEM *a)
 202         {
 203         unsigned long ret;
 204
 205         ret=(unsigned long)a->addr;
 206
 207         ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
 208         return(ret);
 209         }
 210
 211 static int app_info_cmp(APP_INFO *a, APP_INFO *b)
 212         {
 213         return(a->thread - b->thread);
 214         }
 215
 216 static unsigned long app_info_hash(APP_INFO *a)
 217         {
 218         unsigned long ret;
 219
 220         ret=(unsigned long)a->thread;
 221
 222         ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
 223         return(ret);
 224         }
 225
 226 static APP_INFO *remove_info()
 227         {
 228         APP_INFO tmp;
 229         APP_INFO *ret = NULL;
 230
 231         if (amih != NULL)
 232                 {
 233                 tmp.thread=CRYPTO_thread_id();
 234                 if ((ret=(APP_INFO *)lh_delete(amih,(char *)&tmp)) != NULL)
 235                         {
 236                         APP_INFO *next=ret->next;
 237
 238                         if (next != NULL)
 239                                 {
 240                                 next->references++;
 241                                 lh_insert(amih,(char *)next);
 242                                 }
 243 #ifdef LEVITTE_DEBUG
 244                         if (ret->thread != tmp.thread)
 245                                 {
 246                                 fprintf(stderr, "remove_info(): deleted info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
 247                                         ret->thread, tmp.thread);
 248                                 abort();
 249                                 }
 250 #endif
 251                         if (--(ret->references) <= 0)
 252                                 {
 253                                 ret->next = NULL;
 254                                 if (next != NULL)
 255                                         next->references--;
 256                                 Free(ret);
 257                                 }
 258                         }
 259                 }
 260         return(ret);
 261         }
 262
 263 int CRYPTO_add_info(const char *file, int line, const char *info)
 264         {
 265         APP_INFO *ami, *amim;
 266         int ret=0;
 267
 268         if (is_MemCheck_On())
 269                 {
 270                 MemCheck_off();
 271
 272                 if ((ami = (APP_INFO *)Malloc(sizeof(APP_INFO))) == NULL)
 273                         {
 274                         ret=0;
 275                         goto err;
 276                         }
 277                 if (amih == NULL)
 278                         {
 279                         if ((amih=lh_new(app_info_hash,app_info_cmp)) == NULL)
 280                                 {
 281                                 Free(ami);
 282                                 ret=0;
 283                                 goto err;
 284                                 }
 285                         }
 286
 287                 ami->thread=CRYPTO_thread_id();
 288                 ami->file=file;
 289                 ami->line=line;
 290                 ami->info=info;
 291                 ami->references=1;
 292                 ami->next=NULL;
 293
 294                 if ((amim=(APP_INFO *)lh_insert(amih,(char *)ami)) != NULL)
 295                         {
 296 #ifdef LEVITTE_DEBUG
 297                         if (ami->thread != amim->thread)
 298                                 {
 299                                 fprintf(stderr, "CRYPTO_add_info(): previous info has other thread ID (%lu) than the current thread (%lu)!!!!\n",
 300                                         amim->thread, ami->thread);
 301                                 abort();
 302                                 }
 303 #endif
 304                         ami->next=amim;
 305                         }
 306  err:
 307                 MemCheck_on();
 308                 }
 309
 310         return(ret);
 311         }
 312
 313 int CRYPTO_remove_info()
 314         {
 315         int ret=0;
 316
 317         if (is_MemCheck_On())
 318                 {
 319                 MemCheck_off();
 320
 321                 ret=(remove_info() != NULL);
 322
 323                 MemCheck_on();
 324                 }
 325         return(ret);
 326         }
 327
 328 static char *(*malloc_locked_func)()=(char *(*)())malloc;
 329 static void (*free_locked_func)()=(void (*)())free;
 330 static char *(*malloc_func)()=  (char *(*)())malloc;
 331 static char *(*realloc_func)()= (char *(*)())realloc;
 332 static void (*free_func)()=     (void (*)())free;
 333
 334 void CRYPTO_set_mem_functions(char *(*m)(), char *(*r)(), void (*f)())
 335         {
 336         if ((m == NULL) || (r == NULL) || (f == NULL)) return;
 337         malloc_func=m;
 338         realloc_func=r;
 339         free_func=f;
 340         malloc_locked_func=m;
 341         free_locked_func=f;
 342         }
 343
 344 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*f)())
 345         {
 346         if ((m == NULL) || (f == NULL)) return;
 347         malloc_locked_func=m;
 348         free_locked_func=f;
 349         }
 350
 351 void CRYPTO_get_mem_functions(char *(**m)(), char *(**r)(), void (**f)())
 352         {
 353         if (m != NULL) *m=malloc_func;
 354         if (r != NULL) *r=realloc_func;
 355         if (f != NULL) *f=free_func;
 356         }
 357
 358 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)())
 359         {
 360         if (m != NULL) *m=malloc_locked_func;
 361         if (f != NULL) *f=free_locked_func;
 362         }
 363
 364 void *CRYPTO_malloc_locked(int num)
 365         {
 366         return(malloc_locked_func(num));
 367         }
 368
 369 void CRYPTO_free_locked(void *str)
 370         {
 371         free_locked_func(str);
 372         }
 373
 374 void *CRYPTO_malloc(int num)
 375         {
 376         return(malloc_func(num));
 377         }
 378
 379 void *CRYPTO_realloc(void *str, int num)
 380         {
 381         return(realloc_func(str,num));
 382         }
 383
 384 void CRYPTO_free(void *str)
 385         {
 386         free_func(str);
 387         }
 388
 389 static unsigned long break_order_num=0;
 390 void *CRYPTO_dbg_malloc(int num, const char *file, int line)
 391         {
 392         char *ret;
 393         MEM *m,*mm;
 394         APP_INFO tmp,*amim;
 395
 396         if ((ret=malloc_func(num)) == NULL)
 397                 return(NULL);
 398
 399         if (is_MemCheck_On())
 400                 {
 401                 MemCheck_off();
 402                 if ((m=(MEM *)Malloc(sizeof(MEM))) == NULL)
 403                         {
 404                         Free(ret);
 405                         MemCheck_on();
 406                         return(NULL);
 407                         }
 408                 if (mh == NULL)
 409                         {
 410                         if ((mh=lh_new(mem_hash,mem_cmp)) == NULL)
 411                                 {
 412                                 Free(ret);
 413                                 Free(m);
 414                                 ret=NULL;
 415                                 goto err;
 416                                 }
 417                         }
 418
 419                 m->addr=ret;
 420                 m->file=file;
 421                 m->line=line;
 422                 m->num=num;
 423 #ifdef CRYPTO_MDEBUG_THREAD
 424                 m->thread=CRYPTO_thread_id();
 425 #endif
 426                 if (order == break_order_num)
 427                         {
 428                         /* BREAK HERE */
 429                         m->order=order;
 430                         }
 431                 m->order=order++;
 432 #ifdef CRYPTO_MDEBUG_TIME
 433                 m->time=time(NULL);
 434 #endif
 435
 436                 tmp.thread=CRYPTO_thread_id();
 437                 m->app_info=NULL;
 438                 if (amih != NULL
 439                     && (amim=(APP_INFO *)lh_retrieve(amih,(char *)&tmp)) != NULL)
 440                         {
 441                         m->app_info = amim;
 442                         amim->references++;
 443                         }
 444
 445                 if ((mm=(MEM *)lh_insert(mh,(char *)m)) != NULL)
 446                         {
 447                         /* Not good, but don't sweat it */
 448                         if (mm->app_info != NULL)
 449                                 {
 450                                 mm->app_info->references--;
 451                                 }
 452                         Free(mm);
 453                         }
 454 err:
 455                 MemCheck_on();
 456                 }
 457         return(ret);
 458         }
 459
 460 void CRYPTO_dbg_free(void *addr)
 461         {
 462         MEM m,*mp;
 463
 464         if (is_MemCheck_On() && (mh != NULL))
 465                 {
 466                 MemCheck_off();
 467
 468                 m.addr=addr;
 469                 mp=(MEM *)lh_delete(mh,(char *)&m);
 470                 if (mp != NULL)
 471                         {
 472                         if (mp->app_info != NULL)
 473                                 {
 474                                 mp->app_info->references--;
 475                                 }
 476                         Free(mp);
 477                         }
 478
 479                 MemCheck_on();
 480                 }
 481         free_func(addr);
 482         }
 483
 484 void *CRYPTO_dbg_realloc(void *addr, int num, const char *file, int line)
 485         {
 486         char *ret;
 487         MEM m,*mp;
 488
 489         ret=realloc_func(addr,num);
 490         if (ret == addr) return(ret);
 491
 492         if (is_MemCheck_On())
 493                 {
 494                 if (ret == NULL) return(NULL);
 495
 496                 MemCheck_off();
 497
 498                 m.addr=addr;
 499                 mp=(MEM *)lh_delete(mh,(char *)&m);
 500                 if (mp != NULL)
 501                         {
 502                         mp->addr=ret;
 503                         lh_insert(mh,(char *)mp);
 504                         }
 505
 506                 MemCheck_on();
 507                 }
 508         return(ret);
 509         }
 510
 511 void *CRYPTO_remalloc(void *a, int n)
 512         {
 513         if (a != NULL) Free(a);
 514         a=(char *)Malloc(n);
 515         return(a);
 516         }
 517
 518 void *CRYPTO_dbg_remalloc(void *a, int n, const char *file, int line)
 519         {
 520         if (a != NULL) CRYPTO_dbg_free(a);
 521         a=(char *)CRYPTO_dbg_malloc(n,file,line);
 522         return(a);
 523         }
 524
 525
 526 typedef struct mem_leak_st
 527         {
 528         BIO *bio;
 529         int chunks;
 530         long bytes;
 531         } MEM_LEAK;
 532
 533 static void print_leak(MEM *m, MEM_LEAK *l)
 534         {
 535         char buf[128];
 536         APP_INFO *amip;
 537         int ami_cnt;
 538 #ifdef CRYPTO_MDEBUG_TIME
 539         struct tm *lcl;
 540 #endif
 541         unsigned long ti;
 542
 543         if(m->addr == (char *)l->bio)
 544             return;
 545
 546 #ifdef CRYPTO_MDEBUG_TIME
 547         lcl = localtime(&m->time);
 548 #endif
 549
 550         sprintf(buf,
 551 #ifdef CRYPTO_MDEBUG_TIME
 552                 "[%02d:%02d:%02d] "
 553 #endif
 554                 "%5lu file=%s, line=%d, "
 555 #ifdef CRYPTO_MDEBUG_THREAD
 556                 "thread=%lu, "
 557 #endif
 558                 "number=%d, address=%08lX\n",
 559 #ifdef CRYPTO_MDEBUG_TIME
 560                 lcl->tm_hour,lcl->tm_min,lcl->tm_sec,
 561 #endif
 562                 m->order,m->file,m->line,
 563 #ifdef CRYPTO_MDEBUG_THREAD
 564                 m->thread,
 565 #endif
 566                 m->num,(unsigned long)m->addr);
 567
 568         BIO_puts(l->bio,buf);
 569
 570         l->chunks++;
 571         l->bytes+=m->num;
 572
 573         amip=m->app_info;
 574         ami_cnt=0;
 575         if (amip)
 576                 ti=amip->thread;
 577         while(amip && amip->thread == ti)
 578                 {
 579                 int buf_len;
 580                 int info_len;
 581
 582                 ami_cnt++;
 583                 memset(buf,'>',ami_cnt);
 584                 sprintf(buf + ami_cnt,
 585                         "thread=%lu, file=%s, line=%d, info=\"",
 586                         amip->thread, amip->file, amip->line);
 587                 buf_len=strlen(buf);
 588                 info_len=strlen(amip->info);
 589                 if (128 - buf_len - 3 < info_len)
 590                         {
 591                         memcpy(buf + buf_len, amip->info, 128 - buf_len - 3);
 592                         buf_len = 128 - 3;
 593                         }
 594                 else
 595                         {
 596                         strcpy(buf + buf_len, amip->info);
 597                         buf_len = strlen(buf);
 598                         }
 599                 sprintf(buf + buf_len, "\"\n");
 600
 601                 BIO_puts(l->bio,buf);
 602
 603                 amip = amip->next;
 604                 }
 605 #ifdef LEVITTE_DEBUG
 606         if (amip)
 607                 {
 608                 fprintf(stderr, "Thread switch detected i backtrace!!!!\n");
 609                 abort();
 610                 }
 611 #endif
 612         }
 613
 614 void CRYPTO_mem_leaks(BIO *b)
 615         {
 616         MEM_LEAK ml;
 617         char buf[80];
 618
 619         if (mh == NULL) return;
 620         ml.bio=b;
 621         ml.bytes=0;
 622         ml.chunks=0;
 623         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
 624         lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
 625         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
 626         if (ml.chunks != 0)
 627                 {
 628                 sprintf(buf,"%ld bytes leaked in %d chunks\n",
 629                         ml.bytes,ml.chunks);
 630                 BIO_puts(b,buf);
 631                 }
 632
 633 #if 0
 634         lh_stats_bio(mh,b);
 635         lh_node_stats_bio(mh,b);
 636         lh_node_usage_stats_bio(mh,b);
 637 #endif
 638         }
 639
 640 static void (*mem_cb)()=NULL;
 641
 642 static void cb_leak(MEM *m, char *cb)
 643         {
 644         void (*mem_callback)()=(void (*)())cb;
 645         mem_callback(m->order,m->file,m->line,m->num,m->addr);
 646         }
 647
 648 void CRYPTO_mem_leaks_cb(void (*cb)())
 649         {
 650         if (mh == NULL) return;
 651         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC2);
 652         mem_cb=cb;
 653         lh_doall_arg(mh,(void (*)())cb_leak,(char *)mem_cb);
 654         mem_cb=NULL;
 655         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC2);
 656         }
 657
 658 #ifndef NO_FP_API
 659 void CRYPTO_mem_leaks_fp(FILE *fp)
 660         {
 661         BIO *b;
 662
 663         if (mh == NULL) return;
 664         if ((b=BIO_new(BIO_s_file())) == NULL)
 665                 return;
 666         BIO_set_fp(b,fp,BIO_NOCLOSE);
 667         CRYPTO_mem_leaks(b);
 668         BIO_free(b);
 669         }
 670 #endif
 671