| 1 | /* $Id: allocex.h 106061 2024-09-16 14:03:52Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * IPRT - Memory Allocation, Extended Alloc and Free Functions for Ring-3.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2024 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 | #ifndef IPRT_INCLUDED_SRC_r3_allocex_h
|
|---|
| 38 | #define IPRT_INCLUDED_SRC_r3_allocex_h
|
|---|
| 39 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 40 | # pragma once
|
|---|
| 41 | #endif
|
|---|
| 42 |
|
|---|
| 43 | #include <iprt/types.h>
|
|---|
| 44 |
|
|---|
| 45 | /**
|
|---|
| 46 | * Heading for extended memory allocations in ring-3.
|
|---|
| 47 | */
|
|---|
| 48 | typedef struct RTMEMHDRR3
|
|---|
| 49 | {
|
|---|
| 50 | /** Magic (RTMEMHDR_MAGIC). */
|
|---|
| 51 | uint32_t u32Magic;
|
|---|
| 52 | /** Block flags (RTMEMALLOCEX_FLAGS_*). */
|
|---|
| 53 | uint32_t fFlags;
|
|---|
| 54 | /** The actual size of the block, header not included. */
|
|---|
| 55 | uint32_t cb;
|
|---|
| 56 | /** The requested allocation size. */
|
|---|
| 57 | uint32_t cbReq;
|
|---|
| 58 | } RTMEMHDRR3;
|
|---|
| 59 | /** Pointer to a ring-3 extended memory header. */
|
|---|
| 60 | typedef RTMEMHDRR3 *PRTMEMHDRR3;
|
|---|
| 61 |
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Allocate memory in below 64KB.
|
|---|
| 65 | *
|
|---|
| 66 | * @returns IPRT status code.
|
|---|
| 67 | * @param cbAlloc Number of bytes to allocate (including the
|
|---|
| 68 | * header if the caller needs one).
|
|---|
| 69 | * @param fFlags Allocation flags.
|
|---|
| 70 | * @param ppv Where to return the pointer to the memory.
|
|---|
| 71 | */
|
|---|
| 72 | DECLHIDDEN(int) rtMemAllocEx16BitReach(size_t cbAlloc, uint32_t fFlags, void **ppv);
|
|---|
| 73 |
|
|---|
| 74 | /**
|
|---|
| 75 | * Allocate memory in below 4GB.
|
|---|
| 76 | *
|
|---|
| 77 | * @returns IPRT status code.
|
|---|
| 78 | * @param cbAlloc Number of bytes to allocate (including the
|
|---|
| 79 | * header if the caller needs one).
|
|---|
| 80 | * @param fFlags Allocation flags.
|
|---|
| 81 | * @param ppv Where to return the pointer to the memory.
|
|---|
| 82 | */
|
|---|
| 83 | DECLHIDDEN(int) rtMemAllocEx32BitReach(size_t cbAlloc, uint32_t fFlags, void **ppv);
|
|---|
| 84 |
|
|---|
| 85 |
|
|---|
| 86 | /**
|
|---|
| 87 | * Frees memory allocated by rtMemAllocEx16BitReach and rtMemAllocEx32BitReach.
|
|---|
| 88 | *
|
|---|
| 89 | * @param pv Start of allocation.
|
|---|
| 90 | * @param cb Allocation size.
|
|---|
| 91 | * @param fFlags Allocation flags.
|
|---|
| 92 | */
|
|---|
| 93 | DECLHIDDEN(void) rtMemFreeExYyBitReach(void *pv, size_t cb, uint32_t fFlags);
|
|---|
| 94 |
|
|---|
| 95 | #endif /* !IPRT_INCLUDED_SRC_r3_allocex_h */
|
|---|
| 96 |
|
|---|
