xnu-792.6.61.tar.gz

[apple/xnu.git] / osfmk / mach / message.h

diff --git a/osfmk/mach/message.h b/osfmk/mach/message.h
index 75d3531deb3a3b995b31377bfd04676eb54df1a8..77f71a4e1de83d096e5c5eabadff5027abcb03cb 100644 (file)
--- a/osfmk/mach/message.h
+++ b/osfmk/mach/message.h
@@ -1,24 +1,21 @@
 /*
 /*

- * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.

  *
  * @APPLE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_LICENSE_HEADER_START@
  * 

- * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
+ * 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. 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
+ * This 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights and
- * limitations under the License.
+ * 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@
  */
  * 
  * @APPLE_LICENSE_HEADER_END@
  */


@@ -61,23 +58,14 @@
 #ifndef        _MACH_MESSAGE_H_
 #define _MACH_MESSAGE_H_
 
 #ifndef        _MACH_MESSAGE_H_
 #define _MACH_MESSAGE_H_
 

-#ifdef MACH_KERNEL
-/* Have to have MIG parameter check for kernel */
-#define TypeCheck 1
-#define _MIG_KERNEL_SPECIFIC_CODE_ 1
-#endif /* MACH_KERNEL */
-
-/* static templates are slower and bigger */
-/* #define UseStaticTemplates 0 */
-
-#include <sys/appleapiopts.h>
-

 #include <stdint.h>
 #include <mach/port.h>
 #include <mach/boolean.h>
 #include <mach/kern_return.h>
 #include <mach/machine/vm_types.h>
 
 #include <stdint.h>
 #include <mach/port.h>
 #include <mach/boolean.h>
 #include <mach/kern_return.h>
 #include <mach/machine/vm_types.h>
 

