VirtualBox

source: kBuild/vendor/gnumake/current/filedef.h

Last change on this file was 3138, checked in by bird, 7 years ago

Imported make 4.2.1 (2e55f5e4abdc0e38c1d64be703b446695e70b3b6) from https://git.savannah.gnu.org/git/make.git.

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette