1 /* nojobs.c - functions that make children, remember them, and handle their termination. */
3 /* This file works under BSD, System V, minix, and Posix systems. It does
4 not implement job control. */
6 /* Copyright (C) 1987-2011 Free Software Foundation, Inc.
8 This file is part of GNU Bash, the Bourne Again SHell.
10 Bash is free software: you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation, either version 3 of the License, or
13 (at your option) any later version.
15 Bash is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with Bash. If not, see <http://www.gnu.org/licenses/>.
26 #include "bashtypes.h"
29 #if defined (HAVE_UNISTD_H)
37 #if defined (BUFFERED_INPUT)
41 /* Need to include this up here for *_TTY_DRIVER definitions. */
48 #include "execute_cmd.h"
51 #include "builtins/builtext.h" /* for wait_builtin */
53 #define DEFAULT_CHILD_MAX 32
55 #if defined (_POSIX_VERSION) || !defined (HAVE_KILLPG)
56 # define killpg(pg, sig) kill(-(pg),(sig))
57 #endif /* USG || _POSIX_VERSION */
59 #if !defined (HAVE_SIGINTERRUPT) && !defined (HAVE_POSIX_SIGNALS)
60 # define siginterrupt(sig, code)
61 #endif /* !HAVE_SIGINTERRUPT && !HAVE_POSIX_SIGNALS */
63 #if defined (HAVE_WAITPID)
64 # define WAITPID(pid, statusp, options) waitpid (pid, statusp, options)
66 # define WAITPID(pid, statusp, options) wait (statusp)
67 #endif /* !HAVE_WAITPID */
69 /* Return the fd from which we are actually getting input. */
70 #define input_tty() (shell_tty != -1) ? shell_tty : fileno (stderr)
76 extern int interactive
, interactive_shell
, login_shell
;
77 extern int subshell_environment
;
78 extern int last_command_exit_value
, last_command_exit_signal
;
79 extern int interrupt_immediately
;
80 extern sh_builtin_func_t
*this_shell_builtin
;
81 #if defined (HAVE_POSIX_SIGNALS)
82 extern sigset_t top_level_mask
;
84 extern procenv_t wait_intr_buf
;
85 extern int wait_intr_flag
;
86 extern int wait_signal_received
;
88 extern void set_original_signal
__P((int, SigHandler
*));
90 volatile pid_t last_made_pid
= NO_PID
;
91 volatile pid_t last_asynchronous_pid
= NO_PID
;
93 static int queue_sigchld
, waiting_for_child
; /* dummy declarations */
95 /* Call this when you start making children. */
96 int already_making_children
= 0;
98 /* The controlling tty for this shell. */
101 /* If this is non-zero, $LINES and $COLUMNS are reset after every process
102 exits from get_tty_state(). */
103 int check_window_size
= CHECKWINSIZE_DEFAULT
;
105 /* We don't have job control. */
108 int running_in_background
= 0; /* can't tell without job control */
110 /* STATUS and FLAGS are only valid if pid != NO_PID
111 STATUS is only valid if (flags & PROC_RUNNING) == 0 */
114 int status
; /* Exit status of PID or 128 + fatal signal number */
118 /* Values for proc_status.flags */
119 #define PROC_RUNNING 0x01
120 #define PROC_NOTIFIED 0x02
121 #define PROC_ASYNC 0x04
122 #define PROC_SIGNALED 0x10
124 /* Return values from find_status_by_pid */
126 #define PROC_STILL_ALIVE -2
128 static struct proc_status
*pid_list
= (struct proc_status
*)NULL
;
129 static int pid_list_size
;
130 static int wait_sigint_received
;
132 static long child_max
= -1L;
134 static void alloc_pid_list
__P((void));
135 static int find_proc_slot
__P((pid_t
));
136 static int find_index_by_pid
__P((pid_t
));
137 static int find_status_by_pid
__P((pid_t
));
138 static int process_exit_status
__P((WAIT
));
139 static int find_termsig_by_pid
__P((pid_t
));
140 static int get_termsig
__P((WAIT
));
141 static void set_pid_status
__P((pid_t
, WAIT
));
142 static void set_pid_flags
__P((pid_t
, int));
143 static void unset_pid_flags
__P((pid_t
, int));
144 static int get_pid_flags
__P((pid_t
));
145 static void add_pid
__P((pid_t
, int));
146 static void mark_dead_jobs_as_notified
__P((int));
148 static sighandler wait_sigint_handler
__P((int));
149 static char *j_strsignal
__P((int));
151 #if defined (HAVE_WAITPID)
152 static void reap_zombie_children
__P((void));
155 #if !defined (HAVE_SIGINTERRUPT) && defined (HAVE_POSIX_SIGNALS)
156 static int siginterrupt
__P((int, int));
159 static void restore_sigint_handler
__P((void));
161 /* Allocate new, or grow existing PID_LIST. */
166 int old
= pid_list_size
;
169 pid_list
= (struct proc_status
*)xrealloc (pid_list
, pid_list_size
* sizeof (struct proc_status
));
171 /* None of the newly allocated slots have process id's yet. */
172 for (i
= old
; i
< pid_list_size
; i
++)
173 pid_list
[i
].pid
= NO_PID
;
176 /* Return the offset within the PID_LIST array of an empty slot. This can
177 create new slots if all of the existing slots are taken. */
184 for (i
= 0; i
< pid_list_size
; i
++)
185 if (pid_list
[i
].pid
== NO_PID
|| pid_list
[i
].pid
== pid
)
188 if (i
== pid_list_size
)
194 /* Return the offset within the PID_LIST array of a slot containing PID,
195 or the value NO_PID if the pid wasn't found. */
197 find_index_by_pid (pid
)
202 for (i
= 0; i
< pid_list_size
; i
++)
203 if (pid_list
[i
].pid
== pid
)
209 /* Return the status of PID as looked up in the PID_LIST array. A
210 return value of PROC_BAD indicates that PID wasn't found. */
212 find_status_by_pid (pid
)
217 i
= find_index_by_pid (pid
);
220 if (pid_list
[i
].flags
& PROC_RUNNING
)
221 return (PROC_STILL_ALIVE
);
222 return (pid_list
[i
].status
);
226 process_exit_status (status
)
229 if (WIFSIGNALED (status
))
230 return (128 + WTERMSIG (status
));
232 return (WEXITSTATUS (status
));
235 /* Return the status of PID as looked up in the PID_LIST array. A
236 return value of PROC_BAD indicates that PID wasn't found. */
238 find_termsig_by_pid (pid
)
243 i
= find_index_by_pid (pid
);
246 if (pid_list
[i
].flags
& PROC_RUNNING
)
248 return (get_termsig ((WAIT
)pid_list
[i
].status
));
251 /* Set LAST_COMMAND_EXIT_SIGNAL depending on STATUS. If STATUS is -1, look
252 up PID in the pid array and set LAST_COMMAND_EXIT_SIGNAL appropriately
253 depending on its flags and exit status. */
258 if (WIFSTOPPED (status
) == 0 && WIFSIGNALED (status
))
259 return (WTERMSIG (status
));
264 /* Give PID the status value STATUS in the PID_LIST array. */
266 set_pid_status (pid
, status
)
272 #if defined (COPROCESS_SUPPORT)
273 coproc_pidchk (pid
, status
);
276 slot
= find_index_by_pid (pid
);
280 pid_list
[slot
].status
= process_exit_status (status
);
281 pid_list
[slot
].flags
&= ~PROC_RUNNING
;
282 if (WIFSIGNALED (status
))
283 pid_list
[slot
].flags
|= PROC_SIGNALED
;
284 /* If it's not a background process, mark it as notified so it gets
286 if ((pid_list
[slot
].flags
& PROC_ASYNC
) == 0)
287 pid_list
[slot
].flags
|= PROC_NOTIFIED
;
290 /* Give PID the flags FLAGS in the PID_LIST array. */
292 set_pid_flags (pid
, flags
)
298 slot
= find_index_by_pid (pid
);
302 pid_list
[slot
].flags
|= flags
;
305 /* Unset FLAGS for PID in the pid list */
307 unset_pid_flags (pid
, flags
)
313 slot
= find_index_by_pid (pid
);
317 pid_list
[slot
].flags
&= ~flags
;
320 /* Return the flags corresponding to PID in the PID_LIST array. */
327 slot
= find_index_by_pid (pid
);
331 return (pid_list
[slot
].flags
);
341 slot
= find_proc_slot (pid
);
343 pid_list
[slot
].pid
= pid
;
344 pid_list
[slot
].status
= -1;
345 pid_list
[slot
].flags
= PROC_RUNNING
;
347 pid_list
[slot
].flags
|= PROC_ASYNC
;
351 mark_dead_jobs_as_notified (force
)
354 register int i
, ndead
;
356 /* first, count the number of non-running async jobs if FORCE == 0 */
357 for (i
= ndead
= 0; force
== 0 && i
< pid_list_size
; i
++)
359 if (pid_list
[i
].pid
== NO_PID
)
361 if (((pid_list
[i
].flags
& PROC_RUNNING
) == 0) &&
362 (pid_list
[i
].flags
& PROC_ASYNC
))
367 child_max
= getmaxchild ();
369 child_max
= DEFAULT_CHILD_MAX
;
371 if (force
== 0 && ndead
<= child_max
)
374 /* If FORCE == 0, we just mark as many non-running async jobs as notified
375 to bring us under the CHILD_MAX limit. */
376 for (i
= 0; i
< pid_list_size
; i
++)
378 if (pid_list
[i
].pid
== NO_PID
)
380 if (((pid_list
[i
].flags
& PROC_RUNNING
) == 0) &&
381 pid_list
[i
].pid
!= last_asynchronous_pid
)
383 pid_list
[i
].flags
|= PROC_NOTIFIED
;
384 if (force
== 0 && (pid_list
[i
].flags
& PROC_ASYNC
) && --ndead
<= child_max
)
390 /* Remove all dead, notified jobs from the pid_list. */
396 #if defined (HAVE_WAITPID)
397 reap_zombie_children ();
400 for (i
= 0; i
< pid_list_size
; i
++)
402 if ((pid_list
[i
].flags
& PROC_RUNNING
) == 0 &&
403 (pid_list
[i
].flags
& PROC_NOTIFIED
))
404 pid_list
[i
].pid
= NO_PID
;
407 #if defined (COPROCESS_SUPPORT)
417 mark_dead_jobs_as_notified (0);
418 cleanup_dead_jobs ();
421 /* Initialize the job control mechanism, and set up the tty stuff. */
423 initialize_job_control (force
)
426 shell_tty
= fileno (stderr
);
433 /* Setup this shell to handle C-C, etc. */
435 initialize_job_signals ()
437 set_signal_handler (SIGINT
, sigint_sighandler
);
439 /* If this is a login shell we don't wish to be disturbed by
442 ignore_tty_job_signals ();
445 #if defined (HAVE_WAITPID)
446 /* Collect the status of all zombie children so that their system
447 resources can be deallocated. */
449 reap_zombie_children ()
451 # if defined (WNOHANG)
457 while ((pid
= waitpid (-1, (int *)&status
, WNOHANG
)) > 0)
458 set_pid_status (pid
, status
);
459 # endif /* WNOHANG */
465 #if !defined (HAVE_SIGINTERRUPT) && defined (HAVE_POSIX_SIGNALS)
467 #if !defined (SA_RESTART)
468 # define SA_RESTART 0
472 siginterrupt (sig
, flag
)
475 struct sigaction act
;
477 sigaction (sig
, (struct sigaction
*)NULL
, &act
);
480 act
.sa_flags
&= ~SA_RESTART
;
482 act
.sa_flags
|= SA_RESTART
;
484 return (sigaction (sig
, &act
, (struct sigaction
*)NULL
));
486 #endif /* !HAVE_SIGINTERRUPT && HAVE_POSIX_SIGNALS */
488 /* Fork, handling errors. Returns the pid of the newly made child, or 0.
489 COMMAND is just for remembering the name of the command; we don't do
490 anything else with it. ASYNC_P says what to do with the tty. If
491 non-zero, then don't give it away. */
493 make_child (command
, async_p
)
500 /* Discard saved memory. */
506 #if defined (BUFFERED_INPUT)
507 /* If default_buffered_input is active, we are reading a script. If
508 the command is asynchronous, we have already duplicated /dev/null
509 as fd 0, but have not changed the buffered stream corresponding to
510 the old fd 0. We don't want to sync the stream in this case. */
511 if (default_buffered_input
!= -1 && (!async_p
|| default_buffered_input
> 0))
512 sync_buffered_stream (default_buffered_input
);
513 #endif /* BUFFERED_INPUT */
515 /* XXX - block SIGTERM here and unblock in child after fork resets the
516 set of pending signals? */
519 /* Create the child, handle severe errors. Retry on EAGAIN. */
521 while ((pid
= fork ()) < 0 && errno
== EAGAIN
&& forksleep
< FORKSLEEP_MAX
)
523 sys_error ("fork: retry");
526 #if defined (HAVE_WAITPID)
527 /* Posix systems with a non-blocking waitpid () system call available
528 get another chance after zombies are reaped. */
529 reap_zombie_children ();
530 if (forksleep
> 1 && sleep (forksleep
) != 0)
533 if (sleep (forksleep
) != 0)
535 #endif /* HAVE_WAITPID */
545 last_command_exit_value
= EX_NOEXEC
;
546 throw_to_top_level ();
551 #if defined (BUFFERED_INPUT)
552 unset_bash_input (0);
553 #endif /* BUFFERED_INPUT */
555 CLRINTERRUPT
; /* XXX - children have their own interrupt state */
557 #if defined (HAVE_POSIX_SIGNALS)
558 /* Restore top-level signal mask. */
559 sigprocmask (SIG_SETMASK
, &top_level_mask
, (sigset_t
*)NULL
);
563 /* Ignore INT and QUIT in asynchronous children. */
565 last_asynchronous_pid
= getpid ();
568 default_tty_job_signals ();
577 last_asynchronous_pid
= pid
;
579 add_pid (pid
, async_p
);
585 ignore_tty_job_signals ()
587 #if defined (SIGTSTP)
588 set_signal_handler (SIGTSTP
, SIG_IGN
);
589 set_signal_handler (SIGTTIN
, SIG_IGN
);
590 set_signal_handler (SIGTTOU
, SIG_IGN
);
595 default_tty_job_signals ()
597 #if defined (SIGTSTP)
598 if (signal_is_trapped (SIGTSTP
) == 0 && signal_is_hard_ignored (SIGTSTP
))
599 set_signal_handler (SIGTSTP
, SIG_IGN
);
601 set_signal_handler (SIGTSTP
, SIG_DFL
);
602 if (signal_is_trapped (SIGTTIN
) == 0 && signal_is_hard_ignored (SIGTTIN
))
603 set_signal_handler (SIGTTIN
, SIG_IGN
);
605 set_signal_handler (SIGTTIN
, SIG_DFL
);
606 if (signal_is_trapped (SIGTTOU
) == 0 && signal_is_hard_ignored (SIGTTOU
))
607 set_signal_handler (SIGTTOU
, SIG_IGN
);
609 set_signal_handler (SIGTTOU
, SIG_DFL
);
613 /* Called once in a parent process. */
615 get_original_tty_job_signals ()
617 static int fetched
= 0;
621 #if defined (SIGTSTP)
622 if (interactive_shell
)
624 set_original_signal (SIGTSTP
, SIG_DFL
);
625 set_original_signal (SIGTTIN
, SIG_DFL
);
626 set_original_signal (SIGTTOU
, SIG_DFL
);
630 get_original_signal (SIGTSTP
);
631 get_original_signal (SIGTTIN
);
632 get_original_signal (SIGTTOU
);
639 /* Wait for a single pid (PID) and return its exit status. Called by
642 wait_for_single_pid (pid
, flags
)
650 pstatus
= find_status_by_pid (pid
);
652 if (pstatus
== PROC_BAD
)
654 internal_error (_("wait: pid %ld is not a child of this shell"), (long)pid
);
658 if (pstatus
!= PROC_STILL_ALIVE
)
661 last_command_exit_signal
= find_termsig_by_pid (pid
);
665 siginterrupt (SIGINT
, 1);
666 while ((got_pid
= WAITPID (pid
, &status
, 0)) != pid
)
672 if (errno
!= EINTR
&& errno
!= ECHILD
)
674 siginterrupt (SIGINT
, 0);
679 else if (got_pid
> 0)
680 set_pid_status (got_pid
, status
);
685 set_pid_status (got_pid
, status
);
686 set_pid_flags (got_pid
, PROC_NOTIFIED
);
689 siginterrupt (SIGINT
, 0);
692 return (got_pid
> 0 ? process_exit_status (status
) : -1);
695 /* Wait for all of the shell's children to exit. Called by the `wait'
698 wait_for_background_pids ()
703 /* If we aren't using job control, we let the kernel take care of the
704 bookkeeping for us. wait () will return -1 and set errno to ECHILD
705 when there are no more unwaited-for child processes on both
706 4.2 BSD-based and System V-based systems. */
708 siginterrupt (SIGINT
, 1);
710 /* Wait for ECHILD */
711 while ((got_pid
= WAITPID (-1, &status
, 0)) != -1)
712 set_pid_status (got_pid
, status
);
714 if (errno
!= EINTR
&& errno
!= ECHILD
)
716 siginterrupt (SIGINT
, 0);
720 siginterrupt (SIGINT
, 0);
723 mark_dead_jobs_as_notified (1);
724 cleanup_dead_jobs ();
728 wait_sigint_cleanup ()
732 /* Make OLD_SIGINT_HANDLER the SIGINT signal handler. */
733 #define INVALID_SIGNAL_HANDLER (SigHandler *)wait_for_background_pids
734 static SigHandler
*old_sigint_handler
= INVALID_SIGNAL_HANDLER
;
737 restore_sigint_handler ()
739 if (old_sigint_handler
!= INVALID_SIGNAL_HANDLER
)
741 set_signal_handler (SIGINT
, old_sigint_handler
);
742 old_sigint_handler
= INVALID_SIGNAL_HANDLER
;
746 /* Handle SIGINT while we are waiting for children in a script to exit.
747 All interrupts are effectively ignored by the shell, but allowed to
748 kill a running job. */
750 wait_sigint_handler (sig
)
753 SigHandler
*sigint_handler
;
755 /* If we got a SIGINT while in `wait', and SIGINT is trapped, do
756 what POSIX.2 says (see builtins/wait.def for more info). */
757 if (this_shell_builtin
&& this_shell_builtin
== wait_builtin
&&
758 signal_is_trapped (SIGINT
) &&
759 ((sigint_handler
= trap_to_sighandler (SIGINT
)) == trap_handler
))
761 last_command_exit_value
= 128+SIGINT
;
762 restore_sigint_handler ();
763 interrupt_immediately
= 0;
764 trap_handler (SIGINT
); /* set pending_traps[SIGINT] */
765 wait_signal_received
= SIGINT
;
769 if (interrupt_immediately
)
771 last_command_exit_value
= EXECUTION_FAILURE
;
772 restore_sigint_handler ();
777 wait_sigint_received
= 1;
786 static char retcode_name_buffer
[64] = { '\0' };
792 x
= retcode_name_buffer
;
793 sprintf (x
, "Signal %d", s
);
798 /* Wait for pid (one of our children) to terminate. This is called only
799 by the execution code in execute_cmd.c. */
804 int return_val
, pstatus
;
808 pstatus
= find_status_by_pid (pid
);
810 if (pstatus
== PROC_BAD
)
813 if (pstatus
!= PROC_STILL_ALIVE
)
816 last_command_exit_signal
= find_termsig_by_pid (pid
);
820 /* If we are running a script, ignore SIGINT while we're waiting for
821 a child to exit. The loop below does some of this, but not all. */
822 wait_sigint_received
= 0;
823 if (interactive_shell
== 0)
824 old_sigint_handler
= set_signal_handler (SIGINT
, wait_sigint_handler
);
826 while ((got_pid
= WAITPID (-1, &status
, 0)) != pid
) /* XXX was pid now -1 */
830 if (got_pid
< 0 && errno
== ECHILD
)
832 #if !defined (_POSIX_VERSION)
833 status
.w_termsig
= status
.w_retcode
= 0;
836 #endif /* _POSIX_VERSION */
839 else if (got_pid
< 0 && errno
!= EINTR
)
840 programming_error ("wait_for(%ld): %s", (long)pid
, strerror(errno
));
841 else if (got_pid
> 0)
842 set_pid_status (got_pid
, status
);
846 set_pid_status (got_pid
, status
);
848 #if defined (HAVE_WAITPID)
850 reap_zombie_children ();
851 #endif /* HAVE_WAITPID */
856 if (interactive_shell
== 0)
858 SigHandler
*temp_handler
;
860 temp_handler
= old_sigint_handler
;
861 restore_sigint_handler ();
863 /* If the job exited because of SIGINT, make sure the shell acts as if
864 it had received one also. */
865 if (WIFSIGNALED (status
) && (WTERMSIG (status
) == SIGINT
))
868 if (maybe_call_trap_handler (SIGINT
) == 0)
870 if (temp_handler
== SIG_DFL
)
871 termsig_handler (SIGINT
);
872 else if (temp_handler
!= INVALID_SIGNAL_HANDLER
&& temp_handler
!= SIG_IGN
)
873 (*temp_handler
) (SIGINT
);
878 /* Default return value. */
879 /* ``a full 8 bits of status is returned'' */
880 return_val
= process_exit_status (status
);
881 last_command_exit_signal
= get_termsig (status
);
883 #if defined (DONT_REPORT_SIGPIPE) && defined (DONT_REPORT_SIGTERM)
884 # define REPORTSIG(x) ((x) != SIGINT && (x) != SIGPIPE && (x) != SIGTERM)
885 #elif !defined (DONT_REPORT_SIGPIPE) && !defined (DONT_REPORT_SIGTERM)
886 # define REPORTSIG(x) ((x) != SIGINT)
887 #elif defined (DONT_REPORT_SIGPIPE)
888 # define REPORTSIG(x) ((x) != SIGINT && (x) != SIGPIPE)
890 # define REPORTSIG(x) ((x) != SIGINT && (x) != SIGTERM)
893 if ((WIFSTOPPED (status
) == 0) && WIFSIGNALED (status
) && REPORTSIG(WTERMSIG (status
)))
895 fprintf (stderr
, "%s", j_strsignal (WTERMSIG (status
)));
896 if (WIFCORED (status
))
897 fprintf (stderr
, _(" (core dumped)"));
898 fprintf (stderr
, "\n");
901 if (interactive_shell
&& subshell_environment
== 0)
903 if (WIFSIGNALED (status
) || WIFSTOPPED (status
))
908 else if (interactive_shell
== 0 && subshell_environment
== 0 && check_window_size
)
909 get_new_window_size (0, (int *)0, (int *)0);
914 /* Send PID SIGNAL. Returns -1 on failure, 0 on success. If GROUP is non-zero,
915 or PID is less than -1, then kill the process group associated with PID. */
917 kill_pid (pid
, signal
, group
)
928 result
= group
? killpg (pid
, signal
) : kill (pid
, signal
);
932 static TTYSTRUCT shell_tty_info
;
933 static int got_tty_state
;
935 /* Fill the contents of shell_tty_info with the current tty info. */
944 ttgetattr (tty
, &shell_tty_info
);
946 if (check_window_size
)
947 get_new_window_size (0, (int *)0, (int *)0);
952 /* Make the current tty use the state in shell_tty_info. */
961 if (got_tty_state
== 0)
963 ttsetattr (tty
, &shell_tty_info
);
968 /* Give the terminal to PGRP. */
970 give_terminal_to (pgrp
, force
)
977 /* Stop a pipeline. */
979 stop_pipeline (async
, ignore
)
983 already_making_children
= 0;
990 already_making_children
= 1;
994 stop_making_children ()
996 already_making_children
= 0;
999 /* The name is kind of a misnomer, but it's what the job control code uses. */
1001 without_job_control ()
1003 stop_making_children ();
1004 last_made_pid
= NO_PID
; /* XXX */
1008 get_job_by_pid (pid
, block
)
1014 i
= find_index_by_pid (pid
);
1015 return ((i
== NO_PID
) ? PROC_BAD
: i
);
1018 /* Print descriptive information about the job with leader pid PID. */
1023 fprintf (stderr
, "%ld\n", (long) pid
);
1033 unfreeze_jobs_list ()