xnu-2422.90.20.tar.gz

[apple/xnu.git] / osfmk / ipc / ipc_object.h

diff --git a/osfmk/ipc/ipc_object.h b/osfmk/ipc/ipc_object.h
index 62a11978a5caedc1f02c4e23ca93ae5bc37b6c7f..e040b4be3548e13f9d642ba65debf20c5534fdca 100644 (file)
--- a/osfmk/ipc/ipc_object.h
+++ b/osfmk/ipc/ipc_object.h
@@ -1,23 +1,29 @@
 /*
 /*

- * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 2000-2007 Apple 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,
  * 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@
  */
 /*
  * @OSF_COPYRIGHT@


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

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


@@ -61,8 +73,6 @@
 #define _IPC_IPC_OBJECT_H_
 
 #include <mach_rt.h>
 #define _IPC_IPC_OBJECT_H_
 
 #include <mach_rt.h>

-#include <cpus.h>
-#include <mach_kdb.h>

 
 #include <mach/kern_return.h>
 #include <mach/message.h>
 
 #include <mach/kern_return.h>
 #include <mach/message.h>


@@ -70,14 +80,13 @@
 #include <kern/macro_help.h>
 #include <kern/zalloc.h>
 #include <ipc/ipc_types.h>
 #include <kern/macro_help.h>
 #include <kern/zalloc.h>
 #include <ipc/ipc_types.h>

+#include <libkern/OSAtomic.h>

 
 typedef natural_t ipc_object_refs_t;   /* for ipc/ipc_object.h         */
 typedef natural_t ipc_object_bits_t;
 typedef natural_t ipc_object_type_t;
 
 /*
 
 typedef natural_t ipc_object_refs_t;   /* for ipc/ipc_object.h         */
 typedef natural_t ipc_object_bits_t;
 typedef natural_t ipc_object_type_t;
 
 /*

- * There is no lock in the ipc_object; it is in the enclosing kernel
- * data structure (rpc_common_data) used by both ipc_port and ipc_pset.

  * The ipc_object is used to both tag and reference count these two data
  * structures, and (Noto Bene!) pointers to either of these or the
  * ipc_object at the head of these are freely cast back and forth; hence
  * The ipc_object is used to both tag and reference count these two data
  * structures, and (Noto Bene!) pointers to either of these or the
  * ipc_object at the head of these are freely cast back and forth; hence


@@ -89,13 +98,20 @@ typedef natural_t ipc_object_type_t;
  * (with which lock size varies).
  */
 struct ipc_object {
  * (with which lock size varies).
  */
 struct ipc_object {

+       ipc_object_bits_t io_bits;

        ipc_object_refs_t io_references;
        ipc_object_refs_t io_references;

+       lck_spin_t      io_lock_data;
+};
+
+/*
+ * If another object type needs to participate in io_kotype()-based
+ * dispatching, it must include a stub structure as the first
+ * element
+ */
+struct ipc_object_header {

        ipc_object_bits_t io_bits;
        ipc_object_bits_t io_bits;

-       port_name_t       io_receiver_name;
-#if NCPUS == 1
-       usimple_lock_data_t     io_lock_data;
-#else
-       decl_mutex_data(,       io_lock_data)
+#ifdef __LP64__
+       natural_t         io_padding; /* pad to natural boundary */

 #endif
 };
 
 #endif
 };
 


