sys: introduce private NTSTATUS codes FSP_STATUS_POST_IOQ* and ensure that Irp is not touched after STATUS_PENDING

src/sys/cleanup.c

@@ -73,17 +73,14 @@ static NTSTATUS FspFsvolCleanup(
     Request->Req.Cleanup.UserContext2 = UserContext2;
     Request->Req.Cleanup.Delete = DeletePending;
 
+    return FSP_STATUS_IOQ_POST_BEST_EFFORT;
+
     /*
      * Note that it is still possible for this request to not be delivered,
      * if the volume device Ioq is stopped. But such failures are benign
      * from our perspective, because they mean that the file system is going
      * away and should correctly tear things down.
      */
-
-    if (FspIoqPostIrpBestEffort(FsvolDeviceExtension->Ioq, Irp, 0))
-        return STATUS_PENDING;
-    else
-        return STATUS_SUCCESS;
 }
 
 VOID FspFsvolCleanupComplete(

src/sys/create.c

@@ -312,7 +312,7 @@ static NTSTATUS FspFsvolCreate(
         RtlCopyMemory(Request->Buffer + Request->Req.Create.SecurityDescriptor.Offset,
             SecurityDescriptor, SecurityDescriptorSize);
 
-    return STATUS_PENDING;
+    return FSP_STATUS_IOQ_POST;
 }
 
 NTSTATUS FspFsvolCreatePrepare(
@@ -380,8 +380,7 @@ NTSTATUS FspFsvolCreatePrepare(
             /* repost the IRP to retry later */
             FSP_FSVOL_DEVICE_EXTENSION *FsvolDeviceExtension =
                 FspFsvolDeviceExtension(IrpSp->DeviceObject);
-            if (FspIoqPostIrpBestEffort(FsvolDeviceExtension->Ioq, Irp, &Result))
+            FspIoqPostIrpBestEffort(FsvolDeviceExtension->Ioq, Irp, &Result);
-                Result = STATUS_PENDING;
             return Result;
         }
 
@@ -593,8 +592,7 @@ VOID FspFsvolCreateComplete(
              * Note that it is still possible for this request to not be delivered,
              * if the volume device Ioq is stopped or if the IRP is canceled.
              */
-            if (FspIoqPostIrpBestEffort(FsvolDeviceExtension->Ioq, Irp, &Result))
+            FspIoqPostIrpBestEffort(FsvolDeviceExtension->Ioq, Irp, &Result);
-                Result = STATUS_PENDING;
         }
         else
         {

src/sys/debug.c

@@ -16,6 +16,10 @@ const char *NtStatusSym(NTSTATUS Status)
     {
     // cygwin: sed -n '/_WAIT_0/!s/^#define[ \t]*\(STATUS_[^ \t]*\).*NTSTATUS.*$/SYM(\1)/p'
     #include "ntstatus.i"
+    case FSP_STATUS_IOQ_POST:
+        return "FSP_STATUS_IOQ_POST";
+    case FSP_STATUS_IOQ_POST_BEST_EFFORT:
+        return "FSP_STATUS_IOQ_POST_BEST_EFFORT";
     default:
         return "NTSTATUS:Unknown";
     }

src/sys/driver.h

@@ -25,6 +25,11 @@
 #define FSP_FSVRT_DEVICE_SDDL           "D:P(A;;GA;;;SY)(A;;GA;;;BA)(A;;GR;;;WD)"
     /* System:GENERIC_ALL, Administrators:GENERIC_ALL, World:GENERIC_READ */
 
+/* private NTSTATUS codes */
+#define FSP_STATUS_PRIVATE_BIT          (0x20000000)
+#define FSP_STATUS_IOQ_POST             (FSP_STATUS_PRIVATE_BIT | 0x0000)
+#define FSP_STATUS_IOQ_POST_BEST_EFFORT (FSP_STATUS_PRIVATE_BIT | 0x0001)
+
 /* misc macros */
 #define FSP_ALLOC_INTERNAL_TAG          'IpsF'
 #define FSP_ALLOC_EXTERNAL_TAG          'XpsF'
@@ -111,6 +116,10 @@ extern __declspec(selectany) int fsp_bp = 1;
     } while (0,0)
 #define FSP_LEAVE_MJ(fmt, ...)          \
     FSP_LEAVE_(                         \
+        if (STATUS_PENDING != Result)   \
+        {                               \
+            ASSERT(0 == (FSP_STATUS_PRIVATE_BIT & Result) ||\
+                FSP_STATUS_IOQ_POST == Result || FSP_STATUS_IOQ_POST_BEST_EFFORT == Result);\
             FSP_DEBUGLOG_("%p, %s%c, %s%s, " fmt, " = %s[%lld]",\
                 Irp,                    \
                 (const char *)&FspDeviceExtension(IrpSp->DeviceObject)->Kind,\
@@ -120,19 +129,20 @@ extern __declspec(selectany) int fsp_bp = 1;
                 __VA_ARGS__,            \
                 NtStatusSym(Result),    \
                 (LONGLONG)Irp->IoStatus.Information);\
-        if (STATUS_PENDING == Result)   \
+            if (FSP_STATUS_PRIVATE_BIT & Result)\
             {                           \
-            if (0 == (IrpSp->Control & SL_PENDING_RETURNED))\
-            {                           \
-                /* if the IRP has not been marked pending already */\
                 FSP_FSVOL_DEVICE_EXTENSION *fsp_leave_FsvolDeviceExtension =\
                     FspFsvolDeviceExtension(DeviceObject);\
-                if (!FspIoqPostIrp(fsp_leave_FsvolDeviceExtension->Ioq, Irp, &Result))\
+                if (!FspIoqPostIrpEx(fsp_leave_FsvolDeviceExtension->Ioq, Irp,\
+                    FSP_STATUS_IOQ_POST_BEST_EFFORT == Result, &Result))\
+                {\
+                    DEBUGLOG("FspIoqPostIrpEx = %s", NtStatusSym(Result));\
                     FspIopCompleteIrp(Irp, Result);\
-            }                           \
+                }\
             }                           \
             else                        \
                 FspIopCompleteIrpEx(Irp, Result, fsp_device_release);\
+        }                               \
     );                                  \
     return Result
 #define FSP_ENTER_IOC(...)              \
@@ -141,6 +151,9 @@ extern __declspec(selectany) int fsp_bp = 1;
     FSP_ENTER_NOCRIT_(__VA_ARGS__)
 #define FSP_LEAVE_IOC(fmt, ...)         \
     FSP_LEAVE_NOCRIT_(                  \
+        if (STATUS_PENDING != Result)   \
+        {                               \
+            ASSERT(0 == (FSP_STATUS_PRIVATE_BIT & Result));\
             FSP_DEBUGLOG_NOCRIT_("%p, %s%c, %s%s, " fmt, " = %s[%lld]",\
                 Irp,                    \
                 (const char *)&FspDeviceExtension(IrpSp->DeviceObject)->Kind,\
@@ -150,8 +163,8 @@ extern __declspec(selectany) int fsp_bp = 1;
                 __VA_ARGS__,            \
                 NtStatusSym(Result),    \
                 (LONGLONG)Irp->IoStatus.Information);\
-        if (STATUS_PENDING != Result)   \
             FspIopCompleteIrp(Irp, Result);\
+        }                               \
     )
 #define FSP_ENTER_BOOL(...)             \
     BOOLEAN Result = TRUE; FSP_ENTER_(__VA_ARGS__)

src/sys/iop.c

@@ -214,6 +214,7 @@ VOID FspIopCompleteIrpEx(PIRP Irp, NTSTATUS Result, BOOLEAN DeviceRelease)
     PAGED_CODE();
 
     ASSERT(STATUS_PENDING != Result);
+    ASSERT(0 == (FSP_STATUS_PRIVATE_BIT & Result));
 
     if (0 != FspIrpRequest(Irp))
     {

src/sys/ioq.c

@@ -384,10 +384,17 @@ BOOLEAN FspIoqPostIrpEx(FSP_IOQ *Ioq, PIRP Irp, BOOLEAN BestEffort, NTSTATUS *PR
         QueryInterruptTimeInSec() + Ioq->IrpTimeout;
     Result = IoCsqInsertIrpEx(&Ioq->PendingIoCsq, Irp, 0, (PVOID)BestEffort);
     if (NT_SUCCESS(Result))
+    {
+        if (0 != PResult)
+            *PResult = STATUS_PENDING;
         return TRUE;
+    }
+    else
+    {
         if (0 != PResult)
             *PResult = Result;
         return FALSE;
+    }
 }
 
 PIRP FspIoqNextPendingIrp(FSP_IOQ *Ioq, PIRP BoundaryIrp, PLARGE_INTEGER Timeout)

src/sys/volume.c

@@ -644,8 +644,10 @@ NTSTATUS FspVolumeWork(
         Request->Hint = 0;
         FspIrpRequest(Irp) = 0;
     }
-    else
+
-        Result = STATUS_PENDING;
+    DEBUGLOG("%s = %s",
+        IoctlCodeSym(BestEffort ? FSP_FSCTL_WORK_BEST_EFFORT : FSP_FSCTL_WORK),
+        NtStatusSym(Result));
 
     return Result;
 }