Introduce [HAVE_/NO_]MADVISE defines
[openssl.git] / crypto / mem_sec.c
1 /*
2  * Copyright 2015-2022 The OpenSSL Project Authors. All Rights Reserved.
3  * Copyright 2004-2014, Akamai Technologies. All Rights Reserved.
4  *
5  * Licensed under the Apache License 2.0 (the "License").  You may not use
6  * this file except in compliance with the License.  You can obtain a copy
7  * in the file LICENSE in the source distribution or at
8  * https://www.openssl.org/source/license.html
9  */
10
11 /*
12  * This file is in two halves. The first half implements the public API
13  * to be used by external consumers, and to be used by OpenSSL to store
14  * data in a "secure arena." The second half implements the secure arena.
15  * For details on that implementation, see below (look for uppercase
16  * "SECURE HEAP IMPLEMENTATION").
17  */
18 #include "internal/e_os.h"
19 #include <openssl/crypto.h>
20 #include <openssl/err.h>
21
22 #include <string.h>
23
24 #ifndef OPENSSL_NO_SECURE_MEMORY
25 # if defined(_WIN32)
26 #  include <windows.h>
27 #  if defined(WINAPI_FAMILY_PARTITION)
28 #   if !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP | WINAPI_PARTITION_SYSTEM)
29 /*
30  * While VirtualLock is available under the app partition (e.g. UWP),
31  * the headers do not define the API. Define it ourselves instead.
32  */
33 WINBASEAPI
34 BOOL
35 WINAPI
36 VirtualLock(
37     _In_ LPVOID lpAddress,
38     _In_ SIZE_T dwSize
39     );
40 #   endif
41 #  endif
42 # endif
43 # include <stdlib.h>
44 # include <assert.h>
45 # if defined(OPENSSL_SYS_UNIX)
46 #  include <unistd.h>
47 # endif
48 # include <sys/types.h>
49 # if defined(OPENSSL_SYS_UNIX)
50 #  include <sys/mman.h>
51 #  if defined(__FreeBSD__)
52 #    define MADV_DONTDUMP MADV_NOCORE
53 #  endif
54 #  if !defined(MAP_CONCEAL)
55 #    define MAP_CONCEAL 0
56 #  endif
57 # endif
58 # if defined(OPENSSL_SYS_LINUX)
59 #  include <sys/syscall.h>
60 #  if defined(SYS_mlock2)
61 #   include <linux/mman.h>
62 #   include <errno.h>
63 #  endif
64 #  include <sys/param.h>
65 # endif
66 # include <sys/stat.h>
67 # include <fcntl.h>
68 #endif
69 #ifndef HAVE_MADVISE
70 # if defined(MADV_DONTDUMP)
71 #  define HAVE_MADVISE 1
72 # else
73 #  define HAVE_MADVISE 0
74 # endif
75 #endif
76 #if HAVE_MADVISE
77 # undef NO_MADVISE
78 #else
79 # define NO_MADVISE
80 #endif
81
82 #define CLEAR(p, s) OPENSSL_cleanse(p, s)
83 #ifndef PAGE_SIZE
84 # define PAGE_SIZE    4096
85 #endif
86 #if !defined(MAP_ANON) && defined(MAP_ANONYMOUS)
87 # define MAP_ANON MAP_ANONYMOUS
88 #endif
89
90 #ifndef OPENSSL_NO_SECURE_MEMORY
91 static size_t secure_mem_used;
92
93 static int secure_mem_initialized;
94
95 static CRYPTO_RWLOCK *sec_malloc_lock = NULL;
96
97 /*
98  * These are the functions that must be implemented by a secure heap (sh).
99  */
100 static int sh_init(size_t size, size_t minsize);
101 static void *sh_malloc(size_t size);
102 static void sh_free(void *ptr);
103 static void sh_done(void);
104 static size_t sh_actual_size(char *ptr);
105 static int sh_allocated(const char *ptr);
106 #endif
107
108 int CRYPTO_secure_malloc_init(size_t size, size_t minsize)
109 {
110 #ifndef OPENSSL_NO_SECURE_MEMORY
111     int ret = 0;
112
113     if (!secure_mem_initialized) {
114         sec_malloc_lock = CRYPTO_THREAD_lock_new();
115         if (sec_malloc_lock == NULL)
116             return 0;
117         if ((ret = sh_init(size, minsize)) != 0) {
118             secure_mem_initialized = 1;
119         } else {
120             CRYPTO_THREAD_lock_free(sec_malloc_lock);
121             sec_malloc_lock = NULL;
122         }
123     }
124
125     return ret;
126 #else
127     return 0;
128 #endif /* OPENSSL_NO_SECURE_MEMORY */
129 }
130
131 int CRYPTO_secure_malloc_done(void)
132 {
133 #ifndef OPENSSL_NO_SECURE_MEMORY
134     if (secure_mem_used == 0) {
135         sh_done();
136         secure_mem_initialized = 0;
137         CRYPTO_THREAD_lock_free(sec_malloc_lock);
138         sec_malloc_lock = NULL;
139         return 1;
140     }
141 #endif /* OPENSSL_NO_SECURE_MEMORY */
142     return 0;
143 }
144
145 int CRYPTO_secure_malloc_initialized(void)
146 {
147 #ifndef OPENSSL_NO_SECURE_MEMORY
148     return secure_mem_initialized;
149 #else
150     return 0;
151 #endif /* OPENSSL_NO_SECURE_MEMORY */
152 }
153
154 void *CRYPTO_secure_malloc(size_t num, const char *file, int line)
155 {
156 #ifndef OPENSSL_NO_SECURE_MEMORY
157     void *ret = NULL;
158     size_t actual_size;
159     int reason = CRYPTO_R_SECURE_MALLOC_FAILURE;
160
161     if (!secure_mem_initialized) {
162         return CRYPTO_malloc(num, file, line);
163     }
164     if (!CRYPTO_THREAD_write_lock(sec_malloc_lock)) {
165         reason = ERR_R_CRYPTO_LIB;
166         goto err;
167     }
168     ret = sh_malloc(num);
169     actual_size = ret ? sh_actual_size(ret) : 0;
170     secure_mem_used += actual_size;
171     CRYPTO_THREAD_unlock(sec_malloc_lock);
172  err:
173     if (ret == NULL && (file != NULL || line != 0)) {
174         ERR_new();
175         ERR_set_debug(file, line, NULL);
176         ERR_set_error(ERR_LIB_CRYPTO, reason, NULL);
177     }
178     return ret;
179 #else
180     return CRYPTO_malloc(num, file, line);
181 #endif /* OPENSSL_NO_SECURE_MEMORY */
182 }
183
184 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line)
185 {
186 #ifndef OPENSSL_NO_SECURE_MEMORY
187     if (secure_mem_initialized)
188         /* CRYPTO_secure_malloc() zeroes allocations when it is implemented */
189         return CRYPTO_secure_malloc(num, file, line);
190 #endif
191     return CRYPTO_zalloc(num, file, line);
192 }
193
194 void CRYPTO_secure_free(void *ptr, const char *file, int line)
195 {
196 #ifndef OPENSSL_NO_SECURE_MEMORY
197     size_t actual_size;
198
199     if (ptr == NULL)
200         return;
201     if (!CRYPTO_secure_allocated(ptr)) {
202         CRYPTO_free(ptr, file, line);
203         return;
204     }
205     if (!CRYPTO_THREAD_write_lock(sec_malloc_lock))
206         return;
207     actual_size = sh_actual_size(ptr);
208     CLEAR(ptr, actual_size);
209     secure_mem_used -= actual_size;
210     sh_free(ptr);
211     CRYPTO_THREAD_unlock(sec_malloc_lock);
212 #else
213     CRYPTO_free(ptr, file, line);
214 #endif /* OPENSSL_NO_SECURE_MEMORY */
215 }
216
217 void CRYPTO_secure_clear_free(void *ptr, size_t num,
218                               const char *file, int line)
219 {
220 #ifndef OPENSSL_NO_SECURE_MEMORY
221     size_t actual_size;
222
223     if (ptr == NULL)
224         return;
225     if (!CRYPTO_secure_allocated(ptr)) {
226         OPENSSL_cleanse(ptr, num);
227         CRYPTO_free(ptr, file, line);
228         return;
229     }
230     if (!CRYPTO_THREAD_write_lock(sec_malloc_lock))
231         return;
232     actual_size = sh_actual_size(ptr);
233     CLEAR(ptr, actual_size);
234     secure_mem_used -= actual_size;
235     sh_free(ptr);
236     CRYPTO_THREAD_unlock(sec_malloc_lock);
237 #else
238     if (ptr == NULL)
239         return;
240     OPENSSL_cleanse(ptr, num);
241     CRYPTO_free(ptr, file, line);
242 #endif /* OPENSSL_NO_SECURE_MEMORY */
243 }
244
245 int CRYPTO_secure_allocated(const void *ptr)
246 {
247 #ifndef OPENSSL_NO_SECURE_MEMORY
248     if (!secure_mem_initialized)
249         return 0;
250     /*
251      * Only read accesses to the arena take place in sh_allocated() and this
252      * is only changed by the sh_init() and sh_done() calls which are not
253      * locked.  Hence, it is safe to make this check without a lock too.
254      */
255     return sh_allocated(ptr);
256 #else
257     return 0;
258 #endif /* OPENSSL_NO_SECURE_MEMORY */
259 }
260
261 size_t CRYPTO_secure_used(void)
262 {
263 #ifndef OPENSSL_NO_SECURE_MEMORY
264     return secure_mem_used;
265 #else
266     return 0;
267 #endif /* OPENSSL_NO_SECURE_MEMORY */
268 }
269
270 size_t CRYPTO_secure_actual_size(void *ptr)
271 {
272 #ifndef OPENSSL_NO_SECURE_MEMORY
273     size_t actual_size;
274
275     if (!CRYPTO_THREAD_write_lock(sec_malloc_lock))
276         return 0;
277     actual_size = sh_actual_size(ptr);
278     CRYPTO_THREAD_unlock(sec_malloc_lock);
279     return actual_size;
280 #else
281     return 0;
282 #endif
283 }
284
285 /*
286  * SECURE HEAP IMPLEMENTATION
287  */
288 #ifndef OPENSSL_NO_SECURE_MEMORY
289
290
291 /*
292  * The implementation provided here uses a fixed-sized mmap() heap,
293  * which is locked into memory, not written to core files, and protected
294  * on either side by an unmapped page, which will catch pointer overruns
295  * (or underruns) and an attempt to read data out of the secure heap.
296  * Free'd memory is zero'd or otherwise cleansed.
297  *
298  * This is a pretty standard buddy allocator.  We keep areas in a multiple
299  * of "sh.minsize" units.  The freelist and bitmaps are kept separately,
300  * so all (and only) data is kept in the mmap'd heap.
301  *
302  * This code assumes eight-bit bytes.  The numbers 3 and 7 are all over the
303  * place.
304  */
305
306 #define ONE ((size_t)1)
307
308 # define TESTBIT(t, b)  (t[(b) >> 3] &  (ONE << ((b) & 7)))
309 # define SETBIT(t, b)   (t[(b) >> 3] |= (ONE << ((b) & 7)))
310 # define CLEARBIT(t, b) (t[(b) >> 3] &= (0xFF & ~(ONE << ((b) & 7))))
311
312 #define WITHIN_ARENA(p) \
313     ((char*)(p) >= sh.arena && (char*)(p) < &sh.arena[sh.arena_size])
314 #define WITHIN_FREELIST(p) \
315     ((char*)(p) >= (char*)sh.freelist && (char*)(p) < (char*)&sh.freelist[sh.freelist_size])
316
317
318 typedef struct sh_list_st
319 {
320     struct sh_list_st *next;
321     struct sh_list_st **p_next;
322 } SH_LIST;
323
324 typedef struct sh_st
325 {
326     char* map_result;
327     size_t map_size;
328     char *arena;
329     size_t arena_size;
330     char **freelist;
331     ossl_ssize_t freelist_size;
332     size_t minsize;
333     unsigned char *bittable;
334     unsigned char *bitmalloc;
335     size_t bittable_size; /* size in bits */
336 } SH;
337
338 static SH sh;
339
340 static size_t sh_getlist(char *ptr)
341 {
342     ossl_ssize_t list = sh.freelist_size - 1;
343     size_t bit = (sh.arena_size + ptr - sh.arena) / sh.minsize;
344
345     for (; bit; bit >>= 1, list--) {
346         if (TESTBIT(sh.bittable, bit))
347             break;
348         OPENSSL_assert((bit & 1) == 0);
349     }
350
351     return list;
352 }
353
354
355 static int sh_testbit(char *ptr, int list, unsigned char *table)
356 {
357     size_t bit;
358
359     OPENSSL_assert(list >= 0 && list < sh.freelist_size);
360     OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
361     bit = (ONE << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
362     OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
363     return TESTBIT(table, bit);
364 }
365
366 static void sh_clearbit(char *ptr, int list, unsigned char *table)
367 {
368     size_t bit;
369
370     OPENSSL_assert(list >= 0 && list < sh.freelist_size);
371     OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
372     bit = (ONE << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
373     OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
374     OPENSSL_assert(TESTBIT(table, bit));
375     CLEARBIT(table, bit);
376 }
377
378 static void sh_setbit(char *ptr, int list, unsigned char *table)
379 {
380     size_t bit;
381
382     OPENSSL_assert(list >= 0 && list < sh.freelist_size);
383     OPENSSL_assert(((ptr - sh.arena) & ((sh.arena_size >> list) - 1)) == 0);
384     bit = (ONE << list) + ((ptr - sh.arena) / (sh.arena_size >> list));
385     OPENSSL_assert(bit > 0 && bit < sh.bittable_size);
386     OPENSSL_assert(!TESTBIT(table, bit));
387     SETBIT(table, bit);
388 }
389
390 static void sh_add_to_list(char **list, char *ptr)
391 {
392     SH_LIST *temp;
393
394     OPENSSL_assert(WITHIN_FREELIST(list));
395     OPENSSL_assert(WITHIN_ARENA(ptr));
396
397     temp = (SH_LIST *)ptr;
398     temp->next = *(SH_LIST **)list;
399     OPENSSL_assert(temp->next == NULL || WITHIN_ARENA(temp->next));
400     temp->p_next = (SH_LIST **)list;
401
402     if (temp->next != NULL) {
403         OPENSSL_assert((char **)temp->next->p_next == list);
404         temp->next->p_next = &(temp->next);
405     }
406
407     *list = ptr;
408 }
409
410 static void sh_remove_from_list(char *ptr)
411 {
412     SH_LIST *temp, *temp2;
413
414     temp = (SH_LIST *)ptr;
415     if (temp->next != NULL)
416         temp->next->p_next = temp->p_next;
417     *temp->p_next = temp->next;
418     if (temp->next == NULL)
419         return;
420
421     temp2 = temp->next;
422     OPENSSL_assert(WITHIN_FREELIST(temp2->p_next) || WITHIN_ARENA(temp2->p_next));
423 }
424
425
426 static int sh_init(size_t size, size_t minsize)
427 {
428     int ret;
429     size_t i;
430     size_t pgsize;
431     size_t aligned;
432 #if defined(_WIN32)
433     DWORD flOldProtect;
434     SYSTEM_INFO systemInfo;
435 #endif
436
437     memset(&sh, 0, sizeof(sh));
438
439     /* make sure size is a powers of 2 */
440     OPENSSL_assert(size > 0);
441     OPENSSL_assert((size & (size - 1)) == 0);
442     if (size == 0 || (size & (size - 1)) != 0)
443         goto err;
444
445     if (minsize <= sizeof(SH_LIST)) {
446         OPENSSL_assert(sizeof(SH_LIST) <= 65536);
447         /*
448          * Compute the minimum possible allocation size.
449          * This must be a power of 2 and at least as large as the SH_LIST
450          * structure.
451          */
452         minsize = sizeof(SH_LIST) - 1;
453         minsize |= minsize >> 1;
454         minsize |= minsize >> 2;
455         if (sizeof(SH_LIST) > 16)
456             minsize |= minsize >> 4;
457         if (sizeof(SH_LIST) > 256)
458             minsize |= minsize >> 8;
459         minsize++;
460     } else {
461         /* make sure minsize is a powers of 2 */
462           OPENSSL_assert((minsize & (minsize - 1)) == 0);
463           if ((minsize & (minsize - 1)) != 0)
464               goto err;
465     }
466
467     sh.arena_size = size;
468     sh.minsize = minsize;
469     sh.bittable_size = (sh.arena_size / sh.minsize) * 2;
470
471     /* Prevent allocations of size 0 later on */
472     if (sh.bittable_size >> 3 == 0)
473         goto err;
474
475     sh.freelist_size = -1;
476     for (i = sh.bittable_size; i; i >>= 1)
477         sh.freelist_size++;
478
479     sh.freelist = OPENSSL_zalloc(sh.freelist_size * sizeof(char *));
480     OPENSSL_assert(sh.freelist != NULL);
481     if (sh.freelist == NULL)
482         goto err;
483
484     sh.bittable = OPENSSL_zalloc(sh.bittable_size >> 3);
485     OPENSSL_assert(sh.bittable != NULL);
486     if (sh.bittable == NULL)
487         goto err;
488
489     sh.bitmalloc = OPENSSL_zalloc(sh.bittable_size >> 3);
490     OPENSSL_assert(sh.bitmalloc != NULL);
491     if (sh.bitmalloc == NULL)
492         goto err;
493
494     /* Allocate space for heap, and two extra pages as guards */
495 #if defined(_SC_PAGE_SIZE) || defined (_SC_PAGESIZE)
496     {
497 # if defined(_SC_PAGE_SIZE)
498         long tmppgsize = sysconf(_SC_PAGE_SIZE);
499 # else
500         long tmppgsize = sysconf(_SC_PAGESIZE);
501 # endif
502         if (tmppgsize < 1)
503             pgsize = PAGE_SIZE;
504         else
505             pgsize = (size_t)tmppgsize;
506     }
507 #elif defined(_WIN32)
508     GetSystemInfo(&systemInfo);
509     pgsize = (size_t)systemInfo.dwPageSize;
510 #else
511     pgsize = PAGE_SIZE;
512 #endif
513     sh.map_size = pgsize + sh.arena_size + pgsize;
514
515 #if !defined(_WIN32)
516 # ifdef MAP_ANON
517     sh.map_result = mmap(NULL, sh.map_size,
518                          PROT_READ|PROT_WRITE, MAP_ANON|MAP_PRIVATE|MAP_CONCEAL, -1, 0);
519 # else
520     {
521         int fd;
522
523         sh.map_result = MAP_FAILED;
524         if ((fd = open("/dev/zero", O_RDWR)) >= 0) {
525             sh.map_result = mmap(NULL, sh.map_size,
526                                  PROT_READ|PROT_WRITE, MAP_PRIVATE, fd, 0);
527             close(fd);
528         }
529     }
530 # endif
531     if (sh.map_result == MAP_FAILED)
532         goto err;
533 #else
534     sh.map_result = VirtualAlloc(NULL, sh.map_size, MEM_COMMIT | MEM_RESERVE, PAGE_READWRITE);
535
536     if (sh.map_result == NULL)
537             goto err;
538 #endif
539
540     sh.arena = (char *)(sh.map_result + pgsize);
541     sh_setbit(sh.arena, 0, sh.bittable);
542     sh_add_to_list(&sh.freelist[0], sh.arena);
543
544     /* Now try to add guard pages and lock into memory. */
545     ret = 1;
546
547 #if !defined(_WIN32)
548     /* Starting guard is already aligned from mmap. */
549     if (mprotect(sh.map_result, pgsize, PROT_NONE) < 0)
550         ret = 2;
551 #else
552     if (VirtualProtect(sh.map_result, pgsize, PAGE_NOACCESS, &flOldProtect) == FALSE)
553         ret = 2;
554 #endif
555
556     /* Ending guard page - need to round up to page boundary */
557     aligned = (pgsize + sh.arena_size + (pgsize - 1)) & ~(pgsize - 1);
558 #if !defined(_WIN32)
559     if (mprotect(sh.map_result + aligned, pgsize, PROT_NONE) < 0)
560         ret = 2;
561 #else
562     if (VirtualProtect(sh.map_result + aligned, pgsize, PAGE_NOACCESS, &flOldProtect) == FALSE)
563         ret = 2;
564 #endif
565
566 #if defined(OPENSSL_SYS_LINUX) && defined(MLOCK_ONFAULT) && defined(SYS_mlock2)
567     if (syscall(SYS_mlock2, sh.arena, sh.arena_size, MLOCK_ONFAULT) < 0) {
568         if (errno == ENOSYS) {
569             if (mlock(sh.arena, sh.arena_size) < 0)
570                 ret = 2;
571         } else {
572             ret = 2;
573         }
574     }
575 #elif defined(_WIN32)
576     if (VirtualLock(sh.arena, sh.arena_size) == FALSE)
577         ret = 2;
578 #else
579     if (mlock(sh.arena, sh.arena_size) < 0)
580         ret = 2;
581 #endif
582 #ifndef NO_MADVISE
583     if (madvise(sh.arena, sh.arena_size, MADV_DONTDUMP) < 0)
584         ret = 2;
585 #endif
586
587     return ret;
588
589  err:
590     sh_done();
591     return 0;
592 }
593
594 static void sh_done(void)
595 {
596     OPENSSL_free(sh.freelist);
597     OPENSSL_free(sh.bittable);
598     OPENSSL_free(sh.bitmalloc);
599 #if !defined(_WIN32)
600     if (sh.map_result != MAP_FAILED && sh.map_size)
601         munmap(sh.map_result, sh.map_size);
602 #else
603     if (sh.map_result != NULL && sh.map_size)
604         VirtualFree(sh.map_result, 0, MEM_RELEASE);
605 #endif
606     memset(&sh, 0, sizeof(sh));
607 }
608
609 static int sh_allocated(const char *ptr)
610 {
611     return WITHIN_ARENA(ptr) ? 1 : 0;
612 }
613
614 static char *sh_find_my_buddy(char *ptr, int list)
615 {
616     size_t bit;
617     char *chunk = NULL;
618
619     bit = (ONE << list) + (ptr - sh.arena) / (sh.arena_size >> list);
620     bit ^= 1;
621
622     if (TESTBIT(sh.bittable, bit) && !TESTBIT(sh.bitmalloc, bit))
623         chunk = sh.arena + ((bit & ((ONE << list) - 1)) * (sh.arena_size >> list));
624
625     return chunk;
626 }
627
628 static void *sh_malloc(size_t size)
629 {
630     ossl_ssize_t list, slist;
631     size_t i;
632     char *chunk;
633
634     if (size > sh.arena_size)
635         return NULL;
636
637     list = sh.freelist_size - 1;
638     for (i = sh.minsize; i < size; i <<= 1)
639         list--;
640     if (list < 0)
641         return NULL;
642
643     /* try to find a larger entry to split */
644     for (slist = list; slist >= 0; slist--)
645         if (sh.freelist[slist] != NULL)
646             break;
647     if (slist < 0)
648         return NULL;
649
650     /* split larger entry */
651     while (slist != list) {
652         char *temp = sh.freelist[slist];
653
654         /* remove from bigger list */
655         OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
656         sh_clearbit(temp, slist, sh.bittable);
657         sh_remove_from_list(temp);
658         OPENSSL_assert(temp != sh.freelist[slist]);
659
660         /* done with bigger list */
661         slist++;
662
663         /* add to smaller list */
664         OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
665         sh_setbit(temp, slist, sh.bittable);
666         sh_add_to_list(&sh.freelist[slist], temp);
667         OPENSSL_assert(sh.freelist[slist] == temp);
668
669         /* split in 2 */
670         temp += sh.arena_size >> slist;
671         OPENSSL_assert(!sh_testbit(temp, slist, sh.bitmalloc));
672         sh_setbit(temp, slist, sh.bittable);
673         sh_add_to_list(&sh.freelist[slist], temp);
674         OPENSSL_assert(sh.freelist[slist] == temp);
675
676         OPENSSL_assert(temp-(sh.arena_size >> slist) == sh_find_my_buddy(temp, slist));
677     }
678
679     /* peel off memory to hand back */
680     chunk = sh.freelist[list];
681     OPENSSL_assert(sh_testbit(chunk, list, sh.bittable));
682     sh_setbit(chunk, list, sh.bitmalloc);
683     sh_remove_from_list(chunk);
684
685     OPENSSL_assert(WITHIN_ARENA(chunk));
686
687     /* zero the free list header as a precaution against information leakage */
688     memset(chunk, 0, sizeof(SH_LIST));
689
690     return chunk;
691 }
692
693 static void sh_free(void *ptr)
694 {
695     size_t list;
696     void *buddy;
697
698     if (ptr == NULL)
699         return;
700     OPENSSL_assert(WITHIN_ARENA(ptr));
701     if (!WITHIN_ARENA(ptr))
702         return;
703
704     list = sh_getlist(ptr);
705     OPENSSL_assert(sh_testbit(ptr, list, sh.bittable));
706     sh_clearbit(ptr, list, sh.bitmalloc);
707     sh_add_to_list(&sh.freelist[list], ptr);
708
709     /* Try to coalesce two adjacent free areas. */
710     while ((buddy = sh_find_my_buddy(ptr, list)) != NULL) {
711         OPENSSL_assert(ptr == sh_find_my_buddy(buddy, list));
712         OPENSSL_assert(ptr != NULL);
713         OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
714         sh_clearbit(ptr, list, sh.bittable);
715         sh_remove_from_list(ptr);
716         OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
717         sh_clearbit(buddy, list, sh.bittable);
718         sh_remove_from_list(buddy);
719
720         list--;
721
722         /* Zero the higher addressed block's free list pointers */
723         memset(ptr > buddy ? ptr : buddy, 0, sizeof(SH_LIST));
724         if (ptr > buddy)
725             ptr = buddy;
726
727         OPENSSL_assert(!sh_testbit(ptr, list, sh.bitmalloc));
728         sh_setbit(ptr, list, sh.bittable);
729         sh_add_to_list(&sh.freelist[list], ptr);
730         OPENSSL_assert(sh.freelist[list] == ptr);
731     }
732 }
733
734 static size_t sh_actual_size(char *ptr)
735 {
736     int list;
737
738     OPENSSL_assert(WITHIN_ARENA(ptr));
739     if (!WITHIN_ARENA(ptr))
740         return 0;
741     list = sh_getlist(ptr);
742     OPENSSL_assert(sh_testbit(ptr, list, sh.bittable));
743     return sh.arena_size / (ONE << list);
744 }
745 #endif /* OPENSSL_NO_SECURE_MEMORY */