service.c

Go to the documentation of this file.

/*
 * PROJECT:     ReactOS kernel-mode tests
 * LICENSE:     LGPL-2.1+ (https://spdx.org/licenses/LGPL-2.1+)
 * PURPOSE:     Kernel-Mode Test Suite loader service control functions
 * COPYRIGHT:   Copyright 2011-2018 Thomas Faber <thomas.faber@reactos.org>
 *              Copyright 2017 Ged Murphy <gedmurphy@reactos.org>
 *              Copyright 2018 Serge Gautherie <reactos-git_serge_171003@gautherie.fr>
 */
 
#include <kmt_test.h>
#include "kmtest.h"
 
#include <assert.h>
 
#define SERVICE_ACCESS (SERVICE_QUERY_STATUS | SERVICE_START | SERVICE_STOP | DELETE)
 
/*
 * This is an internal function not meant for use by the kmtests app,
 * so we declare it here instead of kmtest.h
 */
DWORD
KmtpCreateService(
    IN PCWSTR ServiceName,
    IN PCWSTR ServicePath,
    IN PCWSTR DisplayName OPTIONAL,
    IN DWORD ServiceType,
    OUT SC_HANDLE *ServiceHandle);
 
 
static SC_HANDLE ScmHandle;
 
DWORD
KmtServiceInit(VOID)
{
    DWORD Error = ERROR_SUCCESS;
 
    assert(!ScmHandle);
 
    ScmHandle = OpenSCManager(NULL, NULL, SC_MANAGER_CREATE_SERVICE);
    if (!ScmHandle)
        error(Error);
 
    return Error;
}
 
DWORD
KmtServiceCleanup(
    BOOLEAN IgnoreErrors)
{
    DWORD Error = ERROR_SUCCESS;
 
    if (ScmHandle && !CloseServiceHandle(ScmHandle) && !IgnoreErrors)
        error(Error);
 
    return Error;
}
 
DWORD
KmtCreateService(
    IN PCWSTR ServiceName,
    IN PCWSTR ServicePath,
    IN PCWSTR DisplayName OPTIONAL,
    OUT SC_HANDLE *ServiceHandle)
{
    return KmtpCreateService(ServiceName,
                             ServicePath,
                             DisplayName,
                             SERVICE_KERNEL_DRIVER,
                             ServiceHandle);
}
 
static
PCSTR
KmtGetServiceStateAsString(
    IN DWORD ServiceState)
{
    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)";
    }
}
 
static
DWORD
KmtEnsureServiceState(
    IN PCWSTR ServiceName OPTIONAL,
    IN SC_HANDLE ServiceHandle,
    IN DWORD ExpectedServiceState)
{
    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;
}
 
DWORD
KmtStartService(
    IN PCWSTR ServiceName OPTIONAL,
    IN OUT SC_HANDLE *ServiceHandle)
{
    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;
}
 
DWORD
KmtCreateAndStartService(
    IN PCWSTR ServiceName,
    IN PCWSTR ServicePath,
    IN PCWSTR DisplayName OPTIONAL,
    OUT SC_HANDLE *ServiceHandle,
    IN BOOLEAN RestartIfRunning)
{
    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;
}
 
DWORD
KmtStopService(
    IN PCWSTR ServiceName OPTIONAL,
    IN OUT SC_HANDLE *ServiceHandle)
{
    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;
}
 
DWORD
KmtDeleteService(
    IN PCWSTR ServiceName OPTIONAL,
    IN OUT SC_HANDLE *ServiceHandle)
{
    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;
}
 
DWORD KmtCloseService(
    IN OUT SC_HANDLE *ServiceHandle)
{
    DWORD Error = ERROR_SUCCESS;
 
    assert(ServiceHandle);
 
    if (*ServiceHandle && !CloseServiceHandle(*ServiceHandle))
        error_goto(Error, cleanup);
 
    *ServiceHandle = NULL;
 
cleanup:
    return Error;
}
 
 
/*
 * Private function, not meant for use in kmtests
 * See KmtCreateService & KmtFltCreateService
 */
DWORD
KmtpCreateService(
    IN PCWSTR ServiceName,
    IN PCWSTR ServicePath,
    IN PCWSTR DisplayName OPTIONAL,
    IN DWORD ServiceType,
    OUT SC_HANDLE *ServiceHandle)
{
    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;
}