dbgrptt.cpp File Reference

#include <corecrt_internal.h>
#include <errno.h>
#include <malloc.h>
#include <minmax.h>
#include <stdio.h>
#include <stdlib.h>

Include dependency graph for dbgrptt.cpp:

Go to the source code of this file.

Macros
#define	_DEBUG
#define	ASSERTINTRO1   "Assertion failed: "
#define	ASSERTINTRO2   "Assertion failed!"

Functions
int __cdecl	__acrt_MessageWindowA (int report_type, void *return_address, char const *file_name, char const *line_number, char const *module_name, char const *user_message)
int __cdecl	__acrt_MessageWindowW (int report_type, void *return_address, wchar_t const *file_name, wchar_t const *line_number, wchar_t const *module_name, wchar_t const *user_message)
int __cdecl	_CrtSetReportMode (int nRptType, int fMode)
_HFILE __cdecl	_CrtSetReportFile (int nRptType, _HFILE hFile)
_CRT_REPORT_HOOK __cdecl	_CrtSetReportHook (_CRT_REPORT_HOOK pfnNewHook)
_CRT_REPORT_HOOK __cdecl	_CrtGetReportHook (void)
int __cdecl	_VCrtDbgReportA (int nRptType, void *returnAddress, char const *szFile, int nLine, char const *szModule, char const *szFormat, va_list arglist)
int __cdecl	_VCrtDbgReportW (int nRptType, void *returnAddress, wchar_t const *szFile, int nLine, wchar_t const *szModule, wchar_t const *szFormat, va_list arglist)

Variables
_CRT_REPORT_HOOK	_pfnReportHook
__crt_report_hook_node< char > *	_pReportHookList
__crt_report_hook_node< wchar_t > *	_pReportHookListW
long	_crtAssertBusy = -1
int	_CrtDbgMode [_CRT_ERRCNT]
_HFILE	_CrtDbgFile [_CRT_ERRCNT]

Macro Definition Documentation

_DEBUG

#define _DEBUG

Definition at line 12 of file dbgrptt.cpp.

ASSERTINTRO1

#define ASSERTINTRO1   "Assertion failed: "

Definition at line 214 of file dbgrptt.cpp.

ASSERTINTRO2

#define ASSERTINTRO2   "Assertion failed!"

Definition at line 215 of file dbgrptt.cpp.

Function Documentation

__acrt_MessageWindowA()

int __cdecl __acrt_MessageWindowA	(	int	report_type,
		void *	return_address,
		char const *	file_name,
		char const *	line_number,
		char const *	module_name,
		char const *	user_message
	)

Definition at line 443 of file dbgrpt.cpp.

{
    return common_message_window(report_type, return_address, file_name, line_number, module_name, user_message);
}

Referenced by _VCrtDbgReportA().

__acrt_MessageWindowW()

int __cdecl __acrt_MessageWindowW	(	int	report_type,
		void *	return_address,
		wchar_t const *	file_name,
		wchar_t const *	line_number,
		wchar_t const *	module_name,
		wchar_t const *	user_message
	)

Definition at line 455 of file dbgrpt.cpp.

{
    return common_message_window(report_type, return_address, file_name, line_number, module_name, user_message);
}

Referenced by _VCrtDbgReportW().

_CrtGetReportHook()

_CRT_REPORT_HOOK __cdecl _CrtGetReportHook

(

void

)

Definition at line 209 of file dbgrptt.cpp.

{
    return _pfnReportHook;
}

_CrtSetReportFile()

_HFILE __cdecl _CrtSetReportFile	(	int	nRptType,
		_HFILE	hFile
	)

Definition at line 143 of file dbgrptt.cpp.

