Runtime/testcase/tstRTReqPool.cpp

4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync/* $Id$ */
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync/** @file
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * IPRT Testcase - Request Thread Pool.
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync */
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync/*
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * Copyright (C) 2011 Oracle Corporation
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync *
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * available from http://www.virtualbox.org. This file is free software;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * you can redistribute it and/or modify it under the terms of the GNU
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * General Public License (GPL) as published by the Free Software
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync *
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * The contents of this file may alternatively be used under the terms
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * of the Common Development and Distribution License Version 1.0
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * VirtualBox OSE distribution, in which case the provisions of the
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * CDDL are applicable instead of those of the GPL.
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync *
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * You may elect to license modified versions of this file under the
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync * terms and conditions of either the GPL or the CDDL or both.
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync */
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync/*******************************************************************************
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync*   Header Files                                                               *
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync*******************************************************************************/
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync#include <iprt/req.h>
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync#include <iprt/err.h>
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync#include <iprt/test.h>
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync#include <iprt/thread.h>
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync#include <iprt/time.h>
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync/*******************************************************************************
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync*   Global Variables                                                           *
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync*******************************************************************************/
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsyncstatic RTTEST g_hTest = NIL_RTTEST;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsyncstatic DECLCALLBACK(int) NopCallback(void)
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync{
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    return VINF_SUCCESS;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync}
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsyncstatic void test1(void)
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync{
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestISub("Basics");
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTREQPOOL hPool;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    uint32_t cMaxThreads = 10;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK_RC_RETV(RTReqPoolCreate(cMaxThreads, RT_MS_1SEC, 6, 500, "test1", &hPool), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_THREAD_TYPE) == (uint64_t)RTTHREADTYPE_DEFAULT);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_MAX_THREADS) == 10);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_MIN_THREADS) > 1);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_MS_MIN_IDLE) == RT_MS_1SEC);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_MS_IDLE_SLEEP) == RT_MS_1SEC);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_PUSH_BACK_THRESHOLD) == 6);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_PUSH_BACK_MAX_MS) == 500);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_PUSH_BACK_MIN_MS) < 500);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_MAX_FREE_REQUESTS) >= 10);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_MAX_FREE_REQUESTS) < 1024);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetStat(hPool, RTREQPOOLSTAT_REQUESTS_FREE) == 0);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetStat(hPool, RTREQPOOLSTAT_THREADS) == 0);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    uint32_t const cMinThreads  = RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_MIN_THREADS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    uint32_t const cMaxFreeReqs = RTReqPoolGetCfgVar(hPool, RTREQPOOLCFGVAR_MAX_FREE_REQUESTS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    PRTREQ hReq;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK_RC_RETV(RTReqPoolAlloc(hPool, RTREQTYPE_INTERNAL, &hReq), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqRetain(hReq) == 2);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqRelease(hReq) == 1);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK_RC(RTReqGetStatus(hReq), VERR_RT_REQUEST_STATUS_STILL_PENDING);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqRelease(hReq) == 0);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetStat(hPool, RTREQPOOLSTAT_REQUESTS_FREE) == 1);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
224132d5ac9f727f499ec4507bc1da2a06080c03vboxsync    RTTESTI_CHECK(RTReqPoolGetStat(hPool, RTREQPOOLSTAT_REQUESTS_PROCESSED) == 0);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK_RC(RTReqPoolCallWait(hPool, (PFNRT)RTThreadSleep, 1, (RTMSINTERVAL)0), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK_RC(RTReqPoolCallWait(hPool, (PFNRT)RTThreadSleep, 1, (RTMSINTERVAL)2), VINF_SUCCESS);
224132d5ac9f727f499ec4507bc1da2a06080c03vboxsync    RTTESTI_CHECK_RC(RTReqPoolCallWait(hPool, (PFNRT)RTThreadSleep, 1, (RTMSINTERVAL)3), VINF_SUCCESS);
224132d5ac9f727f499ec4507bc1da2a06080c03vboxsync    RTTESTI_CHECK(RTReqPoolGetStat(hPool, RTREQPOOLSTAT_REQUESTS_PROCESSED) > 1);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetStat(hPool, RTREQPOOLSTAT_THREADS) == 1);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    /* Use no wait requests to maximize the number of worker threads. */
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestISub("No wait requests");
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    for (unsigned i = 0; i < 32; i++)
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync        RTTESTI_CHECK_RC(RTReqPoolCallNoWait(hPool, (PFNRT)RTThreadSleep, 1, (RTMSINTERVAL)100), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    uint32_t cThreads = RTReqPoolGetStat(hPool, RTREQPOOLSTAT_THREADS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestIValue("thread-count-1", cThreads, RTTESTUNIT_OCCURRENCES);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(cThreads >= cMinThreads);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(cThreads <= cMaxThreads);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    /* Check that idle thread shutdown kicks in.  This means delaying a bit first. */
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestISub("Idle thread shutdown");
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    for (unsigned i = 0; i < 20; i++)
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    {
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync        RTTESTI_CHECK_RC(RTReqPoolCallNoWait(hPool, (PFNRT)RTThreadSleep, 1, (RTMSINTERVAL)10), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync        RTTESTI_CHECK_RC(RTReqPoolCallNoWait(hPool, (PFNRT)RTThreadSleep, 1, (RTMSINTERVAL)10), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync        RTTESTI_CHECK_RC(RTReqPoolCallWait(hPool, (PFNRT)RTThreadSleep, 1, (RTMSINTERVAL)100), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    }
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolGetStat(hPool, RTREQPOOLSTAT_REQUESTS_FREE) == cMaxFreeReqs || cMaxFreeReqs > 32);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    /* Idle shutdown of worker threads should kick in now. */
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    uint32_t cThreads2 = RTReqPoolGetStat(hPool, RTREQPOOLSTAT_THREADS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestIValue("thread-count-2", cThreads2, RTTESTUNIT_OCCURRENCES);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(cThreads2 >= cMinThreads);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(cThreads2 < cThreads || cThreads2 <= cMinThreads);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolRelease(hPool) == 0);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync}
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsyncstatic void test2(void)
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync{
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestISub("Simple Benchmark");
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTREQPOOL hPool;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK_RC_RETV(RTReqPoolCreate(10, RT_MS_1SEC, 6, 500, "test1", &hPool), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    uint64_t NsTsStart = RTTimeNanoTS();
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    for (unsigned i = 0; i < 10000; i++)
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync        RTTESTI_CHECK_RC_BREAK(RTReqPoolCallWait(hPool, (PFNRT)NopCallback, 0), VINF_SUCCESS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    uint64_t cNsElapsed = RTTimeNanoTS() - NsTsStart;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestIValue("total time",              cNsElapsed, RTTESTUNIT_NS);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestIValue("per call",                cNsElapsed / 10000, RTTESTUNIT_NS_PER_CALL);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestIValue("total processing time",   RTReqPoolGetStat(hPool, RTREQPOOLSTAT_NS_AVERAGE_REQ_PROCESSING), RTTESTUNIT_NS_PER_CALL);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTESTI_CHECK(RTReqPoolRelease(hPool) == 0);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync}
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsyncint main()
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync{
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTEXITCODE rcExit = RTTestInitAndCreate("tstRTReqPool", &g_hTest);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    if (rcExit != RTEXITCODE_SUCCESS)
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync        return rcExit;
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    RTTestBanner(g_hTest);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    test1();
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    if (RTTestIErrorCount() == 0)
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    {
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync        test2();
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    }
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync    return RTTestSummaryAndDestroy(g_hTest);
4c865d947c827c8bf5ff8d392b036b4dd5b5a56fvboxsync}