+#include <sys/cdefs.h>
+

 /*
  *  The timeout mechanism uses mach_msg_timeout_t values,
  *  passed by value.  The timeout units are milliseconds.
 /*
  *  The timeout mechanism uses mach_msg_timeout_t values,
  *  passed by value.  The timeout units are milliseconds.


@@ -202,10 +190,11 @@ typedef unsigned int mach_msg_descriptor_type_t;
 #define MACH_MSG_OOL_PORTS_DESCRIPTOR          2
 #define MACH_MSG_OOL_VOLATILE_DESCRIPTOR       3
 
 #define MACH_MSG_OOL_PORTS_DESCRIPTOR          2
 #define MACH_MSG_OOL_VOLATILE_DESCRIPTOR       3
 

+#pragma pack(4)

 
 typedef struct
 {
 
 typedef struct
 {

-  void*                                pad1;
+  natural_t                    pad1;

   mach_msg_size_t              pad2;
   unsigned int                 pad3 : 24;
   mach_msg_descriptor_type_t   type : 8;
   mach_msg_size_t              pad2;
   unsigned int                 pad3 : 24;
   mach_msg_descriptor_type_t   type : 8;


@@ -222,24 +211,79 @@ typedef struct
 
 typedef struct
 {
 
 typedef struct
 {

-  void* address;
+  uint32_t                     address;
+  mach_msg_size_t              size;
+  boolean_t                    deallocate: 8;
+  mach_msg_copy_options_t       copy: 8;
+  unsigned int                 pad1: 8;
+  mach_msg_descriptor_type_t    type: 8;
+} mach_msg_ool_descriptor32_t;
+
+typedef struct
+{
+  uint64_t                     address;
+  boolean_t                    deallocate: 8;
+  mach_msg_copy_options_t       copy: 8;
+  unsigned int                 pad1: 8;
+  mach_msg_descriptor_type_t    type: 8;
+  mach_msg_size_t              size;
+} mach_msg_ool_descriptor64_t;
+
+typedef struct
+{
+  void*                                address;
+#if !defined(__LP64__)

   mach_msg_size_t              size;
   mach_msg_size_t              size;

+#endif

   boolean_t                    deallocate: 8;
   mach_msg_copy_options_t       copy: 8;
   unsigned int                 pad1: 8;
   mach_msg_descriptor_type_t    type: 8;
   boolean_t                    deallocate: 8;
   mach_msg_copy_options_t       copy: 8;
   unsigned int                 pad1: 8;
   mach_msg_descriptor_type_t    type: 8;

+#if defined(__LP64__)
+  mach_msg_size_t              size;
+#endif

 } mach_msg_ool_descriptor_t;
 
 } mach_msg_ool_descriptor_t;
 

+typedef struct
+{
+  uint32_t                     address;
+  mach_msg_size_t              count;
+  boolean_t                    deallocate: 8;
+  mach_msg_copy_options_t       copy: 8;
+  mach_msg_type_name_t         disposition : 8;
+  mach_msg_descriptor_type_t   type : 8;
+} mach_msg_ool_ports_descriptor32_t;
+
+typedef struct
+{
+  uint64_t                     address;
+  boolean_t                    deallocate: 8;
+  mach_msg_copy_options_t       copy: 8;
+  mach_msg_type_name_t         disposition : 8;
+  mach_msg_descriptor_type_t   type : 8;
+  mach_msg_size_t              count;
+} mach_msg_ool_ports_descriptor64_t;
+

 typedef struct
 {
   void*                                address;
 typedef struct
 {
   void*                                address;

+#if !defined(__LP64__)

   mach_msg_size_t              count;
   mach_msg_size_t              count;

+#endif

   boolean_t                    deallocate: 8;
   mach_msg_copy_options_t       copy: 8;
   mach_msg_type_name_t         disposition : 8;
   mach_msg_descriptor_type_t   type : 8;
   boolean_t                    deallocate: 8;
   mach_msg_copy_options_t       copy: 8;
   mach_msg_type_name_t         disposition : 8;
   mach_msg_descriptor_type_t   type : 8;

+#if defined(__LP64__)
+  mach_msg_size_t              count;
+#endif

 } mach_msg_ool_ports_descriptor_t;
 
 } mach_msg_ool_ports_descriptor_t;
 

+/*
+ * LP64support - This union definition is not really
+ * appropriate in LP64 mode because not all descriptors
+ * are of the same size in that environment.
+ */

 typedef union
 {
   mach_msg_port_descriptor_t           port;
 typedef union
 {
   mach_msg_port_descriptor_t           port;


@@ -306,15 +350,59 @@ typedef struct
   security_token_t             msgh_sender;
 } mach_msg_security_trailer_t;
 
   security_token_t             msgh_sender;
 } mach_msg_security_trailer_t;
 

-typedef mach_msg_security_trailer_t mach_msg_format_0_trailer_t;
+/*
+ * The audit token is an opaque token which identifies
+ * Mach tasks and senders of Mach messages as subjects
+ * to the BSM audit system.  Only the appropriate BSM
+ * library routines should be used to interpret the
+ * contents of the audit token as the representation
+ * of the subject identity within the token may change
+ * over time.
+ */
+typedef struct
+{
+  unsigned int                 val[8];
+} audit_token_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_msg_audit_trailer_t;

 
 

-#define MACH_MSG_TRAILER_FORMAT_0_SIZE sizeof(mach_msg_format_0_trailer_t)

 #define MACH_MSG_TRAILER_MINIMUM_SIZE  sizeof(mach_msg_trailer_t)
 #define MACH_MSG_TRAILER_MINIMUM_SIZE  sizeof(mach_msg_trailer_t)

-#define MAX_TRAILER_SIZE              MACH_MSG_TRAILER_FORMAT_0_SIZE   
+
+/*
+ * These values can change from release to release - but clearly
+ * code cannot request additional trailer elements one was not
+ * compiled to understand.  Therefore, it is safe to use this
+ * constant when the same module specified the receive options.
+ * Otherwise, you run the risk that the options requested by
+ * 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)
+
+/*
+ * Legacy requirements keep us from ever updating these defines (even
+ * when the format_0 trailers gain new option data fields in the future).
+ * Therefore, they shouldn't be used going forward.  Instead, the sizes
+ * should be compared against the specific element size requested using
+ * REQUESTED_TRAILER_SIZE.
+ */
+typedef mach_msg_security_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} }
 extern security_token_t KERNEL_SECURITY_TOKEN;
 
 
 #define   KERNEL_SECURITY_TOKEN_VALUE  { {0, 1} }
 extern security_token_t KERNEL_SECURITY_TOKEN;
 

