7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * IPRT R0 Testcase - Common header for the testcase drivers.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * Copyright (C) 2010 Oracle Corporation
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * available from http://www.virtualbox.org. This file is free software;
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * you can redistribute it and/or modify it under the terms of the GNU
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * General Public License (GPL) as published by the Free Software
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * The contents of this file may alternatively be used under the terms
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * of the Common Development and Distribution License Version 1.0
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * VirtualBox OSE distribution, in which case the provisions of the
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * CDDL are applicable instead of those of the GPL.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * You may elect to license modified versions of this file under the
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * terms and conditions of either the GPL or the CDDL or both.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync/*******************************************************************************
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync* Header Files *
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync*******************************************************************************/
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync/*******************************************************************************
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync* Global Variables *
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync*******************************************************************************/
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync/** The test handle. */
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync/** The test & service name. */
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync/** The length of the service name. */
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync/** The base address of the service module. */
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * Initializes the test driver.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * This means creating a test instance (RTTEST), initializing the support
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * library, and loading the service module.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * @returns RTEXITCODE_SUCCESS on success, appropriate exit code on failure.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * @param pszTestServiceName The name of the test and service. This
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * will be used when creating the test
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * instance as well as when talking with the
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * kernel side of the test.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * The ring-0 module name will be derived from
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * this + '.r0'.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * The service request handler function name
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * will be derived by upper casing the first
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * chars and appending 'SrvReqHandler'.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsyncRTEXITCODE RTR3TestR0CommonDriverInit(const char *pszTestServiceName)
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * Init the test.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTEXITCODE rcExit = RTTestInitAndCreate(pszTestServiceName, &g_hTest);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * Init the globals.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync int rc = RTStrCopy(g_szSrvName, sizeof(g_szSrvName), pszTestServiceName);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTestFailed(g_hTest, "The test name is too long! (%zu bytes)", g_cchSrvName);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * Initialize the support driver session.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTestFailed(g_hTest, "SUPR3Init failed with rc=%Rrc\n", rc);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync rc = RTPathAppend(szPath, RTPATH_MAX, pszTestServiceName);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTestFailed(g_hTest, "Failed constructing .r0 filename (rc=%Rrc)", rc);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync char szSrvReqHandler[sizeof(g_szSrvName) + sizeof("SrvReqHandler")];
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync for (size_t off = 0; RT_C_IS_LOWER(szSrvReqHandler[off]); off++)
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync szSrvReqHandler[off] = RT_C_TO_UPPER(szSrvReqHandler[off]);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync rc = SUPR3LoadServiceModule(szPath, pszTestServiceName, szSrvReqHandler, &g_pvImageBase);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTestFailed(g_hTest, "SUPR3LoadServiceModule(%s,%s,%s,) failed with rc=%Rrc\n",
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * Do the sanity checks.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTESTI_CHECK_RC(rc = SUPR3CallR0Service(g_szSrvName, g_cchSrvName, RTTSTR0REQ_SANITY_OK, 0, &Req.Hdr), VINF_SUCCESS);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTESTI_CHECK_MSG(Req.szMsg[0] == '\0', ("%s", Req.szMsg));
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTESTI_CHECK_RC(rc = SUPR3CallR0Service(g_szSrvName, g_cchSrvName, RTTSTR0REQ_SANITY_FAILURE, 0, &Req.Hdr), VINF_SUCCESS);
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync rc = !strncmp(Req.szMsg, "!42failure42", sizeof("!42failure42"));
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTestFailed(g_hTest, "the negative sanity check failed");
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * Processes the messages in the request.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * @returns true on success, false on failure.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @param pReq The request.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsyncstatic bool rtR3TestR0ProcessMessages(PRTTSTR0REQ pReq)
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * Process the message strings.
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * We can have multiple failures and info messages packed into szMsg. They
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync * are separated by a double newline. The kind of message is indicated by
9cdfc12d2fbf4a2e1bae5c459c0b7551449288c9vboxsync * the first character, '!' means error and '?' means info message. '$' means
9cdfc12d2fbf4a2e1bae5c459c0b7551449288c9vboxsync * the test was skipped because a feature is not supported on the host.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync pReq->szMsg[sizeof(pReq->szMsg) - 1] = '\0'; /* paranoia */
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync while (pszNext && (pszNext[-1] != '\n' || pszNext[-2] != '\n'));
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync char *pszEnd = pszNext ? pszNext - 1 : strchr(pszCur, '\0');
7e3ff7c4e45ee1f8eb46a1aba9d2d8816d337c4avboxsync RTTestPrintfNl(g_hTest, RTTESTLVL_ALWAYS, "%s", pszCur + 1);
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * Performs a simple test with an argument (@a u64Arg).
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @returns true on success, false on failure.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @param uOperation The operation to perform.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @param u64Arg 64-bit argument.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @param pszTestFmt The sub-test name.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @param ... Format arguments.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsyncbool RTR3TestR0SimpleTestWithArg(uint32_t uOperation, uint64_t u64Arg, const char *pszTestFmt, ...)
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync int rc = SUPR3CallR0Service(g_szSrvName, g_cchSrvName, uOperation, u64Arg, &Req.Hdr);
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync RTTestFailed(g_hTest, "SUPR3CallR0Service failed with rc=%Rrc", rc);
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync return false;
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * Performs a simple test.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @returns true on success, false on failure.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @param uOperation The operation to perform.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @param pszTestFmt The sub-test name.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync * @param ... Format arguments.
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsyncbool RTR3TestR0SimpleTest(uint32_t uOperation, const char *pszTestFmt, ...)
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync int rc = SUPR3CallR0Service(g_szSrvName, g_cchSrvName, uOperation, 0, &Req.Hdr);
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync RTTestFailed(g_hTest, "SUPR3CallR0Service failed with rc=%Rrc", rc);
533240a0b68828716de5ebea7afaf56720aa6ae7vboxsync return false;