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
[];
86 extern PDRIVER_OBJECT KmtDriverObject
;
88 VOID
KmtSetIrql(IN KIRQL NewIrql
);
89 BOOLEAN
KmtAreInterruptsEnabled(VOID
);
90 ULONG
KmtGetPoolTag(PVOID Memory
);
91 #elif defined KMT_USER_MODE
92 DWORD
KmtRunKernelTest(IN PCSTR TestName
);
94 VOID
KmtLoadDriver(IN PCWSTR ServiceName
, IN BOOLEAN RestartIfRunning
);
95 VOID
KmtUnloadDriver(VOID
);
96 VOID
KmtOpenDriver(VOID
);
97 VOID
KmtCloseDriver(VOID
);
99 DWORD
KmtSendToDriver(IN DWORD ControlCode
);
100 DWORD
KmtSendStringToDriver(IN DWORD ControlCode
, IN PCSTR String
);
101 DWORD
KmtSendBufferToDriver(IN DWORD ControlCode
, IN OUT PVOID Buffer OPTIONAL
, IN DWORD InLength
, IN OUT PDWORD OutLength
);
102 #else /* if !defined KMT_KERNEL_MODE && !defined KMT_USER_MODE */
103 #error either KMT_KERNEL_MODE or KMT_USER_MODE must be defined
104 #endif /* !defined KMT_KERNEL_MODE && !defined KMT_USER_MODE */
106 extern PKMT_RESULTBUFFER ResultBuffer
;
109 /* TODO: GCC doesn't understand %wZ :( */
110 #define KMT_FORMAT(type, fmt, first) /*__attribute__((__format__(type, fmt, first)))*/
111 #elif !defined __GNUC__
112 #define KMT_FORMAT(type, fmt, first)
113 #endif /* !defined __GNUC__ */
115 #define START_TEST(name) VOID Test_##name(VOID)
117 #ifndef KMT_STRINGIZE
118 #define KMT_STRINGIZE(x) #x
119 #endif /* !defined KMT_STRINGIZE */
120 #define ok(test, ...) ok_(test, __FILE__, __LINE__, __VA_ARGS__)
121 #define trace(...) trace_( __FILE__, __LINE__, __VA_ARGS__)
122 #define skip(test, ...) skip_(test, __FILE__, __LINE__, __VA_ARGS__)
124 #define ok_(test, file, line, ...) KmtOk(test, file ":" KMT_STRINGIZE(line), __VA_ARGS__)
125 #define trace_(file, line, ...) KmtTrace( file ":" KMT_STRINGIZE(line), __VA_ARGS__)
126 #define skip_(test, file, line, ...) KmtSkip(test, file ":" KMT_STRINGIZE(line), __VA_ARGS__)
128 BOOLEAN
KmtVOk(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
) KMT_FORMAT(ms_printf
, 3, 0);
129 BOOLEAN
KmtOk(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, ...) KMT_FORMAT(ms_printf
, 3, 4);
130 VOID
KmtVTrace(PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
) KMT_FORMAT(ms_printf
, 2, 0);
131 VOID
KmtTrace(PCSTR FileAndLine
, PCSTR Format
, ...) KMT_FORMAT(ms_printf
, 2, 3);
132 BOOLEAN
KmtVSkip(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
) KMT_FORMAT(ms_printf
, 3, 0);
133 BOOLEAN
KmtSkip(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, ...) KMT_FORMAT(ms_printf
, 3, 4);
134 PVOID
KmtAllocateGuarded(SIZE_T SizeRequested
);
135 VOID
KmtFreeGuarded(PVOID Pointer
);
137 #ifdef KMT_KERNEL_MODE
138 #define ok_irql(irql) ok(KeGetCurrentIrql() == irql, "IRQL is %d, expected %d\n", KeGetCurrentIrql(), irql)
139 #endif /* defined KMT_KERNEL_MODE */
140 #define ok_eq_print(value, expected, spec) ok((value) == (expected), #value " = " spec ", expected " spec "\n", value, expected)
141 #define ok_eq_pointer(value, expected) ok_eq_print(value, expected, "%p")
142 #define ok_eq_int(value, expected) ok_eq_print(value, expected, "%d")
143 #define ok_eq_uint(value, expected) ok_eq_print(value, expected, "%u")
144 #define ok_eq_long(value, expected) ok_eq_print(value, expected, "%ld")
145 #define ok_eq_ulong(value, expected) ok_eq_print(value, expected, "%lu")
146 #define ok_eq_longlong(value, expected) ok_eq_print(value, expected, "%I64d")
147 #define ok_eq_ulonglong(value, expected) ok_eq_print(value, expected, "%I64u")
149 #define ok_eq_size(value, expected) ok_eq_print(value, (SIZE_T)(expected), "%lu")
150 #define ok_eq_longptr(value, expected) ok_eq_print(value, (LONG_PTR)(expected), "%ld")
151 #define ok_eq_ulongptr(value, expected) ok_eq_print(value, (ULONG_PTR)(expected), "%lu")
153 #define ok_eq_size(value, expected) ok_eq_print(value, (SIZE_T)(expected), "%I64u")
154 #define ok_eq_longptr(value, expected) ok_eq_print(value, (LONG_PTR)(expected), "%I64d")
155 #define ok_eq_ulongptr(value, expected) ok_eq_print(value, (ULONG_PTR)(expected), "%I64u")
156 #endif /* defined _WIN64 */
157 #define ok_eq_hex(value, expected) ok_eq_print(value, expected, "0x%08lx")
158 #define ok_bool_true(value, desc) ok((value) == TRUE, desc " FALSE, expected TRUE\n")
159 #define ok_bool_false(value, desc) ok((value) == FALSE, desc " TRUE, expected FALSE\n")
160 #define ok_eq_bool(value, expected) ok((value) == (expected), #value " = %s, expected %s\n", \
161 (value) ? "TRUE" : "FALSE", \
162 (expected) ? "TRUE" : "FALSE")
163 #define ok_eq_str(value, expected) ok(!strcmp(value, expected), #value " = \"%s\", expected \"%s\"\n", value, expected)
164 #define ok_eq_wstr(value, expected) ok(!wcscmp(value, expected), #value " = \"%ls\", expected \"%ls\"\n", value, expected)
165 #define ok_eq_tag(value, expected) ok_eq_print(value, expected, "0x%08lx")
167 #define KMT_MAKE_CODE(ControlCode) CTL_CODE(FILE_DEVICE_UNKNOWN, \
168 0xC00 + (ControlCode), \
172 #define MICROSECOND 10
173 #define MILLISECOND (1000 * MICROSECOND)
174 #define SECOND (1000 * MILLISECOND)
176 #if defined KMT_DEFINE_TEST_FUNCTIONS
178 #if defined KMT_KERNEL_MODE
179 BOOLEAN KmtIsCheckedBuild
;
180 BOOLEAN KmtIsMultiProcessorBuild
;
181 PCSTR KmtMajorFunctionNames
[] =
193 "QueryVolumeInformation",
194 "SetVolumeInformation",
198 "InternalDeviceControl/Scsi",
213 VOID
KmtSetIrql(IN KIRQL NewIrql
)
215 KIRQL Irql
= KeGetCurrentIrql();
217 KeLowerIrql(NewIrql
);
218 else if (Irql
< NewIrql
)
219 KeRaiseIrql(NewIrql
, &Irql
);
222 BOOLEAN
KmtAreInterruptsEnabled(VOID
)
224 return (__readeflags() & (1 << 9)) != 0;
227 typedef struct _POOL_HEADER
234 USHORT PreviousSize
:8;
239 USHORT PreviousSize
:9;
253 PEPROCESS ProcessBilled
;
259 USHORT AllocatorBackTraceIndex
;
263 } POOL_HEADER
, *PPOOL_HEADER
;
265 ULONG
KmtGetPoolTag(PVOID Memory
)
269 /* it's not so easy for allocations of PAGE_SIZE */
270 if (((ULONG_PTR
)Memory
& (PAGE_SIZE
- 1)) == 0)
276 return Header
->PoolTag
;
279 INT __cdecl
KmtVSNPrintF(PSTR Buffer
, SIZE_T BufferMaxLength
, PCSTR Format
, va_list Arguments
) KMT_FORMAT(ms_printf
, 3, 0);
280 #elif defined KMT_USER_MODE
281 static PKMT_RESULTBUFFER
KmtAllocateResultBuffer(SIZE_T ResultBufferSize
)
283 PKMT_RESULTBUFFER Buffer
= HeapAlloc(GetProcessHeap(), 0, ResultBufferSize
);
287 Buffer
->Successes
= 0;
288 Buffer
->Failures
= 0;
290 Buffer
->LogBufferLength
= 0;
291 Buffer
->LogBufferMaxLength
= (ULONG
)ResultBufferSize
- FIELD_OFFSET(KMT_RESULTBUFFER
, LogBuffer
);
296 static VOID
KmtFreeResultBuffer(PKMT_RESULTBUFFER Buffer
)
298 HeapFree(GetProcessHeap(), 0, Buffer
);
301 #define KmtVSNPrintF vsnprintf
302 #endif /* defined KMT_USER_MODE */
304 PKMT_RESULTBUFFER ResultBuffer
= NULL
;
306 static VOID
KmtAddToLogBuffer(PKMT_RESULTBUFFER Buffer
, PCSTR String
, SIZE_T Length
)
316 OldLength
= Buffer
->LogBufferLength
;
317 NewLength
= OldLength
+ (ULONG
)Length
;
318 if (NewLength
> Buffer
->LogBufferMaxLength
)
320 } while (InterlockedCompareExchange(&Buffer
->LogBufferLength
, NewLength
, OldLength
) != OldLength
);
322 memcpy(&Buffer
->LogBuffer
[OldLength
], String
, Length
);
325 KMT_FORMAT(ms_printf
, 5, 0)
326 static SIZE_T
KmtXVSNPrintF(PSTR Buffer
, SIZE_T BufferMaxLength
, PCSTR FileAndLine
, PCSTR Prepend
, PCSTR Format
, va_list Arguments
)
328 SIZE_T BufferLength
= 0;
334 Slash
= strrchr(FileAndLine
, '\\');
336 FileAndLine
= Slash
+ 1;
337 Slash
= strrchr(FileAndLine
, '/');
339 FileAndLine
= Slash
+ 1;
341 Length
= min(BufferMaxLength
, strlen(FileAndLine
));
342 memcpy(Buffer
, FileAndLine
, Length
);
344 BufferLength
+= Length
;
345 BufferMaxLength
-= Length
;
349 Length
= min(BufferMaxLength
, strlen(Prepend
));
350 memcpy(Buffer
, Prepend
, Length
);
352 BufferLength
+= Length
;
353 BufferMaxLength
-= Length
;
357 Length
= KmtVSNPrintF(Buffer
, BufferMaxLength
, Format
, Arguments
);
358 /* vsnprintf can return more than maxLength, we don't want to do that */
359 BufferLength
+= min(Length
, BufferMaxLength
);
364 KMT_FORMAT(ms_printf
, 5, 6)
365 static SIZE_T
KmtXSNPrintF(PSTR Buffer
, SIZE_T BufferMaxLength
, PCSTR FileAndLine
, PCSTR Prepend
, PCSTR Format
, ...)
369 va_start(Arguments
, Format
);
370 BufferLength
= KmtXVSNPrintF(Buffer
, BufferMaxLength
, FileAndLine
, Prepend
, Format
, Arguments
);
375 VOID
KmtFinishTest(PCSTR TestName
)
377 CHAR MessageBuffer
[512];
378 SIZE_T MessageLength
;
383 MessageLength
= KmtXSNPrintF(MessageBuffer
, sizeof MessageBuffer
, NULL
, NULL
,
384 "%s: %ld tests executed (0 marked as todo, %ld failures), %ld skipped.\n",
386 ResultBuffer
->Successes
+ ResultBuffer
->Failures
,
387 ResultBuffer
->Failures
,
388 ResultBuffer
->Skipped
);
389 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
392 BOOLEAN
KmtVOk(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
)
394 CHAR MessageBuffer
[512];
395 SIZE_T MessageLength
;
398 return Condition
!= 0;
402 InterlockedIncrement(&ResultBuffer
->Successes
);
404 if (0/*KmtReportSuccess*/)
406 MessageLength
= KmtXSNPrintF(MessageBuffer
, sizeof MessageBuffer
, FileAndLine
, ": Test succeeded\n", NULL
);
407 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
412 InterlockedIncrement(&ResultBuffer
->Failures
);
413 MessageLength
= KmtXVSNPrintF(MessageBuffer
, sizeof MessageBuffer
, FileAndLine
, ": Test failed: ", Format
, Arguments
);
414 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
417 return Condition
!= 0;
420 BOOLEAN
KmtOk(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, ...)
424 va_start(Arguments
, Format
);
425 Ret
= KmtVOk(Condition
, FileAndLine
, Format
, Arguments
);
430 VOID
KmtVTrace(PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
)
432 CHAR MessageBuffer
[512];
433 SIZE_T MessageLength
;
435 MessageLength
= KmtXVSNPrintF(MessageBuffer
, sizeof MessageBuffer
, FileAndLine
, ": ", Format
, Arguments
);
436 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
439 VOID
KmtTrace(PCSTR FileAndLine
, PCSTR Format
, ...)
442 va_start(Arguments
, Format
);
443 KmtVTrace(FileAndLine
, Format
, Arguments
);
447 BOOLEAN
KmtVSkip(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, va_list Arguments
)
449 CHAR MessageBuffer
[512];
450 SIZE_T MessageLength
;
457 InterlockedIncrement(&ResultBuffer
->Skipped
);
458 MessageLength
= KmtXVSNPrintF(MessageBuffer
, sizeof MessageBuffer
, FileAndLine
, ": Tests skipped: ", Format
, Arguments
);
459 KmtAddToLogBuffer(ResultBuffer
, MessageBuffer
, MessageLength
);
465 BOOLEAN
KmtSkip(INT Condition
, PCSTR FileAndLine
, PCSTR Format
, ...)
469 va_start(Arguments
, Format
);
470 Ret
= KmtVSkip(Condition
, FileAndLine
, Format
, Arguments
);
475 PVOID
KmtAllocateGuarded(SIZE_T SizeRequested
)
478 SIZE_T Size
= PAGE_ROUND_UP(SizeRequested
+ PAGE_SIZE
);
479 PVOID VirtualMemory
= NULL
;
482 Status
= ZwAllocateVirtualMemory(ZwCurrentProcess(), &VirtualMemory
, 0, &Size
, MEM_RESERVE
, PAGE_NOACCESS
);
484 if (!NT_SUCCESS(Status
))
488 Status
= ZwAllocateVirtualMemory(ZwCurrentProcess(), &VirtualMemory
, 0, &Size
, MEM_COMMIT
, PAGE_READWRITE
);
489 if (!NT_SUCCESS(Status
))
492 Status
= ZwFreeVirtualMemory(ZwCurrentProcess(), &VirtualMemory
, &Size
, MEM_RELEASE
);
493 ok_eq_hex(Status
, STATUS_SUCCESS
);
497 StartOfBuffer
= VirtualMemory
;
498 StartOfBuffer
+= Size
- SizeRequested
;
500 return StartOfBuffer
;
503 VOID
KmtFreeGuarded(PVOID Pointer
)
506 PVOID VirtualMemory
= (PVOID
)PAGE_ROUND_DOWN((SIZE_T
)Pointer
);
509 Status
= ZwFreeVirtualMemory(ZwCurrentProcess(), &VirtualMemory
, &Size
, MEM_RELEASE
);
510 ok_eq_hex(Status
, STATUS_SUCCESS
);
513 #endif /* defined KMT_DEFINE_TEST_FUNCTIONS */
515 #endif /* !defined _KMTEST_TEST_H_ */