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 #elif defined KMT_USER_MODE
  83 DWORD KmtRunKernelTest(IN PCSTR TestName);
  84
  85 VOID KmtLoadDriver(IN PCWSTR ServiceName, IN BOOLEAN RestartIfRunning);
  86 VOID KmtUnloadDriver(VOID);
  87 VOID KmtOpenDriver(VOID);
  88 VOID KmtCloseDriver(VOID);
  89
  90 DWORD KmtSendToDriver(IN DWORD ControlCode);
  91 DWORD KmtSendStringToDriver(IN DWORD ControlCode, IN PCSTR String);
  92 DWORD KmtSendBufferToDriver(IN DWORD ControlCode, IN OUT PVOID Buffer OPTIONAL, IN DWORD InLength, IN OUT PDWORD OutLength);
  93 #endif /* defined KMT_USER_MODE */
  94
  95 extern PKMT_RESULTBUFFER ResultBuffer;
  96
  97 #ifdef __GNUC__
  98 #define KMT_FORMAT(type, fmt, first) __attribute__((__format__(type, fmt, first)))
  99 #elif !defined __GNUC__
 100 #define KMT_FORMAT(type, fmt, first)
 101 #endif /* !defined __GNUC__ */
 102
 103 #define START_TEST(name) VOID Test_##name(VOID)
 104
 105 #ifndef KMT_STRINGIZE
 106 #define KMT_STRINGIZE(x) #x
 107 #endif /* !defined KMT_STRINGIZE */
 108 #define ok(test, ...)                ok_(test,   __FILE__, __LINE__, __VA_ARGS__)
 109 #define trace(...)                   trace_(     __FILE__, __LINE__, __VA_ARGS__)
 110 #define skip(test, ...)              skip_(test, __FILE__, __LINE__, __VA_ARGS__)
 111
 112 #define ok_(test, file, line, ...)   KmtOk(test,   file ":" KMT_STRINGIZE(line), __VA_ARGS__)
 113 #define trace_(file, line, ...)      KmtTrace(     file ":" KMT_STRINGIZE(line), __VA_ARGS__)
 114 #define skip_(test, file, line, ...) KmtSkip(test, file ":" KMT_STRINGIZE(line), __VA_ARGS__)
 115
 116 VOID KmtVOk(INT Condition, PCSTR FileAndLine, PCSTR Format, va_list Arguments)      KMT_FORMAT(ms_printf, 3, 0);
 117 VOID KmtOk(INT Condition, PCSTR FileAndLine, PCSTR Format, ...)                     KMT_FORMAT(ms_printf, 3, 4);
 118 VOID KmtVTrace(PCSTR FileAndLine, PCSTR Format, va_list Arguments)                  KMT_FORMAT(ms_printf, 2, 0);
 119 VOID KmtTrace(PCSTR FileAndLine, PCSTR Format, ...)                                 KMT_FORMAT(ms_printf, 2, 3);
 120 BOOLEAN KmtVSkip(INT Condition, PCSTR FileAndLine, PCSTR Format, va_list Arguments) KMT_FORMAT(ms_printf, 3, 0);
 121 BOOLEAN KmtSkip(INT Condition, PCSTR FileAndLine, PCSTR Format, ...)                KMT_FORMAT(ms_printf, 3, 4);
 122
 123 #ifdef KMT_KERNEL_MODE
 124 #define ok_irql(irql)                       ok(KeGetCurrentIrql() == irql, "IRQL is %d, expected %d\n", KeGetCurrentIrql(), irql)
 125 #endif /* defined KMT_KERNEL_MODE */
 126 #define ok_eq_print(value, expected, spec)  ok((value) == (expected), #value " = " spec ", expected " spec "\n", value, expected)
 127 #define ok_eq_pointer(value, expected)      ok_eq_print(value, expected, "%p")
 128 #define ok_eq_int(value, expected)          ok_eq_print(value, expected, "%d")
 129 #define ok_eq_uint(value, expected)         ok_eq_print(value, expected, "%u")
 130 #define ok_eq_long(value, expected)         ok_eq_print(value, expected, "%ld")
 131 #define ok_eq_ulong(value, expected)        ok_eq_print(value, expected, "%lu")
 132 #define ok_eq_hex(value, expected)          ok_eq_print(value, expected, "0x%08lx")
 133 #define ok_bool_true(value, desc)           ok((value) == TRUE, desc " FALSE, expected TRUE\n")
 134 #define ok_bool_false(value, desc)          ok((value) == FALSE, desc " TRUE, expected FALSE\n")
 135 #define ok_eq_bool(value, expected)         ok((value) == (expected), #value " = %s, expected %s\n",    \
 136                                                 (value) ? "TRUE" : "FALSE",                             \
 137                                                 (expected) ? "TRUE" : "FALSE")
 138 #define ok_eq_str(value, expected)          ok(!strcmp(value, expected), #value " = \"%s\", expected \"%s\"\n", value, expected)
 139 #define ok_eq_wstr(value, expected)         ok(!wcscmp(value, expected), #value " = \"%ls\", expected \"%ls\"\n", value, expected)
 140
 141 #define KMT_MAKE_CODE(ControlCode)  CTL_CODE(FILE_DEVICE_UNKNOWN,           \
 142                                              0xC00 + (ControlCode),         \
 143                                              METHOD_BUFFERED,               \
 144                                              FILE_ANY_ACCESS)
 145
 146 #if defined KMT_DEFINE_TEST_FUNCTIONS
 147 PKMT_RESULTBUFFER ResultBuffer = NULL;
 148
 149 #if defined KMT_USER_MODE
 150 static PKMT_RESULTBUFFER KmtAllocateResultBuffer(SIZE_T LogBufferMaxLength)
 151 {
 152     PKMT_RESULTBUFFER Buffer = HeapAlloc(GetProcessHeap(), 0, FIELD_OFFSET(KMT_RESULTBUFFER, LogBuffer[LogBufferMaxLength]));
 153
 154     Buffer->Successes = 0;
 155     Buffer->Failures = 0;
 156     Buffer->Skipped = 0;
 157     Buffer->LogBufferLength = 0;
 158     Buffer->LogBufferMaxLength = LogBufferMaxLength;
 159
 160     return Buffer;
 161 }
 162
 163 static VOID KmtFreeResultBuffer(PKMT_RESULTBUFFER Buffer)
 164 {
 165     HeapFree(GetProcessHeap(), 0, Buffer);
 166 }
 167 #endif /* defined KMT_USER_MODE */
 168
 169 static VOID KmtAddToLogBuffer(PKMT_RESULTBUFFER Buffer, PCSTR String, SIZE_T Length)
 170 {
 171     LONG OldLength;
 172     LONG NewLength;
 173
 174     if (!Buffer)
 175         return;
 176
 177     do
 178     {
 179         OldLength = Buffer->LogBufferLength;
 180         NewLength = OldLength + Length;
 181         if (NewLength > Buffer->LogBufferMaxLength)
 182         {
 183             /* TODO: indicate failure somehow */
 184             __debugbreak();
 185             return;
 186         }
 187     } while (InterlockedCompareExchange(&Buffer->LogBufferLength, NewLength, OldLength) != OldLength);
 188
 189     memcpy(&Buffer->LogBuffer[OldLength], String, Length);
 190 }
 191
 192 #ifdef KMT_KERNEL_MODE
 193 INT __cdecl KmtVSNPrintF(PSTR Buffer, SIZE_T BufferMaxLength, PCSTR Format, va_list Arguments) KMT_FORMAT(ms_printf, 3, 0);
 194 #elif defined KMT_USER_MODE
 195 #define KmtVSNPrintF vsnprintf
 196 #endif /* defined KMT_USER_MODE */
 197
 198 KMT_FORMAT(ms_printf, 5, 0)
 199 static SIZE_T KmtXVSNPrintF(PSTR Buffer, SIZE_T BufferMaxLength, PCSTR FileAndLine, PCSTR Prepend, PCSTR Format, va_list Arguments)
 200 {
 201     SIZE_T BufferLength = 0;
 202     SIZE_T Length;
 203
 204     if (FileAndLine)
 205     {
 206         PCSTR Slash;
 207         Slash = strrchr(FileAndLine, '\\');
 208         if (Slash)
 209             FileAndLine = Slash + 1;
 210         Slash = strrchr(FileAndLine, '/');
 211         if (Slash)
 212             FileAndLine = Slash + 1;
 213
 214         Length = min(BufferMaxLength, strlen(FileAndLine));
 215         memcpy(Buffer, FileAndLine, Length);
 216         Buffer += Length;
 217         BufferLength += Length;
 218         BufferMaxLength -= Length;
 219     }
 220     if (Prepend)
 221     {
 222         Length = min(BufferMaxLength, strlen(Prepend));
 223         memcpy(Buffer, Prepend, Length);
 224         Buffer += Length;
 225         BufferLength += Length;
 226         BufferMaxLength -= Length;
 227     }
 228     if (Format)
 229     {
 230         Length = KmtVSNPrintF(Buffer, BufferMaxLength, Format, Arguments);
 231         /* vsnprintf can return more than maxLength, we don't want to do that */
 232         BufferLength += min(Length, BufferMaxLength);
 233     }
 234     return BufferLength;
 235 }
 236
 237 KMT_FORMAT(ms_printf, 5, 6)
 238 static SIZE_T KmtXSNPrintF(PSTR Buffer, SIZE_T BufferMaxLength, PCSTR FileAndLine, PCSTR Prepend, PCSTR Format, ...)
 239 {
 240     SIZE_T BufferLength;
 241     va_list Arguments;
 242     va_start(Arguments, Format);
 243     BufferLength = KmtXVSNPrintF(Buffer, BufferMaxLength, FileAndLine, Prepend, Format, Arguments);
 244     va_end(Arguments);
 245     return BufferLength;
 246 }
 247
 248 VOID KmtFinishTest(PCSTR TestName)
 249 {
 250     CHAR MessageBuffer[512];
 251     SIZE_T MessageLength;
 252
 253     if (!ResultBuffer)
 254         return;
 255
 256     MessageLength = KmtXSNPrintF(MessageBuffer, sizeof MessageBuffer, NULL, NULL,
 257                                     "%s: %ld tests executed (0 marked as todo, %ld failures), %ld skipped.\n",
 258                                     TestName,
 259                                     ResultBuffer->Successes + ResultBuffer->Failures,
 260                                     ResultBuffer->Failures,
 261                                     ResultBuffer->Skipped);
 262     KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 263 }
 264
 265 VOID KmtVOk(INT Condition, PCSTR FileAndLine, PCSTR Format, va_list Arguments)
 266 {
 267     CHAR MessageBuffer[512];
 268     SIZE_T MessageLength;
 269
 270     if (!ResultBuffer)
 271         return;
 272
 273     if (Condition)
 274     {
 275         InterlockedIncrement(&ResultBuffer->Successes);
 276
 277         if (0/*KmtReportSuccess*/)
 278         {
 279             MessageLength = KmtXSNPrintF(MessageBuffer, sizeof MessageBuffer, FileAndLine, ": Test succeeded\n", NULL);
 280             KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 281         }
 282     }
 283     else
 284     {
 285         InterlockedIncrement(&ResultBuffer->Failures);
 286         MessageLength = KmtXVSNPrintF(MessageBuffer, sizeof MessageBuffer, FileAndLine, ": Test failed: ", Format, Arguments);
 287         KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 288     }
 289 }
 290
 291 VOID KmtOk(INT Condition, PCSTR FileAndLine, PCSTR Format, ...)
 292 {
 293     va_list Arguments;
 294     va_start(Arguments, Format);
 295     KmtVOk(Condition, FileAndLine, Format, Arguments);
 296     va_end(Arguments);
 297 }
 298
 299 VOID KmtVTrace(PCSTR FileAndLine, PCSTR Format, va_list Arguments)
 300 {
 301     CHAR MessageBuffer[512];
 302     SIZE_T MessageLength;
 303
 304     MessageLength = KmtXVSNPrintF(MessageBuffer, sizeof MessageBuffer, FileAndLine, ": ", Format, Arguments);
 305     KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 306 }
 307
 308 VOID KmtTrace(PCSTR FileAndLine, PCSTR Format, ...)
 309 {
 310     va_list Arguments;
 311     va_start(Arguments, Format);
 312     KmtVTrace(FileAndLine, Format, Arguments);
 313     va_end(Arguments);
 314 }
 315
 316 BOOLEAN KmtVSkip(INT Condition, PCSTR FileAndLine, PCSTR Format, va_list Arguments)
 317 {
 318     CHAR MessageBuffer[512];
 319     SIZE_T MessageLength;
 320
 321     if (!ResultBuffer)
 322         return !Condition;
 323
 324     if (!Condition)
 325     {
 326         InterlockedIncrement(&ResultBuffer->Skipped);
 327         MessageLength = KmtXVSNPrintF(MessageBuffer, sizeof MessageBuffer, FileAndLine, ": Tests skipped: ", Format, Arguments);
 328         KmtAddToLogBuffer(ResultBuffer, MessageBuffer, MessageLength);
 329     }
 330
 331     return !Condition;
 332 }
 333
 334 BOOLEAN KmtSkip(INT Condition, PCSTR FileAndLine, PCSTR Format, ...)
 335 {
 336     BOOLEAN Ret;
 337     va_list Arguments;
 338     va_start(Arguments, Format);
 339     Ret = KmtVSkip(Condition, FileAndLine, Format, Arguments);
 340     va_end(Arguments);
 341     return Ret;
 342 }
 343
 344 #endif /* defined KMT_DEFINE_TEST_FUNCTIONS */
 345
 346 #endif /* !defined _KMTEST_TEST_H_ */