VirtualBox

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

Last change on this file since 12822 was 8245, checked in by vboxsync, 17 years ago

rebranding: IPRT files again.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.7 KB
Line 
1/** @file
2 * IPRT - Parameter Definitions.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___iprt_param_h
31#define ___iprt_param_h
32
33/** @todo Much of the PAGE_* stuff here is obsolete and highly risky to have around.
34 * As for component configs (MM_*), either we gather all in here or we move those bits away! */
35
36/** @defgroup grp_rt_param System Parameter Definitions
37 * @ingroup grp_rt_cdefs
38 * @{
39 */
40
41/* Undefine PAGE_SIZE and PAGE_SHIFT to avoid unnecessary noice when clashing
42 with system headers. Include system headers before / after iprt depending
43 on which you wish to take precedence. */
44#undef PAGE_SIZE
45#undef PAGE_SHIFT
46
47/**
48 * i386 Page size.
49 */
50#define PAGE_SIZE 4096
51
52/**
53 * i386 Page shift.
54 * This is used to convert between size (in bytes) and page count.
55 */
56#define PAGE_SHIFT 12
57
58/**
59 * i386 Page offset mask.
60 *
61 * Do NOT one-complement this for whatever purpose. You may get a 32-bit const when you want a 64-bit one.
62 * Use PAGE_BASE_MASK, PAGE_BASE_GC_MASK, PAGE_BASE_HC_MASK, PAGE_ADDRESS() or X86_PTE_PAE_PG_MASK.
63 */
64#define PAGE_OFFSET_MASK 0xfff
65
66/**
67 * Page address mask for the guest context POINTERS.
68 * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
69 */
70#define PAGE_BASE_GC_MASK (~(RTGCUINTPTR)0xfff)
71
72/**
73 * Page address mask for the host context POINTERS.
74 * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
75 */
76#define PAGE_BASE_HC_MASK (~(RTHCUINTPTR)0xfff)
77
78/**
79 * Page address mask for the both context POINTERS.
80 *
81 * Be careful when using this since it may be a size too big!
82 * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
83 */
84#define PAGE_BASE_MASK (~(RTUINTPTR)0xfff)
85
86/**
87 * Get the page aligned address of a POINTER in the CURRENT context.
88 *
89 * @returns Page aligned address (it's an uintptr_t).
90 * @param pv The virtual address to align.
91 *
92 * @remarks Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
93 * @remarks This only works with POINTERS in the current context.
94 * Do NOT use on guest address or physical address!
95 */
96#define PAGE_ADDRESS(pv) ((uintptr_t)(pv) & ~(uintptr_t)0xfff)
97
98/**
99 * Get the page aligned address of a physical address
100 *
101 * @returns Page aligned address (it's an RTHCPHYS or RTGCPHYS).
102 * @param Phys The physical address to align.
103 */
104#define PHYS_PAGE_ADDRESS(Phys) ((Phys) & X86_PTE_PAE_PG_MASK)
105
106/**
107 * Host max path (the reasonable value).
108 */
109#define RTPATH_MAX (4096 + 4) /* (PATH_MAX + 1) on linux w/ some alignment */
110
111/** @} */
112
113
114/** @} */
115
116#endif
117
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