Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add global heap hint setter function #7478

Merged
merged 4 commits into from
May 15, 2024
Merged

add global heap hint setter function #7478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de3d1a4
add global heap hint setter function
JacobBarthelmeh Apr 26, 2024
98a19f9
add debug log and adjust set global heap hint function
JacobBarthelmeh Apr 30, 2024
d68f3cf
add macro guard around test case
JacobBarthelmeh Apr 30, 2024
9aeef1d
add void and remove rebase issue
JacobBarthelmeh May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 55 additions & 6 deletions wolfcrypt/src/memory.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,31 @@ int wolfSSL_GetMemStats(WOLFSSL_HEAP* heap, WOLFSSL_MEM_STATS* stats)
}


/* global heap hint to fall back on when no heap hint is passed to
* XMALLOC/XFREE
* NOT thread safe, should be set once before any expected XMALLOC XFREE calls
*/
static void* globalHeapHint = NULL;


/* Used to set a new global heap hint. Returns a pointer to the current global
* heap hint before being set. */
void* wolfSSL_SetGlobalHeapHint(void* heap)
{
void *oldHint = globalHeapHint;

globalHeapHint = heap;
return oldHint;
}


/* returns a pointer to the current global heap hint */
void* wolfSSL_GetGlobalHeapHint(void)
{
return globalHeapHint;
}


#ifdef WOLFSSL_DEBUG_MEMORY
void* wolfSSL_Malloc(size_t size, void* heap, int type, const char* func, unsigned int line)
#else
Expand All @@ -917,7 +942,7 @@ void* wolfSSL_Malloc(size_t size, void* heap, int type)
#endif

/* if no heap hint then use dynamic memory*/
if (heap == NULL) {
if (heap == NULL && globalHeapHint == NULL) {
#ifdef WOLFSSL_HEAP_TEST
/* allow using malloc for creating ctx and method */
if (type == DYNAMIC_TYPE_CTX || type == DYNAMIC_TYPE_METHOD ||
Expand Down Expand Up @@ -952,7 +977,15 @@ void* wolfSSL_Malloc(size_t size, void* heap, int type)
}
else {
WOLFSSL_HEAP_HINT* hint = (WOLFSSL_HEAP_HINT*)heap;
WOLFSSL_HEAP* mem = hint->memory;
WOLFSSL_HEAP* mem;

if (hint == NULL) {
hint = (WOLFSSL_HEAP_HINT*)globalHeapHint;
billphipps marked this conversation as resolved.
Show resolved Hide resolved
#ifdef WOLFSSL_DEBUG_MEMORY
fprintf(stderr, "(Using global heap hint %p) ", hint);
#endif
}
mem = hint->memory;

if (wc_LockMutex(&(mem->memory_mutex)) != 0) {
WOLFSSL_MSG("Bad memory_mutex lock");
Expand Down Expand Up @@ -1073,7 +1106,7 @@ void wolfSSL_Free(void *ptr, void* heap, int type)
}
#endif

if (heap == NULL) {
if (heap == NULL && globalHeapHint == NULL) {
#ifdef WOLFSSL_HEAP_TEST
/* allow using malloc for creating ctx and method */
if (type == DYNAMIC_TYPE_CTX || type == DYNAMIC_TYPE_METHOD ||
Expand All @@ -1098,9 +1131,17 @@ void wolfSSL_Free(void *ptr, void* heap, int type)
}
else {
WOLFSSL_HEAP_HINT* hint = (WOLFSSL_HEAP_HINT*)heap;
WOLFSSL_HEAP* mem = hint->memory;
WOLFSSL_HEAP* mem;
word32 padSz = -(int)sizeof(wc_Memory) & (WOLFSSL_STATIC_ALIGN - 1);

if (hint == NULL) {
hint = (WOLFSSL_HEAP_HINT*)globalHeapHint;
#ifdef WOLFSSL_DEBUG_MEMORY
fprintf(stderr, "(Using global heap hint %p) ", hint);
#endif
}
mem = hint->memory;

/* get memory struct and add it to available list */
pt = (wc_Memory*)((byte*)ptr - sizeof(wc_Memory) - padSz);
if (wc_LockMutex(&(mem->memory_mutex)) != 0) {
Expand Down Expand Up @@ -1181,7 +1222,7 @@ void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type)
}
#endif

if (heap == NULL) {
if (heap == NULL && globalHeapHint == NULL) {
#ifdef WOLFSSL_HEAP_TEST
WOLFSSL_MSG("ERROR null heap hint passed in to XREALLOC");
#endif
Expand All @@ -1193,9 +1234,17 @@ void* wolfSSL_Realloc(void *ptr, size_t size, void* heap, int type)
}
else {
WOLFSSL_HEAP_HINT* hint = (WOLFSSL_HEAP_HINT*)heap;
WOLFSSL_HEAP* mem = hint->memory;
WOLFSSL_HEAP* mem;
word32 padSz = -(int)sizeof(wc_Memory) & (WOLFSSL_STATIC_ALIGN - 1);

if (hint == NULL) {
hint = (WOLFSSL_HEAP_HINT*)globalHeapHint;
#ifdef WOLFSSL_DEBUG_MEMORY
fprintf(stderr, "(Using global heap hint %p) ", hint);
#endif
}
mem = hint->memory;

if (ptr == NULL) {
#ifdef WOLFSSL_DEBUG_MEMORY
return wolfSSL_Malloc(size, heap, type, func, line);
Expand Down
6 changes: 6 additions & 0 deletions wolfcrypt/test/test.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1059,6 +1059,9 @@ options: [-s max_relative_stack_bytes] [-m max_relative_heap_memory_bytes]\n\
printf("unable to load static memory.\n");
return(EXIT_FAILURE);
}
#ifndef OPENSSL_EXTRA
wolfSSL_SetGlobalHeapHint(HEAP_HINT);
#endif
#endif

#if defined(DEBUG_WOLFSSL) && !defined(HAVE_VALGRIND)
Expand Down Expand Up @@ -2013,6 +2016,9 @@ options: [-s max_relative_stack_bytes] [-m max_relative_heap_memory_bytes]\n\
#endif
#endif

#if defined(WOLFSSL_STATIC_MEMORY) && !defined(OPENSSL_EXTRA)
wolfSSL_SetGlobalHeapHint(NULL);
#endif
TEST_PASS("Test complete\n");

EXIT_TEST(ret);
Expand Down
2 changes: 2 additions & 0 deletions wolfssl/wolfcrypt/memory.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,8 @@ WOLFSSL_API int wolfSSL_GetAllocators(wolfSSL_Malloc_cb* mf,
byte haFlag; /* flag used for checking handshake count */
} WOLFSSL_HEAP_HINT;

WOLFSSL_API void* wolfSSL_SetGlobalHeapHint(void* heap);
WOLFSSL_API void* wolfSSL_GetGlobalHeapHint(void);
WOLFSSL_API int wc_LoadStaticMemory_ex(WOLFSSL_HEAP_HINT** pHint,
unsigned int listSz, const unsigned int *sizeList,
const unsigned int *distList, unsigned char* buf, unsigned int sz,
Expand Down