[apple/xnu.git] / osfmk / mach / exception_types.h

/*
 * Copyright (c) 2000 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,1989,1988,1987 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	_MACH_EXCEPTION_TYPES_H_
#define	_MACH_EXCEPTION_TYPES_H_

#include <mach/machine/exception.h>

/*
 *	Machine-independent exception definitions.
 */

#define EXC_BAD_ACCESS		1	/* Could not access memory */
		/* Code contains kern_return_t describing error. */
		/* Subcode contains bad memory address. */

#define EXC_BAD_INSTRUCTION	2	/* Instruction failed */
		/* Illegal or undefined instruction or operand */

#define EXC_ARITHMETIC		3	/* Arithmetic exception */
		/* Exact nature of exception is in code field */

#define EXC_EMULATION		4	/* Emulation instruction */
		/* Emulation support instruction encountered */
		/* Details in code and subcode fields	*/

#define EXC_SOFTWARE		5	/* Software generated exception */
		/* Exact exception is in code field. */
		/* Codes 0 - 0xFFFF reserved to hardware */
		/* Codes 0x10000 - 0x1FFFF reserved for OS emulation (Unix) */

#define EXC_BREAKPOINT		6	/* Trace, breakpoint, etc. */
		/* Details in code field. */

#define EXC_SYSCALL		7	/* System calls. */

#define EXC_MACH_SYSCALL	8	/* Mach system calls. */

#define EXC_RPC_ALERT		9	/* RPC alert */

#define EXC_CRASH		10	/* Abnormal process exit */

#define EXC_RESOURCE		11	/* Hit resource consumption limit */
		/* Exact resource is in code field. */

#define EXC_GUARD		12	/* Violated guarded resource protections */

#define EXC_CORPSE_NOTIFY	13	/* Abnormal process exited to corpse state */

#define EXC_CORPSE_VARIANT_BIT	0x100  /* bit set for EXC_*_CORPSE variants of EXC_* */


/*
 *	Machine-independent exception behaviors
 */

# define EXCEPTION_DEFAULT		1
/*	Send a catch_exception_raise message including the identity.
 */

# define EXCEPTION_STATE		2
/*	Send a catch_exception_raise_state message including the
 *	thread state.
 */

# define EXCEPTION_STATE_IDENTITY	3
/*	Send a catch_exception_raise_state_identity message including
 *	the thread identity and state.
 */

#define MACH_EXCEPTION_CODES		0x80000000
/*	Send 64-bit code and subcode in the exception header */

/*
 * Masks for exception definitions, above
 * bit zero is unused, therefore 1 word = 31 exception types
 */

#define EXC_MASK_BAD_ACCESS		(1 << EXC_BAD_ACCESS)
#define EXC_MASK_BAD_INSTRUCTION	(1 << EXC_BAD_INSTRUCTION)
#define EXC_MASK_ARITHMETIC		(1 << EXC_ARITHMETIC)
#define EXC_MASK_EMULATION		(1 << EXC_EMULATION)
#define EXC_MASK_SOFTWARE		(1 << EXC_SOFTWARE)
#define EXC_MASK_BREAKPOINT		(1 << EXC_BREAKPOINT)
#define EXC_MASK_SYSCALL		(1 << EXC_SYSCALL)
#define EXC_MASK_MACH_SYSCALL		(1 << EXC_MACH_SYSCALL)
#define EXC_MASK_RPC_ALERT		(1 << EXC_RPC_ALERT)
#define EXC_MASK_CRASH			(1 << EXC_CRASH)
#define EXC_MASK_RESOURCE		(1 << EXC_RESOURCE)
#define EXC_MASK_GUARD			(1 << EXC_GUARD)
#define EXC_MASK_CORPSE_NOTIFY		(1 << EXC_CORPSE_NOTIFY)

#define EXC_MASK_ALL	(EXC_MASK_BAD_ACCESS |			\
			 EXC_MASK_BAD_INSTRUCTION |		\
			 EXC_MASK_ARITHMETIC |			\
			 EXC_MASK_EMULATION |			\
			 EXC_MASK_SOFTWARE |			\
			 EXC_MASK_BREAKPOINT |			\
			 EXC_MASK_SYSCALL |			\
			 EXC_MASK_MACH_SYSCALL |		\
			 EXC_MASK_RPC_ALERT |			\
			 EXC_MASK_RESOURCE |			\
			 EXC_MASK_GUARD |			\
			 EXC_MASK_MACHINE)

#ifdef	KERNEL_PRIVATE
#define EXC_MASK_VALID	(EXC_MASK_ALL | EXC_MASK_CRASH | EXC_MASK_CORPSE_NOTIFY)
#endif /* KERNEL_PRIVATE */

