2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: ntoskrnl/cc/pin.c
5 * PURPOSE: Implements cache managers pinning interface
8 Pierre Schweitzer (pierre@reactos.org)
11 /* INCLUDES ******************************************************************/
17 /* GLOBALS *******************************************************************/
19 extern NPAGED_LOOKASIDE_LIST iBcbLookasideList
;
22 * - Number of calls to CcMapData that could wait
23 * - Number of calls to CcMapData that couldn't wait
24 * - Number of calls to CcPinRead that could wait
25 * - Number of calls to CcPinRead that couldn't wait
26 * - Number of calls to CcPinMappedDataCount
28 ULONG CcMapDataWait
= 0;
29 ULONG CcMapDataNoWait
= 0;
30 ULONG CcPinReadWait
= 0;
31 ULONG CcPinReadNoWait
= 0;
32 ULONG CcPinMappedDataCount
= 0;
34 /* FUNCTIONS *****************************************************************/
40 IN PROS_SHARED_CACHE_MAP SharedCacheMap
,
41 IN PLARGE_INTEGER FileOffset
,
46 BOOLEAN Found
= FALSE
;
47 PLIST_ENTRY NextEntry
;
49 for (NextEntry
= SharedCacheMap
->BcbList
.Flink
;
50 NextEntry
!= &SharedCacheMap
->BcbList
;
51 NextEntry
= NextEntry
->Flink
)
53 Bcb
= CONTAINING_RECORD(NextEntry
, INTERNAL_BCB
, BcbEntry
);
55 if (Bcb
->PFCB
.MappedFileOffset
.QuadPart
<= FileOffset
->QuadPart
&&
56 (Bcb
->PFCB
.MappedFileOffset
.QuadPart
+ Bcb
->PFCB
.MappedLength
) >=
57 (FileOffset
->QuadPart
+ Length
))
59 if ((Pinned
&& Bcb
->PinCount
> 0) || (!Pinned
&& Bcb
->PinCount
== 0))
67 return (Found
? Bcb
: NULL
);
74 IN PROS_SHARED_CACHE_MAP SharedCacheMap
,
75 IN PLARGE_INTEGER FileOffset
,
87 ReadOffset
= FileOffset
->QuadPart
;
89 DPRINT("SectionSize %I64x, FileSize %I64x\n",
90 SharedCacheMap
->SectionSize
.QuadPart
,
91 SharedCacheMap
->FileSize
.QuadPart
);
93 if (ReadOffset
% VACB_MAPPING_GRANULARITY
+ Length
> VACB_MAPPING_GRANULARITY
)
95 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
96 SharedCacheMap
->FileObject
, FileOffset
, Length
, Flags
);
100 if (!BooleanFlagOn(Flags
, MAP_NO_READ
))
102 static int Warned
= 0;
104 SetFlag(Flags
, MAP_NO_READ
);
107 DPRINT1("Mapping/pinning with no read not implemented. Forcing read, might fail if wait not allowed\n");
112 ROffset
= ROUND_DOWN(ReadOffset
, VACB_MAPPING_GRANULARITY
);
113 Status
= CcRosRequestVacb(SharedCacheMap
,
118 if (!NT_SUCCESS(Status
))
120 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
121 SharedCacheMap
->FileObject
, FileOffset
, Length
, Flags
);
122 ExRaiseStatus(Status
);
126 if (!Valid
&& BooleanFlagOn(Flags
, MAP_NO_READ
))
128 if (!BooleanFlagOn(Flags
, MAP_WAIT
))
130 CcRosReleaseVacb(SharedCacheMap
, Vacb
, FALSE
, FALSE
, FALSE
);
131 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
132 SharedCacheMap
->FileObject
, FileOffset
, Length
, Flags
);
136 Status
= CcReadVirtualAddress(Vacb
);
137 if (!NT_SUCCESS(Status
))
139 CcRosReleaseVacb(SharedCacheMap
, Vacb
, FALSE
, FALSE
, FALSE
);
140 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> FALSE\n",
141 SharedCacheMap
->FileObject
, FileOffset
, Length
, Flags
);
142 ExRaiseStatus(Status
);
147 *pBuffer
= (PUCHAR
)*pBuffer
+ ReadOffset
% VACB_MAPPING_GRANULARITY
;
155 CcpGetAppropriateBcb(
156 IN PROS_SHARED_CACHE_MAP SharedCacheMap
,
158 IN PLARGE_INTEGER FileOffset
,
165 PINTERNAL_BCB iBcb
, DupBcb
;
167 iBcb
= ExAllocateFromNPagedLookasideList(&iBcbLookasideList
);
170 CcRosReleaseVacb(SharedCacheMap
, Vacb
, TRUE
, FALSE
, FALSE
);
174 RtlZeroMemory(iBcb
, sizeof(*iBcb
));
175 iBcb
->PFCB
.NodeTypeCode
= 0xDE45; /* Undocumented (CAPTIVE_PUBLIC_BCB_NODETYPECODE) */
176 iBcb
->PFCB
.NodeByteSize
= sizeof(PUBLIC_BCB
);
177 iBcb
->PFCB
.MappedLength
= Length
;
178 iBcb
->PFCB
.MappedFileOffset
= *FileOffset
;
183 ExInitializeResourceLite(&iBcb
->Lock
);
185 KeAcquireSpinLock(&SharedCacheMap
->BcbSpinLock
, &OldIrql
);
187 /* Check if we raced with another BCB creation */
188 DupBcb
= CcpFindBcb(SharedCacheMap
, FileOffset
, Length
, ToPin
);
189 /* Yes, and we've lost */
198 if (BooleanFlagOn(PinFlags
, PIN_EXCLUSIVE
))
200 Result
= ExAcquireResourceExclusiveLite(&iBcb
->Lock
, BooleanFlagOn(PinFlags
, PIN_WAIT
));
204 Result
= ExAcquireSharedStarveExclusive(&iBcb
->Lock
, BooleanFlagOn(PinFlags
, PIN_WAIT
));
216 /* We'll return that BCB */
220 /* Delete the loser */
221 CcRosReleaseVacb(SharedCacheMap
, Vacb
, TRUE
, FALSE
, FALSE
);
222 ExDeleteResourceLite(&iBcb
->Lock
);
223 ExFreeToNPagedLookasideList(&iBcbLookasideList
, iBcb
);
225 /* Return the winner - no need to update buffer address, it's
226 * relative to the VACB, which is unchanged.
230 /* Nope, insert ourselves */
237 if (BooleanFlagOn(PinFlags
, PIN_EXCLUSIVE
))
239 Result
= ExAcquireResourceExclusiveLite(&iBcb
->Lock
, BooleanFlagOn(PinFlags
, PIN_WAIT
));
243 Result
= ExAcquireSharedStarveExclusive(&iBcb
->Lock
, BooleanFlagOn(PinFlags
, PIN_WAIT
));
249 InsertTailList(&SharedCacheMap
->BcbList
, &iBcb
->BcbEntry
);
251 KeReleaseSpinLock(&SharedCacheMap
->BcbSpinLock
, OldIrql
);
259 IN PROS_SHARED_CACHE_MAP SharedCacheMap
,
260 IN PLARGE_INTEGER FileOffset
,
266 PINTERNAL_BCB NewBcb
;
272 KeAcquireSpinLock(&SharedCacheMap
->BcbSpinLock
, &OldIrql
);
273 NewBcb
= CcpFindBcb(SharedCacheMap
, FileOffset
, Length
, TRUE
);
274 KeReleaseSpinLock(&SharedCacheMap
->BcbSpinLock
, OldIrql
);
280 if (BooleanFlagOn(Flags
, PIN_EXCLUSIVE
))
282 Result
= ExAcquireResourceExclusiveLite(&NewBcb
->Lock
, BooleanFlagOn(Flags
, PIN_WAIT
));
286 Result
= ExAcquireSharedStarveExclusive(&NewBcb
->Lock
, BooleanFlagOn(Flags
, PIN_WAIT
));
297 *Buffer
= (PUCHAR
)NewBcb
->Vacb
->BaseAddress
+ FileOffset
->QuadPart
% VACB_MAPPING_GRANULARITY
;
304 if (BooleanFlagOn(Flags
, PIN_IF_BCB
))
309 MapFlags
= Flags
& PIN_WAIT
;
310 if (BooleanFlagOn(Flags
, PIN_NO_READ
))
312 SetFlag(MapFlags
, MAP_NO_READ
);
315 Result
= CcpMapData(SharedCacheMap
, FileOffset
, Length
, MapFlags
, &Vacb
, Buffer
);
318 NewBcb
= CcpGetAppropriateBcb(SharedCacheMap
, Vacb
, FileOffset
, Length
, Flags
, TRUE
);
321 CcRosReleaseVacb(SharedCacheMap
, Vacb
, TRUE
, FALSE
, FALSE
);
340 IN PFILE_OBJECT FileObject
,
341 IN PLARGE_INTEGER FileOffset
,
351 PROS_SHARED_CACHE_MAP SharedCacheMap
;
353 DPRINT("CcMapData(FileObject 0x%p, FileOffset %I64x, Length %lu, Flags 0x%lx,"
354 " pBcb 0x%p, pBuffer 0x%p)\n", FileObject
, FileOffset
->QuadPart
,
355 Length
, Flags
, pBcb
, pBuffer
);
358 ASSERT(FileObject
->SectionObjectPointer
);
359 ASSERT(FileObject
->SectionObjectPointer
->SharedCacheMap
);
361 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
362 ASSERT(SharedCacheMap
);
364 if (Flags
& MAP_WAIT
)
373 KeAcquireSpinLock(&SharedCacheMap
->BcbSpinLock
, &OldIrql
);
374 iBcb
= CcpFindBcb(SharedCacheMap
, FileOffset
, Length
, FALSE
);
375 KeReleaseSpinLock(&SharedCacheMap
->BcbSpinLock
, OldIrql
);
379 Ret
= CcpMapData(SharedCacheMap
, FileOffset
, Length
, Flags
, &Vacb
, pBuffer
);
382 iBcb
= CcpGetAppropriateBcb(SharedCacheMap
, Vacb
, FileOffset
, Length
, 0, FALSE
);
385 CcRosReleaseVacb(SharedCacheMap
, Vacb
, TRUE
, FALSE
, FALSE
);
398 *pBuffer
= (PUCHAR
)iBcb
->Vacb
->BaseAddress
+ FileOffset
->QuadPart
% VACB_MAPPING_GRANULARITY
;
402 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx -> %d Bcb=%p\n",
403 FileObject
, FileOffset
, Length
, Flags
, Ret
, *pBcb
);
413 IN PFILE_OBJECT FileObject
,
414 IN PLARGE_INTEGER FileOffset
,
422 PROS_SHARED_CACHE_MAP SharedCacheMap
;
424 CCTRACE(CC_API_DEBUG
, "FileObject=%p FileOffset=%p Length=%lu Flags=0x%lx\n",
425 FileObject
, FileOffset
, Length
, Flags
);
428 ASSERT(FileObject
->SectionObjectPointer
);
429 ASSERT(FileObject
->SectionObjectPointer
->SharedCacheMap
);
431 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
432 ASSERT(SharedCacheMap
);
433 if (!SharedCacheMap
->PinAccess
)
435 DPRINT1("FIXME: Pinning a file with no pin access!\n");
441 ++CcPinMappedDataCount
;
443 Result
= CcpPinData(SharedCacheMap
, FileOffset
, Length
, Flags
, Bcb
, &Buffer
);
458 IN PFILE_OBJECT FileObject
,
459 IN PLARGE_INTEGER FileOffset
,
465 PROS_SHARED_CACHE_MAP SharedCacheMap
;
467 CCTRACE(CC_API_DEBUG
, "FileOffset=%p FileOffset=%p Length=%lu Flags=0x%lx\n",
468 FileObject
, FileOffset
, Length
, Flags
);
471 ASSERT(FileObject
->SectionObjectPointer
);
472 ASSERT(FileObject
->SectionObjectPointer
->SharedCacheMap
);
474 SharedCacheMap
= FileObject
->SectionObjectPointer
->SharedCacheMap
;
475 ASSERT(SharedCacheMap
);
476 if (!SharedCacheMap
->PinAccess
)
478 DPRINT1("FIXME: Pinning a file with no pin access!\n");
482 if (Flags
& PIN_WAIT
)
491 return CcpPinData(SharedCacheMap
, FileOffset
, Length
, Flags
, Bcb
, Buffer
);
500 IN PFILE_OBJECT FileObject
,
501 IN PLARGE_INTEGER FileOffset
,
508 CCTRACE(CC_API_DEBUG
, "FileOffset=%p FileOffset=%p Length=%lu Zero=%d Flags=0x%lx\n",
509 FileObject
, FileOffset
, Length
, Zero
, Flags
);
512 * FIXME: This is function is similar to CcPinRead, but doesn't
513 * read the data if they're not present. Instead it should just
514 * prepare the VACBs and zero them out if Zero != FALSE.
516 * For now calling CcPinRead is better than returning error or
517 * just having UNIMPLEMENTED here.
519 return CcPinRead(FileObject
, FileOffset
, Length
, Flags
, Bcb
, Buffer
);
526 CcSetDirtyPinnedData (
528 IN PLARGE_INTEGER Lsn
)
530 PINTERNAL_BCB iBcb
= Bcb
;
532 CCTRACE(CC_API_DEBUG
, "Bcb=%p Lsn=%p\n",
536 if (!iBcb
->Vacb
->Dirty
)
538 CcRosMarkDirtyVacb(iBcb
->Vacb
);
550 CCTRACE(CC_API_DEBUG
, "Bcb=%p\n", Bcb
);
552 CcUnpinDataForThread(Bcb
, (ERESOURCE_THREAD
)PsGetCurrentThread());
560 CcUnpinDataForThread (
562 IN ERESOURCE_THREAD ResourceThreadId
)
564 PINTERNAL_BCB iBcb
= Bcb
;
566 CCTRACE(CC_API_DEBUG
, "Bcb=%p ResourceThreadId=%lu\n", Bcb
, ResourceThreadId
);
568 if (iBcb
->PinCount
!= 0)
570 ExReleaseResourceForThreadLite(&iBcb
->Lock
, ResourceThreadId
);
574 if (--iBcb
->RefCount
== 0)
577 PROS_SHARED_CACHE_MAP SharedCacheMap
;
579 ASSERT(iBcb
->PinCount
== 0);
580 SharedCacheMap
= iBcb
->Vacb
->SharedCacheMap
;
581 CcRosReleaseVacb(SharedCacheMap
,
587 KeAcquireSpinLock(&SharedCacheMap
->BcbSpinLock
, &OldIrql
);
588 if (!IsListEmpty(&iBcb
->BcbEntry
))
590 RemoveEntryList(&iBcb
->BcbEntry
);
592 KeReleaseSpinLock(&SharedCacheMap
->BcbSpinLock
, OldIrql
);
594 ExDeleteResourceLite(&iBcb
->Lock
);
595 ExFreeToNPagedLookasideList(&iBcbLookasideList
, iBcb
);
607 PINTERNAL_BCB iBcb
= Bcb
;
609 CCTRACE(CC_API_DEBUG
, "Bcb=%p\n", Bcb
);
621 IN BOOLEAN WriteThrough
,
622 IN PIO_STATUS_BLOCK IoStatus
)
624 PINTERNAL_BCB iBcb
= Bcb
;
626 PROS_SHARED_CACHE_MAP SharedCacheMap
;
628 CCTRACE(CC_API_DEBUG
, "Bcb=%p WriteThrough=%d\n", Bcb
, WriteThrough
);
630 IoStatus
->Status
= STATUS_SUCCESS
;
631 if (--iBcb
->RefCount
== 0)
633 IoStatus
->Information
= 0;
636 if (iBcb
->Vacb
->Dirty
)
638 IoStatus
->Status
= CcRosFlushVacb(iBcb
->Vacb
);
642 IoStatus
->Status
= STATUS_SUCCESS
;
647 IoStatus
->Status
= STATUS_SUCCESS
;
650 if (iBcb
->PinCount
!= 0)
652 ExReleaseResourceLite(&iBcb
->Lock
);
654 ASSERT(iBcb
->PinCount
== 0);
657 SharedCacheMap
= iBcb
->Vacb
->SharedCacheMap
;
658 CcRosReleaseVacb(iBcb
->Vacb
->SharedCacheMap
,
664 KeAcquireSpinLock(&SharedCacheMap
->BcbSpinLock
, &OldIrql
);
665 if (!IsListEmpty(&iBcb
->BcbEntry
))
667 RemoveEntryList(&iBcb
->BcbEntry
);
669 KeReleaseSpinLock(&SharedCacheMap
->BcbSpinLock
, OldIrql
);
671 ExDeleteResourceLite(&iBcb
->Lock
);
672 ExFreeToNPagedLookasideList(&iBcbLookasideList
, iBcb
);