reactos/base/system/services/driver.c
Joachim Henze d31a557237 [SERVICES] Tweak the binary size a bit CORE-18071
Fixes some typos like "alread"->"already"
and kill g_dwServiceBits in rpcserver.cpp
and omit points and exclamation marks at end of prints.

On GCC8.4.0dbg RosBE2.2.1 this shrinks the file for me from 210.432 to 209.920
The file is loaded many times into memory, therefore
optimization pays off here at runtime memory consumption.

Also shorten to H. Poussineau in the header sections,
to stop git from displaying diff in that line on each review
due to that special char.
2022-03-20 20:12:56 +01:00

392 lines
12 KiB
C

/*
* PROJECT: ReactOS Service Control Manager
* LICENSE: GPL - See COPYING in the top level directory
* FILE: base/system/services/driver.c
* PURPOSE: Driver control interface
* COPYRIGHT: Copyright 2005-2006 Eric Kohl
*
*/
/* INCLUDES *****************************************************************/
#include "services.h"
#include <ndk/iofuncs.h>
#include <ndk/setypes.h>
#define NDEBUG
#include <debug.h>
/* FUNCTIONS ****************************************************************/
static
DWORD
ScmLoadDriver(PSERVICE lpService)
{
NTSTATUS Status = STATUS_SUCCESS;
BOOLEAN WasPrivilegeEnabled = FALSE;
PWSTR pszDriverPath;
UNICODE_STRING DriverPath;
/* Build the driver path */
/* 52 = wcslen(L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\") */
pszDriverPath = HeapAlloc(GetProcessHeap(),
HEAP_ZERO_MEMORY,
(52 + wcslen(lpService->lpServiceName) + 1) * sizeof(WCHAR));
if (pszDriverPath == NULL)
return ERROR_NOT_ENOUGH_MEMORY;
wcscpy(pszDriverPath,
L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\");
wcscat(pszDriverPath,
lpService->lpServiceName);
RtlInitUnicodeString(&DriverPath,
pszDriverPath);
DPRINT(" Path: %wZ\n", &DriverPath);
/* Acquire driver-loading privilege */
Status = RtlAdjustPrivilege(SE_LOAD_DRIVER_PRIVILEGE,
TRUE,
FALSE,
&WasPrivilegeEnabled);
if (!NT_SUCCESS(Status))
{
/* We encountered a failure, exit properly */
DPRINT1("SERVICES: Cannot acquire driver-loading privilege, Status = 0x%08lx\n", Status);
goto done;
}
Status = NtLoadDriver(&DriverPath);
/* Release driver-loading privilege */
RtlAdjustPrivilege(SE_LOAD_DRIVER_PRIVILEGE,
WasPrivilegeEnabled,
FALSE,
&WasPrivilegeEnabled);
done:
HeapFree(GetProcessHeap(), 0, pszDriverPath);
return RtlNtStatusToDosError(Status);
}
static
DWORD
ScmUnloadDriver(PSERVICE lpService)
{
NTSTATUS Status = STATUS_SUCCESS;
BOOLEAN WasPrivilegeEnabled = FALSE;
PWSTR pszDriverPath;
UNICODE_STRING DriverPath;
DWORD dwError;
/* Build the driver path */
/* 52 = wcslen(L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\") */
pszDriverPath = HeapAlloc(GetProcessHeap(),
HEAP_ZERO_MEMORY,
(52 + wcslen(lpService->lpServiceName) + 1) * sizeof(WCHAR));
if (pszDriverPath == NULL)
return ERROR_NOT_ENOUGH_MEMORY;
wcscpy(pszDriverPath,
L"\\Registry\\Machine\\System\\CurrentControlSet\\Services\\");
wcscat(pszDriverPath,
lpService->lpServiceName);
RtlInitUnicodeString(&DriverPath,
pszDriverPath);
DPRINT(" Path: %wZ\n", &DriverPath);
/* Acquire driver-unloading privilege */
Status = RtlAdjustPrivilege(SE_LOAD_DRIVER_PRIVILEGE,
TRUE,
FALSE,
&WasPrivilegeEnabled);
if (!NT_SUCCESS(Status))
{
/* We encountered a failure, exit properly */
DPRINT1("SERVICES: Cannot acquire driver-unloading privilege, Status = 0x%08lx\n", Status);
dwError = RtlNtStatusToDosError(Status);
goto done;
}
Status = NtUnloadDriver(&DriverPath);
if (Status == STATUS_INVALID_DEVICE_REQUEST)
dwError = ERROR_INVALID_SERVICE_CONTROL;
else
dwError = RtlNtStatusToDosError(Status);
/* Release driver-unloading privilege */
RtlAdjustPrivilege(SE_LOAD_DRIVER_PRIVILEGE,
WasPrivilegeEnabled,
FALSE,
&WasPrivilegeEnabled);
done:
HeapFree(GetProcessHeap(), 0, pszDriverPath);
return dwError;
}
static
DWORD
ScmGetDriverStatus(PSERVICE lpService,
LPSERVICE_STATUS lpServiceStatus)
{
OBJECT_ATTRIBUTES ObjectAttributes;
UNICODE_STRING DirName;
HANDLE DirHandle;
NTSTATUS Status = STATUS_SUCCESS;
POBJECT_DIRECTORY_INFORMATION DirInfo;
ULONG BufferLength;
ULONG DataLength;
ULONG Index;
DWORD dwError = ERROR_SUCCESS;
BOOLEAN bFound = FALSE;
DWORD dwPreviousState;
DPRINT1("ScmGetDriverStatus() called\n");
/* Zero output buffer if any */
if (lpServiceStatus != NULL)
{
memset(lpServiceStatus, 0, sizeof(SERVICE_STATUS));
}
/* Select the appropriate object directory based on driver type */
if (lpService->Status.dwServiceType == SERVICE_KERNEL_DRIVER)
{
RtlInitUnicodeString(&DirName, L"\\Driver");
}
else // if (lpService->Status.dwServiceType == SERVICE_FILE_SYSTEM_DRIVER)
{
ASSERT(lpService->Status.dwServiceType == SERVICE_FILE_SYSTEM_DRIVER);
RtlInitUnicodeString(&DirName, L"\\FileSystem");
}
InitializeObjectAttributes(&ObjectAttributes,
&DirName,
0,
NULL,
NULL);
/* Open the object directory where loaded drivers are */
Status = NtOpenDirectoryObject(&DirHandle,
DIRECTORY_QUERY | DIRECTORY_TRAVERSE,
&ObjectAttributes);
if (!NT_SUCCESS(Status))
{
DPRINT1("NtOpenDirectoryObject() failed\n");
return RtlNtStatusToDosError(Status);
}
/* Allocate a buffer big enough for querying the object */
BufferLength = sizeof(OBJECT_DIRECTORY_INFORMATION) +
2 * MAX_PATH * sizeof(WCHAR);
DirInfo = (OBJECT_DIRECTORY_INFORMATION*) HeapAlloc(GetProcessHeap(),
HEAP_ZERO_MEMORY,
BufferLength);
/* Now, start browsing entry by entry */
Index = 0;
while (TRUE)
{
Status = NtQueryDirectoryObject(DirHandle,
DirInfo,
BufferLength,
TRUE,
FALSE,
&Index,
&DataLength);
/* End of enumeration, the driver was not found */
if (Status == STATUS_NO_MORE_ENTRIES)
{
DPRINT("No more services\n");
break;
}
/* Other error, fail */
if (!NT_SUCCESS(Status))
break;
DPRINT("Comparing: '%S' '%wZ'\n", lpService->lpServiceName, &DirInfo->Name);
/* Compare names to check whether it matches our driver */
if (_wcsicmp(lpService->lpServiceName, DirInfo->Name.Buffer) == 0)
{
/* That's our driver, bail out! */
DPRINT1("Found: '%S' '%wZ'\n",
lpService->lpServiceName, &DirInfo->Name);
bFound = TRUE;
break;
}
}
/* Release resources we don't need */
HeapFree(GetProcessHeap(),
0,
DirInfo);
NtClose(DirHandle);
/* Only quit if there's a failure
* Not having found the driver is legit!
* It means the driver was registered as a service, but not loaded
* We have not to fail in that situation, but to return proper status
*/
if (!NT_SUCCESS(Status) && Status != STATUS_NO_MORE_ENTRIES)
{
DPRINT1("Status: %lx\n", Status);
return RtlNtStatusToDosError(Status);
}
/* Now, we have two cases:
* We found the driver: it means it's running
* We didn't find the driver: it wasn't running
*/
if (bFound)
{
/* Found, return it's running */
dwPreviousState = lpService->Status.dwCurrentState;
/* It is running */
lpService->Status.dwCurrentState = SERVICE_RUNNING;
if (dwPreviousState == SERVICE_STOPPED)
{
/* Make it run if it was stopped before */
lpService->Status.dwWin32ExitCode = ERROR_SUCCESS;
lpService->Status.dwServiceSpecificExitCode = ERROR_SUCCESS;
lpService->Status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
lpService->Status.dwCheckPoint = 0;
lpService->Status.dwWaitHint = 0;
}
if (lpService->Status.dwWin32ExitCode == ERROR_SERVICE_NEVER_STARTED)
lpService->Status.dwWin32ExitCode = ERROR_SUCCESS;
}
else
{
/* Not found, return it's stopped */
if (lpService->Status.dwCurrentState == SERVICE_STOP_PENDING)
{
/* Stopped successfully */
lpService->Status.dwWin32ExitCode = ERROR_SUCCESS;
lpService->Status.dwCurrentState = SERVICE_STOPPED;
lpService->Status.dwControlsAccepted = 0;
lpService->Status.dwCheckPoint = 0;
lpService->Status.dwWaitHint = 0;
}
else if (lpService->Status.dwCurrentState == SERVICE_STOPPED)
{
/* Don't change the current status */
}
else
{
lpService->Status.dwWin32ExitCode = ERROR_GEN_FAILURE;
lpService->Status.dwCurrentState = SERVICE_STOPPED;
lpService->Status.dwControlsAccepted = 0;
lpService->Status.dwCheckPoint = 0;
lpService->Status.dwWaitHint = 0;
}
}
/* Copy service status if required */
if (lpServiceStatus != NULL)
{
RtlCopyMemory(lpServiceStatus,
&lpService->Status,
sizeof(SERVICE_STATUS));
}
DPRINT1("ScmGetDriverStatus() done (Error: %lu)\n", dwError);
return ERROR_SUCCESS;
}
DWORD
ScmStartDriver(PSERVICE pService)
{
DWORD dwError;
DPRINT("ScmStartDriver(%p)\n", pService);
dwError = ScmLoadDriver(pService);
if (dwError == ERROR_SUCCESS)
{
pService->Status.dwCurrentState = SERVICE_RUNNING;
pService->Status.dwControlsAccepted = SERVICE_ACCEPT_STOP;
pService->Status.dwWin32ExitCode = ERROR_SUCCESS;
}
DPRINT("ScmStartDriver returns %lu\n", dwError);
return dwError;
}
DWORD
ScmControlDriver(PSERVICE lpService,
DWORD dwControl,
LPSERVICE_STATUS lpServiceStatus)
{
DWORD dwError;
DPRINT("ScmControlDriver() called\n");
switch (dwControl)
{
case SERVICE_CONTROL_STOP:
/* Check the drivers status */
dwError = ScmGetDriverStatus(lpService,
lpServiceStatus);
if (dwError != ERROR_SUCCESS)
goto done;
/* Fail, if it is not running */
if (lpService->Status.dwCurrentState != SERVICE_RUNNING)
{
dwError = ERROR_INVALID_SERVICE_CONTROL;
goto done;
}
/* Unload the driver */
dwError = ScmUnloadDriver(lpService);
if (dwError == ERROR_INVALID_SERVICE_CONTROL)
{
/* The driver cannot be stopped, mark it non-stoppable */
lpService->Status.dwControlsAccepted = 0;
goto done;
}
/* Make the driver 'stop pending' */
lpService->Status.dwCurrentState = SERVICE_STOP_PENDING;
/* Check the drivers status again */
dwError = ScmGetDriverStatus(lpService,
lpServiceStatus);
break;
case SERVICE_CONTROL_INTERROGATE:
dwError = ScmGetDriverStatus(lpService,
lpServiceStatus);
break;
default:
dwError = ERROR_INVALID_SERVICE_CONTROL;
}
done:
DPRINT("ScmControlDriver() done (Erorr: %lu)\n", dwError);
return dwError;
}
/* EOF */