From f42bbeca24274908c93a725f49b81e46ee4451e5 Mon Sep 17 00:00:00 2001
From: Anonymous Maarten <[EMAIL REDACTED]>
Date: Fri, 1 Sep 2023 23:19:46 +0200
Subject: [PATCH] SDL_test: track stack frames of allocations on Windows
---
src/test/SDL_test_memory.c | 84 +++++++++++++++++++++++++++++++++++++-
1 file changed, 82 insertions(+), 2 deletions(-)
diff --git a/src/test/SDL_test_memory.c b/src/test/SDL_test_memory.c
index 19e09d0e06eb..526686ad8266 100644
--- a/src/test/SDL_test_memory.c
+++ b/src/test/SDL_test_memory.c
@@ -25,6 +25,26 @@
#include <libunwind.h>
#endif
+#ifdef __WINDOWS__
+#include <windows.h>
+#include <dbghelp.h>
+
+static void *s_dbghelp;
+
+typedef BOOL (__stdcall *dbghelp_SymInitialize_fn)(HANDLE hProcess, PCSTR UserSearchPath, BOOL fInvadeProcess);
+
+typedef BOOL (__stdcall *dbghelp_SymFromAddr_fn)(HANDLE hProcess, DWORD64 Address, PDWORD64 Displacement, PSYMBOL_INFO Symbol);
+static dbghelp_SymFromAddr_fn dbghelp_SymFromAddr;
+
+#ifdef _WIN64
+typedef BOOL (__stdcall *dbghelp_SymGetLineFromAddr_fn)(HANDLE hProcess, DWORD64 qwAddr, PDWORD pdwDisplacement, PIMAGEHLP_LINE64 Line);
+#else
+typedef BOOL (__stdcall *dbghelp_SymGetLineFromAddr_fn)(HANDLE hProcess, DWORD qwAddr, PDWORD pdwDisplacement, PIMAGEHLP_LINE Line);
+#endif
+static dbghelp_SymGetLineFromAddr_fn dbghelp_SymGetLineFromAddr;
+
+#endif
+
/* This is a simple tracking allocator to demonstrate the use of SDL's
memory allocation replacement functionality.
@@ -32,12 +52,14 @@
for production code.
*/
+#define MAXIMUM_TRACKED_STACK_DEPTH 32
+
typedef struct SDL_tracked_allocation
{
void *mem;
size_t size;
- Uint64 stack[10];
- char stack_names[10][256];
+ Uint64 stack[MAXIMUM_TRACKED_STACK_DEPTH];
+ char stack_names[MAXIMUM_TRACKED_STACK_DEPTH][256];
struct SDL_tracked_allocation *next;
} SDL_tracked_allocation;
@@ -127,6 +149,40 @@ static void SDL_TrackAllocation(void *mem, size_t size)
}
}
}
+#elif defined(__WINDOWS__)
+ {
+ Uint32 count;
+ PVOID frames[63];
+ Uint32 i;
+
+ count = CaptureStackBackTrace(1, SDL_arraysize(frames), frames, NULL);
+
+ entry->size = SDL_min(count, MAXIMUM_TRACKED_STACK_DEPTH);
+ for (i = 0; i < entry->size; i++) {
+ char symbol_buffer[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR)];
+ PSYMBOL_INFO pSymbol = (PSYMBOL_INFO)symbol_buffer;
+ DWORD64 dwDisplacement = 0;
+ DWORD lineColumn = 0;
+ pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
+ pSymbol->MaxNameLen = MAX_SYM_NAME;
+ IMAGEHLP_LINE line;
+ line.SizeOfStruct = sizeof(line);
+
+ entry->stack[i] = (Uint64)(uintptr_t)frames[i];
+ if (s_dbghelp) {
+ if (!dbghelp_SymFromAddr(GetCurrentProcess(), (DWORD64)(uintptr_t)frames[i], &dwDisplacement, pSymbol)) {
+ SDL_strlcpy(pSymbol->Name, "???", MAX_SYM_NAME);
+ dwDisplacement = 0;
+ }
+ if (!dbghelp_SymGetLineFromAddr(GetCurrentProcess(), (DWORD64)(uintptr_t)frames[i], &lineColumn, &line)) {
+ line.FileName = "";
+ line.LineNumber = 0;
+ }
+
+ SDL_snprintf(entry->stack_names[i], sizeof(entry->stack_names[i]), "%s+0x%llx %s:%u", pSymbol->Name, (unsigned long long)dwDisplacement, line.FileName, (Uint32)line.LineNumber);
+ }
+ }
+ }
#endif /* HAVE_LIBUNWIND_H */
entry->next = s_tracked_allocations[index];
@@ -235,6 +291,30 @@ void SDLTest_TrackAllocations(void)
if (s_previous_allocations != 0) {
SDL_Log("SDLTest_TrackAllocations(): There are %d previous allocations, disabling free() validation", s_previous_allocations);
}
+#ifdef __WINDOWS__
+ {
+ s_dbghelp = SDL_LoadObject("dbghelp.dll");
+ if (s_dbghelp) {
+ dbghelp_SymInitialize_fn dbghelp_SymInitialize;
+ dbghelp_SymInitialize = (dbghelp_SymInitialize_fn)SDL_LoadFunction(s_dbghelp, "SymInitialize");
+ dbghelp_SymFromAddr = (dbghelp_SymFromAddr_fn)SDL_LoadFunction(s_dbghelp, "SymFromAddr");
+#ifdef _WIN64
+ dbghelp_SymGetLineFromAddr = (dbghelp_SymGetLineFromAddr_fn)SDL_LoadFunction(s_dbghelp, "SymGetLineFromAddr64");
+#else
+ dbghelp_SymGetLineFromAddr = (dbghelp_SymGetLineFromAddr_fn)SDL_LoadFunction(s_dbghelp, "SymGetLineFromAddr");
+#endif
+ if (!dbghelp_SymFromAddr || !dbghelp_SymFromAddr || !dbghelp_SymGetLineFromAddr) {
+ SDL_UnloadObject(s_dbghelp);
+ s_dbghelp = NULL;
+ } else {
+ if (!dbghelp_SymInitialize(GetCurrentProcess(), NULL, TRUE)) {
+ SDL_UnloadObject(s_dbghelp);
+ s_dbghelp = NULL;
+ }
+ }
+ }
+ }
+#endif
SDL_GetMemoryFunctions(&SDL_malloc_orig,
&SDL_calloc_orig,