#include "wdfloader.h"

Include dependency graph for library.c:

Functions
VOID	LibraryFree (_In_ PLIBRARY_MODULE LibModule)

	_Requires_exclusive_lock_held_ (WdfLdrGlobals.LoadedModulesListLock) NTSTATUS LibraryCreate(_In_opt_ PWDF_LIBRARY_INFO LibraryInfo
	Creates a new KMDF library (wdf01000)

	DPRINT_TRACE_ENTRY ()

	if (!ServicePath\|\|!OutLibraryModule)

	if (LibModule==NULL)

	if (!NT_SUCCESS(status))

	if (LibraryInfo)

	if (!LibModule->ServicePath.Buffer)

	RtlCopyMemory (LibModule->ServicePath.Buffer, ServicePath->Buffer, ServicePath->Length)

	if (NT_SUCCESS(status))

	DPRINT_ERROR (("GetImageInfo failed with status 0x%x\n", status))

	DPRINT_TRACE_EXIT ()

NTSTATUS	LibraryOpen (_Inout_ PLIBRARY_MODULE LibModule, _In_ PCUNICODE_STRING ObjectName)
	Opens KMDF library's driver object by its name and fills some library structure data.

VOID	LibraryClose (_Inout_ PLIBRARY_MODULE LibModule)
	Dereferences KMDF library's device object.

NTSTATUS	LibraryFindOrLoad (_In_ PCUNICODE_STRING ServicePath, _Out_ PLIBRARY_MODULE *LibModule)

VOID	LibraryReference (_In_ PLIBRARY_MODULE LibModule)

VOID NTAPI	LibraryReleaseReference (_In_ PLIBRARY_MODULE LibModule)
	Release a reference to a library module.

VOID	LibraryDereference (_In_ PLIBRARY_MODULE LibModule)

VOID	LibraryUnload (_In_ PLIBRARY_MODULE LibModule)

BOOLEAN	LibraryAcquireClientLock (_In_ PLIBRARY_MODULE LibModule)

VOID	LibraryReleaseClientLock (_In_ PLIBRARY_MODULE LibModule)

static VOID	ClientFree (_In_ PCLIENT_MODULE ClientModule)

NTSTATUS	LibraryLinkInClient (_In_ PLIBRARY_MODULE LibModule, _In_ PUNICODE_STRING ServicePath, _In_ PWDF_BIND_INFO BindInfo, _In_ PVOID Context, _Out_ PCLIENT_MODULE *OutClientModule)
	Create client module and add it to library client list.

static VOID	LibraryClientDereference (_In_ PLIBRARY_MODULE LibModule)

BOOLEAN	LibraryUnlinkClient (_In_ PLIBRARY_MODULE LibModule, _In_ PWDF_BIND_INFO BindInfo)

	_Requires_lock_held_ (WdfLdrGlobals.LoadedModulesListLock) PLIBRARY_MODULE FindLibraryByServicePathLocked(_In_ PCUNICODE_STRING ServicePath)

	if (!RegistryPath\|\|!Library)

	for (PLIST_ENTRY entry=WdfLdrGlobals.LoadedModulesList.Flink;entry !=&WdfLdrGlobals.LoadedModulesList;entry=entry->Flink)

Variables
_In_ PCUNICODE_STRING	ServicePath

_In_ PCUNICODE_STRING _Out_ PLIBRARY_MODULE *	OutLibraryModule

PLIBRARY_MODULE	LibModule = NULL

LibModule	LibraryRefCount = 1

LibModule	ImplicitlyLoaded = (LibraryInfo == NULL)

LibModule	IsBootDriver = ServiceCheckBootStart((PUNICODE_STRING)ServicePath)

LibModule	LoaderThread = KeGetCurrentThread()

	status = ExInitializeResourceLite(&LibModule->ClientsListLock)

LibModule ServicePath	Buffer

LibModule ServicePath	MaximumLength = ServicePath->MaximumLength

LibModule ServicePath	Length = ServicePath->Length

Failure	__pad0__

_Out_ PLIBRARY_MODULE *	Library

UNICODE_STRING	imageName = { 0 }

PLIBRARY_MODULE	foundModule = NULL

Exit	__pad1__

Function Documentation

◆ _Requires_exclusive_lock_held_()

_Requires_exclusive_lock_held_ ( WdfLdrGlobals. LoadedModulesListLock )

Creates a new KMDF library (wdf01000)

Parameters

[in]	LibraryInfo	The library information (version and functons)
[in]	ServicePath	The registry path for the KMDF driver

Returns: The Pointer to the created library or NULL.

◆ _Requires_lock_held_()

_Requires_lock_held_ ( WdfLdrGlobals. LoadedModulesListLock )

Definition at line 515 of file library.c.

{
    PLIBRARY_MODULE foundModule = NULL;
    UNICODE_STRING needleName;
 
    GetNameFromPath(ServicePath, &needleName);
 
    for (PLIST_ENTRY entry = WdfLdrGlobals.LoadedModulesList.Flink;
         entry != &WdfLdrGlobals.LoadedModulesList;
         entry = entry->Flink)
    {
        UNICODE_STRING haystackName;
        PLIBRARY_MODULE currentLib = CONTAINING_RECORD(entry, LIBRARY_MODULE, LibraryListEntry);
        GetNameFromPath(&currentLib->ServicePath, &haystackName);
 
        if (RtlEqualUnicodeString(&needleName, &haystackName, TRUE))
        {
            foundModule = currentLib;
            break;
        }
    }
 
    return foundModule;
}

◆ ClientFree()

static VOID ClientFree ( _In_ PCLIENT_MODULE ClientModule )

static

Definition at line 382 of file library.c.

{
    if (ClientModule->ImageName.Buffer)
    {
        RtlFreeUnicodeString(&ClientModule->ImageName);
    }
 
    ExFreePoolWithTag(ClientModule, WDFLDR_TAG);
}

Referenced by LibraryLinkInClient(), and LibraryUnlinkClient().

◆ DPRINT_ERROR()

DPRINT_ERROR ( ("GetImageInfo failed with status 0x%x\n", status) )

◆ DPRINT_TRACE_ENTRY()

DPRINT_TRACE_ENTRY ( )

Referenced by LibraryFree(), and LibraryReleaseReference().

◆ DPRINT_TRACE_EXIT()

DPRINT_TRACE_EXIT ( )

Referenced by if(), LibraryFree(), and LibraryReleaseReference().

◆ for()

for ( PLIST_ENTRY entry = WdfLdrGlobals.LoadedModulesList.Flink; entry != &WdfLdrGlobals.LoadedModulesList; entry = entry->Flink )

Definition at line 575 of file library.c.

    {
        PLIBRARY_MODULE currentLib = CONTAINING_RECORD(entry, LIBRARY_MODULE, LibraryListEntry);
 
        if (RtlEqualUnicodeString(&imageName, &currentLib->ImageName, TRUE))
        {
            foundModule = currentLib;
            break;
        }
    }

◆ if() [1/7]

if ( !LibModule->ServicePath. Buffer )

Definition at line 109 of file library.c.

    {
        DPRINT_ERROR(("Failed to allocate service path buffer\n"));
        status = STATUS_INSUFFICIENT_RESOURCES;
        goto Failure;
    }

◆ if() [2/7]

if ( ! NT_SUCCESSstatus )

Definition at line 87 of file library.c.

    {
        DPRINT_ERROR(("ExInitializeResourceLite failed with status 0x%x\n", status));
        goto Failure;
    }

◆ if() [3/7]

if ( !RegistryPath||! Library )

Definition at line 556 of file library.c.

    {
        return STATUS_INVALID_PARAMETER;
    }

◆ if() [4/7]

if ( !ServicePath||! OutLibraryModule )

Definition at line 62 of file library.c.

    {
        DPRINT_ERROR(("Invalid parameters: ServicePath=%p, OutLibraryModule=%p\n",
                     ServicePath, OutLibraryModule));
        return STATUS_INVALID_PARAMETER;
    }

◆ if() [5/7]

if ( LibModule = = NULL )

Definition at line 72 of file library.c.

    {
        DPRINT_ERROR(("Failed to allocate library module structure\n"));
        return STATUS_INSUFFICIENT_RESOURCES;
    }

◆ if() [6/7]

if ( LibraryInfo )

Definition at line 96 of file library.c.

    {
        LibModule->LibraryInfo = LibraryInfo;
        LibModule->Version = LibraryInfo->Version;
        DPRINT_VERBOSE(("Library info provided: Version %d.%d.%d\n",
                       LibraryInfo->Version.Major,
                       LibraryInfo->Version.Minor,
                       LibraryInfo->Version.Build));
    }

◆ if() [7/7]

if ( NT_SUCCESS(status) )

Definition at line 130 of file library.c.

    {
        // Insert into loaded modules list. The LoadedModulesListLock is held here
        InsertHeadList(&WdfLdrGlobals.LoadedModulesList, &LibModule->LibraryListEntry);
 
        *OutLibraryModule = LibModule;
 
        DPRINT_VERBOSE(("Successfully created library module %wZ (Image: %wZ, Base: %p, Size: 0x%x)\n",
               &LibModule->ServicePath,
               &LibModule->ImageName,
               LibModule->ImageAddress,
               LibModule->ImageSize));
 
        DPRINT_TRACE_EXIT();
        return STATUS_SUCCESS;
    }

◆ LibraryAcquireClientLock()

BOOLEAN LibraryAcquireClientLock ( _In_ PLIBRARY_MODULE LibModule )

Definition at line 365 of file library.c.

{
    KeEnterCriticalRegion();
    return ExAcquireResourceExclusiveLite(&LibModule->ClientsListLock, TRUE);
}

Referenced by ClassLinkInClient(), ClassUnlinkClient(), LibraryLinkInClient(), and LibraryUnlinkClient().

◆ LibraryClientDereference()

static VOID LibraryClientDereference ( _In_ PLIBRARY_MODULE LibModule )

static

Definition at line 461 of file library.c.

{
    LONG refs = InterlockedDecrement(&LibModule->ClientRefCount);
 
    __DBGPRINT(("Dereference module %wZ, %d references left\n", &LibModule->ServicePath, refs));
 
    if (refs <= 0)
    {
        LibraryUnload(LibModule);
    }
}

Referenced by LibraryUnlinkClient().

◆ LibraryClose()

VOID LibraryClose ( _Inout_ PLIBRARY_MODULE LibModule )

Dereferences KMDF library's device object.

Definition at line 195 of file library.c.

{
    if (LibModule->LibraryFileObject != NULL)
    {
        ObDereferenceObject(LibModule->LibraryFileObject);
        LibModule->LibraryFileObject = NULL;
    }
}

Referenced by DllUnload(), LibraryDereference(), and LibraryUnload().

◆ LibraryDereference()

VOID LibraryDereference ( _In_ PLIBRARY_MODULE LibModule )

Definition at line 300 of file library.c.

{
    BOOLEAN cleanupNeeded = FALSE;
 
    FxLdrAcquireLoadedModuleLock();
    if (InterlockedDecrement(&LibModule->LibraryRefCount) == 0)
    {
        if (!IsListEmpty(&LibModule->LibraryListEntry))
        {
            RemoveEntryList(&LibModule->LibraryListEntry);
            InitializeListHead(&LibModule->LibraryListEntry); // Indicate removal process
            cleanupNeeded = TRUE;
        }
    }
    FxLdrReleaseLoadedModuleLock();
 
    if (cleanupNeeded)
    {
        if (LibModule->LibraryInfo)
            LibraryUnload(LibModule);
        else
            LibraryClose(LibModule);
        LibraryFree(LibModule);
    }
}

Referenced by LibraryFindOrLoad(), WdfRegisterLibrary(), WdfVersionBind(), and WdfVersionUnbind().

◆ LibraryFindOrLoad()

NTSTATUS LibraryFindOrLoad	(	_In_ PCUNICODE_STRING	ServicePath,
		_Out_ PLIBRARY_MODULE *	LibModule
	)

Definition at line 206 of file library.c.

{
    BOOLEAN loadNeeded = FALSE;
    NTSTATUS status;
 
    FxLdrAcquireLoadedModuleLock();
    PLIBRARY_MODULE pLibModule = FindLibraryByServicePathLocked(ServicePath);
 
    if (pLibModule == NULL)
    {
        // Client driver is loaded before the library, we need to create it here
        status = LibraryCreate(NULL, ServicePath, &pLibModule);
        if (NT_SUCCESS(status))
        {
            loadNeeded = TRUE;
        }
    }
    else
    {
        status = STATUS_SUCCESS;
    }
 
    // Reference the library
    if (pLibModule)
        InterlockedIncrement(&pLibModule->LibraryRefCount);
 
    FxLdrReleaseLoadedModuleLock();
 
    // We've just created a library, time to load the actual driver
    if (loadNeeded)
    {
        // This will call WdfRegisterLibrary (as part of KMDF's DriverEntry)
        status = ZwLoadDriver((PUNICODE_STRING)ServicePath);
        if (NT_SUCCESS(status) && !pLibModule->LibraryInfo)
        {
            __DBGPRINT(("ZwLoadDriver(%wZ) succeeded but Libray information was returned\n",
                        ServicePath));
            status = STATUS_NOT_SAFE_MODE_DRIVER;
        }
        else if (!NT_SUCCESS(status))
        {
            __DBGPRINT(("ZwLoadDriver(%wZ) failed with status %x\n", ServicePath, status));
        }
 
        if (!NT_SUCCESS(status))
        {
            LibraryDereference(pLibModule);
            // Cleanup created library
            ASSERT(pLibModule->LibraryInfo == NULL);
            LibraryDereference(pLibModule);
            pLibModule = NULL;
        }
    }
 
    *LibModule = pLibModule;
    return status;
}

Referenced by ReferenceVersion().

◆ LibraryFree()

VOID LibraryFree ( _In_ PLIBRARY_MODULE LibModule )

Definition at line 13 of file library.c.

{
    DPRINT_TRACE_ENTRY();
 
    if (!LibModule)
    {
        DPRINT_ERROR(("LibModule is NULL\n"));
        return;
    }
 
    if (LibModule->ServicePath.Buffer)
    {
        RtlFreeUnicodeString(&LibModule->ServicePath);
        LibModule->ServicePath.Buffer = NULL;
    }
 
    if (LibModule->ImageName.Buffer)
    {
        RtlFreeUnicodeString(&LibModule->ImageName);
        LibModule->ImageName.Buffer = NULL;
    }
 
    ExDeleteResourceLite(&LibModule->ClientsListLock);
    RtlZeroMemory(LibModule, sizeof(*LibModule));
    ExFreePoolWithTag(LibModule, WDFLDR_TAG);
 
    DPRINT_TRACE_EXIT();
}

Referenced by DllUnload(), LibraryDereference(), and LibraryUnload().

◆ LibraryLinkInClient()

NTSTATUS LibraryLinkInClient	(	_In_ PLIBRARY_MODULE	LibModule,
		_In_ PUNICODE_STRING	ServicePath,
		_In_ PWDF_BIND_INFO	BindInfo,
		_In_ PVOID	Context,
		_Out_ PCLIENT_MODULE *	OutClientModule
	)

Create client module and add it to library client list.

Parameters

LibModule	Library that client is being added to
ServicePath	Client driver service registry path
BindInfo	Bind information
Context	Client context
OutClientModule	Created client module added to library clients list

Returns: STATUS_SUCCESS on success, error code otherwise

Definition at line 404 of file library.c.

{
    PCLIENT_MODULE clientModule;
    NTSTATUS status;
 
    clientModule = ExAllocatePoolWithTag(NonPagedPool, sizeof(*clientModule), WDFLDR_TAG);
 
    if (clientModule == NULL)
    {
        __DBGPRINT(("ERROR: ExAllocatePoolWithTag failed\n"));
        __DBGPRINT(("ERROR: Client module NOT linked\n"));
 
        return STATUS_INSUFFICIENT_RESOURCES;
    }
 
    *clientModule = (CLIENT_MODULE){
        .Context = Context,
        .Info = BindInfo
    };
 
    InitializeListHead(&clientModule->ClassListHead);
    InitializeListHead(&clientModule->LibListEntry);
 
    status = GetImageName(ServicePath, &clientModule->ImageName);
    if (NT_SUCCESS(status))
    {
        __DBGPRINT(("Client Image Name: %wZ\n", &clientModule->ImageName));
 
        status = GetImageInfo(&clientModule->ImageName,
                              &clientModule->ImageAddr,
                              &clientModule->ImageSize);
        if (!NT_SUCCESS(status))
        {
            __DBGPRINT(("GetImageInfo failed with status 0x%x\n", status));
            __DBGPRINT(("ERROR: Client module NOT linked\n"));
            ClientFree(clientModule);
 
            return status;
        }
    }
 
    LibraryAcquireClientLock(LibModule);
    InsertHeadList(&LibModule->ClientsListHead, &clientModule->LibListEntry);
    InterlockedIncrement(&LibModule->ClientRefCount);
    LibraryReleaseClientLock(LibModule);
 
    *OutClientModule = clientModule;
    return STATUS_SUCCESS;
}

Referenced by WdfVersionBind().

◆ LibraryOpen()

NTSTATUS LibraryOpen	(	_Inout_ PLIBRARY_MODULE	LibModule,
		_In_ PCUNICODE_STRING	ObjectName
	)

Opens KMDF library's driver object by its name and fills some library structure data.

Parameters

LibModule	Library module to update
ObjectName	Device object name

Returns: STATUS_SUCCESS on success, error code otherwise

Definition at line 167 of file library.c.

{
    PDEVICE_OBJECT deviceObject;
 
    if (ObjectName == NULL)
    {
        return STATUS_SUCCESS;
    }
 
    NTSTATUS status = IoGetDeviceObjectPointer((PUNICODE_STRING)ObjectName,
                                               FILE_READ_DATA,
                                               &LibModule->LibraryFileObject,
                                               &deviceObject);
 
    if (NT_SUCCESS(status))
    {
        LibModule->LibraryDriverObject = deviceObject->DriverObject;
    }
 
    return status;
}

Referenced by WdfRegisterLibrary().

◆ LibraryReference()

VOID LibraryReference ( _In_ PLIBRARY_MODULE LibModule )

Definition at line 267 of file library.c.

{
    FxLdrAcquireLoadedModuleLock();
    InterlockedIncrement(&LibModule->LibraryRefCount);
    FxLdrReleaseLoadedModuleLock();
}

Referenced by WdfVersionUnbind().

◆ LibraryReleaseClientLock()

VOID LibraryReleaseClientLock ( _In_ PLIBRARY_MODULE LibModule )

Definition at line 373 of file library.c.

{
    ExReleaseResourceLite(&LibModule->ClientsListLock);
    KeLeaveCriticalRegion();
}

Referenced by ClassLinkInClient(), ClassUnlinkClient(), LibraryLinkInClient(), and LibraryUnlinkClient().

◆ LibraryReleaseReference()

VOID NTAPI LibraryReleaseReference ( _In_ PLIBRARY_MODULE LibModule )

Release a reference to a library module.

Definition at line 280 of file library.c.

{
    LONG refCount;
    DPRINT_TRACE_ENTRY();
 
    refCount = InterlockedDecrement(&LibModule->LibraryRefCount);
    DPRINT_VERBOSE(("Released reference to library %wZ, RefCount=%d\n",
                   &LibModule->ServicePath, refCount));
 
    if (refCount <= 0)
    {
        DPRINT(("Library %wZ reference count reached zero, unloading\n", &LibModule->ServicePath));
        LibraryUnload(LibModule);
    }
 
    DPRINT_TRACE_EXIT();
}

Referenced by DereferenceVersion().

◆ LibraryUnlinkClient()

BOOLEAN LibraryUnlinkClient	(	_In_ PLIBRARY_MODULE	LibModule,
		_In_ PWDF_BIND_INFO	BindInfo
	)

Definition at line 475 of file library.c.

{
    LibraryAcquireClientLock(LibModule);
 
    // search in library clients entry to remove
    BOOLEAN found = FALSE;
    PCLIENT_MODULE clientModule;
    for (PLIST_ENTRY entry = LibModule->ClientsListHead.Flink;
         entry != &LibModule->ClientsListHead;
         entry = entry->Flink)
    {
        clientModule = CONTAINING_RECORD(entry, CLIENT_MODULE, LibListEntry);
        if (clientModule->Info == BindInfo)
        {
            found = TRUE;
            break;
        }
    }
 
    if (found)
    {
        RemoveEntryList(&clientModule->LibListEntry);
        LibraryClientDereference(LibModule);
    }
 
    LibraryReleaseClientLock(LibModule);
 
    if (found)
    {
        InitializeListHead(&clientModule->LibListEntry);
        ClientFree(clientModule);
        return TRUE;
    }
 
    __DBGPRINT(("ERROR: Client module %p, bind %p NOT found\n", LibModule, BindInfo));
    return FALSE;
}

Referenced by DereferenceVersion(), and WdfVersionUnbind().

◆ LibraryUnload()

VOID LibraryUnload ( _In_ PLIBRARY_MODULE LibModule )

Definition at line 328 of file library.c.

{
    NTSTATUS status;
 
    /* This occurs because of how WDF ClassDrivers behave. */
    if (LibModule->IsBootDriver)
        return;
 
    ASSERT(LibModule->LibraryInfo);
 
    status = LibModule->LibraryInfo->LibraryDecommission();
    if (!NT_SUCCESS(status))
    {
        __DBGPRINT(("LibraryDecommission failed %X\n", status));
    }
 
    LibModule->LibraryInfo = NULL;
 
    __DBGPRINT(("Unloading library %wZ\n", &LibModule->ServicePath));
 
    LibraryClose(LibModule);
 
    status = ZwUnloadDriver(&LibModule->ServicePath);
    if (!NT_SUCCESS(status))
    {
        __DBGPRINT(("unload of %wZ returned 0x%x (this may not be a true error if someone else attempted to stop"
            " the service first)\n",
            &LibModule->ServicePath,
            status));
    }
 
    // Free the library module directly - caller handles the cleanup sequence
    LibraryFree(LibModule);
}

◆ RtlCopyMemory()

RtlCopyMemory	(	LibModule->ServicePath.	Buffer,
		ServicePath->	Buffer,
		ServicePath->	Length
	)

Variable Documentation

◆ pad0

Failure __pad0__

Definition at line 149 of file library.c.

◆ pad1

Exit __pad1__

Definition at line 591 of file library.c.

◆ Buffer

LibModule ServicePath Buffer

Initial value:

= ExAllocatePoolWithTag(PagedPool,
                                                           ServicePath->MaximumLength,
                                                           WDFLDR_TAG)