osfmk/mach/exception_types.h

   1 /*
   2  * Copyright (c) 2000 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,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
  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 */
  95
  96 #define EXC_CRASH               10      /* Abnormal process exit */
  97
  98 #define EXC_RESOURCE            11      /* Hit resource consumption limit */
  99 /* Exact resource is in code field. */
 100
 101 #define EXC_GUARD               12      /* Violated guarded resource protections */
 102
 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_* */
 106
 107
 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
 126 #define MACH_EXCEPTION_ERRORS           0x40000000
 127 /*      include additional exception specific errors, not used yet.  */
 128
 129 #define MACH_EXCEPTION_CODES            0x80000000
 130 /*      Send 64-bit code and subcode in the exception header */
 131
 132 #define MACH_EXCEPTION_MASK             (MACH_EXCEPTION_CODES | MACH_EXCEPTION_ERRORS)
 133 /*
 134  * Masks for exception definitions, above
 135  * bit zero is unused, therefore 1 word = 31 exception types
 136  */
 137
 138 #define EXC_MASK_BAD_ACCESS             (1 << EXC_BAD_ACCESS)
 139 #define EXC_MASK_BAD_INSTRUCTION        (1 << EXC_BAD_INSTRUCTION)
 140 #define EXC_MASK_ARITHMETIC             (1 << EXC_ARITHMETIC)
 141 #define EXC_MASK_EMULATION              (1 << EXC_EMULATION)
 142 #define EXC_MASK_SOFTWARE               (1 << EXC_SOFTWARE)
 143 #define EXC_MASK_BREAKPOINT             (1 << EXC_BREAKPOINT)
 144 #define EXC_MASK_SYSCALL                (1 << EXC_SYSCALL)
 145 #define EXC_MASK_MACH_SYSCALL           (1 << EXC_MACH_SYSCALL)
 146 #define EXC_MASK_RPC_ALERT              (1 << EXC_RPC_ALERT)
 147 #define EXC_MASK_CRASH                  (1 << EXC_CRASH)
 148 #define EXC_MASK_RESOURCE               (1 << EXC_RESOURCE)
 149 #define EXC_MASK_GUARD                  (1 << EXC_GUARD)
 150 #define EXC_MASK_CORPSE_NOTIFY          (1 << EXC_CORPSE_NOTIFY)
 151
 152 #define EXC_MASK_ALL    (EXC_MASK_BAD_ACCESS |                  \
 153                          EXC_MASK_BAD_INSTRUCTION |             \
 154                          EXC_MASK_ARITHMETIC |                  \
 155                          EXC_MASK_EMULATION |                   \
 156                          EXC_MASK_SOFTWARE |                    \
 157                          EXC_MASK_BREAKPOINT |                  \
 158                          EXC_MASK_SYSCALL |                     \
 159                          EXC_MASK_MACH_SYSCALL |                \
 160                          EXC_MASK_RPC_ALERT |                   \
 161                          EXC_MASK_RESOURCE |                    \
 162                          EXC_MASK_GUARD |                       \
 163                          EXC_MASK_MACHINE)
 164
 165 #ifdef  KERNEL_PRIVATE
 166 #define EXC_MASK_VALID  (EXC_MASK_ALL | EXC_MASK_CRASH | EXC_MASK_CORPSE_NOTIFY)
 167 #endif /* KERNEL_PRIVATE */
 168
 169 #define FIRST_EXCEPTION         1       /* ZERO is illegal */
 170
 171 /*
 172  * Machine independent codes for EXC_SOFTWARE
 173  * Codes 0x10000 - 0x1FFFF reserved for OS emulation (Unix)
 174  * 0x10000 - 0x10002 in use for unix signals
 175  * 0x20000 - 0x2FFFF reserved for MACF
 176  */
 177 #define EXC_SOFT_SIGNAL         0x10003 /* Unix signal exceptions */
 178
 179 #define EXC_MACF_MIN            0x20000 /* MACF exceptions */
 180 #define EXC_MACF_MAX            0x2FFFF
 181
 182 #ifndef ASSEMBLER
 183
 184 #include <mach/port.h>
 185 #include <mach/thread_status.h>
 186 #include <mach/machine/vm_types.h>
 187 /*
 188  * Exported types
 189  */
 190
 191 typedef int                             exception_type_t;
 192 typedef integer_t                       exception_data_type_t;
 193 typedef int64_t                         mach_exception_data_type_t;
 194 typedef int                             exception_behavior_t;
 195 typedef exception_data_type_t           *exception_data_t;
 196 typedef mach_exception_data_type_t      *mach_exception_data_t;
 197 typedef unsigned int                    exception_mask_t;
 198 typedef exception_mask_t                *exception_mask_array_t;
 199 typedef exception_behavior_t            *exception_behavior_array_t;
 200 typedef thread_state_flavor_t           *exception_flavor_array_t;
 201 typedef mach_port_t                     *exception_port_array_t;
 202 typedef mach_exception_data_type_t      mach_exception_code_t;
 203 typedef mach_exception_data_type_t      mach_exception_subcode_t;
 204
 205 #endif  /* ASSEMBLER */
 206
 207 #endif  /* _MACH_EXCEPTION_TYPES_H_ */