[NTOSKRNL] Don't keep the spin lock hold too long when we lost the BCB race
[reactos.git] / ntoskrnl / cc / pin.c
index 07afd18..b3906a9 100644 (file)
@@ -21,55 +21,72 @@ extern NPAGED_LOOKASIDE_LIST iBcbLookasideList;
 /* Counters:
  * - Number of calls to CcMapData that could wait
  * - Number of calls to CcMapData that couldn't wait
+ * - Number of calls to CcPinRead that could wait
+ * - Number of calls to CcPinRead that couldn't wait
  */
 ULONG CcMapDataWait = 0;
 ULONG CcMapDataNoWait = 0;
+ULONG CcPinReadWait = 0;
+ULONG CcPinReadNoWait = 0;
 
 /* FUNCTIONS *****************************************************************/
 
-/*
- * @implemented
- */
+static
+PINTERNAL_BCB
+NTAPI
+CcpFindBcb(
+    IN PROS_SHARED_CACHE_MAP SharedCacheMap,
+    IN PLARGE_INTEGER FileOffset,
+    IN ULONG Length,
+    IN BOOLEAN Pinned)
+{
+    PINTERNAL_BCB Bcb;
+    BOOLEAN Found = FALSE;
+    PLIST_ENTRY NextEntry;
+
+    for (NextEntry = SharedCacheMap->BcbList.Flink;
+         NextEntry != &SharedCacheMap->BcbList;
+         NextEntry = NextEntry->Flink)
+    {
+        Bcb = CONTAINING_RECORD(NextEntry, INTERNAL_BCB, BcbEntry);
+
+        if (Bcb->PFCB.MappedFileOffset.QuadPart <= FileOffset->QuadPart &&
+            (Bcb->PFCB.MappedFileOffset.QuadPart + Bcb->PFCB.MappedLength) >=
+            (FileOffset->QuadPart + Length))
+        {
+            if ((Pinned && Bcb->PinCount > 0) || (!Pinned && Bcb->PinCount == 0))
+            {
+                Found = TRUE;
+                break;
+            }
+        }
+    }
+
+    return (Found ? Bcb : NULL);
+}
+
+static
 BOOLEAN
 NTAPI
