[apple/xnu.git] / osfmk / ipc / ipc_kmsg.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@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989 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.
 */
/*
 * NOTICE: This file was modified by McAfee Research in 2004 to introduce
 * support for mandatory and extensible security protections.  This notice
 * is included in support of clause 2.2 (b) of the Apple Public License,
 * Version 2.0.
 * Copyright (c) 2005 SPARTA, Inc.
 */
/*
 */
/*
 *	File:	ipc/ipc_kmsg.h
 *	Author:	Rich Draves
 *	Date:	1989
 *
 *	Definitions for kernel messages.
 */

#ifndef	_IPC_IPC_KMSG_H_
#define _IPC_IPC_KMSG_H_

#include <mach/vm_types.h>
#include <mach/message.h>
#include <kern/kern_types.h>
#include <kern/assert.h>
#include <kern/macro_help.h>
#include <ipc/ipc_types.h>
#include <ipc/ipc_object.h>

/*
 *	This structure is only the header for a kmsg buffer;
 *	the actual buffer is normally larger.  The rest of the buffer
 *	holds the body of the message.
 *
 *	In a kmsg, the port fields hold pointers to ports instead
 *	of port names.  These pointers hold references.
 *
 *	The ikm_header.msgh_remote_port field is the destination
 *	of the message.
 */

struct ipc_kmsg {
	mach_msg_size_t			 	ikm_size;
	struct ipc_kmsg				*ikm_next;	/* next message on port/discard queue */
	struct ipc_kmsg 			*ikm_prev;	/* prev message on port/discard queue */
	mach_msg_header_t 			*ikm_header;
	ipc_port_t				ikm_prealloc;	/* port we were preallocated from */
	ipc_port_t				ikm_voucher;	/* voucher port carried */
	struct ipc_importance_elem		*ikm_importance;/* inherited from */
	queue_chain_t				ikm_inheritance;/* inherited from link */
};

#if defined(__i386__) || defined(__arm__)
#define	IKM_SUPPORT_LEGACY	1
#else
#define	IKM_SUPPORT_LEGACY	0
#endif

#define	IKM_OVERHEAD		(sizeof(struct ipc_kmsg))

#define	ikm_plus_overhead(size)	((mach_msg_size_t)((size) + IKM_OVERHEAD))
#define	ikm_less_overhead(size)	((mach_msg_size_t)((size) - IKM_OVERHEAD))

/*
 * XXX	For debugging.
 */
#define IKM_BOGUS		((ipc_kmsg_t) 0xffffff10)

/*
 *	The size of the kernel message buffers that will be cached.
 *	IKM_SAVED_KMSG_SIZE includes overhead; IKM_SAVED_MSG_SIZE doesn't.
 */
extern zone_t ipc_kmsg_zone;
#define	IKM_SAVED_KMSG_SIZE	256
#define	IKM_SAVED_MSG_SIZE	ikm_less_overhead(IKM_SAVED_KMSG_SIZE)

#define	ikm_prealloc_inuse_port(kmsg)					\
	((kmsg)->ikm_prealloc)

#define	ikm_prealloc_inuse(kmsg)					\
	((kmsg)->ikm_prealloc != IP_NULL)

#define	ikm_prealloc_set_inuse(kmsg, port)				\
MACRO_BEGIN								\
	assert((port) != IP_NULL);					\
	(kmsg)->ikm_prealloc = (port);					\
	ip_reference(port);						\
MACRO_END

#define ikm_prealloc_clear_inuse(kmsg, port)				\
MACRO_BEGIN								\
	(kmsg)->ikm_prealloc = IP_NULL;					\
MACRO_END

#define	ikm_init(kmsg, size)						\
MACRO_BEGIN								\
	(kmsg)->ikm_size = (size);					\
	(kmsg)->ikm_prealloc = IP_NULL;					\
        (kmsg)->ikm_voucher = IP_NULL;					\
	(kmsg)->ikm_importance = IIE_NULL;				\
	assert((kmsg)->ikm_prev = (kmsg)->ikm_next = IKM_BOGUS);	\
MACRO_END

#define	ikm_check_init(kmsg, size)					\
MACRO_BEGIN								\
	assert((kmsg)->ikm_size == (size));				\
	assert((kmsg)->ikm_prev == IKM_BOGUS);				\
	assert((kmsg)->ikm_next == IKM_BOGUS);				\
