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