2 * PROJECT: ReactOS kernel-mode tests
3 * LICENSE: GPLv2+ - See COPYING in the top level directory
4 * PURPOSE: Kernel-Mode Test Suite Spin lock test
5 * PROGRAMMER: Thomas Faber <thomas.faber@reactos.org>
9 __declspec(dllimport
) void __stdcall
KeAcquireSpinLock(unsigned long *, unsigned char *);
10 __declspec(dllimport
) void __stdcall
KeReleaseSpinLock(unsigned long *, unsigned char);
11 __declspec(dllimport
) void __stdcall
KeAcquireSpinLockAtDpcLevel(unsigned long *);
12 __declspec(dllimport
) void __stdcall
KeReleaseSpinLockFromDpcLevel(unsigned long *);
15 /* this define makes KeInitializeSpinLock not use the inlined version */
16 #define WIN9X_COMPAT_SPINLOCK
25 _IRQL_requires_min_(DISPATCH_LEVEL
)
26 _Post_satisfies_(return == 1 || return == 0)
29 *pKeTryToAcquireSpinLockAtDpcLevel
)(
30 _Inout_
_Requires_lock_not_held_(*_Curr_
)
31 _When_(return!=0, _Acquires_lock_(*_Curr_
))
32 PKSPIN_LOCK SpinLock
);
37 *pKeAcquireInStackQueuedSpinLockForDpc
)(
38 IN OUT PKSPIN_LOCK SpinLock
,
39 OUT PKLOCK_QUEUE_HANDLE LockHandle
);
44 *pKeReleaseInStackQueuedSpinLockForDpc
)(
45 IN PKLOCK_QUEUE_HANDLE LockHandle
);
52 _In_ PKSPIN_LOCK SpinLock
);
54 /* TODO: multiprocessor testing */
57 typedef struct _CHECK_DATA CHECK_DATA
, *PCHECK_DATA
;
59 typedef VOID (*PACQUIRE_FUNCTION
)(PKSPIN_LOCK
, PCHECK_DATA
);
60 typedef VOID (*PRELEASE_FUNCTION
)(PKSPIN_LOCK
, PCHECK_DATA
);
61 typedef BOOLEAN (*PTRY_FUNCTION
)(PKSPIN_LOCK
, PCHECK_DATA
);
71 KIRQL IrqlWhenAcquired
;
72 PACQUIRE_FUNCTION Acquire
;
73 PRELEASE_FUNCTION Release
;
74 PTRY_FUNCTION TryAcquire
;
75 PACQUIRE_FUNCTION AcquireNoRaise
;
76 PRELEASE_FUNCTION ReleaseNoLower
;
77 PTRY_FUNCTION TryAcquireNoRaise
;
78 KSPIN_LOCK_QUEUE_NUMBER QueueNumber
;
79 BOOLEAN TryRetOnFailure
;
82 _ANONYMOUS_UNION
union
84 KLOCK_QUEUE_HANDLE QueueHandle
;
85 PKSPIN_LOCK_QUEUE Queue
;
91 #define DEFINE_ACQUIRE(LocalName, SetIsAcquired, DoCall) \
92 static VOID LocalName(PKSPIN_LOCK SpinLock, PCHECK_DATA CheckData) \
94 ASSERT(!CheckData->IsAcquired); \
96 if (SetIsAcquired) CheckData->IsAcquired = TRUE; \
99 #define DEFINE_RELEASE(LocalName, SetIsAcquired, DoCall) \
100 static VOID LocalName(PKSPIN_LOCK SpinLock, PCHECK_DATA CheckData) \
103 if (SetIsAcquired) CheckData->IsAcquired = FALSE; \
106 DEFINE_ACQUIRE(AcquireNormal
, TRUE
, KeAcquireSpinLock(SpinLock
, &CheckData
->Irql
))
107 DEFINE_RELEASE(ReleaseNormal
, TRUE
, KeReleaseSpinLock(SpinLock
, CheckData
->Irql
))
109 DEFINE_ACQUIRE(AcquireExp
, TRUE
, (KeAcquireSpinLock
)(SpinLock
, &CheckData
->Irql
))
110 DEFINE_RELEASE(ReleaseExp
, TRUE
, (KeReleaseSpinLock
)(SpinLock
, CheckData
->Irql
))
112 DEFINE_ACQUIRE(AcquireExp
, TRUE
, KeAcquireSpinLock(SpinLock
, &CheckData
->Irql
))
113 DEFINE_RELEASE(ReleaseExp
, TRUE
, KeReleaseSpinLock(SpinLock
, CheckData
->Irql
))
115 DEFINE_ACQUIRE(AcquireSynch
, TRUE
, CheckData
->Irql
= KeAcquireSpinLockRaiseToSynch(SpinLock
))
117 DEFINE_ACQUIRE(AcquireInStackQueued
, TRUE
, KeAcquireInStackQueuedSpinLock(SpinLock
, &CheckData
->QueueHandle
))
118 DEFINE_ACQUIRE(AcquireInStackSynch
, TRUE
, KeAcquireInStackQueuedSpinLockRaiseToSynch(SpinLock
, &CheckData
->QueueHandle
))
119 DEFINE_RELEASE(ReleaseInStackQueued
, TRUE
, KeReleaseInStackQueuedSpinLock(&CheckData
->QueueHandle
))
121 DEFINE_ACQUIRE(AcquireQueued
, TRUE
, CheckData
->Irql
= KeAcquireQueuedSpinLock(CheckData
->QueueNumber
))
122 DEFINE_ACQUIRE(AcquireQueuedSynch
, TRUE
, CheckData
->Irql
= KeAcquireQueuedSpinLockRaiseToSynch(CheckData
->QueueNumber
))
123 DEFINE_RELEASE(ReleaseQueued
, TRUE
, KeReleaseQueuedSpinLock(CheckData
->QueueNumber
, CheckData
->Irql
))
125 DEFINE_ACQUIRE(AcquireNoRaise
, FALSE
, KeAcquireSpinLockAtDpcLevel(SpinLock
))
126 DEFINE_RELEASE(ReleaseNoLower
, FALSE
, KeReleaseSpinLockFromDpcLevel(SpinLock
))
127 DEFINE_ACQUIRE(AcquireExpNoRaise
, FALSE
, (KeAcquireSpinLockAtDpcLevel
)(SpinLock
))
128 DEFINE_RELEASE(ReleaseExpNoLower
, FALSE
, (KeReleaseSpinLockFromDpcLevel
)(SpinLock
))
130 DEFINE_ACQUIRE(AcquireInStackNoRaise
, FALSE
, KeAcquireInStackQueuedSpinLockAtDpcLevel(SpinLock
, &CheckData
->QueueHandle
))
131 DEFINE_RELEASE(ReleaseInStackNoRaise
, FALSE
, KeReleaseInStackQueuedSpinLockFromDpcLevel(&CheckData
->QueueHandle
))
133 /* TODO: test these functions. They behave weirdly, though */
135 DEFINE_ACQUIRE(AcquireForDpc
, TRUE
, CheckData
->Irql
= KeAcquireSpinLockForDpc(SpinLock
))
136 DEFINE_RELEASE(ReleaseForDpc
, TRUE
, KeReleaseSpinLockForDpc(SpinLock
, CheckData
->Irql
))
139 DEFINE_ACQUIRE(AcquireInStackForDpc
, FALSE
, pKeAcquireInStackQueuedSpinLockForDpc(SpinLock
, &CheckData
->QueueHandle
))
140 DEFINE_RELEASE(ReleaseInStackForDpc
, FALSE
, pKeReleaseInStackQueuedSpinLockForDpc(&CheckData
->QueueHandle
))
143 DEFINE_ACQUIRE(AcquireInt
, FALSE
, KiAcquireSpinLock(SpinLock
))
144 DEFINE_RELEASE(ReleaseInt
, FALSE
, KiReleaseSpinLock(SpinLock
))
146 DEFINE_ACQUIRE(AcquireInt
, TRUE
, KeAcquireSpinLock(SpinLock
, &CheckData
->Irql
))
147 DEFINE_RELEASE(ReleaseInt
, TRUE
, KeReleaseSpinLock(SpinLock
, CheckData
->Irql
))
150 BOOLEAN
TryQueued(PKSPIN_LOCK SpinLock
, PCHECK_DATA CheckData
) {
151 LOGICAL Ret
= KeTryToAcquireQueuedSpinLock(CheckData
->QueueNumber
, &CheckData
->Irql
);
152 CheckData
->IsAcquired
= TRUE
;
153 ASSERT(Ret
== FALSE
|| Ret
== TRUE
);
156 BOOLEAN
TryQueuedSynch(PKSPIN_LOCK SpinLock
, PCHECK_DATA CheckData
) {
157 BOOLEAN Ret
= KeTryToAcquireQueuedSpinLockRaiseToSynch(CheckData
->QueueNumber
, &CheckData
->Irql
);
158 CheckData
->IsAcquired
= TRUE
;
161 BOOLEAN
TryNoRaise(PKSPIN_LOCK SpinLock
, PCHECK_DATA CheckData
) {
162 BOOLEAN Ret
= pKeTryToAcquireSpinLockAtDpcLevel(SpinLock
);
166 #define CheckSpinLockLock(SpinLock, CheckData, Value) do \
168 PKTHREAD Thread = KeGetCurrentThread(); \
169 UNREFERENCED_LOCAL_VARIABLE(Thread); \
170 if (KmtIsMultiProcessorBuild) \
172 ok_eq_bool(Ret, (Value) == 0); \
174 ok_eq_ulongptr(*(SpinLock), \
175 (Value) ? (ULONG_PTR)Thread | 1 : 0); \
179 ok_bool_true(Ret, "KeTestSpinLock returned"); \
181 ok_eq_ulongptr(*(SpinLock), 0); \
183 ok_eq_uint((CheckData)->Irql, (CheckData)->OriginalIrql); \
186 #define CheckSpinLockQueue(SpinLock, CheckData, Value) do \
188 ok_eq_pointer((CheckData)->Queue->Next, NULL); \
189 ok_eq_pointer((CheckData)->Queue->Lock, NULL); \
190 ok_eq_uint((CheckData)->Irql, (CheckData)->OriginalIrql); \
193 #define CheckSpinLockQueueHandle(SpinLock, CheckData, Value) do \
195 if (KmtIsMultiProcessorBuild) \
197 ok_eq_bool(Ret, (Value) == 0); \
199 ok_eq_ulongptr(*(SpinLock), \
200 (Value) ? &(CheckData)->QueueHandle : 0); \
201 ok_eq_pointer((CheckData)->QueueHandle.LockQueue.Next, NULL); \
202 ok_eq_pointer((CheckData)->QueueHandle.LockQueue.Lock, \
203 (PVOID)((ULONG_PTR)SpinLock | ((Value) ? 2 : 0))); \
207 ok_bool_true(Ret, "KeTestSpinLock returned"); \
209 ok_eq_ulongptr(*(SpinLock), 0); \
210 ok_eq_pointer((CheckData)->QueueHandle.LockQueue.Next, (CheckData)->UntouchedValue); \
211 ok_eq_pointer((CheckData)->QueueHandle.LockQueue.Lock, (CheckData)->UntouchedValue); \
213 ok_eq_uint((CheckData)->QueueHandle.OldIrql, (CheckData)->OriginalIrql); \
216 #define CheckSpinLock(SpinLock, CheckData, Value) do \
218 BOOLEAN Ret = SpinLock && pKeTestSpinLock ? pKeTestSpinLock(SpinLock) : TRUE; \
219 KIRQL ExpectedIrql = (CheckData)->OriginalIrql; \
221 switch ((CheckData)->Check) \
224 CheckSpinLockLock(SpinLock, CheckData, Value); \
227 CheckSpinLockQueue(SpinLock, CheckData, Value); \
229 case CheckQueueHandle: \
230 CheckSpinLockQueueHandle(SpinLock, CheckData, Value); \
234 if ((CheckData)->IsAcquired) \
235 ExpectedIrql = (CheckData)->IrqlWhenAcquired; \
236 ok_irql(ExpectedIrql); \
237 ok_bool_false(KeAreApcsDisabled(), "KeAreApcsDisabled returned"); \
238 ok_bool_true(KmtAreInterruptsEnabled(), "Interrupts enabled:"); \
244 PKSPIN_LOCK SpinLock
,
245 PCHECK_DATA CheckData
)
248 trace("Test SpinLock run %d\n", Run
++);
250 ok_irql(CheckData
->OriginalIrql
);
253 ok_eq_ulongptr(*SpinLock
, 0);
254 CheckData
->Acquire(SpinLock
, CheckData
);
255 CheckSpinLock(SpinLock
, CheckData
, 1);
256 CheckData
->Release(SpinLock
, CheckData
);
257 CheckSpinLock(SpinLock
, CheckData
, 0);
259 if (CheckData
->TryAcquire
)
261 CheckSpinLock(SpinLock
, CheckData
, 0);
262 ok_bool_true(CheckData
->TryAcquire(SpinLock
, CheckData
), "TryAcquire returned");
263 CheckSpinLock(SpinLock
, CheckData
, 1);
264 if (!KmtIsCheckedBuild
)
266 /* SPINLOCK_ALREADY_OWNED on checked build */
267 ok_bool_true(CheckData
->TryAcquire(SpinLock
, CheckData
), "TryAcquire returned");
268 /* even a failing acquire sets irql */
269 ok_eq_uint(CheckData
->Irql
, CheckData
->IrqlWhenAcquired
);
270 CheckData
->Irql
= CheckData
->OriginalIrql
;
271 CheckSpinLock(SpinLock
, CheckData
, 1);
273 CheckData
->Release(SpinLock
, CheckData
);
274 CheckSpinLock(SpinLock
, CheckData
, 0);
277 if (CheckData
->AcquireNoRaise
&&
278 (CheckData
->OriginalIrql
>= DISPATCH_LEVEL
|| !KmtIsCheckedBuild
) &&
279 (CheckData
->AcquireNoRaise
!= AcquireInStackForDpc
||
280 !skip(pKeAcquireInStackQueuedSpinLockForDpc
&&
281 pKeReleaseInStackQueuedSpinLockForDpc
, "No DPC spinlock functions\n")))
283 /* acquire/release without irql change */
284 CheckData
->AcquireNoRaise(SpinLock
, CheckData
);
285 CheckSpinLock(SpinLock
, CheckData
, 1);
286 CheckData
->ReleaseNoLower(SpinLock
, CheckData
);
287 CheckSpinLock(SpinLock
, CheckData
, 0);
289 /* acquire without raise, but normal release */
290 CheckData
->AcquireNoRaise(SpinLock
, CheckData
);
291 CheckSpinLock(SpinLock
, CheckData
, 1);
292 CheckData
->Release(SpinLock
, CheckData
);
293 CheckSpinLock(SpinLock
, CheckData
, 0);
295 /* acquire normally but release without lower */
296 CheckData
->Acquire(SpinLock
, CheckData
);
297 CheckSpinLock(SpinLock
, CheckData
, 1);
298 CheckData
->ReleaseNoLower(SpinLock
, CheckData
);
299 CheckSpinLock(SpinLock
, CheckData
, 0);
300 CheckData
->IsAcquired
= FALSE
;
301 KmtSetIrql(CheckData
->OriginalIrql
);
303 if (CheckData
->TryAcquireNoRaise
&&
304 !skip(pKeTryToAcquireSpinLockAtDpcLevel
!= NULL
, "KeTryToAcquireSpinLockAtDpcLevel unavailable\n"))
306 CheckSpinLock(SpinLock
, CheckData
, 0);
307 ok_bool_true(CheckData
->TryAcquireNoRaise(SpinLock
, CheckData
), "TryAcquireNoRaise returned");
308 CheckSpinLock(SpinLock
, CheckData
, 1);
309 if (!KmtIsCheckedBuild
)
311 ok_bool_true(CheckData
->TryAcquireNoRaise(SpinLock
, CheckData
), "TryAcquireNoRaise returned");
312 CheckSpinLock(SpinLock
, CheckData
, 1);
314 CheckData
->ReleaseNoLower(SpinLock
, CheckData
);
315 CheckSpinLock(SpinLock
, CheckData
, 0);
319 ok_irql(CheckData
->OriginalIrql
);
320 /* make sure we survive this in case of error */
321 KmtSetIrql(CheckData
->OriginalIrql
);
324 START_TEST(KeSpinLock
)
326 KSPIN_LOCK SpinLock
= (KSPIN_LOCK
)0x5555555555555555LL
;
327 PKSPIN_LOCK pSpinLock
= &SpinLock
;
328 KIRQL Irql
, SynchIrql
= KmtIsMultiProcessorBuild
? IPI_LEVEL
- 2 : DISPATCH_LEVEL
;
329 KIRQL OriginalIrqls
[] = { PASSIVE_LEVEL
, APC_LEVEL
, DISPATCH_LEVEL
, HIGH_LEVEL
};
330 CHECK_DATA TestData
[] =
332 { CheckLock
, DISPATCH_LEVEL
, AcquireNormal
, ReleaseNormal
, NULL
, AcquireNoRaise
, ReleaseNoLower
, TryNoRaise
},
333 { CheckLock
, DISPATCH_LEVEL
, AcquireExp
, ReleaseExp
, NULL
, AcquireExpNoRaise
, ReleaseExpNoLower
, NULL
},
334 /* TODO: this one is just weird!
335 { CheckLock, DISPATCH_LEVEL, AcquireNormal, ReleaseNormal, NULL, AcquireForDpc, ReleaseForDpc, NULL },*/
336 { CheckLock
, DISPATCH_LEVEL
, AcquireNormal
, ReleaseNormal
, NULL
, AcquireInt
, ReleaseInt
, NULL
},
337 { CheckLock
, SynchIrql
, AcquireSynch
, ReleaseNormal
, NULL
, NULL
, NULL
, NULL
},
338 { CheckQueueHandle
, DISPATCH_LEVEL
, AcquireInStackQueued
, ReleaseInStackQueued
, NULL
, AcquireInStackNoRaise
, ReleaseInStackNoRaise
, NULL
},
339 { CheckQueueHandle
, SynchIrql
, AcquireInStackSynch
, ReleaseInStackQueued
, NULL
, NULL
, NULL
, NULL
},
340 { CheckQueueHandle
, DISPATCH_LEVEL
, AcquireInStackQueued
, ReleaseInStackQueued
, NULL
, AcquireInStackForDpc
, ReleaseInStackForDpc
, NULL
},
341 { CheckQueue
, DISPATCH_LEVEL
, AcquireQueued
, ReleaseQueued
, TryQueued
, NULL
, NULL
, NULL
, LockQueuePfnLock
},
342 { CheckQueue
, SynchIrql
, AcquireQueuedSynch
, ReleaseQueued
, TryQueuedSynch
, NULL
, NULL
, NULL
, LockQueuePfnLock
},
347 pKeTryToAcquireSpinLockAtDpcLevel
= KmtGetSystemRoutineAddress(L
"KeTryToAcquireSpinLockAtDpcLevel");
348 pKeAcquireInStackQueuedSpinLockForDpc
= KmtGetSystemRoutineAddress(L
"KeAcquireInStackQueuedSpinLockForDpc");
349 pKeReleaseInStackQueuedSpinLockForDpc
= KmtGetSystemRoutineAddress(L
"KeReleaseInStackQueuedSpinLockForDpc");
350 pKeTestSpinLock
= KmtGetSystemRoutineAddress(L
"KeTestSpinLock");
352 Prcb
= KeGetCurrentPrcb();
354 /* KeInitializeSpinLock */
355 memset(&SpinLock
, 0x55, sizeof SpinLock
);
356 KeInitializeSpinLock(&SpinLock
);
357 ok_eq_ulongptr(SpinLock
, 0);
360 if (!skip(pKeTestSpinLock
!= NULL
, "KeTestSpinLock unavailable\n"))
362 ok_bool_true(pKeTestSpinLock(&SpinLock
), "KeTestSpinLock returned");
364 ok_bool_false(pKeTestSpinLock(&SpinLock
), "KeTestSpinLock returned");
366 ok_bool_false(pKeTestSpinLock(&SpinLock
), "KeTestSpinLock returned");
367 SpinLock
= (ULONG_PTR
)-1;
368 ok_bool_false(pKeTestSpinLock(&SpinLock
), "KeTestSpinLock returned");
369 SpinLock
= (ULONG_PTR
)1 << (sizeof(ULONG_PTR
) * CHAR_BIT
- 1);
370 ok_bool_false(pKeTestSpinLock(&SpinLock
), "KeTestSpinLock returned");
372 ok_bool_true(pKeTestSpinLock(&SpinLock
), "KeTestSpinLock returned");
375 /* on UP none of the following functions actually looks at the spinlock! */
376 if (!KmtIsMultiProcessorBuild
&& !KmtIsCheckedBuild
)
379 for (i
= 0; i
< sizeof TestData
/ sizeof TestData
[0]; ++i
)
381 memset(&SpinLock
, 0x55, sizeof SpinLock
);
382 KeInitializeSpinLock(&SpinLock
);
383 if (TestData
[i
].Check
== CheckQueueHandle
)
384 memset(&TestData
[i
].QueueHandle
, 0x55, sizeof TestData
[i
].QueueHandle
);
385 if (TestData
[i
].Check
== CheckQueue
)
387 TestData
[i
].Queue
= &Prcb
->LockQueue
[TestData
[i
].QueueNumber
];
388 TestData
[i
].UntouchedValue
= NULL
;
391 TestData
[i
].UntouchedValue
= (PVOID
)0x5555555555555555LL
;
393 for (iIrql
= 0; iIrql
< sizeof OriginalIrqls
/ sizeof OriginalIrqls
[0]; ++iIrql
)
395 if (KmtIsCheckedBuild
&& OriginalIrqls
[iIrql
] > DISPATCH_LEVEL
)
397 KeRaiseIrql(OriginalIrqls
[iIrql
], &Irql
);
398 TestData
[i
].OriginalIrql
= OriginalIrqls
[iIrql
];
399 TestData
[i
].IsAcquired
= FALSE
;
400 TestSpinLock(pSpinLock
, &TestData
[i
]);
405 KmtSetIrql(PASSIVE_LEVEL
);