support.c File Reference

#include <kmt_test.h>
#include "kmtest.h"
#include <kmt_public.h>
#include <assert.h>
#include <debug.h>

Include dependency graph for support.c:

Go to the source code of this file.

Functions
KmtUserCallbackThread
Thread routine which awaits callback requests from kernel-mode Returns Win32 error code
DWORD WINAPI	KmtUserCallbackThread (PVOID Parameter)
KmtLoadDriver
Load the specified special-purpose driver (create/start the service) Parameters ServiceName Name of the driver service (Kmtest- prefix will be added automatically) RestartIfRunning TRUE to stop and restart the service if it is already running
DWORD	KmtLoadDriver (IN PCWSTR ServiceName, IN BOOLEAN RestartIfRunning)
KmtUnloadDriverKeepService
Unload special-purpose driver (stop the service only)
VOID	KmtUnloadDriverKeepService (VOID)
KmtUnloadDriver
Unload special-purpose driver (stop and delete the service)
VOID	KmtUnloadDriver (VOID)
KmtOpenDriver
Load and open special-purpose driver (acquire a device handle)
DWORD	KmtOpenDriver (VOID)
DWORD	KmtLoadAndOpenDriver (IN PCWSTR ServiceName, IN BOOLEAN RestartIfRunning)
KmtCloseDriver
Close special-purpose driver (close device handle)
VOID	KmtCloseDriver (VOID)
KmtSendToDriver
Send an I/O control message with no arguments to the driver opened with KmtOpenDriver Parameters ControlCode Returns Win32 error code as returned by DeviceIoControl
DWORD	KmtSendToDriver (IN DWORD ControlCode)
KmtSendStringToDriver
Send an I/O control message with a string argument to the driver opened with KmtOpenDriver Parameters ControlCode String Returns Win32 error code as returned by DeviceIoControl
DWORD	KmtSendStringToDriver (IN DWORD ControlCode, IN PCSTR String)
KmtSendWStringToDriver
Send an I/O control message with a wide string argument to the driver opened with KmtOpenDriver Parameters ControlCode String Returns Win32 error code as returned by DeviceIoControl
DWORD	KmtSendWStringToDriver (IN DWORD ControlCode, IN PCWSTR String)
KmtSendUlongToDriver
Send an I/O control message with an integer argument to the driver opened with KmtOpenDriver Parameters ControlCode Value Returns Win32 error code as returned by DeviceIoControl
DWORD	KmtSendUlongToDriver (IN DWORD ControlCode, IN DWORD Value)
KmtSendBufferToDriver
Send an I/O control message with the specified arguments to the driver opened with KmtOpenDriver Parameters ControlCode Buffer InLength OutLength Returns Win32 error code as returned by DeviceIoControl
DWORD	KmtSendBufferToDriver (IN DWORD ControlCode, IN OUT PVOID Buffer OPTIONAL, IN DWORD InLength, IN OUT PDWORD OutLength)

Variables
HANDLE	KmtestHandle

KmtRunKernelTest
Run the specified kernel-mode test part Parameters TestName Name of the test to run Returns Win32 error code as returned by DeviceIoControl
static WCHAR	TestServiceName [MAX_PATH]
static SC_HANDLE	TestServiceHandle
static HANDLE	TestDeviceHandle
DWORD	KmtRunKernelTest (IN PCSTR TestName)

Function Documentation

KmtCloseDriver()

VOID KmtCloseDriver

(

VOID

)

Definition at line 236 of file support.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    if (TestDeviceHandle && !CloseHandle(TestDeviceHandle))
        error(Error);
 
    if (Error)
    {
        DPRINT1("CloseHandle failed: 0x%lx\n", Error);
    }
}

Referenced by START_TEST(), and UnloadTcpIpTestDriver().

KmtLoadAndOpenDriver()

DWORD KmtLoadAndOpenDriver	(	IN PCWSTR	ServiceName,
		IN BOOLEAN	RestartIfRunning
	)

Definition at line 213 of file support.c.

{
    DWORD Error;
 
    Error = KmtLoadDriver(ServiceName, RestartIfRunning);
    if (Error)
        return Error;
 
    Error = KmtOpenDriver();
    if (Error)
        return Error;
 
    return ERROR_SUCCESS;
}

Referenced by LoadTcpIpTestDriver(), and START_TEST().

KmtLoadDriver()

DWORD KmtLoadDriver	(	IN PCWSTR	ServiceName,
		IN BOOLEAN	RestartIfRunning
	)

Definition at line 128 of file support.c.