MACRO_END

#define ikm_set_header(kmsg, mtsize)					\
MACRO_BEGIN								\
	(kmsg)->ikm_header = (mach_msg_header_t *) 			\
	((vm_offset_t)((kmsg) + 1) + (kmsg)->ikm_size - (mtsize));	\
MACRO_END

struct ipc_kmsg_queue {
	struct ipc_kmsg *ikmq_base;
};

typedef struct ipc_kmsg_queue *ipc_kmsg_queue_t;

#define	IKMQ_NULL		((ipc_kmsg_queue_t) 0)


/*
 * Exported interfaces
 */

#define	ipc_kmsg_queue_init(queue)		\
MACRO_BEGIN					\
	(queue)->ikmq_base = IKM_NULL;		\
MACRO_END

#define	ipc_kmsg_queue_empty(queue)	((queue)->ikmq_base == IKM_NULL)

/* Enqueue a kmsg */
extern void ipc_kmsg_enqueue(
	ipc_kmsg_queue_t	queue,
	ipc_kmsg_t		kmsg);

/* Dequeue and return a kmsg */
extern ipc_kmsg_t ipc_kmsg_dequeue(
	ipc_kmsg_queue_t        queue);

/* Pull a kmsg out of a queue */
extern void ipc_kmsg_rmqueue(
	ipc_kmsg_queue_t	queue,
	ipc_kmsg_t		kmsg);

#define	ipc_kmsg_queue_first(queue)		((queue)->ikmq_base)

/* Return the kmsg following the given kmsg */
extern ipc_kmsg_t ipc_kmsg_queue_next(
	ipc_kmsg_queue_t	queue,
	ipc_kmsg_t		kmsg);

#define	ipc_kmsg_rmqueue_first_macro(queue, kmsg)			\
MACRO_BEGIN								\
	register ipc_kmsg_t _next;					\
									\
	assert((queue)->ikmq_base == (kmsg));				\
									\
	_next = (kmsg)->ikm_next;					\
	if (_next == (kmsg)) {						\
		assert((kmsg)->ikm_prev == (kmsg));			\
		(queue)->ikmq_base = IKM_NULL;				\
	} else {							\
		register ipc_kmsg_t _prev = (kmsg)->ikm_prev;		\
									\
		(queue)->ikmq_base = _next;				\
		_next->ikm_prev = _prev;				\
		_prev->ikm_next = _next;				\
	}								\
  	/* XXX Debug paranoia ASSIGNMENTS */				\
  	assert(kmsg->ikm_next = IKM_BOGUS);				\
  	assert(kmsg->ikm_prev = IKM_BOGUS);				\
MACRO_END

#define	ipc_kmsg_enqueue_macro(queue, kmsg)				\
MACRO_BEGIN								\
	register ipc_kmsg_t _first = (queue)->ikmq_base;		\
									\
	if (_first == IKM_NULL) {					\
		(queue)->ikmq_base = (kmsg);				\
		(kmsg)->ikm_next = (kmsg);				\
		(kmsg)->ikm_prev = (kmsg);				\
	} else {							\
		register ipc_kmsg_t _last = _first->ikm_prev;		\
									\
		(kmsg)->ikm_next = _first;				\
		(kmsg)->ikm_prev = _last;				\
		_first->ikm_prev = (kmsg);				\
		_last->ikm_next = (kmsg);				\
	}								\
MACRO_END

/* Allocate a kernel message */
extern ipc_kmsg_t ipc_kmsg_alloc(
        mach_msg_size_t size);

/* Free a kernel message buffer */
extern void ipc_kmsg_free(
	ipc_kmsg_t	kmsg);

/* Destroy kernel message */
extern void ipc_kmsg_destroy(
	ipc_kmsg_t	kmsg);

/* Enqueue kernel message for deferred destruction */
extern boolean_t ipc_kmsg_delayed_destroy(
	ipc_kmsg_t kmsg);

/* Process all the delayed message destroys */
extern void ipc_kmsg_reap_delayed(void);

/* Preallocate a kernel message buffer */
extern ipc_kmsg_t ipc_kmsg_prealloc(
	mach_msg_size_t	size);

/* bind a preallocated message buffer to a port */
extern void ipc_kmsg_set_prealloc(
	ipc_kmsg_t	kmsg,
	ipc_port_t	port);

