home *** CD-ROM | disk | FTP | other *** search
/ The Developer Connection…ice Driver Kit for OS/2 3 / DEV3-D1.ISO / devtools / toolkt21 / asm / os2inc / bsexcpt.inc < prev    next >
Encoding:
Text File  |  1993-03-12  |  11.0 KB  |  306 lines
  1. ;*************************** START OF SPECIFICATION ************************ *                                                                         *
  2. ;* Source File Name: BSEXCPT.H                                             *
  3. ;*                                                                         *
  4. ;* Descriptive Name: Thread Exception Constants and Structure Definitions. *
  5. ;*                                                                         *
  6. ;* Copyright (c) IBM Corporation 1987,1991                                 *
  7. ;* Copyright (c) Microsoft Corporation 1987,1991                           *
  8. ;*                                                                         *
  9. ;* Function: This file provides constants and data structure definitions   *
  10. ;*      required by application programs to use 32-bit thread exceptions   *
  11. ;*      management facility.                                               *
  12. ;*                                                                         *
  13. ;***************************  END OF SPECIFICATION ************************  
  14. ; 
  15. ;* User Exception Handler Return Codes:
  16. ;  
  17. XCPT_CONTINUE_SEARCH    EQU    00000000H       ;  Exception not handled     
  18. XCPT_CONTINUE_EXECUTION    EQU    0FFFFFFFFH       ;  Exception handled         
  19. XCPT_CONTINUE_STOP    EQU    00716668H       ;  Exception handled by      
  20.                                                 ;  debugger (via DosDebug)   
  21. ; 
  22. ;* fHandlerFlags values (see ExceptionReportRecord):
  23. ;*
  24. ;* The user may only set (but not clear) the EH_NONCONTINUABLE flag.
  25. ;* All other flags are set by the system.
  26. ;*
  27. ;  
  28. EH_NONCONTINUABLE    EQU    1H           ;  Noncontinuable exception           
  29. EH_UNWINDING    EQU    2H                ;  Unwind is in progress              
  30. EH_EXIT_UNWIND    EQU    4H              ;  Exit unwind is in progress         
  31. EH_STACK_INVALID    EQU    8H            ;  Stack out of limits or unaligned   
  32. EH_NESTED_CALL    EQU    10H             ;  Nested exception handler call      
  33. ; 
  34. ;* Unwind all exception handlers (see DosUnwindException API)
  35. ;  
  36. UNWIND_ALL    EQU    0 
  37. ; 
  38. ;*   Exception values are 32-bit values laid out as follows:
  39. ;*
  40. ;*   3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
  41. ;*   1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
  42. ;*   +---+-+-------------------------+-------------------------------+
  43. ;*   |Sev|C|       Facility          |               Code            |
  44. ;*   +---+-+-------------------------+-------------------------------+
  45. ;*
  46. ;*   where
  47. ;*
  48. ;*       Sev - is the severity code
  49. ;*           00 - Success
  50. ;*           01 - Informational
  51. ;*           10 - Warning
  52. ;*           11 - Error
  53. ;*
  54. ;*       C - is the Customer code flag
  55. ;*
  56. ;*       Facility - is the facility code
  57. ;*
  58. ;*       Code - is the facility's status code
  59. ;*
  60. ;*   Exceptions specific to OS/2 2.0 (e.g. XCPT_SIGNAL) will be marked
  61. ;*   with a facility code of 1.
  62. ;*
  63. ;*   System defined exceptions have a facility code of zero.
  64. ;*
  65. ;*   Each exception may also have several pieces of additional information.
  66. ;*   These are stored in the ExceptionInfo fields of the
  67. ;*   ExceptionReportRecord. They are documented here with the exceptions
  68. ;*   only for ease of reference.
  69. ;  
  70. XCPT_FATAL_EXCEPTION    EQU    0C0000000H 
  71. XCPT_SEVERITY_CODE    EQU    0C0000000H 
  72. XCPT_CUSTOMER_CODE    EQU    20000000H 
  73. XCPT_FACILITY_CODE    EQU    1FFF0000H 
  74. XCPT_EXCEPTION_CODE    EQU    0000FFFFH 
  75. ; 
  76. ;* Violation flags in ExceptionInfo
  77. ;  
  78. XCPT_UNKNOWN_ACCESS    EQU    00000000H       ;  Unknown access            
  79. XCPT_READ_ACCESS    EQU    00000001H       ;  Read access               
  80. XCPT_WRITE_ACCESS    EQU    00000002H       ;  Write access              
  81. XCPT_EXECUTE_ACCESS    EQU    00000004H       ;  Execute access            
  82. XCPT_SPACE_ACCESS    EQU    00000008H       ;  Address space access      
  83. XCPT_LIMIT_ACCESS    EQU    00000010H       ;  Address space limit       
  84.                                                 ;  violation                 
  85. XCPT_DATA_UNKNOWN    EQU    0FFFFFFFFH 
  86. ; 
  87. ;* Signal numbers for XCPT_SIGNAL
  88. ;  
  89. XCPT_SIGNAL_INTR    EQU    1 
  90. XCPT_SIGNAL_KILLPROC    EQU    3 
  91. XCPT_SIGNAL_BREAK    EQU    4 
  92. ; 
  93. ;* Portable non-fatal software generated exceptions
  94. ;  
  95. XCPT_GUARD_PAGE_VIOLATION    EQU    80000001H 
  96.       ;  ExceptionInfo[ 0 ] - Access Code: XCPT_READ_ACCESS
  97. ;                                          XCPT_WRITE_ACCESS   
  98.       ;  ExceptionInfo[ 1 ] - FaultAddr   
  99. XCPT_UNABLE_TO_GROW_STACK    EQU    80010001H 
  100. ; 
  101. ;* Portable fatal hardware generated exceptions
  102. ;  
  103. XCPT_DATATYPE_MISALIGNMENT    EQU    0C000009EH 
  104.       ;  ExceptionInfo[ 0 ] - Access Code: XCPT_READ_ACCESS
  105. ;                                          XCPT_WRITE_ACCESS   
  106.       ;  ExceptionInfo[ 1 ] - Alignment   
  107.       ;  ExceptionInfo[ 2 ] - FaultAddr   
  108. XCPT_BREAKPOINT    EQU    0C000009FH 
  109. XCPT_SINGLE_STEP    EQU    0C00000A0H 
  110. XCPT_ACCESS_VIOLATION    EQU    0C0000005H 
  111.       ;  ExceptionInfo[ 0 ] - Access Code: XCPT_READ_ACCESS
  112. ;                                          XCPT_WRITE_ACCESS
  113. ;                                          XCPT_SPACE_ACCESS
  114. ;                                          XCPT_LIMIT_ACCESS
  115. ;                                          XCPT_UNKNOWN_ACCESS   
  116.       ;  ExceptionInfo[ 1 ] - FaultAddr (XCPT_READ_ACCESS/XCPT_WRITE_ACCESS)
  117. ;                             Selector  (XCPT_SPACE_ACCESS)
  118. ;                             -1        (XCPT_LIMIT_ACCESS)   
  119. XCPT_ILLEGAL_INSTRUCTION    EQU    0C000001CH 
  120. XCPT_FLOAT_DENORMAL_OPERAND    EQU    0C0000094H 
  121. XCPT_FLOAT_DIVIDE_BY_ZERO    EQU    0C0000095H 
  122. XCPT_FLOAT_INEXACT_RESULT    EQU    0C0000096H 
  123. XCPT_FLOAT_INVALID_OPERATION    EQU    0C0000097H 
  124. XCPT_FLOAT_OVERFLOW    EQU    0C0000098H 
  125. XCPT_FLOAT_STACK_CHECK    EQU    0C0000099H 
  126. XCPT_FLOAT_UNDERFLOW    EQU    0C000009AH 
  127. XCPT_INTEGER_DIVIDE_BY_ZERO    EQU    0C000009BH 
  128. XCPT_INTEGER_OVERFLOW    EQU    0C000009CH 
  129. XCPT_PRIVILEGED_INSTRUCTION    EQU    0C000009DH 
  130. ; 
  131. ;* Portable fatal software generated exceptions
  132. ;  
  133. XCPT_IN_PAGE_ERROR    EQU    0C0000006H 
  134.       ;  ExceptionInfo[ 0 ] - FaultAddr   
  135. XCPT_PROCESS_TERMINATE    EQU    0C0010001H 
  136. XCPT_ASYNC_PROCESS_TERMINATE    EQU    0C0010002H 
  137.       ;  ExceptionInfo[ 0 ] - TID of 'terminator' thread   
  138. XCPT_NONCONTINUABLE_EXCEPTION    EQU    0C0000024H 
  139. XCPT_INVALID_DISPOSITION    EQU    0C0000025H 
  140. ; 
  141. ;* Non-portable fatal exceptions
  142. ;  
  143. XCPT_INVALID_LOCK_SEQUENCE    EQU    0C000001DH 
  144. XCPT_ARRAY_BOUNDS_EXCEEDED    EQU    0C0000093H 
  145. XCPT_B1NPX_ERRATA_02    EQU    0C0010004H 
  146. ; 
  147. ;* Misc exceptions
  148. ;  
  149. XCPT_UNWIND    EQU    0C0000026H 
  150. XCPT_BAD_STACK    EQU    0C0000027H 
  151. XCPT_INVALID_UNWIND_TARGET    EQU    0C0000028H 
  152. ; 
  153. ;* Signal Exceptions
  154. ;  
  155. XCPT_SIGNAL    EQU    0C0010003H 
  156.       ;  ExceptionInfo[ 0 ] - Signal Number   
  157. ; 
  158. ;* ContextRecord
  159. ;*
  160. ;* This is the machine specific register contents for the thread
  161. ;* at the time of the exception. Note that only the register sets
  162. ;* specified by ContextFlags contain valid data. Conversely, only
  163. ;* registers specified in ContextFlags will be restored if an exception
  164. ;* is handled.
  165. ;  
  166. ; 
  167. ;* The following flags control the contents of the ContextRecord.
  168. ;  
  169. CONTEXT_CONTROL    EQU    00000001H   ;  SS:ESP, CS:EIP, EFLAGS,      
  170.                                              ;  EBP                          
  171. CONTEXT_INTEGER    EQU    00000002H   ;  EAX, EBX, ECX, EDX, ESI,     
  172.                                              ;  EDI                          
  173. CONTEXT_SEGMENTS    EQU    00000004H   ;  DS, ES, FS, GS               
  174. CONTEXT_FLOATING_POINT    EQU    00000008H   ;  Numeric coprocessor state    
  175. CONTEXT_FULL    EQU    (CONTEXT_CONTROL  OR  CONTEXT_INTEGER  OR                        CONTEXT_SEGMENTS  OR  CONTEXT_FLOATING_POINT)
  176.  
  177. _fpreg    STRUC
  178. losig    DD    ?
  179. hisig    DD    ?
  180. signexp    DW    ?
  181. _fpreg    ENDS
  182.  
  183. FPREG struc
  184. db size _fpreg dup(?)
  185. FPREG ends
  186.  
  187.  
  188. _CONTEXT    STRUC
  189.   ; 
  190. ;  * The flags values within this flag control the contents of
  191. ;  * a ContextRecord.
  192. ;  *
  193. ;  * If the ContextRecord is used as an input parameter, then
  194. ;  * for each portion of the ContextRecord controlled by a flag
  195. ;  * whose value is set, it is assumed that that portion of the
  196. ;  * ContextRecord contains valid context. If the ContextRecord
  197. ;  * is being used to modify a thread's context, then only that
  198. ;  * portion of the thread's context will be modified.
  199. ;  *
  200. ;  * If the ContextRecord is used as an Input/Output parameter to
  201. ;  * capture the context of a thread, then only those portions of the
  202. ;  * thread's context corresponding to set flags will be returned.
  203. ;    
  204. ContextFlags    DD    ?
  205.   ; 
  206. ;  * This section is specified/returned if the ContextFlags
  207. ;  * contains the flag CONTEXT_FLOATING_POINT.
  208. ;    
  209. ctx_env    DD    7 DUP (?)
  210. ctx_stack    DB    SIZE _fpreg * 8 DUP (?)
  211.   ; 
  212. ;  * This section is specified/returned if the ContextFlags
  213. ;  * contains the flag CONTEXT_SEGMENTS.
  214. ;    
  215. ctx_SegGs    DD    ?
  216. ctx_SegFs    DD    ?
  217. ctx_SegEs    DD    ?
  218. ctx_SegDs    DD    ?
  219.   ; 
  220. ;  * This section is specified/returned if the ContextFlags
  221. ;  * contains the flag CONTEXT_INTEGER.
  222. ;    
  223. ctx_RegEdi    DD    ?
  224. ctx_RegEsi    DD    ?
  225. ctx_RegEax    DD    ?
  226. ctx_RegEbx    DD    ?
  227. ctx_RegEcx    DD    ?
  228. ctx_RegEdx    DD    ?
  229.   ; 
  230. ;  * This section is specified/returned if the ContextFlags
  231. ;  * contains the flag CONTEXT_CONTROL.
  232. ;    
  233. ctx_RegEbp    DD    ?
  234. ctx_RegEip    DD    ?
  235. ctx_SegCs    DD    ?
  236. ctx_EFlags    DD    ?
  237. ctx_RegEsp    DD    ?
  238. ctx_SegSs    DD    ?
  239. _CONTEXT    ENDS
  240.  
  241. CONTEXTRECORD struc
  242. db size _CONTEXT dup(?)
  243. CONTEXTRECORD ends
  244.  
  245. PCONTEXTRECORD struc
  246.     dd ?
  247. PCONTEXTRECORD ends
  248.  
  249. ; 
  250. ;* ExceptionReportRecord
  251. ;*
  252. ;* This structure contains machine independant information about an
  253. ;* exception/unwind. No system exception will ever have more than
  254. ;* EXCEPTION_MAXIMUM_PARAMETERS parameters. User exceptions are not
  255. ;* bound to this limit.
  256. ;  
  257. EXCEPTION_MAXIMUM_PARAMETERS    EQU    4  ;  Enough for all system exceptions   
  258.  
  259. _EXCEPTIONREPORTRECORD    STRUC
  260. ExceptionNum    DD    ?                ;  Exception number                  
  261. fHandlerFlags    DD    ?               ;  Exception attributes              
  262. NestedExceptionReportRecord    DD    ?
  263.                                         ;  Preceding exception's report      
  264.                                         ;  record if nested exception        
  265. ExceptionAddress    DD    ?            ;  Exception address                 
  266. cParameters    DD    ?                 ;  Size of exception specific        
  267.                                         ;  information                       
  268. ExceptionInfo    DD    EXCEPTION_MAXIMUM_PARAMETERS DUP (?)
  269.                                         ;  Exception specfic information     
  270. _EXCEPTIONREPORTRECORD    ENDS
  271.  
  272. EXCEPTIONREPORTRECORD struc
  273. db size _EXCEPTIONREPORTRECORD dup(?)
  274. EXCEPTIONREPORTRECORD ends
  275.  
  276. PEXCEPTIONREPORTRECORD struc
  277.     dd ?
  278. PEXCEPTIONREPORTRECORD ends
  279.  
  280. ; 
  281. ;* ExceptionRegistrationRecord
  282. ;*
  283. ;* These are linked together to form a chain of exception handlers that
  284. ;* will be dispatched to upon receipt of an exception.
  285. ;  
  286.  
  287. _EXCEPTIONREGISTRATIONRECORD    STRUC
  288. prev_structure      DD      ?
  289. ExceptionHandler    DD      ?
  290. _EXCEPTIONREGISTRATIONRECORD    ENDS
  291.  
  292. EXCEPTIONREGISTRATIONRECORD struc
  293.         db size _EXCEPTIONREGISTRATIONRECORD dup(?)
  294. EXCEPTIONREGISTRATIONRECORD ends
  295.  
  296. PEXCEPTIONREGISTRATIONRECORD struc
  297.         dd ?
  298. PEXCEPTIONREGISTRATIONRECORD ends
  299.  
  300.  
  301. ; 
  302. ;* End of exception chain marker.
  303. ;  
  304. END_OF_CHAIN    EQU     -1
  305.  
  306.