Annotation of src/usr.bin/make/engine.h, Revision 1.12
1.1 espie 1: #ifndef ENGINE_H
2: #define ENGINE_H
1.12 ! espie 3: /* $OpenBSD: engine.h,v 1.11 2012/10/06 09:32:40 espie Exp $ */
1.1 espie 4:
5: /*
6: * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
7: * Copyright (c) 1988, 1989 by Adam de Boor
8: * Copyright (c) 1989 by Berkeley Softworks
9: * All rights reserved.
10: *
11: * This code is derived from software contributed to Berkeley by
12: * Adam de Boor.
13: *
14: * Redistribution and use in source and binary forms, with or without
15: * modification, are permitted provided that the following conditions
16: * are met:
17: * 1. Redistributions of source code must retain the above copyright
18: * notice, this list of conditions and the following disclaimer.
19: * 2. Redistributions in binary form must reproduce the above copyright
20: * notice, this list of conditions and the following disclaimer in the
21: * documentation and/or other materials provided with the distribution.
22: * 3. Neither the name of the University nor the names of its contributors
23: * may be used to endorse or promote products derived from this software
24: * without specific prior written permission.
25: *
26: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36: * SUCH DAMAGE.
37: *
38: * from: @(#)job.h 8.1 (Berkeley) 6/6/93
39: */
40:
1.10 espie 41: /* ok = node_find_valid_commands(node);
1.1 espie 42: * verify the integrity of a node's commands, pulling stuff off
1.2 espie 43: * .DEFAULT and other places if necessary.
1.1 espie 44: */
1.10 espie 45: extern bool node_find_valid_commands(GNode *);
46: extern void node_failure(GNode *);
1.4 espie 47: /* Job_Touch(node);
1.1 espie 48: * touch the path corresponding to a node or update the corresponding
49: * archive object.
50: */
1.4 espie 51: extern void Job_Touch(GNode *);
1.1 espie 52: /* Make_TimeStamp(parent, child);
53: * ensure parent is at least as recent as child.
54: */
55: extern void Make_TimeStamp(GNode *, GNode *);
56: /* Make_HandleUse(user_node, usee_node);
57: * let user_node inherit the commands from usee_node
58: */
59: extern void Make_HandleUse(GNode *, GNode *);
60:
61: /* old = Make_OODate(node);
62: * check if a given node is out-of-date.
63: */
64: extern bool Make_OODate(GNode *);
65: /* Make_DoAllVar(node);
66: * fill all dynamic variables for a node.
67: */
68: extern void Make_DoAllVar(GNode *);
1.3 espie 69:
1.10 espie 70: extern int run_gnode(GNode *);
71:
72: extern void run_command(const char *, bool);
1.3 espie 73:
1.10 espie 74: /*-
75: * Job Table definitions.
76: *
77: * Each job has several things associated with it:
78: * 1) The process id of the child shell
79: * 2) The graph node describing the target being made by this job
80: * 3) State associated to latest command run
81: * 5) A word of flags which determine how the module handles errors,
82: * echoing, etc. for the job
83: *
84: * The job "table" is kept as a linked Lst in 'jobs', with the number of
85: * active jobs maintained in the 'nJobs' variable. At no time will this
86: * exceed the value of 'maxJobs', initialized by the Job_Init function.
87: *
88: * When a job is finished, the Make_Update function is called on each of the
89: * parents of the node which was just remade. This takes care of the upward
90: * traversal of the dependency graph.
91: */
92: struct Job_ {
93: struct Job_ *next; /* singly linked list */
94: pid_t pid; /* Current command process id */
95: Location *location;
96: int exit_type; /* last child exit or signal */
97: #define JOB_EXIT_OKAY 0
98: #define JOB_EXIT_BAD 1
99: #define JOB_SIGNALED 2
100: int code; /* exit status or signal code */
101: LstNode next_cmd; /* Next command to run */
102: char *cmd; /* Last command run */
103: GNode *node; /* Target of this job */
104: unsigned short flags;
105: #define JOB_SILENT 0x001 /* Command was silent */
106: #define JOB_IS_EXPENSIVE 0x002
1.11 espie 107: #define JOB_LOST 0x004 /* sent signal to non-existing pid ? */
1.10 espie 108: #define JOB_ERRCHECK 0x008 /* command wants errcheck */
109: };
110:
111: extern bool job_run_next(Job *);
1.3 espie 112:
1.10 espie 113: extern void job_attach_node(Job *, GNode *);
114: extern void job_handle_status(Job *, int);
1.3 espie 115:
1.1 espie 116: #endif