kmtests/include/kmt_test.h

   1 /*
   2  * PROJECT:         ReactOS kernel-mode tests
   3  * LICENSE:         GPLv2+ - See COPYING in the top level directory
   4  * PURPOSE:         Kernel-Mode Test Suite test framework declarations
   5  * PROGRAMMER:      Thomas Faber <thfabba@gmx.de>
   6  */
   7
   8 /* Inspired by Wine C unit tests, Copyright (C) 2002 Alexandre Julliard
   9  * Inspired by ReactOS kernel-mode regression tests,
  10  *                                Copyright (C) Aleksey Bragin, Filip Navara
  11  */
  12
  13 #ifndef _KMTEST_TEST_H_
  14 #define _KMTEST_TEST_H_
  15
  16 #include <stdarg.h>
  17
  18 typedef VOID KMT_TESTFUNC(VOID);
  19 typedef KMT_TESTFUNC *PKMT_TESTFUNC;
  20
  21 typedef struct
  22 {
  23     const char *TestName;
  24     KMT_TESTFUNC *TestFunction;
  25 } KMT_TEST, *PKMT_TEST;
  26
  27 typedef const KMT_TEST CKMT_TEST, *PCKMT_TEST;
  28
  29 extern const KMT_TEST TestList[];
  30
  31 typedef struct
  32 {
  33     volatile LONG Successes;
  34     volatile LONG Failures;
  35     volatile LONG Skipped;
  36     volatile LONG LogBufferLength;
  37     LONG LogBufferMaxLength;
  38     CHAR LogBuffer[ANYSIZE_ARRAY];
  39 } KMT_RESULTBUFFER, *PKMT_RESULTBUFFER;
  40
  41 #ifdef KMT_STANDALONE_DRIVER
  42 #define KMT_KERNEL_MODE
  43
  44 typedef NTSTATUS (KMT_IRP_HANDLER)(
  45     IN PDEVICE_OBJECT DeviceObject,
  46     IN PIRP Irp,
  47     IN PIO_STACK_LOCATION IoStackLocation);
  48 typedef KMT_IRP_HANDLER *PKMT_IRP_HANDLER;
  49
  50 NTSTATUS KmtRegisterIrpHandler(IN UCHAR MajorFunction, IN PDEVICE_OBJECT DeviceObject OPTIONAL, IN PKMT_IRP_HANDLER IrpHandler);
  51 NTSTATUS KmtUnregisterIrpHandler(IN UCHAR MajorFunction, IN PDEVICE_OBJECT DeviceObject OPTIONAL, IN PKMT_IRP_HANDLER IrpHandler);
  52
  53 typedef NTSTATUS (KMT_MESSAGE_HANDLER)(
  54     IN PDEVICE_OBJECT DeviceObject,
  55     IN ULONG ControlCode,
  56     IN PVOID Buffer OPTIONAL,
  57     IN SIZE_T InLength,
  58     IN OUT PSIZE_T OutLength);
  59 typedef KMT_MESSAGE_HANDLER *PKMT_MESSAGE_HANDLER;
  60
  61 NTSTATUS KmtRegisterMessageHandler(IN ULONG ControlCode OPTIONAL, IN PDEVICE_OBJECT DeviceObject OPTIONAL, IN PKMT_MESSAGE_HANDLER MessageHandler);
  62 NTSTATUS KmtUnregisterMessageHandler(IN ULONG ControlCode OPTIONAL, IN PDEVICE_OBJECT DeviceObject OPTIONAL, IN PKMT_MESSAGE_HANDLER MessageHandler);
  63
  64 typedef enum
  65 {
  66     TESTENTRY_NO_CREATE_DEVICE = 1,
  67     TESTENTRY_NO_REGISTER_DISPATCH = 2,
  68     TESTENTRY_NO_REGISTER_UNLOAD = 4,
  69 } KMT_TESTENTRY_FLAGS;
  70
  71 NTSTATUS TestEntry(IN PDRIVER_OBJECT DriverObject, IN PCUNICODE_STRING RegistryPath, OUT PCWSTR *DeviceName, OUT INT *Flags);
  72 VOID TestUnload(IN PDRIVER_OBJECT DriverObject);
  73 #endif /* defined KMT_STANDALONE_DRIVER */
  74
  75 #ifdef KMT_KERNEL_MODE
  76 /* Device Extension layout */
  77 typedef struct
  78 {
  79     PKMT_RESULTBUFFER ResultBuffer;
  80     PMDL Mdl;
  81 } KMT_DEVICE_EXTENSION, *PKMT_DEVICE_EXTENSION;
  82
  83 extern BOOLEAN KmtIsCheckedBuild;
  84 extern BOOLEAN KmtIsMultiProcessorBuild;
  85
  86 VOID KmtSetIrql(IN KIRQL NewIrql);
  87 BOOLEAN KmtAreInterruptsEnabled(VOID);
  88 #elif defined KMT_USER_MODE
  89 DWORD KmtRunKernelTest(IN PCSTR TestName);
  90
  91 VOID KmtLoadDriver(IN PCWSTR ServiceName, IN BOOLEAN RestartIfRunning);
  92 VOID KmtUnloadDriver(VOID);
  93 VOID KmtOpenDriver(VOID);
  94 VOID KmtCloseDriver(VOID);
  95
  96 DWORD KmtSendToDriver(IN DWORD ControlCode);
  97 DWORD KmtSendStringToDriver(IN DWORD ControlCode, IN PCSTR String);
  98 DWORD KmtSendBufferToDriver(IN DWORD ControlCode, IN OUT PVOID Buffer OPTIONAL, IN DWORD InLength, IN OUT PDWORD OutLength);
  99 #endif /* defined KMT_USER_MODE */
 100
 101 extern PKMT_RESULTBUFFER ResultBuffer;
 102
 103 #ifdef __GNUC__
 104 #define KMT_FORMAT(type, fmt, first) __attribute__((__format__(type, fmt, first)))
 105 #elif !defined __GNUC__
 106 #define KMT_FORMAT(type, fmt, first)
 107 #endif /* !defined __GNUC__ */
 108
 109 #define START_TEST(name) VOID Test_##name(VOID)
 110
 111 #ifndef KMT_STRINGIZE
 112 #define KMT_STRINGIZE(x) #x
 113 #endif /* !defined KMT_STRINGIZE */
 114 #define ok(test, ...)                ok_(test,   __FILE__, __LINE__, __VA_ARGS__)
 115 #define trace(...)                   trace_(     __FILE__, __LINE__, __VA_ARGS__)
 116 #define skip(test, ...)              skip_(test, __FILE__, __LINE__, __VA_ARGS__)
 117
 118 #define ok_(test, file, line, ...)   KmtOk(test,   file ":" KMT_STRINGIZE(line), __VA_ARGS__)
 119 #define trace_(file, line, ...)      KmtTrace(     file ":" KMT_STRINGIZE(line), __VA_ARGS__)
 120 #define skip_(test, file, line, ...) KmtSkip(test, file ":" KMT_STRINGIZE(line), __VA_ARGS__)
 121
 122 VOID KmtVOk(INT Condition, PCSTR FileAndLine, PCSTR Format, va_list Arguments)      KMT_FORMAT(ms_printf, 3, 0);
 123 VOID KmtOk(INT Condition, PCSTR FileAndLine, PCSTR Format, ...)                     KMT_FORMAT(ms_printf, 3, 4);
 124 VOID KmtVTrace(PCSTR FileAndLine, PCSTR Format, va_list Arguments)                  KMT_FORMAT(ms_printf, 2, 0);
 125 VOID KmtTrace(PCSTR FileAndLine, PCSTR Format, ...)                                 KMT_FORMAT(ms_printf, 2, 3);
 126 BOOLEAN KmtVSkip(INT Condition, PCSTR FileAndLine, PCSTR Format, va_list Arguments) KMT_FORMAT(ms_printf, 3, 0);
 127 BOOLEAN KmtSkip(INT Condition, PCSTR FileAndLine, PCSTR Format, ...)                KMT_FORMAT(ms_printf, 3, 4);
 128
 129 #ifdef KMT_KERNEL_MODE
 130 #define ok_irql(irql)                       ok(KeGetCurrentIrql() == irql, "IRQL is %d, expected %d\n", KeGetCurrentIrql(), irql)
 131 #endif /* defined KMT_KERNEL_MODE */
 132 #define ok_eq_print(value, expected, spec)  ok((value) == (expected), #value " = " spec ", expected " spec "\n", value, expected)
 133 #define ok_eq_pointer(value, expected)      ok_eq_print(value, expected, "%p")
 134 #define ok_eq_int(value, expected)          ok_eq_print(value, expected, "%d")
 135 #define ok_eq_uint(value, expected)         ok_eq_print(value, expected, "%u")
 136 #define ok_eq_long(value, expected)         ok_eq_print(value, expected, "%ld")
 137 #define ok_eq_ulong(value, expected)        ok_eq_print(value, expected, "%lu")
 138 #define ok_eq_longlong(value, expected)     ok_eq_print(value, expected, "%I64d")
 139 #define ok_eq_ulonglong(value, expected)    ok_eq_print(value, expected, "%I64u")
 140 #define ok_eq_hex(value, expected)          ok_eq_print(value, expected, "0x%08lx")
 141 #define ok_bool_true(value, desc)           ok((value) == TRUE, desc " FALSE, expected TRUE\n")
 142 #define ok_bool_false(value, desc)          ok((value) == FALSE, desc " TRUE, expected FALSE\n")
 143 #define ok_eq_bool(value, expected)         ok((value) == (expected), #value " = %s, expected %s\n",    \
 144                                                 (value) ? "TRUE" : "FALSE",                             \
 145                                                 (expected) ? "TRUE" : "FALSE")
 146 #define ok_eq_str(value, expected)          ok(!strcmp(value, expected), #value " = \"%s\", expected \"%s\"\n", value, expected)
 147 #define ok_eq_wstr(value, expected)         ok(!wcscmp(value, expected), #value " = \"%ls\", expected \"%ls\"\n", value, expected)
 148
 149 #define KMT_MAKE_CODE(ControlCode)  CTL_CODE(FILE_DEVICE_UNKNOWN,           \
 150                                              0xC00 + (ControlCode),         \
 151                                              METHOD_BUFFERED,               \
 152                                              FILE_ANY_ACCESS)
 153
 154 #if defined KMT_DEFINE_TEST_FUNCTIONS
 155
 156 #if defined KMT_KERNEL_MODE
 157 BOOLEAN KmtIsCheckedBuild;
 158 BOOLEAN KmtIsMultiProcessorBuild;
 159
 160 VOID KmtSetIrql(IN KIRQL NewIrql)
 161 {
 162     KIRQL Irql = KeGetCurrentIrql();
 163     if (Irql > NewIrql)
 164         KeLowerIrql(NewIrql);
 165     else if (Irql < NewIrql)
 166         KeRaiseIrql(NewIrql, &Irql);
 167 }
 168
 169 BOOLEAN KmtAreInterruptsEnabled(VOID)
 170 {
 171     return (__readeflags() & (1 << 9)) != 0;
 172 }
 173
 174 INT __cdecl KmtVSNPrintF(PSTR Buffer, SIZE_T BufferMaxLength, PCSTR Format, va_list Arguments) KMT_FORMAT(ms_printf, 3, 0);
 175 #elif defined KMT_USER_MODE
 176 static PKMT_RESULTBUFFER KmtAllocateResultBuffer(SIZE_T ResultBufferSize)
 177 {
 178     PKMT_RESULTBUFFER Buffer = HeapAlloc(GetProcessHeap(), 0, ResultBufferSize);
 179     if (!Buffer)
 180         return NULL;
 181
 182     Buffer->Successes = 0;
 183     Buffer->Failures = 0;
 184     Buffer->Skipped = 0;
 185     Buffer->LogBufferLength = 0;
 186     Buffer->LogBufferMaxLength = ResultBufferSize - FIELD_OFFSET(KMT_RESULTBUFFER, LogBuffer);
 187
 188     return Buffer;
 189 }
 190
 191 static VOID KmtFreeResultBuffer(PKMT_RESULTBUFFER Buffer)
 192 {
 193     HeapFree(GetProcessHeap(), 0, Buffer);
 194 }
 195
 196 #define KmtVSNPrintF vsnprintf
 197 #endif /* defined KMT_USER_MODE */
 198
 199 PKMT_RESULTBUFFER ResultBuffer = NULL;
 200
 201 static VOID KmtAddToLogBuffer(PKMT_RESULTBUFFER Buffer, PCSTR String, SIZE_T Length)
 202 {
 203     LONG OldLength;
 204     LONG NewLength;
 205
 206     if (!Buffer)
 207         return;
 208
 209     do
 210     {
 211         OldLength = Buffer->LogBufferLength;
 212         NewLength = OldLength + Length;
 213         if (NewLength > Buffer->LogBufferMaxLength)
 214         {
 215             /* TODO: indicate failure somehow */
 216             __debugbreak();
 217             return;
 218         }
 219     } while (InterlockedCompareExchange(&Buffer->LogBufferLength, NewLength, OldLength) != OldLength);
 220
 221     memcpy(&Buffer->LogBuffer[OldLength], String, Length);
 222 }
 223
 224 KMT_FORMAT(ms_printf, 5, 0)
 225 static SIZE_T KmtXVSNPrintF(PSTR Buffer, SIZE_T BufferMaxLength, PCSTR FileAndLine, PCSTR Prepend, PCSTR Format, va_list Arguments)
 226 {
 227     SIZE_T BufferLength = 0;
 228     SIZE_T Length;
 229
 230     if (FileAndLine)
 231     {
 232         PCSTR Slash;
 233         Slash = strrchr(FileAndLine, '\\');
 234         if (Slash)
 235             FileAndLine = Slash + 1;
 236         Slash = strrchr(FileAndLine, '/');
 237         if (Slash)
 238             FileAndLine = Slash + 1;
 239
 240         Length = min(BufferMaxLength, strlen(FileAndLine));
 241         memcpy(Buffer, FileAndLine, Length);
 242         Buffer += Length;
 243         BufferLength += Length;
 244         BufferMaxLength -= Length;
 245     }
 246     if (Prepend)
 247     {
 248         Length = min(BufferMaxLength, strlen(Prepend));
 249         memcpy(Buffer, Prepend, Length);
 250         Buffer += Length;
 251         BufferLength += Length;
 252         BufferMaxLength -= Length;
 253     }
 254     if (Format)
 255     {
 256         Length = KmtVSNPrintF(Buffer, BufferMaxLength, Format, Arguments);
 257         /* vsnprintf can return more than maxLength, we don't want to do that */
 258         BufferLength += min(Length, BufferMaxLength);
 259     }
 260     return BufferLength;
 261 }
 262
 263 KMT_FORMAT(ms_printf, 5, 6)
 264 static SIZE_T KmtXSNPrintF(PSTR Buffer, SIZE_T BufferMaxLength, PCSTR FileAndLine, PCSTR Prepend, PCSTR Format, ...)
 265 {
 266     SIZE_T BufferLength;
 267     va_list Arguments;
 268     va_start(Arguments, Format);
 269     BufferLength = KmtXVSNPrintF(Buffer, BufferMaxLength, FileAndLine, Prepend, Format, Arguments);
 270     va_end(Arguments);
 271     return BufferLength;
 272 }
 273
 274 VOID KmtFinishTest(PCSTR TestName)
 275 {
 276     CHAR MessageBuffer[512];
 277     SIZE_T MessageLength;
 278
 279     if (!ResultBuffer)
 280         return;
 281
 282     MessageLength = KmtXSNPrintF(MessageBuffer, sizeof MessageBuffer, NULL, NULL,
 283                                     "%s: %ld tests executed (0 marked as todo, %ld failures), %ld skipped.\n",
 284                                     TestName,
 285                                     ResultBuffer->Successes + ResultBuffer->Failures,
 286                                     ResultBuffer->Failures,
 287                                     ResultBuffer->Skipped);
 288     KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 289 }
 290
 291 VOID KmtVOk(INT Condition, PCSTR FileAndLine, PCSTR Format, va_list Arguments)
 292 {
 293     CHAR MessageBuffer[512];
 294     SIZE_T MessageLength;
 295
 296     if (!ResultBuffer)
 297         return;
 298
 299     if (Condition)
 300     {
 301         InterlockedIncrement(&ResultBuffer->Successes);
 302
 303         if (0/*KmtReportSuccess*/)
 304         {
 305             MessageLength = KmtXSNPrintF(MessageBuffer, sizeof MessageBuffer, FileAndLine, ": Test succeeded\n", NULL);
 306             KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 307         }
 308     }
 309     else
 310     {
 311         InterlockedIncrement(&ResultBuffer->Failures);
 312         MessageLength = KmtXVSNPrintF(MessageBuffer, sizeof MessageBuffer, FileAndLine, ": Test failed: ", Format, Arguments);
 313         KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 314     }
 315 }
 316
 317 VOID KmtOk(INT Condition, PCSTR FileAndLine, PCSTR Format, ...)
 318 {
 319     va_list Arguments;
 320     va_start(Arguments, Format);
 321     KmtVOk(Condition, FileAndLine, Format, Arguments);
 322     va_end(Arguments);
 323 }
 324
 325 VOID KmtVTrace(PCSTR FileAndLine, PCSTR Format, va_list Arguments)
 326 {
 327     CHAR MessageBuffer[512];
 328     SIZE_T MessageLength;
 329
 330     MessageLength = KmtXVSNPrintF(MessageBuffer, sizeof MessageBuffer, FileAndLine, ": ", Format, Arguments);
 331     KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 332 }
 333
 334 VOID KmtTrace(PCSTR FileAndLine, PCSTR Format, ...)
 335 {
 336     va_list Arguments;
 337     va_start(Arguments, Format);
 338     KmtVTrace(FileAndLine, Format, Arguments);
 339     va_end(Arguments);
 340 }
 341
 342 BOOLEAN KmtVSkip(INT Condition, PCSTR FileAndLine, PCSTR Format, va_list Arguments)
 343 {
 344     CHAR MessageBuffer[512];
 345     SIZE_T MessageLength;
 346
 347     if (!ResultBuffer)
 348         return !Condition;
 349
 350     if (!Condition)
 351     {
 352         InterlockedIncrement(&ResultBuffer->Skipped);
 353         MessageLength = KmtXVSNPrintF(MessageBuffer, sizeof MessageBuffer, FileAndLine, ": Tests skipped: ", Format, Arguments);
 354         KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 355     }
 356
 357     return !Condition;
 358 }
 359
 360 BOOLEAN KmtSkip(INT Condition, PCSTR FileAndLine, PCSTR Format, ...)
 361 {
 362     BOOLEAN Ret;
 363     va_list Arguments;
 364     va_start(Arguments, Format);
 365     Ret = KmtVSkip(Condition, FileAndLine, Format, Arguments);
 366     va_end(Arguments);
 367     return Ret;
 368 }
 369
 370 #endif /* defined KMT_DEFINE_TEST_FUNCTIONS */
 371
 372 #endif /* !defined _KMTEST_TEST_H_ */