#define FIRST_EXCEPTION		1	/* ZERO is illegal */

/*
 * Machine independent codes for EXC_SOFTWARE
 * Codes 0x10000 - 0x1FFFF reserved for OS emulation (Unix) 
 * 0x10000 - 0x10002 in use for unix signals
 * 0x20000 - 0x2FFFF reserved for MACF
 */
#define	EXC_SOFT_SIGNAL		0x10003	/* Unix signal exceptions */

#define	EXC_MACF_MIN		0x20000 /* MACF exceptions */
#define	EXC_MACF_MAX		0x2FFFF

#ifndef	ASSEMBLER

#include <mach/port.h>
#include <mach/thread_status.h>
#include <mach/machine/vm_types.h>
/*
 * Exported types
 */

typedef int				exception_type_t;
typedef	integer_t			exception_data_type_t;
typedef	int64_t				mach_exception_data_type_t;
typedef int				exception_behavior_t;
typedef exception_data_type_t		*exception_data_t;
typedef mach_exception_data_type_t	*mach_exception_data_t;
typedef	unsigned int			exception_mask_t;
typedef	exception_mask_t		*exception_mask_array_t;
typedef exception_behavior_t		*exception_behavior_array_t;
typedef thread_state_flavor_t		*exception_flavor_array_t;
typedef mach_port_t			*exception_port_array_t;
typedef	mach_exception_data_type_t	mach_exception_code_t;
typedef	mach_exception_data_type_t	mach_exception_subcode_t;

#endif	/* ASSEMBLER */

#endif	/* _MACH_EXCEPTION_TYPES_H_ */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	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,1989,1988,1987 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 _MACH_EXCEPTION_TYPES_H_
	60	#define _MACH_EXCEPTION_TYPES_H_
	61
	62	#include <mach/machine/exception.h>
	63
	64	/*
	65	* Machine-independent exception definitions.
	66	*/
	67
1c79356b A	68	#define EXC_BAD_ACCESS 1 /* Could not access memory */
	69	/* Code contains kern_return_t describing error. */
	70	/* Subcode contains bad memory address. */
	71
	72	#define EXC_BAD_INSTRUCTION 2 /* Instruction failed */
	73	/* Illegal or undefined instruction or operand */
	74
	75	#define EXC_ARITHMETIC 3 /* Arithmetic exception */
	76	/* Exact nature of exception is in code field */
	77
	78	#define EXC_EMULATION 4 /* Emulation instruction */
	79	/* Emulation support instruction encountered */
	80	/* Details in code and subcode fields */
	81
	82	#define EXC_SOFTWARE 5 /* Software generated exception */
	83	/* Exact exception is in code field. */
	84	/* Codes 0 - 0xFFFF reserved to hardware */
	85	/* Codes 0x10000 - 0x1FFFF reserved for OS emulation (Unix) */
	86
	87	#define EXC_BREAKPOINT 6 /* Trace, breakpoint, etc. */
	88	/* Details in code field. */
	89
	90	#define EXC_SYSCALL 7 /* System calls. */
	91
	92	#define EXC_MACH_SYSCALL 8 /* Mach system calls. */
	93
	94	#define EXC_RPC_ALERT 9 /* RPC alert */
5ba3f43e	95
2d21ac55	96	#define EXC_CRASH 10 /* Abnormal process exit */
1c79356b	97
316670eb A	98	#define EXC_RESOURCE 11 /* Hit resource consumption limit */
	99	/* Exact resource is in code field. */
	100
39236c6e A	101	#define EXC_GUARD 12 /* Violated guarded resource protections */
39236c6e A	102
5ba3f43e A	103	#define EXC_CORPSE_NOTIFY 13 /* Abnormal process exited to corpse state */
	104
	105	#define EXC_CORPSE_VARIANT_BIT 0x100 /* bit set for EXC__CORPSE variants of EXC_ */
3e170ce0	106
39236c6e	107
1c79356b A	108	/*
	109	* Machine-independent exception behaviors
	110	*/
	111
	112	# define EXCEPTION_DEFAULT 1
	113	/* Send a catch_exception_raise message including the identity.
	114	*/
	115
	116	# define EXCEPTION_STATE 2
	117	/* Send a catch_exception_raise_state message including the
	118	* thread state.
	119	*/
	120
	121	# define EXCEPTION_STATE_IDENTITY 3
	122	/* Send a catch_exception_raise_state_identity message including
	123	* the thread identity and state.
	124	*/
	125
2d21ac55 A	126	#define MACH_EXCEPTION_CODES 0x80000000
	127	/* Send 64-bit code and subcode in the exception header */
	128
