]>
Commit | Line | Data |
---|---|---|
056a1eb7 SF |
1 | /** @file |
2 | * IPRT - Parameter Definitions. | |
3 | */ | |
4 | ||
5 | /* | |
6d209b23 | 6 | * Copyright (C) 2006-2017 Oracle Corporation |
056a1eb7 SF |
7 | * |
8 | * This file is part of VirtualBox Open Source Edition (OSE), as | |
9 | * available from http://www.virtualbox.org. This file is free software; | |
10 | * you can redistribute it and/or modify it under the terms of the GNU | |
11 | * General Public License (GPL) as published by the Free Software | |
12 | * Foundation, in version 2 as it comes in the "COPYING" file of the | |
13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the | |
14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. | |
15 | * | |
16 | * The contents of this file may alternatively be used under the terms | |
17 | * of the Common Development and Distribution License Version 1.0 | |
18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the | |
19 | * VirtualBox OSE distribution, in which case the provisions of the | |
20 | * CDDL are applicable instead of those of the GPL. | |
21 | * | |
22 | * You may elect to license modified versions of this file under the | |
23 | * terms and conditions of either the GPL or the CDDL or both. | |
24 | */ | |
25 | ||
26 | #ifndef ___iprt_param_h | |
27 | #define ___iprt_param_h | |
28 | ||
29 | /** @todo Much of the PAGE_* stuff here is obsolete and highly risky to have around. | |
30 | * As for component configs (MM_*), either we gather all in here or we move those bits away! */ | |
31 | ||
32 | /** @defgroup grp_rt_param System Parameter Definitions | |
33 | * @ingroup grp_rt_cdefs | |
34 | * @{ | |
35 | */ | |
36 | ||
37 | /* Undefine PAGE_SIZE and PAGE_SHIFT to avoid unnecessary noice when clashing | |
38 | * with system headers. Include system headers before / after iprt depending | |
39 | * on which you wish to take precedence. */ | |
40 | #undef PAGE_SIZE | |
41 | #undef PAGE_SHIFT | |
42 | ||
43 | /* Undefine PAGE_OFFSET_MASK to avoid the conflict with the-linux-kernel.h */ | |
44 | #undef PAGE_OFFSET_MASK | |
45 | ||
46 | /** | |
47 | * i386 Page size. | |
48 | */ | |
49 | #if defined(RT_ARCH_SPARC64) | |
50 | # define PAGE_SIZE 8192 | |
51 | #else | |
52 | # define PAGE_SIZE 4096 | |
53 | #endif | |
54 | ||
55 | /** | |
56 | * i386 Page shift. | |
57 | * This is used to convert between size (in bytes) and page count. | |
58 | */ | |
59 | #if defined(RT_ARCH_SPARC64) | |
60 | # define PAGE_SHIFT 13 | |
61 | #else | |
62 | # define PAGE_SHIFT 12 | |
63 | #endif | |
64 | ||
65 | /** | |
66 | * i386 Page offset mask. | |
67 | * | |
68 | * Do NOT one-complement this for whatever purpose. You may get a 32-bit const when you want a 64-bit one. | |
69 | * Use PAGE_BASE_MASK, PAGE_BASE_GC_MASK, PAGE_BASE_HC_MASK, PAGE_ADDRESS() or X86_PTE_PAE_PG_MASK. | |
70 | */ | |
71 | #if defined(RT_ARCH_SPARC64) | |
72 | # define PAGE_OFFSET_MASK 0x1fff | |
73 | #else | |
74 | # define PAGE_OFFSET_MASK 0xfff | |
75 | #endif | |
76 | ||
77 | /** | |
78 | * Page address mask for the guest context POINTERS. | |
79 | * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK! | |
80 | */ | |
81 | #define PAGE_BASE_GC_MASK (~(RTGCUINTPTR)PAGE_OFFSET_MASK) | |
82 | ||
83 | /** | |
84 | * Page address mask for the host context POINTERS. | |
85 | * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK! | |
86 | */ | |
87 | #define PAGE_BASE_HC_MASK (~(RTHCUINTPTR)PAGE_OFFSET_MASK) | |
88 | ||
89 | /** | |
90 | * Page address mask for the both context POINTERS. | |
91 | * | |
92 | * Be careful when using this since it may be a size too big! | |
93 | * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK! | |
94 | */ | |
95 | #define PAGE_BASE_MASK (~(RTUINTPTR)PAGE_OFFSET_MASK) | |
96 | ||
97 | /** | |
98 | * Get the page aligned address of a POINTER in the CURRENT context. | |
99 | * | |
100 | * @returns Page aligned address (it's an uintptr_t). | |
101 | * @param pv The virtual address to align. | |
102 | * | |
103 | * @remarks Physical addresses are always masked using X86_PTE_PAE_PG_MASK! | |
104 | * @remarks This only works with POINTERS in the current context. | |
105 | * Do NOT use on guest address or physical address! | |
106 | */ | |
107 | #define PAGE_ADDRESS(pv) ((uintptr_t)(pv) & ~(uintptr_t)PAGE_OFFSET_MASK) | |
108 | ||
109 | /** | |
110 | * Get the page aligned address of a physical address | |
111 | * | |
112 | * @returns Page aligned address (it's an RTHCPHYS or RTGCPHYS). | |
113 | * @param Phys The physical address to align. | |
114 | */ | |
115 | #define PHYS_PAGE_ADDRESS(Phys) ((Phys) & X86_PTE_PAE_PG_MASK) | |
116 | ||
117 | /** | |
118 | * Host max path (the reasonable value). | |
119 | * @remarks defined both by iprt/param.h and iprt/path.h. | |
120 | */ | |
121 | #if !defined(___iprt_path_h) || defined(DOXYGEN_RUNNING) | |
122 | # define RTPATH_MAX (4096 + 4) /* (PATH_MAX + 1) on linux w/ some alignment */ | |
123 | #endif | |
124 | ||
125 | /** @} */ | |
126 | ||
127 | ||
128 | /** @} */ | |
129 | ||
130 | #endif | |
131 |