xref: /netbsd/bin/sh/jobs.h (revision 14acc88f)
1 /*	$NetBSD: jobs.h,v 1.26 2023/04/07 10:34:13 kre Exp $	*/
2 
3 /*-
4  * Copyright (c) 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Kenneth Almquist.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)jobs.h	8.2 (Berkeley) 5/4/95
35  */
36 
37 #include "output.h"
38 
39 /* Mode argument to forkshell.  Don't change FORK_FG or FORK_BG. */
40 #define FORK_FG 0
41 #define FORK_BG 1
42 #define FORK_NOJOB 2
43 
44 /* mode flags for showjob(s) */
45 #define	SHOW_PGID	0x01	/* only show pgid - for jobs -p */
46 #define	SHOW_MULTILINE	0x02	/* one line per process */
47 #define	SHOW_PID	0x04	/* include process pid */
48 #define	SHOW_CHANGED	0x08	/* only jobs whose state has changed */
49 #define	SHOW_SIGNALLED	0x10	/* only if stopped/exited on signal */
50 #define	SHOW_ISSIG	0x20	/* job was signalled */
51 #define	SHOW_NO_FREE	0x40	/* do not free job */
52 #define	SHOW_PROCTITLE	0x80	/* set the process title */
53 
54 
55 /*
56  * A job structure contains information about a job.  A job is either a
57  * single process or a set of processes contained in a pipeline.  In the
58  * latter case, pidlist will be non-NULL, and will point to a -1 terminated
59  * array of pids.
60  */
61 #define	MAXCMDTEXT	200
62 
63 struct procstat {
64 	pid_t	pid;		/* process id */
65  	int	status;		/* last process status from wait() */
66  	char	cmd[MAXCMDTEXT];/* text of command being run */
67 };
68 
69 struct job {
70 	struct procstat ps0;	/* status of process */
71 	struct procstat *ps;	/* status or processes when more than one */
72 	void	*ref;		/* temporary reference, used variously */
73 	int	nprocs;		/* number of processes */
74 	pid_t	pgrp;		/* process group of this job */
75 	char	state;
76 #define	JOBRUNNING	0	/* at least one proc running */
77 #define	JOBSTOPPED	1	/* all procs are stopped */
78 #define	JOBDONE		2	/* all procs are completed */
79 	char	used;		/* true if this entry is in used */
80 	char	flags;
81 #define	JOBCHANGED	1	/* set if status has changed */
82 #define	JOBWANTED	2	/* set if this is a job being sought */
83 #define	JPIPEFAIL	4	/* set if -o pipefail when job created */
84 #if JOBS
85 	char 	jobctl;		/* job running under job control */
86 	int	prev_job;	/* previous job index */
87 #endif
88 };
89 
90 extern pid_t backgndpid;	/* pid of last background process */
91 extern int job_warning;		/* user was warned about stopped jobs */
92 
93 void setjobctl(int);
94 void showjobs(struct output *, int);
95 struct job *makejob(union node *, int);
96 int forkshell(struct job *, union node *, int);
97 void forkchild(struct job *, union node *, int, int);
98 int forkparent(struct job *, union node *, int, pid_t);
99 int waitforjob(struct job *);
100 int stoppedjobs(void);
101 void commandtext(struct procstat *, union node *);
102 int getjobpgrp(const char *);
103 int anyjobs(void);
104 
105 #if ! JOBS
106 #define setjobctl(on)	/* do nothing */
107 #endif
108