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