dlls/msvcrt/exit.c

   1 /*
   2  * msvcrt.dll exit functions
   3  *
   4  * Copyright 2000 Jon Griffiths
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20 #include <conio.h>
  21 #include <process.h>
  22 #include <signal.h>
  23 #include <stdio.h>
  24 #include "msvcrt.h"
  25 #include "mtdll.h"
  26 #include "winuser.h"
  27 #include "wine/debug.h"
  28
  29 WINE_DEFAULT_DEBUG_CHANNEL(msvcrt);
  30
  31 /* MT */
  32 #define LOCK_EXIT   _lock(_EXIT_LOCK1)
  33 #define UNLOCK_EXIT _unlock(_EXIT_LOCK1)
  34
  35 static _purecall_handler purecall_handler = NULL;
  36
  37 static _onexit_table_t MSVCRT_atexit_table;
  38
  39 typedef void (__stdcall *_tls_callback_type)(void*,ULONG,void*);
  40 static _tls_callback_type tls_atexit_callback;
  41
  42 static CRITICAL_SECTION MSVCRT_onexit_cs;
  43 static CRITICAL_SECTION_DEBUG MSVCRT_onexit_cs_debug =
  44 {
  45     0, 0, &MSVCRT_onexit_cs,
  46     { &MSVCRT_onexit_cs_debug.ProcessLocksList, &MSVCRT_onexit_cs_debug.ProcessLocksList },
  47       0, 0, { (DWORD_PTR)(__FILE__ ": MSVCRT_onexit_cs") }
  48 };
  49 static CRITICAL_SECTION MSVCRT_onexit_cs = { &MSVCRT_onexit_cs_debug, -1, 0, 0, 0, 0 };
  50
  51 extern int MSVCRT_app_type;
  52 extern wchar_t *MSVCRT__wpgmptr;
  53
  54 static unsigned int MSVCRT_abort_behavior =  _WRITE_ABORT_MSG | _CALL_REPORTFAULT;
  55 static int MSVCRT_error_mode = _OUT_TO_DEFAULT;
  56
  57 void (*CDECL _aexit_rtn)(int) = _exit;
  58
  59 static int initialize_onexit_table(_onexit_table_t *table)
  60 {
  61     if (!table)
  62         return -1;
  63
  64     if (table->_first == table->_end)
  65         table->_last = table->_end = table->_first = NULL;
  66     return 0;
  67 }
  68
  69 static int register_onexit_function(_onexit_table_t *table, _onexit_t func)
  70 {
  71     if (!table)
  72         return -1;
  73
  74     EnterCriticalSection(&MSVCRT_onexit_cs);
  75     if (!table->_first)
  76     {
  77         table->_first = calloc(32, sizeof(void *));
  78         if (!table->_first)
  79         {
  80             WARN("failed to allocate initial table.\n");
  81             LeaveCriticalSection(&MSVCRT_onexit_cs);
  82             return -1;
  83         }
  84         table->_last = table->_first;
  85         table->_end = table->_first + 32;
  86     }
  87
  88     /* grow if full */
  89     if (table->_last == table->_end)
  90     {
  91         int len = table->_end - table->_first;
  92         _PVFV *tmp = realloc(table->_first, 2 * len * sizeof(void *));
  93         if (!tmp)
  94         {
  95             WARN("failed to grow table.\n");
  96             LeaveCriticalSection(&MSVCRT_onexit_cs);
  97             return -1;
  98         }
  99         table->_first = tmp;
 100         table->_end = table->_first + 2 * len;
 101         table->_last = table->_first + len;
 102     }
 103
 104     *table->_last = (_PVFV)func;
 105     table->_last++;
 106     LeaveCriticalSection(&MSVCRT_onexit_cs);
 107     return 0;
 108 }
 109
 110 static int execute_onexit_table(_onexit_table_t *table)
 111 {
 112     _onexit_table_t copy;
 113     _PVFV *func;
 114
 115     if (!table)
 116         return -1;
 117
 118     EnterCriticalSection(&MSVCRT_onexit_cs);
 119     if (!table->_first || table->_first >= table->_last)
 120     {
 121         LeaveCriticalSection(&MSVCRT_onexit_cs);
 122         return 0;
 123     }
 124     copy._first = table->_first;
 125     copy._last  = table->_last;
 126     copy._end   = table->_end;
 127     memset(table, 0, sizeof(*table));
 128     initialize_onexit_table(table);
 129     LeaveCriticalSection(&MSVCRT_onexit_cs);
 130
 131     for (func = copy._last - 1; func >= copy._first; func--)
 132     {
 133         if (*func)
 134            (*func)();
 135     }
 136
 137     free(copy._first);
 138     return 0;
 139 }
 140
 141 static void call_atexit(void)
 142 {
 143     /* Note: should only be called with the exit lock held */
 144     if (tls_atexit_callback) tls_atexit_callback(NULL, DLL_PROCESS_DETACH, NULL);
 145     execute_onexit_table(&MSVCRT_atexit_table);
 146 }
 147
 148 /*********************************************************************
 149  *              __dllonexit (MSVCRT.@)
 150  */
 151 _onexit_t CDECL __dllonexit(_onexit_t func, _onexit_t **start, _onexit_t **end)
 152 {
 153   _onexit_t *tmp;
 154   int len;
 155
 156   TRACE("(%p,%p,%p)\n", func, start, end);
 157
 158   if (!start || !*start || !end || !*end)
 159   {
 160    FIXME("bad table\n");
 161    return NULL;
 162   }
 163
 164   len = (*end - *start);
 165
 166   TRACE("table start %p-%p, %d entries\n", *start, *end, len);
 167
 168   if (++len <= 0)
 169     return NULL;
 170
 171   tmp = realloc(*start, len * sizeof(*tmp));
 172   if (!tmp)
 173     return NULL;
 174   *start = tmp;
 175   *end = tmp + len;
 176   tmp[len - 1] = func;
 177   TRACE("new table start %p-%p, %d entries\n", *start, *end, len);
 178   return func;
 179 }
 180
 181 /*********************************************************************
 182  *              _exit (MSVCRT.@)
 183  */
 184 void CDECL _exit(int exitcode)
 185 {
 186   TRACE("(%d)\n", exitcode);
 187   ExitProcess(exitcode);
 188 }
 189
 190 /* Print out an error message with an option to debug */
 191 static void DoMessageBoxW(const wchar_t *lead, const wchar_t *message)
 192 {
 193   MSGBOXPARAMSW msgbox;
 194   wchar_t text[2048];
 195   INT ret;
 196
 197   _snwprintf(text, ARRAY_SIZE(text), L"%ls\n\nProgram: %ls\n%ls\n\n"
 198           L"Press OK to exit the program, or Cancel to start the Wine debugger.\n",
 199           lead, MSVCRT__wpgmptr, message);
 200
 201   msgbox.cbSize = sizeof(msgbox);
 202   msgbox.hwndOwner = GetActiveWindow();
 203   msgbox.hInstance = 0;
 204   msgbox.lpszText = text;
 205   msgbox.lpszCaption = L"Wine C++ Runtime Library";
 206   msgbox.dwStyle = MB_OKCANCEL|MB_ICONERROR;
 207   msgbox.lpszIcon = NULL;
 208   msgbox.dwContextHelpId = 0;
 209   msgbox.lpfnMsgBoxCallback = NULL;
 210   msgbox.dwLanguageId = LANG_NEUTRAL;
 211
 212   ret = MessageBoxIndirectW(&msgbox);
 213   if (ret == IDCANCEL)
 214     DebugBreak();
 215 }
 216
 217 static void DoMessageBox(const char *lead, const char *message)
 218 {
 219   wchar_t leadW[1024], messageW[1024];
 220
 221   mbstowcs(leadW, lead, 1024);
 222   mbstowcs(messageW, message, 1024);
 223
 224   DoMessageBoxW(leadW, messageW);
 225 }
 226
 227 /*********************************************************************
 228  *              _amsg_exit (MSVCRT.@)
 229  */
 230 void CDECL _amsg_exit(int errnum)
 231 {
 232   TRACE("(%d)\n", errnum);
 233
 234   if ((MSVCRT_error_mode == _OUT_TO_MSGBOX) ||
 235      ((MSVCRT_error_mode == _OUT_TO_DEFAULT) && (MSVCRT_app_type == 2)))
 236   {
 237     char text[32];
 238     sprintf(text, "Error: R60%d",errnum);
 239     DoMessageBox("Runtime error!", text);
 240   }
 241   else
 242     _cprintf("\nruntime error R60%d\n",errnum);
 243   _aexit_rtn(255);
 244 }
 245
 246 /*********************************************************************
 247  *              abort (MSVCRT.@)
 248  */
 249 void CDECL abort(void)
 250 {
 251   TRACE("()\n");
 252
 253   if (MSVCRT_abort_behavior & _WRITE_ABORT_MSG)
 254   {
 255     if ((MSVCRT_error_mode == _OUT_TO_MSGBOX) ||
 256        ((MSVCRT_error_mode == _OUT_TO_DEFAULT) && (MSVCRT_app_type == 2)))
 257     {
 258       DoMessageBox("Runtime error!", "abnormal program termination");
 259     }
 260     else
 261       _cputs("\nabnormal program termination\n");
 262   }
 263   raise(SIGABRT);
 264   /* in case raise() returns */
 265   _exit(3);
 266 }
 267
 268 #if _MSVCR_VER>=80
 269 /*********************************************************************
 270  *              _set_abort_behavior (MSVCR80.@)
 271  */
 272 unsigned int CDECL _set_abort_behavior(unsigned int flags, unsigned int mask)
 273 {
 274   unsigned int old = MSVCRT_abort_behavior;
 275
 276   TRACE("%x, %x\n", flags, mask);
 277   if (mask & _CALL_REPORTFAULT)
 278     FIXME("_WRITE_CALL_REPORTFAULT unhandled\n");
 279
 280   MSVCRT_abort_behavior = (MSVCRT_abort_behavior & ~mask) | (flags & mask);
 281   return old;
 282 }
 283 #endif
 284
 285 /*********************************************************************
 286  *              _wassert (MSVCRT.@)
 287  */
 288 void CDECL _wassert(const wchar_t* str, const wchar_t* file, unsigned int line)
 289 {
 290   TRACE("(%s,%s,%d)\n", debugstr_w(str), debugstr_w(file), line);
 291
 292   if ((MSVCRT_error_mode == _OUT_TO_MSGBOX) ||
 293      ((MSVCRT_error_mode == _OUT_TO_DEFAULT) && (MSVCRT_app_type == 2)))
 294   {
 295     wchar_t text[2048];
 296     _snwprintf(text, sizeof(text), L"File: %ls\nLine: %d\n\nExpression: \"%ls\"", file, line, str);
 297     DoMessageBoxW(L"Assertion failed!", text);
 298   }
 299   else
 300     fwprintf(MSVCRT_stderr, L"Assertion failed: %ls, file %ls, line %d\n\n", str, file, line);
 301
 302   raise(SIGABRT);
 303   _exit(3);
 304 }
 305
 306 /*********************************************************************
 307  *              _assert (MSVCRT.@)
 308  */
 309 void CDECL _assert(const char* str, const char* file, unsigned int line)
 310 {
 311     wchar_t strW[1024], fileW[1024];
 312
 313     mbstowcs(strW, str, 1024);
 314     mbstowcs(fileW, file, 1024);
 315
 316     _wassert(strW, fileW, line);
 317 }
 318
 319 /*********************************************************************
 320  *              _c_exit (MSVCRT.@)
 321  */
 322 void CDECL _c_exit(void)
 323 {
 324   TRACE("(void)\n");
 325   /* All cleanup is done on DLL detach; Return to caller */
 326 }
 327
 328 /*********************************************************************
 329  *              _cexit (MSVCRT.@)
 330  */
 331 void CDECL _cexit(void)
 332 {
 333   TRACE("(void)\n");
 334   LOCK_EXIT;
 335   call_atexit();
 336   UNLOCK_EXIT;
 337 }
 338
 339 /*********************************************************************
 340  *              _onexit (MSVCRT.@)
 341  */
 342 _onexit_t CDECL _onexit(_onexit_t func)
 343 {
 344   TRACE("(%p)\n",func);
 345
 346   if (!func)
 347     return NULL;
 348
 349   LOCK_EXIT;
 350   register_onexit_function(&MSVCRT_atexit_table, func);
 351   UNLOCK_EXIT;
 352
 353   return func;
 354 }
 355
 356 /*********************************************************************
 357  *              exit (MSVCRT.@)
 358  */
 359 void CDECL exit(int exitcode)
 360 {
 361   HMODULE hmscoree;
 362   void (WINAPI *pCorExitProcess)(int);
 363
 364   TRACE("(%d)\n",exitcode);
 365   _cexit();
 366
 367   hmscoree = GetModuleHandleW(L"mscoree");
 368
 369   if (hmscoree)
 370   {
 371     pCorExitProcess = (void*)GetProcAddress(hmscoree, "CorExitProcess");
 372
 373     if (pCorExitProcess)
 374       pCorExitProcess(exitcode);
 375   }
 376
 377   ExitProcess(exitcode);
 378 }
 379
 380 /*********************************************************************
 381  *              atexit (MSVCRT.@)
 382  */
 383 int CDECL MSVCRT_atexit(void (__cdecl *func)(void))
 384 {
 385   TRACE("(%p)\n", func);
 386   return _onexit((_onexit_t)func) == (_onexit_t)func ? 0 : -1;
 387 }
 388
 389 #if _MSVCR_VER >= 140
 390 static _onexit_table_t MSVCRT_quick_exit_table;
 391
 392 /*********************************************************************
 393  *             _crt_at_quick_exit (UCRTBASE.@)
 394  */
 395 int CDECL _crt_at_quick_exit(void (__cdecl *func)(void))
 396 {
 397   TRACE("(%p)\n", func);
 398   return register_onexit_function(&MSVCRT_quick_exit_table, (_onexit_t)func);
 399 }
 400
 401 /*********************************************************************
 402  *             quick_exit (UCRTBASE.@)
 403  */
 404 void CDECL quick_exit(int exitcode)
 405 {
 406   TRACE("(%d)\n", exitcode);
 407
 408   execute_onexit_table(&MSVCRT_quick_exit_table);
 409   _exit(exitcode);
 410 }
 411
 412 /*********************************************************************
 413  *              _crt_atexit (UCRTBASE.@)
 414  */
 415 int CDECL _crt_atexit(void (__cdecl *func)(void))
 416 {
 417   TRACE("(%p)\n", func);
 418   return _onexit((_onexit_t)func) == (_onexit_t)func ? 0 : -1;
 419 }
 420
 421 /*********************************************************************
 422  *              _initialize_onexit_table (UCRTBASE.@)
 423  */
 424 int CDECL _initialize_onexit_table(_onexit_table_t *table)
 425 {
 426     TRACE("(%p)\n", table);
 427
 428     return initialize_onexit_table(table);
 429 }
 430
 431 /*********************************************************************
 432  *              _register_onexit_function (UCRTBASE.@)
 433  */
 434 int CDECL _register_onexit_function(_onexit_table_t *table, _onexit_t func)
 435 {
 436     TRACE("(%p %p)\n", table, func);
 437
 438     return register_onexit_function(table, func);
 439 }
 440
 441 /*********************************************************************
 442  *              _execute_onexit_table (UCRTBASE.@)
 443  */
 444 int CDECL _execute_onexit_table(_onexit_table_t *table)
 445 {
 446     TRACE("(%p)\n", table);
 447
 448     return execute_onexit_table(table);
 449 }
 450 #endif
 451
 452 /*********************************************************************
 453  *              _register_thread_local_exe_atexit_callback (UCRTBASE.@)
 454  */
 455 void CDECL _register_thread_local_exe_atexit_callback(_tls_callback_type callback)
 456 {
 457     TRACE("(%p)\n", callback);
 458     tls_atexit_callback = callback;
 459 }
 460
 461 #if _MSVCR_VER>=71
 462 /*********************************************************************
 463  *              _set_purecall_handler (MSVCR71.@)
 464  */
 465 _purecall_handler CDECL _set_purecall_handler(_purecall_handler function)
 466 {
 467     _purecall_handler ret = purecall_handler;
 468
 469     TRACE("(%p)\n", function);
 470     purecall_handler = function;
 471     return ret;
 472 }
 473 #endif
 474
 475 #if _MSVCR_VER>=80
 476 /*********************************************************************
 477  *              _get_purecall_handler (MSVCR80.@)
 478  */
 479 _purecall_handler CDECL _get_purecall_handler(void)
 480 {
 481     TRACE("\n");
 482     return purecall_handler;
 483 }
 484 #endif
 485
 486 /*********************************************************************
 487  *              _purecall (MSVCRT.@)
 488  */
 489 void CDECL _purecall(void)
 490 {
 491   TRACE("(void)\n");
 492
 493   if(purecall_handler)
 494       purecall_handler();
 495   _amsg_exit( 25 );
 496 }
 497
 498 /******************************************************************************
 499  *              _set_error_mode (MSVCRT.@)
 500  *
 501  * Set the error mode, which describes where the C run-time writes error messages.
 502  *
 503  * PARAMS
 504  *   mode - the new error mode
 505  *
 506  * RETURNS
 507  *   The old error mode.
 508  *
 509  */
 510 int CDECL _set_error_mode(int mode)
 511 {
 512
 513   const int old = MSVCRT_error_mode;
 514   if ( _REPORT_ERRMODE != mode ) {
 515     MSVCRT_error_mode = mode;
 516   }
 517   return old;
 518 }