glib-private.c: Add private API to override invalid parameter handler

...if supported, as in the previous commit.  We will eventually use
these private API to override the invalid parameter handler as needed
in the other parts of GLib and the tests.

We also now use _set_thread_local_invalid_parameter_handler()
instead of just _set_invalid_parameter_handler() to be safer, if
that is available.

This can be expanded upon in the future if we desire to use a stricter
or more customized invalid parameter handler.
This commit is contained in:
Chun-wei Fan 2022-11-03 00:00:31 +08:00
parent b92b17f021
commit 08e0fef632
2 changed files with 102 additions and 0 deletions

View File

@ -24,6 +24,10 @@
#include "glib-private.h"
#include "glib-init.h"
#ifdef USE_INVALID_PARAMETER_HANDLER
#include <crtdbg.h>
#endif
/**
* glib__private__:
* @arg: Do not use this argument
@ -60,7 +64,81 @@ glib__private__ (void)
g_win32_reopen_noninherited,
g_win32_handle_is_socket,
#endif
g_win32_push_empty_invalid_parameter_handler,
g_win32_pop_invalid_parameter_handler,
};
return &table;
}
#ifdef USE_INVALID_PARAMETER_HANDLER
/*
* This is the (empty) invalid parameter handler
* that is used for Visual C++ 2005 (and later) builds
* so that we can use this instead of the system automatically
* aborting the process, when calling _get_osfhandle(), isatty()
* and _commit() (via g_fsync()) and so on with an invalid file
* descriptor.
*
* This is necessary so that the gspawn helper and the test programs
* will continue to run as expected, since we are purposely or
* forced to use invalid FDs.
*
* Please see https://learn.microsoft.com/en-us/cpp/c-runtime-library/parameter-validation?view=msvc-170
* for an explanation on this.
*/
static void
empty_invalid_parameter_handler (const wchar_t *expression,
const wchar_t *function,
const wchar_t *file,
unsigned int line,
uintptr_t pReserved)
{
}
/* fallback to _set_invalid_parameter_handler() if we don't have _set_thread_local_invalid_parameter_handler() */
#ifndef HAVE__SET_THREAD_LOCAL_INVALID_PARAMETER_HANDLER
# define _set_thread_local_invalid_parameter_handler _set_invalid_parameter_handler
#endif
#endif
/*
* g_win32_push_empty_invalid_parameter_handler:
* @handler: a possibly uninitialized GWin32InvalidParameterHandler
*/
void
g_win32_push_empty_invalid_parameter_handler (GWin32InvalidParameterHandler *handler)
{
#ifdef USE_INVALID_PARAMETER_HANDLER
/* use the empty invalid parameter handler to override the default invalid parameter_handler */
handler->pushed_handler = empty_invalid_parameter_handler;
handler->old_handler = _set_thread_local_invalid_parameter_handler (handler->pushed_handler);
/* Disable the message box for assertions. */
handler->pushed_report_mode = 0;
handler->prev_report_mode = _CrtSetReportMode(_CRT_ASSERT, handler->pushed_report_mode);
#endif
}
/*
* g_win32_pop_invalid_parameter_handler:
* @handler: a GWin32InvalidParameterHandler processed with
* g_win32_push_empty_invalid_parameter_handler()
*/
void
g_win32_pop_invalid_parameter_handler (GWin32InvalidParameterHandler *handler)
{
#ifdef USE_INVALID_PARAMETER_HANDLER
G_GNUC_UNUSED _invalid_parameter_handler popped_handler;
G_GNUC_UNUSED int popped_report_mode;
/* Restore previous/default invalid parameter handler, check the value returned matches the one we previously pushed */
popped_handler = _set_thread_local_invalid_parameter_handler (handler->old_handler);
g_return_if_fail (handler->pushed_handler == popped_handler);
/* Restore the message box for assertions, check the value returned matches the one we previously pushed */
popped_report_mode = _CrtSetReportMode(_CRT_ASSERT, handler->prev_report_mode);
g_return_if_fail (handler->pushed_report_mode == popped_report_mode);
#endif
}

View File

@ -127,6 +127,21 @@ GMainContext * g_main_context_new_with_next_id (guint next_id);
# define USE_INVALID_PARAMETER_HANDLER
#endif
#ifdef USE_INVALID_PARAMETER_HANDLER
struct _GWin32InvalidParameterHandler
{
_invalid_parameter_handler old_handler;
_invalid_parameter_handler pushed_handler;
int prev_report_mode;
int pushed_report_mode;
};
#else
struct _GWin32InvalidParameterHandler
{
int unused_really;
};
#endif
#ifdef G_OS_WIN32
GLIB_AVAILABLE_IN_ALL
gchar *_glib_get_locale_dir (void);
@ -135,8 +150,13 @@ gchar *_glib_get_locale_dir (void);
GDir * g_dir_open_with_errno (const gchar *path, guint flags);
GDir * g_dir_new_from_dirp (gpointer dirp);
typedef struct _GWin32InvalidParameterHandler GWin32InvalidParameterHandler;
void g_win32_push_empty_invalid_parameter_handler (GWin32InvalidParameterHandler *items);
void g_win32_pop_invalid_parameter_handler (GWin32InvalidParameterHandler *items);
#define GLIB_PRIVATE_CALL(symbol) (glib__private__()->symbol)
typedef struct {
/* See gwakeup.c */
GWakeup * (* g_wakeup_new) (void);
@ -188,6 +208,10 @@ typedef struct {
#endif
/* See glib-private.c */
void (* g_win32_push_empty_invalid_parameter_handler) (GWin32InvalidParameterHandler *items);
void (* g_win32_pop_invalid_parameter_handler) (GWin32InvalidParameterHandler *items);
/* Add other private functions here, initialize them in glib-private.c */
} GLibPrivateVTable;