1/* 2 * Copyright (c) 2000-2007 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_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. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28/* 29 * @OSF_COPYRIGHT@ 30 */ 31/* 32 * Mach Operating System 33 * Copyright (c) 1991,1990,1989 Carnegie Mellon University 34 * All Rights Reserved. 35 * 36 * Permission to use, copy, modify and distribute this software and its 37 * documentation is hereby granted, provided that both the copyright 38 * notice and this permission notice appear in all copies of the 39 * software, derivative works or modified versions, and any portions 40 * thereof, and that both notices appear in supporting documentation. 41 * 42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" 43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR 44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE. 45 * 46 * Carnegie Mellon requests users of this software to return to 47 * 48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU 49 * School of Computer Science 50 * Carnegie Mellon University 51 * Pittsburgh PA 15213-3890 52 * 53 * any improvements or extensions that they make and grant Carnegie Mellon 54 * the rights to redistribute these changes. 55 */ 56/* 57 * NOTICE: This file was modified by McAfee Research in 2004 to introduce 58 * support for mandatory and extensible security protections. This notice 59 * is included in support of clause 2.2 (b) of the Apple Public License, 60 * Version 2.0. 61 */ 62/* 63 */ 64/* 65 * File: ipc/ipc_object.h 66 * Author: Rich Draves 67 * Date: 1989 68 * 69 * Definitions for IPC objects, for which tasks have capabilities. 70 */ 71 72#ifndef _IPC_IPC_OBJECT_H_ 73#define _IPC_IPC_OBJECT_H_ 74 75#include <mach_rt.h> 76 77#include <mach/kern_return.h> 78#include <mach/message.h> 79#include <kern/lock.h> 80#include <kern/macro_help.h> 81#include <kern/zalloc.h> 82#include <ipc/ipc_types.h> 83#include <libkern/OSAtomic.h> 84 85#include <kern/assert.h> 86 87typedef natural_t ipc_object_refs_t; /* for ipc/ipc_object.h */ 88typedef natural_t ipc_object_bits_t; 89typedef natural_t ipc_object_type_t; 90 91/* 92 * The ipc_object is used to both tag and reference count these two data 93 * structures, and (Noto Bene!) pointers to either of these or the 94 * ipc_object at the head of these are freely cast back and forth; hence 95 * the ipc_object MUST BE FIRST in the ipc_common_data. 96 * 97 * If the RPC implementation enabled user-mode code to use kernel-level 98 * data structures (as ours used to), this peculiar structuring would 99 * avoid having anything in user code depend on the kernel configuration 100 * (with which lock size varies). 101 */ 102struct ipc_object { 103 ipc_object_bits_t io_bits; 104 ipc_object_refs_t io_references; 105 lck_spin_t io_lock_data; 106}; 107 108/* 109 * If another object type needs to participate in io_kotype()-based 110 * dispatching, it must include a stub structure as the first 111 * element 112 */ 113struct ipc_object_header { 114 ipc_object_bits_t io_bits; 115#ifdef __LP64__ 116 natural_t io_padding; /* pad to natural boundary */ 117#endif 118}; 119 120/* 121 * Legacy defines. Should use IPC_OBJECT_NULL, etc... 122 */ 123#define IO_NULL ((ipc_object_t) 0) 124#define IO_DEAD ((ipc_object_t) ~0UL) 125#define IO_VALID(io) (((io) != IO_NULL) && ((io) != IO_DEAD)) 126 127/* 128 * IPC steals the high-order bits from the kotype to use 129 * for its own purposes. This allows IPC to record facts 130 * about ports that aren't otherwise obvious from the 131 * existing port fields. In particular, IPC can optionally 132 * mark a port for no more senders detection. Any change 133 * to IO_BITS_PORT_INFO must be coordinated with bitfield 134 * definitions in ipc_port.h. 135 */ 136#define IO_BITS_PORT_INFO 0x0000f000 /* stupid port tricks */ 137#define IO_BITS_KOTYPE 0x00000fff /* used by the object */ 138#define IO_BITS_OTYPE 0x7fff0000 /* determines a zone */ 139#define IO_BITS_ACTIVE 0x80000000 /* is object alive? */ 140 141#define io_active(io) ((io)->io_bits & IO_BITS_ACTIVE) 142 143#define io_otype(io) (((io)->io_bits & IO_BITS_OTYPE) >> 16) 144#define io_kotype(io) ((io)->io_bits & IO_BITS_KOTYPE) 145 146#define io_makebits(active, otype, kotype) \ 147 (((active) ? IO_BITS_ACTIVE : 0) | ((otype) << 16) | (kotype)) 148 149/* 150 * Object types: ports, port sets, kernel-loaded ports 151 */ 152#define IOT_PORT 0 153#define IOT_PORT_SET 1 154#define IOT_NUMBER 2 /* number of types used */ 155 156extern zone_t ipc_object_zones[IOT_NUMBER]; 157 158#define io_alloc(otype) \ 159 ((ipc_object_t) zalloc(ipc_object_zones[(otype)])) 160 161extern void io_free( 162 unsigned int otype, 163 ipc_object_t object); 164 165/* 166 * Here we depend on the ipc_object being first within the kernel struct 167 * (ipc_port and ipc_pset). 168 */ 169#define io_lock_init(io) \ 170 lck_spin_init(&(io)->io_lock_data, &ipc_lck_grp, &ipc_lck_attr) 171#define io_lock_destroy(io) \ 172 lck_spin_destroy(&(io)->io_lock_data, &ipc_lck_grp) 173#define io_lock(io) \ 174 lck_spin_lock(&(io)->io_lock_data) 175#define io_lock_try(io) \ 176 lck_spin_try_lock(&(io)->io_lock_data) 177#define io_unlock(io) \ 178 lck_spin_unlock(&(io)->io_lock_data) 179 180#define _VOLATILE_ volatile 181 182/* Sanity check the ref count. If it is 0, we may be doubly zfreeing. 183 * If it is larger than max int, it has been corrupted, probably by being 184 * modified into an address (this is architecture dependent, but it's 185 * safe to assume there cannot really be max int references). 186 * 187 * NOTE: The 0 test alone will not catch double zfreeing of ipc_port 188 * structs, because the io_references field is the first word of the struct, 189 * and zfree modifies that to point to the next free zone element. 190 */ 191#define IO_MAX_REFERENCES \ 192 (unsigned)(~0 ^ (1 << (sizeof(int)*BYTE_SIZE - 1))) 193 194static inline void 195io_reference(ipc_object_t io) { 196 assert((io)->io_references > 0 && 197 (io)->io_references < IO_MAX_REFERENCES); 198 OSIncrementAtomic(&((io)->io_references)); 199} 200 201 202static inline void 203io_release(ipc_object_t io) { 204 assert((io)->io_references > 0 && 205 (io)->io_references < IO_MAX_REFERENCES); 206 /* If we just removed the last reference count */ 207 if ( 1 == OSDecrementAtomic(&((io)->io_references))) { 208 /* Free the object */ 209 io_free(io_otype((io)), (io)); 210 } 211} 212 213/* 214 * Retrieve a label for use in a kernel call that takes a security 215 * label as a parameter. If necessary, io_getlabel acquires internal 216 * (not io_lock) locks, and io_unlocklabel releases them. 217 */ 218 219struct label; 220extern struct label *io_getlabel (ipc_object_t obj); 221#define io_unlocklabel(obj) 222 223/* 224 * Exported interfaces 225 */ 226 227/* Take a reference to an object */ 228extern void ipc_object_reference( 229 ipc_object_t object); 230 231/* Release a reference to an object */ 232extern void ipc_object_release( 233 ipc_object_t object); 234 235/* Look up an object in a space */ 236extern kern_return_t ipc_object_translate( 237 ipc_space_t space, 238 mach_port_name_t name, 239 mach_port_right_t right, 240 ipc_object_t *objectp); 241 242/* Look up two objects in a space, locking them in the order described */ 243extern kern_return_t ipc_object_translate_two( 244 ipc_space_t space, 245 mach_port_name_t name1, 246 mach_port_right_t right1, 247 ipc_object_t *objectp1, 248 mach_port_name_t name2, 249 mach_port_right_t right2, 250 ipc_object_t *objectp2); 251 252/* Allocate a dead-name entry */ 253extern kern_return_t 254ipc_object_alloc_dead( 255 ipc_space_t space, 256 mach_port_name_t *namep); 257 258/* Allocate a dead-name entry, with a specific name */ 259extern kern_return_t ipc_object_alloc_dead_name( 260 ipc_space_t space, 261 mach_port_name_t name); 262 263/* Allocate an object */ 264extern kern_return_t ipc_object_alloc( 265 ipc_space_t space, 266 ipc_object_type_t otype, 267 mach_port_type_t type, 268 mach_port_urefs_t urefs, 269 mach_port_name_t *namep, 270 ipc_object_t *objectp); 271 272/* Allocate an object, with a specific name */ 273extern kern_return_t ipc_object_alloc_name( 274 ipc_space_t space, 275 ipc_object_type_t otype, 276 mach_port_type_t type, 277 mach_port_urefs_t urefs, 278 mach_port_name_t name, 279 ipc_object_t *objectp); 280 281/* Convert a send type name to a received type name */ 282extern mach_msg_type_name_t ipc_object_copyin_type( 283 mach_msg_type_name_t msgt_name); 284 285/* Copyin a capability from a space */ 286extern kern_return_t ipc_object_copyin( 287 ipc_space_t space, 288 mach_port_name_t name, 289 mach_msg_type_name_t msgt_name, 290 ipc_object_t *objectp); 291 292/* Copyin a naked capability from the kernel */ 293extern void ipc_object_copyin_from_kernel( 294 ipc_object_t object, 295 mach_msg_type_name_t msgt_name); 296 297/* Destroy a naked capability */ 298extern void ipc_object_destroy( 299 ipc_object_t object, 300 mach_msg_type_name_t msgt_name); 301 302/* Destroy a naked destination capability */ 303extern void ipc_object_destroy_dest( 304 ipc_object_t object, 305 mach_msg_type_name_t msgt_name); 306 307/* Copyout a capability, placing it into a space */ 308extern kern_return_t ipc_object_copyout( 309 ipc_space_t space, 310 ipc_object_t object, 311 mach_msg_type_name_t msgt_name, 312 boolean_t overflow, 313 mach_port_name_t *namep); 314 315/* Copyout a capability with a name, placing it into a space */ 316extern kern_return_t ipc_object_copyout_name( 317 ipc_space_t space, 318 ipc_object_t object, 319 mach_msg_type_name_t msgt_name, 320 boolean_t overflow, 321 mach_port_name_t name); 322 323/* Translate/consume the destination right of a message */ 324extern void ipc_object_copyout_dest( 325 ipc_space_t space, 326 ipc_object_t object, 327 mach_msg_type_name_t msgt_name, 328 mach_port_name_t *namep); 329 330/* Rename an entry in a space */ 331extern kern_return_t ipc_object_rename( 332 ipc_space_t space, 333 mach_port_name_t oname, 334 mach_port_name_t nname); 335 336#endif /* _IPC_IPC_OBJECT_H_ */ 337