| 1 | /* $Id: handletable.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Handle Tables.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2008-2023 Oracle and/or its affiliates.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 10 | * available from https://www.virtualbox.org.
|
|---|
| 11 | *
|
|---|
| 12 | * This program is free software; you can redistribute it and/or
|
|---|
| 13 | * modify it under the terms of the GNU General Public License
|
|---|
| 14 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 15 | * License.
|
|---|
| 16 | *
|
|---|
| 17 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 20 | * General Public License for more details.
|
|---|
| 21 | *
|
|---|
| 22 | * You should have received a copy of the GNU General Public License
|
|---|
| 23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 24 | *
|
|---|
| 25 | * The contents of this file may alternatively be used under the terms
|
|---|
| 26 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|---|
| 28 | * in the VirtualBox distribution, in which case the provisions of the
|
|---|
| 29 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 30 | *
|
|---|
| 31 | * You may elect to license modified versions of this file under the
|
|---|
| 32 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 33 | *
|
|---|
| 34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 |
|
|---|
| 38 | /*********************************************************************************************************************************
|
|---|
| 39 | * Header Files *
|
|---|
| 40 | *********************************************************************************************************************************/
|
|---|
| 41 | #include <iprt/handletable.h>
|
|---|
| 42 | #include "internal/iprt.h"
|
|---|
| 43 |
|
|---|
| 44 | #include <iprt/mem.h>
|
|---|
| 45 | #include <iprt/spinlock.h>
|
|---|
| 46 | #include <iprt/errcore.h>
|
|---|
| 47 | #include <iprt/assert.h>
|
|---|
| 48 | #include <iprt/param.h>
|
|---|
| 49 | #include <iprt/string.h>
|
|---|
| 50 | #include <iprt/asm.h>
|
|---|
| 51 | #include "internal/magics.h"
|
|---|
| 52 | #include "handletable.h"
|
|---|
| 53 |
|
|---|
| 54 |
|
|---|
| 55 |
|
|---|
| 56 | RTDECL(int) RTHandleTableCreateEx(PRTHANDLETABLE phHandleTable, uint32_t fFlags, uint32_t uBase, uint32_t cMax,
|
|---|
| 57 | PFNRTHANDLETABLERETAIN pfnRetain, void *pvUser)
|
|---|
| 58 | {
|
|---|
| 59 | PRTHANDLETABLEINT pThis;
|
|---|
| 60 | uint32_t cLevel1;
|
|---|
| 61 | size_t cb;
|
|---|
| 62 |
|
|---|
| 63 | /*
|
|---|
| 64 | * Validate input.
|
|---|
| 65 | */
|
|---|
| 66 | AssertPtrReturn(phHandleTable, VERR_INVALID_POINTER);
|
|---|
| 67 | *phHandleTable = NIL_RTHANDLETABLE;
|
|---|
| 68 | AssertPtrNullReturn(pfnRetain, VERR_INVALID_POINTER);
|
|---|
| 69 | AssertReturn(!(fFlags & ~RTHANDLETABLE_FLAGS_MASK), VERR_INVALID_PARAMETER);
|
|---|
| 70 | AssertReturn(RT_BOOL(fFlags & RTHANDLETABLE_FLAGS_LOCKED) + RT_BOOL(fFlags & RTHANDLETABLE_FLAGS_LOCKED_IRQ_SAFE) < 2,
|
|---|
| 71 | VERR_INVALID_PARAMETER);
|
|---|
| 72 | AssertReturn(cMax > 0, VERR_INVALID_PARAMETER);
|
|---|
| 73 | AssertReturn(UINT32_MAX - cMax >= uBase, VERR_INVALID_PARAMETER);
|
|---|
| 74 |
|
|---|
| 75 | /*
|
|---|
| 76 | * Adjust the cMax value so it is a multiple of the 2nd level tables.
|
|---|
| 77 | */
|
|---|
| 78 | if (cMax >= UINT32_MAX - RTHT_LEVEL2_ENTRIES)
|
|---|
| 79 | cMax = UINT32_MAX - RTHT_LEVEL2_ENTRIES + 1;
|
|---|
| 80 | cMax = ((cMax + RTHT_LEVEL2_ENTRIES - 1) / RTHT_LEVEL2_ENTRIES) * RTHT_LEVEL2_ENTRIES;
|
|---|
| 81 |
|
|---|
| 82 | cLevel1 = cMax / RTHT_LEVEL2_ENTRIES;
|
|---|
| 83 | Assert(cLevel1 * RTHT_LEVEL2_ENTRIES == cMax);
|
|---|
| 84 |
|
|---|
| 85 | /*
|
|---|
| 86 | * Allocate the structure, include the 1st level lookup table
|
|---|
| 87 | * if it's below the threshold size.
|
|---|
| 88 | */
|
|---|
| 89 | cb = sizeof(RTHANDLETABLEINT);
|
|---|
| 90 | if (cLevel1 < RTHT_LEVEL1_DYN_ALLOC_THRESHOLD)
|
|---|
| 91 | cb = RT_ALIGN(cb, sizeof(void *)) + cLevel1 * sizeof(void *);
|
|---|
| 92 | pThis = (PRTHANDLETABLEINT)RTMemAllocZ(cb);
|
|---|
| 93 | if (!pThis)
|
|---|
| 94 | return VERR_NO_MEMORY;
|
|---|
| 95 |
|
|---|
| 96 | /*
|
|---|
| 97 | * Initialize it.
|
|---|
| 98 | */
|
|---|
| 99 | pThis->u32Magic = RTHANDLETABLE_MAGIC;
|
|---|
| 100 | pThis->fFlags = fFlags;
|
|---|
| 101 | pThis->uBase = uBase;
|
|---|
| 102 | pThis->cCur = 0;
|
|---|
| 103 | pThis->hSpinlock = NIL_RTSPINLOCK;
|
|---|
| 104 | if (cLevel1 < RTHT_LEVEL1_DYN_ALLOC_THRESHOLD)
|
|---|
| 105 | pThis->papvLevel1 = (void **)((uint8_t *)pThis + RT_ALIGN(sizeof(*pThis), sizeof(void *)));
|
|---|
| 106 | else
|
|---|
| 107 | pThis->papvLevel1 = NULL;
|
|---|
| 108 | pThis->pfnRetain = pfnRetain;
|
|---|
| 109 | pThis->pvRetainUser = pvUser;
|
|---|
| 110 | pThis->cMax = cMax;
|
|---|
| 111 | pThis->cCurAllocated = 0;
|
|---|
| 112 | pThis->cLevel1 = cLevel1 < RTHT_LEVEL1_DYN_ALLOC_THRESHOLD ? cLevel1 : 0;
|
|---|
| 113 | pThis->iFreeHead = NIL_RTHT_INDEX;
|
|---|
| 114 | pThis->iFreeTail = NIL_RTHT_INDEX;
|
|---|
| 115 | if (fFlags & (RTHANDLETABLE_FLAGS_LOCKED | RTHANDLETABLE_FLAGS_LOCKED_IRQ_SAFE))
|
|---|
| 116 | {
|
|---|
| 117 | int rc;
|
|---|
| 118 | if (fFlags & RTHANDLETABLE_FLAGS_LOCKED_IRQ_SAFE)
|
|---|
| 119 | rc = RTSpinlockCreate(&pThis->hSpinlock, RTSPINLOCK_FLAGS_INTERRUPT_SAFE, "RTHandleTableCreateEx");
|
|---|
| 120 | else
|
|---|
| 121 | rc = RTSpinlockCreate(&pThis->hSpinlock, RTSPINLOCK_FLAGS_INTERRUPT_UNSAFE, "RTHandleTableCreateEx");
|
|---|
| 122 | if (RT_FAILURE(rc))
|
|---|
| 123 | {
|
|---|
| 124 | RTMemFree(pThis);
|
|---|
| 125 | return rc;
|
|---|
| 126 | }
|
|---|
| 127 | }
|
|---|
| 128 |
|
|---|
| 129 | *phHandleTable = pThis;
|
|---|
| 130 | return VINF_SUCCESS;
|
|---|
| 131 | }
|
|---|
| 132 | RT_EXPORT_SYMBOL(RTHandleTableCreateEx);
|
|---|
| 133 |
|
|---|
| 134 |
|
|---|
| 135 | RTDECL(int) RTHandleTableCreate(PRTHANDLETABLE phHandleTable)
|
|---|
| 136 | {
|
|---|
| 137 | return RTHandleTableCreateEx(phHandleTable, RTHANDLETABLE_FLAGS_LOCKED, 1, 65534, NULL, NULL);
|
|---|
| 138 | }
|
|---|
| 139 | RT_EXPORT_SYMBOL(RTHandleTableCreate);
|
|---|
| 140 |
|
|---|
| 141 |
|
|---|
| 142 | RTDECL(int) RTHandleTableDestroy(RTHANDLETABLE hHandleTable, PFNRTHANDLETABLEDELETE pfnDelete, void *pvUser)
|
|---|
| 143 | {
|
|---|
| 144 | PRTHANDLETABLEINT pThis;
|
|---|
| 145 | uint32_t i1;
|
|---|
| 146 | uint32_t i;
|
|---|
| 147 |
|
|---|
| 148 | /*
|
|---|
| 149 | * Validate input, quietly ignore the NIL handle.
|
|---|
| 150 | */
|
|---|
| 151 | if (hHandleTable == NIL_RTHANDLETABLE)
|
|---|
| 152 | return VINF_SUCCESS;
|
|---|
| 153 | pThis = (PRTHANDLETABLEINT)hHandleTable;
|
|---|
| 154 | AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
|
|---|
| 155 | AssertReturn(pThis->u32Magic == RTHANDLETABLE_MAGIC, VERR_INVALID_HANDLE);
|
|---|
| 156 | AssertPtrNullReturn(pfnDelete, VERR_INVALID_POINTER);
|
|---|
| 157 |
|
|---|
| 158 | /*
|
|---|
| 159 | * Mark the thing as invalid / deleted.
|
|---|
| 160 | * Then kill the lock.
|
|---|
| 161 | */
|
|---|
| 162 | rtHandleTableLock(pThis);
|
|---|
| 163 | ASMAtomicWriteU32(&pThis->u32Magic, ~RTHANDLETABLE_MAGIC);
|
|---|
| 164 | rtHandleTableUnlock(pThis);
|
|---|
| 165 |
|
|---|
| 166 | if (pThis->hSpinlock != NIL_RTSPINLOCK)
|
|---|
| 167 | {
|
|---|
| 168 | rtHandleTableLock(pThis);
|
|---|
| 169 | rtHandleTableUnlock(pThis);
|
|---|
| 170 |
|
|---|
| 171 | RTSpinlockDestroy(pThis->hSpinlock);
|
|---|
| 172 | pThis->hSpinlock = NIL_RTSPINLOCK;
|
|---|
| 173 | }
|
|---|
| 174 |
|
|---|
| 175 | if (pfnDelete)
|
|---|
| 176 | {
|
|---|
| 177 | /*
|
|---|
| 178 | * Walk all the tables looking for used handles.
|
|---|
| 179 | */
|
|---|
| 180 | uint32_t cLeft = pThis->cCurAllocated;
|
|---|
| 181 | if (pThis->fFlags & RTHANDLETABLE_FLAGS_CONTEXT)
|
|---|
| 182 | {
|
|---|
| 183 | for (i1 = 0; cLeft > 0 && i1 < pThis->cLevel1; i1++)
|
|---|
| 184 | {
|
|---|
| 185 | PRTHTENTRYCTX paTable = (PRTHTENTRYCTX)pThis->papvLevel1[i1];
|
|---|
| 186 | if (paTable)
|
|---|
| 187 | for (i = 0; i < RTHT_LEVEL2_ENTRIES; i++)
|
|---|
| 188 | if (!RTHT_IS_FREE(paTable[i].pvObj))
|
|---|
| 189 | {
|
|---|
| 190 | pfnDelete(hHandleTable, pThis->uBase + i + i1 * RTHT_LEVEL2_ENTRIES,
|
|---|
| 191 | paTable[i].pvObj, paTable[i].pvCtx, pvUser);
|
|---|
| 192 | Assert(cLeft > 0);
|
|---|
| 193 | cLeft--;
|
|---|
| 194 | }
|
|---|
| 195 | }
|
|---|
| 196 | }
|
|---|
| 197 | else
|
|---|
| 198 | {
|
|---|
| 199 | for (i1 = 0; cLeft > 0 && i1 < pThis->cLevel1; i1++)
|
|---|
| 200 | {
|
|---|
| 201 | PRTHTENTRY paTable = (PRTHTENTRY)pThis->papvLevel1[i1];
|
|---|
| 202 | if (paTable)
|
|---|
| 203 | for (i = 0; i < RTHT_LEVEL2_ENTRIES; i++)
|
|---|
| 204 | if (!RTHT_IS_FREE(paTable[i].pvObj))
|
|---|
| 205 | {
|
|---|
| 206 | pfnDelete(hHandleTable, pThis->uBase + i + i1 * RTHT_LEVEL2_ENTRIES,
|
|---|
| 207 | paTable[i].pvObj, NULL, pvUser);
|
|---|
| 208 | Assert(cLeft > 0);
|
|---|
| 209 | cLeft--;
|
|---|
| 210 | }
|
|---|
| 211 | }
|
|---|
| 212 | }
|
|---|
| 213 | Assert(!cLeft);
|
|---|
| 214 | }
|
|---|
| 215 |
|
|---|
| 216 | /*
|
|---|
| 217 | * Free the memory.
|
|---|
| 218 | */
|
|---|
| 219 | for (i1 = 0; i1 < pThis->cLevel1; i1++)
|
|---|
| 220 | if (pThis->papvLevel1[i1])
|
|---|
| 221 | {
|
|---|
| 222 | RTMemFree(pThis->papvLevel1[i1]);
|
|---|
| 223 | pThis->papvLevel1[i1] = NULL;
|
|---|
| 224 | }
|
|---|
| 225 |
|
|---|
| 226 | if (pThis->cMax / RTHT_LEVEL2_ENTRIES >= RTHT_LEVEL1_DYN_ALLOC_THRESHOLD)
|
|---|
| 227 | RTMemFree(pThis->papvLevel1);
|
|---|
| 228 |
|
|---|
| 229 | RTMemFree(pThis);
|
|---|
| 230 |
|
|---|
| 231 | return VINF_SUCCESS;
|
|---|
| 232 | }
|
|---|
| 233 | RT_EXPORT_SYMBOL(RTHandleTableDestroy);
|
|---|
| 234 |
|
|---|
