VirtualBox

source: vbox/trunk/include/iprt/param.h@ 103224

Last change on this file since 103224 was 100318, checked in by vboxsync, 16 months ago

include/iprt/{param.h,zero.h,asm.h}: Make the use of PAGE_SIZE/PAGE_SHIFT/PAGE_OFFSET_MASK in linux.arm64 userspace code result in a build error due to unknown page size, for the kerne side the page size is derived from the kernel config bits, bugref:10476

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.0 KB
Line 
1/** @file
2 * IPRT - Parameter Definitions.
3 */
4
5/*
6 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
7 *
8 * This file is part of VirtualBox base platform packages, as
9 * available from https://www.virtualbox.org.
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation, in version 3 of the
14 * License.
15 *
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <https://www.gnu.org/licenses>.
23 *
24 * The contents of this file may alternatively be used under the terms
25 * of the Common Development and Distribution License Version 1.0
26 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
27 * in the VirtualBox distribution, in which case the provisions of the
28 * CDDL are applicable instead of those of the GPL.
29 *
30 * You may elect to license modified versions of this file under the
31 * terms and conditions of either the GPL or the CDDL or both.
32 *
33 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
34 */
35
36#ifndef IPRT_INCLUDED_param_h
37#define IPRT_INCLUDED_param_h
38#ifndef RT_WITHOUT_PRAGMA_ONCE
39# pragma once
40#endif
41
42#include <iprt/cdefs.h>
43
44/** @todo Much of the PAGE_* stuff here is obsolete and highly risky to have around.
45 * As for component configs (MM_*), either we gather all in here or we move those bits away! */
46
47/** @defgroup grp_rt_param System Parameter Definitions
48 * @ingroup grp_rt_cdefs
49 * @{
50 */
51
52/* Undefine PAGE_SIZE and PAGE_SHIFT to avoid unnecessary noice when clashing
53 * with system headers. Include system headers before / after iprt depending
54 * on which you wish to take precedence. */
55#undef PAGE_SIZE
56#undef PAGE_SHIFT
57
58/* Undefine PAGE_OFFSET_MASK to avoid the conflict with the-linux-kernel.h */
59#undef PAGE_OFFSET_MASK
60
61/**
62 * i386 Page size.
63 */
64#if defined(RT_ARCH_SPARC64)
65# define PAGE_SIZE 8192
66#elif defined(RT_ARCH_ARM64)
67# if defined(RT_OS_DARWIN)
68# define PAGE_SIZE 16384
69# elif defined(RT_OS_LINUX)
70# ifdef IN_RING0
71# define PAGE_SIZE (1 << CONFIG_ARM64_PAGE_SHIFT)
72# else
73# define PAGE_SIZE RT_DONT_USE_PAGE_SIZE_ON_LINUX_ARM64_IN_USERSPACE_DUE_TO_VARIABLE_PAGE_SIZE
74# endif
75# else
76# error "This needs porting"
77# endif
78#else
79# define PAGE_SIZE 4096
80#endif
81
82/**
83 * i386 Page shift.
84 * This is used to convert between size (in bytes) and page count.
85 */
86#if defined(RT_ARCH_SPARC64)
87# define PAGE_SHIFT 13
88#elif defined(RT_ARCH_ARM64)
89# if defined(RT_OS_DARWIN)
90# define PAGE_SHIFT 14
91# elif defined(RT_OS_LINUX)
92# ifdef IN_RING0
93# define PAGE_SHIFT CONFIG_ARM64_PAGE_SHIFT
94# else
95# define PAGE_SHIFT RT_DONT_USE_PAGE_SHIFT_ON_LINUX_ARM64_IN_USERSPACE_DUE_TO_VARIABLE_PAGE_SIZE
96# endif
97# else
98# error "This needs porting"
99# endif
100#else
101# define PAGE_SHIFT 12
102#endif
103
104/**
105 * i386 Page offset mask.
106 *
107 * @note If you do one-complement this, always insert a target type case after
108 * the operator! Otherwise you may end up with weird results.
109 */
110#if defined(RT_ARCH_SPARC64)
111# define PAGE_OFFSET_MASK 0x1fff
112#elif defined(RT_ARCH_ARM64)
113# if defined(RT_OS_DARWIN)
114# define PAGE_OFFSET_MASK 0x3fff
115# elif defined(RT_OS_LINUX)
116# ifdef IN_RING0
117# define PAGE_OFFSET_MASK (PAGE_SIZE - 1)
118# else
119# define PAGE_OFFSET_MASK RT_DONT_USE_PAGE_OFFSET_MASK_ON_LINUX_ARM64_IN_USERSPACE_DUE_TO_VARIABLE_PAGE_SIZE
120# endif
121# else
122# error "This needs porting"
123# endif
124#else
125# define PAGE_OFFSET_MASK 0xfff
126#endif
127
128/**
129 * Page address mask for the uintptr_t sized pointers.
130 *
131 * Be careful when using this since it may be a size too big!
132 * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
133 */
134#define PAGE_BASE_MASK (~(uintptr_t)PAGE_OFFSET_MASK)
135
136/**
137 * Get the page aligned address of a POINTER in the CURRENT context.
138 *
139 * @returns Page aligned address (it's an uintptr_t).
140 * @param pv The virtual address to align.
141 *
142 * @remarks Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
143 * @remarks This only works with POINTERS in the current context.
144 * Do NOT use on guest address or physical address!
145 */
146#define PAGE_ADDRESS(pv) ((uintptr_t)(pv) & ~(uintptr_t)PAGE_OFFSET_MASK)
147
148/**
149 * Get the page aligned address of a physical address
150 *
151 * @returns Page aligned address (it's an RTHCPHYS or RTGCPHYS).
152 * @param Phys The physical address to align.
153 */
154#define PHYS_PAGE_ADDRESS(Phys) ((Phys) & X86_PTE_PAE_PG_MASK)
155
156/**
157 * Host max path (the reasonable value).
158 * @remarks defined both by iprt/param.h and iprt/path.h.
159 */
160#if !defined(IPRT_INCLUDED_path_h) || defined(DOXYGEN_RUNNING)
161# define RTPATH_MAX (4096 + 4) /* (PATH_MAX + 1) on linux w/ some alignment */
162#endif
163
164/** @} */
165
166#endif /* !IPRT_INCLUDED_param_h */
167
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