reactos/include/wine/exception.h

   1 /*
   2  * Wine exception handling
   3  *
   4  * Copyright (c) 1999 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef __WINE_WINE_EXCEPTION_H
  22 #define __WINE_WINE_EXCEPTION_H
  23
  24 #include <setjmp.h>
  25 #include <windef.h>
  26 #include <excpt.h>
  27
  28 /* The following definitions allow using exceptions in Wine and Winelib code
  29  *
  30  * They should be used like this:
  31  *
  32  * __TRY
  33  * {
  34  *     do some stuff that can raise an exception
  35  * }
  36  * __EXCEPT(filter_func,param)
  37  * {
  38  *     handle the exception here
  39  * }
  40  * __ENDTRY
  41  *
  42  * or
  43  *
  44  * __TRY
  45  * {
  46  *     do some stuff that can raise an exception
  47  * }
  48  * __FINALLY(finally_func,param)
  49  *
  50  * The filter_func must be defined with the WINE_EXCEPTION_FILTER
  51  * macro, and return one of the EXCEPTION_* code; it can use
  52  * GetExceptionInformation and GetExceptionCode to retrieve the
  53  * exception info.
  54  *
  55  * The finally_func must be defined with the WINE_FINALLY_FUNC macro.
  56  *
  57  * Warning: inside a __TRY or __EXCEPT block, 'break' or 'continue' statements
  58  *          break out of the current block. You cannot use 'return', 'goto'
  59  *          or 'longjmp' to leave a __TRY block, as this will surely crash.
  60  *          You can use them to leave a __EXCEPT block though.
  61  *
  62  * -- AJ
  63  */
  64
  65 /* Define this if you want to use your compiler built-in __try/__except support.
  66  * This is only useful when compiling to a native Windows binary, as the built-in
  67  * compiler exceptions will most certainly not work under Winelib.
  68  */
  69 #ifdef USE_COMPILER_EXCEPTIONS
  70
  71 #define __TRY __try
  72 #define __EXCEPT(func) __except((func)(GetExceptionInformation()))
  73 #define __FINALLY(func) __finally { (func)(!AbnormalTermination()); }
  74 #define __ENDTRY /*nothing*/
  75
  76 #else  /* USE_COMPILER_EXCEPTIONS */
  77
  78 #define __TRY \
  79     do { __WINE_FRAME __f; \
  80          int __first = 1; \
  81          for (;;) if (!__first) \
  82          { \
  83              do {
  84
  85 #define __EXCEPT(func) \
  86              } while(0); \
  87              __wine_pop_frame( &__f.frame ); \
  88              break; \
  89          } else { \
  90              __f.frame.Handler = __wine_exception_handler; \
  91              __f.u.filter = (func); \
  92              __wine_push_frame( &__f.frame ); \
  93              if (sigsetjmp( __f.jmp, 1 )) { \
  94                  const __WINE_FRAME * const __eptr WINE_UNUSED = &__f; \
  95                  do {
  96
  97 #define __ENDTRY \
  98                  } while (0); \
  99                  break; \
 100              } \
 101              __first = 0; \
 102          } \
 103     } while (0);
 104
 105 #define __FINALLY(func) \
 106              } while(0); \
 107              __wine_pop_frame( &__f.frame ); \
 108              (func)(1); \
 109              break; \
 110          } else { \
 111              __f.frame.Handler = __wine_finally_handler; \
 112              __f.u.finally_func = (func); \
 113              __wine_push_frame( &__f.frame ); \
 114              __first = 0; \
 115          } \
 116     } while (0);
 117
 118
 119 typedef DWORD (CALLBACK *__WINE_FILTER)(PEXCEPTION_POINTERS);
 120 typedef void (CALLBACK *__WINE_FINALLY)(BOOL);
 121
 122 #define WINE_EXCEPTION_FILTER(func) DWORD WINAPI func( EXCEPTION_POINTERS *__eptr )
 123 #define WINE_FINALLY_FUNC(func) void WINAPI func( BOOL __normal )
 124
 125 #define GetExceptionInformation() (__eptr)
 126 #define GetExceptionCode()        (__eptr->ExceptionRecord->ExceptionCode)
 127
 128 #if defined(AbnormalTermination) && defined(__REACTOS__)
 129 #undef AbnormalTermination
 130 #endif
 131
 132 #define AbnormalTermination()     (!__normal)
 133
 134 typedef struct __tagWINE_FRAME
 135 {
 136     EXCEPTION_REGISTRATION_RECORD frame;
 137     union
 138     {
 139         /* exception data */
 140         __WINE_FILTER filter;
 141         /* finally data */
 142         __WINE_FINALLY finally_func;
 143     } u;
 144     sigjmp_buf jmp;
 145     /* hack to make GetExceptionCode() work in handler */
 146     DWORD ExceptionCode;
 147     const struct __tagWINE_FRAME *ExceptionRecord;
 148 } __WINE_FRAME;
 149
 150 extern DWORD __wine_exception_handler( PEXCEPTION_RECORD record, EXCEPTION_REGISTRATION_RECORD *frame,
 151                                        CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **pdispatcher );
 152 extern DWORD __wine_finally_handler( PEXCEPTION_RECORD record, EXCEPTION_REGISTRATION_RECORD *frame,
 153                                      CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **pdispatcher );
 154
 155 #endif /* USE_COMPILER_EXCEPTIONS */
 156
 157 static inline EXCEPTION_REGISTRATION_RECORD *__wine_push_frame( EXCEPTION_REGISTRATION_RECORD *frame )
 158 {
 159 #if defined(__GNUC__) && defined(__i386__)
 160     EXCEPTION_REGISTRATION_RECORD *prev;
 161     __asm__ __volatile__(".byte 0x64\n\tmovl (0),%0"
 162                          "\n\tmovl %0,(%1)"
 163                          "\n\t.byte 0x64\n\tmovl %1,(0)"
 164                          : "=&r" (prev) : "r" (frame) : "memory" );
 165     return prev;
 166 #else
 167     NT_TIB *teb = (NT_TIB *)NtCurrentTeb();
 168     frame->Prev = (void *)teb->ExceptionList;
 169     teb->ExceptionList = (void *)frame;
 170     return frame->Prev;
 171 #endif
 172 }
 173
 174 static inline EXCEPTION_REGISTRATION_RECORD *__wine_pop_frame( EXCEPTION_REGISTRATION_RECORD *frame )
 175 {
 176 #if defined(__GNUC__) && defined(__i386__)
 177     __asm__ __volatile__(".byte 0x64\n\tmovl %0,(0)"
 178                          //: : "r" (frame->Prev) : "memory" );
 179     //return frame->Prev;
 180                          : : "r" (frame->prev) : "memory" );
 181     return frame->prev;
 182
 183 #else
 184     NT_TIB *teb = (NT_TIB *)NtCurrentTeb();
 185     teb->ExceptionList = (void *)frame->Prev;
 186     return frame->Prev;
 187 #endif
 188 }
 189
 190
 191 /* Wine-specific exceptions codes */
 192
 193 #define EXCEPTION_WINE_STUB       0x80000100  /* stub entry point called */
 194 #define EXCEPTION_WINE_ASSERTION  0x80000101  /* assertion failed */
 195
 196 /* unhandled return status from vm86 mode */
 197 #define EXCEPTION_VM86_INTx       0x80000110
 198 #define EXCEPTION_VM86_STI        0x80000111
 199 #define EXCEPTION_VM86_PICRETURN  0x80000112
 200
 201 extern void __wine_enter_vm86( CONTEXT *context );
 202
 203 #endif  /* __WINE_WINE_EXCEPTION_H */