2 * Wine exception handling
4 * Copyright (c) 1999 Alexandre Julliard
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.
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.
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #ifndef __WINE_WINE_EXCEPTION_H
22 #define __WINE_WINE_EXCEPTION_H
32 /* The following definitions allow using exceptions in Wine and Winelib code
34 * They should be used like this:
38 * do some stuff that can raise an exception
40 * __EXCEPT(filter_func)
42 * handle the exception here
50 * do some stuff that can raise an exception
52 * __FINALLY(finally_func)
54 * The filter_func and finally_func functions must be defined like this:
56 * LONG CALLBACK filter_func( PEXCEPTION_POINTERS __eptr ) { ... }
58 * void CALLBACK finally_func( BOOL __normal ) { ... }
60 * The filter function must return one of the EXCEPTION_* code; it can
61 * use GetExceptionInformation() and GetExceptionCode() to retrieve the
64 * Warning: inside a __TRY or __EXCEPT block, 'break' or 'continue' statements
65 * break out of the current block. You cannot use 'return', 'goto'
66 * or 'longjmp' to leave a __TRY block, as this will surely crash.
67 * You can use them to leave a __EXCEPT block though.
72 /* Define this if you want to use your compiler built-in __try/__except support.
73 * This is only useful when compiling to a native Windows binary, as the built-in
74 * compiler exceptions will most certainly not work under Winelib.
76 #ifdef USE_COMPILER_EXCEPTIONS
79 #define __EXCEPT(func) __except((func)(GetExceptionInformation()))
80 #define __FINALLY(func) __finally { (func)(!AbnormalTermination()); }
81 #define __ENDTRY /*nothing*/
82 #define __EXCEPT_PAGE_FAULT __except(GetExceptionCode() == EXCEPTION_ACCESS_VIOLATION)
83 #define __EXCEPT_ALL __except(EXCEPTION_EXECUTE_HANDLER)
85 #else /* USE_COMPILER_EXCEPTIONS */
88 #define __attribute__(x) /* nothing */
91 #if defined(__MINGW32__) || defined(__CYGWIN__)
92 #define sigjmp_buf jmp_buf
93 #define sigsetjmp(buf,sigs) setjmp(buf)
94 #define siglongjmp(buf,val) longjmp(buf,val)
98 do { __WINE_FRAME __f; \
100 for (;;) if (!__first) \
104 #define __EXCEPT(func) \
106 __wine_pop_frame( &__f.frame ); \
109 __f.frame.Handler = __wine_exception_handler; \
110 __f.u.filter = (func); \
111 if (sigsetjmp( __f.jmp, 0 )) { \
112 const __WINE_FRAME * const __eptr __attribute__((unused)) = &__f; \
115 /* convenience handler for page fault exceptions */
116 #define __EXCEPT_PAGE_FAULT \
118 __wine_pop_frame( &__f.frame ); \
121 __f.frame.Handler = __wine_exception_handler_page_fault; \
122 if (sigsetjmp( __f.jmp, 0 )) { \
123 const __WINE_FRAME * const __eptr __attribute__((unused)) = &__f; \
126 /* convenience handler for all exception */
127 #define __EXCEPT_ALL \
129 __wine_pop_frame( &__f.frame ); \
132 __f.frame.Handler = __wine_exception_handler_all; \
133 if (sigsetjmp( __f.jmp, 0 )) { \
134 const __WINE_FRAME * const __eptr __attribute__((unused)) = &__f; \
141 __wine_push_frame( &__f.frame ); \
146 #define __FINALLY(func) \
148 __wine_pop_frame( &__f.frame ); \
152 __f.frame.Handler = __wine_finally_handler; \
153 __f.u.finally_func = (func); \
154 __wine_push_frame( &__f.frame ); \
160 typedef LONG (CALLBACK
*__WINE_FILTER
)(PEXCEPTION_POINTERS
);
161 typedef void (CALLBACK
*__WINE_FINALLY
)(BOOL
);
163 #define GetExceptionInformation() (__eptr)
164 #define GetExceptionCode() (__eptr->ExceptionRecord->ExceptionCode)
165 #define AbnormalTermination() (!__normal)
167 typedef struct __tagWINE_FRAME
169 EXCEPTION_REGISTRATION_RECORD frame
;
173 __WINE_FILTER filter
;
175 __WINE_FINALLY finally_func
;
178 /* hack to make GetExceptionCode() work in handler */
180 const struct __tagWINE_FRAME
*ExceptionRecord
;
183 #endif /* USE_COMPILER_EXCEPTIONS */
185 static inline EXCEPTION_REGISTRATION_RECORD
*__wine_push_frame( EXCEPTION_REGISTRATION_RECORD
*frame
)
187 #if defined(__GNUC__) && defined(__i386__)
188 EXCEPTION_REGISTRATION_RECORD
*prev
;
189 __asm__
__volatile__(".byte 0x64\n\tmovl (0),%0"
191 "\n\t.byte 0x64\n\tmovl %1,(0)"
192 : "=&r" (prev
) : "r" (frame
) : "memory" );
195 NT_TIB
*teb
= (NT_TIB
*)NtCurrentTeb();
196 frame
->Prev
= teb
->ExceptionList
;
197 teb
->ExceptionList
= frame
;
202 static inline EXCEPTION_REGISTRATION_RECORD
*__wine_pop_frame( EXCEPTION_REGISTRATION_RECORD
*frame
)
204 #if defined(__GNUC__) && defined(__i386__)
205 __asm__
__volatile__(".byte 0x64\n\tmovl %0,(0)"
206 : : "r" (frame
->Prev
) : "memory" );
210 NT_TIB
*teb
= (NT_TIB
*)NtCurrentTeb();
211 teb
->ExceptionList
= frame
->Prev
;
216 static inline EXCEPTION_REGISTRATION_RECORD
*__wine_get_frame(void)
218 #if defined(__GNUC__) && defined(__i386__)
219 EXCEPTION_REGISTRATION_RECORD
*ret
;
220 __asm__
__volatile__(".byte 0x64\n\tmovl (0),%0" : "=r" (ret
) );
223 NT_TIB
*teb
= (NT_TIB
*)NtCurrentTeb();
224 return teb
->ExceptionList
;
228 /* Exception handling flags - from OS/2 2.0 exception handling */
230 /* Win32 seems to use the same flags as ExceptionFlags in an EXCEPTION_RECORD */
231 #define EH_NONCONTINUABLE 0x01
232 #define EH_UNWINDING 0x02
233 #define EH_EXIT_UNWIND 0x04
234 #define EH_STACK_INVALID 0x08
235 #define EH_NESTED_CALL 0x10
237 /* Wine-specific exceptions codes */
239 #define EXCEPTION_WINE_STUB 0x80000100 /* stub entry point called */
240 #define EXCEPTION_WINE_ASSERTION 0x80000101 /* assertion failed */
242 /* unhandled return status from vm86 mode */
243 #define EXCEPTION_VM86_INTx 0x80000110
244 #define EXCEPTION_VM86_STI 0x80000111
245 #define EXCEPTION_VM86_PICRETURN 0x80000112
247 extern void __wine_enter_vm86( CONTEXT
*context
);
249 #ifndef USE_COMPILER_EXCEPTIONS
251 NTSYSAPI
void WINAPI
RtlUnwind(PVOID
,PVOID
,PEXCEPTION_RECORD
,PVOID
);
253 static inline void DECLSPEC_NORETURN
__wine_unwind_target(void)
255 __WINE_FRAME
*wine_frame
= (__WINE_FRAME
*)__wine_get_frame();
256 __wine_pop_frame( &wine_frame
->frame
);
257 siglongjmp( wine_frame
->jmp
, 1 );
260 /* wrapper for RtlUnwind since it clobbers registers on Windows */
261 static inline void DECLSPEC_NORETURN
__wine_rtl_unwind( EXCEPTION_REGISTRATION_RECORD
* frame
,
262 EXCEPTION_RECORD
*record
,
263 void (*target
)(void) )
265 #if defined(__GNUC__) && defined(__i386__)
266 int dummy1
, dummy2
, dummy3
, dummy4
;
267 __asm__
__volatile__("pushl %%ebp\n\t"
276 : "=a" (dummy1
), "=S" (dummy2
), "=D" (dummy3
), "=c" (dummy4
)
277 : "0" (RtlUnwind
), "1" (frame
), "2" (target
), "3" (record
)
280 RtlUnwind( frame
, target
, record
, 0 );
285 static inline void DECLSPEC_NORETURN
__wine_unwind_frame( EXCEPTION_RECORD
*record
,
286 EXCEPTION_REGISTRATION_RECORD
*frame
)
288 __WINE_FRAME
*wine_frame
= (__WINE_FRAME
*)frame
;
290 /* hack to make GetExceptionCode() work in handler */
291 wine_frame
->ExceptionCode
= record
->ExceptionCode
;
292 wine_frame
->ExceptionRecord
= wine_frame
;
294 __wine_rtl_unwind( frame
, record
, __wine_unwind_target
);
297 static inline DWORD
__wine_exception_handler( EXCEPTION_RECORD
*record
,
298 EXCEPTION_REGISTRATION_RECORD
*frame
,
300 EXCEPTION_REGISTRATION_RECORD
**pdispatcher
)
302 __WINE_FRAME
*wine_frame
= (__WINE_FRAME
*)frame
;
303 EXCEPTION_POINTERS ptrs
;
305 if (record
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
| EH_NESTED_CALL
))
306 return ExceptionContinueSearch
;
308 ptrs
.ExceptionRecord
= record
;
309 ptrs
.ContextRecord
= context
;
310 switch(wine_frame
->u
.filter( &ptrs
))
312 case EXCEPTION_CONTINUE_SEARCH
:
313 return ExceptionContinueSearch
;
314 case EXCEPTION_CONTINUE_EXECUTION
:
315 return ExceptionContinueExecution
;
316 case EXCEPTION_EXECUTE_HANDLER
:
319 __wine_unwind_frame( record
, frame
);
322 static inline DWORD
__wine_exception_handler_page_fault( EXCEPTION_RECORD
*record
,
323 EXCEPTION_REGISTRATION_RECORD
*frame
,
325 EXCEPTION_REGISTRATION_RECORD
**pdispatcher
)
327 if (record
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
| EH_NESTED_CALL
))
328 return ExceptionContinueSearch
;
329 if (record
->ExceptionCode
!= STATUS_ACCESS_VIOLATION
)
330 return ExceptionContinueSearch
;
331 __wine_unwind_frame( record
, frame
);
334 static inline DWORD
__wine_exception_handler_all( EXCEPTION_RECORD
*record
,
335 EXCEPTION_REGISTRATION_RECORD
*frame
,
337 EXCEPTION_REGISTRATION_RECORD
**pdispatcher
)
339 if (record
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
| EH_NESTED_CALL
))
340 return ExceptionContinueSearch
;
341 __wine_unwind_frame( record
, frame
);
344 static inline DWORD
__wine_finally_handler( EXCEPTION_RECORD
*record
,
345 EXCEPTION_REGISTRATION_RECORD
*frame
,
347 EXCEPTION_REGISTRATION_RECORD
**pdispatcher
)
349 if (record
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
))
351 __WINE_FRAME
*wine_frame
= (__WINE_FRAME
*)frame
;
352 wine_frame
->u
.finally_func( FALSE
);
354 return ExceptionContinueSearch
;
357 #endif /* USE_COMPILER_EXCEPTIONS */
363 #endif /* __WINE_WINE_EXCEPTION_H */