except.c 17.8 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1 2 3 4
/*
 * Win32 exception functions
 *
 * Copyright (c) 1996 Onno Hovers, (onno@stack.urc.tue.nl)
5
 * Copyright (c) 1999 Alexandre Julliard
Alexandre Julliard's avatar
Alexandre Julliard committed
6
 *
7 8 9 10 11 12 13 14 15 16 17 18
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * 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
20
 *
Alexandre Julliard's avatar
Alexandre Julliard committed
21 22 23 24 25
 * Notes:
 *  What really happens behind the scenes of those new
 *  __try{...}__except(..){....}  and
 *  __try{...}__finally{...}
 *  statements is simply not documented by Microsoft. There could be different
26 27 28
 *  reasons for this:
 *  One reason could be that they try to hide the fact that exception
 *  handling in Win32 looks almost the same as in OS/2 2.x.
Alexandre Julliard's avatar
Alexandre Julliard committed
29
 *  Another reason could be that Microsoft does not want others to write
30
 *  binary compatible implementations of the Win32 API (like us).
Alexandre Julliard's avatar
Alexandre Julliard committed
31
 *
32 33 34
 *  Whatever the reason, THIS SUCKS!! Ensuring portability or future
 *  compatibility may be valid reasons to keep some things undocumented.
 *  But exception handling is so basic to Win32 that it should be
Alexandre Julliard's avatar
Alexandre Julliard committed
35 36 37
 *  documented!
 *
 */
38 39
#include "config.h"
#include "wine/port.h"
Alexandre Julliard's avatar
Alexandre Julliard committed
40

41
#include <stdarg.h>
42
#include <stdio.h>
43
#include "ntstatus.h"
44
#define WIN32_NO_STATUS
45
#include "windef.h"
46
#include "winbase.h"
47
#include "winternl.h"
48 49
#include "wingdi.h"
#include "winuser.h"
50
#include "wine/exception.h"
51
#include "wine/library.h"
52
#include "excpt.h"
53
#include "wine/unicode.h"
54
#include "wine/debug.h"
Alexandre Julliard's avatar
Alexandre Julliard committed
55

56
WINE_DEFAULT_DEBUG_CHANNEL(seh);
Alexandre Julliard's avatar
Alexandre Julliard committed
57

58 59
static PTOP_LEVEL_EXCEPTION_FILTER top_filter;

60 61
typedef INT (WINAPI *MessageBoxA_funcptr)(HWND,LPCSTR,LPCSTR,UINT);
typedef INT (WINAPI *MessageBoxW_funcptr)(HWND,LPCWSTR,LPCWSTR,UINT);
Alexandre Julliard's avatar
Alexandre Julliard committed
62 63

/*******************************************************************
64
 *         RaiseException  (KERNEL32.@)
Alexandre Julliard's avatar
Alexandre Julliard committed
65
 */
66
void WINAPI RaiseException( DWORD code, DWORD flags, DWORD nbargs, const ULONG_PTR *args )
Alexandre Julliard's avatar
Alexandre Julliard committed
67
{
68
    EXCEPTION_RECORD record;
Alexandre Julliard's avatar
Alexandre Julliard committed
69

70 71
    /* Compose an exception record */

72 73 74 75 76
    record.ExceptionCode    = code;
    record.ExceptionFlags   = flags & EH_NONCONTINUABLE;
    record.ExceptionRecord  = NULL;
    record.ExceptionAddress = RaiseException;
    if (nbargs && args)
Alexandre Julliard's avatar
Alexandre Julliard committed
77
    {
78 79 80 81 82
        if (nbargs > EXCEPTION_MAXIMUM_PARAMETERS) nbargs = EXCEPTION_MAXIMUM_PARAMETERS;
        record.NumberParameters = nbargs;
        memcpy( record.ExceptionInformation, args, nbargs * sizeof(*args) );
    }
    else record.NumberParameters = 0;
Alexandre Julliard's avatar
Alexandre Julliard committed
83

84
    RtlRaiseException( &record );
Alexandre Julliard's avatar
Alexandre Julliard committed
85 86
}

