wined3d: No longer make sub-resources full resources.
[wine.git] / dlls / msvcrt / except_i386.c
blobf7f486d566cc95635e400d39a87950c60ad3a8c0
1 /*
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
22 * NOTES
23 * A good reference is the article "How a C++ compiler implements
24 * exception handling" by Vishal Kochhar, available on
25 * www.thecodeproject.com.
28 #include "config.h"
29 #include "wine/port.h"
31 #ifdef __i386__
33 #include <stdarg.h>
35 #include "windef.h"
36 #include "winbase.h"
37 #include "winternl.h"
38 #include "msvcrt.h"
39 #include "wine/exception.h"
40 #include "excpt.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 */
52 int trylevel;
53 DWORD ebp;
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 */
63 } catchblock_info;
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 */
76 } tryblock_info;
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 */
83 } unwind_info;
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 */
93 UINT ipmap_count;
94 const void *ipmap;
95 const void *expect_list; /* expected exceptions list when magic >= VC7 */
96 UINT flags; /* flags when magic >= VC8 */
97 } cxx_function_descr;
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;
114 int trylevel;
115 int _ebp;
116 PEXCEPTION_POINTERS xpointers;
117 } MSVCRT_EXCEPTION_FRAME;
119 typedef struct
121 int gs_cookie_offset;
122 ULONG gs_cookie_xor;
123 int eh_cookie_offset;
124 ULONG eh_cookie_xor;
125 SCOPETABLE entries[1];
126 } SCOPETABLE_V4;
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 )
138 void *ret;
139 int dummy;
140 __asm__ __volatile__ ("pushl %%ebx\n\t"
141 "pushl %%ebp\n\t"
142 "movl %4,%%ebp\n\t"
143 "call *%%eax\n\t"
144 "popl %%ebp\n\t"
145 "popl %%ebx"
146 : "=a" (ret), "=S" (dummy), "=D" (dummy)
147 : "0" (func), "1" (ebp) : "ecx", "edx", "memory" );
148 return ret;
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 );
155 if (has_vbase)
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" );
159 else
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 )
186 int ret;
187 __asm__ __volatile__ ("pushl %%ebp; pushl %3; movl %2,%%ebp; call *%%eax; popl %%ebp; popl %%ebp"
188 : "=a" (ret)
189 : "0" (func), "r" (ebp), "r" (arg)
190 : "ecx", "edx", "memory" );
191 return ret;
194 static inline int call_unwind_func( int (*func)(void), void *ebp )
196 int ret;
197 __asm__ __volatile__ ("pushl %%ebp\n\t"
198 "pushl %%ebx\n\t"
199 "pushl %%esi\n\t"
200 "pushl %%edi\n\t"
201 "movl %2,%%ebp\n\t"
202 "call *%0\n\t"
203 "popl %%edi\n\t"
204 "popl %%esi\n\t"
205 "popl %%ebx\n\t"
206 "popl %%ebp"
207 : "=a" (ret)
208 : "0" (func), "r" (ebp)
209 : "ecx", "edx", "memory" );
210 return ret;
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 )
223 UINT i;
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++)
229 TRACE( " %d: ", i );
230 dump_type( type->type_info_table->info[i] );
234 static void dump_function_descr( const cxx_function_descr *descr )
236 UINT i;
237 int j;
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 )
271 UINT i;
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 */
289 return NULL;
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 )
297 void **dest_ptr;
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 */
315 if (type->copy_ctor)
316 call_copy_ctor( type->copy_ctor, dest_ptr, get_this_pointer(&type->offsets,object),
317 (type->flags & CLASS_HAS_VIRTUAL_BASE_CLASS) );
318 else
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 );
334 MSVCRT_terminate();
336 handler = descr->unwind_table[trylevel].handler;
337 if (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 cxx_exception_frame *cxx_frame; /* frame of parent exception */
353 const cxx_function_descr *descr; /* descriptor of parent exception */
354 int trylevel; /* current try level */
355 cxx_frame_info frame_info;
358 /* handler for exceptions happening while calling a catch function */
359 static DWORD catch_function_nested_handler( EXCEPTION_RECORD *rec, EXCEPTION_REGISTRATION_RECORD *frame,
360 CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
362 struct catch_func_nested_frame *nested_frame = (struct catch_func_nested_frame *)frame;
364 if (rec->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND))
366 __CxxUnregisterExceptionObject(&nested_frame->frame_info, FALSE);
367 return ExceptionContinueSearch;
370 TRACE( "got nested exception in catch function\n" );
372 if(rec->ExceptionCode == CXX_EXCEPTION)
374 PEXCEPTION_RECORD prev_rec = msvcrt_get_thread_data()->exc_record;
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 */
382 *rec = *prev_rec;
383 rec->ExceptionFlags &= ~EH_UNWINDING;
384 if(TRACE_ON(seh)) {
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
393 TRACE("detect threw new exception in catch block\n");
397 return cxx_frame_handler( rec, nested_frame->cxx_frame, context,
398 NULL, nested_frame->descr, &nested_frame->frame,
399 nested_frame->trylevel );
402 /* find and call the appropriate catch block for an exception */
403 /* returns the address to continue execution to after the catch block was called */
404 static inline void call_catch_block( PEXCEPTION_RECORD rec, cxx_exception_frame *frame,
405 const cxx_function_descr *descr, int nested_trylevel,
406 EXCEPTION_REGISTRATION_RECORD *catch_frame,
407 cxx_exception_type *info )
409 UINT i;
410 int j;
411 void *addr, *object = (void *)rec->ExceptionInformation[1];
412 struct catch_func_nested_frame nested_frame;
413 int trylevel = frame->trylevel;
414 DWORD save_esp = ((DWORD*)frame)[-1];
415 thread_data_t *data;
417 for (i = 0; i < descr->tryblock_count; i++)
419 const tryblock_info *tryblock = &descr->tryblock[i];
421 /* only handle try blocks inside current catch block */
422 if (catch_frame && nested_trylevel > tryblock->start_level) continue;
424 if (trylevel < tryblock->start_level) continue;
425 if (trylevel > tryblock->end_level) continue;
427 /* got a try block */
428 for (j = 0; j < tryblock->catchblock_count; j++)
430 const catchblock_info *catchblock = &tryblock->catchblock[j];
431 if(info)
433 const cxx_type_info *type = find_caught_type( info,
434 catchblock->type_info, catchblock->flags );
435 if (!type) continue;
437 TRACE( "matched type %p in tryblock %d catchblock %d\n", type, i, j );
439 /* copy the exception to its destination on the stack */
440 copy_exception( object, frame, catchblock, type );
442 else
444 /* no CXX_EXCEPTION only proceed with a catch(...) block*/
445 if(catchblock->type_info)
446 continue;
447 TRACE("found catch(...) block\n");
450 /* Add frame info here so exception is not freed inside RtlUnwind call */
451 _CreateFrameInfo(&nested_frame.frame_info.frame_info,
452 (void*)rec->ExceptionInformation[1]);
454 /* unwind the stack */
455 RtlUnwind( catch_frame ? catch_frame : &frame->frame, 0, rec, 0 );
456 cxx_local_unwind( frame, descr, tryblock->start_level );
457 frame->trylevel = tryblock->end_level + 1;
459 data = msvcrt_get_thread_data();
460 nested_frame.frame_info.rec = data->exc_record;
461 data->exc_record = rec;
463 /* call the catch block */
464 TRACE( "calling catch block %p addr %p ebp %p\n",
465 catchblock, catchblock->handler, &frame->ebp );
467 /* setup an exception block for nested exceptions */
468 nested_frame.frame.Handler = catch_function_nested_handler;
469 nested_frame.cxx_frame = frame;
470 nested_frame.descr = descr;
471 nested_frame.trylevel = nested_trylevel + 1;
473 __wine_push_frame( &nested_frame.frame );
474 addr = call_ebp_func( catchblock->handler, &frame->ebp );
475 __wine_pop_frame( &nested_frame.frame );
477 ((DWORD*)frame)[-1] = save_esp;
478 __CxxUnregisterExceptionObject(&nested_frame.frame_info, FALSE);
479 TRACE( "done, continuing at %p\n", addr );
481 continue_after_catch( frame, addr );
486 /*********************************************************************
487 * __CxxExceptionFilter (MSVCRT.@)
489 int CDECL __CxxExceptionFilter( PEXCEPTION_POINTERS ptrs,
490 const type_info *ti, int flags, void **copy)
492 const cxx_type_info *type;
493 PEXCEPTION_RECORD rec;
495 TRACE( "%p %p %x %p\n", ptrs, ti, flags, copy );
497 if (!ptrs) return EXCEPTION_CONTINUE_SEARCH;
499 /* handle catch(...) */
500 if (!ti) return EXCEPTION_EXECUTE_HANDLER;
502 rec = ptrs->ExceptionRecord;
503 if (rec->ExceptionCode != CXX_EXCEPTION || rec->NumberParameters != 3 ||
504 rec->ExceptionInformation[0] < CXX_FRAME_MAGIC_VC6 ||
505 rec->ExceptionInformation[0] > CXX_FRAME_MAGIC_VC8)
506 return EXCEPTION_CONTINUE_SEARCH;
508 if (rec->ExceptionInformation[1] == 0 && rec->ExceptionInformation[2] == 0)
510 rec = msvcrt_get_thread_data()->exc_record;
511 if (!rec) return EXCEPTION_CONTINUE_SEARCH;
514 type = find_caught_type( (cxx_exception_type*)rec->ExceptionInformation[2], ti, flags );
515 if (!type) return EXCEPTION_CONTINUE_SEARCH;
517 if (copy)
519 void *object = (void *)rec->ExceptionInformation[1];
521 if (flags & TYPE_FLAG_REFERENCE)
523 *copy = get_this_pointer( &type->offsets, object );
525 else if (type->flags & CLASS_IS_SIMPLE_TYPE)
527 memmove( copy, object, type->size );
528 /* if it is a pointer, adjust it */
529 if (type->size == sizeof(void*)) *copy = get_this_pointer( &type->offsets, *copy );
531 else /* copy the object */
533 if (type->copy_ctor)
534 call_copy_ctor( type->copy_ctor, copy, get_this_pointer(&type->offsets,object),
535 (type->flags & CLASS_HAS_VIRTUAL_BASE_CLASS) );
536 else
537 memmove( copy, get_this_pointer(&type->offsets,object), type->size );
540 return EXCEPTION_EXECUTE_HANDLER;
543 /*********************************************************************
544 * cxx_frame_handler
546 * Implementation of __CxxFrameHandler.
548 DWORD CDECL cxx_frame_handler( PEXCEPTION_RECORD rec, cxx_exception_frame* frame,
549 PCONTEXT context, EXCEPTION_REGISTRATION_RECORD** dispatch,
550 const cxx_function_descr *descr,
551 EXCEPTION_REGISTRATION_RECORD* nested_frame,
552 int nested_trylevel )
554 cxx_exception_type *exc_type;
556 if (descr->magic < CXX_FRAME_MAGIC_VC6 || descr->magic > CXX_FRAME_MAGIC_VC8)
558 ERR( "invalid frame magic %x\n", descr->magic );
559 return ExceptionContinueSearch;
561 if (descr->magic >= CXX_FRAME_MAGIC_VC8 &&
562 (descr->flags & FUNC_DESCR_SYNCHRONOUS) &&
563 (rec->ExceptionCode != CXX_EXCEPTION))
564 return ExceptionContinueSearch; /* handle only c++ exceptions */
566 if (rec->ExceptionFlags & (EH_UNWINDING|EH_EXIT_UNWIND))
568 if (descr->unwind_count && !nested_trylevel) cxx_local_unwind( frame, descr, -1 );
569 return ExceptionContinueSearch;
571 if (!descr->tryblock_count) return ExceptionContinueSearch;
573 if(rec->ExceptionCode == CXX_EXCEPTION &&
574 rec->ExceptionInformation[1] == 0 && rec->ExceptionInformation[2] == 0)
576 *rec = *msvcrt_get_thread_data()->exc_record;
577 rec->ExceptionFlags &= ~EH_UNWINDING;
578 if(TRACE_ON(seh)) {
579 TRACE("detect rethrow: exception code: %x\n", rec->ExceptionCode);
580 if(rec->ExceptionCode == CXX_EXCEPTION)
581 TRACE("re-propage: obj: %lx, type: %lx\n",
582 rec->ExceptionInformation[1], rec->ExceptionInformation[2]);
586 if(rec->ExceptionCode == CXX_EXCEPTION)
588 exc_type = (cxx_exception_type *)rec->ExceptionInformation[2];
590 if (rec->ExceptionInformation[0] > CXX_FRAME_MAGIC_VC8 &&
591 exc_type->custom_handler)
593 return exc_type->custom_handler( rec, frame, context, dispatch,
594 descr, nested_trylevel, nested_frame, 0 );
597 if (TRACE_ON(seh))
599 TRACE("handling C++ exception rec %p frame %p trylevel %d descr %p nested_frame %p\n",
600 rec, frame, frame->trylevel, descr, nested_frame );
601 dump_exception_type( exc_type );
602 dump_function_descr( descr );
605 else
607 thread_data_t *data = msvcrt_get_thread_data();
609 exc_type = NULL;
610 TRACE("handling C exception code %x rec %p frame %p trylevel %d descr %p nested_frame %p\n",
611 rec->ExceptionCode, rec, frame, frame->trylevel, descr, nested_frame );
613 if (data->se_translator) {
614 EXCEPTION_POINTERS except_ptrs;
616 except_ptrs.ExceptionRecord = rec;
617 except_ptrs.ContextRecord = context;
618 data->se_translator(rec->ExceptionCode, &except_ptrs);
622 call_catch_block( rec, frame, descr, frame->trylevel, nested_frame, exc_type );
623 return ExceptionContinueSearch;
627 /*********************************************************************
628 * __CxxFrameHandler (MSVCRT.@)
630 extern DWORD CDECL __CxxFrameHandler( PEXCEPTION_RECORD rec, EXCEPTION_REGISTRATION_RECORD* frame,
631 PCONTEXT context, EXCEPTION_REGISTRATION_RECORD** dispatch );
632 __ASM_GLOBAL_FUNC( __CxxFrameHandler,
633 "pushl $0\n\t" /* nested_trylevel */
634 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
635 "pushl $0\n\t" /* nested_frame */
636 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
637 "pushl %eax\n\t" /* descr */
638 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
639 "pushl 28(%esp)\n\t" /* dispatch */
640 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
641 "pushl 28(%esp)\n\t" /* context */
642 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
643 "pushl 28(%esp)\n\t" /* frame */
644 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
645 "pushl 28(%esp)\n\t" /* rec */
646 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
647 "call " __ASM_NAME("cxx_frame_handler") "\n\t"
648 "add $28,%esp\n\t"
649 __ASM_CFI(".cfi_adjust_cfa_offset -28\n\t")
650 "ret" )
653 /*********************************************************************
654 * __CxxLongjmpUnwind (MSVCRT.@)
656 * Callback meant to be used as UnwindFunc for setjmp/longjmp.
658 void __stdcall __CxxLongjmpUnwind( const struct MSVCRT___JUMP_BUFFER *buf )
660 cxx_exception_frame *frame = (cxx_exception_frame *)buf->Registration;
661 const cxx_function_descr *descr = (const cxx_function_descr *)buf->UnwindData[0];
663 TRACE( "unwinding frame %p descr %p trylevel %ld\n", frame, descr, buf->TryLevel );
664 cxx_local_unwind( frame, descr, buf->TryLevel );
667 /*********************************************************************
668 * __CppXcptFilter (MSVCRT.@)
670 int CDECL __CppXcptFilter(NTSTATUS ex, PEXCEPTION_POINTERS ptr)
672 /* only filter c++ exceptions */
673 if (ex != CXX_EXCEPTION) return EXCEPTION_CONTINUE_SEARCH;
674 return _XcptFilter( ex, ptr );
677 /*********************************************************************
678 * __CxxDetectRethrow (MSVCRT.@)
680 BOOL CDECL __CxxDetectRethrow(PEXCEPTION_POINTERS ptrs)
682 PEXCEPTION_RECORD rec;
684 if (!ptrs)
685 return FALSE;
687 rec = ptrs->ExceptionRecord;
689 if (rec->ExceptionCode == CXX_EXCEPTION &&
690 rec->NumberParameters == 3 &&
691 rec->ExceptionInformation[0] == CXX_FRAME_MAGIC_VC6 &&
692 rec->ExceptionInformation[2])
694 ptrs->ExceptionRecord = msvcrt_get_thread_data()->exc_record;
695 return TRUE;
697 return (msvcrt_get_thread_data()->exc_record == rec);
700 /*********************************************************************
701 * __CxxQueryExceptionSize (MSVCRT.@)
703 unsigned int CDECL __CxxQueryExceptionSize(void)
705 return sizeof(cxx_exception_type);
709 /*********************************************************************
710 * _EH_prolog (MSVCRT.@)
713 /* Provided for VC++ binary compatibility only */
714 __ASM_GLOBAL_FUNC(_EH_prolog,
715 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t") /* skip ret addr */
716 "pushl $-1\n\t"
717 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
718 "pushl %eax\n\t"
719 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
720 "pushl %fs:0\n\t"
721 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
722 "movl %esp, %fs:0\n\t"
723 "movl 12(%esp), %eax\n\t"
724 "movl %ebp, 12(%esp)\n\t"
725 "leal 12(%esp), %ebp\n\t"
726 "pushl %eax\n\t"
727 __ASM_CFI(".cfi_adjust_cfa_offset 4\n\t")
728 "ret")
730 static const SCOPETABLE_V4 *get_scopetable_v4( MSVCRT_EXCEPTION_FRAME *frame, ULONG_PTR cookie )
732 return (const SCOPETABLE_V4 *)((ULONG_PTR)frame->scopetable ^ cookie);
735 static DWORD MSVCRT_nested_handler(PEXCEPTION_RECORD rec,
736 EXCEPTION_REGISTRATION_RECORD* frame,
737 PCONTEXT context,
738 EXCEPTION_REGISTRATION_RECORD** dispatch)
740 if (!(rec->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND)))
741 return ExceptionContinueSearch;
742 *dispatch = frame;
743 return ExceptionCollidedUnwind;
746 static void msvcrt_local_unwind2(MSVCRT_EXCEPTION_FRAME* frame, int trylevel, void *ebp)
748 EXCEPTION_REGISTRATION_RECORD reg;
750 TRACE("(%p,%d,%d)\n",frame, frame->trylevel, trylevel);
752 /* Register a handler in case of a nested exception */
753 reg.Handler = MSVCRT_nested_handler;
754 reg.Prev = NtCurrentTeb()->Tib.ExceptionList;
755 __wine_push_frame(&reg);
757 while (frame->trylevel != TRYLEVEL_END && frame->trylevel != trylevel)
759 int level = frame->trylevel;
760 frame->trylevel = frame->scopetable[level].previousTryLevel;
761 if (!frame->scopetable[level].lpfnFilter)
763 TRACE( "__try block cleanup level %d handler %p ebp %p\n",
764 level, frame->scopetable[level].lpfnHandler, ebp );
765 call_unwind_func( frame->scopetable[level].lpfnHandler, ebp );
768 __wine_pop_frame(&reg);
769 TRACE("unwound OK\n");
772 static void msvcrt_local_unwind4( ULONG *cookie, MSVCRT_EXCEPTION_FRAME* frame, int trylevel, void *ebp )
774 EXCEPTION_REGISTRATION_RECORD reg;
775 const SCOPETABLE_V4 *scopetable = get_scopetable_v4( frame, *cookie );
777 TRACE("(%p,%d,%d)\n",frame, frame->trylevel, trylevel);
779 /* Register a handler in case of a nested exception */
780 reg.Handler = MSVCRT_nested_handler;
781 reg.Prev = NtCurrentTeb()->Tib.ExceptionList;
782 __wine_push_frame(&reg);
784 while (frame->trylevel != -2 && frame->trylevel != trylevel)
786 int level = frame->trylevel;
787 frame->trylevel = scopetable->entries[level].previousTryLevel;
788 if (!scopetable->entries[level].lpfnFilter)
790 TRACE( "__try block cleanup level %d handler %p ebp %p\n",
791 level, scopetable->entries[level].lpfnHandler, ebp );
792 call_unwind_func( scopetable->entries[level].lpfnHandler, ebp );
795 __wine_pop_frame(&reg);
796 TRACE("unwound OK\n");
799 /*******************************************************************
800 * _local_unwind2 (MSVCRT.@)
802 void CDECL _local_unwind2(MSVCRT_EXCEPTION_FRAME* frame, int trylevel)
804 msvcrt_local_unwind2( frame, trylevel, &frame->_ebp );
807 /*******************************************************************
808 * _local_unwind4 (MSVCRT.@)
810 void CDECL _local_unwind4( ULONG *cookie, MSVCRT_EXCEPTION_FRAME* frame, int trylevel )
812 msvcrt_local_unwind4( cookie, frame, trylevel, &frame->_ebp );
815 /*******************************************************************
816 * _global_unwind2 (MSVCRT.@)
818 void CDECL _global_unwind2(EXCEPTION_REGISTRATION_RECORD* frame)
820 TRACE("(%p)\n",frame);
821 RtlUnwind( frame, 0, 0, 0 );
824 /*********************************************************************
825 * _except_handler2 (MSVCRT.@)
827 int CDECL _except_handler2(PEXCEPTION_RECORD rec,
828 EXCEPTION_REGISTRATION_RECORD* frame,
829 PCONTEXT context,
830 EXCEPTION_REGISTRATION_RECORD** dispatcher)
832 FIXME("exception %x flags=%x at %p handler=%p %p %p stub\n",
833 rec->ExceptionCode, rec->ExceptionFlags, rec->ExceptionAddress,
834 frame->Handler, context, dispatcher);
835 return ExceptionContinueSearch;
838 /*********************************************************************
839 * _except_handler3 (MSVCRT.@)
841 int CDECL _except_handler3(PEXCEPTION_RECORD rec,
842 MSVCRT_EXCEPTION_FRAME* frame,
843 PCONTEXT context, void* dispatcher)
845 int retval, trylevel;
846 EXCEPTION_POINTERS exceptPtrs;
847 PSCOPETABLE pScopeTable;
849 TRACE("exception %x flags=%x at %p handler=%p %p %p semi-stub\n",
850 rec->ExceptionCode, rec->ExceptionFlags, rec->ExceptionAddress,
851 frame->handler, context, dispatcher);
853 __asm__ __volatile__ ("cld");
855 if (rec->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND))
857 /* Unwinding the current frame */
858 msvcrt_local_unwind2(frame, TRYLEVEL_END, &frame->_ebp);
859 TRACE("unwound current frame, returning ExceptionContinueSearch\n");
860 return ExceptionContinueSearch;
862 else
864 /* Hunting for handler */
865 exceptPtrs.ExceptionRecord = rec;
866 exceptPtrs.ContextRecord = context;
867 *((DWORD *)frame-1) = (DWORD)&exceptPtrs;
868 trylevel = frame->trylevel;
869 pScopeTable = frame->scopetable;
871 while (trylevel != TRYLEVEL_END)
873 TRACE( "level %d prev %d filter %p\n", trylevel, pScopeTable[trylevel].previousTryLevel,
874 pScopeTable[trylevel].lpfnFilter );
875 if (pScopeTable[trylevel].lpfnFilter)
877 retval = call_filter( pScopeTable[trylevel].lpfnFilter, &exceptPtrs, &frame->_ebp );
879 TRACE("filter returned %s\n", retval == EXCEPTION_CONTINUE_EXECUTION ?
880 "CONTINUE_EXECUTION" : retval == EXCEPTION_EXECUTE_HANDLER ?
881 "EXECUTE_HANDLER" : "CONTINUE_SEARCH");
883 if (retval == EXCEPTION_CONTINUE_EXECUTION)
884 return ExceptionContinueExecution;
886 if (retval == EXCEPTION_EXECUTE_HANDLER)
888 /* Unwind all higher frames, this one will handle the exception */
889 _global_unwind2((EXCEPTION_REGISTRATION_RECORD*)frame);
890 msvcrt_local_unwind2(frame, trylevel, &frame->_ebp);
892 /* Set our trylevel to the enclosing block, and call the __finally
893 * code, which won't return
895 frame->trylevel = pScopeTable[trylevel].previousTryLevel;
896 TRACE("__finally block %p\n",pScopeTable[trylevel].lpfnHandler);
897 call_finally_block(pScopeTable[trylevel].lpfnHandler, &frame->_ebp);
898 ERR("Returned from __finally block - expect crash!\n");
901 trylevel = pScopeTable[trylevel].previousTryLevel;
904 TRACE("reached TRYLEVEL_END, returning ExceptionContinueSearch\n");
905 return ExceptionContinueSearch;
908 /*********************************************************************
909 * _except_handler4_common (MSVCRT.@)
911 int CDECL _except_handler4_common( ULONG *cookie, void (*check_cookie)(void),
912 EXCEPTION_RECORD *rec, MSVCRT_EXCEPTION_FRAME *frame,
913 CONTEXT *context, EXCEPTION_REGISTRATION_RECORD **dispatcher )
915 int retval, trylevel;
916 EXCEPTION_POINTERS exceptPtrs;
917 const SCOPETABLE_V4 *scope_table = get_scopetable_v4( frame, *cookie );
919 TRACE( "exception %x flags=%x at %p handler=%p %p %p cookie=%x scope table=%p cookies=%d/%x,%d/%x\n",
920 rec->ExceptionCode, rec->ExceptionFlags, rec->ExceptionAddress,
921 frame->handler, context, dispatcher, *cookie, scope_table,
922 scope_table->gs_cookie_offset, scope_table->gs_cookie_xor,
923 scope_table->eh_cookie_offset, scope_table->eh_cookie_xor );
925 /* FIXME: no cookie validation yet */
927 if (rec->ExceptionFlags & (EH_UNWINDING | EH_EXIT_UNWIND))
929 /* Unwinding the current frame */
930 msvcrt_local_unwind4( cookie, frame, -2, &frame->_ebp );
931 TRACE("unwound current frame, returning ExceptionContinueSearch\n");
932 return ExceptionContinueSearch;
934 else
936 /* Hunting for handler */
937 exceptPtrs.ExceptionRecord = rec;
938 exceptPtrs.ContextRecord = context;
939 *((DWORD *)frame-1) = (DWORD)&exceptPtrs;
940 trylevel = frame->trylevel;
942 while (trylevel != -2)
944 TRACE( "level %d prev %d filter %p\n", trylevel,
945 scope_table->entries[trylevel].previousTryLevel,
946 scope_table->entries[trylevel].lpfnFilter );
947 if (scope_table->entries[trylevel].lpfnFilter)
949 retval = call_filter( scope_table->entries[trylevel].lpfnFilter, &exceptPtrs, &frame->_ebp );
951 TRACE("filter returned %s\n", retval == EXCEPTION_CONTINUE_EXECUTION ?
952 "CONTINUE_EXECUTION" : retval == EXCEPTION_EXECUTE_HANDLER ?
953 "EXECUTE_HANDLER" : "CONTINUE_SEARCH");
955 if (retval == EXCEPTION_CONTINUE_EXECUTION)
956 return ExceptionContinueExecution;
958 if (retval == EXCEPTION_EXECUTE_HANDLER)
960 __DestructExceptionObject(rec);
962 /* Unwind all higher frames, this one will handle the exception */
963 _global_unwind2((EXCEPTION_REGISTRATION_RECORD*)frame);
964 msvcrt_local_unwind4( cookie, frame, trylevel, &frame->_ebp );
966 /* Set our trylevel to the enclosing block, and call the __finally
967 * code, which won't return
969 frame->trylevel = scope_table->entries[trylevel].previousTryLevel;
970 TRACE("__finally block %p\n",scope_table->entries[trylevel].lpfnHandler);
971 call_finally_block(scope_table->entries[trylevel].lpfnHandler, &frame->_ebp);
972 ERR("Returned from __finally block - expect crash!\n");
975 trylevel = scope_table->entries[trylevel].previousTryLevel;
978 TRACE("reached -2, returning ExceptionContinueSearch\n");
979 return ExceptionContinueSearch;
984 * setjmp/longjmp implementation
987 #define MSVCRT_JMP_MAGIC 0x56433230 /* ID value for new jump structure */
988 typedef void (__stdcall *MSVCRT_unwind_function)(const struct MSVCRT___JUMP_BUFFER *);
990 /* define an entrypoint for setjmp/setjmp3 that stores the registers in the jmp buf */
991 /* and then jumps to the C backend function */
992 #define DEFINE_SETJMP_ENTRYPOINT(name) \
993 __ASM_GLOBAL_FUNC( name, \
994 "movl 4(%esp),%ecx\n\t" /* jmp_buf */ \
995 "movl %ebp,0(%ecx)\n\t" /* jmp_buf.Ebp */ \
996 "movl %ebx,4(%ecx)\n\t" /* jmp_buf.Ebx */ \
997 "movl %edi,8(%ecx)\n\t" /* jmp_buf.Edi */ \
998 "movl %esi,12(%ecx)\n\t" /* jmp_buf.Esi */ \
999 "movl %esp,16(%ecx)\n\t" /* jmp_buf.Esp */ \
1000 "movl 0(%esp),%eax\n\t" \
1001 "movl %eax,20(%ecx)\n\t" /* jmp_buf.Eip */ \
1002 "jmp " __ASM_NAME("__regs_") # name )
1004 /* restore the registers from the jmp buf upon longjmp */
1005 extern void DECLSPEC_NORETURN longjmp_set_regs( struct MSVCRT___JUMP_BUFFER *jmp, int retval );
1006 __ASM_GLOBAL_FUNC( longjmp_set_regs,
1007 "movl 4(%esp),%ecx\n\t" /* jmp_buf */
1008 "movl 8(%esp),%eax\n\t" /* retval */
1009 "movl 0(%ecx),%ebp\n\t" /* jmp_buf.Ebp */
1010 "movl 4(%ecx),%ebx\n\t" /* jmp_buf.Ebx */
1011 "movl 8(%ecx),%edi\n\t" /* jmp_buf.Edi */
1012 "movl 12(%ecx),%esi\n\t" /* jmp_buf.Esi */
1013 "movl 16(%ecx),%esp\n\t" /* jmp_buf.Esp */
1014 "addl $4,%esp\n\t" /* get rid of return address */
1015 "jmp *20(%ecx)\n\t" /* jmp_buf.Eip */ )
1018 * The signatures of the setjmp/longjmp functions do not match that
1019 * declared in the setjmp header so they don't follow the regular naming
1020 * convention to avoid conflicts.
1023 /*******************************************************************
1024 * _setjmp (MSVCRT.@)
1026 DEFINE_SETJMP_ENTRYPOINT(MSVCRT__setjmp)
1027 int CDECL __regs_MSVCRT__setjmp(struct MSVCRT___JUMP_BUFFER *jmp)
1029 jmp->Registration = (unsigned long)NtCurrentTeb()->Tib.ExceptionList;
1030 if (jmp->Registration == ~0UL)
1031 jmp->TryLevel = TRYLEVEL_END;
1032 else
1033 jmp->TryLevel = ((MSVCRT_EXCEPTION_FRAME*)jmp->Registration)->trylevel;
1035 TRACE("buf=%p ebx=%08lx esi=%08lx edi=%08lx ebp=%08lx esp=%08lx eip=%08lx frame=%08lx\n",
1036 jmp, jmp->Ebx, jmp->Esi, jmp->Edi, jmp->Ebp, jmp->Esp, jmp->Eip, jmp->Registration );
1037 return 0;
1040 /*******************************************************************
1041 * _setjmp3 (MSVCRT.@)
1043 DEFINE_SETJMP_ENTRYPOINT( MSVCRT__setjmp3 )
1044 int CDECL __regs_MSVCRT__setjmp3(struct MSVCRT___JUMP_BUFFER *jmp, int nb_args, ...)
1046 jmp->Cookie = MSVCRT_JMP_MAGIC;
1047 jmp->UnwindFunc = 0;
1048 jmp->Registration = (unsigned long)NtCurrentTeb()->Tib.ExceptionList;
1049 if (jmp->Registration == ~0UL)
1051 jmp->TryLevel = TRYLEVEL_END;
1053 else
1055 int i;
1056 va_list args;
1058 va_start( args, nb_args );
1059 if (nb_args > 0) jmp->UnwindFunc = va_arg( args, unsigned long );
1060 if (nb_args > 1) jmp->TryLevel = va_arg( args, unsigned long );
1061 else jmp->TryLevel = ((MSVCRT_EXCEPTION_FRAME*)jmp->Registration)->trylevel;
1062 for (i = 0; i < 6 && i < nb_args - 2; i++)
1063 jmp->UnwindData[i] = va_arg( args, unsigned long );
1064 va_end( args );
1067 TRACE("buf=%p ebx=%08lx esi=%08lx edi=%08lx ebp=%08lx esp=%08lx eip=%08lx frame=%08lx\n",
1068 jmp, jmp->Ebx, jmp->Esi, jmp->Edi, jmp->Ebp, jmp->Esp, jmp->Eip, jmp->Registration );
1069 return 0;
1072 /*********************************************************************
1073 * longjmp (MSVCRT.@)
1075 void CDECL MSVCRT_longjmp(struct MSVCRT___JUMP_BUFFER *jmp, int retval)
1077 unsigned long cur_frame = 0;
1079 TRACE("buf=%p ebx=%08lx esi=%08lx edi=%08lx ebp=%08lx esp=%08lx eip=%08lx frame=%08lx retval=%08x\n",
1080 jmp, jmp->Ebx, jmp->Esi, jmp->Edi, jmp->Ebp, jmp->Esp, jmp->Eip, jmp->Registration, retval );
1082 cur_frame=(unsigned long)NtCurrentTeb()->Tib.ExceptionList;
1083 TRACE("cur_frame=%lx\n",cur_frame);
1085 if (cur_frame != jmp->Registration)
1086 _global_unwind2((EXCEPTION_REGISTRATION_RECORD*)jmp->Registration);
1088 if (jmp->Registration)
1090 if (IsBadReadPtr(&jmp->Cookie, sizeof(long)) || jmp->Cookie != MSVCRT_JMP_MAGIC)
1092 msvcrt_local_unwind2((MSVCRT_EXCEPTION_FRAME*)jmp->Registration,
1093 jmp->TryLevel, (void *)jmp->Ebp);
1095 else if(jmp->UnwindFunc)
1097 MSVCRT_unwind_function unwind_func;
1099 unwind_func=(MSVCRT_unwind_function)jmp->UnwindFunc;
1100 unwind_func(jmp);
1104 if (!retval)
1105 retval = 1;
1107 longjmp_set_regs( jmp, retval );
1110 /*********************************************************************
1111 * _seh_longjmp_unwind (MSVCRT.@)
1113 void __stdcall _seh_longjmp_unwind(struct MSVCRT___JUMP_BUFFER *jmp)
1115 msvcrt_local_unwind2( (MSVCRT_EXCEPTION_FRAME *)jmp->Registration, jmp->TryLevel, (void *)jmp->Ebp );
1118 /*********************************************************************
1119 * _seh_longjmp_unwind4 (MSVCRT.@)
1121 void __stdcall _seh_longjmp_unwind4(struct MSVCRT___JUMP_BUFFER *jmp)
1123 msvcrt_local_unwind4( (ULONG *)&jmp->Cookie, (MSVCRT_EXCEPTION_FRAME *)jmp->Registration,
1124 jmp->TryLevel, (void *)jmp->Ebp );
1127 #endif /* __i386__ */