Add the beginning of the .ONESHELL special feature.
[make.git] / filedef.h
blob69f1994f9ac5e22fba698b33e648b0295d9b1db3
1 /* Definition of target file data structures for GNU Make.
2 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
3 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free
4 Software Foundation, Inc.
5 This file is part of GNU Make.
7 GNU Make is free software; you can redistribute it and/or modify it under the
8 terms of the GNU General Public License as published by the Free Software
9 Foundation; either version 3 of the License, or (at your option) any later
10 version.
12 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License along with
17 this program. If not, see <http://www.gnu.org/licenses/>. */
20 /* Structure that represents the info on one file
21 that the makefile says how to make.
22 All of these are chained together through `next'. */
24 #include "hash.h"
26 struct file
28 const char *name;
29 const char *hname; /* Hashed filename */
30 const char *vpath; /* VPATH/vpath pathname */
31 struct dep *deps; /* all dependencies, including duplicates */
32 struct commands *cmds; /* Commands to execute for this target. */
33 int command_flags; /* Flags OR'd in for cmds; see commands.h. */
34 const char *stem; /* Implicit stem, if an implicit
35 rule has been used */
36 struct dep *also_make; /* Targets that are made by making this. */
37 FILE_TIMESTAMP last_mtime; /* File's modtime, if already known. */
38 FILE_TIMESTAMP mtime_before_update; /* File's modtime before any updating
39 has been performed. */
40 struct file *prev; /* Previous entry for same file name;
41 used when there are multiple double-colon
42 entries for the same file. */
43 struct file *last; /* Last entry for the same file name. */
45 /* File that this file was renamed to. After any time that a
46 file could be renamed, call `check_renamed' (below). */
47 struct file *renamed;
49 /* List of variable sets used for this file. */
50 struct variable_set_list *variables;
52 /* Pattern-specific variable reference for this target, or null if there
53 isn't one. Also see the pat_searched flag, below. */
54 struct variable_set_list *pat_variables;
56 /* Immediate dependent that caused this target to be remade,
57 or nil if there isn't one. */
58 struct file *parent;
60 /* For a double-colon entry, this is the first double-colon entry for
61 the same file. Otherwise this is null. */
62 struct file *double_colon;
64 short int update_status; /* Status of the last attempt to update,
65 or -1 if none has been made. */
67 enum cmd_state /* State of the commands. */
68 { /* Note: It is important that cs_not_started be zero. */
69 cs_not_started, /* Not yet started. */
70 cs_deps_running, /* Dep commands running. */
71 cs_running, /* Commands running. */
72 cs_finished /* Commands finished. */
73 } command_state ENUM_BITFIELD (2);
75 unsigned int precious:1; /* Non-0 means don't delete file on quit */
76 unsigned int low_resolution_time:1; /* Nonzero if this file's time stamp
77 has only one-second resolution. */
78 unsigned int tried_implicit:1; /* Nonzero if have searched
79 for implicit rule for making
80 this file; don't search again. */
81 unsigned int updating:1; /* Nonzero while updating deps of this file */
82 unsigned int updated:1; /* Nonzero if this file has been remade. */
83 unsigned int is_target:1; /* Nonzero if file is described as target. */
84 unsigned int cmd_target:1; /* Nonzero if file was given on cmd line. */
85 unsigned int phony:1; /* Nonzero if this is a phony file
86 i.e., a prerequisite of .PHONY. */
87 unsigned int intermediate:1;/* Nonzero if this is an intermediate file. */
88 unsigned int secondary:1; /* Nonzero means remove_intermediates should
89 not delete it. */
90 unsigned int dontcare:1; /* Nonzero if no complaint is to be made if
91 this target cannot be remade. */
92 unsigned int ignore_vpath:1;/* Nonzero if we threw out VPATH name. */
93 unsigned int pat_searched:1;/* Nonzero if we already searched for
94 pattern-specific variables. */
95 unsigned int considered:1; /* equal to 'considered' if file has been
96 considered on current scan of goal chain */
97 unsigned int no_diag:1; /* True if the file failed to update and no
98 diagnostics has been issued (dontcare). */
102 extern struct file *suffix_file, *default_file;
105 struct file *lookup_file (const char *name);
106 struct file *enter_file (const char *name);
107 struct dep *split_prereqs (char *prereqstr);
108 struct dep *enter_prereqs (struct dep *prereqs, const char *stem);
109 void remove_intermediates (int sig);
110 void snap_deps (void);
111 void rename_file (struct file *file, const char *name);
112 void rehash_file (struct file *file, const char *name);
113 void set_command_state (struct file *file, enum cmd_state state);
114 void notice_finished_file (struct file *file);
115 void init_hash_files (void);
116 char *build_target_list (char *old_list);
117 void print_prereqs (const struct dep *deps);
118 void print_file_data_base (void);
120 #if FILE_TIMESTAMP_HI_RES
121 # define FILE_TIMESTAMP_STAT_MODTIME(fname, st) \
122 file_timestamp_cons (fname, (st).st_mtime, (st).st_mtim.ST_MTIM_NSEC)
123 #else
124 # define FILE_TIMESTAMP_STAT_MODTIME(fname, st) \
125 file_timestamp_cons (fname, (st).st_mtime, 0)
126 #endif
128 /* If FILE_TIMESTAMP is 64 bits (or more), use nanosecond resolution.
129 (Multiply by 2**30 instead of by 10**9 to save time at the cost of
130 slightly decreasing the number of available timestamps.) With
131 64-bit FILE_TIMESTAMP, this stops working on 2514-05-30 01:53:04
132 UTC, but by then uintmax_t should be larger than 64 bits. */
133 #define FILE_TIMESTAMPS_PER_S (FILE_TIMESTAMP_HI_RES ? 1000000000 : 1)
134 #define FILE_TIMESTAMP_LO_BITS (FILE_TIMESTAMP_HI_RES ? 30 : 0)
136 #define FILE_TIMESTAMP_S(ts) (((ts) - ORDINARY_MTIME_MIN) \
137 >> FILE_TIMESTAMP_LO_BITS)
138 #define FILE_TIMESTAMP_NS(ts) ((int) (((ts) - ORDINARY_MTIME_MIN) \
139 & ((1 << FILE_TIMESTAMP_LO_BITS) - 1)))
141 /* Upper bound on length of string "YYYY-MM-DD HH:MM:SS.NNNNNNNNN"
142 representing a file timestamp. The upper bound is not necessarily 19,
143 since the year might be less than -999 or greater than 9999.
145 Subtract one for the sign bit if in case file timestamps can be negative;
146 subtract FLOOR_LOG2_SECONDS_PER_YEAR to yield an upper bound on how many
147 file timestamp bits might affect the year;
148 302 / 1000 is log10 (2) rounded up;
149 add one for integer division truncation;
150 add one more for a minus sign if file timestamps can be negative;
151 add 4 to allow for any 4-digit epoch year (e.g. 1970);
152 add 25 to allow for "-MM-DD HH:MM:SS.NNNNNNNNN". */
153 #define FLOOR_LOG2_SECONDS_PER_YEAR 24
154 #define FILE_TIMESTAMP_PRINT_LEN_BOUND \
155 (((sizeof (FILE_TIMESTAMP) * CHAR_BIT - 1 - FLOOR_LOG2_SECONDS_PER_YEAR) \
156 * 302 / 1000) \
157 + 1 + 1 + 4 + 25)
159 FILE_TIMESTAMP file_timestamp_cons (char const *, time_t, int);
160 FILE_TIMESTAMP file_timestamp_now (int *);
161 void file_timestamp_sprintf (char *p, FILE_TIMESTAMP ts);
163 /* Return the mtime of file F (a struct file *), caching it.
164 The value is NONEXISTENT_MTIME if the file does not exist. */
165 #define file_mtime(f) file_mtime_1 ((f), 1)
166 /* Return the mtime of file F (a struct file *), caching it.
167 Don't search using vpath for the file--if it doesn't actually exist,
168 we don't find it.
169 The value is NONEXISTENT_MTIME if the file does not exist. */
170 #define file_mtime_no_search(f) file_mtime_1 ((f), 0)
171 FILE_TIMESTAMP f_mtime (struct file *file, int search);
172 #define file_mtime_1(f, v) \
173 ((f)->last_mtime == UNKNOWN_MTIME ? f_mtime ((f), v) : (f)->last_mtime)
175 /* Special timestamp values. */
177 /* The file's timestamp is not yet known. */
178 #define UNKNOWN_MTIME 0
180 /* The file does not exist. */
181 #define NONEXISTENT_MTIME 1
183 /* The file does not exist, and we assume that it is older than any
184 actual file. */
185 #define OLD_MTIME 2
187 /* The smallest and largest ordinary timestamps. */
188 #define ORDINARY_MTIME_MIN (OLD_MTIME + 1)
189 #define ORDINARY_MTIME_MAX ((FILE_TIMESTAMP_S (NEW_MTIME) \
190 << FILE_TIMESTAMP_LO_BITS) \
191 + ORDINARY_MTIME_MIN + FILE_TIMESTAMPS_PER_S - 1)
193 /* Modtime value to use for `infinitely new'. We used to get the current time
194 from the system and use that whenever we wanted `new'. But that causes
195 trouble when the machine running make and the machine holding a file have
196 different ideas about what time it is; and can also lose for `force'
197 targets, which need to be considered newer than anything that depends on
198 them, even if said dependents' modtimes are in the future. */
199 #define NEW_MTIME INTEGER_TYPE_MAXIMUM (FILE_TIMESTAMP)
201 #define check_renamed(file) \
202 while ((file)->renamed != 0) (file) = (file)->renamed /* No ; here. */
204 /* Have we snapped deps yet? */
205 extern int snapped_deps;