Alexandre Julliard's avatar
Alexandre Julliard committed
87

88 89 90
/*******************************************************************
 *         format_exception_msg
 */
91
static int format_exception_msg( const EXCEPTION_POINTERS *ptr, char *buffer, int size )
92 93
{
    const EXCEPTION_RECORD *rec = ptr->ExceptionRecord;
94
    int len,len2;
95 96 97 98

    switch(rec->ExceptionCode)
    {
    case EXCEPTION_INT_DIVIDE_BY_ZERO:
99
        len = snprintf( buffer, size, "Unhandled division by zero" );
100 101
        break;
    case EXCEPTION_INT_OVERFLOW:
102
        len = snprintf( buffer, size, "Unhandled overflow" );
103 104
        break;
    case EXCEPTION_ARRAY_BOUNDS_EXCEEDED:
105
        len = snprintf( buffer, size, "Unhandled array bounds" );
106 107
        break;
    case EXCEPTION_ILLEGAL_INSTRUCTION:
108
        len = snprintf( buffer, size, "Unhandled illegal instruction" );
109 110
        break;
    case EXCEPTION_STACK_OVERFLOW:
111
        len = snprintf( buffer, size, "Unhandled stack overflow" );
112 113
        break;
    case EXCEPTION_PRIV_INSTRUCTION:
Andreas Mohr's avatar
Andreas Mohr committed
114
        len = snprintf( buffer, size, "Unhandled privileged instruction" );
115 116 117
        break;
    case EXCEPTION_ACCESS_VIOLATION:
        if (rec->NumberParameters == 2)
118
            len = snprintf( buffer, size, "Unhandled page fault on %s access to 0x%08lx",
119 120 121
                            rec->ExceptionInformation[0] == EXCEPTION_WRITE_FAULT ? "write" :
                            rec->ExceptionInformation[0] == EXCEPTION_EXECUTE_FAULT ? "execute" : "read",
                            rec->ExceptionInformation[1]);
122
        else
123
            len = snprintf( buffer, size, "Unhandled page fault");
124 125
        break;
    case EXCEPTION_DATATYPE_MISALIGNMENT:
126
        len = snprintf( buffer, size, "Unhandled alignment" );
127 128
        break;
    case CONTROL_C_EXIT:
129
        len = snprintf( buffer, size, "Unhandled ^C");
130
        break;
131
    case STATUS_POSSIBLE_DEADLOCK:
132
        len = snprintf( buffer, size, "Critical section %08lx wait failed",
133 134 135
                 rec->ExceptionInformation[0]);
        break;
    case EXCEPTION_WINE_STUB:
136
        if ((ULONG_PTR)rec->ExceptionInformation[1] >> 16)
137 138 139 140 141
            len = snprintf( buffer, size, "Unimplemented function %s.%s called",
                            (char *)rec->ExceptionInformation[0], (char *)rec->ExceptionInformation[1] );
        else
            len = snprintf( buffer, size, "Unimplemented function %s.%ld called",
                            (char *)rec->ExceptionInformation[0], rec->ExceptionInformation[1] );
142
        break;
143 144 145
    case EXCEPTION_WINE_ASSERTION:
        len = snprintf( buffer, size, "Assertion failed" );
        break;
146
    case EXCEPTION_VM86_INTx:
147
        len = snprintf( buffer, size, "Unhandled interrupt %02lx in vm86 mode",
148 149 150
                 rec->ExceptionInformation[0]);
        break;
    case EXCEPTION_VM86_STI:
151
        len = snprintf( buffer, size, "Unhandled sti in vm86 mode");
152 153
        break;
    case EXCEPTION_VM86_PICRETURN:
154
        len = snprintf( buffer, size, "Unhandled PIC return in vm86 mode");
155 156
        break;
    default:
157
        len = snprintf( buffer, size, "Unhandled exception 0x%08x", rec->ExceptionCode);
158 159
        break;
    }
160 161
    if ((len<0) || (len>=size))
        return -1;
162
#ifdef __i386__
163
    if (ptr->ContextRecord->SegCs != wine_get_cs())
164
        len2 = snprintf(buffer+len, size-len, " at address 0x%04x:0x%08x",
165 166
                        ptr->ContextRecord->SegCs,
                        (DWORD)ptr->ExceptionRecord->ExceptionAddress);
167 168
    else
#endif
169
        len2 = snprintf(buffer+len, size-len, " at address %p",
170
                        ptr->ExceptionRecord->ExceptionAddress);
171 172 173
    if ((len2<0) || (len>=size-len))
        return -1;
    return len+len2;
174 175 176
}


