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

/*
 * Copyright (c) 2000-2004 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@
 */
/* 
 * 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.
 */
/*
 */
/*
 *	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 {
	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;
	mach_msg_header_t *ikm_header;
};


#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;					\
	ip_release(port);						\
MACRO_END


#define	ikm_init(kmsg, size)						\
MACRO_BEGIN								\
	(kmsg)->ikm_size = (size);					\
	(kmsg)->ikm_prealloc = IP_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

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

/*
 *	extern void
 *	ipc_kmsg_send_always(ipc_kmsg_t);
 *
 *	Unfortunately, to avoid warnings/lint about unused variables
 *	when assertions are turned off, we need two versions of this.
 */
#if	MACH_ASSERT

#define	ipc_kmsg_send_always(kmsg)					\
MACRO_BEGIN								\
	mach_msg_return_t mr2;						\
									\
	mr2 = ipc_kmsg_send((kmsg), MACH_SEND_ALWAYS,			\
			     MACH_MSG_TIMEOUT_NONE);			\
	assert(mr == MACH_MSG_SUCCESS);					\
MACRO_END

#else	/* MACH_ASSERT */

#define	ipc_kmsg_send_always(kmsg)					\
MACRO_BEGIN								\
	(void) ipc_kmsg_send((kmsg), MACH_SEND_ALWAYS,			\
			       MACH_MSG_TIMEOUT_NONE);			\
MACRO_END

#endif	/* MACH_ASSERT */


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

/* destroy kernel message and a reference on the dest */
extern void ipc_kmsg_destroy_dest(
	ipc_kmsg_t	kmsg);


/* Preallocate a kernel message buffer */
extern void ipc_kmsg_set_prealloc(
	ipc_kmsg_t	kmsg,
	ipc_port_t	port);

/* Clear a kernel message buffer */
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_port_name_t	notify);

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

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

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

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

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

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