2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: ntoskrnl/cc/view.c
5 * PURPOSE: Cache manager
7 * PROGRAMMERS: David Welch (welch@mcmail.com)
8 * Pierre Schweitzer (pierre@reactos.org)
11 /* NOTES **********************************************************************
13 * This is not the NT implementation of a file cache nor anything much like
16 * The general procedure for a filesystem to implement a read or write
17 * dispatch routine is as follows
19 * (1) If caching for the FCB hasn't been initiated then so do by calling
20 * CcInitializeFileCache.
22 * (2) For each 4k region which is being read or written obtain a cache page
23 * by calling CcRequestCachePage.
25 * (3) If either the page is being read or not completely written, and it is
26 * not up to date then read its data from the underlying medium. If the read
27 * fails then call CcReleaseCachePage with VALID as FALSE and return a error.
29 * (4) Copy the data into or out of the page as necessary.
31 * (5) Release the cache page
33 /* INCLUDES ******************************************************************/
39 #if defined (ALLOC_PRAGMA)
40 #pragma alloc_text(INIT, CcInitView)
43 /* GLOBALS *******************************************************************/
45 LIST_ENTRY DirtyVacbListHead
;
46 static LIST_ENTRY VacbLruListHead
;
48 KGUARDED_MUTEX ViewLock
;
50 NPAGED_LOOKASIDE_LIST iBcbLookasideList
;
51 static NPAGED_LOOKASIDE_LIST SharedCacheMapLookasideList
;
52 static NPAGED_LOOKASIDE_LIST VacbLookasideList
;
54 /* Internal vars (MS):
55 * - Threshold above which lazy writer will start action
56 * - Amount of dirty pages
57 * - List for deferred writes
58 * - Spinlock when dealing with the deferred list
59 * - List for "clean" shared cache maps
61 ULONG CcDirtyPageThreshold
= 0;
62 ULONG CcTotalDirtyPages
= 0;
63 LIST_ENTRY CcDeferredWrites
;
64 KSPIN_LOCK CcDeferredWriteSpinLock
;
65 LIST_ENTRY CcCleanSharedCacheMapList
;
67 /* Internal vars (ROS):
68 * - Lock for the CcCleanSharedCacheMapList list
70 KSPIN_LOCK iSharedCacheMapLock
;
73 static void CcRosVacbIncRefCount_(PROS_VACB vacb
, const char* file
, int line
)
75 ++vacb
->ReferenceCount
;
76 if (vacb
->SharedCacheMap
->Trace
)
78 DbgPrint("(%s:%i) VACB %p ++RefCount=%lu, Dirty %u, PageOut %lu\n",
79 file
, line
, vacb
, vacb
->ReferenceCount
, vacb
->Dirty
, vacb
->PageOut
);
82 static void CcRosVacbDecRefCount_(PROS_VACB vacb
, const char* file
, int line
)
84 ASSERT(vacb
->ReferenceCount
!= 0);
85 --vacb
->ReferenceCount
;
86 ASSERT(!(vacb
->ReferenceCount
== 0 && vacb
->Dirty
));
87 if (vacb
->SharedCacheMap
->Trace
)
89 DbgPrint("(%s:%i) VACB %p --RefCount=%lu, Dirty %u, PageOut %lu\n",
90 file
, line
, vacb
, vacb
->ReferenceCount
, vacb
->Dirty
, vacb
->PageOut
);
93 #define CcRosVacbIncRefCount(vacb) CcRosVacbIncRefCount_(vacb,__FILE__,__LINE__)
94 #define CcRosVacbDecRefCount(vacb) CcRosVacbDecRefCount_(vacb,__FILE__,__LINE__)
96 #define CcRosVacbIncRefCount(vacb) (++((vacb)->ReferenceCount))
97 #define CcRosVacbDecRefCount(vacb) (--((vacb)->ReferenceCount))
101 CcRosInternalFreeVacb(PROS_VACB Vacb
);
104 /* FUNCTIONS *****************************************************************/
109 PROS_SHARED_CACHE_MAP SharedCacheMap
,
114 PLIST_ENTRY current_entry
;
120 SharedCacheMap
->Trace
= Trace
;
124 DPRINT1("Enabling Tracing for CacheMap 0x%p:\n", SharedCacheMap
);
126 KeAcquireGuardedMutex(&ViewLock
);
127 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldirql
);
129 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
130 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
132 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
133 current_entry
= current_entry
->Flink
;
135 DPRINT1(" VACB 0x%p enabled, RefCount %lu, Dirty %u, PageOut %lu\n",
136 current
, current
->ReferenceCount
, current
->Dirty
, current
->PageOut
);
138 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldirql
);
139 KeReleaseGuardedMutex(&ViewLock
);
143 DPRINT1("Disabling Tracing for CacheMap 0x%p:\n", SharedCacheMap
);
147 UNREFERENCED_PARAMETER(SharedCacheMap
);
148 UNREFERENCED_PARAMETER(Trace
);
159 Status
= CcWriteVirtualAddress(Vacb
);
160 if (NT_SUCCESS(Status
))
162 CcRosUnmarkDirtyVacb(Vacb
, TRUE
);
170 CcRosFlushDirtyPages (
174 BOOLEAN CalledFromLazy
)
176 PLIST_ENTRY current_entry
;
180 LARGE_INTEGER ZeroTimeout
;
182 DPRINT("CcRosFlushDirtyPages(Target %lu)\n", Target
);
185 ZeroTimeout
.QuadPart
= 0;
187 KeEnterCriticalRegion();
188 KeAcquireGuardedMutex(&ViewLock
);
190 current_entry
= DirtyVacbListHead
.Flink
;
191 if (current_entry
== &DirtyVacbListHead
)
193 DPRINT("No Dirty pages\n");
196 while ((current_entry
!= &DirtyVacbListHead
) && (Target
> 0))
198 current
= CONTAINING_RECORD(current_entry
,
201 current_entry
= current_entry
->Flink
;
203 CcRosVacbIncRefCount(current
);
205 /* When performing lazy write, don't handle temporary files */
206 if (CalledFromLazy
&&
207 BooleanFlagOn(current
->SharedCacheMap
->FileObject
->Flags
, FO_TEMPORARY_FILE
))
209 CcRosVacbDecRefCount(current
);
213 Locked
= current
->SharedCacheMap
->Callbacks
->AcquireForLazyWrite(
214 current
->SharedCacheMap
->LazyWriteContext
, Wait
);
217 CcRosVacbDecRefCount(current
);
221 Status
= CcRosAcquireVacbLock(current
,
222 Wait
? NULL
: &ZeroTimeout
);
223 if (Status
!= STATUS_SUCCESS
)
225 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
226 current
->SharedCacheMap
->LazyWriteContext
);
227 CcRosVacbDecRefCount(current
);
231 ASSERT(current
->Dirty
);
233 /* One reference is added above */
234 if ((current
->ReferenceCount
> 2 && current
->PinCount
== 0) ||
235 (current
->ReferenceCount
> 3 && current
->PinCount
> 1))
237 CcRosReleaseVacbLock(current
);
238 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
239 current
->SharedCacheMap
->LazyWriteContext
);
240 CcRosVacbDecRefCount(current
);
244 KeReleaseGuardedMutex(&ViewLock
);
246 Status
= CcRosFlushVacb(current
);
248 CcRosReleaseVacbLock(current
);
249 current
->SharedCacheMap
->Callbacks
->ReleaseFromLazyWrite(
250 current
->SharedCacheMap
->LazyWriteContext
);
252 KeAcquireGuardedMutex(&ViewLock
);
253 CcRosVacbDecRefCount(current
);
255 if (!NT_SUCCESS(Status
) && (Status
!= STATUS_END_OF_FILE
) &&
256 (Status
!= STATUS_MEDIA_WRITE_PROTECTED
))
258 DPRINT1("CC: Failed to flush VACB.\n");
264 /* How many pages did we free? */
265 PagesFreed
= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
266 (*Count
) += PagesFreed
;
268 /* Make sure we don't overflow target! */
269 if (Target
< PagesFreed
)
271 /* If we would have, jump to zero directly */
276 Target
-= PagesFreed
;
280 current_entry
= DirtyVacbListHead
.Flink
;
283 KeReleaseGuardedMutex(&ViewLock
);
284 KeLeaveCriticalRegion();
286 DPRINT("CcRosFlushDirtyPages() finished\n");
287 return STATUS_SUCCESS
;
296 * FUNCTION: Try to free some memory from the file cache.
298 * Target - The number of pages to be freed.
299 * Priority - The priority of free (currently unused).
300 * NrFreed - Points to a variable where the number of pages
301 * actually freed is returned.
304 PLIST_ENTRY current_entry
;
311 BOOLEAN FlushedPages
= FALSE
;
313 DPRINT("CcRosTrimCache(Target %lu)\n", Target
);
315 InitializeListHead(&FreeList
);
320 KeAcquireGuardedMutex(&ViewLock
);
322 current_entry
= VacbLruListHead
.Flink
;
323 while (current_entry
!= &VacbLruListHead
)
325 current
= CONTAINING_RECORD(current_entry
,
328 current_entry
= current_entry
->Flink
;
330 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
332 /* Reference the VACB */
333 CcRosVacbIncRefCount(current
);
335 /* Check if it's mapped and not dirty */
336 if (current
->MappedCount
> 0 && !current
->Dirty
)
338 /* We have to break these locks because Cc sucks */
339 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
340 KeReleaseGuardedMutex(&ViewLock
);
342 /* Page out the VACB */
343 for (i
= 0; i
< VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
; i
++)
345 Page
= (PFN_NUMBER
)(MmGetPhysicalAddress((PUCHAR
)current
->BaseAddress
+ (i
* PAGE_SIZE
)).QuadPart
>> PAGE_SHIFT
);
347 MmPageOutPhysicalAddress(Page
);
350 /* Reacquire the locks */
351 KeAcquireGuardedMutex(&ViewLock
);
352 KeAcquireSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, &oldIrql
);
355 /* Dereference the VACB */
356 CcRosVacbDecRefCount(current
);
358 /* Check if we can free this entry now */
359 if (current
->ReferenceCount
== 0)
361 ASSERT(!current
->Dirty
);
362 ASSERT(!current
->MappedCount
);
364 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
365 RemoveEntryList(¤t
->VacbLruListEntry
);
366 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
368 /* Calculate how many pages we freed for Mm */
369 PagesFreed
= min(VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
, Target
);
370 Target
-= PagesFreed
;
371 (*NrFreed
) += PagesFreed
;
374 KeReleaseSpinLock(¤t
->SharedCacheMap
->CacheMapLock
, oldIrql
);
377 KeReleaseGuardedMutex(&ViewLock
);
379 /* Try flushing pages if we haven't met our target */
380 if ((Target
> 0) && !FlushedPages
)
382 /* Flush dirty pages to disk */
383 CcRosFlushDirtyPages(Target
, &PagesFreed
, FALSE
, FALSE
);
386 /* We can only swap as many pages as we flushed */
387 if (PagesFreed
< Target
) Target
= PagesFreed
;
389 /* Check if we flushed anything */
392 /* Try again after flushing dirty pages */
393 DPRINT("Flushed %lu dirty cache pages to disk\n", PagesFreed
);
398 while (!IsListEmpty(&FreeList
))
400 current_entry
= RemoveHeadList(&FreeList
);
401 current
= CONTAINING_RECORD(current_entry
,
403 CacheMapVacbListEntry
);
404 CcRosInternalFreeVacb(current
);
407 DPRINT("Evicted %lu cache pages\n", (*NrFreed
));
409 return STATUS_SUCCESS
;
415 PROS_SHARED_CACHE_MAP SharedCacheMap
,
421 ASSERT(SharedCacheMap
);
423 DPRINT("CcRosReleaseVacb(SharedCacheMap 0x%p, Vacb 0x%p, Valid %u)\n",
424 SharedCacheMap
, Vacb
, Valid
);
428 if (Dirty
&& !Vacb
->Dirty
)
430 CcRosMarkDirtyVacb(Vacb
);
437 CcRosVacbDecRefCount(Vacb
);
438 if (Mapped
&& (Vacb
->MappedCount
== 1))
440 CcRosVacbIncRefCount(Vacb
);
443 CcRosReleaseVacbLock(Vacb
);
445 return STATUS_SUCCESS
;
448 /* Returns with VACB Lock Held! */
452 PROS_SHARED_CACHE_MAP SharedCacheMap
,
455 PLIST_ENTRY current_entry
;
459 ASSERT(SharedCacheMap
);
461 DPRINT("CcRosLookupVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
462 SharedCacheMap
, FileOffset
);
464 KeAcquireGuardedMutex(&ViewLock
);
465 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
467 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
468 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
470 current
= CONTAINING_RECORD(current_entry
,
472 CacheMapVacbListEntry
);
473 if (IsPointInRange(current
->FileOffset
.QuadPart
,
474 VACB_MAPPING_GRANULARITY
,
477 CcRosVacbIncRefCount(current
);
478 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
479 KeReleaseGuardedMutex(&ViewLock
);
480 CcRosAcquireVacbLock(current
, NULL
);
483 if (current
->FileOffset
.QuadPart
> FileOffset
)
485 current_entry
= current_entry
->Flink
;
488 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
489 KeReleaseGuardedMutex(&ViewLock
);
500 PROS_SHARED_CACHE_MAP SharedCacheMap
;
502 SharedCacheMap
= Vacb
->SharedCacheMap
;
504 KeAcquireGuardedMutex(&ViewLock
);
505 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
507 ASSERT(!Vacb
->Dirty
);
509 InsertTailList(&DirtyVacbListHead
, &Vacb
->DirtyVacbListEntry
);
510 CcTotalDirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
511 Vacb
->SharedCacheMap
->DirtyPages
+= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
512 CcRosVacbIncRefCount(Vacb
);
514 /* Move to the tail of the LRU list */
515 RemoveEntryList(&Vacb
->VacbLruListEntry
);
516 InsertTailList(&VacbLruListHead
, &Vacb
->VacbLruListEntry
);
520 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
521 KeReleaseGuardedMutex(&ViewLock
);
523 /* FIXME: lock master */
524 if (!LazyWriter
.ScanActive
)
526 CcScheduleLazyWriteScan(FALSE
);
532 CcRosUnmarkDirtyVacb (
537 PROS_SHARED_CACHE_MAP SharedCacheMap
;
539 SharedCacheMap
= Vacb
->SharedCacheMap
;
543 KeAcquireGuardedMutex(&ViewLock
);
544 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
551 RemoveEntryList(&Vacb
->DirtyVacbListEntry
);
552 CcTotalDirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
553 Vacb
->SharedCacheMap
->DirtyPages
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
554 CcRosVacbDecRefCount(Vacb
);
558 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
559 KeReleaseGuardedMutex(&ViewLock
);
566 PROS_SHARED_CACHE_MAP SharedCacheMap
,
571 ASSERT(SharedCacheMap
);
573 DPRINT("CcRosMarkDirtyVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
574 SharedCacheMap
, FileOffset
);
576 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
579 KeBugCheck(CACHE_MANAGER
);
584 CcRosMarkDirtyVacb(Vacb
);
587 CcRosReleaseVacbLock(Vacb
);
589 return STATUS_SUCCESS
;
595 PROS_SHARED_CACHE_MAP SharedCacheMap
,
601 ASSERT(SharedCacheMap
);
603 DPRINT("CcRosUnmapVacb(SharedCacheMap 0x%p, FileOffset %I64u, NowDirty %u)\n",
604 SharedCacheMap
, FileOffset
, NowDirty
);
606 Vacb
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
609 return STATUS_UNSUCCESSFUL
;
612 if (NowDirty
&& !Vacb
->Dirty
)
614 CcRosMarkDirtyVacb(Vacb
);
617 ASSERT(Vacb
->MappedCount
!= 0);
620 CcRosVacbDecRefCount(Vacb
);
621 if (Vacb
->MappedCount
== 0)
623 CcRosVacbDecRefCount(Vacb
);
626 CcRosReleaseVacbLock(Vacb
);
628 return STATUS_SUCCESS
;
638 ULONG_PTR NumberOfPages
;
640 /* Create a memory area. */
641 MmLockAddressSpace(MmGetKernelAddressSpace());
642 Status
= MmCreateMemoryArea(MmGetKernelAddressSpace(),
643 0, // nothing checks for VACB mareas, so set to 0
645 VACB_MAPPING_GRANULARITY
,
647 (PMEMORY_AREA
*)&Vacb
->MemoryArea
,
650 MmUnlockAddressSpace(MmGetKernelAddressSpace());
651 if (!NT_SUCCESS(Status
))
653 DPRINT1("MmCreateMemoryArea failed with %lx for VACB %p\n", Status
, Vacb
);
657 ASSERT(((ULONG_PTR
)Vacb
->BaseAddress
% PAGE_SIZE
) == 0);
658 ASSERT((ULONG_PTR
)Vacb
->BaseAddress
> (ULONG_PTR
)MmSystemRangeStart
);
660 /* Create a virtual mapping for this memory area */
661 NumberOfPages
= BYTES_TO_PAGES(VACB_MAPPING_GRANULARITY
);
662 for (i
= 0; i
< NumberOfPages
; i
++)
664 PFN_NUMBER PageFrameNumber
;
666 MI_SET_USAGE(MI_USAGE_CACHE
);
667 Status
= MmRequestPageMemoryConsumer(MC_CACHE
, TRUE
, &PageFrameNumber
);
668 if (PageFrameNumber
== 0)
670 DPRINT1("Unable to allocate page\n");
671 KeBugCheck(MEMORY_MANAGEMENT
);
674 Status
= MmCreateVirtualMapping(NULL
,
675 (PVOID
)((ULONG_PTR
)Vacb
->BaseAddress
+ (i
* PAGE_SIZE
)),
679 if (!NT_SUCCESS(Status
))
681 DPRINT1("Unable to create virtual mapping\n");
682 KeBugCheck(MEMORY_MANAGEMENT
);
686 return STATUS_SUCCESS
;
692 PROS_SHARED_CACHE_MAP SharedCacheMap
,
698 PLIST_ENTRY current_entry
;
702 ASSERT(SharedCacheMap
);
704 DPRINT("CcRosCreateVacb()\n");
706 if (FileOffset
>= SharedCacheMap
->SectionSize
.QuadPart
)
709 return STATUS_INVALID_PARAMETER
;
712 current
= ExAllocateFromNPagedLookasideList(&VacbLookasideList
);
713 current
->BaseAddress
= NULL
;
714 current
->Valid
= FALSE
;
715 current
->Dirty
= FALSE
;
716 current
->PageOut
= FALSE
;
717 current
->FileOffset
.QuadPart
= ROUND_DOWN(FileOffset
, VACB_MAPPING_GRANULARITY
);
718 current
->SharedCacheMap
= SharedCacheMap
;
720 if (SharedCacheMap
->Trace
)
722 DPRINT1("CacheMap 0x%p: new VACB: 0x%p\n", SharedCacheMap
, current
);
725 current
->MappedCount
= 0;
726 current
->DirtyVacbListEntry
.Flink
= NULL
;
727 current
->DirtyVacbListEntry
.Blink
= NULL
;
728 current
->ReferenceCount
= 1;
729 current
->PinCount
= 0;
730 KeInitializeMutex(¤t
->Mutex
, 0);
731 CcRosAcquireVacbLock(current
, NULL
);
732 KeAcquireGuardedMutex(&ViewLock
);
735 /* There is window between the call to CcRosLookupVacb
736 * and CcRosCreateVacb. We must check if a VACB for the
737 * file offset exist. If there is a VACB, we release
738 * our newly created VACB and return the existing one.
740 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
741 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
743 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
745 current
= CONTAINING_RECORD(current_entry
,
747 CacheMapVacbListEntry
);
748 if (IsPointInRange(current
->FileOffset
.QuadPart
,
749 VACB_MAPPING_GRANULARITY
,
752 CcRosVacbIncRefCount(current
);
753 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
755 if (SharedCacheMap
->Trace
)
757 DPRINT1("CacheMap 0x%p: deleting newly created VACB 0x%p ( found existing one 0x%p )\n",
763 CcRosReleaseVacbLock(*Vacb
);
764 KeReleaseGuardedMutex(&ViewLock
);
765 ExFreeToNPagedLookasideList(&VacbLookasideList
, *Vacb
);
767 CcRosAcquireVacbLock(current
, NULL
);
768 return STATUS_SUCCESS
;
770 if (current
->FileOffset
.QuadPart
< FileOffset
)
772 ASSERT(previous
== NULL
||
773 previous
->FileOffset
.QuadPart
< current
->FileOffset
.QuadPart
);
776 if (current
->FileOffset
.QuadPart
> FileOffset
)
778 current_entry
= current_entry
->Flink
;
780 /* There was no existing VACB. */
784 InsertHeadList(&previous
->CacheMapVacbListEntry
, ¤t
->CacheMapVacbListEntry
);
788 InsertHeadList(&SharedCacheMap
->CacheMapVacbListHead
, ¤t
->CacheMapVacbListEntry
);
790 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
791 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
792 KeReleaseGuardedMutex(&ViewLock
);
794 MI_SET_USAGE(MI_USAGE_CACHE
);
796 if ((SharedCacheMap
->FileObject
) && (SharedCacheMap
->FileObject
->FileName
.Buffer
))
800 pos
= wcsrchr(SharedCacheMap
->FileObject
->FileName
.Buffer
, '\\');
803 len
= wcslen(pos
) * sizeof(WCHAR
);
804 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%S", pos
);
808 snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%wZ", &SharedCacheMap
->FileObject
->FileName
);
813 Status
= CcRosMapVacb(current
);
814 if (!NT_SUCCESS(Status
))
816 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
817 RemoveEntryList(¤t
->VacbLruListEntry
);
818 CcRosReleaseVacbLock(current
);
819 ExFreeToNPagedLookasideList(&VacbLookasideList
, current
);
828 PROS_SHARED_CACHE_MAP SharedCacheMap
,
830 PLONGLONG BaseOffset
,
838 ASSERT(SharedCacheMap
);
840 DPRINT("CcRosGetVacb()\n");
843 * Look for a VACB already mapping the same data.
845 current
= CcRosLookupVacb(SharedCacheMap
, FileOffset
);
849 * Otherwise create a new VACB.
851 Status
= CcRosCreateVacb(SharedCacheMap
, FileOffset
, ¤t
);
852 if (!NT_SUCCESS(Status
))
858 KeAcquireGuardedMutex(&ViewLock
);
860 /* Move to the tail of the LRU list */
861 RemoveEntryList(¤t
->VacbLruListEntry
);
862 InsertTailList(&VacbLruListHead
, ¤t
->VacbLruListEntry
);
864 KeReleaseGuardedMutex(&ViewLock
);
867 * Return information about the VACB to the caller.
869 *UptoDate
= current
->Valid
;
870 *BaseAddress
= current
->BaseAddress
;
871 DPRINT("*BaseAddress %p\n", *BaseAddress
);
873 *BaseOffset
= current
->FileOffset
.QuadPart
;
874 return STATUS_SUCCESS
;
880 PROS_SHARED_CACHE_MAP SharedCacheMap
,
886 * FUNCTION: Request a page mapping for a shared cache map
891 ASSERT(SharedCacheMap
);
893 if (FileOffset
% VACB_MAPPING_GRANULARITY
!= 0)
895 DPRINT1("Bad fileoffset %I64x should be multiple of %x",
896 FileOffset
, VACB_MAPPING_GRANULARITY
);
897 KeBugCheck(CACHE_MANAGER
);
900 return CcRosGetVacb(SharedCacheMap
,
912 MEMORY_AREA
* MemoryArea
,
918 ASSERT(SwapEntry
== 0);
921 ASSERT(MmGetReferenceCountPage(Page
) == 1);
922 MmReleasePageMemoryConsumer(MC_CACHE
, Page
);
927 CcRosInternalFreeVacb (
930 * FUNCTION: Releases a VACB associated with a shared cache map
933 DPRINT("Freeing VACB 0x%p\n", Vacb
);
935 if (Vacb
->SharedCacheMap
->Trace
)
937 DPRINT1("CacheMap 0x%p: deleting VACB: 0x%p\n", Vacb
->SharedCacheMap
, Vacb
);
941 MmLockAddressSpace(MmGetKernelAddressSpace());
942 MmFreeMemoryArea(MmGetKernelAddressSpace(),
946 MmUnlockAddressSpace(MmGetKernelAddressSpace());
948 ExFreeToNPagedLookasideList(&VacbLookasideList
, Vacb
);
949 return STATUS_SUCCESS
;
958 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
,
959 IN PLARGE_INTEGER FileOffset OPTIONAL
,
961 OUT PIO_STATUS_BLOCK IoStatus
)
963 PROS_SHARED_CACHE_MAP SharedCacheMap
;
964 LARGE_INTEGER Offset
;
965 LONGLONG RemainingLength
;
970 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p FileOffset=%p Length=%lu\n",
971 SectionObjectPointers
, FileOffset
, Length
);
973 DPRINT("CcFlushCache(SectionObjectPointers 0x%p, FileOffset 0x%p, Length %lu, IoStatus 0x%p)\n",
974 SectionObjectPointers
, FileOffset
, Length
, IoStatus
);
976 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
978 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
979 ASSERT(SharedCacheMap
);
982 Offset
= *FileOffset
;
983 RemainingLength
= Length
;
988 RemainingLength
= SharedCacheMap
->FileSize
.QuadPart
;
993 IoStatus
->Status
= STATUS_SUCCESS
;
994 IoStatus
->Information
= 0;
997 while (RemainingLength
> 0)
999 current
= CcRosLookupVacb(SharedCacheMap
, Offset
.QuadPart
);
1000 if (current
!= NULL
)
1004 Status
= CcRosFlushVacb(current
);
1005 if (!NT_SUCCESS(Status
) && IoStatus
!= NULL
)
1007 IoStatus
->Status
= Status
;
1011 CcRosReleaseVacbLock(current
);
1013 KeAcquireGuardedMutex(&ViewLock
);
1014 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1015 CcRosVacbDecRefCount(current
);
1016 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1017 KeReleaseGuardedMutex(&ViewLock
);
1020 Offset
.QuadPart
+= VACB_MAPPING_GRANULARITY
;
1021 RemainingLength
-= min(RemainingLength
, VACB_MAPPING_GRANULARITY
);
1028 IoStatus
->Status
= STATUS_INVALID_PARAMETER
;
1035 CcRosDeleteFileCache (
1036 PFILE_OBJECT FileObject
,
1037 PROS_SHARED_CACHE_MAP SharedCacheMap
)
1039 * FUNCTION: Releases the shared cache map associated with a file object
1042 PLIST_ENTRY current_entry
;
1044 LIST_ENTRY FreeList
;
1047 ASSERT(SharedCacheMap
);
1049 SharedCacheMap
->OpenCount
++;
1050 KeReleaseGuardedMutex(&ViewLock
);
1052 CcFlushCache(FileObject
->SectionObjectPointer
, NULL
, 0, NULL
);
1054 KeAcquireGuardedMutex(&ViewLock
);
1055 SharedCacheMap
->OpenCount
--;
1056 if (SharedCacheMap
->OpenCount
== 0)
1060 FileObject
->SectionObjectPointer
->SharedCacheMap
= NULL
;
1065 InitializeListHead(&FreeList
);
1066 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1067 while (!IsListEmpty(&SharedCacheMap
->CacheMapVacbListHead
))
1069 current_entry
= RemoveTailList(&SharedCacheMap
->CacheMapVacbListHead
);
1070 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1072 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1073 CcRosAcquireVacbLock(current
, NULL
);
1074 RemoveEntryList(¤t
->VacbLruListEntry
);
1077 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1078 CcRosUnmarkDirtyVacb(current
, FALSE
);
1079 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1080 DPRINT1("Freeing dirty VACB\n");
1082 InsertHeadList(&FreeList
, ¤t
->CacheMapVacbListEntry
);
1083 CcRosReleaseVacbLock(current
);
1085 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldIrql
);
1088 SharedCacheMap
->Trace
= FALSE
;
1090 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldIrql
);
1092 KeReleaseGuardedMutex(&ViewLock
);
1093 ObDereferenceObject(SharedCacheMap
->FileObject
);
1095 while (!IsListEmpty(&FreeList
))
1097 current_entry
= RemoveTailList(&FreeList
);
1098 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
1099 CcRosInternalFreeVacb(current
);
1102 KeAcquireSpinLock(&iSharedCacheMapLock
, &OldIrql
);
1103 RemoveEntryList(&SharedCacheMap
->SharedCacheMapLinks
);
1104 KeReleaseSpinLock(&iSharedCacheMapLock
, OldIrql
);
1106 ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList
, SharedCacheMap
);
1107 KeAcquireGuardedMutex(&ViewLock
);
1109 return STATUS_SUCCESS
;
1114 CcRosReferenceCache (
1115 PFILE_OBJECT FileObject
)
1117 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1118 KeAcquireGuardedMutex(&ViewLock
);
1119 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1120 ASSERT(SharedCacheMap
);
1121 ASSERT(SharedCacheMap
->OpenCount
!= 0);
1122 SharedCacheMap
->OpenCount
++;
1123 KeReleaseGuardedMutex(&ViewLock
);
1128 CcRosRemoveIfClosed (
1129 PSECTION_OBJECT_POINTERS SectionObjectPointer
)
1131 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1132 DPRINT("CcRosRemoveIfClosed()\n");
1133 KeAcquireGuardedMutex(&ViewLock
);
1134 SharedCacheMap
= SectionObjectPointer
->SharedCacheMap
;
1135 if (SharedCacheMap
&& SharedCacheMap
->OpenCount
== 0)
1137 CcRosDeleteFileCache(SharedCacheMap
->FileObject
, SharedCacheMap
);
1139 KeReleaseGuardedMutex(&ViewLock
);
1145 CcRosDereferenceCache (
1146 PFILE_OBJECT FileObject
)
1148 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1149 KeAcquireGuardedMutex(&ViewLock
);
1150 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1151 ASSERT(SharedCacheMap
);
1152 if (SharedCacheMap
->OpenCount
> 0)
1154 SharedCacheMap
->OpenCount
--;
1155 if (SharedCacheMap
->OpenCount
== 0)
1157 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1158 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1161 KeReleaseGuardedMutex(&ViewLock
);
1166 CcRosReleaseFileCache (
1167 PFILE_OBJECT FileObject
)
1169 * FUNCTION: Called by the file system when a handle to a file object
1173 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1175 KeAcquireGuardedMutex(&ViewLock
);
1177 if (FileObject
->SectionObjectPointer
->SharedCacheMap
!= NULL
)
1179 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1180 if (FileObject
->PrivateCacheMap
!= NULL
)
1182 FileObject
->PrivateCacheMap
= NULL
;
1183 if (SharedCacheMap
->OpenCount
> 0)
1185 SharedCacheMap
->OpenCount
--;
1186 if (SharedCacheMap
->OpenCount
== 0)
1188 MmFreeSectionSegments(SharedCacheMap
->FileObject
);
1189 CcRosDeleteFileCache(FileObject
, SharedCacheMap
);
1194 KeReleaseGuardedMutex(&ViewLock
);
1195 return STATUS_SUCCESS
;
1200 CcTryToInitializeFileCache (
1201 PFILE_OBJECT FileObject
)
1203 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1206 KeAcquireGuardedMutex(&ViewLock
);
1208 ASSERT(FileObject
->SectionObjectPointer
);
1209 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1210 if (SharedCacheMap
== NULL
)
1212 Status
= STATUS_UNSUCCESSFUL
;
1216 if (FileObject
->PrivateCacheMap
== NULL
)
1218 FileObject
->PrivateCacheMap
= SharedCacheMap
;
1219 SharedCacheMap
->OpenCount
++;
1221 Status
= STATUS_SUCCESS
;
1223 KeReleaseGuardedMutex(&ViewLock
);
1231 CcRosInitializeFileCache (
1232 PFILE_OBJECT FileObject
,
1233 PCC_FILE_SIZES FileSizes
,
1235 PCACHE_MANAGER_CALLBACKS CallBacks
,
1236 PVOID LazyWriterContext
)
1238 * FUNCTION: Initializes a shared cache map for a file object
1241 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1243 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1244 DPRINT("CcRosInitializeFileCache(FileObject 0x%p, SharedCacheMap 0x%p)\n",
1245 FileObject
, SharedCacheMap
);
1247 KeAcquireGuardedMutex(&ViewLock
);
1248 if (SharedCacheMap
== NULL
)
1252 SharedCacheMap
= ExAllocateFromNPagedLookasideList(&SharedCacheMapLookasideList
);
1253 if (SharedCacheMap
== NULL
)
1255 KeReleaseGuardedMutex(&ViewLock
);
1256 return STATUS_INSUFFICIENT_RESOURCES
;
1258 RtlZeroMemory(SharedCacheMap
, sizeof(*SharedCacheMap
));
1259 ObReferenceObjectByPointer(FileObject
,
1263 SharedCacheMap
->FileObject
= FileObject
;
1264 SharedCacheMap
->Callbacks
= CallBacks
;
1265 SharedCacheMap
->LazyWriteContext
= LazyWriterContext
;
1266 SharedCacheMap
->SectionSize
= FileSizes
->AllocationSize
;
1267 SharedCacheMap
->FileSize
= FileSizes
->FileSize
;
1268 SharedCacheMap
->PinAccess
= PinAccess
;
1269 SharedCacheMap
->DirtyPageThreshold
= 0;
1270 SharedCacheMap
->DirtyPages
= 0;
1271 KeInitializeSpinLock(&SharedCacheMap
->CacheMapLock
);
1272 InitializeListHead(&SharedCacheMap
->CacheMapVacbListHead
);
1273 FileObject
->SectionObjectPointer
->SharedCacheMap
= SharedCacheMap
;
1275 KeAcquireSpinLock(&iSharedCacheMapLock
, &OldIrql
);
1276 InsertTailList(&CcCleanSharedCacheMapList
, &SharedCacheMap
->SharedCacheMapLinks
);
1277 KeReleaseSpinLock(&iSharedCacheMapLock
, OldIrql
);
1279 if (FileObject
->PrivateCacheMap
== NULL
)
1281 FileObject
->PrivateCacheMap
= SharedCacheMap
;
1282 SharedCacheMap
->OpenCount
++;
1284 KeReleaseGuardedMutex(&ViewLock
);
1286 return STATUS_SUCCESS
;
1294 CcGetFileObjectFromSectionPtrs (
1295 IN PSECTION_OBJECT_POINTERS SectionObjectPointers
)
1297 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1299 CCTRACE(CC_API_DEBUG
, "SectionObjectPointers=%p\n", SectionObjectPointers
);
1301 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1303 SharedCacheMap
= SectionObjectPointers
->SharedCacheMap
;
1304 ASSERT(SharedCacheMap
);
1305 return SharedCacheMap
->FileObject
;
1316 DPRINT("CcInitView()\n");
1318 InitializeListHead(&DirtyVacbListHead
);
1319 InitializeListHead(&VacbLruListHead
);
1320 InitializeListHead(&CcDeferredWrites
);
1321 InitializeListHead(&CcCleanSharedCacheMapList
);
1322 KeInitializeSpinLock(&CcDeferredWriteSpinLock
);
1323 KeInitializeSpinLock(&iSharedCacheMapLock
);
1324 KeInitializeGuardedMutex(&ViewLock
);
1325 ExInitializeNPagedLookasideList(&iBcbLookasideList
,
1329 sizeof(INTERNAL_BCB
),
1332 ExInitializeNPagedLookasideList(&SharedCacheMapLookasideList
,
1336 sizeof(ROS_SHARED_CACHE_MAP
),
1337 TAG_SHARED_CACHE_MAP
,
1339 ExInitializeNPagedLookasideList(&VacbLookasideList
,
1347 MmInitializeMemoryConsumer(MC_CACHE
, CcRosTrimCache
);
1349 CcInitCacheZeroPage();
1352 #if DBG && defined(KDBG)
1354 ExpKdbgExtFileCache(ULONG Argc
, PCHAR Argv
[])
1356 PLIST_ENTRY ListEntry
;
1357 UNICODE_STRING NoName
= RTL_CONSTANT_STRING(L
"No name for File");
1359 KdbpPrint(" Usage Summary (in kb)\n");
1360 KdbpPrint("Shared\t\tValid\tDirty\tName\n");
1361 /* No need to lock the spin lock here, we're in DBG */
1362 for (ListEntry
= CcCleanSharedCacheMapList
.Flink
;
1363 ListEntry
!= &CcCleanSharedCacheMapList
;
1364 ListEntry
= ListEntry
->Flink
)
1367 ULONG Valid
= 0, Dirty
= 0;
1368 PROS_SHARED_CACHE_MAP SharedCacheMap
;
1369 PUNICODE_STRING FileName
;
1371 SharedCacheMap
= CONTAINING_RECORD(ListEntry
, ROS_SHARED_CACHE_MAP
, SharedCacheMapLinks
);
1374 Dirty
= (SharedCacheMap
->DirtyPages
* PAGE_SIZE
) / 1024;
1376 /* First, count for all the associated VACB */
1377 for (Vacbs
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
1378 Vacbs
!= &SharedCacheMap
->CacheMapVacbListHead
;
1379 Vacbs
= Vacbs
->Flink
)
1383 Vacb
= CONTAINING_RECORD(Vacbs
, ROS_VACB
, CacheMapVacbListEntry
);
1386 Valid
+= VACB_MAPPING_GRANULARITY
/ 1024;
1391 if (SharedCacheMap
->FileObject
!= NULL
&&
1392 SharedCacheMap
->FileObject
->FileName
.Length
!= 0)
1394 FileName
= &SharedCacheMap
->FileObject
->FileName
;
1402 KdbpPrint("%p\t%d\t%d\t%wZ\n", SharedCacheMap
, Valid
, Dirty
, FileName
);