[NTOSKRNL] Add the CcPinMappedDataCount counter
[reactos.git] / ntoskrnl / cc / pin.c
index f40405e..4f0e4f5 100644 (file)
@@ -23,14 +23,50 @@ extern NPAGED_LOOKASIDE_LIST iBcbLookasideList;
  * - 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
+ * - Number of calls to CcPinMappedDataCount
  */
 ULONG CcMapDataWait = 0;
 ULONG CcMapDataNoWait = 0;
 ULONG CcPinReadWait = 0;
 ULONG CcPinReadNoWait = 0;
+ULONG CcPinMappedDataCount = 0;
 
 /* FUNCTIONS *****************************************************************/
 
+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
@@ -39,16 +75,14 @@ CcpMapData(
     IN PLARGE_INTEGER FileOffset,
     IN ULONG Length,
     IN ULONG Flags,
-    OUT PVOID *pBcb,
+    OUT PROS_VACB *pVacb,
     OUT PVOID *pBuffer)
 {
     LONGLONG ReadOffset;
     BOOLEAN Valid;
     PROS_VACB Vacb;
     NTSTATUS Status;
-    PINTERNAL_BCB iBcb;
     LONGLONG ROffset;
-    KIRQL OldIrql;
 
     ReadOffset = FileOffset->QuadPart;
 
@@ -111,14 +145,30 @@ CcpMapData(
     }
 
     *pBuffer = (PUCHAR)*pBuffer + ReadOffset % VACB_MAPPING_GRANULARITY;
+    *pVacb = Vacb;
+
+    return TRUE;
+}
+
+static
+PVOID
+CcpGetAppropriateBcb(
+    IN PROS_SHARED_CACHE_MAP SharedCacheMap,
+    IN PROS_VACB Vacb,
+    IN PLARGE_INTEGER FileOffset,
+    IN ULONG Length,
+    IN ULONG PinFlags,
+    IN BOOLEAN ToPin)
+{
+    KIRQL OldIrql;
+    BOOLEAN Result;
+    PINTERNAL_BCB iBcb, DupBcb;
+
     iBcb = ExAllocateFromNPagedLookasideList(&iBcbLookasideList);
     if (iBcb == NULL)
     {
         CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
-        CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
-            SharedCacheMap->FileObject, FileOffset, Length, Flags);
-        ExRaiseStatus(STATUS_INSUFFICIENT_RESOURCES);
-        return FALSE;
+        return NULL;
     }
 
     RtlZeroMemory(iBcb, sizeof(*iBcb));
@@ -131,47 +181,147 @@ CcpMapData(
     iBcb->PinCount = 0;
     iBcb->RefCount = 1;
     ExInitializeResourceLite(&iBcb->Lock);
-    *pBcb = (PVOID)iBcb;
 
     KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
-    InsertTailList(&SharedCacheMap->BcbList, &iBcb->BcbEntry);
+
+    /* Check if we raced with another BCB creation */
+    DupBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, ToPin);
+    /* Yes, and we've lost */
+    if (DupBcb != NULL)
+    {
+        Result = TRUE;
+
+        if (ToPin)
+        {
+            DupBcb->PinCount++;
+
+            if (BooleanFlagOn(PinFlags, PIN_EXCLUSIVE))
+            {
+                Result = ExAcquireResourceExclusiveLite(&iBcb->Lock, BooleanFlagOn(PinFlags, PIN_WAIT));
+            }
+            else
+            {
+                Result = ExAcquireSharedStarveExclusive(&iBcb->Lock, BooleanFlagOn(PinFlags, PIN_WAIT));
+            }
+
+            if (!Result)
+            {
+                DupBcb->PinCount--;
+                DupBcb = NULL;
+            }
+        }
+
+        if (Result)
+        {
+            /* 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.
+         */
+        iBcb = DupBcb;
+    }
+    /* Nope, insert ourselves */
+    else
+    {
+        if (ToPin)
+        {
+            iBcb->PinCount++;
+
+            if (BooleanFlagOn(PinFlags, PIN_EXCLUSIVE))
+            {
+                Result = ExAcquireResourceExclusiveLite(&iBcb->Lock, BooleanFlagOn(PinFlags, PIN_WAIT));
+            }
+            else
+            {
+                Result = ExAcquireSharedStarveExclusive(&iBcb->Lock, BooleanFlagOn(PinFlags, PIN_WAIT));
+            }
+
+            ASSERT(Result);
+        }
+
+        InsertTailList(&SharedCacheMap->BcbList, &iBcb->BcbEntry);
+    }
     KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
 
-    return TRUE;
+    return iBcb;
 }
 
 static
