| 1 | /*␊ |
| 2 | * Copyright (c) 2000-2006 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 | */␊ |
| 58 | /*␊ |
| 59 | *␉File:␉thread_status.h␊ |
| 60 | *␉Author:␉Avadis Tevanian, Jr.␊ |
| 61 | *␉Date:␉1985␊ |
| 62 | *␊ |
| 63 | *␉This file contains the structure definitions for the thread␊ |
| 64 | *␉state as applied to I386 processors.␊ |
| 65 | */␊ |
| 66 | ␊ |
| 67 | #ifndef␉_MACH_I386_THREAD_STATUS_H_␊ |
| 68 | #define _MACH_I386_THREAD_STATUS_H_␊ |
| 69 | ␊ |
| 70 | #include <mach/i386/_structs.h>␊ |
| 71 | #include <mach/message.h>␊ |
| 72 | #include <mach/i386/fp_reg.h>␊ |
| 73 | #include <mach/i386/thread_state.h>␊ |
| 74 | #include <i386/eflags.h>␊ |
| 75 | ␊ |
| 76 | /*␊ |
| 77 | * the i386_xxxx form is kept for legacy purposes since these types␊ |
| 78 | * are externally known... eventually they should be deprecated.␊ |
| 79 | * our internal implementation has moved to the following naming convention␊ |
| 80 | *␊ |
| 81 | * x86_xxxx32 names are used to deal with 32 bit states␊ |
| 82 | * x86_xxxx64 names are used to deal with 64 bit states␊ |
| 83 | * x86_xxxx names are used to deal with either 32 or 64 bit states␊ |
| 84 | *␉via a self-describing mechanism␊ |
| 85 | */␊ |
| 86 | ␊ |
| 87 | /*␊ |
| 88 | * these are the legacy names which should be deprecated in the future␊ |
| 89 | * they are externally known which is the only reason we don't just get␊ |
| 90 | * rid of them␊ |
| 91 | */␊ |
| 92 | #define i386_THREAD_STATE␉␉1␊ |
| 93 | #define i386_FLOAT_STATE␉␉2␊ |
| 94 | #define i386_EXCEPTION_STATE␉␉3␊ |
| 95 | ␊ |
| 96 | /*␊ |
| 97 | * THREAD_STATE_FLAVOR_LIST 0␊ |
| 98 | * ␉these are the supported flavors␊ |
| 99 | */␊ |
| 100 | #define x86_THREAD_STATE32␉␉1␊ |
| 101 | #define x86_FLOAT_STATE32␉␉2␊ |
| 102 | #define x86_EXCEPTION_STATE32␉␉3␊ |
| 103 | #define x86_THREAD_STATE64␉␉4␊ |
| 104 | #define x86_FLOAT_STATE64␉␉5␊ |
| 105 | #define x86_EXCEPTION_STATE64␉␉6␊ |
| 106 | #define x86_THREAD_STATE␉␉7␊ |
| 107 | #define x86_FLOAT_STATE␉␉␉8␊ |
| 108 | #define x86_EXCEPTION_STATE␉␉9␊ |
| 109 | #define x86_DEBUG_STATE32␉␉10␊ |
| 110 | #define x86_DEBUG_STATE64␉␉11␊ |
| 111 | #define x86_DEBUG_STATE␉␉␉12␊ |
| 112 | #define THREAD_STATE_NONE␉␉13␊ |
| 113 | /* 15 and 16 are used for the internal x86_SAVED_STATE flavours */␊ |
| 114 | #define x86_AVX_STATE32␉␉␉16␊ |
| 115 | #define x86_AVX_STATE64␉␉␉17␊ |
| 116 | ␊ |
| 117 | ␊ |
| 118 | /*␊ |
| 119 | * Largest state on this machine:␊ |
| 120 | * (be sure mach/machine/thread_state.h matches!)␊ |
| 121 | */␊ |
| 122 | #define THREAD_MACHINE_STATE_MAX␉THREAD_STATE_MAX␊ |
| 123 | ␊ |
| 124 | /*␊ |
| 125 | * VALID_THREAD_STATE_FLAVOR is a platform specific macro that when passed␊ |
| 126 | * an exception flavor will return if that is a defined flavor for that␊ |
| 127 | * platform. The macro must be manually updated to include all of the valid␊ |
| 128 | * exception flavors as defined above.␊ |
| 129 | */␊ |
| 130 | #define VALID_THREAD_STATE_FLAVOR(x) \␊ |
| 131 | ␉ ((x == x86_THREAD_STATE32)␉|| \␊ |
| 132 | ␉ (x == x86_FLOAT_STATE32)␉|| \␊ |
| 133 | ␉ (x == x86_EXCEPTION_STATE32)␉|| \␊ |
| 134 | ␉ (x == x86_DEBUG_STATE32)␉|| \␊ |
| 135 | ␉ (x == x86_THREAD_STATE64)␉|| \␊ |
| 136 | ␉ (x == x86_FLOAT_STATE64)␉|| \␊ |
| 137 | ␉ (x == x86_EXCEPTION_STATE64)␉|| \␊ |
| 138 | ␉ (x == x86_DEBUG_STATE64)␉|| \␊ |
| 139 | ␉ (x == x86_THREAD_STATE)␉|| \␊ |
| 140 | ␉ (x == x86_FLOAT_STATE)␉|| \␊ |
| 141 | ␉ (x == x86_EXCEPTION_STATE)␉|| \␊ |
| 142 | ␉ (x == x86_DEBUG_STATE)␉|| \␊ |
| 143 | ␉ (x == x86_AVX_STATE32)␉|| \␊ |
| 144 | ␉ (x == x86_AVX_STATE64)␉|| \␊ |
| 145 | ␉ (x == THREAD_STATE_NONE))␊ |
| 146 | ␊ |
| 147 | struct x86_state_hdr {␊ |
| 148 | ␉int␉flavor;␊ |
| 149 | ␉int␉count;␊ |
| 150 | };␊ |
| 151 | typedef struct x86_state_hdr x86_state_hdr_t;␊ |
| 152 | ␊ |
| 153 | /*␊ |
| 154 | * Default segment register values.␊ |
| 155 | */␊ |
| 156 | ␊ |
| 157 | #define USER_CODE_SELECTOR␉0x0017␊ |
| 158 | #define USER_DATA_SELECTOR␉0x001f␊ |
| 159 | #define KERN_CODE_SELECTOR␉0x0008␊ |
| 160 | #define KERN_DATA_SELECTOR␉0x0010␊ |
| 161 | ␊ |
| 162 | /*␊ |
| 163 | * to be deprecated in the future␊ |
| 164 | */␊ |
| 165 | typedef _STRUCT_X86_THREAD_STATE32 i386_thread_state_t;␊ |
| 166 | #define i386_THREAD_STATE_COUNT␉((mach_msg_type_number_t) \␊ |
| 167 | ( sizeof (i386_thread_state_t) / sizeof (int) ))␊ |
| 168 | ␊ |
| 169 | typedef _STRUCT_X86_THREAD_STATE32 x86_thread_state32_t;␊ |
| 170 | #define x86_THREAD_STATE32_COUNT␉((mach_msg_type_number_t) \␊ |
| 171 | ( sizeof (x86_thread_state32_t) / sizeof (int) ))␊ |
| 172 | ␊ |
| 173 | /*␊ |
| 174 | * to be deprecated in the future␊ |
| 175 | */␊ |
| 176 | typedef _STRUCT_X86_FLOAT_STATE32 i386_float_state_t;␊ |
| 177 | #define i386_FLOAT_STATE_COUNT ((mach_msg_type_number_t) \␊ |
| 178 | ␉␉(sizeof(i386_float_state_t)/sizeof(unsigned int)))␊ |
| 179 | ␊ |
| 180 | typedef _STRUCT_X86_FLOAT_STATE32 x86_float_state32_t;␊ |
| 181 | #define x86_FLOAT_STATE32_COUNT ((mach_msg_type_number_t) \␊ |
| 182 | ␉␉(sizeof(x86_float_state32_t)/sizeof(unsigned int)))␊ |
| 183 | ␊ |
| 184 | typedef _STRUCT_X86_AVX_STATE32 x86_avx_state32_t;␊ |
| 185 | #define x86_AVX_STATE32_COUNT ((mach_msg_type_number_t) \␊ |
| 186 | ␉␉(sizeof(x86_avx_state32_t)/sizeof(unsigned int)))␊ |
| 187 | ␊ |
| 188 | /*␊ |
| 189 | * to be deprecated in the future␊ |
| 190 | */␊ |
| 191 | typedef _STRUCT_X86_EXCEPTION_STATE32 i386_exception_state_t;␊ |
| 192 | #define i386_EXCEPTION_STATE_COUNT␉((mach_msg_type_number_t) \␊ |
| 193 | ( sizeof (i386_exception_state_t) / sizeof (int) ))␊ |
| 194 | ␊ |
| 195 | typedef _STRUCT_X86_EXCEPTION_STATE32 x86_exception_state32_t;␊ |
| 196 | #define x86_EXCEPTION_STATE32_COUNT␉((mach_msg_type_number_t) \␊ |
| 197 | ( sizeof (x86_exception_state32_t) / sizeof (int) ))␊ |
| 198 | ␊ |
| 199 | #define I386_EXCEPTION_STATE_COUNT i386_EXCEPTION_STATE_COUNT␊ |
| 200 | ␊ |
| 201 | typedef _STRUCT_X86_DEBUG_STATE32 x86_debug_state32_t;␊ |
| 202 | #define x86_DEBUG_STATE32_COUNT ((mach_msg_type_number_t) \␊ |
| 203 | ␉( sizeof (x86_debug_state32_t) / sizeof (int) ))␊ |
| 204 | ␊ |
| 205 | #define X86_DEBUG_STATE32_COUNT x86_DEBUG_STATE32_COUNT␊ |
| 206 | ␊ |
| 207 | typedef _STRUCT_X86_THREAD_STATE64 x86_thread_state64_t;␊ |
| 208 | #define x86_THREAD_STATE64_COUNT␉((mach_msg_type_number_t) \␊ |
| 209 | ( sizeof (x86_thread_state64_t) / sizeof (int) ))␊ |
| 210 | ␊ |
| 211 | typedef _STRUCT_X86_FLOAT_STATE64 x86_float_state64_t;␊ |
| 212 | #define x86_FLOAT_STATE64_COUNT ((mach_msg_type_number_t) \␊ |
| 213 | ␉␉(sizeof(x86_float_state64_t)/sizeof(unsigned int)))␊ |
| 214 | ␊ |
| 215 | typedef _STRUCT_X86_AVX_STATE64 x86_avx_state64_t;␊ |
| 216 | #define x86_AVX_STATE64_COUNT ((mach_msg_type_number_t) \␊ |
| 217 | ␉␉(sizeof(x86_avx_state64_t)/sizeof(unsigned int)))␊ |
| 218 | ␊ |
| 219 | typedef _STRUCT_X86_EXCEPTION_STATE64 x86_exception_state64_t;␊ |
| 220 | #define x86_EXCEPTION_STATE64_COUNT␉((mach_msg_type_number_t) \␊ |
| 221 | ( sizeof (x86_exception_state64_t) / sizeof (int) ))␊ |
| 222 | ␊ |
| 223 | #define X86_EXCEPTION_STATE64_COUNT x86_EXCEPTION_STATE64_COUNT␊ |
| 224 | ␊ |
| 225 | typedef _STRUCT_X86_DEBUG_STATE64 x86_debug_state64_t;␊ |
| 226 | #define x86_DEBUG_STATE64_COUNT␉((mach_msg_type_number_t) \␊ |
| 227 | ( sizeof (x86_debug_state64_t) / sizeof (int) ))␊ |
| 228 | ␊ |
| 229 | #define X86_DEBUG_STATE64_COUNT x86_DEBUG_STATE64_COUNT␊ |
| 230 | ␊ |
| 231 | /*␊ |
| 232 | * Combined thread, float and exception states␊ |
| 233 | */␊ |
| 234 | struct x86_thread_state {␊ |
| 235 | ␉x86_state_hdr_t␉␉␉tsh;␊ |
| 236 | ␉union {␊ |
| 237 | ␉ x86_thread_state32_t␉ts32;␊ |
| 238 | ␉ x86_thread_state64_t␉ts64;␊ |
| 239 | ␉} uts;␊ |
| 240 | };␊ |
| 241 | ␊ |
| 242 | struct x86_float_state {␊ |
| 243 | ␉x86_state_hdr_t␉␉␉fsh;␊ |
| 244 | ␉union {␊ |
| 245 | ␉␉x86_float_state32_t␉fs32;␊ |
| 246 | ␉␉x86_float_state64_t␉fs64;␊ |
| 247 | ␉} ufs;␊ |
| 248 | };␊ |
| 249 | ␊ |
| 250 | struct x86_exception_state {␊ |
| 251 | ␉x86_state_hdr_t␉␉␉esh;␊ |
| 252 | ␉union {␊ |
| 253 | ␉␉x86_exception_state32_t␉es32;␊ |
| 254 | ␉␉x86_exception_state64_t␉es64;␊ |
| 255 | ␉} ues;␊ |
| 256 | };␊ |
| 257 | ␊ |
| 258 | struct x86_debug_state {␊ |
| 259 | ␉x86_state_hdr_t␉␉␉dsh;␊ |
| 260 | ␉union {␊ |
| 261 | ␉␉x86_debug_state32_t␉ds32;␊ |
| 262 | ␉␉x86_debug_state64_t␉ds64;␊ |
| 263 | ␉} uds;␊ |
| 264 | };␊ |
| 265 | ␊ |
| 266 | typedef struct x86_thread_state x86_thread_state_t;␊ |
| 267 | #define x86_THREAD_STATE_COUNT␉((mach_msg_type_number_t) \␊ |
| 268 | ␉␉( sizeof (x86_thread_state_t) / sizeof (int) ))␊ |
| 269 | ␊ |
| 270 | typedef struct x86_float_state x86_float_state_t;␊ |
| 271 | #define x86_FLOAT_STATE_COUNT ((mach_msg_type_number_t) \␊ |
| 272 | ␉␉(sizeof(x86_float_state_t)/sizeof(unsigned int)))␊ |
| 273 | ␊ |
| 274 | typedef struct x86_exception_state x86_exception_state_t;␊ |
| 275 | #define x86_EXCEPTION_STATE_COUNT ((mach_msg_type_number_t) \␊ |
| 276 | ␉␉(sizeof(x86_exception_state_t)/sizeof(unsigned int)))␊ |
| 277 | ␊ |
| 278 | typedef struct x86_debug_state x86_debug_state_t;␊ |
| 279 | #define x86_DEBUG_STATE_COUNT ((mach_msg_type_number_t) \␊ |
| 280 | ␉␉(sizeof(x86_debug_state_t)/sizeof(unsigned int)))␊ |
| 281 | ␊ |
| 282 | /*␊ |
| 283 | * Machine-independent way for servers and Mach's exception mechanism to␊ |
| 284 | * choose the most efficient state flavor for exception RPC's:␊ |
| 285 | */␊ |
| 286 | #define MACHINE_THREAD_STATE␉␉x86_THREAD_STATE␊ |
| 287 | #define MACHINE_THREAD_STATE_COUNT␉x86_THREAD_STATE_COUNT␊ |
| 288 | ␊ |
| 289 | /*␊ |
| 290 | * when reloading the segment registers on␊ |
| 291 | * a return out of the kernel, we may take␊ |
| 292 | * a GeneralProtection or SegmentNotPresent␊ |
| 293 | * fault if one or more of the segment␊ |
| 294 | * registers in the saved state was improperly␊ |
| 295 | * specified via an x86_THREAD_STATE32 call␊ |
| 296 | * the frame we push on top of the existing␊ |
| 297 | * save area looks like this... we need to␊ |
| 298 | * carry this as part of the save area␊ |
| 299 | * in case we get hit so that we have a big␊ |
| 300 | * enough stack␊ |
| 301 | */␊ |
| 302 | struct x86_seg_load_fault32 {␊ |
| 303 | ␉uint16_t␉trapno;␊ |
| 304 | ␉uint16_t␉cpu;␊ |
| 305 | ␉uint32_t␉err;␊ |
| 306 | ␉uint32_t␉eip;␊ |
| 307 | ␉uint32_t␉cs;␊ |
| 308 | ␉uint32_t␉efl;␊ |
| 309 | };␊ |
| 310 | ␊ |
| 311 | ␊ |
| 312 | #endif␉/* _MACH_I386_THREAD_STATUS_H_ */␊ |
| 313 | |