+#define   KERNEL_AUDIT_TOKEN_VALUE  { {0, 0, 0, 0, 0, 0, 0, 0} }
+extern audit_token_t KERNEL_AUDIT_TOKEN;
+

 typedef        integer_t mach_msg_options_t;
 
 typedef struct
 typedef        integer_t mach_msg_options_t;
 
 typedef struct


@@ -334,6 +422,8 @@ typedef union
   mach_msg_empty_rcv_t rcv;
 } mach_msg_empty_t;
 
   mach_msg_empty_rcv_t rcv;
 } mach_msg_empty_t;
 

+#pragma pack()
+

 /* utility to round the message size - will become machine dependent */
 #define round_msg(x)   (((mach_msg_size_t)(x) + sizeof (natural_t) - 1) & \
                                ~(sizeof (natural_t) - 1))
 /* utility to round the message size - will become machine dependent */
 #define round_msg(x)   (((mach_msg_size_t)(x) + sizeof (natural_t) - 1) & \
                                ~(sizeof (natural_t) - 1))


@@ -344,7 +434,6 @@ typedef union
 
 #define        MACH_MSG_SIZE_MAX       ((mach_msg_size_t) ~0)
 
 
 #define        MACH_MSG_SIZE_MAX       ((mach_msg_size_t) ~0)
 

-#ifdef __APPLE_API_OBSOLETE

 /*
  *  Compatibility definitions, for code written
  *  when there was a msgh_kind instead of msgh_seqno.
 /*
  *  Compatibility definitions, for code written
  *  when there was a msgh_kind instead of msgh_seqno.


@@ -353,7 +442,6 @@ typedef union
 #define MACH_MSGH_KIND_NOTIFICATION    0x00000001
 #define        msgh_kind                       msgh_seqno
 #define mach_msg_kind_t                        mach_port_seqno_t
 #define MACH_MSGH_KIND_NOTIFICATION    0x00000001
 #define        msgh_kind                       msgh_seqno
 #define mach_msg_kind_t                        mach_port_seqno_t

-#endif  /* __APPLE_API_OBSOLETE */

 
 /*
  *  The msgt_number field specifies the number of data elements.
 
 /*
  *  The msgt_number field specifies the number of data elements.


@@ -451,6 +539,7 @@ typedef integer_t mach_msg_option_t;
 #define MACH_RCV_TRAILER_NULL   0
 #define MACH_RCV_TRAILER_SEQNO  1
 #define MACH_RCV_TRAILER_SENDER 2
 #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_TYPE(x)     (((x) & 0xf) << 28) 
 #define MACH_RCV_TRAILER_ELEMENTS(x) (((x) & 0xf) << 24)  
 
 #define MACH_RCV_TRAILER_TYPE(x)     (((x) & 0xf) << 28) 
 #define MACH_RCV_TRAILER_ELEMENTS(x) (((x) & 0xf) << 24)  


@@ -463,7 +552,9 @@ typedef integer_t mach_msg_option_t;
          sizeof(mach_msg_trailer_t) :                          \
          ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_SEQNO) ?    \
           sizeof(mach_msg_seqno_trailer_t) :                   \
          sizeof(mach_msg_trailer_t) :                          \
          ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_SEQNO) ?    \
           sizeof(mach_msg_seqno_trailer_t) :                   \

-          sizeof(mach_msg_security_trailer_t))))
+         ((GET_RCV_ELEMENTS(y) == MACH_RCV_TRAILER_SENDER) ?   \
+          sizeof(mach_msg_security_trailer_t) :                \
+          sizeof(mach_msg_audit_trailer_t)))))

 /*
  *  Much code assumes that mach_msg_return_t == kern_return_t.
  *  This definition is useful for descriptive purposes.
 /*
  *  Much code assumes that mach_msg_return_t == kern_return_t.
  *  This definition is useful for descriptive purposes.


@@ -557,6 +648,9 @@ typedef kern_return_t mach_msg_return_t;
 #define MACH_RCV_IN_PROGRESS_TIMED      0x10004011
                 /* Waiting for receive with timeout. (Internal use only.) */
 
 #define MACH_RCV_IN_PROGRESS_TIMED      0x10004011
                 /* Waiting for receive with timeout. (Internal use only.) */
 

