2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: ntoskrnl/cc/fs.c
5 * PURPOSE: Implements cache managers functions useful for File Systems
7 * PROGRAMMERS: Alex Ionescu
10 /* INCLUDES ******************************************************************/
16 #ifndef VACB_MAPPING_GRANULARITY
17 #define VACB_MAPPING_GRANULARITY (256 * 1024)
20 /* GLOBALS *****************************************************************/
22 extern KGUARDED_MUTEX ViewLock
;
23 extern ULONG DirtyPageCount
;
25 NTSTATUS
CcRosInternalFreeVacb(PROS_VACB Vacb
);
27 /* FUNCTIONS *****************************************************************/
36 IN PDIRTY_PAGE_ROUTINE DirtyPageRoutine
,
42 CCTRACE(CC_API_DEBUG
, "LogHandle=%p DirtyPageRoutine=%p Context1=%p Context2=%p\n",
43 LogHandle
, DirtyPageRoutine
, Context1
, Context2
);
55 CcGetFileObjectFromBcb (
58 PINTERNAL_BCB iBcb
= (PINTERNAL_BCB
)Bcb
;
60 CCTRACE(CC_API_DEBUG
, "Bcb=%p\n", Bcb
);
62 return iBcb
->Vacb
->SharedCacheMap
->FileObject
;
70 CcGetLsnForFileObject (
71 IN PFILE_OBJECT FileObject
,
72 OUT PLARGE_INTEGER OldestLsn OPTIONAL
)
76 CCTRACE(CC_API_DEBUG
, "FileObject=%p\n", FileObject
);
88 CcInitializeCacheMap (
89 IN PFILE_OBJECT FileObject
,
90 IN PCC_FILE_SIZES FileSizes
,
92 IN PCACHE_MANAGER_CALLBACKS CallBacks
,
93 IN PVOID LazyWriterContext
)
100 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileSizes=%p PinAccess=%d CallBacks=%p LazyWriterContext=%p\n",
101 FileObject
, FileSizes
, PinAccess
, CallBacks
, LazyWriterContext
);
103 /* Call old ROS cache init function */
104 Status
= CcRosInitializeFileCache(FileObject
,
109 if (!NT_SUCCESS(Status
))
110 ExRaiseStatus(Status
);
121 CCTRACE(CC_API_DEBUG
, "Vpb=%p\n", Vpb
);
132 CcPurgeCacheSection (
133 IN PSECTION_OBJECT_POINTERS SectionObjectPointer
,
134 IN PLARGE_INTEGER FileOffset OPTIONAL
,
136 IN BOOLEAN UninitializeCacheMaps
)
138 PROS_SHARED_CACHE_MAP SharedCacheMap
;
139 LONGLONG StartOffset
;
143 PLIST_ENTRY ListEntry
;
147 CCTRACE(CC_API_DEBUG
, "SectionObjectPointer=%p\n FileOffset=%p Length=%lu UninitializeCacheMaps=%d",
148 SectionObjectPointer
, FileOffset
, Length
, UninitializeCacheMaps
);
150 if (UninitializeCacheMaps
)
152 DPRINT1("FIXME: CcPurgeCacheSection not uninitializing private cache maps\n");
155 SharedCacheMap
= SectionObjectPointer
->SharedCacheMap
;
157 StartOffset
= FileOffset
!= NULL
? FileOffset
->QuadPart
: 0;
158 if (Length
== 0 || FileOffset
== NULL
)
160 EndOffset
= MAXLONGLONG
;
164 EndOffset
= StartOffset
+ Length
;
165 ASSERT(EndOffset
> StartOffset
);
168 InitializeListHead(&FreeList
);
170 KeAcquireGuardedMutex(&ViewLock
);
171 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &OldIrql
);
172 ListEntry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
173 while (ListEntry
!= &SharedCacheMap
->CacheMapVacbListHead
)
175 Vacb
= CONTAINING_RECORD(ListEntry
, ROS_VACB
, CacheMapVacbListEntry
);
176 ListEntry
= ListEntry
->Flink
;
178 /* Skip VACBs outside the range, or only partially in range */
179 if (Vacb
->FileOffset
.QuadPart
< StartOffset
)
183 ViewEnd
= min(Vacb
->FileOffset
.QuadPart
+ VACB_MAPPING_GRANULARITY
,
184 SharedCacheMap
->SectionSize
.QuadPart
);
185 if (ViewEnd
>= EndOffset
)
190 ASSERT((Vacb
->ReferenceCount
== 0) ||
191 (Vacb
->ReferenceCount
== 1 && Vacb
->Dirty
));
193 /* This VACB is in range, so unlink it and mark for free */
194 RemoveEntryList(&Vacb
->VacbLruListEntry
);
197 RemoveEntryList(&Vacb
->DirtyVacbListEntry
);
198 DirtyPageCount
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
200 RemoveEntryList(&Vacb
->CacheMapVacbListEntry
);
201 InsertHeadList(&FreeList
, &Vacb
->CacheMapVacbListEntry
);
203 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, OldIrql
);
204 KeReleaseGuardedMutex(&ViewLock
);
206 while (!IsListEmpty(&FreeList
))
208 Vacb
= CONTAINING_RECORD(RemoveHeadList(&FreeList
),
210 CacheMapVacbListEntry
);
211 CcRosInternalFreeVacb(Vacb
);
223 IN PFILE_OBJECT FileObject
,
224 IN PCC_FILE_SIZES FileSizes
)
227 PROS_SHARED_CACHE_MAP SharedCacheMap
;
228 PLIST_ENTRY current_entry
;
230 LIST_ENTRY FreeListHead
;
233 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileSizes=%p\n",
234 FileObject
, FileSizes
);
236 DPRINT("CcSetFileSizes(FileObject 0x%p, FileSizes 0x%p)\n",
237 FileObject
, FileSizes
);
238 DPRINT("AllocationSize %I64d, FileSize %I64d, ValidDataLength %I64d\n",
239 FileSizes
->AllocationSize
.QuadPart
,
240 FileSizes
->FileSize
.QuadPart
,
241 FileSizes
->ValidDataLength
.QuadPart
);
243 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
246 * It is valid to call this function on file objects that weren't
247 * initialized for caching. In this case it's simple no-op.
249 if (SharedCacheMap
== NULL
)
252 if (FileSizes
->AllocationSize
.QuadPart
< SharedCacheMap
->SectionSize
.QuadPart
)
254 InitializeListHead(&FreeListHead
);
255 KeAcquireGuardedMutex(&ViewLock
);
256 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldirql
);
258 current_entry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
259 while (current_entry
!= &SharedCacheMap
->CacheMapVacbListHead
)
261 current
= CONTAINING_RECORD(current_entry
,
263 CacheMapVacbListEntry
);
264 current_entry
= current_entry
->Flink
;
265 if (current
->FileOffset
.QuadPart
>= FileSizes
->AllocationSize
.QuadPart
)
267 if ((current
->ReferenceCount
== 0) || ((current
->ReferenceCount
== 1) && current
->Dirty
))
269 RemoveEntryList(¤t
->CacheMapVacbListEntry
);
270 RemoveEntryList(¤t
->VacbLruListEntry
);
273 RemoveEntryList(¤t
->DirtyVacbListEntry
);
274 DirtyPageCount
-= VACB_MAPPING_GRANULARITY
/ PAGE_SIZE
;
276 InsertHeadList(&FreeListHead
, ¤t
->CacheMapVacbListEntry
);
280 DPRINT1("Someone has referenced a VACB behind the new size.\n");
281 KeBugCheck(CACHE_MANAGER
);
286 SharedCacheMap
->SectionSize
= FileSizes
->AllocationSize
;
287 SharedCacheMap
->FileSize
= FileSizes
->FileSize
;
288 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldirql
);
289 KeReleaseGuardedMutex(&ViewLock
);
291 current_entry
= FreeListHead
.Flink
;
292 while(current_entry
!= &FreeListHead
)
294 current
= CONTAINING_RECORD(current_entry
, ROS_VACB
, CacheMapVacbListEntry
);
295 current_entry
= current_entry
->Flink
;
296 Status
= CcRosInternalFreeVacb(current
);
297 if (!NT_SUCCESS(Status
))
299 DPRINT1("CcRosInternalFreeVacb failed, status = %x\n", Status
);
300 KeBugCheck(CACHE_MANAGER
);
306 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &oldirql
);
307 SharedCacheMap
->SectionSize
= FileSizes
->AllocationSize
;
308 SharedCacheMap
->FileSize
= FileSizes
->FileSize
;
309 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, oldirql
);
318 CcSetLogHandleForFile (
319 IN PFILE_OBJECT FileObject
,
321 IN PFLUSH_TO_LSN FlushToLsnRoutine
)
323 CCTRACE(CC_API_DEBUG
, "FileObject=%p LogHandle=%p FlushToLsnRoutine=%p\n",
324 FileObject
, LogHandle
, FlushToLsnRoutine
);
334 CcUninitializeCacheMap (
335 IN PFILE_OBJECT FileObject
,
336 IN PLARGE_INTEGER TruncateSize OPTIONAL
,
337 IN PCACHE_UNINITIALIZE_EVENT UninitializeCompleteEvent OPTIONAL
)
341 CCTRACE(CC_API_DEBUG
, "FileObject=%p TruncateSize=%p UninitializeCompleteEvent=%p\n",
342 FileObject
, TruncateSize
, UninitializeCompleteEvent
);
344 Status
= CcRosReleaseFileCache(FileObject
);
345 if (UninitializeCompleteEvent
)
346 KeSetEvent(&UninitializeCompleteEvent
->Event
, IO_NO_INCREMENT
, FALSE
);
347 return NT_SUCCESS(Status
);
353 IN PFILE_OBJECT FileObject
,
354 IN PCC_FILE_SIZES FileSizes
)
356 PROS_SHARED_CACHE_MAP SharedCacheMap
;
358 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
363 FileSizes
->AllocationSize
= SharedCacheMap
->SectionSize
;
364 FileSizes
->FileSize
= FileSizes
->ValidDataLength
= SharedCacheMap
->FileSize
;