osfmk/kern/ipc_tt.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,1988,1987 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  */
  58
  59 #ifndef _KERN_IPC_TT_H_
  60 #define _KERN_IPC_TT_H_
  61
  62 #include <mach/boolean.h>
  63 #include <mach/port.h>
  64 #include <vm/vm_kern.h>
  65 #include <kern/kern_types.h>
  66 #include <kern/ipc_kobject.h>
  67 #include <ipc/ipc_space.h>
  68 #include <ipc/ipc_table.h>
  69 #include <ipc/ipc_port.h>
  70 #include <ipc/ipc_right.h>
  71 #include <ipc/ipc_entry.h>
  72 #include <ipc/ipc_object.h>
  73
  74
  75 /* Initialize a task's IPC state */
  76 extern void ipc_task_init(
  77         task_t          task,
  78         task_t          parent);
  79
  80 /* Enable a task for IPC access */
  81 extern void ipc_task_enable(
  82         task_t          task);
  83
  84 /* Disable IPC access to a task */
  85 extern void ipc_task_disable(
  86         task_t          task);
  87
  88 /* Clear out a task's IPC state */
  89 extern void ipc_task_reset(
  90         task_t          task);
  91
  92 /* Clean up and destroy a task's IPC state */
  93 extern void ipc_task_terminate(
  94         task_t          task);
  95
  96 __options_decl(ipc_thread_init_options_t, uint32_t, {
  97         IPC_THREAD_INIT_NONE      = 0x00,
  98         IPC_THREAD_INIT_PINNED    = 0x01,
  99         IPC_THREAD_INIT_IMMOVABLE = 0x02,
 100 });
 101
 102 /* Initialize a thread's IPC state */
 103 extern void ipc_thread_init(
 104         thread_t        thread,
 105         ipc_thread_init_options_t options);
 106
 107 extern void ipc_thread_init_exc_actions(
 108         thread_t        thread);
 109
 110 extern void ipc_thread_destroy_exc_actions(
 111         thread_t        thread);
 112
 113 /* Disable IPC access to a thread */
 114 extern void ipc_thread_disable(
 115         thread_t        thread);
 116
 117 /* Clean up and destroy a thread's IPC state */
 118 extern void ipc_thread_terminate(
 119         thread_t        thread);
 120
 121 /* Clear out a thread's IPC state */
 122 extern void ipc_thread_reset(
 123         thread_t        thread);
 124
 125 /* Return a send right for the task's user-visible self port */
 126 extern ipc_port_t retrieve_task_self_fast(
 127         task_t          task);
 128
 129 /* Return a send right for the thread's user-visible self port */
 130 extern ipc_port_t retrieve_thread_self_fast(
 131         thread_t        thread);
 132
 133 /* Check port's type, and convert to correct task type */
 134 extern task_t convert_port_to_task_check_type(
 135         ipc_port_t           port,
 136         ipc_kobject_type_t  *kotype,
 137         mach_task_flavor_t   at_most,
 138         int                  eval_check);
 139
 140 /* Check port's type, and convert to correct thread type */
 141 extern thread_t convert_port_to_thread_check_type(
 142         ipc_port_t           port,
 143         ipc_kobject_type_t  *kotype,
 144         mach_thread_flavor_t at_most,
 145         int                  eval_check);
 146
 147 /* Check port's type, and convert to correct ipc_space type */
 148 extern ipc_space_t convert_port_to_space_check_type(
 149         ipc_port_t           port,
 150         ipc_kobject_type_t  *kotype,
 151         mach_task_flavor_t   at_most,
 152         int                  eval_check);
 153
 154 /* Convert from a port to a task name */
 155 extern task_name_t convert_port_to_task_name(
 156         ipc_port_t      port);
 157
 158 /* Convert from a port to a task for task_policy_set(). */
 159 extern task_policy_set_t convert_port_to_task_policy_set(
 160         ipc_port_t      port);
 161
 162 /* Convert from a port to a task for task_policy_get(). */
 163 extern task_policy_get_t convert_port_to_task_policy_get(
 164         ipc_port_t      port);
 165
 166 /* Convert from a port to a task inspect */
 167 extern task_inspect_t convert_port_to_task_inspect(
 168         ipc_port_t      port);
 169
 170 /* Convert from a port to a task read */
 171 extern task_read_t convert_port_to_task_read(
 172         ipc_port_t      port);
 173
 174 /* Convert from a port to a task */
 175 extern task_t convert_port_to_task(
 176         ipc_port_t      port);
 177
 178 /* Convert from a port to a pinned task */
 179 extern task_t convert_port_to_task_pinned(
 180         ipc_port_t      port);
 181
 182 extern task_t
 183 convert_port_to_task_with_exec_token(
 184         ipc_port_t              port,
 185         uint32_t                *exec_token,
 186         boolean_t               eval);
 187
 188 extern task_t port_name_to_task(
 189         mach_port_name_t name);
 190
 191 extern task_read_t port_name_to_task_read(
 192         mach_port_name_t name);
 193
 194 extern task_read_t port_name_to_task_read_no_eval(
 195         mach_port_name_t name);
 196
 197 extern task_t port_name_to_task_name(
 198         mach_port_name_t name);
 199
 200 extern host_t port_name_to_host(
 201         mach_port_name_t name);
 202
 203 extern boolean_t ref_task_port_locked(
 204         ipc_port_t port, task_t *ptask);
 205
 206 /* Convert from a port to a space */
 207 extern ipc_space_t convert_port_to_space(
 208         ipc_port_t      port);
 209
 210 /* Convert from a port to a space inspection right */
 211 extern ipc_space_read_t convert_port_to_space_read(
 212         ipc_port_t      port);
 213
 214 /* Convert from a port to a space inspection right */
 215 extern ipc_space_inspect_t convert_port_to_space_inspect(
 216         ipc_port_t      port);
 217
 218 extern boolean_t ref_space_port_locked(
 219         ipc_port_t port, ipc_space_t *pspace);
 220
 221 /* Convert from a port to a map */
 222 extern vm_map_t convert_port_to_map(
 223         ipc_port_t      port);
 224
 225 /* Convert from a port to a map read */
 226 extern vm_map_read_t convert_port_to_map_read(
 227         ipc_port_t      port);
 228
 229 /* Convert from a port to a map inspect */
 230 extern vm_map_inspect_t convert_port_to_map_inspect(
 231         ipc_port_t      port);
 232
 233 /* Convert from a port to a thread */
 234 extern thread_t convert_port_to_thread(
 235         ipc_port_t              port);
 236
 237 /* Convert from a port to a thread inspect */
 238 extern thread_inspect_t convert_port_to_thread_inspect(
 239         ipc_port_t              port);
 240
 241 /* Convert from a port to a thread read */
 242 extern thread_read_t convert_port_to_thread_read(
 243         ipc_port_t              port);
 244
 245 __options_decl(port_to_thread_options_t, uint32_t, {
 246         PORT_TO_THREAD_NONE               = 0x0000,
 247         PORT_TO_THREAD_IN_CURRENT_TASK    = 0x0001,
 248         PORT_TO_THREAD_NOT_CURRENT_THREAD = 0x0002,
 249 });
 250
 251 extern thread_t port_name_to_thread(
 252         mach_port_name_t            port_name,
 253         port_to_thread_options_t    options);
 254
 255 /* Deallocate a space ref produced by convert_port_to_space */
 256 extern void space_deallocate(
 257         ipc_space_t             space);
 258
 259 extern void space_read_deallocate(
 260         ipc_space_read_t             space);
 261
 262 extern void space_inspect_deallocate(
 263         ipc_space_inspect_t     space);
 264
 265 #if MACH_KERNEL_PRIVATE
 266 extern void ipc_thread_port_unpin(
 267         ipc_port_t port,
 268         bool check_bit);
 269 #endif
 270
 271 #endif  /* _KERN_IPC_TT_H_ */