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

/*
 * Copyright (c) 2000-2007 Apple 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.
 */
/*
 */
/*
 *	File:	ipc/ipc_mqueue.h
 *	Author:	Rich Draves
 *	Date:	1989
 *
 *	Definitions for message queues.
 */

#ifndef	_IPC_IPC_MQUEUE_H_
#define _IPC_IPC_MQUEUE_H_

#include <mach_assert.h>

#include <mach/message.h>

#include <kern/assert.h>
#include <kern/macro_help.h>
#include <kern/kern_types.h>
#include <kern/spl.h>
#include <kern/waitq.h>

#include <ipc/ipc_kmsg.h>
#include <ipc/ipc_object.h>
#include <ipc/ipc_types.h>

#include <sys/event.h>

typedef struct ipc_mqueue {
	union {
		struct {
			struct  waitq		waitq;
			struct ipc_kmsg_queue	messages;
			mach_port_seqno_t 	seqno;
			mach_port_name_t	receiver_name;
			uint16_t		msgcount;
			uint16_t		qlimit;
		} __attribute__((__packed__)) port;
		struct {
			struct waitq_set	setq;
			mach_port_name_t	local_name;
		} __attribute__((__packed__)) pset;
	} data;
} *ipc_mqueue_t;

#define	IMQ_NULL		((ipc_mqueue_t) 0)

#define imq_wait_queue		data.port.waitq
#define imq_messages		data.port.messages
#define imq_msgcount		data.port.msgcount
#define imq_qlimit		data.port.qlimit
#define imq_seqno		data.port.seqno
#define imq_receiver_name	data.port.receiver_name

/*
 * we can use the 'eventmask' bits of the waitq b/c
 * they are only used by global queues
 */
#define imq_fullwaiters		data.port.waitq.waitq_eventmask
#define imq_in_pset		data.port.waitq.waitq_set_id

#define imq_set_queue		data.pset.setq
#define imq_local_name		data.pset.local_name
#define imq_is_set(mq)		waitqs_is_set(&(mq)->imq_set_queue)

#define	imq_lock(mq)		waitq_lock(&(mq)->imq_wait_queue)
#define	imq_lock_try(mq)	waitq_lock_try(&(mq)->imq_wait_queue)
#define	imq_unlock(mq)		waitq_unlock(&(mq)->imq_wait_queue)
#define imq_held(mq)		waitq_held(&(mq)->imq_wait_queue)

extern void imq_reserve_and_lock(ipc_mqueue_t mq,
				 uint64_t *reserved_prepost, spl_t *spl);

extern void imq_release_and_unlock(ipc_mqueue_t mq,
				   uint64_t reserved_prepost, spl_t spl);

#define imq_full(mq)		((mq)->imq_msgcount >= (mq)->imq_qlimit)
#define imq_full_kernel(mq)	((mq)->imq_msgcount >= MACH_PORT_QLIMIT_KERNEL)

extern int ipc_mqueue_full;
// extern int ipc_mqueue_rcv;

#define IPC_MQUEUE_FULL		CAST_EVENT64_T(&ipc_mqueue_full)
#define IPC_MQUEUE_RECEIVE	NO_EVENT64

/*
 * Exported interfaces
 */

/* Initialize a newly-allocated message queue */
extern void ipc_mqueue_init(
	ipc_mqueue_t		mqueue,
	boolean_t		is_set,
	uint64_t		*reserved_link);

/* de-initialize / cleanup an mqueue (specifically waitq resources) */
extern void ipc_mqueue_deinit(
	ipc_mqueue_t		mqueue);

/* destroy an mqueue */
extern void ipc_mqueue_destroy(
	ipc_mqueue_t		mqueue);

/* Wake up receivers waiting in a message queue */
extern void ipc_mqueue_changed(
	ipc_mqueue_t		mqueue);

/* Add the specific mqueue as a member of the set */
extern kern_return_t ipc_mqueue_add(
	ipc_mqueue_t		mqueue,
	ipc_mqueue_t	 	set_mqueue,
	uint64_t		*reserved_link,
	uint64_t		*reserved_prepost);

/* Check to see if mqueue is member of set_mqueue */
extern boolean_t ipc_mqueue_member(
	ipc_mqueue_t		mqueue,
	ipc_mqueue_t		set_mqueue);

/* Remove an mqueue from a specific set */
extern kern_return_t ipc_mqueue_remove(
	ipc_mqueue_t	 	mqueue,
	ipc_mqueue_t		set_mqueue);

/* Remove an mqueue from all sets */
extern void ipc_mqueue_remove_from_all(
	ipc_mqueue_t		mqueue);

/* Remove all the members of the specifiied set */
extern void ipc_mqueue_remove_all(
	ipc_mqueue_t		mqueue);

