mempool-generic.cpp revision 4110da50b47fcdcce178bdd9e4c6e198469d9de9
20593760b116c90f3e439552763eef632a3bbb17vboxsync * IPRT - Memory Allocation Pool.
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Copyright (C) 2009 Sun Microsystems, Inc.
20593760b116c90f3e439552763eef632a3bbb17vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
20593760b116c90f3e439552763eef632a3bbb17vboxsync * available from http://www.virtualbox.org. This file is free software;
20593760b116c90f3e439552763eef632a3bbb17vboxsync * you can redistribute it and/or modify it under the terms of the GNU
20593760b116c90f3e439552763eef632a3bbb17vboxsync * General Public License (GPL) as published by the Free Software
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
20593760b116c90f3e439552763eef632a3bbb17vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
20593760b116c90f3e439552763eef632a3bbb17vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
20593760b116c90f3e439552763eef632a3bbb17vboxsync * The contents of this file may alternatively be used under the terms
20593760b116c90f3e439552763eef632a3bbb17vboxsync * of the Common Development and Distribution License Version 1.0
20593760b116c90f3e439552763eef632a3bbb17vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20593760b116c90f3e439552763eef632a3bbb17vboxsync * VirtualBox OSE distribution, in which case the provisions of the
20593760b116c90f3e439552763eef632a3bbb17vboxsync * CDDL are applicable instead of those of the GPL.
20593760b116c90f3e439552763eef632a3bbb17vboxsync * You may elect to license modified versions of this file under the
20593760b116c90f3e439552763eef632a3bbb17vboxsync * terms and conditions of either the GPL or the CDDL or both.
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
20593760b116c90f3e439552763eef632a3bbb17vboxsync * additional information or have any questions.
20593760b116c90f3e439552763eef632a3bbb17vboxsync/*******************************************************************************
20593760b116c90f3e439552763eef632a3bbb17vboxsync* Header Files *
20593760b116c90f3e439552763eef632a3bbb17vboxsync*******************************************************************************/
20593760b116c90f3e439552763eef632a3bbb17vboxsync/*******************************************************************************
20593760b116c90f3e439552763eef632a3bbb17vboxsync* Structures and Typedefs *
20593760b116c90f3e439552763eef632a3bbb17vboxsync*******************************************************************************/
20593760b116c90f3e439552763eef632a3bbb17vboxsync/** Pointer to a memory pool instance. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync/** Pointer to a memory pool entry. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Memory pool entry.
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** Pointer to the pool */
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** Pointer to the next entry. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** Pointer to the previous entry. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** The number of references to the pool entry. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Memory pool instance data.
20593760b116c90f3e439552763eef632a3bbb17vboxsynctypedef struct RTMEMPOOLINT
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** Magic number (RTMEMPOOL_MAGIC). */
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** Spinlock protecting the pool entry list updates. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** Head entry pointer. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** The number of entries in the pool (for statistical purposes). */
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** User data assoicated with the pool. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync /** The pool name. (variable length) */
20593760b116c90f3e439552763eef632a3bbb17vboxsync/*******************************************************************************
20593760b116c90f3e439552763eef632a3bbb17vboxsync* Defined Constants And Macros *
20593760b116c90f3e439552763eef632a3bbb17vboxsync*******************************************************************************/
20593760b116c90f3e439552763eef632a3bbb17vboxsync/** Validates a memory pool handle, translating RTMEMPOOL_DEFAULT when found,
20593760b116c90f3e439552763eef632a3bbb17vboxsync * and returns rc if not valid. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync AssertReturn((pMemPool)->u32Magic == RTMEMPOOL_MAGIC, (rc)); \
20593760b116c90f3e439552763eef632a3bbb17vboxsync } while (0)
20593760b116c90f3e439552763eef632a3bbb17vboxsync/** Validates a memory pool entry and returns rc if not valid. */
20593760b116c90f3e439552763eef632a3bbb17vboxsync#define RTMEMPOOL_VALID_ENTRY_RETURN_RC(pEntry, rc) \
20593760b116c90f3e439552763eef632a3bbb17vboxsync AssertReturn((pEntry)->pMemPool->u32Magic == RTMEMPOOL_MAGIC, (rc)); \
20593760b116c90f3e439552763eef632a3bbb17vboxsync } while (0)
20593760b116c90f3e439552763eef632a3bbb17vboxsync/*******************************************************************************
20593760b116c90f3e439552763eef632a3bbb17vboxsync* Global Variables *
20593760b116c90f3e439552763eef632a3bbb17vboxsync*******************************************************************************/
20593760b116c90f3e439552763eef632a3bbb17vboxsync /* .cEntries = */ 0,
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(int) RTMemPoolCreate(PRTMEMPOOL phMemPool, const char *pszName)
20593760b116c90f3e439552763eef632a3bbb17vboxsync PRTMEMPOOLINT pMemPool = (PRTMEMPOOLINT)RTMemAlloc(RT_OFFSETOF(RTMEMPOOLINT, szName[cchName + 1]));
4110da50b47fcdcce178bdd9e4c6e198469d9de9vboxsync RTMEMPOOL_VALID_RETURN_RC(pMemPool, VERR_INVALID_HANDLE);
4110da50b47fcdcce178bdd9e4c6e198469d9de9vboxsync * Invalidate the handle and free all associated resources.
4110da50b47fcdcce178bdd9e4c6e198469d9de9vboxsync ASMAtomicWriteU32(&pMemPool->u32Magic, RTMEMPOOL_MAGIC_DEAD);
4110da50b47fcdcce178bdd9e4c6e198469d9de9vboxsync int rc = RTSpinlockDestroy(pMemPool->hSpinLock); AssertRC(rc);
20593760b116c90f3e439552763eef632a3bbb17vboxsyncDECLINLINE(void) rtMemPoolInitAndLink(PRTMEMPOOLINT pMemPool, PRTMEMPOOLENTRY pEntry)
20593760b116c90f3e439552763eef632a3bbb17vboxsyncDECLINLINE(void) rtMemPoolUnlink(PRTMEMPOOLENTRY pEntry)
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(void *) RTMemPoolAlloc(RTMEMPOOL hMemPool, size_t cb) RT_NO_THROW
20593760b116c90f3e439552763eef632a3bbb17vboxsync PRTMEMPOOLENTRY pEntry = (PRTMEMPOOLENTRY)RTMemAlloc(cb + sizeof(*pEntry));
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(void *) RTMemPoolAllocZ(RTMEMPOOL hMemPool, size_t cb) RT_NO_THROW
20593760b116c90f3e439552763eef632a3bbb17vboxsync PRTMEMPOOLENTRY pEntry = (PRTMEMPOOLENTRY)RTMemAllocZ(cb + sizeof(*pEntry));
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(void *) RTMemPoolDup(RTMEMPOOL hMemPool, const void *pvSrc, size_t cb) RT_NO_THROW
20593760b116c90f3e439552763eef632a3bbb17vboxsync PRTMEMPOOLENTRY pEntry = (PRTMEMPOOLENTRY)RTMemAlloc(cb + sizeof(*pEntry));
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(void *) RTMemPoolDupEx(RTMEMPOOL hMemPool, const void *pvSrc, size_t cbSrc, size_t cbExtra) RT_NO_THROW
20593760b116c90f3e439552763eef632a3bbb17vboxsync PRTMEMPOOLENTRY pEntry = (PRTMEMPOOLENTRY)RTMemAlloc(cbSrc + cbExtra + sizeof(*pEntry));
20593760b116c90f3e439552763eef632a3bbb17vboxsync memset((uint8_t *)(pEntry + 1) + cbSrc, '\0', cbExtra);
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(void *) RTMemPoolRealloc(RTMEMPOOL hMemPool, void *pvOld, size_t cbNew) RT_NO_THROW
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Fend off the odd cases.
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Real realloc.
20593760b116c90f3e439552763eef632a3bbb17vboxsync PRTMEMPOOLENTRY pOldEntry = (PRTMEMPOOLENTRY)pvOld - 1;
20593760b116c90f3e439552763eef632a3bbb17vboxsync * Unlink it from the current pool and try reallocate it.
20593760b116c90f3e439552763eef632a3bbb17vboxsync PRTMEMPOOLENTRY pEntry = (PRTMEMPOOLENTRY)RTMemRealloc(pOldEntry, cbNew + sizeof(*pEntry));
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(void) RTMemPoolFree(RTMEMPOOL hMemPool, void *pv) RT_NO_THROW
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(uint32_t) RTMemPoolRetain(void *pv) RT_NO_THROW
20593760b116c90f3e439552763eef632a3bbb17vboxsync RTMEMPOOL_VALID_ENTRY_RETURN_RC(pEntry, UINT32_MAX);
20593760b116c90f3e439552763eef632a3bbb17vboxsyncRTDECL(uint32_t) RTMemPoolRelease(RTMEMPOOL hMemPool, void *pv) RT_NO_THROW
20593760b116c90f3e439552763eef632a3bbb17vboxsync RTMEMPOOL_VALID_ENTRY_RETURN_RC(pEntry, UINT32_MAX);