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,
4 2010 Free Software Foundation, Inc.
5 This file is part of GNU Make.
6 
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.
11 
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.
15 
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/>.  */
18 
19 
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'.  */
23 
24 #include "hash.h"
25 
26 struct file
27   {
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 #ifdef CONFIG_WITH_LAZY_DEPS_VARS
33     struct dep *deps_no_dupes;	/* dependencies without duplicates, created on
34                                    demaned by func_deps. */
35 #endif
36     struct commands *cmds;	/* Commands to execute for this target.  */
37     int command_flags;		/* Flags OR'd in for cmds; see commands.h.  */
38     const char *stem;		/* Implicit stem, if an implicit
39                                    rule has been used */
40     struct dep *also_make;	/* Targets that are made by making this.  */
41     FILE_TIMESTAMP last_mtime;	/* File's modtime, if already known.  */
42     FILE_TIMESTAMP mtime_before_update;	/* File's modtime before any updating
43                                            has been performed.  */
44     struct file *prev;		/* Previous entry for same file name;
45 				   used when there are multiple double-colon
46 				   entries for the same file.  */
47     struct file *last;          /* Last entry for the same file name.  */
48 
49     /* File that this file was renamed to.  After any time that a
50        file could be renamed, call `check_renamed' (below).  */
51     struct file *renamed;
52 
53     /* List of variable sets used for this file.  */
54     struct variable_set_list *variables;
55 
56     /* Pattern-specific variable reference for this target, or null if there
57        isn't one.  Also see the pat_searched flag, below.  */
58     struct variable_set_list *pat_variables;
59 
60     /* Immediate dependent that caused this target to be remade,
61        or nil if there isn't one.  */
62     struct file *parent;
63 
64     /* For a double-colon entry, this is the first double-colon entry for
65        the same file.  Otherwise this is null.  */
66     struct file *double_colon;
67 
68 #ifdef CONFIG_WITH_EXPLICIT_MULTITARGET
69     /* For a target of an explicit multi target rule, this points to the
70        primary target.  Otherwise this is null. */
71     struct file *multi_head;
72     /* Pointer to next target of an explicit multi target rule. */
73     struct file *multi_next;
74 #endif
75 
76 #ifdef CONFIG_WITH_COMPILER
77     struct kmk_cc_evalprog *evalprog; /* Pointer to evalval/evalctx "program". */
78 #endif
79 
80     short int update_status;	/* Status of the last attempt to update,
81 				   or -1 if none has been made.  */
82 
83     enum cmd_state		/* State of the commands.  */
84       {		/* Note: It is important that cs_not_started be zero.  */
85 	cs_not_started,		/* Not yet started.  */
86 	cs_deps_running,	/* Dep commands running.  */
87 	cs_running,		/* Commands running.  */
88 	cs_finished		/* Commands finished.  */
89       } command_state ENUM_BITFIELD (2);
90 
91     unsigned int precious:1;	/* Non-0 means don't delete file on quit */
92     unsigned int low_resolution_time:1;	/* Nonzero if this file's time stamp
93 					   has only one-second resolution.  */
94     unsigned int tried_implicit:1; /* Nonzero if have searched
95 				      for implicit rule for making
96 				      this file; don't search again.  */
97     unsigned int updating:1;	/* Nonzero while updating deps of this file */
98     unsigned int updated:1;	/* Nonzero if this file has been remade.  */
99     unsigned int is_target:1;	/* Nonzero if file is described as target.  */
100     unsigned int cmd_target:1;	/* Nonzero if file was given on cmd line.  */
101     unsigned int phony:1;	/* Nonzero if this is a phony file
102 				   i.e., a prerequisite of .PHONY.  */
103     unsigned int intermediate:1;/* Nonzero if this is an intermediate file.  */
104     unsigned int secondary:1;   /* Nonzero means remove_intermediates should
105                                    not delete it.  */
106     unsigned int dontcare:1;	/* Nonzero if no complaint is to be made if
107 				   this target cannot be remade.  */
108     unsigned int ignore_vpath:1;/* Nonzero if we threw out VPATH name.  */
109     unsigned int pat_searched:1;/* Nonzero if we already searched for
110                                    pattern-specific variables.  */
111     unsigned int considered:1;  /* equal to 'considered' if file has been
112                                    considered on current scan of goal chain */
113     unsigned int no_diag:1;     /* True if the file failed to update and no
114                                    diagnostics has been issued (dontcare). */
115 
116 #ifdef CONFIG_WITH_EXPLICIT_MULTITARGET
117     unsigned int multi_maybe:1; /* Nonzero if this file isn't always updated
118                                    by the explicit multi target rule. */
119 #endif
120 #ifdef CONFIG_WITH_2ND_TARGET_EXPANSION
121     unsigned int need_2nd_target_expansion:1; /* Nonzero if this file needs
122                                   second expansion of its name. Whether it
123                                   can receive this is decided at parse time,
124                                   and the expanding done in snap_deps. */
125 #endif
126 #if defined (CONFIG_WITH_COMPILER) || defined (CONFIG_WITH_MAKE_STATS)
127     unsigned int eval_count:14; /* Times evaluated as a makefile. */
128 #endif
129   };
130 
131 
132 extern struct file *suffix_file, *default_file;
133 
134 
135 struct file *lookup_file (const char *name);
136 #ifdef CONFIG_WITH_STRCACHE2
137 struct file *lookup_file_cached (const char *name);
138 #endif
139 struct file *enter_file (const char *name);
140 struct dep *split_prereqs (char *prereqstr);
141 struct dep *enter_prereqs (struct dep *prereqs, const char *stem);
142 void remove_intermediates (int sig);
143 void snap_deps (void);
144 void rename_file (struct file *file, const char *name);
145 void rehash_file (struct file *file, const char *name);
146 void set_command_state (struct file *file, enum cmd_state state);
147 void notice_finished_file (struct file *file);
148 void init_hash_files (void);
149 char *build_target_list (char *old_list);
150 void print_prereqs (const struct dep *deps);
151 void print_file_data_base (void);
152 
153 #if FILE_TIMESTAMP_HI_RES
154 # define FILE_TIMESTAMP_STAT_MODTIME(fname, st) \
155     file_timestamp_cons (fname, (st).st_mtime, (st).st_mtim.ST_MTIM_NSEC)
156 #else
157 # define FILE_TIMESTAMP_STAT_MODTIME(fname, st) \
158     file_timestamp_cons (fname, (st).st_mtime, 0)
159 #endif
160 
161 /* If FILE_TIMESTAMP is 64 bits (or more), use nanosecond resolution.
162    (Multiply by 2**30 instead of by 10**9 to save time at the cost of
163    slightly decreasing the number of available timestamps.)  With
164    64-bit FILE_TIMESTAMP, this stops working on 2514-05-30 01:53:04
165    UTC, but by then uintmax_t should be larger than 64 bits.  */
166 #define FILE_TIMESTAMPS_PER_S (FILE_TIMESTAMP_HI_RES ? 1000000000 : 1)
167 #define FILE_TIMESTAMP_LO_BITS (FILE_TIMESTAMP_HI_RES ? 30 : 0)
168 
169 #define FILE_TIMESTAMP_S(ts) (((ts) - ORDINARY_MTIME_MIN) \
170 			      >> FILE_TIMESTAMP_LO_BITS)
171 #define FILE_TIMESTAMP_NS(ts) ((int) (((ts) - ORDINARY_MTIME_MIN) \
172 				      & ((1 << FILE_TIMESTAMP_LO_BITS) - 1)))
173 
174 /* Upper bound on length of string "YYYY-MM-DD HH:MM:SS.NNNNNNNNN"
175    representing a file timestamp.  The upper bound is not necessarily 19,
176    since the year might be less than -999 or greater than 9999.
177 
178    Subtract one for the sign bit if in case file timestamps can be negative;
179    subtract FLOOR_LOG2_SECONDS_PER_YEAR to yield an upper bound on how many
180    file timestamp bits might affect the year;
181    302 / 1000 is log10 (2) rounded up;
182    add one for integer division truncation;
183    add one more for a minus sign if file timestamps can be negative;
184    add 4 to allow for any 4-digit epoch year (e.g. 1970);
185    add 25 to allow for "-MM-DD HH:MM:SS.NNNNNNNNN".  */
186 #define FLOOR_LOG2_SECONDS_PER_YEAR 24
187 #define FILE_TIMESTAMP_PRINT_LEN_BOUND \
188   (((sizeof (FILE_TIMESTAMP) * CHAR_BIT - 1 - FLOOR_LOG2_SECONDS_PER_YEAR) \
189     * 302 / 1000) \
190    + 1 + 1 + 4 + 25)
191 
192 FILE_TIMESTAMP file_timestamp_cons (char const *, time_t, int);
193 FILE_TIMESTAMP file_timestamp_now (int *);
194 void file_timestamp_sprintf (char *p, FILE_TIMESTAMP ts);
195 
196 /* Return the mtime of file F (a struct file *), caching it.
197    The value is NONEXISTENT_MTIME if the file does not exist.  */
198 #define file_mtime(f) file_mtime_1 ((f), 1)
199 /* Return the mtime of file F (a struct file *), caching it.
200    Don't search using vpath for the file--if it doesn't actually exist,
201    we don't find it.
202    The value is NONEXISTENT_MTIME if the file does not exist.  */
203 #define file_mtime_no_search(f) file_mtime_1 ((f), 0)
204 FILE_TIMESTAMP f_mtime (struct file *file, int search);
205 #define file_mtime_1(f, v) \
206   ((f)->last_mtime == UNKNOWN_MTIME ? f_mtime ((f), v) : (f)->last_mtime)
207 
208 /* Special timestamp values.  */
209 
210 /* The file's timestamp is not yet known.  */
211 #define UNKNOWN_MTIME 0
212 
213 /* The file does not exist.  */
214 #define NONEXISTENT_MTIME 1
215 
216 /* The file does not exist, and we assume that it is older than any
217    actual file.  */
218 #define OLD_MTIME 2
219 
220 /* The smallest and largest ordinary timestamps.  */
221 #define ORDINARY_MTIME_MIN (OLD_MTIME + 1)
222 #if FILE_TIMESTAMP_HI_RES == 0 /* bird: shut up annoying warnings!
223   ASSUMES: unsigned FILE_TIMESTAMP ++. */
224 # define ORDINARY_MTIME_MAX     ( ~ (FILE_TIMESTAMP) 0 )
225 #else
226 #define ORDINARY_MTIME_MAX ((FILE_TIMESTAMP_S (NEW_MTIME) \
227 			     << FILE_TIMESTAMP_LO_BITS) \
228 			    + ORDINARY_MTIME_MIN + FILE_TIMESTAMPS_PER_S - 1)
229 #endif
230 
231 /* Modtime value to use for `infinitely new'.  We used to get the current time
232    from the system and use that whenever we wanted `new'.  But that causes
233    trouble when the machine running make and the machine holding a file have
234    different ideas about what time it is; and can also lose for `force'
235    targets, which need to be considered newer than anything that depends on
236    them, even if said dependents' modtimes are in the future.  */
237 #if 1 /* bird: ASSUME the type is unsigned and the wrath of a pedantic gcc.  */
238 # define NEW_MTIME              ( ~ (FILE_TIMESTAMP) 0 )
239 #else
240 #define NEW_MTIME INTEGER_TYPE_MAXIMUM (FILE_TIMESTAMP)
241 #endif
242 
243 #define check_renamed(file) \
244   while ((file)->renamed != 0) (file) = (file)->renamed /* No ; here.  */
245 
246 /* Have we snapped deps yet?  */
247 extern int snapped_deps;
248