modules/rostests/kmtests/ntos_cc/CcMapData_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 CcMapData 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"CcMapData";
  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 MapInAnotherThread(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 = CcMapData(TestFileObject, &Offset, TestContext->Length, MAP_WAIT, &Bcb, (PVOID *)&Buffer);
 171     KmtEndSeh(STATUS_SUCCESS);
 172
 173     if (!skip(Ret == TRUE, "CcMapData failed\n"))
 174     {
 175         ok_eq_pointer(Bcb, TestContext->Bcb);
 176         ok_eq_pointer(Buffer, TestContext->Buffer);
 177
 178         CcUnpinData(Bcb);
 179     }
 180
 181     return;
 182 }
 183
 184 static
 185 VOID
 186 PerformTest(
 187     ULONG TestId,
 188     PDEVICE_OBJECT DeviceObject)
 189 {
 190     PVOID Bcb;
 191     BOOLEAN Ret;
 192     PULONG Buffer;
 193     PTEST_FCB Fcb;
 194     LARGE_INTEGER Offset;
 195
 196     ok_eq_pointer(TestFileObject, NULL);
 197     ok_eq_pointer(TestDeviceObject, NULL);
 198     ok_eq_ulong(TestTestId, -1);
 199
 200     TestDeviceObject = DeviceObject;
 201     TestTestId = TestId;
 202     TestFileObject = IoCreateStreamFileObject(NULL, DeviceObject);
 203     if (!skip(TestFileObject != NULL, "Failed to allocate FO\n"))
 204     {
 205         Fcb = ExAllocatePool(NonPagedPool, sizeof(TEST_FCB));
 206         if (!skip(Fcb != NULL, "ExAllocatePool failed\n"))
 207         {
 208             RtlZeroMemory(Fcb, sizeof(TEST_FCB));
 209             ExInitializeFastMutex(&Fcb->HeaderMutex);
 210             FsRtlSetupAdvancedHeader(&Fcb->Header, &Fcb->HeaderMutex);
 211
 212             TestFileObject->FsContext = Fcb;
 213             TestFileObject->SectionObjectPointer = &Fcb->SectionObjectPointers;
 214
 215             KmtStartSeh();
 216             CcInitializeCacheMap(TestFileObject, &FileSizes, FALSE, &Callbacks, NULL);
 217             KmtEndSeh(STATUS_SUCCESS);
 218
 219             if (!skip(CcIsFileCached(TestFileObject) == TRUE, "CcInitializeCacheMap failed\n"))
 220             {
 221                 if (TestId < 3)
 222                 {
 223                     Ret = FALSE;
 224                     Offset.QuadPart = TestId * 0x1000;
 225                     KmtStartSeh();
 226                     Ret = CcMapData(TestFileObject, &Offset, FileSizes.FileSize.QuadPart - Offset.QuadPart, MAP_WAIT, &Bcb, (PVOID *)&Buffer);
 227                     KmtEndSeh(STATUS_SUCCESS);
 228
 229                     if (!skip(Ret == TRUE, "CcMapData failed\n"))
 230                     {
 231                         ok_eq_ulong(Buffer[(0x3000 - TestId * 0x1000) / sizeof(ULONG)], 0xDEADBABE);
 232
 233                         CcUnpinData(Bcb);
 234                     }
 235                 }
 236                 else if (TestId == 3)
 237                 {
 238                     PTEST_CONTEXT TestContext;
 239
 240                     TestContext = ExAllocatePool(NonPagedPool, sizeof(TEST_CONTEXT));
 241                     if (!skip(Fcb != NULL, "ExAllocatePool failed\n"))
 242                     {
 243                         Ret = FALSE;
 244                         Offset.QuadPart = 0x1000;
 245                         KmtStartSeh();
 246                         Ret = CcMapData(TestFileObject, &Offset, FileSizes.FileSize.QuadPart - Offset.QuadPart, MAP_WAIT, &TestContext->Bcb, &TestContext->Buffer);
 247                         KmtEndSeh(STATUS_SUCCESS);
 248
 249                         if (!skip(Ret == TRUE, "CcMapData failed\n"))
 250                         {
 251                             PKTHREAD ThreadHandle;
 252
 253 #ifdef _X86_
 254                             /* FIXME: Should be fixed, will fail under certains conditions */
 255                             ok(TestContext->Buffer > (PVOID)0xC1000000 && TestContext->Buffer < (PVOID)0xDCFFFFFF,
 256                                "Buffer %p not mapped in system space\n", TestContext->Buffer);
 257 #else
 258 #ifdef _M_AMD64
 259                             ok(TestContext->Buffer > (PVOID)0xFFFFF98000000000 && TestContext->Buffer < (PVOID)0xFFFFFA8000000000,
 260                                "Buffer %p not mapped in system space\n", TestContext->Buffer);
 261 #else
 262                             skip(FALSE, "System space mapping not defined\n");
 263 #endif
 264 #endif
 265
 266                             TestContext->Length = FileSizes.FileSize.QuadPart - Offset.QuadPart;
 267                             ThreadHandle = KmtStartThread(MapInAnotherThread, TestContext);
 268                             KmtFinishThread(ThreadHandle, NULL);
 269
 270                             TestContext->Length = FileSizes.FileSize.QuadPart - 2 * Offset.QuadPart;
 271                             ThreadHandle = KmtStartThread(MapInAnotherThread, TestContext);
 272                             KmtFinishThread(ThreadHandle, NULL);
 273
 274                             CcUnpinData(TestContext->Bcb);
 275                         }
 276
 277                         ExFreePool(TestContext);
 278                     }
 279                 }
 280             }
 281         }
 282     }
 283 }
 284
 285
 286 static
 287 VOID
 288 CleanupTest(
 289     ULONG TestId,
 290     PDEVICE_OBJECT DeviceObject)
 291 {
 292     LARGE_INTEGER Zero = RTL_CONSTANT_LARGE_INTEGER(0LL);
 293     CACHE_UNINITIALIZE_EVENT CacheUninitEvent;
 294
 295     ok_eq_pointer(TestDeviceObject, DeviceObject);
 296     ok_eq_ulong(TestTestId, TestId);
 297
 298     if (!skip(TestFileObject != NULL, "No test FO\n"))
 299     {
 300         if (CcIsFileCached(TestFileObject))
 301         {
 302             KeInitializeEvent(&CacheUninitEvent.Event, NotificationEvent, FALSE);
 303             CcUninitializeCacheMap(TestFileObject, &Zero, &CacheUninitEvent);
 304             KeWaitForSingleObject(&CacheUninitEvent.Event, Executive, KernelMode, FALSE, NULL);
 305         }
 306
 307         if (TestFileObject->FsContext != NULL)
 308         {
 309             ExFreePool(TestFileObject->FsContext);
 310             TestFileObject->FsContext = NULL;
 311             TestFileObject->SectionObjectPointer = NULL;
 312         }
 313
 314         ObDereferenceObject(TestFileObject);
 315     }
 316
 317     TestFileObject = NULL;
 318     TestDeviceObject = NULL;
 319     TestTestId = -1;
 320 }
 321
 322
 323 static
 324 NTSTATUS
 325 TestMessageHandler(
 326     _In_ PDEVICE_OBJECT DeviceObject,
 327     _In_ ULONG ControlCode,
 328     _In_opt_ PVOID Buffer,
 329     _In_ SIZE_T InLength,
 330     _Inout_ PSIZE_T OutLength)
 331 {
 332     NTSTATUS Status = STATUS_SUCCESS;
 333
 334     switch (ControlCode)
 335     {
 336         case IOCTL_START_TEST:
 337             ok_eq_ulong((ULONG)InLength, sizeof(ULONG));
 338             PerformTest(*(PULONG)Buffer, DeviceObject);
 339             break;
 340
 341         case IOCTL_FINISH_TEST:
 342             ok_eq_ulong((ULONG)InLength, sizeof(ULONG));
 343             CleanupTest(*(PULONG)Buffer, DeviceObject);
 344             break;
 345
 346         default:
 347             Status = STATUS_NOT_IMPLEMENTED;
 348             break;
 349     }
 350
 351     return Status;
 352 }
 353
 354 static
 355 NTSTATUS
 356 TestIrpHandler(
 357     _In_ PDEVICE_OBJECT DeviceObject,
 358     _In_ PIRP Irp,
 359     _In_ PIO_STACK_LOCATION IoStack)
 360 {
 361     NTSTATUS Status;
 362
 363     PAGED_CODE();
 364
 365     DPRINT("IRP %x/%x\n", IoStack->MajorFunction, IoStack->MinorFunction);
 366     ASSERT(IoStack->MajorFunction == IRP_MJ_READ);
 367
 368     Status = STATUS_NOT_SUPPORTED;
 369     Irp->IoStatus.Information = 0;
 370
 371     if (IoStack->MajorFunction == IRP_MJ_READ)
 372     {
 373         PMDL Mdl;
 374         ULONG Length;
 375         PVOID Buffer;
 376         LARGE_INTEGER Offset;
 377
 378         Offset = IoStack->Parameters.Read.ByteOffset;
 379         Length = IoStack->Parameters.Read.Length;
 380
 381         ok_eq_pointer(DeviceObject, TestDeviceObject);
 382         ok_eq_pointer(IoStack->FileObject, TestFileObject);
 383
 384         ok(FlagOn(Irp->Flags, IRP_NOCACHE), "Not coming from Cc\n");
 385
 386         ok_irql(APC_LEVEL);
 387         ok((Offset.QuadPart % PAGE_SIZE == 0 || Offset.QuadPart == 0), "Offset is not aligned: %I64i\n", Offset.QuadPart);
 388         ok(Length % PAGE_SIZE == 0, "Length is not aligned: %I64i\n", Length);
 389
 390         ok(Irp->AssociatedIrp.SystemBuffer == NULL, "A SystemBuffer was allocated!\n");
 391         Buffer = MapAndLockUserBuffer(Irp, Length);
 392         ok(Buffer != NULL, "Null pointer!\n");
 393         RtlFillMemory(Buffer, Length, 0xBA);
 394
 395         Status = STATUS_SUCCESS;
 396         if (Offset.QuadPart <= 0x3000 && Offset.QuadPart + Length > 0x3000)
 397         {
 398             *(PULONG)((ULONG_PTR)Buffer + (ULONG_PTR)(0x3000 - Offset.QuadPart)) = 0xDEADBABE;
 399         }
 400
 401         Mdl = Irp->MdlAddress;
 402         ok(Mdl != NULL, "Null pointer for MDL!\n");
 403         ok((Mdl->MdlFlags & MDL_PAGES_LOCKED) != 0, "MDL not locked\n");
 404         ok((Mdl->MdlFlags & MDL_SOURCE_IS_NONPAGED_POOL) == 0, "MDL from non paged\n");
 405         ok((Mdl->MdlFlags & MDL_IO_PAGE_READ) != 0, "Non paging IO\n");
 406         ok((Irp->Flags & IRP_PAGING_IO) != 0, "Non paging IO\n");
 407
 408         Irp->IoStatus.Information = Length;
 409     }
 410
 411     if (Status == STATUS_PENDING)
 412     {
 413         IoMarkIrpPending(Irp);
 414         IoCompleteRequest(Irp, IO_NO_INCREMENT);
 415         Status = STATUS_PENDING;
 416     }
 417     else
 418     {
 419         Irp->IoStatus.Status = Status;
 420         IoCompleteRequest(Irp, IO_NO_INCREMENT);
 421     }
 422
 423     return Status;
 424 }