mirror of
https://github.com/gnif/LookingGlass.git
synced 2024-11-21 21:17:19 +00:00
[host] windows: add OutputDebugString capture for diagnostics
This commit is contained in:
parent
545e736389
commit
eb31815b46
@ -11,6 +11,7 @@ add_library(platform_Windows STATIC
|
||||
src/mousehook.c
|
||||
src/force_compose.c
|
||||
src/com_ref.c
|
||||
src/ods.c
|
||||
)
|
||||
|
||||
# allow use of functions for Windows 7 or later
|
||||
|
183
host/platform/Windows/src/ods.c
Normal file
183
host/platform/Windows/src/ods.c
Normal file
@ -0,0 +1,183 @@
|
||||
/**
|
||||
* Looking Glass
|
||||
* Copyright © 2017-2024 The Looking Glass Authors
|
||||
* https://looking-glass.io
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License as published by the Free
|
||||
* Software Foundation; either version 2 of the License, or (at your option)
|
||||
* any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program; if not, write to the Free Software Foundation, Inc., 59
|
||||
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*/
|
||||
|
||||
#include "ods.h"
|
||||
#include "common/array.h"
|
||||
#include "common/windebug.h"
|
||||
|
||||
#include <windows.h>
|
||||
|
||||
typedef struct ODSData
|
||||
{
|
||||
DWORD dwPid;
|
||||
char buffer[4096 - sizeof(DWORD)];
|
||||
}
|
||||
ODSData;
|
||||
|
||||
typedef struct ODSState
|
||||
{
|
||||
bool started;
|
||||
|
||||
HANDLE hBuffer;
|
||||
HANDLE hBufferReady;
|
||||
HANDLE hDataReady;
|
||||
|
||||
HANDLE hThread;
|
||||
HANDLE hStopEvent;
|
||||
|
||||
ODSData * data;
|
||||
}
|
||||
ODSState;
|
||||
|
||||
static ODSState ods = {0};
|
||||
|
||||
static DWORD CALLBACK ods_thread(LPVOID arg)
|
||||
{
|
||||
const DWORD pid = GetCurrentProcessId();
|
||||
HANDLE wait[] = { ods.hDataReady, ods.hStopEvent };
|
||||
char buffer[sizeof(ods.data->buffer) + 1];
|
||||
|
||||
SetEvent(ods.hBufferReady);
|
||||
|
||||
while(true)
|
||||
{
|
||||
switch(WaitForMultipleObjects(ARRAY_LENGTH(wait), wait, FALSE, INFINITE))
|
||||
{
|
||||
case WAIT_OBJECT_0:
|
||||
{
|
||||
if (ods.data->dwPid != pid)
|
||||
{
|
||||
SetEvent(ods.hBufferReady);
|
||||
break;
|
||||
}
|
||||
|
||||
unsigned size = 0;
|
||||
while(size < sizeof(ods.data->buffer) && ods.data->buffer[size])
|
||||
++size;
|
||||
memcpy(buffer, ods.data->buffer, size);
|
||||
SetEvent(ods.hBufferReady);
|
||||
|
||||
buffer[size] = '\0';
|
||||
while (size && isspace(buffer[size - 1]))
|
||||
buffer[--size] = '\0';
|
||||
|
||||
DEBUG_ERROR("ODS: %s", buffer);
|
||||
break;
|
||||
}
|
||||
|
||||
case WAIT_OBJECT_0 + 1:
|
||||
return 0;
|
||||
|
||||
default:
|
||||
DEBUG_WINERROR("WaitForMultipleObjects failed", GetLastError());
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
bool ods_start(void)
|
||||
{
|
||||
if (IsDebuggerPresent() || ods.started)
|
||||
return true;
|
||||
|
||||
ods.hBuffer = CreateFileMappingA(INVALID_HANDLE_VALUE, NULL, PAGE_READWRITE,
|
||||
0, 4096, "DBWIN_BUFFER");
|
||||
if (ods.hBuffer == INVALID_HANDLE_VALUE)
|
||||
{
|
||||
DEBUG_WINERROR("CreateFileMapping failed", GetLastError());
|
||||
return false;
|
||||
}
|
||||
|
||||
ods.data = MapViewOfFile(ods.hBuffer, SECTION_MAP_READ, 0, 0, 0);
|
||||
if (!ods.data)
|
||||
{
|
||||
DEBUG_WINERROR("MapViewOfFile failed", GetLastError());
|
||||
goto fail_created;
|
||||
}
|
||||
|
||||
ods.hBufferReady = CreateEventA(NULL, FALSE, FALSE, "DBWIN_BUFFER_READY");
|
||||
if (!ods.hBufferReady)
|
||||
{
|
||||
DEBUG_WINERROR("DBWIN_BUFFER_READY createEvent failed", GetLastError());
|
||||
goto fail_mapped;
|
||||
}
|
||||
|
||||
ods.hDataReady = CreateEventA(NULL, FALSE, FALSE, "DBWIN_DATA_READY");
|
||||
if (!ods.hDataReady)
|
||||
{
|
||||
DEBUG_WINERROR("DBWIN_DATA_READY Create event failed", GetLastError());
|
||||
goto fail_buffer_event;
|
||||
}
|
||||
|
||||
ods.hStopEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
|
||||
if (!ods.hStopEvent)
|
||||
{
|
||||
DEBUG_WINERROR("Create thread stop event failed", GetLastError());
|
||||
goto fail_data_event;
|
||||
}
|
||||
|
||||
ods.hThread = CreateThread(NULL, 0, ods_thread, NULL, 0, NULL);
|
||||
if (!ods.hThread)
|
||||
{
|
||||
DEBUG_WINERROR("Create ods thread failed", GetLastError());
|
||||
goto fail_stop_event;
|
||||
}
|
||||
|
||||
ods.started = true;
|
||||
DEBUG_INFO("OutputDebugString Logging Started");
|
||||
return true;
|
||||
|
||||
fail_stop_event:
|
||||
CloseHandle(ods.hStopEvent);
|
||||
|
||||
fail_data_event:
|
||||
CloseHandle(ods.hDataReady);
|
||||
|
||||
fail_buffer_event:
|
||||
CloseHandle(ods.hBufferReady);
|
||||
|
||||
fail_mapped:
|
||||
UnmapViewOfFile(ods.data);
|
||||
|
||||
fail_created:
|
||||
CloseHandle(ods.hBuffer);
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
void ods_stop(void)
|
||||
{
|
||||
if (!ods.started)
|
||||
return;
|
||||
|
||||
SetEvent(ods.hStopEvent);
|
||||
WaitForSingleObject(ods.hThread, INFINITE);
|
||||
|
||||
CloseHandle(ods.hStopEvent);
|
||||
CloseHandle(ods.hDataReady);
|
||||
CloseHandle(ods.hBufferReady);
|
||||
UnmapViewOfFile(ods.data);
|
||||
CloseHandle(ods.hBuffer);
|
||||
|
||||
DEBUG_INFO("OutputDebugString Logging Stopped");
|
||||
ods.started = false;
|
||||
}
|
29
host/platform/Windows/src/ods.h
Normal file
29
host/platform/Windows/src/ods.h
Normal file
@ -0,0 +1,29 @@
|
||||
/**
|
||||
* Looking Glass
|
||||
* Copyright © 2017-2024 The Looking Glass Authors
|
||||
* https://looking-glass.io
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License as published by the Free
|
||||
* Software Foundation; either version 2 of the License, or (at your option)
|
||||
* any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program; if not, write to the Free Software Foundation, Inc., 59
|
||||
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*/
|
||||
|
||||
#ifndef _H_ODS_
|
||||
#define _H_ODS_
|
||||
|
||||
#include <stdbool.h>
|
||||
|
||||
bool ods_start(void);
|
||||
void ods_stop(void);
|
||||
|
||||
#endif
|
@ -21,6 +21,7 @@
|
||||
#include "platform.h"
|
||||
#include "service.h"
|
||||
#include "windows/mousehook.h"
|
||||
#include "ods.h"
|
||||
|
||||
#include <windows.h>
|
||||
#include <shellapi.h>
|
||||
@ -403,6 +404,13 @@ int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine
|
||||
.type = OPTION_TYPE_STRING,
|
||||
.value.x_string = ""
|
||||
},
|
||||
{
|
||||
.module = "os",
|
||||
.name = "ods",
|
||||
.description = "Capture and log OutputDebugString messages",
|
||||
.type = OPTION_TYPE_BOOL,
|
||||
.value.x_bool = false
|
||||
},
|
||||
{0}
|
||||
};
|
||||
|
||||
@ -504,6 +512,8 @@ finish:
|
||||
if (app.taskHandle)
|
||||
AvRevertMmThreadCharacteristics(app.taskHandle);
|
||||
|
||||
ods_stop();
|
||||
|
||||
if (app.stdErrFile)
|
||||
fclose(app.stdErrFile);
|
||||
|
||||
@ -559,6 +569,7 @@ void CALLBACK exitEventCallback(PVOID opaque, BOOLEAN timedOut)
|
||||
bool app_init(void)
|
||||
{
|
||||
const char * logFile = option_get_string("os", "logFile");
|
||||
const bool ods = option_get_bool ("os", "ods" );
|
||||
|
||||
// redirect stderr to a file
|
||||
if (logFile && strcmp(logFile, "stderr") != 0)
|
||||
@ -598,6 +609,9 @@ bool app_init(void)
|
||||
// always flush stderr
|
||||
setbuf(stderr, NULL);
|
||||
|
||||
if (ods && !ods_start())
|
||||
DEBUG_WARN("Failed to setup capture of debug messages");
|
||||
|
||||
windowsSetTimerResolution();
|
||||
|
||||
// get the performance frequency for spinlocks
|
||||
|
Loading…
Reference in New Issue
Block a user