]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/ipc/ipc_kmsg.h
xnu-3789.70.16.tar.gz
[apple/xnu.git] / osfmk / ipc / ipc_kmsg.h
index dc58188a8ce191055df1be40b0962871310edaa1..6e11487c509a4caa229f4b758cf9e6b37afcdef4 100644 (file)
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_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 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.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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 OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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@
  * any improvements or extensions that they make and grant Carnegie Mellon
  * the rights to redistribute these changes.
  */
+/*
+ * NOTICE: This file was modified by McAfee Research in 2004 to introduce
+ * support for mandatory and extensible security protections.  This notice
+ * is included in support of clause 2.2 (b) of the Apple Public License,
+ * Version 2.0.
+ * Copyright (c) 2005 SPARTA, Inc.
+ */
 /*
  */
 /*
@@ -67,6 +80,7 @@
 #include <kern/macro_help.h>
 #include <ipc/ipc_types.h>
 #include <ipc/ipc_object.h>
+#include <sys/kdebug.h>
 
 /*
  *     This structure is only the header for a kmsg buffer;
  *     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;
+       mach_msg_size_t            ikm_size;
+       struct ipc_kmsg            *ikm_next;        /* next message on port/discard queue */
+       struct ipc_kmsg            *ikm_prev;        /* prev message on port/discard queue */
+       mach_msg_header_t          *ikm_header;
+       ipc_port_t                 ikm_prealloc;     /* port we were preallocated from */
+       ipc_port_t                 ikm_voucher;      /* voucher port carried */
+       mach_msg_priority_t        ikm_qos;          /* qos of this kmsg */
+       mach_msg_priority_t        ikm_qos_override; /* qos override on this kmsg */
+       struct ipc_importance_elem *ikm_importance;  /* inherited from */
+       queue_chain_t              ikm_inheritance;  /* inherited from link */
+#if MACH_FLIPC
+       struct mach_node           *ikm_node;        /* Originating node - needed for ack */
+#endif
 };
 
+#if defined(__i386__) || defined(__arm__)
+#define        IKM_SUPPORT_LEGACY      1
+#else
+#define        IKM_SUPPORT_LEGACY      0
+#endif
 
 #define        IKM_OVERHEAD            (sizeof(struct ipc_kmsg))
 
@@ -124,15 +150,24 @@ 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);        \
+#if MACH_FLIPC
+#define ikm_flipc_init(kmsg) (kmsg)->ikm_node = MACH_NODE_NULL
+#else
+#define ikm_flipc_init(kmsg)
+#endif
+
+#define        ikm_init(kmsg, size)                                    \
+MACRO_BEGIN                                                     \
+       (kmsg)->ikm_size = (size);                                  \
+       (kmsg)->ikm_prealloc = IP_NULL;                             \
+       (kmsg)->ikm_voucher = IP_NULL;                              \
+       (kmsg)->ikm_importance = IIE_NULL;                          \
+       (kmsg)->ikm_qos = MACH_MSG_PRIORITY_UNSPECIFIED;            \
+       (kmsg)->ikm_qos_override = MACH_MSG_PRIORITY_UNSPECIFIED;   \
+       ikm_flipc_init(kmsg);                                       \
+       assert((kmsg)->ikm_prev = (kmsg)->ikm_next = IKM_BOGUS);    \
 MACRO_END
 
 #define        ikm_check_init(kmsg, size)                                      \
@@ -142,6 +177,12 @@ MACRO_BEGIN                                                                \
        assert((kmsg)->ikm_next == IKM_BOGUS);                          \
 MACRO_END
 
+#define ikm_set_header(kmsg, mtsize)                                   \
+MACRO_BEGIN                                                            \
+       (kmsg)->ikm_header = (mach_msg_header_t *)                      \
+       ((vm_offset_t)((kmsg) + 1) + (kmsg)->ikm_size - (mtsize));      \
+MACRO_END
+
 struct ipc_kmsg_queue {
        struct ipc_kmsg *ikmq_base;
 };
@@ -167,6 +208,15 @@ extern void ipc_kmsg_enqueue(
        ipc_kmsg_queue_t        queue,
        ipc_kmsg_t              kmsg);
 
+extern boolean_t ipc_kmsg_enqueue_qos(
+       ipc_kmsg_queue_t        queue,
+       ipc_kmsg_t              kmsg);
+
+extern boolean_t ipc_kmsg_override_qos(
+       ipc_kmsg_queue_t    queue,
+       ipc_kmsg_t          kmsg,
+       mach_msg_priority_t override);
+
 /* Dequeue and return a kmsg */
 extern ipc_kmsg_t ipc_kmsg_dequeue(
        ipc_kmsg_queue_t        queue);
