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 #include "cryptlib.h"
  63
  64
  65 static int allow_customize = 1;      /* we provide flexible functions for */
  66 static int allow_customize_debug = 1;/* exchanging memory-related functions at
  67                                       * run-time, but this must be done
  68                                       * before any blocks are actually
  69                                       * allocated; or we'll run into huge
  70                                       * problems when malloc/free pairs
  71                                       * don't match etc. */
  72
  73 /* may be changed as long as `allow_customize' is set */
  74 static void *(*malloc_locked_func)(size_t)  = malloc;
  75 static void (*free_locked_func)(void *)     = free;
  76 static void *(*malloc_func)(size_t)         = malloc;
  77 static void *(*realloc_func)(void *, size_t)= realloc;
  78 static void (*free_func)(void *)            = free;
  79
  80 static void *crypto_i_malloc_ex(size_t, const char *file, int line);
  81 static void *crypto_i_realloc_ex(void *, size_t, const char *file, int line);
  82 static void crypto_i_free_ex(void *);
  83 static void *(*malloc_locked_ex_func)(size_t, const char *file, int line)
  84         = crypto_i_malloc_ex;
  85 static void (*free_locked_ex_func)(void *)
  86         = crypto_i_free_ex;
  87 static void *(*malloc_ex_func)(size_t, const char *file, int line)
  88         = crypto_i_malloc_ex;
  89 static void *(*realloc_ex_func)(void *, size_t, const char *file, int line)
  90         = crypto_i_realloc_ex;
  91 static void (*free_ex_func)(void *)
  92         = crypto_i_free_ex;
  93
  94 /* may be changed as long as `allow_customize_debug' is set */
  95 /* XXX use correct function pointer types */
  96 #ifdef CRYPTO_MDEBUG
  97 /* use default functions from mem_dbg.c */
  98 static void (*malloc_debug_func)(void *,int,const char *,int,int)
  99         = CRYPTO_dbg_malloc;
 100 static void (*realloc_debug_func)(void *,void *,int,const char *,int,int)
 101         = CRYPTO_dbg_realloc;
 102 static void (*free_debug_func)(void *,int) = CRYPTO_dbg_free;
 103 static void (*set_debug_options_func)(long) = CRYPTO_dbg_set_options;
 104 static long (*get_debug_options_func)(void) = CRYPTO_dbg_get_options;
 105 #else
 106 /* applications can use CRYPTO_malloc_debug_init() to select above case
 107  * at run-time */
 108 static void (*malloc_debug_func)(void *,int,const char *,int,int) = NULL;
 109 static void (*realloc_debug_func)(void *,void *,int,const char *,int,int)
 110         = NULL;
 111 static void (*free_debug_func)(void *,int) = NULL;
 112 static void (*set_debug_options_func)(long) = NULL;
 113 static long (*get_debug_options_func)(void) = NULL;
 114 #endif
 115
 116
 117 int CRYPTO_set_mem_functions(void *(*m)(size_t), void *(*r)(void *, size_t),
 118         void (*f)(void *))
 119         {
 120         if (!allow_customize)
 121                 return 0;
 122         if ((m == NULL) || (r == NULL) || (f == NULL))
 123                 return 0;
 124         malloc_func=m;
 125         realloc_func=r;
 126         free_func=f;
 127         malloc_locked_func=m;
 128         free_locked_func=f;
 129         return 1;
 130         }
 131
 132 int CRYPTO_set_mem_ex_functions(
 133         void *(*m)(size_t,const char *,int),
 134         void *(*r)(void *, size_t,const char *,int),
 135         void (*f)(void *))
 136         {
 137         if (!allow_customize)
 138                 return 0;
 139         if (m == NULL) m = crypto_i_malloc_ex;
 140         if (r == NULL) r = crypto_i_realloc_ex;
 141         if (f == NULL) f = crypto_i_free_ex;
 142         malloc_ex_func=m;
 143         realloc_ex_func=r;
 144         free_ex_func=f;
 145         malloc_locked_ex_func=m;
 146         free_locked_ex_func=f;
 147         return 1;
 148         }
 149
 150 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*f)(void *))
 151         {
 152         if (!allow_customize)
 153                 return 0;
 154         if ((m == NULL) || (f == NULL))
 155                 return 0;
 156         malloc_locked_func=m;
 157         free_locked_func=f;
 158         return 1;
 159         }
 160
 161 int CRYPTO_set_locked_mem_ex_functions(
 162         void *(*m)(size_t,const char *,int),
 163         void (*f)(void *))
 164         {
 165         if (!allow_customize)
 166                 return 0;
 167         if (m == NULL) m = crypto_i_malloc_ex;
 168         if (f == NULL) f = crypto_i_free_ex;
 169         malloc_locked_ex_func=m;
 170         free_locked_ex_func=f;
 171         return 1;
 172         }
 173
 174 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
 175                                    void (*r)(void *,void *,int,const char *,int,int),
 176                                    void (*f)(void *,int),
 177                                    void (*so)(long),
 178                                    long (*go)(void))
 179         {
 180         if (!allow_customize_debug)
 181                 return 0;
 182         malloc_debug_func=m;
 183         realloc_debug_func=r;
 184         free_debug_func=f;
 185         set_debug_options_func=so;
 186         get_debug_options_func=go;
 187         return 1;
 188         }
 189
 190 void CRYPTO_get_mem_functions(void *(**m)(size_t), void *(**r)(void *, size_t),
 191         void (**f)(void *))
 192         {
 193         if (m != NULL) *m=malloc_func;
 194         if (r != NULL) *r=realloc_func;
 195         if (f != NULL) *f=free_func;
 196         }
 197
 198 void CRYPTO_get_mem_ex_functions(
 199         void *(**m)(size_t,const char *,int),
 200         void *(**r)(void *, size_t,const char *,int),
 201         void (**f)(void *))
 202         {
 203         if (m != NULL) *m=malloc_ex_func;
 204         if (r != NULL) *r=realloc_ex_func;
 205         if (f != NULL) *f=free_ex_func;
 206         }
 207
 208 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *))
 209         {
 210         if (m != NULL) *m=malloc_locked_func;
 211         if (f != NULL) *f=free_locked_func;
 212         }
 213
 214 void CRYPTO_get_locked_mem_ex_functions(
 215         void *(**m)(size_t,const char *,int),
 216         void (**f)(void *))
 217         {
 218         if (m != NULL) *m=malloc_locked_ex_func;
 219         if (f != NULL) *f=free_locked_ex_func;
 220         }
 221
 222 void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
 223                                     void (**r)(void *,void *,int,const char *,int,int),
 224                                     void (**f)(void *,int),
 225                                     void (**so)(long),
 226                                     long (**go)(void))
 227         {
 228         if (m != NULL) *m=malloc_debug_func;
 229         if (r != NULL) *r=realloc_debug_func;
 230         if (f != NULL) *f=free_debug_func;
 231         if (so != NULL) *so=set_debug_options_func;
 232         if (go != NULL) *go=get_debug_options_func;
 233         }
 234
 235
 236 void *CRYPTO_malloc_locked(int num, const char *file, int line)
 237         {
 238         void *ret = NULL;
 239
 240         allow_customize = 0;
 241         if (malloc_debug_func != NULL)
 242                 {
 243                 allow_customize_debug = 0;
 244                 malloc_debug_func(NULL, num, file, line, 0);
 245                 }
 246         ret = malloc_locked_ex_func(num,file,line);
 247 #ifdef LEVITTE_DEBUG_MEM
 248         fprintf(stderr, "LEVITTE_DEBUG_MEM:         > 0x%p (%d)\n", ret, num);
 249 #endif
 250         if (malloc_debug_func != NULL)
 251                 malloc_debug_func(ret, num, file, line, 1);
 252
 253         return ret;
 254         }
 255
 256 void CRYPTO_free_locked(void *str)
 257         {
 258         if (free_debug_func != NULL)
 259                 free_debug_func(str, 0);
 260 #ifdef LEVITTE_DEBUG_MEM
 261         fprintf(stderr, "LEVITTE_DEBUG_MEM:         < 0x%p\n", str);
 262 #endif
 263         free_locked_ex_func(str);
 264         if (free_debug_func != NULL)
 265                 free_debug_func(NULL, 1);
 266         }
 267
 268 void *CRYPTO_malloc(int num, const char *file, int line)
 269         {
 270         void *ret = NULL;
 271
 272         allow_customize = 0;
 273         if (malloc_debug_func != NULL)
 274                 {
 275                 allow_customize_debug = 0;
 276                 malloc_debug_func(NULL, num, file, line, 0);
 277                 }
 278         ret = malloc_ex_func(num,file,line);
 279 #ifdef LEVITTE_DEBUG_MEM
 280         fprintf(stderr, "LEVITTE_DEBUG_MEM:         > 0x%p (%d)\n", ret, num);
 281 #endif
 282         if (malloc_debug_func != NULL)
 283                 malloc_debug_func(ret, num, file, line, 1);
 284
 285         return ret;
 286         }
 287
 288 void *CRYPTO_realloc(void *str, int num, const char *file, int line)
 289         {
 290         void *ret = NULL;
 291
 292         if (realloc_debug_func != NULL)
 293                 realloc_debug_func(str, NULL, num, file, line, 0);
 294         ret = realloc_ex_func(str,num,file,line);
 295 #ifdef LEVITTE_DEBUG_MEM
 296         fprintf(stderr, "LEVITTE_DEBUG_MEM:         | 0x%p -> 0x%p (%d)\n", str, ret, num);
 297 #endif
 298         if (realloc_debug_func != NULL)
 299                 realloc_debug_func(str, ret, num, file, line, 1);
 300
 301         return ret;
 302         }
 303
 304 void CRYPTO_free(void *str)
 305         {
 306         if (free_debug_func != NULL)
 307                 free_debug_func(str, 0);
 308 #ifdef LEVITTE_DEBUG_MEM
 309         fprintf(stderr, "LEVITTE_DEBUG_MEM:         < 0x%p\n", str);
 310 #endif
 311         free_ex_func(str);
 312         if (free_debug_func != NULL)
 313                 free_debug_func(NULL, 1);
 314         }
 315
 316 void *CRYPTO_remalloc(void *a, int num, const char *file, int line)
 317         {
 318         if (a != NULL) OPENSSL_free(a);
 319         a=(char *)OPENSSL_malloc(num);
 320         return(a);
 321         }
 322
 323
 324 void CRYPTO_set_mem_debug_options(long bits)
 325         {
 326         if (set_debug_options_func != NULL)
 327                 set_debug_options_func(bits);
 328         }
 329
 330 long CRYPTO_get_mem_debug_options(void)
 331         {
 332         if (get_debug_options_func != NULL)
 333                 return get_debug_options_func();
 334         return 0;
 335         }
 336
 337 static void *crypto_i_malloc_ex(size_t num, const char *file, int line)
 338         {
 339         return malloc_func(num);
 340         }
 341
 342 static void *crypto_i_realloc_ex(void *str, size_t num,
 343         const char *file, int line)
 344         {
 345         return realloc_func(str,num);
 346         }
 347
 348 static void crypto_i_free_ex(void *str)
 349         {
 350         free_func(str);
 351         }