2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: ntoskrnl/cc/view.c
5 * PURPOSE: Cache manager
7 * PROGRAMMERS: David Welch (welch@mcmail.com)
8 * Pierre Schweitzer (pierre@reactos.org)
11 /* NOTES **********************************************************************
13 * This is not the NT implementation of a file cache nor anything much like
16 * The general procedure for a filesystem to implement a read or write
17 * dispatch routine is as follows
19 * (1) If caching for the FCB hasn't been initiated then so do by calling
20 * CcInitializeFileCache.
22 * (2) For each 4k region which is being read or written obtain a cache page
23 * by calling CcRequestCachePage.
25 * (3) If either the page is being read or not completely written, and it is
26 * not up to date then read its data from the underlying medium. If the read
27 * fails then call CcReleaseCachePage with VALID as FALSE and return a error.
29 * (4) Copy the data into or out of the page as necessary.
31 * (5) Release the cache page
33 /* INCLUDES ******************************************************************/
39 #if defined (ALLOC_PRAGMA)
40 #pragma alloc_text(INIT, CcInitView)
43 /* GLOBALS *******************************************************************/
45 LIST_ENTRY DirtyVacbListHead
;
46 static LIST_ENTRY VacbLruListHead
;
48 KGUARDED_MUTEX ViewLock
;
50 NPAGED_LOOKASIDE_LIST iBcbLookasideList
;
51 static NPAGED_LOOKASIDE_LIST SharedCacheMapLookasideList
;
52 static NPAGED_LOOKASIDE_LIST VacbLookasideList
;
54 /* Internal vars (MS):
55 * - Threshold above which lazy writer will start action
56 * - Amount of dirty pages
57 * - List for deferred writes
58 * - Spinlock when dealing with the deferred list
59 * - List for "clean" shared cache maps
61 ULONG CcDirtyPageThreshold
= 0;
62 ULONG CcTotalDirtyPages
= 0;
63 LIST_ENTRY CcDeferredWrites
;
64 KSPIN_LOCK CcDeferredWriteSpinLock
;
65 LIST_ENTRY CcCleanSharedCacheMapList
;
67 /* Internal vars (ROS):
68 * - Lock for the CcCleanSharedCacheMapList list
70 KSPIN_LOCK iSharedCacheMapLock
;
73 static void CcRosVacbIncRefCount_(PROS_VACB vacb
, const char* file
, int line
)
75 ++vacb
->ReferenceCount
;
76 if (vacb
->SharedCacheMap
->Trace
)
78 DbgPrint("(%s:%i) VACB %p ++RefCount=%lu, Dirty %u, PageOut %lu\n",
79 file
, line
, vacb
, vacb
->ReferenceCount
, vacb
->Dirty
, vacb
->PageOut
);
82 static void CcRosVacbDecRefCount_(PROS_VACB vacb
, const char* file
, int line
)
84 ASSERT(vacb
->ReferenceCount
!= 0);
85 --vacb
->ReferenceCount
;
86 ASSERT(!(vacb
->ReferenceCount
== 0 && vacb
->Dirty
));
87 if (vacb
->SharedCacheMap
->Trace
)
89 DbgPrint("(%s:%i) VACB %p --RefCount=%lu, Dirty %u, PageOut %lu\n",
90 file
, line
, vacb
, vacb
->ReferenceCount
, vacb
->Dirty
, vacb
->PageOut
);
93 #define CcRosVacbIncRefCount(vacb) CcRosVacbIncRefCount_(vacb,__FILE__,__LINE__)
94 #define CcRosVacbDecRefCount(vacb) CcRosVacbDecRefCount_(vacb,__FILE__,__LINE__)
96 #define CcRosVacbIncRefCount(vacb) (++((vacb)->ReferenceCount))
97 #define CcRosVacbDecRefCount(vacb) (--((vacb)->ReferenceCount))
101 CcRosInternalFreeVacb(PROS_VACB Vacb
);
104 /* FUNCTIONS *****************************************************************/
109 PROS_SHARED_CACHE_MAP SharedCacheMap
,
114 PLIST_ENTRY current_entry
;
120 SharedCacheMap
->Trace
= Trace
;
124 DPRINT1("Enabling Tracing for CacheMap 0x%p:\n", SharedCacheMap
);
126 KeAcquireGuardedMutex(&ViewLock
);
127 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldirql
);
129 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
130 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
132 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
133 current_entry
= current_entry
->Flink
;
135 DPRINT1(" VACB 0x%p enabled, RefCount %lu, Dirty %u, PageOut %lu\n",
136 current
, current
->ReferenceCount
, current
->Dirty
, current
->PageOut
);
138 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldirql
);
139 KeReleaseGuardedMutex(&ViewLock
);
143 DPRINT1("Disabling Tracing for CacheMap 0x%p:\n", SharedCacheMap
);
147 UNREFERENCED_PARAMETER(SharedCacheMap
);
148 UNREFERENCED_PARAMETER(Trace
);
159 Status
= CcWriteVirtualAddress(Vacb
);
160 if (NT_SUCCESS(Status
))
162 CcRosUnmarkDirtyVacb(Vacb
, TRUE
);
170 CcRosFlushDirtyPages (
174 BOOLEAN CalledFromLazy
)
176 PLIST_ENTRY current_entry
;
180 LARGE_INTEGER ZeroTimeout
;
182 DPRINT("CcRosFlushDirtyPages(Target %lu)\n", Target
);
185 ZeroTimeout
.QuadPart
= 0;
187 KeEnterCriticalRegion();
188 KeAcquireGuardedMutex(&ViewLock
);
190 current_entry
= DirtyVacbListHead
.Flink
;
191 if (current_entry
== &DirtyVacbListHead
)
193 DPRINT("No Dirty pages\n");
196 while ((current_entry
!= &DirtyVacbListHead
) && (Target
> 0))
198 current
= CONTAINING_RECORD(current_entry
,
201 current_entry
= current_entry
->Flink
;
203 CcRosVacbIncRefCount(current
);
205 /* When performing lazy write, don't handle temporary files */
206 if (CalledFromLazy
&&
207 BooleanFlagOn(current
->SharedCacheMap
->FileObject
->Flags
, FO_TEMPORARY_FILE
))
209 CcRosVacbDecRefCount(current
);
213 Locked
= current
->SharedCacheMap
->Callbacks
->AcquireForLazyWrite(
214 current
->SharedCacheMap
->LazyWriteContext
, Wait
);
217 CcRosVacbDecRefCount(current
);
221 Status
= CcRosAcquireVacbLock(current
,
222 Wait
? NULL
: &ZeroTimeout
);
223 if (Status
!= STATUS_SUCCESS
)
225 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
226 current
->SharedCacheMap
->LazyWriteContext
);
227 CcRosVacbDecRefCount(current
);
231 ASSERT(current
->Dirty
);
233 /* One reference is added above */
234 if ((current
->ReferenceCount
> 2 && current
->PinCount
== 0) ||
235 (current
->ReferenceCount
> 3 && current
->PinCount
> 1))
237 CcRosReleaseVacbLock(current
);
238 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
239 current
->SharedCacheMap
->LazyWriteContext
);
240 CcRosVacbDecRefCount(current
);
244 KeReleaseGuardedMutex(&ViewLock
);
246 Status
= CcRosFlushVacb(current
);
248 CcRosReleaseVacbLock(current
);
249 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
250 current
->SharedCacheMap
->LazyWriteContext
);
252 KeAcquireGuardedMutex(&ViewLock
);
253 CcRosVacbDecRefCount(current
);
255 if (!NT_SUCCESS(Status
) && (Status
!= STATUS_END_OF_FILE
) &&
256 (Status
!= STATUS_MEDIA_WRITE_PROTECTED
))
258 DPRINT1("CC: Failed to flush VACB.\n");
264 /* How many pages did we free? */
265 PagesFreed
= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
266 (*Count
) += PagesFreed
;
268 /* Make sure we don't overflow target! */
269 if (Target
< PagesFreed
)
271 /* If we would have, jump to zero directly */
276 Target
-= PagesFreed
;
280 current_entry
= DirtyVacbListHead
.Flink
;
283 KeReleaseGuardedMutex(&ViewLock
);
284 KeLeaveCriticalRegion();
286 DPRINT("CcRosFlushDirtyPages() finished\n");
287 return STATUS_SUCCESS
;
296 * FUNCTION: Try to free some memory from the file cache.
298 * Target - The number of pages to be freed.
299 * Priority - The priority of free (currently unused).
300 * NrFreed - Points to a variable where the number of pages
301 * actually freed is returned.
304 PLIST_ENTRY current_entry
;
311 BOOLEAN FlushedPages
= FALSE
;
313 DPRINT("CcRosTrimCache(Target %lu)\n", Target
);
315 InitializeListHead(&FreeList
);
320 KeAcquireGuardedMutex(&ViewLock
);
322 current_entry
= VacbLruListHead
.Flink
;
323 while (current_entry
!= &VacbLruListHead
)
325 current
= CONTAINING_RECORD(current_entry
,
328 current_entry
= current_entry
->Flink
;
330 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
332 /* Reference the VACB */
333 CcRosVacbIncRefCount(current
);
335 /* Check if it's mapped and not dirty */
336 if (current
->MappedCount
> 0 && !current
->Dirty
)
338 /* We have to break these locks because Cc sucks */
339 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
340 KeReleaseGuardedMutex(&ViewLock
);
342 /* Page out the VACB */
343 for (i
= 0; i
< VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
; i
++)
345 Page
= (PFN_NUMBER
)(MmGetPhysicalAddress((PUCHAR
)current
->BaseAddress
+ (i
* PAGE_SIZE
)).QuadPart
>> PAGE_SHIFT
);
347 MmPageOutPhysicalAddress(Page
);
350 /* Reacquire the locks */
351 KeAcquireGuardedMutex(&ViewLock
);
352 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
355 /* Dereference the VACB */
356 CcRosVacbDecRefCount(current
);
358 /* Check if we can free this entry now */
359 if (current
->ReferenceCount
== 0)
361 ASSERT(!current
->Dirty
);
362 ASSERT(!current
->MappedCount
);
364 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
365 RemoveEntryList(¤t
->VacbLruListEntry
);
366 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
368 /* Calculate how many pages we freed for Mm */
369 PagesFreed
= min(VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
, Target
);
370 Target
-= PagesFreed
;
371 (*NrFreed
) += PagesFreed
;
374 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
377 KeReleaseGuardedMutex(&ViewLock
);
379 /* Try flushing pages if we haven't met our target */
380 if ((Target
> 0) && !FlushedPages
)
382 /* Flush dirty pages to disk */
383 CcRosFlushDirtyPages(Target
, &PagesFreed
, FALSE
, FALSE
);
386 /* We can only swap as many pages as we flushed */
387 if (PagesFreed
< Target
) Target
= PagesFreed
;
389 /* Check if we flushed anything */
392 /* Try again after flushing dirty pages */
393 DPRINT("Flushed %lu dirty cache pages to disk\n", PagesFreed
);
398 while (!IsListEmpty(&FreeList
))
400 current_entry
= RemoveHeadList(&FreeList
);
401 current
= CONTAINING_RECORD(current_entry
,
403 CacheMapVacbListEntry
);
404 CcRosInternalFreeVacb(current
);
407 DPRINT("Evicted %lu cache pages\n", (*NrFreed
));
409 return STATUS_SUCCESS
;
415 PROS_SHARED_CACHE_MAP SharedCacheMap
,
421 ASSERT(SharedCacheMap
);
423 DPRINT("CcRosReleaseVacb(SharedCacheMap 0x%p, Vacb 0x%p, Valid %u)\n",
424 SharedCacheMap
, Vacb
, Valid
);
428 if (Dirty
&& !Vacb
->Dirty
)
430 CcRosMarkDirtyVacb(Vacb
);
437 CcRosVacbDecRefCount(Vacb
);
438 if (Mapped
&& (Vacb
->MappedCount
== 1))
440 CcRosVacbIncRefCount(Vacb
);
443 CcRosReleaseVacbLock(Vacb
);
445 return STATUS_SUCCESS
;
448 /* Returns with VACB Lock Held! */
452 PROS_SHARED_CACHE_MAP SharedCacheMap
,
455 PLIST_ENTRY current_entry
;
459 ASSERT(SharedCacheMap
);
461 DPRINT("CcRosLookupVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
462 SharedCacheMap
, FileOffset
);
464 KeAcquireGuardedMutex(&ViewLock
);
465 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
467 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
468 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
470 current
= CONTAINING_RECORD(current_entry
,
472 CacheMapVacbListEntry
);
473 if (IsPointInRange(current
->FileOffset
.QuadPart
,
474 VACB_MAPPING_GRANULARITY
,
477 CcRosVacbIncRefCount(current
);
478 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
479 KeReleaseGuardedMutex(&ViewLock
);
480 CcRosAcquireVacbLock(current
, NULL
);
483 if (current
->FileOffset
.QuadPart
> FileOffset
)
485 current_entry
= current_entry
->Flink
;
488 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
489 KeReleaseGuardedMutex(&ViewLock
);
500 PROS_SHARED_CACHE_MAP SharedCacheMap
;
502 SharedCacheMap
= Vacb
->SharedCacheMap
;
504 KeAcquireGuardedMutex(&ViewLock
);
505 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
507 ASSERT(!Vacb
->Dirty
);
509 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
510 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
511 Vacb
->SharedCacheMap
->DirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
512 CcRosVacbIncRefCount(Vacb
);
514 /* Move to the tail of the LRU list */
515 RemoveEntryList(&Vacb
->VacbLruListEntry
);
516 InsertTailList(&VacbLruListHead
, &Vacb
->VacbLruListEntry
);
520 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
521 KeReleaseGuardedMutex(&ViewLock
);
523 /* Schedule a lazy writer run to now that we have dirty VACB */
524 oldIrql
= KeAcquireQueuedSpinLock(LockQueueMasterLock
);
525 if (!LazyWriter
.ScanActive
)
527 CcScheduleLazyWriteScan(FALSE
);
529 KeReleaseQueuedSpinLock(LockQueueMasterLock
, oldIrql
);
534 CcRosUnmarkDirtyVacb (
539 PROS_SHARED_CACHE_MAP SharedCacheMap
;
541 SharedCacheMap
= Vacb
->SharedCacheMap
;
545 KeAcquireGuardedMutex(&ViewLock
);
546 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
553 RemoveEntryList(&Vacb
->DirtyVacbListEntry
);
554 CcTotalDirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
555 Vacb
->SharedCacheMap
->DirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
556 CcRosVacbDecRefCount(Vacb
);
560 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
561 KeReleaseGuardedMutex(&ViewLock
);
568 PROS_SHARED_CACHE_MAP SharedCacheMap
,
573 ASSERT(SharedCacheMap
);
575 DPRINT("CcRosMarkDirtyVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
576 SharedCacheMap
, FileOffset
);
578 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
581 KeBugCheck(CACHE_MANAGER
);
586 CcRosMarkDirtyVacb(Vacb
);
589 CcRosReleaseVacbLock(Vacb
);
591 return STATUS_SUCCESS
;
597 PROS_SHARED_CACHE_MAP SharedCacheMap
,
603 ASSERT(SharedCacheMap
);
605 DPRINT("CcRosUnmapVacb(SharedCacheMap 0x%p, FileOffset %I64u, NowDirty %u)\n",
606 SharedCacheMap
, FileOffset
, NowDirty
);
608 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
611 return STATUS_UNSUCCESSFUL
;
614 if (NowDirty
&& !Vacb
->Dirty
)
616 CcRosMarkDirtyVacb(Vacb
);
619 ASSERT(Vacb
->MappedCount
!= 0);
622 CcRosVacbDecRefCount(Vacb
);
623 if (Vacb
->MappedCount
== 0)
625 CcRosVacbDecRefCount(Vacb
);
628 CcRosReleaseVacbLock(Vacb
);
630 return STATUS_SUCCESS
;
640 ULONG_PTR NumberOfPages
;
642 /* Create a memory area. */
643 MmLockAddressSpace(MmGetKernelAddressSpace());
644 Status
= MmCreateMemoryArea(MmGetKernelAddressSpace(),
645 0, // nothing checks for VACB mareas, so set to 0
647 VACB_MAPPING_GRANULARITY
,
649 (PMEMORY_AREA
*)&Vacb
->MemoryArea
,
652 MmUnlockAddressSpace(MmGetKernelAddressSpace());
653 if (!NT_SUCCESS(Status
))
655 DPRINT1("MmCreateMemoryArea failed with %lx for VACB %p\n", Status
, Vacb
);
659 ASSERT(((ULONG_PTR
)Vacb
->BaseAddress
% PAGE_SIZE
) == 0);
660 ASSERT((ULONG_PTR
)Vacb
->BaseAddress
> (ULONG_PTR
)MmSystemRangeStart
);
662 /* Create a virtual mapping for this memory area */
663 NumberOfPages
= BYTES_TO_PAGES(VACB_MAPPING_GRANULARITY
);
664 for (i
= 0; i
< NumberOfPages
; i
++)
666 PFN_NUMBER PageFrameNumber
;
668 MI_SET_USAGE(MI_USAGE_CACHE
);
669 Status
= MmRequestPageMemoryConsumer(MC_CACHE
, TRUE
, &PageFrameNumber
);
670 if (PageFrameNumber
== 0)
672 DPRINT1("Unable to allocate page\n");
673 KeBugCheck(MEMORY_MANAGEMENT
);
676 Status
= MmCreateVirtualMapping(NULL
,
677 (PVOID
)((ULONG_PTR
)Vacb
->BaseAddress
+ (i
* PAGE_SIZE
)),
681 if (!NT_SUCCESS(Status
))
683 DPRINT1("Unable to create virtual mapping\n");
684 KeBugCheck(MEMORY_MANAGEMENT
);
688 return STATUS_SUCCESS
;
694 PROS_SHARED_CACHE_MAP SharedCacheMap
,
700 PLIST_ENTRY current_entry
;
704 ASSERT(SharedCacheMap
);
706 DPRINT("CcRosCreateVacb()\n");
708 if (FileOffset
>= SharedCacheMap
->SectionSize
.QuadPart
)
711 return STATUS_INVALID_PARAMETER
;
714 current
= ExAllocateFromNPagedLookasideList(&VacbLookasideList
);
715 current
->BaseAddress
= NULL
;
716 current
->Valid
= FALSE
;
717 current
->Dirty
= FALSE
;
718 current
->PageOut
= FALSE
;
719 current
->FileOffset
.QuadPart
= ROUND_DOWN(FileOffset
, VACB_MAPPING_GRANULARITY
);
720 current
->SharedCacheMap
= SharedCacheMap
;
722 if (SharedCacheMap
->Trace
)
724 DPRINT1("CacheMap 0x%p: new VACB: 0x%p\n", SharedCacheMap
, current
);
727 current
->MappedCount
= 0;
728 current
->DirtyVacbListEntry
.Flink
= NULL
;
729 current
->DirtyVacbListEntry
.Blink
= NULL
;
730 current
->ReferenceCount
= 1;
731 current
->PinCount
= 0;
732 KeInitializeMutex(¤t
->Mutex
, 0);
733 CcRosAcquireVacbLock(current
, NULL
);
734 KeAcquireGuardedMutex(&ViewLock
);
737 /* There is window between the call to CcRosLookupVacb
738 * and CcRosCreateVacb. We must check if a VACB for the
739 * file offset exist. If there is a VACB, we release
740 * our newly created VACB and return the existing one.
742 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
743 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
745 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
747 current
= CONTAINING_RECORD(current_entry
,
749 CacheMapVacbListEntry
);
750 if (IsPointInRange(current
->FileOffset
.QuadPart
,
751 VACB_MAPPING_GRANULARITY
,
754 CcRosVacbIncRefCount(current
);
755 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
757 if (SharedCacheMap
->Trace
)
759 DPRINT1("CacheMap 0x%p: deleting newly created VACB 0x%p ( found existing one 0x%p )\n",
765 CcRosReleaseVacbLock(*Vacb
);
766 KeReleaseGuardedMutex(&ViewLock
);
767 ExFreeToNPagedLookasideList(&VacbLookasideList
, *Vacb
);
769 CcRosAcquireVacbLock(current
, NULL
);
770 return STATUS_SUCCESS
;
772 if (current
->FileOffset
.QuadPart
< FileOffset
)
774 ASSERT(previous
== NULL
||
775 previous
->FileOffset
.QuadPart
< current
->FileOffset
.QuadPart
);
778 if (current
->FileOffset
.QuadPart
> FileOffset
)
780 current_entry
= current_entry
->Flink
;
782 /* There was no existing VACB. */
786 InsertHeadList(&previous
->CacheMapVacbListEntry
, ¤t
->CacheMapVacbListEntry
);
790 InsertHeadList(&SharedCacheMap
->CacheMapVacbListHead
, ¤t
->CacheMapVacbListEntry
);
792 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
793 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
794 KeReleaseGuardedMutex(&ViewLock
);
796 MI_SET_USAGE(MI_USAGE_CACHE
);
798 if ((SharedCacheMap
->FileObject
) && (SharedCacheMap
->FileObject
->FileName
.Buffer
))
802 pos
= wcsrchr(SharedCacheMap
->FileObject
->FileName
.Buffer
, '\\');
805 len
= wcslen(pos
) * sizeof(WCHAR
);
806 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%S", pos
);
810 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%wZ", &SharedCacheMap
->FileObject
->FileName
);
815 Status
= CcRosMapVacb(current
);
816 if (!NT_SUCCESS(Status
))
818 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
819 RemoveEntryList(¤t
->VacbLruListEntry
);
820 CcRosReleaseVacbLock(current
);
821 ExFreeToNPagedLookasideList(&VacbLookasideList
, current
);
830 PROS_SHARED_CACHE_MAP SharedCacheMap
,
832 PLONGLONG BaseOffset
,
840 ASSERT(SharedCacheMap
);
842 DPRINT("CcRosGetVacb()\n");
845 * Look for a VACB already mapping the same data.
847 current
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
851 * Otherwise create a new VACB.
853 Status
= CcRosCreateVacb(SharedCacheMap
, FileOffset
, ¤t
);
854 if (!NT_SUCCESS(Status
))
860 KeAcquireGuardedMutex(&ViewLock
);
862 /* Move to the tail of the LRU list */
863 RemoveEntryList(¤t
->VacbLruListEntry
);
864 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
866 KeReleaseGuardedMutex(&ViewLock
);
869 * Return information about the VACB to the caller.
871 *UptoDate
= current
->Valid
;
872 *BaseAddress
= current
->BaseAddress
;
873 DPRINT("*BaseAddress %p\n", *BaseAddress
);
875 *BaseOffset
= current
->FileOffset
.QuadPart
;
876 return STATUS_SUCCESS
;
882 PROS_SHARED_CACHE_MAP SharedCacheMap
,
888 * FUNCTION: Request a page mapping for a shared cache map
893 ASSERT(SharedCacheMap
);
895 if (FileOffset
% VACB_MAPPING_GRANULARITY
!= 0)
897 DPRINT1("Bad fileoffset %I64x should be multiple of %x",
898 FileOffset
, VACB_MAPPING_GRANULARITY
);
899 KeBugCheck(CACHE_MANAGER
);
902 return CcRosGetVacb(SharedCacheMap
,
914 MEMORY_AREA
* MemoryArea
,
920 ASSERT(SwapEntry
== 0);
923 ASSERT(MmGetReferenceCountPage(Page
) == 1);
924 MmReleasePageMemoryConsumer(MC_CACHE
, Page
);
929 CcRosInternalFreeVacb (
932 * FUNCTION: Releases a VACB associated with a shared cache map
935 DPRINT("Freeing VACB 0x%p\n", Vacb
);
937 if (Vacb
->SharedCacheMap
->Trace
)
939 DPRINT1("CacheMap 0x%p: deleting VACB: 0x%p\n", Vacb
->SharedCacheMap
, Vacb
);
943 MmLockAddressSpace(MmGetKernelAddressSpace());
944 MmFreeMemoryArea(MmGetKernelAddressSpace(),
948 MmUnlockAddressSpace(MmGetKernelAddressSpace());
950 ExFreeToNPagedLookasideList(&VacbLookasideList
, Vacb
);
951 return STATUS_SUCCESS
;
960 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
,
961 IN PLARGE_INTEGER FileOffset OPTIONAL
,
963 OUT PIO_STATUS_BLOCK IoStatus
)
965 PROS_SHARED_CACHE_MAP SharedCacheMap
;
966 LARGE_INTEGER Offset
;
967 LONGLONG RemainingLength
;
972 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p FileOffset=%p Length=%lu\n",
973 SectionObjectPointers
, FileOffset
, Length
);
975 DPRINT("CcFlushCache(SectionObjectPointers 0x%p, FileOffset 0x%p, Length %lu, IoStatus 0x%p)\n",
976 SectionObjectPointers
, FileOffset
, Length
, IoStatus
);
978 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
980 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
981 ASSERT(SharedCacheMap
);
984 Offset
= *FileOffset
;
985 RemainingLength
= Length
;
990 RemainingLength
= SharedCacheMap
->FileSize
.QuadPart
;
995 IoStatus
->Status
= STATUS_SUCCESS
;
996 IoStatus
->Information
= 0;
999 while (RemainingLength
> 0)
1001 current
= CcRosLookupVacb(SharedCacheMap
, Offset
.QuadPart
);
1002 if (current
!= NULL
)
1006 Status
= CcRosFlushVacb(current
);
1007 if (!NT_SUCCESS(Status
) && IoStatus
!= NULL
)
1009 IoStatus
->Status
= Status
;
1013 CcRosReleaseVacbLock(current
);
1015 KeAcquireGuardedMutex(&ViewLock
);
1016 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1017 CcRosVacbDecRefCount(current
);
1018 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1019 KeReleaseGuardedMutex(&ViewLock
);
1022 Offset
.QuadPart
+= VACB_MAPPING_GRANULARITY
;
1023 RemainingLength
-= min(RemainingLength
, VACB_MAPPING_GRANULARITY
);
1030 IoStatus
->Status
= STATUS_INVALID_PARAMETER
;
1037 CcRosDeleteFileCache (
1038 PFILE_OBJECT FileObject
,
1039 PROS_SHARED_CACHE_MAP SharedCacheMap
)
1041 * FUNCTION: Releases the shared cache map associated with a file object
1044 PLIST_ENTRY current_entry
;
1046 LIST_ENTRY FreeList
;
1049 ASSERT(SharedCacheMap
);
1051 SharedCacheMap
->OpenCount
++;
1052 KeReleaseGuardedMutex(&ViewLock
);
1054 CcFlushCache(FileObject
->SectionObjectPointer
, NULL
, 0, NULL
);
1056 KeAcquireGuardedMutex(&ViewLock
);
1057 SharedCacheMap
->OpenCount
--;
1058 if (SharedCacheMap
->OpenCount
== 0)
1062 FileObject
->SectionObjectPointer
->SharedCacheMap
= NULL
;
1067 InitializeListHead(&FreeList
);
1068 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1069 while (!IsListEmpty(&SharedCacheMap
->CacheMapVacbListHead
))
1071 current_entry
= RemoveTailList(&SharedCacheMap
->CacheMapVacbListHead
);
1072 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1074 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1075 CcRosAcquireVacbLock(current
, NULL
);
1076 RemoveEntryList(¤t
->VacbLruListEntry
);
1079 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1080 CcRosUnmarkDirtyVacb(current
, FALSE
);
1081 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1082 DPRINT1("Freeing dirty VACB\n");
1084 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
1085 CcRosReleaseVacbLock(current
);
1087 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1090 SharedCacheMap
->Trace
= FALSE
;
1092 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1094 KeReleaseGuardedMutex(&ViewLock
);
1095 ObDereferenceObject(SharedCacheMap
->FileObject
);
1097 while (!IsListEmpty(&FreeList
))
1099 current_entry
= RemoveTailList(&FreeList
);
1100 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1101 CcRosInternalFreeVacb(current
);
1104 KeAcquireSpinLock(&iSharedCacheMapLock
, &OldIrql
);
1105 RemoveEntryList(&SharedCacheMap
->SharedCacheMapLinks
);
1106 KeReleaseSpinLock(&iSharedCacheMapLock
, OldIrql
);
1108 ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList
, SharedCacheMap
);
1109 KeAcquireGuardedMutex(&ViewLock
);
1111 return STATUS_SUCCESS
;
1116 CcRosReferenceCache (
1117 PFILE_OBJECT FileObject
)
1119 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1120 KeAcquireGuardedMutex(&ViewLock
);
1121 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1122 ASSERT(SharedCacheMap
);
1123 ASSERT(SharedCacheMap
->OpenCount
!= 0);
1124 SharedCacheMap
->OpenCount
++;
1125 KeReleaseGuardedMutex(&ViewLock
);
1130 CcRosRemoveIfClosed (
1131 PSECTION_OBJECT_POINTERS SectionObjectPointer
)
1133 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1134 DPRINT("CcRosRemoveIfClosed()\n");
1135 KeAcquireGuardedMutex(&ViewLock
);
1136 SharedCacheMap
= SectionObjectPointer
->SharedCacheMap
;
1137 if (SharedCacheMap
&& SharedCacheMap
->OpenCount
== 0)
1139 CcRosDeleteFileCache(SharedCacheMap
->FileObject
, SharedCacheMap
);
1141 KeReleaseGuardedMutex(&ViewLock
);
1147 CcRosDereferenceCache (
1148 PFILE_OBJECT FileObject
)
1150 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1151 KeAcquireGuardedMutex(&ViewLock
);
1152 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1153 ASSERT(SharedCacheMap
);
1154 if (SharedCacheMap
->OpenCount
> 0)
1156 SharedCacheMap
->OpenCount
--;
1157 if (SharedCacheMap
->OpenCount
== 0)
1159 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1160 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1163 KeReleaseGuardedMutex(&ViewLock
);
1168 CcRosReleaseFileCache (
1169 PFILE_OBJECT FileObject
)
1171 * FUNCTION: Called by the file system when a handle to a file object
1175 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1177 KeAcquireGuardedMutex(&ViewLock
);
1179 if (FileObject
->SectionObjectPointer
->SharedCacheMap
!= NULL
)
1181 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1182 if (FileObject
->PrivateCacheMap
!= NULL
)
1184 FileObject
->PrivateCacheMap
= NULL
;
1185 if (SharedCacheMap
->OpenCount
> 0)
1187 SharedCacheMap
->OpenCount
--;
1188 if (SharedCacheMap
->OpenCount
== 0)
1190 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1191 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1196 KeReleaseGuardedMutex(&ViewLock
);
1197 return STATUS_SUCCESS
;
1202 CcRosInitializeFileCache (
1203 PFILE_OBJECT FileObject
,
1204 PCC_FILE_SIZES FileSizes
,
1206 PCACHE_MANAGER_CALLBACKS CallBacks
,
1207 PVOID LazyWriterContext
)
1209 * FUNCTION: Initializes a shared cache map for a file object
1214 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1216 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1217 DPRINT("CcRosInitializeFileCache(FileObject 0x%p, SharedCacheMap 0x%p)\n",
1218 FileObject
, SharedCacheMap
);
1221 KeAcquireGuardedMutex(&ViewLock
);
1222 if (SharedCacheMap
== NULL
)
1225 SharedCacheMap
= ExAllocateFromNPagedLookasideList(&SharedCacheMapLookasideList
);
1226 if (SharedCacheMap
== NULL
)
1228 KeReleaseGuardedMutex(&ViewLock
);
1229 return STATUS_INSUFFICIENT_RESOURCES
;
1231 RtlZeroMemory(SharedCacheMap
, sizeof(*SharedCacheMap
));
1232 ObReferenceObjectByPointer(FileObject
,
1236 SharedCacheMap
->FileObject
= FileObject
;
1237 SharedCacheMap
->Callbacks
= CallBacks
;
1238 SharedCacheMap
->LazyWriteContext
= LazyWriterContext
;
1239 SharedCacheMap
->SectionSize
= FileSizes
->AllocationSize
;
1240 SharedCacheMap
->FileSize
= FileSizes
->FileSize
;
1241 SharedCacheMap
->PinAccess
= PinAccess
;
1242 SharedCacheMap
->DirtyPageThreshold
= 0;
1243 SharedCacheMap
->DirtyPages
= 0;
1244 InitializeListHead(&SharedCacheMap
->PrivateList
);
1245 KeInitializeSpinLock(&SharedCacheMap
->CacheMapLock
);
1246 InitializeListHead(&SharedCacheMap
->CacheMapVacbListHead
);
1247 FileObject
->SectionObjectPointer
->SharedCacheMap
= SharedCacheMap
;
1249 KeAcquireSpinLock(&iSharedCacheMapLock
, &OldIrql
);
1250 InsertTailList(&CcCleanSharedCacheMapList
, &SharedCacheMap
->SharedCacheMapLinks
);
1251 KeReleaseSpinLock(&iSharedCacheMapLock
, OldIrql
);
1253 if (FileObject
->PrivateCacheMap
== NULL
)
1255 PPRIVATE_CACHE_MAP PrivateMap
;
1257 /* Allocate the private cache map for this handle */
1258 PrivateMap
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(PRIVATE_CACHE_MAP
), 'cPcC');
1259 if (PrivateMap
== NULL
)
1261 /* If we also allocated the shared cache map for this file, kill it */
1264 KeAcquireSpinLock(&iSharedCacheMapLock
, &OldIrql
);
1265 RemoveEntryList(&SharedCacheMap
->SharedCacheMapLinks
);
1266 KeReleaseSpinLock(&iSharedCacheMapLock
, OldIrql
);
1268 FileObject
->SectionObjectPointer
->SharedCacheMap
= NULL
;
1269 ObDereferenceObject(FileObject
);
1270 ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList
, SharedCacheMap
);
1273 KeReleaseGuardedMutex(&ViewLock
);
1274 return STATUS_INSUFFICIENT_RESOURCES
;
1278 RtlZeroMemory(PrivateMap
, sizeof(PRIVATE_CACHE_MAP
));
1279 PrivateMap
->NodeTypeCode
= NODE_TYPE_PRIVATE_MAP
;
1280 PrivateMap
->ReadAheadMask
= PAGE_SIZE
- 1;
1281 PrivateMap
->FileObject
= FileObject
;
1283 /* Link it to the file */
1284 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &OldIrql
);
1285 InsertTailList(&SharedCacheMap
->PrivateList
, &PrivateMap
->PrivateLinks
);
1286 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, OldIrql
);
1288 FileObject
->PrivateCacheMap
= PrivateMap
;
1289 SharedCacheMap
->OpenCount
++;
1291 KeReleaseGuardedMutex(&ViewLock
);
1293 return STATUS_SUCCESS
;
1301 CcGetFileObjectFromSectionPtrs (
1302 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
)
1304 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1306 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p\n", SectionObjectPointers
);
1308 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1310 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
1311 ASSERT(SharedCacheMap
);
1312 return SharedCacheMap
->FileObject
;
1323 DPRINT("CcInitView()\n");
1325 InitializeListHead(&DirtyVacbListHead
);
1326 InitializeListHead(&VacbLruListHead
);
1327 InitializeListHead(&CcDeferredWrites
);
1328 InitializeListHead(&CcCleanSharedCacheMapList
);
1329 KeInitializeSpinLock(&CcDeferredWriteSpinLock
);
1330 KeInitializeSpinLock(&iSharedCacheMapLock
);
1331 KeInitializeGuardedMutex(&ViewLock
);
1332 ExInitializeNPagedLookasideList(&iBcbLookasideList
,
1336 sizeof(INTERNAL_BCB
),
1339 ExInitializeNPagedLookasideList(&SharedCacheMapLookasideList
,
1343 sizeof(ROS_SHARED_CACHE_MAP
),
1344 TAG_SHARED_CACHE_MAP
,
1346 ExInitializeNPagedLookasideList(&VacbLookasideList
,
1354 MmInitializeMemoryConsumer(MC_CACHE
, CcRosTrimCache
);
1356 CcInitCacheZeroPage();
1359 #if DBG && defined(KDBG)
1361 ExpKdbgExtFileCache(ULONG Argc
, PCHAR Argv
[])
1363 PLIST_ENTRY ListEntry
;
1364 UNICODE_STRING NoName
= RTL_CONSTANT_STRING(L
"No name for File");
1366 KdbpPrint(" Usage Summary (in kb)\n");
1367 KdbpPrint("Shared\t\tValid\tDirty\tName\n");
1368 /* No need to lock the spin lock here, we're in DBG */
1369 for (ListEntry
= CcCleanSharedCacheMapList
.Flink
;
1370 ListEntry
!= &CcCleanSharedCacheMapList
;
1371 ListEntry
= ListEntry
->Flink
)
1374 ULONG Valid
= 0, Dirty
= 0;
1375 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1376 PUNICODE_STRING FileName
;
1378 SharedCacheMap
= CONTAINING_RECORD(ListEntry
, ROS_SHARED_CACHE_MAP
, SharedCacheMapLinks
);
1381 Dirty
= (SharedCacheMap
->DirtyPages
* PAGE_SIZE
) / 1024;
1383 /* First, count for all the associated VACB */
1384 for (Vacbs
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
1385 Vacbs
!= &SharedCacheMap
->CacheMapVacbListHead
;
1386 Vacbs
= Vacbs
->Flink
)
1390 Vacb
= CONTAINING_RECORD(Vacbs
, ROS_VACB
, CacheMapVacbListEntry
);
1393 Valid
+= VACB_MAPPING_GRANULARITY
/ 1024;
1398 if (SharedCacheMap
->FileObject
!= NULL
&&
1399 SharedCacheMap
->FileObject
->FileName
.Length
!= 0)
1401 FileName
= &SharedCacheMap
->FileObject
->FileName
;
1409 KdbpPrint("%p\t%d\t%d\t%wZ\n", SharedCacheMap
, Valid
, Dirty
, FileName
);