1 /* signals.c -- signal handling support for readline. */
3 /* Copyright (C) 1987-2016 Free Software Foundation, Inc.
5 This file is part of the GNU Readline Library (Readline), a library
6 for reading lines of text with interactive input and history editing.
8 Readline is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 Readline is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with Readline. If not, see <http://www.gnu.org/licenses/>.
22 #define READLINE_LIBRARY
24 #if defined (HAVE_CONFIG_H)
28 #include <stdio.h> /* Just for NULL. Yuck. */
29 #include <sys/types.h>
32 #if defined (HAVE_UNISTD_H)
34 #endif /* HAVE_UNISTD_H */
36 /* System-specific feature definitions and include files. */
39 #if defined (GWINSZ_IN_SYS_IOCTL)
40 # include <sys/ioctl.h>
41 #endif /* GWINSZ_IN_SYS_IOCTL */
43 /* Some standard library routines. */
47 #include "rlprivate.h"
49 #if defined (HANDLE_SIGNALS)
51 #if !defined (RETSIGTYPE)
52 # if defined (VOID_SIGHANDLER)
53 # define RETSIGTYPE void
55 # define RETSIGTYPE int
56 # endif /* !VOID_SIGHANDLER */
57 #endif /* !RETSIGTYPE */
59 #if defined (VOID_SIGHANDLER)
60 # define SIGHANDLER_RETURN return
62 # define SIGHANDLER_RETURN return (0)
65 /* This typedef is equivalent to the one for Function; it allows us
66 to say SigHandler *foo = signal (SIGKILL, SIG_IGN); */
67 typedef RETSIGTYPE SigHandler ();
69 #if defined (HAVE_POSIX_SIGNALS)
70 typedef struct sigaction sighandler_cxt;
71 # define rl_sigaction(s, nh, oh) sigaction(s, nh, oh)
73 typedef struct { SigHandler *sa_handler; int sa_mask, sa_flags; } sighandler_cxt;
74 # define sigemptyset(m)
75 #endif /* !HAVE_POSIX_SIGNALS */
81 static SigHandler *rl_set_sighandler PARAMS((int, SigHandler *, sighandler_cxt *));
82 static void rl_maybe_set_sighandler PARAMS((int, SigHandler *, sighandler_cxt *));
83 static void rl_maybe_restore_sighandler PARAMS((int, sighandler_cxt *));
85 static RETSIGTYPE rl_signal_handler PARAMS((int));
86 static RETSIGTYPE _rl_handle_signal PARAMS((int));
88 /* Exported variables for use by applications. */
90 /* If non-zero, readline will install its own signal handlers for
91 SIGINT, SIGTERM, SIGHUP, SIGQUIT, SIGALRM, SIGTSTP, SIGTTIN, and SIGTTOU. */
92 int rl_catch_signals = 1;
94 /* If non-zero, readline will install a signal handler for SIGWINCH. */
96 int rl_catch_sigwinch = 1;
98 int rl_catch_sigwinch = 0; /* for the readline state struct in readline.c */
101 /* Private variables. */
102 int _rl_interrupt_immediately = 0;
103 int volatile _rl_caught_signal = 0; /* should be sig_atomic_t, but that requires including <signal.h> everywhere */
105 /* If non-zero, print characters corresponding to received signals as long as
106 the user has indicated his desire to do so (_rl_echo_control_chars). */
109 int _rl_intr_char = 0;
110 int _rl_quit_char = 0;
111 int _rl_susp_char = 0;
113 static int signals_set_flag;
114 static int sigwinch_set_flag;
116 /* **************************************************************** */
118 /* Signal Handling */
120 /* **************************************************************** */
122 static sighandler_cxt old_int, old_term, old_hup, old_alrm, old_quit;
123 #if defined (SIGTSTP)
124 static sighandler_cxt old_tstp, old_ttou, old_ttin;
126 #if defined (SIGWINCH)
127 static sighandler_cxt old_winch;
130 _rl_sigcleanup_func_t *_rl_sigcleanup;
131 void *_rl_sigcleanarg;
133 /* Readline signal handler functions. */
135 /* Called from RL_CHECK_SIGNALS() macro */
137 _rl_signal_handler (sig)
140 _rl_caught_signal = 0; /* XXX */
142 #if defined (SIGWINCH)
145 rl_resize_terminal ();
146 /* XXX - experimental for now */
147 /* Call a signal hook because though we called the original signal handler
148 in rl_sigwinch_handler below, we will not resend the signal to
150 if (rl_signal_event_hook)
151 (*rl_signal_event_hook) ();
155 _rl_handle_signal (sig);
161 rl_signal_handler (sig)
164 if (_rl_interrupt_immediately)
166 _rl_interrupt_immediately = 0;
167 _rl_handle_signal (sig);
170 _rl_caught_signal = sig;
176 _rl_handle_signal (sig)
179 #if defined (HAVE_POSIX_SIGNALS)
181 #else /* !HAVE_POSIX_SIGNALS */
182 # if defined (HAVE_BSD_SIGNALS)
184 # else /* !HAVE_BSD_SIGNALS */
185 sighandler_cxt dummy_cxt; /* needed for rl_set_sighandler call */
186 # endif /* !HAVE_BSD_SIGNALS */
187 #endif /* !HAVE_POSIX_SIGNALS */
189 RL_SETSTATE(RL_STATE_SIGHANDLER);
191 #if !defined (HAVE_BSD_SIGNALS) && !defined (HAVE_POSIX_SIGNALS)
192 /* Since the signal will not be blocked while we are in the signal
193 handler, ignore it until rl_clear_signals resets the catcher. */
194 # if defined (SIGALRM)
195 if (sig == SIGINT || sig == SIGALRM)
199 rl_set_sighandler (sig, SIG_IGN, &dummy_cxt);
200 #endif /* !HAVE_BSD_SIGNALS && !HAVE_POSIX_SIGNALS */
202 /* If there's a sig cleanup function registered, call it and `deregister'
203 the cleanup function to avoid multiple calls */
206 (*_rl_sigcleanup) (sig, _rl_sigcleanarg);
214 _rl_reset_completion_state ();
215 rl_free_line_state ();
216 #if defined (READLINE_CALLBACKS)
217 rl_callback_sigcleanup ();
222 #if defined (SIGTSTP)
225 # if defined (HAVE_POSIX_SIGNALS)
226 /* Block SIGTTOU so we can restore the terminal settings to something
227 sane without stopping on SIGTTOU if we have been placed into the
228 background. Even trying to get the current terminal pgrp with
229 tcgetpgrp() will generate SIGTTOU, so we don't bother. Don't bother
230 doing this if we've been stopped on SIGTTOU; it's aready too late. */
232 sigaddset (&set, SIGTTOU);
233 sigprocmask (SIG_BLOCK, &set, (sigset_t *)NULL);
241 #if defined (SIGALRM)
244 #if defined (SIGQUIT)
247 rl_echo_signal_char (sig);
248 rl_cleanup_after_signal ();
250 #if defined (HAVE_POSIX_SIGNALS)
251 /* Unblock SIGTTOU blocked above */
252 if (sig == SIGTTIN || sig == SIGTSTP)
253 sigprocmask (SIG_UNBLOCK, &set, (sigset_t *)NULL);
256 sigprocmask (SIG_BLOCK, (sigset_t *)NULL, &set);
257 sigdelset (&set, sig);
258 #else /* !HAVE_POSIX_SIGNALS */
259 # if defined (HAVE_BSD_SIGNALS)
260 omask = sigblock (0);
261 # endif /* HAVE_BSD_SIGNALS */
262 #endif /* !HAVE_POSIX_SIGNALS */
264 #if defined (__EMX__)
265 signal (sig, SIG_ACK);
268 #if defined (HAVE_KILL)
269 kill (getpid (), sig);
271 raise (sig); /* assume we have raise */
274 /* Let the signal that we just sent through. */
275 #if defined (HAVE_POSIX_SIGNALS)
276 sigprocmask (SIG_SETMASK, &set, (sigset_t *)NULL);
277 #else /* !HAVE_POSIX_SIGNALS */
278 # if defined (HAVE_BSD_SIGNALS)
279 sigsetmask (omask & ~(sigmask (sig)));
280 # endif /* HAVE_BSD_SIGNALS */
281 #endif /* !HAVE_POSIX_SIGNALS */
283 rl_reset_after_signal ();
286 RL_UNSETSTATE(RL_STATE_SIGHANDLER);
290 #if defined (SIGWINCH)
292 rl_sigwinch_handler (sig)
297 #if defined (MUST_REINSTALL_SIGHANDLERS)
298 sighandler_cxt dummy_winch;
300 /* We don't want to change old_winch -- it holds the state of SIGWINCH
301 disposition set by the calling application. We need this state
302 because we call the application's SIGWINCH handler after updating
303 our own idea of the screen size. */
304 rl_set_sighandler (SIGWINCH, rl_sigwinch_handler, &dummy_winch);
307 RL_SETSTATE(RL_STATE_SIGHANDLER);
308 _rl_caught_signal = sig;
310 /* If another sigwinch handler has been installed, call it. */
311 oh = (SigHandler *)old_winch.sa_handler;
312 if (oh && oh != (SigHandler *)SIG_IGN && oh != (SigHandler *)SIG_DFL)
315 RL_UNSETSTATE(RL_STATE_SIGHANDLER);
318 #endif /* SIGWINCH */
320 /* Functions to manage signal handling. */
322 #if !defined (HAVE_POSIX_SIGNALS)
324 rl_sigaction (sig, nh, oh)
326 sighandler_cxt *nh, *oh;
328 oh->sa_handler = signal (sig, nh->sa_handler);
331 #endif /* !HAVE_POSIX_SIGNALS */
333 /* Set up a readline-specific signal handler, saving the old signal
334 information in OHANDLER. Return the old signal handler, like
337 rl_set_sighandler (sig, handler, ohandler)
340 sighandler_cxt *ohandler;
342 sighandler_cxt old_handler;
343 #if defined (HAVE_POSIX_SIGNALS)
344 struct sigaction act;
346 act.sa_handler = handler;
347 # if defined (SIGWINCH)
348 act.sa_flags = (sig == SIGWINCH) ? SA_RESTART : 0;
351 # endif /* SIGWINCH */
352 sigemptyset (&act.sa_mask);
353 sigemptyset (&ohandler->sa_mask);
354 sigaction (sig, &act, &old_handler);
356 old_handler.sa_handler = (SigHandler *)signal (sig, handler);
357 #endif /* !HAVE_POSIX_SIGNALS */
359 /* XXX -- assume we have memcpy */
360 /* If rl_set_signals is called twice in a row, don't set the old handler to
361 rl_signal_handler, because that would cause infinite recursion. */
362 if (handler != rl_signal_handler || old_handler.sa_handler != rl_signal_handler)
363 memcpy (ohandler, &old_handler, sizeof (sighandler_cxt));
365 return (ohandler->sa_handler);
368 /* Set disposition of SIG to HANDLER, returning old state in OHANDLER. Don't
369 change disposition if OHANDLER indicates the signal was ignored. */
371 rl_maybe_set_sighandler (sig, handler, ohandler)
374 sighandler_cxt *ohandler;
376 sighandler_cxt dummy;
379 sigemptyset (&dummy.sa_mask);
381 oh = rl_set_sighandler (sig, handler, ohandler);
382 if (oh == (SigHandler *)SIG_IGN)
383 rl_sigaction (sig, ohandler, &dummy);
386 /* Set the disposition of SIG to HANDLER, if HANDLER->sa_handler indicates the
387 signal was not being ignored. MUST only be called for signals whose
388 disposition was changed using rl_maybe_set_sighandler or for which the
389 SIG_IGN check was performed inline (e.g., SIGALRM below). */
391 rl_maybe_restore_sighandler (sig, handler)
393 sighandler_cxt *handler;
395 sighandler_cxt dummy;
397 sigemptyset (&dummy.sa_mask);
399 if (handler->sa_handler != SIG_IGN)
400 rl_sigaction (sig, handler, &dummy);
406 sighandler_cxt dummy;
408 #if defined (HAVE_POSIX_SIGNALS)
409 static int sigmask_set = 0;
410 static sigset_t bset, oset;
413 #if defined (HAVE_POSIX_SIGNALS)
414 if (rl_catch_signals && sigmask_set == 0)
418 sigaddset (&bset, SIGINT);
419 sigaddset (&bset, SIGTERM);
421 sigaddset (&bset, SIGHUP);
423 #if defined (SIGQUIT)
424 sigaddset (&bset, SIGQUIT);
426 #if defined (SIGALRM)
427 sigaddset (&bset, SIGALRM);
429 #if defined (SIGTSTP)
430 sigaddset (&bset, SIGTSTP);
432 #if defined (SIGTTIN)
433 sigaddset (&bset, SIGTTIN);
435 #if defined (SIGTTOU)
436 sigaddset (&bset, SIGTTOU);
440 #endif /* HAVE_POSIX_SIGNALS */
442 if (rl_catch_signals && signals_set_flag == 0)
444 #if defined (HAVE_POSIX_SIGNALS)
446 sigprocmask (SIG_BLOCK, &bset, &oset);
449 rl_maybe_set_sighandler (SIGINT, rl_signal_handler, &old_int);
450 rl_maybe_set_sighandler (SIGTERM, rl_signal_handler, &old_term);
452 rl_maybe_set_sighandler (SIGHUP, rl_signal_handler, &old_hup);
454 #if defined (SIGQUIT)
455 rl_maybe_set_sighandler (SIGQUIT, rl_signal_handler, &old_quit);
458 #if defined (SIGALRM)
459 oh = rl_set_sighandler (SIGALRM, rl_signal_handler, &old_alrm);
460 if (oh == (SigHandler *)SIG_IGN)
461 rl_sigaction (SIGALRM, &old_alrm, &dummy);
462 #if defined (HAVE_POSIX_SIGNALS) && defined (SA_RESTART)
463 /* If the application using readline has already installed a signal
464 handler with SA_RESTART, SIGALRM will cause reads to be restarted
465 automatically, so readline should just get out of the way. Since
466 we tested for SIG_IGN above, we can just test for SIG_DFL here. */
467 if (oh != (SigHandler *)SIG_DFL && (old_alrm.sa_flags & SA_RESTART))
468 rl_sigaction (SIGALRM, &old_alrm, &dummy);
469 #endif /* HAVE_POSIX_SIGNALS */
472 #if defined (SIGTSTP)
473 rl_maybe_set_sighandler (SIGTSTP, rl_signal_handler, &old_tstp);
476 #if defined (SIGTTOU)
477 rl_maybe_set_sighandler (SIGTTOU, rl_signal_handler, &old_ttou);
480 #if defined (SIGTTIN)
481 rl_maybe_set_sighandler (SIGTTIN, rl_signal_handler, &old_ttin);
484 signals_set_flag = 1;
486 #if defined (HAVE_POSIX_SIGNALS)
487 sigprocmask (SIG_SETMASK, &oset, (sigset_t *)NULL);
491 #if defined (SIGWINCH)
492 if (rl_catch_sigwinch && sigwinch_set_flag == 0)
494 rl_maybe_set_sighandler (SIGWINCH, rl_sigwinch_handler, &old_winch);
495 sigwinch_set_flag = 1;
497 #endif /* SIGWINCH */
505 sighandler_cxt dummy;
507 if (rl_catch_signals && signals_set_flag == 1)
509 sigemptyset (&dummy.sa_mask);
511 /* Since rl_maybe_set_sighandler doesn't override a SIG_IGN handler,
512 we should in theory not have to restore a handler where
513 old_xxx.sa_handler == SIG_IGN. That's what rl_maybe_restore_sighandler
514 does. Fewer system calls should reduce readline's per-line
516 rl_maybe_restore_sighandler (SIGINT, &old_int);
517 rl_maybe_restore_sighandler (SIGTERM, &old_term);
519 rl_maybe_restore_sighandler (SIGHUP, &old_hup);
521 #if defined (SIGQUIT)
522 rl_maybe_restore_sighandler (SIGQUIT, &old_quit);
524 #if defined (SIGALRM)
525 rl_maybe_restore_sighandler (SIGALRM, &old_alrm);
528 #if defined (SIGTSTP)
529 rl_maybe_restore_sighandler (SIGTSTP, &old_tstp);
532 #if defined (SIGTTOU)
533 rl_maybe_restore_sighandler (SIGTTOU, &old_ttou);
536 #if defined (SIGTTIN)
537 rl_maybe_restore_sighandler (SIGTTIN, &old_ttin);
540 signals_set_flag = 0;
543 #if defined (SIGWINCH)
544 if (rl_catch_sigwinch && sigwinch_set_flag == 1)
546 sigemptyset (&dummy.sa_mask);
547 rl_sigaction (SIGWINCH, &old_winch, &dummy);
548 sigwinch_set_flag = 0;
555 /* Clean up the terminal and readline state after catching a signal, before
556 resending it to the calling application. */
558 rl_cleanup_after_signal ()
560 _rl_clean_up_for_exit ();
561 if (rl_deprep_term_function)
562 (*rl_deprep_term_function) ();
563 rl_clear_pending_input ();
567 /* Reset the terminal and readline state after a signal handler returns. */
569 rl_reset_after_signal ()
571 if (rl_prep_term_function)
572 (*rl_prep_term_function) (_rl_meta_flag);
576 /* Free up the readline variable line state for the current line (undo list,
577 any partial history entry, any keyboard macros in progress, and any
578 numeric arguments in process) after catching a signal, before calling
579 rl_cleanup_after_signal(). */
581 rl_free_line_state ()
583 register HIST_ENTRY *entry;
585 rl_free_undo_list ();
587 entry = current_history ();
589 entry->data = (char *)NULL;
591 _rl_kill_kbd_macro ();
593 _rl_reset_argument ();
599 return (_rl_caught_signal);
601 #endif /* HANDLE_SIGNALS */
603 /* **************************************************************** */
605 /* SIGINT Management */
607 /* **************************************************************** */
609 #if defined (HAVE_POSIX_SIGNALS)
610 static sigset_t sigint_set, sigint_oset;
611 static sigset_t sigwinch_set, sigwinch_oset;
612 #else /* !HAVE_POSIX_SIGNALS */
613 # if defined (HAVE_BSD_SIGNALS)
614 static int sigint_oldmask;
615 static int sigwinch_oldmask;
616 # endif /* HAVE_BSD_SIGNALS */
617 #endif /* !HAVE_POSIX_SIGNALS */
619 static int sigint_blocked;
620 static int sigwinch_blocked;
622 /* Cause SIGINT to not be delivered until the corresponding call to
633 /* Allow SIGINT to be delivered. */
635 _rl_release_sigint ()
637 if (sigint_blocked == 0)
644 /* Cause SIGWINCH to not be delivered until the corresponding call to
645 release_sigwinch(). */
647 _rl_block_sigwinch ()
649 if (sigwinch_blocked)
652 #if defined (SIGWINCH)
654 #if defined (HAVE_POSIX_SIGNALS)
655 sigemptyset (&sigwinch_set);
656 sigemptyset (&sigwinch_oset);
657 sigaddset (&sigwinch_set, SIGWINCH);
658 sigprocmask (SIG_BLOCK, &sigwinch_set, &sigwinch_oset);
659 #else /* !HAVE_POSIX_SIGNALS */
660 # if defined (HAVE_BSD_SIGNALS)
661 sigwinch_oldmask = sigblock (sigmask (SIGWINCH));
662 # else /* !HAVE_BSD_SIGNALS */
663 # if defined (HAVE_USG_SIGHOLD)
665 # endif /* HAVE_USG_SIGHOLD */
666 # endif /* !HAVE_BSD_SIGNALS */
667 #endif /* !HAVE_POSIX_SIGNALS */
669 #endif /* SIGWINCH */
671 sigwinch_blocked = 1;
674 /* Allow SIGWINCH to be delivered. */
676 _rl_release_sigwinch ()
678 if (sigwinch_blocked == 0)
681 #if defined (SIGWINCH)
683 #if defined (HAVE_POSIX_SIGNALS)
684 sigprocmask (SIG_SETMASK, &sigwinch_oset, (sigset_t *)NULL);
686 # if defined (HAVE_BSD_SIGNALS)
687 sigsetmask (sigwinch_oldmask);
688 # else /* !HAVE_BSD_SIGNALS */
689 # if defined (HAVE_USG_SIGHOLD)
691 # endif /* HAVE_USG_SIGHOLD */
692 # endif /* !HAVE_BSD_SIGNALS */
693 #endif /* !HAVE_POSIX_SIGNALS */
695 #endif /* SIGWINCH */
697 sigwinch_blocked = 0;
700 /* **************************************************************** */
702 /* Echoing special control characters */
704 /* **************************************************************** */
706 rl_echo_signal_char (sig)
712 if (_rl_echoctl == 0 || _rl_echo_control_chars == 0)
717 case SIGINT: c = _rl_intr_char; break;
718 #if defined (SIGQUIT)
719 case SIGQUIT: c = _rl_quit_char; break;
721 #if defined (SIGTSTP)
722 case SIGTSTP: c = _rl_susp_char; break;
727 if (CTRL_CHAR (c) || c == RUBOUT)
730 cstr[1] = CTRL_CHAR (c) ? UNCTRL (c) : '?';
731 cstr[cslen = 2] = '\0';
736 cstr[cslen = 1] = '\0';
739 _rl_output_some_chars (cstr, cslen);