]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/ipc/ipc_object.h
xnu-3789.70.16.tar.gz
[apple/xnu.git] / osfmk / ipc / ipc_object.h
index a3863ffa86dcacd84ea736239e9f6e2d450a19fe..aaddd33c2b65f2553a80d1cd490acc3088480e24 100644 (file)
 #define _IPC_IPC_OBJECT_H_
 
 #include <mach_rt.h>
-#include <mach_kdb.h>
 
 #include <mach/kern_return.h>
 #include <mach/message.h>
-#include <kern/lock.h>
+#include <kern/locks.h>
 #include <kern/macro_help.h>
+#include <kern/assert.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;
 
 /*
- * 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
@@ -100,17 +99,28 @@ typedef natural_t ipc_object_type_t;
  * (with which lock size varies).
  */
 struct ipc_object {
+       ipc_object_bits_t io_bits;
        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;
-       mach_port_name_t  io_receiver_name;
-       decl_mutex_data(,       io_lock_data)
+#ifdef __LP64__
+       natural_t         io_padding; /* pad to natural boundary */
+#endif
 };
 
 /*
  * 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))
 
 /*
@@ -127,7 +137,7 @@ struct ipc_object {
 #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)
@@ -147,49 +157,36 @@ extern zone_t ipc_object_zones[IOT_NUMBER];
 #define        io_alloc(otype)         \
                ((ipc_object_t) zalloc(ipc_object_zones[(otype)]))
 
-#if MACH_ASSERT || CONFIG_MACF_MACH
-/*
- *     Call the routine for io_free so that checking can be performed.
- */
 extern void    io_free(
                        unsigned int    otype,
                        ipc_object_t    object);
 
-#else  /* MACH_ASSERT || MAC_MACH */
-#define io_free(otype, io)  \
-       zfree(ipc_object_zones[(otype)], (io))
-#endif /* MACH_ASSERT || MAC_MACH */
-
 /*
- * 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).
  */
 #define io_lock_init(io) \
-       mutex_init(&(io)->io_lock_data, 0)
+       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) \
-       mutex_lock(&(io)->io_lock_data)
+       lck_spin_lock(&(io)->io_lock_data)
 #define        io_lock_try(io) \
-       mutex_try(&(io)->io_lock_data)
+       lck_spin_try_lock(&(io)->io_lock_data)
+#define io_lock_held_kdp(io) \
+       kdp_lck_spin_is_acquired(&(io)->io_lock_data)
 #define        io_unlock(io) \
-       mutex_unlock(&(io)->io_lock_data)
+       lck_spin_unlock(&(io)->io_lock_data)
 
 #define _VOLATILE_ volatile
 
-#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
- * modified into an address (this is architecture dependent, but it's
- * safe to assume there cannot really be max int references).
+ * If it is larger than max int, it has been corrupted or leaked,
+ * probably by being modified into an address (this is architecture
+ * dependent, but it's safe to assume there cannot really be max int
+ * references unless some code is leaking the io_reference without leaking
+ * object). Saturate the io_reference on release kernel if it reaches
+ * max int to avoid use after free.
  *
  * NOTE: The 0 test alone will not catch double zfreeing of ipc_port
  * structs, because the io_references field is the first word of the struct,
@@ -198,18 +195,48 @@ MACRO_END
 #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
-
-#define        io_release(io)                                                  \
-MACRO_BEGIN                                                            \
-       assert((io)->io_references > 0 &&                               \
-                   (io)->io_references <= IO_MAX_REFERENCES);          \
-       (io)->io_references--;                                          \
-MACRO_END
+static inline void
+io_reference(ipc_object_t io) {
+       ipc_object_refs_t new_io_references;
+       ipc_object_refs_t old_io_references;
+
+       assert((io)->io_references > 0 &&
+           (io)->io_references < IO_MAX_REFERENCES);
+
+       do {
+               old_io_references = (io)->io_references;
+               new_io_references = old_io_references + 1;
+               if (old_io_references == IO_MAX_REFERENCES) {
+                       break;
+               }
+       } while (OSCompareAndSwap(old_io_references, new_io_references,
+                       &((io)->io_references)) == FALSE);
+}
+
+
+static inline void
+io_release(ipc_object_t io) {
+       ipc_object_refs_t new_io_references;
+       ipc_object_refs_t old_io_references;
+
+       assert((io)->io_references > 0 &&
+           (io)->io_references < IO_MAX_REFERENCES);
+
+       do {
+               old_io_references = (io)->io_references;
+               new_io_references = old_io_references - 1;
+               if (old_io_references == IO_MAX_REFERENCES) {
+                       break;
+               }
+       } while (OSCompareAndSwap(old_io_references, new_io_references,
+                       &((io)->io_references)) == FALSE);
+
+        /* If we just removed the last reference count */
+       if (1 == old_io_references) {
+               /* Free the object */
+               io_free(io_otype((io)), (io));
+       }
+}
 
 /*   
  * Retrieve a label for use in a kernel call that takes a security
@@ -300,6 +327,11 @@ extern void ipc_object_destroy(
        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,
@@ -329,12 +361,4 @@ extern kern_return_t ipc_object_rename(
        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_ */