[NTOSKRNL] Stubplement CcPinMappedData() and simplify CcPinRead()
[reactos.git] / ntoskrnl / cc / pin.c
index a439d78..8b99b8c 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 ******************************************************************/
 
 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 *****************************************************************/
 
 /*
@@ -32,19 +44,28 @@ CcMapData (
     OUT PVOID *pBcb,
     OUT PVOID *pBuffer)
 {
-    ULONG ReadOffset;
+    LONGLONG ReadOffset;
     BOOLEAN Valid;
     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 %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);
@@ -59,6 +80,9 @@ 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);
         return FALSE;
     }
 
@@ -70,6 +94,9 @@ CcMapData (
                               &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;
     }
 
@@ -78,21 +105,30 @@ CcMapData (
         if (!(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);
             return FALSE;
         }
 
-        if (!NT_SUCCESS(CcReadVirtualAddress(Vacb)))
+        Status = CcReadVirtualAddress(Vacb);
+        if (!NT_SUCCESS(Status))
         {
             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 % VACB_MAPPING_GRANULARITY);
+    *pBuffer = (PUCHAR)*pBuffer + ReadOffset % VACB_MAPPING_GRANULARITY;
     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",
+            FileObject, FileOffset, Length, Flags);
+        ExRaiseStatus(STATUS_INSUFFICIENT_RESOURCES);
         return FALSE;
     }
 
@@ -103,9 +139,13 @@ CcMapData (
     iBcb->PFCB.MappedFileOffset = *FileOffset;
     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;
 }
 
@@ -121,7 +161,35 @@ CcPinMappedData (
     IN ULONG Flags,
     OUT        PVOID * Bcb)
 {
-    /* no-op for current implementation. */
+    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);
+
+    ASSERT(FileObject);
+    ASSERT(FileObject->SectionObjectPointer);
+    ASSERT(FileObject->SectionObjectPointer->SharedCacheMap);
+
+    SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
+    ASSERT(SharedCacheMap);
+    ASSERT(SharedCacheMap->PinAccess);
+
+    iBcb = *Bcb;
+    ASSERT(iBcb->Pinned == FALSE);
+
+    iBcb->Pinned = TRUE;
+    iBcb->Vacb->PinCount++;
+
+    if (Flags & PIN_EXCLUSIVE)
+    {
+        ExAcquireResourceExclusiveLite(&iBcb->Lock, TRUE);
+    }
+    else
+    {
+        ExAcquireResourceSharedLite(&iBcb->Lock, TRUE);
+    }
+
     return TRUE;
 }
 
