1/*
2 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/*
29 * @OSF_COPYRIGHT@
30 */
31/*
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989,1988 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
49 *  School of Computer Science
50 *  Carnegie Mellon University
51 *  Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
56/*
57 */
58
59/*
60 *	File:	vm_types.h
61 *	Author:	Avadis Tevanian, Jr.
62 *	Date: 1985
63 *
64 *	Header file for VM data types.  I386 version.
65 */
66
67#ifndef	_MACH_I386_VM_TYPES_H_
68#define _MACH_I386_VM_TYPES_H_
69
70#ifndef	ASSEMBLER
71
72#include <i386/_types.h>
73#include <stdint.h>
74
75/*
76 * natural_t and integer_t are Mach's legacy types for machine-
77 * independent integer types (unsigned, and signed, respectively).
78 * Their original purpose was to define other types in a machine/
79 * compiler independent way.
80 *
81 * They also had an implicit "same size as pointer" characteristic
82 * to them (i.e. Mach's traditional types are very ILP32 or ILP64
83 * centric).  We support x86 ABIs that do not follow either of
84 * these models (specifically LP64).  Therefore, we had to make a
85 * choice between making these types scale with pointers or stay
86 * tied to integers.  Because their use is predominantly tied to
87 * to the size of an integer, we are keeping that association and
88 * breaking free from pointer size guarantees.
89 *
90 * New use of these types is discouraged.
91 */
92typedef __darwin_natural_t	natural_t;
93typedef int			integer_t;
94
95/*
96 * A vm_offset_t is a type-neutral pointer,
97 * e.g. an offset into a virtual memory space.
98 */
99#ifdef __LP64__
100typedef uintptr_t		vm_offset_t;
101#else	/* __LP64__ */
102typedef	natural_t		vm_offset_t;
103#endif	/* __LP64__ */
104
105/*
106 * A vm_size_t is the proper type for e.g.
107 * expressing the difference between two
108 * vm_offset_t entities.
109 */
110#ifdef __LP64__
111typedef uintptr_t		vm_size_t;
112#else	/* __LP64__ */
113typedef	natural_t		vm_size_t;
114#endif	/* __LP64__ */
115
116/*
117 * This new type is independent of a particular vm map's
118 * implementation size - and represents appropriate types
119 * for all possible maps.  This is used for interfaces
120 * where the size of the map is not known - or we don't
121 * want to have to distinguish.
122 */
123typedef uint64_t		mach_vm_address_t;
124typedef uint64_t		mach_vm_offset_t;
125typedef uint64_t		mach_vm_size_t;
126
127typedef uint64_t		vm_map_offset_t;
128typedef uint64_t		vm_map_address_t;
129typedef uint64_t		vm_map_size_t;
130
131#ifdef	MACH_KERNEL_PRIVATE
132
133#ifdef	VM32_SUPPORT
134
135/*
136 * These are types used internal to Mach to implement the
137 * legacy 32-bit VM APIs published by the kernel.
138 */
139typedef uint32_t		vm32_address_t;
140typedef uint32_t		vm32_offset_t;
141typedef uint32_t		vm32_size_t;
142
143#endif	/* VM32_SUPPORT */
144
145#endif	/* MACH_KERNEL_PRIVATE */
146
147#endif	/* ASSEMBLER */
148
149/*
150 * If composing messages by hand (please do not)
151 */
152#define	MACH_MSG_TYPE_INTEGER_T	MACH_MSG_TYPE_INTEGER_32
153
154#endif	/* _MACH_I386_VM_TYPES_H_ */
155