handletable.cpp revision ad27e1d5e48ca41245120c331cc88b50464813ce
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * IPRT - Handle Tables.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * Copyright (C) 2008 Oracle Corporation
fc148a6b23d25a87561beaffe0ba06c3ba93bf5avboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * available from http://www.virtualbox.org. This file is free software;
92a27575521748a392dcd1b996fce55b87411a00vboxsync * you can redistribute it and/or modify it under the terms of the GNU
92a27575521748a392dcd1b996fce55b87411a00vboxsync * General Public License (GPL) as published by the Free Software
92a27575521748a392dcd1b996fce55b87411a00vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
92a27575521748a392dcd1b996fce55b87411a00vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
92a27575521748a392dcd1b996fce55b87411a00vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
92a27575521748a392dcd1b996fce55b87411a00vboxsync * The contents of this file may alternatively be used under the terms
92a27575521748a392dcd1b996fce55b87411a00vboxsync * of the Common Development and Distribution License Version 1.0
92a27575521748a392dcd1b996fce55b87411a00vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
92a27575521748a392dcd1b996fce55b87411a00vboxsync * VirtualBox OSE distribution, in which case the provisions of the
92a27575521748a392dcd1b996fce55b87411a00vboxsync * CDDL are applicable instead of those of the GPL.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * You may elect to license modified versions of this file under the
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * terms and conditions of either the GPL or the CDDL or both.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync/*******************************************************************************
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync* Header Files *
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync*******************************************************************************/
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsyncRTDECL(int) RTHandleTableCreateEx(PRTHANDLETABLE phHandleTable, uint32_t fFlags, uint32_t uBase, uint32_t cMax,
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * Validate input.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync AssertPtrReturn(phHandleTable, VERR_INVALID_POINTER);
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync AssertPtrNullReturn(pfnRetain, VERR_INVALID_POINTER);
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync AssertReturn(!(fFlags & ~RTHANDLETABLE_FLAGS_MASK), VERR_INVALID_PARAMETER);
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync AssertReturn(UINT32_MAX - cMax >= uBase, VERR_INVALID_PARAMETER);
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * Adjust the cMax value so it is a multiple of the 2nd level tables.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync cMax = ((cMax + RTHT_LEVEL2_ENTRIES - 1) / RTHT_LEVEL2_ENTRIES) * RTHT_LEVEL2_ENTRIES;
23ee8310386e73ba6760fa30831a7964713d34b6vboxsync * Allocate the structure, include the 1st level lookup table
23ee8310386e73ba6760fa30831a7964713d34b6vboxsync * if it's below the threshold size.
4a429a59b1a82ce092626ea5f7512466c18f2015vboxsync cb = RT_ALIGN(cb, sizeof(void *)) + cLevel1 * sizeof(void *);
4a429a59b1a82ce092626ea5f7512466c18f2015vboxsync * Initialize it.
23ee8310386e73ba6760fa30831a7964713d34b6vboxsync pThis->papvLevel1 = (void **)((uint8_t *)pThis + RT_ALIGN(sizeof(*pThis), sizeof(void *)));
86abc60770f825f8c2ed4257675b50a08743b687vboxsync pThis->cLevel1 = cLevel1 < RTHT_LEVEL1_DYN_ALLOC_THRESHOLD ? cLevel1 : 0;
23ee8310386e73ba6760fa30831a7964713d34b6vboxsyncRTDECL(int) RTHandleTableCreate(PRTHANDLETABLE phHandleTable)
23ee8310386e73ba6760fa30831a7964713d34b6vboxsync return RTHandleTableCreateEx(phHandleTable, RTHANDLETABLE_FLAGS_LOCKED, 1, 65534, NULL, NULL);
86abc60770f825f8c2ed4257675b50a08743b687vboxsyncRTDECL(int) RTHandleTableDestroy(RTHANDLETABLE hHandleTable, PFNRTHANDLETABLEDELETE pfnDelete, void *pvUser)
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * Validate input, quietly ignore the NIL handle.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync AssertReturn(pThis->u32Magic == RTHANDLETABLE_MAGIC, VERR_INVALID_HANDLE);
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync AssertPtrNullReturn(pfnDelete, VERR_INVALID_POINTER);
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * Mark the thing as invalid / deleted.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * Then kill the lock.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync ASMAtomicWriteU32(&pThis->u32Magic, ~RTHANDLETABLE_MAGIC);
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * Walk all the tables looking for used handles.
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync for (i1 = 0; cLeft > 0 && i1 < pThis->cLevel1; i1++)
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync PRTHTENTRYCTX paTable = (PRTHTENTRYCTX)pThis->papvLevel1[i1];
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync for (i = 0; i < RTHT_LEVEL2_ENTRIES; i++)
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync pfnDelete(hHandleTable, pThis->uBase + i + i1 * RTHT_LEVEL2_ENTRIES,
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync for (i1 = 0; cLeft > 0 && i1 < pThis->cLevel1; i1++)
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync PRTHTENTRY paTable = (PRTHTENTRY)pThis->papvLevel1[i1];
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync for (i = 0; i < RTHT_LEVEL2_ENTRIES; i++)
86abc60770f825f8c2ed4257675b50a08743b687vboxsync pfnDelete(hHandleTable, pThis->uBase + i + i1 * RTHT_LEVEL2_ENTRIES,
db3dbd0ed7eb69f804a8921fa23a1267ea01f46evboxsync * Free the memory.