Runtime/testcase/tstRTMemSafer.cpp

9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync/* $Id$ */
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync/** @file
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * IPRT Testcase - RTMemSafer* functions.
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync */
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync/*
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * Copyright (C) 2012 Oracle Corporation
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync *
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * available from http://www.virtualbox.org. This file is free software;
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * you can redistribute it and/or modify it under the terms of the GNU
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * General Public License (GPL) as published by the Free Software
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync *
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * The contents of this file may alternatively be used under the terms
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * of the Common Development and Distribution License Version 1.0
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * VirtualBox OSE distribution, in which case the provisions of the
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * CDDL are applicable instead of those of the GPL.
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync *
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * You may elect to license modified versions of this file under the
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync * terms and conditions of either the GPL or the CDDL or both.
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync */
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync/*******************************************************************************
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync*   Header Files                                                               *
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync*******************************************************************************/
bcb3083f42e955d186649946e002930e75134f8dvboxsync#include <iprt/memsafer.h>
bcb3083f42e955d186649946e002930e75134f8dvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync#include <iprt/asm.h>
bcb3083f42e955d186649946e002930e75134f8dvboxsync#include <iprt/param.h>
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync#include <iprt/rand.h>
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync#include <iprt/string.h>
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync#include <iprt/test.h>
bcb3083f42e955d186649946e002930e75134f8dvboxsync#ifdef VBOX
bcb3083f42e955d186649946e002930e75134f8dvboxsync# include <VBox/sup.h>
bcb3083f42e955d186649946e002930e75134f8dvboxsync#endif
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsyncstatic void doMemSaferScramble(RTTEST hTest, void *pvBuf, size_t cbAlloc)
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync{
bcb3083f42e955d186649946e002930e75134f8dvboxsync    /*
bcb3083f42e955d186649946e002930e75134f8dvboxsync     * Fill it with random bytes and make a reference copy of these.
bcb3083f42e955d186649946e002930e75134f8dvboxsync     */
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    RTRandBytes(pvBuf, cbAlloc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    void *pvRef = RTMemDup(pvBuf, cbAlloc);
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTTESTI_CHECK_RETV(pvRef);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync    /*
bcb3083f42e955d186649946e002930e75134f8dvboxsync     * Scramble the allocation and check that it no longer matches the refernece bytes.
bcb3083f42e955d186649946e002930e75134f8dvboxsync     */
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    int rc = RTMemSaferScramble(pvBuf, cbAlloc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    if (RT_SUCCESS(rc))
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    {
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        if (!memcmp(pvRef, pvBuf, cbAlloc))
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync            RTTestIFailed("Memory blocks must differ (%z bytes, 0x%p vs. 0x%p)!\n",
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync                          cbAlloc, pvRef, pvBuf);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        else
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        {
bcb3083f42e955d186649946e002930e75134f8dvboxsync            /*
bcb3083f42e955d186649946e002930e75134f8dvboxsync             * Check that unscrambling returns the original content.
bcb3083f42e955d186649946e002930e75134f8dvboxsync             */
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync            rc = RTMemSaferUnscramble(pvBuf, cbAlloc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync            if (RT_SUCCESS(rc))
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync            {
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync                if (memcmp(pvRef, pvBuf, cbAlloc))
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync                    RTTestIFailed("Memory blocks must not differ (%z bytes, 0x%p vs. 0x%p)!\n",
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync                                  cbAlloc, pvRef, pvBuf);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync            }
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync            else
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync                RTTestIFailed("Unscrambling %z bytes failed with %Rrc!\n", cbAlloc, rc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        }
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    }
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    else
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        RTTestIFailed("Scrambling %z bytes failed with %Rrc!\n", cbAlloc, rc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    RTMemFree(pvRef);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync}
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsyncstatic void doMemSaferAllocation(RTTEST hTest)
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync{
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    size_t cbAlloc = RTRandS32Ex(1, _1M) * sizeof(uint8_t);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    void *pvBuf = NULL;
bcb3083f42e955d186649946e002930e75134f8dvboxsync    int rc = RTMemSaferAllocZEx(&pvBuf, cbAlloc, 0);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    if (RT_SUCCESS(rc))
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    {
bcb3083f42e955d186649946e002930e75134f8dvboxsync        /* Fill it with random bytes. */
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        RTRandBytes(pvBuf, cbAlloc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        /* Scrambling test */
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        doMemSaferScramble(hTest, pvBuf, cbAlloc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        RTMemSaferFree(pvBuf, cbAlloc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    }
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    else
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        RTTestIFailed("Allocating %z bytes of secure memory failed with %Rrc\n", cbAlloc, rc);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync}
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsyncstatic void doMemRealloc(RTTEST hTest)
bcb3083f42e955d186649946e002930e75134f8dvboxsync{
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTTestPrintf(hTest, RTTESTLVL_ALWAYS, "%u reallocation, grow by 1 bytes\n", PAGE_SIZE * 2);
bcb3083f42e955d186649946e002930e75134f8dvboxsync    size_t cbAlloc = RTRandS32Ex(1, _16K);
bcb3083f42e955d186649946e002930e75134f8dvboxsync    void  *pvBuf   = NULL;
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTTESTI_CHECK_RC_OK_RETV(RTMemSaferAllocZEx(&pvBuf, cbAlloc, 0));
bcb3083f42e955d186649946e002930e75134f8dvboxsync    for (uint32_t i = 0; i <= PAGE_SIZE * 2; i++)
bcb3083f42e955d186649946e002930e75134f8dvboxsync    {
bcb3083f42e955d186649946e002930e75134f8dvboxsync        cbAlloc += 1;
bcb3083f42e955d186649946e002930e75134f8dvboxsync        RTTESTI_CHECK_RC_OK_RETV(RTMemSaferReallocZEx(cbAlloc - 1, pvBuf, cbAlloc, &pvBuf, 0));
bcb3083f42e955d186649946e002930e75134f8dvboxsync        memset(pvBuf, i & 0x7f, cbAlloc);
bcb3083f42e955d186649946e002930e75134f8dvboxsync    }
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTMemSaferFree(pvBuf, cbAlloc);
bcb3083f42e955d186649946e002930e75134f8dvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTTestPrintf(hTest, RTTESTLVL_ALWAYS, "100 random reallocations\n");
bcb3083f42e955d186649946e002930e75134f8dvboxsync    uint8_t chFiller = 0x42;
bcb3083f42e955d186649946e002930e75134f8dvboxsync    cbAlloc = 0;
bcb3083f42e955d186649946e002930e75134f8dvboxsync    pvBuf   = NULL;
bcb3083f42e955d186649946e002930e75134f8dvboxsync    for (uint32_t i = 1; i <= 100; i++)
bcb3083f42e955d186649946e002930e75134f8dvboxsync    {
bcb3083f42e955d186649946e002930e75134f8dvboxsync        uint32_t cbNew = RTRandS32Ex(1, _16K + (i / 4) * _16K);
bcb3083f42e955d186649946e002930e75134f8dvboxsync        RTTESTI_CHECK_RC_OK_RETV(RTMemSaferReallocZEx(cbAlloc, pvBuf, cbNew, &pvBuf, 0));
bcb3083f42e955d186649946e002930e75134f8dvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync        RTTESTI_CHECK(ASMMemIsAll8(pvBuf, RT_MIN(cbAlloc, cbNew), chFiller) == NULL);
bcb3083f42e955d186649946e002930e75134f8dvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync        chFiller += 0x31;
bcb3083f42e955d186649946e002930e75134f8dvboxsync        memset(pvBuf, chFiller, cbNew);
bcb3083f42e955d186649946e002930e75134f8dvboxsync        cbAlloc = cbNew;
bcb3083f42e955d186649946e002930e75134f8dvboxsync    }
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTTESTI_CHECK_RC_OK_RETV(RTMemSaferReallocZEx(cbAlloc, pvBuf, 0, &pvBuf, 0));
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTTESTI_CHECK(pvBuf == NULL);
bcb3083f42e955d186649946e002930e75134f8dvboxsync}
bcb3083f42e955d186649946e002930e75134f8dvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsyncint main()
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync{
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    RTTEST hTest;
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTEXITCODE rcExit = RTTestInitAndCreate("tstRTMemSafer", &hTest);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    if (rcExit != RTEXITCODE_SUCCESS)
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync        return rcExit;
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    RTTestBanner(hTest);
bcb3083f42e955d186649946e002930e75134f8dvboxsync#ifdef VBOX
bcb3083f42e955d186649946e002930e75134f8dvboxsync    SUPR3Init(NULL);
bcb3083f42e955d186649946e002930e75134f8dvboxsync#endif
bcb3083f42e955d186649946e002930e75134f8dvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync    /*
bcb3083f42e955d186649946e002930e75134f8dvboxsync     * Not using sub-tests here, just printing progress.
bcb3083f42e955d186649946e002930e75134f8dvboxsync     */
bcb3083f42e955d186649946e002930e75134f8dvboxsync    RTTestPrintf(hTest, RTTESTLVL_ALWAYS, "20 random allocations\n");
bcb3083f42e955d186649946e002930e75134f8dvboxsync    for (uint32_t i = 0; i < 20; i++)
bcb3083f42e955d186649946e002930e75134f8dvboxsync        doMemSaferAllocation(hTest);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
bcb3083f42e955d186649946e002930e75134f8dvboxsync    doMemRealloc(hTest);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync    return RTTestSummaryAndDestroy(hTest);
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync}
9236bebed5c5902b30061ea6378bba30ef0577cbvboxsync