1/* 2 * Copyright (c) 2000-2007 Apple 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_FREE_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 */ 58/* 59 * File: mach/mach_port.defs 60 * Author: Rich Draves 61 * 62 * Exported kernel calls. 63 */ 64 65subsystem 66#if KERNEL_SERVER 67 KernelServer 68#endif /* KERNEL_SERVER */ 69 thread_act 3600; 70 71#include <mach/std_types.defs> 72#include <mach/mach_types.defs> 73 74/* 75 * Destroy the target thread. 76 * 77 * JMM - For legacy reasons this consumes a reference to the 78 * target thread. This will have to change in the future because 79 * we want the interfaces to be able to be defined in more standard 80 * IDLs and transports, and most of them do not support the notion 81 * of reference ownership transfers (just sharing). 82 */ 83routine thread_terminate( 84 target_act : thread_act_consume_ref_t); 85 86 87/* 88 * Return the selected state information for the target 89 * thr_act. If the thr_act is currently executing, the results 90 * may be stale. [Flavor THREAD_STATE_FLAVOR_LIST provides a 91 * list of valid flavors for the target thread.] 92 */ 93routine act_get_state( 94 target_act : thread_act_t; 95 flavor : int; 96 out old_state : thread_state_t, CountInOut); 97 98/* 99 * Set the selected state information for the target thread. 100 * If the thread is currently executing, the state change 101 * may be ill-defined. 102 */ 103routine 104#ifdef KERNEL_SERVER 105act_set_state_from_user( 106#else 107act_set_state( 108#endif 109 target_act : thread_act_t; 110 flavor : int; 111 new_state : thread_state_t); 112 113/* 114 * Backward compatible old-style thread routines. 115 * These have different semantics than the new activation versions. 116 * 117 * Return the selected state information for the target 118 * thread. If the thread is currently executing, the results 119 * may be stale. [Flavor THREAD_STATE_FLAVOR_LIST provides a 120 * list of valid flavors for the target thr_act.] 121 */ 122routine thread_get_state( 123 target_act : thread_act_t; 124 flavor : thread_state_flavor_t; 125 out old_state : thread_state_t, CountInOut); 126 127/* 128 * Set the selected state information for the target thread. 129 * If the thread is currently executing, the state change 130 * may be ill-defined. 131 */ 132routine 133#ifdef KERNEL_SERVER 134thread_set_state_from_user( 135#else 136thread_set_state( 137#endif 138 target_act : thread_act_t; 139 flavor : thread_state_flavor_t; 140 new_state : thread_state_t); 141 142/* 143 * Increment the suspend count for the target thread. 144 * Once this call has completed, the thread will not 145 * execute any further user or meta- instructions. 146 * Once suspended, a thread may not execute again until 147 * its suspend count is zero, and the suspend count 148 * for its task is also zero. 149 */ 150routine thread_suspend( 151 target_act : thread_act_t); 152 153/* 154 * Decrement the suspend count for the target thread, 155 * if that count is not already zero. 156 */ 157routine thread_resume( 158 target_act : thread_act_t); 159 160/* 161 * Cause any user or meta- instructions currently being 162 * executed by the target thread to be aborted. [Meta- 163 * instructions consist of the basic traps for IPC 164 * (e.g., msg_send, msg_receive) and self-identification 165 * (e.g., task_self, thread_self, thread_reply). Calls 166 * described by MiG interfaces are not meta-instructions 167 * themselves.] 168 */ 169routine thread_abort( 170 target_act : thread_act_t); 171 172/* 173 * Cause any user or meta- instructions currently being 174 * executed by the target thread to be aborted so that 175 * they are transparently restartable. This call fails 176 * if the abort would result in a non-restartable condition. 177 * Retry is the caller's responsibility. [Meta- 178 * instructions consist of the basic traps for IPC 179 * (e.g., msg_send, msg_receive) and self-identification 180 * (e.g., task_self, thread_self, thread_reply). Calls 181 * described by MiG interfaces are not meta-instructions 182 * themselves.] 183 */ 184routine thread_abort_safely( 185 target_act : thread_act_t); 186 187 188routine thread_depress_abort( 189 thread : thread_act_t); 190 191 192/* 193 * Returns the current value of the selected special port 194 * associated with the target thread. 195 */ 196routine thread_get_special_port( 197 thr_act : thread_act_t; 198 which_port : int; 199 out special_port : mach_port_t); 200 201/* 202 * Set one of the special ports associated with the 203 * target thread. 204 */ 205routine thread_set_special_port( 206 thr_act : thread_act_t; 207 which_port : int; 208 special_port : mach_port_t); 209 210/* 211 * Returns information about the target thread. 212 */ 213routine thread_info( 214 target_act : thread_act_t; 215 flavor : thread_flavor_t; 216 out thread_info_out : thread_info_t, CountInOut); 217 218/* 219 * Set an exception handler for a thread on one or more exception types 220 */ 221routine thread_set_exception_ports( 222 thread : thread_act_t; 223 exception_mask : exception_mask_t; 224 new_port : mach_port_t; 225 behavior : exception_behavior_t; 226 new_flavor : thread_state_flavor_t); 227 228/* 229 * Lookup some of the old exception handlers for a thread 230 */ 231routine thread_get_exception_ports( 232 thread : thread_act_t; 233 exception_mask : exception_mask_t; 234 out masks : exception_mask_array_t; 235 out old_handlers : exception_handler_array_t, SameCount; 236 out old_behaviors : exception_behavior_array_t, SameCount; 237 out old_flavors : exception_flavor_array_t, SameCount); 238 239/* 240 * Set an exception handler for a thread on one or more exception types. 241 * At the same time, return the previously defined exception handlers for 242 * those types. 243 */ 244routine thread_swap_exception_ports( 245 thread : thread_act_t; 246 exception_mask : exception_mask_t; 247 new_port : mach_port_t; 248 behavior : exception_behavior_t; 249 new_flavor : thread_state_flavor_t; 250 out masks : exception_mask_array_t; 251 out old_handlers : exception_handler_array_t, SameCount; 252 out old_behaviors : exception_behavior_array_t, SameCount; 253 out old_flavors : exception_flavor_array_t, SameCount); 254 255/* 256 * OBSOLETE interface. 257 */ 258routine thread_policy( 259 thr_act : thread_act_t; 260 policy : policy_t; 261 base : policy_base_t; 262 set_limit : boolean_t); 263 264/* 265 * Set/get policy information for a thread. 266 * (Approved Mac OS X microkernel interface) 267 */ 268 269routine thread_policy_set( 270 thread : thread_act_t; 271 flavor : thread_policy_flavor_t; 272 policy_info : thread_policy_t); 273 274routine thread_policy_get( 275 thread : thread_act_t; 276 flavor : thread_policy_flavor_t; 277out policy_info : thread_policy_t, CountInOut; 278inout get_default : boolean_t); 279 280/* 281 * Removed from the kernel. 282 */ 283#if KERNEL_SERVER 284skip; 285#else 286routine thread_sample( 287 thread : thread_act_t; 288 reply : mach_port_make_send_t); 289#endif 290 291/* 292 * ETAP has been removed from the kernel. 293 */ 294#if KERNEL_SERVER 295skip; 296#else 297routine etap_trace_thread( 298 target_act : thread_act_t; 299 trace_status : boolean_t); 300#endif 301 302/* 303 * Assign thread to processor set. 304 */ 305routine thread_assign( 306 thread : thread_act_t; 307 new_set : processor_set_t); 308 309/* 310 * Assign thread to default set. 311 */ 312routine thread_assign_default( 313 thread : thread_act_t); 314 315/* 316 * Get current assignment for thread. 317 */ 318routine thread_get_assignment( 319 thread : thread_act_t; 320 out assigned_set : processor_set_name_t); 321 322 323/* 324 * OBSOLETE interface. 325 */ 326routine thread_set_policy( 327 thr_act : thread_act_t; 328 pset : processor_set_t; 329 policy : policy_t; 330 base : policy_base_t; 331 limit : policy_limit_t); 332 333/* vim: set ft=c : */ 334