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 /* Initialize a thread's IPC state */
  97 extern void ipc_thread_init(
  98         thread_t        thread);
  99
 100 extern void ipc_thread_init_exc_actions(
 101         thread_t        thread);
 102
 103 extern void ipc_thread_destroy_exc_actions(
 104         thread_t        thread);
 105
 106 /* Disable IPC access to a thread */
 107 extern void ipc_thread_disable(
 108         thread_t        thread);
 109
 110 /* Clean up and destroy a thread's IPC state */
 111 extern void ipc_thread_terminate(
 112         thread_t        thread);
 113
 114 /* Clear out a thread's IPC state */
 115 extern void ipc_thread_reset(
 116         thread_t        thread);
 117
 118 /* Return a send right for the task's user-visible self port */
 119 extern ipc_port_t retrieve_task_self_fast(
 120         task_t          task);
 121
 122 /* Return a send right for the thread's user-visible self port */
 123 extern ipc_port_t retrieve_thread_self_fast(
 124         thread_t        thread);
 125
 126 /* Check port's type, and convert to correct task type */
 127 extern task_t convert_port_to_task_check_type(
 128         ipc_port_t           port,
 129         ipc_kobject_type_t  *kotype,
 130         mach_task_flavor_t   at_most,
 131         int                  eval_check);
 132
 133 /* Check port's type, and convert to correct thread type */
 134 extern thread_t convert_port_to_thread_check_type(
 135         ipc_port_t           port,
 136         ipc_kobject_type_t  *kotype,
 137         mach_thread_flavor_t at_most,
 138         int                  eval_check);
 139
 140 /* Check port's type, and convert to correct ipc_space type */
 141 extern ipc_space_t convert_port_to_space_check_type(
 142         ipc_port_t           port,
 143         ipc_kobject_type_t  *kotype,
 144         mach_task_flavor_t   at_most,
 145         int                  eval_check);
 146
 147 /* Convert from a port to a task name */
 148 extern task_name_t convert_port_to_task_name(
 149         ipc_port_t      port);
 150
 151 /* Convert from a port to a task for task_policy_set(). */
 152 extern task_policy_set_t convert_port_to_task_policy_set(
 153         ipc_port_t      port);
 154
 155 /* Convert from a port to a task for task_policy_get(). */
 156 extern task_policy_get_t convert_port_to_task_policy_get(
 157         ipc_port_t      port);
 158
 159 /* Convert from a port to a task inspect */
 160 extern task_inspect_t convert_port_to_task_inspect(
 161         ipc_port_t      port);
 162
 163 /* Convert from a port to a task read */
 164 extern task_read_t convert_port_to_task_read(
 165         ipc_port_t      port);
 166
 167 /* Convert from a port to a task */
 168 extern task_t convert_port_to_task(
 169         ipc_port_t      port);
 170
 171 extern task_t
 172 convert_port_to_task_with_exec_token(
 173         ipc_port_t              port,
 174         uint32_t                *exec_token,
 175         boolean_t               eval);
 176
 177 extern task_t port_name_to_task(
 178         mach_port_name_t name);
 179
 180 extern task_read_t port_name_to_task_read(
 181         mach_port_name_t name);
 182
 183 extern task_read_t port_name_to_task_read_no_eval(
 184         mach_port_name_t name);
 185
 186 extern task_inspect_t port_name_to_task_inspect(
 187         mach_port_name_t name);
 188
 189 extern task_t port_name_to_task_name(
 190         mach_port_name_t name);
 191
 192 extern host_t port_name_to_host(
 193         mach_port_name_t name);
 194
 195 extern boolean_t ref_task_port_locked(
 196         ipc_port_t port, task_t *ptask);
 197
 198 /* Convert from a port to a space */
 199 extern ipc_space_t convert_port_to_space(
 200         ipc_port_t      port);
 201
 202 /* Convert from a port to a space inspection right */
 203 extern ipc_space_read_t convert_port_to_space_read(
 204         ipc_port_t      port);
 205
 206 /* Convert from a port to a space inspection right */
 207 extern ipc_space_inspect_t convert_port_to_space_inspect(
 208         ipc_port_t      port);
 209
 210 extern boolean_t ref_space_port_locked(
 211         ipc_port_t port, ipc_space_t *pspace);
 212
 213 /* Convert from a port to a map */
 214 extern vm_map_t convert_port_to_map(
 215         ipc_port_t      port);
 216
 217 /* Convert from a port to a map read */
 218 extern vm_map_read_t convert_port_to_map_read(
 219         ipc_port_t      port);
 220
 221 /* Convert from a port to a map inspect */
 222 extern vm_map_inspect_t convert_port_to_map_inspect(
 223         ipc_port_t      port);
 224
 225 /* Convert from a port to a thread */
 226 extern thread_t convert_port_to_thread(
 227         ipc_port_t              port);
 228
 229 /* Convert from a port to a thread inspect */
 230 extern thread_inspect_t convert_port_to_thread_inspect(
 231         ipc_port_t              port);
 232
 233 /* Convert from a port to a thread read */
 234 extern thread_read_t convert_port_to_thread_read(
 235         ipc_port_t              port);
 236
 237 __options_decl(port_to_thread_options_t, uint32_t, {
 238         PORT_TO_THREAD_NONE               = 0x0000,
 239         PORT_TO_THREAD_IN_CURRENT_TASK    = 0x0001,
 240         PORT_TO_THREAD_NOT_CURRENT_THREAD = 0x0002,
 241 });
 242
 243 extern thread_t port_name_to_thread(
 244         mach_port_name_t            port_name,
 245         port_to_thread_options_t    options);
 246
 247 /* Deallocate a space ref produced by convert_port_to_space */
 248 extern void space_deallocate(
 249         ipc_space_t             space);
 250
 251 extern void space_read_deallocate(
 252         ipc_space_read_t             space);
 253
 254 extern void space_inspect_deallocate(
 255         ipc_space_inspect_t     space);
 256
 257 #endif  /* _KERN_IPC_TT_H_ */