1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
|
/* jobs.h -- structures and definitions used by the jobs.c file. */
/* Copyright (C) 1993-2022 Free Software Foundation, Inc.
This file is part of GNU Bash, the Bourne Again SHell.
Bash is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Bash is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Bash. If not, see <http://www.gnu.org/licenses/>.
*/
#if !defined (_JOBS_H_)
# define _JOBS_H_
#include "quit.h"
#include "siglist.h"
#include "stdc.h"
#include "posixwait.h"
/* Defines controlling the fashion in which jobs are listed. */
#define JLIST_STANDARD 0
#define JLIST_LONG 1
#define JLIST_PID_ONLY 2
#define JLIST_CHANGED_ONLY 3
#define JLIST_NONINTERACTIVE 4
/* I looked it up. For pretty_print_job (). The real answer is 24. */
#define LONGEST_SIGNAL_DESC 24
/* Defines for the wait_for_* functions and for the wait builtin to use */
#define JWAIT_PERROR (1 << 0)
#define JWAIT_FORCE (1 << 1)
#define JWAIT_NOWAIT (1 << 2) /* don't waitpid(), just return status if already exited */
#define JWAIT_WAITING (1 << 3) /* wait for jobs marked J_WAITING only */
/* flags for wait_for */
#define JWAIT_NOTERM (1 << 8) /* wait_for doesn't give terminal away */
/* The max time to sleep while retrying fork() on EAGAIN failure */
#define FORKSLEEP_MAX 16
/* We keep an array of jobs. Each entry in the array is a linked list
of processes that are piped together. The first process encountered is
the group leader. */
/* Values for the `running' field of a struct process. */
#define PS_DONE 0
#define PS_RUNNING 1
#define PS_STOPPED 2
#define PS_RECYCLED 4
/* Each child of the shell is remembered in a STRUCT PROCESS. A circular
chain of such structures is a pipeline. */
typedef struct process {
struct process *next; /* Next process in the pipeline. A circular chain. */
pid_t pid; /* Process ID. */
WAIT status; /* The status of this command as returned by wait. */
int running; /* Non-zero if this process is running. */
char *command; /* The particular program that is running. */
} PROCESS;
struct pipeline_saver {
struct process *pipeline;
struct pipeline_saver *next;
};
/* PALIVE really means `not exited' */
#define PSTOPPED(p) (WIFSTOPPED((p)->status))
#define PRUNNING(p) ((p)->running == PS_RUNNING)
#define PALIVE(p) (PRUNNING(p) || PSTOPPED(p))
#define PEXITED(p) ((p)->running == PS_DONE)
#if defined (RECYCLES_PIDS)
# define PRECYCLED(p) ((p)->running == PS_RECYCLED)
#else
# define PRECYCLED(p) (0)
#endif
#define PDEADPROC(p) (PEXITED(p) || PRECYCLED(p))
#define get_job_by_jid(ind) (jobs[(ind)])
/* A description of a pipeline's state. */
typedef enum { JNONE = -1, JRUNNING = 1, JSTOPPED = 2, JDEAD = 4, JMIXED = 8 } JOB_STATE;
#define JOBSTATE(job) (jobs[(job)]->state)
#define J_JOBSTATE(j) ((j)->state)
#define STOPPED(j) (jobs[(j)]->state == JSTOPPED)
#define RUNNING(j) (jobs[(j)]->state == JRUNNING)
#define DEADJOB(j) (jobs[(j)]->state == JDEAD)
#define INVALID_JOB(j) ((j) < 0 || (j) >= js.j_jobslots || get_job_by_jid(j) == 0)
/* Values for the FLAGS field in the JOB struct below. */
#define J_FOREGROUND 0x01 /* Non-zero if this is running in the foreground. */
#define J_NOTIFIED 0x02 /* Non-zero if already notified about job state. */
#define J_JOBCONTROL 0x04 /* Non-zero if this job started under job control. */
#define J_NOHUP 0x08 /* Don't send SIGHUP to job if shell gets SIGHUP. */
#define J_STATSAVED 0x10 /* A process in this job had status saved via $! */
#define J_ASYNC 0x20 /* Job was started asynchronously */
#define J_PIPEFAIL 0x40 /* pipefail set when job was started */
#define J_WAITING 0x80 /* one of a list of jobs for which we are waiting */
#define IS_FOREGROUND(j) ((jobs[j]->flags & J_FOREGROUND) != 0)
#define IS_NOTIFIED(j) ((jobs[j]->flags & J_NOTIFIED) != 0)
#define IS_JOBCONTROL(j) ((jobs[j]->flags & J_JOBCONTROL) != 0)
#define IS_ASYNC(j) ((jobs[j]->flags & J_ASYNC) != 0)
#define IS_WAITING(j) ((jobs[j]->flags & J_WAITING) != 0)
typedef struct job {
char *wd; /* The working directory at time of invocation. */
PROCESS *pipe; /* The pipeline of processes that make up this job. */
pid_t pgrp; /* The process ID of the process group (necessary). */
JOB_STATE state; /* The state that this job is in. */
int flags; /* Flags word: J_NOTIFIED, J_FOREGROUND, or J_JOBCONTROL. */
#if defined (JOB_CONTROL)
COMMAND *deferred; /* Commands that will execute when this job is done. */
sh_vptrfunc_t *j_cleanup; /* Cleanup function to call when job marked JDEAD */
PTR_T cleanarg; /* Argument passed to (*j_cleanup)() */
#endif /* JOB_CONTROL */
} JOB;
struct jobstats {
/* limits */
long c_childmax;
/* child process statistics */
int c_living; /* running or stopped child processes */
int c_reaped; /* exited child processes still in jobs list */
int c_injobs; /* total number of child processes in jobs list */
/* child process totals */
int c_totforked; /* total number of children this shell has forked */
int c_totreaped; /* total number of children this shell has reaped */
/* job counters and indices */
int j_jobslots; /* total size of jobs array */
int j_lastj; /* last (newest) job allocated */
int j_firstj; /* first (oldest) job allocated */
int j_njobs; /* number of non-NULL jobs in jobs array */
int j_ndead; /* number of JDEAD jobs in jobs array */
/* */
int j_current; /* current job */
int j_previous; /* previous job */
/* */
JOB *j_lastmade; /* last job allocated by stop_pipeline */
JOB *j_lastasync; /* last async job allocated by stop_pipeline */
};
/* Revised to accommodate new hash table bgpids implementation. */
typedef pid_t ps_index_t;
struct pidstat {
ps_index_t bucket_next;
ps_index_t bucket_prev;
pid_t pid;
bits16_t status; /* only 8 bits really needed */
};
struct bgpids {
struct pidstat *storage; /* storage arena */
ps_index_t head;
ps_index_t nalloc;
int npid;
};
#define NO_PIDSTAT (ps_index_t)-1
/* standalone process status struct, without bgpids indexes */
struct procstat {
pid_t pid;
bits16_t status;
};
/* A standalone singly-linked list of PROCESS *, used in various places
including keeping track of process substitutions. */
struct procchain {
PROCESS *head;
PROCESS *end;
int nproc;
};
#define NO_JOB -1 /* An impossible job array index. */
#define DUP_JOB -2 /* A possible return value for get_job_spec (). */
#define BAD_JOBSPEC -3 /* Bad syntax for job spec. */
/* A value which cannot be a process ID. */
#define NO_PID (pid_t)-1
#define ANY_PID (pid_t)-1
/* flags for make_child () */
#define FORK_SYNC 0 /* normal synchronous process */
#define FORK_ASYNC 1 /* background process */
#define FORK_NOJOB 2 /* don't put process in separate pgrp */
#define FORK_NOTERM 4 /* don't give terminal to any pgrp */
/* System calls. */
#if !defined (HAVE_UNISTD_H)
extern pid_t fork (), getpid (), getpgrp ();
#endif /* !HAVE_UNISTD_H */
/* Stuff from the jobs.c file. */
extern struct jobstats js;
extern pid_t original_pgrp, shell_pgrp, pipeline_pgrp;
extern volatile pid_t last_made_pid, last_asynchronous_pid;
extern int asynchronous_notification;
extern int already_making_children;
extern int running_in_background;
extern PROCESS *last_procsub_child;
extern JOB **jobs;
extern void making_children PARAMS((void));
extern void stop_making_children PARAMS((void));
extern void cleanup_the_pipeline PARAMS((void));
extern void discard_last_procsub_child PARAMS((void));
extern void save_pipeline PARAMS((int));
extern PROCESS *restore_pipeline PARAMS((int));
extern void start_pipeline PARAMS((void));
extern int stop_pipeline PARAMS((int, COMMAND *));
extern int discard_pipeline PARAMS((PROCESS *));
extern void append_process PARAMS((char *, pid_t, int, int));
extern void save_proc_status PARAMS((pid_t, int));
extern PROCESS *procsub_add PARAMS((PROCESS *));
extern PROCESS *procsub_search PARAMS((pid_t));
extern PROCESS *procsub_delete PARAMS((pid_t));
extern int procsub_waitpid PARAMS((pid_t));
extern void procsub_waitall PARAMS((void));
extern void procsub_clear PARAMS((void));
extern void procsub_prune PARAMS((void));
extern void delete_job PARAMS((int, int));
extern void nohup_job PARAMS((int));
extern void delete_all_jobs PARAMS((int));
extern void nohup_all_jobs PARAMS((int));
extern int count_all_jobs PARAMS((void));
extern void terminate_current_pipeline PARAMS((void));
extern void terminate_stopped_jobs PARAMS((void));
extern void hangup_all_jobs PARAMS((void));
extern void kill_current_pipeline PARAMS((void));
#if defined (__STDC__) && defined (pid_t)
extern int get_job_by_pid PARAMS((int, int, PROCESS **));
extern void describe_pid PARAMS((int));
#else
extern int get_job_by_pid PARAMS((pid_t, int, PROCESS **));
extern void describe_pid PARAMS((pid_t));
#endif
extern void list_one_job PARAMS((JOB *, int, int, int));
extern void list_all_jobs PARAMS((int));
extern void list_stopped_jobs PARAMS((int));
extern void list_running_jobs PARAMS((int));
extern pid_t make_child PARAMS((char *, int));
extern int get_tty_state PARAMS((void));
extern int set_tty_state PARAMS((void));
extern int job_exit_status PARAMS((int));
extern int job_exit_signal PARAMS((int));
extern int wait_for_single_pid PARAMS((pid_t, int));
extern int wait_for_background_pids PARAMS((struct procstat *));
extern int wait_for PARAMS((pid_t, int));
extern int wait_for_job PARAMS((int, int, struct procstat *));
extern int wait_for_any_job PARAMS((int, struct procstat *));
extern void wait_sigint_cleanup PARAMS((void));
extern void notify_and_cleanup PARAMS((void));
extern void reap_dead_jobs PARAMS((void));
extern int start_job PARAMS((int, int));
extern int kill_pid PARAMS((pid_t, int, int));
extern int initialize_job_control PARAMS((int));
extern void initialize_job_signals PARAMS((void));
extern int give_terminal_to PARAMS((pid_t, int));
extern void run_sigchld_trap PARAMS((int));
extern int freeze_jobs_list PARAMS((void));
extern void unfreeze_jobs_list PARAMS((void));
extern void set_jobs_list_frozen PARAMS((int));
extern int set_job_control PARAMS((int));
extern void without_job_control PARAMS((void));
extern void end_job_control PARAMS((void));
extern void restart_job_control PARAMS((void));
extern void set_sigchld_handler PARAMS((void));
extern void ignore_tty_job_signals PARAMS((void));
extern void default_tty_job_signals PARAMS((void));
extern void get_original_tty_job_signals PARAMS((void));
extern void init_job_stats PARAMS((void));
extern void close_pgrp_pipe PARAMS((void));
extern void save_pgrp_pipe PARAMS((int *, int));
extern void restore_pgrp_pipe PARAMS((int *));
extern void set_maxchild PARAMS((int));
#ifdef DEBUG
extern void debug_print_pgrps (void);
#endif
extern int job_control; /* set to 0 in nojobs.c */
#endif /* _JOBS_H_ */
|
