[reactos] 01/04: [NTOS:IO] change DEVICE_ACTION values and rename functions

[Victor Perevertkin]

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=2ed132e90e5390ff1935a…
commit 2ed132e90e5390ff1935a7e2c1019ec231de03bb
Author:     Victor Perevertkin <victor.perevertkin(a)reactos.org>
AuthorDate: Wed Jun 24 04:49:18 2020 +0300
Commit:     Victor Perevertkin <victor.perevertkin(a)reactos.org>
CommitDate: Fri Aug 21 07:48:56 2020 +0300
    [NTOS:IO] change DEVICE_ACTION values and rename functions
---
 ntoskrnl/include/internal/io.h |  28 ++++-------
 ntoskrnl/io/pnpmgr/devaction.c | 102 ++++++++++++++++++++++++++++-------------
 ntoskrnl/io/pnpmgr/pnpmgr.c    |  17 ++++---
 3 files changed, 89 insertions(+), 58 deletions(-)
diff --git a/ntoskrnl/include/internal/io.h b/ntoskrnl/include/internal/io.h
index 3f801a0f647..2d3c53fec24 100644
--- a/ntoskrnl/include/internal/io.h
+++ b/ntoskrnl/include/internal/io.h
@@ -539,28 +539,14 @@ typedef enum _SECURITY_DESCRIPTOR_TYPE
 } SECURITY_DESCRIPTOR_TYPE, *PSECURITY_DESCRIPTOR_TYPE;
 //
-// Action types and data for IopQueueDeviceAction()
+// Action types and data for PiQueueDeviceAction()
 //
 typedef enum _DEVICE_ACTION
 {
-    DeviceActionInvalidateDeviceRelations,
-    MaxDeviceAction
+    PiActionEnumDeviceTree,
+    PiActionEnumRootDevices
 } DEVICE_ACTION;
-typedef struct _DEVICE_ACTION_DATA
-{
-    LIST_ENTRY RequestListEntry;
-    PDEVICE_OBJECT DeviceObject;
-    DEVICE_ACTION Action;
-    union
-    {
-        struct
-        {
-            DEVICE_RELATION_TYPE Type;
-        } InvalidateDeviceRelations;
-    };
-} DEVICE_ACTION_DATA, *PDEVICE_ACTION_DATA;
-
 //
 // Resource code
 //
@@ -1432,9 +1418,11 @@ IopStoreSystemPartitionInformation(IN PUNICODE_STRING
NtSystemPartitionDeviceNam
 // Device action
 //
 VOID
-IopQueueDeviceAction(
-    _In_ PDEVICE_ACTION_DATA ActionData
-);
+PiQueueDeviceAction(
+    _In_ PDEVICE_OBJECT DeviceObject,
+    _In_ DEVICE_ACTION Action,
+    _In_opt_ PKEVENT CompletionEvent,
+    _Out_opt_ NTSTATUS *CompletionStatus);
 //
 // Global I/O Data
diff --git a/ntoskrnl/io/pnpmgr/devaction.c b/ntoskrnl/io/pnpmgr/devaction.c
index 16877098994..75390c47cbd 100644
--- a/ntoskrnl/io/pnpmgr/devaction.c
+++ b/ntoskrnl/io/pnpmgr/devaction.c
@@ -30,6 +30,17 @@ WORK_QUEUE_ITEM IopDeviceActionWorkItem;
 BOOLEAN IopDeviceActionInProgress;
 KSPIN_LOCK IopDeviceActionLock;
+/* TYPES *********************************************************************/
+
+typedef struct _DEVICE_ACTION_REQUEST
+{
+    LIST_ENTRY RequestListEntry;
+    PDEVICE_OBJECT DeviceObject;
+    PKEVENT CompletionEvent;
+    NTSTATUS *CompletionStatus;
+    DEVICE_ACTION Action;
+} DEVICE_ACTION_REQUEST, *PDEVICE_ACTION_REQUEST;
+
 /* FUNCTIONS *****************************************************************/
 PDEVICE_OBJECT
@@ -2298,14 +2309,32 @@ cleanup:
                               &DeviceNode->InstancePath);
 }
+#ifdef DBG
+static
+PCSTR
+ActionToStr(
+    _In_ DEVICE_ACTION Action)
+{
+    switch (Action)
+    {
+        case PiActionEnumDeviceTree:
+            return "PiActionEnumDeviceTree";
+        case PiActionEnumRootDevices:
+            return "PiActionEnumRootDevices";
+        default:
+            return "(request unknown)";
+    }
+}
+#endif
+
 static
 VOID
 NTAPI
