[apple/xnu.git] / osfmk / i386 / trap.h

/*
 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 */

#ifndef	_I386_TRAP_H_
#define	_I386_TRAP_H_

/*
 * Hardware trap vectors for i386.
 */
#define	T_DIVIDE_ERROR		0
#define	T_DEBUG			1
#define	T_NMI			2		/* non-maskable interrupt */
#define	T_INT3			3		/* int 3 instruction */
#define	T_OVERFLOW		4		/* overflow test */
#define	T_OUT_OF_BOUNDS		5		/* bounds check */
#define	T_INVALID_OPCODE	6		/* invalid op code */
#define	T_NO_FPU		7		/* no floating point */
#define	T_DOUBLE_FAULT		8		/* double fault */
#define	T_FPU_FAULT		9
#define T_INVALID_TSS		10
#define	T_SEGMENT_NOT_PRESENT	11
#define	T_STACK_FAULT		12
#define	T_GENERAL_PROTECTION	13
#define	T_PAGE_FAULT		14
/*				15 */
#define	T_FLOATING_POINT_ERROR	16
#define	T_WATCHPOINT		17
#define T_MACHINE_CHECK		18
#define T_SSE_FLOAT_ERROR       19
/*                          20-126 */
#define T_DTRACE_RET            127
#define T_PREEMPT		255

#define TRAP_NAMES "divide error", "debug trap", "NMI", "breakpoint", \
		   "overflow", "bounds check", "invalid opcode", \
		   "no coprocessor", "double fault", "coprocessor overrun", \
		   "invalid TSS", "segment not present", "stack bounds", \
		   "general protection", "page fault", "(reserved)", \
		   "coprocessor error", "watchpoint", "machine check", "SSE floating point"

/*
 * Page-fault trap codes.
 */
#define	T_PF_PROT		0x1		/* protection violation */
#define	T_PF_WRITE		0x2		/* write access */
#define	T_PF_USER		0x4		/* from user state */

#ifdef PAE
#define	T_PF_RSVD		0x8		/* reserved bit set to 1 */
#define T_PF_EXECUTE		0x10		/* instruction fetch when NX */
#endif


#if !defined(ASSEMBLER) && defined(MACH_KERNEL)

#include <i386/thread.h>

extern void		i386_exception(
				int			exc,
				mach_exception_code_t	code,
				mach_exception_subcode_t subcode);

extern void		sync_iss_to_iks(x86_saved_state32_t *regs);

extern void		sync_iss_to_iks_unconditionally(
				x86_saved_state_t	*regs);

extern void		kernel_trap(x86_saved_state_t *regs);

extern void		user_trap(x86_saved_state_t *regs);

extern void		panic_double_fault(int code);

extern void		panic_double_fault64(x86_saved_state_t *regs);

extern void		panic_machine_check(int	code);

extern void		panic_machine_check64(x86_saved_state_t *regs);

extern void		i386_astintr(int preemption);


typedef kern_return_t (*perfCallback)(
				int			trapno,
				void			*regs,
				int			unused1,
				int			unused2);

extern perfCallback perfTrapHook;
extern perfCallback perfASTHook;
extern perfCallback perfIntHook;

extern void		panic_i386_backtrace(void *, int, const char *, boolean_t, x86_saved_state_t *);
#if MACH_KDP
extern boolean_t	kdp_i386_trap(
				unsigned int,
				x86_saved_state32_t *,
				kern_return_t,
				vm_offset_t);
#endif /* MACH_KDP */
#endif	/* !ASSEMBLER && MACH_KERNEL */

#endif	/* _I386_TRAP_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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 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 _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
2d21ac55	75	#define T_INVALID_TSS 10
1c79356b A	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
0c530ab8 A	83	#define T_MACHINE_CHECK 18
0c530ab8 A	84	#define T_SSE_FLOAT_ERROR 19
2d21ac55 A	85	/* 20-126 */
2d21ac55 A	86	#define T_DTRACE_RET 127
1c79356b A	87	#define T_PREEMPT 255
	88
	89	#define TRAP_NAMES "divide error", "debug trap", "NMI", "breakpoint", \
	90	"overflow", "bounds check", "invalid opcode", \
	91	"no coprocessor", "double fault", "coprocessor overrun", \
	92	"invalid TSS", "segment not present", "stack bounds", \
	93	"general protection", "page fault", "(reserved)", \
2d21ac55	94	"coprocessor error", "watchpoint", "machine check", "SSE floating point"
1c79356b A	95
	96	/*
	97	* Page-fault trap codes.
	98	*/
	99	#define T_PF_PROT 0x1 /* protection violation */
	100	#define T_PF_WRITE 0x2 /* write access */
	101	#define T_PF_USER 0x4 /* from user state */
	102
0c530ab8 A	103	#ifdef PAE
	104	#define T_PF_RSVD 0x8 /* reserved bit set to 1 */
	105	#define T_PF_EXECUTE 0x10 /* instruction fetch when NX */
	106	#endif
	107
	108
1c79356b A	109	#if !defined(ASSEMBLER) && defined(MACH_KERNEL)
	110
	111	#include <i386/thread.h>
	112
	113	extern void i386_exception(
2d21ac55 A	114	int exc,
	115	mach_exception_code_t code,
	116	mach_exception_subcode_t subcode);
1c79356b	117
0c530ab8 A	118	extern void sync_iss_to_iks(x86_saved_state32_t *regs);
0c530ab8 A	119
2d21ac55 A	120	extern void sync_iss_to_iks_unconditionally(
2d21ac55 A	121	x86_saved_state_t *regs);
0c530ab8 A	122
	123	extern void kernel_trap(x86_saved_state_t *regs);
	124
	125	extern void user_trap(x86_saved_state_t *regs);
5d5c5d0d	126
0c530ab8	127	extern void panic_double_fault(int code);
5d5c5d0d	128
0c530ab8 A	129	extern void panic_double_fault64(x86_saved_state_t *regs);
	130
	131	extern void panic_machine_check(int code);
	132
	133	extern void panic_machine_check64(x86_saved_state_t *regs);
1c79356b A	134
	135	extern void i386_astintr(int preemption);
	136
0c530ab8 A	137
	138	typedef kern_return_t (*perfCallback)(
	139	int trapno,
	140	void *regs,
	141	int unused1,
	142	int unused2);
	143
	144	extern perfCallback perfTrapHook;
	145	extern perfCallback perfASTHook;
	146	extern perfCallback perfIntHook;
	147
935ed37a	148	extern void panic_i386_backtrace(void , int, const char , boolean_t, x86_saved_state_t *);
0c530ab8 A	149	#if MACH_KDP
0c530ab8 A	150	extern boolean_t kdp_i386_trap(
91447636	151	unsigned int,
0c530ab8	152	x86_saved_state32_t *,
91447636 A	153	kern_return_t,
	154	vm_offset_t);
	155	#endif /* MACH_KDP */
1c79356b A	156	#endif /* !ASSEMBLER && MACH_KERNEL */
	157
	158	#endif /* _I386_TRAP_H_ */