]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/ipc/ipc_space.h
xnu-4903.270.47.tar.gz
[apple/xnu.git] / osfmk / ipc / ipc_space.h
index 06fdf3e79a80a61312b3962b17dc730aecbf4db3..c0a2d1d15d4e10ce53e78249536b8c9f61c602a1 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 2000-2016 Apple Computer, Inc. All rights reserved.
  *
  * @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
  * 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,
  * 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_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * @OSF_COPYRIGHT@
  */
-/* 
+/*
  * Mach Operating System
  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  * All Rights Reserved.
- * 
+ *
  * Permission to use, copy, modify and distribute this software and its
  * documentation is hereby granted, provided that both the copyright
  * notice and this permission notice appear in all copies of the
  * software, derivative works or modified versions, and any portions
  * thereof, and that both notices appear in supporting documentation.
- * 
+ *
  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
- * 
+ *
  * Carnegie Mellon requests users of this software to return to
- * 
+ *
  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  *  School of Computer Science
  *  Carnegie Mellon University
  *  Pittsburgh PA 15213-3890
- * 
+ *
  * any improvements or extensions that they make and grant Carnegie Mellon
  * the rights to redistribute these changes.
  */
@@ -69,7 +69,7 @@
  *     Definitions for IPC spaces of capabilities.
  */
 
-#ifndef        _IPC_IPC_SPACE_H_
+#ifndef _IPC_IPC_SPACE_H_
 #define _IPC_IPC_SPACE_H_
 
 
  */
 
 typedef natural_t ipc_space_refs_t;
-#define IS_REFS_MAX    0x0fffffff
-#define IS_INACTIVE    0x40000000      /* space is inactive */
-#define IS_GROWING     0x20000000      /* space is growing */
-#define IS_ENTROPY_CNT  1              /* per-space entropy pool size */
+#define IS_REFS_MAX     0x0fffffff
+#define IS_INACTIVE     0x40000000      /* space is inactive */
+#define IS_GROWING      0x20000000      /* space is growing */
+#define IS_ENTROPY_CNT  1               /* per-space entropy pool size */
 
 struct ipc_space {
-       lck_spin_t      is_lock_data;
-       ipc_space_refs_t is_bits;       /* holds refs, active, growing */
-       ipc_entry_num_t is_table_size;  /* current size of table */
-       ipc_entry_num_t is_table_free;  /* count of free elements */
-       ipc_entry_t is_table;           /* an array of entries */
+       lck_spin_t      is_lock_data;
+       ipc_space_refs_t is_bits;       /* holds refs, active, growing */
+       ipc_entry_num_t is_table_size;  /* current size of table */
+       ipc_entry_num_t is_table_hashed;/* count of hashed elements */
+       ipc_entry_num_t is_table_free;  /* count of free elements */
+       ipc_entry_t is_table;           /* an array of entries */
        task_t is_task;                 /* associated task */
        struct ipc_table_size *is_table_next; /* info for larger table */
-       ipc_entry_num_t is_low_mod;     /* lowest modified entry during growth */
-       ipc_entry_num_t is_high_mod;    /* highest modified entry during growth */
+       ipc_entry_num_t is_low_mod;     /* lowest modified entry during growth */
+       ipc_entry_num_t is_high_mod;    /* highest modified entry during growth */
        struct bool_gen bool_gen;       /* state for boolean RNG */
        unsigned int is_entropy[IS_ENTROPY_CNT]; /* pool of entropy taken from RNG */
-       int is_node_id;                 /* HOST_LOCAL_NODE, or remote node if proxy space */
+       int is_node_id;                 /* HOST_LOCAL_NODE, or remote node if proxy space */
 };
 
-#define        IS_NULL                 ((ipc_space_t) 0)
-#define        IS_INSPECT_NULL         ((ipc_space_inspect_t) 0)
+#define IS_NULL                 ((ipc_space_t) 0)
+#define IS_INSPECT_NULL         ((ipc_space_inspect_t) 0)
 