/* Send a message to a port */
extern mach_msg_return_t ipc_mqueue_send(
	ipc_mqueue_t		mqueue,
	ipc_kmsg_t		kmsg,
	mach_msg_option_t	option,
	mach_msg_timeout_t	timeout_val,
	spl_t			s);

/* check for queue send queue full of a port */
extern mach_msg_return_t ipc_mqueue_preflight_send(
	ipc_mqueue_t		mqueue,
	ipc_kmsg_t		kmsg,
	mach_msg_option_t	option,
	mach_msg_timeout_t	timeout_val);

/* Deliver message to message queue or waiting receiver */
extern void ipc_mqueue_post(
	ipc_mqueue_t		mqueue,
	ipc_kmsg_t		kmsg);

/* Receive a message from a message queue */
extern void ipc_mqueue_receive(
	ipc_mqueue_t		mqueue,
	mach_msg_option_t	option,
	mach_msg_size_t		max_size,
	mach_msg_timeout_t	timeout_val,
	int                     interruptible);

/* Receive a message from a message queue using a specified thread */
extern wait_result_t ipc_mqueue_receive_on_thread(
        ipc_mqueue_t            mqueue,
	mach_msg_option_t       option,
	mach_msg_size_t         max_size,
	mach_msg_timeout_t      rcv_timeout,
	int                     interruptible,
	thread_t                thread);

/* Continuation routine for message receive */
extern void ipc_mqueue_receive_continue(
	void			*param,
	wait_result_t		wresult);

/* Select a message from a queue and try to post it to ourself */
extern void ipc_mqueue_select_on_thread(
	ipc_mqueue_t		port_mq,
	ipc_mqueue_t		set_mq,
	mach_msg_option_t	option,
	mach_msg_size_t		max_size,
	thread_t                thread);

/* Peek into a messaqe queue to see if there are messages */
extern unsigned ipc_mqueue_peek(
	ipc_mqueue_t		mqueue,
	mach_port_seqno_t	*msg_seqnop,
	mach_msg_size_t		*msg_sizep,
	mach_msg_id_t		*msg_idp,
	mach_msg_max_trailer_t	*msg_trailerp);

/* Peek into a messaqe queue set to see if there are queues with messages */
extern unsigned ipc_mqueue_set_peek(
	ipc_mqueue_t		mqueue);

/* Gather the names of member port for a given set */
extern void ipc_mqueue_set_gather_member_names(
	ipc_space_t		space,
	ipc_mqueue_t		set_mq,
	ipc_entry_num_t		maxnames,
	mach_port_name_t	*names,
	ipc_entry_num_t		*actualp);

/* Clear a message count reservation */
extern void ipc_mqueue_release_msgcount(
	ipc_mqueue_t		port_mq,
	ipc_mqueue_t		set_mq);

/* Change a queue limit */
extern void ipc_mqueue_set_qlimit(
	ipc_mqueue_t		mqueue,
	mach_port_msgcount_t	qlimit);

/* Change a queue's sequence number */
extern void ipc_mqueue_set_seqno(
	ipc_mqueue_t		mqueue, 
	mach_port_seqno_t 	seqno);

/* Convert a name in a space to a message queue */
extern mach_msg_return_t ipc_mqueue_copyin(
	ipc_space_t		space,
	mach_port_name_t	name,
	ipc_mqueue_t		*mqueuep,
	ipc_object_t		*objectp);

#endif	/* _IPC_IPC_MQUEUE_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2007 Apple 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	*/
	56	/*
	57	*/
	58	/*
	59	* File: ipc/ipc_mqueue.h
	60	* Author: Rich Draves
	61	* Date: 1989
	62	*
	63	* Definitions for message queues.
	64	*/
	65
	66	#ifndef _IPC_IPC_MQUEUE_H_
	67	#define _IPC_IPC_MQUEUE_H_
	68
	69	#include <mach_assert.h>
	70
	71	#include <mach/message.h>
	72
	73	#include <kern/assert.h>
	74	#include <kern/macro_help.h>
91447636	75	#include <kern/kern_types.h>
b0d623f7	76	#include <kern/spl.h>
3e170ce0	77	#include <kern/waitq.h>
1c79356b A	78
	79	#include <ipc/ipc_kmsg.h>
	80	#include <ipc/ipc_object.h>
	81	#include <ipc/ipc_types.h>
	82
