X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/43866e378188c25dd1e2208016ab3cbeb086ae6c..0a7de7458d150b5d4dffc935ba399be265ef0a1a:/osfmk/ipc/ipc_mqueue.h diff --git a/osfmk/ipc/ipc_mqueue.h b/osfmk/ipc/ipc_mqueue.h index 93b6fb2fa..140ce1dfd 100644 --- a/osfmk/ipc/ipc_mqueue.h +++ b/osfmk/ipc/ipc_mqueue.h @@ -1,17 +1,20 @@ /* - * Copyright (c) 2000 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2000-2007 Apple Inc. All rights reserved. + * + * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * - * @APPLE_LICENSE_HEADER_START@ - * - * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved. - * * 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. Please obtain a copy of the License at - * http://www.opensource.apple.com/apsl/ and read it before using this - * file. - * + * 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, @@ -19,34 +22,34 @@ * 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_LICENSE_HEADER_END@ + * + * @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. */ @@ -60,7 +63,7 @@ * Definitions for message queues. */ -#ifndef _IPC_IPC_MQUEUE_H_ +#ifndef _IPC_IPC_MQUEUE_H_ #define _IPC_IPC_MQUEUE_H_ #include @@ -69,51 +72,117 @@ #include #include -#include +#include +#include #include #include #include +#include + typedef struct ipc_mqueue { union { struct { - struct wait_queue wait_queue; - struct ipc_kmsg_queue messages; - mach_port_msgcount_t msgcount; - mach_port_msgcount_t qlimit; - mach_port_seqno_t seqno; - boolean_t fullwaiters; + 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; +#if MACH_FLIPC + struct flipc_port *fport; // Null for local port, or ptr to flipc port +#endif } port; - struct wait_queue_set set_queue; + struct { + struct waitq_set setq; + } pset; } data; + union { + struct klist imq_klist; + uintptr_t imq_inheritor; + }; } *ipc_mqueue_t; -#define IMQ_NULL ((ipc_mqueue_t) 0) +#define IMQ_NULL ((ipc_mqueue_t) 0) + +/* + * When a receive right is in flight, before it can ever be registered with + * a new knote, its imq_klist field can be overloaded to hold a pointer + * to the knote that the port is pushing on through his turnstile. + * + * if IMQ_KLIST_VALID() returns true, then the imq_klist field can be used, + * else IMQ_INHERITOR() can be used to get the pointer to the knote currently + * being the port turnstile inheritor. + */ +#define IMQ_KLIST_VALID(imq) (((imq)->imq_inheritor & 1) == 0) +#define IMQ_INHERITOR(imq) ((struct turnstile *)((imq)->imq_inheritor ^ 1)) +#define IMQ_SET_INHERITOR(imq, inheritor) \ +MACRO_BEGIN \ + assert(((imq)->imq_inheritor & 1) || SLIST_EMPTY(&(imq)->imq_klist)); \ + ((imq)->imq_inheritor = (uintptr_t)(inheritor) | 1); \ +MACRO_END + +#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 +#if MACH_FLIPC +#define imq_fport data.port.fport +#endif + +/* + * 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_preposts data.port.waitq.waitq_prepost_id + +#define imq_set_queue data.pset.setq +#define imq_is_set(mq) waitqs_is_set(&(mq)->imq_set_queue) +#define imq_is_queue(mq) waitq_is_queue(&(mq)->imq_wait_queue) +#define imq_is_valid(mq) waitq_is_valid(&(mq)->imq_wait_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) +#define imq_valid(mq) waitq_valid(&(mq)->imq_wait_queue) -#define imq_wait_queue data.port.wait_queue -#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_fullwaiters data.port.fullwaiters +/* + * Get an ipc_mqueue pointer from a waitq pointer. These are traditionally the + * same pointer, but this conversion makes no assumptions on union structure + * member positions - it should allow the waitq to move around in either the + * port-set mqueue or the port mqueue independently. + */ +#define imq_from_waitq(waitq) (waitq_is_set(waitq) ? \ + ((struct ipc_mqueue *)((void *)( \ + (uintptr_t)(waitq) - \ + __offsetof(struct ipc_mqueue, imq_set_queue)) \ + )) : \ + ((struct ipc_mqueue *)((void *)( \ + (uintptr_t)(waitq) - \ + __offsetof(struct ipc_mqueue, imq_wait_queue)) \ + )) \ + ) -#define imq_set_queue data.set_queue -#define imq_setlinks data.set_queue.wqs_setlinks -#define imq_is_set(mq) wait_queue_is_set(&(mq)->imq_set_queue) +extern void imq_reserve_and_lock(ipc_mqueue_t mq, + uint64_t *reserved_prepost); -#define imq_lock(mq) wait_queue_lock(&(mq)->imq_wait_queue) -#define imq_lock_try(mq) wait_queue_lock_try(&(mq)->imq_wait_queue) -#define imq_unlock(mq) wait_queue_unlock(&(mq)->imq_wait_queue) -#define imq_held(mq) wait_queue_held(&(mq)->imq_wait_queue) +extern void imq_release_and_unlock(ipc_mqueue_t mq, + uint64_t reserved_prepost); -#define imq_full(mq) ((mq)->imq_msgcount >= (mq)->imq_qlimit) +#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; +// extern int ipc_mqueue_rcv; -#define IPC_MQUEUE_FULL (event64_t)&ipc_mqueue_full -#define IPC_MQUEUE_RECEIVE (event64_t)&ipc_mqueue_rcv +#define IPC_MQUEUE_FULL CAST_EVENT64_T(&ipc_mqueue_full) +#define IPC_MQUEUE_RECEIVE NO_EVENT64 /* * Exported interfaces @@ -121,61 +190,156 @@ extern int ipc_mqueue_rcv; /* Initialize a newly-allocated message queue */ extern void ipc_mqueue_init( - ipc_mqueue_t mqueue, - boolean_t is_set); + ipc_mqueue_t mqueue, + boolean_t is_set); + +/* de-initialize / cleanup an mqueue (specifically waitq resources) */ +extern void ipc_mqueue_deinit( + ipc_mqueue_t mqueue); + +/* destroy an mqueue */ +extern boolean_t ipc_mqueue_destroy_locked( + ipc_mqueue_t mqueue); /* Wake up receivers waiting in a message queue */ extern void ipc_mqueue_changed( - ipc_mqueue_t mqueue); + ipc_space_t space, + 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); + ipc_mqueue_t mqueue, + ipc_kmsg_t kmsg, + mach_msg_option_t option, + mach_msg_timeout_t timeout_val); + +/* 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); + +/* Set a [send-possible] override on the mqueue */ +extern void ipc_mqueue_override_send( + ipc_mqueue_t mqueue, + mach_msg_priority_t override); /* Deliver message to message queue or waiting receiver */ extern void ipc_mqueue_post( - ipc_mqueue_t mqueue, - ipc_kmsg_t kmsg); + ipc_mqueue_t mqueue, + ipc_kmsg_t kmsg, + mach_msg_option_t option); /* 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, + 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); +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( - ipc_mqueue_t mqueue, - mach_msg_option_t option, - mach_msg_size_t max_size); +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, + ipc_kmsg_t *kmsgp); + +/* Peek into a locked messaqe queue to see if there are messages */ +extern unsigned ipc_mqueue_peek_locked( + 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, + ipc_kmsg_t *kmsgp); + +/* Peek into a messaqe queue set to see if there are queues with messages */ +extern unsigned ipc_mqueue_set_peek( + ipc_mqueue_t mqueue); + +/* Release an mqueue/port reference that was granted by MACH_PEEK_MSG */ +extern void ipc_mqueue_release_peek_ref( + 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 mqueue); + 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); + 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); + 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); + ipc_space_t space, + mach_port_name_t name, + ipc_mqueue_t *mqueuep, + ipc_object_t *objectp); -#endif /* _IPC_IPC_MQUEUE_H_ */ +#endif /* _IPC_IPC_MQUEUE_H_ */