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