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 = wine_server_obj_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 = wine_server_obj_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 client_ptr_t params[EXCEPTION_MAXIMUM_PARAMETERS];
195 if (!NtCurrentTeb()->Peb->BeingDebugged) return 0; /* no debugger present */
197 for (i = 0; i < min( rec->NumberParameters, EXCEPTION_MAXIMUM_PARAMETERS ); i++)
198 params[i] = rec->ExceptionInformation[i];
200 SERVER_START_REQ( queue_exception_event )
202 req->first = first_chance;
203 req->code = rec->ExceptionCode;
204 req->flags = rec->ExceptionFlags;
205 req->record = wine_server_client_ptr( rec->ExceptionRecord );
206 req->address = wine_server_client_ptr( rec->ExceptionAddress );
207 req->len = i * sizeof(params[0]);
208 wine_server_add_data( req, params, req->len );
209 wine_server_add_data( req, context, sizeof(*context) );
210 if (!wine_server_call( req )) handle = wine_server_ptr_handle( reply->handle );
213 if (!handle) return 0;
215 NTDLL_wait_for_multiple_objects( 1, &handle, SELECT_INTERRUPTIBLE, NULL, 0 );
217 SERVER_START_REQ( get_exception_status )
219 req->handle = wine_server_obj_handle( handle );
220 wine_server_set_reply( req, context, sizeof(*context) );
221 ret = wine_server_call( req );
228 /**********************************************************************
229 * call_vectored_handlers
231 * Call the vectored handlers chain.
233 static LONG call_vectored_handlers( EXCEPTION_RECORD *rec, CONTEXT *context )
236 LONG ret = EXCEPTION_CONTINUE_SEARCH;
237 EXCEPTION_POINTERS except_ptrs;
239 except_ptrs.ExceptionRecord = rec;
240 except_ptrs.ContextRecord = context;
242 RtlEnterCriticalSection( &vectored_handlers_section );
243 LIST_FOR_EACH( ptr, &vectored_handlers )
245 VECTORED_HANDLER *handler = LIST_ENTRY( ptr, VECTORED_HANDLER, entry );
246 ret = handler->func( &except_ptrs );
247 if (ret == EXCEPTION_CONTINUE_EXECUTION) break;
249 RtlLeaveCriticalSection( &vectored_handlers_section );
254 /**********************************************************************
255 * call_stack_handlers
257 * Call the stack handlers chain.
259 static NTSTATUS call_stack_handlers( EXCEPTION_RECORD *rec, CONTEXT *context )
261 EXCEPTION_REGISTRATION_RECORD *frame, *dispatch, *nested_frame;
264 frame = NtCurrentTeb()->Tib.ExceptionList;
266 while (frame != (EXCEPTION_REGISTRATION_RECORD*)~0UL)
268 /* Check frame address */
269 if (((void*)frame < NtCurrentTeb()->Tib.StackLimit) ||
270 ((void*)(frame+1) > NtCurrentTeb()->Tib.StackBase) ||
271 (ULONG_PTR)frame & 3)
273 rec->ExceptionFlags |= EH_STACK_INVALID;
278 TRACE( "calling handler at %p code=%x flags=%x\n",
279 frame->Handler, rec->ExceptionCode, rec->ExceptionFlags );
280 res = EXC_CallHandler( rec, frame, context, &dispatch, frame->Handler, EXC_RaiseHandler );
281 TRACE( "handler at %p returned %x\n", frame->Handler, res );
283 if (frame == nested_frame)
285 /* no longer nested */
287 rec->ExceptionFlags &= ~EH_NESTED_CALL;
292 case ExceptionContinueExecution:
293 if (!(rec->ExceptionFlags & EH_NONCONTINUABLE)) return STATUS_SUCCESS;
294 return STATUS_NONCONTINUABLE_EXCEPTION;
295 case ExceptionContinueSearch:
297 case ExceptionNestedException:
298 if (nested_frame < dispatch) nested_frame = dispatch;
299 rec->ExceptionFlags |= EH_NESTED_CALL;
302 return STATUS_INVALID_DISPOSITION;
306 return STATUS_UNHANDLED_EXCEPTION;
310 /*******************************************************************
313 * Implementation of NtRaiseException.
315 static NTSTATUS raise_exception( EXCEPTION_RECORD *rec, CONTEXT *context, BOOL first_chance )
323 TRACE( "code=%x flags=%x addr=%p ip=%p tid=%04x\n",
324 rec->ExceptionCode, rec->ExceptionFlags, rec->ExceptionAddress,
325 GET_IP(context), GetCurrentThreadId() );
326 for (c = 0; c < rec->NumberParameters; c++)
327 TRACE( " info[%d]=%08lx\n", c, rec->ExceptionInformation[c] );
328 if (rec->ExceptionCode == EXCEPTION_WINE_STUB)
330 if (rec->ExceptionInformation[1] >> 16)
331 MESSAGE( "wine: Call from %p to unimplemented function %s.%s, aborting\n",
332 rec->ExceptionAddress,
333 (char*)rec->ExceptionInformation[0], (char*)rec->ExceptionInformation[1] );
335 MESSAGE( "wine: Call from %p to unimplemented function %s.%ld, aborting\n",
336 rec->ExceptionAddress,
337 (char*)rec->ExceptionInformation[0], rec->ExceptionInformation[1] );
342 TRACE(" eax=%08x ebx=%08x ecx=%08x edx=%08x esi=%08x edi=%08x\n",
343 context->Eax, context->Ebx, context->Ecx,
344 context->Edx, context->Esi, context->Edi );
345 TRACE(" ebp=%08x esp=%08x cs=%04x ds=%04x es=%04x fs=%04x gs=%04x flags=%08x\n",
346 context->Ebp, context->Esp, context->SegCs, context->SegDs,
347 context->SegEs, context->SegFs, context->SegGs, context->EFlags );
348 #elif defined(__x86_64__)
349 TRACE(" rax=%016lx rbx=%016lx rcx=%016lx rdx=%016lx\n",
350 context->Rax, context->Rbx, context->Rcx, context->Rdx );
351 TRACE(" rsi=%016lx rdi=%016lx rbp=%016lx rsp=%016lx\n",
352 context->Rsi, context->Rdi, context->Rbp, context->Rsp );
353 TRACE(" r8=%016lx r9=%016lx r10=%016lx r11=%016lx\n",
354 context->R8, context->R9, context->R10, context->R11 );
355 TRACE(" r12=%016lx r13=%016lx r14=%016lx r15=%016lx\n",
356 context->R12, context->R13, context->R14, context->R15 );
359 status = send_debug_event( rec, TRUE, context );
360 if (status == DBG_CONTINUE || status == DBG_EXCEPTION_HANDLED)
361 return STATUS_SUCCESS;
364 /* fix up instruction pointer in context for EXCEPTION_BREAKPOINT */
365 if (rec->ExceptionCode == EXCEPTION_BREAKPOINT) context->Eip--;
368 if (call_vectored_handlers( rec, context ) == EXCEPTION_CONTINUE_EXECUTION)
369 return STATUS_SUCCESS;
371 if ((status = call_stack_handlers( rec, context )) != STATUS_UNHANDLED_EXCEPTION)
375 /* last chance exception */
377 status = send_debug_event( rec, FALSE, context );
378 if (status != DBG_CONTINUE)
380 if (rec->ExceptionFlags & EH_STACK_INVALID)
381 ERR("Exception frame is not in stack limits => unable to dispatch exception.\n");
382 else if (rec->ExceptionCode == STATUS_NONCONTINUABLE_EXCEPTION)
383 ERR("Process attempted to continue execution after noncontinuable exception.\n");
385 ERR("Unhandled exception code %x flags %x addr %p\n",
386 rec->ExceptionCode, rec->ExceptionFlags, rec->ExceptionAddress );
387 NtTerminateProcess( NtCurrentProcess(), 1 );
389 return STATUS_SUCCESS;
393 /*******************************************************************
394 * NtRaiseException (NTDLL.@)
396 NTSTATUS WINAPI NtRaiseException( EXCEPTION_RECORD *rec, CONTEXT *context, BOOL first_chance )
398 NTSTATUS status = raise_exception( rec, context, first_chance );
399 if (status == STATUS_SUCCESS) NtSetContextThread( GetCurrentThread(), context );
404 /***********************************************************************
405 * RtlRaiseException (NTDLL.@)
407 void WINAPI __regs_RtlRaiseException( EXCEPTION_RECORD *rec, CONTEXT *context )
409 NTSTATUS status = raise_exception( rec, context, TRUE );
410 if (status != STATUS_SUCCESS)
412 EXCEPTION_RECORD newrec;
413 newrec.ExceptionCode = status;
414 newrec.ExceptionFlags = EH_NONCONTINUABLE;
415 newrec.ExceptionRecord = rec;
416 newrec.NumberParameters = 0;
417 RtlRaiseException( &newrec ); /* never returns */
421 /**********************************************************************/
423 #ifdef DEFINE_REGS_ENTRYPOINT
424 DEFINE_REGS_ENTRYPOINT( RtlRaiseException, 1 )
426 void WINAPI RtlRaiseException( EXCEPTION_RECORD *rec )
429 RtlCaptureContext( &context );
430 __regs_RtlRaiseException( rec, &context );
435 /*******************************************************************
436 * RtlUnwind (NTDLL.@)
438 void WINAPI __regs_RtlUnwind( EXCEPTION_REGISTRATION_RECORD* pEndFrame, PVOID unusedEip,
439 PEXCEPTION_RECORD pRecord, PVOID returnEax, CONTEXT *context )
441 EXCEPTION_RECORD record, newrec;
442 EXCEPTION_REGISTRATION_RECORD *frame, *dispatch;
446 context->Eax = (DWORD)returnEax;
449 /* build an exception record, if we do not have one */
452 record.ExceptionCode = STATUS_UNWIND;
453 record.ExceptionFlags = 0;
454 record.ExceptionRecord = NULL;
455 record.ExceptionAddress = GET_IP(context);
456 record.NumberParameters = 0;
460 pRecord->ExceptionFlags |= EH_UNWINDING | (pEndFrame ? 0 : EH_EXIT_UNWIND);
462 TRACE( "code=%x flags=%x\n", pRecord->ExceptionCode, pRecord->ExceptionFlags );
464 /* get chain of exception frames */
465 frame = NtCurrentTeb()->Tib.ExceptionList;
466 while ((frame != (EXCEPTION_REGISTRATION_RECORD*)~0UL) && (frame != pEndFrame))
468 /* Check frame address */
469 if (pEndFrame && (frame > pEndFrame))
471 newrec.ExceptionCode = STATUS_INVALID_UNWIND_TARGET;
472 newrec.ExceptionFlags = EH_NONCONTINUABLE;
473 newrec.ExceptionRecord = pRecord;
474 newrec.NumberParameters = 0;
475 RtlRaiseException( &newrec ); /* never returns */
477 if (((void*)frame < NtCurrentTeb()->Tib.StackLimit) ||
478 ((void*)(frame+1) > NtCurrentTeb()->Tib.StackBase) ||
481 newrec.ExceptionCode = STATUS_BAD_STACK;
482 newrec.ExceptionFlags = EH_NONCONTINUABLE;
483 newrec.ExceptionRecord = pRecord;
484 newrec.NumberParameters = 0;
485 RtlRaiseException( &newrec ); /* never returns */
489 TRACE( "calling handler at %p code=%x flags=%x\n",
490 frame->Handler, pRecord->ExceptionCode, pRecord->ExceptionFlags );
491 res = EXC_CallHandler( pRecord, frame, context, &dispatch, frame->Handler, EXC_UnwindHandler );
492 TRACE( "handler at %p returned %x\n", frame->Handler, res );
496 case ExceptionContinueSearch:
498 case ExceptionCollidedUnwind:
502 newrec.ExceptionCode = STATUS_INVALID_DISPOSITION;
503 newrec.ExceptionFlags = EH_NONCONTINUABLE;
504 newrec.ExceptionRecord = pRecord;
505 newrec.NumberParameters = 0;
506 RtlRaiseException( &newrec ); /* never returns */
509 frame = __wine_pop_frame( frame );
513 /**********************************************************************/
515 #ifdef DEFINE_REGS_ENTRYPOINT
516 DEFINE_REGS_ENTRYPOINT( RtlUnwind, 4 )
518 void WINAPI RtlUnwind( PVOID pEndFrame, PVOID unusedEip,
519 PEXCEPTION_RECORD pRecord, PVOID returnEax )
522 RtlCaptureContext( &context );
523 __regs_RtlUnwind( pEndFrame, unusedEip, pRecord, returnEax, &context );
528 /***********************************************************************
529 * RtlRaiseStatus (NTDLL.@)
531 * Raise an exception with ExceptionCode = status
533 void WINAPI RtlRaiseStatus( NTSTATUS status )
535 EXCEPTION_RECORD ExceptionRec;
537 ExceptionRec.ExceptionCode = status;
538 ExceptionRec.ExceptionFlags = EH_NONCONTINUABLE;
539 ExceptionRec.ExceptionRecord = NULL;
540 ExceptionRec.NumberParameters = 0;
541 RtlRaiseException( &ExceptionRec );
545 /*******************************************************************
546 * RtlAddVectoredExceptionHandler (NTDLL.@)
548 PVOID WINAPI RtlAddVectoredExceptionHandler( ULONG first, PVECTORED_EXCEPTION_HANDLER func )
550 VECTORED_HANDLER *handler = RtlAllocateHeap( GetProcessHeap(), 0, sizeof(*handler) );
553 handler->func = func;
554 RtlEnterCriticalSection( &vectored_handlers_section );
555 if (first) list_add_head( &vectored_handlers, &handler->entry );
556 else list_add_tail( &vectored_handlers, &handler->entry );
557 RtlLeaveCriticalSection( &vectored_handlers_section );
563 /*******************************************************************
564 * RtlRemoveVectoredExceptionHandler (NTDLL.@)
566 ULONG WINAPI RtlRemoveVectoredExceptionHandler( PVOID handler )
571 RtlEnterCriticalSection( &vectored_handlers_section );
572 LIST_FOR_EACH( ptr, &vectored_handlers )
574 VECTORED_HANDLER *curr_handler = LIST_ENTRY( ptr, VECTORED_HANDLER, entry );
575 if (curr_handler == handler)
582 RtlLeaveCriticalSection( &vectored_handlers_section );
583 if (ret) RtlFreeHeap( GetProcessHeap(), 0, handler );
588 /*************************************************************************
589 * RtlCaptureStackBackTrace [NTDLL.@]
591 * Captures stack backtrace
594 * Skip [I] Number of stack frames to skip before starting a capture
595 * Count [I] Number of stack frames to capture into Buffer
596 * Buffer [O] Array of backtrace pointers captured from stack
597 * Hash [O] Optional pointer to variable where backtrace hash should be stored
600 * Number of captured stack frames or 0 if error occurred
605 USHORT WINAPI RtlCaptureStackBackTrace(ULONG Skip, ULONG Count, PVOID *Buffer, ULONG *Hash)
607 FIXME("(%d, %d, %p, %p) stub!\n", Skip, Count, Buffer, Hash);
612 /*************************************************************
613 * __wine_spec_unimplemented_stub
615 * ntdll-specific implementation to avoid depending on kernel functions.
616 * Can be removed once ntdll.spec no longer contains stubs.
618 void __wine_spec_unimplemented_stub( const char *module, const char *function )
620 EXCEPTION_RECORD record;
622 record.ExceptionCode = EXCEPTION_WINE_STUB;
623 record.ExceptionFlags = EH_NONCONTINUABLE;
624 record.ExceptionRecord = NULL;
625 record.ExceptionAddress = __wine_spec_unimplemented_stub;
626 record.NumberParameters = 2;
627 record.ExceptionInformation[0] = (ULONG_PTR)module;
628 record.ExceptionInformation[1] = (ULONG_PTR)function;
629 for (;;) RtlRaiseException( &record );