[reactos] 01/01: [NTOS:IO] Fix some bugs in the IoQueryDeviceDescription helpers (#5320)

[Hermès Bélusca-Maïto]

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=84b4a80bebd1feaad2c27…
commit 84b4a80bebd1feaad2c276883cf25aa033c65baa
Author:     Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org>
AuthorDate: Sat May 27 22:55:40 2023 +0200
Commit:     Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org>
CommitDate: Wed Jun 14 11:20:56 2023 +0200
    [NTOS:IO] Fix some bugs in the IoQueryDeviceDescription helpers (#5320)
    - Add missing ExAllocatePool NULL checks.
    - Fix order of KeBugCheckEx parameters for PNP_DETECTED_FATAL_ERROR.
    - The Controller and Peripheral numbers are zero-based, so if the caller
      wants to inspect controller (or peripheral) zero, let it be so!
      The original code was treating controller number zero for enumerating
      controllers of a given class within the different buses, which is
      wrong. See the diff'ed trace below.
      Tested with Windows' videoprt.sys VideoPortGetDeviceData().
    ```diff
     IoQueryDeviceDescription()
         BusType:          0xB093C224 (0)
         BusNumber:        0xB093C228 (0)
         ControllerType:   0xF9D01030 (19)
         ControllerNumber: 0xF9D01038 (0)
         PeripheralType:   0x00000000 (4294967295)
         PeripheralNumber: 0x00000000 (4294967295)
         CalloutRoutine:   0xF9CF74E4
         Context:          0xF9D5A340
     --> Query: 0xF9D5A22C
     IopQueryBusDescription(Query: 0xF9D5A22C)
         RootKey: '\REGISTRY\MACHINE\HARDWARE\DESCRIPTION\SYSTEM'
         RootKeyHandle: 0x00000598
         KeyIsRoot: TRUE
         Bus: 0xF9D5A290 (4294967295)
         Seen: 'CentralProcessor'
         Seen: 'FloatingPointProcessor'
         Seen: 'MultifunctionAdapter'
         SubRootRegName:
'\REGISTRY\MACHINE\HARDWARE\DESCRIPTION\SYSTEM\MultifunctionAdapter'
     IopQueryBusDescription(Query: 0xF9D5A22C)
         RootKey:
'\REGISTRY\MACHINE\HARDWARE\DESCRIPTION\SYSTEM\MultifunctionAdapter'
         RootKeyHandle: 0x00000590
         KeyIsRoot: FALSE
         Bus: 0xF9D5A290 (4294967295)
         Seen: '0'
         SubRootRegName:
'\REGISTRY\MACHINE\HARDWARE\DESCRIPTION\SYSTEM\MultifunctionAdapter\0'
         Getting bus value: 'Identifier'
         Getting bus value: 'Configuration Data'
         Getting bus value: 'Component Information'
         --> Getting device on Bus #0 :
'\REGISTRY\MACHINE\HARDWARE\DESCRIPTION\SYSTEM\MultifunctionAdapter\0'
     IopQueryDeviceDescription(Query: 0xF9D5A22C)
         RootKey:
'\REGISTRY\MACHINE\HARDWARE\DESCRIPTION\SYSTEM\MultifunctionAdapter\0'
         RootKeyHandle: 0x00000590
         Bus: 0
    -    Enumerating controllers in
'\REGISTRY\MACHINE\HARDWARE\DESCRIPTION\SYSTEM\MultifunctionAdapter\0\DisplayController'...
    +    Getting controller #0
    +    Retrieving controller
'\REGISTRY\MACHINE\HARDWARE\DESCRIPTION\SYSTEM\MultifunctionAdapter\0\DisplayController\0'
    ```
---
 ntoskrnl/io/iomgr/iorsrce.c | 73 +++++++++++++++++++++++++++++++++------------
 1 file changed, 54 insertions(+), 19 deletions(-)
diff --git a/ntoskrnl/io/iomgr/iorsrce.c b/ntoskrnl/io/iomgr/iorsrce.c
index 01f2b104a84..af20b2960d6 100644
--- a/ntoskrnl/io/iomgr/iorsrce.c
+++ b/ntoskrnl/io/iomgr/iorsrce.c
@@ -170,18 +170,16 @@ IopQueryDeviceDescription(
                 Bus);
     /* Temporary string */
-    TempString.MaximumLength = sizeof(TempBuffer);
-    TempString.Length = 0;
-    TempString.Buffer = TempBuffer;
+    RtlInitEmptyUnicodeString(&TempString, TempBuffer, sizeof(TempBuffer));
     /* Append controller name to string */
     RtlAppendUnicodeToString(&ControllerRootRegName, L"\\");
     RtlAppendUnicodeToString(&ControllerRootRegName,
ArcTypes[*Query->ControllerType]);
     /* Set the controller number if specified */
-    if (Query->ControllerNumber && *(Query->ControllerNumber))
+    if (Query->ControllerNumber)
     {
-        ControllerNumber = *Query->ControllerNumber;
+        ControllerNumber = *(Query->ControllerNumber);
         MaximumControllerNumber = ControllerNumber + 1;
         IORSRCTRACE("    Getting controller #%lu\n", ControllerNumber);
     }
@@ -208,6 +206,11 @@ IopQueryDeviceDescription(
             /* Allocate it */
             ControllerFullInformation = ExAllocatePoolWithTag(PagedPool,
LenFullInformation, TAG_IO_RESOURCE);
+            if (!ControllerFullInformation)
+            {
+                ZwClose(ControllerKeyHandle);
+                return STATUS_INSUFFICIENT_RESOURCES;
+            }
             /* Get the information */
             Status = ZwQueryKey(ControllerKeyHandle,
@@ -222,7 +225,7 @@ IopQueryDeviceDescription(
         /* No controller was found, bail out */
         if (!NT_SUCCESS(Status))
         {
-            if (ControllerFullInformation != NULL)
+            if (ControllerFullInformation)
                 ExFreePoolWithTag(ControllerFullInformation, TAG_IO_RESOURCE);
             return Status;
         }
@@ -286,11 +289,17 @@ IopQueryDeviceDescription(
                     (Status != STATUS_BUFFER_TOO_SMALL) &&
                     (Status != STATUS_BUFFER_OVERFLOW))
                 {
+                    ControllerInformation[ControllerLoop] = NULL;
                     continue;
                 }
                 /* Allocate it */
                 ControllerInformation[ControllerLoop] = ExAllocatePoolWithTag(PagedPool,
LenKeyFullInformation, TAG_IO_RESOURCE);
+                if (!ControllerInformation[ControllerLoop])
+                {
+                    Status = STATUS_INSUFFICIENT_RESOURCES;
+                    break;
+                }
                 /* Get the information */
                 Status = ZwQueryValueKey(ControllerKeyHandle,
@@ -339,9 +348,9 @@ IopQueryDeviceDescription(
             goto EndLoop;
         /* Set the peripheral number if specified */
-        if (Query->PeripheralNumber && *Query->PeripheralNumber)
+        if (Query->PeripheralNumber)
         {
-            PeripheralNumber = *Query->PeripheralNumber;
+            PeripheralNumber = *(Query->PeripheralNumber);
             MaximumPeripheralNumber = PeripheralNumber + 1;
             IORSRCTRACE("    Getting peripheral #%lu\n", PeripheralNumber);
         }
@@ -368,6 +377,12 @@ IopQueryDeviceDescription(
                 /* Allocate it */
                 PeripheralFullInformation = ExAllocatePoolWithTag(PagedPool,
LenFullInformation, TAG_IO_RESOURCE);
+                if (!PeripheralFullInformation)
+                {
+                    ZwClose(PeripheralKeyHandle);
+                    Status = STATUS_INSUFFICIENT_RESOURCES;
+                    goto EndLoop;
+                }
                 /* Get the information */
                 Status = ZwQueryKey(PeripheralKeyHandle,
@@ -450,6 +465,11 @@ IopQueryDeviceDescription(
                     /* Allocate it */
                     PeripheralInformation[PeripheralLoop] =
ExAllocatePoolWithTag(PagedPool, LenKeyFullInformation, TAG_IO_RESOURCE);
+                    if (!PeripheralInformation[PeripheralLoop])
+                    {
+                        Status = STATUS_INSUFFICIENT_RESOURCES;
+                        break;
+                    }
                     /* Get the information */
                     Status = ZwQueryValueKey(PeripheralKeyHandle,
@@ -591,9 +611,8 @@ IopQueryBusDescription(
     /* Allocate it */
     FullInformation = ExAllocatePoolWithTag(PagedPool, LenFullInformation,
TAG_IO_RESOURCE);
-
     if (!FullInformation)
-        return STATUS_NO_MEMORY;
+        return STATUS_INSUFFICIENT_RESOURCES;
     /* Get the information */
     Status = ZwQueryKey(RootKeyHandle,
@@ -608,6 +627,11 @@ IopQueryBusDescription(
         /* Allocate it */
         BasicInformation = ExAllocatePoolWithTag(PagedPool, LenBasicInformation,
TAG_IO_RESOURCE);
+        if (!BasicInformation)
+        {
+            ExFreePoolWithTag(FullInformation, TAG_IO_RESOURCE);
+            return STATUS_INSUFFICIENT_RESOURCES;
+        }
     }
     /* Deallocate the old buffer */
@@ -691,6 +715,11 @@ IopQueryBusDescription(
                 /* Allocate it */
                 BusInformation[SubBusLoop] = ExAllocatePoolWithTag(PagedPool,
LenKeyFullInformation, TAG_IO_RESOURCE);
+                if (!BusInformation[SubBusLoop])
+                {
+                    Status = STATUS_INSUFFICIENT_RESOURCES;
+                    break;
+                }
                 /* Get the information */
                 Status = ZwQueryValueKey(SubRootKeyHandle,
@@ -774,7 +803,8 @@ IopQueryBusDescription(
         Status = IopQueryBusDescription(Query, SubRootRegName, SubRootKeyHandle, Bus,
!KeyIsRoot);
         /* Everything enumerated */
-        if (Status == STATUS_NO_MORE_ENTRIES) Status = STATUS_SUCCESS;
+        if (Status == STATUS_NO_MORE_ENTRIES)
+            Status = STATUS_SUCCESS;
         ZwClose(SubRootKeyHandle);
         SubRootKeyHandle = NULL;
@@ -860,11 +890,10 @@ IopStoreSystemPartitionInformation(
         return;
     }
-    /* Prepare the string that will receive where symbolic link points to */
-    LinkTarget.Length = 0;
-    /* We will zero the end of the string after having received it */
-    LinkTarget.MaximumLength = sizeof(LinkTargetBuffer) - sizeof(UNICODE_NULL);
-    LinkTarget.Buffer = LinkTargetBuffer;
+    /* Prepare the string that will receive where symbolic link points to.
+     * We will zero the end of the string after having received it */
+    RtlInitEmptyUnicodeString(&LinkTarget, LinkTargetBuffer,
+                              sizeof(LinkTargetBuffer) - sizeof(UNICODE_NULL));
     /* Query target */
     Status = ZwQuerySymbolicLinkObject(LinkHandle, &LinkTarget, NULL);
@@ -1124,10 +1153,10 @@ IoAssignResources(
         {
             /* New drivers should not call this API */
             KeBugCheckEx(PNP_DETECTED_FATAL_ERROR,
-                         0,
-                         0,
+                         0x2,
                          (ULONG_PTR)DeviceObject,
-                         (ULONG_PTR)DriverObject);
+                         (ULONG_PTR)DriverObject,
+                         0);
         }
     }
@@ -1217,10 +1246,16 @@ IoQueryDeviceDescription(
                 CalloutRoutine, Context,
                 &Query);
+    if (!BusType)
+        return STATUS_NOT_IMPLEMENTED;
+
     /* Set up the string */
     RootRegKey.Length = 0;
     RootRegKey.MaximumLength = 2048;
     RootRegKey.Buffer = ExAllocatePoolWithTag(PagedPool, RootRegKey.MaximumLength,
TAG_IO_RESOURCE);
+    if (!RootRegKey.Buffer)
+        return STATUS_INSUFFICIENT_RESOURCES;
+
     RtlAppendUnicodeToString(&RootRegKey,
L"\\REGISTRY\\MACHINE\\HARDWARE\\DESCRIPTION\\SYSTEM");
     /* Open a handle to the Root Registry Key */