git.oblomov.eu Git - wine/blob - dlls/kernel/except.c

   1 /*
   2  * Win32 exception functions
   3  *
   4  * Copyright (c) 1996 Onno Hovers, (onno@stack.urc.tue.nl)
   5  * Copyright (c) 1999 Alexandre Julliard
   6  *
   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.
  11  *
  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.
  16  *
  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  * Notes:
  22  *  What really happens behind the scenes of those new
  23  *  __try{...}__except(..){....}  and
  24  *  __try{...}__finally{...}
  25  *  statements is simply not documented by Microsoft. There could be different
  26  *  reasons for this:
  27  *  One reason could be that they try to hide the fact that exception
  28  *  handling in Win32 looks almost the same as in OS/2 2.x.
  29  *  Another reason could be that Microsoft does not want others to write
  30  *  binary compatible implementations of the Win32 API (like us).
  31  *
  32  *  Whatever the reason, THIS SUCKS!! Ensuring portability or future
  33  *  compatibility may be valid reasons to keep some things undocumented.
  34  *  But exception handling is so basic to Win32 that it should be
  35  *  documented!
  36  *
  37  */
  38 #include "config.h"
  39 #include "wine/port.h"
  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 "winerror.h"
  48 #include "winternl.h"
  49 #include "wingdi.h"
  50 #include "winuser.h"
  51 #include "wine/exception.h"
  52 #include "wine/library.h"
  53 #include "excpt.h"
  54 #include "wine/unicode.h"
  55 #include "wine/debug.h"
  56
  57 WINE_DEFAULT_DEBUG_CHANNEL(seh);
  58
  59 static PTOP_LEVEL_EXCEPTION_FILTER top_filter;
  60
  61 typedef INT (WINAPI *MessageBoxA_funcptr)(HWND,LPCSTR,LPCSTR,UINT);
  62 typedef INT (WINAPI *MessageBoxW_funcptr)(HWND,LPCWSTR,LPCWSTR,UINT);
  63
  64 /*******************************************************************
  65  *         RaiseException  (KERNEL32.@)
  66  */
  67 void WINAPI RaiseException( DWORD code, DWORD flags, DWORD nbargs, const ULONG_PTR *args )
  68 {
  69     EXCEPTION_RECORD record;
  70
  71     /* Compose an exception record */
  72
  73     record.ExceptionCode    = code;
  74     record.ExceptionFlags   = flags & EH_NONCONTINUABLE;
  75     record.ExceptionRecord  = NULL;
  76     record.ExceptionAddress = RaiseException;
  77     if (nbargs && args)
  78     {
  79         if (nbargs > EXCEPTION_MAXIMUM_PARAMETERS) nbargs = EXCEPTION_MAXIMUM_PARAMETERS;
  80         record.NumberParameters = nbargs;
  81         memcpy( record.ExceptionInformation, args, nbargs * sizeof(*args) );
  82     }
  83     else record.NumberParameters = 0;
  84
  85     RtlRaiseException( &record );
  86 }
  87
  88
  89 /*******************************************************************
  90  *         format_exception_msg
  91  */
  92 static int format_exception_msg( const EXCEPTION_POINTERS *ptr, char *buffer, int size )
  93 {
  94     const EXCEPTION_RECORD *rec = ptr->ExceptionRecord;
  95     int len,len2;
  96
  97     switch(rec->ExceptionCode)
  98     {
  99     case EXCEPTION_INT_DIVIDE_BY_ZERO:
 100         len = snprintf( buffer, size, "Unhandled division by zero" );
 101         break;
 102     case EXCEPTION_INT_OVERFLOW:
 103         len = snprintf( buffer, size, "Unhandled overflow" );
 104         break;
 105     case EXCEPTION_ARRAY_BOUNDS_EXCEEDED:
 106         len = snprintf( buffer, size, "Unhandled array bounds" );
 107         break;
 108     case EXCEPTION_ILLEGAL_INSTRUCTION:
 109         len = snprintf( buffer, size, "Unhandled illegal instruction" );
 110         break;
 111     case EXCEPTION_STACK_OVERFLOW:
 112         len = snprintf( buffer, size, "Unhandled stack overflow" );
 113         break;
 114     case EXCEPTION_PRIV_INSTRUCTION:
 115         len = snprintf( buffer, size, "Unhandled privileged instruction" );
 116         break;
 117     case EXCEPTION_ACCESS_VIOLATION:
 118         if (rec->NumberParameters == 2)
 119             len = snprintf( buffer, size, "Unhandled page fault on %s access to 0x%08lx",
 120                      rec->ExceptionInformation[0] ? "write" : "read",
 121                      rec->ExceptionInformation[1]);
 122         else
 123             len = snprintf( buffer, size, "Unhandled page fault");
 124         break;
 125     case EXCEPTION_DATATYPE_MISALIGNMENT:
 126         len = snprintf( buffer, size, "Unhandled alignment" );
 127         break;
 128     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                  rec->ExceptionInformation[0]);
 134         break;
 135     case EXCEPTION_WINE_STUB:
 136         if (HIWORD(rec->ExceptionInformation[1]))
 137             len = snprintf( buffer, size, "Unimplemented function %s.%s called",
 138                             (char *)rec->ExceptionInformation[0], (char *)rec->ExceptionInformation[1] );
 139         else
 140             len = snprintf( buffer, size, "Unimplemented function %s.%ld called",
 141                             (char *)rec->ExceptionInformation[0], rec->ExceptionInformation[1] );
 142         break;
 143     case EXCEPTION_WINE_ASSERTION:
 144         len = snprintf( buffer, size, "Assertion failed" );
 145         break;
 146     case EXCEPTION_VM86_INTx:
 147         len = snprintf( buffer, size, "Unhandled interrupt %02lx in vm86 mode",
 148                  rec->ExceptionInformation[0]);
 149         break;
 150     case EXCEPTION_VM86_STI:
 151         len = snprintf( buffer, size, "Unhandled sti in vm86 mode");
 152         break;
 153     case EXCEPTION_VM86_PICRETURN:
 154         len = snprintf( buffer, size, "Unhandled PIC return in vm86 mode");
 155         break;
 156     default:
 157         len = snprintf( buffer, size, "Unhandled exception 0x%08lx", rec->ExceptionCode);
 158         break;
 159     }
 160     if ((len<0) || (len>=size))
 161         return -1;
 162 #ifdef __i386__
 163     if (ptr->ContextRecord->SegCs != wine_get_cs())
 164         len2 = snprintf(buffer+len, size-len, " at address 0x%04lx:0x%08lx",
 165                         ptr->ContextRecord->SegCs,
 166                         (DWORD)ptr->ExceptionRecord->ExceptionAddress);
 167     else
 168 #endif
 169         len2 = snprintf(buffer+len, size-len, " at address %p",
 170                         ptr->ExceptionRecord->ExceptionAddress);
 171     if ((len2<0) || (len>=size-len))
 172         return -1;
 173     return len+len2;
 174 }
 175
 176
 177 /******************************************************************
 178  *              start_debugger
 179  *
 180  * Does the effective debugger startup according to 'format'
 181  */
 182 static BOOL     start_debugger(PEXCEPTION_POINTERS epointers, HANDLE hEvent)
 183 {
 184     OBJECT_ATTRIBUTES attr;
 185     UNICODE_STRING nameW;
 186     char *cmdline, *env, *p;
 187     HANDLE              hDbgConf;
 188     DWORD               bAuto = FALSE;
 189     PROCESS_INFORMATION info;
 190     STARTUPINFOA        startup;
 191     char*               format = NULL;
 192     BOOL                ret = FALSE;
 193     char buffer[256];
 194
 195     static const WCHAR AeDebugW[] = {'M','a','c','h','i','n','e','\\',
 196                                      'S','o','f','t','w','a','r','e','\\',
 197                                      'M','i','c','r','o','s','o','f','t','\\',
 198                                      'W','i','n','d','o','w','s',' ','N','T','\\',
 199                                      'C','u','r','r','e','n','t','V','e','r','s','i','o','n','\\',
 200                                      'A','e','D','e','b','u','g',0};
 201     static const WCHAR DebuggerW[] = {'D','e','b','u','g','g','e','r',0};
 202     static const WCHAR AutoW[] = {'A','u','t','o',0};
 203
 204     format_exception_msg( epointers, buffer, sizeof(buffer) );
 205     MESSAGE("wine: %s (thread %04lx), starting debugger...\n", buffer, GetCurrentThreadId());
 206
 207     attr.Length = sizeof(attr);
 208     attr.RootDirectory = 0;
 209     attr.ObjectName = &nameW;
 210     attr.Attributes = 0;
 211     attr.SecurityDescriptor = NULL;
 212     attr.SecurityQualityOfService = NULL;
 213     RtlInitUnicodeString( &nameW, AeDebugW );
 214
 215     if (!NtOpenKey( &hDbgConf, KEY_ALL_ACCESS, &attr ))
 216     {
 217         char buffer[64];
 218         KEY_VALUE_PARTIAL_INFORMATION *info;
 219         DWORD format_size = 0;
 220
 221         RtlInitUnicodeString( &nameW, DebuggerW );
 222         if (NtQueryValueKey( hDbgConf, &nameW, KeyValuePartialInformation,
 223                              NULL, 0, &format_size ) == STATUS_BUFFER_OVERFLOW)
 224         {
 225             char *data = HeapAlloc(GetProcessHeap(), 0, format_size);
 226             NtQueryValueKey( hDbgConf, &nameW, KeyValuePartialInformation,
 227                              data, format_size, &format_size );
 228             info = (KEY_VALUE_PARTIAL_INFORMATION *)data;
 229             RtlUnicodeToMultiByteSize( &format_size, (WCHAR *)info->Data, info->DataLength );
 230             format = HeapAlloc( GetProcessHeap(), 0, format_size+1 );
 231             RtlUnicodeToMultiByteN( format, format_size, NULL,
 232                                     (WCHAR *)info->Data, info->DataLength );
 233             format[format_size] = 0;
 234
 235             if (info->Type == REG_EXPAND_SZ)
 236             {
 237                 char* tmp;
 238
 239                 /* Expand environment variable references */
 240                 format_size=ExpandEnvironmentStringsA(format,NULL,0);
 241                 tmp=HeapAlloc(GetProcessHeap(), 0, format_size);
 242                 ExpandEnvironmentStringsA(format,tmp,format_size);
 243                 HeapFree(GetProcessHeap(), 0, format);
 244                 format=tmp;
 245             }
 246             HeapFree( GetProcessHeap(), 0, data );
 247         }
 248
 249         RtlInitUnicodeString( &nameW, AutoW );
 250         if (!NtQueryValueKey( hDbgConf, &nameW, KeyValuePartialInformation,
 251                               buffer, sizeof(buffer)-sizeof(WCHAR), &format_size ))
 252        {
 253            info = (KEY_VALUE_PARTIAL_INFORMATION *)buffer;
 254            if (info->Type == REG_DWORD) memcpy( &bAuto, info->Data, sizeof(DWORD) );
 255            else if (info->Type == REG_SZ)
 256            {
 257                WCHAR *str = (WCHAR *)info->Data;
 258                str[info->DataLength/sizeof(WCHAR)] = 0;
 259                bAuto = atoiW( str );
 260            }
 261        }
 262        else bAuto = TRUE;
 263
 264        NtClose(hDbgConf);
 265     }
 266
 267     if (format)
 268     {
 269         cmdline = HeapAlloc(GetProcessHeap(), 0, strlen(format) + 2*20);
 270         sprintf(cmdline, format, GetCurrentProcessId(), hEvent);
 271         HeapFree(GetProcessHeap(), 0, format);
 272     }
 273     else
 274     {
 275         cmdline = HeapAlloc(GetProcessHeap(), 0, 80);
 276         sprintf(cmdline, "winedbg --auto %ld %ld",
 277                 GetCurrentProcessId(), (ULONG_PTR)hEvent);
 278     }
 279
 280     if (!bAuto)
 281     {
 282         HMODULE                 mod = GetModuleHandleA( "user32.dll" );
 283         MessageBoxA_funcptr     pMessageBoxA = NULL;
 284
 285         if (mod) pMessageBoxA = (MessageBoxA_funcptr)GetProcAddress( mod, "MessageBoxA" );
 286         if (pMessageBoxA)
 287         {
 288             static const char msg[] = ".\nDo you wish to debug it?";
 289             char buffer[256];
 290
 291             format_exception_msg( epointers, buffer, sizeof(buffer)-sizeof(msg) );
 292             strcat( buffer, msg );
 293             if (pMessageBoxA( 0, buffer, "Exception raised", MB_YESNO | MB_ICONHAND ) == IDNO)
 294             {
 295                 TRACE("Killing process\n");
 296                 goto EXIT;
 297             }
 298         }
 299     }
 300
 301     /* make WINEDEBUG empty in the environment */
 302     env = GetEnvironmentStringsA();
 303     for (p = env; *p; p += strlen(p) + 1)
 304     {
 305         if (!memcmp( p, "WINEDEBUG=", sizeof("WINEDEBUG=")-1 ))
 306         {
 307             char *next = p + strlen(p);
 308             char *end = next + 1;
 309             while (*end) end += strlen(end) + 1;
 310             memmove( p + sizeof("WINEDEBUG=") - 1, next, end + 1 - next );
 311             break;
 312         }
 313     }
 314
 315     TRACE("Starting debugger %s\n", debugstr_a(cmdline));
 316     memset(&startup, 0, sizeof(startup));
 317     startup.cb = sizeof(startup);
 318     startup.dwFlags = STARTF_USESHOWWINDOW;
 319     startup.wShowWindow = SW_SHOWNORMAL;
 320     ret = CreateProcessA(NULL, cmdline, NULL, NULL, TRUE, 0, env, NULL, &startup, &info);
 321     FreeEnvironmentStringsA( env );
 322
 323     if (ret) WaitForSingleObject(hEvent, INFINITE);  /* wait for debugger to come up... */
 324     else ERR("Couldn't start debugger (%s) (%ld)\n"
 325              "Read the Wine Developers Guide on how to set up winedbg or another debugger\n",
 326              debugstr_a(cmdline), GetLastError());
 327 EXIT:
 328     HeapFree(GetProcessHeap(), 0, cmdline);
 329     return ret;
 330 }
 331
 332 /******************************************************************
 333  *              start_debugger_atomic
 334  *
 335  * starts the debugger in an atomic way:
 336  *      - either the debugger is not started and it is started
 337  *      - or the debugger has already been started by another thread
 338  *      - or the debugger couldn't be started
 339  *
 340  * returns TRUE for the two first conditions, FALSE for the last
 341  */
 342 static  int     start_debugger_atomic(PEXCEPTION_POINTERS epointers)
 343 {
 344     static HANDLE       hRunOnce /* = 0 */;
 345
 346     if (hRunOnce == 0)
 347     {
 348         OBJECT_ATTRIBUTES       attr;
 349         HANDLE                  hEvent;
 350
 351         attr.Length                   = sizeof(attr);
 352         attr.RootDirectory            = 0;
 353         attr.Attributes               = OBJ_INHERIT;
 354         attr.ObjectName               = NULL;
 355         attr.SecurityDescriptor       = NULL;
 356         attr.SecurityQualityOfService = NULL;
 357
 358         /* ask for manual reset, so that once the debugger is started,
 359          * every thread will know it */
 360         NtCreateEvent( &hEvent, EVENT_ALL_ACCESS, &attr, TRUE, FALSE );
 361         if (InterlockedCompareExchangePointer( (PVOID)&hRunOnce, hEvent, 0 ) == 0)
 362         {
 363             /* ok, our event has been set... we're the winning thread */
 364             BOOL        ret = start_debugger( epointers, hRunOnce );
 365             DWORD       tmp;
 366
 367             if (!ret)
 368             {
 369                 /* so that the other threads won't be stuck */
 370                 NtSetEvent( hRunOnce, &tmp );
 371             }
 372             return ret;
 373         }
 374
 375         /* someone beat us here... */
 376         CloseHandle( hEvent );
 377     }
 378
 379     /* and wait for the winner to have actually created the debugger */
 380     WaitForSingleObject( hRunOnce, INFINITE );
 381     /* in fact, here, we only know that someone has tried to start the debugger,
 382      * we'll know by reposting the exception if it has actually attached
 383      * to the current process */
 384     return TRUE;
 385 }
 386
 387
 388 /*******************************************************************
 389  *         check_resource_write
 390  *
 391  * Check if the exception is a write attempt to the resource data.
 392  * If yes, we unprotect the resources to let broken apps continue
 393  * (Windows does this too).
 394  */
 395 inline static BOOL check_resource_write( const EXCEPTION_RECORD *rec )
 396 {
 397     void *addr, *rsrc;
 398     DWORD size;
 399     MEMORY_BASIC_INFORMATION info;
 400
 401     if (rec->ExceptionCode != EXCEPTION_ACCESS_VIOLATION) return FALSE;
 402     if (rec->NumberParameters < 2) return FALSE;
 403     if (!rec->ExceptionInformation[0]) return FALSE;  /* not a write access */
 404     addr = (void *)rec->ExceptionInformation[1];
 405     if (!VirtualQuery( addr, &info, sizeof(info) )) return FALSE;
 406     if (info.State == MEM_FREE) return FALSE;
 407     if (!(rsrc = RtlImageDirectoryEntryToData( (HMODULE)info.AllocationBase, TRUE,
 408                                               IMAGE_DIRECTORY_ENTRY_RESOURCE, &size )))
 409         return FALSE;
 410     if (addr < rsrc || (char *)addr >= (char *)rsrc + size) return FALSE;
 411     TRACE( "Broken app is writing to the resource data, enabling work-around\n" );
 412     VirtualProtect( rsrc, size, PAGE_WRITECOPY, NULL );
 413     return TRUE;
 414 }
 415
 416
 417 /*******************************************************************
 418  *         UnhandledExceptionFilter   (KERNEL32.@)
 419  */
 420 DWORD WINAPI UnhandledExceptionFilter(PEXCEPTION_POINTERS epointers)
 421 {
 422     if (check_resource_write( epointers->ExceptionRecord )) return EXCEPTION_CONTINUE_EXECUTION;
 423
 424     if (!NtCurrentTeb()->Peb->BeingDebugged)
 425     {
 426         if (epointers->ExceptionRecord->ExceptionCode == CONTROL_C_EXIT)
 427         {
 428             /* do not launch the debugger on ^C, simply terminate the process */
 429             TerminateProcess( GetCurrentProcess(), 1 );
 430         }
 431
 432         if (top_filter)
 433         {
 434             DWORD ret = top_filter( epointers );
 435             if (ret != EXCEPTION_CONTINUE_SEARCH) return ret;
 436         }
 437
 438         /* FIXME: Should check the current error mode */
 439
 440         if (!start_debugger_atomic( epointers ) || !NtCurrentTeb()->Peb->BeingDebugged)
 441             return EXCEPTION_EXECUTE_HANDLER;
 442     }
 443     return EXCEPTION_CONTINUE_SEARCH;
 444 }
 445
 446
 447 /***********************************************************************
 448  *            SetUnhandledExceptionFilter   (KERNEL32.@)
 449  */
 450 LPTOP_LEVEL_EXCEPTION_FILTER WINAPI SetUnhandledExceptionFilter(
 451                                           LPTOP_LEVEL_EXCEPTION_FILTER filter )
 452 {
 453     LPTOP_LEVEL_EXCEPTION_FILTER old = top_filter;
 454     top_filter = filter;
 455     return old;
 456 }
 457
 458
 459 /**************************************************************************
 460  *           FatalAppExitA   (KERNEL32.@)
 461  */
 462 void WINAPI FatalAppExitA( UINT action, LPCSTR str )
 463 {
 464     HMODULE mod = GetModuleHandleA( "user32.dll" );
 465     MessageBoxA_funcptr pMessageBoxA = NULL;
 466
 467     WARN("AppExit\n");
 468
 469     if (mod) pMessageBoxA = (MessageBoxA_funcptr)GetProcAddress( mod, "MessageBoxA" );
 470     if (pMessageBoxA) pMessageBoxA( 0, str, NULL, MB_SYSTEMMODAL | MB_OK );
 471     else ERR( "%s\n", debugstr_a(str) );
 472     ExitProcess(0);
 473 }
 474
 475
 476 /**************************************************************************
 477  *           FatalAppExitW   (KERNEL32.@)
 478  */
 479 void WINAPI FatalAppExitW( UINT action, LPCWSTR str )
 480 {
 481     static const WCHAR User32DllW[] = {'u','s','e','r','3','2','.','d','l','l',0};
 482
 483     HMODULE mod = GetModuleHandleW( User32DllW );
 484     MessageBoxW_funcptr pMessageBoxW = NULL;
 485
 486     WARN("AppExit\n");
 487
 488     if (mod) pMessageBoxW = (MessageBoxW_funcptr)GetProcAddress( mod, "MessageBoxW" );
 489     if (pMessageBoxW) pMessageBoxW( 0, str, NULL, MB_SYSTEMMODAL | MB_OK );
 490     else ERR( "%s\n", debugstr_w(str) );
 491     ExitProcess(0);
 492 }
 493
 494
 495 /**************************************************************************
 496  *           FatalExit   (KERNEL32.@)
 497  */
 498 void WINAPI FatalExit(int ExitCode)
 499 {
 500     WARN("FatalExit\n");
 501     ExitProcess(ExitCode);
 502 }