-CcMapData (
-    IN PFILE_OBJECT FileObject,
+CcpMapData(
+    IN PROS_SHARED_CACHE_MAP SharedCacheMap,
     IN PLARGE_INTEGER FileOffset,
     IN ULONG Length,
     IN ULONG Flags,
+    IN BOOLEAN ToPin,
     OUT PVOID *pBcb,
     OUT PVOID *pBuffer)
 {
     LONGLONG ReadOffset;
     BOOLEAN Valid;
-    PROS_SHARED_CACHE_MAP SharedCacheMap;
     PROS_VACB Vacb;
     NTSTATUS Status;
-    PINTERNAL_BCB iBcb;
+    PINTERNAL_BCB iBcb, DupBcb;
     LONGLONG ROffset;
-
-    DPRINT("CcMapData(FileObject 0x%p, FileOffset %I64x, Length %lu, Flags 0x%lx,"
-           " pBcb 0x%p, pBuffer 0x%p)\n", FileObject, FileOffset->QuadPart,
-           Length, Flags, pBcb, pBuffer);
-
-    if (Flags & MAP_WAIT)
-    {
-        ++CcMapDataWait;
-    }
-    else
-    {
-        ++CcMapDataNoWait;
-    }
+    KIRQL OldIrql;
 
     ReadOffset = FileOffset->QuadPart;
 
-    ASSERT(FileObject);
-    ASSERT(FileObject->SectionObjectPointer);
-    ASSERT(FileObject->SectionObjectPointer->SharedCacheMap);
-
-    SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
-    ASSERT(SharedCacheMap);
-
     DPRINT("SectionSize %I64x, FileSize %I64x\n",
            SharedCacheMap->SectionSize.QuadPart,
            SharedCacheMap->FileSize.QuadPart);
@@ -77,11 +94,22 @@ CcMapData (
     if (ReadOffset % VACB_MAPPING_GRANULARITY + Length > VACB_MAPPING_GRANULARITY)
     {
         CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
-            FileObject, FileOffset, Length, Flags);
-        ExRaiseStatus(STATUS_INVALID_PARAMETER);
+            SharedCacheMap->FileObject, FileOffset, Length, Flags);
         return FALSE;
     }
 
+    if (!BooleanFlagOn(Flags, MAP_NO_READ))
+    {
+        static int Warned = 0;
+
+        SetFlag(Flags, MAP_NO_READ);
+        if (!Warned)
+        {
+            DPRINT1("Mapping/pinning with no read not implemented. Forcing read, might fail if wait not allowed\n");
+            Warned++;
+        }
+    }
+
     ROffset = ROUND_DOWN(ReadOffset, VACB_MAPPING_GRANULARITY);
     Status = CcRosRequestVacb(SharedCacheMap,
                               ROffset,
@@ -91,18 +119,18 @@ CcMapData (
     if (!NT_SUCCESS(Status))
     {
         CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
-            FileObject, FileOffset, Length, Flags);
+            SharedCacheMap->FileObject, FileOffset, Length, Flags);
         ExRaiseStatus(Status);
         return FALSE;
     }
 
-    if (!Valid)
+    if (!Valid && BooleanFlagOn(Flags, MAP_NO_READ))
     {
-        if (!(Flags & MAP_WAIT))
+        if (!BooleanFlagOn(Flags, MAP_WAIT))
         {
             CcRosReleaseVacb(SharedCacheMap, Vacb, FALSE, FALSE, FALSE);
             CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
-                FileObject, FileOffset, Length, Flags);
+                SharedCacheMap->FileObject, FileOffset, Length, Flags);
             return FALSE;
         }
 
@@ -111,7 +139,7 @@ CcMapData (
         {
             CcRosReleaseVacb(SharedCacheMap, Vacb, FALSE, FALSE, FALSE);
             CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
-                FileObject, FileOffset, Length, Flags);
+                SharedCacheMap->FileObject, FileOffset, Length, Flags);
             ExRaiseStatus(Status);
             return FALSE;
         }
@@ -123,7 +151,7 @@ CcMapData (
     {
         CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
         CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
-            FileObject, FileOffset, Length, Flags);
+            SharedCacheMap->FileObject, FileOffset, Length, Flags);
         ExRaiseStatus(STATUS_INSUFFICIENT_RESOURCES);
         return FALSE;
     }
@@ -135,16 +163,108 @@ CcMapData (
     iBcb->PFCB.MappedFileOffset = *FileOffset;
     iBcb->Vacb = Vacb;
     iBcb->Dirty = FALSE;
-    iBcb->Pinned = FALSE;
+    iBcb->PinCount = 0;
     iBcb->RefCount = 1;
     ExInitializeResourceLite(&iBcb->Lock);
     *pBcb = (PVOID)iBcb;
 
-    CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> TRUE Bcb=%p\n",
-        FileObject, FileOffset, Length, Flags, iBcb);
+    /* Only insert if we're not to pin data */
+    if (!ToPin)
+    {
+        KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
+
+        /* Check if we raced with another BCB creation */
+        DupBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, FALSE);
+        /* Yes, and we've lost */
+        if (DupBcb != NULL)
+        {
+            /* We'll return that BCB */
+            ++DupBcb->RefCount;
+
+            /* Delete the loser */
+            CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
+            ExDeleteResourceLite(&iBcb->Lock);
+            ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
+
+            /* Return the winner - no need to update buffer address, it's
+             * relative to the VACB, which is unchanged.
+             */
+            *pBcb = DupBcb;
+        }
+        /* Nope, insert ourselves */
+        else
+        {
+            InsertTailList(&SharedCacheMap->BcbList, &iBcb->BcbEntry);
+        }
+        KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
+    }
+    else
+    {
+        InitializeListHead(&iBcb->BcbEntry);
+    }
+
     return TRUE;
 }
 
