1 #pragma once 2 3 // 4 // Define this if you want debugging support 5 // 6 #define _CC_DEBUG_ 0x00 7 8 // 9 // These define the Debug Masks Supported 10 // 11 #define CC_API_DEBUG 0x01 12 13 // 14 // Debug/Tracing support 15 // 16 #if _CC_DEBUG_ 17 #ifdef NEW_DEBUG_SYSTEM_IMPLEMENTED // enable when Debug Filters are implemented 18 #define CCTRACE(x, ...) \ 19 { \ 20 DbgPrintEx("%s [%.16s] - ", \ 21 __FUNCTION__, \ 22 PsGetCurrentProcess()->ImageFileName); \ 23 DbgPrintEx(__VA_ARGS__); \ 24 } 25 #else 26 #define CCTRACE(x, ...) \ 27 if (x & CcRosTraceLevel) \ 28 { \ 29 DbgPrint("%s [%.16s] - ", \ 30 __FUNCTION__, \ 31 PsGetCurrentProcess()->ImageFileName); \ 32 DbgPrint(__VA_ARGS__); \ 33 } 34 #endif 35 #else 36 #define CCTRACE(x, fmt, ...) DPRINT(fmt, ##__VA_ARGS__) 37 #endif 38 39 // 40 // Global Cc Data 41 // 42 extern ULONG CcRosTraceLevel; 43 extern LIST_ENTRY DirtyVacbListHead; 44 extern ULONG CcDirtyPageThreshold; 45 extern ULONG CcTotalDirtyPages; 46 extern LIST_ENTRY CcDeferredWrites; 47 extern KSPIN_LOCK CcDeferredWriteSpinLock; 48 extern ULONG CcNumberWorkerThreads; 49 extern LIST_ENTRY CcIdleWorkerThreadList; 50 extern LIST_ENTRY CcExpressWorkQueue; 51 extern LIST_ENTRY CcRegularWorkQueue; 52 extern LIST_ENTRY CcPostTickWorkQueue; 53 extern NPAGED_LOOKASIDE_LIST CcTwilightLookasideList; 54 extern LARGE_INTEGER CcIdleDelay; 55 56 // 57 // Counters 58 // 59 extern ULONG CcLazyWritePages; 60 extern ULONG CcLazyWriteIos; 61 extern ULONG CcMapDataWait; 62 extern ULONG CcMapDataNoWait; 63 extern ULONG CcPinReadWait; 64 extern ULONG CcPinReadNoWait; 65 extern ULONG CcPinMappedDataCount; 66 extern ULONG CcDataPages; 67 extern ULONG CcDataFlushes; 68 69 typedef struct _PF_SCENARIO_ID 70 { 71 WCHAR ScenName[30]; 72 ULONG HashId; 73 } PF_SCENARIO_ID, *PPF_SCENARIO_ID; 74 75 typedef struct _PF_LOG_ENTRY 76 { 77 ULONG FileOffset:30; 78 ULONG Type:2; 79 union 80 { 81 ULONG FileKey; 82 ULONG FileSequenceNumber; 83 }; 84 } PF_LOG_ENTRY, *PPF_LOG_ENTRY; 85 86 typedef struct _PFSN_LOG_ENTRIES 87 { 88 LIST_ENTRY TraceBuffersLink; 89 LONG NumEntries; 90 LONG MaxEntries; 91 PF_LOG_ENTRY Entries[ANYSIZE_ARRAY]; 92 } PFSN_LOG_ENTRIES, *PPFSN_LOG_ENTRIES; 93 94 typedef struct _PF_SECTION_INFO 95 { 96 ULONG FileKey; 97 ULONG FileSequenceNumber; 98 ULONG FileIdLow; 99 ULONG FileIdHigh; 100 } PF_SECTION_INFO, *PPF_SECTION_INFO; 101 102 typedef struct _PF_TRACE_HEADER 103 { 104 ULONG Version; 105 ULONG MagicNumber; 106 ULONG Size; 107 PF_SCENARIO_ID ScenarioId; 108 ULONG ScenarioType; // PF_SCENARIO_TYPE 109 ULONG EventEntryIdxs[8]; 110 ULONG NumEventEntryIdxs; 111 ULONG TraceBufferOffset; 112 ULONG NumEntries; 113 ULONG SectionInfoOffset; 114 ULONG NumSections; 115 ULONG FaultsPerPeriod[10]; 116 LARGE_INTEGER LaunchTime; 117 ULONGLONG Reserved[5]; 118 } PF_TRACE_HEADER, *PPF_TRACE_HEADER; 119 120 typedef struct _PFSN_TRACE_DUMP 121 { 122 LIST_ENTRY CompletedTracesLink; 123 PF_TRACE_HEADER Trace; 124 } PFSN_TRACE_DUMP, *PPFSN_TRACE_DUMP; 125 126 typedef struct _PFSN_TRACE_HEADER 127 { 128 ULONG Magic; 129 LIST_ENTRY ActiveTracesLink; 130 PF_SCENARIO_ID ScenarioId; 131 ULONG ScenarioType; // PF_SCENARIO_TYPE 132 ULONG EventEntryIdxs[8]; 133 ULONG NumEventEntryIdxs; 134 PPFSN_LOG_ENTRIES CurrentTraceBuffer; 135 LIST_ENTRY TraceBuffersList; 136 ULONG NumTraceBuffers; 137 KSPIN_LOCK TraceBufferSpinLock; 138 KTIMER TraceTimer; 139 LARGE_INTEGER TraceTimerPeriod; 140 KDPC TraceTimerDpc; 141 KSPIN_LOCK TraceTimerSpinLock; 142 ULONG FaultsPerPeriod[10]; 143 LONG LastNumFaults; 144 LONG CurPeriod; 145 LONG NumFaults; 146 LONG MaxFaults; 147 PEPROCESS Process; 148 EX_RUNDOWN_REF RefCount; 149 WORK_QUEUE_ITEM EndTraceWorkItem; 150 LONG EndTraceCalled; 151 PPFSN_TRACE_DUMP TraceDump; 152 NTSTATUS TraceDumpStatus; 153 LARGE_INTEGER LaunchTime; 154 PPF_SECTION_INFO SectionInfo; 155 ULONG SectionInfoCount; 156 } PFSN_TRACE_HEADER, *PPFSN_TRACE_HEADER; 157 158 typedef struct _PFSN_PREFETCHER_GLOBALS 159 { 160 LIST_ENTRY ActiveTraces; 161 KSPIN_LOCK ActiveTracesLock; 162 PPFSN_TRACE_HEADER SystemWideTrace; 163 LIST_ENTRY CompletedTraces; 164 FAST_MUTEX CompletedTracesLock; 165 LONG NumCompletedTraces; 166 PKEVENT CompletedTracesEvent; 167 LONG ActivePrefetches; 168 } PFSN_PREFETCHER_GLOBALS, *PPFSN_PREFETCHER_GLOBALS; 169 170 typedef struct _ROS_SHARED_CACHE_MAP 171 { 172 CSHORT NodeTypeCode; 173 CSHORT NodeByteSize; 174 ULONG OpenCount; 175 LARGE_INTEGER FileSize; 176 LIST_ENTRY BcbList; 177 LARGE_INTEGER SectionSize; 178 PFILE_OBJECT FileObject; 179 ULONG DirtyPages; 180 LIST_ENTRY SharedCacheMapLinks; 181 ULONG Flags; 182 PCACHE_MANAGER_CALLBACKS Callbacks; 183 PVOID LazyWriteContext; 184 LIST_ENTRY PrivateList; 185 ULONG DirtyPageThreshold; 186 KSPIN_LOCK BcbSpinLock; 187 PRIVATE_CACHE_MAP PrivateCacheMap; 188 189 /* ROS specific */ 190 LIST_ENTRY CacheMapVacbListHead; 191 ULONG TimeStamp; 192 BOOLEAN PinAccess; 193 KSPIN_LOCK CacheMapLock; 194 #if DBG 195 BOOLEAN Trace; /* enable extra trace output for this cache map and it's VACBs */ 196 #endif 197 } ROS_SHARED_CACHE_MAP, *PROS_SHARED_CACHE_MAP; 198 199 #define READAHEAD_DISABLED 0x1 200 #define WRITEBEHIND_DISABLED 0x2 201 202 typedef struct _ROS_VACB 203 { 204 /* Base address of the region where the view's data is mapped. */ 205 PVOID BaseAddress; 206 /* Memory area representing the region where the view's data is mapped. */ 207 struct _MEMORY_AREA* MemoryArea; 208 /* Are the contents of the view valid. */ 209 BOOLEAN Valid; 210 /* Are the contents of the view newer than those on disk. */ 211 BOOLEAN Dirty; 212 /* Page out in progress */ 213 BOOLEAN PageOut; 214 ULONG MappedCount; 215 /* Entry in the list of VACBs for this shared cache map. */ 216 LIST_ENTRY CacheMapVacbListEntry; 217 /* Entry in the list of VACBs which are dirty. */ 218 LIST_ENTRY DirtyVacbListEntry; 219 /* Entry in the list of VACBs. */ 220 LIST_ENTRY VacbLruListEntry; 221 /* Offset in the file which this view maps. */ 222 LARGE_INTEGER FileOffset; 223 /* Number of references. */ 224 volatile ULONG ReferenceCount; 225 /* Pointer to the shared cache map for the file which this view maps data for. */ 226 PROS_SHARED_CACHE_MAP SharedCacheMap; 227 /* Pointer to the next VACB in a chain. */ 228 } ROS_VACB, *PROS_VACB; 229 230 typedef struct _INTERNAL_BCB 231 { 232 /* Lock */ 233 ERESOURCE Lock; 234 PUBLIC_BCB PFCB; 235 PROS_VACB Vacb; 236 BOOLEAN Dirty; 237 ULONG PinCount; 238 CSHORT RefCount; /* (At offset 0x34 on WinNT4) */ 239 LIST_ENTRY BcbEntry; 240 } INTERNAL_BCB, *PINTERNAL_BCB; 241 242 typedef struct _LAZY_WRITER 243 { 244 LIST_ENTRY WorkQueue; 245 KDPC ScanDpc; 246 KTIMER ScanTimer; 247 BOOLEAN ScanActive; 248 BOOLEAN OtherWork; 249 BOOLEAN PendingTeardown; 250 } LAZY_WRITER, *PLAZY_WRITER; 251 252 typedef struct _WORK_QUEUE_ENTRY 253 { 254 LIST_ENTRY WorkQueueLinks; 255 union 256 { 257 struct 258 { 259 FILE_OBJECT *FileObject; 260 } Read; 261 struct 262 { 263 SHARED_CACHE_MAP *SharedCacheMap; 264 } Write; 265 struct 266 { 267 KEVENT *Event; 268 } Event; 269 struct 270 { 271 unsigned long Reason; 272 } Notification; 273 } Parameters; 274 unsigned char Function; 275 } WORK_QUEUE_ENTRY, *PWORK_QUEUE_ENTRY; 276 277 typedef enum _WORK_QUEUE_FUNCTIONS 278 { 279 ReadAhead = 1, 280 WriteBehind = 2, 281 LazyScan = 3, 282 SetDone = 4, 283 } WORK_QUEUE_FUNCTIONS, *PWORK_QUEUE_FUNCTIONS; 284 285 extern LAZY_WRITER LazyWriter; 286 287 #define NODE_TYPE_DEFERRED_WRITE 0x02FC 288 #define NODE_TYPE_PRIVATE_MAP 0x02FE 289 #define NODE_TYPE_SHARED_MAP 0x02FF 290 291 INIT_FUNCTION 292 VOID 293 NTAPI 294 CcPfInitializePrefetcher( 295 VOID 296 ); 297 298 VOID 299 NTAPI 300 CcMdlReadComplete2( 301 IN PFILE_OBJECT FileObject, 302 IN PMDL MemoryDescriptorList 303 ); 304 305 VOID 306 NTAPI 307 CcMdlWriteComplete2( 308 IN PFILE_OBJECT FileObject, 309 IN PLARGE_INTEGER FileOffset, 310 IN PMDL MdlChain 311 ); 312 313 NTSTATUS 314 NTAPI 315 CcRosFlushVacb(PROS_VACB Vacb); 316 317 NTSTATUS 318 NTAPI 319 CcRosGetVacb( 320 PROS_SHARED_CACHE_MAP SharedCacheMap, 321 LONGLONG FileOffset, 322 PLONGLONG BaseOffset, 323 PVOID *BaseAddress, 324 PBOOLEAN UptoDate, 325 PROS_VACB *Vacb 326 ); 327 328 INIT_FUNCTION 329 VOID 330 NTAPI 331 CcInitView(VOID); 332 333 VOID 334 NTAPI 335 CcShutdownLazyWriter(VOID); 336 337 NTSTATUS 338 NTAPI 339 CcReadVirtualAddress(PROS_VACB Vacb); 340 341 NTSTATUS 342 NTAPI 343 CcWriteVirtualAddress(PROS_VACB Vacb); 344 345 INIT_FUNCTION 346 BOOLEAN 347 NTAPI 348 CcInitializeCacheManager(VOID); 349 350 NTSTATUS 351 NTAPI 352 CcRosUnmapVacb( 353 PROS_SHARED_CACHE_MAP SharedCacheMap, 354 LONGLONG FileOffset, 355 BOOLEAN NowDirty 356 ); 357 358 PROS_VACB 359 NTAPI 360 CcRosLookupVacb( 361 PROS_SHARED_CACHE_MAP SharedCacheMap, 362 LONGLONG FileOffset 363 ); 364 365 VOID 366 NTAPI 367 CcInitCacheZeroPage(VOID); 368 369 NTSTATUS 370 NTAPI 371 CcRosMarkDirtyFile( 372 PROS_SHARED_CACHE_MAP SharedCacheMap, 373 LONGLONG FileOffset 374 ); 375 376 VOID 377 NTAPI 378 CcRosMarkDirtyVacb( 379 PROS_VACB Vacb); 380 381 VOID 382 NTAPI 383 CcRosUnmarkDirtyVacb( 384 PROS_VACB Vacb, 385 BOOLEAN LockViews); 386 387 NTSTATUS 388 NTAPI 389 CcRosFlushDirtyPages( 390 ULONG Target, 391 PULONG Count, 392 BOOLEAN Wait, 393 BOOLEAN CalledFromLazy 394 ); 395 396 VOID 397 NTAPI 398 CcRosDereferenceCache(PFILE_OBJECT FileObject); 399 400 VOID 401 NTAPI 402 CcRosReferenceCache(PFILE_OBJECT FileObject); 403 404 VOID 405 NTAPI 406 CcRosRemoveIfClosed(PSECTION_OBJECT_POINTERS SectionObjectPointer); 407 408 NTSTATUS 409 NTAPI 410 CcRosReleaseVacb( 411 PROS_SHARED_CACHE_MAP SharedCacheMap, 412 PROS_VACB Vacb, 413 BOOLEAN Valid, 414 BOOLEAN Dirty, 415 BOOLEAN Mapped 416 ); 417 418 NTSTATUS 419 NTAPI 420 CcRosRequestVacb( 421 PROS_SHARED_CACHE_MAP SharedCacheMap, 422 LONGLONG FileOffset, 423 PVOID* BaseAddress, 424 PBOOLEAN UptoDate, 425 PROS_VACB *Vacb 426 ); 427 428 NTSTATUS 429 NTAPI 430 CcRosInitializeFileCache( 431 PFILE_OBJECT FileObject, 432 PCC_FILE_SIZES FileSizes, 433 BOOLEAN PinAccess, 434 PCACHE_MANAGER_CALLBACKS CallBacks, 435 PVOID LazyWriterContext 436 ); 437 438 NTSTATUS 439 NTAPI 440 CcRosReleaseFileCache( 441 PFILE_OBJECT FileObject 442 ); 443 444 VOID 445 NTAPI 446 CcShutdownSystem(VOID); 447 448 VOID 449 NTAPI 450 CcWorkerThread(PVOID Parameter); 451 452 VOID 453 NTAPI 454 CcScanDpc( 455 PKDPC Dpc, 456 PVOID DeferredContext, 457 PVOID SystemArgument1, 458 PVOID SystemArgument2); 459 460 VOID 461 CcScheduleLazyWriteScan(BOOLEAN NoDelay); 462 463 VOID 464 CcPostDeferredWrites(VOID); 465 466 VOID 467 CcPostWorkQueue( 468 IN PWORK_QUEUE_ENTRY WorkItem, 469 IN PLIST_ENTRY WorkQueue); 470 471 VOID 472 CcPerformReadAhead( 473 IN PFILE_OBJECT FileObject); 474 475 NTSTATUS 476 CcRosInternalFreeVacb( 477 IN PROS_VACB Vacb); 478 479 FORCEINLINE 480 BOOLEAN 481 DoRangesIntersect( 482 _In_ LONGLONG Offset1, 483 _In_ LONGLONG Length1, 484 _In_ LONGLONG Offset2, 485 _In_ LONGLONG Length2) 486 { 487 if (Offset1 + Length1 <= Offset2) 488 return FALSE; 489 if (Offset2 + Length2 <= Offset1) 490 return FALSE; 491 return TRUE; 492 } 493 494 FORCEINLINE 495 BOOLEAN 496 IsPointInRange( 497 _In_ LONGLONG Offset1, 498 _In_ LONGLONG Length1, 499 _In_ LONGLONG Point) 500 { 501 return DoRangesIntersect(Offset1, Length1, Point, 1); 502 } 503 504 #define CcBugCheck(A, B, C) KeBugCheckEx(CACHE_MANAGER, BugCheckFileId | ((ULONG)(__LINE__)), A, B, C) 505 506 #if DBG 507 #define CcRosVacbIncRefCount(vacb) CcRosVacbIncRefCount_(vacb,__FILE__,__LINE__) 508 #define CcRosVacbDecRefCount(vacb) CcRosVacbDecRefCount_(vacb,__FILE__,__LINE__) 509 #define CcRosVacbGetRefCount(vacb) CcRosVacbGetRefCount_(vacb,__FILE__,__LINE__) 510 511 ULONG 512 CcRosVacbIncRefCount_( 513 PROS_VACB vacb, 514 PCSTR file, 515 INT line); 516 517 ULONG 518 CcRosVacbDecRefCount_( 519 PROS_VACB vacb, 520 PCSTR file, 521 INT line); 522 523 ULONG 524 CcRosVacbGetRefCount_( 525 PROS_VACB vacb, 526 PCSTR file, 527 INT line); 528 529 #else 530 #define CcRosVacbIncRefCount(vacb) InterlockedIncrement((PLONG)&(vacb)->ReferenceCount) 531 FORCEINLINE 532 ULONG 533 CcRosVacbDecRefCount( 534 PROS_VACB vacb) 535 { 536 ULONG Refs; 537 538 Refs = InterlockedDecrement((PLONG)&vacb->ReferenceCount); 539 if (Refs == 0) 540 { 541 CcRosInternalFreeVacb(vacb); 542 } 543 return Refs; 544 } 545 #define CcRosVacbGetRefCount(vacb) InterlockedCompareExchange((PLONG)&(vacb)->ReferenceCount, 0, 0) 546 #endif 547