[NTOSKRNL] Add the CcMapDataWait and CcMapDataNoWait counters
[reactos.git] / ntoskrnl / cc / pin.c
index d6e764a..d0a0d7e 100644 (file)
@@ -4,7 +4,8 @@
  * FILE:            ntoskrnl/cc/pin.c
  * PURPOSE:         Implements cache managers pinning interface
  *
- * PROGRAMMERS:
+ * PROGRAMMERS:     ?
+                    Pierre Schweitzer (pierre@reactos.org)
  */
 
 /* INCLUDES ******************************************************************/
@@ -17,6 +18,9 @@
 
 extern NPAGED_LOOKASIDE_LIST iBcbLookasideList;
 
+ULONG CcMapDataWait = 0;
+ULONG CcMapDataNoWait = 0;
+
 /* FUNCTIONS *****************************************************************/
 
 /*
@@ -24,81 +28,116 @@ extern NPAGED_LOOKASIDE_LIST iBcbLookasideList;
  */
 BOOLEAN
 NTAPI
-CcMapData(
+CcMapData (
     IN PFILE_OBJECT FileObject,
-       IN PLARGE_INTEGER FileOffset,
-       IN ULONG Length,
-       IN ULONG Flags,
-       OUT PVOID *pBcb,
-       OUT PVOID *pBuffer)
+    IN PLARGE_INTEGER FileOffset,
+    IN ULONG Length,
+    IN ULONG Flags,
+    OUT PVOID *pBcb,
+    OUT PVOID *pBuffer)
 {
-    ULONG ReadOffset;
+    LONGLONG ReadOffset;
     BOOLEAN Valid;
-    PBCB Bcb;
-    PCACHE_SEGMENT CacheSeg;
+    PROS_SHARED_CACHE_MAP SharedCacheMap;
+    PROS_VACB Vacb;
     NTSTATUS Status;
     PINTERNAL_BCB iBcb;
-    ULONG ROffset;
+    LONGLONG ROffset;
 
-    DPRINT("CcMapData(FileObject 0x%p, FileOffset %I64x, Length %d, Flags %d,"
+    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);
 
-    ReadOffset = (ULONG)FileOffset->QuadPart;
+    if (Flags & MAP_WAIT)
+    {
+        ++CcMapDataWait;
+    }
+    else
+    {
+        ++CcMapDataNoWait;
+    }
+
+    ReadOffset = FileOffset->QuadPart;
 
     ASSERT(FileObject);
     ASSERT(FileObject->SectionObjectPointer);
     ASSERT(FileObject->SectionObjectPointer->SharedCacheMap);
 
-    Bcb = FileObject->SectionObjectPointer->SharedCacheMap;
-    ASSERT(Bcb);
+    SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
+    ASSERT(SharedCacheMap);
 
-    DPRINT("AllocationSize %I64x, FileSize %I64x\n",
-           Bcb->AllocationSize.QuadPart,
-           Bcb->FileSize.QuadPart);
+    DPRINT("SectionSize %I64x, FileSize %I64x\n",
+           SharedCacheMap->SectionSize.QuadPart,
+           SharedCacheMap->FileSize.QuadPart);
 
-    if (ReadOffset % Bcb->CacheSegmentSize + Length > Bcb->CacheSegmentSize)
+    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);
         return FALSE;
     }
-    ROffset = ROUND_DOWN (ReadOffset, Bcb->CacheSegmentSize);
-    Status = CcRosRequestCacheSegment(Bcb, ROffset,
-                                             pBuffer, &Valid,
-                                      &CacheSeg);
+
+    ROffset = ROUND_DOWN(ReadOffset, VACB_MAPPING_GRANULARITY);
+    Status = CcRosRequestVacb(SharedCacheMap,
+                              ROffset,
+                              pBuffer,
+                              &Valid,
+                              &Vacb);
     if (!NT_SUCCESS(Status))
     {
+        CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
+            FileObject, FileOffset, Length, Flags);
+        ExRaiseStatus(Status);
         return FALSE;
     }
+
     if (!Valid)
     {
         if (!(Flags & MAP_WAIT))
         {
-            CcRosReleaseCacheSegment(Bcb, CacheSeg, FALSE, FALSE, FALSE);
+            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);
             return FALSE;
         }