/* Clear preallocated message buffer binding */
extern void ipc_kmsg_clear_prealloc(
	ipc_kmsg_t	kmsg,
	ipc_port_t	port);

/* Allocate a kernel message buffer and copy a user message to the buffer */
extern mach_msg_return_t ipc_kmsg_get(
	mach_vm_address_t	msg_addr, 
	mach_msg_size_t		size,
	ipc_kmsg_t		*kmsgp);

/* Allocate a kernel message buffer and copy a kernel message to the buffer */
extern mach_msg_return_t ipc_kmsg_get_from_kernel(
	mach_msg_header_t	*msg,
	mach_msg_size_t		size,
	ipc_kmsg_t		*kmsgp);

/* Send a message to a port */
extern mach_msg_return_t ipc_kmsg_send(
	ipc_kmsg_t		kmsg,
	mach_msg_option_t	option,
	mach_msg_timeout_t	timeout_val);

/* Copy a kernel message buffer to a user message */
extern mach_msg_return_t ipc_kmsg_put(
	mach_vm_address_t	msg_addr,
	ipc_kmsg_t		kmsg,
	mach_msg_size_t		size);

/* Copy a kernel message buffer to a kernel message */
extern void ipc_kmsg_put_to_kernel(
	mach_msg_header_t	*msg,
	ipc_kmsg_t		kmsg,
	mach_msg_size_t		size);

/* Copyin port rights in the header of a message */
extern mach_msg_return_t ipc_kmsg_copyin_header(
	ipc_kmsg_t              kmsg,
	ipc_space_t		space,
	mach_msg_option_t	*optionp);

/* Copyin port rights and out-of-line memory from a user message */
extern mach_msg_return_t ipc_kmsg_copyin(
	ipc_kmsg_t		kmsg,
	ipc_space_t		space,
	vm_map_t		map,
	mach_msg_option_t	*optionp);

/* Copyin port rights and out-of-line memory from a kernel message */
extern mach_msg_return_t ipc_kmsg_copyin_from_kernel(
	ipc_kmsg_t		kmsg);

#if IKM_SUPPORT_LEGACY
extern mach_msg_return_t ipc_kmsg_copyin_from_kernel_legacy(
	ipc_kmsg_t	kmsg);
#endif

/* Copyout port rights in the header of a message */
extern mach_msg_return_t ipc_kmsg_copyout_header(
	ipc_kmsg_t              kmsg,
	ipc_space_t		space,
	mach_msg_option_t	option);

/* Copyout a port right returning a name */
extern mach_msg_return_t ipc_kmsg_copyout_object(
	ipc_space_t		space,
	ipc_object_t		object,
	mach_msg_type_name_t	msgt_name,
	mach_port_name_t	*namep);

/* Copyout the header and body to a user message */
extern mach_msg_return_t ipc_kmsg_copyout(
	ipc_kmsg_t		kmsg,
	ipc_space_t		space,
	vm_map_t		map,
	mach_msg_body_t		*slist,
	mach_msg_option_t	option);

/* Copyout port rights and out-of-line memory from the body of a message */
extern mach_msg_return_t ipc_kmsg_copyout_body(
    	ipc_kmsg_t		kmsg,
	ipc_space_t		space,
	vm_map_t		map,
	mach_msg_body_t		*slist);

/* Copyout port rights and out-of-line memory to a user message,
   not reversing the ports in the header */
extern mach_msg_return_t ipc_kmsg_copyout_pseudo(
	ipc_kmsg_t		kmsg,
	ipc_space_t		space,
	vm_map_t		map,
	mach_msg_body_t		*slist);

/* Compute size of message as copied out to the specified space/map */
extern mach_msg_size_t ipc_kmsg_copyout_size(
	ipc_kmsg_t		kmsg,
	vm_map_t		map);

/* Copyout the destination port in the message */
extern void ipc_kmsg_copyout_dest( 
	ipc_kmsg_t		kmsg,
	ipc_space_t		space);

/* kernel's version of ipc_kmsg_copyout_dest */
extern void ipc_kmsg_copyout_to_kernel(
	ipc_kmsg_t		kmsg,
	ipc_space_t		space);

#if IKM_SUPPORT_LEGACY
extern void ipc_kmsg_copyout_to_kernel_legacy(
	ipc_kmsg_t		kmsg,
	ipc_space_t		space);
