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 #ifdef CRYPTO_MDEBUG_TIME
  62 # include <time.h>
  63 #endif
  64 #include <openssl/buffer.h>
  65 #include <openssl/bio.h>
  66 #include <openssl/lhash.h>
  67 #include "cryptlib.h"
  68
  69 /* #ifdef CRYPTO_MDEBUG */
  70 /* static int mh_mode=CRYPTO_MEM_CHECK_ON; */
  71 /* #else */
  72 static int mh_mode=CRYPTO_MEM_CHECK_OFF;
  73 /* #endif */
  74 /* State CRYPTO_MEM_CHECK_ON exists only temporarily when the library
  75  * thinks that certain allocations should not be checked (e.g. the data
  76  * structures used for memory checking).  It is not suitable as an initial
  77  * state: the library will unexpectedly enable memory checking when it
  78  * executes one of those sections that want to disable checking
  79  * temporarily.
  80  *
  81  * State CRYPTO_MEM_CHECK_ENABLE without ..._ON makes no sense whatsoever.
  82  */
  83
  84 static unsigned long order=0;
  85
  86 static LHASH *mh=NULL;
  87
  88 typedef struct mem_st
  89         {
  90         char *addr;
  91         int num;
  92         const char *file;
  93         int line;
  94         unsigned long order;
  95 #ifdef CRYPTO_MDEBUG_TIME
  96         time_t time;
  97 #endif
  98         } MEM;
  99
 100 int CRYPTO_mem_ctrl(int mode)
 101         {
 102         int ret=mh_mode;
 103
 104         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 105         switch (mode)
 106                 {
 107         /* for applications: */
 108         case CRYPTO_MEM_CHECK_ON: /* aka MemCheck_start() */
 109                 mh_mode = CRYPTO_MEM_CHECK_ON|CRYPTO_MEM_CHECK_ENABLE;
 110                 break;
 111         case CRYPTO_MEM_CHECK_OFF: /* aka MemCheck_stop() */
 112                 mh_mode = 0;
 113                 break;
 114
 115         /* switch off temporarily (for library-internal use): */
 116         case CRYPTO_MEM_CHECK_DISABLE: /* aka MemCheck_off() */
 117                 mh_mode&= ~CRYPTO_MEM_CHECK_ENABLE;
 118                 break;
 119         case CRYPTO_MEM_CHECK_ENABLE: /* aka MemCheck_on() */
 120                 if (mh_mode&CRYPTO_MEM_CHECK_ON)
 121                         mh_mode|=CRYPTO_MEM_CHECK_ENABLE;
 122                 break;
 123
 124         default:
 125                 break;
 126                 }
 127         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 128         return(ret);
 129         }
 130
 131 static int mem_cmp(MEM *a, MEM *b)
 132         {
 133         return(a->addr - b->addr);
 134         }
 135
 136 static unsigned long mem_hash(MEM *a)
 137         {
 138         unsigned long ret;
 139
 140         ret=(unsigned long)a->addr;
 141
 142         ret=ret*17851+(ret>>14)*7+(ret>>4)*251;
 143         return(ret);
 144         }
 145
 146 static char *(*malloc_locked_func)()=(char *(*)())malloc;
 147 static void (*free_locked_func)()=(void (*)())free;
 148 static char *(*malloc_func)()=  (char *(*)())malloc;
 149 static char *(*realloc_func)()= (char *(*)())realloc;
 150 static void (*free_func)()=     (void (*)())free;
 151
 152 void CRYPTO_set_mem_functions(char *(*m)(), char *(*r)(), void (*f)())
 153         {
 154         if ((m == NULL) || (r == NULL) || (f == NULL)) return;
 155         malloc_func=m;
 156         realloc_func=r;
 157         free_func=f;
 158         malloc_locked_func=m;
 159         free_locked_func=f;
 160         }
 161
 162 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*f)())
 163         {
 164         if ((m == NULL) || (f == NULL)) return;
 165         malloc_locked_func=m;
 166         free_locked_func=f;
 167         }
 168
 169 void CRYPTO_get_mem_functions(char *(**m)(), char *(**r)(), void (**f)())
 170         {
 171         if (m != NULL) *m=malloc_func;
 172         if (r != NULL) *r=realloc_func;
 173         if (f != NULL) *f=free_func;
 174         }
 175
 176 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)())
 177         {
 178         if (m != NULL) *m=malloc_locked_func;
 179         if (f != NULL) *f=free_locked_func;
 180         }
 181
 182 void *CRYPTO_malloc_locked(int num)
 183         {
 184         return(malloc_locked_func(num));
 185         }
 186
 187 void CRYPTO_free_locked(void *str)
 188         {
 189         free_locked_func(str);
 190         }
 191
 192 void *CRYPTO_malloc(int num)
 193         {
 194         return(malloc_func(num));
 195         }
 196
 197 void *CRYPTO_realloc(void *str, int num)
 198         {
 199         return(realloc_func(str,num));
 200         }
 201
 202 void CRYPTO_free(void *str)
 203         {
 204         free_func(str);
 205         }
 206
 207 static unsigned long break_order_num=0;
 208 void *CRYPTO_dbg_malloc(int num, const char *file, int line)
 209         {
 210         char *ret;
 211         MEM *m,*mm;
 212
 213         if ((ret=malloc_func(num)) == NULL)
 214                 return(NULL);
 215
 216         if (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
 217                 {
 218                 MemCheck_off();
 219                 if ((m=(MEM *)Malloc(sizeof(MEM))) == NULL)
 220                         {
 221                         Free(ret);
 222                         MemCheck_on();
 223                         return(NULL);
 224                         }
 225                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 226                 if (mh == NULL)
 227                         {
 228                         if ((mh=lh_new(mem_hash,mem_cmp)) == NULL)
 229                                 {
 230                                 Free(ret);
 231                                 Free(m);
 232                                 ret=NULL;
 233                                 goto err;
 234                                 }
 235                         }
 236
 237                 m->addr=ret;
 238                 m->file=file;
 239                 m->line=line;
 240                 m->num=num;
 241                 if (order == break_order_num)
 242                         {
 243                         /* BREAK HERE */
 244                         m->order=order;
 245                         }
 246                 m->order=order++;
 247 #ifdef CRYPTO_MDEBUG_TIME
 248                 m->time=time(NULL);
 249 #endif
 250                 if ((mm=(MEM *)lh_insert(mh,(char *)m)) != NULL)
 251                         {
 252                         /* Not good, but don't sweat it */
 253                         Free(mm);
 254                         }
 255 err:
 256                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 257                 MemCheck_on();
 258                 }
 259         return(ret);
 260         }
 261
 262 void CRYPTO_dbg_free(void *addr)
 263         {
 264         MEM m,*mp;
 265
 266         if ((mh_mode & CRYPTO_MEM_CHECK_ENABLE) && (mh != NULL))
 267                 {
 268                 MemCheck_off();
 269                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 270                 m.addr=addr;
 271                 mp=(MEM *)lh_delete(mh,(char *)&m);
 272                 if (mp != NULL)
 273                         Free(mp);
 274                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 275                 MemCheck_on();
 276                 }
 277         free_func(addr);
 278         }
 279
 280 void *CRYPTO_dbg_realloc(void *addr, int num, const char *file, int line)
 281         {
 282         char *ret;
 283         MEM m,*mp;
 284
 285         ret=realloc_func(addr,num);
 286         if (ret == addr) return(ret);
 287
 288         if (mh_mode & CRYPTO_MEM_CHECK_ENABLE)
 289                 {
 290                 MemCheck_off();
 291                 if (ret == NULL) return(NULL);
 292                 m.addr=addr;
 293                 CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 294                 mp=(MEM *)lh_delete(mh,(char *)&m);
 295                 if (mp != NULL)
 296                         {
 297                         mp->addr=ret;
 298                         lh_insert(mh,(char *)mp);
 299                         }
 300                 CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 301                 MemCheck_on();
 302                 }
 303         return(ret);
 304         }
 305
 306 void *CRYPTO_remalloc(void *a, int n)
 307         {
 308         if (a != NULL) Free(a);
 309         a=(char *)Malloc(n);
 310         return(a);
 311         }
 312
 313 void *CRYPTO_dbg_remalloc(void *a, int n, const char *file, int line)
 314         {
 315         if (a != NULL) CRYPTO_dbg_free(a);
 316         a=(char *)CRYPTO_dbg_malloc(n,file,line);
 317         return(a);
 318         }
 319
 320
 321 typedef struct mem_leak_st
 322         {
 323         BIO *bio;
 324         int chunks;
 325         long bytes;
 326         } MEM_LEAK;
 327
 328 static void print_leak(MEM *m, MEM_LEAK *l)
 329         {
 330         char buf[128];
 331
 332         if(m->addr == (char *)l->bio)
 333             return;
 334 #ifdef CRYPTO_MDEBUG_TIME
 335         {
 336         struct tm *lcl = localtime(&m->time);
 337         sprintf(buf,"[%02d:%02d:%02d] %5lu file=%s, line=%d, number=%d, address=%08lX\n",
 338                 lcl->tm_hour,lcl->tm_min,lcl->tm_sec,
 339                 m->order,m->file,m->line,m->num,(unsigned long)m->addr);
 340         }
 341 #else
 342         sprintf(buf,"%5lu file=%s, line=%d, number=%d, address=%08lX\n",
 343                 m->order,m->file,m->line,m->num,(unsigned long)m->addr);
 344 #endif
 345         BIO_puts(l->bio,buf);
 346         l->chunks++;
 347         l->bytes+=m->num;
 348         }
 349
 350 void CRYPTO_mem_leaks(BIO *b)
 351         {
 352         MEM_LEAK ml;
 353         char buf[80];
 354
 355         if (mh == NULL) return;
 356         ml.bio=b;
 357         ml.bytes=0;
 358         ml.chunks=0;
 359         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 360         lh_doall_arg(mh,(void (*)())print_leak,(char *)&ml);
 361         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 362         if (ml.chunks != 0)
 363                 {
 364                 sprintf(buf,"%ld bytes leaked in %d chunks\n",
 365                         ml.bytes,ml.chunks);
 366                 BIO_puts(b,buf);
 367                 }
 368
 369 #if 0
 370         lh_stats_bio(mh,b);
 371         lh_node_stats_bio(mh,b);
 372         lh_node_usage_stats_bio(mh,b);
 373 #endif
 374         }
 375
 376 static void (*mem_cb)()=NULL;
 377
 378 static void cb_leak(MEM *m, char *cb)
 379         {
 380         void (*mem_callback)()=(void (*)())cb;
 381         mem_callback(m->order,m->file,m->line,m->num,m->addr);
 382         }
 383
 384 void CRYPTO_mem_leaks_cb(void (*cb)())
 385         {
 386         if (mh == NULL) return;
 387         CRYPTO_w_lock(CRYPTO_LOCK_MALLOC);
 388         mem_cb=cb;
 389         lh_doall_arg(mh,(void (*)())cb_leak,(char *)mem_cb);
 390         mem_cb=NULL;
 391         CRYPTO_w_unlock(CRYPTO_LOCK_MALLOC);
 392         }
 393
 394 #ifndef NO_FP_API
 395 void CRYPTO_mem_leaks_fp(FILE *fp)
 396         {
 397         BIO *b;
 398
 399         if (mh == NULL) return;
 400         if ((b=BIO_new(BIO_s_file())) == NULL)
 401                 return;
 402         BIO_set_fp(b,fp,BIO_NOCLOSE);
 403         CRYPTO_mem_leaks(b);
 404         BIO_free(b);
 405         }
 406 #endif
 407