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 */
52 #include "builtins/common.h"
54 #define DEFAULT_CHILD_MAX 32
56 #if defined (_POSIX_VERSION) || !defined (HAVE_KILLPG)
57 # define killpg(pg, sig) kill(-(pg),(sig))
58 #endif /* USG || _POSIX_VERSION */
60 #if !defined (HAVE_SIGINTERRUPT) && !defined (HAVE_POSIX_SIGNALS)
61 # define siginterrupt(sig, code)
62 #endif /* !HAVE_SIGINTERRUPT && !HAVE_POSIX_SIGNALS */
64 #if defined (HAVE_WAITPID)
65 # define WAITPID(pid, statusp, options) waitpid (pid, statusp, options)
67 # define WAITPID(pid, statusp, options) wait (statusp)
68 #endif /* !HAVE_WAITPID */
70 /* Return the fd from which we are actually getting input. */
71 #define input_tty() (shell_tty != -1) ? shell_tty : fileno (stderr)
77 #if defined (HAVE_POSIX_SIGNALS)
78 extern sigset_t top_level_mask
;
81 extern void set_original_signal
__P((int, SigHandler
*));
83 volatile pid_t last_made_pid
= NO_PID
;
84 volatile pid_t last_asynchronous_pid
= NO_PID
;
86 static int queue_sigchld
, waiting_for_child
; /* dummy declarations */
88 /* Call this when you start making children. */
89 int already_making_children
= 0;
91 /* The controlling tty for this shell. */
94 /* If this is non-zero, $LINES and $COLUMNS are reset after every process
95 exits from get_tty_state(). */
96 int check_window_size
= CHECKWINSIZE_DEFAULT
;
98 /* We don't have job control. */
101 int running_in_background
= 0; /* can't tell without job control */
103 /* STATUS and FLAGS are only valid if pid != NO_PID
104 STATUS is only valid if (flags & PROC_RUNNING) == 0 */
107 int status
; /* Exit status of PID or 128 + fatal signal number */
111 /* Values for proc_status.flags */
112 #define PROC_RUNNING 0x01
113 #define PROC_NOTIFIED 0x02
114 #define PROC_ASYNC 0x04
115 #define PROC_SIGNALED 0x10
117 /* Return values from find_status_by_pid */
119 #define PROC_STILL_ALIVE -2
121 static struct proc_status
*pid_list
= (struct proc_status
*)NULL
;
122 static int pid_list_size
;
123 static int wait_sigint_received
;
125 static long child_max
= -1L;
127 static void alloc_pid_list
__P((void));
128 static int find_proc_slot
__P((pid_t
));
129 static int find_index_by_pid
__P((pid_t
));
130 static int find_status_by_pid
__P((pid_t
));
131 static int process_exit_status
__P((WAIT
));
132 static int find_termsig_by_pid
__P((pid_t
));
133 static int get_termsig
__P((WAIT
));
134 static void set_pid_status
__P((pid_t
, WAIT
));
135 static void set_pid_flags
__P((pid_t
, int));
136 static void unset_pid_flags
__P((pid_t
, int));
137 static int get_pid_flags
__P((pid_t
));
138 static void add_pid
__P((pid_t
, int));
139 static void mark_dead_jobs_as_notified
__P((int));
141 static sighandler wait_sigint_handler
__P((int));
142 static char *j_strsignal
__P((int));
144 #if defined (HAVE_WAITPID)
145 static void reap_zombie_children
__P((void));
148 #if !defined (HAVE_SIGINTERRUPT) && defined (HAVE_POSIX_SIGNALS)
149 static int siginterrupt
__P((int, int));
152 static void restore_sigint_handler
__P((void));
154 /* Allocate new, or grow existing PID_LIST. */
159 int old
= pid_list_size
;
162 pid_list
= (struct proc_status
*)xrealloc (pid_list
, pid_list_size
* sizeof (struct proc_status
));
164 /* None of the newly allocated slots have process id's yet. */
165 for (i
= old
; i
< pid_list_size
; i
++)
167 pid_list
[i
].pid
= NO_PID
;
168 pid_list
[i
].status
= pid_list
[i
].flags
= 0;
172 /* Return the offset within the PID_LIST array of an empty slot. This can
173 create new slots if all of the existing slots are taken. */
180 for (i
= 0; i
< pid_list_size
; i
++)
181 if (pid_list
[i
].pid
== NO_PID
|| pid_list
[i
].pid
== pid
)
184 if (i
== pid_list_size
)
190 /* Return the offset within the PID_LIST array of a slot containing PID,
191 or the value NO_PID if the pid wasn't found. */
193 find_index_by_pid (pid
)
198 for (i
= 0; i
< pid_list_size
; i
++)
199 if (pid_list
[i
].pid
== pid
)
205 /* Return the status of PID as looked up in the PID_LIST array. A
206 return value of PROC_BAD indicates that PID wasn't found. */
208 find_status_by_pid (pid
)
213 i
= find_index_by_pid (pid
);
216 if (pid_list
[i
].flags
& PROC_RUNNING
)
217 return (PROC_STILL_ALIVE
);
218 return (pid_list
[i
].status
);
222 process_exit_status (status
)
225 if (WIFSIGNALED (status
))
226 return (128 + WTERMSIG (status
));
228 return (WEXITSTATUS (status
));
231 /* Return the status of PID as looked up in the PID_LIST array. A
232 return value of PROC_BAD indicates that PID wasn't found. */
234 find_termsig_by_pid (pid
)
239 i
= find_index_by_pid (pid
);
242 if (pid_list
[i
].flags
& PROC_RUNNING
)
244 return (get_termsig ((WAIT
)pid_list
[i
].status
));
247 /* Set LAST_COMMAND_EXIT_SIGNAL depending on STATUS. If STATUS is -1, look
248 up PID in the pid array and set LAST_COMMAND_EXIT_SIGNAL appropriately
249 depending on its flags and exit status. */
254 if (WIFSTOPPED (status
) == 0 && WIFSIGNALED (status
))
255 return (WTERMSIG (status
));
260 /* Give PID the status value STATUS in the PID_LIST array. */
262 set_pid_status (pid
, status
)
268 #if defined (COPROCESS_SUPPORT)
269 coproc_pidchk (pid
, status
);
272 #if defined (PROCESS_SUBSTITUTION)
273 if ((slot
= find_procsub_child (pid
)) >= 0)
274 set_procsub_status (slot
, pid
, WSTATUS (status
));
275 /* XXX - also saving in list below */
278 slot
= find_index_by_pid (pid
);
282 pid_list
[slot
].status
= process_exit_status (status
);
283 pid_list
[slot
].flags
&= ~PROC_RUNNING
;
284 if (WIFSIGNALED (status
))
285 pid_list
[slot
].flags
|= PROC_SIGNALED
;
286 /* If it's not a background process, mark it as notified so it gets
288 if ((pid_list
[slot
].flags
& PROC_ASYNC
) == 0)
289 pid_list
[slot
].flags
|= PROC_NOTIFIED
;
292 /* Give PID the flags FLAGS in the PID_LIST array. */
294 set_pid_flags (pid
, flags
)
300 slot
= find_index_by_pid (pid
);
304 pid_list
[slot
].flags
|= flags
;
307 /* Unset FLAGS for PID in the pid list */
309 unset_pid_flags (pid
, flags
)
315 slot
= find_index_by_pid (pid
);
319 pid_list
[slot
].flags
&= ~flags
;
322 /* Return the flags corresponding to PID in the PID_LIST array. */
329 slot
= find_index_by_pid (pid
);
333 return (pid_list
[slot
].flags
);
343 slot
= find_proc_slot (pid
);
345 pid_list
[slot
].pid
= pid
;
346 pid_list
[slot
].status
= -1;
347 pid_list
[slot
].flags
= PROC_RUNNING
;
349 pid_list
[slot
].flags
|= PROC_ASYNC
;
353 mark_dead_jobs_as_notified (force
)
356 register int i
, ndead
;
358 /* first, count the number of non-running async jobs if FORCE == 0 */
359 for (i
= ndead
= 0; force
== 0 && i
< pid_list_size
; i
++)
361 if (pid_list
[i
].pid
== NO_PID
)
363 if (((pid_list
[i
].flags
& PROC_RUNNING
) == 0) &&
364 (pid_list
[i
].flags
& PROC_ASYNC
))
369 child_max
= getmaxchild ();
371 child_max
= DEFAULT_CHILD_MAX
;
373 if (force
== 0 && ndead
<= child_max
)
376 /* If FORCE == 0, we just mark as many non-running async jobs as notified
377 to bring us under the CHILD_MAX limit. */
378 for (i
= 0; i
< pid_list_size
; i
++)
380 if (pid_list
[i
].pid
== NO_PID
)
382 if (((pid_list
[i
].flags
& PROC_RUNNING
) == 0) &&
383 pid_list
[i
].pid
!= last_asynchronous_pid
)
385 pid_list
[i
].flags
|= PROC_NOTIFIED
;
386 if (force
== 0 && (pid_list
[i
].flags
& PROC_ASYNC
) && --ndead
<= child_max
)
392 /* Remove all dead, notified jobs from the pid_list. */
398 #if defined (HAVE_WAITPID)
399 reap_zombie_children ();
402 for (i
= 0; i
< pid_list_size
; i
++)
404 if (pid_list
[i
].pid
!= NO_PID
&&
405 (pid_list
[i
].flags
& PROC_RUNNING
) == 0 &&
406 (pid_list
[i
].flags
& PROC_NOTIFIED
))
407 pid_list
[i
].pid
= NO_PID
;
410 #if defined (COPROCESS_SUPPORT)
420 mark_dead_jobs_as_notified (0);
421 cleanup_dead_jobs ();
424 /* Initialize the job control mechanism, and set up the tty stuff. */
426 initialize_job_control (force
)
429 shell_tty
= fileno (stderr
);
436 /* Setup this shell to handle C-C, etc. */
438 initialize_job_signals ()
440 set_signal_handler (SIGINT
, sigint_sighandler
);
442 /* If this is a login shell we don't wish to be disturbed by
445 ignore_tty_job_signals ();
448 #if defined (HAVE_WAITPID)
449 /* Collect the status of all zombie children so that their system
450 resources can be deallocated. */
452 reap_zombie_children ()
454 # if defined (WNOHANG)
460 while ((pid
= waitpid (-1, (int *)&status
, WNOHANG
)) > 0)
461 set_pid_status (pid
, status
);
462 # endif /* WNOHANG */
468 #if !defined (HAVE_SIGINTERRUPT) && defined (HAVE_POSIX_SIGNALS)
470 #if !defined (SA_RESTART)
471 # define SA_RESTART 0
475 siginterrupt (sig
, flag
)
478 struct sigaction act
;
480 sigaction (sig
, (struct sigaction
*)NULL
, &act
);
483 act
.sa_flags
&= ~SA_RESTART
;
485 act
.sa_flags
|= SA_RESTART
;
487 return (sigaction (sig
, &act
, (struct sigaction
*)NULL
));
489 #endif /* !HAVE_SIGINTERRUPT && HAVE_POSIX_SIGNALS */
491 /* Fork, handling errors. Returns the pid of the newly made child, or 0.
492 COMMAND is just for remembering the name of the command; we don't do
493 anything else with it. ASYNC_P says what to do with the tty. If
494 non-zero, then don't give it away. */
496 make_child (command
, async_p
)
503 /* Discard saved memory. */
509 #if defined (BUFFERED_INPUT)
510 /* If default_buffered_input is active, we are reading a script. If
511 the command is asynchronous, we have already duplicated /dev/null
512 as fd 0, but have not changed the buffered stream corresponding to
513 the old fd 0. We don't want to sync the stream in this case. */
514 if (default_buffered_input
!= -1 && (!async_p
|| default_buffered_input
> 0))
515 sync_buffered_stream (default_buffered_input
);
516 #endif /* BUFFERED_INPUT */
518 /* XXX - block SIGTERM here and unblock in child after fork resets the
519 set of pending signals? */
522 /* Create the child, handle severe errors. Retry on EAGAIN. */
524 while ((pid
= fork ()) < 0 && errno
== EAGAIN
&& forksleep
< FORKSLEEP_MAX
)
526 sys_error ("fork: retry");
529 #if defined (HAVE_WAITPID)
530 /* Posix systems with a non-blocking waitpid () system call available
531 get another chance after zombies are reaped. */
532 reap_zombie_children ();
533 if (forksleep
> 1 && sleep (forksleep
) != 0)
536 if (sleep (forksleep
) != 0)
538 #endif /* HAVE_WAITPID */
548 last_command_exit_value
= EX_NOEXEC
;
549 throw_to_top_level ();
554 #if defined (BUFFERED_INPUT)
555 unset_bash_input (0);
556 #endif /* BUFFERED_INPUT */
558 CLRINTERRUPT
; /* XXX - children have their own interrupt state */
560 #if defined (HAVE_POSIX_SIGNALS)
561 /* Restore top-level signal mask. */
562 sigprocmask (SIG_SETMASK
, &top_level_mask
, (sigset_t
*)NULL
);
566 /* Ignore INT and QUIT in asynchronous children. */
568 last_asynchronous_pid
= getpid ();
571 default_tty_job_signals ();
580 last_asynchronous_pid
= pid
;
582 add_pid (pid
, async_p
);
588 ignore_tty_job_signals ()
590 #if defined (SIGTSTP)
591 set_signal_handler (SIGTSTP
, SIG_IGN
);
592 set_signal_handler (SIGTTIN
, SIG_IGN
);
593 set_signal_handler (SIGTTOU
, SIG_IGN
);
598 default_tty_job_signals ()
600 #if defined (SIGTSTP)
601 if (signal_is_trapped (SIGTSTP
) == 0 && signal_is_hard_ignored (SIGTSTP
))
602 set_signal_handler (SIGTSTP
, SIG_IGN
);
604 set_signal_handler (SIGTSTP
, SIG_DFL
);
605 if (signal_is_trapped (SIGTTIN
) == 0 && signal_is_hard_ignored (SIGTTIN
))
606 set_signal_handler (SIGTTIN
, SIG_IGN
);
608 set_signal_handler (SIGTTIN
, SIG_DFL
);
609 if (signal_is_trapped (SIGTTOU
) == 0 && signal_is_hard_ignored (SIGTTOU
))
610 set_signal_handler (SIGTTOU
, SIG_IGN
);
612 set_signal_handler (SIGTTOU
, SIG_DFL
);
616 /* Called once in a parent process. */
618 get_original_tty_job_signals ()
620 static int fetched
= 0;
624 #if defined (SIGTSTP)
625 if (interactive_shell
)
627 set_original_signal (SIGTSTP
, SIG_DFL
);
628 set_original_signal (SIGTTIN
, SIG_DFL
);
629 set_original_signal (SIGTTOU
, SIG_DFL
);
633 get_original_signal (SIGTSTP
);
634 get_original_signal (SIGTTIN
);
635 get_original_signal (SIGTTOU
);
642 /* Wait for a single pid (PID) and return its exit status. Called by
645 wait_for_single_pid (pid
, flags
)
653 pstatus
= find_status_by_pid (pid
);
655 if (pstatus
== PROC_BAD
)
657 internal_error (_("wait: pid %ld is not a child of this shell"), (long)pid
);
661 if (pstatus
!= PROC_STILL_ALIVE
)
664 last_command_exit_signal
= find_termsig_by_pid (pid
);
668 siginterrupt (SIGINT
, 1);
669 while ((got_pid
= WAITPID (pid
, &status
, 0)) != pid
)
675 if (errno
!= EINTR
&& errno
!= ECHILD
)
677 siginterrupt (SIGINT
, 0);
682 else if (got_pid
> 0)
683 set_pid_status (got_pid
, status
);
688 set_pid_status (got_pid
, status
);
689 set_pid_flags (got_pid
, PROC_NOTIFIED
);
692 siginterrupt (SIGINT
, 0);
695 return (got_pid
> 0 ? process_exit_status (status
) : -1);
698 /* Wait for all of the shell's children to exit. Called by the `wait'
701 wait_for_background_pids ()
706 /* If we aren't using job control, we let the kernel take care of the
707 bookkeeping for us. wait () will return -1 and set errno to ECHILD
708 when there are no more unwaited-for child processes on both
709 4.2 BSD-based and System V-based systems. */
711 siginterrupt (SIGINT
, 1);
713 /* Wait for ECHILD */
714 while ((got_pid
= WAITPID (-1, &status
, 0)) != -1)
715 set_pid_status (got_pid
, status
);
717 if (errno
!= EINTR
&& errno
!= ECHILD
)
719 siginterrupt (SIGINT
, 0);
723 siginterrupt (SIGINT
, 0);
726 mark_dead_jobs_as_notified (1);
727 cleanup_dead_jobs ();
731 wait_sigint_cleanup ()
735 /* Make OLD_SIGINT_HANDLER the SIGINT signal handler. */
736 #define INVALID_SIGNAL_HANDLER (SigHandler *)wait_for_background_pids
737 static SigHandler
*old_sigint_handler
= INVALID_SIGNAL_HANDLER
;
740 restore_sigint_handler ()
742 if (old_sigint_handler
!= INVALID_SIGNAL_HANDLER
)
744 set_signal_handler (SIGINT
, old_sigint_handler
);
745 old_sigint_handler
= INVALID_SIGNAL_HANDLER
;
749 /* Handle SIGINT while we are waiting for children in a script to exit.
750 All interrupts are effectively ignored by the shell, but allowed to
751 kill a running job. */
753 wait_sigint_handler (sig
)
756 SigHandler
*sigint_handler
;
758 /* If we got a SIGINT while in `wait', and SIGINT is trapped, do
759 what POSIX.2 says (see builtins/wait.def for more info). */
760 if (this_shell_builtin
&& this_shell_builtin
== wait_builtin
&&
761 signal_is_trapped (SIGINT
) &&
762 ((sigint_handler
= trap_to_sighandler (SIGINT
)) == trap_handler
))
764 last_command_exit_value
= 128+SIGINT
;
765 restore_sigint_handler ();
766 interrupt_immediately
= 0;
767 trap_handler (SIGINT
); /* set pending_traps[SIGINT] */
768 wait_signal_received
= SIGINT
;
772 if (interrupt_immediately
)
774 last_command_exit_value
= EXECUTION_FAILURE
;
775 restore_sigint_handler ();
780 wait_sigint_received
= 1;
789 static char retcode_name_buffer
[64] = { '\0' };
795 x
= retcode_name_buffer
;
796 sprintf (x
, "Signal %d", s
);
801 /* Wait for pid (one of our children) to terminate. This is called only
802 by the execution code in execute_cmd.c. */
807 int return_val
, pstatus
;
811 pstatus
= find_status_by_pid (pid
);
813 if (pstatus
== PROC_BAD
)
816 if (pstatus
!= PROC_STILL_ALIVE
)
819 last_command_exit_signal
= find_termsig_by_pid (pid
);
823 /* If we are running a script, ignore SIGINT while we're waiting for
824 a child to exit. The loop below does some of this, but not all. */
825 wait_sigint_received
= 0;
826 if (interactive_shell
== 0)
827 old_sigint_handler
= set_signal_handler (SIGINT
, wait_sigint_handler
);
829 while ((got_pid
= WAITPID (-1, &status
, 0)) != pid
) /* XXX was pid now -1 */
833 if (got_pid
< 0 && errno
== ECHILD
)
835 #if !defined (_POSIX_VERSION)
836 status
.w_termsig
= status
.w_retcode
= 0;
839 #endif /* _POSIX_VERSION */
842 else if (got_pid
< 0 && errno
!= EINTR
)
843 programming_error ("wait_for(%ld): %s", (long)pid
, strerror(errno
));
844 else if (got_pid
> 0)
845 set_pid_status (got_pid
, status
);
849 set_pid_status (got_pid
, status
);
851 #if defined (HAVE_WAITPID)
853 reap_zombie_children ();
854 #endif /* HAVE_WAITPID */
859 if (interactive_shell
== 0)
861 SigHandler
*temp_handler
;
863 temp_handler
= old_sigint_handler
;
864 restore_sigint_handler ();
866 /* If the job exited because of SIGINT, make sure the shell acts as if
867 it had received one also. */
868 if (WIFSIGNALED (status
) && (WTERMSIG (status
) == SIGINT
))
871 if (maybe_call_trap_handler (SIGINT
) == 0)
873 if (temp_handler
== SIG_DFL
)
874 termsig_handler (SIGINT
);
875 else if (temp_handler
!= INVALID_SIGNAL_HANDLER
&& temp_handler
!= SIG_IGN
)
876 (*temp_handler
) (SIGINT
);
881 /* Default return value. */
882 /* ``a full 8 bits of status is returned'' */
883 return_val
= process_exit_status (status
);
884 last_command_exit_signal
= get_termsig (status
);
886 #if defined (DONT_REPORT_SIGPIPE) && defined (DONT_REPORT_SIGTERM)
887 # define REPORTSIG(x) ((x) != SIGINT && (x) != SIGPIPE && (x) != SIGTERM)
888 #elif !defined (DONT_REPORT_SIGPIPE) && !defined (DONT_REPORT_SIGTERM)
889 # define REPORTSIG(x) ((x) != SIGINT)
890 #elif defined (DONT_REPORT_SIGPIPE)
891 # define REPORTSIG(x) ((x) != SIGINT && (x) != SIGPIPE)
893 # define REPORTSIG(x) ((x) != SIGINT && (x) != SIGTERM)
896 if ((WIFSTOPPED (status
) == 0) && WIFSIGNALED (status
) && REPORTSIG(WTERMSIG (status
)))
898 fprintf (stderr
, "%s", j_strsignal (WTERMSIG (status
)));
899 if (WIFCORED (status
))
900 fprintf (stderr
, _(" (core dumped)"));
901 fprintf (stderr
, "\n");
904 if (interactive_shell
&& subshell_environment
== 0)
906 if (WIFSIGNALED (status
) || WIFSTOPPED (status
))
911 else if (interactive_shell
== 0 && subshell_environment
== 0 && check_window_size
)
912 get_new_window_size (0, (int *)0, (int *)0);
917 /* Send PID SIGNAL. Returns -1 on failure, 0 on success. If GROUP is non-zero,
918 or PID is less than -1, then kill the process group associated with PID. */
920 kill_pid (pid
, signal
, group
)
931 result
= group
? killpg (pid
, signal
) : kill (pid
, signal
);
935 static TTYSTRUCT shell_tty_info
;
936 static int got_tty_state
;
938 /* Fill the contents of shell_tty_info with the current tty info. */
947 ttgetattr (tty
, &shell_tty_info
);
949 if (check_window_size
)
950 get_new_window_size (0, (int *)0, (int *)0);
955 /* Make the current tty use the state in shell_tty_info. */
964 if (got_tty_state
== 0)
966 ttsetattr (tty
, &shell_tty_info
);
971 /* Give the terminal to PGRP. */
973 give_terminal_to (pgrp
, force
)
980 /* Stop a pipeline. */
982 stop_pipeline (async
, ignore
)
986 already_making_children
= 0;
993 already_making_children
= 1;
997 stop_making_children ()
999 already_making_children
= 0;
1002 /* The name is kind of a misnomer, but it's what the job control code uses. */
1004 without_job_control ()
1006 stop_making_children ();
1007 last_made_pid
= NO_PID
; /* XXX */
1011 get_job_by_pid (pid
, block
)
1017 i
= find_index_by_pid (pid
);
1018 return ((i
== NO_PID
) ? PROC_BAD
: i
);
1021 /* Print descriptive information about the job with leader pid PID. */
1026 fprintf (stderr
, "%ld\n", (long) pid
);
1036 unfreeze_jobs_list ()
1041 set_jobs_list_frozen (s
)