xnu-4570.71.2.tar.gz

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

diff --git a/osfmk/mach/port.h b/osfmk/mach/port.h
index a2af7172f7dbedf07ba3852efebeb8d354d7513e..30b55a1b09f0adad7b3ecf1507d5a771eaadd298 100644 (file)
--- a/osfmk/mach/port.h
+++ b/osfmk/mach/port.h
@@ -1,31 +1,29 @@
 /*
 /*

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

  *
  *

- * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
+ * @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, 
- * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
- * Please see the License for the specific language governing rights and 
+ * 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,
+ * 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.
  * limitations under the License.

- *
- * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
+ * 
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  * @OSF_COPYRIGHT@
  */
 /*
  * @OSF_COPYRIGHT@


@@ -55,6 +53,12 @@
  * 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.
  */

+/*
+ * 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.
+ */

 /*
  */
 /*
 /*
  */
 /*


@@ -82,6 +86,7 @@
 #ifndef        _MACH_PORT_H_
 #define _MACH_PORT_H_
 
 #ifndef        _MACH_PORT_H_
 #define _MACH_PORT_H_
 

+#include <sys/cdefs.h>

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


@@ -101,7 +106,7 @@
 typedef natural_t mach_port_name_t;
 typedef mach_port_name_t *mach_port_name_array_t;
 
 typedef natural_t mach_port_name_t;
 typedef mach_port_name_t *mach_port_name_array_t;
 

-#ifdef KERNEL_PRIVATE
+#ifdef KERNEL

 
 /* 
  *     mach_port_t - a named port right
 
 /* 
  *     mach_port_t - a named port right


@@ -135,14 +140,22 @@ struct ipc_port ;
 
 typedef struct ipc_port                *ipc_port_t;
 
 
 typedef struct ipc_port                *ipc_port_t;
 

-#define IPC_PORT_NULL          ((ipc_port_t) 0)
-#define IPC_PORT_DEAD          ((ipc_port_t)~0)
+#define IPC_PORT_NULL          ((ipc_port_t) 0UL)
+#define IPC_PORT_DEAD          ((ipc_port_t)~0UL)

 #define IPC_PORT_VALID(port) \
        ((port) != IPC_PORT_NULL && (port) != IPC_PORT_DEAD)
 
 typedef ipc_port_t             mach_port_t;
 
 #define IPC_PORT_VALID(port) \
        ((port) != IPC_PORT_NULL && (port) != IPC_PORT_DEAD)
 
 typedef ipc_port_t             mach_port_t;
 

-#else  /* KERNEL_PRIVATE */
+/*
+ * Since the 32-bit and 64-bit representations of ~0 are different,
+ * explicitly handle MACH_PORT_DEAD
+ */
+
+#define CAST_MACH_PORT_TO_NAME(x) ((mach_port_name_t)(uintptr_t)(x))
+#define CAST_MACH_NAME_TO_PORT(x) ((x) == MACH_PORT_DEAD ? (mach_port_t)IPC_PORT_DEAD : (mach_port_t)(uintptr_t)(x))
+
+#else  /* KERNEL */

 
 /* 
  *     mach_port_t - a named port right
 
 /* 
  *     mach_port_t - a named port right


@@ -160,12 +173,10 @@ typedef ipc_port_t                mach_port_t;
  *
  */
 
  *
  */
 

-#ifndef _MACH_PORT_T
-#define _MACH_PORT_T
-typedef mach_port_name_t               mach_port_t;
-#endif
+#include <sys/_types.h>
+#include <sys/_types/_mach_port_t.h>

 
 

-#endif /* KERNEL_PRIVATE */
+#endif /* KERNEL */

 
 typedef mach_port_t                    *mach_port_array_t;
 
 
 typedef mach_port_t                    *mach_port_array_t;
 


@@ -232,7 +243,8 @@ typedef natural_t mach_port_right_t;
 #define MACH_PORT_RIGHT_SEND_ONCE      ((mach_port_right_t) 2)
 #define MACH_PORT_RIGHT_PORT_SET       ((mach_port_right_t) 3)
 #define MACH_PORT_RIGHT_DEAD_NAME      ((mach_port_right_t) 4)
 #define MACH_PORT_RIGHT_SEND_ONCE      ((mach_port_right_t) 2)
 #define MACH_PORT_RIGHT_PORT_SET       ((mach_port_right_t) 3)
 #define MACH_PORT_RIGHT_DEAD_NAME      ((mach_port_right_t) 4)

-#define MACH_PORT_RIGHT_NUMBER         ((mach_port_right_t) 5)
+#define MACH_PORT_RIGHT_LABELH         ((mach_port_right_t) 5)
+#define MACH_PORT_RIGHT_NUMBER         ((mach_port_right_t) 6)

 
 typedef natural_t mach_port_type_t;
 typedef mach_port_type_t *mach_port_type_array_t;
 
 typedef natural_t mach_port_type_t;
 typedef mach_port_type_t *mach_port_type_array_t;


@@ -246,6 +258,7 @@ typedef mach_port_type_t *mach_port_type_array_t;
 #define MACH_PORT_TYPE_SEND_ONCE    MACH_PORT_TYPE(MACH_PORT_RIGHT_SEND_ONCE)
 #define MACH_PORT_TYPE_PORT_SET            MACH_PORT_TYPE(MACH_PORT_RIGHT_PORT_SET)
 #define MACH_PORT_TYPE_DEAD_NAME    MACH_PORT_TYPE(MACH_PORT_RIGHT_DEAD_NAME)
 #define MACH_PORT_TYPE_SEND_ONCE    MACH_PORT_TYPE(MACH_PORT_RIGHT_SEND_ONCE)
 #define MACH_PORT_TYPE_PORT_SET            MACH_PORT_TYPE(MACH_PORT_RIGHT_PORT_SET)
 #define MACH_PORT_TYPE_DEAD_NAME    MACH_PORT_TYPE(MACH_PORT_RIGHT_DEAD_NAME)

+#define MACH_PORT_TYPE_LABELH       MACH_PORT_TYPE(MACH_PORT_RIGHT_LABELH)

 
 /* Convenient combinations. */
 
 
 /* Convenient combinations. */
 


@@ -262,7 +275,9 @@ typedef mach_port_type_t *mach_port_type_array_t;
 
 /* Dummy type bits that mach_port_type/mach_port_names can return. */
 
 
 /* Dummy type bits that mach_port_type/mach_port_names can return. */
 

-#define MACH_PORT_TYPE_DNREQUEST       0x80000000
+#define MACH_PORT_TYPE_DNREQUEST               0x80000000
+#define MACH_PORT_TYPE_SPREQUEST               0x40000000
+#define MACH_PORT_TYPE_SPREQUEST_DELAYED       0x20000000

 
 /* User-references for capabilities. */
 
 
 /* User-references for capabilities. */
 


