service.c File Reference

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

Include dependency graph for service.c:

Go to the source code of this file.

Macros
#define	SERVICE_ACCESS   (SERVICE_QUERY_STATUS | SERVICE_START | SERVICE_STOP | DELETE)

Functions
DWORD	KmtpCreateService (IN PCWSTR ServiceName, IN PCWSTR ServicePath, IN PCWSTR DisplayName OPTIONAL, IN DWORD ServiceType, OUT SC_HANDLE *ServiceHandle)
KmtServiceInit
Initialize service management routines (by opening the service control manager) Returns Win32 error code
DWORD	KmtServiceInit (VOID)
KmtServiceCleanup
Clean up resources used by service management routines. Parameters IgnoreErrors If TRUE, the function will never set ErrorLineAndFile, and always return ERROR_SUCCESS Returns Win32 error code
DWORD	KmtServiceCleanup (BOOLEAN IgnoreErrors)
KmtCreateService
Create the specified driver service and return a handle to it Parameters ServiceName Name of the service to create ServicePath File name of the driver, relative to the current directory DisplayName Service display name ServiceHandle Pointer to a variable to receive the handle to the service Returns Win32 error code
DWORD	KmtCreateService (IN PCWSTR ServiceName, IN PCWSTR ServicePath, IN PCWSTR DisplayName OPTIONAL, OUT SC_HANDLE *ServiceHandle)
KmtGetServiceStateAsString
Parameters ServiceState Service state as a number Returns Service state as a string
static PCSTR	KmtGetServiceStateAsString (IN DWORD ServiceState)
KmtEnsureServiceState
Parameters ServiceName Name of the service to check, or NULL ServiceHandle Handle to the service ExpectedServiceState State which the service should be in Returns Win32 error code
static DWORD	KmtEnsureServiceState (IN PCWSTR ServiceName OPTIONAL, IN SC_HANDLE ServiceHandle, IN DWORD ExpectedServiceState)
KmtStartService
Start the specified driver service by handle or name (and return a handle to it) Parameters ServiceName If *ServiceHandle is NULL, name of the service to start ServiceHandle Pointer to a variable containing the service handle, or NULL (in which case it will be filled with a handle to the service) Returns Win32 error code
DWORD	KmtStartService (IN PCWSTR ServiceName OPTIONAL, IN OUT SC_HANDLE *ServiceHandle)
KmtCreateAndStartService
Create and start the specified driver service and return a handle to it Parameters ServiceName Name of the service to create ServicePath File name of the driver, relative to the current directory DisplayName Service display name ServiceHandle Pointer to a variable to receive the handle to the service RestartIfRunning TRUE to stop and restart the service if it is already running Returns Win32 error code
DWORD	KmtCreateAndStartService (IN PCWSTR ServiceName, IN PCWSTR ServicePath, IN PCWSTR DisplayName OPTIONAL, OUT SC_HANDLE *ServiceHandle, IN BOOLEAN RestartIfRunning)
KmtStopService
Stop the specified driver service by handle or name (and return a handle to it) Parameters ServiceName If *ServiceHandle is NULL, name of the service to stop ServiceHandle Pointer to a variable containing the service handle, or NULL (in which case it will be filled with a handle to the service) Returns Win32 error code
DWORD	KmtStopService (IN PCWSTR ServiceName OPTIONAL, IN OUT SC_HANDLE *ServiceHandle)
KmtDeleteService
Delete the specified driver service by handle or name (and return a handle to it) Parameters ServiceName If *ServiceHandle is NULL, name of the service to delete ServiceHandle Pointer to a variable containing the service handle. Will be set to NULL on success Returns Win32 error code
DWORD	KmtDeleteService (IN PCWSTR ServiceName OPTIONAL, IN OUT SC_HANDLE *ServiceHandle)
KmtCloseService
Close the specified driver service handle Parameters ServiceHandle Pointer to a variable containing the service handle. Will be set to NULL on success Returns Win32 error code
DWORD	KmtCloseService (IN OUT SC_HANDLE *ServiceHandle)

Variables
static SC_HANDLE	ScmHandle

Macro Definition Documentation

SERVICE_ACCESS

#define SERVICE_ACCESS   (SERVICE_QUERY_STATUS | SERVICE_START | SERVICE_STOP | DELETE)

Definition at line 15 of file service.c.

Function Documentation

KmtCloseService()

DWORD KmtCloseService

(

IN OUT SC_HANDLE *

ServiceHandle

)

Definition at line 392 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    assert(ServiceHandle);
 
    if (*ServiceHandle && !CloseServiceHandle(*ServiceHandle))
        error_goto(Error, cleanup);
 
    *ServiceHandle = NULL;
 
cleanup:
    return Error;
}

Referenced by KmtFltCloseService(), and main().

KmtCreateAndStartService()

