mirrors/FreeRDP
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Moved windows backtrace to own file

Browse Source 
(cherry picked from commit ca8c9ea7b9)
This commit is contained in:
akallabeth 2022-04-29 11:51:18 +02:00 committed by akallabeth
parent 979e063581
commit aeeeee00bd
4 changed files with 220 additions and 160 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
winpr/libwinpr/utils/CMakeLists.txt
View File

@ -114,6 +114,12 @@ if (ANDROID)
include_directories(${CMAKE_CURRENT_SOURCE_DIR})
endif()
if (WIN32)
list(APPEND SRCS
windows/debug.c
windows/debug.h)
endif()
if (HAVE_EXECINFO_H)
list(APPEND SRCS
execinfo/debug.c

165
winpr/libwinpr/utils/debug.c
View File

@ -35,10 +35,7 @@
#endif
#if defined(_WIN32) || defined(_WIN64)
#include <io.h>
#include <windows.h>
#include <dbghelp.h>
#define write _write
#include <windows/debug.h>
#endif
#include <winpr/crt.h>
@ -79,15 +76,6 @@
static const char* support_msg = "Invalid stacktrace buffer! check if platform is supported!";
#if defined(_WIN32) || defined(_WIN64)
typedef struct
{
PVOID* stack;
ULONG used;
ULONG max;
} t_win_stack;
#endif
#if defined(ANDROID)
#include <pthread.h>
#include <dlfcn.h>
@ -203,47 +191,6 @@ fail:
fkt = NULL;
}
}
#endif
#if defined(_WIN32) && (NTDDI_VERSION <= NTDDI_WINXP)
typedef USHORT(WINAPI* PRTL_CAPTURE_STACK_BACK_TRACE_FN)(ULONG FramesToSkip, ULONG FramesToCapture,
PVOID* BackTrace, PULONG BackTraceHash);
static HMODULE g_NTDLL_Library = NULL;
static BOOL g_RtlCaptureStackBackTrace_Detected = FALSE;
static BOOL g_RtlCaptureStackBackTrace_Available = FALSE;
static PRTL_CAPTURE_STACK_BACK_TRACE_FN g_pRtlCaptureStackBackTrace = NULL;
USHORT RtlCaptureStackBackTrace(ULONG FramesToSkip, ULONG FramesToCapture, PVOID* BackTrace,
PULONG BackTraceHash)
{
if (!g_RtlCaptureStackBackTrace_Detected)
{
g_NTDLL_Library = LoadLibraryA("kernel32.dll");
if (g_NTDLL_Library)
{
g_pRtlCaptureStackBackTrace = (PRTL_CAPTURE_STACK_BACK_TRACE_FN)GetProcAddress(
g_NTDLL_Library, "RtlCaptureStackBackTrace");
g_RtlCaptureStackBackTrace_Available = (g_pRtlCaptureStackBackTrace) ? TRUE : FALSE;
}
else
{
g_RtlCaptureStackBackTrace_Available = FALSE;
}
g_RtlCaptureStackBackTrace_Detected = TRUE;
}
if (g_RtlCaptureStackBackTrace_Available)
{
return (*g_pRtlCaptureStackBackTrace)(FramesToSkip, FramesToCapture, BackTrace,
BackTraceHash);
}
return 0;
}
#endif
@ -259,11 +206,7 @@ void winpr_backtrace_free(void* buffer)
free(data->buffer);
free(data);
#elif defined(_WIN32) || defined(_WIN64)
{
t_win_stack* data = (t_win_stack*)buffer;
free(data->stack);
free(data);
}
winpr_win_backtrace_free(buffer);
#else
LOGF(support_msg);
#endif
@ -292,24 +235,7 @@ void* winpr_backtrace(DWORD size)
data->used = fkt->unwind_backtrace(data->buffer, 0, size);
return data;
#elif (defined(_WIN32) || defined(_WIN64)) && !defined(_UWP)
HANDLE process = GetCurrentProcess();
t_win_stack* data = calloc(1, sizeof(t_win_stack));
if (!data)
return NULL;
data->max = size;
data->stack = calloc(data->max, sizeof(PVOID));
if (!data->stack)
{
free(data);
return NULL;
}
SymInitialize(process, NULL, TRUE);
data->used = RtlCaptureStackBackTrace(2, size, data->stack, NULL);
return data;
return winpr_win_backtrace(size);
#else
LOGF(support_msg);
return NULL;
@ -377,55 +303,7 @@ char** winpr_backtrace_symbols(void* buffer, size_t* used)
}
#elif (defined(_WIN32) || defined(_WIN64)) && !defined(_UWP)
{
size_t i;
size_t line_len = 1024;
HANDLE process = GetCurrentProcess();
t_win_stack* data = (t_win_stack*)buffer;
size_t array_size = data->used * sizeof(char*);
size_t lines_size = data->used * line_len;
char** vlines = calloc(1, array_size + lines_size);
SYMBOL_INFO* symbol = calloc(1, sizeof(SYMBOL_INFO) + line_len * sizeof(char));
IMAGEHLP_LINE64* line = (IMAGEHLP_LINE64*)calloc(1, sizeof(IMAGEHLP_LINE64));
if (!vlines || !symbol || !line)
{
free(vlines);
free(symbol);
free(line);
return NULL;
}
line->SizeOfStruct = sizeof(IMAGEHLP_LINE64);
symbol->MaxNameLen = line_len;
symbol->SizeOfStruct = sizeof(SYMBOL_INFO);
/* Set the pointers in the allocated buffer's initial array section */
for (i = 0; i < data->used; i++)
vlines[i] = (char*)vlines + array_size + i * line_len;
for (i = 0; i < data->used; i++)
{
DWORD64 address = (DWORD64)(data->stack[i]);
DWORD displacement;
SymFromAddr(process, address, 0, symbol);
if (SymGetLineFromAddr64(process, address, &displacement, line))
{
sprintf_s(vlines[i], line_len, "%016" PRIx64 ": %s in %s:%" PRIu32, symbol->Address,
symbol->Name, line->FileName, line->LineNumber);
}
else
sprintf_s(vlines[i], line_len, "%016" PRIx64 ": %s", symbol->Address, symbol->Name);
}
if (used)
*used = data->used;
free(symbol);
free(line);
return vlines;
}
return winpr_win_backtrace_symbols(buffer, used);
#else
LOGF(support_msg);
return NULL;
@ -493,40 +371,7 @@ fail:
char* winpr_strerror(DWORD dw, char* dmsg, size_t size)
{
#if defined(_WIN32)
DWORD rc;
DWORD nSize = 0;
DWORD dwFlags = 0;
LPTSTR msg = NULL;
BOOL alloc = FALSE;
dwFlags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
#ifdef FORMAT_MESSAGE_ALLOCATE_BUFFER
alloc = TRUE;
dwFlags |= FORMAT_MESSAGE_ALLOCATE_BUFFER;
#else
nSize = (DWORD)(size * 2);
msg = (LPTSTR)calloc(nSize, sizeof(TCHAR));
#endif
rc = FormatMessage(dwFlags, NULL, dw, 0, alloc ? (LPTSTR)&msg : msg, nSize, NULL);
if (rc)
{
#if defined(UNICODE)
WideCharToMultiByte(CP_ACP, 0, msg, rc, dmsg, (int)MIN(size - 1, INT_MAX), NULL, NULL);
#else /* defined(UNICODE) */
memcpy(dmsg, msg, MIN(rc, size - 1));
#endif /* defined(UNICODE) */
dmsg[MIN(rc, size - 1)] = 0;
#ifdef FORMAT_MESSAGE_ALLOCATE_BUFFER
LocalFree(msg);
#else
free(msg);
#endif
}
else
{
_snprintf(dmsg, size, "FAILURE: 0x%08" PRIX32 "", GetLastError());
}
return winpr_win_strerror(dw, dmsg, size);
#else /* defined(_WIN32) */
_snprintf(dmsg, size, "%s", strerror(dw));
#endif /* defined(_WIN32) */

169
winpr/libwinpr/utils/windows/debug.c Normal file
View File

@ -0,0 +1,169 @@
/**
* WinPR: Windows Portable Runtime
* Debugging Utils
*
* Copyright 2014 Armin Novak <armin.novak@thincast.com>
* Copyright 2014 Thincast Technologies GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <stdio.h>
#include <fcntl.h>
#include <io.h>
#include <windows.h>
#include <dbghelp.h>
#include "debug.h"
#ifndef MIN
#define MIN(a, b) (a) < (b) ? (a) : (b)
#endif
typedef struct
{
PVOID* stack;
ULONG used;
ULONG max;
} t_win_stack;
void winpr_win_backtrace_free(void* buffer)
{
t_win_stack* data = (t_win_stack*)buffer;
if (!data)
return;
free(data->stack);
free(data);
}
void* winpr_win_backtrace(DWORD size)
{
HANDLE process = GetCurrentProcess();
t_win_stack* data = calloc(1, sizeof(t_win_stack));
if (!data)
return NULL;
data->max = size;
data->stack = calloc(data->max, sizeof(PVOID));
if (!data->stack)
{
free(data);
return NULL;
}
SymInitialize(process, NULL, TRUE);
data->used = RtlCaptureStackBackTrace(2, size, data->stack, NULL);
return data;
}
char** winpr_win_backtrace_symbols(void* buffer, size_t* used)
{
if (used)
*used = 0;
if (!buffer)
return NULL;
{
size_t i;
size_t line_len = 1024;
HANDLE process = GetCurrentProcess();
t_win_stack* data = (t_win_stack*)buffer;
size_t array_size = data->used * sizeof(char*);
size_t lines_size = data->used * line_len;
char** vlines = calloc(1, array_size + lines_size);
SYMBOL_INFO* symbol = calloc(1, sizeof(SYMBOL_INFO) + line_len * sizeof(char));
IMAGEHLP_LINE64* line = (IMAGEHLP_LINE64*)calloc(1, sizeof(IMAGEHLP_LINE64));
if (!vlines || !symbol || !line)
{
free(vlines);
free(symbol);
free(line);
return NULL;
}
line->SizeOfStruct = sizeof(IMAGEHLP_LINE64);
symbol->MaxNameLen = (ULONG)line_len;
symbol->SizeOfStruct = sizeof(SYMBOL_INFO);
/* Set the pointers in the allocated buffer's initial array section */
for (i = 0; i < data->used; i++)
vlines[i] = (char*)vlines + array_size + i * line_len;
for (i = 0; i < data->used; i++)
{
DWORD64 address = (DWORD64)(data->stack[i]);
DWORD displacement;
SymFromAddr(process, address, 0, symbol);
if (SymGetLineFromAddr64(process, address, &displacement, line))
{
sprintf_s(vlines[i], line_len, "%016" PRIx64 ": %s in %s:%" PRIu32, symbol->Address,
symbol->Name, line->FileName, line->LineNumber);
}
else
sprintf_s(vlines[i], line_len, "%016" PRIx64 ": %s", symbol->Address, symbol->Name);
}
if (used)
*used = data->used;
free(symbol);
free(line);
return vlines;
}
}
char* winpr_win_strerror(DWORD dw, char* dmsg, size_t size)
{
DWORD rc;
DWORD nSize = 0;
DWORD dwFlags = 0;
LPTSTR msg = NULL;
BOOL alloc = FALSE;
dwFlags = FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS;
#ifdef FORMAT_MESSAGE_ALLOCATE_BUFFER
alloc = TRUE;
dwFlags |= FORMAT_MESSAGE_ALLOCATE_BUFFER;
#else
nSize = (DWORD)(size * 2);
msg = (LPTSTR)calloc(nSize, sizeof(TCHAR));
#endif
rc = FormatMessage(dwFlags, NULL, dw, 0, alloc ? (LPTSTR)&msg : msg, nSize, NULL);
if (rc)
{
#if defined(UNICODE)
WideCharToMultiByte(CP_ACP, 0, msg, rc, dmsg, (int)MIN(size - 1, INT_MAX), NULL, NULL);
#else /* defined(UNICODE) */
memcpy(dmsg, msg, MIN(rc, size - 1));
#endif /* defined(UNICODE) */
dmsg[MIN(rc, size - 1)] = 0;
#ifdef FORMAT_MESSAGE_ALLOCATE_BUFFER
LocalFree(msg);
#else
free(msg);
#endif
}
else
{
_snprintf(dmsg, size, "FAILURE: 0x%08" PRIX32 "", GetLastError());
}
return dmsg;
}

40
winpr/libwinpr/utils/windows/debug.h Normal file
View File

@ -0,0 +1,40 @@
/**
* WinPR: Windows Portable Runtime
* WinPR Debugging helpers
*
* Copyright 2022 Armin Novak <armin.novak@thincast.com>
* Copyright 2022 Thincast Technologies GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef WINPR_DEBUG_WIN_H
#define WINPR_DEBUG_WIN_H
#ifdef __cplusplus
extern "C"
{
#endif
#include <winpr/wtypes.h>
void* winpr_win_backtrace(DWORD size);
void winpr_win_backtrace_free(void* buffer);
char** winpr_win_backtrace_symbols(void* buffer, size_t* used);
char* winpr_win_strerror(DWORD dw, char* dmsg, size_t size);
#ifdef __cplusplus
}
#endif
#endif /* WINPR_DEBUG_WIN_H */