2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: ntoskrnl/cc/copy.c
5 * PURPOSE: Implements cache managers copy interface
7 * PROGRAMMERS: Some people?
8 * Pierre Schweitzer (pierre@reactos.org)
11 /* INCLUDES ******************************************************************/
17 /* GLOBALS *******************************************************************/
19 static PFN_NUMBER CcZeroPage
= 0;
21 #define MAX_ZERO_LENGTH (256 * 1024)
23 typedef enum _CC_COPY_OPERATION
30 ULONG CcRosTraceLevel
= 0;
31 ULONG CcFastMdlReadWait
;
32 ULONG CcFastMdlReadNotPossible
;
33 ULONG CcFastReadNotPossible
;
35 ULONG CcFastReadNoWait
;
36 ULONG CcFastReadResourceMiss
;
38 extern KEVENT iLazyWriterNotify
;
40 /* FUNCTIONS *****************************************************************/
45 IN PFN_NUMBER PageFrameIndex
55 MI_SET_USAGE(MI_USAGE_CACHE
);
56 //MI_SET_PROCESS2(PsGetCurrentProcess()->ImageFileName);
57 Status
= MmRequestPageMemoryConsumer(MC_SYSTEM
, TRUE
, &CcZeroPage
);
58 if (!NT_SUCCESS(Status
))
60 DbgPrint("Can't allocate CcZeroPage.\n");
61 KeBugCheck(CACHE_MANAGER
);
63 MiZeroPhysicalPage(CcZeroPage
);
68 CcReadVirtualAddress (
74 IO_STATUS_BLOCK IoStatus
;
77 Size
= (ULONG
)(Vacb
->SharedCacheMap
->SectionSize
.QuadPart
- Vacb
->FileOffset
.QuadPart
);
78 if (Size
> VACB_MAPPING_GRANULARITY
)
80 Size
= VACB_MAPPING_GRANULARITY
;
83 Pages
= BYTES_TO_PAGES(Size
);
84 ASSERT(Pages
* PAGE_SIZE
<= VACB_MAPPING_GRANULARITY
);
86 Mdl
= IoAllocateMdl(Vacb
->BaseAddress
, Pages
* PAGE_SIZE
, FALSE
, FALSE
, NULL
);
89 return STATUS_INSUFFICIENT_RESOURCES
;
92 Status
= STATUS_SUCCESS
;
95 MmProbeAndLockPages(Mdl
, KernelMode
, IoWriteAccess
);
97 _SEH2_EXCEPT (EXCEPTION_EXECUTE_HANDLER
)
99 Status
= _SEH2_GetExceptionCode();
100 KeBugCheck(CACHE_MANAGER
);
103 if (NT_SUCCESS(Status
))
105 Mdl
->MdlFlags
|= MDL_IO_PAGE_READ
;
106 KeInitializeEvent(&Event
, NotificationEvent
, FALSE
);
107 Status
= IoPageRead(Vacb
->SharedCacheMap
->FileObject
, Mdl
, &Vacb
->FileOffset
, &Event
, &IoStatus
);
108 if (Status
== STATUS_PENDING
)
110 KeWaitForSingleObject(&Event
, Executive
, KernelMode
, FALSE
, NULL
);
111 Status
= IoStatus
.Status
;
119 if (!NT_SUCCESS(Status
) && (Status
!= STATUS_END_OF_FILE
))
121 DPRINT1("IoPageRead failed, Status %x\n", Status
);
125 if (Size
< VACB_MAPPING_GRANULARITY
)
127 RtlZeroMemory((char*)Vacb
->BaseAddress
+ Size
,
128 VACB_MAPPING_GRANULARITY
- Size
);
131 return STATUS_SUCCESS
;
136 CcWriteVirtualAddress (
142 IO_STATUS_BLOCK IoStatus
;
145 Size
= (ULONG
)(Vacb
->SharedCacheMap
->SectionSize
.QuadPart
- Vacb
->FileOffset
.QuadPart
);
146 if (Size
> VACB_MAPPING_GRANULARITY
)
148 Size
= VACB_MAPPING_GRANULARITY
;
151 // Nonpaged pool PDEs in ReactOS must actually be synchronized between the
152 // MmGlobalPageDirectory and the real system PDE directory. What a mess...
158 MmGetPfnForProcess(NULL
, (PVOID
)((ULONG_PTR
)Vacb
->BaseAddress
+ (i
<< PAGE_SHIFT
)));
159 } while (++i
< (Size
>> PAGE_SHIFT
));
162 Mdl
= IoAllocateMdl(Vacb
->BaseAddress
, Size
, FALSE
, FALSE
, NULL
);
165 return STATUS_INSUFFICIENT_RESOURCES
;
168 Status
= STATUS_SUCCESS
;
171 MmProbeAndLockPages(Mdl
, KernelMode
, IoReadAccess
);
173 _SEH2_EXCEPT (EXCEPTION_EXECUTE_HANDLER
)
175 Status
= _SEH2_GetExceptionCode();
176 KeBugCheck(CACHE_MANAGER
);
179 if (NT_SUCCESS(Status
))
181 KeInitializeEvent(&Event
, NotificationEvent
, FALSE
);
182 Status
= IoSynchronousPageWrite(Vacb
->SharedCacheMap
->FileObject
, Mdl
, &Vacb
->FileOffset
, &Event
, &IoStatus
);
183 if (Status
== STATUS_PENDING
)
185 KeWaitForSingleObject(&Event
, Executive
, KernelMode
, FALSE
, NULL
);
186 Status
= IoStatus
.Status
;
192 if (!NT_SUCCESS(Status
) && (Status
!= STATUS_END_OF_FILE
))
194 DPRINT1("IoPageWrite failed, Status %x\n", Status
);
198 return STATUS_SUCCESS
;
203 _Inout_ PVOID BaseAddress
,
204 _Inout_opt_ PVOID Buffer
,
206 _In_ CC_COPY_OPERATION Operation
)
208 NTSTATUS Status
= STATUS_SUCCESS
;
210 if (Operation
== CcOperationZero
)
213 RtlZeroMemory(BaseAddress
, Length
);
219 if (Operation
== CcOperationWrite
)
220 RtlCopyMemory(BaseAddress
, Buffer
, Length
);
222 RtlCopyMemory(Buffer
, BaseAddress
, Length
);
224 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
226 Status
= _SEH2_GetExceptionCode();
235 _In_ PFILE_OBJECT FileObject
,
236 _In_ LONGLONG FileOffset
,
237 _Inout_ PVOID Buffer
,
238 _In_ LONGLONG Length
,
239 _In_ CC_COPY_OPERATION Operation
,
241 _Out_ PIO_STATUS_BLOCK IoStatus
)
244 LONGLONG CurrentOffset
;
247 PROS_SHARED_CACHE_MAP SharedCacheMap
;
248 PLIST_ENTRY ListEntry
;
254 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
255 CurrentOffset
= FileOffset
;
260 /* test if the requested data is available */
261 KeAcquireSpinLock(&SharedCacheMap
->CacheMapLock
, &OldIrql
);
262 /* FIXME: this loop doesn't take into account areas that don't have
263 * a VACB in the list yet */
264 ListEntry
= SharedCacheMap
->CacheMapVacbListHead
.Flink
;
265 while (ListEntry
!= &SharedCacheMap
->CacheMapVacbListHead
)
267 Vacb
= CONTAINING_RECORD(ListEntry
,
269 CacheMapVacbListEntry
);
270 ListEntry
= ListEntry
->Flink
;
272 DoRangesIntersect(Vacb
->FileOffset
.QuadPart
,
273 VACB_MAPPING_GRANULARITY
,
274 CurrentOffset
, Length
))
276 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, OldIrql
);
277 /* data not available */
280 if (Vacb
->FileOffset
.QuadPart
>= CurrentOffset
+ Length
)
283 KeReleaseSpinLock(&SharedCacheMap
->CacheMapLock
, OldIrql
);
286 PartialLength
= CurrentOffset
% VACB_MAPPING_GRANULARITY
;
287 if (PartialLength
!= 0)
289 PartialLength
= min(Length
, VACB_MAPPING_GRANULARITY
- PartialLength
);
290 Status
= CcRosRequestVacb(SharedCacheMap
,
291 ROUND_DOWN(CurrentOffset
,
292 VACB_MAPPING_GRANULARITY
),
296 if (!NT_SUCCESS(Status
))
297 ExRaiseStatus(Status
);
300 Status
= CcReadVirtualAddress(Vacb
);
301 if (!NT_SUCCESS(Status
))
303 CcRosReleaseVacb(SharedCacheMap
, Vacb
, FALSE
, FALSE
, FALSE
);
304 ExRaiseStatus(Status
);
307 Status
= ReadWriteOrZero((PUCHAR
)BaseAddress
+ CurrentOffset
% VACB_MAPPING_GRANULARITY
,
312 CcRosReleaseVacb(SharedCacheMap
, Vacb
, TRUE
, Operation
!= CcOperationRead
, FALSE
);
314 if (!NT_SUCCESS(Status
))
315 ExRaiseStatus(STATUS_INVALID_USER_BUFFER
);
317 Length
-= PartialLength
;
318 CurrentOffset
+= PartialLength
;
319 BytesCopied
+= PartialLength
;
321 if (Operation
!= CcOperationZero
)
322 Buffer
= (PVOID
)((ULONG_PTR
)Buffer
+ PartialLength
);
327 ASSERT(CurrentOffset
% VACB_MAPPING_GRANULARITY
== 0);
328 PartialLength
= min(VACB_MAPPING_GRANULARITY
, Length
);
329 Status
= CcRosRequestVacb(SharedCacheMap
,
334 if (!NT_SUCCESS(Status
))
335 ExRaiseStatus(Status
);
337 (Operation
== CcOperationRead
||
338 PartialLength
< VACB_MAPPING_GRANULARITY
))
340 Status
= CcReadVirtualAddress(Vacb
);
341 if (!NT_SUCCESS(Status
))
343 CcRosReleaseVacb(SharedCacheMap
, Vacb
, FALSE
, FALSE
, FALSE
);
344 ExRaiseStatus(Status
);
347 Status
= ReadWriteOrZero(BaseAddress
, Buffer
, PartialLength
, Operation
);
349 CcRosReleaseVacb(SharedCacheMap
, Vacb
, TRUE
, Operation
!= CcOperationRead
, FALSE
);
351 if (!NT_SUCCESS(Status
))
352 ExRaiseStatus(STATUS_INVALID_USER_BUFFER
);
354 Length
-= PartialLength
;
355 CurrentOffset
+= PartialLength
;
356 BytesCopied
+= PartialLength
;
358 if (Operation
!= CcOperationZero
)
359 Buffer
= (PVOID
)((ULONG_PTR
)Buffer
+ PartialLength
);
361 IoStatus
->Status
= STATUS_SUCCESS
;
362 IoStatus
->Information
= BytesCopied
;
372 IN PFILE_OBJECT FileObject
,
373 IN ULONG BytesToWrite
,
377 PFSRTL_COMMON_FCB_HEADER Fcb
;
378 PROS_SHARED_CACHE_MAP SharedCacheMap
;
380 CCTRACE(CC_API_DEBUG
, "FileObject=%p BytesToWrite=%lu Wait=%d Retrying=%d\n",
381 FileObject
, BytesToWrite
, Wait
, Retrying
);
383 /* We cannot write if dirty pages count is above threshold */
384 if (CcTotalDirtyPages
> CcDirtyPageThreshold
)
389 /* We cannot write if dirty pages count will bring use above
390 * XXX: Might not be accurate
392 if (CcTotalDirtyPages
+ (BytesToWrite
/ PAGE_SIZE
) > CcDirtyPageThreshold
)
397 /* Is there a limit per file object? */
398 Fcb
= FileObject
->FsContext
;
399 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
400 if (!BooleanFlagOn(Fcb
->Flags
, FSRTL_FLAG_LIMIT_MODIFIED_PAGES
) ||
401 SharedCacheMap
->DirtyPageThreshold
== 0)
403 /* Nope, so that's fine, allow write operation */
407 /* Is dirty page count above local threshold? */
408 if (SharedCacheMap
->DirtyPages
> SharedCacheMap
->DirtyPageThreshold
)
413 /* We cannot write if dirty pages count will bring use above
414 * XXX: Might not be accurate
416 if (SharedCacheMap
->DirtyPages
+ (BytesToWrite
/ PAGE_SIZE
) > SharedCacheMap
->DirtyPageThreshold
)
430 IN PFILE_OBJECT FileObject
,
431 IN PLARGE_INTEGER FileOffset
,
435 OUT PIO_STATUS_BLOCK IoStatus
)
437 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%I64d Length=%lu Wait=%d\n",
438 FileObject
, FileOffset
->QuadPart
, Length
, Wait
);
440 DPRINT("CcCopyRead(FileObject 0x%p, FileOffset %I64x, "
441 "Length %lu, Wait %u, Buffer 0x%p, IoStatus 0x%p)\n",
442 FileObject
, FileOffset
->QuadPart
, Length
, Wait
,
445 return CcCopyData(FileObject
,
446 FileOffset
->QuadPart
,
460 IN PFILE_OBJECT FileObject
,
461 IN PLARGE_INTEGER FileOffset
,
466 IO_STATUS_BLOCK IoStatus
;
468 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%I64d Length=%lu Wait=%d Buffer=%p\n",
469 FileObject
, FileOffset
->QuadPart
, Length
, Wait
, Buffer
);
471 DPRINT("CcCopyWrite(FileObject 0x%p, FileOffset %I64x, "
472 "Length %lu, Wait %u, Buffer 0x%p)\n",
473 FileObject
, FileOffset
->QuadPart
, Length
, Wait
, Buffer
);
475 return CcCopyData(FileObject
,
476 FileOffset
->QuadPart
,
490 IN PFILE_OBJECT FileObject
,
491 IN PCC_POST_DEFERRED_WRITE PostRoutine
,
494 IN ULONG BytesToWrite
,
497 PDEFERRED_WRITE Context
;
499 CCTRACE(CC_API_DEBUG
, "FileObject=%p PostRoutine=%p Context1=%p Context2=%p BytesToWrite=%lu Retrying=%d\n",
500 FileObject
, PostRoutine
, Context1
, Context2
, BytesToWrite
, Retrying
);
502 /* Try to allocate a context for queueing the write operation */
503 Context
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(DEFERRED_WRITE
), 'CcDw');
504 /* If it failed, immediately execute the operation! */
507 PostRoutine(Context1
, Context2
);
511 /* Otherwise, initialize the context */
512 RtlZeroMemory(Context
, sizeof(DEFERRED_WRITE
));
513 Context
->NodeTypeCode
= NODE_TYPE_DEFERRED_WRITE
;
514 Context
->NodeByteSize
= sizeof(DEFERRED_WRITE
);
515 Context
->FileObject
= FileObject
;
516 Context
->PostRoutine
= PostRoutine
;
517 Context
->Context1
= Context1
;
518 Context
->Context2
= Context2
;
519 Context
->BytesToWrite
= BytesToWrite
;
524 /* To the top, if that's a retry */
525 ExInterlockedInsertHeadList(&CcDeferredWrites
,
526 &Context
->DeferredWriteLinks
,
527 &CcDeferredWriteSpinLock
);
531 /* To the bottom, if that's a first time */
532 ExInterlockedInsertTailList(&CcDeferredWrites
,
533 &Context
->DeferredWriteLinks
,
534 &CcDeferredWriteSpinLock
);
537 /* FIXME: lock master */
538 if (!LazyWriter
.ScanActive
)
540 CcScheduleLazyWriteScan(FALSE
);
550 IN PFILE_OBJECT FileObject
,
555 OUT PIO_STATUS_BLOCK IoStatus
)
557 LARGE_INTEGER LargeFileOffset
;
560 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%lu Length=%lu PageCount=%lu Buffer=%p\n",
561 FileObject
, FileOffset
, Length
, PageCount
, Buffer
);
563 DBG_UNREFERENCED_PARAMETER(PageCount
);
565 LargeFileOffset
.QuadPart
= FileOffset
;
566 Success
= CcCopyRead(FileObject
,
572 ASSERT(Success
== TRUE
);
581 IN PFILE_OBJECT FileObject
,
586 LARGE_INTEGER LargeFileOffset
;
589 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%lu Length=%lu Buffer=%p\n",
590 FileObject
, FileOffset
, Length
, Buffer
);
592 LargeFileOffset
.QuadPart
= FileOffset
;
593 Success
= CcCopyWrite(FileObject
,
598 ASSERT(Success
== TRUE
);
606 CcWaitForCurrentLazyWriterActivity (
611 /* Lazy writer is done when its event is set */
612 Status
= KeWaitForSingleObject(&iLazyWriterNotify
,
617 if (!NT_SUCCESS(Status
))
622 return STATUS_SUCCESS
;
631 IN PFILE_OBJECT FileObject
,
632 IN PLARGE_INTEGER StartOffset
,
633 IN PLARGE_INTEGER EndOffset
,
637 LARGE_INTEGER WriteOffset
;
642 IO_STATUS_BLOCK Iosb
;
645 CCTRACE(CC_API_DEBUG
, "FileObject=%p StartOffset=%I64u EndOffset=%I64u Wait=%d\n",
646 FileObject
, StartOffset
->QuadPart
, EndOffset
->QuadPart
, Wait
);
648 DPRINT("CcZeroData(FileObject 0x%p, StartOffset %I64x, EndOffset %I64x, "
649 "Wait %u)\n", FileObject
, StartOffset
->QuadPart
, EndOffset
->QuadPart
,
652 Length
= EndOffset
->QuadPart
- StartOffset
->QuadPart
;
653 WriteOffset
.QuadPart
= StartOffset
->QuadPart
;
655 if (FileObject
->SectionObjectPointer
->SharedCacheMap
== NULL
)
657 /* File is not cached */
659 Mdl
= _alloca(MmSizeOfMdl(NULL
, MAX_ZERO_LENGTH
));
663 if (Length
+ WriteOffset
.QuadPart
% PAGE_SIZE
> MAX_ZERO_LENGTH
)
665 CurrentLength
= MAX_ZERO_LENGTH
- WriteOffset
.QuadPart
% PAGE_SIZE
;
669 CurrentLength
= Length
;
671 MmInitializeMdl(Mdl
, (PVOID
)(ULONG_PTR
)WriteOffset
.QuadPart
, CurrentLength
);
672 Mdl
->MdlFlags
|= (MDL_PAGES_LOCKED
| MDL_IO_PAGE_READ
);
673 for (i
= 0; i
< ((Mdl
->Size
- sizeof(MDL
)) / sizeof(ULONG
)); i
++)
675 ((PPFN_NUMBER
)(Mdl
+ 1))[i
] = CcZeroPage
;
677 KeInitializeEvent(&Event
, NotificationEvent
, FALSE
);
678 Status
= IoSynchronousPageWrite(FileObject
, Mdl
, &WriteOffset
, &Event
, &Iosb
);
679 if (Status
== STATUS_PENDING
)
681 KeWaitForSingleObject(&Event
, Executive
, KernelMode
, FALSE
, NULL
);
682 Status
= Iosb
.Status
;
684 if (Mdl
->MdlFlags
& MDL_MAPPED_TO_SYSTEM_VA
)
686 MmUnmapLockedPages(Mdl
->MappedSystemVa
, Mdl
);
688 if (!NT_SUCCESS(Status
))
692 WriteOffset
.QuadPart
+= CurrentLength
;
693 Length
-= CurrentLength
;
698 IO_STATUS_BLOCK IoStatus
;
700 return CcCopyData(FileObject
,
701 WriteOffset
.QuadPart
,