-IopDeviceActionWorker(
-    _In_ PVOID Context)
+PipDeviceActionWorker(
+    _In_opt_ PVOID Context)
 {
     PLIST_ENTRY ListEntry;
-    PDEVICE_ACTION_DATA Data;
+    PDEVICE_ACTION_REQUEST Request;
     KIRQL OldIrql;
     KeAcquireSpinLock(&IopDeviceActionLock, &OldIrql);
@@ -2313,52 +2342,66 @@ IopDeviceActionWorker(
     {
         ListEntry = RemoveHeadList(&IopDeviceActionRequestList);
         KeReleaseSpinLock(&IopDeviceActionLock, OldIrql);
-        Data = CONTAINING_RECORD(ListEntry,
-                                 DEVICE_ACTION_DATA,
-                                 RequestListEntry);
+        Request = CONTAINING_RECORD(ListEntry, DEVICE_ACTION_REQUEST, RequestListEntry);
-        switch (Data->Action)
+        switch (Request->Action)
         {
-            case DeviceActionInvalidateDeviceRelations:
-                IoSynchronousInvalidateDeviceRelations(Data->DeviceObject,
-
Data->InvalidateDeviceRelations.Type);
+            case PiActionEnumDeviceTree:
+                // this will be reworked in next commits
+                IoSynchronousInvalidateDeviceRelations(Request->DeviceObject,
BusRelations);
                 break;
             default:
-                DPRINT1("Unimplemented device action %u\n", Data->Action);
+                DPRINT1("Unimplemented device action %u\n",
Request->Action);
                 break;
         }
-        ObDereferenceObject(Data->DeviceObject);
-        ExFreePoolWithTag(Data, TAG_IO);
+        ObDereferenceObject(Request->DeviceObject);
+        ExFreePoolWithTag(Request, TAG_IO);
         KeAcquireSpinLock(&IopDeviceActionLock, &OldIrql);
     }
     IopDeviceActionInProgress = FALSE;
     KeReleaseSpinLock(&IopDeviceActionLock, OldIrql);
 }
+/**
+ * @brief      Queue a device operation to a worker thread.
+ *
+ * @param[in]  DeviceObject      The device object
+ * @param[in]  Action            The action
+ * @param[in]  CompletionEvent   The completion event object (optional)
+ * @param[out] CompletionStatus  Status returned be the action will be written here
+ */
+
 VOID
-IopQueueDeviceAction(
-    _In_ PDEVICE_ACTION_DATA ActionData)
+PiQueueDeviceAction(
+    _In_ PDEVICE_OBJECT DeviceObject,
+    _In_ DEVICE_ACTION Action,
+    _In_opt_ PKEVENT CompletionEvent,
+    _Out_opt_ NTSTATUS *CompletionStatus)
 {
-    PDEVICE_ACTION_DATA Data;
+    PDEVICE_ACTION_REQUEST Request;
     KIRQL OldIrql;
-    DPRINT("IopQueueDeviceAction(%p)\n", ActionData);
-
-    Data = ExAllocatePoolWithTag(NonPagedPool,
-                                 sizeof(DEVICE_ACTION_DATA),
-                                 TAG_IO);
-    if (!Data)
+    Request = ExAllocatePoolWithTag(NonPagedPool, sizeof(*Request), TAG_IO);
+    if (!Request)
+    {
+        KeBugCheckEx(PNP_DETECTED_FATAL_ERROR, 0x3, 0, 0, 0);
         return;
+    }
-    ObReferenceObject(ActionData->DeviceObject);
-    RtlCopyMemory(Data, ActionData, sizeof(DEVICE_ACTION_DATA));
+    DPRINT("PiQueueDeviceAction: DeviceObject - %p, Request - %p, Action -
%s\n",
+        DeviceObject, Request, ActionToStr(Action));
-    DPRINT("Action %u\n", Data->Action);
+    ObReferenceObject(DeviceObject);
+
+    Request->DeviceObject = DeviceObject;
+    Request->Action = Action;
+    Request->CompletionEvent = CompletionEvent;
+    Request->CompletionStatus = CompletionStatus;
     KeAcquireSpinLock(&IopDeviceActionLock, &OldIrql);
-    InsertTailList(&IopDeviceActionRequestList, &Data->RequestListEntry);
+    InsertTailList(&IopDeviceActionRequestList, &Request->RequestListEntry);
     if (IopDeviceActionInProgress)
     {
         KeReleaseSpinLock(&IopDeviceActionLock, OldIrql);
@@ -2367,9 +2410,6 @@ IopQueueDeviceAction(
     IopDeviceActionInProgress = TRUE;
     KeReleaseSpinLock(&IopDeviceActionLock, OldIrql);
-    ExInitializeWorkItem(&IopDeviceActionWorkItem,
-                         IopDeviceActionWorker,
-                         NULL);
-    ExQueueWorkItem(&IopDeviceActionWorkItem,
-                    DelayedWorkQueue);
+    ExInitializeWorkItem(&IopDeviceActionWorkItem, PipDeviceActionWorker, NULL);
+    ExQueueWorkItem(&IopDeviceActionWorkItem, DelayedWorkQueue);
 }
diff --git a/ntoskrnl/io/pnpmgr/pnpmgr.c b/ntoskrnl/io/pnpmgr/pnpmgr.c
index 8b9c92ca466..443c3ab7b35 100644
--- a/ntoskrnl/io/pnpmgr/pnpmgr.c
+++ b/ntoskrnl/io/pnpmgr/pnpmgr.c
@@ -2474,13 +2474,16 @@ IoInvalidateDeviceRelations(
     IN PDEVICE_OBJECT DeviceObject,
     IN DEVICE_RELATION_TYPE Type)
 {
-    DEVICE_ACTION_DATA ActionData;
-
-    ActionData.DeviceObject = DeviceObject;
-    ActionData.Action = DeviceActionInvalidateDeviceRelations;
-    ActionData.InvalidateDeviceRelations.Type = Type;
-
-    IopQueueDeviceAction(&ActionData);
+    switch (Type)
+    {
+        case BusRelations:
+            /* Enumerate the device */
+            PiQueueDeviceAction(DeviceObject, PiActionEnumDeviceTree, NULL, NULL);
+            break;
+        default:
+            /* Everything else is not implemented */
+            break;
+    }
 }
 /*