-#define is_active(is)          (((is)->is_bits & IS_INACTIVE) != IS_INACTIVE)
+#define is_active(is)           (((is)->is_bits & IS_INACTIVE) != IS_INACTIVE)
 
-static inline void 
+static inline void
 is_mark_inactive(ipc_space_t is)
 {
        assert(is_active(is));
        OSBitOrAtomic(IS_INACTIVE, &is->is_bits);
 }
 
-#define is_growing(is)         (((is)->is_bits & IS_GROWING) == IS_GROWING)
+#define is_growing(is)          (((is)->is_bits & IS_GROWING) == IS_GROWING)
 
 static inline void
 is_start_growing(ipc_space_t is)
@@ -149,7 +150,7 @@ is_start_growing(ipc_space_t is)
 }
 
 static inline void
-is_done_growing(ipc_space_t is)        
+is_done_growing(ipc_space_t is)
 {
        assert(is_growing(is));
        OSBitAndAtomic(~IS_GROWING, &is->is_bits);
@@ -157,40 +158,42 @@ is_done_growing(ipc_space_t is)
 
 extern zone_t ipc_space_zone;
 
-#define is_alloc()             ((ipc_space_t) zalloc(ipc_space_zone))
-#define        is_free(is)             zfree(ipc_space_zone, (is))
+#define is_alloc()              ((ipc_space_t) zalloc(ipc_space_zone))
+#define is_free(is)             zfree(ipc_space_zone, (is))
 
 extern ipc_space_t ipc_space_kernel;
 extern ipc_space_t ipc_space_reply;
-#if    DIPC
+#if     DIPC
 extern ipc_space_t ipc_space_remote;
-#endif /* DIPC */
-#if    DIPC
+#endif  /* DIPC */
+#if     DIPC
 extern ipc_space_t default_pager_space;
-#endif /* DIPC */
+#endif  /* DIPC */
 
-extern lck_grp_t       ipc_lck_grp;
-extern lck_attr_t      ipc_lck_attr;
+extern lck_grp_t        ipc_lck_grp;
+extern lck_attr_t       ipc_lck_attr;
 
-#define        is_lock_init(is)        lck_spin_init(&(is)->is_lock_data, &ipc_lck_grp, &ipc_lck_attr)
-#define        is_lock_destroy(is)     lck_spin_destroy(&(is)->is_lock_data, &ipc_lck_grp)
+#define is_lock_init(is)        lck_spin_init(&(is)->is_lock_data, &ipc_lck_grp, &ipc_lck_attr)
+#define is_lock_destroy(is)     lck_spin_destroy(&(is)->is_lock_data, &ipc_lck_grp)
 
-#define        is_read_lock(is)        lck_spin_lock(&(is)->is_lock_data)
-#define is_read_unlock(is)     lck_spin_unlock(&(is)->is_lock_data)
-#define is_read_sleep(is)      lck_spin_sleep(&(is)->is_lock_data,     \
-                                                       LCK_SLEEP_DEFAULT,                                      \
-                                                       (event_t)(is),                                          \
-                                                       THREAD_UNINT)
+#define is_read_lock(is)        lck_spin_lock_grp(&(is)->is_lock_data, &ipc_lck_grp)
+#define is_read_unlock(is)      lck_spin_unlock(&(is)->is_lock_data)
+#define is_read_sleep(is)       lck_spin_sleep_grp(&(is)->is_lock_data,     \
+                                                       LCK_SLEEP_DEFAULT,                                      \
+                                                       (event_t)(is),                                          \
+                                                       THREAD_UNINT,                                           \
+                                                       &ipc_lck_grp)
 
