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 <stdio.h>
  21 #include "msvcrt.h"
  22 #include "mtdll.h"
  23 #include "winuser.h"
  24 #include "wine/debug.h"
  25
  26 WINE_DEFAULT_DEBUG_CHANNEL(msvcrt);
  27
  28 /* MT */
  29 #define LOCK_EXIT   _mlock(_EXIT_LOCK1)
  30 #define UNLOCK_EXIT _munlock(_EXIT_LOCK1)
  31
  32 static MSVCRT__onexit_t *MSVCRT_atexit_table = NULL;
  33 static int MSVCRT_atexit_table_size = 0;
  34 static int MSVCRT_atexit_registered = 0; /* Points to free slot */
  35 static MSVCRT_purecall_handler purecall_handler = NULL;
  36
  37 typedef struct MSVCRT__onexit_table_t
  38 {
  39     MSVCRT__onexit_t *_first;
  40     MSVCRT__onexit_t *_last;
  41     MSVCRT__onexit_t *_end;
  42 } MSVCRT__onexit_table_t;
  43
  44 typedef void (__stdcall *_tls_callback_type)(void*,ULONG,void*);
  45 static _tls_callback_type tls_atexit_callback;
  46
  47 static CRITICAL_SECTION MSVCRT_onexit_cs;
  48 static CRITICAL_SECTION_DEBUG MSVCRT_onexit_cs_debug =
  49 {
  50     0, 0, &MSVCRT_onexit_cs,
  51     { &MSVCRT_onexit_cs_debug.ProcessLocksList, &MSVCRT_onexit_cs_debug.ProcessLocksList },
  52       0, 0, { (DWORD_PTR)(__FILE__ ": MSVCRT_onexit_cs") }
  53 };
  54 static CRITICAL_SECTION MSVCRT_onexit_cs = { &MSVCRT_onexit_cs_debug, -1, 0, 0, 0, 0 };
  55
  56 extern int MSVCRT_app_type;
  57 extern MSVCRT_wchar_t *MSVCRT__wpgmptr;
  58
  59 static unsigned int MSVCRT_abort_behavior =  MSVCRT__WRITE_ABORT_MSG | MSVCRT__CALL_REPORTFAULT;
  60 static int MSVCRT_error_mode = MSVCRT__OUT_TO_DEFAULT;
  61
  62 void (*CDECL _aexit_rtn)(int) = MSVCRT__exit;
  63
  64 /* INTERNAL: call atexit functions */
  65 static void __MSVCRT__call_atexit(void)
  66 {
  67   /* Note: should only be called with the exit lock held */
  68   TRACE("%d atext functions to call\n", MSVCRT_atexit_registered);
  69   if (tls_atexit_callback) tls_atexit_callback(NULL, DLL_PROCESS_DETACH, NULL);
  70   /* Last registered gets executed first */
  71   while (MSVCRT_atexit_registered > 0)
  72   {
  73     MSVCRT_atexit_registered--;
  74     TRACE("next is %p\n",MSVCRT_atexit_table[MSVCRT_atexit_registered]);
  75     if (MSVCRT_atexit_table[MSVCRT_atexit_registered])
  76       (*MSVCRT_atexit_table[MSVCRT_atexit_registered])();
  77     TRACE("returned\n");
  78   }
  79 }
  80
  81 /*********************************************************************
  82  *              __dllonexit (MSVCRT.@)
  83  */
  84 MSVCRT__onexit_t CDECL __dllonexit(MSVCRT__onexit_t func, MSVCRT__onexit_t **start, MSVCRT__onexit_t **end)
  85 {
  86   MSVCRT__onexit_t *tmp;
  87   int len;
  88
  89   TRACE("(%p,%p,%p)\n", func, start, end);
  90
  91   if (!start || !*start || !end || !*end)
  92   {
  93    FIXME("bad table\n");
  94    return NULL;
  95   }
  96
  97   len = (*end - *start);
  98
  99   TRACE("table start %p-%p, %d entries\n", *start, *end, len);
 100
 101   if (++len <= 0)
 102     return NULL;
 103
 104   tmp = MSVCRT_realloc(*start, len * sizeof(*tmp));
 105   if (!tmp)
 106     return NULL;
 107   *start = tmp;
 108   *end = tmp + len;
 109   tmp[len - 1] = func;
 110   TRACE("new table start %p-%p, %d entries\n", *start, *end, len);
 111   return func;
 112 }
 113
 114 /*********************************************************************
 115  *              _exit (MSVCRT.@)
 116  */
 117 void CDECL MSVCRT__exit(int exitcode)
 118 {
 119   TRACE("(%d)\n", exitcode);
 120   ExitProcess(exitcode);
 121 }
 122
 123 /* Print out an error message with an option to debug */
 124 static void DoMessageBoxW(const MSVCRT_wchar_t *lead, const MSVCRT_wchar_t *message)
 125 {
 126   static const MSVCRT_wchar_t message_format[] = {'%','s','\n','\n','P','r','o','g','r','a','m',':',' ','%','s','\n',
 127     '%','s','\n','\n','P','r','e','s','s',' ','O','K',' ','t','o',' ','e','x','i','t',' ','t','h','e',' ',
 128     'p','r','o','g','r','a','m',',',' ','o','r',' ','C','a','n','c','e','l',' ','t','o',' ','s','t','a','r','t',' ',
 129     't','h','e',' ','W','i','n','e',' ','d','e','b','u','g','g','e','r','.','\n',0};
 130   static const WCHAR title[] =
 131     {'W','i','n','e',' ','C','+','+',' ','R','u','n','t','i','m','e',' ','L','i','b','r','a','r','y',0};
 132
 133   MSGBOXPARAMSW msgbox;
 134   MSVCRT_wchar_t text[2048];
 135   INT ret;
 136
 137   MSVCRT__snwprintf(text, sizeof(text)/sizeof(text[0]), message_format,
 138           lead, MSVCRT__wpgmptr, message);
 139
 140   msgbox.cbSize = sizeof(msgbox);
 141   msgbox.hwndOwner = GetActiveWindow();
 142   msgbox.hInstance = 0;
 143   msgbox.lpszText = text;
 144   msgbox.lpszCaption = title;
 145   msgbox.dwStyle = MB_OKCANCEL|MB_ICONERROR;
 146   msgbox.lpszIcon = NULL;
 147   msgbox.dwContextHelpId = 0;
 148   msgbox.lpfnMsgBoxCallback = NULL;
 149   msgbox.dwLanguageId = LANG_NEUTRAL;
 150
 151   ret = MessageBoxIndirectW(&msgbox);
 152   if (ret == IDCANCEL)
 153     DebugBreak();
 154 }
 155
 156 static void DoMessageBox(const char *lead, const char *message)
 157 {
 158   MSVCRT_wchar_t leadW[1024], messageW[1024];
 159
 160   MSVCRT_mbstowcs(leadW, lead, 1024);
 161   MSVCRT_mbstowcs(messageW, message, 1024);
 162
 163   DoMessageBoxW(leadW, messageW);
 164 }
 165
 166 /*********************************************************************
 167  *              _amsg_exit (MSVCRT.@)
 168  */
 169 void CDECL _amsg_exit(int errnum)
 170 {
 171   TRACE("(%d)\n", errnum);
 172
 173   if ((MSVCRT_error_mode == MSVCRT__OUT_TO_MSGBOX) ||
 174      ((MSVCRT_error_mode == MSVCRT__OUT_TO_DEFAULT) && (MSVCRT_app_type == 2)))
 175   {
 176     char text[32];
 177     sprintf(text, "Error: R60%d",errnum);
 178     DoMessageBox("Runtime error!", text);
 179   }
 180   else
 181     _cprintf("\nruntime error R60%d\n",errnum);
 182   _aexit_rtn(255);
 183 }
 184
 185 /*********************************************************************
 186  *              abort (MSVCRT.@)
 187  */
 188 void CDECL MSVCRT_abort(void)
 189 {
 190   TRACE("()\n");
 191
 192   if (MSVCRT_abort_behavior & MSVCRT__WRITE_ABORT_MSG)
 193   {
 194     if ((MSVCRT_error_mode == MSVCRT__OUT_TO_MSGBOX) ||
 195        ((MSVCRT_error_mode == MSVCRT__OUT_TO_DEFAULT) && (MSVCRT_app_type == 2)))
 196     {
 197       DoMessageBox("Runtime error!", "abnormal program termination");
 198     }
 199     else
 200       _cputs("\nabnormal program termination\n");
 201   }
 202   MSVCRT_raise(MSVCRT_SIGABRT);
 203   /* in case raise() returns */
 204   MSVCRT__exit(3);
 205 }
 206
 207 #if _MSVCR_VER>=80
 208 /*********************************************************************
 209  *              _set_abort_behavior (MSVCR80.@)
 210  */
 211 unsigned int CDECL MSVCRT__set_abort_behavior(unsigned int flags, unsigned int mask)
 212 {
 213   unsigned int old = MSVCRT_abort_behavior;
 214
 215   TRACE("%x, %x\n", flags, mask);
 216   if (mask & MSVCRT__CALL_REPORTFAULT)
 217     FIXME("_WRITE_CALL_REPORTFAULT unhandled\n");
 218
 219   MSVCRT_abort_behavior = (MSVCRT_abort_behavior & ~mask) | (flags & mask);
 220   return old;
 221 }
 222 #endif
 223
 224 /*********************************************************************
 225  *              _wassert (MSVCRT.@)
 226  */
 227 void CDECL MSVCRT__wassert(const MSVCRT_wchar_t* str, const MSVCRT_wchar_t* file, unsigned int line)
 228 {
 229   static const MSVCRT_wchar_t assertion_failed[] = {'A','s','s','e','r','t','i','o','n',' ','f','a','i','l','e','d','!',0};
 230   static const MSVCRT_wchar_t format_msgbox[] = {'F','i','l','e',':',' ','%','s','\n','L','i','n','e',':',' ','%','d',
 231       '\n','\n','E','x','p','r','e','s','s','i','o','n',':',' ','\"','%','s','\"',0};
 232   static const MSVCRT_wchar_t format_console[] = {'A','s','s','e','r','t','i','o','n',' ','f','a','i','l','e','d',':',' ',
 233       '%','s',',',' ','f','i','l','e',' ','%','s',',',' ','l','i','n','e',' ','%','d','\n','\n',0};
 234
 235   TRACE("(%s,%s,%d)\n", debugstr_w(str), debugstr_w(file), line);
 236
 237   if ((MSVCRT_error_mode == MSVCRT__OUT_TO_MSGBOX) ||
 238      ((MSVCRT_error_mode == MSVCRT__OUT_TO_DEFAULT) && (MSVCRT_app_type == 2)))
 239   {
 240     MSVCRT_wchar_t text[2048];
 241     MSVCRT__snwprintf(text, sizeof(text), format_msgbox, file, line, str);
 242     DoMessageBoxW(assertion_failed, text);
 243   }
 244   else
 245     _cwprintf(format_console, str, file, line);
 246
 247   MSVCRT_raise(MSVCRT_SIGABRT);
 248   MSVCRT__exit(3);
 249 }
 250
 251 /*********************************************************************
 252  *              _assert (MSVCRT.@)
 253  */
 254 void CDECL MSVCRT__assert(const char* str, const char* file, unsigned int line)
 255 {
 256     MSVCRT_wchar_t strW[1024], fileW[1024];
 257
 258     MSVCRT_mbstowcs(strW, str, 1024);
 259     MSVCRT_mbstowcs(fileW, file, 1024);
 260
 261     MSVCRT__wassert(strW, fileW, line);
 262 }
 263
 264 /*********************************************************************
 265  *              _c_exit (MSVCRT.@)
 266  */
 267 void CDECL MSVCRT__c_exit(void)
 268 {
 269   TRACE("(void)\n");
 270   /* All cleanup is done on DLL detach; Return to caller */
 271 }
 272
 273 /*********************************************************************
 274  *              _cexit (MSVCRT.@)
 275  */
 276 void CDECL MSVCRT__cexit(void)
 277 {
 278   TRACE("(void)\n");
 279   LOCK_EXIT;
 280   __MSVCRT__call_atexit();
 281   UNLOCK_EXIT;
 282 }
 283
 284 /*********************************************************************
 285  *              _onexit (MSVCRT.@)
 286  */
 287 MSVCRT__onexit_t CDECL MSVCRT__onexit(MSVCRT__onexit_t func)
 288 {
 289   TRACE("(%p)\n",func);
 290
 291   if (!func)
 292     return NULL;
 293
 294   LOCK_EXIT;
 295   if (MSVCRT_atexit_registered > MSVCRT_atexit_table_size - 1)
 296   {
 297     MSVCRT__onexit_t *newtable;
 298     TRACE("expanding table\n");
 299     newtable = MSVCRT_calloc(MSVCRT_atexit_table_size + 32, sizeof(void *));
 300     if (!newtable)
 301     {
 302       TRACE("failed!\n");
 303       UNLOCK_EXIT;
 304       return NULL;
 305     }
 306     memcpy (newtable, MSVCRT_atexit_table, MSVCRT_atexit_table_size*sizeof(void *));
 307     MSVCRT_atexit_table_size += 32;
 308     MSVCRT_free (MSVCRT_atexit_table);
 309     MSVCRT_atexit_table = newtable;
 310   }
 311   MSVCRT_atexit_table[MSVCRT_atexit_registered] = func;
 312   MSVCRT_atexit_registered++;
 313   UNLOCK_EXIT;
 314   return func;
 315 }
 316
 317 /*********************************************************************
 318  *              exit (MSVCRT.@)
 319  */
 320 void CDECL MSVCRT_exit(int exitcode)
 321 {
 322   HMODULE hmscoree;
 323   static const WCHAR mscoreeW[] = {'m','s','c','o','r','e','e',0};
 324   void (WINAPI *pCorExitProcess)(int);
 325
 326   TRACE("(%d)\n",exitcode);
 327   MSVCRT__cexit();
 328
 329   hmscoree = GetModuleHandleW(mscoreeW);
 330
 331   if (hmscoree)
 332   {
 333     pCorExitProcess = (void*)GetProcAddress(hmscoree, "CorExitProcess");
 334
 335     if (pCorExitProcess)
 336       pCorExitProcess(exitcode);
 337   }
 338
 339   ExitProcess(exitcode);
 340 }
 341
 342 /*********************************************************************
 343  *              atexit (MSVCRT.@)
 344  */
 345 int CDECL MSVCRT_atexit(void (*func)(void))
 346 {
 347   TRACE("(%p)\n", func);
 348   return MSVCRT__onexit((MSVCRT__onexit_t)func) == (MSVCRT__onexit_t)func ? 0 : -1;
 349 }
 350
 351 #if _MSVCR_VER>=140
 352
 353 /*********************************************************************
 354  *              _crt_atexit (UCRTBASE.@)
 355  */
 356 int CDECL MSVCRT__crt_atexit(void (*func)(void))
 357 {
 358   TRACE("(%p)\n", func);
 359   return MSVCRT__onexit((MSVCRT__onexit_t)func) == (MSVCRT__onexit_t)func ? 0 : -1;
 360 }
 361
 362
 363 /*********************************************************************
 364  *              _initialize_onexit_table (UCRTBASE.@)
 365  */
 366 int CDECL MSVCRT__initialize_onexit_table(MSVCRT__onexit_table_t *table)
 367 {
 368     TRACE("(%p)\n", table);
 369
 370     if (!table)
 371         return -1;
 372
 373     if (table->_first == table->_end)
 374         table->_last = table->_end = table->_first = NULL;
 375     return 0;
 376 }
 377
 378 /*********************************************************************
 379  *              _register_onexit_function (UCRTBASE.@)
 380  */
 381 int CDECL MSVCRT__register_onexit_function(MSVCRT__onexit_table_t *table, MSVCRT__onexit_t func)
 382 {
 383     TRACE("(%p %p)\n", table, func);
 384
 385     if (!table)
 386         return -1;
 387
 388     EnterCriticalSection(&MSVCRT_onexit_cs);
 389     if (!table->_first)
 390     {
 391         table->_first = MSVCRT_calloc(32, sizeof(void *));
 392         if (!table->_first)
 393         {
 394             WARN("failed to allocate initial table.\n");
 395             LeaveCriticalSection(&MSVCRT_onexit_cs);
 396             return -1;
 397         }
 398         table->_last = table->_first;
 399         table->_end = table->_first + 32;
 400     }
 401
 402     /* grow if full */
 403     if (table->_last == table->_end)
 404     {
 405         int len = table->_end - table->_first;
 406         MSVCRT__onexit_t *tmp = MSVCRT_realloc(table->_first, 2 * len * sizeof(void *));
 407         if (!tmp)
 408         {
 409             WARN("failed to grow table.\n");
 410             LeaveCriticalSection(&MSVCRT_onexit_cs);
 411             return -1;
 412         }
 413         table->_first = tmp;
 414         table->_end = table->_first + 2 * len;
 415         table->_last = table->_first + len;
 416     }
 417
 418     *table->_last = func;
 419     table->_last++;
 420     LeaveCriticalSection(&MSVCRT_onexit_cs);
 421     return 0;
 422 }
 423
 424 /*********************************************************************
 425  *              _execute_onexit_table (UCRTBASE.@)
 426  */
 427 int CDECL MSVCRT__execute_onexit_table(MSVCRT__onexit_table_t *table)
 428 {
 429     MSVCRT__onexit_t *func;
 430     MSVCRT__onexit_table_t copy;
 431
 432     TRACE("(%p)\n", table);
 433
 434     if (!table)
 435         return -1;
 436
 437     EnterCriticalSection(&MSVCRT_onexit_cs);
 438     if (!table->_first || table->_first >= table->_last)
 439     {
 440         LeaveCriticalSection(&MSVCRT_onexit_cs);
 441         return 0;
 442     }
 443     copy._first = table->_first;
 444     copy._last  = table->_last;
 445     copy._end   = table->_end;
 446     memset(table, 0, sizeof(*table));
 447     MSVCRT__initialize_onexit_table(table);
 448     LeaveCriticalSection(&MSVCRT_onexit_cs);
 449
 450     for (func = copy._last - 1; func >= copy._first; func--)
 451     {
 452         if (*func)
 453            (*func)();
 454     }
 455
 456     MSVCRT_free(copy._first);
 457     return 0;
 458 }
 459
 460 /*********************************************************************
 461  *              _register_thread_local_exe_atexit_callback (UCRTBASE.@)
 462  */
 463 void CDECL _register_thread_local_exe_atexit_callback(_tls_callback_type callback)
 464 {
 465     TRACE("(%p)\n", callback);
 466     tls_atexit_callback = callback;
 467 }
 468
 469 #endif /* _MSVCR_VER>=140 */
 470
 471 #if _MSVCR_VER>=71
 472 /*********************************************************************
 473  *              _set_purecall_handler (MSVCR71.@)
 474  */
 475 MSVCRT_purecall_handler CDECL _set_purecall_handler(MSVCRT_purecall_handler function)
 476 {
 477     MSVCRT_purecall_handler ret = purecall_handler;
 478
 479     TRACE("(%p)\n", function);
 480     purecall_handler = function;
 481     return ret;
 482 }
 483 #endif
 484
 485 #if _MSVCR_VER>=80
 486 /*********************************************************************
 487  *              _get_purecall_handler (MSVCR80.@)
 488  */
 489 MSVCRT_purecall_handler CDECL _get_purecall_handler(void)
 490 {
 491     TRACE("\n");
 492     return purecall_handler;
 493 }
 494 #endif
 495
 496 /*********************************************************************
 497  *              _purecall (MSVCRT.@)
 498  */
 499 void CDECL _purecall(void)
 500 {
 501   TRACE("(void)\n");
 502
 503   if(purecall_handler)
 504       purecall_handler();
 505   _amsg_exit( 25 );
 506 }
 507
 508 /******************************************************************************
 509  *              _set_error_mode (MSVCRT.@)
 510  *
 511  * Set the error mode, which describes where the C run-time writes error messages.
 512  *
 513  * PARAMS
 514  *   mode - the new error mode
 515  *
 516  * RETURNS
 517  *   The old error mode.
 518  *
 519  */
 520 int CDECL _set_error_mode(int mode)
 521 {
 522
 523   const int old = MSVCRT_error_mode;
 524   if ( MSVCRT__REPORT_ERRMODE != mode ) {
 525     MSVCRT_error_mode = mode;
 526   }
 527   return old;
 528 }