[apple/xnu.git] / osfmk / mach / vm_types.h

/*
 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 * 
 */
#ifndef	_MACH_VM_TYPES_H_
#define _MACH_VM_TYPES_H_

#include <mach/port.h>
#include <mach/machine/vm_types.h>

#include <stdint.h>

typedef vm_offset_t     	pointer_t;
typedef vm_offset_t     	vm_address_t;

/*
 * We use addr64_t for 64-bit addresses that are used on both
 * 32 and 64-bit machines.  On PPC, they are passed and returned as
 * two adjacent 32-bit GPRs.  We use addr64_t in places where
 * common code must be useable both on 32 and 64-bit machines.
 */
typedef uint64_t addr64_t;		/* Basic effective address */

/*
 * We use reg64_t for addresses that are 32 bits on a 32-bit
 * machine, and 64 bits on a 64-bit machine, but are always
 * passed and returned in a single GPR on PPC.  This type
 * cannot be used in generic 32-bit c, since on a 64-bit
 * machine the upper half of the register will be ignored
 * by the c compiler in 32-bit mode.  In c, we can only use the
 * type in prototypes of functions that are written in and called
 * from assembly language.  This type is basically a comment.
 */
typedef	uint32_t	reg64_t;

/*
 * To minimize the use of 64-bit fields, we keep some physical
 * addresses (that are page aligned) as 32-bit page numbers. 
 * This limits the physical address space to 16TB of RAM.
 */
typedef uint32_t ppnum_t;		/* Physical page number */
#define PPNUM_MAX UINT32_MAX


#ifdef	KERNEL_PRIVATE

#include <sys/cdefs.h>

#ifndef	MACH_KERNEL_PRIVATE
/*
 * Use specifically typed null structures for these in
 * other parts of the kernel to enable compiler warnings
 * about type mismatches, etc...  Otherwise, these would
 * be void*.
 */
__BEGIN_DECLS

struct pmap ;
struct _vm_map ;
struct vm_object ;

__END_DECLS

#endif	/* MACH_KERNEL_PRIVATE */

typedef struct pmap		*pmap_t;
typedef struct _vm_map		*vm_map_t;
typedef struct vm_object 	*vm_object_t;
typedef struct vm_object_fault_info 	*vm_object_fault_info_t;

#define PMAP_NULL		((pmap_t) 0)
#define VM_OBJECT_NULL	((vm_object_t) 0)

#else   /* KERNEL_PRIVATE */

typedef mach_port_t		vm_map_t;

#endif  /* KERNEL_PRIVATE */

#define VM_MAP_NULL		((vm_map_t) 0)

/*
 * Evolving definitions, likely to change.
 */

typedef uint64_t		vm_object_offset_t;
typedef uint64_t		vm_object_size_t;

#ifdef  KERNEL_PRIVATE

#ifndef	MACH_KERNEL_PRIVATE

__BEGIN_DECLS

struct upl ;
struct vm_map_copy ;
struct vm_named_entry ;

__END_DECLS

#endif	/* MACH_KERNEL_PRIVATE */

typedef struct upl		*upl_t;
typedef struct vm_map_copy	*vm_map_copy_t;
typedef struct vm_named_entry	*vm_named_entry_t;

#define VM_MAP_COPY_NULL	((vm_map_copy_t) 0)

#else	/* KERNEL_PRIVATE */

typedef mach_port_t		upl_t;
typedef mach_port_t		vm_named_entry_t;

#endif	/* KERNEL_PRIVATE */

#define UPL_NULL		((upl_t) 0)
#define VM_NAMED_ENTRY_NULL	((vm_named_entry_t) 0)

#endif	/* _MACH_VM_TYPES_H_ */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*
	31	*/
91447636 A	32	#ifndef _MACH_VM_TYPES_H_
91447636 A	33	#define _MACH_VM_TYPES_H_
9bccf70c	34
0b4e3aa0	35	#include <mach/port.h>
1c79356b A	36	#include <mach/machine/vm_types.h>
1c79356b A	37
91447636 A	38	#include <stdint.h>
91447636 A	39
1c79356b A	40	typedef vm_offset_t pointer_t;
1c79356b A	41	typedef vm_offset_t vm_address_t;
1c79356b	42
55e303ae A	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	*/
	49	typedef 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	*/
	61	typedef 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	*/
	68	typedef uint32_t ppnum_t; /* Physical page number */
e5568f75	69	#define PPNUM_MAX UINT32_MAX
55e303ae	70
1c79356b	71
91447636	72	#ifdef KERNEL_PRIVATE
0b4e3aa0	73
91447636 A	74	#include <sys/cdefs.h>
	75
	76	#ifndef MACH_KERNEL_PRIVATE
1c79356b A	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	*/
91447636 A	83	__BEGIN_DECLS
	84
	85	struct pmap ;
2d21ac55	86	struct _vm_map ;
1c79356b	87	struct vm_object ;
9bccf70c	88
91447636 A	89	__END_DECLS
	90
	91	#endif /* MACH_KERNEL_PRIVATE */
9bccf70c	92
91447636	93	typedef struct pmap *pmap_t;
2d21ac55	94	typedef struct _vm_map *vm_map_t;
9bccf70c	95	typedef struct vm_object *vm_object_t;
2d21ac55	96	typedef struct vm_object_fault_info *vm_object_fault_info_t;
91447636 A	97
	98	#define PMAP_NULL ((pmap_t) 0)
	99	#define VM_OBJECT_NULL ((vm_object_t) 0)
9bccf70c A	100
	101	#else /* KERNEL_PRIVATE */
	102
	103	typedef mach_port_t vm_map_t;
	104
	105	#endif /* KERNEL_PRIVATE */
	106
	107	#define VM_MAP_NULL ((vm_map_t) 0)
	108
91447636 A	109	/*
	110	* Evolving definitions, likely to change.
	111	*/
9bccf70c	112
91447636 A	113	typedef uint64_t vm_object_offset_t;
91447636 A	114	typedef uint64_t vm_object_size_t;
9bccf70c A	115
	116	#ifdef KERNEL_PRIVATE
	117
91447636 A	118	#ifndef MACH_KERNEL_PRIVATE
	119
	120	__BEGIN_DECLS
	121
9bccf70c	122	struct upl ;
1c79356b	123	struct vm_map_copy ;
0b4e3aa0	124	struct vm_named_entry ;
91447636 A	125
	126	__END_DECLS
	127
	128	#endif /* MACH_KERNEL_PRIVATE */
1c79356b	129
0b4e3aa0	130	typedef struct upl *upl_t;
9bccf70c	131	typedef struct vm_map_copy *vm_map_copy_t;
0b4e3aa0 A	132	typedef struct vm_named_entry *vm_named_entry_t;
0b4e3aa0 A	133
0b4e3aa0 A	134	#define VM_MAP_COPY_NULL ((vm_map_copy_t) 0)
0b4e3aa0 A	135
91447636	136	#else /* KERNEL_PRIVATE */
0b4e3aa0 A	137
0b4e3aa0 A	138	typedef mach_port_t upl_t;
0b4e3aa0 A	139	typedef mach_port_t vm_named_entry_t;
0b4e3aa0 A	140
91447636	141	#endif /* KERNEL_PRIVATE */
1c79356b	142
0b4e3aa0	143	#define UPL_NULL ((upl_t) 0)
0b4e3aa0	144	#define VM_NAMED_ENTRY_NULL ((vm_named_entry_t) 0)
1c79356b	145
91447636	146	#endif /* _MACH_VM_TYPES_H_ */