177 178 179 180
/******************************************************************
 *		start_debugger
 *
 * Does the effective debugger startup according to 'format'
Alexandre Julliard's avatar
Alexandre Julliard committed
181
 */
182
static BOOL	start_debugger(PEXCEPTION_POINTERS epointers, HANDLE hEvent)
Alexandre Julliard's avatar
Alexandre Julliard committed
183
{
184 185
    OBJECT_ATTRIBUTES attr;
    UNICODE_STRING nameW;
186
    char *cmdline, *env, *p;
187
    HANDLE		hDbgConf;
188
    DWORD		bAuto = TRUE;
189 190
    PROCESS_INFORMATION	info;
    STARTUPINFOA	startup;
191 192
    char*		format = NULL;
    BOOL		ret = FALSE;
193
    char 		buffer[256];
Alexandre Julliard's avatar
Alexandre Julliard committed
194

195 196 197 198 199 200 201 202 203
    static const WCHAR AeDebugW[] = {'M','a','c','h','i','n','e','\\',
                                     'S','o','f','t','w','a','r','e','\\',
                                     'M','i','c','r','o','s','o','f','t','\\',
                                     'W','i','n','d','o','w','s',' ','N','T','\\',
                                     'C','u','r','r','e','n','t','V','e','r','s','i','o','n','\\',
                                     'A','e','D','e','b','u','g',0};
    static const WCHAR DebuggerW[] = {'D','e','b','u','g','g','e','r',0};
    static const WCHAR AutoW[] = {'A','u','t','o',0};

204
    format_exception_msg( epointers, buffer, sizeof(buffer) );
205
    MESSAGE("wine: %s (thread %04x), starting debugger...\n", buffer, GetCurrentThreadId());
Andreas Mohr's avatar
Andreas Mohr committed
206

207 208 209 210 211 212 213
    attr.Length = sizeof(attr);
    attr.RootDirectory = 0;
    attr.ObjectName = &nameW;
    attr.Attributes = 0;
    attr.SecurityDescriptor = NULL;
    attr.SecurityQualityOfService = NULL;
    RtlInitUnicodeString( &nameW, AeDebugW );
214

215
    if (!NtOpenKey( &hDbgConf, KEY_READ, &attr ))
216 217
    {
        KEY_VALUE_PARTIAL_INFORMATION *info;
218
        DWORD format_size = 0;
219

220 221
        RtlInitUnicodeString( &nameW, DebuggerW );
        if (NtQueryValueKey( hDbgConf, &nameW, KeyValuePartialInformation,
222
                             NULL, 0, &format_size ) == STATUS_BUFFER_TOO_SMALL)
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
        {
            char *data = HeapAlloc(GetProcessHeap(), 0, format_size);
            NtQueryValueKey( hDbgConf, &nameW, KeyValuePartialInformation,
                             data, format_size, &format_size );
            info = (KEY_VALUE_PARTIAL_INFORMATION *)data;
            RtlUnicodeToMultiByteSize( &format_size, (WCHAR *)info->Data, info->DataLength );
            format = HeapAlloc( GetProcessHeap(), 0, format_size+1 );
            RtlUnicodeToMultiByteN( format, format_size, NULL,
                                    (WCHAR *)info->Data, info->DataLength );
            format[format_size] = 0;

            if (info->Type == REG_EXPAND_SZ)
            {
                char* tmp;

                /* Expand environment variable references */
                format_size=ExpandEnvironmentStringsA(format,NULL,0);
                tmp=HeapAlloc(GetProcessHeap(), 0, format_size);
                ExpandEnvironmentStringsA(format,tmp,format_size);
                HeapFree(GetProcessHeap(), 0, format);
                format=tmp;
            }
            HeapFree( GetProcessHeap(), 0, data );
        }
247

248 249 250
        RtlInitUnicodeString( &nameW, AutoW );
        if (!NtQueryValueKey( hDbgConf, &nameW, KeyValuePartialInformation,
                              buffer, sizeof(buffer)-sizeof(WCHAR), &format_size ))
251
       {
252 253 254 255 256 257 258 259
           info = (KEY_VALUE_PARTIAL_INFORMATION *)buffer;
           if (info->Type == REG_DWORD) memcpy( &bAuto, info->Data, sizeof(DWORD) );
           else if (info->Type == REG_SZ)
           {
               WCHAR *str = (WCHAR *)info->Data;
               str[info->DataLength/sizeof(WCHAR)] = 0;
               bAuto = atoiW( str );
           }
260
       }
261 262

       NtClose(hDbgConf);
263 264 265 266
    }

    if (format)
    {
267 268 269
        size_t format_size = strlen(format) + 2*20;
        cmdline = HeapAlloc(GetProcessHeap(), 0, format_size);
        snprintf(cmdline, format_size, format, (long)GetCurrentProcessId(), (long)HandleToLong(hEvent));
270 271 272 273 274
        HeapFree(GetProcessHeap(), 0, format);
    }
    else
    {
        cmdline = HeapAlloc(GetProcessHeap(), 0, 80);
275 276
        snprintf(cmdline, 80, "winedbg --auto %ld %ld", /* as in tools/wine.inf */
                 (long)GetCurrentProcessId(), (long)HandleToLong(hEvent));
277 278
    }

279 280
    if (!bAuto)
    {
281 282 283 284 285 286
	HMODULE			mod = GetModuleHandleA( "user32.dll" );
	MessageBoxA_funcptr	pMessageBoxA = NULL;

	if (mod) pMessageBoxA = (MessageBoxA_funcptr)GetProcAddress( mod, "MessageBoxA" );
	if (pMessageBoxA)
	{
287 288 289 290
            static const char msg[] = ".\nDo you wish to debug it?";

            format_exception_msg( epointers, buffer, sizeof(buffer)-sizeof(msg) );
            strcat( buffer, msg );
291 292 293
	    if (pMessageBoxA( 0, buffer, "Exception raised", MB_YESNO | MB_ICONHAND ) == IDNO)
	    {
		TRACE("Killing process\n");
294
		goto EXIT;
295 296
	    }
	}
297
    }
298

299
    /* make WINEDEBUG empty in the environment */
300 301 302 303 304
    env = GetEnvironmentStringsA();
    for (p = env; *p; p += strlen(p) + 1)
    {
        if (!memcmp( p, "WINEDEBUG=", sizeof("WINEDEBUG=")-1 ))
        {
305 306
            char *next = p + strlen(p);
            char *end = next + 1;
307
            while (*end) end += strlen(end) + 1;
308
            memmove( p + sizeof("WINEDEBUG=") - 1, next, end + 1 - next );
309 310 311 312
            break;
        }
    }

313 314 315 316 317
    TRACE("Starting debugger %s\n", debugstr_a(cmdline));
    memset(&startup, 0, sizeof(startup));
    startup.cb = sizeof(startup);
    startup.dwFlags = STARTF_USESHOWWINDOW;
    startup.wShowWindow = SW_SHOWNORMAL;
318 319
    ret = CreateProcessA(NULL, cmdline, NULL, NULL, TRUE, 0, env, NULL, &startup, &info);
    FreeEnvironmentStringsA( env );
320

321 322 323 324 325 326 327 328 329 330
    if (ret)
    {
        /* wait for debugger to come up... */
        HANDLE handles[2];
        CloseHandle(info.hThread);
        handles[0]=hEvent;
        handles[1]=info.hProcess;
        WaitForMultipleObjects(2, handles, FALSE, INFINITE);
        CloseHandle(info.hProcess);
    }
331
    else ERR("Couldn't start debugger (%s) (%d)\n"
332 333
             "Read the Wine Developers Guide on how to set up winedbg or another debugger\n",
             debugstr_a(cmdline), GetLastError());
334
EXIT:
335
    HeapFree(GetProcessHeap(), 0, cmdline);
336
    return ret;
337 338 339 340 341
}

/******************************************************************
 *		start_debugger_atomic
 *
342
 * starts the debugger in an atomic way:
343
 *	- either the debugger is not started and it is started
344 345
 *	- or the debugger has already been started by another thread
 *	- or the debugger couldn't be started
346
 *
347
 * returns TRUE for the two first conditions, FALSE for the last
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
 */
static	int	start_debugger_atomic(PEXCEPTION_POINTERS epointers)
{
    static HANDLE	hRunOnce /* = 0 */;

    if (hRunOnce == 0)
    {
	OBJECT_ATTRIBUTES	attr;
	HANDLE			hEvent;

	attr.Length                   = sizeof(attr);
	attr.RootDirectory            = 0;
	attr.Attributes               = OBJ_INHERIT;
	attr.ObjectName               = NULL;
	attr.SecurityDescriptor       = NULL;
	attr.SecurityQualityOfService = NULL;

365 366
	/* ask for manual reset, so that once the debugger is started,
	 * every thread will know it */
367
	NtCreateEvent( &hEvent, EVENT_ALL_ACCESS, &attr, NotificationEvent, FALSE );
368
        if (InterlockedCompareExchangePointer( &hRunOnce, hEvent, 0 ) == 0)
369 370 371 372 373 374 375 376 377 378 379 380
	{
	    /* ok, our event has been set... we're the winning thread */
	    BOOL	ret = start_debugger( epointers, hRunOnce );
	    DWORD	tmp;

	    if (!ret)
	    {
		/* so that the other threads won't be stuck */
		NtSetEvent( hRunOnce, &tmp );
	    }
	    return ret;
	}
381

382 383 384
	/* someone beat us here... */
	CloseHandle( hEvent );
    }
385

386 387
    /* and wait for the winner to have actually created the debugger */
    WaitForSingleObject( hRunOnce, INFINITE );
388 389 390
    /* in fact, here, we only know that someone has tried to start the debugger,
     * we'll know by reposting the exception if it has actually attached
     * to the current process */
391 392 393 394
    return TRUE;
}


395 396 397 398 399 400 401
/*******************************************************************
 *         check_resource_write
 *
 * Check if the exception is a write attempt to the resource data.
 * If yes, we unprotect the resources to let broken apps continue
 * (Windows does this too).
 */
402
static inline BOOL check_resource_write( void *addr )
403
{
404
    void *rsrc;
405 406 407 408
    DWORD size;
    MEMORY_BASIC_INFORMATION info;

    if (!VirtualQuery( addr, &info, sizeof(info) )) return FALSE;
Eric Pouech's avatar
Eric Pouech committed
409
    if (info.State == MEM_FREE || !(info.Type & MEM_IMAGE)) return FALSE;
410
    if (!(rsrc = RtlImageDirectoryEntryToData( info.AllocationBase, TRUE,
411 412 413
                                              IMAGE_DIRECTORY_ENTRY_RESOURCE, &size )))
        return FALSE;
    if (addr < rsrc || (char *)addr >= (char *)rsrc + size) return FALSE;
414
    TRACE( "Broken app is writing to the resource data, enabling work-around\n" );
415
    VirtualProtect( rsrc, size, PAGE_READWRITE, NULL );
416 417 418 419
    return TRUE;
}


420 421 422
/*******************************************************************
 *         UnhandledExceptionFilter   (KERNEL32.@)
 */
423
LONG WINAPI UnhandledExceptionFilter(PEXCEPTION_POINTERS epointers)
424
{
425 426 427 428 429 430
    const EXCEPTION_RECORD *rec = epointers->ExceptionRecord;

    if (rec->ExceptionCode == EXCEPTION_ACCESS_VIOLATION && rec->NumberParameters >= 2)
    {
        switch(rec->ExceptionInformation[0])
        {
431
        case EXCEPTION_WRITE_FAULT:
432 433 434 435 436
            if (check_resource_write( (void *)rec->ExceptionInformation[1] ))
                return EXCEPTION_CONTINUE_EXECUTION;
            break;
        }
    }
437

438
    if (!NtCurrentTeb()->Peb->BeingDebugged)
439
    {
440
        if (rec->ExceptionCode == CONTROL_C_EXIT)
441 442 443 444
        {
            /* do not launch the debugger on ^C, simply terminate the process */
            TerminateProcess( GetCurrentProcess(), 1 );
        }
445

446 447
        if (top_filter)
        {
448
            LONG ret = top_filter( epointers );
449 450
            if (ret != EXCEPTION_CONTINUE_SEARCH) return ret;
        }
451

452
        /* FIXME: Should check the current error mode */
453

454 455
        if (!start_debugger_atomic( epointers ) || !NtCurrentTeb()->Peb->BeingDebugged)
            return EXCEPTION_EXECUTE_HANDLER;
456
    }
457
    return EXCEPTION_CONTINUE_SEARCH;
Alexandre Julliard's avatar
Alexandre Julliard committed
458 459
}

Alexandre Julliard's avatar
Alexandre Julliard committed
460

461
/***********************************************************************
462
 *            SetUnhandledExceptionFilter   (KERNEL32.@)
Alexandre Julliard's avatar
Alexandre Julliard committed
463
 */
Alexandre Julliard's avatar
Alexandre Julliard committed
464
LPTOP_LEVEL_EXCEPTION_FILTER WINAPI SetUnhandledExceptionFilter(
Alexandre Julliard's avatar
Alexandre Julliard committed
465 466
                                          LPTOP_LEVEL_EXCEPTION_FILTER filter )
{
467 468
    LPTOP_LEVEL_EXCEPTION_FILTER old = top_filter;
    top_filter = filter;
Alexandre Julliard's avatar
Alexandre Julliard committed
469
    return old;
Alexandre Julliard's avatar
Alexandre Julliard committed
470
}
471 472


473
/**************************************************************************
474
 *           FatalAppExitA   (KERNEL32.@)
475 476 477
 */
void WINAPI FatalAppExitA( UINT action, LPCSTR str )
{
478 479 480
    HMODULE mod = GetModuleHandleA( "user32.dll" );
    MessageBoxA_funcptr pMessageBoxA = NULL;

481
    WARN("AppExit\n");
482 483 484 485

    if (mod) pMessageBoxA = (MessageBoxA_funcptr)GetProcAddress( mod, "MessageBoxA" );
    if (pMessageBoxA) pMessageBoxA( 0, str, NULL, MB_SYSTEMMODAL | MB_OK );
    else ERR( "%s\n", debugstr_a(str) );
486 487 488 489 490
    ExitProcess(0);
}


/**************************************************************************
491
 *           FatalAppExitW   (KERNEL32.@)
492 493 494
 */
void WINAPI FatalAppExitW( UINT action, LPCWSTR str )
{
495 496 497
    static const WCHAR User32DllW[] = {'u','s','e','r','3','2','.','d','l','l',0};

    HMODULE mod = GetModuleHandleW( User32DllW );
498 499
    MessageBoxW_funcptr pMessageBoxW = NULL;

500
    WARN("AppExit\n");
501 502 503 504

    if (mod) pMessageBoxW = (MessageBoxW_funcptr)GetProcAddress( mod, "MessageBoxW" );
    if (pMessageBoxW) pMessageBoxW( 0, str, NULL, MB_SYSTEMMODAL | MB_OK );
    else ERR( "%s\n", debugstr_w(str) );
505 506
    ExitProcess(0);
}
Robert Shearman's avatar
Robert Shearman committed
507 508 509 510 511 512 513 514 515 516


/**************************************************************************
 *           FatalExit   (KERNEL32.@)
 */
void WINAPI FatalExit(int ExitCode)
{
    WARN("FatalExit\n");
    ExitProcess(ExitCode);
}