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

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */
/*
 *	File:	mach/task_special_ports.h
 *
 *	Defines codes for special_purpose task ports.  These are NOT
 *	port identifiers - they are only used for the task_get_special_port
 *	and task_set_special_port routines.
 *	
 */

#ifndef	_MACH_TASK_SPECIAL_PORTS_H_
#define _MACH_TASK_SPECIAL_PORTS_H_

#include <sys/appleapiopts.h>

typedef	int	task_special_port_t;

#define TASK_KERNEL_PORT	1	/* Represents task to the outside
					   world.*/

#define TASK_HOST_PORT		2	/* The host (priv) port for task.  */

#define TASK_BOOTSTRAP_PORT	4	/* Bootstrap environment for task. */

#ifdef  __APPLE_API_EVOLVING

#define TASK_WIRED_LEDGER_PORT	5	/* Wired resource ledger for task. */

#define TASK_PAGED_LEDGER_PORT	6	/* Paged resource ledger for task. */

#define task_get_wired_ledger_port(task, port)	\
		(task_get_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))

#define task_set_wired_ledger_port(task, port)	\
		(task_set_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))

#define task_get_paged_ledger_port(task, port)	\
		(task_get_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))

#define task_set_paged_ledger_port(task, port)	\
		(task_set_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))

#endif  /* __APPLE_API_EVOLVING */

/*
 *	Definitions for ease of use
 */

#define task_get_kernel_port(task, port)	\
		(task_get_special_port((task), TASK_KERNEL_PORT, (port)))

#define task_set_kernel_port(task, port)	\
		(task_set_special_port((task), TASK_KERNEL_PORT, (port)))

#define task_get_host_port(task, port)		\
		(task_get_special_port((task), TASK_HOST_PORT, (port)))

#define task_set_host_port(task, port)	\
		(task_set_special_port((task), TASK_HOST_PORT, (port)))

#define task_get_bootstrap_port(task, port)	\
		(task_get_special_port((task), TASK_BOOTSTRAP_PORT, (port)))

#define task_set_bootstrap_port(task, port)	\
		(task_set_special_port((task), TASK_BOOTSTRAP_PORT, (port)))

#endif	/* _MACH_TASK_SPECIAL_PORTS_H_ */
Commit	Line	Data
1c79356b	1	/*
9bccf70c	2	* Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
1c79356b A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
43866e37	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
1c79356b	7	*
43866e37 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
43866e37 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
1c79356b A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
	25	/*
	26	* @OSF_COPYRIGHT@
	27	*/
1c79356b A	28	/*
	29	* Mach Operating System
	30	* Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
	31	* All Rights Reserved.
	32	*
	33	* Permission to use, copy, modify and distribute this software and its
	34	* documentation is hereby granted, provided that both the copyright
	35	* notice and this permission notice appear in all copies of the
	36	* software, derivative works or modified versions, and any portions
	37	* thereof, and that both notices appear in supporting documentation.
	38	*
	39	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	40	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	41	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	42	*
	43	* Carnegie Mellon requests users of this software to return to
	44	*
	45	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	46	* School of Computer Science
	47	* Carnegie Mellon University
	48	* Pittsburgh PA 15213-3890
	49	*
	50	* any improvements or extensions that they make and grant Carnegie Mellon
	51	* the rights to redistribute these changes.
	52	*/
	53	/*
	54	*/
	55	/*
	56	* File: mach/task_special_ports.h
	57	*
	58	* Defines codes for special_purpose task ports. These are NOT
	59	* port identifiers - they are only used for the task_get_special_port
	60	* and task_set_special_port routines.
	61	*
	62	*/
	63
	64	#ifndef _MACH_TASK_SPECIAL_PORTS_H_
	65	#define _MACH_TASK_SPECIAL_PORTS_H_
	66
9bccf70c A	67	#include <sys/appleapiopts.h>
9bccf70c A	68
1c79356b A	69	typedef int task_special_port_t;
	70
	71	#define TASK_KERNEL_PORT 1 /* Represents task to the outside
	72	world.*/
	73
	74	#define TASK_HOST_PORT 2 /* The host (priv) port for task. */
	75
	76	#define TASK_BOOTSTRAP_PORT 4 /* Bootstrap environment for task. */
	77
9bccf70c A	78	#ifdef __APPLE_API_EVOLVING
9bccf70c A	79
1c79356b A	80	#define TASK_WIRED_LEDGER_PORT 5 /* Wired resource ledger for task. */
	81
	82	#define TASK_PAGED_LEDGER_PORT 6 /* Paged resource ledger for task. */
	83
9bccf70c A	84	#define task_get_wired_ledger_port(task, port) \
	85	(task_get_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
	86
	87	#define task_set_wired_ledger_port(task, port) \
	88	(task_set_special_port((task), TASK_WIRED_LEDGER_PORT, (port)))
	89
	90	#define task_get_paged_ledger_port(task, port) \
	91	(task_get_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
	92
	93	#define task_set_paged_ledger_port(task, port) \
	94	(task_set_special_port((task), TASK_PAGED_LEDGER_PORT, (port)))
	95
	96	#endif /* __APPLE_API_EVOLVING */
	97
1c79356b A	98	/*
	99	* Definitions for ease of use
	100	*/
	101
	102	#define task_get_kernel_port(task, port) \
	103	(task_get_special_port((task), TASK_KERNEL_PORT, (port)))
	104
	105	#define task_set_kernel_port(task, port) \
	106	(task_set_special_port((task), TASK_KERNEL_PORT, (port)))
	107
	108	#define task_get_host_port(task, port) \
	109	(task_get_special_port((task), TASK_HOST_PORT, (port)))
	110
	111	#define task_set_host_port(task, port) \
	112	(task_set_special_port((task), TASK_HOST_PORT, (port)))
	113
	114	#define task_get_bootstrap_port(task, port) \
	115	(task_get_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
	116
	117	#define task_set_bootstrap_port(task, port) \
	118	(task_set_special_port((task), TASK_BOOTSTRAP_PORT, (port)))
	119
1c79356b	120	#endif /* _MACH_TASK_SPECIAL_PORTS_H_ */