1/*
2 * Copyright (c) 2000-2004 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#ifndef	_MACH_VM_TYPES_H_
33#define _MACH_VM_TYPES_H_
34
35#include <mach/port.h>
36#include <mach/machine/vm_types.h>
37
38#include <stdint.h>
39
40typedef vm_offset_t     	pointer_t;
41typedef vm_offset_t     	vm_address_t;
42
43/*
44 * We use addr64_t for 64-bit addresses that are used on both
45 * 32 and 64-bit machines.  On PPC, they are passed and returned as
46 * two adjacent 32-bit GPRs.  We use addr64_t in places where
47 * common code must be useable both on 32 and 64-bit machines.
48 */
49typedef uint64_t addr64_t;		/* Basic effective address */
50
51/*
52 * We use reg64_t for addresses that are 32 bits on a 32-bit
53 * machine, and 64 bits on a 64-bit machine, but are always
54 * passed and returned in a single GPR on PPC.  This type
55 * cannot be used in generic 32-bit c, since on a 64-bit
56 * machine the upper half of the register will be ignored
57 * by the c compiler in 32-bit mode.  In c, we can only use the
58 * type in prototypes of functions that are written in and called
59 * from assembly language.  This type is basically a comment.
60 */
61typedef	uint32_t	reg64_t;
62
63/*
64 * To minimize the use of 64-bit fields, we keep some physical
65 * addresses (that are page aligned) as 32-bit page numbers.
66 * This limits the physical address space to 16TB of RAM.
67 */
68typedef uint32_t ppnum_t;		/* Physical page number */
69#define PPNUM_MAX UINT32_MAX
70
71
72#ifdef	KERNEL_PRIVATE
73
74#include <sys/cdefs.h>
75
76#ifndef	MACH_KERNEL_PRIVATE
77/*
78 * Use specifically typed null structures for these in
79 * other parts of the kernel to enable compiler warnings
80 * about type mismatches, etc...  Otherwise, these would
81 * be void*.
82 */
83__BEGIN_DECLS
84
85struct pmap ;
86struct _vm_map ;
87struct vm_object ;
88
89__END_DECLS
90
91#endif	/* MACH_KERNEL_PRIVATE */
92
93typedef struct pmap		*pmap_t;
94typedef struct _vm_map		*vm_map_t;
95typedef struct vm_object 	*vm_object_t;
96typedef struct vm_object_fault_info 	*vm_object_fault_info_t;
97
98#define PMAP_NULL		((pmap_t) 0)
99#define VM_OBJECT_NULL	((vm_object_t) 0)
100
101#else   /* KERNEL_PRIVATE */
102
103typedef mach_port_t		vm_map_t;
104
105#endif  /* KERNEL_PRIVATE */
106
107#define VM_MAP_NULL		((vm_map_t) 0)
108
109/*
110 * Evolving definitions, likely to change.
111 */
112
113typedef uint64_t		vm_object_offset_t;
114typedef uint64_t		vm_object_size_t;
115
116#ifdef  KERNEL_PRIVATE
117
118#ifndef	MACH_KERNEL_PRIVATE
119
120__BEGIN_DECLS
121
122struct upl ;
123struct vm_map_copy ;
124struct vm_named_entry ;
125
126__END_DECLS
127
128#endif	/* MACH_KERNEL_PRIVATE */
129
130typedef struct upl		*upl_t;
131typedef struct vm_map_copy	*vm_map_copy_t;
132typedef struct vm_named_entry	*vm_named_entry_t;
133
134#define VM_MAP_COPY_NULL	((vm_map_copy_t) 0)
135
136#else	/* KERNEL_PRIVATE */
137
138typedef mach_port_t		upl_t;
139typedef mach_port_t		vm_named_entry_t;
140
141#endif	/* KERNEL_PRIVATE */
142
143#define UPL_NULL		((upl_t) 0)
144#define VM_NAMED_ENTRY_NULL	((vm_named_entry_t) 0)
145
146#endif	/* _MACH_VM_TYPES_H_ */
147