@@ -176,6 +226,11 @@ extern void ipc_kmsg_rmqueue(
        ipc_kmsg_queue_t        queue,
        ipc_kmsg_t              kmsg);
 
+/* Pull the (given) first kmsg out of a queue */
+extern void ipc_kmsg_rmqueue_first(
+       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 */
@@ -183,75 +238,6 @@ 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);
@@ -264,17 +250,23 @@ extern void ipc_kmsg_free(
 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);
+/* Enqueue kernel message for deferred destruction */
+extern boolean_t ipc_kmsg_delayed_destroy(
+       ipc_kmsg_t kmsg);
 
+/* Process all the delayed message destroys */
+extern void ipc_kmsg_reap_delayed(void);
 
 /* Preallocate a kernel message buffer */
+extern ipc_kmsg_t ipc_kmsg_prealloc(
+       mach_msg_size_t size);
+
+/* bind a preallocated message buffer to a port */
 extern void ipc_kmsg_set_prealloc(
        ipc_kmsg_t      kmsg,
        ipc_port_t      port);
 
-/* Clear a kernel message buffer */
+/* Clear preallocated message buffer binding */
 extern void ipc_kmsg_clear_prealloc(
        ipc_kmsg_t      kmsg,
        ipc_port_t      port);
@@ -299,9 +291,12 @@ extern mach_msg_return_t ipc_kmsg_send(
 
 /* 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);
+       mach_msg_option_t       option,
+       mach_vm_address_t       rcv_addr,
+       mach_msg_size_t         rcv_size,
+       mach_msg_size_t         trailer_size,
+       mach_msg_size_t         *size);
 
 /* Copy a kernel message buffer to a kernel message */
 extern void ipc_kmsg_put_to_kernel(
@@ -311,26 +306,33 @@ extern void ipc_kmsg_put_to_kernel(
 
 /* Copyin port rights in the header of a message */
 extern mach_msg_return_t ipc_kmsg_copyin_header(
-       mach_msg_header_t       *msg,
+       ipc_kmsg_t              kmsg,
        ipc_space_t             space,
-       mach_port_name_t        notify);
+       mach_msg_priority_t override,
+       mach_msg_option_t       *optionp);
 
 /* 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);
+       mach_msg_priority_t override,
+       mach_msg_option_t       *optionp);
 
 /* Copyin port rights and out-of-line memory from a kernel message */
-extern void ipc_kmsg_copyin_from_kernel(
+extern mach_msg_return_t ipc_kmsg_copyin_from_kernel(
        ipc_kmsg_t              kmsg);
 
+#if IKM_SUPPORT_LEGACY
+extern mach_msg_return_t ipc_kmsg_copyin_from_kernel_legacy(
+       ipc_kmsg_t      kmsg);
+#endif
+
 /* Copyout port rights in the header of a message */
 extern mach_msg_return_t ipc_kmsg_copyout_header(
-       mach_msg_header_t       *msg,
+       ipc_kmsg_t              kmsg,
        ipc_space_t             space,
-       mach_port_name_t        notify);
+       mach_msg_option_t       option);
 
 /* Copyout a port right returning a name */
 extern mach_msg_return_t ipc_kmsg_copyout_object(
@@ -344,8 +346,8 @@ 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);
+       mach_msg_body_t         *slist,
+       mach_msg_option_t       option);
 
 /* Copyout port rights and out-of-line memory from the body of a message */
 extern mach_msg_return_t ipc_kmsg_copyout_body(
@@ -377,15 +379,24 @@ 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);
+#if IKM_SUPPORT_LEGACY
+extern void ipc_kmsg_copyout_to_kernel_legacy(
+       ipc_kmsg_t              kmsg,
+       ipc_space_t             space);
+#endif
+
+extern mach_msg_trailer_size_t
+ipc_kmsg_add_trailer(ipc_kmsg_t kmsg, ipc_space_t space, 
+               mach_msg_option_t option, thread_t thread, 
+               mach_port_seqno_t seqno, boolean_t minimal_trailer,
+               mach_vm_offset_t context);
 
-/* free a scatter list */
-extern void ipc_kmsg_free_scatter(
-        mach_msg_body_t        *slist,
-        mach_msg_size_t                slist_size);
+#if (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD)
+extern void ipc_kmsg_trace_send(ipc_kmsg_t kmsg,
+                               mach_msg_option_t option);
+#else
+#define ipc_kmsg_trace_send(a,b) do { } while (0)
+#endif
 
 #endif /* _IPC_IPC_KMSG_H_ */
+