1 /* jobs.h -- structures and stuff used by the jobs.c file. */
3 /* Copyright (C) 1993 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 it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License along
18 with Bash; see the file COPYING. If not, write to the Free Software
19 Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
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 /* We keep an array of jobs. Each entry in the array is a linked list
42 of processes that are piped together. The first process encountered is
45 /* Values for the `running' field of a struct process. */
50 /* Each child of the shell is remembered in a STRUCT PROCESS. A chain of
51 such structures is a pipeline. The chain is circular. */
52 typedef struct process {
53 struct process *next; /* Next process in the pipeline. A circular chain. */
54 pid_t pid; /* Process ID. */
55 WAIT status; /* The status of this command as returned by wait. */
56 int running; /* Non-zero if this process is running. */
57 char *command; /* The particular program that is running. */
60 /* A description of a pipeline's state. */
61 typedef enum { JRUNNING, JSTOPPED, JDEAD, JMIXED } JOB_STATE;
62 #define JOBSTATE(job) (jobs[(job)]->state)
64 #define STOPPED(j) (jobs[(j)]->state == JSTOPPED)
65 #define RUNNING(j) (jobs[(j)]->state == JRUNNING)
66 #define DEADJOB(j) (jobs[(j)]->state == JDEAD)
68 /* Values for the FLAGS field in the JOB struct below. */
69 #define J_FOREGROUND 0x01 /* Non-zero if this is running in the foreground. */
70 #define J_NOTIFIED 0x02 /* Non-zero if already notified about job state. */
71 #define J_JOBCONTROL 0x04 /* Non-zero if this job started under job control. */
72 #define J_NOHUP 0x08 /* Don't send SIGHUP to job if shell gets SIGHUP. */
74 #define IS_FOREGROUND(j) ((jobs[j]->flags & J_FOREGROUND) != 0)
75 #define IS_NOTIFIED(j) ((jobs[j]->flags & J_NOTIFIED) != 0)
76 #define IS_JOBCONTROL(j) ((jobs[j]->flags & J_JOBCONTROL) != 0)
79 char *wd; /* The working directory at time of invocation. */
80 PROCESS *pipe; /* The pipeline of processes that make up this job. */
81 pid_t pgrp; /* The process ID of the process group (necessary). */
82 JOB_STATE state; /* The state that this job is in. */
83 int flags; /* Flags word: J_NOTIFIED, J_FOREGROUND, or J_JOBCONTROL. */
84 #if defined (JOB_CONTROL)
85 COMMAND *deferred; /* Commands that will execute when this job is done. */
86 sh_vptrfunc_t *j_cleanup; /* Cleanup function to call when job marked JDEAD */
87 PTR_T cleanarg; /* Argument passed to (*j_cleanup)() */
88 #endif /* JOB_CONTROL */
91 #define NO_JOB -1 /* An impossible job array index. */
92 #define DUP_JOB -2 /* A possible return value for get_job_spec (). */
94 /* A value which cannot be a process ID. */
95 #define NO_PID (pid_t)-1
98 #if !defined (HAVE_UNISTD_H)
99 extern pid_t fork (), getpid (), getpgrp ();
100 #endif /* !HAVE_UNISTD_H */
102 /* Stuff from the jobs.c file. */
103 extern pid_t original_pgrp, shell_pgrp, pipeline_pgrp;
104 extern pid_t last_made_pid, last_asynchronous_pid;
105 extern int current_job, previous_job;
106 extern int asynchronous_notification;
108 extern int job_slots;
110 extern void making_children __P((void));
111 extern void stop_making_children __P((void));
112 extern void cleanup_the_pipeline __P((void));
113 extern void save_pipeline __P((int));
114 extern void restore_pipeline __P((int));
115 extern void start_pipeline __P((void));
116 extern int stop_pipeline __P((int, COMMAND *));
118 extern void delete_job __P((int, int));
119 extern void nohup_job __P((int));
120 extern void delete_all_jobs __P((int));
121 extern void nohup_all_jobs __P((int));
123 extern int count_all_jobs __P((void));
125 extern void terminate_current_pipeline __P((void));
126 extern void terminate_stopped_jobs __P((void));
127 extern void hangup_all_jobs __P((void));
128 extern void kill_current_pipeline __P((void));
130 #if defined (__STDC__) && defined (pid_t)
131 extern int get_job_by_pid __P((int, int));
132 extern void describe_pid __P((int));
134 extern int get_job_by_pid __P((pid_t, int));
135 extern void describe_pid __P((pid_t));
138 extern void list_one_job __P((JOB *, int, int, int));
139 extern void list_all_jobs __P((int));
140 extern void list_stopped_jobs __P((int));
141 extern void list_running_jobs __P((int));
143 extern pid_t make_child __P((char *, int));
145 extern int get_tty_state __P((void));
146 extern int set_tty_state __P((void));
148 extern int wait_for_single_pid __P((pid_t));
149 extern void wait_for_background_pids __P((void));
150 extern int wait_for __P((pid_t));
151 extern int wait_for_job __P((int));
153 extern void notify_and_cleanup __P((void));
154 extern void reap_dead_jobs __P((void));
155 extern int start_job __P((int, int));
156 extern int kill_pid __P((pid_t, int, int));
157 extern int initialize_job_control __P((int));
158 extern void initialize_job_signals __P((void));
159 extern int give_terminal_to __P((pid_t, int));
161 extern void set_sigwinch_handler __P((void));
162 extern void unset_sigwinch_handler __P((void));
164 extern void unfreeze_jobs_list __P((void));
165 extern int set_job_control __P((int));
166 extern void without_job_control __P((void));
167 extern void end_job_control __P((void));
168 extern void restart_job_control __P((void));
169 extern void set_sigchld_handler __P((void));
170 extern void ignore_tty_job_signals __P((void));
171 extern void default_tty_job_signals __P((void));
173 #if defined (JOB_CONTROL)
174 extern int job_control;
177 #endif /* _JOBS_H_ */