[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_labelh;

struct ipc_kmsg {
	struct ipc_kmsg *ikm_next;
	struct ipc_kmsg *ikm_prev;
	ipc_port_t ikm_prealloc;	/* port we were preallocated from */
	mach_msg_size_t ikm_size;
	struct ipc_labelh *ikm_sender;
	mach_msg_header_t *ikm_header;
};

#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_sender = 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(
	mach_msg_header_t	*msg,
	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(
	mach_msg_header_t	*msg,
	ipc_space_t		space);

/* 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);

/* 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

/* get a scatter list and check consistency */
extern mach_msg_body_t *ipc_kmsg_get_scatter(
        mach_vm_address_t       msg_addr,
        mach_msg_size_t         slist_size,
        ipc_kmsg_t              kmsg);

/* free a scatter list */
extern void ipc_kmsg_free_scatter(
        mach_msg_body_t 	*slist,
        mach_msg_size_t		slist_size);


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
2d21ac55	96	struct ipc_labelh;
1c79356b	97
91447636	98	struct ipc_kmsg {
1c79356b A	99	struct ipc_kmsg *ikm_next;
	100	struct ipc_kmsg *ikm_prev;
	101	ipc_port_t ikm_prealloc; /* port we were preallocated from */
	102	mach_msg_size_t ikm_size;
2d21ac55	103	struct ipc_labelh *ikm_sender;
91447636 A	104	mach_msg_header_t *ikm_header;
91447636 A	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; \
2d21ac55	153	(kmsg)->ikm_sender = NULL; \
1c79356b A	154	assert((kmsg)->ikm_prev = (kmsg)->ikm_next = IKM_BOGUS); \
	155	MACRO_END
	156
	157	#define ikm_check_init(kmsg, size) \
	158	MACRO_BEGIN \
	159	assert((kmsg)->ikm_size == (size)); \
	160	assert((kmsg)->ikm_prev == IKM_BOGUS); \
	161	assert((kmsg)->ikm_next == IKM_BOGUS); \
	162	MACRO_END
	163
b7266188 A	164	#define ikm_set_header(kmsg, mtsize) \
	165	MACRO_BEGIN \
	166	(kmsg)->ikm_header = (mach_msg_header_t *) \
	167	((vm_offset_t)((kmsg) + 1) + (kmsg)->ikm_size - (mtsize)); \
	168	MACRO_END
	169
1c79356b A	170	struct ipc_kmsg_queue {
	171	struct ipc_kmsg *ikmq_base;
	172	};
	173
	174	typedef struct ipc_kmsg_queue *ipc_kmsg_queue_t;
	175
	176	#define IKMQ_NULL ((ipc_kmsg_queue_t) 0)
	177
	178
	179	/*
	180	* Exported interfaces
	181	*/
	182
	183	#define ipc_kmsg_queue_init(queue) \
	184	MACRO_BEGIN \
	185	(queue)->ikmq_base = IKM_NULL; \
	186	MACRO_END
	187
	188	#define ipc_kmsg_queue_empty(queue) ((queue)->ikmq_base == IKM_NULL)
	189
	190	/* Enqueue a kmsg */
	191	extern void ipc_kmsg_enqueue(
	192	ipc_kmsg_queue_t queue,
	193	ipc_kmsg_t kmsg);
	194
	195	/* Dequeue and return a kmsg */
	196	extern ipc_kmsg_t ipc_kmsg_dequeue(
	197	ipc_kmsg_queue_t queue);
	198
	199	/* Pull a kmsg out of a queue */
	200	extern void ipc_kmsg_rmqueue(
	201	ipc_kmsg_queue_t queue,
	202	ipc_kmsg_t kmsg);
	203
	204	#define ipc_kmsg_queue_first(queue) ((queue)->ikmq_base)
	205
	206	/* Return the kmsg following the given kmsg */
	207	extern ipc_kmsg_t ipc_kmsg_queue_next(
	208	ipc_kmsg_queue_t queue,
	209	ipc_kmsg_t kmsg);
	210
	211	#define ipc_kmsg_rmqueue_first_macro(queue, kmsg) \
	212	MACRO_BEGIN \
	213	register ipc_kmsg_t _next; \
	214	\
	215	assert((queue)->ikmq_base == (kmsg)); \
	216	\
	217	_next = (kmsg)->ikm_next; \
	218	if (_next == (kmsg)) { \
	219	assert((kmsg)->ikm_prev == (kmsg)); \
	220	(queue)->ikmq_base = IKM_NULL; \
	221	} else { \
	222	register ipc_kmsg_t _prev = (kmsg)->ikm_prev; \
	223	\
	224	(queue)->ikmq_base = _next; \
	225	_next->ikm_prev = _prev; \
	226	_prev->ikm_next = _next; \
	227	} \
	228	/* XXX Debug paranoia ASSIGNMENTS */ \
	229	assert(kmsg->ikm_next = IKM_BOGUS); \
	230	assert(kmsg->ikm_prev = IKM_BOGUS); \
	231	MACRO_END
	232
	233	#define ipc_kmsg_enqueue_macro(queue, kmsg) \
234	MACRO_BEGIN \
235	register ipc_kmsg_t _first = (queue)->ikmq_base; \
236	\
237	if (_first == IKM_NULL) { \
238	(queue)->ikmq_base = (kmsg); \
239	(kmsg)->ikm_next = (kmsg); \
240	(kmsg)->ikm_prev = (kmsg); \
241	} else { \
242	register ipc_kmsg_t _last = _first->ikm_prev; \
243	\
244	(kmsg)->ikm_next = _first; \
245	(kmsg)->ikm_prev = _last; \
246	_first->ikm_prev = (kmsg); \
247	_last->ikm_next = (kmsg); \
248	} \
249	MACRO_END
250
1c79356b A	251	/* Allocate a kernel message */
	252	extern ipc_kmsg_t ipc_kmsg_alloc(
	253	mach_msg_size_t size);
	254
	255	/* Free a kernel message buffer */
	256	extern void ipc_kmsg_free(
	257	ipc_kmsg_t kmsg);
	258
	259	/* Destroy kernel message */
	260	extern void ipc_kmsg_destroy(
	261	ipc_kmsg_t kmsg);
	262
6d2010ae A	263	/* Enqueue kernel message for deferred destruction */
	264	extern boolean_t ipc_kmsg_delayed_destroy(
	265	ipc_kmsg_t kmsg);
	266
	267	/* Process all the delayed message destroys */
	268	extern void ipc_kmsg_reap_delayed(void);
91447636	269
1c79356b	270	/* Preallocate a kernel message buffer */
b7266188 A	271	extern ipc_kmsg_t ipc_kmsg_prealloc(
	272	mach_msg_size_t size);
	273
	274	/* bind a preallocated message buffer to a port */
1c79356b A	275	extern void ipc_kmsg_set_prealloc(
	276	ipc_kmsg_t kmsg,
	277	ipc_port_t port);
	278
b7266188	279	/* Clear preallocated message buffer binding */
1c79356b A	280	extern void ipc_kmsg_clear_prealloc(
	281	ipc_kmsg_t kmsg,
	282	ipc_port_t port);
	283
	284	/* Allocate a kernel message buffer and copy a user message to the buffer */
	285	extern mach_msg_return_t ipc_kmsg_get(
91447636	286	mach_vm_address_t msg_addr,
1c79356b A	287	mach_msg_size_t size,
	288	ipc_kmsg_t *kmsgp);
	289
	290	/* Allocate a kernel message buffer and copy a kernel message to the buffer */
	291	extern mach_msg_return_t ipc_kmsg_get_from_kernel(
	292	mach_msg_header_t *msg,
	293	mach_msg_size_t size,
	294	ipc_kmsg_t *kmsgp);
	295
	296	/* Send a message to a port */
	297	extern mach_msg_return_t ipc_kmsg_send(
	298	ipc_kmsg_t kmsg,
	299	mach_msg_option_t option,
91447636	300	mach_msg_timeout_t timeout_val);
1c79356b A	301
	302	/* Copy a kernel message buffer to a user message */
	303	extern mach_msg_return_t ipc_kmsg_put(
91447636	304	mach_vm_address_t msg_addr,
1c79356b A	305	ipc_kmsg_t kmsg,
	306	mach_msg_size_t size);
	307
	308	/* Copy a kernel message buffer to a kernel message */
	309	extern void ipc_kmsg_put_to_kernel(
	310	mach_msg_header_t *msg,
	311	ipc_kmsg_t kmsg,
	312	mach_msg_size_t size);
	313
	314	/* Copyin port rights in the header of a message */
	315	extern mach_msg_return_t ipc_kmsg_copyin_header(
	316	mach_msg_header_t *msg,
	317	ipc_space_t space,
39236c6e	318	mach_msg_option_t *optionp);
1c79356b A	319
	320	/* Copyin port rights and out-of-line memory from a user message */
	321	extern mach_msg_return_t ipc_kmsg_copyin(
	322	ipc_kmsg_t kmsg,
	323	ipc_space_t space,
	324	vm_map_t map,
39236c6e	325	mach_msg_option_t *optionp);
1c79356b A	326
1c79356b A	327	/* Copyin port rights and out-of-line memory from a kernel message */
6d2010ae	328	extern mach_msg_return_t ipc_kmsg_copyin_from_kernel(
1c79356b A	329	ipc_kmsg_t kmsg);
1c79356b A	330
b0d623f7	331	#if IKM_SUPPORT_LEGACY
6d2010ae	332	extern mach_msg_return_t ipc_kmsg_copyin_from_kernel_legacy(
b0d623f7 A	333	ipc_kmsg_t kmsg);
	334	#endif
	335
1c79356b A	336	/* Copyout port rights in the header of a message */
	337	extern mach_msg_return_t ipc_kmsg_copyout_header(
	338	mach_msg_header_t *msg,
6d2010ae	339	ipc_space_t space);
1c79356b A	340
	341	/* Copyout a port right returning a name */
	342	extern mach_msg_return_t ipc_kmsg_copyout_object(
	343	ipc_space_t space,
	344	ipc_object_t object,
	345	mach_msg_type_name_t msgt_name,
	346	mach_port_name_t *namep);
	347
	348	/* Copyout the header and body to a user message */
	349	extern mach_msg_return_t ipc_kmsg_copyout(
	350	ipc_kmsg_t kmsg,
	351	ipc_space_t space,
	352	vm_map_t map,
1c79356b A	353	mach_msg_body_t *slist);
	354
	355	/* Copyout port rights and out-of-line memory from the body of a message */
	356	extern mach_msg_return_t ipc_kmsg_copyout_body(
	357	ipc_kmsg_t kmsg,
	358	ipc_space_t space,
	359	vm_map_t map,
	360	mach_msg_body_t *slist);
	361
	362	/* Copyout port rights and out-of-line memory to a user message,
	363	not reversing the ports in the header */
	364	extern mach_msg_return_t ipc_kmsg_copyout_pseudo(
	365	ipc_kmsg_t kmsg,
	366	ipc_space_t space,
	367	vm_map_t map,
	368	mach_msg_body_t *slist);
	369
91447636 A	370	/* Compute size of message as copied out to the specified space/map */
	371	extern mach_msg_size_t ipc_kmsg_copyout_size(
	372	ipc_kmsg_t kmsg,
	373	vm_map_t map);
	374
1c79356b A	375	/* Copyout the destination port in the message */
	376	extern void ipc_kmsg_copyout_dest(
	377	ipc_kmsg_t kmsg,
	378	ipc_space_t space);
	379
	380	/* kernel's version of ipc_kmsg_copyout_dest */
	381	extern void ipc_kmsg_copyout_to_kernel(
	382	ipc_kmsg_t kmsg,
	383	ipc_space_t space);
	384
b0d623f7 A	385	#if IKM_SUPPORT_LEGACY
	386	extern void ipc_kmsg_copyout_to_kernel_legacy(
	387	ipc_kmsg_t kmsg,
	388	ipc_space_t space);
	389	#endif
	390
91447636 A	391	/* get a scatter list and check consistency */
	392	extern mach_msg_body_t *ipc_kmsg_get_scatter(
	393	mach_vm_address_t msg_addr,
1c79356b A	394	mach_msg_size_t slist_size,
	395	ipc_kmsg_t kmsg);
	396
	397	/* free a scatter list */
	398	extern void ipc_kmsg_free_scatter(
	399	mach_msg_body_t *slist,
	400	mach_msg_size_t slist_size);
	401
316670eb A	402
	403	extern mach_msg_trailer_size_t
	404	ipc_kmsg_add_trailer(ipc_kmsg_t kmsg, ipc_space_t space,
	405	mach_msg_option_t option, thread_t thread,
	406	mach_port_seqno_t seqno, boolean_t minimal_trailer,
	407	mach_vm_offset_t context);
	408
1c79356b	409	#endif /* _IPC_IPC_KMSG_H_ */
2d21ac55	410