[thirdparty/bash.git] / jobs.h

/* jobs.h -- structures and stuff used by the jobs.c file. */

/* Copyright (C) 1993-2004 Free Software Foundation, Inc.

   This file is part of GNU Bash, the Bourne Again SHell.

   Bash is free software; you can redistribute it and/or modify it under
   the terms of the GNU General Public License as published by the Free
   Software Foundation; either version 2, or (at your option) any later
   version.

   Bash is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   for more details.

   You should have received a copy of the GNU General Public License along
   with Bash; see the file COPYING.  If not, write to the Free Software
   Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */

#if !defined (_JOBS_H_)
#  define _JOBS_H_

#include "quit.h"
#include "siglist.h"

#include "stdc.h"

#include "posixwait.h"

/* Defines controlling the fashion in which jobs are listed. */
#define JLIST_STANDARD       0
#define JLIST_LONG	     1
#define JLIST_PID_ONLY	     2
#define JLIST_CHANGED_ONLY   3
#define JLIST_NONINTERACTIVE 4

/* I looked it up.  For pretty_print_job ().  The real answer is 24. */
#define LONGEST_SIGNAL_DESC 24

/* We keep an array of jobs.  Each entry in the array is a linked list
   of processes that are piped together.  The first process encountered is
   the group leader. */

/* Values for the `running' field of a struct process. */
#define PS_DONE		0
#define PS_RUNNING	1
#define PS_STOPPED	2

/* Each child of the shell is remembered in a STRUCT PROCESS.  A chain of
   such structures is a pipeline.  The chain is circular. */
typedef struct process {
  struct process *next;	/* Next process in the pipeline.  A circular chain. */
  pid_t pid;		/* Process ID. */
  WAIT status;		/* The status of this command as returned by wait. */
  int running;		/* Non-zero if this process is running. */
  char *command;	/* The particular program that is running. */
} PROCESS;

/* PRUNNING really means `not exited' */
#define PRUNNING(p)	((p)->running || WIFSTOPPED((p)->status))
#define PSTOPPED(p)	(WIFSTOPPED((p)->status))
#define PDEADPROC(p)	((p)->running == PS_DONE)

/* A description of a pipeline's state. */
typedef enum { JRUNNING, JSTOPPED, JDEAD, JMIXED } JOB_STATE;
#define JOBSTATE(job) (jobs[(job)]->state)

#define STOPPED(j)	(jobs[(j)]->state == JSTOPPED)
#define RUNNING(j)	(jobs[(j)]->state == JRUNNING)
#define DEADJOB(j)	(jobs[(j)]->state == JDEAD)

/* Values for the FLAGS field in the JOB struct below. */
#define J_FOREGROUND 0x01 /* Non-zero if this is running in the foreground.  */
#define J_NOTIFIED   0x02 /* Non-zero if already notified about job state.   */
#define J_JOBCONTROL 0x04 /* Non-zero if this job started under job control. */
#define J_NOHUP      0x08 /* Don't send SIGHUP to job if shell gets SIGHUP. */

#define IS_FOREGROUND(j)	((jobs[j]->flags & J_FOREGROUND) != 0)
#define IS_NOTIFIED(j)		((jobs[j]->flags & J_NOTIFIED) != 0)
#define IS_JOBCONTROL(j)	((jobs[j]->flags & J_JOBCONTROL) != 0)

typedef struct job {
  char *wd;	   /* The working directory at time of invocation. */
  PROCESS *pipe;   /* The pipeline of processes that make up this job. */
  pid_t pgrp;	   /* The process ID of the process group (necessary). */
  JOB_STATE state; /* The state that this job is in. */
  int flags;	   /* Flags word: J_NOTIFIED, J_FOREGROUND, or J_JOBCONTROL. */
#if defined (JOB_CONTROL)
  COMMAND *deferred;	/* Commands that will execute when this job is done. */
  sh_vptrfunc_t *j_cleanup; /* Cleanup function to call when job marked JDEAD */
  PTR_T cleanarg;	/* Argument passed to (*j_cleanup)() */
#endif /* JOB_CONTROL */
} JOB;