b0d623f7 A	83	#include <sys/event.h>
b0d623f7 A	84
1c79356b A	85	typedef struct ipc_mqueue {
	86	union {
	87	struct {
3e170ce0	88	struct waitq waitq;
1c79356b	89	struct ipc_kmsg_queue messages;
b0d623f7 A	90	mach_port_seqno_t seqno;
b0d623f7 A	91	mach_port_name_t receiver_name;
3e170ce0 A	92	uint16_t msgcount;
	93	uint16_t qlimit;
	94	} __attribute__((__packed__)) port;
b0d623f7	95	struct {
3e170ce0	96	struct waitq_set setq;
b0d623f7	97	mach_port_name_t local_name;
3e170ce0	98	} __attribute__((__packed__)) pset;
1c79356b A	99	} data;
	100	} *ipc_mqueue_t;
	101
	102	#define IMQ_NULL ((ipc_mqueue_t) 0)
	103
3e170ce0	104	#define imq_wait_queue data.port.waitq
1c79356b A	105	#define imq_messages data.port.messages
	106	#define imq_msgcount data.port.msgcount
	107	#define imq_qlimit data.port.qlimit
	108	#define imq_seqno data.port.seqno
b0d623f7	109	#define imq_receiver_name data.port.receiver_name
1c79356b	110
3e170ce0 A	111	/*
	112	* we can use the 'eventmask' bits of the waitq b/c
	113	* they are only used by global queues
	114	*/
	115	#define imq_fullwaiters data.port.waitq.waitq_eventmask
	116	#define imq_in_pset data.port.waitq.waitq_set_id
	117
	118	#define imq_set_queue data.pset.setq
b0d623f7	119	#define imq_local_name data.pset.local_name
3e170ce0 A	120	#define imq_is_set(mq) waitqs_is_set(&(mq)->imq_set_queue)
	121
	122	#define imq_lock(mq) waitq_lock(&(mq)->imq_wait_queue)
	123	#define imq_lock_try(mq) waitq_lock_try(&(mq)->imq_wait_queue)
	124	#define imq_unlock(mq) waitq_unlock(&(mq)->imq_wait_queue)
	125	#define imq_held(mq) waitq_held(&(mq)->imq_wait_queue)
1c79356b	126
3e170ce0 A	127	extern void imq_reserve_and_lock(ipc_mqueue_t mq,
	128	uint64_t reserved_prepost, spl_t spl);
	129
	130	extern void imq_release_and_unlock(ipc_mqueue_t mq,
	131	uint64_t reserved_prepost, spl_t spl);
1c79356b A	132
1c79356b A	133	#define imq_full(mq) ((mq)->imq_msgcount >= (mq)->imq_qlimit)
c910b4d9	134	#define imq_full_kernel(mq) ((mq)->imq_msgcount >= MACH_PORT_QLIMIT_KERNEL)
1c79356b A	135
1c79356b A	136	extern int ipc_mqueue_full;
b0d623f7	137	// extern int ipc_mqueue_rcv;
1c79356b	138
cf7d32b8	139	#define IPC_MQUEUE_FULL CAST_EVENT64_T(&ipc_mqueue_full)
b0d623f7	140	#define IPC_MQUEUE_RECEIVE NO_EVENT64
1c79356b A	141
	142	/*
	143	* Exported interfaces
	144	*/
	145
	146	/* Initialize a newly-allocated message queue */
	147	extern void ipc_mqueue_init(
91447636	148	ipc_mqueue_t mqueue,
3e170ce0 A	149	boolean_t is_set,
	150	uint64_t *reserved_link);
	151
	152	/* de-initialize / cleanup an mqueue (specifically waitq resources) */
	153	extern void ipc_mqueue_deinit(
	154	ipc_mqueue_t mqueue);
91447636 A	155
	156	/* destroy an mqueue */
	157	extern void ipc_mqueue_destroy(
	158	ipc_mqueue_t mqueue);
1c79356b	159
1c79356b A	160	/* Wake up receivers waiting in a message queue */
	161	extern void ipc_mqueue_changed(
	162	ipc_mqueue_t mqueue);
	163
