filedef.h

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