1 /*
2 * Copyright (c) 2000-2012 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_COPYRIGHT@
30 */
31 /*
32 * Mach Operating System
33 * Copyright (c) 1991,1990 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 #ifndef _I386_TRAP_H_
60 #define _I386_TRAP_H_
61
62 /*
63 * Hardware trap vectors for i386.
64 */
65 #define T_DIVIDE_ERROR 0
66 #define T_DEBUG 1
67 #define T_NMI 2 /* non-maskable interrupt */
68 #define T_INT3 3 /* int 3 instruction */
69 #define T_OVERFLOW 4 /* overflow test */
70 #define T_OUT_OF_BOUNDS 5 /* bounds check */
71 #define T_INVALID_OPCODE 6 /* invalid op code */
72 #define T_NO_FPU 7 /* no floating point */
73 #define T_DOUBLE_FAULT 8 /* double fault */
74 #define T_FPU_FAULT 9
75 #define T_INVALID_TSS 10
76 #define T_SEGMENT_NOT_PRESENT 11
77 #define T_STACK_FAULT 12
78 #define T_GENERAL_PROTECTION 13
79 #define T_PAGE_FAULT 14
80 /* 15 */
81 #define T_FLOATING_POINT_ERROR 16
82 #define T_WATCHPOINT 17
83 #define T_MACHINE_CHECK 18
84 #define T_SSE_FLOAT_ERROR 19
85 /* 20-126 */
86 #define T_DTRACE_RET 127
87
88 /* The SYSENTER and SYSCALL trap numbers are software constructs.
89 * These exceptions are dispatched directly to the system call handlers.
90 * See also the "software interrupt codes" section of
91 * osfmk/mach/i386/syscall_sw.h
92 */
93 #define T_SYSENTER 0x84
94 #define T_SYSCALL 0x85
95
96 #define T_PREEMPT 255
97
98 #define TRAP_NAMES "divide error", "debug trap", "NMI", "breakpoint", \
99 "overflow", "bounds check", "invalid opcode", \
100 "no coprocessor", "double fault", "coprocessor overrun", \
101 "invalid TSS", "segment not present", "stack bounds", \
102 "general protection", "page fault", "(reserved)", \
103 "coprocessor error", "watchpoint", "machine check", "SSE floating point"
104
105 /*
106 * Page-fault trap codes.
107 */
108 #define T_PF_PROT 0x1 /* protection violation */
109 #define T_PF_WRITE 0x2 /* write access */
110 #define T_PF_USER 0x4 /* from user state */
111
112 #define T_PF_RSVD 0x8 /* reserved bit set to 1 */
113 #define T_PF_EXECUTE 0x10 /* instruction fetch when NX */
114
115 #if !defined(ASSEMBLER)
116 __attribute__((cold, always_inline))
117 static inline void
ml_recoverable_trap(unsigned int code)118 ml_recoverable_trap(unsigned int code)
119 __attribute__((diagnose_if(!__builtin_constant_p(code), "code must be constant", "error")))
120 {
121 __asm__ volatile ("ud1l %0(%%eax), %%eax" : : "p"((void *)((unsigned long long)code)));
122 }
123
124 __attribute__((cold, noreturn, always_inline))
125 static inline void
ml_fatal_trap(unsigned int code)126 ml_fatal_trap(unsigned int code)
127 __attribute__((diagnose_if(!__builtin_constant_p(code), "code must be constant", "error")))
128 {
129 __asm__ volatile ("ud1l %0(%%eax), %%eax" : : "p"((void *)((unsigned long long)code)));
130 __builtin_unreachable();
131 }
132
133 #if defined(XNU_KERNEL_PRIVATE)
134 __attribute__((cold, always_inline))
135 static inline void
ml_trap(unsigned int code)136 ml_trap(unsigned int code)
137 {
138 __asm__ volatile ("ud1l %0(%%eax), %%eax" : : "p"((void *)((unsigned long long)code)));
139 }
140
141 /* For use by clang option -ftrap-function only */
142 __attribute__((cold, always_inline))
143 static inline void
ml_bound_chk_soft_trap(unsigned char code)144 ml_bound_chk_soft_trap(unsigned char code)
145 {
146 /* clang mandates arg to be unsigned char */
147 unsigned int code32 = code;
148 if (code32 == 0x19) {
149 /* if we see a bound check trap, implicitly make it soft */
150 code32 += 0xFF00; /* code defined in kern/telemetry.h */
151 }
152
153 /* let other codes fall through */
154 ml_trap(code32);
155 }
156 #endif /* XNU_KERNEL_PRIVATE */
157 #endif /* !ASSEMBLER */
158
159 #if defined(MACH_KERNEL_PRIVATE)
160
161 #if !defined(ASSEMBLER) && defined(MACH_KERNEL)
162
163 #include <i386/thread.h>
164
165 #define DEFAULT_PANIC_ON_TRAP_MASK ((1U << T_INVALID_OPCODE) | \
166 (1U << T_GENERAL_PROTECTION) | \
167 (1U << T_PAGE_FAULT) | \
168 (1U << T_SEGMENT_NOT_PRESENT) | \
169 (1U << T_STACK_FAULT))
170
171
172 extern void i386_exception(
173 int exc,
174 mach_exception_code_t code,
175 mach_exception_subcode_t subcode);
176
177 extern void sync_iss_to_iks(x86_saved_state_t *regs);
178
179 extern void sync_iss_to_iks_unconditionally(
180 x86_saved_state_t *regs);
181
182 extern void kernel_trap(x86_saved_state_t *regs, uintptr_t *lo_spp);
183
184 extern void user_trap(x86_saved_state_t *regs);
185
186 extern void interrupt(x86_saved_state_t *regs);
187
188 extern void panic_double_fault64(x86_saved_state_t *regs) __abortlike;
189 extern void panic_machine_check64(x86_saved_state_t *regs) __abortlike;
190
191 typedef kern_return_t (*perfCallback)(
192 int trapno,
193 void *regs,
194 uintptr_t *lo_spp,
195 int);
196
197 extern void panic_i386_backtrace(void *, int, const char *, boolean_t, x86_saved_state_t *);
198 extern void print_one_backtrace(pmap_t pmap, vm_offset_t topfp, const char *cur_marker, boolean_t is_64_bit);
199 extern void print_thread_num_that_crashed(task_t task);
200 extern void print_tasks_user_threads(task_t task);
201 extern void print_threads_registers(thread_t thread);
202 extern void print_uuid_info(task_t task);
203 extern void print_launchd_info(void);
204
205 #if MACH_KDP
206 extern boolean_t kdp_i386_trap(
207 unsigned int,
208 x86_saved_state64_t *,
209 kern_return_t,
210 vm_offset_t);
211 #endif /* MACH_KDP */
212 #endif /* !ASSEMBLER && MACH_KERNEL */
213
214 #endif /* MACH_KERNEL_PRIVATE */
215
216 #endif /* _I386_TRAP_H_ */
217