//========= Copyright (c) 1996-2005, Valve Corporation, All rights reserved. ============// // // Purpose: // //===========================================================================// #include "tier0/platform.h" #include "tier0/valve_off.h" #ifdef _X360 #include "xbox/xbox_console.h" #include "xbox/xbox_vxconsole.h" #elif defined( _PS3 ) #include "ps3/ps3_console.h" #elif defined( _WIN32 ) #include #elif POSIX char *GetCommandLine(); #endif #include "resource.h" #include "tier0/valve_on.h" #include "tier0/threadtools.h" #include "tier0/icommandline.h" #if defined( LINUX ) || defined( OSX ) #include #endif #if defined( LINUX ) || defined( USE_SDL ) // We lazily load the SDL shared object, and only reference functions if it's // available, so this can be included on the dedicated server too. #include "SDL.h" typedef int ( SDLCALL FUNC_SDL_ShowMessageBox )( const SDL_MessageBoxData *messageboxdata, int *buttonid ); typedef SDL_Window* ( SDLCALL FUNC_SDL_GetKeyboardFocus )(); #endif // NOTE: This has to be the last file included! #include "tier0/memdbgon.h" class CDialogInitInfo { public: const tchar *m_pFilename; int m_iLine; const tchar *m_pExpression; }; class CAssertDisable { public: tchar m_Filename[512]; // If these are not -1, then this CAssertDisable only disables asserts on lines between // these values (inclusive). int m_LineMin; int m_LineMax; // Decremented each time we hit this assert and ignore it, until it's 0. // Then the CAssertDisable is removed. // If this is -1, then we always ignore this assert. int m_nIgnoreTimes; CAssertDisable *m_pNext; }; #ifdef _WIN32 static HINSTANCE g_hTier0Instance = 0; #endif static bool g_bAssertsEnabled = true; static bool g_bAssertDialogEnabled = true; static CAssertDisable *g_pAssertDisables = NULL; #if ( defined( _WIN32 ) && !defined( _X360 ) ) static int g_iLastLineRange = 5; static int g_nLastIgnoreNumTimes = 1; #endif #if defined( _X360 ) || defined( _PS3 ) static int g_VXConsoleAssertReturnValue = -1; #endif // Set to true if they want to break in the debugger. static bool g_bBreak = false; static CDialogInitInfo g_Info; static bool g_bDisableAsserts = false; // -------------------------------------------------------------------------------- // // Internal functions. // -------------------------------------------------------------------------------- // #if defined(_WIN32) && !defined(STATIC_TIER0) BOOL WINAPI DllMain( HINSTANCE hinstDLL, // handle to the DLL module DWORD fdwReason, // reason for calling function LPVOID lpvReserved // reserved ) { g_hTier0Instance = hinstDLL; return true; } #endif static bool IsDebugBreakEnabled() { static bool bResult = ( _tcsstr( Plat_GetCommandLine(), _T("-debugbreak") ) != NULL ); return bResult; } static bool AssertStack() { static bool bResult = ( _tcsstr( Plat_GetCommandLine(), _T("-assertstack") ) != NULL ); return bResult; } static bool AreAssertsDisabled() { static bool bResult = ( _tcsstr( Plat_GetCommandLine(), _T("-noassert") ) != NULL ); return bResult || g_bDisableAsserts; } static bool AllAssertOnce() { static bool bResult = ( _tcsstr( Plat_GetCommandLine(), _T("-assertonce") ) != NULL ); return bResult; } static bool AreAssertsEnabledInFileLine( const tchar *pFilename, int iLine ) { CAssertDisable **pPrev = &g_pAssertDisables; CAssertDisable *pNext; for ( CAssertDisable *pCur=g_pAssertDisables; pCur; pCur=pNext ) { pNext = pCur->m_pNext; if ( _tcsicmp( pFilename, pCur->m_Filename ) == 0 ) { // Are asserts disabled in the whole file? bool bAssertsEnabled = true; if ( pCur->m_LineMin == -1 && pCur->m_LineMax == -1 ) bAssertsEnabled = false; // Are asserts disabled on the specified line? if ( iLine >= pCur->m_LineMin && iLine <= pCur->m_LineMax ) bAssertsEnabled = false; if ( !bAssertsEnabled ) { // If this assert is only disabled for the next N times, then countdown.. if ( pCur->m_nIgnoreTimes > 0 ) { --pCur->m_nIgnoreTimes; if ( pCur->m_nIgnoreTimes == 0 ) { // Remove this one from the list. *pPrev = pNext; delete pCur; continue; } } return false; } } pPrev = &pCur->m_pNext; } return true; } CAssertDisable* CreateNewAssertDisable( const tchar *pFilename ) { CAssertDisable *pDisable = new CAssertDisable; pDisable->m_pNext = g_pAssertDisables; g_pAssertDisables = pDisable; pDisable->m_LineMin = pDisable->m_LineMax = -1; pDisable->m_nIgnoreTimes = -1; _tcsncpy( pDisable->m_Filename, g_Info.m_pFilename, sizeof( pDisable->m_Filename ) - 1 ); pDisable->m_Filename[ sizeof( pDisable->m_Filename ) - 1 ] = 0; return pDisable; } void IgnoreAssertsInCurrentFile() { CreateNewAssertDisable( g_Info.m_pFilename ); } CAssertDisable* IgnoreAssertsNearby( int nRange ) { CAssertDisable *pDisable = CreateNewAssertDisable( g_Info.m_pFilename ); pDisable->m_LineMin = g_Info.m_iLine - nRange; pDisable->m_LineMax = g_Info.m_iLine - nRange; return pDisable; } #if ( defined( _WIN32 ) && !defined( _X360 ) ) INT_PTR CALLBACK AssertDialogProc( HWND hDlg, // handle to dialog box UINT uMsg, // message WPARAM wParam, // first message parameter LPARAM lParam // second message parameter ) { switch( uMsg ) { case WM_INITDIALOG: { #ifdef TCHAR_IS_WCHAR SetDlgItemTextW( hDlg, IDC_ASSERT_MSG_CTRL, g_Info.m_pExpression ); SetDlgItemTextW( hDlg, IDC_FILENAME_CONTROL, g_Info.m_pFilename ); #else SetDlgItemText( hDlg, IDC_ASSERT_MSG_CTRL, g_Info.m_pExpression ); SetDlgItemText( hDlg, IDC_FILENAME_CONTROL, g_Info.m_pFilename ); #endif SetDlgItemInt( hDlg, IDC_LINE_CONTROL, g_Info.m_iLine, false ); SetDlgItemInt( hDlg, IDC_IGNORE_NUMLINES, g_iLastLineRange, false ); SetDlgItemInt( hDlg, IDC_IGNORE_NUMTIMES, g_nLastIgnoreNumTimes, false ); // Center the dialog. RECT rcDlg, rcDesktop; GetWindowRect( hDlg, &rcDlg ); GetWindowRect( GetDesktopWindow(), &rcDesktop ); SetWindowPos( hDlg, HWND_TOP, ((rcDesktop.right-rcDesktop.left) - (rcDlg.right-rcDlg.left)) / 2, ((rcDesktop.bottom-rcDesktop.top) - (rcDlg.bottom-rcDlg.top)) / 2, 0, 0, SWP_NOSIZE ); } return true; case WM_COMMAND: { switch( LOWORD( wParam ) ) { case IDC_IGNORE_FILE: { IgnoreAssertsInCurrentFile(); EndDialog( hDlg, 0 ); return true; } // Ignore this assert N times. case IDC_IGNORE_THIS: { BOOL bTranslated = false; UINT value = GetDlgItemInt( hDlg, IDC_IGNORE_NUMTIMES, &bTranslated, false ); if ( bTranslated && value > 1 ) { CAssertDisable *pDisable = IgnoreAssertsNearby( 0 ); pDisable->m_nIgnoreTimes = value - 1; g_nLastIgnoreNumTimes = value; } EndDialog( hDlg, 0 ); return true; } // Always ignore this assert. case IDC_IGNORE_ALWAYS: { IgnoreAssertsNearby( 0 ); EndDialog( hDlg, 0 ); return true; } case IDC_IGNORE_NEARBY: { BOOL bTranslated = false; UINT value = GetDlgItemInt( hDlg, IDC_IGNORE_NUMLINES, &bTranslated, false ); if ( !bTranslated || value < 1 ) return true; IgnoreAssertsNearby( value ); EndDialog( hDlg, 0 ); return true; } case IDC_IGNORE_ALL: { g_bAssertsEnabled = false; EndDialog( hDlg, 0 ); return true; } case IDC_BREAK: { g_bBreak = true; EndDialog( hDlg, 0 ); return true; } } case WM_KEYDOWN: { // Escape? if ( wParam == 2 ) { // Ignore this assert. EndDialog( hDlg, 0 ); return true; } } } return true; } return FALSE; } static HWND g_hBestParentWindow; static BOOL CALLBACK ParentWindowEnumProc( HWND hWnd, // handle to parent window LPARAM lParam // application-defined value ) { if ( IsWindowVisible( hWnd ) ) { DWORD procID; GetWindowThreadProcessId( hWnd, &procID ); if ( procID == (DWORD)lParam ) { g_hBestParentWindow = hWnd; return FALSE; // don't iterate any more. } } return TRUE; } static HWND FindLikelyParentWindow() { // Enumerate top-level windows and take the first visible one with our processID. g_hBestParentWindow = NULL; EnumWindows( ParentWindowEnumProc, GetCurrentProcessId() ); return g_hBestParentWindow; } #endif // -------------------------------------------------------------------------------- // // Interface functions. // -------------------------------------------------------------------------------- // // provides access to the global that turns asserts on and off PLATFORM_INTERFACE bool AreAllAssertsDisabled() { return !g_bAssertsEnabled; } PLATFORM_INTERFACE void SetAllAssertsDisabled( bool bAssertsDisabled ) { g_bAssertsEnabled = !bAssertsDisabled; } // provides access to the global that turns asserts on and off PLATFORM_INTERFACE bool IsAssertDialogDisabled() { return !g_bAssertDialogEnabled; } PLATFORM_INTERFACE void SetAssertDialogDisabled( bool bAssertDialogDisabled ) { g_bAssertDialogEnabled = !bAssertDialogDisabled; } #if defined( LINUX ) || ( defined( USE_SDL ) && defined( OSX ) ) SDL_Window *g_SDLWindow = NULL; PLATFORM_INTERFACE void SetAssertDialogParent( struct SDL_Window *window ) { g_SDLWindow = window; } PLATFORM_INTERFACE struct SDL_Window * GetAssertDialogParent() { return g_SDLWindow; } #endif PLATFORM_INTERFACE bool ShouldUseNewAssertDialog() { static bool bMPIWorker = ( _tcsstr( Plat_GetCommandLine(), _T("-mpi_worker") ) != NULL ); if ( bMPIWorker ) { return false; } #ifdef DBGFLAG_ASSERTDLG return true; // always show an assert dialog #else return Plat_IsInDebugSession(); // only show an assert dialog if the process is being debugged #endif // DBGFLAG_ASSERTDLG } PLATFORM_INTERFACE bool DoNewAssertDialog( const tchar *pFilename, int line, const tchar *pExpression ) { LOCAL_THREAD_LOCK(); if ( AreAssertsDisabled() ) return false; // If they have the old mode enabled (always break immediately), then just break right into // the debugger like we used to do. if ( IsDebugBreakEnabled() ) return true; // Have ALL Asserts been disabled? if ( !g_bAssertsEnabled ) return false; // Has this specific Assert been disabled? if ( !AreAssertsEnabledInFileLine( pFilename, line ) ) return false; // Now create the dialog. g_Info.m_pFilename = pFilename; g_Info.m_iLine = line; g_Info.m_pExpression = pExpression; if ( AssertStack() ) { IgnoreAssertsNearby( 0 ); // @TODO: add-back callstack spew support Warning( "%s (%d) : Assertion callstack...(NOT IMPLEMENTED IN NEW LOGGING SYSTEM.)\n", pFilename, line ); // Warning_SpewCallStack( 10, "%s (%d) : Assertion callstack...\n", pFilename, line ); return false; } if( AllAssertOnce() ) { IgnoreAssertsNearby( 0 ); } g_bBreak = false; #if defined( _X360 ) char cmdString[XBX_MAX_RCMDLENGTH]; // Before calling VXConsole, init the global variable that receives the result g_VXConsoleAssertReturnValue = -1; // Message VXConsole to pop up a PC-side Assert dialog _snprintf( cmdString, sizeof(cmdString), "Assert() 0x%.8x File: %s\tLine: %d\t%s", &g_VXConsoleAssertReturnValue, pFilename, line, pExpression ); XBX_SendRemoteCommand( cmdString, false ); // We sent a synchronous message, so g_xbx_dbgVXConsoleAssertReturnValue should have been overwritten by now if ( g_VXConsoleAssertReturnValue == -1 ) { // VXConsole isn't connected/running - default to the old behaviour (break) g_bBreak = true; } else { // Respond to what the user selected switch( g_VXConsoleAssertReturnValue ) { case ASSERT_ACTION_IGNORE_FILE: IgnoreAssertsInCurrentFile(); break; case ASSERT_ACTION_IGNORE_THIS: // Ignore this Assert once break; case ASSERT_ACTION_BREAK: // Break on this Assert g_bBreak = true; break; case ASSERT_ACTION_IGNORE_ALL: // Ignore all Asserts from now on g_bAssertsEnabled = false; break; case ASSERT_ACTION_IGNORE_ALWAYS: // Ignore this Assert from now on IgnoreAssertsNearby( 0 ); break; case ASSERT_ACTION_OTHER: default: // Error... just break XBX_Error( "DoNewAssertDialog: invalid Assert response returned from VXConsole - breaking to debugger" ); g_bBreak = true; break; } } #elif defined( _PS3 ) // There are a few ways to handle this sort of assert behavior with the PS3 / Target Manager API. // One is to use a DebuggerBreak per usual, and then SNProcessContinue in the TMAPI to make // the game resume after a breakpoint. (You can use snIsDebuggerPresent() to determine if // the debugger is attached, although really it doesn't matter here.) // This doesn't work because the DebuggerBreak() is actually an interrupt op, and so Continue() // won't continue past it -- you need to do that from inside the ProDG debugger itself. // Another is to wait on a mutex here and then trip it from the TMAPI, but there isn't // a clean way to trip sync primitives from TMAPI. // Another way is to suspend the thread here and have TMAPI resume it. // The simplest way is to spin-wait on a shared variable that you expect the // TMAPI to poke into memory. I'm trying that. char cmdString[XBX_MAX_RCMDLENGTH]; // Before calling VXConsole, init the global variable that receives the result g_VXConsoleAssertReturnValue = -1; // Message VXConsole to pop up a PC-side Assert dialog _snprintf( cmdString, sizeof(cmdString), "Assert() 0x%.8x File: %s\tLine: %d\t%s", &g_VXConsoleAssertReturnValue, pFilename, line, pExpression ); XBX_SendRemoteCommand( cmdString, false ); if ( g_pValvePS3Console->IsConsoleConnected() ) { // DebuggerBreak(); while ( g_VXConsoleAssertReturnValue == -1 ) { ThreadSleep( 1000 ); } // assume that the VX has poked the return value // Respond to what the user selected switch( g_VXConsoleAssertReturnValue ) { case ASSERT_ACTION_IGNORE_FILE: IgnoreAssertsInCurrentFile(); break; case ASSERT_ACTION_IGNORE_THIS: // Ignore this Assert once break; case ASSERT_ACTION_BREAK: // Break on this Assert g_bBreak = true; break; case ASSERT_ACTION_IGNORE_ALL: // Ignore all Asserts from now on g_bAssertsEnabled = false; break; case ASSERT_ACTION_IGNORE_ALWAYS: // Ignore this Assert from now on IgnoreAssertsNearby( 0 ); break; case ASSERT_ACTION_OTHER: default: // nothing. break; } } else if ( g_pValvePS3Console->IsDebuggerPresent() ) { g_bBreak = true; } else { // ignore the assert } #elif defined( _WIN32 ) if ( !g_hTier0Instance || !ThreadInMainThread() ) { int result = MessageBox( NULL, pExpression, "Assertion Failed", MB_SYSTEMMODAL | MB_CANCELTRYCONTINUE ); if ( result == IDCANCEL ) { IgnoreAssertsNearby( 0 ); } else if ( result == IDCONTINUE ) { g_bBreak = true; } } else { HWND hParentWindow = FindLikelyParentWindow(); DialogBox( g_hTier0Instance, MAKEINTRESOURCE( IDD_ASSERT_DIALOG ), hParentWindow, AssertDialogProc ); } #elif defined( LINUX ) || defined( USE_SDL ) #define COLOR_YELLOW "\033[1;33m" #define COLOR_GREEN "\033[1;32m" #define COLOR_RED "\033[1;31m" #define COLOR_END "\033[0m" fprintf(stderr, COLOR_YELLOW "ASSERT: " COLOR_RED "%s" COLOR_GREEN ":%i:" COLOR_RED "%s" COLOR_END "\n", pFilename, line, pExpression); static FUNC_SDL_ShowMessageBox *pfnSDLShowMessageBox = NULL; static FUNC_SDL_GetKeyboardFocus *pfnSDLGetKeyboardFocus = NULL; if( getenv( "GAME_ASSERT_DIALOG" ) && !pfnSDLShowMessageBox ) { #if defined( WIN32 ) HMODULE ret = LoadLibrary( "SDL2.lib" ); pfnSDLShowMessageBox = ( FUNC_SDL_ShowMessageBox * )GetProcAddress( ret, "SDL_ShowMessageBox" ); pfnSDLGetKeyboardFocus = ( FUNC_SDL_GetKeyboardFocus * )GetProcAddress( ret, "SDL_GetKeyboardFocus" ); #else #if defined( OSX ) void *ret = dlopen( "libSDL2-2.0.0.dylib", RTLD_LAZY ); #else void *ret = dlopen( "libSDL2-2.0.so.0", RTLD_LAZY ); #endif pfnSDLShowMessageBox = ( FUNC_SDL_ShowMessageBox * )dlsym( ret, "SDL_ShowMessageBox" ); pfnSDLGetKeyboardFocus = ( FUNC_SDL_GetKeyboardFocus * )dlsym( ret, "SDL_GetKeyboardFocus" ); #endif } if( pfnSDLShowMessageBox ) { int buttonid; char text[ 4096 ]; SDL_MessageBoxData messageboxdata = { 0 }; const char *DefaultAction = Plat_IsInDebugSession() ? "Break" : "Corefile"; SDL_MessageBoxButtonData buttondata[] = { { SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, IDC_BREAK, DefaultAction }, { SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, IDC_IGNORE_THIS, "Ignore" }, { 0, IDC_IGNORE_FILE, "Ignore This File" }, { 0, IDC_IGNORE_ALWAYS, "Always Ignore" }, { 0, IDC_IGNORE_ALL, "Ignore All Asserts" }, }; _snprintf( text, sizeof( text ), "File: %s\nLine: %i\nExpr: %s\n", pFilename, line, pExpression ); text[ sizeof( text ) - 1 ] = 0; messageboxdata.window = g_SDLWindow; messageboxdata.title = "Assertion Failed"; messageboxdata.message = text; messageboxdata.numbuttons = ARRAYSIZE( buttondata ); messageboxdata.buttons = buttondata; int Ret = ( *pfnSDLShowMessageBox )( &messageboxdata, &buttonid ); if( Ret == -1 ) { buttonid = IDC_BREAK; } switch( buttonid ) { default: case IDC_BREAK: // Break on this Assert g_bBreak = true; break; case IDC_IGNORE_THIS: // Ignore this Assert once break; case IDC_IGNORE_FILE: IgnoreAssertsInCurrentFile(); break; case IDC_IGNORE_ALWAYS: // Ignore this Assert from now on IgnoreAssertsNearby( 0 ); break; case IDC_IGNORE_ALL: // Ignore all Asserts from now on g_bAssertsEnabled = false; break; } } else if ( getenv( "RAISE_ON_ASSERT" ) ) { g_bBreak = true; } #elif defined( POSIX ) fprintf(stderr, "%s %i %s\n", pFilename, line, pExpression); if ( getenv( "RAISE_ON_ASSERT" ) ) { g_bBreak = true; } #endif return g_bBreak; }