#endif

extern mach_msg_trailer_size_t
ipc_kmsg_add_trailer(ipc_kmsg_t kmsg, ipc_space_t space, 
		mach_msg_option_t option, thread_t thread, 
		mach_port_seqno_t seqno, boolean_t minimal_trailer,
		mach_vm_offset_t context);

#endif	/* _IPC_IPC_KMSG_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	/*
	32	* Mach Operating System
	33	* Copyright (c) 1991,1990,1989 Carnegie Mellon University
	34	* All Rights Reserved.
	35	*
	36	* Permission to use, copy, modify and distribute this software and its
	37	* documentation is hereby granted, provided that both the copyright
	38	* notice and this permission notice appear in all copies of the
	39	* software, derivative works or modified versions, and any portions
	40	* thereof, and that both notices appear in supporting documentation.
	41	*
	42	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	43	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	44	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	45	*
	46	* Carnegie Mellon requests users of this software to return to
	47	*
	48	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	49	* School of Computer Science
	50	* Carnegie Mellon University
	51	* Pittsburgh PA 15213-3890
	52	*
	53	* any improvements or extensions that they make and grant Carnegie Mellon
	54	* the rights to redistribute these changes.
	55	*/
2d21ac55 A	56	/*
	57	* NOTICE: This file was modified by McAfee Research in 2004 to introduce
	58	* support for mandatory and extensible security protections. This notice
	59	* is included in support of clause 2.2 (b) of the Apple Public License,
	60	* Version 2.0.
	61	* Copyright (c) 2005 SPARTA, Inc.
	62	*/
1c79356b A	63	/*
	64	*/
	65	/*
	66	* File: ipc/ipc_kmsg.h
	67	* Author: Rich Draves
	68	* Date: 1989
	69	*
	70	* Definitions for kernel messages.
	71	*/
	72
	73	#ifndef _IPC_IPC_KMSG_H_
	74	#define _IPC_IPC_KMSG_H_
	75
1c79356b A	76	#include <mach/vm_types.h>
1c79356b A	77	#include <mach/message.h>
91447636	78	#include <kern/kern_types.h>
1c79356b	79	#include <kern/assert.h>
1c79356b	80	#include <kern/macro_help.h>
91447636	81	#include <ipc/ipc_types.h>
1c79356b A	82	#include <ipc/ipc_object.h>
	83
	84	/*
	85	* This structure is only the header for a kmsg buffer;
	86	* the actual buffer is normally larger. The rest of the buffer
	87	* holds the body of the message.
	88	*
	89	* In a kmsg, the port fields hold pointers to ports instead
	90	* of port names. These pointers hold references.
	91	*
	92	* The ikm_header.msgh_remote_port field is the destination
	93	* of the message.
	94	*/
	95
91447636	96	struct ipc_kmsg {
fe8ab488 A	97	mach_msg_size_t ikm_size;
	98	struct ipc_kmsg ikm_next; / next message on port/discard queue */
	99	struct ipc_kmsg ikm_prev; / prev message on port/discard queue */
	100	mach_msg_header_t *ikm_header;
	101	ipc_port_t ikm_prealloc; /* port we were preallocated from */
	102	ipc_port_t ikm_voucher; /* voucher port carried */
	103	struct ipc_importance_elem ikm_importance;/ inherited from */
	104	queue_chain_t ikm_inheritance;/* inherited from link */
91447636	105	};
1c79356b	106
b0d623f7 A	107	#if defined(__i386__) \|\| defined(__arm__)
	108	#define IKM_SUPPORT_LEGACY 1
	109	#else
	110	#define IKM_SUPPORT_LEGACY 0
	111	#endif
1c79356b	112
91447636	113	#define IKM_OVERHEAD (sizeof(struct ipc_kmsg))
1c79356b A	114
	115	#define ikm_plus_overhead(size) ((mach_msg_size_t)((size) + IKM_OVERHEAD))
	116	#define ikm_less_overhead(size) ((mach_msg_size_t)((size) - IKM_OVERHEAD))
	117
	118	/*
	119	* XXX For debugging.
	120	*/
	121	#define IKM_BOGUS ((ipc_kmsg_t) 0xffffff10)
	122
	123	/*
	124	* The size of the kernel message buffers that will be cached.
	125	* IKM_SAVED_KMSG_SIZE includes overhead; IKM_SAVED_MSG_SIZE doesn't.
	126	*/
