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)
10 /* NOTES **********************************************************************
12 * This is not the NT implementation of a file cache nor anything much like
15 * The general procedure for a filesystem to implement a read or write
16 * dispatch routine is as follows
18 * (1) If caching for the FCB hasn't been initiated then so do by calling
19 * CcInitializeFileCache.
21 * (2) For each 4k region which is being read or written obtain a cache page
22 * by calling CcRequestCachePage.
24 * (3) If either the page is being read or not completely written, and it is
25 * not up to date then read its data from the underlying medium. If the read
26 * fails then call CcReleaseCachePage with VALID as FALSE and return a error.
28 * (4) Copy the data into or out of the page as necessary.
30 * (5) Release the cache page
32 /* INCLUDES ******************************************************************/
38 #if defined (ALLOC_PRAGMA)
39 #pragma alloc_text(INIT, CcInitView)
42 /* GLOBALS *******************************************************************/
44 LIST_ENTRY DirtyVacbListHead
;
45 static LIST_ENTRY VacbLruListHead
;
47 KGUARDED_MUTEX ViewLock
;
49 NPAGED_LOOKASIDE_LIST iBcbLookasideList
;
50 static NPAGED_LOOKASIDE_LIST SharedCacheMapLookasideList
;
51 static NPAGED_LOOKASIDE_LIST VacbLookasideList
;
54 * - Amount of pages flushed by lazy writer
55 * - Number of times lazy writer ran
57 ULONG CcLazyWritePages
= 0;
58 ULONG CcLazyWriteIos
= 0;
60 /* Internal vars (MS):
61 * - Threshold above which lazy writer will start action
62 * - Amount of dirty pages
64 ULONG CcDirtyPageThreshold
= 0;
65 ULONG CcTotalDirtyPages
= 0;
67 /* Internal vars (ROS):
68 * - Event to notify lazy writer to shutdown
69 * - Event to inform watchers lazy writer is done for this loop
71 KEVENT iLazyWriterShutdown
;
72 KEVENT iLazyWriterNotify
;
75 static void CcRosVacbIncRefCount_(PROS_VACB vacb
, const char* file
, int line
)
77 ++vacb
->ReferenceCount
;
78 if (vacb
->SharedCacheMap
->Trace
)
80 DbgPrint("(%s:%i) VACB %p ++RefCount=%lu, Dirty %u, PageOut %lu\n",
81 file
, line
, vacb
, vacb
->ReferenceCount
, vacb
->Dirty
, vacb
->PageOut
);
84 static void CcRosVacbDecRefCount_(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 #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
);
160 Status
= CcWriteVirtualAddress(Vacb
);
161 if (NT_SUCCESS(Status
))
163 KeAcquireGuardedMutex(&ViewLock
);
164 KeAcquireSpinLock(&Vacb
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
167 RemoveEntryList(&Vacb
->DirtyVacbListEntry
);
168 CcTotalDirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
169 CcRosVacbDecRefCount(Vacb
);
171 KeReleaseSpinLock(&Vacb
->SharedCacheMap
->CacheMapLock
, oldIrql
);
172 KeReleaseGuardedMutex(&ViewLock
);
180 CcRosFlushDirtyPages (
184 BOOLEAN CalledFromLazy
)
186 PLIST_ENTRY current_entry
;
190 LARGE_INTEGER ZeroTimeout
;
192 DPRINT("CcRosFlushDirtyPages(Target %lu)\n", Target
);
195 ZeroTimeout
.QuadPart
= 0;
197 KeEnterCriticalRegion();
198 KeAcquireGuardedMutex(&ViewLock
);
200 current_entry
= DirtyVacbListHead
.Flink
;
201 if (current_entry
== &DirtyVacbListHead
)
203 DPRINT("No Dirty pages\n");
206 while ((current_entry
!= &DirtyVacbListHead
) && (Target
> 0))
208 current
= CONTAINING_RECORD(current_entry
,
211 current_entry
= current_entry
->Flink
;
213 CcRosVacbIncRefCount(current
);
215 /* When performing lazy write, don't handle temporary files */
216 if (CalledFromLazy
&&
217 BooleanFlagOn(current
->SharedCacheMap
->FileObject
->Flags
, FO_TEMPORARY_FILE
))
219 CcRosVacbDecRefCount(current
);
223 Locked
= current
->SharedCacheMap
->Callbacks
->AcquireForLazyWrite(
224 current
->SharedCacheMap
->LazyWriteContext
, Wait
);
227 CcRosVacbDecRefCount(current
);
231 Status
= CcRosAcquireVacbLock(current
,
232 Wait
? NULL
: &ZeroTimeout
);
233 if (Status
!= STATUS_SUCCESS
)
235 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
236 current
->SharedCacheMap
->LazyWriteContext
);
237 CcRosVacbDecRefCount(current
);
241 ASSERT(current
->Dirty
);
243 /* One reference is added above */
244 if (current
->ReferenceCount
> 2)
246 CcRosReleaseVacbLock(current
);
247 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
248 current
->SharedCacheMap
->LazyWriteContext
);
249 CcRosVacbDecRefCount(current
);
253 KeReleaseGuardedMutex(&ViewLock
);
255 Status
= CcRosFlushVacb(current
);
257 CcRosReleaseVacbLock(current
);
258 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
259 current
->SharedCacheMap
->LazyWriteContext
);
261 KeAcquireGuardedMutex(&ViewLock
);
262 CcRosVacbDecRefCount(current
);
264 if (!NT_SUCCESS(Status
) && (Status
!= STATUS_END_OF_FILE
) &&
265 (Status
!= STATUS_MEDIA_WRITE_PROTECTED
))
267 DPRINT1("CC: Failed to flush VACB.\n");
273 /* How many pages did we free? */
274 PagesFreed
= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
275 (*Count
) += PagesFreed
;
277 /* Make sure we don't overflow target! */
278 if (Target
< PagesFreed
)
280 /* If we would have, jump to zero directly */
285 Target
-= PagesFreed
;
289 current_entry
= DirtyVacbListHead
.Flink
;
292 KeReleaseGuardedMutex(&ViewLock
);
293 KeLeaveCriticalRegion();
295 DPRINT("CcRosFlushDirtyPages() finished\n");
296 return STATUS_SUCCESS
;
299 /* FIXME: Someday this could somewhat implement write-behind/read-ahead */
302 CciLazyWriter(PVOID Unused
)
304 LARGE_INTEGER OneSecond
;
306 OneSecond
.QuadPart
= (LONGLONG
)-1*1000*1000*10;
311 ULONG Target
, Count
= 0;
313 /* One per second or until we have to stop */
314 Status
= KeWaitForSingleObject(&iLazyWriterShutdown
,
320 /* If we succeeed, we've to stop running! */
321 if (Status
== STATUS_SUCCESS
)
326 /* We're not sleeping anymore */
327 KeClearEvent(&iLazyWriterNotify
);
329 /* Our target is one-eighth of the dirty pages */
330 Target
= CcTotalDirtyPages
/ 8;
334 DPRINT("Lazy writer starting (%d)\n", Target
);
335 CcRosFlushDirtyPages(Target
, &Count
, FALSE
, TRUE
);
337 /* And update stats */
338 CcLazyWritePages
+= Count
;
340 DPRINT("Lazy writer done (%d)\n", Count
);
343 /* Inform people waiting on us that we're done */
344 KeSetEvent(&iLazyWriterNotify
, IO_DISK_INCREMENT
, FALSE
);
354 * FUNCTION: Try to free some memory from the file cache.
356 * Target - The number of pages to be freed.
357 * Priority - The priority of free (currently unused).
358 * NrFreed - Points to a variable where the number of pages
359 * actually freed is returned.
362 PLIST_ENTRY current_entry
;
369 BOOLEAN FlushedPages
= FALSE
;
371 DPRINT("CcRosTrimCache(Target %lu)\n", Target
);
373 InitializeListHead(&FreeList
);
378 KeAcquireGuardedMutex(&ViewLock
);
380 current_entry
= VacbLruListHead
.Flink
;
381 while (current_entry
!= &VacbLruListHead
)
383 current
= CONTAINING_RECORD(current_entry
,
386 current_entry
= current_entry
->Flink
;
388 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
390 /* Reference the VACB */
391 CcRosVacbIncRefCount(current
);
393 /* Check if it's mapped and not dirty */
394 if (current
->MappedCount
> 0 && !current
->Dirty
)
396 /* We have to break these locks because Cc sucks */
397 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
398 KeReleaseGuardedMutex(&ViewLock
);
400 /* Page out the VACB */
401 for (i
= 0; i
< VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
; i
++)
403 Page
= (PFN_NUMBER
)(MmGetPhysicalAddress((PUCHAR
)current
->BaseAddress
+ (i
* PAGE_SIZE
)).QuadPart
>> PAGE_SHIFT
);
405 MmPageOutPhysicalAddress(Page
);
408 /* Reacquire the locks */
409 KeAcquireGuardedMutex(&ViewLock
);
410 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
413 /* Dereference the VACB */
414 CcRosVacbDecRefCount(current
);
416 /* Check if we can free this entry now */
417 if (current
->ReferenceCount
== 0)
419 ASSERT(!current
->Dirty
);
420 ASSERT(!current
->MappedCount
);
422 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
423 RemoveEntryList(¤t
->VacbLruListEntry
);
424 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
426 /* Calculate how many pages we freed for Mm */
427 PagesFreed
= min(VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
, Target
);
428 Target
-= PagesFreed
;
429 (*NrFreed
) += PagesFreed
;
432 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
435 KeReleaseGuardedMutex(&ViewLock
);
437 /* Try flushing pages if we haven't met our target */
438 if ((Target
> 0) && !FlushedPages
)
440 /* Flush dirty pages to disk */
441 CcRosFlushDirtyPages(Target
, &PagesFreed
, FALSE
, FALSE
);
444 /* We can only swap as many pages as we flushed */
445 if (PagesFreed
< Target
) Target
= PagesFreed
;
447 /* Check if we flushed anything */
450 /* Try again after flushing dirty pages */
451 DPRINT("Flushed %lu dirty cache pages to disk\n", PagesFreed
);
456 while (!IsListEmpty(&FreeList
))
458 current_entry
= RemoveHeadList(&FreeList
);
459 current
= CONTAINING_RECORD(current_entry
,
461 CacheMapVacbListEntry
);
462 CcRosInternalFreeVacb(current
);
465 DPRINT("Evicted %lu cache pages\n", (*NrFreed
));
467 return STATUS_SUCCESS
;
473 PROS_SHARED_CACHE_MAP SharedCacheMap
,
482 ASSERT(SharedCacheMap
);
484 DPRINT("CcRosReleaseVacb(SharedCacheMap 0x%p, Vacb 0x%p, Valid %u)\n",
485 SharedCacheMap
, Vacb
, Valid
);
487 KeAcquireGuardedMutex(&ViewLock
);
488 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
492 WasDirty
= Vacb
->Dirty
;
493 Vacb
->Dirty
= Vacb
->Dirty
|| Dirty
;
495 if (!WasDirty
&& Vacb
->Dirty
)
497 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
498 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
505 CcRosVacbDecRefCount(Vacb
);
506 if (Mapped
&& (Vacb
->MappedCount
== 1))
508 CcRosVacbIncRefCount(Vacb
);
510 if (!WasDirty
&& Vacb
->Dirty
)
512 CcRosVacbIncRefCount(Vacb
);
515 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
516 KeReleaseGuardedMutex(&ViewLock
);
517 CcRosReleaseVacbLock(Vacb
);
519 return STATUS_SUCCESS
;
522 /* Returns with VACB Lock Held! */
526 PROS_SHARED_CACHE_MAP SharedCacheMap
,
529 PLIST_ENTRY current_entry
;
533 ASSERT(SharedCacheMap
);
535 DPRINT("CcRosLookupVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
536 SharedCacheMap
, FileOffset
);
538 KeAcquireGuardedMutex(&ViewLock
);
539 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
541 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
542 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
544 current
= CONTAINING_RECORD(current_entry
,
546 CacheMapVacbListEntry
);
547 if (IsPointInRange(current
->FileOffset
.QuadPart
,
548 VACB_MAPPING_GRANULARITY
,
551 CcRosVacbIncRefCount(current
);
552 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
553 KeReleaseGuardedMutex(&ViewLock
);
554 CcRosAcquireVacbLock(current
, NULL
);
557 if (current
->FileOffset
.QuadPart
> FileOffset
)
559 current_entry
= current_entry
->Flink
;
562 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
563 KeReleaseGuardedMutex(&ViewLock
);
571 PROS_SHARED_CACHE_MAP SharedCacheMap
,
577 ASSERT(SharedCacheMap
);
579 DPRINT("CcRosMarkDirtyVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
580 SharedCacheMap
, FileOffset
);
582 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
585 KeBugCheck(CACHE_MANAGER
);
588 KeAcquireGuardedMutex(&ViewLock
);
589 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
593 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
594 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
598 CcRosVacbDecRefCount(Vacb
);
601 /* Move to the tail of the LRU list */
602 RemoveEntryList(&Vacb
->VacbLruListEntry
);
603 InsertTailList(&VacbLruListHead
, &Vacb
->VacbLruListEntry
);
607 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
608 KeReleaseGuardedMutex(&ViewLock
);
609 CcRosReleaseVacbLock(Vacb
);
611 return STATUS_SUCCESS
;
617 PROS_SHARED_CACHE_MAP SharedCacheMap
,
625 ASSERT(SharedCacheMap
);
627 DPRINT("CcRosUnmapVacb(SharedCacheMap 0x%p, FileOffset %I64u, NowDirty %u)\n",
628 SharedCacheMap
, FileOffset
, NowDirty
);
630 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
633 return STATUS_UNSUCCESSFUL
;
636 KeAcquireGuardedMutex(&ViewLock
);
637 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
639 WasDirty
= Vacb
->Dirty
;
640 Vacb
->Dirty
= Vacb
->Dirty
|| NowDirty
;
644 if (!WasDirty
&& NowDirty
)
646 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
647 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
650 CcRosVacbDecRefCount(Vacb
);
651 if (!WasDirty
&& NowDirty
)
653 CcRosVacbIncRefCount(Vacb
);
655 if (Vacb
->MappedCount
== 0)
657 CcRosVacbDecRefCount(Vacb
);
660 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
661 KeReleaseGuardedMutex(&ViewLock
);
662 CcRosReleaseVacbLock(Vacb
);
664 return STATUS_SUCCESS
;
674 ULONG_PTR NumberOfPages
;
676 /* Create a memory area. */
677 MmLockAddressSpace(MmGetKernelAddressSpace());
678 Status
= MmCreateMemoryArea(MmGetKernelAddressSpace(),
679 0, // nothing checks for VACB mareas, so set to 0
681 VACB_MAPPING_GRANULARITY
,
683 (PMEMORY_AREA
*)&Vacb
->MemoryArea
,
686 MmUnlockAddressSpace(MmGetKernelAddressSpace());
687 if (!NT_SUCCESS(Status
))
689 DPRINT1("MmCreateMemoryArea failed with %lx for VACB %p\n", Status
, Vacb
);
693 ASSERT(((ULONG_PTR
)Vacb
->BaseAddress
% PAGE_SIZE
) == 0);
694 ASSERT((ULONG_PTR
)Vacb
->BaseAddress
> (ULONG_PTR
)MmSystemRangeStart
);
696 /* Create a virtual mapping for this memory area */
697 NumberOfPages
= BYTES_TO_PAGES(VACB_MAPPING_GRANULARITY
);
698 for (i
= 0; i
< NumberOfPages
; i
++)
700 PFN_NUMBER PageFrameNumber
;
702 MI_SET_USAGE(MI_USAGE_CACHE
);
703 Status
= MmRequestPageMemoryConsumer(MC_CACHE
, TRUE
, &PageFrameNumber
);
704 if (PageFrameNumber
== 0)
706 DPRINT1("Unable to allocate page\n");
707 KeBugCheck(MEMORY_MANAGEMENT
);
710 Status
= MmCreateVirtualMapping(NULL
,
711 (PVOID
)((ULONG_PTR
)Vacb
->BaseAddress
+ (i
* PAGE_SIZE
)),
715 if (!NT_SUCCESS(Status
))
717 DPRINT1("Unable to create virtual mapping\n");
718 KeBugCheck(MEMORY_MANAGEMENT
);
722 return STATUS_SUCCESS
;
728 PROS_SHARED_CACHE_MAP SharedCacheMap
,
734 PLIST_ENTRY current_entry
;
738 ASSERT(SharedCacheMap
);
740 DPRINT("CcRosCreateVacb()\n");
742 if (FileOffset
>= SharedCacheMap
->SectionSize
.QuadPart
)
745 return STATUS_INVALID_PARAMETER
;
748 current
= ExAllocateFromNPagedLookasideList(&VacbLookasideList
);
749 current
->BaseAddress
= NULL
;
750 current
->Valid
= FALSE
;
751 current
->Dirty
= FALSE
;
752 current
->PageOut
= FALSE
;
753 current
->FileOffset
.QuadPart
= ROUND_DOWN(FileOffset
, VACB_MAPPING_GRANULARITY
);
754 current
->SharedCacheMap
= SharedCacheMap
;
756 if (SharedCacheMap
->Trace
)
758 DPRINT1("CacheMap 0x%p: new VACB: 0x%p\n", SharedCacheMap
, current
);
761 current
->MappedCount
= 0;
762 current
->DirtyVacbListEntry
.Flink
= NULL
;
763 current
->DirtyVacbListEntry
.Blink
= NULL
;
764 current
->ReferenceCount
= 1;
765 current
->PinCount
= 0;
766 KeInitializeMutex(¤t
->Mutex
, 0);
767 CcRosAcquireVacbLock(current
, NULL
);
768 KeAcquireGuardedMutex(&ViewLock
);
771 /* There is window between the call to CcRosLookupVacb
772 * and CcRosCreateVacb. We must check if a VACB for the
773 * file offset exist. If there is a VACB, we release
774 * our newly created VACB and return the existing one.
776 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
777 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
779 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
781 current
= CONTAINING_RECORD(current_entry
,
783 CacheMapVacbListEntry
);
784 if (IsPointInRange(current
->FileOffset
.QuadPart
,
785 VACB_MAPPING_GRANULARITY
,
788 CcRosVacbIncRefCount(current
);
789 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
791 if (SharedCacheMap
->Trace
)
793 DPRINT1("CacheMap 0x%p: deleting newly created VACB 0x%p ( found existing one 0x%p )\n",
799 CcRosReleaseVacbLock(*Vacb
);
800 KeReleaseGuardedMutex(&ViewLock
);
801 ExFreeToNPagedLookasideList(&VacbLookasideList
, *Vacb
);
803 CcRosAcquireVacbLock(current
, NULL
);
804 return STATUS_SUCCESS
;
806 if (current
->FileOffset
.QuadPart
< FileOffset
)
808 ASSERT(previous
== NULL
||
809 previous
->FileOffset
.QuadPart
< current
->FileOffset
.QuadPart
);
812 if (current
->FileOffset
.QuadPart
> FileOffset
)
814 current_entry
= current_entry
->Flink
;
816 /* There was no existing VACB. */
820 InsertHeadList(&previous
->CacheMapVacbListEntry
, ¤t
->CacheMapVacbListEntry
);
824 InsertHeadList(&SharedCacheMap
->CacheMapVacbListHead
, ¤t
->CacheMapVacbListEntry
);
826 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
827 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
828 KeReleaseGuardedMutex(&ViewLock
);
830 MI_SET_USAGE(MI_USAGE_CACHE
);
832 if ((SharedCacheMap
->FileObject
) && (SharedCacheMap
->FileObject
->FileName
.Buffer
))
836 pos
= wcsrchr(SharedCacheMap
->FileObject
->FileName
.Buffer
, '\\');
839 len
= wcslen(pos
) * sizeof(WCHAR
);
840 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%S", pos
);
844 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%wZ", &SharedCacheMap
->FileObject
->FileName
);
849 Status
= CcRosMapVacb(current
);
850 if (!NT_SUCCESS(Status
))
852 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
853 RemoveEntryList(¤t
->VacbLruListEntry
);
854 CcRosReleaseVacbLock(current
);
855 ExFreeToNPagedLookasideList(&VacbLookasideList
, current
);
864 PROS_SHARED_CACHE_MAP SharedCacheMap
,
866 PLONGLONG BaseOffset
,
874 ASSERT(SharedCacheMap
);
876 DPRINT("CcRosGetVacb()\n");
879 * Look for a VACB already mapping the same data.
881 current
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
885 * Otherwise create a new VACB.
887 Status
= CcRosCreateVacb(SharedCacheMap
, FileOffset
, ¤t
);
888 if (!NT_SUCCESS(Status
))
894 KeAcquireGuardedMutex(&ViewLock
);
896 /* Move to the tail of the LRU list */
897 RemoveEntryList(¤t
->VacbLruListEntry
);
898 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
900 KeReleaseGuardedMutex(&ViewLock
);
903 * Return information about the VACB to the caller.
905 *UptoDate
= current
->Valid
;
906 *BaseAddress
= current
->BaseAddress
;
907 DPRINT("*BaseAddress %p\n", *BaseAddress
);
909 *BaseOffset
= current
->FileOffset
.QuadPart
;
910 return STATUS_SUCCESS
;
916 PROS_SHARED_CACHE_MAP SharedCacheMap
,
922 * FUNCTION: Request a page mapping for a shared cache map
927 ASSERT(SharedCacheMap
);
929 if (FileOffset
% VACB_MAPPING_GRANULARITY
!= 0)
931 DPRINT1("Bad fileoffset %I64x should be multiple of %x",
932 FileOffset
, VACB_MAPPING_GRANULARITY
);
933 KeBugCheck(CACHE_MANAGER
);
936 return CcRosGetVacb(SharedCacheMap
,
948 MEMORY_AREA
* MemoryArea
,
954 ASSERT(SwapEntry
== 0);
957 ASSERT(MmGetReferenceCountPage(Page
) == 1);
958 MmReleasePageMemoryConsumer(MC_CACHE
, Page
);
963 CcRosInternalFreeVacb (
966 * FUNCTION: Releases a VACB associated with a shared cache map
969 DPRINT("Freeing VACB 0x%p\n", Vacb
);
971 if (Vacb
->SharedCacheMap
->Trace
)
973 DPRINT1("CacheMap 0x%p: deleting VACB: 0x%p\n", Vacb
->SharedCacheMap
, Vacb
);
977 MmLockAddressSpace(MmGetKernelAddressSpace());
978 MmFreeMemoryArea(MmGetKernelAddressSpace(),
982 MmUnlockAddressSpace(MmGetKernelAddressSpace());
984 ExFreeToNPagedLookasideList(&VacbLookasideList
, Vacb
);
985 return STATUS_SUCCESS
;
994 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
,
995 IN PLARGE_INTEGER FileOffset OPTIONAL
,
997 OUT PIO_STATUS_BLOCK IoStatus
)
999 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1000 LARGE_INTEGER Offset
;
1001 LONGLONG RemainingLength
;
1006 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p FileOffset=%p Length=%lu\n",
1007 SectionObjectPointers
, FileOffset
, Length
);
1009 DPRINT("CcFlushCache(SectionObjectPointers 0x%p, FileOffset 0x%p, Length %lu, IoStatus 0x%p)\n",
1010 SectionObjectPointers
, FileOffset
, Length
, IoStatus
);
1012 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1014 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
1015 ASSERT(SharedCacheMap
);
1018 Offset
= *FileOffset
;
1019 RemainingLength
= Length
;
1023 Offset
.QuadPart
= 0;
1024 RemainingLength
= SharedCacheMap
->FileSize
.QuadPart
;
1029 IoStatus
->Status
= STATUS_SUCCESS
;
1030 IoStatus
->Information
= 0;
1033 while (RemainingLength
> 0)
1035 current
= CcRosLookupVacb(SharedCacheMap
, Offset
.QuadPart
);
1036 if (current
!= NULL
)
1040 Status
= CcRosFlushVacb(current
);
1041 if (!NT_SUCCESS(Status
) && IoStatus
!= NULL
)
1043 IoStatus
->Status
= Status
;
1047 CcRosReleaseVacbLock(current
);
1049 KeAcquireGuardedMutex(&ViewLock
);
1050 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1051 CcRosVacbDecRefCount(current
);
1052 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1053 KeReleaseGuardedMutex(&ViewLock
);
1056 Offset
.QuadPart
+= VACB_MAPPING_GRANULARITY
;
1057 RemainingLength
-= min(RemainingLength
, VACB_MAPPING_GRANULARITY
);
1064 IoStatus
->Status
= STATUS_INVALID_PARAMETER
;
1071 CcRosDeleteFileCache (
1072 PFILE_OBJECT FileObject
,
1073 PROS_SHARED_CACHE_MAP SharedCacheMap
)
1075 * FUNCTION: Releases the shared cache map associated with a file object
1078 PLIST_ENTRY current_entry
;
1080 LIST_ENTRY FreeList
;
1083 ASSERT(SharedCacheMap
);
1085 SharedCacheMap
->OpenCount
++;
1086 KeReleaseGuardedMutex(&ViewLock
);
1088 CcFlushCache(FileObject
->SectionObjectPointer
, NULL
, 0, NULL
);
1090 KeAcquireGuardedMutex(&ViewLock
);
1091 SharedCacheMap
->OpenCount
--;
1092 if (SharedCacheMap
->OpenCount
== 0)
1094 FileObject
->SectionObjectPointer
->SharedCacheMap
= NULL
;
1099 InitializeListHead(&FreeList
);
1100 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1101 while (!IsListEmpty(&SharedCacheMap
->CacheMapVacbListHead
))
1103 current_entry
= RemoveTailList(&SharedCacheMap
->CacheMapVacbListHead
);
1104 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1105 RemoveEntryList(¤t
->VacbLruListEntry
);
1108 RemoveEntryList(¤t
->DirtyVacbListEntry
);
1109 CcTotalDirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
1110 DPRINT1("Freeing dirty VACB\n");
1112 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
1115 SharedCacheMap
->Trace
= FALSE
;
1117 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1119 KeReleaseGuardedMutex(&ViewLock
);
1120 ObDereferenceObject(SharedCacheMap
->FileObject
);
1122 while (!IsListEmpty(&FreeList
))
1124 current_entry
= RemoveTailList(&FreeList
);
1125 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1126 CcRosInternalFreeVacb(current
);
1128 ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList
, SharedCacheMap
);
1129 KeAcquireGuardedMutex(&ViewLock
);
1131 return STATUS_SUCCESS
;
1136 CcRosReferenceCache (
1137 PFILE_OBJECT FileObject
)
1139 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1140 KeAcquireGuardedMutex(&ViewLock
);
1141 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1142 ASSERT(SharedCacheMap
);
1143 ASSERT(SharedCacheMap
->OpenCount
!= 0);
1144 SharedCacheMap
->OpenCount
++;
1145 KeReleaseGuardedMutex(&ViewLock
);
1150 CcRosRemoveIfClosed (
1151 PSECTION_OBJECT_POINTERS SectionObjectPointer
)
1153 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1154 DPRINT("CcRosRemoveIfClosed()\n");
1155 KeAcquireGuardedMutex(&ViewLock
);
1156 SharedCacheMap
= SectionObjectPointer
->SharedCacheMap
;
1157 if (SharedCacheMap
&& SharedCacheMap
->OpenCount
== 0)
1159 CcRosDeleteFileCache(SharedCacheMap
->FileObject
, SharedCacheMap
);
1161 KeReleaseGuardedMutex(&ViewLock
);
1167 CcRosDereferenceCache (
1168 PFILE_OBJECT FileObject
)
1170 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1171 KeAcquireGuardedMutex(&ViewLock
);
1172 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1173 ASSERT(SharedCacheMap
);
1174 if (SharedCacheMap
->OpenCount
> 0)
1176 SharedCacheMap
->OpenCount
--;
1177 if (SharedCacheMap
->OpenCount
== 0)
1179 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1180 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1183 KeReleaseGuardedMutex(&ViewLock
);
1188 CcRosReleaseFileCache (
1189 PFILE_OBJECT FileObject
)
1191 * FUNCTION: Called by the file system when a handle to a file object
1195 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1197 KeAcquireGuardedMutex(&ViewLock
);
1199 if (FileObject
->SectionObjectPointer
->SharedCacheMap
!= NULL
)
1201 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1202 if (FileObject
->PrivateCacheMap
!= NULL
)
1204 FileObject
->PrivateCacheMap
= NULL
;
1205 if (SharedCacheMap
->OpenCount
> 0)
1207 SharedCacheMap
->OpenCount
--;
1208 if (SharedCacheMap
->OpenCount
== 0)
1210 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1211 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1216 KeReleaseGuardedMutex(&ViewLock
);
1217 return STATUS_SUCCESS
;
1222 CcTryToInitializeFileCache (
1223 PFILE_OBJECT FileObject
)
1225 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1228 KeAcquireGuardedMutex(&ViewLock
);
1230 ASSERT(FileObject
->SectionObjectPointer
);
1231 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1232 if (SharedCacheMap
== NULL
)
1234 Status
= STATUS_UNSUCCESSFUL
;
1238 if (FileObject
->PrivateCacheMap
== NULL
)
1240 FileObject
->PrivateCacheMap
= SharedCacheMap
;
1241 SharedCacheMap
->OpenCount
++;
1243 Status
= STATUS_SUCCESS
;
1245 KeReleaseGuardedMutex(&ViewLock
);
1253 CcRosInitializeFileCache (
1254 PFILE_OBJECT FileObject
,
1255 PCC_FILE_SIZES FileSizes
,
1257 PCACHE_MANAGER_CALLBACKS CallBacks
,
1258 PVOID LazyWriterContext
)
1260 * FUNCTION: Initializes a shared cache map for a file object
1263 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1265 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1266 DPRINT("CcRosInitializeFileCache(FileObject 0x%p, SharedCacheMap 0x%p)\n",
1267 FileObject
, SharedCacheMap
);
1269 KeAcquireGuardedMutex(&ViewLock
);
1270 if (SharedCacheMap
== NULL
)
1272 SharedCacheMap
= ExAllocateFromNPagedLookasideList(&SharedCacheMapLookasideList
);
1273 if (SharedCacheMap
== NULL
)
1275 KeReleaseGuardedMutex(&ViewLock
);
1276 return STATUS_INSUFFICIENT_RESOURCES
;
1278 RtlZeroMemory(SharedCacheMap
, sizeof(*SharedCacheMap
));
1279 ObReferenceObjectByPointer(FileObject
,
1283 SharedCacheMap
->FileObject
= FileObject
;
1284 SharedCacheMap
->Callbacks
= CallBacks
;
1285 SharedCacheMap
->LazyWriteContext
= LazyWriterContext
;
1286 SharedCacheMap
->SectionSize
= FileSizes
->AllocationSize
;
1287 SharedCacheMap
->FileSize
= FileSizes
->FileSize
;
1288 SharedCacheMap
->PinAccess
= PinAccess
;
1289 KeInitializeSpinLock(&SharedCacheMap
->CacheMapLock
);
1290 InitializeListHead(&SharedCacheMap
->CacheMapVacbListHead
);
1291 FileObject
->SectionObjectPointer
->SharedCacheMap
= SharedCacheMap
;
1293 if (FileObject
->PrivateCacheMap
== NULL
)
1295 FileObject
->PrivateCacheMap
= SharedCacheMap
;
1296 SharedCacheMap
->OpenCount
++;
1298 KeReleaseGuardedMutex(&ViewLock
);
1300 return STATUS_SUCCESS
;
1308 CcGetFileObjectFromSectionPtrs (
1309 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
)
1311 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1313 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p\n", SectionObjectPointers
);
1315 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1317 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
1318 ASSERT(SharedCacheMap
);
1319 return SharedCacheMap
->FileObject
;
1326 CcShutdownLazyWriter (
1329 /* Simply set the event, lazy writer will stop when it's done */
1330 KeSetEvent(&iLazyWriterShutdown
, IO_DISK_INCREMENT
, FALSE
);
1341 OBJECT_ATTRIBUTES ObjectAttributes
;
1343 DPRINT("CcInitView()\n");
1345 InitializeListHead(&DirtyVacbListHead
);
1346 InitializeListHead(&VacbLruListHead
);
1347 KeInitializeGuardedMutex(&ViewLock
);
1348 ExInitializeNPagedLookasideList(&iBcbLookasideList
,
1352 sizeof(INTERNAL_BCB
),
1355 ExInitializeNPagedLookasideList(&SharedCacheMapLookasideList
,
1359 sizeof(ROS_SHARED_CACHE_MAP
),
1360 TAG_SHARED_CACHE_MAP
,
1362 ExInitializeNPagedLookasideList(&VacbLookasideList
,
1370 MmInitializeMemoryConsumer(MC_CACHE
, CcRosTrimCache
);
1372 /* Initialize lazy writer events */
1373 KeInitializeEvent(&iLazyWriterShutdown
, SynchronizationEvent
, FALSE
);
1374 KeInitializeEvent(&iLazyWriterNotify
, NotificationEvent
, FALSE
);
1376 /* Define lazy writer threshold, depending on system type */
1377 switch (MmQuerySystemSize())
1380 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 8;
1383 case MmMediumSystem
:
1384 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 4;
1388 CcDirtyPageThreshold
= MmNumberOfPhysicalPages
/ 8 + MmNumberOfPhysicalPages
/ 4;
1392 /* Start the lazy writer thread */
1393 InitializeObjectAttributes(&ObjectAttributes
,
1398 Status
= PsCreateSystemThread(&LazyWriter
,
1405 if (!NT_SUCCESS(Status
))
1410 /* Handle is not needed */
1411 ObCloseHandle(LazyWriter
, KernelMode
);
1413 CcInitCacheZeroPage();