osfmk/ipc/ipc_space.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * @OSF_COPYRIGHT@
  25  */
  26 /*
  27  * Mach Operating System
  28  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  29  * All Rights Reserved.
  30  *
  31  * Permission to use, copy, modify and distribute this software and its
  32  * documentation is hereby granted, provided that both the copyright
  33  * notice and this permission notice appear in all copies of the
  34  * software, derivative works or modified versions, and any portions
  35  * thereof, and that both notices appear in supporting documentation.
  36  *
  37  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  38  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  39  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  40  *
  41  * Carnegie Mellon requests users of this software to return to
  42  *
  43  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  44  *  School of Computer Science
  45  *  Carnegie Mellon University
  46  *  Pittsburgh PA 15213-3890
  47  *
  48  * any improvements or extensions that they make and grant Carnegie Mellon
  49  * the rights to redistribute these changes.
  50  */
  51 /*
  52  */
  53 /*
  54  *      File:   ipc/ipc_space.h
  55  *      Author: Rich Draves
  56  *      Date:   1989
  57  *
  58  *      Definitions for IPC spaces of capabilities.
  59  */
  60
  61 #ifndef _IPC_IPC_SPACE_H_
  62 #define _IPC_IPC_SPACE_H_
  63
  64
  65 #include <mach/mach_types.h>
  66 #include <mach/boolean.h>
  67 #include <mach/kern_return.h>
  68 #include <mach/vm_types.h>
  69
  70 #include <sys/appleapiopts.h>
  71
  72 #ifdef __APPLE_API_PRIVATE
  73 #ifdef MACH_KERNEL_PRIVATE
  74 #include <mach_kdb.h>
  75 #include <kern/macro_help.h>
  76 #include <kern/kern_types.h>
  77 #include <kern/lock.h>
  78 #include <kern/task.h>
  79 #include <kern/zalloc.h>
  80 #include <ipc/ipc_entry.h>
  81 #include <ipc/ipc_splay.h>
  82 #include <ipc/ipc_types.h>
  83
  84 /*
  85  *      Every task has a space of IPC capabilities.
  86  *      IPC operations like send and receive use this space.
  87  *      IPC kernel calls manipulate the space of the target task.
  88  *
  89  *      Every space has a non-NULL is_table with is_table_size entries.
  90  *      A space may have a NULL is_tree.  is_tree_small records the
  91  *      number of entries in the tree that, if the table were to grow
  92  *      to the next larger size, would move from the tree to the table.
  93  *
  94  *      is_growing marks when the table is in the process of growing.
  95  *      When the table is growing, it can't be freed or grown by another
  96  *      thread, because of krealloc/kmem_realloc's requirements.
  97  *
  98  */
  99
 100 typedef natural_t ipc_space_refs_t;
 101
 102 struct ipc_space {
 103         decl_mutex_data(,is_ref_lock_data)
 104         ipc_space_refs_t is_references;
 105
 106         decl_mutex_data(,is_lock_data)
 107         boolean_t is_active;            /* is the space alive? */
 108         boolean_t is_growing;           /* is the space growing? */
 109         ipc_entry_t is_table;           /* an array of entries */
 110         ipc_entry_num_t is_table_size;  /* current size of table */
 111         struct ipc_table_size *is_table_next; /* info for larger table */
 112         struct ipc_splay_tree is_tree;  /* a splay tree of entries */
 113         ipc_entry_num_t is_tree_total;  /* number of entries in the tree */
 114         ipc_entry_num_t is_tree_small;  /* # of small entries in the tree */
 115         ipc_entry_num_t is_tree_hash;   /* # of hashed entries in the tree */
 116         boolean_t is_fast;              /* for is_fast_space() */
 117 };
 118
 119 #define IS_NULL                 ((ipc_space_t) 0)
 120
 121 extern zone_t ipc_space_zone;
 122
 123 #define is_alloc()              ((ipc_space_t) zalloc(ipc_space_zone))
 124 #define is_free(is)             zfree(ipc_space_zone, (is))
 125
 126 extern ipc_space_t ipc_space_kernel;
 127 extern ipc_space_t ipc_space_reply;
 128 #if     DIPC
 129 extern ipc_space_t ipc_space_remote;
 130 #endif  /* DIPC */
 131 #if     DIPC || MACH_KDB
 132 extern ipc_space_t default_pager_space;
 133 #endif  /* DIPC || MACH_KDB */
 134
 135 #define is_fast_space(is)       ((is)->is_fast)
 136
 137 #define is_ref_lock_init(is)    mutex_init(&(is)->is_ref_lock_data, 0)
 138
 139 #define ipc_space_reference_macro(is)                                   \
 140 MACRO_BEGIN                                                             \
 141         mutex_lock(&(is)->is_ref_lock_data);                            \
 142         assert((is)->is_references > 0);                                \
 143         (is)->is_references++;                                          \
 144         mutex_unlock(&(is)->is_ref_lock_data);                          \
 145 MACRO_END
 146
 147 #define ipc_space_release_macro(is)                                     \
 148 MACRO_BEGIN                                                             \
 149         ipc_space_refs_t _refs;                                         \
 150                                                                         \
 151         mutex_lock(&(is)->is_ref_lock_data);                            \
 152         assert((is)->is_references > 0);                                \
 153         _refs = --(is)->is_references;                                  \
 154         mutex_unlock(&(is)->is_ref_lock_data);                          \
 155                                                                         \
 156         if (_refs == 0)                                                 \
 157                 is_free(is);                                            \
 158 MACRO_END
 159
 160 #define is_lock_init(is)        mutex_init(&(is)->is_lock_data, 0)
 161
 162 #define is_read_lock(is)        mutex_lock(&(is)->is_lock_data)
 163 #define is_read_unlock(is)      mutex_unlock(&(is)->is_lock_data)
 164 #define is_read_sleep(is)       thread_sleep_mutex((event_t)(is),       \
 165                                                    &(is)->is_lock_data, \
 166                                                    THREAD_UNINT)
 167
 168 #define is_write_lock(is)       mutex_lock(&(is)->is_lock_data)
 169 #define is_write_lock_try(is)   mutex_try(&(is)->is_lock_data)
 170 #define is_write_unlock(is)     mutex_unlock(&(is)->is_lock_data)
 171 #define is_write_sleep(is)      thread_sleep_mutex((event_t)(is),       \
 172                                                    &(is)->is_lock_data, \
 173                                                    THREAD_UNINT)
 174
 175 #define is_reference(is)        ipc_space_reference(is)
 176 #define is_release(is)          ipc_space_release(is)
 177
 178 #define is_write_to_read_lock(is)
 179
 180 #define current_space_fast()    (current_task_fast()->itk_space)
 181 #define current_space()         (current_space_fast())
 182
 183 /* Create a special IPC space */
 184 extern kern_return_t ipc_space_create_special(
 185         ipc_space_t     *spacep);
 186
 187 /* Create  new IPC space */
 188 extern kern_return_t ipc_space_create(
 189         ipc_table_size_t        initial,
 190         ipc_space_t             *spacep);
 191
 192 /* Mark a space as dead and cleans up the entries*/
 193 extern void ipc_space_destroy(
 194         ipc_space_t     space);
 195
 196 /* Clean up the entries - but leave the space alive */
 197 extern void ipc_space_clean(
 198         ipc_space_t     space);
 199
 200 #endif /* MACH_KERNEL_PRIVATE */
 201 #endif /* __APPLE_API_PRIVATE */
 202
 203 #ifdef  __APPLE_API_UNSTABLE
 204 #ifndef MACH_KERNEL_PRIVATE
 205
 206 extern ipc_space_t              current_space(void);
 207
 208 #endif /* !MACH_KERNEL_PRIVATE */
 209 #endif /* __APPLE_API_UNSTABLE */
 210
 211 /* Take a reference on a space */
 212 extern void ipc_space_reference(
 213         ipc_space_t     space);
 214
 215 /* Realase a reference on a space */
 216 extern void ipc_space_release(
 217         ipc_space_t     space);
 218
 219 #endif  /* _IPC_IPC_SPACE_H_ */