91447636 A	127	extern zone_t ipc_kmsg_zone;
	128	#define IKM_SAVED_KMSG_SIZE 256
	129	#define IKM_SAVED_MSG_SIZE ikm_less_overhead(IKM_SAVED_KMSG_SIZE)
1c79356b A	130
	131	#define ikm_prealloc_inuse_port(kmsg) \
	132	((kmsg)->ikm_prealloc)
	133
	134	#define ikm_prealloc_inuse(kmsg) \
	135	((kmsg)->ikm_prealloc != IP_NULL)
	136
	137	#define ikm_prealloc_set_inuse(kmsg, port) \
	138	MACRO_BEGIN \
9bccf70c A	139	assert((port) != IP_NULL); \
	140	(kmsg)->ikm_prealloc = (port); \
	141	ip_reference(port); \
1c79356b A	142	MACRO_END
	143
	144	#define ikm_prealloc_clear_inuse(kmsg, port) \
	145	MACRO_BEGIN \
	146	(kmsg)->ikm_prealloc = IP_NULL; \
	147	MACRO_END
	148
1c79356b A	149	#define ikm_init(kmsg, size) \
	150	MACRO_BEGIN \
	151	(kmsg)->ikm_size = (size); \
	152	(kmsg)->ikm_prealloc = IP_NULL; \
fe8ab488 A	153	(kmsg)->ikm_voucher = IP_NULL; \
fe8ab488 A	154	(kmsg)->ikm_importance = IIE_NULL; \
1c79356b A	155	assert((kmsg)->ikm_prev = (kmsg)->ikm_next = IKM_BOGUS); \
	156	MACRO_END
	157
	158	#define ikm_check_init(kmsg, size) \
	159	MACRO_BEGIN \
	160	assert((kmsg)->ikm_size == (size)); \
	161	assert((kmsg)->ikm_prev == IKM_BOGUS); \
	162	assert((kmsg)->ikm_next == IKM_BOGUS); \
	163	MACRO_END
	164
b7266188 A	165	#define ikm_set_header(kmsg, mtsize) \
	166	MACRO_BEGIN \
	167	(kmsg)->ikm_header = (mach_msg_header_t *) \
	168	((vm_offset_t)((kmsg) + 1) + (kmsg)->ikm_size - (mtsize)); \
	169	MACRO_END
	170
1c79356b A	171	struct ipc_kmsg_queue {
	172	struct ipc_kmsg *ikmq_base;
	173	};
	174
	175	typedef struct ipc_kmsg_queue *ipc_kmsg_queue_t;
	176
	177	#define IKMQ_NULL ((ipc_kmsg_queue_t) 0)
	178
	179
	180	/*
	181	* Exported interfaces
	182	*/
	183
	184	#define ipc_kmsg_queue_init(queue) \
	185	MACRO_BEGIN \
	186	(queue)->ikmq_base = IKM_NULL; \
	187	MACRO_END
	188
	189	#define ipc_kmsg_queue_empty(queue) ((queue)->ikmq_base == IKM_NULL)
	190
	191	/* Enqueue a kmsg */
	192	extern void ipc_kmsg_enqueue(
	193	ipc_kmsg_queue_t queue,
	194	ipc_kmsg_t kmsg);
	195
	196	/* Dequeue and return a kmsg */
	197	extern ipc_kmsg_t ipc_kmsg_dequeue(
	198	ipc_kmsg_queue_t queue);
	199
	200	/* Pull a kmsg out of a queue */
	201	extern void ipc_kmsg_rmqueue(
	202	ipc_kmsg_queue_t queue,
	203	ipc_kmsg_t kmsg);
	204
	205	#define ipc_kmsg_queue_first(queue) ((queue)->ikmq_base)
	206
	207	/* Return the kmsg following the given kmsg */
	208	extern ipc_kmsg_t ipc_kmsg_queue_next(
	209	ipc_kmsg_queue_t queue,
	210	ipc_kmsg_t kmsg);
	211
	212	#define ipc_kmsg_rmqueue_first_macro(queue, kmsg) \
	213	MACRO_BEGIN \
	214	register ipc_kmsg_t _next; \
	215	\
	216	assert((queue)->ikmq_base == (kmsg)); \
	217	\
	218	_next = (kmsg)->ikm_next; \
	219	if (_next == (kmsg)) { \
	220	assert((kmsg)->ikm_prev == (kmsg)); \
	221	(queue)->ikmq_base = IKM_NULL; \
	222	} else { \
	223	register ipc_kmsg_t _prev = (kmsg)->ikm_prev; \
	224	\
	225	(queue)->ikmq_base = _next; \
	226	_next->ikm_prev = _prev; \
	227	_prev->ikm_next = _next; \
	228	} \
	229	/* XXX Debug paranoia ASSIGNMENTS */ \
	230	assert(kmsg->ikm_next = IKM_BOGUS); \
	231	assert(kmsg->ikm_prev = IKM_BOGUS); \
	232	MACRO_END
	233
	234	#define ipc_kmsg_enqueue_macro(queue, kmsg) \