{
    WCHAR ServicePath[MAX_PATH];
 
    StringCbCopyW(ServicePath, sizeof(ServicePath), ServiceName);
    StringCbCatW(ServicePath, sizeof(ServicePath), L"_drv.sys");
 
    StringCbCopyW(TestServiceName, sizeof(TestServiceName), L"Kmtest-");
    StringCbCatW(TestServiceName, sizeof(TestServiceName), ServiceName);
 
    return KmtCreateAndStartService(TestServiceName, ServicePath, NULL, &TestServiceHandle, RestartIfRunning);
}

Referenced by KmtLoadAndOpenDriver(), and START_TEST().

KmtOpenDriver()

DWORD KmtOpenDriver

(

VOID

)

Definition at line 192 of file support.c.

{
    DWORD Error = ERROR_SUCCESS;
    WCHAR DevicePath[MAX_PATH];
 
    StringCbCopyW(DevicePath, sizeof(DevicePath), L"\\\\.\\Global\\GLOBALROOT\\Device\\");
    StringCbCatW(DevicePath, sizeof(DevicePath), TestServiceName);
 
    TestDeviceHandle = CreateFile(DevicePath, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);
    if (TestDeviceHandle == INVALID_HANDLE_VALUE)
        error(Error);
 
    return Error;
}

Referenced by KmtLoadAndOpenDriver().

KmtRunKernelTest()

DWORD KmtRunKernelTest

(

IN PCSTR

TestName

)

Definition at line 95 of file support.c.

{
    HANDLE CallbackThread;
    DWORD Error = ERROR_SUCCESS;
    DWORD BytesRead;
 
    CallbackThread = CreateThread(NULL, 0, KmtUserCallbackThread, NULL, 0, NULL);
 
    if (!DeviceIoControl(KmtestHandle, IOCTL_KMTEST_RUN_TEST, (PVOID)TestName, (DWORD)strlen(TestName), NULL, 0, &BytesRead, NULL))
        error(Error);
 
    if (CallbackThread != NULL)
         CloseHandle(CallbackThread);
 
    return Error;
}

Referenced by RunTest(), and START_TEST().

KmtSendBufferToDriver()

DWORD KmtSendBufferToDriver	(	IN DWORD	ControlCode,
		IN OUT PVOID Buffer	OPTIONAL,
		IN DWORD	InLength,
		IN OUT PDWORD	OutLength
	)

Definition at line 360 of file support.c.

{
    assert(OutLength);
    assert(Buffer || (!InLength && !*OutLength));
    assert(ControlCode < 0x400);
 
    if (!DeviceIoControl(TestDeviceHandle, KMT_MAKE_CODE(ControlCode), Buffer, InLength, Buffer, *OutLength, OutLength, NULL))
        return GetLastError();
 
    return ERROR_SUCCESS;
}

Referenced by START_TEST().

KmtSendStringToDriver()

DWORD KmtSendStringToDriver	(	IN DWORD	ControlCode,
		IN PCSTR	String
	)

Definition at line 283 of file support.c.

{
    DWORD BytesRead;
 
    assert(ControlCode < 0x400);
 
    if (!DeviceIoControl(TestDeviceHandle, KMT_MAKE_CODE(ControlCode), (PVOID)String, (DWORD)strlen(String), NULL, 0, &BytesRead, NULL))
        return GetLastError();
 
    return ERROR_SUCCESS;
}

Referenced by START_TEST().

KmtSendToDriver()

DWORD KmtSendToDriver

(

IN DWORD

ControlCode

)

Definition at line 259 of file support.c.

{
    DWORD BytesRead;
 
    assert(ControlCode < 0x400);
 
    if (!DeviceIoControl(TestDeviceHandle, KMT_MAKE_CODE(ControlCode), NULL, 0, NULL, 0, &BytesRead, NULL))
        return GetLastError();
 
    return ERROR_SUCCESS;
}

Referenced by START_TEST().

KmtSendUlongToDriver()

DWORD KmtSendUlongToDriver	(	IN DWORD	ControlCode,
		IN DWORD	Value
	)

Definition at line 333 of file support.c.

{
    DWORD BytesRead;
 
    assert(ControlCode < 0x400);
 
    if (!DeviceIoControl(TestDeviceHandle, KMT_MAKE_CODE(ControlCode), &Value, sizeof(Value), NULL, 0, &BytesRead, NULL))
        return GetLastError();
 
    return ERROR_SUCCESS;
}

Referenced by START_TEST().

KmtSendWStringToDriver()

DWORD KmtSendWStringToDriver	(	IN DWORD	ControlCode,
		IN PCWSTR	String
	)

Definition at line 308 of file support.c.

{
    DWORD BytesRead;
 
    assert(ControlCode < 0x400);
 
    if (!DeviceIoControl(TestDeviceHandle, KMT_MAKE_CODE(ControlCode), (PVOID)String, (DWORD)wcslen(String) * sizeof(WCHAR), NULL, 0, &BytesRead, NULL))
        return GetLastError();
 
    return ERROR_SUCCESS;
}

