- Added more documentation in CHANGES.
[openssl.git] / 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 char *(*malloc_locked_func)()=(char *(*)())malloc;
66 static void (*free_locked_func)()=(void (*)())free;
67 static char *(*malloc_func)()=  (char *(*)())malloc;
68 static char *(*realloc_func)()= (char *(*)())realloc;
69 static void (*free_func)()=     (void (*)())free;
70
71 #ifdef CRYPTO_MDEBUG
72 static void (*malloc_debug_func)()= (void (*)())CRYPTO_dbg_malloc;
73 static void (*realloc_debug_func)()= (void (*)())CRYPTO_dbg_realloc;
74 static void (*free_debug_func)()= (void (*)())CRYPTO_dbg_free;
75 static void (*set_debug_options_func)()= (void (*)())CRYPTO_dbg_set_options;
76 static int (*get_debug_options_func)()= (int (*)())CRYPTO_dbg_get_options;
77 #else
78 static void (*malloc_debug_func)()= (void (*)())NULL;
79 static void (*realloc_debug_func)()= (void (*)())NULL;
80 static void (*free_debug_func)()= (void (*)())NULL;
81 static void (*set_debug_options_func)()= (void (*)())NULL;
82 static int (*get_debug_options_func)()= (int (*)())NULL;
83 #endif
84
85 void CRYPTO_set_mem_functions(char *(*m)(), char *(*r)(), void (*f)())
86         {
87         if ((m == NULL) || (r == NULL) || (f == NULL)) return;
88         malloc_func=m;
89         realloc_func=r;
90         free_func=f;
91         malloc_locked_func=m;
92         free_locked_func=f;
93         }
94
95 void CRYPTO_set_mem_debug_functions(void (*m)(), void (*r)(), void (*f)(),void (*so)(),int (*go)())
96         {
97         if ((m == NULL) || (r == NULL) || (f == NULL) || (so == NULL) || (go == NULL))
98                 return;
99         malloc_debug_func=m;
100         realloc_debug_func=r;
101         free_debug_func=f;
102         set_debug_options_func=so;
103         get_debug_options_func=go;
104         }
105
106 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*f)())
107         {
108         if ((m == NULL) || (f == NULL)) return;
109         malloc_locked_func=m;
110         free_locked_func=f;
111         }
112
113 void CRYPTO_get_mem_functions(char *(**m)(), char *(**r)(), void (**f)())
114         {
115         if (m != NULL) *m=malloc_func;
116         if (r != NULL) *r=realloc_func;
117         if (f != NULL) *f=free_func;
118         }
119
120 void CRYPTO_get_mem_debug_functions(void (**m)(), void (**r)(), void (**f)(),void (**so)(),int (**go)())
121         {
122         if (m != NULL) *m=malloc_debug_func;
123         if (r != NULL) *r=realloc_debug_func;
124         if (f != NULL) *f=free_debug_func;
125         if (so != NULL) *so=set_debug_options_func;
126         if (go != NULL) *go=get_debug_options_func;
127         }
128
129 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)())
130         {
131         if (m != NULL) *m=malloc_locked_func;
132         if (f != NULL) *f=free_locked_func;
133         }
134
135 void *CRYPTO_malloc_locked(int num, char *file, int line)
136         {
137         char *ret = NULL;
138
139         if (malloc_debug_func != NULL)
140                 malloc_debug_func(NULL, num, file, line, 0);
141         ret = malloc_locked_func(num);
142 #ifdef LEVITTE_DEBUG
143         fprintf(stderr, "LEVITTE_DEBUG:         > 0x%p (%d)\n", ret, num);
144 #endif
145         if (malloc_debug_func != NULL)
146                 malloc_debug_func(ret, num, file, line, 1);
147
148         return ret;
149         }
150
151 void CRYPTO_free_locked(void *str)
152         {
153         if (free_debug_func != NULL)
154                 free_debug_func(str, 0);
155 #ifdef LEVITTE_DEBUG
156         fprintf(stderr, "LEVITTE_DEBUG:         < 0x%p\n", str);
157 #endif
158         free_locked_func(str);
159         if (free_debug_func != NULL)
160                 free_debug_func(NULL, 1);
161         }
162
163 void *CRYPTO_malloc(int num, char *file, int line)
164         {
165         char *ret = NULL;
166
167         if (malloc_debug_func != NULL)
168                 malloc_debug_func(NULL, num, file, line, 0);
169         ret = malloc_func(num);
170 #ifdef LEVITTE_DEBUG
171         fprintf(stderr, "LEVITTE_DEBUG:         > 0x%p (%d)\n", ret, num);
172 #endif
173         if (malloc_debug_func != NULL)
174                 malloc_debug_func(ret, num, file, line, 1);
175
176         return ret;
177         }
178
179 void *CRYPTO_realloc(void *str, int num, char *file, int line)
180         {
181         char *ret = NULL;
182
183         if (realloc_debug_func != NULL)
184                 realloc_debug_func(str, NULL, num, file, line, 0);
185         ret = realloc_func(str,num);
186 #ifdef LEVITTE_DEBUG
187         fprintf(stderr, "LEVITTE_DEBUG:         | 0x%p -> 0x%p (%d)\n", str, ret, num);
188 #endif
189         if (realloc_debug_func != NULL)
190                 realloc_debug_func(str, ret, num, file, line, 1);
191
192         return ret;
193         }
194
195 void CRYPTO_free(void *str)
196         {
197         if (free_debug_func != NULL)
198                 free_debug_func(str, 0);
199 #ifdef LEVITTE_DEBUG
200         fprintf(stderr, "LEVITTE_DEBUG:         < 0x%p\n", str);
201 #endif
202         free_func(str);
203         if (free_debug_func != NULL)
204                 free_debug_func(NULL, 1);
205         }
206
207
208 void *CRYPTO_remalloc(void *a, int num, char *file, int line)
209         {
210         if (a != NULL) Free(a);
211         a=(char *)Malloc(num);
212         return(a);
213         }
214
215 void CRYPTO_set_mem_debug_options(int bits)
216         {
217         if (set_debug_options_func != NULL)
218                 set_debug_options_func(bits);
219         }
220
221 int CRYPTO_get_mem_debug_options()
222         {
223         if (get_debug_options_func != NULL)
224                 return get_debug_options_func();
225         }