Changeset 435 for trunk/include/helpers/except.h

Timestamp:

May 24, 2018, 6:16:00 AM (7 years ago)

Author:

rlwalsh

Message:

exception handler: update exception report to show function that set
the handler; optionally, print a debug message with up to 4 arguments

File:

• trunk/include/helpers/except.h (modified) (6 diffs)

trunk/include/helpers/except.h

@@ -70 +70 @@
      *      struct for thread exception handling.
      *
-     *@@changed V0.9.0 (99-10-22) [umoeller]: pfnOnKill added
-     *@@changed V0.9.0 (99-10-22) [umoeller]: renamed from REGREC2
+     *      Note: code within a TRY{}CATCH block can change
+     *      pszFmt and ulArgX whenever needed to help identify
+     *      the cause of an exception
      */
 
@@ -80 +81 @@
         jmp_buf         jmpThread;          // additional buffer for setjmp
         EXCEPTIONREPORTRECORD err;          // exception handlers copy the report rec here
-        PVOID           pvUser;             // user ptr
+        PVOID           pvUser;             // user ptr - set to &pszSetBy by TRY_V2
+        PSZ             pszSetBy;           // the file & function that set the handler
+        PSZ             pszFmt;             // format string for fprintf() - can be null
+        ULONG           ulArg1;             // arg1 for pszFmt
+        ULONG           ulArg2;             // arg2 for pszFmt
+        ULONG           ulArg3;             // arg3 for pszFmt
+        ULONG           ulArg4;             // arg4 for pszFmt
     } EXCEPTIONREGISTRATIONRECORD2;
 
@@ -123 +130 @@
                                       PCONTEXTRECORD pContextRec);
 
+    VOID _Optlink excExplainException2(FILE *file,
+                                       PSZ pszHandlerName,
+                                       PEXCEPTIONREPORTRECORD pReportRec,
+                                       PCONTEXTRECORD pContextRec,
+                                       PEXCEPTIONREGISTRATIONRECORD2 pRegRec2);
+
     VOID excRegisterHooks(PFNEXCOPENFILE pfnExcOpenFileNew,
                           PFNEXCHOOK pfnExcHookNew,
@@ -152 +165 @@
     #ifdef __NO_EXCEPTION_HANDLERS__
         // exception handlers can completely be disabled
+        #define TRY_LOUD6(excptstruct, fmt, arg1, arg2, arg3, arg4)
         #define TRY_LOUD(excptstruct)
-    #else
+        #define FMT_WNDPROC
+    #else
+        // avoid problems if header and source are different versions
+        #define TRY_V2  1
+
         #ifdef __NO_LOUD_EXCEPTION_HANDLERS__
-            #define TRY_LOUD(e) TRY_QUIET(e)
+            #define TRY_LOUD6   TRY_QUIET6
         #else // __NO_LOUD_EXCEPTION_HANDLERS__
-        #define TRY_LOUD(excptstruct)                                           \
+            #define TRY_LOUD6(excptstruct, fmt, arg1, arg2, arg3, arg4)         \
                 {                                                               \
                     EXCEPTSTRUCT          excptstruct = {0};                    \
                     excptstruct.RegRec2.pfnHandler = (PFN)excHandlerLoud;       \
+                    excptstruct.RegRec2.pvUser = &excptstruct.RegRec2.pszSetBy; \
+                    excptstruct.RegRec2.pszSetBy = __FILE__##"::"##__FUNCTION__##"()";  \
+                    excptstruct.RegRec2.pszFmt = fmt;                           \
+                    excptstruct.RegRec2.ulArg1 = (ULONG)arg1;                   \
+                    excptstruct.RegRec2.ulArg2 = (ULONG)arg2;                   \
+                    excptstruct.RegRec2.ulArg3 = (ULONG)arg3;                   \
+                    excptstruct.RegRec2.ulArg4 = (ULONG)arg4;                   \
                     excptstruct.arc = DosSetExceptionHandler(                   \
                                 (PEXCEPTIONREGISTRATIONRECORD)&(excptstruct.RegRec2)); \
@@ -173 +198 @@
 
         #endif // __NO_LOUD_EXCEPTION_HANDLERS__
-    #endif
-
-    #ifdef __NO_EXCEPTION_HANDLERS__
-        // exception handlers can completely be disabled
+
+        #define TRY_LOUD(excptstruct) \
+            TRY_LOUD6(excptstruct, 0, 0, 0, 0, 0)
+
+        #define TRY_LOUD2(excptstruct, fmt) \
+            TRY_LOUD6(excptstruct, fmt, 0, 0, 0, 0)
+
+        #define TRY_LOUD3(excptstruct, fmt, arg1) \
+            TRY_LOUD6(excptstruct, fmt, arg1, 0, 0, 0)
+
+        #define TRY_LOUD4(excptstruct, fmt, arg1, arg2) \
+            TRY_LOUD6(excptstruct, fmt, arg1, arg2, 0, 0)
+
+        #define TRY_LOUD5(excptstruct, fmt, arg1, arg2, arg3) \
+            TRY_LOUD6(excptstruct, fmt, arg1, arg2, arg3, 0)
+
+        #define TRY_WNDPROC_FMT     "hwnd= %08x  msg= %04x  mp1= %08x  mp2= %08x\n"
+
+        #define TRY_WNDPROC(excptstruct, hwd) \
+            TRY_LOUD6(excptstruct, TRY_WNDPROC_FMT, hwd, msg, mp1, mp2)
+
+    #endif
+
+    #ifdef __NO_EXCEPTION_HANDLERS__
+        // exception handlers can completely be disabled
+        #define TRY_QUIET6(excptstruct, fmt, arg1, arg2, arg3, arg4)
         #define TRY_QUIET(excptstruct)
     #else
-        #define TRY_QUIET(excptstruct)                                          \
+        #define TRY_QUIET6(excptstruct, fmt, arg1, arg2, arg3, arg4)            \
                 {                                                               \
                     EXCEPTSTRUCT          excptstruct = {0};                    \
                     excptstruct.RegRec2.pfnHandler = (PFN)excHandlerQuiet;      \
+                    excptstruct.RegRec2.pvUser = &excptstruct.RegRec2.pszSetBy; \
+                    excptstruct.RegRec2.pszSetBy = __FILE__##"::"##__FUNCTION__##"()";  \
+                    excptstruct.RegRec2.pszFmt = fmt;                           \
+                    excptstruct.RegRec2.ulArg1 = arg1;                          \
+                    excptstruct.RegRec2.ulArg2 = arg2;                          \
+                    excptstruct.RegRec2.ulArg3 = arg3;                          \
+                    excptstruct.RegRec2.ulArg4 = arg4;                          \
                     excptstruct.arc = DosSetExceptionHandler(                   \
                                 (PEXCEPTIONREGISTRATIONRECORD)&(excptstruct.RegRec2)); \
@@ -194 +248 @@
                     {
 
+        #define TRY_QUIET(excptstruct) \
+            TRY_QUIET6(excptstruct, 0, 0, 0, 0, 0)
+
     #endif