#define NO_JOB  -1	/* An impossible job array index. */
#define DUP_JOB -2	/* A possible return value for get_job_spec (). */
#define BAD_JOBSPEC -3	/* Bad syntax for job spec. */

/* A value which cannot be a process ID. */
#define NO_PID (pid_t)-1

/* System calls. */
#if !defined (HAVE_UNISTD_H)
extern pid_t fork (), getpid (), getpgrp ();
#endif /* !HAVE_UNISTD_H */

/* Stuff from the jobs.c file. */
extern pid_t original_pgrp, shell_pgrp, pipeline_pgrp;
extern pid_t last_made_pid, last_asynchronous_pid;
extern int current_job, previous_job;
extern int asynchronous_notification;
extern JOB **jobs;
extern int job_slots;

extern void making_children __P((void));
extern void stop_making_children __P((void));
extern void cleanup_the_pipeline __P((void));
extern void save_pipeline __P((int));
extern void restore_pipeline __P((int));
extern void start_pipeline __P((void));
extern int stop_pipeline __P((int, COMMAND *));

extern void delete_job __P((int, int));
extern void nohup_job __P((int));
extern void delete_all_jobs __P((int));
extern void nohup_all_jobs __P((int));

extern int count_all_jobs __P((void));

extern void terminate_current_pipeline __P((void));
extern void terminate_stopped_jobs __P((void));
extern void hangup_all_jobs __P((void));
extern void kill_current_pipeline __P((void));

#if defined (__STDC__) && defined (pid_t)
extern int get_job_by_pid __P((int, int));
extern void describe_pid __P((int));
#else
extern int get_job_by_pid __P((pid_t, int));
extern void describe_pid __P((pid_t));
#endif

extern void list_one_job __P((JOB *, int, int, int));
extern void list_all_jobs __P((int));
extern void list_stopped_jobs __P((int));
extern void list_running_jobs __P((int));

extern pid_t make_child __P((char *, int));

extern int get_tty_state __P((void));
extern int set_tty_state __P((void));

extern int wait_for_single_pid __P((pid_t));
extern void wait_for_background_pids __P((void));
extern int wait_for __P((pid_t));
extern int wait_for_job __P((int));

extern void notify_and_cleanup __P((void));
extern void reap_dead_jobs __P((void));
extern int start_job __P((int, int));
extern int kill_pid __P((pid_t, int, int));
extern int initialize_job_control __P((int));
extern void initialize_job_signals __P((void));
extern int give_terminal_to __P((pid_t, int));

extern void set_sigwinch_handler __P((void));
extern void unset_sigwinch_handler __P((void));

extern void unfreeze_jobs_list __P((void));
extern int set_job_control __P((int));
extern void without_job_control __P((void));
extern void end_job_control __P((void));
extern void restart_job_control __P((void));
extern void set_sigchld_handler __P((void));
extern void ignore_tty_job_signals __P((void));
extern void default_tty_job_signals __P((void));

#if defined (JOB_CONTROL)
extern int job_control;
#endif

#endif /* _JOBS_H_ */
Commit	Line	Data
726f6388 JA	1	/* jobs.h -- structures and stuff used by the jobs.c file. */
726f6388 JA	2
b80f6443	3	/* Copyright (C) 1993-2004 Free Software Foundation, Inc.
726f6388 JA	4
	5	This file is part of GNU Bash, the Bourne Again SHell.
	6
	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
	10	version.
	11
	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
	15	for more details.
	16
	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
bb70624e	19	Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
726f6388	20
ccc6cda3 JA	21	#if !defined (_JOBS_H_)
ccc6cda3 JA	22	# define _JOBS_H_
726f6388 JA	23
	24	#include "quit.h"
	25	#include "siglist.h"
	26
	27	#include "stdc.h"
	28
d166f048 JA	29	#include "posixwait.h"
d166f048 JA	30
726f6388	31	/* Defines controlling the fashion in which jobs are listed. */
ccc6cda3 JA	32	#define JLIST_STANDARD 0
	33	#define JLIST_LONG 1
	34	#define JLIST_PID_ONLY 2
	35	#define JLIST_CHANGED_ONLY 3
	36	#define JLIST_NONINTERACTIVE 4
	37