235	MACRO_BEGIN \
236	register ipc_kmsg_t _first = (queue)->ikmq_base; \
237	\
238	if (_first == IKM_NULL) { \
239	(queue)->ikmq_base = (kmsg); \
240	(kmsg)->ikm_next = (kmsg); \
241	(kmsg)->ikm_prev = (kmsg); \
242	} else { \
243	register ipc_kmsg_t _last = _first->ikm_prev; \
244	\
245	(kmsg)->ikm_next = _first; \
246	(kmsg)->ikm_prev = _last; \
247	_first->ikm_prev = (kmsg); \
248	_last->ikm_next = (kmsg); \
249	} \
250	MACRO_END
251
1c79356b A	252	/* Allocate a kernel message */
	253	extern ipc_kmsg_t ipc_kmsg_alloc(
	254	mach_msg_size_t size);
	255
	256	/* Free a kernel message buffer */
	257	extern void ipc_kmsg_free(
	258	ipc_kmsg_t kmsg);
	259
	260	/* Destroy kernel message */
	261	extern void ipc_kmsg_destroy(
	262	ipc_kmsg_t kmsg);
	263
6d2010ae A	264	/* Enqueue kernel message for deferred destruction */
	265	extern boolean_t ipc_kmsg_delayed_destroy(
	266	ipc_kmsg_t kmsg);
	267
	268	/* Process all the delayed message destroys */
	269	extern void ipc_kmsg_reap_delayed(void);
91447636	270
1c79356b	271	/* Preallocate a kernel message buffer */
b7266188 A	272	extern ipc_kmsg_t ipc_kmsg_prealloc(
	273	mach_msg_size_t size);
	274
	275	/* bind a preallocated message buffer to a port */
1c79356b A	276	extern void ipc_kmsg_set_prealloc(
	277	ipc_kmsg_t kmsg,
	278	ipc_port_t port);
	279
b7266188	280	/* Clear preallocated message buffer binding */
1c79356b A	281	extern void ipc_kmsg_clear_prealloc(
	282	ipc_kmsg_t kmsg,
	283	ipc_port_t port);
	284
	285	/* Allocate a kernel message buffer and copy a user message to the buffer */
	286	extern mach_msg_return_t ipc_kmsg_get(
91447636	287	mach_vm_address_t msg_addr,
1c79356b A	288	mach_msg_size_t size,
	289	ipc_kmsg_t *kmsgp);
	290
	291	/* Allocate a kernel message buffer and copy a kernel message to the buffer */
	292	extern mach_msg_return_t ipc_kmsg_get_from_kernel(
	293	mach_msg_header_t *msg,
	294	mach_msg_size_t size,
	295	ipc_kmsg_t *kmsgp);
	296
	297	/* Send a message to a port */
	298	extern mach_msg_return_t ipc_kmsg_send(
	299	ipc_kmsg_t kmsg,
	300	mach_msg_option_t option,
91447636	301	mach_msg_timeout_t timeout_val);
1c79356b A	302
	303	/* Copy a kernel message buffer to a user message */
	304	extern mach_msg_return_t ipc_kmsg_put(
91447636	305	mach_vm_address_t msg_addr,
1c79356b A	306	ipc_kmsg_t kmsg,
	307	mach_msg_size_t size);
	308
	309	/* Copy a kernel message buffer to a kernel message */
	310	extern void ipc_kmsg_put_to_kernel(
	311	mach_msg_header_t *msg,
	312	ipc_kmsg_t kmsg,
	313	mach_msg_size_t size);
	314
	315	/* Copyin port rights in the header of a message */
	316	extern mach_msg_return_t ipc_kmsg_copyin_header(
fe8ab488	317	ipc_kmsg_t kmsg,
1c79356b	318	ipc_space_t space,
39236c6e	319	mach_msg_option_t *optionp);
1c79356b A	320
	321	/* Copyin port rights and out-of-line memory from a user message */
	322	extern mach_msg_return_t ipc_kmsg_copyin(
	323	ipc_kmsg_t kmsg,
	324	ipc_space_t space,
	325	vm_map_t map,
39236c6e	326	mach_msg_option_t *optionp);
1c79356b A	327
1c79356b A	328	/* Copyin port rights and out-of-line memory from a kernel message */
6d2010ae	329	extern mach_msg_return_t ipc_kmsg_copyin_from_kernel(
1c79356b A	330	ipc_kmsg_t kmsg);
1c79356b A	331
b0d623f7	332	#if IKM_SUPPORT_LEGACY
6d2010ae	333	extern mach_msg_return_t ipc_kmsg_copyin_from_kernel_legacy(
b0d623f7 A	334	ipc_kmsg_t kmsg);
	335	#endif
	336
