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>
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
13 #ifndef _KMTEST_TEST_H_
14 #define _KMTEST_TEST_H_
16 #include <kmt_platform.h>
18 typedef VOID
KMT_TESTFUNC(VOID
);
19 typedef KMT_TESTFUNC
*PKMT_TESTFUNC
;
24 KMT_TESTFUNC
*TestFunction
;
25 } KMT_TEST
, *PKMT_TEST
;
27 typedef const KMT_TEST CKMT_TEST
, *PCKMT_TEST
;
29 extern const KMT_TEST TestList
[];
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
;
41 #ifdef KMT_STANDALONE_DRIVER
42 #define KMT_KERNEL_MODE
44 typedef NTSTATUS (KMT_IRP_HANDLER
)(
45 IN PDEVICE_OBJECT DeviceObject
,
47 IN PIO_STACK_LOCATION IoStackLocation
);
48 typedef KMT_IRP_HANDLER
*PKMT_IRP_HANDLER
;
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
);
53 typedef NTSTATUS (KMT_MESSAGE_HANDLER
)(
54 IN PDEVICE_OBJECT DeviceObject
,
56 IN PVOID Buffer OPTIONAL
,
58 IN OUT PSIZE_T OutLength
);
59 typedef KMT_MESSAGE_HANDLER
*PKMT_MESSAGE_HANDLER
;
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
);
66 TESTENTRY_NO_CREATE_DEVICE
= 1,
67 TESTENTRY_NO_REGISTER_DISPATCH
= 2,
68 TESTENTRY_NO_REGISTER_UNLOAD
= 4,
69 } KMT_TESTENTRY_FLAGS
;
71 NTSTATUS
TestEntry(IN PDRIVER_OBJECT DriverObject
, IN PCUNICODE_STRING RegistryPath
, OUT PCWSTR
*DeviceName
, IN OUT INT
*Flags
);
72 VOID
TestUnload(IN PDRIVER_OBJECT DriverObject
);
73 #endif /* defined KMT_STANDALONE_DRIVER */
75 #ifdef KMT_KERNEL_MODE
76 /* Device Extension layout */
79 PKMT_RESULTBUFFER ResultBuffer
;
81 } KMT_DEVICE_EXTENSION
, *PKMT_DEVICE_EXTENSION
;
83 extern BOOLEAN KmtIsCheckedBuild
;
84 extern BOOLEAN KmtIsMultiProcessorBuild
;
85 extern PCSTR KmtMajorFunctionNames
[];
87 VOID
KmtSetIrql(IN KIRQL NewIrql
);
88 BOOLEAN
KmtAreInterruptsEnabled(VOID
);
89 #elif defined KMT_USER_MODE
90 DWORD
KmtRunKernelTest(IN PCSTR TestName
);
92 VOID
KmtLoadDriver(IN PCWSTR ServiceName
, IN BOOLEAN RestartIfRunning
);
93 VOID
KmtUnloadDriver(VOID
);
94 VOID
KmtOpenDriver(VOID
);
95 VOID
KmtCloseDriver(VOID
);
97 DWORD
KmtSendToDriver(IN DWORD ControlCode
);
98 DWORD
KmtSendStringToDriver(IN DWORD ControlCode
, IN PCSTR String
);
99 DWORD
KmtSendBufferToDriver(IN DWORD ControlCode
, IN OUT PVOID Buffer OPTIONAL
, IN DWORD InLength
, IN OUT PDWORD OutLength
);
100 #else /* if !defined KMT_KERNEL_MODE && !defined KMT_USER_MODE */
101 #error either KMT_KERNEL_MODE or KMT_USER_MODE must be defined
102 #endif /* !defined KMT_KERNEL_MODE && !defined KMT_USER_MODE */
104 extern PKMT_RESULTBUFFER ResultBuffer
;
107 /* TODO: GCC doesn't understand %wZ :( */
108 #define KMT_FORMAT(type, fmt, first) /*__attribute__((__format__(type, fmt, first)))*/
109 #elif !defined __GNUC__
110 #define KMT_FORMAT(type, fmt, first)
111 #endif /* !defined __GNUC__ */
113 #define START_TEST(name) VOID Test_##name(VOID)
115 #ifndef KMT_STRINGIZE
116 #define KMT_STRINGIZE(x) #x
117 #endif /* !defined KMT_STRINGIZE */
118 #define ok(test, ...) ok_(test, __FILE__, __LINE__, __VA_ARGS__)
119 #define trace(...) trace_( __FILE__, __LINE__, __VA_ARGS__)
120 #define skip(test, ...) skip_(test, __FILE__, __LINE__, __VA_ARGS__)
122 #define ok_(test, file, line, ...) KmtOk(test, file ":" KMT_STRINGIZE(line), __VA_ARGS__)
123 #define trace_(file, line, ...) KmtTrace( file ":" KMT_STRINGIZE(line), __VA_ARGS__)
124 #define skip_(test, file, line, ...) KmtSkip(test, file ":" KMT_STRINGIZE(line), __VA_ARGS__)
126 VOID
KmtVOk(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
) KMT_FORMAT(ms_printf
, 3, 0);
127 VOID
KmtOk(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, ...) KMT_FORMAT(ms_printf
, 3, 4);
128 VOID
KmtVTrace(PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
) KMT_FORMAT(ms_printf
, 2, 0);
129 VOID
KmtTrace(PCSTR FileAndLine
, PCSTR Format
, ...) KMT_FORMAT(ms_printf
, 2, 3);
130 BOOLEAN
KmtVSkip(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
) KMT_FORMAT(ms_printf
, 3, 0);
131 BOOLEAN
KmtSkip(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, ...) KMT_FORMAT(ms_printf
, 3, 4);
133 #ifdef KMT_KERNEL_MODE
134 #define ok_irql(irql) ok(KeGetCurrentIrql() == irql, "IRQL is %d, expected %d\n", KeGetCurrentIrql(), irql)
135 #endif /* defined KMT_KERNEL_MODE */
136 #define ok_eq_print(value, expected, spec) ok((value) == (expected), #value " = " spec ", expected " spec "\n", value, expected)
137 #define ok_eq_pointer(value, expected) ok_eq_print(value, expected, "%p")
138 #define ok_eq_int(value, expected) ok_eq_print(value, expected, "%d")
139 #define ok_eq_uint(value, expected) ok_eq_print(value, expected, "%u")
140 #define ok_eq_long(value, expected) ok_eq_print(value, expected, "%ld")
141 #define ok_eq_ulong(value, expected) ok_eq_print(value, expected, "%lu")
142 #define ok_eq_longlong(value, expected) ok_eq_print(value, expected, "%I64d")
143 #define ok_eq_ulonglong(value, expected) ok_eq_print(value, expected, "%I64u")
145 #define ok_eq_size(value, expected) ok_eq_print(value, (SIZE_T)(expected), "%lu")
146 #define ok_eq_longptr(value, expected) ok_eq_print(value, (LONG_PTR)(expected), "%ld")
147 #define ok_eq_ulongptr(value, expected) ok_eq_print(value, (ULONG_PTR)(expected), "%lu")
149 #define ok_eq_size(value, expected) ok_eq_print(value, (SIZE_T)(expected), "%I64u")
150 #define ok_eq_longptr(value, expected) ok_eq_print(value, (LONG_PTR)(expected), "%I64d")
151 #define ok_eq_ulongptr(value, expected) ok_eq_print(value, (ULONG_PTR)(expected), "%I64u")
152 #endif /* defined _WIN64 */
153 #define ok_eq_hex(value, expected) ok_eq_print(value, expected, "0x%08lx")
154 #define ok_bool_true(value, desc) ok((value) == TRUE, desc " FALSE, expected TRUE\n")
155 #define ok_bool_false(value, desc) ok((value) == FALSE, desc " TRUE, expected FALSE\n")
156 #define ok_eq_bool(value, expected) ok((value) == (expected), #value " = %s, expected %s\n", \
157 (value) ? "TRUE" : "FALSE", \
158 (expected) ? "TRUE" : "FALSE")
159 #define ok_eq_str(value, expected) ok(!strcmp(value, expected), #value " = \"%s\", expected \"%s\"\n", value, expected)
160 #define ok_eq_wstr(value, expected) ok(!wcscmp(value, expected), #value " = \"%ls\", expected \"%ls\"\n", value, expected)
162 #define KMT_MAKE_CODE(ControlCode) CTL_CODE(FILE_DEVICE_UNKNOWN, \
163 0xC00 + (ControlCode), \
167 #define MICROSECOND 10
168 #define MILLISECOND (1000 * MICROSECOND)
169 #define SECOND (1000 * MILLISECOND)
171 #if defined KMT_DEFINE_TEST_FUNCTIONS
173 #if defined KMT_KERNEL_MODE
174 BOOLEAN KmtIsCheckedBuild
;
175 BOOLEAN KmtIsMultiProcessorBuild
;
176 PCSTR KmtMajorFunctionNames
[] =
188 "QueryVolumeInformation",
189 "SetVolumeInformation",
193 "InternalDeviceControl/Scsi",
208 VOID
KmtSetIrql(IN KIRQL NewIrql
)
210 KIRQL Irql
= KeGetCurrentIrql();
212 KeLowerIrql(NewIrql
);
213 else if (Irql
< NewIrql
)
214 KeRaiseIrql(NewIrql
, &Irql
);
217 BOOLEAN
KmtAreInterruptsEnabled(VOID
)
219 return (__readeflags() & (1 << 9)) != 0;
222 INT __cdecl
KmtVSNPrintF(PSTR Buffer
, SIZE_T BufferMaxLength
, PCSTR Format
, va_list Arguments
) KMT_FORMAT(ms_printf
, 3, 0);
223 #elif defined KMT_USER_MODE
224 static PKMT_RESULTBUFFER
KmtAllocateResultBuffer(SIZE_T ResultBufferSize
)
226 PKMT_RESULTBUFFER Buffer
= HeapAlloc(GetProcessHeap(), 0, ResultBufferSize
);
230 Buffer
->Successes
= 0;
231 Buffer
->Failures
= 0;
233 Buffer
->LogBufferLength
= 0;
234 Buffer
->LogBufferMaxLength
= ResultBufferSize
- FIELD_OFFSET(KMT_RESULTBUFFER
, LogBuffer
);
239 static VOID
KmtFreeResultBuffer(PKMT_RESULTBUFFER Buffer
)
241 HeapFree(GetProcessHeap(), 0, Buffer
);
244 #define KmtVSNPrintF vsnprintf
245 #endif /* defined KMT_USER_MODE */
247 PKMT_RESULTBUFFER ResultBuffer
= NULL
;
249 static VOID
KmtAddToLogBuffer(PKMT_RESULTBUFFER Buffer
, PCSTR String
, SIZE_T Length
)
259 OldLength
= Buffer
->LogBufferLength
;
260 NewLength
= OldLength
+ Length
;
261 if (NewLength
> Buffer
->LogBufferMaxLength
)
263 } while (InterlockedCompareExchange(&Buffer
->LogBufferLength
, NewLength
, OldLength
) != OldLength
);
265 memcpy(&Buffer
->LogBuffer
[OldLength
], String
, Length
);
268 KMT_FORMAT(ms_printf
, 5, 0)
269 static SIZE_T
KmtXVSNPrintF(PSTR Buffer
, SIZE_T BufferMaxLength
, PCSTR FileAndLine
, PCSTR Prepend
, PCSTR Format
, va_list Arguments
)
271 SIZE_T BufferLength
= 0;
277 Slash
= strrchr(FileAndLine
, '\\');
279 FileAndLine
= Slash
+ 1;
280 Slash
= strrchr(FileAndLine
, '/');
282 FileAndLine
= Slash
+ 1;
284 Length
= min(BufferMaxLength
, strlen(FileAndLine
));
285 memcpy(Buffer
, FileAndLine
, Length
);
287 BufferLength
+= Length
;
288 BufferMaxLength
-= Length
;
292 Length
= min(BufferMaxLength
, strlen(Prepend
));
293 memcpy(Buffer
, Prepend
, Length
);
295 BufferLength
+= Length
;
296 BufferMaxLength
-= Length
;
300 Length
= KmtVSNPrintF(Buffer
, BufferMaxLength
, Format
, Arguments
);
301 /* vsnprintf can return more than maxLength, we don't want to do that */
302 BufferLength
+= min(Length
, BufferMaxLength
);
307 KMT_FORMAT(ms_printf
, 5, 6)
308 static SIZE_T
KmtXSNPrintF(PSTR Buffer
, SIZE_T BufferMaxLength
, PCSTR FileAndLine
, PCSTR Prepend
, PCSTR Format
, ...)
312 va_start(Arguments
, Format
);
313 BufferLength
= KmtXVSNPrintF(Buffer
, BufferMaxLength
, FileAndLine
, Prepend
, Format
, Arguments
);
318 VOID
KmtFinishTest(PCSTR TestName
)
320 CHAR MessageBuffer
[512];
321 SIZE_T MessageLength
;
326 MessageLength
= KmtXSNPrintF(MessageBuffer
, sizeof MessageBuffer
, NULL
, NULL
,
327 "%s: %ld tests executed (0 marked as todo, %ld failures), %ld skipped.\n",
329 ResultBuffer
->Successes
+ ResultBuffer
->Failures
,
330 ResultBuffer
->Failures
,
331 ResultBuffer
->Skipped
);
332 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
335 VOID
KmtVOk(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
)
337 CHAR MessageBuffer
[512];
338 SIZE_T MessageLength
;
345 InterlockedIncrement(&ResultBuffer
->Successes
);
347 if (0/*KmtReportSuccess*/)
349 MessageLength
= KmtXSNPrintF(MessageBuffer
, sizeof MessageBuffer
, FileAndLine
, ": Test succeeded\n", NULL
);
350 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
355 InterlockedIncrement(&ResultBuffer
->Failures
);
356 MessageLength
= KmtXVSNPrintF(MessageBuffer
, sizeof MessageBuffer
, FileAndLine
, ": Test failed: ", Format
, Arguments
);
357 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
361 VOID
KmtOk(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, ...)
364 va_start(Arguments
, Format
);
365 KmtVOk(Condition
, FileAndLine
, Format
, Arguments
);
369 VOID
KmtVTrace(PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
)
371 CHAR MessageBuffer
[512];
372 SIZE_T MessageLength
;
374 MessageLength
= KmtXVSNPrintF(MessageBuffer
, sizeof MessageBuffer
, FileAndLine
, ": ", Format
, Arguments
);
375 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
378 VOID
KmtTrace(PCSTR FileAndLine
, PCSTR Format
, ...)
381 va_start(Arguments
, Format
);
382 KmtVTrace(FileAndLine
, Format
, Arguments
);
386 BOOLEAN
KmtVSkip(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
)
388 CHAR MessageBuffer
[512];
389 SIZE_T MessageLength
;
396 InterlockedIncrement(&ResultBuffer
->Skipped
);
397 MessageLength
= KmtXVSNPrintF(MessageBuffer
, sizeof MessageBuffer
, FileAndLine
, ": Tests skipped: ", Format
, Arguments
);
398 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
404 BOOLEAN
KmtSkip(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, ...)
408 va_start(Arguments
, Format
);
409 Ret
= KmtVSkip(Condition
, FileAndLine
, Format
, Arguments
);
414 #endif /* defined KMT_DEFINE_TEST_FUNCTIONS */
416 #endif /* !defined _KMTEST_TEST_H_ */