-        if (!NT_SUCCESS(ReadCacheSegment(CacheSeg)))
+
+        Status = CcReadVirtualAddress(Vacb);
+        if (!NT_SUCCESS(Status))
         {
-            CcRosReleaseCacheSegment(Bcb, CacheSeg, FALSE, FALSE, FALSE);
-               return FALSE;
+            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);
+            ExRaiseStatus(Status);
+            return FALSE;
         }
     }
 
-    *pBuffer = (PVOID)((ULONG_PTR)(*pBuffer) + (ReadOffset % Bcb->CacheSegmentSize));
+    *pBuffer = (PUCHAR)*pBuffer + ReadOffset % VACB_MAPPING_GRANULARITY;
     iBcb = ExAllocateFromNPagedLookasideList(&iBcbLookasideList);
     if (iBcb == NULL)
     {
-        CcRosReleaseCacheSegment(Bcb, CacheSeg, TRUE, FALSE, FALSE);
+        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);
+        ExRaiseStatus(STATUS_INSUFFICIENT_RESOURCES);
         return FALSE;
     }
-    memset(iBcb, 0, sizeof(INTERNAL_BCB));
+
+    RtlZeroMemory(iBcb, sizeof(*iBcb));
     iBcb->PFCB.NodeTypeCode = 0xDE45; /* Undocumented (CAPTIVE_PUBLIC_BCB_NODETYPECODE) */
     iBcb->PFCB.NodeByteSize = sizeof(PUBLIC_BCB);
     iBcb->PFCB.MappedLength = Length;
     iBcb->PFCB.MappedFileOffset = *FileOffset;
-    iBcb->CacheSegment = CacheSeg;
+    iBcb->Vacb = Vacb;
     iBcb->Dirty = FALSE;
+    iBcb->Pinned = FALSE;
     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);
     return TRUE;
 }
 