@@ -284,7 +299,7 @@ typedef natural_t mach_port_rights_t;               /* number of rights */
 typedef unsigned int mach_port_srights_t;      /* status of send rights */
 
 typedef struct mach_port_status {
 typedef unsigned int mach_port_srights_t;      /* status of send rights */
 
 typedef struct mach_port_status {

-       mach_port_name_t        mps_pset;       /* containing port set */
+       mach_port_rights_t      mps_pset;       /* count of containing port sets */

        mach_port_seqno_t       mps_seqno;      /* sequence number */
        mach_port_mscount_t     mps_mscount;    /* make-send count */
        mach_port_msgcount_t    mps_qlimit;     /* queue limit */
        mach_port_seqno_t       mps_seqno;      /* sequence number */
        mach_port_mscount_t     mps_mscount;    /* make-send count */
        mach_port_msgcount_t    mps_qlimit;     /* queue limit */


@@ -296,39 +311,108 @@ typedef struct mach_port_status {
        natural_t               mps_flags;              /* port flags */
 } mach_port_status_t;
 
        natural_t               mps_flags;              /* port flags */
 } mach_port_status_t;
 

-#define MACH_PORT_QLIMIT_DEFAULT       ((mach_port_msgcount_t) 5)
-#define MACH_PORT_QLIMIT_MAX   ((mach_port_msgcount_t) 16)
+/* System-wide values for setting queue limits on a port */
+#define MACH_PORT_QLIMIT_ZERO          (0)
+#define MACH_PORT_QLIMIT_BASIC         (5)
+#define MACH_PORT_QLIMIT_SMALL         (16)
+#define MACH_PORT_QLIMIT_LARGE         (1024)
+#define MACH_PORT_QLIMIT_KERNEL                (65534)
+#define MACH_PORT_QLIMIT_MIN           MACH_PORT_QLIMIT_ZERO
+#define MACH_PORT_QLIMIT_DEFAULT       MACH_PORT_QLIMIT_BASIC
+#define MACH_PORT_QLIMIT_MAX           MACH_PORT_QLIMIT_LARGE

 
 typedef struct mach_port_limits {
        mach_port_msgcount_t    mpl_qlimit;     /* number of msgs */
 } mach_port_limits_t;
 
 
 typedef struct mach_port_limits {
        mach_port_msgcount_t    mpl_qlimit;     /* number of msgs */
 } mach_port_limits_t;
 

+/* Possible values for mps_flags (part of mach_port_status_t) */
+#define MACH_PORT_STATUS_FLAG_TEMPOWNER                0x01
+#define MACH_PORT_STATUS_FLAG_GUARDED          0x02
+#define MACH_PORT_STATUS_FLAG_STRICT_GUARD     0x04
+#define MACH_PORT_STATUS_FLAG_IMP_DONATION     0x08
+#define MACH_PORT_STATUS_FLAG_REVIVE           0x10
+#define MACH_PORT_STATUS_FLAG_TASKPTR          0x20
+
+typedef struct mach_port_info_ext {
+       mach_port_status_t      mpie_status;
+       mach_port_msgcount_t    mpie_boost_cnt;
+       uint32_t                reserved[6];
+} mach_port_info_ext_t;
+

 typedef integer_t *mach_port_info_t;           /* varying array of natural_t */
 
 /* Flavors for mach_port_get/set_attributes() */
 typedef int    mach_port_flavor_t;
 typedef integer_t *mach_port_info_t;           /* varying array of natural_t */
 
 /* Flavors for mach_port_get/set_attributes() */
 typedef int    mach_port_flavor_t;

-#define MACH_PORT_LIMITS_INFO          1       /* uses mach_port_status_t */
-#define MACH_PORT_RECEIVE_STATUS       2       /* uses mach_port_limits_t */
+#define MACH_PORT_LIMITS_INFO          1       /* uses mach_port_limits_t */
+#define MACH_PORT_RECEIVE_STATUS       2       /* uses mach_port_status_t */

 #define MACH_PORT_DNREQUESTS_SIZE      3       /* info is int */
 #define MACH_PORT_DNREQUESTS_SIZE      3       /* info is int */

+#define MACH_PORT_TEMPOWNER            4       /* indicates receive right will be reassigned to another task */
+#define MACH_PORT_IMPORTANCE_RECEIVER  5       /* indicates recieve right accepts priority donation */
+#define MACH_PORT_DENAP_RECEIVER       6       /* indicates receive right accepts de-nap donation */
+#define MACH_PORT_INFO_EXT             7       /* uses mach_port_info_ext_t */

 
 #define MACH_PORT_LIMITS_INFO_COUNT    ((natural_t) \
        (sizeof(mach_port_limits_t)/sizeof(natural_t)))
 #define MACH_PORT_RECEIVE_STATUS_COUNT ((natural_t) \
        (sizeof(mach_port_status_t)/sizeof(natural_t)))
 #define MACH_PORT_DNREQUESTS_SIZE_COUNT 1
 
 #define MACH_PORT_LIMITS_INFO_COUNT    ((natural_t) \
        (sizeof(mach_port_limits_t)/sizeof(natural_t)))
 #define MACH_PORT_RECEIVE_STATUS_COUNT ((natural_t) \
        (sizeof(mach_port_status_t)/sizeof(natural_t)))
 #define MACH_PORT_DNREQUESTS_SIZE_COUNT 1

