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

/*
 * Copyright (c) 2002,2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 * 
 */
#ifndef	MACH_VM_TYPES_H_
#define MACH_VM_TYPES_H_

#include <stdint.h>
#include <sys/appleapiopts.h>

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

typedef vm_offset_t     	pointer_t;
typedef vm_offset_t     	vm_address_t;
typedef uint64_t		vm_object_offset_t;

#ifdef KERNEL_PRIVATE

#if !defined(__APPLE_API_PRIVATE) || !defined(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*.
 */
struct vm_map ;
struct vm_object ;

#endif /* !__APPLE_API_PRIVATE || !MACH_KERNEL_PRIVATE */

typedef struct vm_map		*vm_map_t;
typedef struct vm_object 	*vm_object_t;
#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)


#ifdef  __APPLE_API_EVOLVING

#ifdef  KERNEL_PRIVATE

#ifndef MACH_KERNEL_PRIVATE
struct upl ;
struct vm_map_copy ;
struct vm_named_entry ;
#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	/* __APPLE_API_EVOLVING */

#endif	/* MACH_VM_TYPES_H_ */
Commit	Line	Data
1c79356b	1	/*
9bccf70c	2	* Copyright (c) 2002,2000 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
de355530 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
de355530 A	12	* This Original Code and all software distributed under the License are
de355530 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
de355530 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* @OSF_COPYRIGHT@
	24	*
	25	*/
	26	#ifndef MACH_VM_TYPES_H_
	27	#define MACH_VM_TYPES_H_
	28
9bccf70c A	29	#include <stdint.h>
	30	#include <sys/appleapiopts.h>
	31
0b4e3aa0	32	#include <mach/port.h>
1c79356b A	33	#include <mach/machine/vm_types.h>
	34
	35	typedef vm_offset_t pointer_t;
	36	typedef vm_offset_t vm_address_t;
9bccf70c	37	typedef uint64_t vm_object_offset_t;
1c79356b A	38
	39	#ifdef KERNEL_PRIVATE
	40
9bccf70c	41	#if !defined(__APPLE_API_PRIVATE) \|\| !defined(MACH_KERNEL_PRIVATE)
0b4e3aa0	42
1c79356b A	43	/*
	44	* Use specifically typed null structures for these in
	45	* other parts of the kernel to enable compiler warnings
	46	* about type mismatches, etc... Otherwise, these would
	47	* be void*.
	48	*/
1c79356b A	49	struct vm_map ;
1c79356b A	50	struct vm_object ;
9bccf70c A	51
	52	#endif /* !__APPLE_API_PRIVATE \|\| !MACH_KERNEL_PRIVATE */
	53
	54	typedef struct vm_map *vm_map_t;
	55	typedef struct vm_object *vm_object_t;
	56	#define VM_OBJECT_NULL ((vm_object_t) 0)
	57
	58	#else /* KERNEL_PRIVATE */
	59
	60	typedef mach_port_t vm_map_t;
	61
	62	#endif /* KERNEL_PRIVATE */
	63
	64	#define VM_MAP_NULL ((vm_map_t) 0)
	65
	66
	67	#ifdef __APPLE_API_EVOLVING
	68
	69	#ifdef KERNEL_PRIVATE
	70
	71	#ifndef MACH_KERNEL_PRIVATE
	72	struct upl ;
1c79356b	73	struct vm_map_copy ;
0b4e3aa0	74	struct vm_named_entry ;
1c79356b A	75	#endif /* !MACH_KERNEL_PRIVATE */
1c79356b A	76
0b4e3aa0	77	typedef struct upl *upl_t;
9bccf70c	78	typedef struct vm_map_copy *vm_map_copy_t;
0b4e3aa0 A	79	typedef struct vm_named_entry *vm_named_entry_t;
0b4e3aa0 A	80
0b4e3aa0 A	81	#define VM_MAP_COPY_NULL ((vm_map_copy_t) 0)
	82
	83	#else /* !KERNEL_PRIVATE */
	84
	85	typedef mach_port_t upl_t;
0b4e3aa0 A	86	typedef mach_port_t vm_named_entry_t;
	87
	88	#endif /* !KERNEL_PRIVATE */
1c79356b	89
0b4e3aa0	90	#define UPL_NULL ((upl_t) 0)
0b4e3aa0	91	#define VM_NAMED_ENTRY_NULL ((vm_named_entry_t) 0)
1c79356b	92
9bccf70c A	93	#endif /* __APPLE_API_EVOLVING */
9bccf70c A	94
1c79356b A	95	#endif /* MACH_VM_TYPES_H_ */
	96
	97