VirtualBox

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

Last change on this file since 7170 was 5999, checked in by vboxsync, 17 years ago

The Giant CDDL Dual-License Header Change.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.2 KB
Line 
1/** @file
2 * innotek Portable Runtime - Parameter Definitions.
3 */
4
5/*
6 * Copyright (C) 2006-2007 innotek GmbH
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/**
44 * i386 Page size.
45 */
46#define PAGE_SIZE 4096
47
48/**
49 * i386 Page shift.
50 * This is used to convert between size (in bytes) and page count.
51 */
52#define PAGE_SHIFT 12
53
54/**
55 * i386 Page offset mask.
56 *
57 * Do NOT one-complement this for whatever purpose. You may get a 32-bit const when you want a 64-bit one.
58 * Use PAGE_BASE_MASK, PAGE_BASE_GC_MASK, PAGE_BASE_HC_MASK, PAGE_ADDRESS() or X86_PTE_PAE_PG_MASK.
59 */
60#define PAGE_OFFSET_MASK 0xfff
61
62/**
63 * Page address mask for the guest context POINTERS.
64 * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
65 */
66#define PAGE_BASE_GC_MASK (~(RTGCUINTPTR)0xfff)
67
68/**
69 * Page address mask for the host context POINTERS.
70 * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
71 */
72#define PAGE_BASE_HC_MASK (~(RTHCUINTPTR)0xfff)
73
74/**
75 * Page address mask for the both context POINTERS.
76 *
77 * Be careful when using this since it may be a size too big!
78 * @remark Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
79 */
80#define PAGE_BASE_MASK (~(RTUINTPTR)0xfff)
81
82/**
83 * Get the page aligned address of a POINTER in the CURRENT context.
84 *
85 * @returns Page aligned address (it's an uintptr_t).
86 * @param pv The address to align.
87 *
88 * @remarks Physical addresses are always masked using X86_PTE_PAE_PG_MASK!
89 * @remarks This only works with POINTERS in the current context.
90 * Do NOT use on guest address or physical address!
91 */
92#define PAGE_ADDRESS(pv) ((uintptr_t)(pv) & ~(uintptr_t)0xfff)
93
94/**
95 * Host max path (the reasonable value).
96 */
97#define RTPATH_MAX (4096 + 4) /* (PATH_MAX + 1) on linux w/ some alignment */
98
99/** @} */
100
101
102/** @} */
103
104#endif
105
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