VirtualBox

source: vbox/trunk/src/VBox/Runtime/include/internal/mem.h@ 104465

Last change on this file since 104465 was 101162, checked in by vboxsync, 15 months ago

IPRT/mem: Use mempage /w heap code everwhere all the time. bugref:10370

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.6 KB
Line 
1/* $Id: mem.h 101162 2023-09-18 20:03:52Z vboxsync $ */
2/** @file
3 * IPRT - Memory Management.
4 */
5
6/*
7 * Copyright (C) 2010-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#ifndef IPRT_INCLUDED_INTERNAL_mem_h
38#define IPRT_INCLUDED_INTERNAL_mem_h
39#ifndef RT_WITHOUT_PRAGMA_ONCE
40# pragma once
41#endif
42
43#include <iprt/cdefs.h>
44
45RT_C_DECLS_BEGIN
46
47/**
48 * Special allocation method that does not have any IPRT dependencies.
49 *
50 * This is suitable for allocating memory for IPRT heaps, pools, caches, memory
51 * trackers, semaphores and similar that end up in bootstrap depencency hell
52 * otherwise.
53 *
54 * @returns Pointer to the allocated memory, NULL on failure. Must be freed by
55 * calling rtMemBaseFree().
56 * @param cb The number of bytes to allocate.
57 */
58DECLHIDDEN(void *) rtMemBaseAlloc(size_t cb);
59
60/**
61 * Frees memory allocated by rtInitAlloc().
62 *
63 * @param pv What rtInitAlloc() returned.
64 */
65DECLHIDDEN(void) rtMemBaseFree(void *pv);
66
67
68#ifdef IN_RING0
69/** @def RTR0MEM_WITH_EF_APIS
70 * Enables the electrict fence APIs.
71 *
72 * Requires working rtR0MemObjNativeProtect implementation, thus the current
73 * OS restrictions.
74 */
75# if defined(RT_OS_DARWIN) || defined(RT_OS_FREEBSD) || defined(DOXYGEN_RUNNING)
76# define RTR0MEM_WITH_EF_APIS
77# endif
78# ifdef RTR0MEM_WITH_EF_APIS
79DECLHIDDEN(void) rtR0MemEfInit(void);
80DECLHIDDEN(void) rtR0MemEfTerm(void);
81# endif
82#endif
83
84#ifdef IN_RING3
85
86/**
87 * Native allocation worker for the heap-based RTMemPage implementation.
88 */
89DECLHIDDEN(int) rtMemPageNativeAlloc(size_t cb, uint32_t fFlags, void **ppvRet);
90
91/**
92 * Native allocation worker for the heap-based RTMemPage implementation.
93 */
94DECLHIDDEN(int) rtMemPageNativeFree(void *pv, size_t cb);
95
96/**
97 * Native page allocator worker that applies advisory flags to the memory.
98 *
99 * @returns Set of flags succesfully applied
100 * @param pv The memory block address.
101 * @param cb The size of the memory block.
102 * @param fFlags The flags to apply (may include other flags too, ignore).
103 */
104DECLHIDDEN(uint32_t) rtMemPageNativeApplyFlags(void *pv, size_t cb, uint32_t fFlags);
105
106/**
107 * Reverts flags previously applied by rtMemPageNativeApplyFlags().
108 *
109 * @param pv The memory block address.
110 * @param cb The size of the memory block.
111 * @param fFlags The flags to revert.
112 */
113DECLHIDDEN(void) rtMemPageNativeRevertFlags(void *pv, size_t cb, uint32_t fFlags);
114
115#endif /* IN_RING3 */
116
117RT_C_DECLS_END
118
119#endif /* !IPRT_INCLUDED_INTERNAL_mem_h */
120
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette