xnu-3789.51.2.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 f452f70796d0df31bf2546e3205c03a784bb2af4..af0a534a4027ded7a31a38a21154c694f5e54d4f 100644 (file)
--- a/osfmk/ipc/ipc_mqueue.h
+++ b/osfmk/ipc/ipc_mqueue.h
@@ -73,8 +73,7 @@
 #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/spl.h>
-#include <kern/wait_queue.h>
+#include <kern/waitq.h>

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


@@ -85,41 +84,76 @@
 typedef struct ipc_mqueue {
        union {
                struct {
 typedef struct ipc_mqueue {
        union {
                struct {

-                       struct  wait_queue      wait_queue;     
+                       struct  waitq           waitq;

                        struct ipc_kmsg_queue   messages;
                        struct ipc_kmsg_queue   messages;

-                       mach_port_msgcount_t    msgcount;
-                       mach_port_msgcount_t    qlimit;

                        mach_port_seqno_t       seqno;
                        mach_port_name_t        receiver_name;
                        mach_port_seqno_t       seqno;
                        mach_port_name_t        receiver_name;

-                       boolean_t               fullwaiters;
+                       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 {
                } port;
                struct {

-                       struct wait_queue_set   set_queue;
-                       mach_port_name_t        local_name;
+                       struct waitq_set        setq;

                } pset;
        } data;
                } pset;
        } data;

+       struct klist imq_klist;

 } *ipc_mqueue_t;
 
 #define        IMQ_NULL                ((ipc_mqueue_t) 0)
 
 } *ipc_mqueue_t;
 
 #define        IMQ_NULL                ((ipc_mqueue_t) 0)
 

-#define imq_wait_queue         data.port.wait_queue
+#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
 #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

-#define imq_fullwaiters                data.port.fullwaiters
+#if MACH_FLIPC
+#define imq_fport              data.port.fport
+#endif

 
 

-#define imq_set_queue          data.pset.set_queue
-#define imq_setlinks           data.pset.set_queue.wqs_setlinks
-#define imq_preposts           data.pset.set_queue.wqs_preposts
-#define imq_local_name         data.pset.local_name
-#define imq_is_set(mq)         wait_queue_is_set(&(mq)->imq_set_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_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)
+#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)
+
+/*
+ * 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_wait_queue)) \
+                                       )) : \
+                                       ((struct ipc_mqueue *)((void *)( \
+                                               (uintptr_t)(waitq) - \
+                                               __offsetof(struct ipc_mqueue, imq_set_queue)) \
+                                       )) \
+                                )
+
+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_kernel(mq)    ((mq)->imq_msgcount >= MACH_PORT_QLIMIT_KERNEL)
 
 #define imq_full(mq)           ((mq)->imq_msgcount >= (mq)->imq_qlimit)
 #define imq_full_kernel(mq)    ((mq)->imq_msgcount >= MACH_PORT_QLIMIT_KERNEL)


@@ -137,10 +171,15 @@ extern int ipc_mqueue_full;
 /* Initialize a newly-allocated message queue */
 extern void ipc_mqueue_init(
        ipc_mqueue_t            mqueue,
 /* Initialize a newly-allocated message queue */
 extern void ipc_mqueue_init(
        ipc_mqueue_t            mqueue,

-       boolean_t               is_set);
+       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 */
 
 /* destroy an mqueue */

-extern void ipc_mqueue_destroy(
+extern boolean_t ipc_mqueue_destroy_locked(

        ipc_mqueue_t            mqueue);
 
 /* Wake up receivers waiting in a message queue */
        ipc_mqueue_t            mqueue);
 
 /* Wake up receivers waiting in a message queue */


@@ -151,7 +190,8 @@ extern void ipc_mqueue_changed(
 extern kern_return_t ipc_mqueue_add(
        ipc_mqueue_t            mqueue,
        ipc_mqueue_t            set_mqueue,
 extern kern_return_t ipc_mqueue_add(
        ipc_mqueue_t            mqueue,
        ipc_mqueue_t            set_mqueue,

-       wait_queue_link_t       wql);
+       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(


@@ -161,31 +201,40 @@ extern boolean_t ipc_mqueue_member(
 /* Remove an mqueue from a specific set */
 extern kern_return_t ipc_mqueue_remove(
        ipc_mqueue_t            mqueue,
 /* Remove an mqueue from a specific set */
 extern kern_return_t ipc_mqueue_remove(
        ipc_mqueue_t            mqueue,

-       ipc_mqueue_t            set_mqueue,
-       wait_queue_link_t       *wqlp);
+       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,
-       queue_t                 links);
+       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,
-       queue_t                 links);
+       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,
 
 /* 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);
+       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,
 
 /* Deliver message to message queue or waiting receiver */
 extern void ipc_mqueue_post(
        ipc_mqueue_t            mqueue,

-       ipc_kmsg_t              kmsg);
+       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(


@@ -211,18 +260,50 @@ extern void ipc_mqueue_receive_continue(
 
 /* Select a message from a queue and try to post it to ourself */
 extern void ipc_mqueue_select_on_thread(
 
 /* Select a message from a queue and try to post it to ourself */
 extern void ipc_mqueue_select_on_thread(

-       ipc_mqueue_t            mqueue,
+       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(
        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);
 
        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(