bin/sh/jobs.h

   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: src/bin/sh/jobs.h,v 1.19 2006/10/07 16:51:16 stefanf Exp $
  38  * $DragonFly: src/bin/sh/jobs.h,v 1.3 2007/01/13 20:33:47 pavalos Exp $
  39  */
  40
  41 /* Mode argument to forkshell.  Don't change FORK_FG or FORK_BG. */
  42 #define FORK_FG 0
  43 #define FORK_BG 1
  44 #define FORK_NOJOB 2
  45
  46 #include <signal.h>             /* for sig_atomic_t */
  47
  48 /*
  49  * A job structure contains information about a job.  A job is either a
  50  * single process or a set of processes contained in a pipeline.  In the
  51  * latter case, pidlist will be non-NULL, and will point to a -1 terminated
  52  * array of pids.
  53  */
  54
  55 struct procstat {
  56         pid_t pid;              /* process id */
  57         int status;             /* status flags (defined above) */
  58         char *cmd;              /* text of command being run */
  59 };
  60
  61
  62 /* states */
  63 #define JOBSTOPPED 1            /* all procs are stopped */
  64 #define JOBDONE 2               /* all procs are completed */
  65
  66
  67 struct job {
  68         struct procstat ps0;    /* status of process */
  69         struct procstat *ps;    /* status or processes when more than one */
  70         short nprocs;           /* number of processes */
  71         pid_t pgrp;             /* process group of this job */
  72         char state;             /* true if job is finished */
  73         char used;              /* true if this entry is in used */
  74         char changed;           /* true if status has changed */
  75         char foreground;        /* true if running in the foreground */
  76 #if JOBS
  77         char jobctl;            /* job running under job control */
  78         struct job *next;       /* job used after this one */
  79 #endif
  80 };
  81
  82 enum {
  83         SHOWJOBS_DEFAULT,       /* job number, status, command */
  84         SHOWJOBS_VERBOSE,       /* job number, PID, status, command */
  85         SHOWJOBS_PIDS,          /* PID only */
  86         SHOWJOBS_PGIDS          /* PID of the group leader only */
  87 };
  88
  89 extern pid_t backgndpid;        /* pid of last background process */
  90 extern int job_warning;         /* user was warned about stopped jobs */
  91 extern int in_waitcmd;          /* are we in waitcmd()? */
  92 extern int in_dowait;           /* are we in dowait()? */
  93 extern volatile sig_atomic_t breakwaitcmd; /* break wait to process traps? */
  94
  95 void setjobctl(int);
  96 int fgcmd(int, char **);
  97 int bgcmd(int, char **);
  98 int jobscmd(int, char **);
  99 void showjobs(int, int);
 100 int waitcmd(int, char **);
 101 int jobidcmd(int, char **);
 102 struct job *makejob(union node *, int);
 103 pid_t forkshell(struct job *, union node *, int);
 104 int waitforjob(struct job *, int *);
 105 int stoppedjobs(void);
 106 char *commandtext(union node *);
 107
 108 #if ! JOBS
 109 #define setjobctl(on)   /* do nothing */
 110 #endif