Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 | /* * Copyright (c) 2000-2004 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 * 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. * * 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, * 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. */ /* * 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. * Copyright (c) 2005 SPARTA, Inc. */ /* */ /* * File: ipc/ipc_kmsg.h * Author: Rich Draves * Date: 1989 * * Definitions for kernel messages. */ #ifndef _IPC_IPC_KMSG_H_ #define _IPC_IPC_KMSG_H_ #include <mach/vm_types.h> #include <mach/message.h> #include <kern/kern_types.h> #include <kern/assert.h> #include <kern/macro_help.h> #include <ipc/ipc_types.h> #include <ipc/ipc_object.h> #include <sys/kdebug.h> typedef uint32_t ipc_kmsg_flags_t; #define IPC_KMSG_FLAGS_ALLOW_IMMOVABLE_SEND 0x1 /* Dest port contains an immovable send right */ /* * This structure is only the header for a kmsg buffer; * the actual buffer is normally larger. The rest of the buffer * holds the body of the message. * * In a kmsg, the port fields hold pointers to ports instead * of port names. These pointers hold references. * * The ikm_header.msgh_remote_port field is the destination * of the message. * * sync_qos and special_port_qos stores the qos for prealloced * port, this fields could be deleted once we remove ip_prealloc. */ struct ipc_kmsg { mach_msg_size_t ikm_size; ipc_kmsg_flags_t ikm_flags; struct ipc_kmsg *ikm_next; /* next message on port/discard queue */ struct ipc_kmsg *ikm_prev; /* prev message on port/discard queue */ mach_msg_header_t *ikm_header; ipc_port_t ikm_prealloc; /* port we were preallocated from */ ipc_port_t ikm_voucher; /* voucher port carried */ mach_msg_priority_t ikm_qos; /* qos of this kmsg */ mach_msg_priority_t ikm_qos_override; /* qos override on this kmsg */ struct ipc_importance_elem *ikm_importance; /* inherited from */ queue_chain_t ikm_inheritance; /* inherited from link */ struct turnstile *ikm_turnstile; /* send turnstile for ikm_prealloc port */ #if MACH_FLIPC struct mach_node *ikm_node; /* Originating node - needed for ack */ #endif }; #if defined(__i386__) || defined(__arm__) #define IKM_SUPPORT_LEGACY 1 #else #define IKM_SUPPORT_LEGACY 0 #endif #define IKM_OVERHEAD (sizeof(struct ipc_kmsg)) #define ikm_plus_overhead(size) ((mach_msg_size_t)((size) + IKM_OVERHEAD)) #define ikm_less_overhead(size) ((mach_msg_size_t)((size) - IKM_OVERHEAD)) /* * XXX For debugging. */ #define IKM_BOGUS ((ipc_kmsg_t) 0xffffff10) /* * The size of the kernel message buffers that will be cached. * IKM_SAVED_KMSG_SIZE includes overhead; IKM_SAVED_MSG_SIZE doesn't. */ extern zone_t ipc_kmsg_zone; #define IKM_SAVED_KMSG_SIZE 256 #define IKM_SAVED_MSG_SIZE ikm_less_overhead(IKM_SAVED_KMSG_SIZE) #define ikm_prealloc_inuse_port(kmsg) \ ((kmsg)->ikm_prealloc) #define ikm_prealloc_inuse(kmsg) \ ((kmsg)->ikm_prealloc != IP_NULL) #define ikm_prealloc_set_inuse(kmsg, port) \ MACRO_BEGIN \ assert((port) != IP_NULL); \ (kmsg)->ikm_prealloc = (port); \ ip_reference(port); \ MACRO_END #define ikm_prealloc_clear_inuse(kmsg, port) \ MACRO_BEGIN \ (kmsg)->ikm_prealloc = IP_NULL; \ MACRO_END #if MACH_FLIPC #define ikm_flipc_init(kmsg) (kmsg)->ikm_node = MACH_NODE_NULL #else #define ikm_flipc_init(kmsg) #endif #define ikm_init(kmsg, size) \ MACRO_BEGIN \ (kmsg)->ikm_size = (size); \ (kmsg)->ikm_flags = 0; \ (kmsg)->ikm_prealloc = IP_NULL; \ (kmsg)->ikm_voucher = IP_NULL; \ (kmsg)->ikm_importance = IIE_NULL; \ ikm_qos_init(kmsg); \ ikm_flipc_init(kmsg); \ assert((kmsg)->ikm_prev = (kmsg)->ikm_next = IKM_BOGUS); \ MACRO_END #define ikm_qos_init(kmsg) \ MACRO_BEGIN \ (kmsg)->ikm_qos = MACH_MSG_PRIORITY_UNSPECIFIED; \ (kmsg)->ikm_qos_override = MACH_MSG_PRIORITY_UNSPECIFIED; \ MACRO_END #define ikm_check_init(kmsg, size) \ MACRO_BEGIN \ assert((kmsg)->ikm_size == (size)); \ assert((kmsg)->ikm_prev == IKM_BOGUS); \ assert((kmsg)->ikm_next == IKM_BOGUS); \ MACRO_END #define ikm_set_header(kmsg, mtsize) \ MACRO_BEGIN \ (kmsg)->ikm_header = (mach_msg_header_t *) \ ((vm_offset_t)((kmsg) + 1) + (kmsg)->ikm_size - (mtsize)); \ MACRO_END struct ipc_kmsg_queue { struct ipc_kmsg *ikmq_base; }; typedef struct ipc_kmsg_queue *ipc_kmsg_queue_t; #define IKMQ_NULL ((ipc_kmsg_queue_t) 0) /* * Exported interfaces */ #define ipc_kmsg_queue_init(queue) \ MACRO_BEGIN \ (queue)->ikmq_base = IKM_NULL; \ MACRO_END #define ipc_kmsg_queue_empty(queue) ((queue)->ikmq_base == IKM_NULL) /* Enqueue a kmsg */ extern void ipc_kmsg_enqueue( ipc_kmsg_queue_t queue, ipc_kmsg_t kmsg); extern boolean_t ipc_kmsg_enqueue_qos( ipc_kmsg_queue_t queue, ipc_kmsg_t kmsg); extern boolean_t ipc_kmsg_override_qos( ipc_kmsg_queue_t queue, ipc_kmsg_t kmsg, mach_msg_priority_t override); /* Dequeue and return a kmsg */ extern ipc_kmsg_t ipc_kmsg_dequeue( ipc_kmsg_queue_t queue); /* Pull a kmsg out of a queue */ extern void ipc_kmsg_rmqueue( ipc_kmsg_queue_t queue, ipc_kmsg_t kmsg); /* Pull the (given) first kmsg out of a queue */ extern void ipc_kmsg_rmqueue_first( ipc_kmsg_queue_t queue, ipc_kmsg_t kmsg); #define ipc_kmsg_queue_first(queue) ((queue)->ikmq_base) /* Return the kmsg following the given kmsg */ extern ipc_kmsg_t ipc_kmsg_queue_next( ipc_kmsg_queue_t queue, ipc_kmsg_t kmsg); /* Allocate a kernel message */ extern ipc_kmsg_t ipc_kmsg_alloc( mach_msg_size_t size); /* Free a kernel message buffer */ extern void ipc_kmsg_free( ipc_kmsg_t kmsg); /* Destroy kernel message */ extern void ipc_kmsg_destroy( ipc_kmsg_t kmsg); /* Enqueue kernel message for deferred destruction */ extern boolean_t ipc_kmsg_delayed_destroy( ipc_kmsg_t kmsg); /* Process all the delayed message destroys */ extern void ipc_kmsg_reap_delayed(void); /* Preallocate a kernel message buffer */ extern ipc_kmsg_t ipc_kmsg_prealloc( mach_msg_size_t size); /* bind a preallocated message buffer to a port */ extern void ipc_kmsg_set_prealloc( ipc_kmsg_t kmsg, ipc_port_t port); /* Clear preallocated message buffer binding */ extern void ipc_kmsg_clear_prealloc( ipc_kmsg_t kmsg, ipc_port_t port); /* Allocate a kernel message buffer and copy a user message to the buffer */ extern mach_msg_return_t ipc_kmsg_get( mach_vm_address_t msg_addr, mach_msg_size_t size, ipc_kmsg_t *kmsgp); /* Allocate a kernel message buffer and copy a kernel message to the buffer */ extern mach_msg_return_t ipc_kmsg_get_from_kernel( mach_msg_header_t *msg, mach_msg_size_t size, ipc_kmsg_t *kmsgp); /* Send a message to a port */ extern mach_msg_return_t ipc_kmsg_send( ipc_kmsg_t kmsg, mach_msg_option_t option, mach_msg_timeout_t timeout_val); /* Copy a kernel message buffer to a user message */ extern mach_msg_return_t ipc_kmsg_put( ipc_kmsg_t kmsg, mach_msg_option_t option, mach_vm_address_t rcv_addr, mach_msg_size_t rcv_size, mach_msg_size_t trailer_size, mach_msg_size_t *size); /* Copy a kernel message buffer to a kernel message */ extern void ipc_kmsg_put_to_kernel( mach_msg_header_t *msg, ipc_kmsg_t kmsg, mach_msg_size_t size); /* Copyin port rights in the header of a message */ extern mach_msg_return_t ipc_kmsg_copyin_header( ipc_kmsg_t kmsg, ipc_space_t space, mach_msg_priority_t override, mach_msg_option_t *optionp); /* Copyin port rights and out-of-line memory from a user message */ extern mach_msg_return_t ipc_kmsg_copyin( ipc_kmsg_t kmsg, ipc_space_t space, vm_map_t map, mach_msg_priority_t override, mach_msg_option_t *optionp); /* Copyin port rights and out-of-line memory from a kernel message */ extern mach_msg_return_t ipc_kmsg_copyin_from_kernel( ipc_kmsg_t kmsg); #if IKM_SUPPORT_LEGACY extern mach_msg_return_t ipc_kmsg_copyin_from_kernel_legacy( ipc_kmsg_t kmsg); #endif /* Copyout port rights in the header of a message */ extern mach_msg_return_t ipc_kmsg_copyout_header( ipc_kmsg_t kmsg, ipc_space_t space, mach_msg_option_t option); /* Copyout a port right returning a name */ extern mach_msg_return_t ipc_kmsg_copyout_object( ipc_space_t space, ipc_object_t object, mach_msg_type_name_t msgt_name, mach_port_context_t *context, mach_msg_guard_flags_t *guard_flags, mach_port_name_t *namep); /* Copyout the header and body to a user message */ extern mach_msg_return_t ipc_kmsg_copyout( ipc_kmsg_t kmsg, ipc_space_t space, vm_map_t map, mach_msg_body_t *slist, mach_msg_option_t option); /* Copyout port rights and out-of-line memory from the body of a message */ extern mach_msg_return_t ipc_kmsg_copyout_body( ipc_kmsg_t kmsg, ipc_space_t space, vm_map_t map, mach_msg_option_t option, mach_msg_body_t *slist); /* Copyout port rights and out-of-line memory to a user message, * not reversing the ports in the header */ extern mach_msg_return_t ipc_kmsg_copyout_pseudo( ipc_kmsg_t kmsg, ipc_space_t space, vm_map_t map, mach_msg_body_t *slist); /* Compute size of message as copied out to the specified space/map */ extern mach_msg_size_t ipc_kmsg_copyout_size( ipc_kmsg_t kmsg, vm_map_t map); /* Copyout the destination port in the message */ extern void ipc_kmsg_copyout_dest( ipc_kmsg_t kmsg, ipc_space_t space); /* kernel's version of ipc_kmsg_copyout_dest */ extern void ipc_kmsg_copyout_to_kernel( ipc_kmsg_t kmsg, ipc_space_t space); #if IKM_SUPPORT_LEGACY extern void ipc_kmsg_copyout_to_kernel_legacy( ipc_kmsg_t kmsg, ipc_space_t space); #endif extern mach_msg_trailer_size_t ipc_kmsg_add_trailer(ipc_kmsg_t kmsg, ipc_space_t space, mach_msg_option_t option, thread_t thread, mach_port_seqno_t seqno, boolean_t minimal_trailer, mach_vm_offset_t context); #if (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) extern void ipc_kmsg_trace_send(ipc_kmsg_t kmsg, mach_msg_option_t option); #else #define ipc_kmsg_trace_send(a, b) do { } while (0) #endif extern mach_msg_header_t * ipc_kmsg_msg_header(ipc_kmsg_t); #endif /* _IPC_IPC_KMSG_H_ */ |