1/*-
2 * Copyright (c) 1991, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Kenneth Almquist.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 4. Neither the name of the University nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 *	@(#)jobs.h	8.2 (Berkeley) 5/4/95
33 * $FreeBSD$
34 */
35
36/* Mode argument to forkshell.  Don't change FORK_FG or FORK_BG. */
37#define FORK_FG 0
38#define FORK_BG 1
39#define FORK_NOJOB 2
40
41#include <signal.h>		/* for sig_atomic_t */
42
43/*
44 * A job structure contains information about a job.  A job is either a
45 * single process or a set of processes contained in a pipeline.  In the
46 * latter case, pidlist will be non-NULL, and will point to a -1 terminated
47 * array of pids.
48 */
49
50struct procstat {
51	pid_t pid;		/* process id */
52	int status;		/* status flags (defined above) */
53	char *cmd;		/* text of command being run */
54};
55
56
57/* states */
58#define JOBSTOPPED 1		/* all procs are stopped */
59#define JOBDONE 2		/* all procs are completed */
60
61
62struct job {
63	struct procstat ps0;	/* status of process */
64	struct procstat *ps;	/* status or processes when more than one */
65	short nprocs;		/* number of processes */
66	pid_t pgrp;		/* process group of this job */
67	char state;		/* true if job is finished */
68	char used;		/* true if this entry is in used */
69	char changed;		/* true if status has changed */
70	char foreground;	/* true if running in the foreground */
71	char remembered;	/* true if $! referenced */
72#if JOBS
73	char jobctl;		/* job running under job control */
74	struct job *next;	/* job used after this one */
75#endif
76};
77
78enum {
79	SHOWJOBS_DEFAULT,	/* job number, status, command */
80	SHOWJOBS_VERBOSE,	/* job number, PID, status, command */
81	SHOWJOBS_PIDS,		/* PID only */
82	SHOWJOBS_PGIDS		/* PID of the group leader only */
83};
84
85extern int job_warning;		/* user was warned about stopped jobs */
86extern int in_waitcmd;		/* are we in waitcmd()? */
87extern int in_dowait;		/* are we in dowait()? */
88extern volatile sig_atomic_t breakwaitcmd; /* break wait to process traps? */
89
90void setjobctl(int);
91void showjobs(int, int);
92struct job *makejob(union node *, int);
93pid_t forkshell(struct job *, union node *, int);
94pid_t vforkexecshell(struct job *, char **, char **, const char *, int, int []);
95int waitforjob(struct job *, int *);
96int stoppedjobs(void);
97int backgndpidset(void);
98pid_t backgndpidval(void);
99char *commandtext(union node *);
100
101#if ! JOBS
102#define setjobctl(on)	/* do nothing */
103#endif
104