1 /*
2 * Copyright (c) 2000-2020 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 [email protected]
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 #if defined (__i386__) || defined (__x86_64__)
71
72 #include <mach/machine/_structs.h>
73 #include <mach/machine/thread_state.h>
74 #include <mach/message.h>
75 #include <mach/i386/fp_reg.h>
76 #include <i386/eflags.h>
77
78 #ifdef KERNEL_PRIVATE
79 #include <i386/proc_reg.h>
80 #endif
81
82 /*
83 * the i386_xxxx form is kept for legacy purposes since these types
84 * are externally known... eventually they should be deprecated.
85 * our internal implementation has moved to the following naming convention
86 *
87 * x86_xxxx32 names are used to deal with 32 bit states
88 * x86_xxxx64 names are used to deal with 64 bit states
89 * x86_xxxx names are used to deal with either 32 or 64 bit states
90 * via a self-describing mechanism
91 */
92
93 /*
94 * these are the legacy names which should be deprecated in the future
95 * they are externally known which is the only reason we don't just get
96 * rid of them
97 */
98 #define i386_THREAD_STATE 1
99 #define i386_FLOAT_STATE 2
100 #define i386_EXCEPTION_STATE 3
101
102 /*
103 * THREAD_STATE_FLAVOR_LIST 0
104 * these are the supported flavors
105 */
106 #define x86_THREAD_STATE32 1
107 #define x86_FLOAT_STATE32 2
108 #define x86_EXCEPTION_STATE32 3
109 #define x86_THREAD_STATE64 4
110 #define x86_FLOAT_STATE64 5
111 #define x86_EXCEPTION_STATE64 6
112 #define x86_THREAD_STATE 7
113 #define x86_FLOAT_STATE 8
114 #define x86_EXCEPTION_STATE 9
115 #define x86_DEBUG_STATE32 10
116 #define x86_DEBUG_STATE64 11
117 #define x86_DEBUG_STATE 12
118 #define THREAD_STATE_NONE 13
119 /* 14 and 15 are used for the internal x86_SAVED_STATE flavours */
120 /* Arrange for flavors to take sequential values, 32-bit, 64-bit, non-specific */
121 #define x86_AVX_STATE32 16
122 #define x86_AVX_STATE64 (x86_AVX_STATE32 + 1)
123 #define x86_AVX_STATE (x86_AVX_STATE32 + 2)
124 #define x86_AVX512_STATE32 19
125 #define x86_AVX512_STATE64 (x86_AVX512_STATE32 + 1)
126 #define x86_AVX512_STATE (x86_AVX512_STATE32 + 2)
127 #define x86_PAGEIN_STATE 22
128 #define x86_THREAD_FULL_STATE64 23
129 #define x86_INSTRUCTION_STATE 24
130 #define x86_LAST_BRANCH_STATE 25
131
132 /*
133 * Largest state on this machine:
134 * (be sure mach/machine/thread_state.h matches!)
135 */
136 #define THREAD_MACHINE_STATE_MAX THREAD_STATE_MAX
137
138 /*
139 * VALID_THREAD_STATE_FLAVOR is a platform specific macro that when passed
140 * an exception flavor will return if that is a defined flavor for that
141 * platform. The macro must be manually updated to include all of the valid
142 * exception flavors as defined above.
143 */
144 #define VALID_THREAD_STATE_FLAVOR(x) \
145 ((x == x86_THREAD_STATE32) || \
146 (x == x86_FLOAT_STATE32) || \
147 (x == x86_EXCEPTION_STATE32) || \
148 (x == x86_DEBUG_STATE32) || \
149 (x == x86_THREAD_STATE64) || \
150 (x == x86_THREAD_FULL_STATE64) || \
151 (x == x86_FLOAT_STATE64) || \
152 (x == x86_EXCEPTION_STATE64) || \
153 (x == x86_DEBUG_STATE64) || \
154 (x == x86_THREAD_STATE) || \
155 (x == x86_FLOAT_STATE) || \
156 (x == x86_EXCEPTION_STATE) || \
157 (x == x86_DEBUG_STATE) || \
158 (x == x86_AVX_STATE32) || \
159 (x == x86_AVX_STATE64) || \
160 (x == x86_AVX_STATE) || \
161 (x == x86_AVX512_STATE32) || \
162 (x == x86_AVX512_STATE64) || \
163 (x == x86_AVX512_STATE) || \
164 (x == x86_PAGEIN_STATE) || \
165 (x == x86_INSTRUCTION_STATE) || \
166 (x == x86_LAST_BRANCH_STATE) || \
167 (x == THREAD_STATE_NONE))
168
169 struct x86_state_hdr {
170 uint32_t flavor;
171 uint32_t count;
172 };
173 typedef struct x86_state_hdr x86_state_hdr_t;
174
175 /*
176 * Default segment register values.
177 */
178
179 #define USER_CODE_SELECTOR 0x0017
180 #define USER_DATA_SELECTOR 0x001f
181 #define KERN_CODE_SELECTOR 0x0008
182 #define KERN_DATA_SELECTOR 0x0010
183
184 /*
185 * to be deprecated in the future
186 */
187 typedef _STRUCT_X86_THREAD_STATE32 i386_thread_state_t;
188 #define i386_THREAD_STATE_COUNT ((mach_msg_type_number_t) \
189 ( sizeof (i386_thread_state_t) / sizeof (int) ))
190
191 typedef _STRUCT_X86_THREAD_STATE32 x86_thread_state32_t;
192 #define x86_THREAD_STATE32_COUNT ((mach_msg_type_number_t) \
193 ( sizeof (x86_thread_state32_t) / sizeof (int) ))
194
195 /*
196 * to be deprecated in the future
197 */
198 typedef _STRUCT_X86_FLOAT_STATE32 i386_float_state_t;
199 #define i386_FLOAT_STATE_COUNT ((mach_msg_type_number_t) \
200 (sizeof(i386_float_state_t)/sizeof(unsigned int)))
201
202 typedef _STRUCT_X86_FLOAT_STATE32 x86_float_state32_t;
203 #define x86_FLOAT_STATE32_COUNT ((mach_msg_type_number_t) \
204 (sizeof(x86_float_state32_t)/sizeof(unsigned int)))
205
206 typedef _STRUCT_X86_AVX_STATE32 x86_avx_state32_t;
207 #define x86_AVX_STATE32_COUNT ((mach_msg_type_number_t) \
208 (sizeof(x86_avx_state32_t)/sizeof(unsigned int)))
209
210 typedef _STRUCT_X86_AVX512_STATE32 x86_avx512_state32_t;
211 #define x86_AVX512_STATE32_COUNT ((mach_msg_type_number_t) \
212 (sizeof(x86_avx512_state32_t)/sizeof(unsigned int)))
213
214 /*
215 * to be deprecated in the future
216 */
217 typedef _STRUCT_X86_EXCEPTION_STATE32 i386_exception_state_t;
218 #define i386_EXCEPTION_STATE_COUNT ((mach_msg_type_number_t) \
219 ( sizeof (i386_exception_state_t) / sizeof (int) ))
220
221 typedef _STRUCT_X86_EXCEPTION_STATE32 x86_exception_state32_t;
222 #define x86_EXCEPTION_STATE32_COUNT ((mach_msg_type_number_t) \
223 ( sizeof (x86_exception_state32_t) / sizeof (int) ))
224
225 #define I386_EXCEPTION_STATE_COUNT i386_EXCEPTION_STATE_COUNT
226
227 typedef _STRUCT_X86_DEBUG_STATE32 x86_debug_state32_t;
228 #define x86_DEBUG_STATE32_COUNT ((mach_msg_type_number_t) \
229 ( sizeof (x86_debug_state32_t) / sizeof (int) ))
230
231 #define X86_DEBUG_STATE32_COUNT x86_DEBUG_STATE32_COUNT
232
233 typedef _STRUCT_X86_THREAD_STATE64 x86_thread_state64_t;
234 #define x86_THREAD_STATE64_COUNT ((mach_msg_type_number_t) \
235 ( sizeof (x86_thread_state64_t) / sizeof (int) ))
236
237 typedef _STRUCT_X86_THREAD_FULL_STATE64 x86_thread_full_state64_t;
238 #define x86_THREAD_FULL_STATE64_COUNT ((mach_msg_type_number_t) \
239 ( sizeof (x86_thread_full_state64_t) / sizeof (int) ))
240
241 typedef _STRUCT_X86_FLOAT_STATE64 x86_float_state64_t;
242 #define x86_FLOAT_STATE64_COUNT ((mach_msg_type_number_t) \
243 (sizeof(x86_float_state64_t)/sizeof(unsigned int)))
244
245 typedef _STRUCT_X86_AVX_STATE64 x86_avx_state64_t;
246 #define x86_AVX_STATE64_COUNT ((mach_msg_type_number_t) \
247 (sizeof(x86_avx_state64_t)/sizeof(unsigned int)))
248
249 typedef _STRUCT_X86_AVX512_STATE64 x86_avx512_state64_t;
250 #define x86_AVX512_STATE64_COUNT ((mach_msg_type_number_t) \
251 (sizeof(x86_avx512_state64_t)/sizeof(unsigned int)))
252
253 typedef _STRUCT_X86_EXCEPTION_STATE64 x86_exception_state64_t;
254 #define x86_EXCEPTION_STATE64_COUNT ((mach_msg_type_number_t) \
255 ( sizeof (x86_exception_state64_t) / sizeof (int) ))
256
257 #define X86_EXCEPTION_STATE64_COUNT x86_EXCEPTION_STATE64_COUNT
258
259 typedef _STRUCT_X86_DEBUG_STATE64 x86_debug_state64_t;
260 #define x86_DEBUG_STATE64_COUNT ((mach_msg_type_number_t) \
261 ( sizeof (x86_debug_state64_t) / sizeof (int) ))
262
263 #define X86_DEBUG_STATE64_COUNT x86_DEBUG_STATE64_COUNT
264
265 typedef _STRUCT_X86_PAGEIN_STATE x86_pagein_state_t;
266 #define x86_PAGEIN_STATE_COUNT \
267 ((mach_msg_type_number_t)(sizeof(x86_pagein_state_t) / sizeof(int)))
268
269 #define X86_PAGEIN_STATE_COUNT x86_PAGEIN_STATE_COUNT
270
271 typedef _STRUCT_X86_INSTRUCTION_STATE x86_instruction_state_t;
272 #define x86_INSTRUCTION_STATE_COUNT \
273 ((mach_msg_type_number_t)(sizeof(x86_instruction_state_t) / sizeof(int)))
274
275 #define X86_INSTRUCTION_STATE_COUNT x86_INSTRUCTION_STATE_COUNT
276
277 typedef _STRUCT_LAST_BRANCH_STATE last_branch_state_t;
278 #define x86_LAST_BRANCH_STATE_COUNT \
279 ((mach_msg_type_number_t)(sizeof(last_branch_state_t) / sizeof(int)))
280
281 #define X86_LAST_BRANCH_STATE_COUNT x86_LAST_BRANCH_STATE_COUNT
282
283
284 /*
285 * Combined thread, float and exception states
286 */
287 struct x86_thread_state {
288 x86_state_hdr_t tsh;
289 union {
290 x86_thread_state32_t ts32;
291 x86_thread_state64_t ts64;
292 } uts;
293 };
294
295 struct x86_float_state {
296 x86_state_hdr_t fsh;
297 union {
298 x86_float_state32_t fs32;
299 x86_float_state64_t fs64;
300 } ufs;
301 };
302
303 struct x86_exception_state {
304 x86_state_hdr_t esh;
305 union {
306 x86_exception_state32_t es32;
307 x86_exception_state64_t es64;
308 } ues;
309 };
310
311 struct x86_debug_state {
312 x86_state_hdr_t dsh;
313 union {
314 x86_debug_state32_t ds32;
315 x86_debug_state64_t ds64;
316 } uds;
317 };
318
319 struct x86_avx_state {
320 x86_state_hdr_t ash;
321 union {
322 x86_avx_state32_t as32;
323 x86_avx_state64_t as64;
324 } ufs;
325 };
326
327 struct x86_avx512_state {
328 x86_state_hdr_t ash;
329 union {
330 x86_avx512_state32_t as32;
331 x86_avx512_state64_t as64;
332 } ufs;
333 };
334
335 typedef struct x86_thread_state x86_thread_state_t;
336 #define x86_THREAD_STATE_COUNT ((mach_msg_type_number_t) \
337 ( sizeof (x86_thread_state_t) / sizeof (int) ))
338
339 typedef struct x86_float_state x86_float_state_t;
340 #define x86_FLOAT_STATE_COUNT ((mach_msg_type_number_t) \
341 (sizeof(x86_float_state_t)/sizeof(unsigned int)))
342
343 typedef struct x86_exception_state x86_exception_state_t;
344 #define x86_EXCEPTION_STATE_COUNT ((mach_msg_type_number_t) \
345 (sizeof(x86_exception_state_t)/sizeof(unsigned int)))
346
347 typedef struct x86_debug_state x86_debug_state_t;
348 #define x86_DEBUG_STATE_COUNT ((mach_msg_type_number_t) \
349 (sizeof(x86_debug_state_t)/sizeof(unsigned int)))
350
351 typedef struct x86_avx_state x86_avx_state_t;
352 #define x86_AVX_STATE_COUNT ((mach_msg_type_number_t) \
353 (sizeof(x86_avx_state_t)/sizeof(unsigned int)))
354
355 typedef struct x86_avx512_state x86_avx512_state_t;
356 #define x86_AVX512_STATE_COUNT ((mach_msg_type_number_t) \
357 (sizeof(x86_avx512_state_t)/sizeof(unsigned int)))
358
359 /*
360 * Machine-independent way for servers and Mach's exception mechanism to
361 * choose the most efficient state flavor for exception RPC's:
362 */
363 #define MACHINE_THREAD_STATE x86_THREAD_STATE
364 #define MACHINE_THREAD_STATE_COUNT x86_THREAD_STATE_COUNT
365
366 #ifdef XNU_KERNEL_PRIVATE
367
368 #define x86_SAVED_STATE32 THREAD_STATE_NONE + 1
369 #define x86_SAVED_STATE64 THREAD_STATE_NONE + 2
370
371 /*
372 * The format in which thread state is saved by Mach on this machine. This
373 * state flavor is most efficient for exception RPC's to kernel-loaded
374 * servers, because copying can be avoided:
375 */
376 struct x86_saved_state32 {
377 uint32_t gs;
378 uint32_t fs;
379 uint32_t es;
380 uint32_t ds;
381 uint32_t edi;
382 uint32_t esi;
383 uint32_t ebp;
384 uint32_t cr2; /* kernel esp stored by pusha - we save cr2 here later */
385 uint32_t ebx;
386 uint32_t edx;
387 uint32_t ecx;
388 uint32_t eax;
389 uint16_t trapno;
390 uint16_t cpu;
391 uint32_t err;
392 uint32_t eip;
393 uint32_t cs;
394 uint32_t efl;
395 uint32_t uesp;
396 uint32_t ss;
397 };
398 typedef struct x86_saved_state32 x86_saved_state32_t;
399
400 #define x86_SAVED_STATE32_COUNT ((mach_msg_type_number_t) \
401 (sizeof (x86_saved_state32_t)/sizeof(unsigned int)))
402
403 #pragma pack(4)
404
405 /*
406 * This is the state pushed onto the 64-bit interrupt stack
407 * on any exception/trap/interrupt.
408 */
409 struct x86_64_intr_stack_frame {
410 uint16_t trapno;
411 uint16_t cpu;
412 uint32_t _pad;
413 uint64_t trapfn;
414 uint64_t err;
415 uint64_t rip;
416 uint64_t cs;
417 uint64_t rflags;
418 uint64_t rsp;
419 uint64_t ss;
420 };
421 typedef struct x86_64_intr_stack_frame x86_64_intr_stack_frame_t;
422 _Static_assert((sizeof(x86_64_intr_stack_frame_t) % 16) == 0,
423 "interrupt stack frame size must be a multiple of 16 bytes");
424
425 /*
426 * thread state format for task running in 64bit long mode
427 * in long mode, the same hardware frame is always pushed regardless
428 * of whether there was a change in privilege level... therefore, there
429 * is no need for an x86_saved_state64_from_kernel variant
430 */
431 struct x86_saved_state64 {
432 uint64_t rdi; /* arg0 for system call */
433 uint64_t rsi;
434 uint64_t rdx;
435 uint64_t r10; /* R10 := RCX prior to syscall trap */
436 uint64_t r8;
437 uint64_t r9; /* arg5 for system call */
438
439 uint64_t cr2;
440 uint64_t r15;
441 uint64_t r14;
442 uint64_t r13;
443 uint64_t r12;
444 uint64_t r11;
445 uint64_t rbp;
446 uint64_t rbx;
447 uint64_t rcx;
448 uint64_t rax;
449
450 uint32_t gs;
451 uint32_t fs;
452
453 uint32_t ds;
454 uint32_t es;
455
456 struct x86_64_intr_stack_frame isf;
457 };
458 typedef struct x86_saved_state64 x86_saved_state64_t;
459 #define x86_SAVED_STATE64_COUNT ((mach_msg_type_number_t) \
460 (sizeof (struct x86_saved_state64)/sizeof(unsigned int)))
461
462 extern uint32_t get_eflags_exportmask(void);
463
464 /*
465 * Unified, tagged saved state:
466 */
467 typedef struct {
468 uint32_t flavor;
469 uint32_t _pad_for_16byte_alignment[3];
470 union {
471 x86_saved_state32_t ss_32;
472 x86_saved_state64_t ss_64;
473 } uss;
474 } x86_saved_state_t;
475 #define ss_32 uss.ss_32
476 #define ss_64 uss.ss_64
477 #pragma pack()
478
479 static inline boolean_t
is_saved_state64(x86_saved_state_t * iss)480 is_saved_state64(x86_saved_state_t *iss)
481 {
482 return iss->flavor == x86_SAVED_STATE64;
483 }
484
485 static inline boolean_t
is_saved_state32(x86_saved_state_t * iss)486 is_saved_state32(x86_saved_state_t *iss)
487 {
488 return iss->flavor == x86_SAVED_STATE32;
489 }
490
491 static inline x86_saved_state32_t *
saved_state32(x86_saved_state_t * iss)492 saved_state32(x86_saved_state_t *iss)
493 {
494 return &iss->ss_32;
495 }
496
497 static inline x86_saved_state64_t *
saved_state64(x86_saved_state_t * iss)498 saved_state64(x86_saved_state_t *iss)
499 {
500 return &iss->ss_64;
501 }
502
503 #endif /* XNU_KERNEL_PRIVATE */
504
505 #endif /* defined (__i386__) || defined (__x86_64__) */
506
507 #endif /* _MACH_I386_THREAD_STATUS_H_ */
508