xref: /openbsd/usr.bin/make/job.h (revision a6445c1d)
1 #ifndef _JOB_H_
2 #define _JOB_H_
3 
4 /*	$OpenBSD: job.h,v 1.31 2012/12/14 11:10:03 espie Exp $	*/
5 /*	$NetBSD: job.h,v 1.5 1996/11/06 17:59:10 christos Exp $ */
6 
7 /*
8  * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
9  * Copyright (c) 1988, 1989 by Adam de Boor
10  * Copyright (c) 1989 by Berkeley Softworks
11  * All rights reserved.
12  *
13  * This code is derived from software contributed to Berkeley by
14  * Adam de Boor.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  *
40  *	from: @(#)job.h 8.1 (Berkeley) 6/6/93
41  */
42 
43 /*-
44  * job.h --
45  *	Definitions pertaining to the running of jobs.
46  */
47 
48 /* Job_Make(gn);
49  *	register a new job running commands associated with building gn.
50  */
51 extern void Job_Make(GNode *);
52 /* Job_Init(maxproc);
53  *	setup job handling framework
54  */
55 extern void Job_Init(int);
56 
57 /* interface with the normal build in make.c */
58 /* okay = can_start_job();
59  *	can we run new jobs right now ?
60  */
61 extern bool can_start_job(void);
62 
63 /* finished = Job_Empty();
64  *	wait until all jobs are finished after we build everything.
65  */
66 extern bool Job_Empty(void);
67 
68 /* errors = Job_Finish();
69  *	final processing including running .END target if no errors.
70  */
71 extern bool Job_Finish(void);
72 
73 /* Job_Begin();
74  *	similarly, run .BEGIN job at start of job.
75  */
76 extern void Job_Begin(void);
77 
78 extern void Job_Wait(void);
79 extern void Job_AbortAll(void);
80 extern void print_errors(void);
81 
82 /* handle_running_jobs();
83  *	wait until something happens, like a job finishing running a command
84  *	or a signal coming in.
85  */
86 extern void handle_running_jobs(void);
87 
88 /* handle_all_signals();
89  *	if a signal was received, react accordingly.
90  *	By displaying STATUS info, or by aborting running jobs for a fatal
91  *	signals. Relies on Job_Init() for setting up handlers.
92  */
93 extern void handle_all_signals(void);
94 
95 extern void determine_expensive_job(Job *);
96 extern Job *runningJobs, *errorJobs;
97 extern void debug_job_printf(const char *, ...);
98 extern void handle_one_job(Job *);
99 extern int check_dying_signal(void);
100 
101 extern const char *basedirectory;
102 
103 #endif /* _JOB_H_ */
104