91447636 A	164	/* Add the specific mqueue as a member of the set */
	165	extern kern_return_t ipc_mqueue_add(
	166	ipc_mqueue_t mqueue,
316670eb	167	ipc_mqueue_t set_mqueue,
3e170ce0 A	168	uint64_t *reserved_link,
3e170ce0 A	169	uint64_t *reserved_prepost);
91447636 A	170
	171	/* Check to see if mqueue is member of set_mqueue */
	172	extern boolean_t ipc_mqueue_member(
	173	ipc_mqueue_t mqueue,
	174	ipc_mqueue_t set_mqueue);
	175
	176	/* Remove an mqueue from a specific set */
	177	extern kern_return_t ipc_mqueue_remove(
	178	ipc_mqueue_t mqueue,
3e170ce0	179	ipc_mqueue_t set_mqueue);
91447636 A	180
	181	/* Remove an mqueue from all sets */
	182	extern void ipc_mqueue_remove_from_all(
3e170ce0	183	ipc_mqueue_t mqueue);
91447636 A	184
	185	/* Remove all the members of the specifiied set */
	186	extern void ipc_mqueue_remove_all(
3e170ce0	187	ipc_mqueue_t mqueue);
91447636	188
1c79356b A	189	/* Send a message to a port */
	190	extern mach_msg_return_t ipc_mqueue_send(
	191	ipc_mqueue_t mqueue,
	192	ipc_kmsg_t kmsg,
	193	mach_msg_option_t option,
b0d623f7 A	194	mach_msg_timeout_t timeout_val,
b0d623f7 A	195	spl_t s);
1c79356b	196
39236c6e A	197	/* check for queue send queue full of a port */
	198	extern mach_msg_return_t ipc_mqueue_preflight_send(
	199	ipc_mqueue_t mqueue,
	200	ipc_kmsg_t kmsg,
	201	mach_msg_option_t option,
	202	mach_msg_timeout_t timeout_val);
	203
1c79356b A	204	/* Deliver message to message queue or waiting receiver */
	205	extern void ipc_mqueue_post(
	206	ipc_mqueue_t mqueue,
	207	ipc_kmsg_t kmsg);
	208
	209	/* Receive a message from a message queue */
	210	extern void ipc_mqueue_receive(
	211	ipc_mqueue_t mqueue,
	212	mach_msg_option_t option,
	213	mach_msg_size_t max_size,
91447636	214	mach_msg_timeout_t timeout_val,
1c79356b A	215	int interruptible);
1c79356b A	216
b0d623f7 A	217	/* Receive a message from a message queue using a specified thread */
	218	extern wait_result_t ipc_mqueue_receive_on_thread(
	219	ipc_mqueue_t mqueue,
	220	mach_msg_option_t option,
	221	mach_msg_size_t max_size,
	222	mach_msg_timeout_t rcv_timeout,
	223	int interruptible,
	224	thread_t thread);
	225
1c79356b	226	/* Continuation routine for message receive */
91447636 A	227	extern void ipc_mqueue_receive_continue(
	228	void *param,
	229	wait_result_t wresult);
1c79356b A	230
1c79356b A	231	/* Select a message from a queue and try to post it to ourself */
b0d623f7	232	extern void ipc_mqueue_select_on_thread(
3e170ce0 A	233	ipc_mqueue_t port_mq,
3e170ce0 A	234	ipc_mqueue_t set_mq,
1c79356b	235	mach_msg_option_t option,
b0d623f7 A	236	mach_msg_size_t max_size,
	237	thread_t thread);
	238
	239	/* Peek into a messaqe queue to see if there are messages */
6d2010ae	240	extern unsigned ipc_mqueue_peek(
39236c6e A	241	ipc_mqueue_t mqueue,
	242	mach_port_seqno_t *msg_seqnop,
	243	mach_msg_size_t *msg_sizep,
	244	mach_msg_id_t *msg_idp,
	245	mach_msg_max_trailer_t *msg_trailerp);
	246
	247	/* Peek into a messaqe queue set to see if there are queues with messages */
	248	extern unsigned ipc_mqueue_set_peek(
b0d623f7	249	ipc_mqueue_t mqueue);
1c79356b	250
39236c6e A	251	/* Gather the names of member port for a given set */
39236c6e A	252	extern void ipc_mqueue_set_gather_member_names(
3e170ce0 A	253	ipc_space_t space,
3e170ce0 A	254	ipc_mqueue_t set_mq,
39236c6e A	255	ipc_entry_num_t maxnames,
	256	mach_port_name_t *names,
	257	ipc_entry_num_t *actualp);
	258
1c79356b A	259	/* Clear a message count reservation */
1c79356b A	260	extern void ipc_mqueue_release_msgcount(
3e170ce0 A	261	ipc_mqueue_t port_mq,
3e170ce0 A	262	ipc_mqueue_t set_mq);
1c79356b A	263
	264	/* Change a queue limit */
	265	extern void ipc_mqueue_set_qlimit(
	266	ipc_mqueue_t mqueue,
	267	mach_port_msgcount_t qlimit);
	268
	269	/* Change a queue's sequence number */
	270	extern void ipc_mqueue_set_seqno(
	271	ipc_mqueue_t mqueue,
	272	mach_port_seqno_t seqno);
	273
	274	/* Convert a name in a space to a message queue */
	275	extern mach_msg_return_t ipc_mqueue_copyin(
	276	ipc_space_t space,
	277	mach_port_name_t name,
	278	ipc_mqueue_t *mqueuep,
	279	ipc_object_t *objectp);
	280
	281	#endif /* _IPC_IPC_MQUEUE_H_ */