DWORD KmtCreateAndStartService	(	IN PCWSTR	ServiceName,
		IN PCWSTR	ServicePath,
		IN PCWSTR DisplayName	OPTIONAL,
		OUT SC_HANDLE *	ServiceHandle,
		IN BOOLEAN	RestartIfRunning
	)

Definition at line 262 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    assert(ServiceHandle);
 
    Error = KmtCreateService(ServiceName, ServicePath, DisplayName, ServiceHandle);
 
    if (Error && Error != ERROR_SERVICE_EXISTS)
        goto cleanup;
 
    Error = KmtStartService(ServiceName, ServiceHandle);
 
    if (Error != ERROR_SERVICE_ALREADY_RUNNING)
        goto cleanup;
 
    Error = ERROR_SUCCESS;
 
    if (!RestartIfRunning)
        goto cleanup;
 
    Error = KmtStopService(ServiceName, ServiceHandle);
    if (Error)
        goto cleanup;
 
    Error = KmtStartService(ServiceName, ServiceHandle);
    if (Error)
        goto cleanup;
 
cleanup:
    assert(Error || *ServiceHandle);
    return Error;
}

Referenced by KmtLoadDriver(), and main().

KmtCreateService()

DWORD KmtCreateService	(	IN PCWSTR	ServiceName,
		IN PCWSTR	ServicePath,
		IN PCWSTR DisplayName	OPTIONAL,
		OUT SC_HANDLE *	ServiceHandle
	)

Definition at line 92 of file service.c.

{
    return KmtpCreateService(ServiceName,
                             ServicePath,
                             DisplayName,
                             SERVICE_KERNEL_DRIVER,
                             ServiceHandle);
}

Referenced by KmtCreateAndStartService(), and main().

KmtDeleteService()

DWORD KmtDeleteService	(	IN PCWSTR ServiceName	OPTIONAL,
		IN OUT SC_HANDLE *	ServiceHandle
	)

Definition at line 356 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    assert(ServiceHandle);
    assert(ServiceName || *ServiceHandle);
 
    if (!*ServiceHandle)
        *ServiceHandle = OpenService(ScmHandle, ServiceName, SERVICE_ACCESS);
 
    if (!*ServiceHandle)
        error_goto(Error, cleanup);
 
    if (!DeleteService(*ServiceHandle))
        error_goto(Error, cleanup);
 
    if (*ServiceHandle)
        CloseServiceHandle(*ServiceHandle);
 
cleanup:
    return Error;
}

Referenced by KmtFltDeleteService(), KmtUnloadDriver(), and main().

KmtEnsureServiceState()

static DWORD KmtEnsureServiceState ( IN PCWSTR ServiceName  OPTIONAL, IN SC_HANDLE  ServiceHandle, IN DWORD  ExpectedServiceState  )

static

Definition at line 155 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
    SERVICE_STATUS ServiceStatus;
    DWORD StartTime = GetTickCount();
    DWORD Timeout = 10 * 1000;
    PCWSTR ServiceNameOut = ServiceName ? ServiceName : L"(handle only, no name)";
 
    assert(ServiceHandle);
    assert(ExpectedServiceState);
 
    if (!QueryServiceStatus(ServiceHandle, &ServiceStatus))
        error_goto(Error, cleanup);
 
    while (ServiceStatus.dwCurrentState != ExpectedServiceState)
    {
        // NB: ServiceStatus.dwWaitHint and ServiceStatus.dwCheckPoint logic could be added, if need be.
 
        Sleep(1 * 1000);
 
        if (!QueryServiceStatus(ServiceHandle, &ServiceStatus))
            error_goto(Error, cleanup);
 
        if (GetTickCount() - StartTime >= Timeout)
            break;
    }
 
    if (ServiceStatus.dwCurrentState != ExpectedServiceState)
    {
        ok(FALSE, "Service = %ls, state = %lu %s (!= %lu %s), waitHint = %lu, checkPoint = %lu\n",
           ServiceNameOut,
           ServiceStatus.dwCurrentState, KmtGetServiceStateAsString(ServiceStatus.dwCurrentState),
           ExpectedServiceState, KmtGetServiceStateAsString(ExpectedServiceState),
           ServiceStatus.dwWaitHint, ServiceStatus.dwCheckPoint);
        goto cleanup;
    }
 
    trace("Service = %ls, state = %lu %s\n",
          ServiceNameOut,
          ExpectedServiceState, KmtGetServiceStateAsString(ExpectedServiceState));
 
cleanup:
    return Error;
}

Referenced by KmtStartService(), and KmtStopService().

KmtGetServiceStateAsString()

static PCSTR KmtGetServiceStateAsString ( IN DWORD  ServiceState )

static

Definition at line 115 of file service.c.

