VirtualBox

source: vbox/trunk/src/VBox/Runtime/testcase/tstRTCritSect.cpp@ 85546

Last change on this file since 85546 was 82968, checked in by vboxsync, 5 years ago

Copyright year updates by scm.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 17.5 KB
Line 
1/* $Id: tstRTCritSect.cpp 82968 2020-02-04 10:35:17Z vboxsync $ */
2/** @file
3 * IPRT Testcase - Critical Sections.
4 */
5
6/*
7 * Copyright (C) 2006-2020 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*********************************************************************************************************************************
29* Header Files *
30*********************************************************************************************************************************/
31#ifdef TRY_WIN32_CRIT
32# include <iprt/win/windows.h>
33#endif
34#define RTCRITSECT_WITHOUT_REMAPPING
35#include <iprt/critsect.h>
36
37#include <iprt/asm.h>
38#include <iprt/assert.h>
39#include <iprt/ctype.h>
40#include <iprt/errcore.h>
41#include <iprt/initterm.h>
42#include <iprt/getopt.h>
43#include <iprt/cpp/lock.h>
44#include <iprt/log.h>
45#include <iprt/mem.h>
46#include <iprt/semaphore.h>
47#include <iprt/stream.h>
48#include <iprt/string.h>
49#include <iprt/test.h>
50#include <iprt/time.h>
51#include <iprt/thread.h>
52
53
54#ifndef TRY_WIN32_CRIT
55# define LOCKERS(sect) ((sect).cLockers)
56#else /* TRY_WIN32_CRIT */
57
58/* This is for comparing with the "real thing". */
59#define RTCRITSECT CRITICAL_SECTION
60#define PRTCRITSECT LPCRITICAL_SECTION
61#define LOCKERS(sect) (*(LONG volatile *)&(sect).LockCount)
62
63DECLINLINE(int) RTCritSectInit(PCRITICAL_SECTION pCritSect)
64{
65 InitializeCriticalSection(pCritSect);
66 return VINF_SUCCESS;
67}
68
69DECLINLINE(int) RTCritSectEnter(PCRITICAL_SECTION pCritSect)
70{
71 EnterCriticalSection(pCritSect);
72 return VINF_SUCCESS;
73}
74
75DECLINLINE(int) RTCritSectLeave(PCRITICAL_SECTION pCritSect)
76{
77 LeaveCriticalSection(pCritSect);
78 return VINF_SUCCESS;
79}
80
81DECLINLINE(int) RTCritSectDelete(PCRITICAL_SECTION pCritSect)
82{
83 DeleteCriticalSection(pCritSect);
84 return VINF_SUCCESS;
85}
86
87#endif /* TRY_WIN32_CRIT */
88
89
90/*********************************************************************************************************************************
91* Structures and Typedefs *
92*********************************************************************************************************************************/
93/**
94 * Arguments to ThreadTest1().
95 */
96typedef struct THREADTEST1ARGS
97{
98 /** The critical section. */
99 PRTCRITSECT pCritSect;
100 /** The thread ordinal. */
101 uint32_t iThread;
102 /** Pointer to the release counter. */
103 uint32_t volatile *pu32Release;
104} THREADTEST1ARGS, *PTHREADTEST1ARGS;
105
106
107/**
108 * Arguments to ThreadTest2().
109 */
110typedef struct THREADTEST2ARGS
111{
112 /** The critical section. */
113 PRTCRITSECT pCritSect;
114 /** The thread ordinal. */
115 uint32_t iThread;
116 /** Pointer to the release counter. */
117 uint32_t volatile *pu32Release;
118 /** Pointer to the alone indicator. */
119 uint32_t volatile *pu32Alone;
120 /** Pointer to the previous thread variable. */
121 uint32_t volatile *pu32Prev;
122 /** Pointer to the sequential enters counter. */
123 uint32_t volatile *pcSeq;
124 /** Pointer to the reordered enters counter. */
125 uint32_t volatile *pcReordered;
126 /** Pointer to the variable counting running threads. */
127 uint32_t volatile *pcThreadRunning;
128 /** Number of times this thread was inside the section. */
129 uint32_t volatile cTimes;
130 /** The number of threads. */
131 uint32_t cThreads;
132 /** Number of iterations (sum of all threads). */
133 uint32_t cIterations;
134 /** Yield while inside the section. */
135 unsigned cCheckLoops;
136 /** Signal this when done. */
137 RTSEMEVENT EventDone;
138} THREADTEST2ARGS, *PTHREADTEST2ARGS;
139
140
141/*********************************************************************************************************************************
142* Global Variables *
143*********************************************************************************************************************************/
144/** The test handle. */
145static RTTEST g_hTest;
146
147
148
149/**
150 * Thread which goes to sleep on the critsect and checks that it's released in the right order.
151 */
152static DECLCALLBACK(int) ThreadTest1(RTTHREAD ThreadSelf, void *pvArgs)
153{
154 RT_NOREF1(ThreadSelf);
155 THREADTEST1ARGS Args = *(PTHREADTEST1ARGS)pvArgs;
156 Log2(("ThreadTest1: Start - iThread=%d ThreadSelf=%p\n", Args.iThread, ThreadSelf));
157 RTMemFree(pvArgs);
158
159 /*
160 * Enter it.
161 */
162 int rc = RTCritSectEnter(Args.pCritSect);
163 if (RT_FAILURE(rc))
164 {
165 RTTestFailed(g_hTest, "thread %d: RTCritSectEnter -> %Rrc", Args.iThread, rc);
166 return 1;
167 }
168
169 /*
170 * Check release order.
171 */
172 if (*Args.pu32Release != Args.iThread)
173 RTTestFailed(g_hTest, "thread %d: released as number %d", Args.iThread, *Args.pu32Release);
174 ASMAtomicIncU32(Args.pu32Release);
175
176 /*
177 * Leave it.
178 */
179 rc = RTCritSectLeave(Args.pCritSect);
180 if (RT_FAILURE(rc))
181 {
182 RTTestFailed(g_hTest, "thread %d: RTCritSectEnter -> %Rrc", Args.iThread, rc);
183 return 1;
184 }
185
186 Log2(("ThreadTest1: End - iThread=%d ThreadSelf=%p\n", Args.iThread, ThreadSelf));
187 return 0;
188}
189
190
191static int Test1(unsigned cThreads)
192{
193 RTTestSubF(g_hTest, "Test #1 with %u thread", cThreads);
194
195 /*
196 * Create a critical section.
197 */
198 RTCRITSECT CritSect;
199 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectInit(&CritSect), VINF_SUCCESS, 1);
200
201 /*
202 * Enter, leave and enter again.
203 */
204 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectEnter(&CritSect), VINF_SUCCESS, 1);
205 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectLeave(&CritSect), VINF_SUCCESS, 1);
206 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectEnter(&CritSect), VINF_SUCCESS, 1);
207
208 /*
209 * Now spawn threads which will go to sleep entering the critsect.
210 */
211 uint32_t u32Release = 0;
212 for (uint32_t iThread = 0; iThread < cThreads; iThread++)
213 {
214 PTHREADTEST1ARGS pArgs = (PTHREADTEST1ARGS)RTMemAllocZ(sizeof(*pArgs));
215 pArgs->iThread = iThread;
216 pArgs->pCritSect = &CritSect;
217 pArgs->pu32Release = &u32Release;
218 int32_t iLock = LOCKERS(CritSect);
219 RTTHREAD Thread;
220 RTTEST_CHECK_RC_RET(g_hTest, RTThreadCreateF(&Thread, ThreadTest1, pArgs, 0, RTTHREADTYPE_DEFAULT, 0, "T%d", iThread), VINF_SUCCESS, 1);
221
222 /* wait for it to get into waiting. */
223 while (LOCKERS(CritSect) == iLock)
224 RTThreadSleep(10);
225 RTThreadSleep(20);
226 }
227
228 /*
229 * Now we'll release the threads and wait for all of them to quit.
230 */
231 u32Release = 0;
232 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectLeave(&CritSect), VINF_SUCCESS, 1);
233 while (u32Release < cThreads)
234 RTThreadSleep(10);
235
236 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectDelete(&CritSect), VINF_SUCCESS, 1);
237 return 0;
238}
239
240
241
242/**
243 * Thread which goes to sleep on the critsect and checks
244 * that it's released along and in the right order. This is done a number of times.
245 *
246 */
247static DECLCALLBACK(int) ThreadTest2(RTTHREAD ThreadSelf, void *pvArg)
248{
249 RT_NOREF1(ThreadSelf);
250 PTHREADTEST2ARGS pArgs = (PTHREADTEST2ARGS)pvArg;
251 Log2(("ThreadTest2: Start - iThread=%d ThreadSelf=%p\n", pArgs->iThread, ThreadSelf));
252 uint64_t u64TSStart = 0;
253 ASMAtomicIncU32(pArgs->pcThreadRunning);
254
255 for (unsigned i = 0; *pArgs->pu32Release < pArgs->cIterations; i++)
256 {
257 /*
258 * Enter it.
259 */
260 int rc = RTCritSectEnter(pArgs->pCritSect);
261 if (RT_FAILURE(rc))
262 {
263 RTTestFailed(g_hTest, "thread %d, iteration %d: RTCritSectEnter -> %d", pArgs->iThread, i, rc);
264 return 1;
265 }
266 if (!u64TSStart)
267 u64TSStart = RTTimeNanoTS();
268
269#if 0 /* We just check for sequences. */
270 /*
271 * Check release order.
272 */
273 if ((*pArgs->pu32Release % pArgs->cThreads) != pArgs->iThread)
274 RTTestFailed(g_hTest, "thread %d, iteration %d: released as number %d (%d)",
275 pArgs->iThread, i, *pArgs->pu32Release % pArgs->cThreads, *pArgs->pu32Release);
276 else
277 RTTestPrintf(g_hTest, RTTESTLVL_INFO, "iteration %d: released as number %d (%d)\n",
278 pArgs->iThread, i, *pArgs->pu32Release % pArgs->cThreads, *pArgs->pu32Release);
279#endif
280 pArgs->cTimes++;
281 ASMAtomicIncU32(pArgs->pu32Release);
282
283 /*
284 * Check distribution every now and again.
285 */
286#if 0
287 if (!(*pArgs->pu32Release % 879))
288 {
289 uint32_t u32Perfect = *pArgs->pu32Release / pArgs->cThreads;
290 for (int iThread = 0 ; iThread < (int)pArgs->cThreads; iThread++)
291 {
292 int cDiff = pArgs[iThread - pArgs->iThread].cTimes - u32Perfect;
293 if ((unsigned)RT_ABS(cDiff) > RT_MAX(u32Perfect / 10000, 2))
294 {
295 printf("tstCritSect: FAILURE - bad distribution thread %d u32Perfect=%d cTimes=%d cDiff=%d (runtime)\n",
296 iThread, u32Perfect, pArgs[iThread - pArgs->iThread].cTimes, cDiff);
297 ASMAtomicIncU32(&g_cErrors);
298 }
299 }
300 }
301#endif
302 /*
303 * Check alone and make sure we stay inside here a while
304 * so the other guys can get ready.
305 */
306 uint32_t u32;
307 for (u32 = 0; u32 < pArgs->cCheckLoops; u32++)
308 {
309 if (*pArgs->pu32Alone != ~0U)
310 {
311 RTTestFailed(g_hTest, "thread %d, iteration %d: not alone!!!", pArgs->iThread, i);
312 //AssertReleaseMsgFailed(("Not alone!\n"));
313 return 1;
314 }
315 }
316 ASMAtomicCmpXchgU32(pArgs->pu32Alone, pArgs->iThread, UINT32_MAX);
317 for (u32 = 0; u32 < pArgs->cCheckLoops; u32++)
318 {
319 if (*pArgs->pu32Alone != pArgs->iThread)
320 {
321 RTTestFailed(g_hTest, "thread %d, iteration %d: not alone!!!", pArgs->iThread, i);
322 //AssertReleaseMsgFailed(("Not alone!\n"));
323 return 1;
324 }
325 }
326 ASMAtomicXchgU32(pArgs->pu32Alone, UINT32_MAX);
327
328 /*
329 * Check for sequences.
330 */
331 if (*pArgs->pu32Prev == pArgs->iThread && pArgs->cThreads > 1)
332 ASMAtomicIncU32(pArgs->pcSeq);
333 else if ((*pArgs->pu32Prev + 1) % pArgs->cThreads != pArgs->iThread)
334 ASMAtomicIncU32(pArgs->pcReordered);
335 ASMAtomicXchgU32(pArgs->pu32Prev, pArgs->iThread);
336
337 /*
338 * Leave it.
339 */
340 rc = RTCritSectLeave(pArgs->pCritSect);
341 if (RT_FAILURE(rc))
342 {
343 RTTestFailed(g_hTest, "thread %d, iteration %d: RTCritSectEnter -> %d", pArgs->iThread, i, rc);
344 return 1;
345 }
346 }
347
348 uint64_t u64TSEnd = RTTimeNanoTS(); NOREF(u64TSEnd);
349 ASMAtomicDecU32(pArgs->pcThreadRunning);
350 RTSemEventSignal(pArgs->EventDone);
351 Log2(("ThreadTest2: End - iThread=%d ThreadSelf=%p time=%lld\n", pArgs->iThread, ThreadSelf, u64TSEnd - u64TSStart));
352 return 0;
353}
354
355static int Test2(unsigned cThreads, unsigned cIterations, unsigned cCheckLoops)
356{
357 RTTestSubF(g_hTest, "Test #2 - cThreads=%u cIterations=%u cCheckLoops=%u", cThreads, cIterations, cCheckLoops);
358
359 /*
360 * Create a critical section.
361 */
362 RTCRITSECT CritSect;
363 int rc;
364 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectInit(&CritSect), VINF_SUCCESS, 1);
365
366 /*
367 * Enter, leave and enter again.
368 */
369 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectEnter(&CritSect), VINF_SUCCESS, 1);
370 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectLeave(&CritSect), VINF_SUCCESS, 1);
371 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectEnter(&CritSect), VINF_SUCCESS, 1);
372
373 /*
374 * Now spawn threads which will go to sleep entering the critsect.
375 */
376 PTHREADTEST2ARGS paArgs = (PTHREADTEST2ARGS)RTMemAllocZ(sizeof(THREADTEST2ARGS) * cThreads);
377 RTSEMEVENT EventDone;
378 RTTEST_CHECK_RC_RET(g_hTest, RTSemEventCreate(&EventDone), VINF_SUCCESS, 1);
379 uint32_t volatile u32Release = 0;
380 uint32_t volatile u32Alone = UINT32_MAX;
381 uint32_t volatile u32Prev = UINT32_MAX;
382 uint32_t volatile cSeq = 0;
383 uint32_t volatile cReordered = 0;
384 uint32_t volatile cThreadRunning = 0;
385 unsigned iThread;
386 for (iThread = 0; iThread < cThreads; iThread++)
387 {
388 paArgs[iThread].iThread = iThread;
389 paArgs[iThread].pCritSect = &CritSect;
390 paArgs[iThread].pu32Release = &u32Release;
391 paArgs[iThread].pu32Alone = &u32Alone;
392 paArgs[iThread].pu32Prev = &u32Prev;
393 paArgs[iThread].pcSeq = &cSeq;
394 paArgs[iThread].pcReordered = &cReordered;
395 paArgs[iThread].pcThreadRunning = &cThreadRunning;
396 paArgs[iThread].cTimes = 0;
397 paArgs[iThread].cThreads = cThreads;
398 paArgs[iThread].cIterations = cIterations;
399 paArgs[iThread].cCheckLoops = cCheckLoops;
400 paArgs[iThread].EventDone = EventDone;
401 int32_t iLock = LOCKERS(CritSect);
402 char szThread[17];
403 RTStrPrintf(szThread, sizeof(szThread), "T%d", iThread);
404 RTTHREAD Thread;
405 rc = RTThreadCreate(&Thread, ThreadTest2, &paArgs[iThread], 0, RTTHREADTYPE_DEFAULT, 0, szThread);
406 if (RT_FAILURE(rc))
407 {
408 RTTestFailed(g_hTest, "RTThreadCreate -> %d", rc);
409 return 1;
410 }
411 /* wait for it to get into waiting. */
412 while (LOCKERS(CritSect) == iLock)
413 RTThreadSleep(10);
414 RTThreadSleep(20);
415 }
416 RTTestPrintf(g_hTest, RTTESTLVL_INFO, "threads created...\n");
417
418 /*
419 * Now we'll release the threads and wait for all of them to quit.
420 */
421 u32Release = 0;
422 uint64_t u64TSStart = RTTimeNanoTS();
423 RTTEST_CHECK_RC_RET(g_hTest, RTCritSectLeave(&CritSect), VINF_SUCCESS, 1);
424
425 while (cThreadRunning > 0)
426 RTSemEventWait(EventDone, RT_INDEFINITE_WAIT);
427 uint64_t u64TSEnd = RTTimeNanoTS();
428
429 /*
430 * Clean up and report results.
431 */
432 RTTEST_CHECK_RC(g_hTest, RTCritSectDelete(&CritSect), VINF_SUCCESS);
433
434 /* sequences */
435 if (cSeq > RT_MAX(u32Release / 10000, 1))
436 RTTestFailed(g_hTest, "too many same thread sequences! cSeq=%d\n", cSeq);
437
438 /* distribution caused by sequences / reordering. */
439 unsigned cDiffTotal = 0;
440 uint32_t u32Perfect = (u32Release + cThreads / 2) / cThreads;
441 for (iThread = 0; iThread < cThreads; iThread++)
442 {
443 int cDiff = paArgs[iThread].cTimes - u32Perfect;
444 if ((unsigned)RT_ABS(cDiff) > RT_MAX(u32Perfect / 10000, 2))
445 RTTestFailed(g_hTest, "bad distribution thread %d u32Perfect=%d cTimes=%d cDiff=%d\n",
446 iThread, u32Perfect, paArgs[iThread].cTimes, cDiff);
447 cDiffTotal += RT_ABS(cDiff);
448 }
449
450 uint32_t cMillies = (uint32_t)((u64TSEnd - u64TSStart) / 1000000);
451 RTTestPrintf(g_hTest, RTTESTLVL_ALWAYS,
452 "%d enter+leave in %dms cSeq=%d cReordered=%d cDiffTotal=%d\n",
453 u32Release, cMillies, cSeq, cReordered, cDiffTotal);
454 return 0;
455}
456
457
458int main(int argc, char **argv)
459{
460 RTTEST hTest;
461#ifndef TRY_WIN32_CRT
462 int rc = RTTestInitAndCreate("tstRTCritSect", &hTest);
463#else
464 int rc = RTTestInitAndCreate("tstRTCritSectW32", &hTest);
465#endif
466 if (rc)
467 return rc;
468 RTTestBanner(hTest);
469 g_hTest = hTest;
470
471 /* parse args. */
472 static const RTGETOPTDEF s_aOptions[] =
473 {
474 { "--distribution", 'd', RTGETOPT_REQ_NOTHING },
475 { "--help", 'h', RTGETOPT_REQ_NOTHING }
476 };
477
478 bool fTestDistribution = false;
479
480 int ch;
481 RTGETOPTUNION ValueUnion;
482 RTGETOPTSTATE GetState;
483 RTGetOptInit(&GetState, argc, argv, s_aOptions, RT_ELEMENTS(s_aOptions), 1, 0);
484 while ((ch = RTGetOpt(&GetState, &ValueUnion)))
485 {
486 switch (ch)
487 {
488 case 'd':
489 fTestDistribution = true;
490 break;
491
492 case 'h':
493 RTTestIPrintf(RTTESTLVL_ALWAYS, "%s [--help|-h] [--distribution|-d]\n", argv[0]);
494 return 1;
495
496 case 'V':
497 RTPrintf("$Revision: 82968 $\n");
498 return 0;
499
500 default:
501 return RTGetOptPrintError(ch, &ValueUnion);
502 }
503 }
504
505
506 /*
507 * Perform the testing.
508 */
509 if ( !Test1(1)
510 && !Test1(3)
511 && !Test1(10)
512 && !Test1(63))
513 {
514
515 if ( fTestDistribution
516 && !Test2(1, 200000, 1000)
517 && !Test2(2, 200000, 1000)
518 && !Test2(3, 200000, 1000)
519 && !Test2(4, 200000, 1000)
520 && !Test2(5, 200000, 1000)
521 && !Test2(7, 200000, 1000)
522 && !Test2(67, 200000, 1000))
523 {
524 /*nothing*/;
525 }
526 }
527
528 /*
529 * Summary.
530 */
531 return RTTestSummaryAndDestroy(hTest);
532}
533
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette