2 * NT exception handling routines
4 * Copyright 1999 Turchanov Sergey
5 * Copyright 1999 Alexandre Julliard
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #include "wine/port.h"
31 #define WIN32_NO_STATUS
34 #include "wine/exception.h"
35 #include "wine/server.h"
36 #include "wine/list.h"
37 #include "wine/debug.h"
39 #include "ntdll_misc.h"
41 WINE_DEFAULT_DEBUG_CHANNEL(seh
);
43 /* Exception record for handling exceptions happening inside exception handlers */
46 EXCEPTION_REGISTRATION_RECORD frame
;
47 EXCEPTION_REGISTRATION_RECORD
*prevFrame
;
53 PVECTORED_EXCEPTION_HANDLER func
;
56 static struct list vectored_handlers
= LIST_INIT(vectored_handlers
);
58 static RTL_CRITICAL_SECTION vectored_handlers_section
;
59 static RTL_CRITICAL_SECTION_DEBUG critsect_debug
=
61 0, 0, &vectored_handlers_section
,
62 { &critsect_debug
.ProcessLocksList
, &critsect_debug
.ProcessLocksList
},
63 0, 0, { (DWORD_PTR
)(__FILE__
": vectored_handlers_section") }
65 static RTL_CRITICAL_SECTION vectored_handlers_section
= { &critsect_debug
, -1, 0, 0, 0, 0 };
68 # define GET_IP(context) ((LPVOID)(context)->Eip)
69 #elif defined(__sparc__)
70 # define GET_IP(context) ((LPVOID)(context)->pc)
71 #elif defined(__powerpc__)
72 # define GET_IP(context) ((LPVOID)(context)->Iar)
73 #elif defined(__ALPHA__)
74 # define GET_IP(context) ((LPVOID)(context)->Fir)
75 #elif defined(__x86_64__)
76 # define GET_IP(context) ((LPVOID)(context)->Rip)
78 # error You must define GET_IP for this CPU
81 /*******************************************************************
84 * Handler for exceptions happening inside a handler.
86 static DWORD
EXC_RaiseHandler( EXCEPTION_RECORD
*rec
, EXCEPTION_REGISTRATION_RECORD
*frame
,
87 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**dispatcher
)
89 if (rec
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
))
90 return ExceptionContinueSearch
;
91 /* We shouldn't get here so we store faulty frame in dispatcher */
92 *dispatcher
= ((EXC_NESTED_FRAME
*)frame
)->prevFrame
;
93 return ExceptionNestedException
;
97 /*******************************************************************
100 * Handler for exceptions happening inside an unwind handler.
102 static DWORD
EXC_UnwindHandler( EXCEPTION_RECORD
*rec
, EXCEPTION_REGISTRATION_RECORD
*frame
,
103 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**dispatcher
)
105 if (!(rec
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
)))
106 return ExceptionContinueSearch
;
107 /* We shouldn't get here so we store faulty frame in dispatcher */
108 *dispatcher
= ((EXC_NESTED_FRAME
*)frame
)->prevFrame
;
109 return ExceptionCollidedUnwind
;
113 /*******************************************************************
116 * Call an exception handler, setting up an exception frame to catch exceptions
117 * happening during the handler execution.
119 * For i386 this function is implemented in assembler in signal_i386.c.
122 static DWORD
EXC_CallHandler( EXCEPTION_RECORD
*record
, EXCEPTION_REGISTRATION_RECORD
*frame
,
123 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**dispatcher
,
124 PEXCEPTION_HANDLER handler
, PEXCEPTION_HANDLER nested_handler
)
126 EXC_NESTED_FRAME newframe
;
129 newframe
.frame
.Handler
= nested_handler
;
130 newframe
.prevFrame
= frame
;
131 __wine_push_frame( &newframe
.frame
);
132 ret
= handler( record
, frame
, context
, dispatcher
);
133 __wine_pop_frame( &newframe
.frame
);
137 /* in signal_i386.c */
138 extern DWORD
EXC_CallHandler( EXCEPTION_RECORD
*record
, EXCEPTION_REGISTRATION_RECORD
*frame
,
139 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**dispatcher
,
140 PEXCEPTION_HANDLER handler
, PEXCEPTION_HANDLER nested_handler
);
143 /**********************************************************************
146 * Wait until the thread is no longer suspended.
148 void wait_suspend( CONTEXT
*context
)
150 LARGE_INTEGER timeout
;
151 int saved_errno
= errno
;
153 /* store the context we got at suspend time */
154 SERVER_START_REQ( set_thread_context
)
156 req
->handle
= GetCurrentThread();
157 req
->flags
= CONTEXT_FULL
;
159 wine_server_add_data( req
, context
, sizeof(*context
) );
160 wine_server_call( req
);
164 /* wait with 0 timeout, will only return once the thread is no longer suspended */
165 timeout
.QuadPart
= 0;
166 NTDLL_wait_for_multiple_objects( 0, NULL
, SELECT_INTERRUPTIBLE
, &timeout
, 0 );
168 /* retrieve the new context */
169 SERVER_START_REQ( get_thread_context
)
171 req
->handle
= GetCurrentThread();
172 req
->flags
= CONTEXT_FULL
;
174 wine_server_set_reply( req
, context
, sizeof(*context
) );
175 wine_server_call( req
);
183 /**********************************************************************
186 * Send an EXCEPTION_DEBUG_EVENT event to the debugger.
188 static NTSTATUS
send_debug_event( EXCEPTION_RECORD
*rec
, int first_chance
, CONTEXT
*context
)
193 if (!NtCurrentTeb()->Peb
->BeingDebugged
) return 0; /* no debugger present */
195 SERVER_START_REQ( queue_exception_event
)
197 req
->first
= first_chance
;
198 wine_server_add_data( req
, context
, sizeof(*context
) );
199 wine_server_add_data( req
, rec
, sizeof(*rec
) );
200 if (!wine_server_call( req
)) handle
= reply
->handle
;
203 if (!handle
) return 0;
205 NTDLL_wait_for_multiple_objects( 1, &handle
, SELECT_INTERRUPTIBLE
, NULL
, 0 );
207 SERVER_START_REQ( get_exception_status
)
209 req
->handle
= handle
;
210 wine_server_set_reply( req
, context
, sizeof(*context
) );
211 ret
= wine_server_call( req
);
218 /**********************************************************************
219 * call_vectored_handlers
221 * Call the vectored handlers chain.
223 static LONG
call_vectored_handlers( EXCEPTION_RECORD
*rec
, CONTEXT
*context
)
226 LONG ret
= EXCEPTION_CONTINUE_SEARCH
;
227 EXCEPTION_POINTERS except_ptrs
;
229 except_ptrs
.ExceptionRecord
= rec
;
230 except_ptrs
.ContextRecord
= context
;
232 RtlEnterCriticalSection( &vectored_handlers_section
);
233 LIST_FOR_EACH( ptr
, &vectored_handlers
)
235 VECTORED_HANDLER
*handler
= LIST_ENTRY( ptr
, VECTORED_HANDLER
, entry
);
236 ret
= handler
->func( &except_ptrs
);
237 if (ret
== EXCEPTION_CONTINUE_EXECUTION
) break;
239 RtlLeaveCriticalSection( &vectored_handlers_section
);
244 /**********************************************************************
245 * call_stack_handlers
247 * Call the stack handlers chain.
249 static NTSTATUS
call_stack_handlers( EXCEPTION_RECORD
*rec
, CONTEXT
*context
)
251 EXCEPTION_REGISTRATION_RECORD
*frame
, *dispatch
, *nested_frame
;
254 memcpy(&backup
, context
, sizeof(backup
));
256 frame
= NtCurrentTeb()->Tib
.ExceptionList
;
258 while (frame
!= (EXCEPTION_REGISTRATION_RECORD
*)~0UL)
260 /* Check frame address */
261 if (((void*)frame
< NtCurrentTeb()->Tib
.StackLimit
) ||
262 ((void*)(frame
+1) > NtCurrentTeb()->Tib
.StackBase
) ||
263 (ULONG_PTR
)frame
& 3)
265 rec
->ExceptionFlags
|= EH_STACK_INVALID
;
270 TRACE( "calling handler at %p code=%x flags=%x\n",
271 frame
->Handler
, rec
->ExceptionCode
, rec
->ExceptionFlags
);
272 res
= EXC_CallHandler( rec
, frame
, context
, &dispatch
, frame
->Handler
, EXC_RaiseHandler
);
273 TRACE( "handler at %p returned %x\n", frame
->Handler
, res
);
276 #define check_changed(reg)\
278 if(backup.reg != context->reg)\
280 TRACE(#reg" 0x%08x -> 0x%08x\n", backup.reg, context->reg);\
292 check_changed(EFlags
)
301 if (frame
== nested_frame
)
303 /* no longer nested */
305 rec
->ExceptionFlags
&= ~EH_NESTED_CALL
;
310 case ExceptionContinueExecution
:
311 if (!(rec
->ExceptionFlags
& EH_NONCONTINUABLE
)) return STATUS_SUCCESS
;
312 return STATUS_NONCONTINUABLE_EXCEPTION
;
313 case ExceptionContinueSearch
:
315 case ExceptionNestedException
:
316 if (nested_frame
< dispatch
) nested_frame
= dispatch
;
317 rec
->ExceptionFlags
|= EH_NESTED_CALL
;
320 return STATUS_INVALID_DISPOSITION
;
324 return STATUS_UNHANDLED_EXCEPTION
;
328 /*******************************************************************
331 * Implementation of NtRaiseException.
333 static NTSTATUS
raise_exception( EXCEPTION_RECORD
*rec
, CONTEXT
*context
, BOOL first_chance
)
341 TRACE( ">>> first chance code=%x flags=%x addr=%p\n",
342 rec
->ExceptionCode
, rec
->ExceptionFlags
, rec
->ExceptionAddress
);
343 for (c
= 0; c
< rec
->NumberParameters
; c
++)
344 TRACE( " info[%d]=%08lx\n", c
, rec
->ExceptionInformation
[c
] );
345 if (rec
->ExceptionCode
== EXCEPTION_WINE_STUB
)
347 if (rec
->ExceptionInformation
[1] >> 16)
348 MESSAGE( "wine: Call from %p to unimplemented function %s.%s, aborting\n",
349 rec
->ExceptionAddress
,
350 (char*)rec
->ExceptionInformation
[0], (char*)rec
->ExceptionInformation
[1] );
352 MESSAGE( "wine: Call from %p to unimplemented function %s.%ld, aborting\n",
353 rec
->ExceptionAddress
,
354 (char*)rec
->ExceptionInformation
[0], rec
->ExceptionInformation
[1] );
359 TRACE(" eax=%08x ebx=%08x ecx=%08x edx=%08x esi=%08x edi=%08x\n",
360 context
->Eax
, context
->Ebx
, context
->Ecx
,
361 context
->Edx
, context
->Esi
, context
->Edi
);
362 TRACE(" ebp=%08x esp=%08x cs=%04x ds=%04x es=%04x fs=%04x gs=%04x flags=%08x\n",
363 context
->Ebp
, context
->Esp
, context
->SegCs
, context
->SegDs
,
364 context
->SegEs
, context
->SegFs
, context
->SegGs
, context
->EFlags
);
367 status
= send_debug_event( rec
, TRUE
, context
);
368 if (status
== DBG_CONTINUE
|| status
== DBG_EXCEPTION_HANDLED
)
369 return STATUS_SUCCESS
;
372 /* fix up instruction pointer in context for EXCEPTION_BREAKPOINT */
373 if (rec
->ExceptionCode
== EXCEPTION_BREAKPOINT
) context
->Eip
--;
376 if (call_vectored_handlers( rec
, context
) == EXCEPTION_CONTINUE_EXECUTION
)
377 return STATUS_SUCCESS
;
379 if ((status
= call_stack_handlers( rec
, context
)) != STATUS_UNHANDLED_EXCEPTION
)
383 /* last chance exception */
384 TRACE( ">>> second chance\n");
385 status
= send_debug_event( rec
, FALSE
, context
);
386 if (status
!= DBG_CONTINUE
)
388 if (rec
->ExceptionFlags
& EH_STACK_INVALID
)
389 ERR("Exception frame is not in stack limits => unable to dispatch exception.\n");
390 else if (rec
->ExceptionCode
== STATUS_NONCONTINUABLE_EXCEPTION
)
391 ERR("Process attempted to continue execution after noncontinuable exception.\n");
393 ERR("Unhandled exception code %x flags %x addr %p\n",
394 rec
->ExceptionCode
, rec
->ExceptionFlags
, rec
->ExceptionAddress
);
395 NtTerminateProcess( NtCurrentProcess(), 1 );
397 return STATUS_SUCCESS
;
401 /*******************************************************************
402 * NtRaiseException (NTDLL.@)
404 NTSTATUS WINAPI
NtRaiseException( EXCEPTION_RECORD
*rec
, CONTEXT
*context
, BOOL first_chance
)
406 NTSTATUS status
= raise_exception( rec
, context
, first_chance
);
407 if (status
== STATUS_SUCCESS
) NtSetContextThread( GetCurrentThread(), context
);
411 /***********************************************************************
412 * RtlRaiseException (NTDLL.@)
414 void WINAPI
__regs_RtlRaiseException( EXCEPTION_RECORD
*rec
, CONTEXT
*context
)
416 NTSTATUS status
= raise_exception( rec
, context
, TRUE
);
417 if (status
!= STATUS_SUCCESS
)
419 EXCEPTION_RECORD newrec
;
420 newrec
.ExceptionCode
= status
;
421 newrec
.ExceptionFlags
= EH_NONCONTINUABLE
;
422 newrec
.ExceptionRecord
= rec
;
423 newrec
.NumberParameters
= 0;
424 RtlRaiseException( &newrec
); /* never returns */
428 /**********************************************************************/
430 #ifdef DEFINE_REGS_ENTRYPOINT
431 DEFINE_REGS_ENTRYPOINT( RtlRaiseException
, 4, 4 )
433 void WINAPI
RtlRaiseException( EXCEPTION_RECORD
*rec
)
436 memset( &context
, 0, sizeof(context
) );
437 __regs_RtlRaiseException( rec
, &context
);
442 /*******************************************************************
443 * RtlUnwind (NTDLL.@)
445 void WINAPI
__regs_RtlUnwind( EXCEPTION_REGISTRATION_RECORD
* pEndFrame
, PVOID unusedEip
,
446 PEXCEPTION_RECORD pRecord
, PVOID returnEax
, CONTEXT
*context
)
448 EXCEPTION_RECORD record
, newrec
;
449 EXCEPTION_REGISTRATION_RECORD
*frame
, *dispatch
;
453 context
->Eax
= (DWORD
)returnEax
;
456 /* build an exception record, if we do not have one */
459 record
.ExceptionCode
= STATUS_UNWIND
;
460 record
.ExceptionFlags
= 0;
461 record
.ExceptionRecord
= NULL
;
462 record
.ExceptionAddress
= GET_IP(context
);
463 record
.NumberParameters
= 0;
467 pRecord
->ExceptionFlags
|= EH_UNWINDING
| (pEndFrame
? 0 : EH_EXIT_UNWIND
);
469 TRACE( "code=%x flags=%x\n", pRecord
->ExceptionCode
, pRecord
->ExceptionFlags
);
471 /* get chain of exception frames */
472 frame
= NtCurrentTeb()->Tib
.ExceptionList
;
473 while ((frame
!= (EXCEPTION_REGISTRATION_RECORD
*)~0UL) && (frame
!= pEndFrame
))
475 /* Check frame address */
476 if (pEndFrame
&& (frame
> pEndFrame
))
478 newrec
.ExceptionCode
= STATUS_INVALID_UNWIND_TARGET
;
479 newrec
.ExceptionFlags
= EH_NONCONTINUABLE
;
480 newrec
.ExceptionRecord
= pRecord
;
481 newrec
.NumberParameters
= 0;
482 RtlRaiseException( &newrec
); /* never returns */
484 if (((void*)frame
< NtCurrentTeb()->Tib
.StackLimit
) ||
485 ((void*)(frame
+1) > NtCurrentTeb()->Tib
.StackBase
) ||
488 newrec
.ExceptionCode
= STATUS_BAD_STACK
;
489 newrec
.ExceptionFlags
= EH_NONCONTINUABLE
;
490 newrec
.ExceptionRecord
= pRecord
;
491 newrec
.NumberParameters
= 0;
492 RtlRaiseException( &newrec
); /* never returns */
496 TRACE( "calling handler at %p code=%x flags=%x\n",
497 frame
->Handler
, pRecord
->ExceptionCode
, pRecord
->ExceptionFlags
);
498 res
= EXC_CallHandler( pRecord
, frame
, context
, &dispatch
, frame
->Handler
, EXC_UnwindHandler
);
499 TRACE( "handler at %p returned %x\n", frame
->Handler
, res
);
503 case ExceptionContinueSearch
:
505 case ExceptionCollidedUnwind
:
509 newrec
.ExceptionCode
= STATUS_INVALID_DISPOSITION
;
510 newrec
.ExceptionFlags
= EH_NONCONTINUABLE
;
511 newrec
.ExceptionRecord
= pRecord
;
512 newrec
.NumberParameters
= 0;
513 RtlRaiseException( &newrec
); /* never returns */
516 frame
= __wine_pop_frame( frame
);
520 /**********************************************************************/
522 #ifdef DEFINE_REGS_ENTRYPOINT
523 DEFINE_REGS_ENTRYPOINT( RtlUnwind
, 16, 16 )
525 void WINAPI
RtlUnwind( PVOID pEndFrame
, PVOID unusedEip
,
526 PEXCEPTION_RECORD pRecord
, PVOID returnEax
)
529 memset( &context
, 0, sizeof(context
) );
530 __regs_RtlUnwind( pEndFrame
, unusedEip
, pRecord
, returnEax
, &context
);
535 /***********************************************************************
536 * RtlRaiseStatus (NTDLL.@)
538 * Raise an exception with ExceptionCode = status
540 void WINAPI
RtlRaiseStatus( NTSTATUS status
)
542 EXCEPTION_RECORD ExceptionRec
;
544 ExceptionRec
.ExceptionCode
= status
;
545 ExceptionRec
.ExceptionFlags
= EH_NONCONTINUABLE
;
546 ExceptionRec
.ExceptionRecord
= NULL
;
547 ExceptionRec
.NumberParameters
= 0;
548 RtlRaiseException( &ExceptionRec
);
552 /*******************************************************************
553 * RtlAddVectoredExceptionHandler (NTDLL.@)
555 PVOID WINAPI
RtlAddVectoredExceptionHandler( ULONG first
, PVECTORED_EXCEPTION_HANDLER func
)
557 VECTORED_HANDLER
*handler
= RtlAllocateHeap( GetProcessHeap(), 0, sizeof(*handler
) );
560 handler
->func
= func
;
561 RtlEnterCriticalSection( &vectored_handlers_section
);
562 if (first
) list_add_head( &vectored_handlers
, &handler
->entry
);
563 else list_add_tail( &vectored_handlers
, &handler
->entry
);
564 RtlLeaveCriticalSection( &vectored_handlers_section
);
570 /*******************************************************************
571 * RtlRemoveVectoredExceptionHandler (NTDLL.@)
573 ULONG WINAPI
RtlRemoveVectoredExceptionHandler( PVOID handler
)
578 RtlEnterCriticalSection( &vectored_handlers_section
);
579 LIST_FOR_EACH( ptr
, &vectored_handlers
)
581 VECTORED_HANDLER
*curr_handler
= LIST_ENTRY( ptr
, VECTORED_HANDLER
, entry
);
582 if (curr_handler
== handler
)
589 RtlLeaveCriticalSection( &vectored_handlers_section
);
590 if (ret
) RtlFreeHeap( GetProcessHeap(), 0, handler
);
595 /*************************************************************
596 * __wine_exception_handler (NTDLL.@)
598 * Exception handler for exception blocks declared in Wine code.
600 DWORD
__wine_exception_handler( EXCEPTION_RECORD
*record
, EXCEPTION_REGISTRATION_RECORD
*frame
,
601 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**pdispatcher
)
603 __WINE_FRAME
*wine_frame
= (__WINE_FRAME
*)frame
;
605 if (record
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
| EH_NESTED_CALL
))
606 return ExceptionContinueSearch
;
608 if (wine_frame
->u
.filter
== (void *)1) /* special hack for page faults */
610 if (record
->ExceptionCode
!= STATUS_ACCESS_VIOLATION
)
611 return ExceptionContinueSearch
;
613 else if (wine_frame
->u
.filter
)
615 EXCEPTION_POINTERS ptrs
;
616 ptrs
.ExceptionRecord
= record
;
617 ptrs
.ContextRecord
= context
;
618 switch(wine_frame
->u
.filter( &ptrs
))
620 case EXCEPTION_CONTINUE_SEARCH
:
621 return ExceptionContinueSearch
;
622 case EXCEPTION_CONTINUE_EXECUTION
:
623 return ExceptionContinueExecution
;
624 case EXCEPTION_EXECUTE_HANDLER
:
627 MESSAGE( "Invalid return value from exception filter\n" );
631 /* hack to make GetExceptionCode() work in handler */
632 wine_frame
->ExceptionCode
= record
->ExceptionCode
;
633 wine_frame
->ExceptionRecord
= wine_frame
;
635 RtlUnwind( frame
, 0, record
, 0 );
636 __wine_pop_frame( frame
);
637 siglongjmp( wine_frame
->jmp
, 1 );
641 /*************************************************************
642 * __wine_finally_handler (NTDLL.@)
644 * Exception handler for try/finally blocks declared in Wine code.
646 DWORD
__wine_finally_handler( EXCEPTION_RECORD
*record
, EXCEPTION_REGISTRATION_RECORD
*frame
,
647 CONTEXT
*context
, EXCEPTION_REGISTRATION_RECORD
**pdispatcher
)
649 if (record
->ExceptionFlags
& (EH_UNWINDING
| EH_EXIT_UNWIND
))
651 __WINE_FRAME
*wine_frame
= (__WINE_FRAME
*)frame
;
652 wine_frame
->u
.finally_func( FALSE
);
654 return ExceptionContinueSearch
;
658 /*************************************************************
659 * __wine_spec_unimplemented_stub
661 * ntdll-specific implementation to avoid depending on kernel functions.
662 * Can be removed once ntdll.spec no longer contains stubs.
664 void __wine_spec_unimplemented_stub( const char *module
, const char *function
)
666 EXCEPTION_RECORD record
;
668 record
.ExceptionCode
= EXCEPTION_WINE_STUB
;
669 record
.ExceptionFlags
= EH_NONCONTINUABLE
;
670 record
.ExceptionRecord
= NULL
;
671 record
.ExceptionAddress
= __wine_spec_unimplemented_stub
;
672 record
.NumberParameters
= 2;
673 record
.ExceptionInformation
[0] = (ULONG_PTR
)module
;
674 record
.ExceptionInformation
[1] = (ULONG_PTR
)function
;
675 RtlRaiseException( &record
);