[SHELL32] SHChangeNotify: Use tree for CDirectoryList (#6784)
[reactos.git] / ntoskrnl / cc / pin.c
index 044458f..dcd1d54 100644 (file)
@@ -67,91 +67,6 @@ CcpFindBcb(
     return (Found ? Bcb : NULL);
 }
 
-static
-BOOLEAN
-NTAPI
-CcpMapData(
-    IN PROS_SHARED_CACHE_MAP SharedCacheMap,
-    IN PLARGE_INTEGER FileOffset,
-    IN ULONG Length,
-    IN ULONG Flags,
-    OUT PROS_VACB *pVacb,
-    OUT PVOID *pBuffer)
-{
-    LONGLONG ReadOffset, BaseOffset;
-    BOOLEAN Valid;
-    PROS_VACB Vacb;
-    NTSTATUS Status;
-    LONGLONG ROffset;
-
-    ReadOffset = FileOffset->QuadPart;
-
-    DPRINT("SectionSize %I64x, FileSize %I64x\n",
-           SharedCacheMap->SectionSize.QuadPart,
-           SharedCacheMap->FileSize.QuadPart);
-
-    if (ReadOffset % VACB_MAPPING_GRANULARITY + Length > VACB_MAPPING_GRANULARITY)
-    {
-        CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
-            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++;
-        }
-    }
-
-    /* Properly round offset and call internal helper for getting a VACB */
-    ROffset = ROUND_DOWN(ReadOffset, VACB_MAPPING_GRANULARITY);
-    Status = CcRosGetVacb(SharedCacheMap,
-                          ROffset,
-                          &BaseOffset,
-                          pBuffer,
-                          &Valid,
-                          &Vacb);
-    if (!NT_SUCCESS(Status))
-    {
-        CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
-            SharedCacheMap->FileObject, FileOffset, Length, Flags);
-        ExRaiseStatus(Status);
-        return FALSE;
-    }
-
-    if (!Valid && BooleanFlagOn(Flags, MAP_NO_READ))
-    {
-        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",
-                SharedCacheMap->FileObject, FileOffset, Length, Flags);
-            return FALSE;
-        }
-
-        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",
-                SharedCacheMap->FileObject, FileOffset, Length, Flags);
-            ExRaiseStatus(Status);
-            return FALSE;
-        }
-    }
-
-    *pBuffer = (PUCHAR)*pBuffer + ReadOffset % VACB_MAPPING_GRANULARITY;
-    *pVacb = Vacb;
-
-    return TRUE;
-}
-
 static
 VOID
 CcpDereferenceBcb(
@@ -176,7 +91,6 @@ CcpDereferenceBcb(
          */
         CcRosReleaseVacb(SharedCacheMap,
                          Bcb->Vacb,
-                         TRUE,
                          FALSE,
                          FALSE);
 
@@ -206,17 +120,16 @@ CcpGetAppropriateBcb(
     iBcb = ExAllocateFromNPagedLookasideList(&iBcbLookasideList);
     if (iBcb == NULL)
     {
-        CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
+        CcRosReleaseVacb(SharedCacheMap, Vacb, FALSE, FALSE);
         return NULL;
     }
 
     RtlZeroMemory(iBcb, sizeof(*iBcb));
-    iBcb->PFCB.NodeTypeCode = 0xDE45; /* Undocumented (CAPTIVE_PUBLIC_BCB_NODETYPECODE) */
-    iBcb->PFCB.NodeByteSize = sizeof(PUBLIC_BCB);
+    iBcb->PFCB.NodeTypeCode = 0x2FD; /* As per KMTests */
+    iBcb->PFCB.NodeByteSize = 0;
     iBcb->PFCB.MappedLength = Length;
     iBcb->PFCB.MappedFileOffset = *FileOffset;
     iBcb->Vacb = Vacb;
-    iBcb->Dirty = FALSE;
     iBcb->PinCount = 0;
     iBcb->RefCount = 1;
     ExInitializeResourceLite(&iBcb->Lock);
@@ -258,7 +171,7 @@ CcpGetAppropriateBcb(
         if (DupBcb != NULL)
         {
             /* Delete the loser */
-            CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
+            CcRosReleaseVacb(SharedCacheMap, Vacb, FALSE, FALSE);
             ExDeleteResourceLite(&iBcb->Lock);
             ExFreeToNPagedLookasideList(&iBcbLookasideList, iBcb);
         }
@@ -305,44 +218,48 @@ CcpPinData(
     OUT        PVOID * Buffer)
 {
     PINTERNAL_BCB NewBcb;
-    BOOLEAN Result;
-    PROS_VACB Vacb;
     KIRQL OldIrql;
-    ULONG MapFlags;
+    ULONG VacbOffset;
+    NTSTATUS Status;
+    _SEH2_VOLATILE BOOLEAN Result;
+
+    VacbOffset = (ULONG)(FileOffset->QuadPart % VACB_MAPPING_GRANULARITY);
+
+    if ((VacbOffset + Length) > VACB_MAPPING_GRANULARITY)
+    {
+        /* Complain loudly, we shoud pin the whole range */
+        DPRINT1("TRUNCATING DATA PIN FROM %lu to %lu!\n", Length, VACB_MAPPING_GRANULARITY - VacbOffset);
+        Length = VACB_MAPPING_GRANULARITY - VacbOffset;
+    }
 
     KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
     NewBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, TRUE);
 
     if (NewBcb != NULL)
     {
+        BOOLEAN Result;
+
         ++NewBcb->RefCount;
         KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
 
         if (BooleanFlagOn(Flags, PIN_EXCLUSIVE))
-        {
             Result = ExAcquireResourceExclusiveLite(&NewBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
-        }
         else
-        {
             Result = ExAcquireSharedStarveExclusive(&NewBcb->Lock, BooleanFlagOn(Flags, PIN_WAIT));
-        }
 
         if (!Result)
         {
             CcpDereferenceBcb(SharedCacheMap, NewBcb);
-            NewBcb = NULL;
-        }
-        else
-        {
-            NewBcb->PinCount++;
-            *Bcb = NewBcb;
-            *Buffer = (PUCHAR)NewBcb->Vacb->BaseAddress + FileOffset->QuadPart % VACB_MAPPING_GRANULARITY;
+            return FALSE;
         }
 
-        return Result;
+        NewBcb->PinCount++;
     }
     else
     {
+        LONGLONG ROffset;
+        PROS_VACB Vacb;
+
         KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
 
         if (BooleanFlagOn(Flags, PIN_IF_BCB))
@@ -350,27 +267,52 @@ CcpPinData(
             return FALSE;
         }
 
-        MapFlags = Flags & PIN_WAIT;
-        if (BooleanFlagOn(Flags, PIN_NO_READ))
+        /* Properly round offset and call internal helper for getting a VACB */
+        ROffset = ROUND_DOWN(FileOffset->QuadPart, VACB_MAPPING_GRANULARITY);
+        Status = CcRosGetVacb(SharedCacheMap, ROffset, &Vacb);
+        if (!NT_SUCCESS(Status))
         {
-            SetFlag(MapFlags, MAP_NO_READ);
+            CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
+                SharedCacheMap->FileObject, FileOffset, Length, Flags);
+            ExRaiseStatus(Status);
+            return FALSE;
         }
 
-        Result = CcpMapData(SharedCacheMap, FileOffset, Length, MapFlags, &Vacb, Buffer);
-        if (Result)
+        NewBcb = CcpGetAppropriateBcb(SharedCacheMap, Vacb, FileOffset, Length, Flags, TRUE);
+        if (NewBcb == NULL)
         {
-            NewBcb = CcpGetAppropriateBcb(SharedCacheMap, Vacb, FileOffset, Length, Flags, TRUE);
-            if (NewBcb == NULL)
-            {
-                CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
-                Result = FALSE;
-            }
-            else
-            {
-                *Bcb = NewBcb;
-            }
+            CcRosReleaseVacb(SharedCacheMap, Vacb, FALSE, FALSE);
+            return FALSE;
+        }
+    }
+
+    Result = FALSE;
+    _SEH2_TRY
+    {
+        /* Ensure the pages are resident */
+        Result = CcRosEnsureVacbResident(NewBcb->Vacb,
+                BooleanFlagOn(Flags, PIN_WAIT),
+                BooleanFlagOn(Flags, PIN_NO_READ),
+                VacbOffset, Length);
+    }
+    _SEH2_FINALLY
+    {
+        if (!Result)
+        {
+            CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
+                            SharedCacheMap->FileObject, FileOffset, Length, Flags);
+            CcUnpinData(&NewBcb->PFCB);
+            *Bcb = NULL;
+            *Buffer = NULL;
         }
     }
+    _SEH2_END;
+
+    if (Result)
+    {
+        *Bcb = &NewBcb->PFCB;
+        *Buffer = (PVOID)((ULONG_PTR)NewBcb->Vacb->BaseAddress + VacbOffset);
+    }
 
     return Result;
 }
@@ -388,13 +330,15 @@ CcMapData (
     OUT PVOID *pBcb,
     OUT PVOID *pBuffer)
 {
-    BOOLEAN Ret;
     KIRQL OldIrql;
     PINTERNAL_BCB iBcb;
     PROS_VACB Vacb;
     PROS_SHARED_CACHE_MAP SharedCacheMap;
+    ULONG VacbOffset;
+    NTSTATUS Status;
+    _SEH2_VOLATILE BOOLEAN Result;
 
-    DPRINT("CcMapData(FileObject 0x%p, FileOffset %I64x, Length %lu, Flags 0x%lx,"
+    CCTRACE(CC_API_DEBUG, "CcMapData(FileObject 0x%p, FileOffset 0x%I64x, Length %lu, Flags 0x%lx,"
            " pBcb 0x%p, pBuffer 0x%p)\n", FileObject, FileOffset->QuadPart,
            Length, Flags, pBcb, pBuffer);
 
@@ -414,6 +358,14 @@ CcMapData (
         ++CcMapDataNoWait;
     }
 
+    VacbOffset = (ULONG)(FileOffset->QuadPart % VACB_MAPPING_GRANULARITY);
+    /* KMTests seem to show that it is allowed to call accross mapping granularity */
+    if ((VacbOffset + Length) > VACB_MAPPING_GRANULARITY)
+    {
+        DPRINT1("TRUNCATING DATA MAP FROM %lu to %lu!\n", Length, VACB_MAPPING_GRANULARITY - VacbOffset);
+        Length = VACB_MAPPING_GRANULARITY - VacbOffset;
+    }
+
     KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
     iBcb = CcpFindBcb(SharedCacheMap, FileOffset, Length, FALSE);
 
@@ -421,34 +373,58 @@ CcMapData (
     {
         KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
 
-        Ret = CcpMapData(SharedCacheMap, FileOffset, Length, Flags, &Vacb, pBuffer);
-        if (Ret)
+        /* Call internal helper for getting a VACB */
+        Status = CcRosGetVacb(SharedCacheMap, FileOffset->QuadPart, &Vacb);
+        if (!NT_SUCCESS(Status))
         {
-            iBcb = CcpGetAppropriateBcb(SharedCacheMap, Vacb, FileOffset, Length, 0, FALSE);
-            if (iBcb == NULL)
-            {
-                CcRosReleaseVacb(SharedCacheMap, Vacb, TRUE, FALSE, FALSE);
-                Ret = FALSE;
-            }
-            else
-            {
-                *pBcb = iBcb;
-            }
+            CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
+                SharedCacheMap->FileObject, FileOffset, Length, Flags);
+            ExRaiseStatus(Status);
+        }
+
+        iBcb = CcpGetAppropriateBcb(SharedCacheMap, Vacb, FileOffset, Length, 0, FALSE);
+        if (iBcb == NULL)
+        {
+            CcRosReleaseVacb(SharedCacheMap, Vacb, FALSE, FALSE);
+            CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
+                SharedCacheMap->FileObject, FileOffset, Length, Flags);
+            *pBcb = NULL; // If you ever remove this for compat, make sure to review all callers for using an unititialized value
+            ExRaiseStatus(STATUS_INSUFFICIENT_RESOURCES);
         }
     }
     else
     {
         ++iBcb->RefCount;
         KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
+    }
+
+    _SEH2_TRY
+    {
+        Result = FALSE;
+        /* Ensure the pages are resident */
+        Result = CcRosEnsureVacbResident(iBcb->Vacb, BooleanFlagOn(Flags, MAP_WAIT),
+                BooleanFlagOn(Flags, MAP_NO_READ), VacbOffset, Length);
+    }
+    _SEH2_FINALLY
+    {
+        if (!Result)
+        {
+            CcpDereferenceBcb(SharedCacheMap, iBcb);
+            *pBcb = NULL;
+            *pBuffer = NULL;
+        }
+    }
+    _SEH2_END;
 
-        *pBcb = iBcb;
-        *pBuffer = (PUCHAR)iBcb->Vacb->BaseAddress + FileOffset->QuadPart % VACB_MAPPING_GRANULARITY;
-        Ret = TRUE;
+    if (Result)
+    {
+        *pBcb = &iBcb->PFCB;
+        *pBuffer = (PVOID)((ULONG_PTR)iBcb->Vacb->BaseAddress + VacbOffset);
     }
 
-    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;
+    CCTRACE(CC_API_DEBUG, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> TRUE Bcb=%p, Buffer %p\n",
+        FileObject, FileOffset, Length, Flags, *pBcb, *pBuffer);
+    return Result;
 }
 
 /*
@@ -483,14 +459,14 @@ CcPinMappedData (
         return FALSE;
     }
 
-    iBcb = *Bcb;
+    iBcb = *Bcb ? CONTAINING_RECORD(*Bcb, INTERNAL_BCB, PFCB) : NULL;
 
     ++CcPinMappedDataCount;
 
     Result = CcpPinData(SharedCacheMap, FileOffset, Length, Flags, Bcb, &Buffer);
     if (Result)
     {
-        CcUnpinData(iBcb);
+        CcUnpinData(&iBcb->PFCB);
     }
 
     return Result;
@@ -574,12 +550,15 @@ CcSetDirtyPinnedData (
     IN PVOID Bcb,
     IN PLARGE_INTEGER Lsn)
 {
-    PINTERNAL_BCB iBcb = Bcb;
+    PINTERNAL_BCB iBcb = CONTAINING_RECORD(Bcb, INTERNAL_BCB, PFCB);
+
+    CCTRACE(CC_API_DEBUG, "Bcb=%p Lsn=%p\n", Bcb, Lsn);
 
-    CCTRACE(CC_API_DEBUG, "Bcb=%p Lsn=%p\n",
-        Bcb, Lsn);
+    /* Tell Mm */
+    MmMakePagesDirty(NULL,
+                     Add2Ptr(iBcb->Vacb->BaseAddress, iBcb->PFCB.MappedFileOffset.QuadPart - iBcb->Vacb->FileOffset.QuadPart),
+                     iBcb->PFCB.MappedLength);
 
-    iBcb->Dirty = TRUE;
     if (!iBcb->Vacb->Dirty)
     {
         CcRosMarkDirtyVacb(iBcb->Vacb);
@@ -608,8 +587,7 @@ CcUnpinDataForThread (
     IN PVOID Bcb,
     IN ERESOURCE_THREAD ResourceThreadId)
 {
-    PINTERNAL_BCB iBcb = Bcb;
-    PROS_SHARED_CACHE_MAP SharedCacheMap;
+    PINTERNAL_BCB iBcb = CONTAINING_RECORD(Bcb, INTERNAL_BCB, PFCB);
 
     CCTRACE(CC_API_DEBUG, "Bcb=%p ResourceThreadId=%lu\n", Bcb, ResourceThreadId);
 
@@ -619,8 +597,7 @@ CcUnpinDataForThread (
         iBcb->PinCount--;
     }
 
-    SharedCacheMap = iBcb->Vacb->SharedCacheMap;
-    CcpDereferenceBcb(SharedCacheMap, iBcb);
+    CcpDereferenceBcb(iBcb->Vacb->SharedCacheMap, iBcb);
 }
 
 /*
@@ -631,7 +608,7 @@ NTAPI
 CcRepinBcb (
     IN PVOID Bcb)
 {
-    PINTERNAL_BCB iBcb = Bcb;
+    PINTERNAL_BCB iBcb = CONTAINING_RECORD(Bcb, INTERNAL_BCB, PFCB);
 
     CCTRACE(CC_API_DEBUG, "Bcb=%p\n", Bcb);
 
@@ -648,7 +625,7 @@ CcUnpinRepinnedBcb (
     IN BOOLEAN WriteThrough,
     IN PIO_STATUS_BLOCK IoStatus)
 {
-    PINTERNAL_BCB iBcb = Bcb;
+    PINTERNAL_BCB iBcb = CONTAINING_RECORD(Bcb, INTERNAL_BCB, PFCB);
     KIRQL OldIrql;
     PROS_SHARED_CACHE_MAP SharedCacheMap;
 
@@ -657,29 +634,25 @@ CcUnpinRepinnedBcb (
     SharedCacheMap = iBcb->Vacb->SharedCacheMap;
     IoStatus->Status = STATUS_SUCCESS;
 
+    if (WriteThrough)
+    {
+        CcFlushCache(iBcb->Vacb->SharedCacheMap->FileObject->SectionObjectPointer,
+                     &iBcb->PFCB.MappedFileOffset,
+                     iBcb->PFCB.MappedLength,
+                     IoStatus);
+    }
+    else
+    {
+        IoStatus->Status = STATUS_SUCCESS;
+        IoStatus->Information = 0;
+    }
+
     KeAcquireSpinLock(&SharedCacheMap->BcbSpinLock, &OldIrql);
     if (--iBcb->RefCount == 0)
     {
         RemoveEntryList(&iBcb->BcbEntry);
         KeReleaseSpinLock(&SharedCacheMap->BcbSpinLock, OldIrql);
 
-        IoStatus->Information = 0;
-        if (WriteThrough)
-        {
-            if (iBcb->Vacb->Dirty)
-            {
-                IoStatus->Status = CcRosFlushVacb(iBcb->Vacb);
-            }
-            else
-            {
-                IoStatus->Status = STATUS_SUCCESS;
-            }
-        }
-        else
-        {
-            IoStatus->Status = STATUS_SUCCESS;
-        }
-
         if (iBcb->PinCount != 0)
         {
             ExReleaseResourceLite(&iBcb->Lock);
@@ -694,7 +667,6 @@ CcUnpinRepinnedBcb (
          */
         CcRosReleaseVacb(iBcb->Vacb->SharedCacheMap,
                          iBcb->Vacb,
-                         TRUE,
                          FALSE,
                          FALSE);