726f6388 JA	38	/* I looked it up. For pretty_print_job (). The real answer is 24. */
	39	#define LONGEST_SIGNAL_DESC 24
	40
	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
	43	the group leader. */
	44
f73dda09 JA	45	/* Values for the `running' field of a struct process. */
	46	#define PS_DONE 0
	47	#define PS_RUNNING 1
	48	#define PS_STOPPED 2
	49
726f6388 JA	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. */
	58	} PROCESS;
	59
7117c2d2 JA	60	/* PRUNNING really means `not exited' */
	61	#define PRUNNING(p) ((p)->running \|\| WIFSTOPPED((p)->status))
	62	#define PSTOPPED(p) (WIFSTOPPED((p)->status))
	63	#define PDEADPROC(p) ((p)->running == PS_DONE)
	64
726f6388 JA	65	/* A description of a pipeline's state. */
	66	typedef enum { JRUNNING, JSTOPPED, JDEAD, JMIXED } JOB_STATE;
	67	#define JOBSTATE(job) (jobs[(job)]->state)
	68
ccc6cda3 JA	69	#define STOPPED(j) (jobs[(j)]->state == JSTOPPED)
	70	#define RUNNING(j) (jobs[(j)]->state == JRUNNING)
	71	#define DEADJOB(j) (jobs[(j)]->state == JDEAD)
	72
726f6388 JA	73	/* Values for the FLAGS field in the JOB struct below. */
	74	#define J_FOREGROUND 0x01 /* Non-zero if this is running in the foreground. */
	75	#define J_NOTIFIED 0x02 /* Non-zero if already notified about job state. */
	76	#define J_JOBCONTROL 0x04 /* Non-zero if this job started under job control. */
ccc6cda3 JA	77	#define J_NOHUP 0x08 /* Don't send SIGHUP to job if shell gets SIGHUP. */
	78
	79	#define IS_FOREGROUND(j) ((jobs[j]->flags & J_FOREGROUND) != 0)
	80	#define IS_NOTIFIED(j) ((jobs[j]->flags & J_NOTIFIED) != 0)
	81	#define IS_JOBCONTROL(j) ((jobs[j]->flags & J_JOBCONTROL) != 0)
726f6388 JA	82
	83	typedef struct job {
	84	char wd; / The working directory at time of invocation. */
	85	PROCESS pipe; / The pipeline of processes that make up this job. */
	86	pid_t pgrp; /* The process ID of the process group (necessary). */
	87	JOB_STATE state; /* The state that this job is in. */
	88	int flags; /* Flags word: J_NOTIFIED, J_FOREGROUND, or J_JOBCONTROL. */
	89	#if defined (JOB_CONTROL)
	90	COMMAND deferred; / Commands that will execute when this job is done. */
f73dda09	91	sh_vptrfunc_t j_cleanup; / Cleanup function to call when job marked JDEAD */
ccc6cda3	92	PTR_T cleanarg; /* Argument passed to (j_cleanup)() /
726f6388 JA	93	#endif /* JOB_CONTROL */
	94	} JOB;
	95
	96	#define NO_JOB -1 /* An impossible job array index. */
	97	#define DUP_JOB -2 /* A possible return value for get_job_spec (). */
b80f6443	98	#define BAD_JOBSPEC -3 /* Bad syntax for job spec. */
726f6388 JA	99
	100	/* A value which cannot be a process ID. */
	101	#define NO_PID (pid_t)-1
	102