-#define        is_write_lock(is)       lck_spin_lock(&(is)->is_lock_data)
-#define        is_write_lock_try(is)   lck_spin_try_lock(&(is)->is_lock_data)
-#define is_write_unlock(is)    lck_spin_unlock(&(is)->is_lock_data)
-#define is_write_sleep(is)     lck_spin_sleep(&(is)->is_lock_data,     \
-                                                       LCK_SLEEP_DEFAULT,                                      \
-                                                       (event_t)(is),                                          \
-                                                       THREAD_UNINT)
+#define is_write_lock(is)       lck_spin_lock_grp(&(is)->is_lock_data, &ipc_lck_grp)
+#define is_write_lock_try(is)   lck_spin_try_lock_grp(&(is)->is_lock_data, &ipc_lck_grp)
+#define is_write_unlock(is)     lck_spin_unlock(&(is)->is_lock_data)
+#define is_write_sleep(is)      lck_spin_sleep_grp(&(is)->is_lock_data,     \
+                                                       LCK_SLEEP_DEFAULT,                                      \
+                                                       (event_t)(is),                                          \
+                                                       THREAD_UNINT,                                           \
+                                                       &ipc_lck_grp)
 
-#define is_refs(is)            ((is)->is_bits & IS_REFS_MAX)
+#define is_refs(is)             ((is)->is_bits & IS_REFS_MAX)
 
 static inline void
 is_reference(ipc_space_t is)
@@ -201,43 +204,44 @@ is_reference(ipc_space_t is)
 
 
 static inline void
-is_release(ipc_space_t is) {
+is_release(ipc_space_t is)
+{
        assert(is_refs(is) > 0);
 
-        /* If we just removed the last reference count */
-       if ( 1 == (OSDecrementAtomic(&(is->is_bits)) & IS_REFS_MAX)) {
+       /* If we just removed the last reference count */
+       if (1 == (OSDecrementAtomic(&(is->is_bits)) & IS_REFS_MAX)) {
                assert(!is_active(is));
                is_lock_destroy(is);
                is_free(is);
        }
 }
-       
-#define        current_space_fast()    (current_task_fast()->itk_space)
-#define current_space()                (current_space_fast())
+
+#define current_space_fast()    (current_task_fast()->itk_space)
+#define current_space()         (current_space_fast())
 
 /* Create a special IPC space */
 extern kern_return_t ipc_space_create_special(
-       ipc_space_t     *spacep);
+       ipc_space_t     *spacep);
 
 /* Create a new IPC space */
 extern kern_return_t ipc_space_create(
-       ipc_table_size_t        initial,
-       ipc_space_t             *spacep);
+       ipc_table_size_t        initial,
+       ipc_space_t             *spacep);
 
 /* Mark a space as dead and cleans up the entries*/
 extern void ipc_space_terminate(
-       ipc_space_t     space);
+       ipc_space_t     space);
 
 /* Clean up the entries - but leave the space alive */
 extern void ipc_space_clean(
-       ipc_space_t     space);
+       ipc_space_t     space);
 
 /* Permute the order of a range within an IPC space */
 extern void ipc_space_rand_freelist(
-       ipc_space_t             space,
-       ipc_entry_t             table,
-       mach_port_index_t       bottom,
-       mach_port_index_t       top);
+       ipc_space_t             space,
+       ipc_entry_t             table,
+       mach_port_index_t       bottom,
+       mach_port_index_t       top);
 
 /* Generate a new gencount rollover point from a space's entropy pool */
 extern ipc_entry_bits_t ipc_space_get_rollpoint(ipc_space_t space);
@@ -247,17 +251,17 @@ extern ipc_entry_bits_t ipc_space_get_rollpoint(ipc_space_t space);
 #ifdef  __APPLE_API_UNSTABLE
 #ifndef MACH_KERNEL_PRIVATE
 
-extern ipc_space_t             current_space(void);
+extern ipc_space_t              current_space(void);
 
 #endif /* !MACH_KERNEL_PRIVATE */
 #endif /* __APPLE_API_UNSTABLE */
 
 /* Take a reference on a space */
 extern void ipc_space_reference(
-       ipc_space_t     space);
+       ipc_space_t     space);
 
 /* Realase a reference on a space */
 extern void ipc_space_release(
-       ipc_space_t     space);
+       ipc_space_t     space);
 
-#endif /* _IPC_IPC_SPACE_H_ */
+#endif  /* _IPC_IPC_SPACE_H_ */