@@ -103,7 +119,7 @@ struct ipc_object {
  * Legacy defines.  Should use IPC_OBJECT_NULL, etc...
  */
 #define        IO_NULL                 ((ipc_object_t) 0)
  * Legacy defines.  Should use IPC_OBJECT_NULL, etc...
  */
 #define        IO_NULL                 ((ipc_object_t) 0)

-#define        IO_DEAD                 ((ipc_object_t) -1)
+#define        IO_DEAD                 ((ipc_object_t) ~0UL)

 #define        IO_VALID(io)            (((io) != IO_NULL) && ((io) != IO_DEAD))
 
 /*
 #define        IO_VALID(io)            (((io) != IO_NULL) && ((io) != IO_DEAD))
 
 /*


@@ -120,7 +136,7 @@ struct ipc_object {
 #define IO_BITS_OTYPE          0x7fff0000      /* determines a zone */
 #define        IO_BITS_ACTIVE          0x80000000      /* is object alive? */
 
 #define IO_BITS_OTYPE          0x7fff0000      /* determines a zone */
 #define        IO_BITS_ACTIVE          0x80000000      /* is object alive? */
 

-#define        io_active(io)           ((io)->io_bits & IO_BITS_ACTIVE)
+#define        io_active(io)           (((io)->io_bits & IO_BITS_ACTIVE) != 0)

 
 #define        io_otype(io)            (((io)->io_bits & IO_BITS_OTYPE) >> 16)
 #define        io_kotype(io)           ((io)->io_bits & IO_BITS_KOTYPE)
 
 #define        io_otype(io)            (((io)->io_bits & IO_BITS_OTYPE) >> 16)
 #define        io_kotype(io)           ((io)->io_bits & IO_BITS_KOTYPE)


@@ -140,63 +156,26 @@ extern zone_t ipc_object_zones[IOT_NUMBER];
 #define        io_alloc(otype)         \
                ((ipc_object_t) zalloc(ipc_object_zones[(otype)]))
 
 #define        io_alloc(otype)         \
                ((ipc_object_t) zalloc(ipc_object_zones[(otype)]))
 

-#if    MACH_ASSERT
-/*
- *     Call the routine for io_free so that checking can be performed.
- */

 extern void    io_free(
                        unsigned int    otype,
                        ipc_object_t    object);
 
 extern void    io_free(
                        unsigned int    otype,
                        ipc_object_t    object);
 

-#else  /* MACH_ASSERT */
-#define        io_free(otype, io)      \
-               zfree(ipc_object_zones[(otype)], (vm_offset_t) (io))
-#endif /* MACH_ASSERT */
-

 /*
 /*

- * Here we depend on the ipc_object being first within the ipc_common_data,
- * which is first within the rpc_common_data, which in turn must be first
- * within any kernel data structure needing to lock an ipc_object
+ * Here we depend on the ipc_object being first within the kernel struct

  * (ipc_port and ipc_pset).
  */
  * (ipc_port and ipc_pset).
  */

-#if    NCPUS == 1
-

 #define io_lock_init(io) \
 #define io_lock_init(io) \

-       usimple_lock_init(&(io)-io_lock_data, ETAP_IPC_OBJECT)
+       lck_spin_init(&(io)->io_lock_data, &ipc_lck_grp, &ipc_lck_attr)
+#define io_lock_destroy(io) \
+       lck_spin_destroy(&(io)->io_lock_data, &ipc_lck_grp)

 #define        io_lock(io) \
 #define        io_lock(io) \

-       usimple_lock(&(io)->io_lock_data)
+       lck_spin_lock(&(io)->io_lock_data)

 #define        io_lock_try(io) \
 #define        io_lock_try(io) \

-       usimple_lock_try(&(io)->io_lock_data)
+       lck_spin_try_lock(&(io)->io_lock_data)

 #define        io_unlock(io) \
 #define        io_unlock(io) \

-       usimple_unlock(&(io)->io_lock_data)
-
-#else  /* NCPUS == 1 */
+       lck_spin_unlock(&(io)->io_lock_data)

 
 

-#define io_lock_init(io) \
-       mutex_init(&(io)->io_lock_data, ETAP_IPC_OBJECT)
-#define        io_lock(io) \
-       mutex_lock(&(io)->io_lock_data)
-#define        io_lock_try(io) \
-       mutex_try(&(io)->io_lock_data)
-#define        io_unlock(io) \
-       mutex_unlock(&(io)->io_lock_data)
-
-#endif /* NCPUS == 1 */
-
-#if    NCPUS > 1

 #define _VOLATILE_ volatile
 #define _VOLATILE_ volatile

-#else  /* NCPUS > 1 */
-#define _VOLATILE_
-#endif /* NCPUS > 1 */
-
-#define io_check_unlock(io)                                            \
-MACRO_BEGIN                                                            \
-       _VOLATILE_ ipc_object_refs_t _refs = (io)->io_references;       \
-                                                                       \
-       io_unlock(io);                                                  \
-       if (_refs == 0)                                                 \
-               io_free(io_otype(io), io);                              \
-MACRO_END

 
 /* Sanity check the ref count.  If it is 0, we may be doubly zfreeing.
  * If it is larger than max int, it has been corrupted, probably by being
 
 /* Sanity check the ref count.  If it is 0, we may be doubly zfreeing.
  * If it is larger than max int, it has been corrupted, probably by being


@@ -210,18 +189,34 @@ MACRO_END
 #define IO_MAX_REFERENCES                                              \
        (unsigned)(~0 ^ (1 << (sizeof(int)*BYTE_SIZE - 1)))
 
 #define IO_MAX_REFERENCES                                              \
        (unsigned)(~0 ^ (1 << (sizeof(int)*BYTE_SIZE - 1)))
 

-#define        io_reference(io)                                                \
-MACRO_BEGIN                                                            \
-       assert((io)->io_references < IO_MAX_REFERENCES);                \
-       (io)->io_references++;                                          \
-MACRO_END
+static inline void
+io_reference(ipc_object_t io) {
+       assert((io)->io_references > 0 &&
+           (io)->io_references < IO_MAX_REFERENCES);
+       OSIncrementAtomic(&((io)->io_references));
+}
+
+
+static inline void
+io_release(ipc_object_t io) {
+       assert((io)->io_references > 0 &&
+           (io)->io_references < IO_MAX_REFERENCES);
+        /* If we just removed the last reference count */
+       if ( 1 == OSDecrementAtomic(&((io)->io_references))) {
+               /* Free the object */
+               io_free(io_otype((io)), (io));
+       }
+}
+
+/*   
+ * Retrieve a label for use in a kernel call that takes a security
+ * label as a parameter. If necessary, io_getlabel acquires internal
+ * (not io_lock) locks, and io_unlocklabel releases them.
+ */

 
 

