1 /* jobs.h -- structures and definitions used by the jobs.c file. */
3 /* Copyright (C) 1993-2015 Free Software Foundation, Inc.
5 This file is part of GNU Bash, the Bourne Again SHell.
7 Bash is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 Bash is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with Bash. If not, see <http://www.gnu.org/licenses/>.
21 #if !defined (_JOBS_H_)
29 #include "posixwait.h"
31 /* Defines controlling the fashion in which jobs are listed. */
32 #define JLIST_STANDARD 0
34 #define JLIST_PID_ONLY 2
35 #define JLIST_CHANGED_ONLY 3
36 #define JLIST_NONINTERACTIVE 4
38 /* I looked it up. For pretty_print_job (). The real answer is 24. */
39 #define LONGEST_SIGNAL_DESC 24
41 /* The max time to sleep while retrying fork() on EAGAIN failure */
42 #define FORKSLEEP_MAX 16
44 /* We keep an array of jobs. Each entry in the array is a linked list
45 of processes that are piped together. The first process encountered is
48 /* Values for the `running' field of a struct process. */
54 /* Each child of the shell is remembered in a STRUCT PROCESS. A circular
55 chain of such structures is a pipeline. */
56 typedef struct process
{
57 struct process
*next
; /* Next process in the pipeline. A circular chain. */
58 pid_t pid
; /* Process ID. */
59 WAIT status
; /* The status of this command as returned by wait. */
60 int running
; /* Non-zero if this process is running. */
61 char *command
; /* The particular program that is running. */
64 struct pipeline_saver
{
65 struct process
*pipeline
;
66 struct pipeline_saver
*next
;
69 /* PALIVE really means `not exited' */
70 #define PSTOPPED(p) (WIFSTOPPED((p)->status))
71 #define PRUNNING(p) ((p)->running == PS_RUNNING)
72 #define PALIVE(p) (PRUNNING(p) || PSTOPPED(p))
74 #define PEXITED(p) ((p)->running == PS_DONE)
75 #if defined (RECYCLES_PIDS)
76 # define PRECYCLED(p) ((p)->running == PS_RECYCLED)
78 # define PRECYCLED(p) (0)
80 #define PDEADPROC(p) (PEXITED(p) || PRECYCLED(p))
82 #define get_job_by_jid(ind) (jobs[(ind)])
84 /* A description of a pipeline's state. */
85 typedef enum { JNONE
= -1, JRUNNING
= 1, JSTOPPED
= 2, JDEAD
= 4, JMIXED
= 8 } JOB_STATE
;
86 #define JOBSTATE(job) (jobs[(job)]->state)
87 #define J_JOBSTATE(j) ((j)->state)
89 #define STOPPED(j) (jobs[(j)]->state == JSTOPPED)
90 #define RUNNING(j) (jobs[(j)]->state == JRUNNING)
91 #define DEADJOB(j) (jobs[(j)]->state == JDEAD)
93 #define INVALID_JOB(j) ((j) < 0 || (j) >= js.j_jobslots || get_job_by_jid(j) == 0)
95 /* Values for the FLAGS field in the JOB struct below. */
96 #define J_FOREGROUND 0x01 /* Non-zero if this is running in the foreground. */
97 #define J_NOTIFIED 0x02 /* Non-zero if already notified about job state. */
98 #define J_JOBCONTROL 0x04 /* Non-zero if this job started under job control. */
99 #define J_NOHUP 0x08 /* Don't send SIGHUP to job if shell gets SIGHUP. */
100 #define J_STATSAVED 0x10 /* A process in this job had had status saved via $! */
101 #define J_ASYNC 0x20 /* Job was started asynchronously */
103 #define IS_FOREGROUND(j) ((jobs[j]->flags & J_FOREGROUND) != 0)
104 #define IS_NOTIFIED(j) ((jobs[j]->flags & J_NOTIFIED) != 0)
105 #define IS_JOBCONTROL(j) ((jobs[j]->flags & J_JOBCONTROL) != 0)
106 #define IS_ASYNC(j) ((jobs[j]->flags & J_ASYNC) != 0)
109 char *wd
; /* The working directory at time of invocation. */
110 PROCESS
*pipe
; /* The pipeline of processes that make up this job. */
111 pid_t pgrp
; /* The process ID of the process group (necessary). */
112 JOB_STATE state
; /* The state that this job is in. */
113 int flags
; /* Flags word: J_NOTIFIED, J_FOREGROUND, or J_JOBCONTROL. */
114 #if defined (JOB_CONTROL)
115 COMMAND
*deferred
; /* Commands that will execute when this job is done. */
116 sh_vptrfunc_t
*j_cleanup
; /* Cleanup function to call when job marked JDEAD */
117 PTR_T cleanarg
; /* Argument passed to (*j_cleanup)() */
118 #endif /* JOB_CONTROL */
124 /* child process statistics */
125 int c_living
; /* running or stopped child processes */
126 int c_reaped
; /* exited child processes still in jobs list */
127 int c_injobs
; /* total number of child processes in jobs list */
128 /* child process totals */
129 int c_totforked
; /* total number of children this shell has forked */
130 int c_totreaped
; /* total number of children this shell has reaped */
131 /* job counters and indices */
132 int j_jobslots
; /* total size of jobs array */
133 int j_lastj
; /* last (newest) job allocated */
134 int j_firstj
; /* first (oldest) job allocated */
135 int j_njobs
; /* number of non-NULL jobs in jobs array */
136 int j_ndead
; /* number of JDEAD jobs in jobs array */
138 int j_current
; /* current job */
139 int j_previous
; /* previous job */
141 JOB
*j_lastmade
; /* last job allocated by stop_pipeline */
142 JOB
*j_lastasync
; /* last async job allocated by stop_pipeline */
145 /* Revised to accommodate new hash table bgpids implementation. */
146 typedef pid_t ps_index_t
;
149 ps_index_t bucket_next
;
150 ps_index_t bucket_prev
;
153 bits16_t status
; /* only 8 bits really needed */
157 struct pidstat
*storage
; /* storage arena */
165 #define NO_PIDSTAT (ps_index_t)-1
167 #define NO_JOB -1 /* An impossible job array index. */
168 #define DUP_JOB -2 /* A possible return value for get_job_spec (). */
169 #define BAD_JOBSPEC -3 /* Bad syntax for job spec. */
171 /* A value which cannot be a process ID. */
172 #define NO_PID (pid_t)-1
174 #define ANY_PID (pid_t)-1
177 #if !defined (HAVE_UNISTD_H)
178 extern pid_t
fork (), getpid (), getpgrp ();
179 #endif /* !HAVE_UNISTD_H */
181 /* Stuff from the jobs.c file. */
182 extern struct jobstats js
;
184 extern pid_t original_pgrp
, shell_pgrp
, pipeline_pgrp
;
185 extern volatile pid_t last_made_pid
, last_asynchronous_pid
;
186 extern int asynchronous_notification
;
190 extern void making_children
__P((void));
191 extern void stop_making_children
__P((void));
192 extern void cleanup_the_pipeline
__P((void));
193 extern void discard_last_procsub_child
__P((void));
194 extern void save_pipeline
__P((int));
195 extern PROCESS
*restore_pipeline
__P((int));
196 extern void start_pipeline
__P((void));
197 extern int stop_pipeline
__P((int, COMMAND
*));
198 extern int discard_pipeline
__P((PROCESS
*));
199 extern void append_process
__P((char *, pid_t
, int, int));
201 extern void delete_job
__P((int, int));
202 extern void nohup_job
__P((int));
203 extern void delete_all_jobs
__P((int));
204 extern void nohup_all_jobs
__P((int));
206 extern int count_all_jobs
__P((void));
208 extern void terminate_current_pipeline
__P((void));
209 extern void terminate_stopped_jobs
__P((void));
210 extern void hangup_all_jobs
__P((void));
211 extern void kill_current_pipeline
__P((void));
213 #if defined (__STDC__) && defined (pid_t)
214 extern int get_job_by_pid
__P((int, int));
215 extern void describe_pid
__P((int));
217 extern int get_job_by_pid
__P((pid_t
, int));
218 extern void describe_pid
__P((pid_t
));
221 extern void list_one_job
__P((JOB
*, int, int, int));
222 extern void list_all_jobs
__P((int));
223 extern void list_stopped_jobs
__P((int));
224 extern void list_running_jobs
__P((int));
226 extern pid_t make_child
__P((char *, int));
228 extern int get_tty_state
__P((void));
229 extern int set_tty_state
__P((void));
231 extern int job_exit_status
__P((int));
232 extern int job_exit_signal
__P((int));
234 extern int wait_for_single_pid
__P((pid_t
, int));
235 extern void wait_for_background_pids
__P((void));
236 extern int wait_for
__P((pid_t
));
237 extern int wait_for_job
__P((int));
238 extern int wait_for_any_job
__P((void));
240 extern void wait_sigint_cleanup
__P((void));
242 extern void notify_and_cleanup
__P((void));
243 extern void reap_dead_jobs
__P((void));
244 extern int start_job
__P((int, int));
245 extern int kill_pid
__P((pid_t
, int, int));
246 extern int initialize_job_control
__P((int));
247 extern void initialize_job_signals
__P((void));
248 extern int give_terminal_to
__P((pid_t
, int));
250 extern void run_sigchld_trap
__P((int));
252 extern int freeze_jobs_list
__P((void));
253 extern void unfreeze_jobs_list
__P((void));
254 extern int set_job_control
__P((int));
255 extern void without_job_control
__P((void));
256 extern void end_job_control
__P((void));
257 extern void restart_job_control
__P((void));
258 extern void set_sigchld_handler
__P((void));
259 extern void ignore_tty_job_signals
__P((void));
260 extern void default_tty_job_signals
__P((void));
261 extern void get_original_tty_job_signals
__P((void));
263 extern void init_job_stats
__P((void));
265 extern void close_pgrp_pipe
__P((void));
266 extern void save_pgrp_pipe
__P((int *, int));
267 extern void restore_pgrp_pipe
__P((int *));
269 extern void set_maxchild
__P((int));
271 extern int job_control
; /* set to 0 in nojobs.c */
273 #endif /* _JOBS_H_ */