{
    switch(ServiceState)
    {
        case SERVICE_STOPPED:
            return "STOPPED";
        case SERVICE_START_PENDING:
            return "START_PENDING";
        case SERVICE_STOP_PENDING:
            return "STOP_PENDING";
        case SERVICE_RUNNING:
            return "RUNNING";
        case SERVICE_CONTINUE_PENDING:
            return "CONTINUE_PENDING";
        case SERVICE_PAUSE_PENDING:
            return "PAUSE_PENDING";
        case SERVICE_PAUSED:
            return "PAUSED";
        default:
            ok(FALSE, "Unknown service state = %lu\n", ServiceState);
            return "(Unknown)";
    }
}

Referenced by KmtEnsureServiceState().

KmtpCreateService()

DWORD KmtpCreateService	(	IN PCWSTR	ServiceName,
		IN PCWSTR	ServicePath,
		IN PCWSTR DisplayName	OPTIONAL,
		IN DWORD	ServiceType,
		OUT SC_HANDLE *	ServiceHandle
	)

Definition at line 414 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
    WCHAR DriverPath[MAX_PATH];
    HRESULT result = S_OK;
 
    assert(ServiceHandle);
    assert(ServiceName && ServicePath);
 
    if (!GetModuleFileName(NULL, DriverPath, sizeof DriverPath / sizeof DriverPath[0]))
        error_goto(Error, cleanup);
 
    assert(wcsrchr(DriverPath, L'\\') != NULL);
    wcsrchr(DriverPath, L'\\')[1] = L'\0';
 
    result = StringCbCatW(DriverPath, sizeof(DriverPath), ServicePath);
    if (FAILED(result))
        error_value_goto(Error, result, cleanup);
 
    if (GetFileAttributes(DriverPath) == INVALID_FILE_ATTRIBUTES)
        error_goto(Error, cleanup);
 
    *ServiceHandle = CreateService(ScmHandle, ServiceName, DisplayName,
                                   SERVICE_ACCESS, ServiceType, SERVICE_DEMAND_START,
                                   SERVICE_ERROR_NORMAL, DriverPath, NULL, NULL, NULL, NULL, NULL);
 
    if (!*ServiceHandle)
        error_goto(Error, cleanup);
 
cleanup:
    return Error;
}

Referenced by KmtCreateService(), and KmtFltCreateService().

KmtServiceCleanup()

DWORD KmtServiceCleanup

(

BOOLEAN

IgnoreErrors

)

Definition at line 64 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    if (ScmHandle && !CloseServiceHandle(ScmHandle) && !IgnoreErrors)
        error(Error);
 
    return Error;
}

Referenced by main().

KmtServiceInit()

DWORD KmtServiceInit

(

VOID

)

Definition at line 40 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    assert(!ScmHandle);
 
    ScmHandle = OpenSCManager(NULL, NULL, SC_MANAGER_CREATE_SERVICE);
    if (!ScmHandle)
        error(Error);
 
    return Error;
}

Referenced by main().

KmtStartService()

DWORD KmtStartService	(	IN PCWSTR ServiceName	OPTIONAL,
		IN OUT SC_HANDLE *	ServiceHandle
	)

Definition at line 217 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
 
    assert(ServiceHandle);
    assert(ServiceName || *ServiceHandle);
 
    if (!*ServiceHandle)
        *ServiceHandle = OpenService(ScmHandle, ServiceName, SERVICE_ACCESS);
 
    if (!*ServiceHandle)
        error_goto(Error, cleanup);
 
    if (!StartService(*ServiceHandle, 0, NULL))
        error_goto(Error, cleanup);
 
    Error = KmtEnsureServiceState(ServiceName, *ServiceHandle, SERVICE_RUNNING);
    if (Error)
        goto cleanup;
 
cleanup:
    return Error;
}

Referenced by KmtCreateAndStartService(), main(), and START_TEST().

KmtStopService()

DWORD KmtStopService	(	IN PCWSTR ServiceName	OPTIONAL,
		IN OUT SC_HANDLE *	ServiceHandle
	)

Definition at line 315 of file service.c.

{
    DWORD Error = ERROR_SUCCESS;
    SERVICE_STATUS ServiceStatus;
 
    assert(ServiceHandle);
    assert(ServiceName || *ServiceHandle);
 
    if (!*ServiceHandle)
        *ServiceHandle = OpenService(ScmHandle, ServiceName, SERVICE_ACCESS);
 
    if (!*ServiceHandle)
        error_goto(Error, cleanup);
 
    if (!ControlService(*ServiceHandle, SERVICE_CONTROL_STOP, &ServiceStatus))
        error_goto(Error, cleanup);
 
    Error = KmtEnsureServiceState(ServiceName, *ServiceHandle, SERVICE_STOPPED);
    if (Error)
        goto cleanup;
 
cleanup:
    return Error;
}

Referenced by KmtCreateAndStartService(), KmtUnloadDriver(), KmtUnloadDriverKeepService(), and main().

Variable Documentation

ScmHandle

SC_HANDLE ScmHandle

static

Definition at line 30 of file service.c.

Referenced by KmtDeleteService(), KmtpCreateService(), KmtServiceCleanup(), KmtServiceInit(), KmtStartService(), and KmtStopService().