1c79356b A	129	/*
	130	* Masks for exception definitions, above
	131	* bit zero is unused, therefore 1 word = 31 exception types
	132	*/
	133
	134	#define EXC_MASK_BAD_ACCESS (1 << EXC_BAD_ACCESS)
	135	#define EXC_MASK_BAD_INSTRUCTION (1 << EXC_BAD_INSTRUCTION)
	136	#define EXC_MASK_ARITHMETIC (1 << EXC_ARITHMETIC)
	137	#define EXC_MASK_EMULATION (1 << EXC_EMULATION)
	138	#define EXC_MASK_SOFTWARE (1 << EXC_SOFTWARE)
	139	#define EXC_MASK_BREAKPOINT (1 << EXC_BREAKPOINT)
	140	#define EXC_MASK_SYSCALL (1 << EXC_SYSCALL)
	141	#define EXC_MASK_MACH_SYSCALL (1 << EXC_MACH_SYSCALL)
	142	#define EXC_MASK_RPC_ALERT (1 << EXC_RPC_ALERT)
2d21ac55	143	#define EXC_MASK_CRASH (1 << EXC_CRASH)
316670eb	144	#define EXC_MASK_RESOURCE (1 << EXC_RESOURCE)
39236c6e	145	#define EXC_MASK_GUARD (1 << EXC_GUARD)
3e170ce0	146	#define EXC_MASK_CORPSE_NOTIFY (1 << EXC_CORPSE_NOTIFY)
1c79356b A	147
	148	#define EXC_MASK_ALL (EXC_MASK_BAD_ACCESS \| \
	149	EXC_MASK_BAD_INSTRUCTION \| \
	150	EXC_MASK_ARITHMETIC \| \
	151	EXC_MASK_EMULATION \| \
	152	EXC_MASK_SOFTWARE \| \
	153	EXC_MASK_BREAKPOINT \| \
	154	EXC_MASK_SYSCALL \| \
	155	EXC_MASK_MACH_SYSCALL \| \
	156	EXC_MASK_RPC_ALERT \| \
316670eb	157	EXC_MASK_RESOURCE \| \
39236c6e	158	EXC_MASK_GUARD \| \
1c79356b A	159	EXC_MASK_MACHINE)
1c79356b A	160
b0d623f7	161	#ifdef KERNEL_PRIVATE
3e170ce0	162	#define EXC_MASK_VALID (EXC_MASK_ALL \| EXC_MASK_CRASH \| EXC_MASK_CORPSE_NOTIFY)
b0d623f7	163	#endif /* KERNEL_PRIVATE */
1c79356b A	164
	165	#define FIRST_EXCEPTION 1 /* ZERO is illegal */
	166
9bccf70c A	167	/*
	168	* Machine independent codes for EXC_SOFTWARE
	169	* Codes 0x10000 - 0x1FFFF reserved for OS emulation (Unix)
	170	* 0x10000 - 0x10002 in use for unix signals
316670eb	171	* 0x20000 - 0x2FFFF reserved for MACF
9bccf70c A	172	*/
	173	#define EXC_SOFT_SIGNAL 0x10003 /* Unix signal exceptions */
	174
316670eb A	175	#define EXC_MACF_MIN 0x20000 /* MACF exceptions */
	176	#define EXC_MACF_MAX 0x2FFFF
	177
1c79356b	178	#ifndef ASSEMBLER
91447636	179
1c79356b A	180	#include <mach/port.h>
	181	#include <mach/thread_status.h>
	182	#include <mach/machine/vm_types.h>
	183	/*
	184	* Exported types
	185	*/
	186
2d21ac55 A	187	typedef int exception_type_t;
	188	typedef integer_t exception_data_type_t;
	189	typedef int64_t mach_exception_data_type_t;
	190	typedef int exception_behavior_t;
	191	typedef exception_data_type_t *exception_data_t;
	192	typedef mach_exception_data_type_t *mach_exception_data_t;
	193	typedef unsigned int exception_mask_t;
	194	typedef exception_mask_t *exception_mask_array_t;
	195	typedef exception_behavior_t *exception_behavior_array_t;
	196	typedef thread_state_flavor_t *exception_flavor_array_t;
	197	typedef mach_port_t *exception_port_array_t;
	198	typedef mach_exception_data_type_t mach_exception_code_t;
	199	typedef mach_exception_data_type_t mach_exception_subcode_t;
1c79356b A	200
1c79356b A	201	#endif /* ASSEMBLER */
91447636	202
1c79356b	203	#endif /* _MACH_EXCEPTION_TYPES_H_ */