VirtualBox

source: vbox/trunk/src/VBox/Runtime/testcase/tstRTMemCache.cpp@ 82968

Last change on this file since 82968 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 Author Date Id Revision
File size: 11.8 KB
Line 
1/* $Id: tstRTMemCache.cpp 82968 2020-02-04 10:35:17Z vboxsync $ */
2/** @file
3 * IPRT Testcase - RTMemCache.
4 */
5
6/*
7 * Copyright (C) 2010-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#include <iprt/memcache.h>
32
33#include <iprt/asm.h>
34#include <iprt/err.h>
35#include <iprt/initterm.h>
36#include <iprt/mem.h>
37#include <iprt/param.h>
38#include <iprt/rand.h>
39#include <iprt/string.h>
40#include <iprt/semaphore.h>
41#include <iprt/test.h>
42#include <iprt/time.h>
43#include <iprt/thread.h>
44
45
46/*********************************************************************************************************************************
47* Structures and Typedefs *
48*********************************************************************************************************************************/
49typedef struct TST3THREAD
50{
51 RTTHREAD hThread;
52 RTSEMEVENTMULTI hEvt;
53 uint64_t volatile cIterations;
54 uint32_t cbObject;
55 bool fUseCache;
56} TST3THREAD, *PTST3THREAD;
57
58
59/*********************************************************************************************************************************
60* Global Variables *
61*********************************************************************************************************************************/
62/** The test handle */
63static RTTEST g_hTest;
64/** Global mem cache handle for use in some of the testcases. */
65static RTMEMCACHE g_hMemCache;
66/** Stop indicator for tst3 threads. */
67static bool volatile g_fTst3Stop;
68
69
70/**
71 * Basic API checks.
72 * We'll return if any of these fails.
73 */
74static void tst1(void)
75{
76 RTTestISub("Basics");
77
78 /* Create one without constructor or destructor. */
79 uint32_t const cObjects = PAGE_SIZE * 2 / 256;
80 RTMEMCACHE hMemCache;
81 RTTESTI_CHECK_RC_RETV(RTMemCacheCreate(&hMemCache, 256, cObjects, 32, NULL, NULL, NULL, 0 /*fFlags*/), VINF_SUCCESS);
82 RTTESTI_CHECK_RETV(hMemCache != NIL_RTMEMCACHE);
83
84 /* Allocate a bit and free it again. */
85 void *pv = NULL;
86 RTTESTI_CHECK_RC_RETV(RTMemCacheAllocEx(hMemCache, &pv), VINF_SUCCESS);
87 RTTESTI_CHECK_RETV(pv != NULL);
88 RTTESTI_CHECK_RETV(RT_ALIGN_P(pv, 32) == pv);
89 RTMemCacheFree(hMemCache, pv);
90
91 RTTESTI_CHECK((pv = RTMemCacheAlloc(hMemCache)) != NULL);
92 RTMemCacheFree(hMemCache, pv);
93
94 /* Allocate everything and free it again, checking size constraints. */
95 for (uint32_t iLoop = 0; iLoop < 20; iLoop++)
96 {
97 /* Allocate everything. */
98 void *apv[cObjects];
99 for (uint32_t i = 0; i < cObjects; i++)
100 {
101 apv[i] = NULL;
102 RTTESTI_CHECK_RC(RTMemCacheAllocEx(hMemCache, &apv[i]), VINF_SUCCESS);
103 }
104
105 /* Check that we've got it all. */
106 int rc;
107 RTTESTI_CHECK_RC(rc = RTMemCacheAllocEx(hMemCache, &pv), VERR_MEM_CACHE_MAX_SIZE);
108 if (RT_SUCCESS(rc))
109 RTMemCacheFree(hMemCache, pv);
110
111 RTTESTI_CHECK((pv = RTMemCacheAlloc(hMemCache)) == NULL);
112 RTMemCacheFree(hMemCache, pv);
113
114 /* Free all the allocations. */
115 for (uint32_t i = 0; i < cObjects; i++)
116 {
117 RTMemCacheFree(hMemCache, apv[i]);
118
119 RTTESTI_CHECK((pv = RTMemCacheAlloc(hMemCache)) != NULL);
120 RTMemCacheFree(hMemCache, pv);
121 }
122 }
123
124 /* Destroy it. */
125 RTTESTI_CHECK_RC(RTMemCacheDestroy(hMemCache), VINF_SUCCESS);
126 RTTESTI_CHECK_RC(RTMemCacheDestroy(NIL_RTMEMCACHE), VINF_SUCCESS);
127}
128
129
130
131/** Constructor for tst2. */
132static DECLCALLBACK(int) tst2Ctor(RTMEMCACHE hMemCache, void *pvObj, void *pvUser)
133{
134 RTTESTI_CHECK(hMemCache == g_hMemCache);
135 RTTESTI_CHECK(ASMMemIsZero(pvObj, 256));
136
137 if (*(bool *)pvUser)
138 return VERR_RESOURCE_BUSY;
139
140 strcat((char *)pvObj, "ctor was called\n");
141 return VINF_SUCCESS;
142}
143
144
145/** Destructor for tst2. Checks that it was constructed and used twice. */
146static DECLCALLBACK(void) tst2Dtor(RTMEMCACHE hMemCache, void *pvObj, void *pvUser)
147{
148 RT_NOREF_PV(hMemCache); RT_NOREF_PV(pvUser);
149
150 RTTESTI_CHECK(!strcmp((char *)pvObj, "ctor was called\nused\nused\n"));
151 strcat((char *)pvObj, "dtor was called\n");
152}
153
154/**
155 * Test constructor / destructor.
156 */
157static void tst2(void)
158{
159 RTTestISub("Ctor/Dtor");
160
161 /* Create one without constructor or destructor. */
162 bool fFail = false;
163 uint32_t const cObjects = PAGE_SIZE * 2 / 256;
164 RTTESTI_CHECK_RC_RETV(RTMemCacheCreate(&g_hMemCache, 256, cObjects, 32, tst2Ctor, tst2Dtor, &fFail, 0 /*fFlags*/), VINF_SUCCESS);
165
166 /* A failure run first. */
167 fFail = true;
168 void *pv = (void *)0x42;
169 RTTESTI_CHECK_RC_RETV(RTMemCacheAllocEx(g_hMemCache, &pv), VERR_RESOURCE_BUSY);
170 RTTESTI_CHECK(pv == (void *)0x42);
171 fFail = false;
172
173 /* To two rounds where we allocate all the objects and free them again. */
174 for (uint32_t iLoop = 0; iLoop < 2; iLoop++)
175 {
176 void *apv[cObjects];
177 for (uint32_t i = 0; i < cObjects; i++)
178 {
179 apv[i] = NULL;
180 RTTESTI_CHECK_RC_RETV(RTMemCacheAllocEx(g_hMemCache, &apv[i]), VINF_SUCCESS);
181 if (iLoop == 0)
182 RTTESTI_CHECK(!strcmp((char *)apv[i], "ctor was called\n"));
183 else
184 RTTESTI_CHECK(!strcmp((char *)apv[i], "ctor was called\nused\n"));
185 strcat((char *)apv[i], "used\n");
186 }
187
188 RTTESTI_CHECK_RETV((pv = RTMemCacheAlloc(g_hMemCache)) == NULL);
189 RTMemCacheFree(g_hMemCache, pv);
190
191 for (uint32_t i = 0; i < cObjects; i++)
192 RTMemCacheFree(g_hMemCache, apv[i]);
193 }
194
195 /* Cone, destroy the cache. */
196 RTTESTI_CHECK_RC(RTMemCacheDestroy(g_hMemCache), VINF_SUCCESS);
197}
198
199
200/**
201 * Thread that allocates
202 * @returns
203 * @param hThreadSelf The thread.
204 * @param pvArg Pointer to fUseCache.
205 */
206static DECLCALLBACK(int) tst3Thread(RTTHREAD hThreadSelf, void *pvArg)
207{
208 PTST3THREAD pThread = (PTST3THREAD)(pvArg);
209 size_t cbObject = pThread->cbObject;
210 uint64_t cIterations = 0;
211 RT_NOREF_PV(hThreadSelf);
212
213 /* wait for the kick-off */
214 RTTEST_CHECK_RC_OK(g_hTest, RTSemEventMultiWait(pThread->hEvt, RT_INDEFINITE_WAIT));
215
216 /* allocate and free loop */
217 if (pThread->fUseCache)
218 {
219 while (!g_fTst3Stop)
220 {
221 void *apv[64];
222 for (unsigned i = 0; i < RT_ELEMENTS(apv); i++)
223 {
224 apv[i] = RTMemCacheAlloc(g_hMemCache);
225 RTTEST_CHECK(g_hTest, apv[i] != NULL);
226 }
227 for (unsigned i = 0; i < RT_ELEMENTS(apv); i++)
228 RTMemCacheFree(g_hMemCache, apv[i]);
229
230 cIterations += RT_ELEMENTS(apv);
231 }
232 }
233 else
234 {
235 while (!g_fTst3Stop)
236 {
237 void *apv[64];
238
239 for (unsigned i = 0; i < RT_ELEMENTS(apv); i++)
240 {
241 apv[i] = RTMemAlloc(cbObject);
242 RTTEST_CHECK(g_hTest, apv[i] != NULL);
243 }
244
245 for (unsigned i = 0; i < RT_ELEMENTS(apv); i++)
246 RTMemFree(apv[i]);
247
248 cIterations += RT_ELEMENTS(apv);
249 }
250 }
251
252 /* report back the status */
253 pThread->cIterations = cIterations;
254 return VINF_SUCCESS;
255}
256
257/**
258 * Time constrained test with and unlimited N threads.
259 */
260static void tst3(uint32_t cThreads, uint32_t cbObject, int iMethod, uint32_t cSecs)
261{
262 RTTestISubF("Benchmark - %u threads, %u bytes, %u secs, %s", cThreads, cbObject, cSecs,
263 iMethod == 0 ? "RTMemCache"
264 : "RTMemAlloc");
265
266 /*
267 * Create a cache with unlimited space, a start semaphore and line up
268 * the threads.
269 */
270 RTTESTI_CHECK_RC_RETV(RTMemCacheCreate(&g_hMemCache, cbObject, 0 /*cbAlignment*/, UINT32_MAX, NULL, NULL, NULL, 0 /*fFlags*/), VINF_SUCCESS);
271
272 RTSEMEVENTMULTI hEvt;
273 RTTESTI_CHECK_RC_OK_RETV(RTSemEventMultiCreate(&hEvt));
274
275 TST3THREAD aThreads[64];
276 RTTESTI_CHECK_RETV(cThreads < RT_ELEMENTS(aThreads));
277
278 ASMAtomicWriteBool(&g_fTst3Stop, false);
279 for (uint32_t i = 0; i < cThreads; i++)
280 {
281 aThreads[i].hThread = NIL_RTTHREAD;
282 aThreads[i].cIterations = 0;
283 aThreads[i].fUseCache = iMethod == 0;
284 aThreads[i].cbObject = cbObject;
285 aThreads[i].hEvt = hEvt;
286 RTTESTI_CHECK_RC_OK_RETV(RTThreadCreateF(&aThreads[i].hThread, tst3Thread, &aThreads[i], 0,
287 RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE, "tst3-%u", i));
288 }
289
290 /*
291 * Start the race.
292 */
293 RTTimeNanoTS(); /* warmup */
294
295 uint64_t uStartTS = RTTimeNanoTS();
296 RTTESTI_CHECK_RC_OK_RETV(RTSemEventMultiSignal(hEvt));
297 RTThreadSleep(cSecs * 1000);
298 ASMAtomicWriteBool(&g_fTst3Stop, true);
299 for (uint32_t i = 0; i < cThreads; i++)
300 RTTESTI_CHECK_RC_OK_RETV(RTThreadWait(aThreads[i].hThread, 60*1000, NULL));
301 uint64_t cElapsedNS = RTTimeNanoTS() - uStartTS;
302
303 /*
304 * Sum up the counts.
305 */
306 uint64_t cIterations = 0;
307 for (uint32_t i = 0; i < cThreads; i++)
308 cIterations += aThreads[i].cIterations;
309
310 RTTestIPrintf(RTTESTLVL_ALWAYS, "%'8u iterations per second, %'llu ns on avg\n",
311 (unsigned)((long double)cIterations * 1000000000.0 / cElapsedNS),
312 cElapsedNS / cIterations);
313
314 /* clean up */
315 RTTESTI_CHECK_RC(RTMemCacheDestroy(g_hMemCache), VINF_SUCCESS);
316 RTTESTI_CHECK_RC_OK(RTSemEventMultiDestroy(hEvt));
317}
318
319static void tst3AllMethods(uint32_t cThreads, uint32_t cbObject, uint32_t cSecs)
320{
321 tst3(cThreads, cbObject, 0, cSecs);
322 tst3(cThreads, cbObject, 1, cSecs);
323}
324
325
326int main(int argc, char **argv)
327{
328 RT_NOREF_PV(argc); RT_NOREF_PV(argv);
329
330 RTTEST hTest;
331 int rc = RTTestInitAndCreate("tstRTMemCache", &hTest);
332 if (rc)
333 return rc;
334 RTTestBanner(hTest);
335 g_hTest = hTest;
336
337 tst1();
338 tst2();
339 if (RTTestIErrorCount() == 0)
340 {
341 uint32_t cSecs = argc == 1 ? 5 : 2;
342 /* threads, cbObj, cSecs */
343 tst3AllMethods( 1, 256, cSecs);
344 tst3AllMethods( 1, 32, cSecs);
345 tst3AllMethods( 1, 8, cSecs);
346 tst3AllMethods( 1, 2, cSecs);
347 tst3AllMethods( 1, 1, cSecs);
348
349 tst3AllMethods( 3, 256, cSecs);
350 tst3AllMethods( 3, 128, cSecs);
351 tst3AllMethods( 3, 64, cSecs);
352 tst3AllMethods( 3, 32, cSecs);
353 tst3AllMethods( 3, 2, cSecs);
354 tst3AllMethods( 3, 1, cSecs);
355
356 tst3AllMethods( 16, 32, cSecs);
357 }
358
359 /*
360 * Summary.
361 */
362 return RTTestSummaryAndDestroy(hTest);
363}
364
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