726f6388	103	/* System calls. */
ccc6cda3	104	#if !defined (HAVE_UNISTD_H)
726f6388	105	extern pid_t fork (), getpid (), getpgrp ();
ccc6cda3	106	#endif /* !HAVE_UNISTD_H */
726f6388 JA	107
726f6388 JA	108	/* Stuff from the jobs.c file. */
bb70624e	109	extern pid_t original_pgrp, shell_pgrp, pipeline_pgrp;
726f6388 JA	110	extern pid_t last_made_pid, last_asynchronous_pid;
	111	extern int current_job, previous_job;
	112	extern int asynchronous_notification;
	113	extern JOB **jobs;
	114	extern int job_slots;
	115
	116	extern void making_children __P((void));
	117	extern void stop_making_children __P((void));
	118	extern void cleanup_the_pipeline __P((void));
ccc6cda3 JA	119	extern void save_pipeline __P((int));
ccc6cda3 JA	120	extern void restore_pipeline __P((int));
726f6388 JA	121	extern void start_pipeline __P((void));
726f6388 JA	122	extern int stop_pipeline __P((int, COMMAND *));
d166f048	123
cce855bc	124	extern void delete_job __P((int, int));
ccc6cda3	125	extern void nohup_job __P((int));
cce855bc JA	126	extern void delete_all_jobs __P((int));
cce855bc JA	127	extern void nohup_all_jobs __P((int));
726f6388	128
bb70624e JA	129	extern int count_all_jobs __P((void));
bb70624e JA	130
726f6388 JA	131	extern void terminate_current_pipeline __P((void));
	132	extern void terminate_stopped_jobs __P((void));
	133	extern void hangup_all_jobs __P((void));
	134	extern void kill_current_pipeline __P((void));
	135
	136	#if defined (__STDC__) && defined (pid_t)
d166f048	137	extern int get_job_by_pid __P((int, int));
726f6388 JA	138	extern void describe_pid __P((int));
726f6388 JA	139	#else
d166f048	140	extern int get_job_by_pid __P((pid_t, int));
726f6388 JA	141	extern void describe_pid __P((pid_t));
	142	#endif
	143
ccc6cda3 JA	144	extern void list_one_job __P((JOB *, int, int, int));
	145	extern void list_all_jobs __P((int));
	146	extern void list_stopped_jobs __P((int));
	147	extern void list_running_jobs __P((int));
726f6388 JA	148
726f6388 JA	149	extern pid_t make_child __P((char *, int));
bb70624e	150
726f6388 JA	151	extern int get_tty_state __P((void));
	152	extern int set_tty_state __P((void));
	153
	154	extern int wait_for_single_pid __P((pid_t));
	155	extern void wait_for_background_pids __P((void));
	156	extern int wait_for __P((pid_t));
	157	extern int wait_for_job __P((int));
	158
	159	extern void notify_and_cleanup __P((void));
	160	extern void reap_dead_jobs __P((void));
	161	extern int start_job __P((int, int));
	162	extern int kill_pid __P((pid_t, int, int));
d166f048	163	extern int initialize_job_control __P((int));
726f6388	164	extern void initialize_job_signals __P((void));
28ef6c31	165	extern int give_terminal_to __P((pid_t, int));
726f6388	166
ccc6cda3 JA	167	extern void set_sigwinch_handler __P((void));
	168	extern void unset_sigwinch_handler __P((void));
	169
	170	extern void unfreeze_jobs_list __P((void));
726f6388 JA	171	extern int set_job_control __P((int));
	172	extern void without_job_control __P((void));
	173	extern void end_job_control __P((void));
	174	extern void restart_job_control __P((void));
	175	extern void set_sigchld_handler __P((void));
ccc6cda3 JA	176	extern void ignore_tty_job_signals __P((void));
ccc6cda3 JA	177	extern void default_tty_job_signals __P((void));
726f6388 JA	178
	179	#if defined (JOB_CONTROL)
	180	extern int job_control;
	181	#endif
	182
ccc6cda3	183	#endif /* _JOBS_H_ */