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