dlls/msvcrt/except.c

   1 /*
   2  * msvcrt.dll exception handling
   3  *
   4  * Copyright 2000 Jon Griffiths
   5  * Copyright 2005 Juan Lang
   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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  *
  21  * FIXME: Incomplete support for nested exceptions/try block cleanup.
  22  */
  23
  24 #include <stdarg.h>
  25 #include <stdbool.h>
  26
  27 #include "ntstatus.h"
  28 #define WIN32_NO_STATUS
  29 #include "windef.h"
  30 #include "winbase.h"
  31 #include "winternl.h"
  32 #include "wine/exception.h"
  33 #include "msvcrt.h"
  34 #include "excpt.h"
  35 #include "wincon.h"
  36 #include "wine/debug.h"
  37
  38 #include "cppexcept.h"
  39
  40 WINE_DEFAULT_DEBUG_CHANNEL(seh);
  41
  42 #if _MSVCR_VER>=70 && _MSVCR_VER<=71
  43 static MSVCRT_security_error_handler security_error_handler;
  44 #endif
  45
  46 static MSVCRT___sighandler_t sighandlers[MSVCRT_NSIG] = { MSVCRT_SIG_DFL };
  47
  48 static BOOL WINAPI msvcrt_console_handler(DWORD ctrlType)
  49 {
  50     BOOL ret = FALSE;
  51
  52     switch (ctrlType)
  53     {
  54     case CTRL_C_EVENT:
  55         if (sighandlers[MSVCRT_SIGINT])
  56         {
  57             if (sighandlers[MSVCRT_SIGINT] != MSVCRT_SIG_IGN)
  58                 sighandlers[MSVCRT_SIGINT](MSVCRT_SIGINT);
  59             ret = TRUE;
  60         }
  61         break;
  62     }
  63     return ret;
  64 }
  65
  66 /*********************************************************************
  67  *              __pxcptinfoptrs (MSVCRT.@)
  68  */
  69 void** CDECL MSVCRT___pxcptinfoptrs(void)
  70 {
  71     return (void**)&msvcrt_get_thread_data()->xcptinfo;
  72 }
  73
  74 typedef void (CDECL *float_handler)(int, int);
  75
  76 /* The exception codes are actually NTSTATUS values */
  77 static const struct
  78 {
  79     NTSTATUS status;
  80     int signal;
  81 } float_exception_map[] = {
  82  { EXCEPTION_FLT_DENORMAL_OPERAND, MSVCRT__FPE_DENORMAL },
  83  { EXCEPTION_FLT_DIVIDE_BY_ZERO, MSVCRT__FPE_ZERODIVIDE },
  84  { EXCEPTION_FLT_INEXACT_RESULT, MSVCRT__FPE_INEXACT },
  85  { EXCEPTION_FLT_INVALID_OPERATION, MSVCRT__FPE_INVALID },
  86  { EXCEPTION_FLT_OVERFLOW, MSVCRT__FPE_OVERFLOW },
  87  { EXCEPTION_FLT_STACK_CHECK, MSVCRT__FPE_STACKOVERFLOW },
  88  { EXCEPTION_FLT_UNDERFLOW, MSVCRT__FPE_UNDERFLOW },
  89 };
  90
  91 static LONG msvcrt_exception_filter(struct _EXCEPTION_POINTERS *except)
  92 {
  93     LONG ret = EXCEPTION_CONTINUE_SEARCH;
  94     MSVCRT___sighandler_t handler;
  95
  96     if (!except || !except->ExceptionRecord)
  97         return EXCEPTION_CONTINUE_SEARCH;
  98
  99     switch (except->ExceptionRecord->ExceptionCode)
 100     {
 101     case EXCEPTION_ACCESS_VIOLATION:
 102         if ((handler = sighandlers[MSVCRT_SIGSEGV]) != MSVCRT_SIG_DFL)
 103         {
 104             if (handler != MSVCRT_SIG_IGN)
 105             {
 106                 EXCEPTION_POINTERS **ep = (EXCEPTION_POINTERS**)MSVCRT___pxcptinfoptrs(), *old_ep;
 107
 108                 old_ep = *ep;
 109                 *ep = except;
 110                 sighandlers[MSVCRT_SIGSEGV] = MSVCRT_SIG_DFL;
 111                 handler(MSVCRT_SIGSEGV);
 112                 *ep = old_ep;
 113             }
 114             ret = EXCEPTION_CONTINUE_EXECUTION;
 115         }
 116         break;
 117     /* According to msdn,
 118      * the FPE signal handler takes as a second argument the type of
 119      * floating point exception.
 120      */
 121     case EXCEPTION_FLT_DENORMAL_OPERAND:
 122     case EXCEPTION_FLT_DIVIDE_BY_ZERO:
 123     case EXCEPTION_FLT_INEXACT_RESULT:
 124     case EXCEPTION_FLT_INVALID_OPERATION:
 125     case EXCEPTION_FLT_OVERFLOW:
 126     case EXCEPTION_FLT_STACK_CHECK:
 127     case EXCEPTION_FLT_UNDERFLOW:
 128         if ((handler = sighandlers[MSVCRT_SIGFPE]) != MSVCRT_SIG_DFL)
 129         {
 130             if (handler != MSVCRT_SIG_IGN)
 131             {
 132                 EXCEPTION_POINTERS **ep = (EXCEPTION_POINTERS**)MSVCRT___pxcptinfoptrs(), *old_ep;
 133                 unsigned int i;
 134                 int float_signal = MSVCRT__FPE_INVALID;
 135
 136                 sighandlers[MSVCRT_SIGFPE] = MSVCRT_SIG_DFL;
 137                 for (i = 0; i < ARRAY_SIZE(float_exception_map); i++)
 138                 {
 139                     if (float_exception_map[i].status ==
 140                         except->ExceptionRecord->ExceptionCode)
 141                     {
 142                         float_signal = float_exception_map[i].signal;
 143                         break;
 144                     }
 145                 }
 146
 147                 old_ep = *ep;
 148                 *ep = except;
 149                 ((float_handler)handler)(MSVCRT_SIGFPE, float_signal);
 150                 *ep = old_ep;
 151             }
 152             ret = EXCEPTION_CONTINUE_EXECUTION;
 153         }
 154         break;
 155     case EXCEPTION_ILLEGAL_INSTRUCTION:
 156     case EXCEPTION_PRIV_INSTRUCTION:
 157         if ((handler = sighandlers[MSVCRT_SIGILL]) != MSVCRT_SIG_DFL)
 158         {
 159             if (handler != MSVCRT_SIG_IGN)
 160             {
 161                 EXCEPTION_POINTERS **ep = (EXCEPTION_POINTERS**)MSVCRT___pxcptinfoptrs(), *old_ep;
 162
 163                 old_ep = *ep;
 164                 *ep = except;
 165                 sighandlers[MSVCRT_SIGILL] = MSVCRT_SIG_DFL;
 166                 handler(MSVCRT_SIGILL);
 167                 *ep = old_ep;
 168             }
 169             ret = EXCEPTION_CONTINUE_EXECUTION;
 170         }
 171         break;
 172     }
 173     return ret;
 174 }
 175
 176 void msvcrt_init_signals(void)
 177 {
 178     SetConsoleCtrlHandler(msvcrt_console_handler, TRUE);
 179 }
 180
 181 void msvcrt_free_signals(void)
 182 {
 183     SetConsoleCtrlHandler(msvcrt_console_handler, FALSE);
 184 }
 185
 186 /*********************************************************************
 187  *              signal (MSVCRT.@)
 188  * Some signals may never be generated except through an explicit call to
 189  * raise.
 190  */
 191 MSVCRT___sighandler_t CDECL MSVCRT_signal(int sig, MSVCRT___sighandler_t func)
 192 {
 193     MSVCRT___sighandler_t ret = MSVCRT_SIG_ERR;
 194
 195     TRACE("(%d, %p)\n", sig, func);
 196
 197     if (func == MSVCRT_SIG_ERR) return MSVCRT_SIG_ERR;
 198
 199     switch (sig)
 200     {
 201     /* Cases handled internally.  Note SIGTERM is never generated by Windows,
 202      * so we effectively mask it.
 203      */
 204     case MSVCRT_SIGABRT:
 205     case MSVCRT_SIGFPE:
 206     case MSVCRT_SIGILL:
 207     case MSVCRT_SIGSEGV:
 208     case MSVCRT_SIGINT:
 209     case MSVCRT_SIGTERM:
 210     case MSVCRT_SIGBREAK:
 211         ret = sighandlers[sig];
 212         sighandlers[sig] = func;
 213         break;
 214     default:
 215         ret = MSVCRT_SIG_ERR;
 216     }
 217     return ret;
 218 }
 219
 220 /*********************************************************************
 221  *              raise (MSVCRT.@)
 222  */
 223 int CDECL MSVCRT_raise(int sig)
 224 {
 225     MSVCRT___sighandler_t handler;
 226
 227     TRACE("(%d)\n", sig);
 228
 229     switch (sig)
 230     {
 231     case MSVCRT_SIGFPE:
 232     case MSVCRT_SIGILL:
 233     case MSVCRT_SIGSEGV:
 234         handler = sighandlers[sig];
 235         if (handler == MSVCRT_SIG_DFL) MSVCRT__exit(3);
 236         if (handler != MSVCRT_SIG_IGN)
 237         {
 238             EXCEPTION_POINTERS **ep = (EXCEPTION_POINTERS**)MSVCRT___pxcptinfoptrs(), *old_ep;
 239
 240             sighandlers[sig] = MSVCRT_SIG_DFL;
 241
 242             old_ep = *ep;
 243             *ep = NULL;
 244             if (sig == MSVCRT_SIGFPE)
 245                 ((float_handler)handler)(sig, MSVCRT__FPE_EXPLICITGEN);
 246             else
 247                 handler(sig);
 248             *ep = old_ep;
 249         }
 250         break;
 251     case MSVCRT_SIGABRT:
 252     case MSVCRT_SIGINT:
 253     case MSVCRT_SIGTERM:
 254     case MSVCRT_SIGBREAK:
 255         handler = sighandlers[sig];
 256         if (handler == MSVCRT_SIG_DFL) MSVCRT__exit(3);
 257         if (handler != MSVCRT_SIG_IGN)
 258         {
 259             sighandlers[sig] = MSVCRT_SIG_DFL;
 260             handler(sig);
 261         }
 262         break;
 263     default:
 264         return -1;
 265     }
 266     return 0;
 267 }
 268
 269 /*********************************************************************
 270  *              _XcptFilter (MSVCRT.@)
 271  */
 272 int CDECL _XcptFilter(NTSTATUS ex, PEXCEPTION_POINTERS ptr)
 273 {
 274     TRACE("(%08x,%p)\n", ex, ptr);
 275     /* I assume ptr->ExceptionRecord->ExceptionCode is the same as ex */
 276     return msvcrt_exception_filter(ptr);
 277 }
 278
 279 /*********************************************************************
 280  *              _abnormal_termination (MSVCRT.@)
 281  */
 282 int CDECL _abnormal_termination(void)
 283 {
 284   FIXME("(void)stub\n");
 285   return 0;
 286 }
 287
 288 /******************************************************************
 289  *              __uncaught_exception (MSVCRT.@)
 290  */
 291 BOOL CDECL MSVCRT___uncaught_exception(void)
 292 {
 293     return msvcrt_get_thread_data()->processing_throw != 0;
 294 }
 295
 296 #if _MSVCR_VER>=70 && _MSVCR_VER<=71
 297
 298 /*********************************************************************
 299  *              _set_security_error_handler (MSVCR70.@)
 300  */
 301 MSVCRT_security_error_handler CDECL _set_security_error_handler(
 302     MSVCRT_security_error_handler handler )
 303 {
 304     MSVCRT_security_error_handler old = security_error_handler;
 305
 306     TRACE("(%p)\n", handler);
 307
 308     security_error_handler = handler;
 309     return old;
 310 }
 311
 312 /*********************************************************************
 313  *              __security_error_handler (MSVCR70.@)
 314  */
 315 void CDECL __security_error_handler(int code, void *data)
 316 {
 317     if(security_error_handler)
 318         security_error_handler(code, data);
 319     else
 320         FIXME("(%d, %p) stub\n", code, data);
 321
 322     MSVCRT__exit(3);
 323 }
 324
 325 #endif /* _MSVCR_VER>=70 && _MSVCR_VER<=71 */
 326
 327 #if _MSVCR_VER>=110
 328 /*********************************************************************
 329  *  __crtSetUnhandledExceptionFilter (MSVCR110.@)
 330  */
 331 LPTOP_LEVEL_EXCEPTION_FILTER CDECL MSVCR110__crtSetUnhandledExceptionFilter(LPTOP_LEVEL_EXCEPTION_FILTER filter)
 332 {
 333     return SetUnhandledExceptionFilter(filter);
 334 }
 335 #endif
 336
 337 /*********************************************************************
 338  * _CreateFrameInfo (MSVCR80.@)
 339  */
 340 frame_info* CDECL _CreateFrameInfo(frame_info *fi, void *obj)
 341 {
 342     thread_data_t *data = msvcrt_get_thread_data();
 343
 344     TRACE("(%p, %p)\n", fi, obj);
 345
 346     fi->next = data->frame_info_head;
 347     data->frame_info_head = fi;
 348     fi->object = obj;
 349     return fi;
 350 }
 351
 352 /*********************************************************************
 353  * _FindAndUnlinkFrame (MSVCR80.@)
 354  */
 355 void CDECL _FindAndUnlinkFrame(frame_info *fi)
 356 {
 357     thread_data_t *data = msvcrt_get_thread_data();
 358     frame_info *cur = data->frame_info_head;
 359
 360     TRACE("(%p)\n", fi);
 361
 362     if (cur == fi)
 363     {
 364         data->frame_info_head = cur->next;
 365         return;
 366     }
 367
 368     for (; cur->next; cur = cur->next)
 369     {
 370         if (cur->next == fi)
 371         {
 372             cur->next = fi->next;
 373             return;
 374         }
 375     }
 376
 377     ERR("frame not found, native crashes in this case\n");
 378 }
 379
 380 /*********************************************************************
 381  *              _IsExceptionObjectToBeDestroyed (MSVCR80.@)
 382  */
 383 BOOL __cdecl _IsExceptionObjectToBeDestroyed(const void *obj)
 384 {
 385     frame_info *cur;
 386
 387     TRACE( "%p\n", obj );
 388
 389     for (cur = msvcrt_get_thread_data()->frame_info_head; cur; cur = cur->next)
 390     {
 391         if (cur->object == obj)
 392             return FALSE;
 393     }
 394
 395     return TRUE;
 396 }
 397
 398 /*********************************************************************
 399  * __DestructExceptionObject (MSVCRT.@)
 400  */
 401 void CDECL __DestructExceptionObject(EXCEPTION_RECORD *rec)
 402 {
 403     cxx_exception_type *info = (cxx_exception_type*) rec->ExceptionInformation[2];
 404     void *object = (void*)rec->ExceptionInformation[1];
 405
 406     TRACE("(%p)\n", rec);
 407
 408     if (rec->ExceptionCode != CXX_EXCEPTION) return;
 409 #ifndef __x86_64__
 410     if (rec->NumberParameters != 3) return;
 411 #else
 412     if (rec->NumberParameters != 4) return;
 413 #endif
 414     if (rec->ExceptionInformation[0] < CXX_FRAME_MAGIC_VC6 ||
 415             rec->ExceptionInformation[0] > CXX_FRAME_MAGIC_VC8) return;
 416
 417     if (!info || !info->destructor)
 418         return;
 419
 420 #if defined(__i386__)
 421     __asm__ __volatile__("call *%0" : : "r" (info->destructor), "c" (object) : "eax", "edx", "memory" );
 422 #elif defined(__x86_64__)
 423     ((void (__cdecl*)(void*))(info->destructor+rec->ExceptionInformation[3]))(object);
 424 #else
 425     ((void (__cdecl*)(void*))info->destructor)(object);
 426 #endif
 427 }
 428
 429 /*********************************************************************
 430  *  __CxxRegisterExceptionObject (MSVCRT.@)
 431  */
 432 BOOL CDECL __CxxRegisterExceptionObject(EXCEPTION_POINTERS *ep, cxx_frame_info *frame_info)
 433 {
 434     thread_data_t *data = msvcrt_get_thread_data();
 435
 436     TRACE("(%p, %p)\n", ep, frame_info);
 437
 438     if (!ep || !ep->ExceptionRecord)
 439     {
 440         frame_info->rec = (void*)-1;
 441         frame_info->context = (void*)-1;
 442         return TRUE;
 443     }
 444
 445     frame_info->rec = data->exc_record;
 446     frame_info->context = data->ctx_record;
 447     data->exc_record = ep->ExceptionRecord;
 448     data->ctx_record = ep->ContextRecord;
 449     _CreateFrameInfo(&frame_info->frame_info, (void*)ep->ExceptionRecord->ExceptionInformation[1]);
 450     return TRUE;
 451 }
 452
 453 /*********************************************************************
 454  *  __CxxUnregisterExceptionObject (MSVCRT.@)
 455  */
 456 void CDECL __CxxUnregisterExceptionObject(cxx_frame_info *frame_info, BOOL in_use)
 457 {
 458     thread_data_t *data = msvcrt_get_thread_data();
 459
 460     TRACE("(%p)\n", frame_info);
 461
 462     if(frame_info->rec == (void*)-1)
 463         return;
 464
 465     _FindAndUnlinkFrame(&frame_info->frame_info);
 466     if(data->exc_record->ExceptionCode == CXX_EXCEPTION && !in_use
 467             && _IsExceptionObjectToBeDestroyed((void*)data->exc_record->ExceptionInformation[1]))
 468         __DestructExceptionObject(data->exc_record);
 469     data->exc_record = frame_info->rec;
 470     data->ctx_record = frame_info->context;
 471 }
 472
 473 struct __std_exception_data {
 474     char *what;
 475     bool dofree;
 476 };
 477
 478 #if _MSVCR_VER>=140
 479
 480 /*********************************************************************
 481  *  __std_exception_copy (UCRTBASE.@)
 482  */
 483 void CDECL MSVCRT___std_exception_copy(const struct __std_exception_data *src,
 484                                        struct __std_exception_data *dst)
 485 {
 486     TRACE("(%p %p)\n", src, dst);
 487
 488     if(src->dofree && src->what) {
 489         dst->what   = MSVCRT__strdup(src->what);
 490         dst->dofree = 1;
 491     } else {
 492         dst->what   = src->what;
 493         dst->dofree = 0;
 494     }
 495 }
 496
 497 /*********************************************************************
 498  *  __std_exception_destroy (UCRTBASE.@)
 499  */
 500 void CDECL MSVCRT___std_exception_destroy(struct __std_exception_data *data)
 501 {
 502     TRACE("(%p)\n", data);
 503
 504     if(data->dofree)
 505         MSVCRT_free(data->what);
 506     data->what   = NULL;
 507     data->dofree = 0;
 508 }
 509
 510 /*********************************************************************
 511  *  __current_exception (UCRTBASE.@)
 512  */
 513 void** CDECL __current_exception(void)
 514 {
 515     TRACE("()\n");
 516     return (void**)&msvcrt_get_thread_data()->exc_record;
 517 }
 518
 519 /*********************************************************************
 520  *  __current_exception_context (UCRTBASE.@)
 521  */
 522 void** CDECL __current_exception_context(void)
 523 {
 524     TRACE("()\n");
 525     return (void**)&msvcrt_get_thread_data()->ctx_record;
 526 }
 527
 528 /*********************************************************************
 529  *  __processing_throw (UCRTBASE.@)
 530  */
 531 int* CDECL __processing_throw(void)
 532 {
 533     TRACE("()\n");
 534     return &msvcrt_get_thread_data()->processing_throw;
 535 }
 536
 537 #endif /* _MSVCR_VER>=140 */