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 | /* * Copyright (c) 2000-2005 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@ */ #ifndef _KERN_IPC_MIG_H_ #define _KERN_IPC_MIG_H_ #include <mach/mig.h> #include <mach/mach_types.h> #include <mach/message.h> #include <kern/kern_types.h> #include <sys/cdefs.h> #ifdef XNU_KERNEL_PRIVATE #include <sys/kdebug.h> struct ipc_kmsg; /* * Define the trace points for MIG-generated calls. One traces the input parameters * to MIG called things, another traces the outputs, and one traces bad message IDs. */ #ifdef _MIG_TRACE_PARAMETERS_ #define __BeforeRcvCallTrace(msgid, arg1, arg2, arg3, arg4) \ KERNEL_DEBUG_CONSTANT_IST(KDEBUG_TRACE, \ KDBG_MIGCODE(msgid) | DBG_FUNC_START, \ (unsigned int)(arg1), \ (unsigned int)(arg2), \ (unsigned int)(arg3), \ (unsigned int)(arg4), \ (unsigned int)(0)); #define __AfterRcvCallTrace(msgid, arg1, arg2, arg3, arg4) \ KERNEL_DEBUG_CONSTANT_IST(KDEBUG_TRACE, \ KDBG_MIGCODE(msgid) | DBG_FUNC_END, \ (unsigned int)(arg1), \ (unsigned int)(arg2), \ (unsigned int)(arg3), \ (unsigned int)(arg4), \ (unsigned int)(0)); #define __BeforeSimpleCallTrace(msgid, arg1, arg2, arg3, arg4) \ KERNEL_DEBUG_CONSTANT_IST(KDEBUG_TRACE, \ KDBG_MIGCODE(msgid) | DBG_FUNC_START, \ (unsigned int)(arg1), \ (unsigned int)(arg2), \ (unsigned int)(arg3), \ (unsigned int)(arg4), \ (unsigned int)(0)); #define __AfterSimpleCallTrace(msgid, arg1, arg2, arg3, arg4) \ KERNEL_DEBUG_CONSTANT_IST(KDEBUG_TRACE, \ KDBG_MIGCODE(msgid) | DBG_FUNC_END, \ (unsigned int)(arg1), \ (unsigned int)(arg2), \ (unsigned int)(arg3), \ (unsigned int)(arg4), \ (unsigned int)(0)); #define __BeforeKobjectServerTrace(msgid) ((void)0) #define __AfterKobjectServerTrace(msgid) ((void)0) #else /* !_MIG_TRACE_PARAMETERS_ */ #define __BeforeKobjectServerTrace(msgid) \ KERNEL_DEBUG_CONSTANT_IST(KDEBUG_TRACE, \ KDBG_MIGCODE(msgid) | DBG_FUNC_START, 0u, 0u, 0u, 0u, 0u) #define __AfterKobjectServerTrace(msgid) \ KERNEL_DEBUG_CONSTANT_IST(KDEBUG_TRACE, \ KDBG_MIGCODE(msgid) | DBG_FUNC_END, 0u, 0u, 0u, 0u, 0u) #endif /* !_MIG_TRACE_PARAMETERS_ */ #define _MIG_MSGID_INVALID(msgid) \ KERNEL_DEBUG_CONSTANT_IST(KDEBUG_TRACE, \ MACHDBG_CODE(DBG_MACH_MSGID_INVALID, (msgid)), 0u, 0u, 0u, 0u, 0u) #endif /* XNU_KERNEL_PRIVATE */ __BEGIN_DECLS /* Send a message from the kernel */ #if XNU_KERNEL_PRIVATE extern mach_msg_return_t mach_msg_send_from_kernel( mach_msg_header_t *msg, mach_msg_size_t send_size); #else extern mach_msg_return_t mach_msg_send_from_kernel_proper( mach_msg_header_t *msg, mach_msg_size_t send_size); #define mach_msg_send_from_kernel mach_msg_send_from_kernel_proper #endif /* * Allocate kernel message buffer(s) large enough to fit the message, * and accept a block that populates the message content. * * - descriptor_count: Descriptor count in the outgoing message. If non-zero, * kernel expects a complex message, and vice-versa. * * - payload_size: Size of data not processed by kernel (i.e. size of data * following the header, or last descriptor if the message is complex). * This is NOT the total size of the outgoing message. * * For memory safety the kmsg buffers allocated may occupy non-contiguous memory * and it is the caller's responsibility to correctly set up the message * based on content's offset from the mach message header, as follows: * * void (^builder)(mach_msg_header_t *header, mach_msg_descriptor_t *descs, void *payload)) * * header* ───────► ┌─────────────────────────┐ * │ │ * │ mach_msg_header_t │ * │ │ * ├─────────────────────────┤ * │(optional)mach_msg_body_t│ * descs* ───────► ├─────────────────────────┤ * │ │ * │ │ * │ │ * │ (optional)descriptors │ * │ │ * │ │ * │ │ * └─────────────────────────┘ * ~~~~~~~~void space~~~~~~~ * payload* ───────► ┌─────────────────────────┐ * │ │ * │ │ * │ other data in msg │ * │ │ * │ │ * └─────────────────────────┘ * * header: Points to the start of the message, caller should populate this * with the mach message header. * * descs: Pointers to the start of kernel descriptors region, if caller requested * a non-zero descriptor_count. Or NULL if descriptor_count is 0 (meaning * the messsage is not complex). Caller should populate this with descriptors. * * payload: Points to the start of data not processed by kernel, which is after * the last descriptor, if caller requested a non-zero payload_size. Or * NULL if payload_size is 0. * * Mach message body (descriptor count) will be set after the builder accordingly. */ #if MACH_KERNEL_PRIVATE || !XNU_KERNEL_PRIVATE extern mach_msg_return_t kernel_mach_msg_send_with_builder( mach_msg_size_t descriptor_count, mach_msg_size_t payload_size, /* Warning: NOT total send size */ void (^builder)(mach_msg_header_t *header, mach_msg_descriptor_t *__counted_by(descriptor_count)descs, /* Nullable */ void *__sized_by(payload_size)payload)); /* Nullable */ #endif /* MACH_KERNEL_PRIVATE || !XNU_KERNEL_PRIVATE */ #if XNU_KERNEL_PRIVATE extern mach_msg_return_t mach_msg_rpc_from_kernel( mach_msg_header_t *msg, mach_msg_size_t send_size, mach_msg_size_t rcv_size); extern void mach_msg_destroy_from_kernel( mach_msg_header_t *msg); #else extern mach_msg_return_t mach_msg_rpc_from_kernel_proper( mach_msg_header_t *msg, mach_msg_size_t send_size, mach_msg_size_t rcv_size); extern void mach_msg_destroy_from_kernel_proper( mach_msg_header_t *msg); #define mach_msg_rpc_from_kernel mach_msg_rpc_from_kernel_proper #define mach_msg_destroy_from_kernel mach_msg_destroy_from_kernel_proper #endif #ifdef XNU_KERNEL_PRIVATE mach_msg_return_t kernel_mach_msg_rpc( mach_msg_header_t *msg, mach_msg_size_t send_size, mach_msg_size_t rcv_size, boolean_t interruptible, boolean_t *message_moved); extern mach_msg_return_t kernel_mach_msg_send( mach_msg_header_t *msg, mach_msg_size_t send_size, mach_msg_option64_t option, mach_msg_timeout_t timeout_val, boolean_t *message_moved); extern mach_msg_return_t kernel_mach_msg_send_kmsg( struct ipc_kmsg *kmsg); extern mach_msg_return_t kernel_mach_msg_send_with_builder_internal( mach_msg_size_t desc_count, mach_msg_size_t payload_size, /* Not total send size */ mach_msg_option64_t option, mach_msg_timeout_t timeout_val, boolean_t *message_moved, void (^builder)(mach_msg_header_t *, mach_msg_descriptor_t *, void *)); extern mach_msg_return_t mach_msg_send_from_kernel_with_options( mach_msg_header_t *msg, mach_msg_size_t send_size, mach_msg_option64_t option, mach_msg_timeout_t timeout_val); #endif /* XNU_KERNEL_PRIVATE */ #ifdef MACH_KERNEL_PRIVATE extern void mach_msg_receive_continue(void); #endif /* MACH_KERNEL_PRIVATE */ __END_DECLS #endif /* _KERN_IPC_MIG_H_ */ |