modules/rostests/kmtests/ntos_cc/CcPinRead_drv.c

   1 /*
   2  * PROJECT:         ReactOS kernel-mode tests
   3  * LICENSE:         LGPLv2.1+ - See COPYING.LIB in the top level directory
   4  * PURPOSE:         Test driver for CcPinRead function
   5  * PROGRAMMER:      Pierre Schweitzer <pierre@reactos.org>
   6  */
   7
   8 #include <kmt_test.h>
   9
  10 #define NDEBUG
  11 #include <debug.h>
  12
  13 #define IOCTL_START_TEST  1
  14 #define IOCTL_FINISH_TEST 2
  15
  16 typedef struct _TEST_FCB
  17 {
  18     FSRTL_ADVANCED_FCB_HEADER Header;
  19     SECTION_OBJECT_POINTERS SectionObjectPointers;
  20     FAST_MUTEX HeaderMutex;
  21 } TEST_FCB, *PTEST_FCB;
  22
  23 typedef struct _TEST_CONTEXT
  24 {
  25     PVOID Bcb;
  26     PVOID Buffer;
  27     ULONG Length;
  28 } TEST_CONTEXT, *PTEST_CONTEXT;
  29
  30 static ULONG TestTestId = -1;
  31 static PFILE_OBJECT TestFileObject;
  32 static PDEVICE_OBJECT TestDeviceObject;
  33 static KMT_IRP_HANDLER TestIrpHandler;
  34 static KMT_MESSAGE_HANDLER TestMessageHandler;
  35
  36 NTSTATUS
  37 TestEntry(
  38     _In_ PDRIVER_OBJECT DriverObject,
  39     _In_ PCUNICODE_STRING RegistryPath,
  40     _Out_ PCWSTR *DeviceName,
  41     _Inout_ INT *Flags)
  42 {
  43     NTSTATUS Status = STATUS_SUCCESS;
  44
  45     PAGED_CODE();
  46
  47     UNREFERENCED_PARAMETER(RegistryPath);
  48
  49     *DeviceName = L"CcPinRead";
  50     *Flags = TESTENTRY_NO_EXCLUSIVE_DEVICE |
  51              TESTENTRY_BUFFERED_IO_DEVICE |
  52              TESTENTRY_NO_READONLY_DEVICE;
  53
  54     KmtRegisterIrpHandler(IRP_MJ_READ, NULL, TestIrpHandler);
  55     KmtRegisterMessageHandler(0, NULL, TestMessageHandler);
  56
  57
  58     return Status;
  59 }
  60
  61 VOID
  62 TestUnload(
  63     _In_ PDRIVER_OBJECT DriverObject)
  64 {
  65     PAGED_CODE();
  66 }
  67
  68 BOOLEAN
  69 NTAPI
  70 AcquireForLazyWrite(
  71     _In_ PVOID Context,
  72     _In_ BOOLEAN Wait)
  73 {
  74     return TRUE;
  75 }
  76
  77 VOID
  78 NTAPI
  79 ReleaseFromLazyWrite(
  80     _In_ PVOID Context)
  81 {
  82     return;
  83 }
  84
  85 BOOLEAN
  86 NTAPI
  87 AcquireForReadAhead(
  88     _In_ PVOID Context,
  89     _In_ BOOLEAN Wait)
  90 {
  91     return TRUE;
  92 }
  93
  94 VOID
  95 NTAPI
  96 ReleaseFromReadAhead(
  97     _In_ PVOID Context)
  98 {
  99     return;
 100 }
 101
 102 static CACHE_MANAGER_CALLBACKS Callbacks = {
 103     AcquireForLazyWrite,
 104     ReleaseFromLazyWrite,
 105     AcquireForReadAhead,
 106     ReleaseFromReadAhead,
 107 };
 108
 109 static CC_FILE_SIZES FileSizes = {
 110     RTL_CONSTANT_LARGE_INTEGER((LONGLONG)0x4000), // .AllocationSize
 111     RTL_CONSTANT_LARGE_INTEGER((LONGLONG)0x4000), // .FileSize
 112     RTL_CONSTANT_LARGE_INTEGER((LONGLONG)0x4000)  // .ValidDataLength
 113 };
 114
 115 static
 116 PVOID
 117 MapAndLockUserBuffer(
 118     _In_ _Out_ PIRP Irp,
 119     _In_ ULONG BufferLength)
 120 {
 121     PMDL Mdl;
 122
 123     if (Irp->MdlAddress == NULL)
 124     {
 125         Mdl = IoAllocateMdl(Irp->UserBuffer, BufferLength, FALSE, FALSE, Irp);
 126         if (Mdl == NULL)
 127         {
 128             return NULL;
 129         }
 130
 131         _SEH2_TRY
 132         {
 133             MmProbeAndLockPages(Mdl, Irp->RequestorMode, IoWriteAccess);
 134         }
 135         _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
 136         {
 137             IoFreeMdl(Mdl);
 138             Irp->MdlAddress = NULL;
 139             _SEH2_YIELD(return NULL);
 140         }
 141         _SEH2_END;
 142     }
 143
 144     return MmGetSystemAddressForMdlSafe(Irp->MdlAddress, NormalPagePriority);
 145 }
 146
 147 static
 148 VOID
 149 NTAPI
 150 PinInAnotherThread(IN PVOID Context)
 151 {
 152     BOOLEAN Ret;
 153     PULONG Buffer;
 154     PVOID Bcb;
 155     LARGE_INTEGER Offset;
 156     PTEST_CONTEXT TestContext;
 157
 158     ok(TestFileObject != NULL, "Called in invalid context!\n");
 159     ok_eq_ulong(TestTestId, 3);
 160
 161     TestContext = Context;
 162     ok(TestContext != NULL, "Called in invalid context!\n");
 163     ok(TestContext->Bcb != NULL, "Called in invalid context!\n");
 164     ok(TestContext->Buffer != NULL, "Called in invalid context!\n");
 165     ok(TestContext->Length != 0, "Called in invalid context!\n");
 166
 167     Ret = FALSE;
 168     Offset.QuadPart = 0x1000;
 169     KmtStartSeh();
 170     Ret = CcPinRead(TestFileObject, &Offset, TestContext->Length, PIN_WAIT, &Bcb, (PVOID *)&Buffer);
 171     KmtEndSeh(STATUS_SUCCESS);
 172
 173     if (!skip(Ret == TRUE, "CcPinRead failed\n"))
 174     {
 175         ok_eq_pointer(Bcb, TestContext->Bcb);
 176         ok_eq_pointer(Buffer, TestContext->Buffer);
 177
 178         CcUnpinData(Bcb);
 179     }
 180
 181     KmtStartSeh();
 182     Ret = CcPinRead(TestFileObject, &Offset, TestContext->Length, PIN_WAIT | PIN_IF_BCB, &Bcb, (PVOID *)&Buffer);
 183     KmtEndSeh(STATUS_SUCCESS);
 184
 185     if (!skip(Ret == TRUE, "CcPinRead failed\n"))
 186     {
 187         ok_eq_pointer(Bcb, TestContext->Bcb);
 188         ok_eq_pointer(Buffer, TestContext->Buffer);
 189
 190         CcUnpinData(Bcb);
 191     }
 192
 193     return;
 194 }
 195
 196 static
 197 VOID
 198 PerformTest(
 199     ULONG TestId,
 200     PDEVICE_OBJECT DeviceObject)
 201 {
 202     PVOID Bcb;
 203     BOOLEAN Ret;
 204     PULONG Buffer;
 205     PTEST_FCB Fcb;
 206     LARGE_INTEGER Offset;
 207
 208     ok_eq_pointer(TestFileObject, NULL);
 209     ok_eq_pointer(TestDeviceObject, NULL);
 210     ok_eq_ulong(TestTestId, -1);
 211
 212     TestDeviceObject = DeviceObject;
 213     TestTestId = TestId;
 214     TestFileObject = IoCreateStreamFileObject(NULL, DeviceObject);
 215     if (!skip(TestFileObject != NULL, "Failed to allocate FO\n"))
 216     {
 217         Fcb = ExAllocatePool(NonPagedPool, sizeof(TEST_FCB));
 218         if (!skip(Fcb != NULL, "ExAllocatePool failed\n"))
 219         {
 220             RtlZeroMemory(Fcb, sizeof(TEST_FCB));
 221             ExInitializeFastMutex(&Fcb->HeaderMutex);
 222             FsRtlSetupAdvancedHeader(&Fcb->Header, &Fcb->HeaderMutex);
 223
 224             TestFileObject->FsContext = Fcb;
 225             TestFileObject->SectionObjectPointer = &Fcb->SectionObjectPointers;
 226
 227             KmtStartSeh();
 228             CcInitializeCacheMap(TestFileObject, &FileSizes, TRUE, &Callbacks, NULL);
 229             KmtEndSeh(STATUS_SUCCESS);
 230
 231             if (!skip(CcIsFileCached(TestFileObject) == TRUE, "CcInitializeCacheMap failed\n"))
 232             {
 233                 if (TestId < 3)
 234                 {
 235                     Ret = FALSE;
 236                     Offset.QuadPart = TestId * 0x1000;
 237                     KmtStartSeh();
 238                     Ret = CcPinRead(TestFileObject, &Offset, FileSizes.FileSize.QuadPart - Offset.QuadPart, PIN_WAIT, &Bcb, (PVOID *)&Buffer);
 239                     KmtEndSeh(STATUS_SUCCESS);
 240
 241                     if (!skip(Ret == TRUE, "CcPinRead failed\n"))
 242                     {
 243                         ok_eq_ulong(Buffer[(0x3000 - TestId * 0x1000) / sizeof(ULONG)], 0xDEADBABE);
 244
 245                         CcUnpinData(Bcb);
 246                     }
 247                 }
 248                 else if (TestId == 3)
 249                 {
 250                     PTEST_CONTEXT TestContext;
 251
 252                     TestContext = ExAllocatePool(NonPagedPool, sizeof(TEST_CONTEXT));
 253                     if (!skip(Fcb != NULL, "ExAllocatePool failed\n"))
 254                     {
 255                         Ret = FALSE;
 256                         Offset.QuadPart = 0x1000;
 257
 258                         /* Try enforce BCB first */
 259                         KmtStartSeh();
 260                         Ret = CcPinRead(TestFileObject, &Offset, FileSizes.FileSize.QuadPart - Offset.QuadPart, PIN_WAIT | PIN_IF_BCB, &Bcb, (PVOID *)&Buffer);
 261                         KmtEndSeh(STATUS_SUCCESS);
 262                         ok(Ret == FALSE, "CcPinRead succeed\n");
 263                         if (Ret)
 264                         {
 265                             CcUnpinData(Bcb);
 266                         }
 267
 268                         KmtStartSeh();
 269                         Ret = CcPinRead(TestFileObject, &Offset, FileSizes.FileSize.QuadPart - Offset.QuadPart, PIN_WAIT, &TestContext->Bcb, &TestContext->Buffer);
 270                         KmtEndSeh(STATUS_SUCCESS);
 271
 272                         if (!skip(Ret == TRUE, "CcPinRead failed\n"))
 273                         {
 274                             PKTHREAD ThreadHandle;
 275
 276 #ifdef _X86_
 277                             /* FIXME: Should be fixed, will fail under certains conditions */
 278                             ok(TestContext->Buffer > (PVOID)0xC1000000 && TestContext->Buffer < (PVOID)0xDCFFFFFF,
 279                                "Buffer %p not mapped in system space\n", TestContext->Buffer);
 280 #else
 281 #ifdef _M_AMD64
 282                             ok(TestContext->Buffer > (PVOID)0xFFFFF98000000000 && TestContext->Buffer < (PVOID)0xFFFFFA8000000000,
 283                                "Buffer %p not mapped in system space\n", TestContext->Buffer);
 284 #else
 285                             skip(FALSE, "System space mapping not defined\n");
 286 #endif
 287 #endif
 288
 289                             TestContext->Length = FileSizes.FileSize.QuadPart - Offset.QuadPart;
 290                             ThreadHandle = KmtStartThread(PinInAnotherThread, TestContext);
 291                             KmtFinishThread(ThreadHandle, NULL);
 292
 293                             TestContext->Length = FileSizes.FileSize.QuadPart - 2 * Offset.QuadPart;
 294                             ThreadHandle = KmtStartThread(PinInAnotherThread, TestContext);
 295                             KmtFinishThread(ThreadHandle, NULL);
 296
 297                             CcUnpinData(TestContext->Bcb);
 298                         }
 299
 300                         ExFreePool(TestContext);
 301                     }
 302                 }
 303             }
 304         }
 305     }
 306 }
 307
 308
 309 static
 310 VOID
 311 CleanupTest(
 312     ULONG TestId,
 313     PDEVICE_OBJECT DeviceObject)
 314 {
 315     LARGE_INTEGER Zero = RTL_CONSTANT_LARGE_INTEGER(0LL);
 316     CACHE_UNINITIALIZE_EVENT CacheUninitEvent;
 317
 318     ok_eq_pointer(TestDeviceObject, DeviceObject);
 319     ok_eq_ulong(TestTestId, TestId);
 320
 321     if (!skip(TestFileObject != NULL, "No test FO\n"))
 322     {
 323         if (CcIsFileCached(TestFileObject))
 324         {
 325             KeInitializeEvent(&CacheUninitEvent.Event, NotificationEvent, FALSE);
 326             CcUninitializeCacheMap(TestFileObject, &Zero, &CacheUninitEvent);
 327             KeWaitForSingleObject(&CacheUninitEvent.Event, Executive, KernelMode, FALSE, NULL);
 328         }
 329
 330         if (TestFileObject->FsContext != NULL)
 331         {
 332             ExFreePool(TestFileObject->FsContext);
 333             TestFileObject->FsContext = NULL;
 334             TestFileObject->SectionObjectPointer = NULL;
 335         }
 336
 337         ObDereferenceObject(TestFileObject);
 338     }
 339
 340     TestFileObject = NULL;
 341     TestDeviceObject = NULL;
 342     TestTestId = -1;
 343 }
 344
 345
 346 static
 347 NTSTATUS
 348 TestMessageHandler(
 349     _In_ PDEVICE_OBJECT DeviceObject,
 350     _In_ ULONG ControlCode,
 351     _In_opt_ PVOID Buffer,
 352     _In_ SIZE_T InLength,
 353     _Inout_ PSIZE_T OutLength)
 354 {
 355     NTSTATUS Status = STATUS_SUCCESS;
 356
 357     FsRtlEnterFileSystem();
 358
 359     switch (ControlCode)
 360     {
 361         case IOCTL_START_TEST:
 362             ok_eq_ulong((ULONG)InLength, sizeof(ULONG));
 363             PerformTest(*(PULONG)Buffer, DeviceObject);
 364             break;
 365
 366         case IOCTL_FINISH_TEST:
 367             ok_eq_ulong((ULONG)InLength, sizeof(ULONG));
 368             CleanupTest(*(PULONG)Buffer, DeviceObject);
 369             break;
 370
 371         default:
 372             Status = STATUS_NOT_IMPLEMENTED;
 373             break;
 374     }
 375
 376     FsRtlExitFileSystem();
 377
 378     return Status;
 379 }
 380
 381 static
 382 NTSTATUS
 383 TestIrpHandler(
 384     _In_ PDEVICE_OBJECT DeviceObject,
 385     _In_ PIRP Irp,
 386     _In_ PIO_STACK_LOCATION IoStack)
 387 {
 388     NTSTATUS Status;
 389
 390     PAGED_CODE();
 391
 392     DPRINT("IRP %x/%x\n", IoStack->MajorFunction, IoStack->MinorFunction);
 393     ASSERT(IoStack->MajorFunction == IRP_MJ_READ);
 394
 395     FsRtlEnterFileSystem();
 396
 397     Status = STATUS_NOT_SUPPORTED;
 398     Irp->IoStatus.Information = 0;
 399
 400     if (IoStack->MajorFunction == IRP_MJ_READ)
 401     {
 402         PMDL Mdl;
 403         ULONG Length;
 404         PVOID Buffer;
 405         LARGE_INTEGER Offset;
 406
 407         Offset = IoStack->Parameters.Read.ByteOffset;
 408         Length = IoStack->Parameters.Read.Length;
 409
 410         ok_eq_pointer(DeviceObject, TestDeviceObject);
 411         ok_eq_pointer(IoStack->FileObject, TestFileObject);
 412
 413         ok(FlagOn(Irp->Flags, IRP_NOCACHE), "Not coming from Cc\n");
 414
 415         ok_irql(APC_LEVEL);
 416         ok((Offset.QuadPart % PAGE_SIZE == 0 || Offset.QuadPart == 0), "Offset is not aligned: %I64i\n", Offset.QuadPart);
 417         ok(Length % PAGE_SIZE == 0, "Length is not aligned: %I64i\n", Length);
 418
 419         ok(Irp->AssociatedIrp.SystemBuffer == NULL, "A SystemBuffer was allocated!\n");
 420         Buffer = MapAndLockUserBuffer(Irp, Length);
 421         ok(Buffer != NULL, "Null pointer!\n");
 422         RtlFillMemory(Buffer, Length, 0xBA);
 423
 424         Status = STATUS_SUCCESS;
 425         if (Offset.QuadPart <= 0x3000 && Offset.QuadPart + Length > 0x3000)
 426         {
 427             *(PULONG)((ULONG_PTR)Buffer + (ULONG_PTR)(0x3000 - Offset.QuadPart)) = 0xDEADBABE;
 428         }
 429
 430         Mdl = Irp->MdlAddress;
 431         ok(Mdl != NULL, "Null pointer for MDL!\n");
 432         ok((Mdl->MdlFlags & MDL_PAGES_LOCKED) != 0, "MDL not locked\n");
 433         ok((Mdl->MdlFlags & MDL_SOURCE_IS_NONPAGED_POOL) == 0, "MDL from non paged\n");
 434         ok((Mdl->MdlFlags & MDL_IO_PAGE_READ) != 0, "Non paging IO\n");
 435         ok((Irp->Flags & IRP_PAGING_IO) != 0, "Non paging IO\n");
 436
 437         Irp->IoStatus.Information = Length;
 438     }
 439
 440     if (Status == STATUS_PENDING)
 441     {
 442         IoMarkIrpPending(Irp);
 443         IoCompleteRequest(Irp, IO_NO_INCREMENT);
 444         Status = STATUS_PENDING;
 445     }
 446     else
 447     {
 448         Irp->IoStatus.Status = Status;
 449         IoCompleteRequest(Irp, IO_NO_INCREMENT);
 450     }
 451
 452     FsRtlExitFileSystem();
 453
 454     return Status;
 455 }