+
+__BEGIN_DECLS
+

 /*
  *     Routine:        mach_msg_overwrite
  *     Purpose:
 /*
  *     Routine:        mach_msg_overwrite
  *     Purpose:


@@ -573,18 +667,6 @@ typedef kern_return_t mach_msg_return_t;
  *             already contain scatter control information to direct the
  *             receiving of the message.
  */
  *             already contain scatter control information to direct the
  *             receiving of the message.
  */

-#ifdef __APPLE_API_PRIVATE
-extern mach_msg_return_t       mach_msg_overwrite_trap(
-                                       mach_msg_header_t *msg,
-                                       mach_msg_option_t option,
-                                       mach_msg_size_t send_size,
-                                       mach_msg_size_t rcv_size,
-                                       mach_port_name_t rcv_name,
-                                       mach_msg_timeout_t timeout,
-                                       mach_port_name_t notify,
-                                       mach_msg_header_t *rcv_msg,
-                                       mach_msg_size_t rcv_limit);
-#endif /* __APPLE_API_PRIVATE */

 
 extern mach_msg_return_t       mach_msg_overwrite(
                                        mach_msg_header_t *msg,
 
 extern mach_msg_return_t       mach_msg_overwrite(
                                        mach_msg_header_t *msg,


@@ -597,6 +679,8 @@ extern mach_msg_return_t    mach_msg_overwrite(
                                        mach_msg_header_t *rcv_msg,
                                        mach_msg_size_t rcv_limit);
 
                                        mach_msg_header_t *rcv_msg,
                                        mach_msg_size_t rcv_limit);
 

+#ifndef        KERNEL
+

 /*
  *     Routine:        mach_msg
  *     Purpose:
 /*
  *     Routine:        mach_msg
  *     Purpose:


@@ -605,17 +689,6 @@ extern mach_msg_return_t   mach_msg_overwrite(
  *             of that fact, then restart the appropriate parts of the
  *             operation silently (trap version does not restart).
  */
  *             of that fact, then restart the appropriate parts of the
  *             operation silently (trap version does not restart).
  */

-#ifdef __APPLE_API_PRIVATE 
-extern mach_msg_return_t       mach_msg_trap(
-                                       mach_msg_header_t *msg,
-                                       mach_msg_option_t option,
-                                       mach_msg_size_t send_size,
-                                       mach_msg_size_t rcv_size,
-                                       mach_port_name_t rcv_name,
-                                       mach_msg_timeout_t timeout,
-                                       mach_port_name_t notify);
-#endif /* __APPLE_API_PRIVATE */
-

 extern mach_msg_return_t       mach_msg(
                                        mach_msg_header_t *msg,
                                        mach_msg_option_t option,
 extern mach_msg_return_t       mach_msg(
                                        mach_msg_header_t *msg,
                                        mach_msg_option_t option,


@@ -625,4 +698,8 @@ extern mach_msg_return_t    mach_msg(
                                        mach_msg_timeout_t timeout,
                                        mach_port_name_t notify);
 
                                        mach_msg_timeout_t timeout,
                                        mach_port_name_t notify);
 

+#endif /* KERNEL */
+
+__END_DECLS
+

 #endif /* _MACH_MESSAGE_H_ */
 #endif /* _MACH_MESSAGE_H_ */