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