osfmk/ipc/ipc_kmsg.h

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