2 * msvcrt C++ exception handling
4 * Copyright 2000 Jon Griffiths
5 * Copyright 2002 Alexandre Julliard
6 * Copyright 2005 Juan Lang
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 * A good reference is the article "How a C++ compiler implements
24 * exception handling" by Vishal Kochhar, available on
25 * www.thecodeproject.com.
29 #include "wine/port.h"
39 #include "wine/exception.h"
41 #include "wine/debug.h"
43 #include "cppexcept.h"
45 WINE_DEFAULT_DEBUG_CHANNEL(seh
);
48 /* the exception frame used by CxxFrameHandler */
49 typedef struct __cxx_exception_frame
51 EXCEPTION_REGISTRATION_RECORD frame
; /* the standard exception frame */
54 } cxx_exception_frame
;
56 /* info about a single catch {} block */
57 typedef struct __catchblock_info
59 UINT flags
; /* flags (see below) */
60 const type_info
*type_info
; /* C++ type caught by this block */
61 int offset
; /* stack offset to copy exception object to */
62 void (*handler
)(void);/* catch block handler code */
64 #define TYPE_FLAG_CONST 1
65 #define TYPE_FLAG_VOLATILE 2
66 #define TYPE_FLAG_REFERENCE 8
68 /* info about a single try {} block */
69 typedef struct __tryblock_info
71 int start_level
; /* start trylevel of that block */
72 int end_level
; /* end trylevel of that block */
73 int catch_level
; /* initial trylevel of the catch block */
74 int catchblock_count
; /* count of catch blocks in array */
75 const catchblock_info
*catchblock
; /* array of catch blocks */
78 /* info about the unwind handler for a given trylevel */
79 typedef struct __unwind_info
81 int prev
; /* prev trylevel unwind handler, to run after this one */
82 void (*handler
)(void);/* unwind handler */
85 /* descriptor of all try blocks of a given function */
86 typedef struct __cxx_function_descr
88 UINT magic
; /* must be CXX_FRAME_MAGIC */
89 UINT unwind_count
; /* number of unwind handlers */
90 const unwind_info
*unwind_table
; /* array of unwind handlers */
91 UINT tryblock_count
; /* number of try blocks */
92 const tryblock_info
*tryblock
; /* array of try blocks */
95 const void *expect_list
; /* expected exceptions list when magic >= VC7 */
96 UINT flags
; /* flags when magic >= VC8 */
99 #define FUNC_DESCR_SYNCHRONOUS 1 /* synchronous exceptions only (built with /EHs) */
101 typedef struct _SCOPETABLE
103 int previousTryLevel
;
104 int (*lpfnFilter
)(PEXCEPTION_POINTERS
);
105 int (*lpfnHandler
)(void);
106 } SCOPETABLE
, *PSCOPETABLE
;
108 typedef struct _MSVCRT_EXCEPTION_FRAME
110 EXCEPTION_REGISTRATION_RECORD
*prev
;
111 void (*handler
)(PEXCEPTION_RECORD
, EXCEPTION_REGISTRATION_RECORD
*,
112 PCONTEXT
, PEXCEPTION_RECORD
);
113 PSCOPETABLE scopetable
;
116 PEXCEPTION_POINTERS xpointers
;
117 } MSVCRT_EXCEPTION_FRAME
;
121 int gs_cookie_offset
;
123 int eh_cookie_offset
;
125 SCOPETABLE entries
[1];
128 #define TRYLEVEL_END (-1) /* End of trylevel list */
130 DWORD CDECL
cxx_frame_handler( PEXCEPTION_RECORD rec
, cxx_exception_frame
* frame
,
131 PCONTEXT context
, EXCEPTION_REGISTRATION_RECORD
** dispatch
,
132 const cxx_function_descr
*descr
,
133 EXCEPTION_REGISTRATION_RECORD
* nested_frame
, int nested_trylevel
);
135 /* call a function with a given ebp */
136 static inline void *call_ebp_func( void *func
, void *ebp
)
140 __asm__
__volatile__ ("pushl %%ebx\n\t"
146 : "=a" (ret
), "=S" (dummy
), "=D" (dummy
)
147 : "0" (func
), "1" (ebp
) : "ecx", "edx", "memory" );
151 /* call a copy constructor */
152 static inline void call_copy_ctor( void *func
, void *this, void *src
, int has_vbase
)
154 TRACE( "calling copy ctor %p object %p src %p\n", func
, this, src
);
156 /* in that case copy ctor takes an extra bool indicating whether to copy the base class */
157 __asm__
__volatile__("pushl $1; pushl %2; call *%0"
158 : : "r" (func
), "c" (this), "r" (src
) : "eax", "edx", "memory" );
160 __asm__
__volatile__("pushl %2; call *%0"
161 : : "r" (func
), "c" (this), "r" (src
) : "eax", "edx", "memory" );
164 /* call the destructor of the exception object */
165 static inline void call_dtor( void *func
, void *object
)
167 __asm__
__volatile__("call *%0" : : "r" (func
), "c" (object
) : "eax", "edx", "memory" );
170 /* continue execution to the specified address after exception is caught */
171 static inline void DECLSPEC_NORETURN
continue_after_catch( cxx_exception_frame
* frame
, void *addr
)
173 __asm__
__volatile__("movl -4(%0),%%esp; leal 12(%0),%%ebp; jmp *%1"
174 : : "r" (frame
), "a" (addr
) );
175 for (;;) ; /* unreached */
178 static inline void call_finally_block( void *code_block
, void *base_ptr
)
180 __asm__
__volatile__ ("movl %1,%%ebp; call *%%eax"
181 : : "a" (code_block
), "g" (base_ptr
));
184 static inline int call_filter( int (*func
)(PEXCEPTION_POINTERS
), void *arg
, void *ebp
)
187 __asm__
__volatile__ ("pushl %%ebp; pushl %3; movl %2,%%ebp; call *%%eax; popl %%ebp; popl %%ebp"
189 : "0" (func
), "r" (ebp
), "r" (arg
)
190 : "ecx", "edx", "memory" );
194 static inline int call_unwind_func( int (*func
)(void), void *ebp
)
197 __asm__
__volatile__ ("pushl %%ebp\n\t"
208 : "0" (func
), "r" (ebp
)
209 : "ecx", "edx", "memory" );
213 static inline void dump_type( const cxx_type_info
*type
)
215 TRACE( "flags %x type %p %s offsets %d,%d,%d size %d copy ctor %p\n",
216 type
->flags
, type
->type_info
, dbgstr_type_info(type
->type_info
),
217 type
->offsets
.this_offset
, type
->offsets
.vbase_descr
, type
->offsets
.vbase_offset
,
218 type
->size
, type
->copy_ctor
);
221 static void dump_exception_type( const cxx_exception_type
*type
)
225 TRACE( "flags %x destr %p handler %p type info %p\n",
226 type
->flags
, type
->destructor
, type
->custom_handler
, type
->type_info_table
);
227 for (i
= 0; i
< type
->type_info_table
->count
; i
++)
230 dump_type( type
->type_info_table
->info
[i
] );
234 static void dump_function_descr( const cxx_function_descr
*descr
)
239 TRACE( "magic %x\n", descr
->magic
);
240 TRACE( "unwind table: %p %d\n", descr
->unwind_table
, descr
->unwind_count
);
241 for (i
= 0; i
< descr
->unwind_count
; i
++)
243 TRACE( " %d: prev %d func %p\n", i
,
244 descr
->unwind_table
[i
].prev
, descr
->unwind_table
[i
].handler
);
246 TRACE( "try table: %p %d\n", descr
->tryblock
, descr
->tryblock_count
);
247 for (i
= 0; i
< descr
->tryblock_count
; i
++)
249 TRACE( " %d: start %d end %d catchlevel %d catch %p %d\n", i
,
250 descr
->tryblock
[i
].start_level
, descr
->tryblock
[i
].end_level
,
251 descr
->tryblock
[i
].catch_level
, descr
->tryblock
[i
].catchblock
,
252 descr
->tryblock
[i
].catchblock_count
);
253 for (j
= 0; j
< descr
->tryblock
[i
].catchblock_count
; j
++)
255 const catchblock_info
*ptr
= &descr
->tryblock
[i
].catchblock
[j
];
256 TRACE( " %d: flags %x offset %d handler %p type %p %s\n",
257 j
, ptr
->flags
, ptr
->offset
, ptr
->handler
,
258 ptr
->type_info
, dbgstr_type_info( ptr
->type_info
) );
261 if (descr
->magic
<= CXX_FRAME_MAGIC_VC6
) return;
262 TRACE( "expect list: %p\n", descr
->expect_list
);
263 if (descr
->magic
<= CXX_FRAME_MAGIC_VC7
) return;
264 TRACE( "flags: %08x\n", descr
->flags
);
267 /* check if the exception type is caught by a given catch block, and return the type that matched */
268 static const cxx_type_info
*find_caught_type( cxx_exception_type
*exc_type
,
269 const type_info
*catch_ti
, UINT catch_flags
)
273 for (i
= 0; i
< exc_type
->type_info_table
->count
; i
++)
275 const cxx_type_info
*type
= exc_type
->type_info_table
->info
[i
];
277 if (!catch_ti
) return type
; /* catch(...) matches any type */
278 if (catch_ti
!= type
->type_info
)
280 if (strcmp( catch_ti
->mangled
, type
->type_info
->mangled
)) continue;
282 /* type is the same, now check the flags */
283 if ((exc_type
->flags
& TYPE_FLAG_CONST
) &&
284 !(catch_flags
& TYPE_FLAG_CONST
)) continue;
285 if ((exc_type
->flags
& TYPE_FLAG_VOLATILE
) &&
286 !(catch_flags
& TYPE_FLAG_VOLATILE
)) continue;
287 return type
; /* it matched */
293 /* copy the exception object where the catch block wants it */
294 static void copy_exception( void *object
, cxx_exception_frame
*frame
,
295 const catchblock_info
*catchblock
, const cxx_type_info
*type
)
299 if (!catchblock
->type_info
|| !catchblock
->type_info
->mangled
[0]) return;
300 if (!catchblock
->offset
) return;
301 dest_ptr
= (void **)((char *)&frame
->ebp
+ catchblock
->offset
);
303 if (catchblock
->flags
& TYPE_FLAG_REFERENCE
)
305 *dest_ptr
= get_this_pointer( &type
->offsets
, object
);
307 else if (type
->flags
& CLASS_IS_SIMPLE_TYPE
)
309 memmove( dest_ptr
, object
, type
->size
);
310 /* if it is a pointer, adjust it */
311 if (type
->size
== sizeof(void *)) *dest_ptr
= get_this_pointer( &type
->offsets
, *dest_ptr
);
313 else /* copy the object */
316 call_copy_ctor( type
->copy_ctor
, dest_ptr
, get_this_pointer(&type
->offsets
,object
),
317 (type
->flags
& CLASS_HAS_VIRTUAL_BASE_CLASS
) );
319 memmove( dest_ptr
, get_this_pointer(&type
->offsets
,object
), type
->size
);
323 /* unwind the local function up to a given trylevel */
324 static void cxx_local_unwind( cxx_exception_frame
* frame
, const cxx_function_descr
*descr
, int last_level
)
326 void (*handler
)(void);
327 int trylevel
= frame
->trylevel
;
329 while (trylevel
!= last_level
)
331 if (trylevel
< 0 || trylevel
>= descr
->unwind_count
)
333 ERR( "invalid trylevel %d\n", trylevel
);
336 handler
= descr
->unwind_table
[trylevel
].handler
;
339 TRACE( "calling unwind handler %p trylevel %d last %d ebp %p\n",
340 handler
, trylevel
, last_level
, &frame
->ebp
);
341 call_ebp_func( handler
, &frame
->ebp
);
343 trylevel
= descr
->unwind_table
[trylevel
].prev
;
345 frame
->trylevel
= last_level
;
348 /* exception frame for nested exceptions in catch block */
349 struct catch_func_nested_frame
351 EXCEPTION_REGISTRATION_RECORD frame
; /* standard exception frame */
352 EXCEPTION_RECORD
*prev_rec
; /* previous record to restore in thread data */
353 cxx_exception_frame
*cxx_frame
; /* frame of parent exception */
354 const cxx_function_descr
*descr
; /* descriptor of parent exception */
355 int trylevel
; /* current try level */
356 EXCEPTION_RECORD
*rec
; /* rec associated with frame */
359 /* handler for exceptions happening while calling a catch function */
360 static DWORD
catch_function_nested_handler( EXCEPTION_RECORD
*rec
, EXCEPTION_REGISTRATION_RECORD
*frame
,
361 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**dispatcher
)
363 struct catch_func_nested_frame
*nested_frame
= (struct catch_func_nested_frame
*)frame
;
365 if (rec
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
))
367 msvcrt_get_thread_data()->exc_record
= nested_frame
->prev_rec
;
368 return ExceptionContinueSearch
;
371 TRACE( "got nested exception in catch function\n" );
373 if(rec
->ExceptionCode
== CXX_EXCEPTION
)
375 PEXCEPTION_RECORD prev_rec
= nested_frame
->rec
;
376 if((rec
->ExceptionInformation
[1] == 0 && rec
->ExceptionInformation
[2] == 0) ||
377 (prev_rec
->ExceptionCode
== CXX_EXCEPTION
&&
378 rec
->ExceptionInformation
[1] == prev_rec
->ExceptionInformation
[1] &&
379 rec
->ExceptionInformation
[2] == prev_rec
->ExceptionInformation
[2]))
381 /* exception was rethrown */
383 rec
->ExceptionFlags
&= ~EH_UNWINDING
;
385 TRACE("detect rethrow: exception code: %x\n", rec
->ExceptionCode
);
386 if(rec
->ExceptionCode
== CXX_EXCEPTION
)
387 TRACE("re-propage: obj: %lx, type: %lx\n",
388 rec
->ExceptionInformation
[1], rec
->ExceptionInformation
[2]);
391 else if (nested_frame
->prev_rec
&& nested_frame
->prev_rec
->ExceptionCode
== CXX_EXCEPTION
&&
392 nested_frame
->prev_rec
->ExceptionInformation
[1] == prev_rec
->ExceptionInformation
[1] &&
393 nested_frame
->prev_rec
->ExceptionInformation
[2] == prev_rec
->ExceptionInformation
[2])
395 TRACE("detect threw new exception in catch block - not owning old(obj: %lx type: %lx)\n",
396 prev_rec
->ExceptionInformation
[1], prev_rec
->ExceptionInformation
[2]);
398 else if (prev_rec
->ExceptionCode
== CXX_EXCEPTION
) {
399 /* new exception in exception handler, destroy old */
400 void *object
= (void*)prev_rec
->ExceptionInformation
[1];
401 cxx_exception_type
*info
= (cxx_exception_type
*) prev_rec
->ExceptionInformation
[2];
402 TRACE("detect threw new exception in catch block - destroy old(obj: %p type: %p)\n",
404 if(info
&& info
->destructor
)
405 call_dtor( info
->destructor
, object
);
409 TRACE("detect threw new exception in catch block\n");
413 return cxx_frame_handler( rec
, nested_frame
->cxx_frame
, context
,
414 NULL
, nested_frame
->descr
, &nested_frame
->frame
,
415 nested_frame
->trylevel
);
418 /* find and call the appropriate catch block for an exception */
419 /* returns the address to continue execution to after the catch block was called */
420 static inline void call_catch_block( PEXCEPTION_RECORD rec
, cxx_exception_frame
*frame
,
421 const cxx_function_descr
*descr
, int nested_trylevel
,
422 cxx_exception_type
*info
)
426 void *addr
, *object
= (void *)rec
->ExceptionInformation
[1];
427 struct catch_func_nested_frame nested_frame
;
428 int trylevel
= frame
->trylevel
;
429 thread_data_t
*thread_data
= msvcrt_get_thread_data();
430 DWORD save_esp
= ((DWORD
*)frame
)[-1];
432 for (i
= 0; i
< descr
->tryblock_count
; i
++)
434 const tryblock_info
*tryblock
= &descr
->tryblock
[i
];
436 if (trylevel
< tryblock
->start_level
) continue;
437 if (trylevel
> tryblock
->end_level
) continue;
439 /* got a try block */
440 for (j
= 0; j
< tryblock
->catchblock_count
; j
++)
442 const catchblock_info
*catchblock
= &tryblock
->catchblock
[j
];
445 const cxx_type_info
*type
= find_caught_type( info
,
446 catchblock
->type_info
, catchblock
->flags
);
449 TRACE( "matched type %p in tryblock %d catchblock %d\n", type
, i
, j
);
451 /* copy the exception to its destination on the stack */
452 copy_exception( object
, frame
, catchblock
, type
);
456 /* no CXX_EXCEPTION only proceed with a catch(...) block*/
457 if(catchblock
->type_info
)
459 TRACE("found catch(...) block\n");
462 /* unwind the stack */
463 RtlUnwind( frame
, 0, rec
, 0 );
464 cxx_local_unwind( frame
, descr
, tryblock
->start_level
);
465 frame
->trylevel
= tryblock
->end_level
+ 1;
467 /* call the catch block */
468 TRACE( "calling catch block %p addr %p ebp %p\n",
469 catchblock
, catchblock
->handler
, &frame
->ebp
);
471 /* setup an exception block for nested exceptions */
473 nested_frame
.frame
.Handler
= catch_function_nested_handler
;
474 nested_frame
.prev_rec
= thread_data
->exc_record
;
475 nested_frame
.cxx_frame
= frame
;
476 nested_frame
.descr
= descr
;
477 nested_frame
.trylevel
= nested_trylevel
+ 1;
478 nested_frame
.rec
= rec
;
480 __wine_push_frame( &nested_frame
.frame
);
481 thread_data
->exc_record
= rec
;
482 addr
= call_ebp_func( catchblock
->handler
, &frame
->ebp
);
483 thread_data
->exc_record
= nested_frame
.prev_rec
;
484 __wine_pop_frame( &nested_frame
.frame
);
486 ((DWORD
*)frame
)[-1] = save_esp
;
487 if (info
&& info
->destructor
) call_dtor( info
->destructor
, object
);
488 TRACE( "done, continuing at %p\n", addr
);
490 continue_after_catch( frame
, addr
);
495 /*********************************************************************
496 * __CxxExceptionFilter (MSVCRT.@)
498 int CDECL
__CxxExceptionFilter( PEXCEPTION_POINTERS ptrs
,
499 const type_info
*ti
, int flags
, void **copy
)
501 const cxx_type_info
*type
;
502 PEXCEPTION_RECORD rec
;
504 TRACE( "%p %p %x %p\n", ptrs
, ti
, flags
, copy
);
506 if (!ptrs
) return EXCEPTION_CONTINUE_SEARCH
;
508 /* handle catch(...) */
509 if (!ti
) return EXCEPTION_EXECUTE_HANDLER
;
511 rec
= ptrs
->ExceptionRecord
;
512 if (rec
->ExceptionCode
!= CXX_EXCEPTION
|| rec
->NumberParameters
!= 3 ||
513 rec
->ExceptionInformation
[0] < CXX_FRAME_MAGIC_VC6
||
514 rec
->ExceptionInformation
[0] > CXX_FRAME_MAGIC_VC8
)
515 return EXCEPTION_CONTINUE_SEARCH
;
517 if (rec
->ExceptionInformation
[1] == 0 && rec
->ExceptionInformation
[2] == 0)
519 rec
= msvcrt_get_thread_data()->exc_record
;
520 if (!rec
) return EXCEPTION_CONTINUE_SEARCH
;
523 type
= find_caught_type( (cxx_exception_type
*)rec
->ExceptionInformation
[2], ti
, flags
);
524 if (!type
) return EXCEPTION_CONTINUE_SEARCH
;
528 void *object
= (void *)rec
->ExceptionInformation
[1];
530 if (flags
& TYPE_FLAG_REFERENCE
)
532 *copy
= get_this_pointer( &type
->offsets
, object
);
534 else if (type
->flags
& CLASS_IS_SIMPLE_TYPE
)
536 memmove( copy
, object
, type
->size
);
537 /* if it is a pointer, adjust it */
538 if (type
->size
== sizeof(void*)) *copy
= get_this_pointer( &type
->offsets
, *copy
);
540 else /* copy the object */
543 call_copy_ctor( type
->copy_ctor
, copy
, get_this_pointer(&type
->offsets
,object
),
544 (type
->flags
& CLASS_HAS_VIRTUAL_BASE_CLASS
) );
546 memmove( copy
, get_this_pointer(&type
->offsets
,object
), type
->size
);
549 return EXCEPTION_EXECUTE_HANDLER
;
552 /*********************************************************************
555 * Implementation of __CxxFrameHandler.
557 DWORD CDECL
cxx_frame_handler( PEXCEPTION_RECORD rec
, cxx_exception_frame
* frame
,
558 PCONTEXT context
, EXCEPTION_REGISTRATION_RECORD
** dispatch
,
559 const cxx_function_descr
*descr
,
560 EXCEPTION_REGISTRATION_RECORD
* nested_frame
,
561 int nested_trylevel
)
563 cxx_exception_type
*exc_type
;
565 if (descr
->magic
< CXX_FRAME_MAGIC_VC6
|| descr
->magic
> CXX_FRAME_MAGIC_VC8
)
567 ERR( "invalid frame magic %x\n", descr
->magic
);
568 return ExceptionContinueSearch
;
570 if (descr
->magic
>= CXX_FRAME_MAGIC_VC8
&&
571 (descr
->flags
& FUNC_DESCR_SYNCHRONOUS
) &&
572 (rec
->ExceptionCode
!= CXX_EXCEPTION
))
573 return ExceptionContinueSearch
; /* handle only c++ exceptions */
575 if (rec
->ExceptionFlags
& (EH_UNWINDING
|EH_EXIT_UNWIND
))
577 if (descr
->unwind_count
&& !nested_trylevel
) cxx_local_unwind( frame
, descr
, -1 );
578 return ExceptionContinueSearch
;
580 if (!descr
->tryblock_count
) return ExceptionContinueSearch
;
582 if(rec
->ExceptionCode
== CXX_EXCEPTION
&&
583 rec
->ExceptionInformation
[1] == 0 && rec
->ExceptionInformation
[2] == 0)
585 *rec
= *msvcrt_get_thread_data()->exc_record
;
586 rec
->ExceptionFlags
&= ~EH_UNWINDING
;
588 TRACE("detect rethrow: exception code: %x\n", rec
->ExceptionCode
);
589 if(rec
->ExceptionCode
== CXX_EXCEPTION
)
590 TRACE("re-propage: obj: %lx, type: %lx\n",
591 rec
->ExceptionInformation
[1], rec
->ExceptionInformation
[2]);
595 if(rec
->ExceptionCode
== CXX_EXCEPTION
)
597 exc_type
= (cxx_exception_type
*)rec
->ExceptionInformation
[2];
599 if (rec
->ExceptionInformation
[0] > CXX_FRAME_MAGIC_VC8
&&
600 exc_type
->custom_handler
)
602 return exc_type
->custom_handler( rec
, frame
, context
, dispatch
,
603 descr
, nested_trylevel
, nested_frame
, 0 );
608 TRACE("handling C++ exception rec %p frame %p trylevel %d descr %p nested_frame %p\n",
609 rec
, frame
, frame
->trylevel
, descr
, nested_frame
);
610 dump_exception_type( exc_type
);
611 dump_function_descr( descr
);
616 thread_data_t
*data
= msvcrt_get_thread_data();
619 TRACE("handling C exception code %x rec %p frame %p trylevel %d descr %p nested_frame %p\n",
620 rec
->ExceptionCode
, rec
, frame
, frame
->trylevel
, descr
, nested_frame
);
622 if (data
->se_translator
) {
623 EXCEPTION_POINTERS except_ptrs
;
625 except_ptrs
.ExceptionRecord
= rec
;
626 except_ptrs
.ContextRecord
= context
;
627 data
->se_translator(rec
->ExceptionCode
, &except_ptrs
);
631 call_catch_block( rec
, frame
, descr
, frame
->trylevel
, exc_type
);
632 return ExceptionContinueSearch
;
636 /*********************************************************************
637 * __CxxFrameHandler (MSVCRT.@)
639 extern DWORD CDECL
__CxxFrameHandler( PEXCEPTION_RECORD rec
, EXCEPTION_REGISTRATION_RECORD
* frame
,
640 PCONTEXT context
, EXCEPTION_REGISTRATION_RECORD
** dispatch
);
641 __ASM_GLOBAL_FUNC( __CxxFrameHandler
,
642 "pushl $0\n\t" /* nested_trylevel */
643 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
644 "pushl $0\n\t" /* nested_frame */
645 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
646 "pushl %eax\n\t" /* descr */
647 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
648 "pushl 28(%esp)\n\t" /* dispatch */
649 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
650 "pushl 28(%esp)\n\t" /* context */
651 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
652 "pushl 28(%esp)\n\t" /* frame */
653 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
654 "pushl 28(%esp)\n\t" /* rec */
655 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
656 "call " __ASM_NAME("cxx_frame_handler") "\n\t"
658 __ASM_CFI(".cfi_adjust_cfa_offset -28\n\t")
662 /*********************************************************************
663 * __CxxLongjmpUnwind (MSVCRT.@)
665 * Callback meant to be used as UnwindFunc for setjmp/longjmp.
667 void __stdcall
__CxxLongjmpUnwind( const struct MSVCRT___JUMP_BUFFER
*buf
)
669 cxx_exception_frame
*frame
= (cxx_exception_frame
*)buf
->Registration
;
670 const cxx_function_descr
*descr
= (const cxx_function_descr
*)buf
->UnwindData
[0];
672 TRACE( "unwinding frame %p descr %p trylevel %ld\n", frame
, descr
, buf
->TryLevel
);
673 cxx_local_unwind( frame
, descr
, buf
->TryLevel
);
676 /*********************************************************************
677 * __CppXcptFilter (MSVCRT.@)
679 int CDECL
__CppXcptFilter(NTSTATUS ex
, PEXCEPTION_POINTERS ptr
)
681 /* only filter c++ exceptions */
682 if (ex
!= CXX_EXCEPTION
) return EXCEPTION_CONTINUE_SEARCH
;
683 return _XcptFilter( ex
, ptr
);
686 /*********************************************************************
687 * __CxxDetectRethrow (MSVCRT.@)
689 BOOL CDECL
__CxxDetectRethrow(PEXCEPTION_POINTERS ptrs
)
691 PEXCEPTION_RECORD rec
;
696 rec
= ptrs
->ExceptionRecord
;
698 if (rec
->ExceptionCode
== CXX_EXCEPTION
&&
699 rec
->NumberParameters
== 3 &&
700 rec
->ExceptionInformation
[0] == CXX_FRAME_MAGIC_VC6
&&
701 rec
->ExceptionInformation
[2])
703 ptrs
->ExceptionRecord
= msvcrt_get_thread_data()->exc_record
;
706 return (msvcrt_get_thread_data()->exc_record
== rec
);
709 /*********************************************************************
710 * __CxxQueryExceptionSize (MSVCRT.@)
712 unsigned int CDECL
__CxxQueryExceptionSize(void)
714 return sizeof(cxx_exception_type
);
718 /*********************************************************************
719 * _EH_prolog (MSVCRT.@)
722 /* Provided for VC++ binary compatibility only */
723 __ASM_GLOBAL_FUNC(_EH_prolog
,
724 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t") /* skip ret addr */
726 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
728 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
730 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
731 "movl %esp, %fs:0\n\t"
732 "movl 12(%esp), %eax\n\t"
733 "movl %ebp, 12(%esp)\n\t"
734 "leal 12(%esp), %ebp\n\t"
736 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
739 static const SCOPETABLE_V4
*get_scopetable_v4( MSVCRT_EXCEPTION_FRAME
*frame
, ULONG_PTR cookie
)
741 return (const SCOPETABLE_V4
*)((ULONG_PTR
)frame
->scopetable
^ cookie
);
744 static DWORD
MSVCRT_nested_handler(PEXCEPTION_RECORD rec
,
745 EXCEPTION_REGISTRATION_RECORD
* frame
,
747 EXCEPTION_REGISTRATION_RECORD
** dispatch
)
749 if (!(rec
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
)))
750 return ExceptionContinueSearch
;
752 return ExceptionCollidedUnwind
;
755 static void msvcrt_local_unwind2(MSVCRT_EXCEPTION_FRAME
* frame
, int trylevel
, void *ebp
)
757 EXCEPTION_REGISTRATION_RECORD reg
;
759 TRACE("(%p,%d,%d)\n",frame
, frame
->trylevel
, trylevel
);
761 /* Register a handler in case of a nested exception */
762 reg
.Handler
= MSVCRT_nested_handler
;
763 reg
.Prev
= NtCurrentTeb()->Tib
.ExceptionList
;
764 __wine_push_frame(®
);
766 while (frame
->trylevel
!= TRYLEVEL_END
&& frame
->trylevel
!= trylevel
)
768 int level
= frame
->trylevel
;
769 frame
->trylevel
= frame
->scopetable
[level
].previousTryLevel
;
770 if (!frame
->scopetable
[level
].lpfnFilter
)
772 TRACE( "__try block cleanup level %d handler %p ebp %p\n",
773 level
, frame
->scopetable
[level
].lpfnHandler
, ebp
);
774 call_unwind_func( frame
->scopetable
[level
].lpfnHandler
, ebp
);
777 __wine_pop_frame(®
);
778 TRACE("unwound OK\n");
781 static void msvcrt_local_unwind4( ULONG
*cookie
, MSVCRT_EXCEPTION_FRAME
* frame
, int trylevel
, void *ebp
)
783 EXCEPTION_REGISTRATION_RECORD reg
;
784 const SCOPETABLE_V4
*scopetable
= get_scopetable_v4( frame
, *cookie
);
786 TRACE("(%p,%d,%d)\n",frame
, frame
->trylevel
, trylevel
);
788 /* Register a handler in case of a nested exception */
789 reg
.Handler
= MSVCRT_nested_handler
;
790 reg
.Prev
= NtCurrentTeb()->Tib
.ExceptionList
;
791 __wine_push_frame(®
);
793 while (frame
->trylevel
!= -2 && frame
->trylevel
!= trylevel
)
795 int level
= frame
->trylevel
;
796 frame
->trylevel
= scopetable
->entries
[level
].previousTryLevel
;
797 if (!scopetable
->entries
[level
].lpfnFilter
)
799 TRACE( "__try block cleanup level %d handler %p ebp %p\n",
800 level
, scopetable
->entries
[level
].lpfnHandler
, ebp
);
801 call_unwind_func( scopetable
->entries
[level
].lpfnHandler
, ebp
);
804 __wine_pop_frame(®
);
805 TRACE("unwound OK\n");
808 /*******************************************************************
809 * _local_unwind2 (MSVCRT.@)
811 void CDECL
_local_unwind2(MSVCRT_EXCEPTION_FRAME
* frame
, int trylevel
)
813 msvcrt_local_unwind2( frame
, trylevel
, &frame
->_ebp
);
816 /*******************************************************************
817 * _local_unwind4 (MSVCRT.@)
819 void CDECL
_local_unwind4( ULONG
*cookie
, MSVCRT_EXCEPTION_FRAME
* frame
, int trylevel
)
821 msvcrt_local_unwind4( cookie
, frame
, trylevel
, &frame
->_ebp
);
824 /*******************************************************************
825 * _global_unwind2 (MSVCRT.@)
827 void CDECL
_global_unwind2(EXCEPTION_REGISTRATION_RECORD
* frame
)
829 TRACE("(%p)\n",frame
);
830 RtlUnwind( frame
, 0, 0, 0 );
833 /*********************************************************************
834 * _except_handler2 (MSVCRT.@)
836 int CDECL
_except_handler2(PEXCEPTION_RECORD rec
,
837 EXCEPTION_REGISTRATION_RECORD
* frame
,
839 EXCEPTION_REGISTRATION_RECORD
** dispatcher
)
841 FIXME("exception %x flags=%x at %p handler=%p %p %p stub\n",
842 rec
->ExceptionCode
, rec
->ExceptionFlags
, rec
->ExceptionAddress
,
843 frame
->Handler
, context
, dispatcher
);
844 return ExceptionContinueSearch
;
847 /*********************************************************************
848 * _except_handler3 (MSVCRT.@)
850 int CDECL
_except_handler3(PEXCEPTION_RECORD rec
,
851 MSVCRT_EXCEPTION_FRAME
* frame
,
852 PCONTEXT context
, void* dispatcher
)
854 int retval
, trylevel
;
855 EXCEPTION_POINTERS exceptPtrs
;
856 PSCOPETABLE pScopeTable
;
858 TRACE("exception %x flags=%x at %p handler=%p %p %p semi-stub\n",
859 rec
->ExceptionCode
, rec
->ExceptionFlags
, rec
->ExceptionAddress
,
860 frame
->handler
, context
, dispatcher
);
862 __asm__
__volatile__ ("cld");
864 if (rec
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
))
866 /* Unwinding the current frame */
867 msvcrt_local_unwind2(frame
, TRYLEVEL_END
, &frame
->_ebp
);
868 TRACE("unwound current frame, returning ExceptionContinueSearch\n");
869 return ExceptionContinueSearch
;
873 /* Hunting for handler */
874 exceptPtrs
.ExceptionRecord
= rec
;
875 exceptPtrs
.ContextRecord
= context
;
876 *((DWORD
*)frame
-1) = (DWORD
)&exceptPtrs
;
877 trylevel
= frame
->trylevel
;
878 pScopeTable
= frame
->scopetable
;
880 while (trylevel
!= TRYLEVEL_END
)
882 TRACE( "level %d prev %d filter %p\n", trylevel
, pScopeTable
[trylevel
].previousTryLevel
,
883 pScopeTable
[trylevel
].lpfnFilter
);
884 if (pScopeTable
[trylevel
].lpfnFilter
)
886 retval
= call_filter( pScopeTable
[trylevel
].lpfnFilter
, &exceptPtrs
, &frame
->_ebp
);
888 TRACE("filter returned %s\n", retval
== EXCEPTION_CONTINUE_EXECUTION
?
889 "CONTINUE_EXECUTION" : retval
== EXCEPTION_EXECUTE_HANDLER
?
890 "EXECUTE_HANDLER" : "CONTINUE_SEARCH");
892 if (retval
== EXCEPTION_CONTINUE_EXECUTION
)
893 return ExceptionContinueExecution
;
895 if (retval
== EXCEPTION_EXECUTE_HANDLER
)
897 /* Unwind all higher frames, this one will handle the exception */
898 _global_unwind2((EXCEPTION_REGISTRATION_RECORD
*)frame
);
899 msvcrt_local_unwind2(frame
, trylevel
, &frame
->_ebp
);
901 /* Set our trylevel to the enclosing block, and call the __finally
902 * code, which won't return
904 frame
->trylevel
= pScopeTable
[trylevel
].previousTryLevel
;
905 TRACE("__finally block %p\n",pScopeTable
[trylevel
].lpfnHandler
);
906 call_finally_block(pScopeTable
[trylevel
].lpfnHandler
, &frame
->_ebp
);
907 ERR("Returned from __finally block - expect crash!\n");
910 trylevel
= pScopeTable
[trylevel
].previousTryLevel
;
913 TRACE("reached TRYLEVEL_END, returning ExceptionContinueSearch\n");
914 return ExceptionContinueSearch
;
917 /*********************************************************************
918 * _except_handler4_common (MSVCRT.@)
920 int CDECL
_except_handler4_common( ULONG
*cookie
, void (*check_cookie
)(void),
921 EXCEPTION_RECORD
*rec
, MSVCRT_EXCEPTION_FRAME
*frame
,
922 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**dispatcher
)
924 int retval
, trylevel
;
925 EXCEPTION_POINTERS exceptPtrs
;
926 const SCOPETABLE_V4
*scope_table
= get_scopetable_v4( frame
, *cookie
);
928 TRACE( "exception %x flags=%x at %p handler=%p %p %p cookie=%x scope table=%p cookies=%d/%x,%d/%x\n",
929 rec
->ExceptionCode
, rec
->ExceptionFlags
, rec
->ExceptionAddress
,
930 frame
->handler
, context
, dispatcher
, *cookie
, scope_table
,
931 scope_table
->gs_cookie_offset
, scope_table
->gs_cookie_xor
,
932 scope_table
->eh_cookie_offset
, scope_table
->eh_cookie_xor
);
934 /* FIXME: no cookie validation yet */
936 if (rec
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
))
938 /* Unwinding the current frame */
939 msvcrt_local_unwind4( cookie
, frame
, -2, &frame
->_ebp
);
940 TRACE("unwound current frame, returning ExceptionContinueSearch\n");
941 return ExceptionContinueSearch
;
945 /* Hunting for handler */
946 exceptPtrs
.ExceptionRecord
= rec
;
947 exceptPtrs
.ContextRecord
= context
;
948 *((DWORD
*)frame
-1) = (DWORD
)&exceptPtrs
;
949 trylevel
= frame
->trylevel
;
951 while (trylevel
!= -2)
953 TRACE( "level %d prev %d filter %p\n", trylevel
,
954 scope_table
->entries
[trylevel
].previousTryLevel
,
955 scope_table
->entries
[trylevel
].lpfnFilter
);
956 if (scope_table
->entries
[trylevel
].lpfnFilter
)
958 retval
= call_filter( scope_table
->entries
[trylevel
].lpfnFilter
, &exceptPtrs
, &frame
->_ebp
);
960 TRACE("filter returned %s\n", retval
== EXCEPTION_CONTINUE_EXECUTION
?
961 "CONTINUE_EXECUTION" : retval
== EXCEPTION_EXECUTE_HANDLER
?
962 "EXECUTE_HANDLER" : "CONTINUE_SEARCH");
964 if (retval
== EXCEPTION_CONTINUE_EXECUTION
)
965 return ExceptionContinueExecution
;
967 if (retval
== EXCEPTION_EXECUTE_HANDLER
)
969 /* Unwind all higher frames, this one will handle the exception */
970 _global_unwind2((EXCEPTION_REGISTRATION_RECORD
*)frame
);
971 msvcrt_local_unwind4( cookie
, frame
, trylevel
, &frame
->_ebp
);
973 /* Set our trylevel to the enclosing block, and call the __finally
974 * code, which won't return
976 frame
->trylevel
= scope_table
->entries
[trylevel
].previousTryLevel
;
977 TRACE("__finally block %p\n",scope_table
->entries
[trylevel
].lpfnHandler
);
978 call_finally_block(scope_table
->entries
[trylevel
].lpfnHandler
, &frame
->_ebp
);
979 ERR("Returned from __finally block - expect crash!\n");
982 trylevel
= scope_table
->entries
[trylevel
].previousTryLevel
;
985 TRACE("reached -2, returning ExceptionContinueSearch\n");
986 return ExceptionContinueSearch
;
991 * setjmp/longjmp implementation
994 #define MSVCRT_JMP_MAGIC 0x56433230 /* ID value for new jump structure */
995 typedef void (__stdcall
*MSVCRT_unwind_function
)(const struct MSVCRT___JUMP_BUFFER
*);
997 /* define an entrypoint for setjmp/setjmp3 that stores the registers in the jmp buf */
998 /* and then jumps to the C backend function */
999 #define DEFINE_SETJMP_ENTRYPOINT(name) \
1000 __ASM_GLOBAL_FUNC( name, \
1001 "movl 4(%esp),%ecx\n\t" /* jmp_buf */ \
1002 "movl %ebp,0(%ecx)\n\t" /* jmp_buf.Ebp */ \
1003 "movl %ebx,4(%ecx)\n\t" /* jmp_buf.Ebx */ \
1004 "movl %edi,8(%ecx)\n\t" /* jmp_buf.Edi */ \
1005 "movl %esi,12(%ecx)\n\t" /* jmp_buf.Esi */ \
1006 "movl %esp,16(%ecx)\n\t" /* jmp_buf.Esp */ \
1007 "movl 0(%esp),%eax\n\t" \
1008 "movl %eax,20(%ecx)\n\t" /* jmp_buf.Eip */ \
1009 "jmp " __ASM_NAME("__regs_") # name )
1011 /* restore the registers from the jmp buf upon longjmp */
1012 extern void DECLSPEC_NORETURN
longjmp_set_regs( struct MSVCRT___JUMP_BUFFER
*jmp
, int retval
);
1013 __ASM_GLOBAL_FUNC( longjmp_set_regs
,
1014 "movl 4(%esp),%ecx\n\t" /* jmp_buf */
1015 "movl 8(%esp),%eax\n\t" /* retval */
1016 "movl 0(%ecx),%ebp\n\t" /* jmp_buf.Ebp */
1017 "movl 4(%ecx),%ebx\n\t" /* jmp_buf.Ebx */
1018 "movl 8(%ecx),%edi\n\t" /* jmp_buf.Edi */
1019 "movl 12(%ecx),%esi\n\t" /* jmp_buf.Esi */
1020 "movl 16(%ecx),%esp\n\t" /* jmp_buf.Esp */
1021 "addl $4,%esp\n\t" /* get rid of return address */
1022 "jmp *20(%ecx)\n\t" /* jmp_buf.Eip */ )
1025 * The signatures of the setjmp/longjmp functions do not match that
1026 * declared in the setjmp header so they don't follow the regular naming
1027 * convention to avoid conflicts.
1030 /*******************************************************************
1031 * _setjmp (MSVCRT.@)
1033 DEFINE_SETJMP_ENTRYPOINT(MSVCRT__setjmp
)
1034 int CDECL
__regs_MSVCRT__setjmp(struct MSVCRT___JUMP_BUFFER
*jmp
)
1036 jmp
->Registration
= (unsigned long)NtCurrentTeb()->Tib
.ExceptionList
;
1037 if (jmp
->Registration
== ~0UL)
1038 jmp
->TryLevel
= TRYLEVEL_END
;
1040 jmp
->TryLevel
= ((MSVCRT_EXCEPTION_FRAME
*)jmp
->Registration
)->trylevel
;
1042 TRACE("buf=%p ebx=%08lx esi=%08lx edi=%08lx ebp=%08lx esp=%08lx eip=%08lx frame=%08lx\n",
1043 jmp
, jmp
->Ebx
, jmp
->Esi
, jmp
->Edi
, jmp
->Ebp
, jmp
->Esp
, jmp
->Eip
, jmp
->Registration
);
1047 /*******************************************************************
1048 * _setjmp3 (MSVCRT.@)
1050 DEFINE_SETJMP_ENTRYPOINT( MSVCRT__setjmp3
)
1051 int CDECL
__regs_MSVCRT__setjmp3(struct MSVCRT___JUMP_BUFFER
*jmp
, int nb_args
, ...)
1053 jmp
->Cookie
= MSVCRT_JMP_MAGIC
;
1054 jmp
->UnwindFunc
= 0;
1055 jmp
->Registration
= (unsigned long)NtCurrentTeb()->Tib
.ExceptionList
;
1056 if (jmp
->Registration
== ~0UL)
1058 jmp
->TryLevel
= TRYLEVEL_END
;
1065 va_start( args
, nb_args
);
1066 if (nb_args
> 0) jmp
->UnwindFunc
= va_arg( args
, unsigned long );
1067 if (nb_args
> 1) jmp
->TryLevel
= va_arg( args
, unsigned long );
1068 else jmp
->TryLevel
= ((MSVCRT_EXCEPTION_FRAME
*)jmp
->Registration
)->trylevel
;
1069 for (i
= 0; i
< 6 && i
< nb_args
- 2; i
++)
1070 jmp
->UnwindData
[i
] = va_arg( args
, unsigned long );
1074 TRACE("buf=%p ebx=%08lx esi=%08lx edi=%08lx ebp=%08lx esp=%08lx eip=%08lx frame=%08lx\n",
1075 jmp
, jmp
->Ebx
, jmp
->Esi
, jmp
->Edi
, jmp
->Ebp
, jmp
->Esp
, jmp
->Eip
, jmp
->Registration
);
1079 /*********************************************************************
1080 * longjmp (MSVCRT.@)
1082 void CDECL
MSVCRT_longjmp(struct MSVCRT___JUMP_BUFFER
*jmp
, int retval
)
1084 unsigned long cur_frame
= 0;
1086 TRACE("buf=%p ebx=%08lx esi=%08lx edi=%08lx ebp=%08lx esp=%08lx eip=%08lx frame=%08lx retval=%08x\n",
1087 jmp
, jmp
->Ebx
, jmp
->Esi
, jmp
->Edi
, jmp
->Ebp
, jmp
->Esp
, jmp
->Eip
, jmp
->Registration
, retval
);
1089 cur_frame
=(unsigned long)NtCurrentTeb()->Tib
.ExceptionList
;
1090 TRACE("cur_frame=%lx\n",cur_frame
);
1092 if (cur_frame
!= jmp
->Registration
)
1093 _global_unwind2((EXCEPTION_REGISTRATION_RECORD
*)jmp
->Registration
);
1095 if (jmp
->Registration
)
1097 if (IsBadReadPtr(&jmp
->Cookie
, sizeof(long)) || jmp
->Cookie
!= MSVCRT_JMP_MAGIC
)
1099 msvcrt_local_unwind2((MSVCRT_EXCEPTION_FRAME
*)jmp
->Registration
,
1100 jmp
->TryLevel
, (void *)jmp
->Ebp
);
1102 else if(jmp
->UnwindFunc
)
1104 MSVCRT_unwind_function unwind_func
;
1106 unwind_func
=(MSVCRT_unwind_function
)jmp
->UnwindFunc
;
1114 longjmp_set_regs( jmp
, retval
);
1117 /*********************************************************************
1118 * _seh_longjmp_unwind (MSVCRT.@)
1120 void __stdcall
_seh_longjmp_unwind(struct MSVCRT___JUMP_BUFFER
*jmp
)
1122 msvcrt_local_unwind2( (MSVCRT_EXCEPTION_FRAME
*)jmp
->Registration
, jmp
->TryLevel
, (void *)jmp
->Ebp
);
1125 /*********************************************************************
1126 * _seh_longjmp_unwind4 (MSVCRT.@)
1128 void __stdcall
_seh_longjmp_unwind4(struct MSVCRT___JUMP_BUFFER
*jmp
)
1130 msvcrt_local_unwind4( (ULONG
*)&jmp
->Cookie
, (MSVCRT_EXCEPTION_FRAME
*)jmp
->Registration
,
1131 jmp
->TryLevel
, (void *)jmp
->Ebp
);
1134 #endif /* __i386__ */