jobs.h revision 97659
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 * 3. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *	This product includes software developed by the University of
19 *	California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 *    may be used to endorse or promote products derived from this software
22 *    without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 *	@(#)jobs.h	8.2 (Berkeley) 5/4/95
37 * $FreeBSD: head/bin/sh/jobs.h 97659 2002-05-31 12:31:23Z tjr $
38 */
39
40/* Mode argument to forkshell.  Don't change FORK_FG or FORK_BG. */
41#define FORK_FG 0
42#define FORK_BG 1
43#define FORK_NOJOB 2
44
45#include <signal.h>		/* for sig_atomic_t */
46
47/*
48 * A job structure contains information about a job.  A job is either a
49 * single process or a set of processes contained in a pipeline.  In the
50 * latter case, pidlist will be non-NULL, and will point to a -1 terminated
51 * array of pids.
52 */
53
54struct procstat {
55	pid_t pid;		/* process id */
56	int status;		/* status flags (defined above) */
57	char *cmd;		/* text of command being run */
58};
59
60
61/* states */
62#define JOBSTOPPED 1		/* all procs are stopped */
63#define JOBDONE 2		/* all procs are completed */
64
65
66struct job {
67	struct procstat ps0;	/* status of process */
68	struct procstat *ps;	/* status or processes when more than one */
69	short nprocs;		/* number of processes */
70	short pgrp;		/* process group of this job */
71	char state;		/* true if job is finished */
72	char used;		/* true if this entry is in used */
73	char changed;		/* true if status has changed */
74#if JOBS
75	char jobctl;		/* job running under job control */
76	struct job *next;	/* job used after this one */
77#endif
78};
79
80extern pid_t backgndpid;	/* pid of last background process */
81extern int job_warning;		/* user was warned about stopped jobs */
82extern int in_waitcmd;		/* are we in waitcmd()? */
83extern int in_dowait;		/* are we in dowait()? */
84extern volatile sig_atomic_t breakwaitcmd; /* break wait to process traps? */
85
86void setjobctl(int);
87int fgcmd(int, char **);
88int bgcmd(int, char **);
89int jobscmd(int, char **);
90void showjobs(int);
91int waitcmd(int, char **);
92int jobidcmd(int, char **);
93struct job *makejob(union node *, int);
94int forkshell(struct job *, union node *, int);
95int waitforjob(struct job *, int *);
96int stoppedjobs(void);
97char *commandtext(union node *);
98
99#if ! JOBS
100#define setjobctl(on)	/* do nothing */
101#endif
102