@@ -138,14 +206,32 @@ CcPinRead (
     OUT        PVOID * Bcb,
     OUT        PVOID * Buffer)
 {
-    if (CcMapData(FileObject, FileOffset, Length, Flags, Bcb, Buffer))
+    CCTRACE(CC_API_DEBUG, "FileOffset=%p FileOffset=%p Length=%lu Flags=0x%lx\n",
+        FileObject, FileOffset, Length, Flags);
+
+    if (Flags & PIN_WAIT)
     {
-        if (CcPinMappedData(FileObject, FileOffset, Length, Flags, Bcb))
-            return TRUE;
-        else
-            CcUnpinData(Bcb);
+        ++CcPinReadWait;
+    }
+    else
+    {
+        ++CcPinReadNoWait;
+    }
+
+    /* Map first */
+    if (!CcMapData(FileObject, FileOffset, Length, Flags, Bcb, Buffer))
+    {
+        return FALSE;
     }
-    return FALSE;
+
+    /* Pin then */
+    if (!CcPinMappedData(FileObject, FileOffset, Length, Flags, Bcb))
+    {
+        CcUnpinData(*Bcb);
+        return FALSE;
+    }
+
+    return TRUE;
 }
 
 /*
@@ -162,10 +248,13 @@ CcPreparePinWrite (
     OUT        PVOID * Bcb,
     OUT        PVOID * 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 == TRUE.
+     * prepare the VACBs and zero them out if Zero != FALSE.
      *
      * For now calling CcPinRead is better than returning error or
      * just having UNIMPLEMENTED here.
@@ -182,7 +271,15 @@ CcSetDirtyPinnedData (
     IN PLARGE_INTEGER Lsn)
 {
     PINTERNAL_BCB iBcb = Bcb;
+
+    CCTRACE(CC_API_DEBUG, "Bcb=%p Lsn=%p\n",
+        Bcb, Lsn);
+
     iBcb->Dirty = TRUE;
+    if (!iBcb->Vacb->Dirty)
+    {
+        CcRosMarkDirtyVacb(iBcb->Vacb);
+    }
 }
 
 
@@ -193,17 +290,9 @@ VOID NTAPI
 CcUnpinData (
     IN PVOID Bcb)
 {
-    PINTERNAL_BCB iBcb = Bcb;
+    CCTRACE(CC_API_DEBUG, "Bcb=%p\n", Bcb);
 
-    CcRosReleaseVacb(iBcb->Vacb->SharedCacheMap,
-                     iBcb->Vacb,
-                     TRUE,
-                     iBcb->Dirty,
-                     FALSE);
-    if (--iBcb->RefCount == 0)
-    {
-        ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
-    }
+    CcUnpinDataForThread(Bcb, (ERESOURCE_THREAD)PsGetCurrentThread());
 }
 
 /*
@@ -215,7 +304,28 @@ CcUnpinDataForThread (
     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;
+        iBcb->Vacb->PinCount--;
+    }
+
+    if (--iBcb->RefCount == 0)
+    {
+        CcRosReleaseVacb(iBcb->Vacb->SharedCacheMap,
+                         iBcb->Vacb,
+                         TRUE,
+                         iBcb->Dirty,
+                         FALSE);
+
+        ExDeleteResourceLite(&iBcb->Lock);
+        ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
+    }
 }
 
 /*
@@ -227,6 +337,9 @@ CcRepinBcb (
     IN PVOID Bcb)
 {
     PINTERNAL_BCB iBcb = Bcb;
+
+    CCTRACE(CC_API_DEBUG, "Bcb=%p\n", Bcb);
+
     iBcb->RefCount++;
 }
 
@@ -242,17 +355,14 @@ CcUnpinRepinnedBcb (
 {
     PINTERNAL_BCB iBcb = Bcb;
 
+    CCTRACE(CC_API_DEBUG, "Bcb=%p WriteThrough=%d\n", Bcb, WriteThrough);
+
     IoStatus->Status = STATUS_SUCCESS;
     if (--iBcb->RefCount == 0)
     {
         IoStatus->Information = 0;
         if (WriteThrough)
         {
-            KeWaitForSingleObject(&iBcb->Vacb->Mutex,
-                                  Executive,
-                                  KernelMode,
-                                  FALSE,
-                                  NULL);
             if (iBcb->Vacb->Dirty)
             {
                 IoStatus->Status = CcRosFlushVacb(iBcb->Vacb);
@@ -261,13 +371,27 @@ CcUnpinRepinnedBcb (
             {
                 IoStatus->Status = STATUS_SUCCESS;
             }
-            KeReleaseMutex(&iBcb->Vacb->Mutex, FALSE);
         }
         else
         {
             IoStatus->Status = STATUS_SUCCESS;
         }
 
+        if (iBcb->Pinned)
+        {
+            ExReleaseResourceLite(&iBcb->Lock);
+            iBcb->Pinned = FALSE;
+            iBcb->Vacb->PinCount--;
+            ASSERT(iBcb->Vacb->PinCount == 0);
+        }
+
+        CcRosReleaseVacb(iBcb->Vacb->SharedCacheMap,
+                         iBcb->Vacb,
+                         TRUE,
+                         iBcb->Dirty,
+                         FALSE);
+
+        ExDeleteResourceLite(&iBcb->Lock);
         ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
     }
 }