Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 2ec477d

Browse files
committed
Cope with Readline's failure to track SIGWINCH events outside of input.
It emerges that libreadline doesn't notice terminal window size change events unless they occur while collecting input. This is easy to stumble over if you resize the window while using a pager to look at query output, but it can be demonstrated without any pager involvement. The symptom is that queries exceeding one line are misdisplayed during subsequent input cycles, because libreadline has the wrong idea of the screen dimensions. The safest, simplest way to fix this is to call rl_reset_screen_size() just before calling readline(). That causes an extra ioctl(TIOCGWINSZ) for every command; but since it only happens when reading from a tty, the performance impact should be negligible. A more valid objection is that this still leaves a tiny window during entry to readline() wherein delivery of SIGWINCH will be missed; but the practical consequences of that are probably negligible. In any case, there doesn't seem to be any good way to avoid the race, since readline exposes no functions that seem safe to call from a generic signal handler --- rl_reset_screen_size() certainly isn't. It turns out that we also need an explicit rl_initialize() call, else rl_reset_screen_size() dumps core when called before the first readline() call. rl_reset_screen_size() is not present in old versions of libreadline, so we need a configure test for that. (rl_initialize() is present at least back to readline 4.0, so we won't bother with a test for it.) We would need a configure test anyway since libedit's emulation of libreadline doesn't currently include such a function. Fortunately, libedit seems not to have any corresponding bug. Merlin Moncure, adjusted a bit by me
1 parent b648b70 commit 2ec477d

File tree

4 files changed

+17
-2
lines changed

4 files changed

+17
-2
lines changed

configure

+1-1
Original file line numberDiff line numberDiff line change
@@ -13232,7 +13232,7 @@ if test x"$pgac_cv_var_rl_completion_append_character" = x"yes"; then
1323213232
$as_echo "#define HAVE_RL_COMPLETION_APPEND_CHARACTER 1" >>confdefs.h
1323313233

1323413234
fi
13235-
for ac_func in rl_completion_matches rl_filename_completion_function
13235+
for ac_func in rl_completion_matches rl_filename_completion_function rl_reset_screen_size
1323613236
do :
1323713237
as_ac_var=`$as_echo "ac_cv_func_$ac_func" | $as_tr_sh`
1323813238
ac_fn_c_check_func "$LINENO" "$ac_func" "$as_ac_var"

configure.in

+1-1
Original file line numberDiff line numberDiff line change
@@ -1635,7 +1635,7 @@ LIBS="$LIBS_including_readline"
16351635

16361636
if test "$with_readline" = yes; then
16371637
PGAC_VAR_RL_COMPLETION_APPEND_CHARACTER
1638-
AC_CHECK_FUNCS([rl_completion_matches rl_filename_completion_function])
1638+
AC_CHECK_FUNCS([rl_completion_matches rl_filename_completion_function rl_reset_screen_size])
16391639
AC_CHECK_FUNCS([append_history history_truncate_file])
16401640
fi
16411641

src/bin/psql/input.c

+12
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,17 @@ gets_interactive(const char *prompt)
6565
{
6666
char *result;
6767

68+
/*
69+
* Some versions of readline don't notice SIGWINCH signals that arrive
70+
* when not actively reading input. The simplest fix is to always
71+
* re-read the terminal size. This leaves a window for SIGWINCH to be
72+
* missed between here and where readline() enables libreadline's
73+
* signal handler, but that's probably short enough to be ignored.
74+
*/
75+
#ifdef HAVE_RL_RESET_SCREEN_SIZE
76+
rl_reset_screen_size();
77+
#endif
78+
6879
/* Enable SIGINT to longjmp to sigint_interrupt_jmp */
6980
sigint_interrupt_enabled = true;
7081

@@ -330,6 +341,7 @@ initializeInput(int flags)
330341
char home[MAXPGPATH];
331342

332343
useReadline = true;
344+
rl_initialize();
333345
initialize_readline();
334346

335347
useHistory = true;

src/include/pg_config.h.in

+3
Original file line numberDiff line numberDiff line change
@@ -428,6 +428,9 @@
428428
/* Define to 1 if you have the `rl_filename_completion_function' function. */
429429
#undef HAVE_RL_FILENAME_COMPLETION_FUNCTION
430430

431+
/* Define to 1 if you have the `rl_reset_screen_size' function. */
432+
#undef HAVE_RL_RESET_SCREEN_SIZE
433+
431434
/* Define to 1 if you have the <security/pam_appl.h> header file. */
432435
#undef HAVE_SECURITY_PAM_APPL_H
433436

0 commit comments

Comments
 (0)