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
;
55 * - Amount of pages flushed by lazy writer
56 * - Number of times lazy writer ran
58 ULONG CcLazyWritePages
= 0;
59 ULONG CcLazyWriteIos
= 0;
61 /* Internal vars (MS):
62 * - Threshold above which lazy writer will start action
63 * - Amount of dirty pages
64 * - List for deferred writes
65 * - Spinlock when dealing with the deferred list
66 * - List for "clean" shared cache maps
68 ULONG CcDirtyPageThreshold
= 0;
69 ULONG CcTotalDirtyPages
= 0;
70 LIST_ENTRY CcDeferredWrites
;
71 KSPIN_LOCK CcDeferredWriteSpinLock
;
72 LIST_ENTRY CcCleanSharedCacheMapList
;
74 /* Internal vars (ROS):
75 * - Event to notify lazy writer to shutdown
76 * - Event to inform watchers lazy writer is done for this loop
77 * - Lock for the CcCleanSharedCacheMapList list
79 KEVENT iLazyWriterShutdown
;
80 KEVENT iLazyWriterNotify
;
81 KSPIN_LOCK iSharedCacheMapLock
;
84 static void CcRosVacbIncRefCount_(PROS_VACB vacb
, const char* file
, int line
)
86 ++vacb
->ReferenceCount
;
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 static void CcRosVacbDecRefCount_(PROS_VACB vacb
, const char* file
, int line
)
95 --vacb
->ReferenceCount
;
96 if (vacb
->SharedCacheMap
->Trace
)
98 DbgPrint("(%s:%i) VACB %p --RefCount=%lu, Dirty %u, PageOut %lu\n",
99 file
, line
, vacb
, vacb
->ReferenceCount
, vacb
->Dirty
, vacb
->PageOut
);
102 #define CcRosVacbIncRefCount(vacb) CcRosVacbIncRefCount_(vacb,__FILE__,__LINE__)
103 #define CcRosVacbDecRefCount(vacb) CcRosVacbDecRefCount_(vacb,__FILE__,__LINE__)
105 #define CcRosVacbIncRefCount(vacb) (++((vacb)->ReferenceCount))
106 #define CcRosVacbDecRefCount(vacb) (--((vacb)->ReferenceCount))
110 CcRosInternalFreeVacb(PROS_VACB Vacb
);
113 /* FUNCTIONS *****************************************************************/
118 PROS_SHARED_CACHE_MAP SharedCacheMap
,
123 PLIST_ENTRY current_entry
;
129 SharedCacheMap
->Trace
= Trace
;
133 DPRINT1("Enabling Tracing for CacheMap 0x%p:\n", SharedCacheMap
);
135 KeAcquireGuardedMutex(&ViewLock
);
136 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldirql
);
138 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
139 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
141 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
142 current_entry
= current_entry
->Flink
;
144 DPRINT1(" VACB 0x%p enabled, RefCount %lu, Dirty %u, PageOut %lu\n",
145 current
, current
->ReferenceCount
, current
->Dirty
, current
->PageOut
);
147 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldirql
);
148 KeReleaseGuardedMutex(&ViewLock
);
152 DPRINT1("Disabling Tracing for CacheMap 0x%p:\n", SharedCacheMap
);
156 UNREFERENCED_PARAMETER(SharedCacheMap
);
157 UNREFERENCED_PARAMETER(Trace
);
169 Status
= CcWriteVirtualAddress(Vacb
);
170 if (NT_SUCCESS(Status
))
172 KeAcquireGuardedMutex(&ViewLock
);
173 KeAcquireSpinLock(&Vacb
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
176 RemoveEntryList(&Vacb
->DirtyVacbListEntry
);
177 CcTotalDirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
178 CcRosVacbDecRefCount(Vacb
);
180 KeReleaseSpinLock(&Vacb
->SharedCacheMap
->CacheMapLock
, oldIrql
);
181 KeReleaseGuardedMutex(&ViewLock
);
189 CcRosFlushDirtyPages (
193 BOOLEAN CalledFromLazy
)
195 PLIST_ENTRY current_entry
;
199 LARGE_INTEGER ZeroTimeout
;
201 DPRINT("CcRosFlushDirtyPages(Target %lu)\n", Target
);
204 ZeroTimeout
.QuadPart
= 0;
206 KeEnterCriticalRegion();
207 KeAcquireGuardedMutex(&ViewLock
);
209 current_entry
= DirtyVacbListHead
.Flink
;
210 if (current_entry
== &DirtyVacbListHead
)
212 DPRINT("No Dirty pages\n");
215 while ((current_entry
!= &DirtyVacbListHead
) && (Target
> 0))
217 current
= CONTAINING_RECORD(current_entry
,
220 current_entry
= current_entry
->Flink
;
222 CcRosVacbIncRefCount(current
);
224 /* When performing lazy write, don't handle temporary files */
225 if (CalledFromLazy
&&
226 BooleanFlagOn(current
->SharedCacheMap
->FileObject
->Flags
, FO_TEMPORARY_FILE
))
228 CcRosVacbDecRefCount(current
);
232 Locked
= current
->SharedCacheMap
->Callbacks
->AcquireForLazyWrite(
233 current
->SharedCacheMap
->LazyWriteContext
, Wait
);
236 CcRosVacbDecRefCount(current
);
240 Status
= CcRosAcquireVacbLock(current
,
241 Wait
? NULL
: &ZeroTimeout
);
242 if (Status
!= STATUS_SUCCESS
)
244 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
245 current
->SharedCacheMap
->LazyWriteContext
);
246 CcRosVacbDecRefCount(current
);
250 ASSERT(current
->Dirty
);
252 /* One reference is added above */
253 if ((current
->ReferenceCount
> 2 && current
->PinCount
== 0) ||
254 (current
->ReferenceCount
> 3 && current
->PinCount
> 1))
256 CcRosReleaseVacbLock(current
);
257 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
258 current
->SharedCacheMap
->LazyWriteContext
);
259 CcRosVacbDecRefCount(current
);
263 KeReleaseGuardedMutex(&ViewLock
);
265 Status
= CcRosFlushVacb(current
);
267 CcRosReleaseVacbLock(current
);
268 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
269 current
->SharedCacheMap
->LazyWriteContext
);
271 KeAcquireGuardedMutex(&ViewLock
);
272 CcRosVacbDecRefCount(current
);
274 if (!NT_SUCCESS(Status
) && (Status
!= STATUS_END_OF_FILE
) &&
275 (Status
!= STATUS_MEDIA_WRITE_PROTECTED
))
277 DPRINT1("CC: Failed to flush VACB.\n");
283 /* How many pages did we free? */
284 PagesFreed
= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
285 (*Count
) += PagesFreed
;
287 /* Make sure we don't overflow target! */
288 if (Target
< PagesFreed
)
290 /* If we would have, jump to zero directly */
295 Target
-= PagesFreed
;
299 current_entry
= DirtyVacbListHead
.Flink
;
302 KeReleaseGuardedMutex(&ViewLock
);
303 KeLeaveCriticalRegion();
305 DPRINT("CcRosFlushDirtyPages() finished\n");
306 return STATUS_SUCCESS
;
309 /* FIXME: Someday this could somewhat implement write-behind/read-ahead */
312 CciLazyWriter(PVOID Unused
)
314 LARGE_INTEGER OneSecond
;
316 OneSecond
.QuadPart
= (LONGLONG
)-1*1000*1000*10;
321 PLIST_ENTRY ListEntry
;
322 ULONG Target
, Count
= 0;
324 /* One per second or until we have to stop */
325 Status
= KeWaitForSingleObject(&iLazyWriterShutdown
,
331 /* If we succeeed, we've to stop running! */
332 if (Status
== STATUS_SUCCESS
)
337 /* We're not sleeping anymore */
338 KeClearEvent(&iLazyWriterNotify
);
340 /* Our target is one-eighth of the dirty pages */
341 Target
= CcTotalDirtyPages
/ 8;
345 DPRINT("Lazy writer starting (%d)\n", Target
);
346 CcRosFlushDirtyPages(Target
, &Count
, FALSE
, TRUE
);
348 /* And update stats */
349 CcLazyWritePages
+= Count
;
351 DPRINT("Lazy writer done (%d)\n", Count
);
354 /* Inform people waiting on us that we're done */
355 KeSetEvent(&iLazyWriterNotify
, IO_DISK_INCREMENT
, FALSE
);
357 /* Likely not optimal, but let's handle one deferred write now! */
358 ListEntry
= ExInterlockedRemoveHeadList(&CcDeferredWrites
, &CcDeferredWriteSpinLock
);
359 if (ListEntry
!= NULL
)
361 PROS_DEFERRED_WRITE_CONTEXT Context
;
363 /* Extract the context */
364 Context
= CONTAINING_RECORD(ListEntry
, ROS_DEFERRED_WRITE_CONTEXT
, CcDeferredWritesEntry
);
366 /* Can we write now? */
367 if (CcCanIWrite(Context
->FileObject
, Context
->BytesToWrite
, FALSE
, Context
->Retrying
))
369 /* Yes! Do it, and destroy the associated context */
370 Context
->PostRoutine(Context
->Context1
, Context
->Context2
);
371 ExFreePoolWithTag(Context
, 'CcDw');
375 /* Otherwise, requeue it, but in tail, so that it doesn't block others
376 * This is clearly to improve, but given the poor algorithm used now
377 * It's better than nothing!
379 ExInterlockedInsertTailList(&CcDeferredWrites
,
380 &Context
->CcDeferredWritesEntry
,
381 &CcDeferredWriteSpinLock
);
393 * FUNCTION: Try to free some memory from the file cache.
395 * Target - The number of pages to be freed.
396 * Priority - The priority of free (currently unused).
397 * NrFreed - Points to a variable where the number of pages
398 * actually freed is returned.
401 PLIST_ENTRY current_entry
;
408 BOOLEAN FlushedPages
= FALSE
;
410 DPRINT("CcRosTrimCache(Target %lu)\n", Target
);
412 InitializeListHead(&FreeList
);
417 KeAcquireGuardedMutex(&ViewLock
);
419 current_entry
= VacbLruListHead
.Flink
;
420 while (current_entry
!= &VacbLruListHead
)
422 current
= CONTAINING_RECORD(current_entry
,
425 current_entry
= current_entry
->Flink
;
427 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
429 /* Reference the VACB */
430 CcRosVacbIncRefCount(current
);
432 /* Check if it's mapped and not dirty */
433 if (current
->MappedCount
> 0 && !current
->Dirty
)
435 /* We have to break these locks because Cc sucks */
436 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
437 KeReleaseGuardedMutex(&ViewLock
);
439 /* Page out the VACB */
440 for (i
= 0; i
< VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
; i
++)
442 Page
= (PFN_NUMBER
)(MmGetPhysicalAddress((PUCHAR
)current
->BaseAddress
+ (i
* PAGE_SIZE
)).QuadPart
>> PAGE_SHIFT
);
444 MmPageOutPhysicalAddress(Page
);
447 /* Reacquire the locks */
448 KeAcquireGuardedMutex(&ViewLock
);
449 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
452 /* Dereference the VACB */
453 CcRosVacbDecRefCount(current
);
455 /* Check if we can free this entry now */
456 if (current
->ReferenceCount
== 0)
458 ASSERT(!current
->Dirty
);
459 ASSERT(!current
->MappedCount
);
461 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
462 RemoveEntryList(¤t
->VacbLruListEntry
);
463 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
465 /* Calculate how many pages we freed for Mm */
466 PagesFreed
= min(VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
, Target
);
467 Target
-= PagesFreed
;
468 (*NrFreed
) += PagesFreed
;
471 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
474 KeReleaseGuardedMutex(&ViewLock
);
476 /* Try flushing pages if we haven't met our target */
477 if ((Target
> 0) && !FlushedPages
)
479 /* Flush dirty pages to disk */
480 CcRosFlushDirtyPages(Target
, &PagesFreed
, FALSE
, FALSE
);
483 /* We can only swap as many pages as we flushed */
484 if (PagesFreed
< Target
) Target
= PagesFreed
;
486 /* Check if we flushed anything */
489 /* Try again after flushing dirty pages */
490 DPRINT("Flushed %lu dirty cache pages to disk\n", PagesFreed
);
495 while (!IsListEmpty(&FreeList
))
497 current_entry
= RemoveHeadList(&FreeList
);
498 current
= CONTAINING_RECORD(current_entry
,
500 CacheMapVacbListEntry
);
501 CcRosInternalFreeVacb(current
);
504 DPRINT("Evicted %lu cache pages\n", (*NrFreed
));
506 return STATUS_SUCCESS
;
512 PROS_SHARED_CACHE_MAP SharedCacheMap
,
521 ASSERT(SharedCacheMap
);
523 DPRINT("CcRosReleaseVacb(SharedCacheMap 0x%p, Vacb 0x%p, Valid %u)\n",
524 SharedCacheMap
, Vacb
, Valid
);
526 KeAcquireGuardedMutex(&ViewLock
);
527 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
531 WasDirty
= Vacb
->Dirty
;
532 Vacb
->Dirty
= Vacb
->Dirty
|| Dirty
;
534 if (!WasDirty
&& Vacb
->Dirty
)
536 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
537 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
544 CcRosVacbDecRefCount(Vacb
);
545 if (Mapped
&& (Vacb
->MappedCount
== 1))
547 CcRosVacbIncRefCount(Vacb
);
549 if (!WasDirty
&& Vacb
->Dirty
)
551 CcRosVacbIncRefCount(Vacb
);
554 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
555 KeReleaseGuardedMutex(&ViewLock
);
556 CcRosReleaseVacbLock(Vacb
);
558 return STATUS_SUCCESS
;
561 /* Returns with VACB Lock Held! */
565 PROS_SHARED_CACHE_MAP SharedCacheMap
,
568 PLIST_ENTRY current_entry
;
572 ASSERT(SharedCacheMap
);
574 DPRINT("CcRosLookupVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
575 SharedCacheMap
, FileOffset
);
577 KeAcquireGuardedMutex(&ViewLock
);
578 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
580 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
581 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
583 current
= CONTAINING_RECORD(current_entry
,
585 CacheMapVacbListEntry
);
586 if (IsPointInRange(current
->FileOffset
.QuadPart
,
587 VACB_MAPPING_GRANULARITY
,
590 CcRosVacbIncRefCount(current
);
591 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
592 KeReleaseGuardedMutex(&ViewLock
);
593 CcRosAcquireVacbLock(current
, NULL
);
596 if (current
->FileOffset
.QuadPart
> FileOffset
)
598 current_entry
= current_entry
->Flink
;
601 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
602 KeReleaseGuardedMutex(&ViewLock
);
613 PROS_SHARED_CACHE_MAP SharedCacheMap
;
615 SharedCacheMap
= Vacb
->SharedCacheMap
;
617 KeAcquireGuardedMutex(&ViewLock
);
618 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
622 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
623 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
627 CcRosVacbDecRefCount(Vacb
);
630 /* Move to the tail of the LRU list */
631 RemoveEntryList(&Vacb
->VacbLruListEntry
);
632 InsertTailList(&VacbLruListHead
, &Vacb
->VacbLruListEntry
);
636 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
637 KeReleaseGuardedMutex(&ViewLock
);
643 PROS_SHARED_CACHE_MAP SharedCacheMap
,
648 ASSERT(SharedCacheMap
);
650 DPRINT("CcRosMarkDirtyVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
651 SharedCacheMap
, FileOffset
);
653 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
656 KeBugCheck(CACHE_MANAGER
);
659 CcRosMarkDirtyVacb(Vacb
);
662 CcRosReleaseVacbLock(Vacb
);
664 return STATUS_SUCCESS
;
670 PROS_SHARED_CACHE_MAP SharedCacheMap
,
678 ASSERT(SharedCacheMap
);
680 DPRINT("CcRosUnmapVacb(SharedCacheMap 0x%p, FileOffset %I64u, NowDirty %u)\n",
681 SharedCacheMap
, FileOffset
, NowDirty
);
683 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
686 return STATUS_UNSUCCESSFUL
;
689 KeAcquireGuardedMutex(&ViewLock
);
690 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
692 WasDirty
= Vacb
->Dirty
;
693 Vacb
->Dirty
= Vacb
->Dirty
|| NowDirty
;
697 if (!WasDirty
&& NowDirty
)
699 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
700 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
703 CcRosVacbDecRefCount(Vacb
);
704 if (!WasDirty
&& NowDirty
)
706 CcRosVacbIncRefCount(Vacb
);
708 if (Vacb
->MappedCount
== 0)
710 CcRosVacbDecRefCount(Vacb
);
713 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
714 KeReleaseGuardedMutex(&ViewLock
);
715 CcRosReleaseVacbLock(Vacb
);
717 return STATUS_SUCCESS
;
727 ULONG_PTR NumberOfPages
;
729 /* Create a memory area. */
730 MmLockAddressSpace(MmGetKernelAddressSpace());
731 Status
= MmCreateMemoryArea(MmGetKernelAddressSpace(),
732 0, // nothing checks for VACB mareas, so set to 0
734 VACB_MAPPING_GRANULARITY
,
736 (PMEMORY_AREA
*)&Vacb
->MemoryArea
,
739 MmUnlockAddressSpace(MmGetKernelAddressSpace());
740 if (!NT_SUCCESS(Status
))
742 DPRINT1("MmCreateMemoryArea failed with %lx for VACB %p\n", Status
, Vacb
);
746 ASSERT(((ULONG_PTR
)Vacb
->BaseAddress
% PAGE_SIZE
) == 0);
747 ASSERT((ULONG_PTR
)Vacb
->BaseAddress
> (ULONG_PTR
)MmSystemRangeStart
);
749 /* Create a virtual mapping for this memory area */
750 NumberOfPages
= BYTES_TO_PAGES(VACB_MAPPING_GRANULARITY
);
751 for (i
= 0; i
< NumberOfPages
; i
++)
753 PFN_NUMBER PageFrameNumber
;
755 MI_SET_USAGE(MI_USAGE_CACHE
);
756 Status
= MmRequestPageMemoryConsumer(MC_CACHE
, TRUE
, &PageFrameNumber
);
757 if (PageFrameNumber
== 0)
759 DPRINT1("Unable to allocate page\n");
760 KeBugCheck(MEMORY_MANAGEMENT
);
763 Status
= MmCreateVirtualMapping(NULL
,
764 (PVOID
)((ULONG_PTR
)Vacb
->BaseAddress
+ (i
* PAGE_SIZE
)),
768 if (!NT_SUCCESS(Status
))
770 DPRINT1("Unable to create virtual mapping\n");
771 KeBugCheck(MEMORY_MANAGEMENT
);
775 return STATUS_SUCCESS
;
781 PROS_SHARED_CACHE_MAP SharedCacheMap
,
787 PLIST_ENTRY current_entry
;
791 ASSERT(SharedCacheMap
);
793 DPRINT("CcRosCreateVacb()\n");
795 if (FileOffset
>= SharedCacheMap
->SectionSize
.QuadPart
)
798 return STATUS_INVALID_PARAMETER
;
801 current
= ExAllocateFromNPagedLookasideList(&VacbLookasideList
);
802 current
->BaseAddress
= NULL
;
803 current
->Valid
= FALSE
;
804 current
->Dirty
= FALSE
;
805 current
->PageOut
= FALSE
;
806 current
->FileOffset
.QuadPart
= ROUND_DOWN(FileOffset
, VACB_MAPPING_GRANULARITY
);
807 current
->SharedCacheMap
= SharedCacheMap
;
809 if (SharedCacheMap
->Trace
)
811 DPRINT1("CacheMap 0x%p: new VACB: 0x%p\n", SharedCacheMap
, current
);
814 current
->MappedCount
= 0;
815 current
->DirtyVacbListEntry
.Flink
= NULL
;
816 current
->DirtyVacbListEntry
.Blink
= NULL
;
817 current
->ReferenceCount
= 1;
818 current
->PinCount
= 0;
819 KeInitializeMutex(¤t
->Mutex
, 0);
820 CcRosAcquireVacbLock(current
, NULL
);
821 KeAcquireGuardedMutex(&ViewLock
);
824 /* There is window between the call to CcRosLookupVacb
825 * and CcRosCreateVacb. We must check if a VACB for the
826 * file offset exist. If there is a VACB, we release
827 * our newly created VACB and return the existing one.
829 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
830 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
832 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
834 current
= CONTAINING_RECORD(current_entry
,
836 CacheMapVacbListEntry
);
837 if (IsPointInRange(current
->FileOffset
.QuadPart
,
838 VACB_MAPPING_GRANULARITY
,
841 CcRosVacbIncRefCount(current
);
842 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
844 if (SharedCacheMap
->Trace
)
846 DPRINT1("CacheMap 0x%p: deleting newly created VACB 0x%p ( found existing one 0x%p )\n",
852 CcRosReleaseVacbLock(*Vacb
);
853 KeReleaseGuardedMutex(&ViewLock
);
854 ExFreeToNPagedLookasideList(&VacbLookasideList
, *Vacb
);
856 CcRosAcquireVacbLock(current
, NULL
);
857 return STATUS_SUCCESS
;
859 if (current
->FileOffset
.QuadPart
< FileOffset
)
861 ASSERT(previous
== NULL
||
862 previous
->FileOffset
.QuadPart
< current
->FileOffset
.QuadPart
);
865 if (current
->FileOffset
.QuadPart
> FileOffset
)
867 current_entry
= current_entry
->Flink
;
869 /* There was no existing VACB. */
873 InsertHeadList(&previous
->CacheMapVacbListEntry
, ¤t
->CacheMapVacbListEntry
);
877 InsertHeadList(&SharedCacheMap
->CacheMapVacbListHead
, ¤t
->CacheMapVacbListEntry
);
879 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
880 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
881 KeReleaseGuardedMutex(&ViewLock
);
883 MI_SET_USAGE(MI_USAGE_CACHE
);
885 if ((SharedCacheMap
->FileObject
) && (SharedCacheMap
->FileObject
->FileName
.Buffer
))
889 pos
= wcsrchr(SharedCacheMap
->FileObject
->FileName
.Buffer
, '\\');
892 len
= wcslen(pos
) * sizeof(WCHAR
);
893 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%S", pos
);
897 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%wZ", &SharedCacheMap
->FileObject
->FileName
);
902 Status
= CcRosMapVacb(current
);
903 if (!NT_SUCCESS(Status
))
905 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
906 RemoveEntryList(¤t
->VacbLruListEntry
);
907 CcRosReleaseVacbLock(current
);
908 ExFreeToNPagedLookasideList(&VacbLookasideList
, current
);
917 PROS_SHARED_CACHE_MAP SharedCacheMap
,
919 PLONGLONG BaseOffset
,
927 ASSERT(SharedCacheMap
);
929 DPRINT("CcRosGetVacb()\n");
932 * Look for a VACB already mapping the same data.
934 current
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
938 * Otherwise create a new VACB.
940 Status
= CcRosCreateVacb(SharedCacheMap
, FileOffset
, ¤t
);
941 if (!NT_SUCCESS(Status
))
947 KeAcquireGuardedMutex(&ViewLock
);
949 /* Move to the tail of the LRU list */
950 RemoveEntryList(¤t
->VacbLruListEntry
);
951 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
953 KeReleaseGuardedMutex(&ViewLock
);
956 * Return information about the VACB to the caller.
958 *UptoDate
= current
->Valid
;
959 *BaseAddress
= current
->BaseAddress
;
960 DPRINT("*BaseAddress %p\n", *BaseAddress
);
962 *BaseOffset
= current
->FileOffset
.QuadPart
;
963 return STATUS_SUCCESS
;
969 PROS_SHARED_CACHE_MAP SharedCacheMap
,
975 * FUNCTION: Request a page mapping for a shared cache map
980 ASSERT(SharedCacheMap
);
982 if (FileOffset
% VACB_MAPPING_GRANULARITY
!= 0)
984 DPRINT1("Bad fileoffset %I64x should be multiple of %x",
985 FileOffset
, VACB_MAPPING_GRANULARITY
);
986 KeBugCheck(CACHE_MANAGER
);
989 return CcRosGetVacb(SharedCacheMap
,
1001 MEMORY_AREA
* MemoryArea
,
1004 SWAPENTRY SwapEntry
,
1007 ASSERT(SwapEntry
== 0);
1010 ASSERT(MmGetReferenceCountPage(Page
) == 1);
1011 MmReleasePageMemoryConsumer(MC_CACHE
, Page
);
1016 CcRosInternalFreeVacb (
1019 * FUNCTION: Releases a VACB associated with a shared cache map
1022 DPRINT("Freeing VACB 0x%p\n", Vacb
);
1024 if (Vacb
->SharedCacheMap
->Trace
)
1026 DPRINT1("CacheMap 0x%p: deleting VACB: 0x%p\n", Vacb
->SharedCacheMap
, Vacb
);
1030 MmLockAddressSpace(MmGetKernelAddressSpace());
1031 MmFreeMemoryArea(MmGetKernelAddressSpace(),
1035 MmUnlockAddressSpace(MmGetKernelAddressSpace());
1037 ExFreeToNPagedLookasideList(&VacbLookasideList
, Vacb
);
1038 return STATUS_SUCCESS
;
1047 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
,
1048 IN PLARGE_INTEGER FileOffset OPTIONAL
,
1050 OUT PIO_STATUS_BLOCK IoStatus
)
1052 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1053 LARGE_INTEGER Offset
;
1054 LONGLONG RemainingLength
;
1059 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p FileOffset=%p Length=%lu\n",
1060 SectionObjectPointers
, FileOffset
, Length
);
1062 DPRINT("CcFlushCache(SectionObjectPointers 0x%p, FileOffset 0x%p, Length %lu, IoStatus 0x%p)\n",
1063 SectionObjectPointers
, FileOffset
, Length
, IoStatus
);
1065 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1067 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
1068 ASSERT(SharedCacheMap
);
1071 Offset
= *FileOffset
;
1072 RemainingLength
= Length
;
1076 Offset
.QuadPart
= 0;
1077 RemainingLength
= SharedCacheMap
->FileSize
.QuadPart
;
1082 IoStatus
->Status
= STATUS_SUCCESS
;
1083 IoStatus
->Information
= 0;
1086 while (RemainingLength
> 0)
1088 current
= CcRosLookupVacb(SharedCacheMap
, Offset
.QuadPart
);
1089 if (current
!= NULL
)
1093 Status
= CcRosFlushVacb(current
);
1094 if (!NT_SUCCESS(Status
) && IoStatus
!= NULL
)
1096 IoStatus
->Status
= Status
;
1100 CcRosReleaseVacbLock(current
);
1102 KeAcquireGuardedMutex(&ViewLock
);
1103 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1104 CcRosVacbDecRefCount(current
);
1105 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1106 KeReleaseGuardedMutex(&ViewLock
);
1109 Offset
.QuadPart
+= VACB_MAPPING_GRANULARITY
;
1110 RemainingLength
-= min(RemainingLength
, VACB_MAPPING_GRANULARITY
);
1117 IoStatus
->Status
= STATUS_INVALID_PARAMETER
;
1124 CcRosDeleteFileCache (
1125 PFILE_OBJECT FileObject
,
1126 PROS_SHARED_CACHE_MAP SharedCacheMap
)
1128 * FUNCTION: Releases the shared cache map associated with a file object
1131 PLIST_ENTRY current_entry
;
1133 LIST_ENTRY FreeList
;
1136 ASSERT(SharedCacheMap
);
1138 SharedCacheMap
->OpenCount
++;
1139 KeReleaseGuardedMutex(&ViewLock
);
1141 CcFlushCache(FileObject
->SectionObjectPointer
, NULL
, 0, NULL
);
1143 KeAcquireGuardedMutex(&ViewLock
);
1144 SharedCacheMap
->OpenCount
--;
1145 if (SharedCacheMap
->OpenCount
== 0)
1149 FileObject
->SectionObjectPointer
->SharedCacheMap
= NULL
;
1154 InitializeListHead(&FreeList
);
1155 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1156 while (!IsListEmpty(&SharedCacheMap
->CacheMapVacbListHead
))
1158 current_entry
= RemoveTailList(&SharedCacheMap
->CacheMapVacbListHead
);
1159 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1160 RemoveEntryList(¤t
->VacbLruListEntry
);
1163 RemoveEntryList(¤t
->DirtyVacbListEntry
);
1164 CcTotalDirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
1165 DPRINT1("Freeing dirty VACB\n");
1167 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
1170 SharedCacheMap
->Trace
= FALSE
;
1172 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1174 KeReleaseGuardedMutex(&ViewLock
);
1175 ObDereferenceObject(SharedCacheMap
->FileObject
);
1177 while (!IsListEmpty(&FreeList
))
1179 current_entry
= RemoveTailList(&FreeList
);
1180 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1181 CcRosInternalFreeVacb(current
);
1184 KeAcquireSpinLock(&iSharedCacheMapLock
, &OldIrql
);
1185 RemoveEntryList(&SharedCacheMap
->SharedCacheMapLinks
);
1186 KeReleaseSpinLock(&iSharedCacheMapLock
, OldIrql
);
1188 ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList
, SharedCacheMap
);
1189 KeAcquireGuardedMutex(&ViewLock
);
1191 return STATUS_SUCCESS
;
1196 CcRosReferenceCache (
1197 PFILE_OBJECT FileObject
)
1199 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1200 KeAcquireGuardedMutex(&ViewLock
);
1201 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1202 ASSERT(SharedCacheMap
);
1203 ASSERT(SharedCacheMap
->OpenCount
!= 0);
1204 SharedCacheMap
->OpenCount
++;
1205 KeReleaseGuardedMutex(&ViewLock
);
1210 CcRosRemoveIfClosed (
1211 PSECTION_OBJECT_POINTERS SectionObjectPointer
)
1213 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1214 DPRINT("CcRosRemoveIfClosed()\n");
1215 KeAcquireGuardedMutex(&ViewLock
);
1216 SharedCacheMap
= SectionObjectPointer
->SharedCacheMap
;
1217 if (SharedCacheMap
&& SharedCacheMap
->OpenCount
== 0)
1219 CcRosDeleteFileCache(SharedCacheMap
->FileObject
, SharedCacheMap
);
1221 KeReleaseGuardedMutex(&ViewLock
);
1227 CcRosDereferenceCache (
1228 PFILE_OBJECT FileObject
)
1230 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1231 KeAcquireGuardedMutex(&ViewLock
);
1232 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1233 ASSERT(SharedCacheMap
);
1234 if (SharedCacheMap
->OpenCount
> 0)
1236 SharedCacheMap
->OpenCount
--;
1237 if (SharedCacheMap
->OpenCount
== 0)
1239 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1240 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1243 KeReleaseGuardedMutex(&ViewLock
);
1248 CcRosReleaseFileCache (
1249 PFILE_OBJECT FileObject
)
1251 * FUNCTION: Called by the file system when a handle to a file object
1255 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1257 KeAcquireGuardedMutex(&ViewLock
);
1259 if (FileObject
->SectionObjectPointer
->SharedCacheMap
!= NULL
)
1261 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1262 if (FileObject
->PrivateCacheMap
!= NULL
)
1264 FileObject
->PrivateCacheMap
= NULL
;
1265 if (SharedCacheMap
->OpenCount
> 0)
1267 SharedCacheMap
->OpenCount
--;
1268 if (SharedCacheMap
->OpenCount
== 0)
1270 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1271 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1276 KeReleaseGuardedMutex(&ViewLock
);
1277 return STATUS_SUCCESS
;
1282 CcTryToInitializeFileCache (
1283 PFILE_OBJECT FileObject
)
1285 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1288 KeAcquireGuardedMutex(&ViewLock
);
1290 ASSERT(FileObject
->SectionObjectPointer
);
1291 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1292 if (SharedCacheMap
== NULL
)
1294 Status
= STATUS_UNSUCCESSFUL
;
1298 if (FileObject
->PrivateCacheMap
== NULL
)
1300 FileObject
->PrivateCacheMap
= SharedCacheMap
;
1301 SharedCacheMap
->OpenCount
++;
1303 Status
= STATUS_SUCCESS
;
1305 KeReleaseGuardedMutex(&ViewLock
);
1313 CcRosInitializeFileCache (
1314 PFILE_OBJECT FileObject
,
1315 PCC_FILE_SIZES FileSizes
,
1317 PCACHE_MANAGER_CALLBACKS CallBacks
,
1318 PVOID LazyWriterContext
)
1320 * FUNCTION: Initializes a shared cache map for a file object
1323 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1325 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1326 DPRINT("CcRosInitializeFileCache(FileObject 0x%p, SharedCacheMap 0x%p)\n",
1327 FileObject
, SharedCacheMap
);
1329 KeAcquireGuardedMutex(&ViewLock
);
1330 if (SharedCacheMap
== NULL
)
1334 SharedCacheMap
= ExAllocateFromNPagedLookasideList(&SharedCacheMapLookasideList
);
1335 if (SharedCacheMap
== NULL
)
1337 KeReleaseGuardedMutex(&ViewLock
);
1338 return STATUS_INSUFFICIENT_RESOURCES
;
1340 RtlZeroMemory(SharedCacheMap
, sizeof(*SharedCacheMap
));
1341 ObReferenceObjectByPointer(FileObject
,
1345 SharedCacheMap
->FileObject
= FileObject
;
1346 SharedCacheMap
->Callbacks
= CallBacks
;
1347 SharedCacheMap
->LazyWriteContext
= LazyWriterContext
;
1348 SharedCacheMap
->SectionSize
= FileSizes
->AllocationSize
;
1349 SharedCacheMap
->FileSize
= FileSizes
->FileSize
;
1350 SharedCacheMap
->PinAccess
= PinAccess
;
1351 SharedCacheMap
->DirtyPageThreshold
= 0;
1352 KeInitializeSpinLock(&SharedCacheMap
->CacheMapLock
);
1353 InitializeListHead(&SharedCacheMap
->CacheMapVacbListHead
);
1354 FileObject
->SectionObjectPointer
->SharedCacheMap
= SharedCacheMap
;
1356 KeAcquireSpinLock(&iSharedCacheMapLock
, &OldIrql
);
1357 InsertTailList(&CcCleanSharedCacheMapList
, &SharedCacheMap
->SharedCacheMapLinks
);
1358 KeReleaseSpinLock(&iSharedCacheMapLock
, OldIrql
);
1360 if (FileObject
->PrivateCacheMap
== NULL
)
1362 FileObject
->PrivateCacheMap
= SharedCacheMap
;
1363 SharedCacheMap
->OpenCount
++;
1365 KeReleaseGuardedMutex(&ViewLock
);
1367 return STATUS_SUCCESS
;
1375 CcGetFileObjectFromSectionPtrs (
1376 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
)
1378 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1380 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p\n", SectionObjectPointers
);
1382 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1384 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
1385 ASSERT(SharedCacheMap
);
1386 return SharedCacheMap
->FileObject
;
1393 CcShutdownLazyWriter (
1396 /* Simply set the event, lazy writer will stop when it's done */
1397 KeSetEvent(&iLazyWriterShutdown
, IO_DISK_INCREMENT
, FALSE
);
1409 OBJECT_ATTRIBUTES ObjectAttributes
;
1411 DPRINT("CcInitView()\n");
1413 InitializeListHead(&DirtyVacbListHead
);
1414 InitializeListHead(&VacbLruListHead
);
1415 InitializeListHead(&CcDeferredWrites
);
1416 InitializeListHead(&CcCleanSharedCacheMapList
);
1417 KeInitializeSpinLock(&CcDeferredWriteSpinLock
);
1418 KeInitializeSpinLock(&iSharedCacheMapLock
);
1419 KeInitializeGuardedMutex(&ViewLock
);
1420 ExInitializeNPagedLookasideList(&iBcbLookasideList
,
1424 sizeof(INTERNAL_BCB
),
1427 ExInitializeNPagedLookasideList(&SharedCacheMapLookasideList
,
1431 sizeof(ROS_SHARED_CACHE_MAP
),
1432 TAG_SHARED_CACHE_MAP
,
1434 ExInitializeNPagedLookasideList(&VacbLookasideList
,
1442 MmInitializeMemoryConsumer(MC_CACHE
, CcRosTrimCache
);
1444 /* Initialize lazy writer events */
1445 KeInitializeEvent(&iLazyWriterShutdown
, SynchronizationEvent
, FALSE
);
1446 KeInitializeEvent(&iLazyWriterNotify
, NotificationEvent
, FALSE
);
1448 /* Define lazy writer threshold, depending on system type */
1449 switch (MmQuerySystemSize())
1452 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 8;
1455 case MmMediumSystem
:
1456 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 4;
1460 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 8 + MmNumberOfPhysicalPages
/ 4;
1464 /* Start the lazy writer thread */
1465 InitializeObjectAttributes(&ObjectAttributes
,
1470 Status
= PsCreateSystemThread(&LazyWriter
,
1477 if (!NT_SUCCESS(Status
))
1483 Status
= NtSetInformationThread(LazyWriter
,
1487 ASSERT(NT_SUCCESS(Status
));
1489 /* Handle is not needed */
1490 ObCloseHandle(LazyWriter
, KernelMode
);
1492 CcInitCacheZeroPage();
1497 #if DBG && defined(KDBG)
1499 ExpKdbgExtFileCache(ULONG Argc
, PCHAR Argv
[])
1501 PLIST_ENTRY ListEntry
;
1502 UNICODE_STRING NoName
= RTL_CONSTANT_STRING(L
"No name for File");
1504 KdbpPrint(" Usage Summary (in kb)\n");
1505 KdbpPrint("Shared\t\tValid\tDirty\tName\n");
1506 /* No need to lock the spin lock here, we're in DBG */
1507 for (ListEntry
= CcCleanSharedCacheMapList
.Flink
;
1508 ListEntry
!= &CcCleanSharedCacheMapList
;
1509 ListEntry
= ListEntry
->Flink
)
1512 ULONG Valid
= 0, Dirty
= 0;
1513 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1514 PUNICODE_STRING FileName
;
1516 SharedCacheMap
= CONTAINING_RECORD(ListEntry
, ROS_SHARED_CACHE_MAP
, SharedCacheMapLinks
);
1518 /* First, count for all the associated VACB */
1519 for (Vacbs
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
1520 Vacbs
!= &SharedCacheMap
->CacheMapVacbListHead
;
1521 Vacbs
= Vacbs
->Flink
)
1525 Vacb
= CONTAINING_RECORD(Vacbs
, ROS_VACB
, CacheMapVacbListEntry
);
1528 Dirty
+= VACB_MAPPING_GRANULARITY
/ 1024;
1532 Valid
+= VACB_MAPPING_GRANULARITY
/ 1024;
1537 if (SharedCacheMap
->FileObject
!= NULL
&&
1538 SharedCacheMap
->FileObject
->FileName
.Length
!= 0)
1540 FileName
= &SharedCacheMap
->FileObject
->FileName
;
1548 KdbpPrint("%p\t%d\t%d\t%wZ\n", SharedCacheMap
, Valid
, Dirty
, FileName
);