+/*
+ * @implemented
+ */
+BOOLEAN
+NTAPI
+CcMapData (
+    IN PFILE_OBJECT FileObject,
+    IN PLARGE_INTEGER FileOffset,
+    IN ULONG Length,
+    IN ULONG Flags,
+    OUT PVOID *pBcb,
+    OUT PVOID *pBuffer)
+{
+    BOOLEAN Ret;
+    KIRQL OldIrql;
+    PINTERNAL_BCB iBcb;
+    PROS_SHARED_CACHE_MAP SharedCacheMap;
+
+    DPRINT("CcMapData(FileObject 0x%p, FileOffset %I64x, Length %lu, Flags 0x%lx,"
+           " pBcb 0x%p, pBuffer 0x%p)\n", FileObject, FileOffset->QuadPart,
+           Length, Flags, pBcb, pBuffer);
+
+    ASSERT(FileObject);
+    ASSERT(FileObject->SectionObjectPointer);
+    ASSERT(FileObject->SectionObjectPointer->SharedCacheMap);
+
+    SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
+    ASSERT(SharedCacheMap);
+
+    if (Flags & MAP_WAIT)
+    {
+        ++CcMapDataWait;
+    }
+    else
+    {
+        ++CcMapDataNoWait;
+    }
+
+    KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
+    iBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, FALSE);
+    KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
+
+    if (iBcb == NULL)
+    {
+        Ret = CcpMapData(SharedCacheMap, FileOffset, Length, Flags, FALSE, pBcb, pBuffer);
+    }
+    else
+    {
+        ++iBcb->RefCount;
+        *pBcb = iBcb;
+        *pBuffer = (PUCHAR)iBcb->Vacb->BaseAddress + FileOffset->QuadPart % VACB_MAPPING_GRANULARITY;
+        Ret = TRUE;
+    }
+
+    CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> %d Bcb=%p\n",
+        FileObject, FileOffset, Length, Flags, Ret, *pBcb);
+    return Ret;
+}
+
 /*
  * @unimplemented
  */