@@ -108,15 +147,27 @@ CcMapData(
 BOOLEAN
 NTAPI
 CcPinMappedData (
-       IN      PFILE_OBJECT            FileObject,
-       IN      PLARGE_INTEGER          FileOffset,
-       IN      ULONG                   Length,
-       IN      ULONG                   Flags,
-       OUT     PVOID                   * Bcb
-       )
+    IN PFILE_OBJECT FileObject,
+    IN PLARGE_INTEGER FileOffset,
+    IN ULONG Length,
+    IN ULONG Flags,
+    OUT        PVOID * Bcb)
 {
-  /* no-op for current implementation. */
-  return TRUE;
+    PROS_SHARED_CACHE_MAP SharedCacheMap;
+
+    CCTRACE(CC_API_DEBUG, "FileOffset=%p FileOffset=%p Length=%lu Flags=0x%lx\n",
+        FileObject, FileOffset, Length, Flags);
+
+    ASSERT(FileObject);
+    ASSERT(FileObject->SectionObjectPointer);
+    ASSERT(FileObject->SectionObjectPointer->SharedCacheMap);
+
+    SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
+    ASSERT(SharedCacheMap);
+    ASSERT(SharedCacheMap->PinAccess);
+
+    /* no-op for current implementation. */
+    return TRUE;
 }
 
 /*
@@ -125,22 +176,45 @@ CcPinMappedData (
 BOOLEAN
 NTAPI
 CcPinRead (
-       IN      PFILE_OBJECT            FileObject,
-       IN      PLARGE_INTEGER          FileOffset,
-       IN      ULONG                   Length,
-       IN      ULONG                   Flags,
-       OUT     PVOID                   * Bcb,
-       OUT     PVOID                   * Buffer
-       )
+    IN PFILE_OBJECT FileObject,
+    IN PLARGE_INTEGER FileOffset,
+    IN ULONG Length,
+    IN ULONG Flags,
+    OUT        PVOID * Bcb,
+    OUT        PVOID * Buffer)
 {
-  if (CcMapData(FileObject, FileOffset, Length, Flags, Bcb, Buffer))
-  {
-    if (CcPinMappedData(FileObject, FileOffset, Length, Flags, Bcb))
-      return TRUE;
-    else
-      CcUnpinData(Bcb);
-  }
-  return FALSE;
+    PINTERNAL_BCB iBcb;
+
+    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))
+    {
+        if (CcPinMappedData(FileObject, FileOffset, Length, Flags, Bcb))
+        {
+            iBcb = *Bcb;
+
+            ASSERT(iBcb->Pinned == FALSE);
+
+            iBcb->Pinned = TRUE;
+            iBcb->Vacb->PinCount++;
+            CcRosReleaseVacbLock(iBcb->Vacb);
+
+            if (Flags & PIN_EXCLUSIVE)
+            {
+                ExAcquireResourceExclusiveLite(&iBcb->Lock, TRUE);
+            }
+            else
+            {
+                ExAcquireResourceSharedLite(&iBcb->Lock, TRUE);
+            }
+
+            return TRUE;
+        }
+        else
+            CcUnpinData(*Bcb);
+    }
+    return FALSE;
 }
 
 /*
@@ -149,35 +223,42 @@ CcPinRead (
 BOOLEAN
 NTAPI
 CcPreparePinWrite (
-       IN      PFILE_OBJECT            FileObject,
-       IN      PLARGE_INTEGER          FileOffset,
-       IN      ULONG                   Length,
-       IN      BOOLEAN                 Zero,
-       IN      ULONG                   Flags,
-       OUT     PVOID                   * Bcb,
-       OUT     PVOID                   * Buffer
-       )
+    IN PFILE_OBJECT FileObject,
+    IN PLARGE_INTEGER FileOffset,
+    IN ULONG Length,
+    IN BOOLEAN Zero,
+    IN ULONG Flags,
+    OUT        PVOID * Bcb,
+    OUT        PVOID * Buffer)
 {
-        /*
-         * FIXME: This is function is similar to CcPinRead, but doesn't
-         * read the data if they're not present. Instead it should just
-         * prepare the cache segments and zero them out if Zero == TRUE.
-         *
-         * For now calling CcPinRead is better than returning error or
-         * just having UNIMPLEMENTED here.
-         */
-        return CcPinRead(FileObject, FileOffset, Length, Flags, Bcb, Buffer);
+    CCTRACE(CC_API_DEBUG, "FileOffset=%p FileOffset=%p Length=%lu Zero=%d Flags=0x%lx\n",
+        FileObject, FileOffset, Length, Zero, Flags);
+
+    /*
+     * FIXME: This is function is similar to CcPinRead, but doesn't
+     * read the data if they're not present. Instead it should just
+     * prepare the VACBs and zero them out if Zero != FALSE.
+     *
+     * For now calling CcPinRead is better than returning error or
+     * just having UNIMPLEMENTED here.
+     */
+    return CcPinRead(FileObject, FileOffset, Length, Flags, Bcb, Buffer);
 }
 
 /*
  * @implemented
  */
 VOID NTAPI
-CcSetDirtyPinnedData (IN PVOID Bcb,
-                     IN PLARGE_INTEGER Lsn)
+CcSetDirtyPinnedData (
+    IN PVOID Bcb,
+    IN PLARGE_INTEGER Lsn)
 {
-   PINTERNAL_BCB iBcb = Bcb;
-   iBcb->Dirty = TRUE;
+    PINTERNAL_BCB iBcb = Bcb;
+
+    CCTRACE(CC_API_DEBUG, "Bcb=%p Lsn=%p\n",
+        Bcb, Lsn);
+
+    iBcb->Dirty = TRUE;
 }
 
 
