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 /* may be changed as long as `allow_customize_debug' is set */
  81 /* XXX use correct function pointer types */
  82 #ifdef CRYPTO_MDEBUG
  83   /* use default functions from mem_dbg.c */
  84   static void (*malloc_debug_func)()= (void (*)())CRYPTO_dbg_malloc;
  85   static void (*realloc_debug_func)()= (void (*)())CRYPTO_dbg_realloc;
  86   static void (*free_debug_func)()= (void (*)())CRYPTO_dbg_free;
  87   static void (*set_debug_options_func)()= (void (*)())CRYPTO_dbg_set_options;
  88   static long (*get_debug_options_func)()= (long (*)())CRYPTO_dbg_get_options;
  89 #else
  90   /* applications can use CRYPTO_malloc_debug_init() to select above case
  91    * at run-time */
  92   static void (*malloc_debug_func)()= NULL;
  93   static void (*realloc_debug_func)()= NULL;
  94   static void (*free_debug_func)()= NULL;
  95   static void (*set_debug_options_func)()= NULL;
  96   static long (*get_debug_options_func)()= NULL;
  97 #endif
  98
  99
 100 int CRYPTO_set_mem_functions(void *(*m)(size_t), void *(*r)(void *, size_t),
 101         void (*f)(void *))
 102         {
 103         if (!allow_customize)
 104                 return 0;
 105         if ((m == NULL) || (r == NULL) || (f == NULL))
 106                 return 0;
 107         malloc_func=m;
 108         realloc_func=r;
 109         free_func=f;
 110         malloc_locked_func=m;
 111         free_locked_func=f;
 112         return 1;
 113         }
 114
 115 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*f)(void *))
 116         {
 117         if (!allow_customize)
 118                 return 0;
 119         if ((m == NULL) || (f == NULL))
 120                 return 0;
 121         malloc_locked_func=m;
 122         free_locked_func=f;
 123         return 1;
 124         }
 125
 126 int CRYPTO_set_mem_debug_functions(void (*m)(), void (*r)(), void (*f)(),void (*so)(),long (*go)())
 127         {
 128         if (!allow_customize_debug)
 129                 return 0;
 130         malloc_debug_func=m;
 131         realloc_debug_func=r;
 132         free_debug_func=f;
 133         set_debug_options_func=so;
 134         get_debug_options_func=go;
 135         return 1;
 136         }
 137
 138 void CRYPTO_get_mem_functions(void *(**m)(size_t), void *(**r)(void *, size_t),
 139         void (**f)(void *))
 140         {
 141         if (m != NULL) *m=malloc_func;
 142         if (r != NULL) *r=realloc_func;
 143         if (f != NULL) *f=free_func;
 144         }
 145
 146 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *))
 147         {
 148         if (m != NULL) *m=malloc_locked_func;
 149         if (f != NULL) *f=free_locked_func;
 150         }
 151
 152 void CRYPTO_get_mem_debug_functions(void (**m)(), void (**r)(), void (**f)(),void (**so)(),long (**go)())
 153         {
 154         if (m != NULL) *m=malloc_debug_func;
 155         if (r != NULL) *r=realloc_debug_func;
 156         if (f != NULL) *f=free_debug_func;
 157         if (so != NULL) *so=set_debug_options_func;
 158         if (go != NULL) *go=get_debug_options_func;
 159         }
 160
 161
 162 void *CRYPTO_malloc_locked(int num, char *file, int line)
 163         {
 164         char *ret = NULL;
 165
 166         allow_customize = 0;
 167         if (malloc_debug_func != NULL)
 168                 {
 169                 allow_customize_debug = 0;
 170                 malloc_debug_func(NULL, num, file, line, 0);
 171                 }
 172         ret = malloc_locked_func(num);
 173 #ifdef LEVITTE_DEBUG
 174         fprintf(stderr, "LEVITTE_DEBUG:         > 0x%p (%d)\n", ret, num);
 175 #endif
 176         if (malloc_debug_func != NULL)
 177                 malloc_debug_func(ret, num, file, line, 1);
 178
 179         return ret;
 180         }
 181
 182 void CRYPTO_free_locked(void *str)
 183         {
 184         if (free_debug_func != NULL)
 185                 free_debug_func(str, 0);
 186 #ifdef LEVITTE_DEBUG
 187         fprintf(stderr, "LEVITTE_DEBUG:         < 0x%p\n", str);
 188 #endif
 189         free_locked_func(str);
 190         if (free_debug_func != NULL)
 191                 free_debug_func(NULL, 1);
 192         }
 193
 194 void *CRYPTO_malloc(int num, char *file, int line)
 195         {
 196         char *ret = NULL;
 197
 198         allow_customize = 0;
 199         if (malloc_debug_func != NULL)
 200                 {
 201                 allow_customize_debug = 0;
 202                 malloc_debug_func(NULL, num, file, line, 0);
 203                 }
 204         ret = malloc_func(num);
 205 #ifdef LEVITTE_DEBUG
 206         fprintf(stderr, "LEVITTE_DEBUG:         > 0x%p (%d)\n", ret, num);
 207 #endif
 208         if (malloc_debug_func != NULL)
 209                 malloc_debug_func(ret, num, file, line, 1);
 210
 211         return ret;
 212         }
 213
 214 void *CRYPTO_realloc(void *str, int num, char *file, int line)
 215         {
 216         char *ret = NULL;
 217
 218         if (realloc_debug_func != NULL)
 219                 realloc_debug_func(str, NULL, num, file, line, 0);
 220         ret = realloc_func(str,num);
 221 #ifdef LEVITTE_DEBUG
 222         fprintf(stderr, "LEVITTE_DEBUG:         | 0x%p -> 0x%p (%d)\n", str, ret, num);
 223 #endif
 224         if (realloc_debug_func != NULL)
 225                 realloc_debug_func(str, ret, num, file, line, 1);
 226
 227         return ret;
 228         }
 229
 230 void CRYPTO_free(void *str)
 231         {
 232         if (free_debug_func != NULL)
 233                 free_debug_func(str, 0);
 234 #ifdef LEVITTE_DEBUG
 235         fprintf(stderr, "LEVITTE_DEBUG:         < 0x%p\n", str);
 236 #endif
 237         free_func(str);
 238         if (free_debug_func != NULL)
 239                 free_debug_func(NULL, 1);
 240         }
 241
 242 void *CRYPTO_remalloc(void *a, int num, char *file, int line)
 243         {
 244         if (a != NULL) Free(a);
 245         a=(char *)Malloc(num);
 246         return(a);
 247         }
 248
 249
 250 void CRYPTO_set_mem_debug_options(long bits)
 251         {
 252         if (set_debug_options_func != NULL)
 253                 set_debug_options_func(bits);
 254         }
 255
 256 long CRYPTO_get_mem_debug_options()
 257         {
 258         if (get_debug_options_func != NULL)
 259                 return get_debug_options_func();
 260         return 0;
 261         }