{
    _HFILE oldFile;
 
    /* validation section */
    _VALIDATE_RETURN(nRptType >= 0 && nRptType < _CRT_ERRCNT, EINVAL, _CRTDBG_HFILE_ERROR);
 
    if (hFile == _CRTDBG_REPORT_FILE)
        return _CrtDbgFile[nRptType];
 
    oldFile = _CrtDbgFile[nRptType];
 
    if (_CRTDBG_FILE_STDOUT == hFile)
        _CrtDbgFile[nRptType] = GetStdHandle(STD_OUTPUT_HANDLE);
    else if (_CRTDBG_FILE_STDERR == hFile)
        _CrtDbgFile[nRptType] = GetStdHandle(STD_ERROR_HANDLE);
    else
        _CrtDbgFile[nRptType] = hFile;
 
    return oldFile;
}

_CrtSetReportHook()

_CRT_REPORT_HOOK __cdecl _CrtSetReportHook

(

_CRT_REPORT_HOOK

pfnNewHook

)

Definition at line 187 of file dbgrptt.cpp.

{
    _CRT_REPORT_HOOK pfnOldHook = _pfnReportHook;
    _pfnReportHook = pfnNewHook;
    return pfnOldHook;
}

_CrtSetReportMode()

int __cdecl _CrtSetReportMode	(	int	nRptType,
		int	fMode
	)

Definition at line 101 of file dbgrptt.cpp.

{
    int oldMode;
 
    /* validation section */
    _VALIDATE_RETURN(nRptType >= 0 && nRptType < _CRT_ERRCNT, EINVAL, -1);
    _VALIDATE_RETURN(
        fMode == _CRTDBG_REPORT_MODE ||
        (fMode & ~(_CRTDBG_MODE_FILE | _CRTDBG_MODE_DEBUG | _CRTDBG_MODE_WNDW)) == 0,
        EINVAL,
        -1);
 
    if (fMode == _CRTDBG_REPORT_MODE)
        return _CrtDbgMode[nRptType];
 
    oldMode = _CrtDbgMode[nRptType];
 
    _CrtDbgMode[nRptType] = fMode;
 
    return oldMode;
}

_VCrtDbgReportA()

int __cdecl _VCrtDbgReportA	(	int	nRptType,
		void *	returnAddress,
		char const *	szFile,
		int	nLine,
		char const *	szModule,
		char const *	szFormat,
		va_list	arglist
	)

Definition at line 241 of file dbgrptt.cpp.

{
    int retval=0;
    int handled=FALSE;
 
    char    szLineMessage[DBGRPT_MAX_MSG]{0};
    char    szOutMessage [DBGRPT_MAX_MSG]{0};
    wchar_t szOutMessage2[DBGRPT_MAX_MSG]{0};
    char    szUserMessage[DBGRPT_MAX_MSG]{0};
 
    if (nRptType < 0 || nRptType >= _CRT_ERRCNT)
        return -1;
 
    /*
     * handle the (hopefully rare) case of
     *
     * 1) ASSERT while already dealing with an ASSERT
     *      or
     * 2) two threads asserting at the same time
     */
 
    __try
    {
        if (_CRT_ASSERT == nRptType && _InterlockedIncrement(&_crtAssertBusy) > 0)
        {
            /* use only 'safe' functions -- must not assert in here! */
 
            _ERRCHECK(_itoa_s(nLine, szLineMessage, DBGRPT_MAX_MSG, 10));
 
            __acrt_OutputDebugStringA("Second Chance Assertion Failed: File ");
            __acrt_OutputDebugStringA(szFile ? szFile : "<file unknown>");
            __acrt_OutputDebugStringA(", Line ");
            __acrt_OutputDebugStringA(szLineMessage);
            __acrt_OutputDebugStringA("\n");
 
            _CrtDbgBreak();
            retval=-1;
            __leave;
        }
 
        // Leave space for ASSERTINTRO1 and "\r\n"
        if (szFormat)
        {
            int szlen = 0;
            _ERRCHECK_SPRINTF(szlen = _vsnprintf_s(szUserMessage, DBGRPT_MAX_MSG,
                                                    DBGRPT_MAX_MSG - 2- max(sizeof(ASSERTINTRO1),sizeof(ASSERTINTRO2)),
                                                    szFormat, arglist));
            if (szlen < 0)
            {
                _ERRCHECK(strcpy_s(szUserMessage, DBGRPT_MAX_MSG, DBGRPT_TOOLONGMSG));
            }
        }
 
        if (_CRT_ASSERT == nRptType)
        {
            _ERRCHECK(strcpy_s(szLineMessage, DBGRPT_MAX_MSG, szFormat ? ASSERTINTRO1 : ASSERTINTRO2));
        }
 
        _ERRCHECK(strcat_s(szLineMessage, DBGRPT_MAX_MSG, szUserMessage));
 
        if (_CRT_ASSERT == nRptType)
        {
            if (_CrtDbgMode[nRptType] & _CRTDBG_MODE_FILE)
            {
                _ERRCHECK(strcat_s(szLineMessage, DBGRPT_MAX_MSG, "\r"));
            }
 
            _ERRCHECK(strcat_s(szLineMessage, DBGRPT_MAX_MSG, "\n"));
        }
 
        if (szFile)
        {
            int szlen = 0;
            _ERRCHECK_SPRINTF(szlen = _snprintf_s(szOutMessage, DBGRPT_MAX_MSG, DBGRPT_MAX_MSG - 1, "%s(%d) : %s",
                                                    szFile, nLine, szLineMessage));
            if (szlen < 0)
            {
                _ERRCHECK(strcpy_s(szOutMessage, DBGRPT_MAX_MSG, DBGRPT_TOOLONGMSG));
            }
        }
        else
        {
            _ERRCHECK(strcpy_s(szOutMessage, DBGRPT_MAX_MSG, szLineMessage));
        }
 
        {
            size_t ret = 0;
            errno_t e = 0;
            _ERRCHECK_EINVAL_ERANGE(e = mbstowcs_s(&ret, szOutMessage2, DBGRPT_MAX_MSG, szOutMessage, _TRUNCATE));
            if(e != 0)
            {
                _ERRCHECK(wcscpy_s(szOutMessage2, DBGRPT_MAX_MSG, _CRT_WIDE(DBGRPT_INVALIDMSG)));
            }
        }
 
        /* User hook may handle report.
            We have to check the ANSI Hook2 List & then the UNICODE Hook2 List.
            Then we have check any ANSI individual Hook set through
            SetReportHook */
 
        if (_pReportHookList || _pReportHookListW)
        {
            __crt_report_hook_node<char> *pnode=nullptr;
            __crt_report_hook_node<wchar_t> *pnodeW=nullptr;
 
            __acrt_lock(__acrt_debug_lock);
            __try
            {
                for (pnode = _pReportHookList; pnode; pnode = pnode->next)
                {
                    int hook_retval=0;
                    if (pnode->hook(nRptType, szOutMessage, &hook_retval))
                    {
                        handled=TRUE;
                        retval=hook_retval;
                        __leave;
                    }
                }
 
                for (pnodeW = _pReportHookListW; pnodeW; pnodeW = pnodeW->next)
                {
                    int hook_retval=0;
                    if (pnodeW->hook(nRptType, szOutMessage2, &hook_retval))
                    {
                        handled=TRUE;
                        retval=hook_retval;
                        __leave;
                    }
                }
            }
            __finally
            {
                __acrt_unlock(__acrt_debug_lock);
            }
            __endtry
        }
 
        if (handled)
            __leave;
 
        if (_pfnReportHook)
        {
            int hook_retval=0;
            if (_pfnReportHook(nRptType, szOutMessage, &hook_retval))
            {
                retval = hook_retval;
                __leave;
            }
        }
 
        if (_CrtDbgMode[nRptType] & _CRTDBG_MODE_FILE)
        {
            if (_CrtDbgFile[nRptType] != _CRTDBG_INVALID_HFILE)
            {
                DWORD bytes_written = 0;
                WriteFile(_CrtDbgFile[nRptType], szOutMessage, static_cast<DWORD>(strlen(szOutMessage)), &bytes_written, nullptr);
            }
        }
 
        if (_CrtDbgMode[nRptType] & _CRTDBG_MODE_DEBUG)
        {
            __acrt_OutputDebugStringA(szOutMessage);
        }
 
        if (_CrtDbgMode[nRptType] & _CRTDBG_MODE_WNDW)
        {
            szLineMessage[0] = 0;
            if (nLine)
            {
                _ERRCHECK(_itoa_s(nLine, szLineMessage, DBGRPT_MAX_MSG, 10));
            }
 
            retval = __acrt_MessageWindowA(nRptType, returnAddress, szFile, (nLine ? szLineMessage : nullptr), szModule, szUserMessage);
        }
    }
    __finally
    {
        if (_CRT_ASSERT == nRptType)
        {
            _InterlockedDecrement(&_crtAssertBusy);
        }
    }
    __endtry
 
    return retval;
}