@@ -157,9 +277,11 @@ CcPinMappedData (
     IN ULONG Flags,
     OUT        PVOID * Bcb)
 {
+    BOOLEAN Result;
+    PINTERNAL_BCB iBcb;
     PROS_SHARED_CACHE_MAP SharedCacheMap;
 
-    CCTRACE(CC_API_DEBUG, "FileOffset=%p FileOffset=%p Length=%lu Flags=0x%lx\n",
+    CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx\n",
         FileObject, FileOffset, Length, Flags);
 
     ASSERT(FileObject);
@@ -168,10 +290,32 @@ CcPinMappedData (
 
     SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
     ASSERT(SharedCacheMap);
-    ASSERT(SharedCacheMap->PinAccess);
+    if (!SharedCacheMap->PinAccess)
+    {
+        DPRINT1("FIXME: Pinning a file with no pin access!\n");
+        return FALSE;
+    }
 
-    /* no-op for current implementation. */
-    return TRUE;
+    iBcb = *Bcb;
+    ASSERT(iBcb->PinCount == 0);
+
+    iBcb->PinCount++;
+
+    if (BooleanFlagOn(Flags, PIN_EXCLUSIVE))
+    {
+        Result = ExAcquireResourceExclusiveLite(&iBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
+    }
+    else
+    {
+        Result = ExAcquireSharedStarveExclusive(&iBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
+    }
+
+    if (!Result)
+    {
+        iBcb->PinCount--;
+    }
+
+    return Result;
 }
 
 /*
@@ -187,38 +331,119 @@ CcPinRead (
     OUT        PVOID * Bcb,
     OUT        PVOID * Buffer)
 {
+    KIRQL OldIrql;
+    BOOLEAN Result;
     PINTERNAL_BCB iBcb;
+    PROS_SHARED_CACHE_MAP SharedCacheMap;
 
     CCTRACE(CC_API_DEBUG, "FileOffset=%p FileOffset=%p Length=%lu Flags=0x%lx\n",
         FileObject, FileOffset, Length, Flags);
 
-    if (CcMapData(FileObject, FileOffset, Length, Flags, Bcb, Buffer))
+    ASSERT(FileObject);
+    ASSERT(FileObject->SectionObjectPointer);
+    ASSERT(FileObject->SectionObjectPointer->SharedCacheMap);
+
+    SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
+    ASSERT(SharedCacheMap);
+
+    if (Flags & PIN_WAIT)
+    {
+        ++CcPinReadWait;
+    }
+    else
+    {
+        ++CcPinReadNoWait;
+    }
+
+    KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
+    iBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, TRUE);
+    KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
+
+    if (iBcb == NULL)
     {
-        if (CcPinMappedData(FileObject, FileOffset, Length, Flags, Bcb))
+        /* We failed to find an already existing BCB */
+        if (BooleanFlagOn(Flags, PIN_IF_BCB))
         {
-            iBcb = *Bcb;
+            return FALSE;
+        }
+
+        /* Map first */
+        if (!CcpMapData(SharedCacheMap, FileOffset, Length, Flags, TRUE, Bcb, Buffer))
+        {
+            return FALSE;
+        }
+
+        /* Pin then */
+        if (!CcPinMappedData(FileObject, FileOffset, Length, Flags, Bcb))
+        {
+            CcUnpinData(*Bcb);
+            return FALSE;
+        }
 
-            ASSERT(iBcb->Pinned == FALSE);
+        /* Did we race for the BCB creation? */
+        KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
+        iBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, TRUE);
+        if (iBcb != NULL)
+        {
+            KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
 
-            iBcb->Pinned = TRUE;
-            iBcb->Vacb->PinCount++;
-            CcRosReleaseVacbLock(iBcb->Vacb);
+            /* Free our now unused BCB */
+            CcUnpinData(*Bcb);
 
-            if (Flags & PIN_EXCLUSIVE)
+            /* Lock the found BCB and return it */
+            if (BooleanFlagOn(Flags, PIN_EXCLUSIVE))
             {
-                ExAcquireResourceExclusiveLite(&iBcb->Lock, TRUE);
+                Result = ExAcquireResourceExclusiveLite(&iBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
             }
             else
             {
-                ExAcquireResourceSharedLite(&iBcb->Lock, TRUE);
+                Result = ExAcquireSharedStarveExclusive(&iBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
             }
 
-            return TRUE;
+            if (!Result)
+            {
+                return FALSE;
+            }
+
+            ++iBcb->PinCount;
+            ++iBcb->RefCount;
+
+            *Bcb = iBcb;
         }
         else
-            CcUnpinData(*Bcb);
+        {
+            iBcb = *Bcb;
+
+            /* Insert ourselves in the linked list */
+            InsertTailList(&SharedCacheMap->BcbList, &iBcb->BcbEntry);
+            KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
+        }
     }
-    return FALSE;
+    /* We found a BCB, lock it and return it */
+    else
+    {
+        if (BooleanFlagOn(Flags, PIN_EXCLUSIVE))
+        {
+            Result = ExAcquireResourceExclusiveLite(&iBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
+        }
+        else
+        {
+            Result = ExAcquireSharedStarveExclusive(&iBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
+        }
+
+        if (!Result)
+        {
+            return FALSE;
+        }
+
+        ++iBcb->PinCount;
+        ++iBcb->RefCount;
+
+        *Bcb = iBcb;
+        *Buffer = (PUCHAR)iBcb->Vacb->BaseAddress + FileOffset->QuadPart % VACB_MAPPING_GRANULARITY;
+    }
+
+    return TRUE;
 }
 
 /*
@@ -263,6 +488,10 @@ CcSetDirtyPinnedData (
         Bcb, Lsn);
 
     iBcb->Dirty = TRUE;
+    if (!iBcb->Vacb->Dirty)
+    {
+        CcRosMarkDirtyVacb(iBcb->Vacb);
+    }
 }
 
 
@@ -291,22 +520,32 @@ CcUnpinDataForThread (
 
     CCTRACE(CC_API_DEBUG, "Bcb=%p ResourceThreadId=%lu\n", Bcb, ResourceThreadId);
 
-    if (iBcb->Pinned)
+    if (iBcb->PinCount != 0)
     {
         ExReleaseResourceForThreadLite(&iBcb->Lock, ResourceThreadId);
-        iBcb->Pinned = FALSE;
-        CcRosAcquireVacbLock(iBcb->Vacb, NULL);
-        iBcb->Vacb->PinCount--;
+        iBcb->PinCount--;
     }
 
     if (--iBcb->RefCount == 0)
     {
-        CcRosReleaseVacb(iBcb->Vacb->SharedCacheMap,
+        KIRQL OldIrql;
+        PROS_SHARED_CACHE_MAP SharedCacheMap;
+
+        ASSERT(iBcb->PinCount == 0);
+        SharedCacheMap = iBcb->Vacb->SharedCacheMap;
+        CcRosReleaseVacb(SharedCacheMap,
                          iBcb->Vacb,
                          TRUE,
                          iBcb->Dirty,
                          FALSE);
 
+        KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
+        if (!IsListEmpty(&iBcb->BcbEntry))
+        {
+            RemoveEntryList(&iBcb->BcbEntry);
+        }
+        KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
+
         ExDeleteResourceLite(&iBcb->Lock);
         ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
     }
@@ -338,6 +577,8 @@ CcUnpinRepinnedBcb (
     IN PIO_STATUS_BLOCK IoStatus)
 {
     PINTERNAL_BCB iBcb = Bcb;
+    KIRQL OldIrql;
+    PROS_SHARED_CACHE_MAP SharedCacheMap;
 
     CCTRACE(CC_API_DEBUG, "Bcb=%p WriteThrough=%d\n", Bcb, WriteThrough);
 
@@ -347,7 +588,6 @@ CcUnpinRepinnedBcb (
         IoStatus->Information = 0;
         if (WriteThrough)
         {
-            CcRosAcquireVacbLock(iBcb->Vacb, NULL);
             if (iBcb->Vacb->Dirty)
             {
                 IoStatus->Status = CcRosFlushVacb(iBcb->Vacb);
@@ -356,20 +596,33 @@ CcUnpinRepinnedBcb (
             {
                 IoStatus->Status = STATUS_SUCCESS;
             }
-            CcRosReleaseVacbLock(iBcb->Vacb);
         }
         else
         {
             IoStatus->Status = STATUS_SUCCESS;
         }
 
-        if (iBcb->Pinned)
+        if (iBcb->PinCount != 0)
         {
             ExReleaseResourceLite(&iBcb->Lock);
-            iBcb->Pinned = FALSE;
-            CcRosAcquireVacbLock(iBcb->Vacb, NULL);
-            iBcb->Vacb->PinCount--;
+            iBcb->PinCount--;
+            ASSERT(iBcb->PinCount == 0);
+        }
+
+        SharedCacheMap = iBcb->Vacb->SharedCacheMap;
+        CcRosReleaseVacb(iBcb->Vacb->SharedCacheMap,
+                         iBcb->Vacb,
+                         TRUE,
+                         iBcb->Dirty,
+                         FALSE);
+
+        KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
+        if (!IsListEmpty(&iBcb->BcbEntry))
+        {
+            RemoveEntryList(&iBcb->BcbEntry);
         }
+        KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
+
         ExDeleteResourceLite(&iBcb->Lock);
         ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
     }