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