BIO_PAIR_DEBUG did nothing; remove it.
[openssl.git] / crypto / mem.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include <stdlib.h>
60 #include <limits.h>
61 #include <openssl/crypto.h>
62 #include "internal/cryptlib.h"
63
64 /*
65  * the following pointers may be changed as long as 'allow_customize' is set
66  */
67 static int allow_customize = 1;
68
69 static void *(*malloc_wrapper)(size_t, const char *, int)
70     = CRYPTO_malloc;
71 static void *(*realloc_wrapper)(void *, size_t, const char *, int)
72     = CRYPTO_realloc;
73 static void (*free_wrapper)(void *)
74     = CRYPTO_free;
75
76 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
77 static int call_malloc_debug = 1;
78 #else
79 static int call_malloc_debug = 0;
80 #endif
81
82 int CRYPTO_set_mem_functions(
83         void *(*m)(size_t, const char *, int),
84         void *(*r)(void *, size_t, const char *, int),
85         void (*f)(void *))
86 {
87     if (!allow_customize)
88         return 0;
89     if (m)
90         malloc_wrapper = m;
91     if (r)
92         realloc_wrapper = r;
93     if (f)
94         free_wrapper = f;
95     return 1;
96 }
97
98 int CRYPTO_set_mem_debug(int flag)
99 {
100     if (!allow_customize)
101         return 0;
102     call_malloc_debug = flag;
103     return 1;
104 }
105
106 void CRYPTO_get_mem_functions(
107         void *(**m)(size_t, const char *, int),
108         void *(**r)(void *, size_t, const char *, int),
109         void (**f)(void *))
110 {
111     if (m != NULL)
112         *m = malloc_wrapper;
113     if (r != NULL)
114         *r = realloc_wrapper;
115     if (f != NULL)
116         *f = free_wrapper;
117 }
118
119 void *CRYPTO_malloc(size_t num, const char *file, int line)
120 {
121     void *ret = NULL;
122
123     if (num <= 0)
124         return NULL;
125
126     allow_customize = 0;
127 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
128     if (call_malloc_debug) {
129         CRYPTO_mem_debug_malloc(NULL, num, 0, file, line);
130         ret = malloc(num);
131         CRYPTO_mem_debug_malloc(ret, num, 1, file, line);
132     } else {
133         ret = malloc(num);
134     }
135 #else
136     (void)file;
137     (void)line;
138     ret = malloc(num);
139 #endif
140
141 #ifndef OPENSSL_CPUID_OBJ
142     /*
143      * Create a dependency on the value of 'cleanse_ctr' so our memory
144      * sanitisation function can't be optimised out. NB: We only do this for
145      * >2Kb so the overhead doesn't bother us.
146      */
147     if (ret && (num > 2048)) {
148         extern unsigned char cleanse_ctr;
149         ((unsigned char *)ret)[0] = cleanse_ctr;
150     }
151 #endif
152
153     return ret;
154 }
155
156 void *CRYPTO_zalloc(size_t num, const char *file, int line)
157 {
158     void *ret = CRYPTO_malloc(num, file, line);
159
160     if (ret != NULL)
161         memset(ret, 0, num);
162     return ret;
163 }
164
165 void *CRYPTO_realloc(void *str, size_t num, const char *file, int line)
166 {
167     if (str == NULL)
168         return CRYPTO_malloc(num, file, line);
169
170     if (num == 0) {
171         CRYPTO_free(str);
172         return NULL;
173     }
174
175     allow_customize = 0;
176 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
177     if (call_malloc_debug) {
178         void *ret;
179         CRYPTO_mem_debug_realloc(str, NULL, num, 0, file, line);
180         ret = realloc(str, num);
181         CRYPTO_mem_debug_realloc(str, ret, num, 1, file, line);
182         return ret;
183     }
184 #else
185     (void)file;
186     (void)line;
187 #endif
188     return realloc(str, num);
189
190 }
191
192 void *CRYPTO_clear_realloc(void *str, size_t old_len, size_t num,
193                            const char *file, int line)
194 {
195     void *ret = NULL;
196
197     if (str == NULL)
198         return CRYPTO_malloc(num, file, line);
199
200     if (num == 0) {
201         CRYPTO_clear_free(str, old_len);
202         return NULL;
203     }
204
205     /* Can't shrink the buffer since memcpy below copies |old_len| bytes. */
206     if (num < old_len) {
207         memset((char*)str + num, 0, old_len - num);
208         return str;
209     }
210
211     /* Allocate new memory.  Call malloc and do a copy, so that we can
212      * cleanse the old buffer. */
213 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
214     if (call_malloc_debug) {
215         CRYPTO_mem_debug_realloc(str, NULL, num, 0, file, line);
216         ret = malloc(num);
217         CRYPTO_mem_debug_realloc(str, ret, num, 1, file, line);
218     } else {
219         ret = malloc(num);
220     }
221 #else
222     (void)file;
223     (void)line;
224     ret = malloc(num);
225 #endif
226
227     if (ret)
228         memcpy(ret, str, old_len);
229     CRYPTO_clear_free(str, old_len);
230     return ret;
231 }
232
233 void CRYPTO_free(void *str)
234 {
235 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
236     if (call_malloc_debug) {
237         CRYPTO_mem_debug_free(str, 0);
238         free(str);
239         CRYPTO_mem_debug_free(str, 1);
240     } else {
241         free(str);
242     }
243 #else
244     free(str);
245 #endif
246 }
247
248 void CRYPTO_clear_free(void *str, size_t num)
249 {
250     if (str == NULL)
251         return;
252     if (num)
253         OPENSSL_cleanse(str, num);
254     CRYPTO_free(str);
255 }