home *** CD-ROM | disk | FTP | other *** search
/ The Developer Connection…ice Driver Kit for OS/2 3 / DEV3-D1.ISO / devtools / toolkt21 / cplus / os2h / bsexcpt.h < prev    next >
Encoding:
C/C++ Source or Header  |  1993-05-02  |  11.4 KB  |  355 lines
  1. /*      SCCSID = @(#)bsexcpt.h    6.9 92/03/15 */
  2.  
  3. /*************************** START OF SPECIFICATION *****************
  4.  *
  5.  * Source File Name: bsexcpt.h
  6.  *
  7.  * Descriptive Name: Thread Exception Constants and Structure Definitions.
  8.  *
  9.  * Copyright: IBM Corp. 1989  - 1992
  10.  *
  11.  * Function: This file provides constants and data structure
  12.  *      definitions required by application programs to use 32 bit
  13.  *      thread exceptions management facility.
  14.  *
  15.  * Notes: None.
  16.  *
  17.  *************************** END OF SPECIFICATION *******************/
  18.  
  19. #pragma info( none )
  20.    #ifndef __CHKHDR__
  21.       #pragma info( none )
  22.    #endif
  23. #pragma info( restore )
  24. #ifdef __cplusplus
  25.       extern "C" {
  26. #endif
  27.  
  28. #ifndef __BSEXCPT__
  29. #define __BSEXCPT__
  30.  
  31. /*
  32.  * User Exception Handler Return Codes:
  33.  */
  34.  
  35. #define XCPT_CONTINUE_SEARCH    0x00000000      /* exception not handled   */
  36. #define XCPT_CONTINUE_EXECUTION 0xFFFFFFFF      /* exception handled       */
  37. #define XCPT_CONTINUE_STOP      0x00716668      /* exception handled by    */
  38.                                                 /* debugger (VIA DosDebug) */
  39.  
  40. /*
  41.  * fHandlerFlags values (see ExceptionReportRecord):
  42.  *
  43.  * The user may only set (but not clear) the EH_NONCONTINUABLE flag.
  44.  * All other flags are set by the system.
  45.  *
  46.  */
  47.  
  48. #define EH_NONCONTINUABLE   0x1          /* Noncontinuable exception */
  49. #define EH_UNWINDING        0x2          /* Unwind is in progress */
  50. #define EH_EXIT_UNWIND      0x4          /* Exit unwind is in progress */
  51. #define EH_STACK_INVALID    0x8          /* Stack out of limits or unaligned */
  52. #define EH_NESTED_CALL      0x10         /* Nested exception handler call */
  53.  
  54.  
  55. /*
  56.  * Unwind all exception handlers (see DosUnwindException API)
  57.  */
  58. #define UNWIND_ALL              0
  59.  
  60.  
  61. /*
  62.  *   Exception values are 32 bit values layed out as follows:
  63.  *
  64.  *   3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
  65.  *   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
  66.  *   +---+-+-------------------------+-------------------------------+
  67.  *   |Sev|C|       Facility          |               Code            |
  68.  *   +---+-+-------------------------+-------------------------------+
  69.  *
  70.  *   where
  71.  *
  72.  *       Sev - is the severity code
  73.  *           00 - Success
  74.  *           01 - Informational
  75.  *           10 - Warning
  76.  *           11 - Error
  77.  *
  78.  *       C - is the Customer code flag
  79.  *
  80.  *       Facility - is the facility code
  81.  *
  82.  *       Code - is the facility's status code
  83.  *
  84.  *   Exceptions specific to OS/2 2.0 (e.g. XCPT_SIGNAL) will be marked
  85.  *   with a facility code of 1.
  86.  *
  87.  *   System defined exceptions have a facility code of zero.
  88.  *
  89.  *   Each exception may also have several pieces of additional information.
  90.  *   These are stored in the ExceptionInfo fields of the
  91.  *   ExceptionReportRecord. They are documented here with the exceptions
  92.  *   only for ease of reference.
  93.  */
  94.  
  95. #define XCPT_FATAL_EXCEPTION    0xC0000000
  96. #define XCPT_SEVERITY_CODE      0xC0000000
  97. #define XCPT_CUSTOMER_CODE      0x20000000
  98. #define XCPT_FACILITY_CODE      0x1FFF0000
  99. #define XCPT_EXCEPTION_CODE     0x0000FFFF
  100.  
  101. /*  Violation flags in ExceptionInfo */
  102.  
  103. #define XCPT_UNKNOWN_ACCESS     0x00000000      /* Unknown access */
  104. #define XCPT_READ_ACCESS        0x00000001      /* Read access    */
  105. #define XCPT_WRITE_ACCESS       0x00000002      /* Write access   */
  106. #define XCPT_EXECUTE_ACCESS     0x00000004      /* Execute access */
  107. #define XCPT_SPACE_ACCESS       0x00000008      /* Address space access */
  108. #define XCPT_LIMIT_ACCESS       0x00000010      /* Address space limit violation */
  109. #define XCPT_DATA_UNKNOWN       0xFFFFFFFF
  110.  
  111. /*  Signal numbers for XCPT_SIGNAL */
  112.  
  113. #define XCPT_SIGNAL_INTR        1
  114. #define XCPT_SIGNAL_KILLPROC    3
  115. #define XCPT_SIGNAL_BREAK       4
  116.  
  117. /*  Portable non-fatal software generated exceptions */
  118.  
  119. #define XCPT_GUARD_PAGE_VIOLATION       0x80000001
  120.       /* ExceptionInfo[ 0 ] - Access Code: XCPT_READ_ACCESS
  121.                                            XCPT_WRITE_ACCESS */
  122.       /* ExceptionInfo[ 1 ] - FaultAddr */
  123.  
  124. #define XCPT_UNABLE_TO_GROW_STACK       0x80010001
  125.  
  126. /*  Portable fatal hardware generated exceptions */
  127.  
  128. #define XCPT_DATATYPE_MISALIGNMENT      0xC000009E
  129.       /* ExceptionInfo[ 0 ] - Access Code: XCPT_READ_ACCESS
  130.                                            XCPT_WRITE_ACCESS */
  131.       /* ExceptionInfo[ 1 ] - Alignment */
  132.       /* ExceptionInfo[ 2 ] - FaultAddr */
  133.  
  134. #define XCPT_BREAKPOINT                 0xC000009F
  135. #define XCPT_SINGLE_STEP                0xC00000A0
  136. #define XCPT_ACCESS_VIOLATION           0xC0000005
  137.       /* ExceptionInfo[ 0 ] - Access Code: XCPT_READ_ACCESS
  138.                                            XCPT_WRITE_ACCESS
  139.                                            XCPT_SPACE_ACCESS
  140.                                            XCPT_LIMIT_ACCESS
  141.                                            XCPT_UNKNOWN_ACCESS */
  142.       /* ExceptionInfo[ 1 ] - FaultAddr (XCPT_READ_ACCESS/XCPT_WRITE_ACCESS)
  143.                               Selector  (XCPT_SPACE_ACCESS)
  144.                               -1        (XCPT_LIMIT_ACCESS) */
  145.  
  146. #define XCPT_ILLEGAL_INSTRUCTION        0xC000001C
  147. #define XCPT_FLOAT_DENORMAL_OPERAND     0xC0000094
  148. #define XCPT_FLOAT_DIVIDE_BY_ZERO       0xC0000095
  149. #define XCPT_FLOAT_INEXACT_RESULT       0xC0000096
  150. #define XCPT_FLOAT_INVALID_OPERATION    0xC0000097
  151. #define XCPT_FLOAT_OVERFLOW             0xC0000098
  152. #define XCPT_FLOAT_STACK_CHECK          0xC0000099
  153. #define XCPT_FLOAT_UNDERFLOW            0xC000009A
  154. #define XCPT_INTEGER_DIVIDE_BY_ZERO     0xC000009B
  155. #define XCPT_INTEGER_OVERFLOW           0xC000009C
  156. #define XCPT_PRIVILEGED_INSTRUCTION     0xC000009D
  157.  
  158. /*  Portable fatal software generated exceptions */
  159.  
  160. #define XCPT_IN_PAGE_ERROR              0xC0000006
  161.       /* ExceptionInfo[ 0 ] - FaultAddr */
  162.  
  163. #define XCPT_PROCESS_TERMINATE          0xC0010001
  164. #define XCPT_ASYNC_PROCESS_TERMINATE    0xC0010002
  165.       /* ExceptionInfo[ 0 ] - TID of 'terminator' thread */
  166.  
  167. #define XCPT_NONCONTINUABLE_EXCEPTION   0xC0000024
  168. #define XCPT_INVALID_DISPOSITION        0xC0000025
  169.  
  170. /*  Non-portable fatal exceptions */
  171.  
  172. #define XCPT_INVALID_LOCK_SEQUENCE      0xC000001D
  173. #define XCPT_ARRAY_BOUNDS_EXCEEDED      0xC0000093
  174. #define XCPT_B1NPX_ERRATA_02            0xC0010004
  175.  
  176. /*  Misc exceptions */
  177.  
  178. #define XCPT_UNWIND                     0xC0000026
  179. #define XCPT_BAD_STACK                  0xC0000027
  180. #define XCPT_INVALID_UNWIND_TARGET      0xC0000028
  181.  
  182. /*  Signal Exceptions */
  183.  
  184. #define XCPT_SIGNAL                     0xC0010003
  185.       /* ExceptionInfo[ 0 ] - Signal Number */
  186.  
  187. /*
  188.  * ContextRecord
  189.  *
  190.  * This is the machine specific register contents for the thread
  191.  * at the time of the exception. Note that only the register sets
  192.  * specified by ContextFlags contain valid data. Conversely, only
  193.  * registers specified in ContextFlags will be restored if an exception
  194.  * is handled.
  195.  */
  196.  
  197. /*  The following flags control the contents of the CONTEXT structure. */
  198.  
  199. #define CONTEXT_CONTROL         0x00000001L     /* SS:ESP, CS:EIP, EFLAGS,  */
  200.                                                 /* EBP                      */
  201. #define CONTEXT_INTEGER         0x00000002L     /* EAX, EBX, ECX, EDX, ESI, */
  202.                                                 /* EDI                      */
  203. #define CONTEXT_SEGMENTS        0x00000004L     /* DS, ES, FS, GS           */
  204. #define CONTEXT_FLOATING_POINT  0x00000008L     /* numeric coprocessor state */
  205.  
  206. #define CONTEXT_FULL            (CONTEXT_CONTROL | CONTEXT_INTEGER | \
  207.                                  CONTEXT_SEGMENTS | CONTEXT_FLOATING_POINT)
  208.  
  209. /*XLATOFF */
  210. #pragma pack(1)
  211. /*XLATON  */
  212. typedef struct  _fpreg      /* coprocessor stack register element */
  213.    {
  214.    ULONG losig;
  215.    ULONG hisig;
  216.    USHORT signexp;
  217.    } FPREG , *PFPREG ;
  218. #pragma pack()
  219.  
  220. struct _CONTEXT
  221.    {
  222.   /*
  223.    * The flags values within this flag control the contents of
  224.    * a ContextRecord.
  225.    *
  226.    * If the ContextRecord is used as an input parameter, then
  227.    * for each portion of the ContextRecord controlled by a flag
  228.    * whose value is set, it is assumed that that portion of the
  229.    * ContextRecord contains valid context. If the ContextRecord
  230.    * is being used to modify a thread's context, then only that
  231.    * portion of the thread's context will be modified.
  232.    *
  233.    * If the ContextRecord is used as an Input/Output parameter to
  234.    * capture the context of a thread, then only those portions of the
  235.    * thread's context corresponding to set flags will be returned.
  236.    */
  237.  
  238.    ULONG ContextFlags;
  239.  
  240.   /*
  241.    * This section is specified/returned if the ContextFlags
  242.    * contains the flag CONTEXT_FLOATING_POINT.
  243.    */
  244.  
  245.    ULONG   ctx_env[7];
  246.    FPREG   ctx_stack[8];
  247.  
  248.   /*
  249.    * This section is specified/returned if the ContextFlags
  250.    * contains the flag CONTEXT_SEGMENTS.
  251.    */
  252.  
  253.    ULONG ctx_SegGs;
  254.    ULONG ctx_SegFs;
  255.    ULONG ctx_SegEs;
  256.    ULONG ctx_SegDs;
  257.  
  258.   /*
  259.    * This section is specified/returned if the ContextFlags
  260.    * contains the flag CONTEXT_INTEGER.
  261.    */
  262.  
  263.    ULONG ctx_RegEdi;
  264.    ULONG ctx_RegEsi;
  265.    ULONG ctx_RegEax;
  266.    ULONG ctx_RegEbx;
  267.    ULONG ctx_RegEcx;
  268.    ULONG ctx_RegEdx;
  269.  
  270.   /*
  271.    * This section is specified/returned if the ContextFlags
  272.    * contains the flag CONTEXT_CONTROL.
  273.    */
  274.  
  275.    ULONG ctx_RegEbp;
  276.    ULONG ctx_RegEip;
  277.    ULONG ctx_SegCs;
  278.    ULONG ctx_EFlags;
  279.    ULONG ctx_RegEsp;
  280.    ULONG ctx_SegSs;
  281.  
  282.    };
  283.  
  284. typedef struct _CONTEXT CONTEXTRECORD;
  285. typedef struct _CONTEXT *PCONTEXTRECORD;
  286.  
  287.  
  288. /*
  289.  * ExceptionReportRecord
  290.  *
  291.  * This structure contains machine independant information about an
  292.  * exception/unwind. No system exception will ever have more than
  293.  * EXCEPTION_MAXIMUM_PARAMETERS parameters. User exceptions are not
  294.  * bound to this limit.
  295.  */
  296.  
  297.  
  298. #define EXCEPTION_MAXIMUM_PARAMETERS 4  /* Enough for all system exceptions. */
  299.  
  300. struct _EXCEPTIONREPORTRECORD
  301.    {
  302.    ULONG   ExceptionNum;                /* exception number */
  303.    ULONG   fHandlerFlags;
  304.    struct  _EXCEPTIONREPORTRECORD    *NestedExceptionReportRecord;
  305.    PVOID   ExceptionAddress;
  306.    ULONG   cParameters;                 /* Size of Exception Specific Info */
  307.    ULONG   ExceptionInfo[EXCEPTION_MAXIMUM_PARAMETERS];
  308.                                         /* Exception Specfic Info */
  309.    };
  310.  
  311. typedef struct _EXCEPTIONREPORTRECORD EXCEPTIONREPORTRECORD;
  312. typedef struct _EXCEPTIONREPORTRECORD *PEXCEPTIONREPORTRECORD;
  313.  
  314. /*
  315.  * ExceptionRegistrationRecord
  316.  *
  317.  * These are linked together to form a chain of exception handlers that
  318.  * will be dispatched to upon receipt of an exception.
  319.  */
  320.  
  321.  
  322. struct _EXCEPTIONREGISTRATIONRECORD;
  323.  
  324. typedef ULONG APIENTRY _ERR(PEXCEPTIONREPORTRECORD,
  325.                             struct _EXCEPTIONREGISTRATIONRECORD *,
  326.                             PCONTEXTRECORD,
  327.                             PVOID);
  328.  
  329. typedef _ERR  *ERR;
  330.  
  331. struct _EXCEPTIONREGISTRATIONRECORD
  332.    {
  333.    struct _EXCEPTIONREGISTRATIONRECORD * volatile prev_structure;
  334.    _ERR * volatile ExceptionHandler;
  335.    };
  336.  
  337. typedef struct _EXCEPTIONREGISTRATIONRECORD EXCEPTIONREGISTRATIONRECORD;
  338. typedef struct _EXCEPTIONREGISTRATIONRECORD *PEXCEPTIONREGISTRATIONRECORD;
  339.  
  340. /* End of exception chain marker. */
  341.  
  342. #define END_OF_CHAIN        ((PEXCEPTIONREGISTRATIONRECORD) -1)
  343. #pragma pack()
  344.  
  345. #endif /* __BSEXCPT__ */
  346.  
  347. #ifdef __cplusplus
  348.         }
  349. #endif
  350. #pragma info( none )
  351.    #ifndef __CHKHDR__
  352.       #pragma info( restore )
  353.    #endif
  354. #pragma info( restore )
  355.