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