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