-#define        io_release(io)                                                  \
-MACRO_BEGIN                                                            \
-       assert((io)->io_references > 0 &&                               \
-                   (io)->io_references <= IO_MAX_REFERENCES);          \
-       (io)->io_references--;                                          \
-MACRO_END
+struct label;
+extern struct label *io_getlabel (ipc_object_t obj);
+#define io_unlocklabel(obj)

 
 /*
  * Exported interfaces
 
 /*
  * Exported interfaces


@@ -302,6 +297,11 @@ extern void ipc_object_destroy(
        ipc_object_t            object,
        mach_msg_type_name_t    msgt_name);
 
        ipc_object_t            object,
        mach_msg_type_name_t    msgt_name);
 

+/* Destroy a naked destination capability */
+extern void ipc_object_destroy_dest(
+       ipc_object_t            object,
+       mach_msg_type_name_t    msgt_name);
+

 /* Copyout a capability, placing it into a space */
 extern kern_return_t ipc_object_copyout(
        ipc_space_t             space,
 /* Copyout a capability, placing it into a space */
 extern kern_return_t ipc_object_copyout(
        ipc_space_t             space,


@@ -331,12 +331,4 @@ extern kern_return_t ipc_object_rename(
        mach_port_name_t        oname,
        mach_port_name_t        nname);
 
        mach_port_name_t        oname,
        mach_port_name_t        nname);
 

-#if    MACH_KDB
-/* Pretty-print an ipc object */
-
-extern void ipc_object_print(
-       ipc_object_t    object);
-
-#endif /* MACH_KDB */
-

 #endif /* _IPC_IPC_OBJECT_H_ */
 #endif /* _IPC_IPC_OBJECT_H_ */