@@ -185,15 +266,12 @@ CcSetDirtyPinnedData (IN PVOID Bcb,
  * @implemented
  */
 VOID NTAPI
-CcUnpinData (IN PVOID Bcb)
+CcUnpinData (
+    IN PVOID Bcb)
 {
-  PINTERNAL_BCB iBcb = Bcb;
-  CcRosReleaseCacheSegment(iBcb->CacheSegment->Bcb, iBcb->CacheSegment, TRUE,
-                           iBcb->Dirty, FALSE);
-  if (--iBcb->RefCount == 0)
-  {
-    ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
-  }
+    CCTRACE(CC_API_DEBUG, "Bcb=%p\n", Bcb);
+
+    CcUnpinDataForThread(Bcb, (ERESOURCE_THREAD)PsGetCurrentThread());
 }
 
 /*
@@ -202,11 +280,32 @@ CcUnpinData (IN PVOID Bcb)
 VOID
 NTAPI
 CcUnpinDataForThread (
-       IN      PVOID                   Bcb,
-       IN      ERESOURCE_THREAD        ResourceThreadId
-       )
+    IN PVOID Bcb,
+    IN ERESOURCE_THREAD ResourceThreadId)
 {
-       UNIMPLEMENTED;
+    PINTERNAL_BCB iBcb = Bcb;
+
+    CCTRACE(CC_API_DEBUG, "Bcb=%p ResourceThreadId=%lu\n", Bcb, ResourceThreadId);
+
+    if (iBcb->Pinned)
+    {
+        ExReleaseResourceForThreadLite(&iBcb->Lock, ResourceThreadId);
+        iBcb->Pinned = FALSE;
+        CcRosAcquireVacbLock(iBcb->Vacb, NULL);
+        iBcb->Vacb->PinCount--;
+    }
+
+    if (--iBcb->RefCount == 0)
+    {
+        CcRosReleaseVacb(iBcb->Vacb->SharedCacheMap,
+                         iBcb->Vacb,
+                         TRUE,
+                         iBcb->Dirty,
+                         FALSE);
+
+        ExDeleteResourceLite(&iBcb->Lock);
+        ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
+    }
 }
 
 /*
@@ -215,11 +314,13 @@ CcUnpinDataForThread (
 VOID
 NTAPI
 CcRepinBcb (
-       IN      PVOID   Bcb
-       )
+    IN PVOID Bcb)
 {
-  PINTERNAL_BCB iBcb = Bcb;
-  iBcb->RefCount++;
+    PINTERNAL_BCB iBcb = Bcb;
+
+    CCTRACE(CC_API_DEBUG, "Bcb=%p\n", Bcb);
+
+    iBcb->RefCount++;
 }
 
 /*
@@ -228,38 +329,44 @@ CcRepinBcb (
 VOID
 NTAPI
 CcUnpinRepinnedBcb (
-       IN      PVOID                   Bcb,
-       IN      BOOLEAN                 WriteThrough,
-       IN      PIO_STATUS_BLOCK        IoStatus
-       )
+    IN PVOID Bcb,
+    IN BOOLEAN WriteThrough,
+    IN PIO_STATUS_BLOCK IoStatus)
 {
-  PINTERNAL_BCB iBcb = Bcb;
+    PINTERNAL_BCB iBcb = Bcb;
 
-  if (--iBcb->RefCount == 0)
+    CCTRACE(CC_API_DEBUG, "Bcb=%p WriteThrough=%d\n", Bcb, WriteThrough);
+
+    IoStatus->Status = STATUS_SUCCESS;
+    if (--iBcb->RefCount == 0)
     {
-      IoStatus->Information = 0;
-      if (WriteThrough)
+        IoStatus->Information = 0;
+        if (WriteThrough)
         {
-            KeWaitForSingleObject(&iBcb->CacheSegment->Mutex,
-                                  Executive,
-                                  KernelMode,
-                                  FALSE,
-                                  NULL);
-          if (iBcb->CacheSegment->Dirty)
+            CcRosAcquireVacbLock(iBcb->Vacb, NULL);
+            if (iBcb->Vacb->Dirty)
             {
-              IoStatus->Status = CcRosFlushCacheSegment(iBcb->CacheSegment);
+                IoStatus->Status = CcRosFlushVacb(iBcb->Vacb);
             }
-          else
+            else
             {
-              IoStatus->Status = STATUS_SUCCESS;
+                IoStatus->Status = STATUS_SUCCESS;
             }
-          KeReleaseMutex(&iBcb->CacheSegment->Mutex, 0);
+            CcRosReleaseVacbLock(iBcb->Vacb);
         }
-      else
+        else
         {
-          IoStatus->Status = STATUS_SUCCESS;
+            IoStatus->Status = STATUS_SUCCESS;
         }
 
-      ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
+        if (iBcb->Pinned)
+        {
+            ExReleaseResourceLite(&iBcb->Lock);
+            iBcb->Pinned = FALSE;
+            CcRosAcquireVacbLock(iBcb->Vacb, NULL);
+            iBcb->Vacb->PinCount--;
+        }
+        ExDeleteResourceLite(&iBcb->Lock);
+        ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
     }
 }