-PINTERNAL_BCB
-NTAPI
-CcpFindBcb(
+BOOLEAN
+CcpPinData(
     IN PROS_SHARED_CACHE_MAP SharedCacheMap,
     IN PLARGE_INTEGER FileOffset,
     IN ULONG Length,
-    IN BOOLEAN Pinned)
+    IN ULONG Flags,
+    OUT        PVOID * Bcb,
+    OUT        PVOID * Buffer)
 {
-    PINTERNAL_BCB Bcb;
-    BOOLEAN Found = FALSE;
-    PLIST_ENTRY NextEntry;
+    PINTERNAL_BCB NewBcb;
+    BOOLEAN Result;
+    PROS_VACB Vacb;
+    KIRQL OldIrql;
 
-    for (NextEntry = SharedCacheMap->BcbList.Flink;
-         NextEntry != &SharedCacheMap->BcbList;
-         NextEntry = NextEntry->Flink)
+    KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
+    NewBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, TRUE);
+    KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
+
+    if (NewBcb != NULL)
     {
-        Bcb = CONTAINING_RECORD(NextEntry, INTERNAL_BCB, BcbEntry);
+        NewBcb->PinCount++;
 
-        if (Bcb->PFCB.MappedFileOffset.QuadPart <= FileOffset->QuadPart &&
-            (Bcb->PFCB.MappedFileOffset.QuadPart + Bcb->PFCB.MappedLength) >=
-            (FileOffset->QuadPart + Length))
+        if (BooleanFlagOn(Flags, PIN_EXCLUSIVE))
         {
-            if ((Pinned && Bcb->PinCount > 0) || (!Pinned && Bcb->PinCount == 0))
+            Result = ExAcquireResourceExclusiveLite(&NewBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
+        }
+        else
+        {
+            Result = ExAcquireSharedStarveExclusive(&NewBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
+        }
+
+        if (!Result)
+        {
+            NewBcb->PinCount--;
+        }
+        else
+        {
+            NewBcb->RefCount++;
+            *Bcb = NewBcb;
+            *Buffer = (PUCHAR)NewBcb->Vacb->BaseAddress + FileOffset->QuadPart % VACB_MAPPING_GRANULARITY;
+        }
+
+        return Result;
+    }
+    else
+    {
+        if (BooleanFlagOn(Flags, PIN_IF_BCB))
+        {
+            return FALSE;
+        }
+
+        Result = CcpMapData(SharedCacheMap, FileOffset, Length, Flags, &Vacb, Buffer);
+        if (Result)
+        {
+            NewBcb = CcpGetAppropriateBcb(SharedCacheMap, Vacb, FileOffset, Length, Flags, TRUE);
+            if (NewBcb == NULL)
             {
-                Found = TRUE;
-                break;
+                CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
+                Result = FALSE;
+            }
+            else
+            {
+                *Bcb = NewBcb;
             }
         }
     }
 
-    return (Found ? Bcb : NULL);
+    return Result;
 }
 
 /*
@@ -190,6 +340,7 @@ CcMapData (
     BOOLEAN Ret;
     KIRQL OldIrql;
     PINTERNAL_BCB iBcb;
+    PROS_VACB Vacb;
     PROS_SHARED_CACHE_MAP SharedCacheMap;
 
     DPRINT("CcMapData(FileObject 0x%p, FileOffset %I64x, Length %lu, Flags 0x%lx,"
@@ -218,7 +369,20 @@ CcMapData (
 
     if (iBcb == NULL)
     {
-        Ret = CcpMapData(SharedCacheMap, FileOffset, Length, Flags, pBcb, pBuffer);
+        Ret = CcpMapData(SharedCacheMap, FileOffset, Length, Flags, &Vacb, pBuffer);
+        if (Ret)
+        {
+            iBcb = CcpGetAppropriateBcb(SharedCacheMap, Vacb, FileOffset, Length, 0, FALSE);
+            if (iBcb == NULL)
+            {
+                CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
+                Ret = FALSE;
+            }
+            else
+            {
+                *pBcb = iBcb;
+            }
+        }
     }
     else
     {
@@ -246,6 +410,7 @@ CcPinMappedData (
     OUT        PVOID * Bcb)
 {
     BOOLEAN Result;
+    PVOID Buffer;
     PINTERNAL_BCB iBcb;
     PROS_SHARED_CACHE_MAP SharedCacheMap;
 
@@ -265,22 +430,13 @@ CcPinMappedData (
     }
 
     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));
-    }
+    ++CcPinMappedDataCount;
 
-    if (!Result)
+    Result = CcpPinData(SharedCacheMap, FileOffset, Length, Flags, Bcb, &Buffer);
+    if (Result)
     {
-        iBcb->PinCount--;
+        CcUnpinData(iBcb);
     }
 
     return Result;
@@ -299,9 +455,6 @@ 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",
@@ -313,6 +466,11 @@ CcPinRead (
 
     SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
     ASSERT(SharedCacheMap);
+    if (!SharedCacheMap->PinAccess)
+    {
+        DPRINT1("FIXME: Pinning a file with no pin access!\n");
+        return FALSE;
+    }
 
     if (Flags & PIN_WAIT)
     {
@@ -323,50 +481,7 @@ CcPinRead (
         ++CcPinReadNoWait;
     }
 
-    KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
-    iBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, TRUE);
-    KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
-
-    if (iBcb == NULL)
-    {
-        /* Map first */
-        if (!CcpMapData(SharedCacheMap, FileOffset, Length, Flags, Bcb, Buffer))
-        {
-            return FALSE;
-        }
-
-        /* Pin then */
-        if (!CcPinMappedData(FileObject, FileOffset, Length, Flags, Bcb))
-        {
-            CcUnpinData(*Bcb);
-            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;
+    return CcpPinData(SharedCacheMap, FileOffset, Length, Flags, Bcb, Buffer);
 }
 
 /*
@@ -463,7 +578,10 @@ CcUnpinDataForThread (
                          FALSE);
 
         KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
-        RemoveEntryList(&iBcb->BcbEntry);
+        if (!IsListEmpty(&iBcb->BcbEntry))
+        {
+            RemoveEntryList(&iBcb->BcbEntry);
+        }
         KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
 
         ExDeleteResourceLite(&iBcb->Lock);
@@ -537,7 +655,10 @@ CcUnpinRepinnedBcb (
                          FALSE);
 
         KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
-        RemoveEntryList(&iBcb->BcbEntry);
+        if (!IsListEmpty(&iBcb->BcbEntry))
+        {
+            RemoveEntryList(&iBcb->BcbEntry);
+        }
         KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
 
         ExDeleteResourceLite(&iBcb->Lock);