ntoskrnl/cc/view.c

   1 /*
   2  * COPYRIGHT:       See COPYING in the top level directory
   3  * PROJECT:         ReactOS kernel
   4  * FILE:            ntoskrnl/cc/view.c
   5  * PURPOSE:         Cache manager
   6  *
   7  * PROGRAMMERS:     David Welch (welch@mcmail.com)
   8  *                  Pierre Schweitzer (pierre@reactos.org)
   9  */
  10
  11 /* NOTES **********************************************************************
  12  *
  13  * This is not the NT implementation of a file cache nor anything much like
  14  * it.
  15  *
  16  * The general procedure for a filesystem to implement a read or write
  17  * dispatch routine is as follows
  18  *
  19  * (1) If caching for the FCB hasn't been initiated then so do by calling
  20  * CcInitializeFileCache.
  21  *
  22  * (2) For each 4k region which is being read or written obtain a cache page
  23  * by calling CcRequestCachePage.
  24  *
  25  * (3) If either the page is being read or not completely written, and it is
  26  * not up to date then read its data from the underlying medium. If the read
  27  * fails then call CcReleaseCachePage with VALID as FALSE and return a error.
  28  *
  29  * (4) Copy the data into or out of the page as necessary.
  30  *
  31  * (5) Release the cache page
  32  */
  33 /* INCLUDES ******************************************************************/
  34
  35 #include <ntoskrnl.h>
  36 #define NDEBUG
  37 #include <debug.h>
  38
  39 #if defined (ALLOC_PRAGMA)
  40 #pragma alloc_text(INIT, CcInitView)
  41 #endif
  42
  43 /* GLOBALS *******************************************************************/
  44
  45 LIST_ENTRY DirtyVacbListHead;
  46 static LIST_ENTRY VacbLruListHead;
  47
  48 KGUARDED_MUTEX ViewLock;
  49
  50 NPAGED_LOOKASIDE_LIST iBcbLookasideList;
  51 static NPAGED_LOOKASIDE_LIST SharedCacheMapLookasideList;
  52 static NPAGED_LOOKASIDE_LIST VacbLookasideList;
  53
  54 /* Internal vars (MS):
  55  * - Threshold above which lazy writer will start action
  56  * - Amount of dirty pages
  57  * - List for deferred writes
  58  * - Spinlock when dealing with the deferred list
  59  * - List for "clean" shared cache maps
  60  */
  61 ULONG CcDirtyPageThreshold = 0;
  62 ULONG CcTotalDirtyPages = 0;
  63 LIST_ENTRY CcDeferredWrites;
  64 KSPIN_LOCK CcDeferredWriteSpinLock;
  65 LIST_ENTRY CcCleanSharedCacheMapList;
  66
  67 #if DBG
  68 ULONG CcRosVacbIncRefCount_(PROS_VACB vacb, PCSTR file, INT line)
  69 {
  70     ULONG Refs;
  71
  72     Refs = InterlockedIncrement((PLONG)&vacb->ReferenceCount);
  73     if (vacb->SharedCacheMap->Trace)
  74     {
  75         DbgPrint("(%s:%i) VACB %p ++RefCount=%lu, Dirty %u, PageOut %lu\n",
  76                  file, line, vacb, Refs, vacb->Dirty, vacb->PageOut);
  77     }
  78
  79     return Refs;
  80 }
  81 ULONG CcRosVacbDecRefCount_(PROS_VACB vacb, PCSTR file, INT line)
  82 {
  83     ULONG Refs;
  84
  85     Refs = InterlockedDecrement((PLONG)&vacb->ReferenceCount);
  86     ASSERT(!(Refs == 0 && vacb->Dirty));
  87     if (vacb->SharedCacheMap->Trace)
  88     {
  89         DbgPrint("(%s:%i) VACB %p --RefCount=%lu, Dirty %u, PageOut %lu\n",
  90                  file, line, vacb, Refs, vacb->Dirty, vacb->PageOut);
  91     }
  92
  93     if (Refs == 0)
  94     {
  95         CcRosInternalFreeVacb(vacb);
  96     }
  97
  98     return Refs;
  99 }
 100 ULONG CcRosVacbGetRefCount_(PROS_VACB vacb, PCSTR file, INT line)
 101 {
 102     ULONG Refs;
 103
 104     Refs = InterlockedCompareExchange((PLONG)&vacb->ReferenceCount, 0, 0);
 105     if (vacb->SharedCacheMap->Trace)
 106     {
 107         DbgPrint("(%s:%i) VACB %p ==RefCount=%lu, Dirty %u, PageOut %lu\n",
 108                  file, line, vacb, Refs, vacb->Dirty, vacb->PageOut);
 109     }
 110
 111     return Refs;
 112 }
 113 #endif
 114
 115
 116 /* FUNCTIONS *****************************************************************/
 117
 118 VOID
 119 NTAPI
 120 CcRosTraceCacheMap (
 121     PROS_SHARED_CACHE_MAP SharedCacheMap,
 122     BOOLEAN Trace )
 123 {
 124 #if DBG
 125     KIRQL oldirql;
 126     PLIST_ENTRY current_entry;
 127     PROS_VACB current;
 128
 129     if (!SharedCacheMap)
 130         return;
 131
 132     SharedCacheMap->Trace = Trace;
 133
 134     if (Trace)
 135     {
 136         DPRINT1("Enabling Tracing for CacheMap 0x%p:\n", SharedCacheMap);
 137
 138         KeAcquireGuardedMutex(&ViewLock);
 139         KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldirql);
 140
 141         current_entry = SharedCacheMap->CacheMapVacbListHead.Flink;
 142         while (current_entry != &SharedCacheMap->CacheMapVacbListHead)
 143         {
 144             current = CONTAINING_RECORD(current_entry, ROS_VACB, CacheMapVacbListEntry);
 145             current_entry = current_entry->Flink;
 146
 147             DPRINT1("  VACB 0x%p enabled, RefCount %lu, Dirty %u, PageOut %lu\n",
 148                     current, current->ReferenceCount, current->Dirty, current->PageOut );
 149         }
 150         KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldirql);
 151         KeReleaseGuardedMutex(&ViewLock);
 152     }
 153     else
 154     {
 155         DPRINT1("Disabling Tracing for CacheMap 0x%p:\n", SharedCacheMap);
 156     }
 157
 158 #else
 159     UNREFERENCED_PARAMETER(SharedCacheMap);
 160     UNREFERENCED_PARAMETER(Trace);
 161 #endif
 162 }
 163
 164 NTSTATUS
 165 NTAPI
 166 CcRosFlushVacb (
 167     PROS_VACB Vacb)
 168 {
 169     NTSTATUS Status;
 170
 171     CcRosUnmarkDirtyVacb(Vacb, TRUE);
 172
 173     Status = CcWriteVirtualAddress(Vacb);
 174     if (!NT_SUCCESS(Status))
 175     {
 176         CcRosMarkDirtyVacb(Vacb);
 177     }
 178
 179     return Status;
 180 }
 181
 182 NTSTATUS
 183 NTAPI
 184 CcRosFlushDirtyPages (
 185     ULONG Target,
 186     PULONG Count,
 187     BOOLEAN Wait,
 188     BOOLEAN CalledFromLazy)
 189 {
 190     PLIST_ENTRY current_entry;
 191     PROS_VACB current;
 192     BOOLEAN Locked;
 193     NTSTATUS Status;
 194
 195     DPRINT("CcRosFlushDirtyPages(Target %lu)\n", Target);
 196
 197     (*Count) = 0;
 198
 199     KeEnterCriticalRegion();
 200     KeAcquireGuardedMutex(&ViewLock);
 201
 202     current_entry = DirtyVacbListHead.Flink;
 203     if (current_entry == &DirtyVacbListHead)
 204     {
 205         DPRINT("No Dirty pages\n");
 206     }
 207
 208     while ((current_entry != &DirtyVacbListHead) && (Target > 0))
 209     {
 210         current = CONTAINING_RECORD(current_entry,
 211                                     ROS_VACB,
 212                                     DirtyVacbListEntry);
 213         current_entry = current_entry->Flink;
 214
 215         CcRosVacbIncRefCount(current);
 216
 217         /* When performing lazy write, don't handle temporary files */
 218         if (CalledFromLazy &&
 219             BooleanFlagOn(current->SharedCacheMap->FileObject->Flags, FO_TEMPORARY_FILE))
 220         {
 221             CcRosVacbDecRefCount(current);
 222             continue;
 223         }
 224
 225         Locked = current->SharedCacheMap->Callbacks->AcquireForLazyWrite(
 226                      current->SharedCacheMap->LazyWriteContext, Wait);
 227         if (!Locked)
 228         {
 229             CcRosVacbDecRefCount(current);
 230             continue;
 231         }
 232
 233         ASSERT(current->Dirty);
 234
 235         KeReleaseGuardedMutex(&ViewLock);
 236
 237         Status = CcRosFlushVacb(current);
 238
 239         current->SharedCacheMap->Callbacks->ReleaseFromLazyWrite(
 240             current->SharedCacheMap->LazyWriteContext);
 241
 242         KeAcquireGuardedMutex(&ViewLock);
 243         CcRosVacbDecRefCount(current);
 244
 245         if (!NT_SUCCESS(Status) && (Status != STATUS_END_OF_FILE) &&
 246             (Status != STATUS_MEDIA_WRITE_PROTECTED))
 247         {
 248             DPRINT1("CC: Failed to flush VACB.\n");
 249         }
 250         else
 251         {
 252             ULONG PagesFreed;
 253
 254             /* How many pages did we free? */
 255             PagesFreed = VACB_MAPPING_GRANULARITY / PAGE_SIZE;
 256             (*Count) += PagesFreed;
 257
 258             /* Make sure we don't overflow target! */
 259             if (Target < PagesFreed)
 260             {
 261                 /* If we would have, jump to zero directly */
 262                 Target = 0;
 263             }
 264             else
 265             {
 266                 Target -= PagesFreed;
 267             }
 268         }
 269
 270         current_entry = DirtyVacbListHead.Flink;
 271     }
 272
 273     KeReleaseGuardedMutex(&ViewLock);
 274     KeLeaveCriticalRegion();
 275
 276     DPRINT("CcRosFlushDirtyPages() finished\n");
 277     return STATUS_SUCCESS;
 278 }
 279
 280 NTSTATUS
 281 CcRosTrimCache (
 282     ULONG Target,
 283     ULONG Priority,
 284     PULONG NrFreed)
 285 /*
 286  * FUNCTION: Try to free some memory from the file cache.
 287  * ARGUMENTS:
 288  *       Target - The number of pages to be freed.
 289  *       Priority - The priority of free (currently unused).
 290  *       NrFreed - Points to a variable where the number of pages
 291  *                 actually freed is returned.
 292  */
 293 {
 294     PLIST_ENTRY current_entry;
 295     PROS_VACB current;
 296     ULONG PagesFreed;
 297     KIRQL oldIrql;
 298     LIST_ENTRY FreeList;
 299     PFN_NUMBER Page;
 300     ULONG i;
 301     BOOLEAN FlushedPages = FALSE;
 302
 303     DPRINT("CcRosTrimCache(Target %lu)\n", Target);
 304
 305     InitializeListHead(&FreeList);
 306
 307     *NrFreed = 0;
 308
 309 retry:
 310     KeAcquireGuardedMutex(&ViewLock);
 311
 312     current_entry = VacbLruListHead.Flink;
 313     while (current_entry != &VacbLruListHead)
 314     {
 315         ULONG Refs;
 316
 317         current = CONTAINING_RECORD(current_entry,
 318                                     ROS_VACB,
 319                                     VacbLruListEntry);
 320         current_entry = current_entry->Flink;
 321
 322         KeAcquireSpinLock(&current->SharedCacheMap->CacheMapLock, &oldIrql);
 323
 324         /* Reference the VACB */
 325         CcRosVacbIncRefCount(current);
 326
 327         /* Check if it's mapped and not dirty */
 328         if (InterlockedCompareExchange((PLONG)&current->MappedCount, 0, 0) > 0 && !current->Dirty)
 329         {
 330             /* We have to break these locks because Cc sucks */
 331             KeReleaseSpinLock(&current->SharedCacheMap->CacheMapLock, oldIrql);
 332             KeReleaseGuardedMutex(&ViewLock);
 333
 334             /* Page out the VACB */
 335             for (i = 0; i < VACB_MAPPING_GRANULARITY / PAGE_SIZE; i++)
 336             {
 337                 Page = (PFN_NUMBER)(MmGetPhysicalAddress((PUCHAR)current->BaseAddress + (i * PAGE_SIZE)).QuadPart >> PAGE_SHIFT);
 338
 339                 MmPageOutPhysicalAddress(Page);
 340             }
 341
 342             /* Reacquire the locks */
 343             KeAcquireGuardedMutex(&ViewLock);
 344             KeAcquireSpinLock(&current->SharedCacheMap->CacheMapLock, &oldIrql);
 345         }
 346
 347         /* Dereference the VACB */
 348         Refs = CcRosVacbDecRefCount(current);
 349
 350         /* Check if we can free this entry now */
 351         if (Refs < 2)
 352         {
 353             ASSERT(!current->Dirty);
 354             ASSERT(!current->MappedCount);
 355             ASSERT(Refs == 1);
 356
 357             RemoveEntryList(&current->CacheMapVacbListEntry);
 358             RemoveEntryList(&current->VacbLruListEntry);
 359             InitializeListHead(&current->VacbLruListEntry);
 360             InsertHeadList(&FreeList, &current->CacheMapVacbListEntry);
 361
 362             /* Calculate how many pages we freed for Mm */
 363             PagesFreed = min(VACB_MAPPING_GRANULARITY / PAGE_SIZE, Target);
 364             Target -= PagesFreed;
 365             (*NrFreed) += PagesFreed;
 366         }
 367
 368         KeReleaseSpinLock(&current->SharedCacheMap->CacheMapLock, oldIrql);
 369     }
 370
 371     KeReleaseGuardedMutex(&ViewLock);
 372
 373     /* Try flushing pages if we haven't met our target */
 374     if ((Target > 0) && !FlushedPages)
 375     {
 376         /* Flush dirty pages to disk */
 377         CcRosFlushDirtyPages(Target, &PagesFreed, FALSE, FALSE);
 378         FlushedPages = TRUE;
 379
 380         /* We can only swap as many pages as we flushed */
 381         if (PagesFreed < Target) Target = PagesFreed;
 382
 383         /* Check if we flushed anything */
 384         if (PagesFreed != 0)
 385         {
 386             /* Try again after flushing dirty pages */
 387             DPRINT("Flushed %lu dirty cache pages to disk\n", PagesFreed);
 388             goto retry;
 389         }
 390     }
 391
 392     while (!IsListEmpty(&FreeList))
 393     {
 394         ULONG Refs;
 395
 396         current_entry = RemoveHeadList(&FreeList);
 397         current = CONTAINING_RECORD(current_entry,
 398                                     ROS_VACB,
 399                                     CacheMapVacbListEntry);
 400         InitializeListHead(&current->CacheMapVacbListEntry);
 401         Refs = CcRosVacbDecRefCount(current);
 402         ASSERT(Refs == 0);
 403     }
 404
 405     DPRINT("Evicted %lu cache pages\n", (*NrFreed));
 406
 407     return STATUS_SUCCESS;
 408 }
 409
 410 NTSTATUS
 411 NTAPI
 412 CcRosReleaseVacb (
 413     PROS_SHARED_CACHE_MAP SharedCacheMap,
 414     PROS_VACB Vacb,
 415     BOOLEAN Valid,
 416     BOOLEAN Dirty,
 417     BOOLEAN Mapped)
 418 {
 419     ULONG Refs;
 420     ASSERT(SharedCacheMap);
 421
 422     DPRINT("CcRosReleaseVacb(SharedCacheMap 0x%p, Vacb 0x%p, Valid %u)\n",
 423            SharedCacheMap, Vacb, Valid);
 424
 425     Vacb->Valid = Valid;
 426
 427     if (Dirty && !Vacb->Dirty)
 428     {
 429         CcRosMarkDirtyVacb(Vacb);
 430     }
 431
 432     if (Mapped)
 433     {
 434         if (InterlockedIncrement((PLONG)&Vacb->MappedCount) == 1)
 435         {
 436             CcRosVacbIncRefCount(Vacb);
 437         }
 438     }
 439
 440     Refs = CcRosVacbDecRefCount(Vacb);
 441     ASSERT(Refs > 0);
 442
 443     return STATUS_SUCCESS;
 444 }
 445
 446 /* Returns with VACB Lock Held! */
 447 PROS_VACB
 448 NTAPI
 449 CcRosLookupVacb (
 450     PROS_SHARED_CACHE_MAP SharedCacheMap,
 451     LONGLONG FileOffset)
 452 {
 453     PLIST_ENTRY current_entry;
 454     PROS_VACB current;
 455     KIRQL oldIrql;
 456
 457     ASSERT(SharedCacheMap);
 458
 459     DPRINT("CcRosLookupVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
 460            SharedCacheMap, FileOffset);
 461
 462     KeAcquireGuardedMutex(&ViewLock);
 463     KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldIrql);
 464
 465     current_entry = SharedCacheMap->CacheMapVacbListHead.Flink;
 466     while (current_entry != &SharedCacheMap->CacheMapVacbListHead)
 467     {
 468         current = CONTAINING_RECORD(current_entry,
 469                                     ROS_VACB,
 470                                     CacheMapVacbListEntry);
 471         if (IsPointInRange(current->FileOffset.QuadPart,
 472                            VACB_MAPPING_GRANULARITY,
 473                            FileOffset))
 474         {
 475             CcRosVacbIncRefCount(current);
 476             KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
 477             KeReleaseGuardedMutex(&ViewLock);
 478             return current;
 479         }
 480         if (current->FileOffset.QuadPart > FileOffset)
 481             break;
 482         current_entry = current_entry->Flink;
 483     }
 484
 485     KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
 486     KeReleaseGuardedMutex(&ViewLock);
 487
 488     return NULL;
 489 }
 490
 491 VOID
 492 NTAPI
 493 CcRosMarkDirtyVacb (
 494     PROS_VACB Vacb)
 495 {
 496     KIRQL oldIrql;
 497     PROS_SHARED_CACHE_MAP SharedCacheMap;
 498
 499     SharedCacheMap = Vacb->SharedCacheMap;
 500
 501     KeAcquireGuardedMutex(&ViewLock);
 502     KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldIrql);
 503
 504     ASSERT(!Vacb->Dirty);
 505
 506     InsertTailList(&DirtyVacbListHead, &Vacb->DirtyVacbListEntry);
 507     CcTotalDirtyPages += VACB_MAPPING_GRANULARITY / PAGE_SIZE;
 508     Vacb->SharedCacheMap->DirtyPages += VACB_MAPPING_GRANULARITY / PAGE_SIZE;
 509     CcRosVacbIncRefCount(Vacb);
 510
 511     /* Move to the tail of the LRU list */
 512     RemoveEntryList(&Vacb->VacbLruListEntry);
 513     InsertTailList(&VacbLruListHead, &Vacb->VacbLruListEntry);
 514
 515     Vacb->Dirty = TRUE;
 516
 517     KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
 518     KeReleaseGuardedMutex(&ViewLock);
 519
 520     /* Schedule a lazy writer run to now that we have dirty VACB */
 521     oldIrql = KeAcquireQueuedSpinLock(LockQueueMasterLock);
 522     if (!LazyWriter.ScanActive)
 523     {
 524         CcScheduleLazyWriteScan(FALSE);
 525     }
 526     KeReleaseQueuedSpinLock(LockQueueMasterLock, oldIrql);
 527 }
 528
 529 VOID
 530 NTAPI
 531 CcRosUnmarkDirtyVacb (
 532     PROS_VACB Vacb,
 533     BOOLEAN LockViews)
 534 {
 535     KIRQL oldIrql;
 536     PROS_SHARED_CACHE_MAP SharedCacheMap;
 537
 538     SharedCacheMap = Vacb->SharedCacheMap;
 539
 540     if (LockViews)
 541     {
 542         KeAcquireGuardedMutex(&ViewLock);
 543         KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldIrql);
 544     }
 545
 546     ASSERT(Vacb->Dirty);
 547
 548     Vacb->Dirty = FALSE;
 549
 550     RemoveEntryList(&Vacb->DirtyVacbListEntry);
 551     InitializeListHead(&Vacb->DirtyVacbListEntry);
 552     CcTotalDirtyPages -= VACB_MAPPING_GRANULARITY / PAGE_SIZE;
 553     Vacb->SharedCacheMap->DirtyPages -= VACB_MAPPING_GRANULARITY / PAGE_SIZE;
 554     CcRosVacbDecRefCount(Vacb);
 555
 556     if (LockViews)
 557     {
 558         KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
 559         KeReleaseGuardedMutex(&ViewLock);
 560     }
 561 }
 562
 563 NTSTATUS
 564 NTAPI
 565 CcRosMarkDirtyFile (
 566     PROS_SHARED_CACHE_MAP SharedCacheMap,
 567     LONGLONG FileOffset)
 568 {
 569     PROS_VACB Vacb;
 570
 571     ASSERT(SharedCacheMap);
 572
 573     DPRINT("CcRosMarkDirtyVacb(SharedCacheMap 0x%p, FileOffset %I64u)\n",
 574            SharedCacheMap, FileOffset);
 575
 576     Vacb = CcRosLookupVacb(SharedCacheMap, FileOffset);
 577     if (Vacb == NULL)
 578     {
 579         KeBugCheck(CACHE_MANAGER);
 580     }
 581
 582     CcRosReleaseVacb(SharedCacheMap, Vacb, Vacb->Valid, TRUE, FALSE);
 583
 584     return STATUS_SUCCESS;
 585 }
 586
 587 /*
 588  * Note: this is not the contrary function of
 589  * CcRosMapVacbInKernelSpace()
 590  */
 591 NTSTATUS
 592 NTAPI
 593 CcRosUnmapVacb (
 594     PROS_SHARED_CACHE_MAP SharedCacheMap,
 595     LONGLONG FileOffset,
 596     BOOLEAN NowDirty)
 597 {
 598     PROS_VACB Vacb;
 599
 600     ASSERT(SharedCacheMap);
 601
 602     DPRINT("CcRosUnmapVacb(SharedCacheMap 0x%p, FileOffset %I64u, NowDirty %u)\n",
 603            SharedCacheMap, FileOffset, NowDirty);
 604
 605     Vacb = CcRosLookupVacb(SharedCacheMap, FileOffset);
 606     if (Vacb == NULL)
 607     {
 608         return STATUS_UNSUCCESSFUL;
 609     }
 610
 611     ASSERT(Vacb->MappedCount != 0);
 612     if (InterlockedDecrement((PLONG)&Vacb->MappedCount) == 0)
 613     {
 614         CcRosVacbDecRefCount(Vacb);
 615     }
 616
 617     CcRosReleaseVacb(SharedCacheMap, Vacb, Vacb->Valid, NowDirty, FALSE);
 618
 619     return STATUS_SUCCESS;
 620 }
 621
 622 static
 623 NTSTATUS
 624 CcRosMapVacbInKernelSpace(
 625     PROS_VACB Vacb)
 626 {
 627     ULONG i;
 628     NTSTATUS Status;
 629     ULONG_PTR NumberOfPages;
 630     PVOID BaseAddress = NULL;
 631
 632     /* Create a memory area. */
 633     MmLockAddressSpace(MmGetKernelAddressSpace());
 634     Status = MmCreateMemoryArea(MmGetKernelAddressSpace(),
 635                                 0, // nothing checks for VACB mareas, so set to 0
 636                                 &BaseAddress,
 637                                 VACB_MAPPING_GRANULARITY,
 638                                 PAGE_READWRITE,
 639                                 (PMEMORY_AREA*)&Vacb->MemoryArea,
 640                                 0,
 641                                 PAGE_SIZE);
 642     ASSERT(Vacb->BaseAddress == NULL);
 643     Vacb->BaseAddress = BaseAddress;
 644     MmUnlockAddressSpace(MmGetKernelAddressSpace());
 645     if (!NT_SUCCESS(Status))
 646     {
 647         DPRINT1("MmCreateMemoryArea failed with %lx for VACB %p\n", Status, Vacb);
 648         return Status;
 649     }
 650
 651     ASSERT(((ULONG_PTR)Vacb->BaseAddress % PAGE_SIZE) == 0);
 652     ASSERT((ULONG_PTR)Vacb->BaseAddress > (ULONG_PTR)MmSystemRangeStart);
 653     ASSERT((ULONG_PTR)Vacb->BaseAddress + VACB_MAPPING_GRANULARITY - 1 > (ULONG_PTR)MmSystemRangeStart);
 654
 655     /* Create a virtual mapping for this memory area */
 656     NumberOfPages = BYTES_TO_PAGES(VACB_MAPPING_GRANULARITY);
 657     for (i = 0; i < NumberOfPages; i++)
 658     {
 659         PFN_NUMBER PageFrameNumber;
 660
 661         MI_SET_USAGE(MI_USAGE_CACHE);
 662         Status = MmRequestPageMemoryConsumer(MC_CACHE, TRUE, &PageFrameNumber);
 663         if (PageFrameNumber == 0)
 664         {
 665             DPRINT1("Unable to allocate page\n");
 666             KeBugCheck(MEMORY_MANAGEMENT);
 667         }
 668
 669         ASSERT(BaseAddress == Vacb->BaseAddress);
 670         ASSERT(i * PAGE_SIZE < VACB_MAPPING_GRANULARITY);
 671         ASSERT((ULONG_PTR)Vacb->BaseAddress + (i * PAGE_SIZE) >= (ULONG_PTR)BaseAddress);
 672         ASSERT((ULONG_PTR)Vacb->BaseAddress + (i * PAGE_SIZE) > (ULONG_PTR)MmSystemRangeStart);
 673
 674         Status = MmCreateVirtualMapping(NULL,
 675                                         (PVOID)((ULONG_PTR)Vacb->BaseAddress + (i * PAGE_SIZE)),
 676                                         PAGE_READWRITE,
 677                                         &PageFrameNumber,
 678                                         1);
 679         if (!NT_SUCCESS(Status))
 680         {
 681             DPRINT1("Unable to create virtual mapping\n");
 682             KeBugCheck(MEMORY_MANAGEMENT);
 683         }
 684     }
 685
 686     return STATUS_SUCCESS;
 687 }
 688
 689 static
 690 BOOLEAN
 691 CcRosFreeUnusedVacb (
 692     PULONG Count)
 693 {
 694     ULONG cFreed;
 695     BOOLEAN Freed;
 696     KIRQL oldIrql;
 697     PROS_VACB current;
 698     LIST_ENTRY FreeList;
 699     PLIST_ENTRY current_entry;
 700
 701     cFreed = 0;
 702     Freed = FALSE;
 703     InitializeListHead(&FreeList);
 704
 705     KeAcquireGuardedMutex(&ViewLock);
 706
 707     /* Browse all the available VACB */
 708     current_entry = VacbLruListHead.Flink;
 709     while (current_entry != &VacbLruListHead)
 710     {
 711         ULONG Refs;
 712
 713         current = CONTAINING_RECORD(current_entry,
 714                                     ROS_VACB,
 715                                     VacbLruListEntry);
 716         current_entry = current_entry->Flink;
 717
 718         KeAcquireSpinLock(&current->SharedCacheMap->CacheMapLock, &oldIrql);
 719
 720         /* Only deal with unused VACB, we will free them */
 721         Refs = CcRosVacbGetRefCount(current);
 722         if (Refs < 2)
 723         {
 724             ASSERT(!current->Dirty);
 725             ASSERT(!current->MappedCount);
 726             ASSERT(Refs == 1);
 727
 728             /* Reset and move to free list */
 729             RemoveEntryList(&current->CacheMapVacbListEntry);
 730             RemoveEntryList(&current->VacbLruListEntry);
 731             InitializeListHead(&current->VacbLruListEntry);
 732             InsertHeadList(&FreeList, &current->CacheMapVacbListEntry);
 733         }
 734
 735         KeReleaseSpinLock(&current->SharedCacheMap->CacheMapLock, oldIrql);
 736
 737     }
 738
 739     KeReleaseGuardedMutex(&ViewLock);
 740
 741     /* And now, free any of the found VACB, that'll free memory! */
 742     while (!IsListEmpty(&FreeList))
 743     {
 744         ULONG Refs;
 745
 746         current_entry = RemoveHeadList(&FreeList);
 747         current = CONTAINING_RECORD(current_entry,
 748                                     ROS_VACB,
 749                                     CacheMapVacbListEntry);
 750         InitializeListHead(&current->CacheMapVacbListEntry);
 751         Refs = CcRosVacbDecRefCount(current);
 752         ASSERT(Refs == 0);
 753         ++cFreed;
 754     }
 755
 756     /* If we freed at least one VACB, return success */
 757     if (cFreed != 0)
 758     {
 759         Freed = TRUE;
 760     }
 761
 762     /* If caller asked for free count, return it */
 763     if (Count != NULL)
 764     {
 765         *Count = cFreed;
 766     }
 767
 768     return Freed;
 769 }
 770
 771 static
 772 NTSTATUS
 773 CcRosCreateVacb (
 774     PROS_SHARED_CACHE_MAP SharedCacheMap,
 775     LONGLONG FileOffset,
 776     PROS_VACB *Vacb)
 777 {
 778     PROS_VACB current;
 779     PROS_VACB previous;
 780     PLIST_ENTRY current_entry;
 781     NTSTATUS Status;
 782     KIRQL oldIrql;
 783     ULONG Refs;
 784     BOOLEAN Retried;
 785
 786     ASSERT(SharedCacheMap);
 787
 788     DPRINT("CcRosCreateVacb()\n");
 789
 790     if (FileOffset >= SharedCacheMap->SectionSize.QuadPart)
 791     {
 792         *Vacb = NULL;
 793         return STATUS_INVALID_PARAMETER;
 794     }
 795
 796     current = ExAllocateFromNPagedLookasideList(&VacbLookasideList);
 797     current->BaseAddress = NULL;
 798     current->Valid = FALSE;
 799     current->Dirty = FALSE;
 800     current->PageOut = FALSE;
 801     current->FileOffset.QuadPart = ROUND_DOWN(FileOffset, VACB_MAPPING_GRANULARITY);
 802     current->SharedCacheMap = SharedCacheMap;
 803 #if DBG
 804     if (SharedCacheMap->Trace)
 805     {
 806         DPRINT1("CacheMap 0x%p: new VACB: 0x%p\n", SharedCacheMap, current);
 807     }
 808 #endif
 809     current->MappedCount = 0;
 810     current->ReferenceCount = 0;
 811     InitializeListHead(&current->CacheMapVacbListEntry);
 812     InitializeListHead(&current->DirtyVacbListEntry);
 813     InitializeListHead(&current->VacbLruListEntry);
 814
 815     CcRosVacbIncRefCount(current);
 816
 817     Retried = FALSE;
 818 Retry:
 819     /* Map VACB in kernel space */
 820     Status = CcRosMapVacbInKernelSpace(current);
 821     if (!NT_SUCCESS(Status))
 822     {
 823         ULONG Freed;
 824         /* If no space left, try to prune unused VACB
 825          * to recover space to map our VACB
 826          * If it succeed, retry to map, otherwise
 827          * just fail.
 828          */
 829         if (!Retried && CcRosFreeUnusedVacb(&Freed))
 830         {
 831             DPRINT("Prunned %d VACB, trying again\n", Freed);
 832             Retried = TRUE;
 833             goto Retry;
 834         }
 835
 836         CcRosVacbDecRefCount(current);
 837         ExFreeToNPagedLookasideList(&VacbLookasideList, current);
 838         return Status;
 839     }
 840
 841     KeAcquireGuardedMutex(&ViewLock);
 842
 843     *Vacb = current;
 844     /* There is window between the call to CcRosLookupVacb
 845      * and CcRosCreateVacb. We must check if a VACB for the
 846      * file offset exist. If there is a VACB, we release
 847      * our newly created VACB and return the existing one.
 848      */
 849     KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldIrql);
 850     current_entry = SharedCacheMap->CacheMapVacbListHead.Flink;
 851     previous = NULL;
 852     while (current_entry != &SharedCacheMap->CacheMapVacbListHead)
 853     {
 854         current = CONTAINING_RECORD(current_entry,
 855                                     ROS_VACB,
 856                                     CacheMapVacbListEntry);
 857         if (IsPointInRange(current->FileOffset.QuadPart,
 858                            VACB_MAPPING_GRANULARITY,
 859                            FileOffset))
 860         {
 861             CcRosVacbIncRefCount(current);
 862             KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
 863 #if DBG
 864             if (SharedCacheMap->Trace)
 865             {
 866                 DPRINT1("CacheMap 0x%p: deleting newly created VACB 0x%p ( found existing one 0x%p )\n",
 867                         SharedCacheMap,
 868                         (*Vacb),
 869                         current);
 870             }
 871 #endif
 872             KeReleaseGuardedMutex(&ViewLock);
 873
 874             Refs = CcRosVacbDecRefCount(*Vacb);
 875             ASSERT(Refs == 0);
 876
 877             *Vacb = current;
 878             return STATUS_SUCCESS;
 879         }
 880         if (current->FileOffset.QuadPart < FileOffset)
 881         {
 882             ASSERT(previous == NULL ||
 883                    previous->FileOffset.QuadPart < current->FileOffset.QuadPart);
 884             previous = current;
 885         }
 886         if (current->FileOffset.QuadPart > FileOffset)
 887             break;
 888         current_entry = current_entry->Flink;
 889     }
 890     /* There was no existing VACB. */
 891     current = *Vacb;
 892     if (previous)
 893     {
 894         InsertHeadList(&previous->CacheMapVacbListEntry, &current->CacheMapVacbListEntry);
 895     }
 896     else
 897     {
 898         InsertHeadList(&SharedCacheMap->CacheMapVacbListHead, &current->CacheMapVacbListEntry);
 899     }
 900     KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
 901     InsertTailList(&VacbLruListHead, &current->VacbLruListEntry);
 902     KeReleaseGuardedMutex(&ViewLock);
 903
 904     MI_SET_USAGE(MI_USAGE_CACHE);
 905 #if MI_TRACE_PFNS
 906     if ((SharedCacheMap->FileObject) && (SharedCacheMap->FileObject->FileName.Buffer))
 907     {
 908         PWCHAR pos;
 909         ULONG len = 0;
 910         pos = wcsrchr(SharedCacheMap->FileObject->FileName.Buffer, '\\');
 911         if (pos)
 912         {
 913             len = wcslen(pos) * sizeof(WCHAR);
 914             snprintf(MI_PFN_CURRENT_PROCESS_NAME, min(16, len), "%S", pos);
 915         }
 916         else
 917         {
 918             snprintf(MI_PFN_CURRENT_PROCESS_NAME, min(16, len), "%wZ", &SharedCacheMap->FileObject->FileName);
 919         }
 920     }
 921 #endif
 922
 923     /* Reference it to allow release */
 924     CcRosVacbIncRefCount(current);
 925
 926     return Status;
 927 }
 928
 929 NTSTATUS
 930 NTAPI
 931 CcRosGetVacb (
 932     PROS_SHARED_CACHE_MAP SharedCacheMap,
 933     LONGLONG FileOffset,
 934     PLONGLONG BaseOffset,
 935     PVOID* BaseAddress,
 936     PBOOLEAN UptoDate,
 937     PROS_VACB *Vacb)
 938 {
 939     PROS_VACB current;
 940     NTSTATUS Status;
 941     ULONG Refs;
 942
 943     ASSERT(SharedCacheMap);
 944
 945     DPRINT("CcRosGetVacb()\n");
 946
 947     /*
 948      * Look for a VACB already mapping the same data.
 949      */
 950     current = CcRosLookupVacb(SharedCacheMap, FileOffset);
 951     if (current == NULL)
 952     {
 953         /*
 954          * Otherwise create a new VACB.
 955          */
 956         Status = CcRosCreateVacb(SharedCacheMap, FileOffset, &current);
 957         if (!NT_SUCCESS(Status))
 958         {
 959             return Status;
 960         }
 961     }
 962
 963     Refs = CcRosVacbGetRefCount(current);
 964
 965     KeAcquireGuardedMutex(&ViewLock);
 966
 967     /* Move to the tail of the LRU list */
 968     RemoveEntryList(&current->VacbLruListEntry);
 969     InsertTailList(&VacbLruListHead, &current->VacbLruListEntry);
 970
 971     KeReleaseGuardedMutex(&ViewLock);
 972
 973     /*
 974      * Return information about the VACB to the caller.
 975      */
 976     *UptoDate = current->Valid;
 977     *BaseAddress = current->BaseAddress;
 978     DPRINT("*BaseAddress %p\n", *BaseAddress);
 979     *Vacb = current;
 980     *BaseOffset = current->FileOffset.QuadPart;
 981
 982     ASSERT(Refs > 1);
 983
 984     return STATUS_SUCCESS;
 985 }
 986
 987 NTSTATUS
 988 NTAPI
 989 CcRosRequestVacb (
 990     PROS_SHARED_CACHE_MAP SharedCacheMap,
 991     LONGLONG FileOffset,
 992     PVOID* BaseAddress,
 993     PBOOLEAN UptoDate,
 994     PROS_VACB *Vacb)
 995 /*
 996  * FUNCTION: Request a page mapping for a shared cache map
 997  */
 998 {
 999     LONGLONG BaseOffset;
1000
1001     ASSERT(SharedCacheMap);
1002
1003     if (FileOffset % VACB_MAPPING_GRANULARITY != 0)
1004     {
1005         DPRINT1("Bad fileoffset %I64x should be multiple of %x",
1006                 FileOffset, VACB_MAPPING_GRANULARITY);
1007         KeBugCheck(CACHE_MANAGER);
1008     }
1009
1010     return CcRosGetVacb(SharedCacheMap,
1011                         FileOffset,
1012                         &BaseOffset,
1013                         BaseAddress,
1014                         UptoDate,
1015                         Vacb);
1016 }
1017
1018 static
1019 VOID
1020 CcFreeCachePage (
1021     PVOID Context,
1022     MEMORY_AREA* MemoryArea,
1023     PVOID Address,
1024     PFN_NUMBER Page,
1025     SWAPENTRY SwapEntry,
1026     BOOLEAN Dirty)
1027 {
1028     ASSERT(SwapEntry == 0);
1029     if (Page != 0)
1030     {
1031         ASSERT(MmGetReferenceCountPage(Page) == 1);
1032         MmReleasePageMemoryConsumer(MC_CACHE, Page);
1033     }
1034 }
1035
1036 NTSTATUS
1037 CcRosInternalFreeVacb (
1038     PROS_VACB Vacb)
1039 /*
1040  * FUNCTION: Releases a VACB associated with a shared cache map
1041  */
1042 {
1043     DPRINT("Freeing VACB 0x%p\n", Vacb);
1044 #if DBG
1045     if (Vacb->SharedCacheMap->Trace)
1046     {
1047         DPRINT1("CacheMap 0x%p: deleting VACB: 0x%p\n", Vacb->SharedCacheMap, Vacb);
1048     }
1049 #endif
1050
1051     MmLockAddressSpace(MmGetKernelAddressSpace());
1052     MmFreeMemoryArea(MmGetKernelAddressSpace(),
1053                      Vacb->MemoryArea,
1054                      CcFreeCachePage,
1055                      NULL);
1056     MmUnlockAddressSpace(MmGetKernelAddressSpace());
1057
1058     if (Vacb->ReferenceCount != 0)
1059     {
1060         DPRINT1("Invalid free: %ld\n", Vacb->ReferenceCount);
1061         if (Vacb->SharedCacheMap->FileObject && Vacb->SharedCacheMap->FileObject->FileName.Length)
1062         {
1063             DPRINT1("For file: %wZ\n", &Vacb->SharedCacheMap->FileObject->FileName);
1064         }
1065     }
1066
1067     ASSERT(Vacb->ReferenceCount == 0);
1068     ASSERT(IsListEmpty(&Vacb->CacheMapVacbListEntry));
1069     ASSERT(IsListEmpty(&Vacb->DirtyVacbListEntry));
1070     ASSERT(IsListEmpty(&Vacb->VacbLruListEntry));
1071     RtlFillMemory(Vacb, sizeof(*Vacb), 0xfd);
1072     ExFreeToNPagedLookasideList(&VacbLookasideList, Vacb);
1073     return STATUS_SUCCESS;
1074 }
1075
1076 /*
1077  * @implemented
1078  */
1079 VOID
1080 NTAPI
1081 CcFlushCache (
1082     IN PSECTION_OBJECT_POINTERS SectionObjectPointers,
1083     IN PLARGE_INTEGER FileOffset OPTIONAL,
1084     IN ULONG Length,
1085     OUT PIO_STATUS_BLOCK IoStatus)
1086 {
1087     PROS_SHARED_CACHE_MAP SharedCacheMap;
1088     LARGE_INTEGER Offset;
1089     LONGLONG RemainingLength;
1090     PROS_VACB current;
1091     NTSTATUS Status;
1092
1093     CCTRACE(CC_API_DEBUG, "SectionObjectPointers=%p FileOffset=%p Length=%lu\n",
1094         SectionObjectPointers, FileOffset, Length);
1095
1096     DPRINT("CcFlushCache(SectionObjectPointers 0x%p, FileOffset 0x%p, Length %lu, IoStatus 0x%p)\n",
1097            SectionObjectPointers, FileOffset, Length, IoStatus);
1098
1099     if (SectionObjectPointers && SectionObjectPointers->SharedCacheMap)
1100     {
1101         SharedCacheMap = SectionObjectPointers->SharedCacheMap;
1102         ASSERT(SharedCacheMap);
1103         if (FileOffset)
1104         {
1105             Offset = *FileOffset;
1106             RemainingLength = Length;
1107         }
1108         else
1109         {
1110             Offset.QuadPart = 0;
1111             RemainingLength = SharedCacheMap->FileSize.QuadPart;
1112         }
1113
1114         if (IoStatus)
1115         {
1116             IoStatus->Status = STATUS_SUCCESS;
1117             IoStatus->Information = 0;
1118         }
1119
1120         while (RemainingLength > 0)
1121         {
1122             current = CcRosLookupVacb(SharedCacheMap, Offset.QuadPart);
1123             if (current != NULL)
1124             {
1125                 if (current->Dirty)
1126                 {
1127                     Status = CcRosFlushVacb(current);
1128                     if (!NT_SUCCESS(Status) && IoStatus != NULL)
1129                     {
1130                         IoStatus->Status = Status;
1131                     }
1132                 }
1133
1134                 CcRosReleaseVacb(SharedCacheMap, current, current->Valid, current->Dirty, FALSE);
1135             }
1136
1137             Offset.QuadPart += VACB_MAPPING_GRANULARITY;
1138             RemainingLength -= min(RemainingLength, VACB_MAPPING_GRANULARITY);
1139         }
1140     }
1141     else
1142     {
1143         if (IoStatus)
1144         {
1145             IoStatus->Status = STATUS_INVALID_PARAMETER;
1146         }
1147     }
1148 }
1149
1150 NTSTATUS
1151 NTAPI
1152 CcRosDeleteFileCache (
1153     PFILE_OBJECT FileObject,
1154     PROS_SHARED_CACHE_MAP SharedCacheMap)
1155 /*
1156  * FUNCTION: Releases the shared cache map associated with a file object
1157  */
1158 {
1159     PLIST_ENTRY current_entry;
1160     PROS_VACB current;
1161     LIST_ENTRY FreeList;
1162     KIRQL oldIrql;
1163
1164     ASSERT(SharedCacheMap);
1165
1166     SharedCacheMap->OpenCount++;
1167     KeReleaseGuardedMutex(&ViewLock);
1168
1169     CcFlushCache(FileObject->SectionObjectPointer, NULL, 0, NULL);
1170
1171     KeAcquireGuardedMutex(&ViewLock);
1172     SharedCacheMap->OpenCount--;
1173     if (SharedCacheMap->OpenCount == 0)
1174     {
1175         KIRQL OldIrql;
1176
1177         FileObject->SectionObjectPointer->SharedCacheMap = NULL;
1178
1179         /*
1180          * Release all VACBs
1181          */
1182         InitializeListHead(&FreeList);
1183         KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldIrql);
1184         while (!IsListEmpty(&SharedCacheMap->CacheMapVacbListHead))
1185         {
1186             current_entry = RemoveTailList(&SharedCacheMap->CacheMapVacbListHead);
1187             KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
1188
1189             current = CONTAINING_RECORD(current_entry, ROS_VACB, CacheMapVacbListEntry);
1190             RemoveEntryList(&current->VacbLruListEntry);
1191             InitializeListHead(&current->VacbLruListEntry);
1192             if (current->Dirty)
1193             {
1194                 KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldIrql);
1195                 CcRosUnmarkDirtyVacb(current, FALSE);
1196                 KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
1197                 DPRINT1("Freeing dirty VACB\n");
1198             }
1199             if (current->MappedCount != 0)
1200             {
1201                 current->MappedCount = 0;
1202                 NT_VERIFY(CcRosVacbDecRefCount(current) > 0);
1203                 DPRINT1("Freeing mapped VACB\n");
1204             }
1205             InsertHeadList(&FreeList, &current->CacheMapVacbListEntry);
1206
1207             KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldIrql);
1208         }
1209 #if DBG
1210         SharedCacheMap->Trace = FALSE;
1211 #endif
1212         KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldIrql);
1213
1214         KeReleaseGuardedMutex(&ViewLock);
1215         ObDereferenceObject(SharedCacheMap->FileObject);
1216
1217         while (!IsListEmpty(&FreeList))
1218         {
1219             ULONG Refs;
1220
1221             current_entry = RemoveTailList(&FreeList);
1222             current = CONTAINING_RECORD(current_entry, ROS_VACB, CacheMapVacbListEntry);
1223             InitializeListHead(&current->CacheMapVacbListEntry);
1224             Refs = CcRosVacbDecRefCount(current);
1225 #if DBG // CORE-14578
1226             if (Refs != 0)
1227             {
1228                 DPRINT1("Leaking VACB %p attached to %p (%I64d)\n", current, FileObject, current->FileOffset.QuadPart);
1229                 DPRINT1("There are: %d references left\n", Refs);
1230                 DPRINT1("Map: %d\n", current->MappedCount);
1231                 DPRINT1("Dirty: %d\n", current->Dirty);
1232                 if (FileObject->FileName.Length != 0)
1233                 {
1234                     DPRINT1("File was: %wZ\n", &FileObject->FileName);
1235                 }
1236                 else if (FileObject->FsContext != NULL &&
1237                          ((PFSRTL_COMMON_FCB_HEADER)(FileObject->FsContext))->NodeTypeCode == 0x0502 &&
1238                          ((PFSRTL_COMMON_FCB_HEADER)(FileObject->FsContext))->NodeByteSize == 0x1F8 &&
1239                          ((PUNICODE_STRING)(((PUCHAR)FileObject->FsContext) + 0x100))->Length != 0)
1240                 {
1241                     DPRINT1("File was: %wZ (FastFAT)\n", (PUNICODE_STRING)(((PUCHAR)FileObject->FsContext) + 0x100));
1242                 }
1243                 else
1244                 {
1245                     DPRINT1("No name for the file\n");
1246                 }
1247             }
1248 #else
1249             ASSERT(Refs == 0);
1250 #endif
1251         }
1252
1253         OldIrql = KeAcquireQueuedSpinLock(LockQueueMasterLock);
1254         RemoveEntryList(&SharedCacheMap->SharedCacheMapLinks);
1255         KeReleaseQueuedSpinLock(LockQueueMasterLock, OldIrql);
1256
1257         ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList, SharedCacheMap);
1258         KeAcquireGuardedMutex(&ViewLock);
1259     }
1260     return STATUS_SUCCESS;
1261 }
1262
1263 VOID
1264 NTAPI
1265 CcRosReferenceCache (
1266     PFILE_OBJECT FileObject)
1267 {
1268     PROS_SHARED_CACHE_MAP SharedCacheMap;
1269     KeAcquireGuardedMutex(&ViewLock);
1270     SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
1271     ASSERT(SharedCacheMap);
1272     ASSERT(SharedCacheMap->OpenCount != 0);
1273     SharedCacheMap->OpenCount++;
1274     KeReleaseGuardedMutex(&ViewLock);
1275 }
1276
1277 VOID
1278 NTAPI
1279 CcRosRemoveIfClosed (
1280     PSECTION_OBJECT_POINTERS SectionObjectPointer)
1281 {
1282     PROS_SHARED_CACHE_MAP SharedCacheMap;
1283     DPRINT("CcRosRemoveIfClosed()\n");
1284     KeAcquireGuardedMutex(&ViewLock);
1285     SharedCacheMap = SectionObjectPointer->SharedCacheMap;
1286     if (SharedCacheMap && SharedCacheMap->OpenCount == 0)
1287     {
1288         CcRosDeleteFileCache(SharedCacheMap->FileObject, SharedCacheMap);
1289     }
1290     KeReleaseGuardedMutex(&ViewLock);
1291 }
1292
1293
1294 VOID
1295 NTAPI
1296 CcRosDereferenceCache (
1297     PFILE_OBJECT FileObject)
1298 {
1299     PROS_SHARED_CACHE_MAP SharedCacheMap;
1300     KeAcquireGuardedMutex(&ViewLock);
1301     SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
1302     ASSERT(SharedCacheMap);
1303     if (SharedCacheMap->OpenCount > 0)
1304     {
1305         SharedCacheMap->OpenCount--;
1306         if (SharedCacheMap->OpenCount == 0)
1307         {
1308             MmFreeSectionSegments(SharedCacheMap->FileObject);
1309             CcRosDeleteFileCache(FileObject, SharedCacheMap);
1310         }
1311     }
1312     KeReleaseGuardedMutex(&ViewLock);
1313 }
1314
1315 NTSTATUS
1316 NTAPI
1317 CcRosReleaseFileCache (
1318     PFILE_OBJECT FileObject)
1319 /*
1320  * FUNCTION: Called by the file system when a handle to a file object
1321  * has been closed.
1322  */
1323 {
1324     KIRQL OldIrql;
1325     PPRIVATE_CACHE_MAP PrivateMap;
1326     PROS_SHARED_CACHE_MAP SharedCacheMap;
1327
1328     KeAcquireGuardedMutex(&ViewLock);
1329
1330     if (FileObject->SectionObjectPointer->SharedCacheMap != NULL)
1331     {
1332         SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
1333
1334         /* Closing the handle, so kill the private cache map
1335          * Before you event try to remove it from FO, always
1336          * lock the master lock, to be sure not to race
1337          * with a potential read ahead ongoing!
1338          */
1339         OldIrql = KeAcquireQueuedSpinLock(LockQueueMasterLock);
1340         PrivateMap = FileObject->PrivateCacheMap;
1341         FileObject->PrivateCacheMap = NULL;
1342         KeReleaseQueuedSpinLock(LockQueueMasterLock, OldIrql);
1343
1344         if (PrivateMap != NULL)
1345         {
1346             /* Remove it from the file */
1347             KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &OldIrql);
1348             RemoveEntryList(&PrivateMap->PrivateLinks);
1349             KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, OldIrql);
1350
1351             /* And free it. */
1352             if (PrivateMap != &SharedCacheMap->PrivateCacheMap)
1353             {
1354                 ExFreePoolWithTag(PrivateMap, TAG_PRIVATE_CACHE_MAP);
1355             }
1356             else
1357             {
1358                 PrivateMap->NodeTypeCode = 0;
1359             }
1360
1361             if (SharedCacheMap->OpenCount > 0)
1362             {
1363                 SharedCacheMap->OpenCount--;
1364                 if (SharedCacheMap->OpenCount == 0)
1365                 {
1366                     MmFreeSectionSegments(SharedCacheMap->FileObject);
1367                     CcRosDeleteFileCache(FileObject, SharedCacheMap);
1368                 }
1369             }
1370         }
1371     }
1372     KeReleaseGuardedMutex(&ViewLock);
1373     return STATUS_SUCCESS;
1374 }
1375
1376 NTSTATUS
1377 NTAPI
1378 CcRosInitializeFileCache (
1379     PFILE_OBJECT FileObject,
1380     PCC_FILE_SIZES FileSizes,
1381     BOOLEAN PinAccess,
1382     PCACHE_MANAGER_CALLBACKS CallBacks,
1383     PVOID LazyWriterContext)
1384 /*
1385  * FUNCTION: Initializes a shared cache map for a file object
1386  */
1387 {
1388     KIRQL OldIrql;
1389     BOOLEAN Allocated;
1390     PROS_SHARED_CACHE_MAP SharedCacheMap;
1391
1392     DPRINT("CcRosInitializeFileCache(FileObject 0x%p)\n", FileObject);
1393
1394     Allocated = FALSE;
1395     SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
1396     if (SharedCacheMap == NULL)
1397     {
1398         Allocated = TRUE;
1399         SharedCacheMap = ExAllocateFromNPagedLookasideList(&SharedCacheMapLookasideList);
1400         if (SharedCacheMap == NULL)
1401         {
1402             return STATUS_INSUFFICIENT_RESOURCES;
1403         }
1404         RtlZeroMemory(SharedCacheMap, sizeof(*SharedCacheMap));
1405         SharedCacheMap->NodeTypeCode = NODE_TYPE_SHARED_MAP;
1406         SharedCacheMap->NodeByteSize = sizeof(*SharedCacheMap);
1407         SharedCacheMap->FileObject = FileObject;
1408         SharedCacheMap->Callbacks = CallBacks;
1409         SharedCacheMap->LazyWriteContext = LazyWriterContext;
1410         SharedCacheMap->SectionSize = FileSizes->AllocationSize;
1411         SharedCacheMap->FileSize = FileSizes->FileSize;
1412         SharedCacheMap->PinAccess = PinAccess;
1413         SharedCacheMap->DirtyPageThreshold = 0;
1414         SharedCacheMap->DirtyPages = 0;
1415         InitializeListHead(&SharedCacheMap->PrivateList);
1416         KeInitializeSpinLock(&SharedCacheMap->CacheMapLock);
1417         InitializeListHead(&SharedCacheMap->CacheMapVacbListHead);
1418         InitializeListHead(&SharedCacheMap->BcbList);
1419     }
1420
1421     KeAcquireGuardedMutex(&ViewLock);
1422     if (Allocated)
1423     {
1424         if (FileObject->SectionObjectPointer->SharedCacheMap == NULL)
1425         {
1426             ObReferenceObjectByPointer(FileObject,
1427                                        FILE_ALL_ACCESS,
1428                                        NULL,
1429                                        KernelMode);
1430             FileObject->SectionObjectPointer->SharedCacheMap = SharedCacheMap;
1431
1432             OldIrql = KeAcquireQueuedSpinLock(LockQueueMasterLock);
1433             InsertTailList(&CcCleanSharedCacheMapList, &SharedCacheMap->SharedCacheMapLinks);
1434             KeReleaseQueuedSpinLock(LockQueueMasterLock, OldIrql);
1435         }
1436         else
1437         {
1438             ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList, SharedCacheMap);
1439             SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
1440         }
1441     }
1442     if (FileObject->PrivateCacheMap == NULL)
1443     {
1444         PPRIVATE_CACHE_MAP PrivateMap;
1445
1446         /* Allocate the private cache map for this handle */
1447         if (SharedCacheMap->PrivateCacheMap.NodeTypeCode != 0)
1448         {
1449             PrivateMap = ExAllocatePoolWithTag(NonPagedPool, sizeof(PRIVATE_CACHE_MAP), TAG_PRIVATE_CACHE_MAP);
1450         }
1451         else
1452         {
1453             PrivateMap = &SharedCacheMap->PrivateCacheMap;
1454         }
1455
1456         if (PrivateMap == NULL)
1457         {
1458             /* If we also allocated the shared cache map for this file, kill it */
1459             if (Allocated)
1460             {
1461                 OldIrql = KeAcquireQueuedSpinLock(LockQueueMasterLock);
1462                 RemoveEntryList(&SharedCacheMap->SharedCacheMapLinks);
1463                 KeReleaseQueuedSpinLock(LockQueueMasterLock, OldIrql);
1464
1465                 FileObject->SectionObjectPointer->SharedCacheMap = NULL;
1466                 ObDereferenceObject(FileObject);
1467                 ExFreeToNPagedLookasideList(&SharedCacheMapLookasideList, SharedCacheMap);
1468             }
1469
1470             KeReleaseGuardedMutex(&ViewLock);
1471             return STATUS_INSUFFICIENT_RESOURCES;
1472         }
1473
1474         /* Initialize it */
1475         RtlZeroMemory(PrivateMap, sizeof(PRIVATE_CACHE_MAP));
1476         PrivateMap->NodeTypeCode = NODE_TYPE_PRIVATE_MAP;
1477         PrivateMap->ReadAheadMask = PAGE_SIZE - 1;
1478         PrivateMap->FileObject = FileObject;
1479         KeInitializeSpinLock(&PrivateMap->ReadAheadSpinLock);
1480
1481         /* Link it to the file */
1482         KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &OldIrql);
1483         InsertTailList(&SharedCacheMap->PrivateList, &PrivateMap->PrivateLinks);
1484         KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, OldIrql);
1485
1486         FileObject->PrivateCacheMap = PrivateMap;
1487         SharedCacheMap->OpenCount++;
1488     }
1489     KeReleaseGuardedMutex(&ViewLock);
1490
1491     return STATUS_SUCCESS;
1492 }
1493
1494 /*
1495  * @implemented
1496  */
1497 PFILE_OBJECT
1498 NTAPI
1499 CcGetFileObjectFromSectionPtrs (
1500     IN PSECTION_OBJECT_POINTERS SectionObjectPointers)
1501 {
1502     PROS_SHARED_CACHE_MAP SharedCacheMap;
1503
1504     CCTRACE(CC_API_DEBUG, "SectionObjectPointers=%p\n", SectionObjectPointers);
1505
1506     if (SectionObjectPointers && SectionObjectPointers->SharedCacheMap)
1507     {
1508         SharedCacheMap = SectionObjectPointers->SharedCacheMap;
1509         ASSERT(SharedCacheMap);
1510         return SharedCacheMap->FileObject;
1511     }
1512     return NULL;
1513 }
1514
1515 VOID
1516 INIT_FUNCTION
1517 NTAPI
1518 CcInitView (
1519     VOID)
1520 {
1521     DPRINT("CcInitView()\n");
1522
1523     InitializeListHead(&DirtyVacbListHead);
1524     InitializeListHead(&VacbLruListHead);
1525     InitializeListHead(&CcDeferredWrites);
1526     InitializeListHead(&CcCleanSharedCacheMapList);
1527     KeInitializeSpinLock(&CcDeferredWriteSpinLock);
1528     KeInitializeGuardedMutex(&ViewLock);
1529     ExInitializeNPagedLookasideList(&iBcbLookasideList,
1530                                     NULL,
1531                                     NULL,
1532                                     0,
1533                                     sizeof(INTERNAL_BCB),
1534                                     TAG_BCB,
1535                                     20);
1536     ExInitializeNPagedLookasideList(&SharedCacheMapLookasideList,
1537                                     NULL,
1538                                     NULL,
1539                                     0,
1540                                     sizeof(ROS_SHARED_CACHE_MAP),
1541                                     TAG_SHARED_CACHE_MAP,
1542                                     20);
1543     ExInitializeNPagedLookasideList(&VacbLookasideList,
1544                                     NULL,
1545                                     NULL,
1546                                     0,
1547                                     sizeof(ROS_VACB),
1548                                     TAG_VACB,
1549                                     20);
1550
1551     MmInitializeMemoryConsumer(MC_CACHE, CcRosTrimCache);
1552
1553     CcInitCacheZeroPage();
1554 }
1555
1556 #if DBG && defined(KDBG)
1557 BOOLEAN
1558 ExpKdbgExtFileCache(ULONG Argc, PCHAR Argv[])
1559 {
1560     PLIST_ENTRY ListEntry;
1561     UNICODE_STRING NoName = RTL_CONSTANT_STRING(L"No name for File");
1562
1563     KdbpPrint("  Usage Summary (in kb)\n");
1564     KdbpPrint("Shared\t\tValid\tDirty\tName\n");
1565     /* No need to lock the spin lock here, we're in DBG */
1566     for (ListEntry = CcCleanSharedCacheMapList.Flink;
1567          ListEntry != &CcCleanSharedCacheMapList;
1568          ListEntry = ListEntry->Flink)
1569     {
1570         PLIST_ENTRY Vacbs;
1571         ULONG Valid = 0, Dirty = 0;
1572         PROS_SHARED_CACHE_MAP SharedCacheMap;
1573         PUNICODE_STRING FileName;
1574         PWSTR Extra = L"";
1575
1576         SharedCacheMap = CONTAINING_RECORD(ListEntry, ROS_SHARED_CACHE_MAP, SharedCacheMapLinks);
1577
1578         /* Dirty size */
1579         Dirty = (SharedCacheMap->DirtyPages * PAGE_SIZE) / 1024;
1580
1581         /* First, count for all the associated VACB */
1582         for (Vacbs = SharedCacheMap->CacheMapVacbListHead.Flink;
1583              Vacbs != &SharedCacheMap->CacheMapVacbListHead;
1584              Vacbs = Vacbs->Flink)
1585         {
1586             PROS_VACB Vacb;
1587
1588             Vacb = CONTAINING_RECORD(Vacbs, ROS_VACB, CacheMapVacbListEntry);
1589             if (Vacb->Valid)
1590             {
1591                 Valid += VACB_MAPPING_GRANULARITY / 1024;
1592             }
1593         }
1594
1595         /* Setup name */
1596         if (SharedCacheMap->FileObject != NULL &&
1597             SharedCacheMap->FileObject->FileName.Length != 0)
1598         {
1599             FileName = &SharedCacheMap->FileObject->FileName;
1600         }
1601         else if (SharedCacheMap->FileObject != NULL &&
1602                  SharedCacheMap->FileObject->FsContext != NULL &&
1603                  ((PFSRTL_COMMON_FCB_HEADER)(SharedCacheMap->FileObject->FsContext))->NodeTypeCode == 0x0502 &&
1604                  ((PFSRTL_COMMON_FCB_HEADER)(SharedCacheMap->FileObject->FsContext))->NodeByteSize == 0x1F8 &&
1605                  ((PUNICODE_STRING)(((PUCHAR)SharedCacheMap->FileObject->FsContext) + 0x100))->Length != 0)
1606         {
1607             FileName = (PUNICODE_STRING)(((PUCHAR)SharedCacheMap->FileObject->FsContext) + 0x100);
1608             Extra = L" (FastFAT)";
1609         }
1610         else
1611         {
1612             FileName = &NoName;
1613         }
1614
1615         /* And print */
1616         KdbpPrint("%p\t%d\t%d\t%wZ%S\n", SharedCacheMap, Valid, Dirty, FileName, Extra);
1617     }
1618
1619     return TRUE;
1620 }
1621
1622 BOOLEAN
1623 ExpKdbgExtDefWrites(ULONG Argc, PCHAR Argv[])
1624 {
1625     KdbpPrint("CcTotalDirtyPages:\t%lu (%lu Kb)\n", CcTotalDirtyPages,
1626               (CcTotalDirtyPages * PAGE_SIZE) / 1024);
1627     KdbpPrint("CcDirtyPageThreshold:\t%lu (%lu Kb)\n", CcDirtyPageThreshold,
1628               (CcDirtyPageThreshold * PAGE_SIZE) / 1024);
1629     KdbpPrint("MmAvailablePages:\t%lu (%lu Kb)\n", MmAvailablePages,
1630               (MmAvailablePages * PAGE_SIZE) / 1024);
1631     KdbpPrint("MmThrottleTop:\t\t%lu (%lu Kb)\n", MmThrottleTop,
1632               (MmThrottleTop * PAGE_SIZE) / 1024);
1633     KdbpPrint("MmThrottleBottom:\t%lu (%lu Kb)\n", MmThrottleBottom,
1634               (MmThrottleBottom * PAGE_SIZE) / 1024);
1635     KdbpPrint("MmModifiedPageListHead.Total:\t%lu (%lu Kb)\n", MmModifiedPageListHead.Total,
1636               (MmModifiedPageListHead.Total * PAGE_SIZE) / 1024);
1637
1638     if (CcTotalDirtyPages >= CcDirtyPageThreshold)
1639     {
1640         KdbpPrint("CcTotalDirtyPages above the threshold, writes should be throttled\n");
1641     }
1642     else if (CcTotalDirtyPages + 64 >= CcDirtyPageThreshold)
1643     {
1644         KdbpPrint("CcTotalDirtyPages within 64 (max charge) pages of the threshold, writes may be throttled\n");
1645     }
1646     else
1647     {
1648         KdbpPrint("CcTotalDirtyPages below the threshold, writes should not be throttled\n");
1649     }
1650
1651     return TRUE;
1652 }
1653 #endif
1654
1655 /* EOF */