reactos/ntoskrnl/cc/fs.c

   1 /*
   2  * COPYRIGHT:       See COPYING in the top level directory
   3  * PROJECT:         ReactOS kernel
   4  * FILE:            ntoskrnl/cc/fs.c
   5  * PURPOSE:         Implements cache managers functions useful for File Systems
   6  *
   7  * PROGRAMMERS:     Alex Ionescu
   8  */
   9
  10 /* INCLUDES ******************************************************************/
  11
  12 #include <ntoskrnl.h>
  13 #define NDEBUG
  14 #include <debug.h>
  15
  16 #ifndef VACB_MAPPING_GRANULARITY
  17 #define VACB_MAPPING_GRANULARITY (256 * 1024)
  18 #endif
  19
  20 /* GLOBALS   *****************************************************************/
  21
  22 extern KGUARDED_MUTEX ViewLock;
  23 extern ULONG DirtyPageCount;
  24
  25 NTSTATUS CcRosInternalFreeVacb(PROS_VACB Vacb);
  26
  27 /* FUNCTIONS *****************************************************************/
  28
  29 /*
  30  * @unimplemented
  31  */
  32 LARGE_INTEGER
  33 NTAPI
  34 CcGetDirtyPages (
  35     IN PVOID LogHandle,
  36     IN PDIRTY_PAGE_ROUTINE DirtyPageRoutine,
  37     IN PVOID Context1,
  38     IN PVOID Context2)
  39 {
  40     LARGE_INTEGER i;
  41
  42     CCTRACE(CC_API_DEBUG, "LogHandle=%p DirtyPageRoutine=%p Context1=%p Context2=%p\n",
  43         LogHandle, DirtyPageRoutine, Context1, Context2);
  44
  45     UNIMPLEMENTED;
  46     i.QuadPart = 0;
  47     return i;
  48 }
  49
  50 /*
  51  * @implemented
  52  */
  53 PFILE_OBJECT
  54 NTAPI
  55 CcGetFileObjectFromBcb (
  56     IN PVOID Bcb)
  57 {
  58     PINTERNAL_BCB iBcb = (PINTERNAL_BCB)Bcb;
  59
  60     CCTRACE(CC_API_DEBUG, "Bcb=%p\n", Bcb);
  61
  62     return iBcb->Vacb->SharedCacheMap->FileObject;
  63 }
  64
  65 /*
  66  * @unimplemented
  67  */
  68 LARGE_INTEGER
  69 NTAPI
  70 CcGetLsnForFileObject (
  71     IN PFILE_OBJECT FileObject,
  72     OUT PLARGE_INTEGER OldestLsn OPTIONAL)
  73 {
  74     LARGE_INTEGER i;
  75
  76     CCTRACE(CC_API_DEBUG, "FileObject=%p\n", FileObject);
  77
  78     UNIMPLEMENTED;
  79     i.QuadPart = 0;
  80     return i;
  81 }
  82
  83 /*
  84  * @unimplemented
  85  */
  86 VOID
  87 NTAPI
  88 CcInitializeCacheMap (
  89     IN PFILE_OBJECT FileObject,
  90     IN PCC_FILE_SIZES FileSizes,
  91     IN BOOLEAN PinAccess,
  92     IN PCACHE_MANAGER_CALLBACKS CallBacks,
  93     IN PVOID LazyWriterContext)
  94 {
  95     NTSTATUS Status;
  96
  97     ASSERT(FileObject);
  98     ASSERT(FileSizes);
  99
 100     CCTRACE(CC_API_DEBUG, "FileObject=%p FileSizes=%p PinAccess=%d CallBacks=%p LazyWriterContext=%p\n",
 101         FileObject, FileSizes, PinAccess, CallBacks, LazyWriterContext);
 102
 103     /* Call old ROS cache init function */
 104     Status = CcRosInitializeFileCache(FileObject,
 105                                       FileSizes,
 106                                       PinAccess,
 107                                       CallBacks,
 108                                       LazyWriterContext);
 109     if (!NT_SUCCESS(Status))
 110         ExRaiseStatus(Status);
 111 }
 112
 113 /*
 114  * @unimplemented
 115  */
 116 BOOLEAN
 117 NTAPI
 118 CcIsThereDirtyData (
 119     IN PVPB Vpb)
 120 {
 121     CCTRACE(CC_API_DEBUG, "Vpb=%p\n", Vpb);
 122
 123     UNIMPLEMENTED;
 124     return FALSE;
 125 }
 126
 127 /*
 128  * @unimplemented
 129  */
 130 BOOLEAN
 131 NTAPI
 132 CcPurgeCacheSection (
 133     IN PSECTION_OBJECT_POINTERS SectionObjectPointer,
 134     IN PLARGE_INTEGER FileOffset OPTIONAL,
 135     IN ULONG Length,
 136     IN BOOLEAN UninitializeCacheMaps)
 137 {
 138     PROS_SHARED_CACHE_MAP SharedCacheMap;
 139     LONGLONG StartOffset;
 140     LONGLONG EndOffset;
 141     LIST_ENTRY FreeList;
 142     KIRQL OldIrql;
 143     PLIST_ENTRY ListEntry;
 144     PROS_VACB Vacb;
 145     LONGLONG ViewEnd;
 146
 147     CCTRACE(CC_API_DEBUG, "SectionObjectPointer=%p\n FileOffset=%p Length=%lu UninitializeCacheMaps=%d",
 148         SectionObjectPointer, FileOffset, Length, UninitializeCacheMaps);
 149
 150     if (UninitializeCacheMaps)
 151     {
 152         DPRINT1("FIXME: CcPurgeCacheSection not uninitializing private cache maps\n");
 153     }
 154
 155     SharedCacheMap = SectionObjectPointer->SharedCacheMap;
 156
 157     StartOffset = FileOffset != NULL ? FileOffset->QuadPart : 0;
 158     if (Length == 0 || FileOffset == NULL)
 159     {
 160         EndOffset = MAXLONGLONG;
 161     }
 162     else
 163     {
 164         EndOffset = StartOffset + Length;
 165         ASSERT(EndOffset > StartOffset);
 166     }
 167
 168     InitializeListHead(&FreeList);
 169
 170     KeAcquireGuardedMutex(&ViewLock);
 171     KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &OldIrql);
 172     ListEntry = SharedCacheMap->CacheMapVacbListHead.Flink;
 173     while (ListEntry != &SharedCacheMap->CacheMapVacbListHead)
 174     {
 175         Vacb = CONTAINING_RECORD(ListEntry, ROS_VACB, CacheMapVacbListEntry);
 176         ListEntry = ListEntry->Flink;
 177
 178         /* Skip VACBs outside the range, or only partially in range */
 179         if (Vacb->FileOffset.QuadPart < StartOffset)
 180         {
 181             continue;
 182         }
 183         ViewEnd = min(Vacb->FileOffset.QuadPart + VACB_MAPPING_GRANULARITY,
 184                       SharedCacheMap->SectionSize.QuadPart);
 185         if (ViewEnd >= EndOffset)
 186         {
 187             break;
 188         }
 189
 190         ASSERT((Vacb->ReferenceCount == 0) ||
 191                (Vacb->ReferenceCount == 1 && Vacb->Dirty));
 192
 193         /* This VACB is in range, so unlink it and mark for free */
 194         RemoveEntryList(&Vacb->VacbLruListEntry);
 195         if (Vacb->Dirty)
 196         {
 197             RemoveEntryList(&Vacb->DirtyVacbListEntry);
 198             DirtyPageCount -= VACB_MAPPING_GRANULARITY / PAGE_SIZE;
 199         }
 200         RemoveEntryList(&Vacb->CacheMapVacbListEntry);
 201         InsertHeadList(&FreeList, &Vacb->CacheMapVacbListEntry);
 202     }
 203     KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, OldIrql);
 204     KeReleaseGuardedMutex(&ViewLock);
 205
 206     while (!IsListEmpty(&FreeList))
 207     {
 208         Vacb = CONTAINING_RECORD(RemoveHeadList(&FreeList),
 209                                  ROS_VACB,
 210                                  CacheMapVacbListEntry);
 211         CcRosInternalFreeVacb(Vacb);
 212     }
 213
 214     return FALSE;
 215 }
 216
 217
 218 /*
 219  * @implemented
 220  */
 221 VOID NTAPI
 222 CcSetFileSizes (
 223     IN PFILE_OBJECT FileObject,
 224     IN PCC_FILE_SIZES FileSizes)
 225 {
 226     KIRQL oldirql;
 227     PROS_SHARED_CACHE_MAP SharedCacheMap;
 228     PLIST_ENTRY current_entry;
 229     PROS_VACB current;
 230     LIST_ENTRY FreeListHead;
 231     NTSTATUS Status;
 232
 233     CCTRACE(CC_API_DEBUG, "FileObject=%p FileSizes=%p\n",
 234         FileObject, FileSizes);
 235
 236     DPRINT("CcSetFileSizes(FileObject 0x%p, FileSizes 0x%p)\n",
 237            FileObject, FileSizes);
 238     DPRINT("AllocationSize %I64d, FileSize %I64d, ValidDataLength %I64d\n",
 239            FileSizes->AllocationSize.QuadPart,
 240            FileSizes->FileSize.QuadPart,
 241            FileSizes->ValidDataLength.QuadPart);
 242
 243     SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
 244
 245     /*
 246      * It is valid to call this function on file objects that weren't
 247      * initialized for caching. In this case it's simple no-op.
 248      */
 249     if (SharedCacheMap == NULL)
 250         return;
 251
 252     if (FileSizes->AllocationSize.QuadPart < SharedCacheMap->SectionSize.QuadPart)
 253     {
 254         InitializeListHead(&FreeListHead);
 255         KeAcquireGuardedMutex(&ViewLock);
 256         KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldirql);
 257
 258         current_entry = SharedCacheMap->CacheMapVacbListHead.Flink;
 259         while (current_entry != &SharedCacheMap->CacheMapVacbListHead)
 260         {
 261             current = CONTAINING_RECORD(current_entry,
 262                                         ROS_VACB,
 263                                         CacheMapVacbListEntry);
 264             current_entry = current_entry->Flink;
 265             if (current->FileOffset.QuadPart >= FileSizes->AllocationSize.QuadPart)
 266             {
 267                 if ((current->ReferenceCount == 0) || ((current->ReferenceCount == 1) && current->Dirty))
 268                 {
 269                     RemoveEntryList(&current->CacheMapVacbListEntry);
 270                     RemoveEntryList(&current->VacbLruListEntry);
 271                     if (current->Dirty)
 272                     {
 273                         RemoveEntryList(&current->DirtyVacbListEntry);
 274                         DirtyPageCount -= VACB_MAPPING_GRANULARITY / PAGE_SIZE;
 275                     }
 276                     InsertHeadList(&FreeListHead, &current->CacheMapVacbListEntry);
 277                 }
 278                 else
 279                 {
 280                     DPRINT1("Someone has referenced a VACB behind the new size.\n");
 281                     KeBugCheck(CACHE_MANAGER);
 282                 }
 283             }
 284         }
 285
 286         SharedCacheMap->SectionSize = FileSizes->AllocationSize;
 287         SharedCacheMap->FileSize = FileSizes->FileSize;
 288         KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldirql);
 289         KeReleaseGuardedMutex(&ViewLock);
 290
 291         current_entry = FreeListHead.Flink;
 292         while(current_entry != &FreeListHead)
 293         {
 294             current = CONTAINING_RECORD(current_entry, ROS_VACB, CacheMapVacbListEntry);
 295             current_entry = current_entry->Flink;
 296             Status = CcRosInternalFreeVacb(current);
 297             if (!NT_SUCCESS(Status))
 298             {
 299                 DPRINT1("CcRosInternalFreeVacb failed, status = %x\n", Status);
 300                 KeBugCheck(CACHE_MANAGER);
 301             }
 302         }
 303     }
 304     else
 305     {
 306         KeAcquireSpinLock(&SharedCacheMap->CacheMapLock, &oldirql);
 307         SharedCacheMap->SectionSize = FileSizes->AllocationSize;
 308         SharedCacheMap->FileSize = FileSizes->FileSize;
 309         KeReleaseSpinLock(&SharedCacheMap->CacheMapLock, oldirql);
 310     }
 311 }
 312
 313 /*
 314  * @unimplemented
 315  */
 316 VOID
 317 NTAPI
 318 CcSetLogHandleForFile (
 319     IN PFILE_OBJECT FileObject,
 320     IN PVOID LogHandle,
 321     IN PFLUSH_TO_LSN FlushToLsnRoutine)
 322 {
 323     CCTRACE(CC_API_DEBUG, "FileObject=%p LogHandle=%p FlushToLsnRoutine=%p\n",
 324         FileObject, LogHandle, FlushToLsnRoutine);
 325
 326     UNIMPLEMENTED;
 327 }
 328
 329 /*
 330  * @unimplemented
 331  */
 332 BOOLEAN
 333 NTAPI
 334 CcUninitializeCacheMap (
 335     IN PFILE_OBJECT FileObject,
 336     IN PLARGE_INTEGER TruncateSize OPTIONAL,
 337     IN PCACHE_UNINITIALIZE_EVENT UninitializeCompleteEvent OPTIONAL)
 338 {
 339     NTSTATUS Status;
 340
 341     CCTRACE(CC_API_DEBUG, "FileObject=%p TruncateSize=%p UninitializeCompleteEvent=%p\n",
 342         FileObject, TruncateSize, UninitializeCompleteEvent);
 343
 344     Status = CcRosReleaseFileCache(FileObject);
 345     if (UninitializeCompleteEvent)
 346         KeSetEvent(&UninitializeCompleteEvent->Event, IO_NO_INCREMENT, FALSE);
 347     return NT_SUCCESS(Status);
 348 }
 349
 350 BOOLEAN
 351 NTAPI
 352 CcGetFileSizes (
 353     IN PFILE_OBJECT FileObject,
 354     IN PCC_FILE_SIZES FileSizes)
 355 {
 356     PROS_SHARED_CACHE_MAP SharedCacheMap;
 357
 358     SharedCacheMap = FileObject->SectionObjectPointer->SharedCacheMap;
 359
 360     if (!SharedCacheMap)
 361         return FALSE;
 362
 363     FileSizes->AllocationSize = SharedCacheMap->SectionSize;
 364     FileSizes->FileSize = FileSizes->ValidDataLength = SharedCacheMap->FileSize;
 365     return TRUE;
 366 }