]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/mem.c
Add volatile qualifications to two blocks of inline asm to stop GCC from
[thirdparty/openssl.git] / crypto / mem.c
CommitLineData
d02b48c6 1/* crypto/mem.c */
58964a49 2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6
RE
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>
458cddc1 61#include <openssl/crypto.h>
d02b48c6
RE
62#include "cryptlib.h"
63
1f575f1b 64
0cd08cce
BM
65static int allow_customize = 1; /* we provide flexible functions for */
66static 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. */
d02b48c6 72
a5435e8b
BM
73
74
75/* the following pointers may be changed as long as 'allow_customize' is set */
76
0cd08cce 77static void *(*malloc_func)(size_t) = malloc;
a5435e8b
BM
78static void *default_malloc_ex(size_t num, const char *file, int line)
79 { return malloc_func(num); }
80static void *(*malloc_ex_func)(size_t, const char *file, int line)
81 = default_malloc_ex;
82
0cd08cce 83static void *(*realloc_func)(void *, size_t)= realloc;
a5435e8b
BM
84static void *default_realloc_ex(void *str, size_t num,
85 const char *file, int line)
86 { return realloc_func(str,num); }
87static void *(*realloc_ex_func)(void *, size_t, const char *file, int line)
88 = default_realloc_ex;
89
0cd08cce
BM
90static void (*free_func)(void *) = free;
91
a5435e8b
BM
92static void *(*malloc_locked_func)(size_t) = malloc;
93static void *default_malloc_locked_ex(size_t num, const char *file, int line)
94 { return malloc_locked_func(num); }
65a22e8e 95static void *(*malloc_locked_ex_func)(size_t, const char *file, int line)
a5435e8b
BM
96 = default_malloc_locked_ex;
97
98static void (*free_locked_func)(void *) = free;
65a22e8e 99
a5435e8b
BM
100
101
102/* may be changed as long as 'allow_customize_debug' is set */
0cd08cce 103/* XXX use correct function pointer types */
8067d34b 104#if defined(CRYPTO_MDEBUG) && !defined(OPENSSL_FIPS)
65962686
RL
105/* use default functions from mem_dbg.c */
106static void (*malloc_debug_func)(void *,int,const char *,int,int)
107 = CRYPTO_dbg_malloc;
108static void (*realloc_debug_func)(void *,void *,int,const char *,int,int)
109 = CRYPTO_dbg_realloc;
110static void (*free_debug_func)(void *,int) = CRYPTO_dbg_free;
111static void (*set_debug_options_func)(long) = CRYPTO_dbg_set_options;
112static long (*get_debug_options_func)(void) = CRYPTO_dbg_get_options;
8067d34b
DSH
113
114static int (*push_info_func)(const char *info, const char *file, int line)
115 = CRYPTO_dbg_push_info;
116static int (*pop_info_func)(void)
117 = CRYPTO_dbg_pop_info;
118static int (*remove_all_info_func)(void)
119 = CRYPTO_dbg_remove_all_info;
120
f3a2a044 121#else
65962686
RL
122/* applications can use CRYPTO_malloc_debug_init() to select above case
123 * at run-time */
124static void (*malloc_debug_func)(void *,int,const char *,int,int) = NULL;
125static void (*realloc_debug_func)(void *,void *,int,const char *,int,int)
126 = NULL;
127static void (*free_debug_func)(void *,int) = NULL;
128static void (*set_debug_options_func)(long) = NULL;
129static long (*get_debug_options_func)(void) = NULL;
8067d34b
DSH
130
131
132static int (*push_info_func)(const char *info, const char *file, int line)
133 = NULL;
134static int (*pop_info_func)(void) = NULL;
135static int (*remove_all_info_func)(void) = NULL;
136
f3a2a044 137#endif
9ac42ed8 138
0cd08cce
BM
139
140int CRYPTO_set_mem_functions(void *(*m)(size_t), void *(*r)(void *, size_t),
141 void (*f)(void *))
d02b48c6 142 {
0cd08cce
BM
143 if (!allow_customize)
144 return 0;
a5435e8b 145 if ((m == 0) || (r == 0) || (f == 0))
0cd08cce 146 return 0;
a5435e8b
BM
147 malloc_func=m; malloc_ex_func=default_malloc_ex;
148 realloc_func=r; realloc_ex_func=default_realloc_ex;
d02b48c6 149 free_func=f;
a5435e8b 150 malloc_locked_func=m; malloc_locked_ex_func=default_malloc_locked_ex;
dfeab068 151 free_locked_func=f;
0cd08cce
BM
152 return 1;
153 }
154
65a22e8e
RL
155int CRYPTO_set_mem_ex_functions(
156 void *(*m)(size_t,const char *,int),
157 void *(*r)(void *, size_t,const char *,int),
158 void (*f)(void *))
159 {
160 if (!allow_customize)
161 return 0;
a5435e8b
BM
162 if ((m == 0) || (r == 0) || (f == 0))
163 return 0;
164 malloc_func=0; malloc_ex_func=m;
165 realloc_func=0; realloc_ex_func=r;
166 free_func=f;
167 malloc_locked_func=0; malloc_locked_ex_func=m;
168 free_locked_func=f;
65a22e8e
RL
169 return 1;
170 }
171
0cd08cce
BM
172int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*f)(void *))
173 {
174 if (!allow_customize)
175 return 0;
176 if ((m == NULL) || (f == NULL))
177 return 0;
a5435e8b 178 malloc_locked_func=m; malloc_locked_ex_func=default_malloc_locked_ex;
0cd08cce
BM
179 free_locked_func=f;
180 return 1;
dfeab068
RE
181 }
182
65a22e8e
RL
183int CRYPTO_set_locked_mem_ex_functions(
184 void *(*m)(size_t,const char *,int),
185 void (*f)(void *))
186 {
187 if (!allow_customize)
188 return 0;
a5435e8b
BM
189 if ((m == NULL) || (f == NULL))
190 return 0;
191 malloc_locked_func=0; malloc_locked_ex_func=m;
192 free_func=f;
65a22e8e
RL
193 return 1;
194 }
195
65962686
RL
196int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
197 void (*r)(void *,void *,int,const char *,int,int),
198 void (*f)(void *,int),
199 void (*so)(long),
200 long (*go)(void))
9ac42ed8 201 {
0cd08cce
BM
202 if (!allow_customize_debug)
203 return 0;
9ac42ed8
RL
204 malloc_debug_func=m;
205 realloc_debug_func=r;
206 free_debug_func=f;
207 set_debug_options_func=so;
208 get_debug_options_func=go;
0cd08cce 209 return 1;
9ac42ed8
RL
210 }
211
8067d34b
DSH
212void CRYPTO_set_mem_info_functions(
213 int (*push_info_fn)(const char *info, const char *file, int line),
214 int (*pop_info_fn)(void),
215 int (*remove_all_info_fn)(void))
216 {
217 push_info_func = push_info_fn;
218 pop_info_func = pop_info_fn;
219 remove_all_info_func = remove_all_info_fn;
220 }
a5435e8b 221
0cd08cce
BM
222void CRYPTO_get_mem_functions(void *(**m)(size_t), void *(**r)(void *, size_t),
223 void (**f)(void *))
d02b48c6 224 {
b93642c5
BM
225 if (m != NULL) *m = (malloc_ex_func == default_malloc_ex) ?
226 malloc_func : 0;
227 if (r != NULL) *r = (realloc_ex_func == default_realloc_ex) ?
228 realloc_func : 0;
d02b48c6
RE
229 if (f != NULL) *f=free_func;
230 }
231
65a22e8e
RL
232void CRYPTO_get_mem_ex_functions(
233 void *(**m)(size_t,const char *,int),
234 void *(**r)(void *, size_t,const char *,int),
235 void (**f)(void *))
236 {
a5435e8b
BM
237 if (m != NULL) *m = (malloc_ex_func != default_malloc_ex) ?
238 malloc_ex_func : 0;
239 if (r != NULL) *r = (realloc_ex_func != default_realloc_ex) ?
240 realloc_ex_func : 0;
241 if (f != NULL) *f=free_func;
65a22e8e
RL
242 }
243
0cd08cce
BM
244void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *))
245 {
b93642c5
BM
246 if (m != NULL) *m = (malloc_locked_ex_func == default_malloc_locked_ex) ?
247 malloc_locked_func : 0;
0cd08cce
BM
248 if (f != NULL) *f=free_locked_func;
249 }
250
65a22e8e
RL
251void CRYPTO_get_locked_mem_ex_functions(
252 void *(**m)(size_t,const char *,int),
253 void (**f)(void *))
254 {
a5435e8b
BM
255 if (m != NULL) *m = (malloc_locked_ex_func != default_malloc_locked_ex) ?
256 malloc_locked_ex_func : 0;
257 if (f != NULL) *f=free_locked_func;
65a22e8e
RL
258 }
259
65962686
RL
260void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
261 void (**r)(void *,void *,int,const char *,int,int),
262 void (**f)(void *,int),
263 void (**so)(long),
264 long (**go)(void))
dfeab068 265 {
9ac42ed8
RL
266 if (m != NULL) *m=malloc_debug_func;
267 if (r != NULL) *r=realloc_debug_func;
268 if (f != NULL) *f=free_debug_func;
269 if (so != NULL) *so=set_debug_options_func;
270 if (go != NULL) *go=get_debug_options_func;
dfeab068
RE
271 }
272
d02b48c6 273
9d1a01be 274void *CRYPTO_malloc_locked(int num, const char *file, int line)
d02b48c6 275 {
65962686 276 void *ret = NULL;
df29cc8f 277 extern unsigned char cleanse_ctr;
d02b48c6 278
6781efb9 279 if (num <= 0) return NULL;
d5234c7b 280
0cd08cce 281 allow_customize = 0;
f3a2a044 282 if (malloc_debug_func != NULL)
0cd08cce
BM
283 {
284 allow_customize_debug = 0;
f3a2a044 285 malloc_debug_func(NULL, num, file, line, 0);
0cd08cce 286 }
65a22e8e 287 ret = malloc_locked_ex_func(num,file,line);
8d28d5f8
RL
288#ifdef LEVITTE_DEBUG_MEM
289 fprintf(stderr, "LEVITTE_DEBUG_MEM: > 0x%p (%d)\n", ret, num);
3dff94c2 290#endif
f3a2a044
RL
291 if (malloc_debug_func != NULL)
292 malloc_debug_func(ret, num, file, line, 1);
1f575f1b 293
df29cc8f
RL
294 /* Create a dependency on the value of 'cleanse_ctr' so our memory
295 * sanitisation function can't be optimised out. NB: We only do
296 * this for >2Kb so the overhead doesn't bother us. */
297 if(ret && (num > 2048))
298 ((unsigned char *)ret)[0] = cleanse_ctr;
299
9ac42ed8 300 return ret;
d02b48c6
RE
301 }
302
9ac42ed8 303void CRYPTO_free_locked(void *str)
d02b48c6 304 {
f3a2a044
RL
305 if (free_debug_func != NULL)
306 free_debug_func(str, 0);
8d28d5f8
RL
307#ifdef LEVITTE_DEBUG_MEM
308 fprintf(stderr, "LEVITTE_DEBUG_MEM: < 0x%p\n", str);
9ac42ed8 309#endif
a5435e8b 310 free_locked_func(str);
f3a2a044
RL
311 if (free_debug_func != NULL)
312 free_debug_func(NULL, 1);
d02b48c6
RE
313 }
314
9d1a01be 315void *CRYPTO_malloc(int num, const char *file, int line)
d02b48c6 316 {
65962686 317 void *ret = NULL;
df29cc8f 318 extern unsigned char cleanse_ctr;
d02b48c6 319
6781efb9 320 if (num <= 0) return NULL;
d5234c7b 321
0cd08cce 322 allow_customize = 0;
f3a2a044 323 if (malloc_debug_func != NULL)
0cd08cce
BM
324 {
325 allow_customize_debug = 0;
f3a2a044 326 malloc_debug_func(NULL, num, file, line, 0);
0cd08cce 327 }
65a22e8e 328 ret = malloc_ex_func(num,file,line);
8d28d5f8
RL
329#ifdef LEVITTE_DEBUG_MEM
330 fprintf(stderr, "LEVITTE_DEBUG_MEM: > 0x%p (%d)\n", ret, num);
9ac42ed8 331#endif
f3a2a044
RL
332 if (malloc_debug_func != NULL)
333 malloc_debug_func(ret, num, file, line, 1);
d02b48c6 334
df29cc8f
RL
335 /* Create a dependency on the value of 'cleanse_ctr' so our memory
336 * sanitisation function can't be optimised out. NB: We only do
337 * this for >2Kb so the overhead doesn't bother us. */
338 if(ret && (num > 2048))
339 ((unsigned char *)ret)[0] = cleanse_ctr;
340
9ac42ed8 341 return ret;
d02b48c6
RE
342 }
343
9d1a01be 344void *CRYPTO_realloc(void *str, int num, const char *file, int line)
d02b48c6 345 {
65962686 346 void *ret = NULL;
d02b48c6 347
0472883c
RL
348 if (str == NULL)
349 return CRYPTO_malloc(num, file, line);
d5234c7b 350
6781efb9 351 if (num <= 0) return NULL;
d5234c7b 352
f3a2a044
RL
353 if (realloc_debug_func != NULL)
354 realloc_debug_func(str, NULL, num, file, line, 0);
65a22e8e 355 ret = realloc_ex_func(str,num,file,line);
8d28d5f8
RL
356#ifdef LEVITTE_DEBUG_MEM
357 fprintf(stderr, "LEVITTE_DEBUG_MEM: | 0x%p -> 0x%p (%d)\n", str, ret, num);
1f575f1b 358#endif
f3a2a044
RL
359 if (realloc_debug_func != NULL)
360 realloc_debug_func(str, ret, num, file, line, 1);
9ac42ed8
RL
361
362 return ret;
d02b48c6
RE
363 }
364
54a656ef
BL
365void *CRYPTO_realloc_clean(void *str, int old_len, int num, const char *file,
366 int line)
367 {
368 void *ret = NULL;
369
370 if (str == NULL)
371 return CRYPTO_malloc(num, file, line);
d5234c7b 372
6781efb9 373 if (num <= 0) return NULL;
d5234c7b 374
556e27b1
DSH
375 /* We don't support shrinking the buffer. Note the memcpy that copies
376 * |old_len| bytes to the new buffer, below. */
377 if (num < old_len) return NULL;
378
54a656ef
BL
379 if (realloc_debug_func != NULL)
380 realloc_debug_func(str, NULL, num, file, line, 0);
381 ret=malloc_ex_func(num,file,line);
382 if(ret)
83eb412d 383 {
54a656ef 384 memcpy(ret,str,old_len);
83eb412d
RL
385 OPENSSL_cleanse(str,old_len);
386 free_func(str);
387 }
54a656ef 388#ifdef LEVITTE_DEBUG_MEM
83eb412d
RL
389 fprintf(stderr,
390 "LEVITTE_DEBUG_MEM: | 0x%p -> 0x%p (%d)\n",
391 str, ret, num);
54a656ef
BL
392#endif
393 if (realloc_debug_func != NULL)
394 realloc_debug_func(str, ret, num, file, line, 1);
395
396 return ret;
397 }
398
9ac42ed8 399void CRYPTO_free(void *str)
d02b48c6 400 {
f3a2a044
RL
401 if (free_debug_func != NULL)
402 free_debug_func(str, 0);
8d28d5f8
RL
403#ifdef LEVITTE_DEBUG_MEM
404 fprintf(stderr, "LEVITTE_DEBUG_MEM: < 0x%p\n", str);
dfeab068 405#endif
a5435e8b 406 free_func(str);
f3a2a044
RL
407 if (free_debug_func != NULL)
408 free_debug_func(NULL, 1);
d02b48c6
RE
409 }
410
9d1a01be 411void *CRYPTO_remalloc(void *a, int num, const char *file, int line)
d02b48c6 412 {
26a3a48d
RL
413 if (a != NULL) OPENSSL_free(a);
414 a=(char *)OPENSSL_malloc(num);
9ac42ed8 415 return(a);
d02b48c6
RE
416 }
417
0cd08cce 418void CRYPTO_set_mem_debug_options(long bits)
d02b48c6 419 {
f3a2a044
RL
420 if (set_debug_options_func != NULL)
421 set_debug_options_func(bits);
d02b48c6
RE
422 }
423
667ac4ec 424long CRYPTO_get_mem_debug_options(void)
d02b48c6 425 {
f3a2a044
RL
426 if (get_debug_options_func != NULL)
427 return get_debug_options_func();
0cd08cce 428 return 0;
d02b48c6 429 }
8067d34b
DSH
430
431int CRYPTO_push_info_(const char *info, const char *file, int line)
432 {
433 if (push_info_func)
434 return push_info_func(info, file, line);
435 return 1;
436 }
437
438int CRYPTO_pop_info(void)
439 {
440 if (pop_info_func)
441 return pop_info_func();
442 return 1;
443 }
444
445int CRYPTO_remove_all_info(void)
446 {
447 if (remove_all_info_func)
448 return remove_all_info_func();
449 return 1;
450 }