-
+#define MACH_PORT_INFO_EXT_COUNT       ((natural_t) \
+       (sizeof(mach_port_info_ext_t)/sizeof(natural_t)))

 /*
  * Structure used to pass information about port allocation requests.
  * Must be padded to 64-bits total length.
  */
 typedef struct mach_port_qos {
 /*
  * Structure used to pass information about port allocation requests.
  * Must be padded to 64-bits total length.
  */
 typedef struct mach_port_qos {

-       boolean_t               name:1;         /* name given */
-       boolean_t               prealloc:1;     /* prealloced message */
+       unsigned int            name:1;         /* name given */
+       unsigned int            prealloc:1;     /* prealloced message */

        boolean_t               pad1:30;
        natural_t               len;
 } mach_port_qos_t;
 
        boolean_t               pad1:30;
        natural_t               len;
 } mach_port_qos_t;
 

-#if    !defined(_POSIX_C_SOURCE) && !defined(_NO_PORT_T_FROM_MACH)
+/* Mach Port Guarding definitions */
+
+/*
+ * Flags for mach_port_options (used for
+ * invocation of mach_port_construct).
+ * Indicates attributes to be set for the newly
+ * allocated port.
+ */
+#define MPO_CONTEXT_AS_GUARD   0x01    /* Add guard to the port */
+#define MPO_QLIMIT             0x02    /* Set qlimit for the port msg queue */
+#define MPO_TEMPOWNER          0x04    /* Set the tempowner bit of the port */
+#define MPO_IMPORTANCE_RECEIVER 0x08   /* Mark the port as importance receiver */
+#define MPO_INSERT_SEND_RIGHT   0x10   /* Insert a send right for the port */
+#define MPO_STRICT             0x20    /* Apply strict guarding for port */
+#define MPO_DENAP_RECEIVER     0x40    /* Mark the port as App de-nap receiver */
+/*
+ * Structure to define optional attributes for a newly
+ * constructed port.
+ */
+typedef struct mach_port_options {
+       uint32_t                flags;          /* Flags defining attributes for port */
+       mach_port_limits_t      mpl;            /* Message queue limit for port */
+       uint64_t                reserved[2];    /* Reserved */
+}mach_port_options_t;
+
+typedef mach_port_options_t *mach_port_options_ptr_t;
+
+/*
+ * EXC_GUARD represents a guard violation for both
+ * mach ports and file descriptors. GUARD_TYPE_ is used
+ * to differentiate among them.
+ */
+#define GUARD_TYPE_MACH_PORT   0x1
+
+/* Reasons for exception for a guarded mach port */
+enum mach_port_guard_exception_codes {
+       kGUARD_EXC_DESTROY              = 1u << 0,
+       kGUARD_EXC_MOD_REFS             = 1u << 1,
+       kGUARD_EXC_SET_CONTEXT          = 1u << 2,
+       kGUARD_EXC_UNGUARDED            = 1u << 3,
+       kGUARD_EXC_INCORRECT_GUARD      = 1u << 4
+};
+
+#if    !__DARWIN_UNIX03 && !defined(_NO_PORT_T_FROM_MACH)

 /*
  *  Mach 3.0 renamed everything to have mach_ in front of it.
  *  These types and macros are provided for backward compatibility
 /*
  *  Mach 3.0 renamed everything to have mach_ in front of it.
  *  These types and macros are provided for backward compatibility


@@ -343,6 +427,6 @@ typedef mach_port_name_t    *port_name_array_t;
 #define PORT_VALID(name) \
                ((port_t)(name) != PORT_NULL && (port_t)(name) != PORT_DEAD)
 
 #define PORT_VALID(name) \
                ((port_t)(name) != PORT_NULL && (port_t)(name) != PORT_DEAD)
 

-#endif /* !_POSIX_C_SOURCE && !_NO_PORT_T_FROM_MACH */
+#endif /* !__DARWIN_UNIX03 && !_NO_PORT_T_FROM_MACH */

 
 #endif /* _MACH_PORT_H_ */
 
 #endif /* _MACH_PORT_H_ */