Cleaned up the error handling in the Windows testing code by also creating HRESULT functions for whatever it calls. This resolves a bunch of the TODOs in that file.

This commit is contained in:
Pietro Gagliardi 2019-04-30 01:18:48 -04:00
parent db6b6fd97b
commit 848c3813ee
1 changed files with 218 additions and 72 deletions

View File

@ -18,6 +18,149 @@
#include "testing.h" #include "testing.h"
#include "testingpriv.h" #include "testingpriv.h"
static HRESULT lastErrorCodeToHRESULT(DWORD lastError)
{
if (lastError == 0)
return E_FAIL;
return HRESULT_FROM_WIN32(lastError);
}
static HRESULT lastErrorToHRESULT(void)
{
return lastErrorCodeToHRESULT(GetLastError());
}
static HRESULT WINAPI hrWaitForMultipleObjectsEx(DWORD n, const HANDLE *objects, BOOL waitAll, DWORD timeout, BOOL alertable, DWORD *result)
{
SetLastError(0);
*result = WaitForMultipleObjectsEx(n, objects, waitAll, timeout, alertable);
if (*result == WAIT_FAILED)
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrSuspendThread(HANDLE thread)
{
DWORD ret;
SetLastError(0);
ret = SuspendThread(thread);
if (ret == (DWORD) (-1))
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrGetThreadContext(HANDLE thread, LPCONTEXT ctx)
{
BOOL ret;
SetLastError(0);
ret = GetThreadContext(thread, ctx);
if (ret == 0)
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrSetThreadContext(HANDLE thread, CONST CONTEXT *ctx)
{
BOOL ret;
SetLastError(0);
ret = SetThreadContext(thread, ctx);
if (ret == 0)
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrResumeThread(HANDLE thread)
{
DWORD ret;
SetLastError(0);
ret = ResumeThread(thread);
if (ret == (DWORD) (-1))
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrDuplicateHandle(HANDLE sourceProcess, HANDLE sourceHandle, HANDLE targetProcess, LPHANDLE targetHandle, DWORD access, BOOL inherit, DWORD options)
{
BOOL ret;
SetLastError(0);
ret = DuplicateHandle(sourceProcess, sourceHandle,
targetProcess, targetHandle,
access, inherit, options);
if (ret == 0)
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrCreateWaitableTimerW(LPSECURITY_ATTRIBUTES attributes, BOOL manualReset, LPCWSTR name, HANDLE *handle)
{
SetLastError(0);
*handle = CreateWaitableTimerW(attributes, manualReset, name);
if (*handle == NULL)
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrCreateEventW(LPSECURITY_ATTRIBUTES attributes, BOOL manualReset, BOOL initialState, LPCWSTR name, HANDLE *handle)
{
SetLastError(0);
*handle = CreateEventW(attributes, manualReset, initialState, name);
if (*handle == NULL)
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrSetWaitableTimer(HANDLE timer, const LARGE_INTEGER *duration, LONG period, PTIMERAPCROUTINE completionRoutine, LPVOID completionData, BOOL resume)
{
BOOL ret;
SetLastError(0);
ret = SetWaitableTimer(timer, duration, period, completionRoutine, completionData, resume);
if (ret == 0)
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT __cdecl hr_beginthreadex(void *security, unsigned stackSize, unsigned (__stdcall *threadProc)(void *arg), void *threadProcArg, unsigned flags, unsigned *thirdArg, uintptr_t *handle)
{
DWORD lastError;
// _doserrno is the equivalent of GetLastError(), or at least that's how _beginthreadex() uses it.
_doserrno = 0;
*handle = _beginthreadex(security, stackSize, threadProc, threadProcArg, flags, thirdArg);
if (*handle == 0) {
lastError = (DWORD) _doserrno;
return lastErrorCodeToHRESULT(lastError);
}
return S_OK;
}
static HRESULT WINAPI hrSetEvent(HANDLE event)
{
BOOL ret;
SetLastError(0);
ret = SetEvent(event);
if (ret == 0)
return lastErrorToHRESULT();
return S_OK;
}
static HRESULT WINAPI hrWaitForSingleObject(HANDLE handle, DWORD timeout)
{
DWORD ret;
SetLastError(0);
ret = WaitForSingleObject(handle, timeout);
if (ret == WAIT_FAILED)
return lastErrorToHRESULT();
return S_OK;
}
struct testingTimer { struct testingTimer {
LARGE_INTEGER start; LARGE_INTEGER start;
LARGE_INTEGER end; LARGE_INTEGER end;
@ -102,36 +245,39 @@ static unsigned __stdcall timerThreadProc(void *data)
{ {
HANDLE objects[2]; HANDLE objects[2];
CONTEXT ctx; CONTEXT ctx;
DWORD ret; DWORD which;
DWORD lastError; HRESULT hr;
objects[0] = timeout_timer; objects[0] = timeout_timer;
objects[1] = timeout_finished; objects[1] = timeout_finished;
timeout_hr = S_OK; timeout_hr = hrWaitForMultipleObjectsEx(2, objects,
SetLastError(0); FALSE, INFINITE, FALSE, &which);
ret = WaitForMultipleObjectsEx(2, objects, if (timeout_hr != S_OK)
FALSE, INFINITE, FALSE); // act as if we timed out; the other thread will see the error
if (ret == WAIT_FAILED) { which = WAIT_OBJECT_0;
lastError = GetLastError(); if (which == WAIT_OBJECT_0 + 1)
timeout_hr = E_FAIL;
if (lastError != 0)
timeout_hr = HRESULT_FROM_WIN32(lastError);
ret = WAIT_OBJECT_0;
}
if (ret == WAIT_OBJECT_0 + 1)
// we succeeded; do nothing // we succeeded; do nothing
return 0; return 0;
// we timed out (or there was an error); signal it // we timed out (or there was an error); signal it
// TODO check errors hr = hrSuspendThread(timeout_targetThread);
SuspendThread(timeout_targetThread); if (hr != S_OK)
testingprivInternalError("error calling SuspendThread() after timeout: 0x%08I32X", hr);
setContextForGet(&ctx); setContextForGet(&ctx);
GetThreadContext(timeout_targetThread, &ctx); hr = hrGetThreadContext(timeout_targetThread, &ctx);
if (hr != S_OK)
testingprivInternalError("error calling GetThreadContext() after timeout: 0x%08I32X", hr);
setContextForSet(&ctx); setContextForSet(&ctx);
SetThreadContext(timeout_targetThread, &ctx); hr = hrSetThreadContext(timeout_targetThread, &ctx);
if (hr != S_OK)
testingprivInternalError("error calling SetThreadContext() after timeout: 0x%08I32X", hr);
// and force the thread to return from GetMessage(), if we are indeed in that // and force the thread to return from GetMessage(), if we are indeed in that
// TODO decide whether to check errors
// TODO either way, check errors in GetThreadId()
PostThreadMessage(GetThreadId(timeout_targetThread), WM_NULL, 0, 0); PostThreadMessage(GetThreadId(timeout_targetThread), WM_NULL, 0, 0);
ResumeThread(timeout_targetThread); hr = hrResumeThread(timeout_targetThread);
if (hr != S_OK)
testingprivInternalError("error calling ResumeThread() after timeout: 0x%08I32X", hr);
return 0; return 0;
} }
@ -141,82 +287,61 @@ void testingprivRunWithTimeout(testingT *t, const char *file, long line, int64_t
int closeTargetThread = 0; int closeTargetThread = 0;
uintptr_t timerThread = 0; uintptr_t timerThread = 0;
LARGE_INTEGER timer; LARGE_INTEGER timer;
BOOL ret; int waitForTimerThread = 0;
DWORD lastError;
HRESULT hr; HRESULT hr;
timeoutstr = testingNsecString(timeout); timeoutstr = testingNsecString(timeout);
SetLastError(0); hr = hrDuplicateHandle(GetCurrentProcess(), GetCurrentThread(),
ret = DuplicateHandle(GetCurrentProcess(), GetCurrentThread(),
GetCurrentProcess(), &timeout_targetThread, GetCurrentProcess(), &timeout_targetThread,
0, FALSE, DUPLICATE_SAME_ACCESS); 0, FALSE, DUPLICATE_SAME_ACCESS);
if (ret == 0) { if (hr != S_OK) {
lastError = GetLastError();
hr = E_FAIL;
if (lastError != 0)
hr = HRESULT_FROM_WIN32(lastError);
testingprivTLogfFull(t, file, line, "error getting current thread for %s timeout: 0x%08I32X", comment, hr); testingprivTLogfFull(t, file, line, "error getting current thread for %s timeout: 0x%08I32X", comment, hr);
testingTFail(t); testingTFail(t);
goto out; goto out;
} }
closeTargetThread = 1; closeTargetThread = 1;
SetLastError(0); hr = hrCreateWaitableTimerW(NULL, TRUE, NULL, &timeout_timer);
timeout_timer = CreateWaitableTimerW(NULL, TRUE, NULL); if (hr != S_OK) {
if (timeout_timer == NULL) {
lastError = GetLastError();
hr = E_FAIL;
if (lastError != 0)
hr = HRESULT_FROM_WIN32(lastError);
testingprivTLogfFull(t, file, line, "error creating timer for %s timeout: 0x%08I32X", comment, hr); testingprivTLogfFull(t, file, line, "error creating timer for %s timeout: 0x%08I32X", comment, hr);
testingTFail(t); testingTFail(t);
goto out; goto out;
} }
SetLastError(0); hr = hrCreateEventW(NULL, TRUE, FALSE, NULL, &timeout_finished);
timeout_finished = CreateEventW(NULL, TRUE, FALSE, NULL); if (hr != S_OK) {
if (timeout_finished == NULL) {
lastError = GetLastError();
hr = E_FAIL;
if (lastError != 0)
hr = HRESULT_FROM_WIN32(lastError);
testingprivTLogfFull(t, file, line, "error creating finished event for %s timeout: 0x%08I32X", comment, hr); testingprivTLogfFull(t, file, line, "error creating finished event for %s timeout: 0x%08I32X", comment, hr);
testingTFail(t); testingTFail(t);
goto out; goto out;
} }
SetLastError(0);
timer.QuadPart = timeout / 100; timer.QuadPart = timeout / 100;
timer.QuadPart = -timer.QuadPart; timer.QuadPart = -timer.QuadPart;
ret = SetWaitableTimer(timeout_timer, &timer, 0, NULL, NULL, FALSE); hr = hrSetWaitableTimer(timeout_timer, &timer, 0, NULL, NULL, FALSE);
if (ret == 0) { if (hr != S_OK) {
lastError = (DWORD) _doserrno;
hr = E_FAIL;
if (lastError != 0)
hr = HRESULT_FROM_WIN32(lastError);
testingprivTLogfFull(t, file, line, "error applying %s timeout: 0x%08I32X", comment, hr); testingprivTLogfFull(t, file, line, "error applying %s timeout: 0x%08I32X", comment, hr);
testingTFail(t); testingTFail(t);
goto out; goto out;
} }
// _doserrno is the equivalent of GetLastError(), or at least that's how _beginthreadex() uses it.
_doserrno = 0;
// don't start the thread until after we call setjmp() // don't start the thread until after we call setjmp()
timerThread = _beginthreadex(NULL, 0, timerThreadProc, NULL, CREATE_SUSPENDED, NULL); hr = hr_beginthreadex(NULL, 0, timerThreadProc, NULL, CREATE_SUSPENDED, NULL, &timerThread);
if (timerThread == 0) { if (hr != S_OK) {
lastError = (DWORD) _doserrno;
hr = E_FAIL;
if (lastError != 0)
hr = HRESULT_FROM_WIN32(lastError);
testingprivTLogfFull(t, file, line, "error creating timer thread for %s timeout: 0x%08I32X", comment, hr); testingprivTLogfFull(t, file, line, "error creating timer thread for %s timeout: 0x%08I32X", comment, hr);
testingTFail(t); testingTFail(t);
goto out; goto out;
} }
waitForTimerThread = 1;
if (setjmp(timeout_ret) == 0) { if (setjmp(timeout_ret) == 0) {
// TODO check error hr = hrResumeThread((HANDLE) timerThread);
ResumeThread((HANDLE) timerThread); if (hr != S_OK) {
testingprivTLogfFull(t, file, line, "error calling ResumeThread() to start timeout thread: 0x%08I32X", hr);
testingTFail(t);
waitForTimerThread = 0;
goto out;
}
(*f)(t, data); (*f)(t, data);
failNowOnError = 0; // we succeeded failNowOnError = 0; // we succeeded
} else if (timeout_hr == S_OK) { } else if (timeout_hr == S_OK) {
@ -229,10 +354,14 @@ void testingprivRunWithTimeout(testingT *t, const char *file, long line, int64_t
out: out:
if (timerThread != 0) { if (timerThread != 0) {
// TODO check errors if (waitForTimerThread) {
SetEvent(timeout_finished); hr = hrSetEvent(timeout_finished);
WaitForSingleObject((HANDLE) timerThread, INFINITE); if (hr != S_OK)
// TODO end check errors testingprivInternalError("error signaling timer thread to finish for %s timeout: 0x%08I32X (this is fatal because that thread may interrupt us)", comment, hr);
hr = hrWaitForSingleObject((HANDLE) timerThread, INFINITE);
if (hr != S_OK)
testingprivInternalError("error waiting for timer thread to quit for %s timeout: 0x%08I32X (this is fatal because that thread may interrupt us)", comment, hr);
}
CloseHandle((HANDLE) timerThread); CloseHandle((HANDLE) timerThread);
} }
if (timeout_finished != NULL) { if (timeout_finished != NULL) {
@ -255,15 +384,27 @@ void testingSleep(int64_t nsec)
{ {
HANDLE timer; HANDLE timer;
LARGE_INTEGER duration; LARGE_INTEGER duration;
HRESULT hr;
// TODO check errors, possibly falling back to Sleep() (although it has lower resolution)
// TODO rename all the other durations that are timeout or timer to duration or nsec, both here and in the Unix/Darwin code // TODO rename all the other durations that are timeout or timer to duration or nsec, both here and in the Unix/Darwin code
duration.QuadPart = nsec / 100; duration.QuadPart = nsec / 100;
duration.QuadPart = -duration.QuadPart; duration.QuadPart = -duration.QuadPart;
timer = CreateWaitableTimerW(NULL, TRUE, NULL); hr = hrCreateWaitableTimerW(NULL, TRUE, NULL, &timer);
SetWaitableTimer(timer, &duration, 0, NULL, NULL, FALSE); if (hr != S_OK)
WaitForSingleObject(timer, INFINITE); goto fallback;
hr = hrSetWaitableTimer(timer, &duration, 0, NULL, NULL, FALSE);
if (hr != S_OK) {
CloseHandle(timer);
goto fallback;
}
hr = hrWaitForSingleObject(timer, INFINITE);
CloseHandle(timer); CloseHandle(timer);
if (hr == S_OK)
return;
fallback:
// this has lower resolution, but we can't detect a failure, so use it as a fallback
Sleep((DWORD) (nsec / testingNsecPerMsec));
} }
struct testingThread { struct testingThread {
@ -280,24 +421,29 @@ static unsigned __stdcall threadThreadProc(void *data)
return 0; return 0;
} }
// TODO instead of panicking, should these functions report errors to a testingT?
testingThread *testingNewThread(void (*f)(void *data), void *data) testingThread *testingNewThread(void (*f)(void *data), void *data)
{ {
testingThread *t; testingThread *t;
HRESULT hr;
t = testingprivNew(testingThread); t = testingprivNew(testingThread);
t->f = f; t->f = f;
t->data = data; t->data = data;
t->handle = _beginthreadex(NULL, 0, threadThreadProc, t, 0, NULL); hr = hr_beginthreadex(NULL, 0, threadThreadProc, t, 0, NULL, &(t->handle));
// TODO check error if (hr != S_OK)
testingprivInternalError("error creating thread: 0x%08I32X", hr);
return t; return t;
} }
void testingThreadWaitAndFree(testingThread *t) void testingThreadWaitAndFree(testingThread *t)
{ {
// TODO check errors HRESULT hr;
WaitForSingleObject((HANDLE) (t->handle), INFINITE);
// TODO end check errors hr = hrWaitForSingleObject((HANDLE) (t->handle), INFINITE);
if (hr != S_OK)
testingprivInternalError("error waiting for thread to finish: 0x%08I32X", hr);
CloseHandle((HANDLE) (t->handle)); CloseHandle((HANDLE) (t->handle));
testingprivFree(t); testingprivFree(t);
} }