1 /* trap.c -- Not the trap command, but useful functions for manipulating
2 those objects. The trap command is in builtins/trap.def. */
4 /* Copyright (C) 1987, 1991 Free Software Foundation, Inc.
6 This file is part of GNU Bash, the Bourne Again SHell.
8 Bash is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 1, or (at your option) any later
13 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License along
19 with Bash; see the file COPYING. If not, write to the Free Software
20 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
26 #include "bashtypes.h"
31 #if defined (HAVE_UNISTD_H)
37 #include "builtins/common.h"
39 /* Flags which describe the current handling state of a signal. */
40 #define SIG_INHERITED 0x0 /* Value inherited from parent. */
41 #define SIG_TRAPPED 0x1 /* Currently trapped. */
42 #define SIG_HARD_IGNORE 0x2 /* Signal was ignored on shell entry. */
43 #define SIG_SPECIAL 0x4 /* Treat this signal specially. */
44 #define SIG_NO_TRAP 0x8 /* Signal cannot be trapped. */
45 #define SIG_INPROGRESS 0x10 /* Signal handler currently executing. */
46 #define SIG_CHANGED 0x20 /* Trap value changed in trap handler. */
47 #define SIG_IGNORED 0x40 /* The signal is currently being ignored. */
49 /* An array of such flags, one for each signal, describing what the
50 shell will do with a signal. DEBUG_TRAP == NSIG; some code below
52 static int sigmodes
[NSIG
+1];
54 static void change_signal (), restore_signal ();
56 /* Variables used here but defined in other files. */
57 extern int interactive_shell
, interactive
;
58 extern int interrupt_immediately
;
59 extern int last_command_exit_value
;
60 extern int line_number
;
62 /* The list of things to do originally, before we started trapping. */
63 SigHandler
*original_signals
[NSIG
];
65 /* For each signal, a slot for a string, which is a command to be
66 executed when that signal is recieved. The slot can also contain
67 DEFAULT_SIG, which means do whatever you were going to do before
68 you were so rudely interrupted, or IGNORE_SIG, which says ignore
70 char *trap_list
[NSIG
+1];
72 /* A bitmap of signals received for which we have trap handlers. */
73 int pending_traps
[NSIG
];
75 /* Set to the number of the signal we're running the trap for + 1.
76 Used in execute_cmd.c and builtins/common.c to clean up when
77 parse_and_execute does not return normally after executing the
78 trap command (e.g., when `return' is executed in the trap command). */
81 /* The value of line_number when the trap started executing, since
82 parse_and_execute resets it to 1 and the trap command might want
86 /* A value which can never be the target of a trap handler. */
87 #define IMPOSSIBLE_TRAP_HANDLER (SigHandler *)initialize_traps
94 trap_list
[EXIT_TRAP
] = trap_list
[DEBUG_TRAP
] = (char *)NULL
;
95 sigmodes
[EXIT_TRAP
] = sigmodes
[DEBUG_TRAP
] = SIG_INHERITED
;
96 original_signals
[EXIT_TRAP
] = IMPOSSIBLE_TRAP_HANDLER
;
98 for (i
= 1; i
< NSIG
; i
++)
100 pending_traps
[i
] = 0;
101 trap_list
[i
] = (char *)DEFAULT_SIG
;
102 sigmodes
[i
] = SIG_INHERITED
;
103 original_signals
[i
] = IMPOSSIBLE_TRAP_HANDLER
;
106 /* Show which signals are treated specially by the shell. */
107 #if defined (SIGCHLD)
108 original_signals
[SIGCHLD
] =
109 (SigHandler
*) set_signal_handler (SIGCHLD
, SIG_DFL
);
110 set_signal_handler (SIGCHLD
, original_signals
[SIGCHLD
]);
111 sigmodes
[SIGCHLD
] |= (SIG_SPECIAL
| SIG_NO_TRAP
);
114 original_signals
[SIGINT
] =
115 (SigHandler
*) set_signal_handler (SIGINT
, SIG_DFL
);
116 set_signal_handler (SIGINT
, original_signals
[SIGINT
]);
117 sigmodes
[SIGINT
] |= SIG_SPECIAL
;
119 original_signals
[SIGQUIT
] =
120 (SigHandler
*) set_signal_handler (SIGQUIT
, SIG_DFL
);
121 set_signal_handler (SIGQUIT
, original_signals
[SIGQUIT
]);
122 sigmodes
[SIGQUIT
] |= SIG_SPECIAL
;
126 original_signals
[SIGTERM
] =
127 (SigHandler
*)set_signal_handler (SIGTERM
, SIG_DFL
);
128 set_signal_handler (SIGTERM
, original_signals
[SIGTERM
]);
129 sigmodes
[SIGTERM
] |= SIG_SPECIAL
;
133 /* Return the print name of this signal. */
138 return ((sig
> NSIG
|| sig
< 0) ? "bad signal number" : signal_names
[sig
]);
141 /* Turn a string into a signal number, or a number into
142 a signal number. If STRING is "2", "SIGINT", or "INT",
143 then (int)2 is returned. Return NO_SIG if STRING doesn't
144 contain a valid signal descriptor. */
146 decode_signal (string
)
151 if (legal_number (string
, &sig
))
152 return ((sig
>= 0 && sig
<= NSIG
) ? (int)sig
: NO_SIG
);
154 for (sig
= 0; sig
<= NSIG
; sig
++)
155 if (strcasecmp (string
, signal_names
[sig
]) == 0 ||
156 strcasecmp (string
, &(signal_names
[sig
])[3]) == 0)
162 /* Non-zero when we catch a trapped signal. */
163 static int catch_flag
;
171 if (catch_flag
== 0) /* simple optimization */
176 /* Preserve $? when running trap. */
177 old_exit_value
= last_command_exit_value
;
179 for (sig
= 1; sig
< NSIG
; sig
++)
181 /* XXX this could be made into a counter by using
182 while (pending_traps[sig]--) instead of the if statement. */
183 if (pending_traps
[sig
])
185 #if defined (HAVE_POSIX_SIGNALS)
191 sigaddset (&set
, sig
);
192 sigprocmask (SIG_BLOCK
, &set
, &oset
);
194 # if defined (HAVE_BSD_SIGNALS)
195 int oldmask
= sigblock (sigmask (sig
));
197 #endif /* HAVE_POSIX_SIGNALS */
201 run_interrupt_trap ();
205 parse_and_execute (savestring (trap_list
[sig
]), "trap", SEVAL_NONINT
|SEVAL_NOHIST
);
207 pending_traps
[sig
] = 0;
209 #if defined (HAVE_POSIX_SIGNALS)
210 sigprocmask (SIG_SETMASK
, &oset
, (sigset_t
*)NULL
);
212 # if defined (HAVE_BSD_SIGNALS)
213 sigsetmask (oldmask
);
215 #endif /* POSIX_VERSION */
219 last_command_exit_value
= old_exit_value
;
227 (trap_list
[sig
] == (char *)DEFAULT_SIG
) ||
228 (trap_list
[sig
] == (char *)IGNORE_SIG
))
229 programming_error ("trap_handler: bad signal %d", sig
);
232 #if defined (MUST_REINSTALL_SIGHANDLERS)
233 set_signal_handler (sig
, trap_handler
);
234 #endif /* MUST_REINSTALL_SIGHANDLERS */
237 pending_traps
[sig
]++;
239 if (interrupt_immediately
)
240 run_pending_traps ();
246 #if defined (JOB_CONTROL) && defined (SIGCHLD)
247 /* Make COMMAND_STRING be executed when SIGCHLD is caught. */
249 set_sigchld_trap (command_string
)
250 char *command_string
;
252 set_signal (SIGCHLD
, command_string
);
255 /* Make COMMAND_STRING be executed when SIGCHLD is caught iff the current
256 SIGCHLD trap handler is DEFAULT_SIG. */
258 maybe_set_sigchld_trap (command_string
)
259 char *command_string
;
261 if ((sigmodes
[SIGCHLD
] & SIG_TRAPPED
) == 0)
262 set_signal (SIGCHLD
, command_string
);
264 #endif /* JOB_CONTROL && SIGCHLD */
267 set_debug_trap (command
)
270 set_signal (DEBUG_TRAP
, command
);
274 set_sigint_trap (command
)
277 set_signal (SIGINT
, command
);
280 /* Reset the SIGINT handler so that subshells that are doing `shellsy'
281 things, like waiting for command substitution or executing commands
282 in explicit subshells ( ( cmd ) ), can catch interrupts properly. */
284 set_sigint_handler ()
286 if (sigmodes
[SIGINT
] & SIG_HARD_IGNORE
)
287 return ((SigHandler
*)SIG_IGN
);
289 else if (sigmodes
[SIGINT
] & SIG_IGNORED
)
290 return ((SigHandler
*)set_signal_handler (SIGINT
, SIG_IGN
)); /* XXX */
292 else if (sigmodes
[SIGINT
] & SIG_TRAPPED
)
293 return ((SigHandler
*)set_signal_handler (SIGINT
, trap_handler
));
295 /* The signal is not trapped, so set the handler to the shell's special
296 interrupt handler. */
297 else if (interactive
) /* XXX - was interactive_shell */
298 return (set_signal_handler (SIGINT
, sigint_sighandler
));
300 return (set_signal_handler (SIGINT
, termination_unwind_protect
));
303 /* Set SIG to call STRING as a command. */
305 set_signal (sig
, string
)
309 if (sig
== DEBUG_TRAP
|| sig
== EXIT_TRAP
)
311 change_signal (sig
, savestring (string
));
312 if (sig
== EXIT_TRAP
&& interactive
== 0)
313 initialize_terminating_signals ();
317 /* A signal ignored on entry to the shell cannot be trapped or reset, but
318 no error is reported when attempting to do so. -- Posix.2 */
319 if (sigmodes
[sig
] & SIG_HARD_IGNORE
)
322 /* Make sure we have original_signals[sig] if the signal has not yet
324 if ((sigmodes
[sig
] & SIG_TRAPPED
) == 0)
326 /* If we aren't sure of the original value, check it. */
327 if (original_signals
[sig
] == IMPOSSIBLE_TRAP_HANDLER
)
329 original_signals
[sig
] = (SigHandler
*)set_signal_handler (sig
, SIG_DFL
);
330 set_signal_handler (sig
, original_signals
[sig
]);
333 /* Signals ignored on entry to the shell cannot be trapped or reset. */
334 if (original_signals
[sig
] == SIG_IGN
)
336 sigmodes
[sig
] |= SIG_HARD_IGNORE
;
341 /* Only change the system signal handler if SIG_NO_TRAP is not set.
342 The trap command string is changed in either case. The shell signal
343 handlers for SIGINT and SIGCHLD run the user specified traps in an
344 environment in which it is safe to do so. */
345 if ((sigmodes
[sig
] & SIG_NO_TRAP
) == 0)
347 set_signal_handler (sig
, SIG_IGN
);
348 change_signal (sig
, savestring (string
));
349 set_signal_handler (sig
, trap_handler
);
352 change_signal (sig
, savestring (string
));
356 free_trap_command (sig
)
359 if ((sigmodes
[sig
] & SIG_TRAPPED
) && trap_list
[sig
] &&
360 (trap_list
[sig
] != (char *)IGNORE_SIG
) &&
361 (trap_list
[sig
] != (char *)DEFAULT_SIG
) &&
362 (trap_list
[sig
] != (char *)IMPOSSIBLE_TRAP_HANDLER
))
363 free (trap_list
[sig
]);
366 /* If SIG has a string assigned to it, get rid of it. Then give it
369 change_signal (sig
, value
)
373 if ((sigmodes
[sig
] & SIG_INPROGRESS
) == 0)
374 free_trap_command (sig
);
375 trap_list
[sig
] = value
;
377 sigmodes
[sig
] |= SIG_TRAPPED
;
378 if (value
== (char *)IGNORE_SIG
)
379 sigmodes
[sig
] |= SIG_IGNORED
;
381 sigmodes
[sig
] &= ~SIG_IGNORED
;
382 if (sigmodes
[sig
] & SIG_INPROGRESS
)
383 sigmodes
[sig
] |= SIG_CHANGED
;
386 #define GET_ORIGINAL_SIGNAL(sig) \
387 if (sig && sig < NSIG && original_signals[sig] == IMPOSSIBLE_TRAP_HANDLER) \
388 get_original_signal (sig)
391 get_original_signal (sig
)
394 /* If we aren't sure the of the original value, then get it. */
395 if (original_signals
[sig
] == (SigHandler
*)IMPOSSIBLE_TRAP_HANDLER
)
397 original_signals
[sig
] =
398 (SigHandler
*) set_signal_handler (sig
, SIG_DFL
);
399 set_signal_handler (sig
, original_signals
[sig
]);
401 /* Signals ignored on entry to the shell cannot be trapped. */
402 if (original_signals
[sig
] == SIG_IGN
)
403 sigmodes
[sig
] |= SIG_HARD_IGNORE
;
407 /* Restore the default action for SIG; i.e., the action the shell
408 would have taken before you used the trap command. This is called
409 from trap_builtin (), which takes care to restore the handlers for
410 the signals the shell treats specially. */
412 restore_default_signal (sig
)
415 if (sig
== DEBUG_TRAP
|| sig
== EXIT_TRAP
)
417 if ((sig
!= DEBUG_TRAP
) || (sigmodes
[sig
] & SIG_INPROGRESS
) == 0)
418 free_trap_command (sig
);
419 trap_list
[sig
] = (char *)NULL
;
420 sigmodes
[sig
] &= ~SIG_TRAPPED
;
421 if (sigmodes
[sig
] & SIG_INPROGRESS
)
422 sigmodes
[sig
] |= SIG_CHANGED
;
426 GET_ORIGINAL_SIGNAL (sig
);
428 /* A signal ignored on entry to the shell cannot be trapped or reset, but
429 no error is reported when attempting to do so. Thanks Posix.2. */
430 if (sigmodes
[sig
] & SIG_HARD_IGNORE
)
433 /* If we aren't trapping this signal, don't bother doing anything else. */
434 if ((sigmodes
[sig
] & SIG_TRAPPED
) == 0)
437 /* Only change the signal handler for SIG if it allows it. */
438 if ((sigmodes
[sig
] & SIG_NO_TRAP
) == 0)
439 set_signal_handler (sig
, original_signals
[sig
]);
441 /* Change the trap command in either case. */
442 change_signal (sig
, (char *)DEFAULT_SIG
);
444 /* Mark the signal as no longer trapped. */
445 sigmodes
[sig
] &= ~SIG_TRAPPED
;
448 /* Make this signal be ignored. */
453 if ((sig
== EXIT_TRAP
|| sig
== DEBUG_TRAP
) && ((sigmodes
[sig
] & SIG_IGNORED
) == 0))
455 change_signal (sig
, (char *)IGNORE_SIG
);
459 GET_ORIGINAL_SIGNAL (sig
);
461 /* A signal ignored on entry to the shell cannot be trapped or reset.
462 No error is reported when the user attempts to do so. */
463 if (sigmodes
[sig
] & SIG_HARD_IGNORE
)
466 /* If already trapped and ignored, no change necessary. */
467 if (sigmodes
[sig
] & SIG_IGNORED
)
470 /* Only change the signal handler for SIG if it allows it. */
471 if ((sigmodes
[sig
] & SIG_NO_TRAP
) == 0)
472 set_signal_handler (sig
, SIG_IGN
);
474 /* Change the trap command in either case. */
475 change_signal (sig
, (char *)IGNORE_SIG
);
478 /* Handle the calling of "trap 0". The only sticky situation is when
479 the command to be executed includes an "exit". This is why we have
480 to provide our own place for top_level to jump to. */
485 int code
, old_exit_value
;
487 old_exit_value
= last_command_exit_value
;
489 /* Run the trap only if signal 0 is trapped and not ignored, and we are not
490 currently running in the trap handler (call to exit in the list of
491 commands given to trap 0). */
492 if ((sigmodes
[EXIT_TRAP
] & SIG_TRAPPED
) &&
493 (sigmodes
[EXIT_TRAP
] & (SIG_IGNORED
|SIG_INPROGRESS
)) == 0)
495 trap_command
= savestring (trap_list
[EXIT_TRAP
]);
496 sigmodes
[EXIT_TRAP
] &= ~SIG_TRAPPED
;
497 sigmodes
[EXIT_TRAP
] |= SIG_INPROGRESS
;
499 code
= setjmp (top_level
);
502 parse_and_execute (trap_command
, "exit trap", SEVAL_NONINT
|SEVAL_NOHIST
);
503 else if (code
== EXITPROG
)
504 return (last_command_exit_value
);
506 return (old_exit_value
);
509 return (old_exit_value
);
513 run_trap_cleanup (sig
)
516 sigmodes
[sig
] &= ~(SIG_INPROGRESS
|SIG_CHANGED
);
519 /* Run a trap command for SIG. SIG is one of the signals the shell treats
522 _run_trap_internal (sig
, tag
)
526 char *trap_command
, *old_trap
;
527 int old_exit_value
, old_line_number
;
529 /* Run the trap only if SIG is trapped and not ignored, and we are not
530 currently executing in the trap handler. */
531 if ((sigmodes
[sig
] & SIG_TRAPPED
) && ((sigmodes
[sig
] & SIG_IGNORED
) == 0) &&
532 (trap_list
[sig
] != (char *)IMPOSSIBLE_TRAP_HANDLER
) &&
533 ((sigmodes
[sig
] & SIG_INPROGRESS
) == 0))
535 old_trap
= trap_list
[sig
];
536 sigmodes
[sig
] |= SIG_INPROGRESS
;
537 sigmodes
[sig
] &= ~SIG_CHANGED
; /* just to be sure */
538 trap_command
= savestring (old_trap
);
540 running_trap
= sig
+ 1;
541 old_exit_value
= last_command_exit_value
;
542 /* Need to copy the value of line_number because parse_and_execute
543 resets it to 1, and the trap command might want it. */
544 trap_line_number
= line_number
;
545 parse_and_execute (trap_command
, tag
, SEVAL_NONINT
|SEVAL_NOHIST
);
546 last_command_exit_value
= old_exit_value
;
549 sigmodes
[sig
] &= ~SIG_INPROGRESS
;
551 if (sigmodes
[sig
] & SIG_CHANGED
)
554 sigmodes
[sig
] &= ~SIG_CHANGED
;
562 if ((sigmodes
[DEBUG_TRAP
] & SIG_TRAPPED
) && (sigmodes
[DEBUG_TRAP
] & SIG_INPROGRESS
) == 0)
563 _run_trap_internal (DEBUG_TRAP
, "debug trap");
566 /* Run a trap set on SIGINT. This is called from throw_to_top_level (), and
567 declared here to localize the trap functions. */
569 run_interrupt_trap ()
571 _run_trap_internal (SIGINT
, "interrupt trap");
574 /* Free all the allocated strings in the list of traps and reset the trap
575 values to the default. */
581 for (i
= 0; i
< NSIG
+1; i
++)
583 free_trap_command (i
);
584 trap_list
[i
] = (char *)DEFAULT_SIG
;
585 sigmodes
[i
] &= ~SIG_TRAPPED
;
587 trap_list
[DEBUG_TRAP
] = trap_list
[EXIT_TRAP
] = (char *)NULL
;
590 /* Reset the handler for SIG to the original value. */
595 set_signal_handler (sig
, original_signals
[sig
]);
598 /* Set the handler signal SIG to the original and free any trap
599 command associated with it. */
604 set_signal_handler (sig
, original_signals
[sig
]);
605 change_signal (sig
, (char *)DEFAULT_SIG
);
606 sigmodes
[sig
] &= ~SIG_TRAPPED
;
610 reset_or_restore_signal_handlers (reset
)
615 /* Take care of the exit trap first */
616 if (sigmodes
[EXIT_TRAP
] & SIG_TRAPPED
)
618 free_trap_command (EXIT_TRAP
);
619 trap_list
[EXIT_TRAP
] = (char *)NULL
;
620 sigmodes
[EXIT_TRAP
] &= ~SIG_TRAPPED
;
622 for (i
= 1; i
< NSIG
; i
++)
624 if (sigmodes
[i
] & SIG_TRAPPED
)
626 if (trap_list
[i
] == (char *)IGNORE_SIG
)
627 set_signal_handler (i
, SIG_IGN
);
631 else if (sigmodes
[i
] & SIG_SPECIAL
)
637 reset_signal_handlers ()
639 reset_or_restore_signal_handlers (reset_signal
);
642 /* Reset all trapped signals to their original values. Signals set to be
643 ignored with trap '' SIGNAL should be ignored, so we make sure that they
644 are. Called by child processes after they are forked. */
646 restore_original_signals ()
648 reset_or_restore_signal_handlers (restore_signal
);
651 /* If a trap handler exists for signal SIG, then call it; otherwise just
654 maybe_call_trap_handler (sig
)
657 /* Call the trap handler for SIG if the signal is trapped and not ignored. */
658 if ((sigmodes
[sig
] & SIG_TRAPPED
) && ((sigmodes
[sig
] & SIG_IGNORED
) == 0))
663 run_interrupt_trap ();
682 signal_is_trapped (sig
)
685 return (sigmodes
[sig
] & SIG_TRAPPED
);
689 signal_is_special (sig
)
692 return (sigmodes
[sig
] & SIG_SPECIAL
);
696 signal_is_ignored (sig
)
699 return (sigmodes
[sig
] & SIG_IGNORED
);
703 set_signal_ignored (sig
)
706 sigmodes
[sig
] |= SIG_HARD_IGNORE
;
707 original_signals
[sig
] = SIG_IGN
;