filedef.h

   1 /* Definition of target file data structures for GNU Make.
   2 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1997,
   3 2002 Free Software Foundation, Inc.
   4 This file is part of GNU Make.
   5
   6 GNU Make is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Make is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Make; see the file COPYING.  If not, write to
  18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21
  22 /* Structure that represents the info on one file
  23    that the makefile says how to make.
  24    All of these are chained together through `next'.  */
  25
  26 #include "hash.h"
  27
  28 struct file
  29   {
  30     char *name;
  31     char *hname;                /* Hashed filename */
  32     char *vpath;                /* VPATH/vpath pathname */
  33     struct dep *deps;           /* all dependencies, including duplicates */
  34     struct commands *cmds;      /* Commands to execute for this target.  */
  35     int command_flags;          /* Flags OR'd in for cmds; see commands.h.  */
  36     char *stem;                 /* Implicit stem, if an implicit
  37                                    rule has been used */
  38     struct dep *also_make;      /* Targets that are made by making this.  */
  39     FILE_TIMESTAMP last_mtime;  /* File's modtime, if already known.  */
  40     FILE_TIMESTAMP mtime_before_update; /* File's modtime before any updating
  41                                            has been performed.  */
  42     struct file *prev;          /* Previous entry for same file name;
  43                                    used when there are multiple double-colon
  44                                    entries for the same file.  */
  45     struct file *last;          /* Last entry for the same file name.  */
  46
  47     /* File that this file was renamed to.  After any time that a
  48        file could be renamed, call `check_renamed' (below).  */
  49     struct file *renamed;
  50
  51     /* List of variable sets used for this file.  */
  52     struct variable_set_list *variables;
  53
  54     /* Pattern-specific variable reference for this target, or null if there
  55        isn't one.  Also see the pat_searched flag, below.  */
  56     struct variable_set_list *pat_variables;
  57
  58     /* Immediate dependent that caused this target to be remade,
  59        or nil if there isn't one.  */
  60     struct file *parent;
  61
  62     /* For a double-colon entry, this is the first double-colon entry for
  63        the same file.  Otherwise this is null.  */
  64     struct file *double_colon;
  65
  66     short int update_status;    /* Status of the last attempt to update,
  67                                    or -1 if none has been made.  */
  68
  69     enum cmd_state              /* State of the commands.  */
  70       {         /* Note: It is important that cs_not_started be zero.  */
  71         cs_not_started,         /* Not yet started.  */
  72         cs_deps_running,        /* Dep commands running.  */
  73         cs_running,             /* Commands running.  */
  74         cs_finished             /* Commands finished.  */
  75       } command_state ENUM_BITFIELD (2);
  76
  77     unsigned int precious:1;    /* Non-0 means don't delete file on quit */
  78     unsigned int low_resolution_time:1; /* Nonzero if this file's time stamp
  79                                            has only one-second resolution.  */
  80     unsigned int tried_implicit:1; /* Nonzero if have searched
  81                                       for implicit rule for making
  82                                       this file; don't search again.  */
  83     unsigned int updating:1;    /* Nonzero while updating deps of this file */
  84     unsigned int updated:1;     /* Nonzero if this file has been remade.  */
  85     unsigned int is_target:1;   /* Nonzero if file is described as target.  */
  86     unsigned int cmd_target:1;  /* Nonzero if file was given on cmd line.  */
  87     unsigned int phony:1;       /* Nonzero if this is a phony file
  88                                    i.e., a prerequisite of .PHONY.  */
  89     unsigned int intermediate:1;/* Nonzero if this is an intermediate file.  */
  90     unsigned int secondary:1;   /* Nonzero means remove_intermediates should
  91                                    not delete it.  */
  92     unsigned int dontcare:1;    /* Nonzero if no complaint is to be made if
  93                                    this target cannot be remade.  */
  94     unsigned int ignore_vpath:1;/* Nonzero if we threw out VPATH name.  */
  95     unsigned int pat_searched:1;/* Nonzero if we already searched for
  96                                    pattern-specific variables.  */
  97     unsigned int considered:1;  /* equal to 'considered' if file has been
  98                                    considered on current scan of goal chain */
  99   };
 100
 101
 102 extern struct file *default_goal_file, *suffix_file, *default_file;
 103 extern char **default_goal_name;
 104
 105
 106 extern struct file *lookup_file PARAMS ((char *name));
 107 extern struct file *enter_file PARAMS ((char *name));
 108 extern struct dep *parse_prereqs PARAMS ((char *prereqs));
 109 extern void remove_intermediates PARAMS ((int sig));
 110 extern void snap_deps PARAMS ((void));
 111 extern void rename_file PARAMS ((struct file *file, char *name));
 112 extern void rehash_file PARAMS ((struct file *file, char *name));
 113 extern void set_command_state PARAMS ((struct file *file, enum cmd_state state));
 114 extern void notice_finished_file PARAMS ((struct file *file));
 115 extern void init_hash_files PARAMS ((void));
 116 extern char *build_target_list PARAMS ((char *old_list));
 117
 118 #if FILE_TIMESTAMP_HI_RES
 119 # define FILE_TIMESTAMP_STAT_MODTIME(fname, st) \
 120     file_timestamp_cons (fname, (st).st_mtime, (st).st_mtim.ST_MTIM_NSEC)
 121 #else
 122 # define FILE_TIMESTAMP_STAT_MODTIME(fname, st) \
 123     file_timestamp_cons (fname, (st).st_mtime, 0)
 124 #endif
 125
 126 /* If FILE_TIMESTAMP is 64 bits (or more), use nanosecond resolution.
 127    (Multiply by 2**30 instead of by 10**9 to save time at the cost of
 128    slightly decreasing the number of available timestamps.)  With
 129    64-bit FILE_TIMESTAMP, this stops working on 2514-05-30 01:53:04
 130    UTC, but by then uintmax_t should be larger than 64 bits.  */
 131 #define FILE_TIMESTAMPS_PER_S (FILE_TIMESTAMP_HI_RES ? 1000000000 : 1)
 132 #define FILE_TIMESTAMP_LO_BITS (FILE_TIMESTAMP_HI_RES ? 30 : 0)
 133
 134 #define FILE_TIMESTAMP_S(ts) (((ts) - ORDINARY_MTIME_MIN) \
 135                               >> FILE_TIMESTAMP_LO_BITS)
 136 #define FILE_TIMESTAMP_NS(ts) ((int) (((ts) - ORDINARY_MTIME_MIN) \
 137                                       & ((1 << FILE_TIMESTAMP_LO_BITS) - 1)))
 138
 139 /* Upper bound on length of string "YYYY-MM-DD HH:MM:SS.NNNNNNNNN"
 140    representing a file timestamp.  The upper bound is not necessarily 19,
 141    since the year might be less than -999 or greater than 9999.
 142
 143    Subtract one for the sign bit if in case file timestamps can be negative;
 144    subtract FLOOR_LOG2_SECONDS_PER_YEAR to yield an upper bound on how many
 145    file timestamp bits might affect the year;
 146    302 / 1000 is log10 (2) rounded up;
 147    add one for integer division truncation;
 148    add one more for a minus sign if file timestamps can be negative;
 149    add 4 to allow for any 4-digit epoch year (e.g. 1970);
 150    add 25 to allow for "-MM-DD HH:MM:SS.NNNNNNNNN".  */
 151 #define FLOOR_LOG2_SECONDS_PER_YEAR 24
 152 #define FILE_TIMESTAMP_PRINT_LEN_BOUND \
 153   (((sizeof (FILE_TIMESTAMP) * CHAR_BIT - 1 - FLOOR_LOG2_SECONDS_PER_YEAR) \
 154     * 302 / 1000) \
 155    + 1 + 1 + 4 + 25)
 156
 157 extern FILE_TIMESTAMP file_timestamp_cons PARAMS ((char const *,
 158                                                    time_t, int));
 159 extern FILE_TIMESTAMP file_timestamp_now PARAMS ((int *));
 160 extern void file_timestamp_sprintf PARAMS ((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 extern FILE_TIMESTAMP f_mtime PARAMS ((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;