handletable.cpp revision 45fdb697e9030f33bf5fabea82ca7eeafab2f6af
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/* $Id$ */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/** @file
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * IPRT - Handle Tables.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Copyright (C) 2008 Oracle Corporation
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * available from http://www.virtualbox.org. This file is free software;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * you can redistribute it and/or modify it under the terms of the GNU
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * General Public License (GPL) as published by the Free Software
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * The contents of this file may alternatively be used under the terms
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * of the Common Development and Distribution License Version 1.0
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * VirtualBox OSE distribution, in which case the provisions of the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * CDDL are applicable instead of those of the GPL.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * You may elect to license modified versions of this file under the
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * terms and conditions of either the GPL or the CDDL or both.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync/*******************************************************************************
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync* Header Files *
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync*******************************************************************************/
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/handletable.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include "internal/iprt.h"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/mem.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/spinlock.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/err.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/assert.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/param.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/string.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include <iprt/asm.h>
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include "internal/magics.h"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync#include "handletable.h"
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncRTDECL(int) RTHandleTableCreateEx(PRTHANDLETABLE phHandleTable, uint32_t fFlags, uint32_t uBase, uint32_t cMax,
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync PFNRTHANDLETABLERETAIN pfnRetain, void *pvUser)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync PRTHANDLETABLEINT pThis;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync uint32_t cLevel1;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync size_t cb;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync /*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Validate input.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync AssertPtrReturn(phHandleTable, VERR_INVALID_POINTER);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *phHandleTable = NIL_RTHANDLETABLE;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync AssertPtrNullReturn(pfnRetain, VERR_INVALID_POINTER);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync AssertReturn(!(fFlags & ~RTHANDLETABLE_FLAGS_MASK), VERR_INVALID_PARAMETER);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync AssertReturn(cMax > 0, VERR_INVALID_PARAMETER);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync AssertReturn(UINT32_MAX - cMax >= uBase, VERR_INVALID_PARAMETER);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync /*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Adjust the cMax value so it is a multiple of the 2nd level tables.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync if (cMax >= UINT32_MAX - RTHT_LEVEL2_ENTRIES)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync cMax = UINT32_MAX - RTHT_LEVEL2_ENTRIES + 1;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync cMax = ((cMax + RTHT_LEVEL2_ENTRIES - 1) / RTHT_LEVEL2_ENTRIES) * RTHT_LEVEL2_ENTRIES;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync cLevel1 = cMax / RTHT_LEVEL2_ENTRIES;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync Assert(cLevel1 * RTHT_LEVEL2_ENTRIES == cMax);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync /*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Allocate the structure, include the 1st level lookup table
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * if it's below the threshold size.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync cb = sizeof(RTHANDLETABLEINT);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync if (cLevel1 < RTHT_LEVEL1_DYN_ALLOC_THRESHOLD)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync cb = RT_ALIGN(cb, sizeof(void *)) + cLevel1 * sizeof(void *);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis = (PRTHANDLETABLEINT)RTMemAllocZ(cb);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync if (!pThis)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync return VERR_NO_MEMORY;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync /*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Initialize it.
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync */
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->u32Magic = RTHANDLETABLE_MAGIC;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->fFlags = fFlags;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->uBase = uBase;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->cCur = 0;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->hSpinlock = NIL_RTSPINLOCK;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync if (cLevel1 < RTHT_LEVEL1_DYN_ALLOC_THRESHOLD)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->papvLevel1 = (void **)((uint8_t *)pThis + RT_ALIGN(sizeof(*pThis), sizeof(void *)));
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync else
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->papvLevel1 = (void **)NULL;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->pfnRetain = pfnRetain;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->pvRetainUser = pvUser;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->cMax = cMax;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->cCurAllocated = 0;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->cLevel1 = cLevel1 < RTHT_LEVEL1_DYN_ALLOC_THRESHOLD ? cLevel1 : 0;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->iFreeHead = NIL_RTHT_INDEX;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync pThis->iFreeTail = NIL_RTHT_INDEX;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync if (fFlags & RTHANDLETABLE_FLAGS_LOCKED)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync int rc = RTSpinlockCreate(&pThis->hSpinlock, RTSPINLOCK_FLAGS_INTERRUPT_UNSAFE, "RTHandleTableCreateEx");
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync if (RT_FAILURE(rc))
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync {
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync RTMemFree(pThis);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync return rc;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync }
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync }
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync *phHandleTable = pThis;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync return VINF_SUCCESS;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncRT_EXPORT_SYMBOL(RTHandleTableCreateEx);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncRTDECL(int) RTHandleTableCreate(PRTHANDLETABLE phHandleTable)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync return RTHandleTableCreateEx(phHandleTable, RTHANDLETABLE_FLAGS_LOCKED, 1, 65534, (PFNRTHANDLETABLERETAIN)NULL, NULL);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync}
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncRT_EXPORT_SYMBOL(RTHandleTableCreate);
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsyncRTDECL(int) RTHandleTableDestroy(RTHANDLETABLE hHandleTable, PFNRTHANDLETABLEDELETE pfnDelete, void *pvUser)
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync{
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync PRTHANDLETABLEINT pThis;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync uint32_t i1;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync uint32_t i;
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync /*
b8e299dddd091ae24e0c08c45d91b8f937bd14d2vboxsync * Validate input, quietly ignore the NIL handle.
*/
if (hHandleTable == NIL_RTHANDLETABLE)
return VINF_SUCCESS;
pThis = (PRTHANDLETABLEINT)hHandleTable;
AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
AssertReturn(pThis->u32Magic == RTHANDLETABLE_MAGIC, VERR_INVALID_HANDLE);
AssertPtrNullReturn(pfnDelete, VERR_INVALID_POINTER);
/*
* Mark the thing as invalid / deleted.
* Then kill the lock.
*/
rtHandleTableLock(pThis);
ASMAtomicWriteU32(&pThis->u32Magic, ~RTHANDLETABLE_MAGIC);
rtHandleTableUnlock(pThis);
if (pThis->hSpinlock != NIL_RTSPINLOCK)
{
rtHandleTableLock(pThis);
rtHandleTableUnlock(pThis);
RTSpinlockDestroy(pThis->hSpinlock);
pThis->hSpinlock = NIL_RTSPINLOCK;
}
if (pfnDelete)
{
/*
* Walk all the tables looking for used handles.
*/
uint32_t cLeft = pThis->cCurAllocated;
if (pThis->fFlags & RTHANDLETABLE_FLAGS_CONTEXT)
{
for (i1 = 0; cLeft > 0 && i1 < pThis->cLevel1; i1++)
{
PRTHTENTRYCTX paTable = (PRTHTENTRYCTX)pThis->papvLevel1[i1];
if (paTable)
for (i = 0; i < RTHT_LEVEL2_ENTRIES; i++)
if (!RTHT_IS_FREE(paTable[i].pvObj))
{
pfnDelete(hHandleTable, pThis->uBase + i + i1 * RTHT_LEVEL2_ENTRIES,
paTable[i].pvObj, paTable[i].pvCtx, pvUser);
Assert(cLeft > 0);
cLeft--;
}
}
}
else
{
for (i1 = 0; cLeft > 0 && i1 < pThis->cLevel1; i1++)
{
PRTHTENTRY paTable = (PRTHTENTRY)pThis->papvLevel1[i1];
if (paTable)
for (i = 0; i < RTHT_LEVEL2_ENTRIES; i++)
if (!RTHT_IS_FREE(paTable[i].pvObj))
{
pfnDelete(hHandleTable, pThis->uBase + i + i1 * RTHT_LEVEL2_ENTRIES,
paTable[i].pvObj, NULL, pvUser);
Assert(cLeft > 0);
cLeft--;
}
}
}
Assert(!cLeft);
}
/*
* Free the memory.
*/
for (i1 = 0; i1 < pThis->cLevel1; i1++)
if (pThis->papvLevel1[i1])
{
RTMemFree(pThis->papvLevel1[i1]);
pThis->papvLevel1[i1] = NULL;
}
if (pThis->cMax / RTHT_LEVEL2_ENTRIES >= RTHT_LEVEL1_DYN_ALLOC_THRESHOLD)
RTMemFree(pThis->papvLevel1);
RTMemFree(pThis);
return VINF_SUCCESS;
}
RT_EXPORT_SYMBOL(RTHandleTableDestroy);