xnu-6153.61.1.tar.gz

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

diff --git a/osfmk/ipc/ipc_mqueue.h b/osfmk/ipc/ipc_mqueue.h
index 2670f5c5cf0af601fc01e4f6f85aae5ebe4e24eb..f982ba6771e9706e8e26e2846a6bbca5e8ecc2f9 100644 (file)
--- a/osfmk/ipc/ipc_mqueue.h
+++ b/osfmk/ipc/ipc_mqueue.h
@@ -1,49 +1,55 @@
 /*
 /*

- * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2007 Apple 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
+ * @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,
  * 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@
+ * 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@
  */
  */
 /*
  * @OSF_COPYRIGHT@
  */

-/* 
+/*

  * Mach Operating System
  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  * All Rights Reserved.
  * 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.
  * 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 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
  * 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
  *  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.
  */
  * any improvements or extensions that they make and grant Carnegie Mellon
  * the rights to redistribute these changes.
  */


@@ -57,7 +63,7 @@
  *     Definitions for message queues.
  */
 
  *     Definitions for message queues.
  */
 

-#ifndef        _IPC_IPC_MQUEUE_H_
+#ifndef _IPC_IPC_MQUEUE_H_

 #define _IPC_IPC_MQUEUE_H_
 
 #include <mach_assert.h>
 #define _IPC_IPC_MQUEUE_H_
 
 #include <mach_assert.h>


@@ -67,142 +73,292 @@
 #include <kern/assert.h>
 #include <kern/macro_help.h>
 #include <kern/kern_types.h>
 #include <kern/assert.h>
 #include <kern/macro_help.h>
 #include <kern/kern_types.h>

-#include <kern/wait_queue.h>
+#include <kern/waitq.h>

 
 #include <ipc/ipc_kmsg.h>
 #include <ipc/ipc_object.h>
 #include <ipc/ipc_types.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 {
 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;
+#ifdef __LP64__
+                       uint32_t                qcontext;
+#endif
+#if MACH_FLIPC
+                       struct flipc_port       *fport; // Null for local port, or ptr to flipc port
+#endif

                } port;
                } port;

-               struct wait_queue_set           set_queue;
+               struct {
+                       struct waitq_set        setq;
+               } pset;

        } data;
        } data;

+       union {
+               /*
+                * Port Sets:
+                *   only use imq_klist
+                *
+                * Special Reply Ports (ip_specialreply == true):
+                *   only use imq_srp_owner_thread
+                *
+                * Ports, based on ip_sync_link_state, use:
+                * - PORT_SYNC_LINK_ANY:            imq_klist
+                * - PORT_SYNC_LINK_WORKLOOP_KNOTE: imq_inheritor_knote
+                * - PORT_SYNC_LINK_WORKLOOP_STASH: imq_inheritor_turnstile
+                * - PORT_SYNC_LINK_RCV_THREAD: imq_inheritor_thread_ref
+                */
+               struct klist imq_klist;
+               struct knote *imq_inheritor_knote;
+               struct turnstile *imq_inheritor_turnstile;
+               thread_t imq_inheritor_thread_ref;
+               thread_t imq_srp_owner_thread;
+       };
+#ifndef __LP64__
+       uint32_t qcontext;
+#endif

 } *ipc_mqueue_t;
 
 } *ipc_mqueue_t;
 

-#define        IMQ_NULL                ((ipc_mqueue_t) 0)
+#define IMQ_NULL                ((ipc_mqueue_t) 0)

 
 

-#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
+#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

 
 

-#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)
+/*
+ * The qcontext structure member fills in a 32-bit padding gap in ipc_mqueue.
+ * However, the 32-bits are in slightly different places on 32 and 64 bit systems.
+ */
+#ifdef __LP64__
+#define imq_context             data.port.qcontext
+#else
+#define imq_context             qcontext
+#endif

 
 

-#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)
+/*
+ * 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_turnstile_proxy(mq) \
+               waitq_is_turnstile_proxy(&(mq)->imq_wait_queue)
+#define imq_is_valid(mq)        waitq_is_valid(&(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)
+
+extern void imq_lock(ipc_mqueue_t mq);
+extern unsigned int imq_lock_try(ipc_mqueue_t mq);
+
+/*
+ * 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) ? \
+               __container_of(waitq, struct ipc_mqueue, imq_set_queue.wqset_q) : \
+               __container_of(waitq, struct ipc_mqueue, imq_wait_queue))
+
+#define imq_to_object(mq) ip_to_object(ip_from_mq(mq))
+
+extern void imq_reserve_and_lock(ipc_mqueue_t mq,
+    uint64_t *reserved_prepost);
+
+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_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
  */
 
 
 /*
  * Exported interfaces
  */
 

+__enum_closed_decl(ipc_mqueue_kind_t, int, {
+       IPC_MQUEUE_KIND_NONE,   /* this mqueue really isn't used */
+       IPC_MQUEUE_KIND_PORT,   /* this queue is a regular port queue */
+       IPC_MQUEUE_KIND_SET,    /* this queue is a portset queue */
+});
+

 /* Initialize a newly-allocated message queue */
 extern void ipc_mqueue_init(
 /* Initialize a newly-allocated message queue */
 extern void ipc_mqueue_init(

-       ipc_mqueue_t            mqueue,
-       boolean_t               is_set);
+       ipc_mqueue_t            mqueue,
+       ipc_mqueue_kind_t       kind);
+
+/* de-initialize / cleanup an mqueue (specifically waitq resources) */
+extern void ipc_mqueue_deinit(
+       ipc_mqueue_t            mqueue);

 
 /* destroy an mqueue */
 
 /* destroy an mqueue */

-extern void ipc_mqueue_destroy(
-       ipc_mqueue_t            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(
 
 /* 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(
 
 /* 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);
+       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(
 
 /* 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);
+       ipc_mqueue_t            mqueue,
+       ipc_mqueue_t            set_mqueue);

 
 /* Remove an mqueue from a specific set */
 extern kern_return_t ipc_mqueue_remove(
 
 /* Remove an mqueue from a specific set */
 extern kern_return_t ipc_mqueue_remove(

-       ipc_mqueue_t            mqueue,
-       ipc_mqueue_t            set_mqueue);
+       ipc_mqueue_t            mqueue,
+       ipc_mqueue_t            set_mqueue);

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

-       ipc_mqueue_t            mqueue);
+       ipc_mqueue_t            mqueue);

 
 /* Remove all the members of the specifiied set */
 extern void ipc_mqueue_remove_all(
 
 /* Remove all the members of the specifiied set */
 extern void ipc_mqueue_remove_all(

-       ipc_mqueue_t            mqueue);
+       ipc_mqueue_t            mqueue);

 
 /* Send a message to a port */
 extern mach_msg_return_t ipc_mqueue_send(
 
 /* 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);
+       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(
 
 /* 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(
 
 /* 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,
+       ipc_mqueue_t            mqueue,
+       mach_msg_option_t       option,
+       mach_msg_size_t         max_size,
+       mach_msg_timeout_t      timeout_val,

        int                     interruptible);
 
        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(
 /* Continuation routine for message receive */
 extern void ipc_mqueue_receive_continue(

-       void                    *param,
-       wait_result_t           wresult);
+       void                    *param,
+       wait_result_t           wresult);

 
 /* Select a message from a queue and try to post it to ourself */
 
 /* 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(
 
 /* 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(
 
 /* 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(
 
 /* 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(
 
 /* 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_ */