Referenced by START_TEST().

KmtUnloadDriver()

VOID KmtUnloadDriver

(

VOID

)

Definition at line 167 of file support.c.

{
    DWORD Error;
 
    Error = KmtStopService(TestServiceName, &TestServiceHandle);
 
    if (Error)
    {
        fprintf(stderr, "Failed to stop %ls service with error 0x%lx\n", TestServiceName, Error);
    }
 
    Error = KmtDeleteService(TestServiceName, &TestServiceHandle);
 
    if (Error)
    {
        fprintf(stderr, "Failed to delete %ls service with error 0x%lx\n", TestServiceName, Error);
    }
}

Referenced by START_TEST(), and UnloadTcpIpTestDriver().

KmtUnloadDriverKeepService()

VOID KmtUnloadDriverKeepService

(

VOID

)

Definition at line 149 of file support.c.

{
    DWORD Error;
 
    Error = KmtStopService(TestServiceName, &TestServiceHandle);
 
    if (Error)
    {
        fprintf(stderr, "Failed to stop %ls service with error 0x%lx\n", TestServiceName, Error);
    }
}

Referenced by START_TEST().

KmtUserCallbackThread()

DWORD WINAPI KmtUserCallbackThread

(

PVOID

Parameter

)

Definition at line 29 of file support.c.

{
    DWORD Error = ERROR_SUCCESS;
    /* TODO: RequestPacket? */
    KMT_CALLBACK_REQUEST_PACKET RequestPacket;
    KMT_RESPONSE Response;
    DWORD BytesReturned;
    HANDLE LocalKmtHandle;
 
    UNREFERENCED_PARAMETER(Parameter);
 
    /* concurrent IoCtls on the same (non-overlapped) handle aren't possible,
     * so open a separate one.
     * For more info http://www.osronline.com/showthread.cfm?link=230782 */
    LocalKmtHandle = CreateFile(KMTEST_DEVICE_PATH, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);
    if (LocalKmtHandle == INVALID_HANDLE_VALUE)
        error_goto(Error, cleanup);
 
    while (1)
    {
        if (!DeviceIoControl(LocalKmtHandle, IOCTL_KMTEST_USERMODE_AWAIT_REQ, NULL, 0, &RequestPacket, sizeof(RequestPacket), &BytesReturned, NULL))
            error_goto(Error, cleanup);
        ASSERT(BytesReturned == sizeof(RequestPacket));
 
        switch (RequestPacket.OperationClass)
        {
            case QueryVirtualMemory:
            {
                SIZE_T InfoBufferSize = VirtualQuery(RequestPacket.Parameters, &Response.MemInfo, sizeof(Response.MemInfo));
                /* FIXME: an error is a valid result. That should go as a response to kernel mode instead of terminating the thread */
                if (InfoBufferSize == 0)
                    error_goto(Error, cleanup);
 
                if (!DeviceIoControl(LocalKmtHandle, IOCTL_KMTEST_USERMODE_SEND_RESPONSE, &RequestPacket.RequestId, sizeof(RequestPacket.RequestId), &Response, sizeof(Response), &BytesReturned, NULL))
                    error_goto(Error, cleanup);
                ASSERT(BytesReturned == 0);
 
                break;
            }
            default:
                DPRINT1("Unrecognized user-mode callback request\n");
                break;
        }
    }
 
cleanup:
    if (LocalKmtHandle != INVALID_HANDLE_VALUE)
        CloseHandle(LocalKmtHandle);
 
    DPRINT("Callback handler dying! Error code %lu", Error);
    return Error;
}

Referenced by KmtRunKernelTest().

Variable Documentation

KmtestHandle

HANDLE KmtestHandle

extern

Definition at line 32 of file kmtest.c.

Referenced by KmtRunKernelTest(), ListTests(), main(), and RunTest().

TestDeviceHandle

HANDLE TestDeviceHandle

static

Definition at line 115 of file support.c.

Referenced by KmtCloseDriver(), KmtOpenDriver(), KmtSendBufferToDriver(), KmtSendStringToDriver(), KmtSendToDriver(), KmtSendUlongToDriver(), and KmtSendWStringToDriver().

TestServiceHandle

SC_HANDLE TestServiceHandle

static

Definition at line 114 of file support.c.

Referenced by KmtLoadDriver(), KmtUnloadDriver(), and KmtUnloadDriverKeepService().

TestServiceName

WCHAR TestServiceName[MAX_PATH]

static

Definition at line 113 of file support.c.

Referenced by KmtLoadDriver(), KmtOpenDriver(), KmtUnloadDriver(), and KmtUnloadDriverKeepService().