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 *******************************************************************/
45 * If CACHE_BITMAP is defined, the cache manager uses one large memory region
46 * within the kernel address space and allocate/deallocate space from this block
47 * over a bitmap. If CACHE_BITMAP is used, the size of the mdl mapping region
48 * must be reduced (ntoskrnl\mm\mdl.c, MI_MDLMAPPING_REGION_SIZE).
50 //#define CACHE_BITMAP
52 static LIST_ENTRY DirtySegmentListHead
;
53 static LIST_ENTRY CacheSegmentListHead
;
54 static LIST_ENTRY CacheSegmentLRUListHead
;
55 static LIST_ENTRY ClosedListHead
;
56 ULONG DirtyPageCount
=0;
58 KGUARDED_MUTEX ViewLock
;
61 #define CI_CACHESEG_MAPPING_REGION_SIZE (128*1024*1024)
63 static PVOID CiCacheSegMappingRegionBase
= NULL
;
64 static RTL_BITMAP CiCacheSegMappingRegionAllocMap
;
65 static ULONG CiCacheSegMappingRegionHint
;
66 static KSPIN_LOCK CiCacheSegMappingRegionLock
;
69 NPAGED_LOOKASIDE_LIST iBcbLookasideList
;
70 static NPAGED_LOOKASIDE_LIST BcbLookasideList
;
71 static NPAGED_LOOKASIDE_LIST CacheSegLookasideList
;
74 static void CcRosCacheSegmentIncRefCount_ ( PCACHE_SEGMENT cs
, const char* file
, int line
)
79 DbgPrint("(%s:%i) CacheSegment %p ++RefCount=%d, Dirty %d, PageOut %d\n",
80 file
, line
, cs
, cs
->ReferenceCount
, cs
->Dirty
, cs
->PageOut
);
83 static void CcRosCacheSegmentDecRefCount_ ( PCACHE_SEGMENT cs
, const char* file
, int line
)
88 DbgPrint("(%s:%i) CacheSegment %p --RefCount=%d, Dirty %d, PageOut %d\n",
89 file
, line
, cs
, cs
->ReferenceCount
, cs
->Dirty
, cs
->PageOut
);
92 #define CcRosCacheSegmentIncRefCount(cs) CcRosCacheSegmentIncRefCount_(cs,__FILE__,__LINE__)
93 #define CcRosCacheSegmentDecRefCount(cs) CcRosCacheSegmentDecRefCount_(cs,__FILE__,__LINE__)
95 #define CcRosCacheSegmentIncRefCount(cs) (++((cs)->ReferenceCount))
96 #define CcRosCacheSegmentDecRefCount(cs) (--((cs)->ReferenceCount))
100 CcRosInternalFreeCacheSegment(PCACHE_SEGMENT CacheSeg
);
103 /* FUNCTIONS *****************************************************************/
113 PLIST_ENTRY current_entry
;
114 PCACHE_SEGMENT current
;
123 DPRINT1("Enabling Tracing for CacheMap 0x%p:\n", Bcb
);
125 KeAcquireGuardedMutex(&ViewLock
);
126 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldirql
);
128 current_entry
= Bcb
->BcbSegmentListHead
.Flink
;
129 while (current_entry
!= &Bcb
->BcbSegmentListHead
)
131 current
= CONTAINING_RECORD(current_entry
, CACHE_SEGMENT
, BcbSegmentListEntry
);
132 current_entry
= current_entry
->Flink
;
134 DPRINT1(" CacheSegment 0x%p enabled, RefCount %d, Dirty %d, PageOut %d\n",
135 current
, current
->ReferenceCount
, current
->Dirty
, current
->PageOut
);
137 KeReleaseSpinLock(&Bcb
->BcbLock
, oldirql
);
138 KeReleaseGuardedMutex(&ViewLock
);
142 DPRINT1("Disabling Tracing for CacheMap 0x%p:\n", Bcb
);
153 CcRosFlushCacheSegment(PCACHE_SEGMENT CacheSegment
)
158 Status
= WriteCacheSegment(CacheSegment
);
159 if (NT_SUCCESS(Status
))
161 KeAcquireGuardedMutex(&ViewLock
);
162 KeAcquireSpinLock(&CacheSegment
->Bcb
->BcbLock
, &oldIrql
);
164 CacheSegment
->Dirty
= FALSE
;
165 RemoveEntryList(&CacheSegment
->DirtySegmentListEntry
);
166 DirtyPageCount
-= CacheSegment
->Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
167 CcRosCacheSegmentDecRefCount ( CacheSegment
);
169 KeReleaseSpinLock(&CacheSegment
->Bcb
->BcbLock
, oldIrql
);
170 KeReleaseGuardedMutex(&ViewLock
);
178 CcRosFlushDirtyPages(ULONG Target
, PULONG Count
)
180 PLIST_ENTRY current_entry
;
181 PCACHE_SEGMENT current
;
182 ULONG PagesPerSegment
;
185 static ULONG WriteCount
[4] = {0, 0, 0, 0};
188 DPRINT("CcRosFlushDirtyPages(Target %d)\n", Target
);
192 KeEnterCriticalRegion();
193 KeAcquireGuardedMutex(&ViewLock
);
195 WriteCount
[0] = WriteCount
[1];
196 WriteCount
[1] = WriteCount
[2];
197 WriteCount
[2] = WriteCount
[3];
200 NewTarget
= WriteCount
[0] + WriteCount
[1] + WriteCount
[2];
202 if (NewTarget
< DirtyPageCount
)
204 NewTarget
= (DirtyPageCount
- NewTarget
+ 3) / 4;
205 WriteCount
[0] += NewTarget
;
206 WriteCount
[1] += NewTarget
;
207 WriteCount
[2] += NewTarget
;
208 WriteCount
[3] += NewTarget
;
211 NewTarget
= WriteCount
[0];
213 Target
= max(NewTarget
, Target
);
215 current_entry
= DirtySegmentListHead
.Flink
;
216 if (current_entry
== &DirtySegmentListHead
)
218 DPRINT("No Dirty pages\n");
221 while (current_entry
!= &DirtySegmentListHead
&& Target
> 0)
223 current
= CONTAINING_RECORD(current_entry
, CACHE_SEGMENT
,
224 DirtySegmentListEntry
);
225 current_entry
= current_entry
->Flink
;
227 Locked
= current
->Bcb
->Callbacks
->AcquireForLazyWrite(
228 current
->Bcb
->LazyWriteContext
, FALSE
);
234 Locked
= ExTryToAcquirePushLockExclusive(¤t
->Lock
);
237 current
->Bcb
->Callbacks
->ReleaseFromLazyWrite(
238 current
->Bcb
->LazyWriteContext
);
243 ASSERT(current
->Dirty
);
244 if (current
->ReferenceCount
> 1)
246 ExReleasePushLock(¤t
->Lock
);
247 current
->Bcb
->Callbacks
->ReleaseFromLazyWrite(
248 current
->Bcb
->LazyWriteContext
);
252 PagesPerSegment
= current
->Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
254 KeReleaseGuardedMutex(&ViewLock
);
256 Status
= CcRosFlushCacheSegment(current
);
258 ExReleasePushLock(¤t
->Lock
);
259 current
->Bcb
->Callbacks
->ReleaseFromLazyWrite(
260 current
->Bcb
->LazyWriteContext
);
262 if (!NT_SUCCESS(Status
) && (Status
!= STATUS_END_OF_FILE
))
264 DPRINT1("CC: Failed to flush cache segment.\n");
268 (*Count
) += PagesPerSegment
;
269 Target
-= PagesPerSegment
;
272 KeAcquireGuardedMutex(&ViewLock
);
273 current_entry
= DirtySegmentListHead
.Flink
;
276 if (*Count
< NewTarget
)
278 WriteCount
[1] += (NewTarget
- *Count
);
281 KeReleaseGuardedMutex(&ViewLock
);
282 KeLeaveCriticalRegion();
284 DPRINT("CcRosFlushDirtyPages() finished\n");
285 return(STATUS_SUCCESS
);
289 CcRosTrimCache(ULONG Target
, ULONG Priority
, PULONG NrFreed
)
291 * FUNCTION: Try to free some memory from the file cache.
293 * Target - The number of pages to be freed.
294 * Priority - The priority of free (currently unused).
295 * NrFreed - Points to a variable where the number of pages
296 * actually freed is returned.
299 PLIST_ENTRY current_entry
;
300 PCACHE_SEGMENT current
;
301 ULONG PagesPerSegment
;
308 DPRINT("CcRosTrimCache(Target %d)\n", Target
);
310 InitializeListHead(&FreeList
);
312 /* Flush dirty pages to disk */
313 CcRosFlushDirtyPages(Target
, NrFreed
);
315 if ((*NrFreed
) != 0) DPRINT1("Flushed %d dirty cache pages to disk\n", (*NrFreed
));
319 KeAcquireGuardedMutex(&ViewLock
);
321 current_entry
= CacheSegmentLRUListHead
.Flink
;
322 while (current_entry
!= &CacheSegmentLRUListHead
)
324 current
= CONTAINING_RECORD(current_entry
, CACHE_SEGMENT
,
325 CacheSegmentLRUListEntry
);
326 current_entry
= current_entry
->Flink
;
328 KeAcquireSpinLock(¤t
->Bcb
->BcbLock
, &oldIrql
);
330 /* Reference the cache segment */
331 CcRosCacheSegmentIncRefCount(current
);
333 /* Check if it's mapped and not dirty */
334 if (current
->MappedCount
> 0 && !current
->Dirty
)
336 /* We have to break these locks because Cc sucks */
337 KeReleaseSpinLock(¤t
->Bcb
->BcbLock
, oldIrql
);
338 KeReleaseGuardedMutex(&ViewLock
);
340 /* Page out the segment */
341 for (i
= 0; i
< current
->Bcb
->CacheSegmentSize
/ PAGE_SIZE
; i
++)
343 Page
= (PFN_NUMBER
)(MmGetPhysicalAddress((PUCHAR
)current
->BaseAddress
+ (i
* PAGE_SIZE
)).QuadPart
>> PAGE_SHIFT
);
345 MmPageOutPhysicalAddress(Page
);
348 /* Reacquire the locks */
349 KeAcquireGuardedMutex(&ViewLock
);
350 KeAcquireSpinLock(¤t
->Bcb
->BcbLock
, &oldIrql
);
353 /* Dereference the cache segment */
354 CcRosCacheSegmentDecRefCount(current
);
356 /* Check if we can free this entry now */
357 if (current
->ReferenceCount
== 0)
359 ASSERT(!current
->Dirty
);
360 ASSERT(!current
->MappedCount
);
362 RemoveEntryList(¤t
->BcbSegmentListEntry
);
363 RemoveEntryList(¤t
->CacheSegmentListEntry
);
364 RemoveEntryList(¤t
->CacheSegmentLRUListEntry
);
365 InsertHeadList(&FreeList
, ¤t
->BcbSegmentListEntry
);
367 /* Calculate how many pages we freed for Mm */
368 PagesPerSegment
= current
->Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
369 PagesFreed
= min(PagesPerSegment
, Target
);
370 Target
-= PagesFreed
;
371 (*NrFreed
) += PagesFreed
;
374 KeReleaseSpinLock(¤t
->Bcb
->BcbLock
, oldIrql
);
377 KeReleaseGuardedMutex(&ViewLock
);
379 while (!IsListEmpty(&FreeList
))
381 current_entry
= RemoveHeadList(&FreeList
);
382 current
= CONTAINING_RECORD(current_entry
, CACHE_SEGMENT
,
383 BcbSegmentListEntry
);
384 CcRosInternalFreeCacheSegment(current
);
387 DPRINT1("Evicted %d cache pages\n", (*NrFreed
));
389 return(STATUS_SUCCESS
);
394 CcRosReleaseCacheSegment(PBCB Bcb
,
395 PCACHE_SEGMENT CacheSeg
,
400 BOOLEAN WasDirty
= CacheSeg
->Dirty
;
405 DPRINT("CcReleaseCacheSegment(Bcb 0x%p, CacheSeg 0x%p, Valid %d)\n",
406 Bcb
, CacheSeg
, Valid
);
408 CacheSeg
->Valid
= Valid
;
409 CacheSeg
->Dirty
= CacheSeg
->Dirty
|| Dirty
;
411 KeAcquireGuardedMutex(&ViewLock
);
412 if (!WasDirty
&& CacheSeg
->Dirty
)
414 InsertTailList(&DirtySegmentListHead
, &CacheSeg
->DirtySegmentListEntry
);
415 DirtyPageCount
+= Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
417 RemoveEntryList(&CacheSeg
->CacheSegmentLRUListEntry
);
418 InsertTailList(&CacheSegmentLRUListHead
, &CacheSeg
->CacheSegmentLRUListEntry
);
422 CacheSeg
->MappedCount
++;
424 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldIrql
);
425 CcRosCacheSegmentDecRefCount(CacheSeg
);
426 if (Mapped
&& CacheSeg
->MappedCount
== 1)
428 CcRosCacheSegmentIncRefCount(CacheSeg
);
430 if (!WasDirty
&& CacheSeg
->Dirty
)
432 CcRosCacheSegmentIncRefCount(CacheSeg
);
434 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
435 KeReleaseGuardedMutex(&ViewLock
);
436 ExReleasePushLock(&CacheSeg
->Lock
);
438 return(STATUS_SUCCESS
);
441 /* Returns with Cache Segment Lock Held! */
444 CcRosLookupCacheSegment(PBCB Bcb
, ULONG FileOffset
)
446 PLIST_ENTRY current_entry
;
447 PCACHE_SEGMENT current
;
452 DPRINT("CcRosLookupCacheSegment(Bcb -x%p, FileOffset %d)\n", Bcb
, FileOffset
);
454 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldIrql
);
455 current_entry
= Bcb
->BcbSegmentListHead
.Flink
;
456 while (current_entry
!= &Bcb
->BcbSegmentListHead
)
458 current
= CONTAINING_RECORD(current_entry
, CACHE_SEGMENT
,
459 BcbSegmentListEntry
);
460 if (current
->FileOffset
<= FileOffset
&&
461 (current
->FileOffset
+ Bcb
->CacheSegmentSize
) > FileOffset
)
463 CcRosCacheSegmentIncRefCount(current
);
464 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
465 ExAcquirePushLockExclusive(¤t
->Lock
);
468 current_entry
= current_entry
->Flink
;
470 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
476 CcRosMarkDirtyCacheSegment(PBCB Bcb
, ULONG FileOffset
)
478 PCACHE_SEGMENT CacheSeg
;
483 DPRINT("CcRosMarkDirtyCacheSegment(Bcb 0x%p, FileOffset %d)\n", Bcb
, FileOffset
);
485 CacheSeg
= CcRosLookupCacheSegment(Bcb
, FileOffset
);
486 if (CacheSeg
== NULL
)
488 KeBugCheck(CACHE_MANAGER
);
490 if (!CacheSeg
->Dirty
)
492 KeAcquireGuardedMutex(&ViewLock
);
493 InsertTailList(&DirtySegmentListHead
, &CacheSeg
->DirtySegmentListEntry
);
494 DirtyPageCount
+= Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
495 KeReleaseGuardedMutex(&ViewLock
);
499 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldIrql
);
500 CcRosCacheSegmentDecRefCount(CacheSeg
);
501 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
505 CacheSeg
->Dirty
= TRUE
;
506 ExReleasePushLock(&CacheSeg
->Lock
);
508 return(STATUS_SUCCESS
);
513 CcRosUnmapCacheSegment(PBCB Bcb
, ULONG FileOffset
, BOOLEAN NowDirty
)
515 PCACHE_SEGMENT CacheSeg
;
521 DPRINT("CcRosUnmapCacheSegment(Bcb 0x%p, FileOffset %d, NowDirty %d)\n",
522 Bcb
, FileOffset
, NowDirty
);
524 CacheSeg
= CcRosLookupCacheSegment(Bcb
, FileOffset
);
525 if (CacheSeg
== NULL
)
527 return(STATUS_UNSUCCESSFUL
);
530 WasDirty
= CacheSeg
->Dirty
;
531 CacheSeg
->Dirty
= CacheSeg
->Dirty
|| NowDirty
;
533 CacheSeg
->MappedCount
--;
535 if (!WasDirty
&& NowDirty
)
537 KeAcquireGuardedMutex(&ViewLock
);
538 InsertTailList(&DirtySegmentListHead
, &CacheSeg
->DirtySegmentListEntry
);
539 DirtyPageCount
+= Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
540 KeReleaseGuardedMutex(&ViewLock
);
543 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldIrql
);
544 CcRosCacheSegmentDecRefCount(CacheSeg
);
545 if (!WasDirty
&& NowDirty
)
547 CcRosCacheSegmentIncRefCount(CacheSeg
);
549 if (CacheSeg
->MappedCount
== 0)
551 CcRosCacheSegmentDecRefCount(CacheSeg
);
553 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
555 ExReleasePushLock(&CacheSeg
->Lock
);
556 return(STATUS_SUCCESS
);
561 CcRosCreateCacheSegment(PBCB Bcb
,
563 PCACHE_SEGMENT
* CacheSeg
)
565 PCACHE_SEGMENT current
;
566 PCACHE_SEGMENT previous
;
567 PLIST_ENTRY current_entry
;
571 ULONG StartingOffset
;
573 PHYSICAL_ADDRESS BoundaryAddressMultiple
;
577 DPRINT("CcRosCreateCacheSegment()\n");
579 BoundaryAddressMultiple
.QuadPart
= 0;
580 if (FileOffset
>= Bcb
->FileSize
.u
.LowPart
)
583 return STATUS_INVALID_PARAMETER
;
586 current
= ExAllocateFromNPagedLookasideList(&CacheSegLookasideList
);
587 current
->Valid
= FALSE
;
588 current
->Dirty
= FALSE
;
589 current
->PageOut
= FALSE
;
590 current
->FileOffset
= ROUND_DOWN(FileOffset
, Bcb
->CacheSegmentSize
);
595 DPRINT1("CacheMap 0x%p: new Cache Segment: 0x%p\n", Bcb
, current
);
598 current
->MappedCount
= 0;
599 current
->DirtySegmentListEntry
.Flink
= NULL
;
600 current
->DirtySegmentListEntry
.Blink
= NULL
;
601 current
->ReferenceCount
= 1;
602 ExInitializePushLock(¤t
->Lock
);
603 ExAcquirePushLockExclusive(¤t
->Lock
);
604 KeAcquireGuardedMutex(&ViewLock
);
607 /* There is window between the call to CcRosLookupCacheSegment
608 * and CcRosCreateCacheSegment. We must check if a segment on
609 * the fileoffset exist. If there exist a segment, we release
610 * our new created segment and return the existing one.
612 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldIrql
);
613 current_entry
= Bcb
->BcbSegmentListHead
.Flink
;
615 while (current_entry
!= &Bcb
->BcbSegmentListHead
)
617 current
= CONTAINING_RECORD(current_entry
, CACHE_SEGMENT
,
618 BcbSegmentListEntry
);
619 if (current
->FileOffset
<= FileOffset
&&
620 (current
->FileOffset
+ Bcb
->CacheSegmentSize
) > FileOffset
)
622 CcRosCacheSegmentIncRefCount(current
);
623 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
627 DPRINT1("CacheMap 0x%p: deleting newly created Cache Segment 0x%p ( found existing one 0x%p )\n",
633 ExReleasePushLock(&(*CacheSeg
)->Lock
);
634 KeReleaseGuardedMutex(&ViewLock
);
635 ExFreeToNPagedLookasideList(&CacheSegLookasideList
, *CacheSeg
);
637 ExAcquirePushLockExclusive(¤t
->Lock
);
638 return STATUS_SUCCESS
;
640 if (current
->FileOffset
< FileOffset
)
642 if (previous
== NULL
)
648 if (previous
->FileOffset
< current
->FileOffset
)
654 current_entry
= current_entry
->Flink
;
656 /* There was no existing segment. */
660 InsertHeadList(&previous
->BcbSegmentListEntry
, ¤t
->BcbSegmentListEntry
);
664 InsertHeadList(&Bcb
->BcbSegmentListHead
, ¤t
->BcbSegmentListEntry
);
666 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
667 InsertTailList(&CacheSegmentListHead
, ¤t
->CacheSegmentListEntry
);
668 InsertTailList(&CacheSegmentLRUListHead
, ¤t
->CacheSegmentLRUListEntry
);
669 KeReleaseGuardedMutex(&ViewLock
);
671 KeAcquireSpinLock(&CiCacheSegMappingRegionLock
, &oldIrql
);
673 StartingOffset
= RtlFindClearBitsAndSet(&CiCacheSegMappingRegionAllocMap
, Bcb
->CacheSegmentSize
/ PAGE_SIZE
, CiCacheSegMappingRegionHint
);
675 if (StartingOffset
== 0xffffffff)
677 DPRINT1("Out of CacheSeg mapping space\n");
678 KeBugCheck(CACHE_MANAGER
);
681 current
->BaseAddress
= CiCacheSegMappingRegionBase
+ StartingOffset
* PAGE_SIZE
;
683 if (CiCacheSegMappingRegionHint
== StartingOffset
)
685 CiCacheSegMappingRegionHint
+= Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
688 KeReleaseSpinLock(&CiCacheSegMappingRegionLock
, oldIrql
);
690 MmLockAddressSpace(MmGetKernelAddressSpace());
691 current
->BaseAddress
= NULL
;
692 Status
= MmCreateMemoryArea(MmGetKernelAddressSpace(),
693 0, // nothing checks for cache_segment mareas, so set to 0
694 ¤t
->BaseAddress
,
695 Bcb
->CacheSegmentSize
,
697 (PMEMORY_AREA
*)¤t
->MemoryArea
,
700 BoundaryAddressMultiple
);
701 MmUnlockAddressSpace(MmGetKernelAddressSpace());
702 if (!NT_SUCCESS(Status
))
704 KeBugCheck(CACHE_MANAGER
);
708 /* Create a virtual mapping for this memory area */
709 MI_SET_USAGE(MI_USAGE_CACHE
);
713 if ((Bcb
->FileObject
) && (Bcb
->FileObject
->FileName
.Buffer
))
715 pos
= wcsrchr(Bcb
->FileObject
->FileName
.Buffer
, '\\');
716 len
= wcslen(pos
) * sizeof(WCHAR
);
717 if (pos
) snprintf(MI_PFN_CURRENT_PROCESS_NAME
, min(16, len
), "%S", pos
);
721 MmMapMemoryArea(current
->BaseAddress
, Bcb
->CacheSegmentSize
,
722 MC_CACHE
, PAGE_READWRITE
);
724 return(STATUS_SUCCESS
);
729 CcRosGetCacheSegmentChain(PBCB Bcb
,
732 PCACHE_SEGMENT
* CacheSeg
)
734 PCACHE_SEGMENT current
;
736 PCACHE_SEGMENT
* CacheSegList
;
737 PCACHE_SEGMENT Previous
= NULL
;
741 DPRINT("CcRosGetCacheSegmentChain()\n");
743 Length
= ROUND_UP(Length
, Bcb
->CacheSegmentSize
);
745 CacheSegList
= _alloca(sizeof(PCACHE_SEGMENT
) *
746 (Length
/ Bcb
->CacheSegmentSize
));
749 * Look for a cache segment already mapping the same data.
751 for (i
= 0; i
< (Length
/ Bcb
->CacheSegmentSize
); i
++)
753 ULONG CurrentOffset
= FileOffset
+ (i
* Bcb
->CacheSegmentSize
);
754 current
= CcRosLookupCacheSegment(Bcb
, CurrentOffset
);
757 CacheSegList
[i
] = current
;
761 CcRosCreateCacheSegment(Bcb
, CurrentOffset
, ¤t
);
762 CacheSegList
[i
] = current
;
766 for (i
= 0; i
< (Length
/ Bcb
->CacheSegmentSize
); i
++)
770 *CacheSeg
= CacheSegList
[i
];
771 Previous
= CacheSegList
[i
];
775 Previous
->NextInChain
= CacheSegList
[i
];
776 Previous
= CacheSegList
[i
];
780 Previous
->NextInChain
= NULL
;
782 return(STATUS_SUCCESS
);
787 CcRosGetCacheSegment(PBCB Bcb
,
792 PCACHE_SEGMENT
* CacheSeg
)
794 PCACHE_SEGMENT current
;
799 DPRINT("CcRosGetCacheSegment()\n");
802 * Look for a cache segment already mapping the same data.
804 current
= CcRosLookupCacheSegment(Bcb
, FileOffset
);
808 * Otherwise create a new segment.
810 Status
= CcRosCreateCacheSegment(Bcb
, FileOffset
, ¤t
);
811 if (!NT_SUCCESS(Status
))
817 * Return information about the segment to the caller.
819 *UptoDate
= current
->Valid
;
820 *BaseAddress
= current
->BaseAddress
;
821 DPRINT("*BaseAddress 0x%.8X\n", *BaseAddress
);
823 *BaseOffset
= current
->FileOffset
;
824 return(STATUS_SUCCESS
);
828 CcRosRequestCacheSegment(PBCB Bcb
,
832 PCACHE_SEGMENT
* CacheSeg
)
834 * FUNCTION: Request a page mapping for a BCB
841 if ((FileOffset
% Bcb
->CacheSegmentSize
) != 0)
843 DPRINT1("Bad fileoffset %x should be multiple of %x",
844 FileOffset
, Bcb
->CacheSegmentSize
);
845 KeBugCheck(CACHE_MANAGER
);
848 return(CcRosGetCacheSegment(Bcb
,
858 CcFreeCachePage(PVOID Context
, MEMORY_AREA
* MemoryArea
, PVOID Address
,
859 PFN_NUMBER Page
, SWAPENTRY SwapEntry
, BOOLEAN Dirty
)
861 ASSERT(SwapEntry
== 0);
864 MmReleasePageMemoryConsumer(MC_CACHE
, Page
);
869 CcRosInternalFreeCacheSegment(PCACHE_SEGMENT CacheSeg
)
871 * FUNCTION: Releases a cache segment associated with a BCB
881 DPRINT("Freeing cache segment 0x%p\n", CacheSeg
);
883 if ( CacheSeg
->Bcb
->Trace
)
885 DPRINT1("CacheMap 0x%p: deleting Cache Segment: 0x%p\n", CacheSeg
->Bcb
, CacheSeg
);
889 RegionSize
= CacheSeg
->Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
891 /* Unmap all the pages. */
892 for (i
= 0; i
< RegionSize
; i
++)
894 MmDeleteVirtualMapping(NULL
,
895 CacheSeg
->BaseAddress
+ (i
* PAGE_SIZE
),
899 MmReleasePageMemoryConsumer(MC_CACHE
, Page
);
902 KeAcquireSpinLock(&CiCacheSegMappingRegionLock
, &oldIrql
);
903 /* Deallocate all the pages used. */
904 Base
= (ULONG
)(CacheSeg
->BaseAddress
- CiCacheSegMappingRegionBase
) / PAGE_SIZE
;
906 RtlClearBits(&CiCacheSegMappingRegionAllocMap
, Base
, RegionSize
);
908 CiCacheSegMappingRegionHint
= min (CiCacheSegMappingRegionHint
, Base
);
910 KeReleaseSpinLock(&CiCacheSegMappingRegionLock
, oldIrql
);
912 MmLockAddressSpace(MmGetKernelAddressSpace());
913 MmFreeMemoryArea(MmGetKernelAddressSpace(),
914 CacheSeg
->MemoryArea
,
917 MmUnlockAddressSpace(MmGetKernelAddressSpace());
919 ExFreeToNPagedLookasideList(&CacheSegLookasideList
, CacheSeg
);
920 return(STATUS_SUCCESS
);
925 CcRosFreeCacheSegment(PBCB Bcb
, PCACHE_SEGMENT CacheSeg
)
932 DPRINT("CcRosFreeCacheSegment(Bcb 0x%p, CacheSeg 0x%p)\n",
935 KeAcquireGuardedMutex(&ViewLock
);
936 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldIrql
);
937 RemoveEntryList(&CacheSeg
->BcbSegmentListEntry
);
938 RemoveEntryList(&CacheSeg
->CacheSegmentListEntry
);
939 RemoveEntryList(&CacheSeg
->CacheSegmentLRUListEntry
);
942 RemoveEntryList(&CacheSeg
->DirtySegmentListEntry
);
943 DirtyPageCount
-= Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
946 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
947 KeReleaseGuardedMutex(&ViewLock
);
949 Status
= CcRosInternalFreeCacheSegment(CacheSeg
);
957 CcFlushCache(IN PSECTION_OBJECT_POINTERS SectionObjectPointers
,
958 IN PLARGE_INTEGER FileOffset OPTIONAL
,
960 OUT PIO_STATUS_BLOCK IoStatus
)
963 LARGE_INTEGER Offset
;
964 PCACHE_SEGMENT current
;
968 DPRINT("CcFlushCache(SectionObjectPointers 0x%p, FileOffset 0x%p, Length %d, IoStatus 0x%p)\n",
969 SectionObjectPointers
, FileOffset
, Length
, IoStatus
);
971 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
973 Bcb
= (PBCB
)SectionObjectPointers
->SharedCacheMap
;
977 Offset
= *FileOffset
;
981 Offset
.QuadPart
= (LONGLONG
)0;
982 Length
= Bcb
->FileSize
.u
.LowPart
;
987 IoStatus
->Status
= STATUS_SUCCESS
;
988 IoStatus
->Information
= 0;
993 current
= CcRosLookupCacheSegment (Bcb
, Offset
.u
.LowPart
);
998 Status
= CcRosFlushCacheSegment(current
);
999 if (!NT_SUCCESS(Status
) && IoStatus
!= NULL
)
1001 IoStatus
->Status
= Status
;
1004 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldIrql
);
1005 ExReleasePushLock(¤t
->Lock
);
1006 CcRosCacheSegmentDecRefCount(current
);
1007 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
1010 Offset
.QuadPart
+= Bcb
->CacheSegmentSize
;
1011 if (Length
> Bcb
->CacheSegmentSize
)
1013 Length
-= Bcb
->CacheSegmentSize
;
1025 IoStatus
->Status
= STATUS_INVALID_PARAMETER
;
1032 CcRosDeleteFileCache(PFILE_OBJECT FileObject
, PBCB Bcb
)
1034 * FUNCTION: Releases the BCB associated with a file object
1037 PLIST_ENTRY current_entry
;
1038 PCACHE_SEGMENT current
;
1039 LIST_ENTRY FreeList
;
1045 KeReleaseGuardedMutex(&ViewLock
);
1047 CcFlushCache(FileObject
->SectionObjectPointer
, NULL
, 0, NULL
);
1049 KeAcquireGuardedMutex(&ViewLock
);
1051 if (Bcb
->RefCount
== 0)
1053 if (Bcb
->BcbRemoveListEntry
.Flink
!= NULL
)
1055 RemoveEntryList(&Bcb
->BcbRemoveListEntry
);
1056 Bcb
->BcbRemoveListEntry
.Flink
= NULL
;
1059 FileObject
->SectionObjectPointer
->SharedCacheMap
= NULL
;
1062 * Release all cache segments.
1064 InitializeListHead(&FreeList
);
1065 KeAcquireSpinLock(&Bcb
->BcbLock
, &oldIrql
);
1066 current_entry
= Bcb
->BcbSegmentListHead
.Flink
;
1067 while (!IsListEmpty(&Bcb
->BcbSegmentListHead
))
1069 current_entry
= RemoveTailList(&Bcb
->BcbSegmentListHead
);
1070 current
= CONTAINING_RECORD(current_entry
, CACHE_SEGMENT
, BcbSegmentListEntry
);
1071 RemoveEntryList(¤t
->CacheSegmentListEntry
);
1072 RemoveEntryList(¤t
->CacheSegmentLRUListEntry
);
1075 RemoveEntryList(¤t
->DirtySegmentListEntry
);
1076 DirtyPageCount
-= Bcb
->CacheSegmentSize
/ PAGE_SIZE
;
1077 DPRINT1("Freeing dirty segment\n");
1079 InsertHeadList(&FreeList
, ¤t
->BcbSegmentListEntry
);
1084 KeReleaseSpinLock(&Bcb
->BcbLock
, oldIrql
);
1086 KeReleaseGuardedMutex(&ViewLock
);
1087 ObDereferenceObject (Bcb
->FileObject
);
1089 while (!IsListEmpty(&FreeList
))
1091 current_entry
= RemoveTailList(&FreeList
);
1092 current
= CONTAINING_RECORD(current_entry
, CACHE_SEGMENT
, BcbSegmentListEntry
);
1093 CcRosInternalFreeCacheSegment(current
);
1095 ExFreeToNPagedLookasideList(&BcbLookasideList
, Bcb
);
1096 KeAcquireGuardedMutex(&ViewLock
);
1098 return(STATUS_SUCCESS
);
1103 CcRosReferenceCache(PFILE_OBJECT FileObject
)
1106 KeAcquireGuardedMutex(&ViewLock
);
1107 Bcb
= (PBCB
)FileObject
->SectionObjectPointer
->SharedCacheMap
;
1109 if (Bcb
->RefCount
== 0)
1111 ASSERT(Bcb
->BcbRemoveListEntry
.Flink
!= NULL
);
1112 RemoveEntryList(&Bcb
->BcbRemoveListEntry
);
1113 Bcb
->BcbRemoveListEntry
.Flink
= NULL
;
1118 ASSERT(Bcb
->BcbRemoveListEntry
.Flink
== NULL
);
1121 KeReleaseGuardedMutex(&ViewLock
);
1126 CcRosSetRemoveOnClose(PSECTION_OBJECT_POINTERS SectionObjectPointer
)
1129 DPRINT("CcRosSetRemoveOnClose()\n");
1130 KeAcquireGuardedMutex(&ViewLock
);
1131 Bcb
= (PBCB
)SectionObjectPointer
->SharedCacheMap
;
1134 Bcb
->RemoveOnClose
= TRUE
;
1135 if (Bcb
->RefCount
== 0)
1137 CcRosDeleteFileCache(Bcb
->FileObject
, Bcb
);
1140 KeReleaseGuardedMutex(&ViewLock
);
1146 CcRosDereferenceCache(PFILE_OBJECT FileObject
)
1149 KeAcquireGuardedMutex(&ViewLock
);
1150 Bcb
= (PBCB
)FileObject
->SectionObjectPointer
->SharedCacheMap
;
1152 if (Bcb
->RefCount
> 0)
1155 if (Bcb
->RefCount
== 0)
1157 MmFreeSectionSegments(Bcb
->FileObject
);
1158 CcRosDeleteFileCache(FileObject
, Bcb
);
1161 KeReleaseGuardedMutex(&ViewLock
);
1165 CcRosReleaseFileCache(PFILE_OBJECT FileObject
)
1167 * FUNCTION: Called by the file system when a handle to a file object
1173 KeAcquireGuardedMutex(&ViewLock
);
1175 if (FileObject
->SectionObjectPointer
->SharedCacheMap
!= NULL
)
1177 Bcb
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1178 if (FileObject
->PrivateCacheMap
!= NULL
)
1180 FileObject
->PrivateCacheMap
= NULL
;
1181 if (Bcb
->RefCount
> 0)
1184 if (Bcb
->RefCount
== 0)
1186 MmFreeSectionSegments(Bcb
->FileObject
);
1187 CcRosDeleteFileCache(FileObject
, Bcb
);
1192 KeReleaseGuardedMutex(&ViewLock
);
1193 return(STATUS_SUCCESS
);
1198 CcTryToInitializeFileCache(PFILE_OBJECT FileObject
)
1203 KeAcquireGuardedMutex(&ViewLock
);
1205 ASSERT(FileObject
->SectionObjectPointer
);
1206 Bcb
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1209 Status
= STATUS_UNSUCCESSFUL
;
1213 if (FileObject
->PrivateCacheMap
== NULL
)
1215 FileObject
->PrivateCacheMap
= Bcb
;
1218 if (Bcb
->BcbRemoveListEntry
.Flink
!= NULL
)
1220 RemoveEntryList(&Bcb
->BcbRemoveListEntry
);
1221 Bcb
->BcbRemoveListEntry
.Flink
= NULL
;
1223 Status
= STATUS_SUCCESS
;
1225 KeReleaseGuardedMutex(&ViewLock
);
1232 CcRosInitializeFileCache(PFILE_OBJECT FileObject
,
1233 ULONG CacheSegmentSize
,
1234 PCACHE_MANAGER_CALLBACKS CallBacks
,
1235 PVOID LazyWriterContext
)
1237 * FUNCTION: Initializes a BCB for a file object
1242 Bcb
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
1243 DPRINT("CcRosInitializeFileCache(FileObject 0x%p, Bcb 0x%p, CacheSegmentSize %d)\n",
1244 FileObject
, Bcb
, CacheSegmentSize
);
1246 KeAcquireGuardedMutex(&ViewLock
);
1249 Bcb
= ExAllocateFromNPagedLookasideList(&BcbLookasideList
);
1252 KeReleaseGuardedMutex(&ViewLock
);
1253 return(STATUS_UNSUCCESSFUL
);
1255 memset(Bcb
, 0, sizeof(BCB
));
1256 ObReferenceObjectByPointer(FileObject
,
1260 Bcb
->FileObject
= FileObject
;
1261 Bcb
->CacheSegmentSize
= CacheSegmentSize
;
1262 Bcb
->Callbacks
= CallBacks
;
1263 Bcb
->LazyWriteContext
= LazyWriterContext
;
1264 if (FileObject
->FsContext
)
1266 Bcb
->AllocationSize
=
1267 ((PFSRTL_COMMON_FCB_HEADER
)FileObject
->FsContext
)->AllocationSize
;
1269 ((PFSRTL_COMMON_FCB_HEADER
)FileObject
->FsContext
)->FileSize
;
1271 KeInitializeSpinLock(&Bcb
->BcbLock
);
1272 InitializeListHead(&Bcb
->BcbSegmentListHead
);
1273 FileObject
->SectionObjectPointer
->SharedCacheMap
= Bcb
;
1275 if (FileObject
->PrivateCacheMap
== NULL
)
1277 FileObject
->PrivateCacheMap
= Bcb
;
1280 if (Bcb
->BcbRemoveListEntry
.Flink
!= NULL
)
1282 RemoveEntryList(&Bcb
->BcbRemoveListEntry
);
1283 Bcb
->BcbRemoveListEntry
.Flink
= NULL
;
1285 KeReleaseGuardedMutex(&ViewLock
);
1287 return(STATUS_SUCCESS
);
1294 CcGetFileObjectFromSectionPtrs(IN PSECTION_OBJECT_POINTERS SectionObjectPointers
)
1297 if (SectionObjectPointers
&& SectionObjectPointers
->SharedCacheMap
)
1299 Bcb
= (PBCB
)SectionObjectPointers
->SharedCacheMap
;
1301 return Bcb
->FileObject
;
1314 PHYSICAL_ADDRESS BoundaryAddressMultiple
;
1317 DPRINT("CcInitView()\n");
1319 BoundaryAddressMultiple
.QuadPart
= 0;
1320 CiCacheSegMappingRegionHint
= 0;
1321 CiCacheSegMappingRegionBase
= NULL
;
1323 MmLockAddressSpace(MmGetKernelAddressSpace());
1325 Status
= MmCreateMemoryArea(MmGetKernelAddressSpace(),
1326 MEMORY_AREA_CACHE_SEGMENT
,
1327 &CiCacheSegMappingRegionBase
,
1328 CI_CACHESEG_MAPPING_REGION_SIZE
,
1333 BoundaryAddressMultiple
);
1334 MmUnlockAddressSpace(MmGetKernelAddressSpace());
1335 if (!NT_SUCCESS(Status
))
1337 KeBugCheck(CACHE_MANAGER
);
1340 Buffer
= ExAllocatePool(NonPagedPool
, CI_CACHESEG_MAPPING_REGION_SIZE
/ (PAGE_SIZE
* 8));
1343 KeBugCheck(CACHE_MANAGER
);
1346 RtlInitializeBitMap(&CiCacheSegMappingRegionAllocMap
, Buffer
, CI_CACHESEG_MAPPING_REGION_SIZE
/ PAGE_SIZE
);
1347 RtlClearAllBits(&CiCacheSegMappingRegionAllocMap
);
1349 KeInitializeSpinLock(&CiCacheSegMappingRegionLock
);
1351 InitializeListHead(&CacheSegmentListHead
);
1352 InitializeListHead(&DirtySegmentListHead
);
1353 InitializeListHead(&CacheSegmentLRUListHead
);
1354 InitializeListHead(&ClosedListHead
);
1355 KeInitializeGuardedMutex(&ViewLock
);
1356 ExInitializeNPagedLookasideList (&iBcbLookasideList
,
1360 sizeof(INTERNAL_BCB
),
1363 ExInitializeNPagedLookasideList (&BcbLookasideList
,
1370 ExInitializeNPagedLookasideList (&CacheSegLookasideList
,
1374 sizeof(CACHE_SEGMENT
),
1378 MmInitializeMemoryConsumer(MC_CACHE
, CcRosTrimCache
);
1380 CcInitCacheZeroPage();