[apple/xnu.git] / osfmk / ipc / ipc_types.h

/*
 * Copyright (c) 2000-2005 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@
 */

/*
 * Define Basic IPC types available to callers.
 * These are not intended to be used directly, but
 * are used to define other types available through
 * port.h and mach_types.h for in-kernel entities.
 */

#ifndef	_IPC_IPC_TYPES_H_
#define	_IPC_IPC_TYPES_H_

#include <mach/port.h>
#include <mach/message.h>
#include <mach/mach_types.h>

#ifdef	MACH_KERNEL_PRIVATE

typedef natural_t ipc_table_index_t;	/* index into tables */
typedef natural_t ipc_table_elems_t;	/* size of tables */
typedef natural_t ipc_entry_bits_t;
typedef ipc_table_elems_t ipc_entry_num_t;	/* number of entries */
typedef ipc_table_index_t ipc_port_request_index_t;

typedef mach_port_name_t mach_port_index_t;		/* index values */
typedef mach_port_name_t mach_port_gen_t;		/* generation numbers */

typedef struct ipc_entry *ipc_entry_t;

typedef struct ipc_table_size *ipc_table_size_t;
typedef struct ipc_port_request *ipc_port_request_t;
typedef struct ipc_pset *ipc_pset_t;
typedef struct ipc_kmsg *ipc_kmsg_t;

#define	IE_NULL	((ipc_entry_t) 0)

#define	ITS_NULL	((ipc_table_size_t) 0)
#define ITS_SIZE_NONE	((ipc_table_elems_t) -1)
#define	IPR_NULL	((ipc_port_request_t) 0)
#define	IPS_NULL	((ipc_pset_t) 0)
#define	IKM_NULL	((ipc_kmsg_t) 0)

typedef	void (*mach_msg_continue_t)(mach_msg_return_t);	/* after wakeup */
#define	MACH_MSG_CONTINUE_NULL	((mach_msg_continue_t) 0)

#else	/* MACH_KERNEL_PRIVATE */

struct ipc_object ;

#endif	/* MACH_KERNEL_PRIVATE */

typedef struct ipc_object	*ipc_object_t;

#define IPC_OBJECT_NULL		((ipc_object_t) 0)
#define IPC_OBJECT_DEAD		((ipc_object_t)~0)
#define IPC_OBJECT_VALID(io)	(((io) != IPC_OBJECT_NULL) && \
				 ((io) != IPC_OBJECT_DEAD))

#endif	/* _IPC_IPC_TYPES_H_ */
Commit	Line	Data
1c79356b	1	/*
91447636	2	* Copyright (c) 2000-2005 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	*/
91447636	31
1c79356b A	32	/*
	33	* Define Basic IPC types available to callers.
	34	* These are not intended to be used directly, but
	35	* are used to define other types available through
	36	* port.h and mach_types.h for in-kernel entities.
	37	*/
91447636 A	38
	39	#ifndef _IPC_IPC_TYPES_H_
	40	#define _IPC_IPC_TYPES_H_
1c79356b	41
9bccf70c A	42	#include <mach/port.h>
	43	#include <mach/message.h>
	44	#include <mach/mach_types.h>
1c79356b	45
91447636 A	46	#ifdef MACH_KERNEL_PRIVATE
	47
	48	typedef natural_t ipc_table_index_t; /* index into tables */
	49	typedef natural_t ipc_table_elems_t; /* size of tables */
	50	typedef natural_t ipc_entry_bits_t;
	51	typedef ipc_table_elems_t ipc_entry_num_t; /* number of entries */
	52	typedef ipc_table_index_t ipc_port_request_index_t;
	53
	54	typedef mach_port_name_t mach_port_index_t; /* index values */
	55	typedef mach_port_name_t mach_port_gen_t; /* generation numbers */
	56
	57	typedef struct ipc_entry *ipc_entry_t;
316670eb	58
91447636 A	59	typedef struct ipc_table_size *ipc_table_size_t;
	60	typedef struct ipc_port_request *ipc_port_request_t;
	61	typedef struct ipc_pset *ipc_pset_t;
	62	typedef struct ipc_kmsg *ipc_kmsg_t;
	63
	64	#define IE_NULL ((ipc_entry_t) 0)
316670eb	65
91447636	66	#define ITS_NULL ((ipc_table_size_t) 0)
316670eb	67	#define ITS_SIZE_NONE ((ipc_table_elems_t) -1)
91447636 A	68	#define IPR_NULL ((ipc_port_request_t) 0)
	69	#define IPS_NULL ((ipc_pset_t) 0)
	70	#define IKM_NULL ((ipc_kmsg_t) 0)
	71
	72	typedef void (mach_msg_continue_t)(mach_msg_return_t); / after wakeup */
6d2010ae	73	#define MACH_MSG_CONTINUE_NULL ((mach_msg_continue_t) 0)
91447636 A	74
91447636 A	75	#else /* MACH_KERNEL_PRIVATE */
1c79356b	76
1c79356b	77	struct ipc_object ;
1c79356b	78
91447636	79	#endif /* MACH_KERNEL_PRIVATE */
1c79356b A	80
1c79356b A	81	typedef struct ipc_object *ipc_object_t;
1c79356b A	82
	83	#define IPC_OBJECT_NULL ((ipc_object_t) 0)
	84	#define IPC_OBJECT_DEAD ((ipc_object_t)~0)
	85	#define IPC_OBJECT_VALID(io) (((io) != IPC_OBJECT_NULL) && \
	86	((io) != IPC_OBJECT_DEAD))
	87
91447636	88	#endif /* _IPC_IPC_TYPES_H_ */