1c79356b A	337	/* Copyout port rights in the header of a message */
1c79356b A	338	extern mach_msg_return_t ipc_kmsg_copyout_header(
fe8ab488 A	339	ipc_kmsg_t kmsg,
	340	ipc_space_t space,
	341	mach_msg_option_t option);
1c79356b A	342
	343	/* Copyout a port right returning a name */
	344	extern mach_msg_return_t ipc_kmsg_copyout_object(
	345	ipc_space_t space,
	346	ipc_object_t object,
	347	mach_msg_type_name_t msgt_name,
	348	mach_port_name_t *namep);
	349
	350	/* Copyout the header and body to a user message */
	351	extern mach_msg_return_t ipc_kmsg_copyout(
	352	ipc_kmsg_t kmsg,
	353	ipc_space_t space,
	354	vm_map_t map,
fe8ab488 A	355	mach_msg_body_t *slist,
fe8ab488 A	356	mach_msg_option_t option);
1c79356b A	357
	358	/* Copyout port rights and out-of-line memory from the body of a message */
	359	extern mach_msg_return_t ipc_kmsg_copyout_body(
	360	ipc_kmsg_t kmsg,
	361	ipc_space_t space,
	362	vm_map_t map,
	363	mach_msg_body_t *slist);
	364
	365	/* Copyout port rights and out-of-line memory to a user message,
	366	not reversing the ports in the header */
	367	extern mach_msg_return_t ipc_kmsg_copyout_pseudo(
	368	ipc_kmsg_t kmsg,
	369	ipc_space_t space,
	370	vm_map_t map,
	371	mach_msg_body_t *slist);
	372
91447636 A	373	/* Compute size of message as copied out to the specified space/map */
	374	extern mach_msg_size_t ipc_kmsg_copyout_size(
	375	ipc_kmsg_t kmsg,
	376	vm_map_t map);
	377
1c79356b A	378	/* Copyout the destination port in the message */
	379	extern void ipc_kmsg_copyout_dest(
	380	ipc_kmsg_t kmsg,
	381	ipc_space_t space);
	382
	383	/* kernel's version of ipc_kmsg_copyout_dest */
	384	extern void ipc_kmsg_copyout_to_kernel(
	385	ipc_kmsg_t kmsg,
	386	ipc_space_t space);
	387
b0d623f7 A	388	#if IKM_SUPPORT_LEGACY
	389	extern void ipc_kmsg_copyout_to_kernel_legacy(
	390	ipc_kmsg_t kmsg,
	391	ipc_space_t space);
	392	#endif
	393
316670eb A	394	extern mach_msg_trailer_size_t
	395	ipc_kmsg_add_trailer(ipc_kmsg_t kmsg, ipc_space_t space,
	396	mach_msg_option_t option, thread_t thread,
	397	mach_port_seqno_t seqno, boolean_t minimal_trailer,
	398	mach_vm_offset_t context);
	399
1c79356b	400	#endif /* _IPC_IPC_KMSG_H_ */
2d21ac55	401