allocex-r3-generic.cpp revision dd3b708fb52e912a0a07fab811a5427d5abf15e6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/* $Id$ */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * IPRT - Memory Allocation, Extended Alloc and Free Functions for Ring-3, generic.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/*
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Copyright (C) 2006-2013 Oracle Corporation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * available from http://www.virtualbox.org. This file is free software;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * you can redistribute it and/or modify it under the terms of the GNU
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * General Public License (GPL) as published by the Free Software
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * The contents of this file may alternatively be used under the terms
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * of the Common Development and Distribution License Version 1.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * VirtualBox OSE distribution, in which case the provisions of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * CDDL are applicable instead of those of the GPL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * You may elect to license modified versions of this file under the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * terms and conditions of either the GPL or the CDDL or both.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/*******************************************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync* Header Files *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync*******************************************************************************/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define RTMEM_NO_WRAP_TO_EF_APIS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <iprt/mem.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include "internal/iprt.h"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <iprt/assert.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <iprt/string.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include "internal/magics.h"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/*******************************************************************************
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync* Structures and Typedefs *
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync*******************************************************************************/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Heading for extended memory allocations in ring-3.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct RTMEMHDRR3
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /** Magic (RTMEMHDR_MAGIC). */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync uint32_t u32Magic;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /** Block flags (RTMEMALLOCEX_FLAGS_*). */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync uint32_t fFlags;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /** The actual size of the block, header not included. */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync uint32_t cb;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /** The requested allocation size. */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync uint32_t cbReq;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} RTMEMHDRR3;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** Pointer to a ring-3 extended memory header. */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef RTMEMHDRR3 *PRTMEMHDRR3;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRTDECL(int) RTMemAllocExTag(size_t cb, size_t cbAlignment, uint32_t fFlags, const char *pszTag, void **ppv) RT_NO_THROW
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /*
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Validate and adjust input.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AssertMsgReturn(!(fFlags & ~RTMEMALLOCEX_FLAGS_VALID_MASK), ("%#x\n", fFlags), VERR_INVALID_PARAMETER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AssertReturn(cb > 0, VERR_INVALID_PARAMETER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AssertReturn(RT_IS_POWER_OF_TWO(cbAlignment), VERR_INVALID_PARAMETER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AssertMsgReturn(cbAlignment <= sizeof(void *), ("%zu (%#x)\n", cbAlignment, cbAlignment), VERR_UNSUPPORTED_ALIGNMENT);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (fFlags & (RTMEMALLOCEX_FLAGS_16BIT_REACH | RTMEMALLOCEX_FLAGS_32BIT_REACH | RTMEMALLOCEX_FLAGS_ANY_CTX))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return VERR_NOT_SUPPORTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /*
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Align the request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync size_t cbAligned = cb;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (cbAlignment)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cbAligned = RT_ALIGN_Z(cb, cbAlignment);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync else
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cbAligned = RT_ALIGN_Z(cb, sizeof(uint64_t));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AssertMsgReturn(cbAligned >= cb && cbAligned <= ~(size_t)0 / 2U, ("cbAligned=%#zx cb=%#zx", cbAligned, cb),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VERR_INVALID_PARAMETER);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /*
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Allocate the requested memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync void *pv;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (fFlags & RTMEMALLOCEX_FLAGS_EXEC)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pv = RTMemExecAlloc(cbAligned + sizeof(RTMEMHDRR3));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((fFlags & RTMEMALLOCEX_FLAGS_ZEROED) && pv)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RT_BZERO(pv, cbAligned + sizeof(RTMEMHDRR3));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync else if (fFlags & RTMEMALLOCEX_FLAGS_ZEROED)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pv = RTMemAllocZ(cbAligned + sizeof(RTMEMHDRR3));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync else
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pv = RTMemAlloc(cbAligned + sizeof(RTMEMHDRR3));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!pv)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return VERR_NO_MEMORY;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /*
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync * Fill in the header and return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync */
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PRTMEMHDRR3 pHdr = (PRTMEMHDRR3)pv;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pHdr->u32Magic = RTMEMHDR_MAGIC;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pHdr->fFlags = fFlags;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pHdr->cb = cbAligned;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pHdr->cbReq = cb;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *ppv = pHdr + 1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return VINF_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRT_EXPORT_SYMBOL(RTMemAllocExTag);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRTDECL(void) RTMemFreeEx(void *pv, size_t cb) RT_NO_THROW
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!pv)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AssertPtr(pv);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PRTMEMHDRR3 pHdr = (PRTMEMHDRR3)pv - 1;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AssertMsg(pHdr->u32Magic == RTMEMHDR_MAGIC, ("pHdr->u32Magic=%RX32 pv=%p cb=%#x\n", pHdr->u32Magic, pv, cb));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pHdr->u32Magic = RTMEMHDR_MAGIC_DEAD;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Assert(pHdr->cbReq == cb);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (pHdr->fFlags & RTMEMALLOCEX_FLAGS_EXEC)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RTMemExecFree(pHdr, pHdr->cb + sizeof(*pHdr));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync else
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RTMemFree(pHdr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncRT_EXPORT_SYMBOL(RTMemFreeEx);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync