dbgrpt.cpp File Reference

#include <corecrt_internal.h>
#include <corecrt_internal_traits.h>
#include <intrin.h>
#include <malloc.h>
#include <minmax.h>
#include <signal.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>

Include dependency graph for dbgrpt.cpp:

Go to the source code of this file.

Macros
#define	MAXLINELEN   64

Functions
static __crt_report_hook_node< char > *&__cdecl	get_report_hook_list (char) throw ()
static __crt_report_hook_node< wchar_t > *&__cdecl	get_report_hook_list (wchar_t) throw ()
static wchar_t const *__cdecl	get_output_message_format (char) throw ()
static wchar_t const *__cdecl	get_output_message_format (wchar_t) throw ()
template<typename Character , typename Hook >
static int __cdecl	common_set_report_hook (int const mode, Hook const new_hook) throw ()
int __cdecl	_CrtSetReportHook2 (int const mode, _CRT_REPORT_HOOK const new_hook)
int __cdecl	_CrtSetReportHookW2 (int const mode, _CRT_REPORT_HOOKW const new_hook)
int __cdecl	_CrtDbgReport (int const report_type, char const *const file_name, int const line_number, char const *const module_name, char const *const format,...)
int __cdecl	_CrtDbgReportW (int const report_type, wchar_t const *const file_name, int const line_number, wchar_t const *const module_name, wchar_t const *const format,...)
template<typename Character >
static int __cdecl	common_message_window (int const report_type, void *const return_address, Character const *const file_name, Character const *const line_number, Character const *const module_name, Character const *const user_message) throw ()
int __cdecl	__acrt_MessageWindowA (int const report_type, void *const return_address, char const *const file_name, char const *const line_number, char const *const module_name, char const *const user_message)
int __cdecl	__acrt_MessageWindowW (int const report_type, void *const return_address, wchar_t const *const file_name, wchar_t const *const line_number, wchar_t const *const module_name, wchar_t const *const user_message)

Variables
_CRT_REPORT_HOOK	_pfnReportHook
__crt_report_hook_node< char > *	_pReportHookList
__crt_report_hook_node< wchar_t > *	_pReportHookListW
static wchar_t const *const	report_type_messages [_CRT_ERRCNT]
static wchar_t const *const	more_info_string

Macro Definition Documentation

MAXLINELEN

#define MAXLINELEN   64

Definition at line 204 of file dbgrpt.cpp.

Function Documentation

__acrt_MessageWindowA()

int __cdecl __acrt_MessageWindowA	(	int const	report_type,
		void *const	return_address,
		char const *const	file_name,
		char const *const	line_number,
		char const *const	module_name,
		char const *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 const	report_type,
		void *const	return_address,
		wchar_t const *const	file_name,
		wchar_t const *const	line_number,
		wchar_t const *const	module_name,
		wchar_t const *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().

_CrtDbgReport()

int __cdecl _CrtDbgReport	(	int const	report_type,
		char const *const	file_name,
		int const	line_number,
		char const *const	module_name,
		char const *const	format,
			...
	)

Definition at line 253 of file dbgrpt.cpp.

{
    va_list arglist;
    va_start(arglist, format);
    int const result = _VCrtDbgReportA(report_type, _ReturnAddress(), file_name, line_number, module_name, format, arglist);
    va_end(arglist);
    return result;
}

_CrtDbgReportW()

int __cdecl _CrtDbgReportW	(	int const	report_type,
		wchar_t const *const	file_name,
		int const	line_number,
		wchar_t const *const	module_name,
		wchar_t const *const	format,
			...
	)

Definition at line 268 of file dbgrpt.cpp.

{
    va_list arglist;
    va_start(arglist, format);
    int const result = _VCrtDbgReportW(report_type, _ReturnAddress(), file_name, line_number, module_name, format, arglist);
    va_end(arglist);
    return result;
}

_CrtSetReportHook2()

int __cdecl _CrtSetReportHook2	(	int const	mode,
		_CRT_REPORT_HOOK const	new_hook
	)

Definition at line 188 of file dbgrpt.cpp.

{
    return common_set_report_hook<char>(mode, new_hook);
}

_CrtSetReportHookW2()

int __cdecl _CrtSetReportHookW2	(	int const	mode,
		_CRT_REPORT_HOOKW const	new_hook
	)

Definition at line 196 of file dbgrpt.cpp.

{
    return common_set_report_hook<wchar_t>(mode, new_hook);
}

common_message_window()

template<typename Character >

static int __cdecl common_message_window ( int const  report_type, void *const  return_address, Character const *const  file_name, Character const *const  line_number, Character const *const  module_name, Character const *const  user_message  ) throw ( )

static

Definition at line 316 of file dbgrpt.cpp.

{
    using traits = __crt_char_traits<Character>;
 
    if (user_message == nullptr)
    {
        return 1;
    }
 
    HMODULE module = nullptr;
    if (!GetModuleHandleExW(
            GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT | GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS,
            static_cast<LPCWSTR>(return_address),
            &module))
    {
        module = nullptr;
    }
    #ifdef CRTDLL
    else if (module == reinterpret_cast<HMODULE>(&__ImageBase))
    {
        // If the message was reported from within the CRT DLL, report it as
        // having come from the EXE instead:
        module = nullptr;
    }
    #endif
 
    Character program_name[MAX_PATH + 1]{};
    if (!traits::get_module_file_name(module, program_name, static_cast<DWORD>(_countof(program_name))))
    {
        _ERRCHECK(traits::tcscpy_s(program_name, _countof(program_name), get_program_name_unknown_text(Character())));
    }
 
    // Shorten the program name:
    size_t const program_name_length = traits::tcslen(program_name);
    Character*   short_program_name  = program_name;
    if (program_name_length > MAXLINELEN)
    {
        short_program_name += program_name_length - MAXLINELEN;
        static_assert(MAXLINELEN > 3, "");
#pragma warning(push)
#pragma warning(disable:__WARNING_POTENTIAL_BUFFER_OVERFLOW_HIGH_PRIORITY) // 26015
        short_program_name[0] = '.';
        short_program_name[1] = '.';
        short_program_name[2] = '.';
#pragma warning(pop)
    }
 
    // Shorten the module name:
    size_t    const  module_name_length = module_name ? traits::tcslen(module_name) : 0;
    Character const* short_module_name  = nullptr;
    if (module_name && module_name_length > MAXLINELEN)
    {
        short_module_name = module_name + module_name_length - MAXLINELEN + 3;
    }
 
    static Character const empty_string[] = { '\0' };
 
    wchar_t message_buffer[DBGRPT_MAX_MSG];
    int const sprintf_result = _snwprintf_s(
        message_buffer,
        _countof(message_buffer),
        _countof(message_buffer) - 1,
 
        get_output_message_format(Character()),
 
        report_type_messages[report_type],
        short_program_name,
        module_name ? L"\nModule: " : L"",
        short_module_name ? L"..." : L"",
        short_module_name ? short_module_name : (module_name ? module_name : empty_string),
        file_name ? L"\nFile: " : L"",
        file_name ? file_name : empty_string,
        line_number ? L"\nLine: " : L"",
        line_number ? line_number : empty_string,
        user_message[0] ? L"\n\n" : L"",
        user_message[0] && _CRT_ASSERT == report_type ? L"Expression: " : L"",
        user_message[0] ? user_message : empty_string,
        _CRT_ASSERT == report_type ? more_info_string : L"");
 
    _ERRCHECK_SPRINTF(sprintf_result);
 
    if (sprintf_result < 0)
    {
        _ERRCHECK(wcscpy_s(message_buffer, DBGRPT_MAX_MSG, _CRT_WIDE(DBGRPT_TOOLONGMSG)));
    }
 
    int const message_box_result = __acrt_show_wide_message_box(
        message_buffer,
        L"Microsoft Visual C++ Runtime Library",
        MB_TASKMODAL | MB_ICONHAND | MB_ABORTRETRYIGNORE | MB_SETFOREGROUND);
 
    switch (message_box_result)
    {
    case IDABORT: // Abort:  Terminate execution
    {
        // Note that even though we are "aborting," we do not call abort()
        // because we do not want to invoke Watson (the user has already had an
        // opportunity to debug the error and chose not to).
        __crt_signal_handler_t const sigabrt_action = __acrt_get_sigabrt_handler();
        if (sigabrt_action != SIG_DFL)
        {
            raise(SIGABRT);
        }
 
        TerminateProcess(GetCurrentProcess(), 3);
    }
 
    case IDRETRY:
    {
        return 1; // Retry:  Debug break
    }
 
    case IDIGNORE:
    default:
    {
        return 0; // Ignore:  Continue execution
    }
    }
}

Referenced by __acrt_MessageWindowA(), and __acrt_MessageWindowW().

common_set_report_hook()

template<typename Character , typename Hook >

static int __cdecl common_set_report_hook ( int const  mode, Hook const  new_hook  ) throw ( )

static

Definition at line 88 of file dbgrpt.cpp.

{
    using node_type = __crt_report_hook_node<Character>;
 
    _VALIDATE_RETURN(mode == _CRT_RPTHOOK_INSTALL || mode == _CRT_RPTHOOK_REMOVE, EINVAL, -1);
    _VALIDATE_RETURN(new_hook != nullptr,                                         EINVAL, -1);
 
    return __acrt_lock_and_call(__acrt_debug_lock, [&]
    {
        node_type*& hook_list = get_report_hook_list(Character());
 
        node_type* p;
        int ret = 0;
 
        // Search for new hook function to see if it's already installed
        for (p = hook_list; p != nullptr; p = p->next)
            if (p->hook == new_hook)
                break;
 
        if (mode == _CRT_RPTHOOK_REMOVE)
        {
            // Remove request - free list node if refcount goes to zero
            if (p != nullptr)
            {
                if ((ret = --p->refcount) == 0)
                {
                    if (p->next)
                    {
                        p->next->prev = p->prev;
                    }
                    if (p->prev)
                    {
                        p->prev->next = p->next;
                    }
                    else
                    {
                        hook_list = p->next;
                    }
 
                    _free_crt(p);
                }
            }
            else
            {
                _ASSERTE(("The hook function is not in the list!", 0));
                errno = EINVAL;
                return -1;
            }
        }
        else
        {
            // Insert request
            if (p != nullptr)
            {
                // Hook function already registered, move to head of list
                ret = ++p->refcount;
                if (p != hook_list)
                {
                    if (p->next)
                        p->next->prev = p->prev;
                    p->prev->next = p->next;
                    p->prev = nullptr;
                    p->next = hook_list;
                    hook_list->prev = p;
                    hook_list = p;
                }
            }
            else
            {
                // Hook function not already registered, insert new node
                __crt_unique_heap_ptr<node_type> new_node(_calloc_crt_t(node_type, 1));
                if (!new_node)
                {
                    ret = -1;
                    errno = ENOMEM;
                }
                else
                {
                    new_node.get()->prev = nullptr;
                    new_node.get()->next = hook_list;
 
                    if (hook_list)
                    {
                        hook_list->prev = new_node.get();
                    }
 
                    ret = new_node.get()->refcount = 1;
                    new_node.get()->hook = new_hook;
                    hook_list = new_node.detach();
                }
            }
        }
 
        return ret;
    });
}

get_output_message_format() [1/2]

static wchar_t const *__cdecl get_output_message_format ( char  ) throw ( )

static

Definition at line 47 of file dbgrpt.cpp.

{
    return L"Debug %ls!\n\nProgram: %hs%ls%ls%hs%ls%hs%ls%hs%ls%ls%hs%ls\n\n(Press Retry to debug the application)\n";
}

Referenced by common_message_window().

get_output_message_format() [2/2]

static wchar_t const *__cdecl get_output_message_format ( wchar_t  ) throw ( )

static

Definition at line 52 of file dbgrpt.cpp.

{
    return L"Debug %ls!\n\nProgram: %ls%ls%ls%ls%ls%ls%ls%ls%ls%ls%ls%ls\n\n(Press Retry to debug the application)\n";
}

get_report_hook_list() [1/2]

static __crt_report_hook_node< char > *&__cdecl get_report_hook_list ( char  ) throw ( )

static

Definition at line 34 of file dbgrpt.cpp.

{ return _pReportHookList;  }

Referenced by common_set_report_hook().

get_report_hook_list() [2/2]

static __crt_report_hook_node< wchar_t > *&__cdecl get_report_hook_list ( wchar_t  ) throw ( )

static

Definition at line 35 of file dbgrpt.cpp.

{ return _pReportHookListW; }

Variable Documentation

_pfnReportHook

_CRT_REPORT_HOOK _pfnReportHook

Definition at line 30 of file dbgrpt.cpp.

_pReportHookList

__crt_report_hook_node<char>* _pReportHookList

Definition at line 31 of file dbgrpt.cpp.

Referenced by get_report_hook_list().

_pReportHookListW

__crt_report_hook_node<wchar_t>* _pReportHookListW

Definition at line 32 of file dbgrpt.cpp.

Referenced by get_report_hook_list().

more_info_string

wchar_t const* const more_info_string

static

Initial value:

=
    L"\n\nFor information on how your program can cause an assertion"
    L"\nfailure, see the Visual C++ documentation on asserts."

Definition at line 57 of file dbgrpt.cpp.

Referenced by common_message_window().

report_type_messages

wchar_t const* const report_type_messages[_CRT_ERRCNT]

static

Initial value:

=
{
    L"Warning",
    L"Error",
    L"Assertion Failed"
}

Definition at line 37 of file dbgrpt.cpp.

Referenced by common_message_window().