_VCrtDbgReportW()

int __cdecl _VCrtDbgReportW	(	int	nRptType,
		void *	returnAddress,
		wchar_t const *	szFile,
		int	nLine,
		wchar_t const *	szModule,
		wchar_t const *	szFormat,
		va_list	arglist
	)

Definition at line 461 of file dbgrptt.cpp.

{
    int retval=0;
    int handled=FALSE;
    wchar_t szLineMessage[DBGRPT_MAX_MSG] = {0};
    wchar_t szOutMessage[DBGRPT_MAX_MSG] = {0};
    char szOutMessage2[DBGRPT_MAX_MSG] = {0};
    wchar_t szUserMessage[DBGRPT_MAX_MSG] = {0};
 
    if (nRptType < 0 || nRptType >= _CRT_ERRCNT)
        return -1;
 
    /*
     * handle the (hopefully rare) case of
     *
     * 1) ASSERT while already dealing with an ASSERT
     *      or
     * 2) two threads asserting at the same time
     */
 
    __try
    {
        if (_CRT_ASSERT == nRptType && _InterlockedIncrement(&_crtAssertBusy) > 0)
        {
            /* use only 'safe' functions -- must not assert in here! */
 
            _ERRCHECK(_itow_s(nLine, szLineMessage, DBGRPT_MAX_MSG, 10));
 
            OutputDebugStringW(L"Second Chance Assertion Failed: File ");
            OutputDebugStringW(szFile ? szFile : L"<file unknown>");
            OutputDebugStringW(L", Line ");
            OutputDebugStringW(szLineMessage);
            OutputDebugStringW(L"\n");
 
            _CrtDbgBreak();
            retval = -1;
            __leave;
        }
 
        if (szFormat)
        {
            // Leave space for ASSERTINTRO{1,2} and "\r\n"
            size_t const max_assert_intro_count = __max(_countof(ASSERTINTRO1), _countof(ASSERTINTRO2));
            size_t const max_user_message_count = _countof(szUserMessage) - 2 - max_assert_intro_count;
 
            // Force use of the legacy stdio wide character format specifiers
            // mode for source compatibility.  If we ever revisit support for
            // the standard format specifiers, we'll need to revisit this as
            // well.
            int szlen = 0;
            _ERRCHECK_SPRINTF(szlen = __stdio_common_vsnwprintf_s(
                _CRT_INTERNAL_PRINTF_LEGACY_WIDE_SPECIFIERS,
                szUserMessage,
                _countof(szUserMessage),
                max_user_message_count,
                szFormat,
                nullptr,
                arglist));
            if (szlen < 0)
            {
                _ERRCHECK(wcscpy_s(szUserMessage, DBGRPT_MAX_MSG, _CRT_WIDE(DBGRPT_TOOLONGMSG)));
            }
        }
 
        if (_CRT_ASSERT == nRptType)
            _ERRCHECK(wcscpy_s(szLineMessage, DBGRPT_MAX_MSG, szFormat ? _CRT_WIDE(ASSERTINTRO1) : _CRT_WIDE(ASSERTINTRO2)));
 
        _ERRCHECK(wcscat_s(szLineMessage, DBGRPT_MAX_MSG, szUserMessage));
 
        if (_CRT_ASSERT == nRptType)
        {
            if (_CrtDbgMode[nRptType] & _CRTDBG_MODE_FILE)
                _ERRCHECK(wcscat_s(szLineMessage, DBGRPT_MAX_MSG, L"\r"));
            {
                _ERRCHECK(wcscat_s(szLineMessage, DBGRPT_MAX_MSG, L"\n"));
            }
        }
 
        if (szFile)
        {
            int szlen = 0;
            _ERRCHECK_SPRINTF(szlen = _snwprintf_s(szOutMessage, DBGRPT_MAX_MSG, DBGRPT_MAX_MSG, L"%ls(%d) : %ls",
                                                    szFile, nLine, szLineMessage));
            if (szlen < 0)
                _ERRCHECK(wcscpy_s(szOutMessage, DBGRPT_MAX_MSG, _CRT_WIDE(DBGRPT_TOOLONGMSG)));
        }
        else
        {
            _ERRCHECK(wcscpy_s(szOutMessage, DBGRPT_MAX_MSG, szLineMessage));
        }
 
        /* scope */
        {
            errno_t e = _ERRCHECK_EINVAL_ERANGE(wcstombs_s(nullptr, szOutMessage2, DBGRPT_MAX_MSG, szOutMessage, _TRUNCATE));
            if(e != 0)
                _ERRCHECK(strcpy_s(szOutMessage2, DBGRPT_MAX_MSG, DBGRPT_INVALIDMSG));
        }
 
        /* User hook may handle report.
            We have to check the ANSI Hook2 List & then the UNICODE Hook2 List.
            Then we have check any ANSI individual Hook set through
            SetReportHook */
 
        if (_pReportHookList || _pReportHookListW)
        {
            __crt_report_hook_node<char> *pnode=nullptr;
            __crt_report_hook_node<wchar_t> *pnodeW=nullptr;
 
            __acrt_lock(__acrt_debug_lock);
            __try
            {
                for (pnode = _pReportHookList; pnode; pnode = pnode->next)
                {
                    int hook_retval=0;
                    if (pnode->hook(nRptType, szOutMessage2, &hook_retval))
                    {
                        retval=hook_retval;
                        handled=TRUE;
                        __leave;
                    }
                }
 
                for (pnodeW = _pReportHookListW; pnodeW; pnodeW = pnodeW->next)
                {
                    int hook_retval=0;
                    if (pnodeW->hook(nRptType, szOutMessage, &hook_retval))
                    {
                        retval=hook_retval;
                        handled=TRUE;
                        __leave;
                    }
                }
            }
            __finally
            {
                __acrt_unlock(__acrt_debug_lock);
            }
            __endtry
        }
 
        if (handled)
            __leave;
 
        if(_pfnReportHook)
        {
            int hook_retval=0;
            if (_pfnReportHook(nRptType, szOutMessage2, &hook_retval))
            {
                retval = hook_retval;
                __leave;
            }
        }
 
        if ((_CrtDbgMode[nRptType] & _CRTDBG_MODE_FILE) && _CrtDbgFile[nRptType] != _CRTDBG_INVALID_HFILE)
        {
            /* Use WriteConsole for Consoles, WriteFile otherwise */
            switch (GetFileType(_CrtDbgFile[nRptType]))
            {
            case FILE_TYPE_CHAR:
            {
                DWORD characters_written = 0;
                if (WriteConsoleW(_CrtDbgFile[nRptType], szOutMessage, static_cast<DWORD>(wcslen(szOutMessage)), &characters_written, nullptr))
                    break;
 
                /* If WriteConsole fails & LastError is ERROR_INVALID_VALUE, then the console is redirected */
                if (GetLastError() != ERROR_INVALID_HANDLE)
                    break;
            }
            default:
            {
                char szaOutMessage[DBGRPT_MAX_MSG];
                size_t ret = 0;
                errno_t e = _ERRCHECK_EINVAL_ERANGE(wcstombs_s(&ret, szaOutMessage, DBGRPT_MAX_MSG, szOutMessage, _TRUNCATE));
 
                if (e != 0 && e != STRUNCATE)
                {
                    DWORD bytes_written = 0;
                    WriteFile(_CrtDbgFile[nRptType], szOutMessage, static_cast<DWORD>(wcslen(szOutMessage)) * 2, &bytes_written, nullptr);
                }
                else
                {
                    /* ret counts for the null terminator as well */
                    if (ret > 0)
                    {
                        --ret;
                    }
 
                    DWORD bytes_written = 0;
                    WriteFile(_CrtDbgFile[nRptType], szaOutMessage, static_cast<DWORD>(ret), &bytes_written, nullptr);
                }
            }
            }
        }
 
        if (_CrtDbgMode[nRptType] & _CRTDBG_MODE_DEBUG)
        {
            ::OutputDebugStringW(szOutMessage);
        }
 
        if (_CrtDbgMode[nRptType] & _CRTDBG_MODE_WNDW)
        {
            szLineMessage[0] = 0;
            if (nLine)
            {
                _ERRCHECK(_itow_s(nLine, szLineMessage, DBGRPT_MAX_MSG, 10));
            }
            retval = __acrt_MessageWindowW(nRptType, returnAddress, szFile, (nLine ? szLineMessage : nullptr), szModule, szUserMessage);
        }
    }
    __finally
    {
        if (_CRT_ASSERT == nRptType)
        {
            _InterlockedDecrement(&_crtAssertBusy);
        }
    }
    __endtry
 
    return retval;
}

Variable Documentation

_crtAssertBusy

long _crtAssertBusy = -1

Definition at line 49 of file dbgrptt.cpp.

Referenced by _VCrtDbgReportA(), and _VCrtDbgReportW().

_CrtDbgFile

_HFILE _CrtDbgFile[_CRT_ERRCNT]

Initial value:

{
    _CRTDBG_INVALID_HFILE,
    _CRTDBG_INVALID_HFILE,
    _CRTDBG_INVALID_HFILE
}

Definition at line 77 of file dbgrptt.cpp.

Referenced by _CrtSetReportFile(), _VCrtDbgReportA(), and _VCrtDbgReportW().

_CrtDbgMode

int _CrtDbgMode[_CRT_ERRCNT]

Initial value:

{
    _CRTDBG_MODE_DEBUG,
    _CRTDBG_MODE_WNDW,
    _CRTDBG_MODE_WNDW
}

Definition at line 70 of file dbgrptt.cpp.

Referenced by _CrtSetReportMode(), _VCrtDbgReportA(), and _VCrtDbgReportW().

_pfnReportHook

_CRT_REPORT_HOOK _pfnReportHook

Definition at line 44 of file dbgrptt.cpp.

Referenced by _CrtGetReportHook(), _CrtSetReportHook(), _VCrtDbgReportA(), and _VCrtDbgReportW().

_pReportHookList

__crt_report_hook_node<char>* _pReportHookList

Definition at line 46 of file dbgrptt.cpp.

Referenced by _VCrtDbgReportA(), and _VCrtDbgReportW().

_pReportHookListW

__crt_report_hook_node<wchar_t>* _pReportHookListW

Definition at line 47 of file dbgrptt.cpp.

Referenced by _VCrtDbgReportA(), and _VCrtDbgReportW().