IoDeviceInterface.c File Reference

#include <kmt_test.h>
#include <poclass.h>
#include <debug.h>

Include dependency graph for IoDeviceInterface.c:

Go to the source code of this file.

Macros
#define	NDEBUG

Functions
static VOID	Test_IoOpenDeviceInterfaceRegistryKey (_In_opt_ PCWSTR SymbolicLink)
static VOID	Test_IoGetDeviceInterfaceAlias (_In_opt_ PCWSTR SymbolicLink)
static VOID	Test_IoSetDeviceInterfaceState (_In_opt_ PCWSTR SymbolicLink)
static VOID	Test_IoGetDeviceInterfaces (_In_ const GUID *Guid)
static NTSTATUS NTAPI	NotificationCallback (_In_ PVOID NotificationStructure, _Inout_opt_ PVOID Context)
static VOID	Test_IoRegisterPlugPlayNotification (VOID)
	START_TEST (IoDeviceInterface)

Variables
static const GUID	GUID_NULL = {0x00000000L, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
static const GUID	KSCATEGORY_BRIDGE = {0x085AFF00L, 0x62CE, 0x11CF, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}
static const GUID	KSCATEGORY_CAPTURE = {0x65E8773DL, 0x8F56, 0x11D0, {0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}
static const GUID	KSCATEGORY_COMMUNICATIONSTRANSFORM = {0xCF1DDA2CL, 0x9743, 0x11D0, {0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}
static const GUID	KSCATEGORY_DATACOMPRESSOR = {0x1E84C900L, 0x7E70, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}
static const GUID	KSCATEGORY_DATADECOMPRESSOR = {0x2721AE20L, 0x7E70, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}
static const GUID	KSCATEGORY_DATATRANSFORM = {0x2EB07EA0L, 0x7E70, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}
static const GUID	KSCATEGORY_FILESYSTEM = {0x760FED5EL, 0x9357, 0x11D0, {0xA3, 0xCC, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}
static const GUID	KSCATEGORY_INTERFACETRANSFORM = {0xCF1DDA2DL, 0x9743, 0x11D0, {0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}
static const GUID	KSCATEGORY_MEDIUMTRANSFORM = {0xCF1DDA2EL, 0x9743, 0x11D0, {0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}
static const GUID	KSCATEGORY_MIXER = {0xAD809C00L, 0x7B88, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}
static const GUID	KSCATEGORY_RENDER = {0x65E8773EL, 0x8F56, 0x11D0, {0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}
static const GUID	KSCATEGORY_SPLITTER = {0x0A4252A0L, 0x7E70, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}
static const GUID *	Types []
static UCHAR	NotificationContext
static DRIVER_NOTIFICATION_CALLBACK_ROUTINE	NotificationCallback

Macro Definition Documentation

NDEBUG

#define NDEBUG

Definition at line 16 of file IoDeviceInterface.c.

Function Documentation

NotificationCallback()

static NTSTATUS NTAPI NotificationCallback ( _In_ PVOID  NotificationStructure, _Inout_opt_ PVOID  Context  )

static

Definition at line 197 of file IoDeviceInterface.c.

{
    PDEVICE_INTERFACE_CHANGE_NOTIFICATION Notification = NotificationStructure;
    NTSTATUS Status;
    OBJECT_ATTRIBUTES ObjectAttributes;
    HANDLE Handle;
 
    ok_irql(PASSIVE_LEVEL);
    ok_eq_pointer(Context, &NotificationContext);
    ok_eq_uint(Notification->Version, 1);
    ok_eq_uint(Notification->Size, sizeof(*Notification));
 
    /* symbolic link must exist */
    trace("Interface change: %wZ\n", Notification->SymbolicLinkName);
    InitializeObjectAttributes(&ObjectAttributes,
                               Notification->SymbolicLinkName,
                               OBJ_KERNEL_HANDLE,
                               NULL,
                               NULL);
    Status = ZwOpenSymbolicLinkObject(&Handle, GENERIC_READ, &ObjectAttributes);
    ok_eq_hex(Status, STATUS_SUCCESS);
    if (!skip(NT_SUCCESS(Status), "No symbolic link\n"))
    {
        Status = ObCloseHandle(Handle, KernelMode);
        ok_eq_hex(Status, STATUS_SUCCESS);
    }
    return STATUS_SUCCESS;
}

START_TEST()

START_TEST

(

IoDeviceInterface

)

Definition at line 250 of file IoDeviceInterface.c.

{
    size_t n;
    for (n = 0; n < RTL_NUMBER_OF(Types); ++n)
    {
        Test_IoGetDeviceInterfaces(Types[n]);
    }
    /* Test the invalid case behaviour */
    Test_IoGetDeviceInterfaceAlias(NULL);
    Test_IoOpenDeviceInterfaceRegistryKey(NULL);
    Test_IoSetDeviceInterfaceState(NULL);
    Test_IoRegisterPlugPlayNotification();
}

Test_IoGetDeviceInterfaceAlias()

static VOID Test_IoGetDeviceInterfaceAlias ( _In_opt_ PCWSTR  SymbolicLink )

static

Definition at line 110 of file IoDeviceInterface.c.

{
    UNICODE_STRING SymbolicLinkName;
    size_t n;
 
    RtlInitUnicodeString(&SymbolicLinkName, SymbolicLink);
 
    for (n = 0; n < RTL_NUMBER_OF(Types); ++n)
    {
        UNICODE_STRING AliasSymbolicLinkName;
        NTSTATUS Status = IoGetDeviceInterfaceAlias(&SymbolicLinkName, Types[n], &AliasSymbolicLinkName);
 
        if (skip(NT_SUCCESS(Status), "IoGetDeviceInterfaceAlias(): fail: %d 0x%x\n", n, Status))
            continue;
 
        trace("IoGetDeviceInterfaceAlias(): success: %d %wZ\n", n, &AliasSymbolicLinkName);
 
        /* Test IoOpenDeviceInterfaceRegistryKey with alias symbolic link too */
        Test_IoOpenDeviceInterfaceRegistryKey(AliasSymbolicLinkName.Buffer);
 
        RtlFreeUnicodeString(&AliasSymbolicLinkName);
    }
}

Referenced by START_TEST(), and Test_IoGetDeviceInterfaces().

Test_IoGetDeviceInterfaces()

static VOID Test_IoGetDeviceInterfaces ( _In_ const GUID *  Guid )

static

Definition at line 158 of file IoDeviceInterface.c.

{
    NTSTATUS Status;
    PZZWSTR SymbolicLinkList;
    PWSTR SymbolicLink;
    UNICODE_STRING GuidString;
 
    Status = IoGetDeviceInterfaces(Guid, NULL, DEVICE_INTERFACE_INCLUDE_NONACTIVE, &SymbolicLinkList);
 
    RtlStringFromGUID(Guid, &GuidString);
    if (skip(NT_SUCCESS(Status), "IoGetDeviceInterfaces failed with status 0x%x for '%wZ'\n", Status, &GuidString))
    {
        RtlFreeUnicodeString(&GuidString);
        return;
    }
 
    trace("IoGetDeviceInterfaces '%wZ' results:\n", &GuidString);
    RtlFreeUnicodeString(&GuidString);
 
    for (SymbolicLink = SymbolicLinkList;
         SymbolicLink[0] != UNICODE_NULL;
         SymbolicLink += wcslen(SymbolicLink) + 1)
    {
        trace("Symbolic Link: %S\n", SymbolicLink);
        Test_IoGetDeviceInterfaceAlias(SymbolicLink);
        Test_IoOpenDeviceInterfaceRegistryKey(SymbolicLink);
        Test_IoSetDeviceInterfaceState(SymbolicLink);
    }
 
    ExFreePool(SymbolicLinkList);
}

Referenced by START_TEST().

Test_IoOpenDeviceInterfaceRegistryKey()

static VOID Test_IoOpenDeviceInterfaceRegistryKey ( _In_opt_ PCWSTR  SymbolicLink )

static

Definition at line 58 of file IoDeviceInterface.c.

{
    UNICODE_STRING KeyName, SymbolicLinkName;
    HANDLE DeviceInterfaceKey;
    NTSTATUS Status;
    size_t n;
 
    RtlInitUnicodeString(&SymbolicLinkName, SymbolicLink);
    RtlInitUnicodeString(&KeyName, L"ReactOS_kmtest");
 
    /* It's okay to call this from a user process's thread */
    Status = IoOpenDeviceInterfaceRegistryKey(&SymbolicLinkName, KEY_CREATE_SUB_KEY, &DeviceInterfaceKey);
 
    if (skip(NT_SUCCESS(Status), "IoOpenDeviceInterfaceRegistryKey() failed: 0x%lx\n", Status))
        return;
 
    trace("IoOpenDeviceInterfaceRegistryKey() success: 0x%p\n", DeviceInterfaceKey);
 
    for (n = 0; n < RTL_NUMBER_OF(Types); ++n)
    {
        HANDLE DeviceInterfaceSubKey;
        OBJECT_ATTRIBUTES ObjectAttributes;
 
        /* Try to create the non-volatile subkey to check whether the parent key is volatile */
        InitializeObjectAttributes(&ObjectAttributes,
                                   &KeyName,
                                   OBJ_CASE_INSENSITIVE | OBJ_KERNEL_HANDLE,
                                   DeviceInterfaceKey,
                                   NULL);
        Status = ZwCreateKey(&DeviceInterfaceSubKey,
                             KEY_WRITE,
                             &ObjectAttributes,
                             0,
                             NULL,
                             REG_OPTION_NON_VOLATILE,
                             NULL);
 
        if (skip(NT_SUCCESS(Status), "ZwCreateKey() failed to create a subkey: %d 0x%lx\n", n, Status))
            continue;
 
        trace("ZwCreateKey(): successfully created subkey: %d 0x%p\n", n, DeviceInterfaceSubKey);
 
        ZwDeleteKey(DeviceInterfaceSubKey);
        ZwClose(DeviceInterfaceSubKey);
    }
 
    ZwClose(DeviceInterfaceKey);
}

Referenced by START_TEST(), Test_IoGetDeviceInterfaceAlias(), and Test_IoGetDeviceInterfaces().

Test_IoRegisterPlugPlayNotification()

static VOID Test_IoRegisterPlugPlayNotification ( VOID  )

static

Definition at line 230 of file IoDeviceInterface.c.

{
    NTSTATUS Status;
    PVOID NotificationEntry;
 
    Status = IoRegisterPlugPlayNotification(EventCategoryDeviceInterfaceChange,
                                            PNPNOTIFY_DEVICE_INTERFACE_INCLUDE_EXISTING_INTERFACES,
                                            (PVOID)&GUID_DEVICE_SYS_BUTTON,
                                            KmtDriverObject,
                                            NotificationCallback,
                                            &NotificationContext,
                                            &NotificationEntry);
    ok_eq_hex(Status, STATUS_SUCCESS);
    if (!skip(NT_SUCCESS(Status), "PlugPlayNotification not registered\n"))
    {
        Status = IoUnregisterPlugPlayNotification(NotificationEntry);
        ok_eq_hex(Status, STATUS_SUCCESS);
    }
}

Referenced by START_TEST().

Test_IoSetDeviceInterfaceState()

static VOID Test_IoSetDeviceInterfaceState ( _In_opt_ PCWSTR  SymbolicLink )

static

Definition at line 137 of file IoDeviceInterface.c.

{
    UNICODE_STRING SymbolicLinkName;
    size_t n;
 
    RtlInitUnicodeString(&SymbolicLinkName, SymbolicLink);
 
    for (n = 0; n < RTL_NUMBER_OF(Types); ++n)
    {
        NTSTATUS Status = IoSetDeviceInterfaceState(&SymbolicLinkName, TRUE);
 
        if (skip(NT_SUCCESS(Status), "IoSetDeviceInterfaceState(): failed to enable interface: %d 0x%x\n", n, Status))
            continue;
 
        trace("IoSetDeviceInterfaceState(): successfully enabled interface: %d %wZ\n", n, &SymbolicLinkName);
    }
}

Referenced by START_TEST(), and Test_IoGetDeviceInterfaces().

Variable Documentation

GUID_NULL

const GUID GUID_NULL = {0x00000000L, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}

static

Definition at line 24 of file IoDeviceInterface.c.

KSCATEGORY_BRIDGE

const GUID KSCATEGORY_BRIDGE = {0x085AFF00L, 0x62CE, 0x11CF, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}

static

Definition at line 26 of file IoDeviceInterface.c.

KSCATEGORY_CAPTURE

const GUID KSCATEGORY_CAPTURE = {0x65E8773DL, 0x8F56, 0x11D0, {0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}

static

Definition at line 27 of file IoDeviceInterface.c.

KSCATEGORY_COMMUNICATIONSTRANSFORM

const GUID KSCATEGORY_COMMUNICATIONSTRANSFORM = {0xCF1DDA2CL, 0x9743, 0x11D0, {0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}

static

Definition at line 28 of file IoDeviceInterface.c.

KSCATEGORY_DATACOMPRESSOR

const GUID KSCATEGORY_DATACOMPRESSOR = {0x1E84C900L, 0x7E70, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}

static

Definition at line 29 of file IoDeviceInterface.c.

KSCATEGORY_DATADECOMPRESSOR

const GUID KSCATEGORY_DATADECOMPRESSOR = {0x2721AE20L, 0x7E70, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}

static

Definition at line 30 of file IoDeviceInterface.c.

KSCATEGORY_DATATRANSFORM

const GUID KSCATEGORY_DATATRANSFORM = {0x2EB07EA0L, 0x7E70, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}

static

Definition at line 31 of file IoDeviceInterface.c.

KSCATEGORY_FILESYSTEM

const GUID KSCATEGORY_FILESYSTEM = {0x760FED5EL, 0x9357, 0x11D0, {0xA3, 0xCC, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}

static

Definition at line 32 of file IoDeviceInterface.c.

KSCATEGORY_INTERFACETRANSFORM

const GUID KSCATEGORY_INTERFACETRANSFORM = {0xCF1DDA2DL, 0x9743, 0x11D0, {0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}

static

Definition at line 33 of file IoDeviceInterface.c.

KSCATEGORY_MEDIUMTRANSFORM

const GUID KSCATEGORY_MEDIUMTRANSFORM = {0xCF1DDA2EL, 0x9743, 0x11D0, {0xA3, 0xEE, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}

static

Definition at line 34 of file IoDeviceInterface.c.

KSCATEGORY_MIXER

const GUID KSCATEGORY_MIXER = {0xAD809C00L, 0x7B88, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}

static

Definition at line 35 of file IoDeviceInterface.c.

KSCATEGORY_RENDER

const GUID KSCATEGORY_RENDER = {0x65E8773EL, 0x8F56, 0x11D0, {0xA3, 0xB9, 0x00, 0xA0, 0xC9, 0x22, 0x31, 0x96}}

static

Definition at line 36 of file IoDeviceInterface.c.

KSCATEGORY_SPLITTER

const GUID KSCATEGORY_SPLITTER = {0x0A4252A0L, 0x7E70, 0x11D0, {0xA5, 0xD6, 0x28, 0xDB, 0x04, 0xC1, 0x00, 0x00}}

static

Definition at line 37 of file IoDeviceInterface.c.

NotificationCallback

DRIVER_NOTIFICATION_CALLBACK_ROUTINE NotificationCallback

static

Definition at line 193 of file IoDeviceInterface.c.

Referenced by Test_IoRegisterPlugPlayNotification().

NotificationContext

UCHAR NotificationContext

static

Definition at line 191 of file IoDeviceInterface.c.

Referenced by NotificationCallback(), and Test_IoRegisterPlugPlayNotification().

Types

const GUID* Types[]

static

Initial value:

=
{
    &GUID_NULL,
    &KSCATEGORY_BRIDGE,
    &KSCATEGORY_CAPTURE,
    &KSCATEGORY_COMMUNICATIONSTRANSFORM,
    &KSCATEGORY_DATACOMPRESSOR,
    &KSCATEGORY_DATADECOMPRESSOR,
    &KSCATEGORY_DATATRANSFORM,
    &KSCATEGORY_FILESYSTEM,
    &KSCATEGORY_INTERFACETRANSFORM,
    &KSCATEGORY_MEDIUMTRANSFORM,
    &KSCATEGORY_MIXER,
    &KSCATEGORY_RENDER,
    &KSCATEGORY_SPLITTER,
}

Definition at line 39 of file IoDeviceInterface.c.

Referenced by START_TEST(), Test_IoGetDeviceInterfaceAlias(), Test_IoOpenDeviceInterfaceRegistryKey(), and Test_IoSetDeviceInterfaceState().