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
67 ULONG CcDirtyPageThreshold
= 0;
68 ULONG CcTotalDirtyPages
= 0;
69 LIST_ENTRY CcDeferredWrites
;
70 KSPIN_LOCK CcDeferredWriteSpinLock
;
72 /* Internal vars (ROS):
73 * - Event to notify lazy writer to shutdown
74 * - Event to inform watchers lazy writer is done for this loop
76 KEVENT iLazyWriterShutdown
;
77 KEVENT iLazyWriterNotify
;
80 static void CcRosVacbIncRefCount_(PROS_VACB vacb
, const char* file
, int line
)
82 ++vacb
->ReferenceCount
;
83 if (vacb
->SharedCacheMap
->Trace
)
85 DbgPrint("(%s:%i) VACB %p ++RefCount=%lu, Dirty %u, PageOut %lu\n",
86 file
, line
, vacb
, vacb
->ReferenceCount
, vacb
->Dirty
, vacb
->PageOut
);
89 static void CcRosVacbDecRefCount_(PROS_VACB vacb
, const char* file
, int line
)
91 --vacb
->ReferenceCount
;
92 if (vacb
->SharedCacheMap
->Trace
)
94 DbgPrint("(%s:%i) VACB %p --RefCount=%lu, Dirty %u, PageOut %lu\n",
95 file
, line
, vacb
, vacb
->ReferenceCount
, vacb
->Dirty
, vacb
->PageOut
);
98 #define CcRosVacbIncRefCount(vacb) CcRosVacbIncRefCount_(vacb,__FILE__,__LINE__)
99 #define CcRosVacbDecRefCount(vacb) CcRosVacbDecRefCount_(vacb,__FILE__,__LINE__)
101 #define CcRosVacbIncRefCount(vacb) (++((vacb)->ReferenceCount))
102 #define CcRosVacbDecRefCount(vacb) (--((vacb)->ReferenceCount))
106 CcRosInternalFreeVacb(PROS_VACB Vacb
);
109 /* FUNCTIONS *****************************************************************/
114 PROS_SHARED_CACHE_MAP SharedCacheMap
,
119 PLIST_ENTRY current_entry
;
125 SharedCacheMap
->Trace
= Trace
;
129 DPRINT1("Enabling Tracing for CacheMap 0x%p:\n", SharedCacheMap
);
131 KeAcquireGuardedMutex(&ViewLock
);
132 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldirql
);
134 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
135 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
137 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
138 current_entry
= current_entry
->Flink
;
140 DPRINT1(" VACB 0x%p enabled, RefCount %lu, Dirty %u, PageOut %lu\n",
141 current
, current
->ReferenceCount
, current
->Dirty
, current
->PageOut
);
143 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldirql
);
144 KeReleaseGuardedMutex(&ViewLock
);
148 DPRINT1("Disabling Tracing for CacheMap 0x%p:\n", SharedCacheMap
);
152 UNREFERENCED_PARAMETER(SharedCacheMap
);
153 UNREFERENCED_PARAMETER(Trace
);
165 Status
= CcWriteVirtualAddress(Vacb
);
166 if (NT_SUCCESS(Status
))
168 KeAcquireGuardedMutex(&ViewLock
);
169 KeAcquireSpinLock(&Vacb
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
172 RemoveEntryList(&Vacb
->DirtyVacbListEntry
);
173 CcTotalDirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
174 CcRosVacbDecRefCount(Vacb
);
176 KeReleaseSpinLock(&Vacb
->SharedCacheMap
->CacheMapLock
, oldIrql
);
177 KeReleaseGuardedMutex(&ViewLock
);
185 CcRosFlushDirtyPages (
189 BOOLEAN CalledFromLazy
)
191 PLIST_ENTRY current_entry
;
195 LARGE_INTEGER ZeroTimeout
;
197 DPRINT("CcRosFlushDirtyPages(Target %lu)\n", Target
);
200 ZeroTimeout
.QuadPart
= 0;
202 KeEnterCriticalRegion();
203 KeAcquireGuardedMutex(&ViewLock
);
205 current_entry
= DirtyVacbListHead
.Flink
;
206 if (current_entry
== &DirtyVacbListHead
)
208 DPRINT("No Dirty pages\n");
211 while ((current_entry
!= &DirtyVacbListHead
) && (Target
> 0))
213 current
= CONTAINING_RECORD(current_entry
,
216 current_entry
= current_entry
->Flink
;
218 CcRosVacbIncRefCount(current
);
220 /* When performing lazy write, don't handle temporary files */
221 if (CalledFromLazy
&&
222 BooleanFlagOn(current
->SharedCacheMap
->FileObject
->Flags
, FO_TEMPORARY_FILE
))
224 CcRosVacbDecRefCount(current
);
228 Locked
= current
->SharedCacheMap
->Callbacks
->AcquireForLazyWrite(
229 current
->SharedCacheMap
->LazyWriteContext
, Wait
);
232 CcRosVacbDecRefCount(current
);
236 Status
= CcRosAcquireVacbLock(current
,
237 Wait
? NULL
: &ZeroTimeout
);
238 if (Status
!= STATUS_SUCCESS
)
240 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
241 current
->SharedCacheMap
->LazyWriteContext
);
242 CcRosVacbDecRefCount(current
);
246 ASSERT(current
->Dirty
);
248 /* One reference is added above */
249 if (current
->ReferenceCount
> 2)
251 CcRosReleaseVacbLock(current
);
252 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
253 current
->SharedCacheMap
->LazyWriteContext
);
254 CcRosVacbDecRefCount(current
);
258 KeReleaseGuardedMutex(&ViewLock
);
260 Status
= CcRosFlushVacb(current
);
262 CcRosReleaseVacbLock(current
);
263 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
264 current
->SharedCacheMap
->LazyWriteContext
);
266 KeAcquireGuardedMutex(&ViewLock
);
267 CcRosVacbDecRefCount(current
);
269 if (!NT_SUCCESS(Status
) && (Status
!= STATUS_END_OF_FILE
) &&
270 (Status
!= STATUS_MEDIA_WRITE_PROTECTED
))
272 DPRINT1("CC: Failed to flush VACB.\n");
278 /* How many pages did we free? */
279 PagesFreed
= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
280 (*Count
) += PagesFreed
;
282 /* Make sure we don't overflow target! */
283 if (Target
< PagesFreed
)
285 /* If we would have, jump to zero directly */
290 Target
-= PagesFreed
;
294 current_entry
= DirtyVacbListHead
.Flink
;
297 KeReleaseGuardedMutex(&ViewLock
);
298 KeLeaveCriticalRegion();
300 DPRINT("CcRosFlushDirtyPages() finished\n");
301 return STATUS_SUCCESS
;
304 /* FIXME: Someday this could somewhat implement write-behind/read-ahead */
307 CciLazyWriter(PVOID Unused
)
309 LARGE_INTEGER OneSecond
;
311 OneSecond
.QuadPart
= (LONGLONG
)-1*1000*1000*10;
316 PLIST_ENTRY ListEntry
;
317 ULONG Target
, Count
= 0;
319 /* One per second or until we have to stop */
320 Status
= KeWaitForSingleObject(&iLazyWriterShutdown
,
326 /* If we succeeed, we've to stop running! */
327 if (Status
== STATUS_SUCCESS
)
332 /* We're not sleeping anymore */
333 KeClearEvent(&iLazyWriterNotify
);
335 /* Our target is one-eighth of the dirty pages */
336 Target
= CcTotalDirtyPages
/ 8;
340 DPRINT("Lazy writer starting (%d)\n", Target
);
341 CcRosFlushDirtyPages(Target
, &Count
, FALSE
, TRUE
);
343 /* And update stats */
344 CcLazyWritePages
+= Count
;
346 DPRINT("Lazy writer done (%d)\n", Count
);
349 /* Inform people waiting on us that we're done */
350 KeSetEvent(&iLazyWriterNotify
, IO_DISK_INCREMENT
, FALSE
);
352 /* Likely not optimal, but let's handle one deferred write now! */
353 ListEntry
= ExInterlockedRemoveHeadList(&CcDeferredWrites
, &CcDeferredWriteSpinLock
);
354 if (ListEntry
!= NULL
)
356 PROS_DEFERRED_WRITE_CONTEXT Context
;
358 /* Extract the context */
359 Context
= CONTAINING_RECORD(ListEntry
, ROS_DEFERRED_WRITE_CONTEXT
, CcDeferredWritesEntry
);
361 /* Can we write now? */
362 if (CcCanIWrite(Context
->FileObject
, Context
->BytesToWrite
, FALSE
, Context
->Retrying
))
364 /* Yes! Do it, and destroy the associated context */
365 Context
->PostRoutine(Context
->Context1
, Context
->Context2
);
366 ExFreePoolWithTag(Context
, 'CcDw');
370 /* Otherwise, requeue it, but in tail, so that it doesn't block others
371 * This is clearly to improve, but given the poor algorithm used now
372 * It's better than nothing!
374 ExInterlockedInsertTailList(&CcDeferredWrites
,
375 &Context
->CcDeferredWritesEntry
,
376 &CcDeferredWriteSpinLock
);
388 * FUNCTION: Try to free some memory from the file cache.
390 * Target - The number of pages to be freed.
391 * Priority - The priority of free (currently unused).
392 * NrFreed - Points to a variable where the number of pages
393 * actually freed is returned.
396 PLIST_ENTRY current_entry
;
403 BOOLEAN FlushedPages
= FALSE
;
405 DPRINT("CcRosTrimCache(Target %lu)\n", Target
);
407 InitializeListHead(&FreeList
);
412 KeAcquireGuardedMutex(&ViewLock
);
414 current_entry
= VacbLruListHead
.Flink
;
415 while (current_entry
!= &VacbLruListHead
)
417 current
= CONTAINING_RECORD(current_entry
,
420 current_entry
= current_entry
->Flink
;
422 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
424 /* Reference the VACB */
425 CcRosVacbIncRefCount(current
);
427 /* Check if it's mapped and not dirty */
428 if (current
->MappedCount
> 0 && !current
->Dirty
)
430 /* We have to break these locks because Cc sucks */
431 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
432 KeReleaseGuardedMutex(&ViewLock
);
434 /* Page out the VACB */
435 for (i
= 0; i
< VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
; i
++)
437 Page
= (PFN_NUMBER
)(MmGetPhysicalAddress((PUCHAR
)current
->BaseAddress
+ (i
* PAGE_SIZE
)).QuadPart
>> PAGE_SHIFT
);
439 MmPageOutPhysicalAddress(Page
);
442 /* Reacquire the locks */
443 KeAcquireGuardedMutex(&ViewLock
);
444 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
447 /* Dereference the VACB */
448 CcRosVacbDecRefCount(current
);
450 /* Check if we can free this entry now */
451 if (current
->ReferenceCount
== 0)
453 ASSERT(!current
->Dirty
);
454 ASSERT(!current
->MappedCount
);
456 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
457 RemoveEntryList(¤t
->VacbLruListEntry
);
458 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
460 /* Calculate how many pages we freed for Mm */
461 PagesFreed
= min(VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
, Target
);
462 Target
-= PagesFreed
;
463 (*NrFreed
) += PagesFreed
;
466 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
469 KeReleaseGuardedMutex(&ViewLock
);
471 /* Try flushing pages if we haven't met our target */
472 if ((Target
> 0) && !FlushedPages
)
474 /* Flush dirty pages to disk */
475 CcRosFlushDirtyPages(Target
, &PagesFreed
, FALSE
, FALSE
);
478 /* We can only swap as many pages as we flushed */
479 if (PagesFreed
< Target
) Target
= PagesFreed
;
481 /* Check if we flushed anything */
484 /* Try again after flushing dirty pages */
485 DPRINT("Flushed %lu dirty cache pages to disk\n", PagesFreed
);
490 while (!IsListEmpty(&FreeList
))
492 current_entry
= RemoveHeadList(&FreeList
);
493 current
= CONTAINING_RECORD(current_entry
,
495 CacheMapVacbListEntry
);
496 CcRosInternalFreeVacb(current
);
499 DPRINT("Evicted %lu cache pages\n", (*NrFreed
));
501 return STATUS_SUCCESS
;
507 PROS_SHARED_CACHE_MAP SharedCacheMap
,
516 ASSERT(SharedCacheMap
);
518 DPRINT("CcRosReleaseVacb(SharedCacheMap 0x%p, Vacb 0x%p, Valid %u)\n",
519 SharedCacheMap
, Vacb
, Valid
);
521 KeAcquireGuardedMutex(&ViewLock
);
522 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
526 WasDirty
= Vacb
->Dirty
;
527 Vacb
->Dirty
= Vacb
->Dirty
|| Dirty
;
529 if (!WasDirty
&& Vacb
->Dirty
)
531 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
532 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
539 CcRosVacbDecRefCount(Vacb
);
540 if (Mapped
&& (Vacb
->MappedCount
== 1))
542 CcRosVacbIncRefCount(Vacb
);
544 if (!WasDirty
&& Vacb
->Dirty
)
546 CcRosVacbIncRefCount(Vacb
);
549 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
550 KeReleaseGuardedMutex(&ViewLock
);
551 CcRosReleaseVacbLock(Vacb
);
553 return STATUS_SUCCESS
;
556 /* Returns with VACB Lock Held! */
560 PROS_SHARED_CACHE_MAP SharedCacheMap
,
563 PLIST_ENTRY current_entry
;
567 ASSERT(SharedCacheMap
);
569 DPRINT("CcRosLookupVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
570 SharedCacheMap
, FileOffset
);
572 KeAcquireGuardedMutex(&ViewLock
);
573 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
575 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
576 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
578 current
= CONTAINING_RECORD(current_entry
,
580 CacheMapVacbListEntry
);
581 if (IsPointInRange(current
->FileOffset
.QuadPart
,
582 VACB_MAPPING_GRANULARITY
,
585 CcRosVacbIncRefCount(current
);
586 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
587 KeReleaseGuardedMutex(&ViewLock
);
588 CcRosAcquireVacbLock(current
, NULL
);
591 if (current
->FileOffset
.QuadPart
> FileOffset
)
593 current_entry
= current_entry
->Flink
;
596 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
597 KeReleaseGuardedMutex(&ViewLock
);
608 PROS_SHARED_CACHE_MAP SharedCacheMap
;
610 SharedCacheMap
= Vacb
->SharedCacheMap
;
612 KeAcquireGuardedMutex(&ViewLock
);
613 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
617 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
618 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
622 CcRosVacbDecRefCount(Vacb
);
625 /* Move to the tail of the LRU list */
626 RemoveEntryList(&Vacb
->VacbLruListEntry
);
627 InsertTailList(&VacbLruListHead
, &Vacb
->VacbLruListEntry
);
631 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
632 KeReleaseGuardedMutex(&ViewLock
);
638 PROS_SHARED_CACHE_MAP SharedCacheMap
,
643 ASSERT(SharedCacheMap
);
645 DPRINT("CcRosMarkDirtyVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
646 SharedCacheMap
, FileOffset
);
648 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
651 KeBugCheck(CACHE_MANAGER
);
654 CcRosMarkDirtyVacb(Vacb
);
657 CcRosReleaseVacbLock(Vacb
);
659 return STATUS_SUCCESS
;
665 PROS_SHARED_CACHE_MAP SharedCacheMap
,
673 ASSERT(SharedCacheMap
);
675 DPRINT("CcRosUnmapVacb(SharedCacheMap 0x%p, FileOffset %I64u, NowDirty %u)\n",
676 SharedCacheMap
, FileOffset
, NowDirty
);
678 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
681 return STATUS_UNSUCCESSFUL
;
684 KeAcquireGuardedMutex(&ViewLock
);
685 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
687 WasDirty
= Vacb
->Dirty
;
688 Vacb
->Dirty
= Vacb
->Dirty
|| NowDirty
;
692 if (!WasDirty
&& NowDirty
)
694 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
695 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
698 CcRosVacbDecRefCount(Vacb
);
699 if (!WasDirty
&& NowDirty
)
701 CcRosVacbIncRefCount(Vacb
);
703 if (Vacb
->MappedCount
== 0)
705 CcRosVacbDecRefCount(Vacb
);
708 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
709 KeReleaseGuardedMutex(&ViewLock
);
710 CcRosReleaseVacbLock(Vacb
);
712 return STATUS_SUCCESS
;
722 ULONG_PTR NumberOfPages
;
724 /* Create a memory area. */
725 MmLockAddressSpace(MmGetKernelAddressSpace());
726 Status
= MmCreateMemoryArea(MmGetKernelAddressSpace(),
727 0, // nothing checks for VACB mareas, so set to 0
729 VACB_MAPPING_GRANULARITY
,
731 (PMEMORY_AREA
*)&Vacb
->MemoryArea
,
734 MmUnlockAddressSpace(MmGetKernelAddressSpace());
735 if (!NT_SUCCESS(Status
))
737 DPRINT1("MmCreateMemoryArea failed with %lx for VACB %p\n", Status
, Vacb
);
741 ASSERT(((ULONG_PTR
)Vacb
->BaseAddress
% PAGE_SIZE
) == 0);
742 ASSERT((ULONG_PTR
)Vacb
->BaseAddress
> (ULONG_PTR
)MmSystemRangeStart
);
744 /* Create a virtual mapping for this memory area */
745 NumberOfPages
= BYTES_TO_PAGES(VACB_MAPPING_GRANULARITY
);
746 for (i
= 0; i
< NumberOfPages
; i
++)
748 PFN_NUMBER PageFrameNumber
;
750 MI_SET_USAGE(MI_USAGE_CACHE
);
751 Status
= MmRequestPageMemoryConsumer(MC_CACHE
, TRUE
, &PageFrameNumber
);
752 if (PageFrameNumber
== 0)
754 DPRINT1("Unable to allocate page\n");
755 KeBugCheck(MEMORY_MANAGEMENT
);
758 Status
= MmCreateVirtualMapping(NULL
,
759 (PVOID
)((ULONG_PTR
)Vacb
->BaseAddress
+ (i
* PAGE_SIZE
)),
763 if (!NT_SUCCESS(Status
))
765 DPRINT1("Unable to create virtual mapping\n");
766 KeBugCheck(MEMORY_MANAGEMENT
);
770 return STATUS_SUCCESS
;
776 PROS_SHARED_CACHE_MAP SharedCacheMap
,
782 PLIST_ENTRY current_entry
;
786 ASSERT(SharedCacheMap
);
788 DPRINT("CcRosCreateVacb()\n");
790 if (FileOffset
>= SharedCacheMap
->SectionSize
.QuadPart
)
793 return STATUS_INVALID_PARAMETER
;
796 current
= ExAllocateFromNPagedLookasideList(&VacbLookasideList
);
797 current
->BaseAddress
= NULL
;
798 current
->Valid
= FALSE
;
799 current
->Dirty
= FALSE
;
800 current
->PageOut
= FALSE
;
801 current
->FileOffset
.QuadPart
= ROUND_DOWN(FileOffset
, VACB_MAPPING_GRANULARITY
);
802 current
->SharedCacheMap
= SharedCacheMap
;
804 if (SharedCacheMap
->Trace
)
806 DPRINT1("CacheMap 0x%p: new VACB: 0x%p\n", SharedCacheMap
, current
);
809 current
->MappedCount
= 0;
810 current
->DirtyVacbListEntry
.Flink
= NULL
;
811 current
->DirtyVacbListEntry
.Blink
= NULL
;
812 current
->ReferenceCount
= 1;
813 current
->PinCount
= 0;
814 KeInitializeMutex(¤t
->Mutex
, 0);
815 CcRosAcquireVacbLock(current
, NULL
);
816 KeAcquireGuardedMutex(&ViewLock
);
819 /* There is window between the call to CcRosLookupVacb
820 * and CcRosCreateVacb. We must check if a VACB for the
821 * file offset exist. If there is a VACB, we release
822 * our newly created VACB and return the existing one.
824 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
825 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
827 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
829 current
= CONTAINING_RECORD(current_entry
,
831 CacheMapVacbListEntry
);
832 if (IsPointInRange(current
->FileOffset
.QuadPart
,
833 VACB_MAPPING_GRANULARITY
,
836 CcRosVacbIncRefCount(current
);
837 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
839 if (SharedCacheMap
->Trace
)
841 DPRINT1("CacheMap 0x%p: deleting newly created VACB 0x%p ( found existing one 0x%p )\n",
847 CcRosReleaseVacbLock(*Vacb
);
848 KeReleaseGuardedMutex(&ViewLock
);
849 ExFreeToNPagedLookasideList(&VacbLookasideList
, *Vacb
);
851 CcRosAcquireVacbLock(current
, NULL
);
852 return STATUS_SUCCESS
;
854 if (current
->FileOffset
.QuadPart
< FileOffset
)
856 ASSERT(previous
== NULL
||
857 previous
->FileOffset
.QuadPart
< current
->FileOffset
.QuadPart
);
860 if (current
->FileOffset
.QuadPart
> FileOffset
)
862 current_entry
= current_entry
->Flink
;
864 /* There was no existing VACB. */
868 InsertHeadList(&previous
->CacheMapVacbListEntry
, ¤t
->CacheMapVacbListEntry
);
872 InsertHeadList(&SharedCacheMap
->CacheMapVacbListHead
, ¤t
->CacheMapVacbListEntry
);
874 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
875 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
876 KeReleaseGuardedMutex(&ViewLock
);
878 MI_SET_USAGE(MI_USAGE_CACHE
);
880 if ((SharedCacheMap
->FileObject
) && (SharedCacheMap
->FileObject
->FileName
.Buffer
))
884 pos
= wcsrchr(SharedCacheMap
->FileObject
->FileName
.Buffer
, '\\');
887 len
= wcslen(pos
) * sizeof(WCHAR
);
888 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%S", pos
);
892 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%wZ", &SharedCacheMap
->FileObject
->FileName
);
897 Status
= CcRosMapVacb(current
);
898 if (!NT_SUCCESS(Status
))
900 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
901 RemoveEntryList(¤t
->VacbLruListEntry
);
902 CcRosReleaseVacbLock(current
);
903 ExFreeToNPagedLookasideList(&VacbLookasideList
, current
);
912 PROS_SHARED_CACHE_MAP SharedCacheMap
,
914 PLONGLONG BaseOffset
,
922 ASSERT(SharedCacheMap
);
924 DPRINT("CcRosGetVacb()\n");
927 * Look for a VACB already mapping the same data.
929 current
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
933 * Otherwise create a new VACB.
935 Status
= CcRosCreateVacb(SharedCacheMap
, FileOffset
, ¤t
);
936 if (!NT_SUCCESS(Status
))
942 KeAcquireGuardedMutex(&ViewLock
);
944 /* Move to the tail of the LRU list */
945 RemoveEntryList(¤t
->VacbLruListEntry
);
946 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
948 KeReleaseGuardedMutex(&ViewLock
);
951 * Return information about the VACB to the caller.
953 *UptoDate
= current
->Valid
;
954 *BaseAddress
= current
->BaseAddress
;
955 DPRINT("*BaseAddress %p\n", *BaseAddress
);
957 *BaseOffset
= current
->FileOffset
.QuadPart
;
958 return STATUS_SUCCESS
;
964 PROS_SHARED_CACHE_MAP SharedCacheMap
,
970 * FUNCTION: Request a page mapping for a shared cache map
975 ASSERT(SharedCacheMap
);
977 if (FileOffset
% VACB_MAPPING_GRANULARITY
!= 0)
979 DPRINT1("Bad fileoffset %I64x should be multiple of %x",
980 FileOffset
, VACB_MAPPING_GRANULARITY
);
981 KeBugCheck(CACHE_MANAGER
);
984 return CcRosGetVacb(SharedCacheMap
,
996 MEMORY_AREA
* MemoryArea
,
1002 ASSERT(SwapEntry
== 0);
1005 ASSERT(MmGetReferenceCountPage(Page
) == 1);
1006 MmReleasePageMemoryConsumer(MC_CACHE
, Page
);
1011 CcRosInternalFreeVacb (
1014 * FUNCTION: Releases a VACB associated with a shared cache map
1017 DPRINT("Freeing VACB 0x%p\n", Vacb
);
1019 if (Vacb
->SharedCacheMap
->Trace
)
1021 DPRINT1("CacheMap 0x%p: deleting VACB: 0x%p\n", Vacb
->SharedCacheMap
, Vacb
);
1025 MmLockAddressSpace(MmGetKernelAddressSpace());
1026 MmFreeMemoryArea(MmGetKernelAddressSpace(),
1030 MmUnlockAddressSpace(MmGetKernelAddressSpace());
1032 ExFreeToNPagedLookasideList(&VacbLookasideList
, Vacb
);
1033 return STATUS_SUCCESS
;
1042 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
,
1043 IN PLARGE_INTEGER FileOffset OPTIONAL
,
1045 OUT PIO_STATUS_BLOCK IoStatus
)
1047 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1048 LARGE_INTEGER Offset
;
1049 LONGLONG RemainingLength
;
1054 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p FileOffset=%p Length=%lu\n",
1055 SectionObjectPointers
, FileOffset
, Length
);
1057 DPRINT("CcFlushCache(SectionObjectPointers 0x%p, FileOffset 0x%p, Length %lu, IoStatus 0x%p)\n",
1058 SectionObjectPointers
, FileOffset
, Length
, IoStatus
);
1060 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1062 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
1063 ASSERT(SharedCacheMap
);
1066 Offset
= *FileOffset
;
1067 RemainingLength
= Length
;
1071 Offset
.QuadPart
= 0;
1072 RemainingLength
= SharedCacheMap
->FileSize
.QuadPart
;
1077 IoStatus
->Status
= STATUS_SUCCESS
;
1078 IoStatus
->Information
= 0;
1081 while (RemainingLength
> 0)
1083 current
= CcRosLookupVacb(SharedCacheMap
, Offset
.QuadPart
);
1084 if (current
!= NULL
)
1088 Status
= CcRosFlushVacb(current
);
1089 if (!NT_SUCCESS(Status
) && IoStatus
!= NULL
)
1091 IoStatus
->Status
= Status
;
1095 CcRosReleaseVacbLock(current
);
1097 KeAcquireGuardedMutex(&ViewLock
);
1098 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1099 CcRosVacbDecRefCount(current
);
1100 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1101 KeReleaseGuardedMutex(&ViewLock
);
1104 Offset
.QuadPart
+= VACB_MAPPING_GRANULARITY
;
1105 RemainingLength
-= min(RemainingLength
, VACB_MAPPING_GRANULARITY
);
1112 IoStatus
->Status
= STATUS_INVALID_PARAMETER
;
1119 CcRosDeleteFileCache (
1120 PFILE_OBJECT FileObject
,
1121 PROS_SHARED_CACHE_MAP SharedCacheMap
)
1123 * FUNCTION: Releases the shared cache map associated with a file object
1126 PLIST_ENTRY current_entry
;
1128 LIST_ENTRY FreeList
;
1131 ASSERT(SharedCacheMap
);
1133 SharedCacheMap
->OpenCount
++;
1134 KeReleaseGuardedMutex(&ViewLock
);
1136 CcFlushCache(FileObject
->SectionObjectPointer
, NULL
, 0, NULL
);
1138 KeAcquireGuardedMutex(&ViewLock
);
1139 SharedCacheMap
->OpenCount
--;
1140 if (SharedCacheMap
->OpenCount
== 0)
1142 FileObject
->SectionObjectPointer
->SharedCacheMap
= NULL
;
1147 InitializeListHead(&FreeList
);
1148 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1149 while (!IsListEmpty(&SharedCacheMap
->CacheMapVacbListHead
))
1151 current_entry
= RemoveTailList(&SharedCacheMap
->CacheMapVacbListHead
);
1152 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1153 RemoveEntryList(¤t
->VacbLruListEntry
);
1156 RemoveEntryList(¤t
->DirtyVacbListEntry
);
1157 CcTotalDirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
1158 DPRINT1("Freeing dirty VACB\n");
1160 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
1163 SharedCacheMap
->Trace
= FALSE
;
1165 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1167 KeReleaseGuardedMutex(&ViewLock
);
1168 ObDereferenceObject(SharedCacheMap
->FileObject
);
1170 while (!IsListEmpty(&FreeList
))
1172 current_entry
= RemoveTailList(&FreeList
);
1173 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1174 CcRosInternalFreeVacb(current
);
1176 ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList
, SharedCacheMap
);
1177 KeAcquireGuardedMutex(&ViewLock
);
1179 return STATUS_SUCCESS
;
1184 CcRosReferenceCache (
1185 PFILE_OBJECT FileObject
)
1187 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1188 KeAcquireGuardedMutex(&ViewLock
);
1189 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1190 ASSERT(SharedCacheMap
);
1191 ASSERT(SharedCacheMap
->OpenCount
!= 0);
1192 SharedCacheMap
->OpenCount
++;
1193 KeReleaseGuardedMutex(&ViewLock
);
1198 CcRosRemoveIfClosed (
1199 PSECTION_OBJECT_POINTERS SectionObjectPointer
)
1201 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1202 DPRINT("CcRosRemoveIfClosed()\n");
1203 KeAcquireGuardedMutex(&ViewLock
);
1204 SharedCacheMap
= SectionObjectPointer
->SharedCacheMap
;
1205 if (SharedCacheMap
&& SharedCacheMap
->OpenCount
== 0)
1207 CcRosDeleteFileCache(SharedCacheMap
->FileObject
, SharedCacheMap
);
1209 KeReleaseGuardedMutex(&ViewLock
);
1215 CcRosDereferenceCache (
1216 PFILE_OBJECT FileObject
)
1218 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1219 KeAcquireGuardedMutex(&ViewLock
);
1220 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1221 ASSERT(SharedCacheMap
);
1222 if (SharedCacheMap
->OpenCount
> 0)
1224 SharedCacheMap
->OpenCount
--;
1225 if (SharedCacheMap
->OpenCount
== 0)
1227 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1228 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1231 KeReleaseGuardedMutex(&ViewLock
);
1236 CcRosReleaseFileCache (
1237 PFILE_OBJECT FileObject
)
1239 * FUNCTION: Called by the file system when a handle to a file object
1243 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1245 KeAcquireGuardedMutex(&ViewLock
);
1247 if (FileObject
->SectionObjectPointer
->SharedCacheMap
!= NULL
)
1249 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1250 if (FileObject
->PrivateCacheMap
!= NULL
)
1252 FileObject
->PrivateCacheMap
= NULL
;
1253 if (SharedCacheMap
->OpenCount
> 0)
1255 SharedCacheMap
->OpenCount
--;
1256 if (SharedCacheMap
->OpenCount
== 0)
1258 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1259 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1264 KeReleaseGuardedMutex(&ViewLock
);
1265 return STATUS_SUCCESS
;
1270 CcTryToInitializeFileCache (
1271 PFILE_OBJECT FileObject
)
1273 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1276 KeAcquireGuardedMutex(&ViewLock
);
1278 ASSERT(FileObject
->SectionObjectPointer
);
1279 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1280 if (SharedCacheMap
== NULL
)
1282 Status
= STATUS_UNSUCCESSFUL
;
1286 if (FileObject
->PrivateCacheMap
== NULL
)
1288 FileObject
->PrivateCacheMap
= SharedCacheMap
;
1289 SharedCacheMap
->OpenCount
++;
1291 Status
= STATUS_SUCCESS
;
1293 KeReleaseGuardedMutex(&ViewLock
);
1301 CcRosInitializeFileCache (
1302 PFILE_OBJECT FileObject
,
1303 PCC_FILE_SIZES FileSizes
,
1305 PCACHE_MANAGER_CALLBACKS CallBacks
,
1306 PVOID LazyWriterContext
)
1308 * FUNCTION: Initializes a shared cache map for a file object
1311 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1313 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1314 DPRINT("CcRosInitializeFileCache(FileObject 0x%p, SharedCacheMap 0x%p)\n",
1315 FileObject
, SharedCacheMap
);
1317 KeAcquireGuardedMutex(&ViewLock
);
1318 if (SharedCacheMap
== NULL
)
1320 SharedCacheMap
= ExAllocateFromNPagedLookasideList(&SharedCacheMapLookasideList
);
1321 if (SharedCacheMap
== NULL
)
1323 KeReleaseGuardedMutex(&ViewLock
);
1324 return STATUS_INSUFFICIENT_RESOURCES
;
1326 RtlZeroMemory(SharedCacheMap
, sizeof(*SharedCacheMap
));
1327 ObReferenceObjectByPointer(FileObject
,
1331 SharedCacheMap
->FileObject
= FileObject
;
1332 SharedCacheMap
->Callbacks
= CallBacks
;
1333 SharedCacheMap
->LazyWriteContext
= LazyWriterContext
;
1334 SharedCacheMap
->SectionSize
= FileSizes
->AllocationSize
;
1335 SharedCacheMap
->FileSize
= FileSizes
->FileSize
;
1336 SharedCacheMap
->PinAccess
= PinAccess
;
1337 SharedCacheMap
->DirtyPageThreshold
= 0;
1338 KeInitializeSpinLock(&SharedCacheMap
->CacheMapLock
);
1339 InitializeListHead(&SharedCacheMap
->CacheMapVacbListHead
);
1340 FileObject
->SectionObjectPointer
->SharedCacheMap
= SharedCacheMap
;
1342 if (FileObject
->PrivateCacheMap
== NULL
)
1344 FileObject
->PrivateCacheMap
= SharedCacheMap
;
1345 SharedCacheMap
->OpenCount
++;
1347 KeReleaseGuardedMutex(&ViewLock
);
1349 return STATUS_SUCCESS
;
1357 CcGetFileObjectFromSectionPtrs (
1358 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
)
1360 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1362 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p\n", SectionObjectPointers
);
1364 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1366 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
1367 ASSERT(SharedCacheMap
);
1368 return SharedCacheMap
->FileObject
;
1375 CcShutdownLazyWriter (
1378 /* Simply set the event, lazy writer will stop when it's done */
1379 KeSetEvent(&iLazyWriterShutdown
, IO_DISK_INCREMENT
, FALSE
);
1391 OBJECT_ATTRIBUTES ObjectAttributes
;
1393 DPRINT("CcInitView()\n");
1395 InitializeListHead(&DirtyVacbListHead
);
1396 InitializeListHead(&VacbLruListHead
);
1397 InitializeListHead(&CcDeferredWrites
);
1398 KeInitializeSpinLock(&CcDeferredWriteSpinLock
);
1399 KeInitializeGuardedMutex(&ViewLock
);
1400 ExInitializeNPagedLookasideList(&iBcbLookasideList
,
1404 sizeof(INTERNAL_BCB
),
1407 ExInitializeNPagedLookasideList(&SharedCacheMapLookasideList
,
1411 sizeof(ROS_SHARED_CACHE_MAP
),
1412 TAG_SHARED_CACHE_MAP
,
1414 ExInitializeNPagedLookasideList(&VacbLookasideList
,
1422 MmInitializeMemoryConsumer(MC_CACHE
, CcRosTrimCache
);
1424 /* Initialize lazy writer events */
1425 KeInitializeEvent(&iLazyWriterShutdown
, SynchronizationEvent
, FALSE
);
1426 KeInitializeEvent(&iLazyWriterNotify
, NotificationEvent
, FALSE
);
1428 /* Define lazy writer threshold, depending on system type */
1429 switch (MmQuerySystemSize())
1432 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 8;
1435 case MmMediumSystem
:
1436 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 4;
1440 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 8 + MmNumberOfPhysicalPages
/ 4;
1444 /* Start the lazy writer thread */
1445 InitializeObjectAttributes(&ObjectAttributes
,
1450 Status
= PsCreateSystemThread(&LazyWriter
,
1457 if (!NT_SUCCESS(Status
))
1463 Status
= NtSetInformationThread(LazyWriter
,
1467 ASSERT(NT_SUCCESS(Status
));
1469 /* Handle is not needed */
1470 ObCloseHandle(LazyWriter
, KernelMode
);
1472 CcInitCacheZeroPage();