/*
* Copyright (c) 2000-2005 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.
+ */
/*
*/
/*
#include <mach/machine/vm_types.h>
#include <sys/cdefs.h>
+#include <sys/appleapiopts.h>
/*
* The timeout mechanism uses mach_msg_timeout_t values,
#define MACH_MSG_TIMEOUT_NONE ((mach_msg_timeout_t) 0)
/*
- * The kernel uses MACH_MSGH_BITS_COMPLEX as a hint. It it isn't on, it
+ * The kernel uses MACH_MSGH_BITS_COMPLEX as a hint. If it isn't on, it
* assumes the body of the message doesn't contain port rights or OOL
* data. The field is set in received messages. A user task must
* use caution in interpreting the body of a message if the bit isn't
#define MACH_MSGH_BITS_USER 0x8000ffffU
#define MACH_MSGH_BITS_CIRCULAR 0x40000000 /* internal use only */
-#define MACH_MSGH_BITS_USED 0xc000ffffU
+#define MACH_MSGH_BITS_RAISEIMP 0x20000000 /* importance raise, internal use only */
+#define MACH_MSGH_BITS_IMPHOLDASRT 0x10000000 /* holds assertion alredy, in userland */
+#define MACH_MSGH_BITS_USED 0xf000ffffU
#define MACH_MSGH_BITS_PORTS_MASK \
(MACH_MSGH_BITS_REMOTE_MASK|MACH_MSGH_BITS_LOCAL_MASK)
/*
* Every message starts with a message header.
- * Following the message header are zero or more pairs of
- * type descriptors (mach_msg_type_t/mach_msg_type_long_t) and
- * data values. The size of the message must be specified in bytes,
- * and includes the message header, type descriptors, inline
- * data, and inline pointer for out-of-line data.
+ * Following the message header, if the message is complex, are a count
+ * of type descriptors and the type descriptors themselves
+ * (mach_msg_descriptor_t). The size of the message must be specified in
+ * bytes, and includes the message header, descriptor count, descriptors,
+ * and inline data.
*
* The msgh_remote_port field specifies the destination of the message.
* It must specify a valid send or send-once right for a port.
#define MACH_MSG_KALLOC_COPY_T 4
#endif /* MACH_KERNEL */
+/*
+ * In a complex mach message, the mach_msg_header_t is followed by
+ * a descriptor count, then an array of that number of descriptors
+ * (mach_msg_*_descriptor_t). The type field of mach_msg_type_descriptor_t
+ * (which any descriptor can be cast to) indicates the flavor of the
+ * descriptor.
+ *
+ * Note that in LP64, the various types of descriptors are no longer all
+ * the same size as mach_msg_descriptor_t, so the array cannot be indexed
+ * as expected.
+ */
+
typedef unsigned int mach_msg_descriptor_type_t;
#define MACH_MSG_PORT_DESCRIPTOR 0
typedef struct
{
mach_port_t name;
+#if !(defined(KERNEL) && defined(__LP64__))
+// Pad to 8 bytes everywhere except the K64 kernel where mach_port_t is 8 bytes
mach_msg_size_t pad1;
+#endif
unsigned int pad2 : 16;
mach_msg_type_name_t disposition : 8;
mach_msg_descriptor_type_t type : 8;
+#if defined(KERNEL)
+ uint32_t pad_end;
+#endif
} mach_msg_port_descriptor_t;
typedef struct
#if defined(__LP64__)
mach_msg_size_t size;
#endif
+#if defined(KERNEL) && !defined(__LP64__)
+ uint32_t pad_end;
+#endif
} mach_msg_ool_descriptor_t;
typedef struct
#if defined(__LP64__)
mach_msg_size_t count;
#endif
+#if defined(KERNEL) && !defined(__LP64__)
+ uint32_t pad_end;
+#endif
} mach_msg_ool_ports_descriptor_t;
/*
* appropriate in LP64 mode because not all descriptors
* are of the same size in that environment.
*/
+#if defined(__LP64__) && defined(KERNEL)
+typedef union
+{
+ mach_msg_port_descriptor_t port;
+ mach_msg_ool_descriptor32_t out_of_line;
+ mach_msg_ool_ports_descriptor32_t ool_ports;
+ mach_msg_type_descriptor_t type;
+} mach_msg_descriptor_t;
+#else
typedef union
{
mach_msg_port_descriptor_t port;
mach_msg_ool_ports_descriptor_t ool_ports;
mach_msg_type_descriptor_t type;
} mach_msg_descriptor_t;
+#endif
typedef struct
{
#define MACH_MSG_TRAILER_FORMAT_0 0
typedef unsigned int mach_msg_trailer_size_t;
+typedef char *mach_msg_trailer_info_t;
typedef struct
{
audit_token_t msgh_audit;
} mach_msg_audit_trailer_t;
+typedef struct
+{
+ mach_msg_trailer_type_t msgh_trailer_type;
+ mach_msg_trailer_size_t msgh_trailer_size;
+ mach_port_seqno_t msgh_seqno;
+ security_token_t msgh_sender;
+ audit_token_t msgh_audit;
+ mach_port_context_t msgh_context;
+} mach_msg_context_trailer_t;
+
+typedef struct
+{
+ mach_port_name_t sender;
+} msg_labels_t;
+
+/*
+ Trailer type to pass MAC policy label info as a mach message trailer.
+
+*/
+
+typedef struct
+{
+ mach_msg_trailer_type_t msgh_trailer_type;
+ mach_msg_trailer_size_t msgh_trailer_size;
+ mach_port_seqno_t msgh_seqno;
+ security_token_t msgh_sender;
+ audit_token_t msgh_audit;
+ mach_port_context_t msgh_context;
+ int msgh_ad;
+ msg_labels_t msgh_labels;
+} mach_msg_mac_trailer_t;
+
#define MACH_MSG_TRAILER_MINIMUM_SIZE sizeof(mach_msg_trailer_t)
/*
* another module may exceed the local modules notion of
* MAX_TRAILER_SIZE.
*/
-typedef mach_msg_audit_trailer_t mach_msg_max_trailer_t;
-#define MAX_TRAILER_SIZE sizeof(mach_msg_max_trailer_t)
+
+typedef mach_msg_mac_trailer_t mach_msg_max_trailer_t;
+#define MAX_TRAILER_SIZE ((mach_msg_size_t)sizeof(mach_msg_max_trailer_t))
/*
* Legacy requirements keep us from ever updating these defines (even
* REQUESTED_TRAILER_SIZE.
*/
typedef mach_msg_security_trailer_t mach_msg_format_0_trailer_t;
+
+/*typedef mach_msg_mac_trailer_t mach_msg_format_0_trailer_t;
+*/
+
#define MACH_MSG_TRAILER_FORMAT_0_SIZE sizeof(mach_msg_format_0_trailer_t)
#define KERNEL_SECURITY_TOKEN_VALUE { {0, 1} }
/*
* There is no fixed upper bound to the size of Mach messages.
*/
-
#define MACH_MSG_SIZE_MAX ((mach_msg_size_t) ~0)
+#if defined(__APPLE_API_PRIVATE)
+/*
+ * But architectural limits of a given implementation, or
+ * temporal conditions may cause unpredictable send failures
+ * for messages larger than MACH_MSG_SIZE_RELIABLE.
+ *
+ * In either case, waiting for memory is [currently] outside
+ * the scope of send timeout values provided to IPC.
+ */
+#define MACH_MSG_SIZE_RELIABLE ((mach_msg_size_t) 256 * 1024)
+#endif
/*
* Compatibility definitions, for code written
* when there was a msgh_kind instead of msgh_seqno.
#define msgh_kind msgh_seqno
#define mach_msg_kind_t mach_port_seqno_t
-/*
- * The msgt_number field specifies the number of data elements.
- * The msgt_size field specifies the size of each data element, in bits.
- * The msgt_name field specifies the type of each data element.
- * If msgt_inline is TRUE, the data follows the type descriptor
- * in the body of the message. If msgt_inline is FALSE, then a pointer
- * to the data should follow the type descriptor, and the data is
- * sent out-of-line. In this case, if msgt_deallocate is TRUE,
- * then the out-of-line data is moved (instead of copied) into the message.
- * If msgt_longform is TRUE, then the type descriptor is actually
- * a mach_msg_type_long_t.
- *
- * The actual amount of inline data following the descriptor must
- * a multiple of the word size. For out-of-line data, this is a
- * pointer. For inline data, the supplied data size (calculated
- * from msgt_number/msgt_size) is rounded up. This guarantees
- * that type descriptors always fall on word boundaries.
- *
- * For port rights, msgt_size must be 8*sizeof(mach_port_t).
- * If the data is inline, msgt_deallocate should be FALSE.
- * The msgt_unused bit should be zero.
- * The msgt_name, msgt_size, msgt_number fields in
- * a mach_msg_type_long_t should be zero.
- */
-
typedef natural_t mach_msg_type_size_t;
typedef natural_t mach_msg_type_number_t;
#define MACH_SEND_MSG 0x00000001
#define MACH_RCV_MSG 0x00000002
-#define MACH_RCV_LARGE 0x00000004
-#define MACH_SEND_TIMEOUT 0x00000010
-#define MACH_SEND_INTERRUPT 0x00000040 /* libmach implements */
-#define MACH_SEND_CANCEL 0x00000080
-#define MACH_SEND_ALWAYS 0x00010000 /* internal use only */
-#define MACH_SEND_TRAILER 0x00020000
+#define MACH_RCV_LARGE 0x00000004 /* report large message sizes */
+#define MACH_RCV_LARGE_IDENTITY 0x00000008 /* identify source of large messages */
+
+#define MACH_SEND_TIMEOUT 0x00000010 /* timeout value applies to send */
+#define MACH_SEND_INTERRUPT 0x00000040 /* don't restart interrupted sends */
+#define MACH_SEND_NOTIFY 0x00000080 /* arm send-possible notify */
+#define MACH_SEND_ALWAYS 0x00010000 /* ignore qlimits - kernel only */
+#define MACH_SEND_TRAILER 0x00020000 /* sender-provided trailer */
+#define MACH_SEND_NOIMPORTANCE 0x00040000 /* msg won't carry importance */
+#define MACH_SEND_IMPORTANCE 0x00080000 /* msg carries importance - kernel only */
+
-#define MACH_RCV_TIMEOUT 0x00000100
-#define MACH_RCV_NOTIFY 0x00000200
-#define MACH_RCV_INTERRUPT 0x00000400 /* libmach implements */
-#define MACH_RCV_OVERWRITE 0x00001000
+#define MACH_RCV_TIMEOUT 0x00000100 /* timeout value applies to receive */
+#define MACH_RCV_NOTIFY 0x00000200 /* reserved - legacy */
+#define MACH_RCV_INTERRUPT 0x00000400 /* don't restart interrupted receive */
+#define MACH_RCV_OVERWRITE 0x00001000 /* scatter receive */
/*
* NOTE: a 0x00------ RCV mask implies to ask for
* a MACH_MSG_TRAILER_FORMAT_0 with 0 Elements,
* which is equivalent to a mach_msg_trailer_t.
+ *
+ * XXXMAC: unlike the rest of the MACH_RCV_* flags, MACH_RCV_TRAILER_LABELS
+ * needs its own private bit since we only calculate its fields when absolutely
+ * required.
*/
#define MACH_RCV_TRAILER_NULL 0
#define MACH_RCV_TRAILER_SEQNO 1
#define MACH_RCV_TRAILER_SENDER 2
#define MACH_RCV_TRAILER_AUDIT 3
+#define MACH_RCV_TRAILER_CTX 4
+#define MACH_RCV_TRAILER_AV 7
+#define MACH_RCV_TRAILER_LABELS 8
#define MACH_RCV_TRAILER_TYPE(x) (((x) & 0xf) << 28)
#define MACH_RCV_TRAILER_ELEMENTS(x) (((x) & 0xf) << 24)
-#define MACH_RCV_TRAILER_MASK ((0xff << 24))
+#define MACH_RCV_TRAILER_MASK ((0xf << 24))
#define GET_RCV_ELEMENTS(y) (((y) >> 24) & 0xf)
-#define REQUESTED_TRAILER_SIZE(y) \
+
+#ifdef MACH_KERNEL_PRIVATE
+/* The options that the kernel honors when passed from user space */
+#define MACH_SEND_USER (MACH_SEND_MSG | \
+ MACH_SEND_TIMEOUT | MACH_SEND_NOTIFY | \
+ MACH_SEND_TRAILER | MACH_SEND_NOIMPORTANCE )
+
+#define MACH_RCV_USER (MACH_RCV_MSG | \
+ MACH_RCV_TIMEOUT | MACH_RCV_OVERWRITE | \
+ MACH_RCV_LARGE | MACH_RCV_LARGE_IDENTITY | \
+ MACH_RCV_TRAILER_MASK)
+
+#define MACH_MSG_OPTION_USER (MACH_SEND_USER | MACH_RCV_USER)
+
+/* The options implemented by the library interface to mach_msg et. al. */
+#define MACH_MSG_OPTION_LIB (MACH_SEND_INTERRUPT | MACH_RCV_INTERRUPT)
+
+/* Default options to use when sending from the kernel */
+#if 11938665
+ /*
+ * Until we are sure of its effects, we are disabling
+ * importance donation from the kernel-side of user
+ * threads in importance-donating tasks.
+ */
+#define MACH_SEND_KERNEL_DEFAULT (MACH_SEND_MSG | \
+ MACH_SEND_ALWAYS | MACH_SEND_NOIMPORTANCE)
+#else
+#define MACH_SEND_KERNEL_DEFAULT (MACH_SEND_MSG | MACH_SEND_ALWAYS)
+#endif
+
+#endif /* MACH_KERNEL_PRIVATE */
+
+/*
+ * XXXMAC: note that in the case of MACH_RCV_TRAILER_LABELS,
+ * we just fall through to mach_msg_max_trailer_t.
+ * This is correct behavior since mach_msg_max_trailer_t is defined as
+ * mac_msg_mac_trailer_t which is used for the LABELS trailer.
+ * It also makes things work properly if MACH_RCV_TRAILER_LABELS is ORed
+ * with one of the other options.
+ */
+
+#define REQUESTED_TRAILER_SIZE_NATIVE(y) \
((mach_msg_trailer_size_t) \
((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_NULL) ? \
sizeof(mach_msg_trailer_t) : \
sizeof(mach_msg_seqno_trailer_t) : \
((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_SENDER) ? \
sizeof(mach_msg_security_trailer_t) : \
- sizeof(mach_msg_audit_trailer_t)))))
+ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_AUDIT) ? \
+ sizeof(mach_msg_audit_trailer_t) : \
+ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_CTX) ? \
+ sizeof(mach_msg_context_trailer_t) : \
+ ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_AV) ? \
+ sizeof(mach_msg_mac_trailer_t) : \
+ sizeof(mach_msg_max_trailer_t))))))))
+
+
+#ifdef XNU_KERNEL_PRIVATE
+
+#define REQUESTED_TRAILER_SIZE(is64, y) REQUESTED_TRAILER_SIZE_NATIVE(y)
+
+#else /* XNU_KERNEL_PRIVATE */
+#define REQUESTED_TRAILER_SIZE(y) REQUESTED_TRAILER_SIZE_NATIVE(y)
+#endif /* XNU_KERNEL_PRIVATE */
+
/*
* Much code assumes that mach_msg_return_t == kern_return_t.
* This definition is useful for descriptive purposes.
mach_msg_timeout_t timeout,
mach_port_name_t notify);
+#elif defined(MACH_KERNEL_PRIVATE)
+
+extern mach_msg_return_t mach_msg_receive_results(void);
+
#endif /* KERNEL */
__END_DECLS
#endif /* _MACH_MESSAGE_H_ */
+
projects / apple / xnu.git / blobdiff