filedef.h

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