1 /* $NetBSD: dir.c,v 1.73 2018/07/12 18:03:31 christos Exp $ */
4 * Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
7 * This code is derived from software contributed to Berkeley by
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * Copyright (c) 1988, 1989 by Adam de Boor
37 * Copyright (c) 1989 by Berkeley Softworks
38 * All rights reserved.
40 * This code is derived from software contributed to Berkeley by
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by the University of
54 * California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
73 static char rcsid[] = "$NetBSD: dir.c,v 1.73 2018/07/12 18:03:31 christos Exp $";
75 #include <sys/cdefs.h>
78 static char sccsid[] = "@(#)dir.c 8.2 (Berkeley) 1/2/94";
80 __RCSID("$NetBSD: dir.c,v 1.73 2018/07/12 18:03:31 christos Exp $");
87 * Directory searching using wildcards and/or normal names...
88 * Used both for source wildcarding in the Makefile and for finding
91 * The interface for this module is:
92 * Dir_Init Initialize the module.
94 * Dir_InitCur Set the cur Path.
96 * Dir_InitDot Set the dot Path.
98 * Dir_End Cleanup the module.
100 * Dir_SetPATH Set ${.PATH} to reflect state of dirSearchPath.
102 * Dir_HasWildcards Returns TRUE if the name given it needs to
103 * be wildcard-expanded.
105 * Dir_Expand Given a pattern and a path, return a Lst of names
106 * which match the pattern on the search path.
108 * Dir_FindFile Searches for a file on a given search path.
109 * If it exists, the entire path is returned.
110 * Otherwise NULL is returned.
112 * Dir_FindHereOrAbove Search for a path in the current directory and
113 * then all the directories above it in turn until
114 * the path is found or we reach the root ("/").
116 * Dir_MTime Return the modification time of a node. The file
117 * is searched for along the default search path.
118 * The path and mtime fields of the node are filled
121 * Dir_AddDir Add a directory to a search path.
123 * Dir_MakeFlags Given a search path and a command flag, create
124 * a string with each of the directories in the path
125 * preceded by the command flag and all of them
126 * separated by a space.
128 * Dir_Destroy Destroy an element of a search path. Frees up all
129 * things that can be freed for the element as long
130 * as the element is no longer referenced by any other
132 * Dir_ClearPath Resets a search path to the empty list.
135 * Dir_PrintDirectories Print stats about the directory cache.
138 #include <sys/types.h>
139 #include <sys/stat.h>
151 * A search path consists of a Lst of Path structures. A Path structure
152 * has in it the name of the directory and a hash table of all the files
153 * in the directory. This is used to cut down on the number of system
154 * calls necessary to find implicit dependents and their like. Since
155 * these searches are made before any actions are taken, we need not
156 * worry about the directory changing due to creation commands. If this
157 * hampers the style of some makefiles, they must be changed.
159 * A list of all previously-read directories is kept in the
160 * openDirectories Lst. This list is checked first before a directory
163 * The need for the caching of whole directories is brought about by
164 * the multi-level transformation code in suff.c, which tends to search
165 * for far more files than regular make does. In the initial
166 * implementation, the amount of time spent performing "stat" calls was
167 * truly astronomical. The problem with hashing at the start is,
168 * of course, that pmake doesn't then detect changes to these directories
169 * during the course of the make. Three possibilities suggest themselves:
171 * 1) just use stat to test for a file's existence. As mentioned
172 * above, this is very inefficient due to the number of checks
173 * engendered by the multi-level transformation code.
174 * 2) use readdir() and company to search the directories, keeping
175 * them open between checks. I have tried this and while it
176 * didn't slow down the process too much, it could severely
177 * affect the amount of parallelism available as each directory
178 * open would take another file descriptor out of play for
179 * handling I/O for another job. Given that it is only recently
180 * that UNIX OS's have taken to allowing more than 20 or 32
181 * file descriptors for a process, this doesn't seem acceptable
183 * 3) record the mtime of the directory in the Path structure and
184 * verify the directory hasn't changed since the contents were
185 * hashed. This will catch the creation or deletion of files,
186 * but not the updating of files. However, since it is the
187 * creation and deletion that is the problem, this could be
188 * a good thing to do. Unfortunately, if the directory (say ".")
189 * were fairly large and changed fairly frequently, the constant
190 * rehashing could seriously degrade performance. It might be
191 * good in such cases to keep track of the number of rehashes
192 * and if the number goes over a (small) limit, resort to using
195 * An additional thing to consider is that pmake is used primarily
196 * to create C programs and until recently pcc-based compilers refused
197 * to allow you to specify where the resulting object file should be
198 * placed. This forced all objects to be created in the current
199 * directory. This isn't meant as a full excuse, just an explanation of
200 * some of the reasons for the caching used here.
202 * One more note: the location of a target's file is only performed
203 * on the downward traversal of the graph and then only for terminal
204 * nodes in the graph. This could be construed as wrong in some cases,
205 * but prevents inadvertent modification of files when the "installed"
206 * directory for a file is provided in the search path.
208 * Another data structure maintained by this module is an mtime
209 * cache used when the searching of cached directories fails to find
210 * a file. In the past, Dir_FindFile would simply perform an access()
211 * call in such a case to determine if the file could be found using
212 * just the name given. When this hit, however, all that was gained
213 * was the knowledge that the file existed. Given that an access() is
214 * essentially a stat() without the copyout() call, and that the same
215 * filesystem overhead would have to be incurred in Dir_MTime, it made
216 * sense to replace the access() with a stat() and record the mtime
217 * in a cache for when Dir_MTime was actually called.
220 Lst dirSearchPath; /* main search path */
222 static Lst openDirectories; /* the list of all open directories */
225 * Variables for gathering statistics on the efficiency of the hashing
228 static int hits, /* Found in directory cache */
229 misses, /* Sad, but not evil misses */
230 nearmisses, /* Found under search path */
231 bigmisses; /* Sought by itself */
233 static Path *dot; /* contents of current directory */
234 static Path *cur; /* contents of current directory, if not dot */
235 static Path *dotLast; /* a fake path entry indicating we need to
237 static Hash_Table mtimes; /* Results of doing a last-resort stat in
238 * Dir_FindFile -- if we have to go to the
239 * system to find the file, we might as well
240 * have its mtime on record. XXX: If this is done
241 * way early, there's a chance other rules will
242 * have already updated the file, in which case
243 * we'll update it again. Generally, there won't
244 * be two rules to update a single file, so this
245 * should be ok, but... */
247 static Hash_Table lmtimes; /* same as mtimes but for lstat */
249 static int DirFindName(const void *, const void *);
250 static int DirMatchFiles(const char *, Path *, Lst);
251 static void DirExpandCurly(const char *, const char *, Lst, Lst);
252 static void DirExpandInt(const char *, Lst, Lst);
253 static int DirPrintWord(void *, void *);
254 static int DirPrintDir(void *, void *);
255 static char *DirLookup(Path *, const char *, const char *, Boolean);
256 static char *DirLookupSubdir(Path *, const char *);
257 static char *DirFindDot(Boolean, const char *, const char *);
258 static char *DirLookupAbs(Path *, const char *, const char *);
262 * We use stat(2) a lot, cache the results
263 * mtime and mode are all we care about.
270 /* minimize changes below */
275 cached_stats(Hash_Table *htp, const char *pathname, struct stat *st, int flags)
278 struct cache_st *cst;
281 if (!pathname || !pathname[0])
284 entry = Hash_FindEntry(htp, pathname);
286 if (entry && (flags & CST_UPDATE) == 0) {
287 cst = entry->clientPtr;
289 memset(st, 0, sizeof(*st));
290 st->st_mtime = cst->mtime;
291 st->st_mode = cst->mode;
293 fprintf(debug_file, "Using cached time %s for %s\n",
294 Targ_FmtTime(st->st_mtime), pathname);
299 rc = (flags & CST_LSTAT) ? lstat(pathname, st) : stat(pathname, st);
303 if (st->st_mtime == 0)
304 st->st_mtime = 1; /* avoid confusion with missing file */
307 entry = Hash_CreateEntry(htp, pathname, NULL);
308 if (!entry->clientPtr)
309 entry->clientPtr = bmake_malloc(sizeof(*cst));
310 cst = entry->clientPtr;
311 cst->mtime = st->st_mtime;
312 cst->mode = st->st_mode;
314 fprintf(debug_file, " Caching %s for %s\n",
315 Targ_FmtTime(st->st_mtime), pathname);
322 cached_stat(const char *pathname, void *st)
324 return cached_stats(&mtimes, pathname, st, 0);
328 cached_lstat(const char *pathname, void *st)
330 return cached_stats(&lmtimes, pathname, st, CST_LSTAT);
334 *-----------------------------------------------------------------------
336 * initialize things for this module
342 * some directories may be opened.
343 *-----------------------------------------------------------------------
346 Dir_Init(const char *cdname)
349 dirSearchPath = Lst_Init(FALSE);
350 openDirectories = Lst_Init(FALSE);
351 Hash_InitTable(&mtimes, 0);
352 Hash_InitTable(&lmtimes, 0);
357 dotLast = bmake_malloc(sizeof(Path));
358 dotLast->refCount = 1;
360 dotLast->name = bmake_strdup(".DOTLAST");
361 Hash_InitTable(&dotLast->files, -1);
365 * Called by Dir_Init() and whenever .CURDIR is assigned to.
368 Dir_InitCur(const char *cdname)
372 if (cdname != NULL) {
374 * Our build directory is not the same as our source directory.
375 * Keep this one around too.
377 if ((p = Dir_AddDir(NULL, cdname))) {
379 if (cur && cur != p) {
381 * We've been here before, cleanup.
392 *-----------------------------------------------------------------------
394 * (re)initialize "dot" (current/object directory) path hash
400 * some directories may be opened.
401 *-----------------------------------------------------------------------
409 /* Remove old entry from openDirectories, but do not destroy. */
410 ln = Lst_Member(openDirectories, dot);
411 (void)Lst_Remove(openDirectories, ln);
414 dot = Dir_AddDir(NULL, ".");
417 Error("Cannot open `.' (%s)", strerror(errno));
422 * We always need to have dot around, so we increment its reference count
423 * to make sure it's not destroyed.
426 Dir_SetPATH(); /* initialize */
430 *-----------------------------------------------------------------------
432 * cleanup things for this module
439 *-----------------------------------------------------------------------
450 dotLast->refCount -= 1;
451 Dir_Destroy(dotLast);
453 Dir_ClearPath(dirSearchPath);
454 Lst_Destroy(dirSearchPath, NULL);
455 Dir_ClearPath(openDirectories);
456 Lst_Destroy(openDirectories, NULL);
457 Hash_DeleteTable(&mtimes);
462 * We want ${.PATH} to indicate the order in which we will actually
463 * search, so we rebuild it after any .PATH: target.
464 * This is the simplest way to deal with the effect of .DOTLAST.
469 LstNode ln; /* a list element */
471 Boolean hasLastDot = FALSE; /* true we should search dot last */
473 Var_Delete(".PATH", VAR_GLOBAL);
475 if (Lst_Open(dirSearchPath) == SUCCESS) {
476 if ((ln = Lst_First(dirSearchPath)) != NULL) {
477 p = (Path *)Lst_Datum(ln);
480 Var_Append(".PATH", dotLast->name, VAR_GLOBAL);
486 Var_Append(".PATH", dot->name, VAR_GLOBAL);
488 Var_Append(".PATH", cur->name, VAR_GLOBAL);
491 while ((ln = Lst_Next(dirSearchPath)) != NULL) {
492 p = (Path *)Lst_Datum(ln);
495 if (p == dot && hasLastDot)
497 Var_Append(".PATH", p->name, VAR_GLOBAL);
502 Var_Append(".PATH", dot->name, VAR_GLOBAL);
504 Var_Append(".PATH", cur->name, VAR_GLOBAL);
506 Lst_Close(dirSearchPath);
511 *-----------------------------------------------------------------------
513 * See if the Path structure describes the same directory as the
514 * given one by comparing their names. Called from Dir_AddDir via
515 * Lst_Find when searching the list of open directories.
522 * 0 if it is the same. Non-zero otherwise
526 *-----------------------------------------------------------------------
529 DirFindName(const void *p, const void *dname)
531 return (strcmp(((const Path *)p)->name, dname));
535 *-----------------------------------------------------------------------
536 * Dir_HasWildcards --
537 * see if the given name has any wildcard characters in it
538 * be careful not to expand unmatching brackets or braces.
539 * XXX: This code is not 100% correct. ([^]] fails etc.)
540 * I really don't think that make(1) should be expanding
541 * patterns, because then you have to set a mechanism for
542 * escaping the expansion!
548 * returns TRUE if the word should be expanded, FALSE otherwise
552 *-----------------------------------------------------------------------
555 Dir_HasWildcards(char *name)
558 int wild = 0, brace = 0, bracket = 0;
560 for (cp = name; *cp; cp++) {
584 return wild && bracket == 0 && brace == 0;
588 *-----------------------------------------------------------------------
590 * Given a pattern and a Path structure, see if any files
591 * match the pattern and add their names to the 'expansions' list if
592 * any do. This is incomplete -- it doesn't take care of patterns like
593 * src / *src / *.c properly (just *.c on any of the directories), but it
597 * pattern Pattern to look for
598 * p Directory to search
599 * expansion Place to store the results
605 * File names are added to the expansions lst. The directory will be
606 * fully hashed when this is done.
607 *-----------------------------------------------------------------------
610 DirMatchFiles(const char *pattern, Path *p, Lst expansions)
612 Hash_Search search; /* Index into the directory's table */
613 Hash_Entry *entry; /* Current entry in the table */
614 Boolean isDot; /* TRUE if the directory being searched is . */
616 isDot = (*p->name == '.' && p->name[1] == '\0');
618 for (entry = Hash_EnumFirst(&p->files, &search);
620 entry = Hash_EnumNext(&search))
623 * See if the file matches the given pattern. Note we follow the UNIX
624 * convention that dot files will only be found if the pattern
625 * begins with a dot (note also that as a side effect of the hashing
626 * scheme, .* won't match . or .. since they aren't hashed).
628 if (Str_Match(entry->name, pattern) &&
629 ((entry->name[0] != '.') ||
630 (pattern[0] == '.')))
632 (void)Lst_AtEnd(expansions,
633 (isDot ? bmake_strdup(entry->name) :
634 str_concat(p->name, entry->name,
642 *-----------------------------------------------------------------------
644 * Expand curly braces like the C shell. Does this recursively.
645 * Note the special case: if after the piece of the curly brace is
646 * done there are no wildcard characters in the result, the result is
647 * placed on the list WITHOUT CHECKING FOR ITS EXISTENCE.
650 * word Entire word to expand
651 * brace First curly brace in it
652 * path Search path to use
653 * expansions Place to store the expansions
659 * The given list is filled with the expansions...
661 *-----------------------------------------------------------------------
664 DirExpandCurly(const char *word, const char *brace, Lst path, Lst expansions)
666 const char *end; /* Character after the closing brace */
667 const char *cp; /* Current position in brace clause */
668 const char *start; /* Start of current piece of brace clause */
669 int bracelevel; /* Number of braces we've seen. If we see a
670 * right brace when this is 0, we've hit the
671 * end of the clause. */
672 char *file; /* Current expansion */
673 int otherLen; /* The length of the other pieces of the
674 * expansion (chars before and after the
675 * clause in 'word') */
676 char *cp2; /* Pointer for checking for wildcards in
677 * expansion before calling Dir_Expand */
682 * Find the end of the brace clause first, being wary of nested brace
685 for (end = start, bracelevel = 0; *end != '\0'; end++) {
688 } else if ((*end == '}') && (bracelevel-- == 0)) {
693 Error("Unterminated {} clause \"%s\"", start);
698 otherLen = brace - word + strlen(end);
700 for (cp = start; cp < end; cp++) {
702 * Find the end of this piece of the clause.
708 } else if ((*cp == '}') && (bracelevel-- <= 0)) {
714 * Allocate room for the combination and install the three pieces.
716 file = bmake_malloc(otherLen + cp - start + 1);
718 strncpy(file, word, brace-word);
721 strncpy(&file[brace-word], start, cp-start);
723 strcpy(&file[(brace-word)+(cp-start)], end);
726 * See if the result has any wildcards in it. If we find one, call
727 * Dir_Expand right away, telling it to place the result on our list
730 for (cp2 = file; *cp2 != '\0'; cp2++) {
736 Dir_Expand(file, path, expansions);
742 * Hit the end w/o finding any wildcards, so stick the expansion
743 * on the end of the list.
745 (void)Lst_AtEnd(expansions, file);
756 *-----------------------------------------------------------------------
758 * Internal expand routine. Passes through the directories in the
759 * path one by one, calling DirMatchFiles for each. NOTE: This still
760 * doesn't handle patterns in directories...
763 * word Word to expand
764 * path Path on which to look
765 * expansions Place to store the result
771 * Things are added to the expansions list.
773 *-----------------------------------------------------------------------
776 DirExpandInt(const char *word, Lst path, Lst expansions)
778 LstNode ln; /* Current node */
779 Path *p; /* Directory in the node */
781 if (Lst_Open(path) == SUCCESS) {
782 while ((ln = Lst_Next(path)) != NULL) {
783 p = (Path *)Lst_Datum(ln);
784 DirMatchFiles(word, p, expansions);
791 *-----------------------------------------------------------------------
793 * Print a word in the list of expansions. Callback for Dir_Expand
794 * when DEBUG(DIR), via Lst_ForEach.
800 * The passed word is printed, followed by a space.
802 *-----------------------------------------------------------------------
805 DirPrintWord(void *word, void *dummy MAKE_ATTR_UNUSED)
807 fprintf(debug_file, "%s ", (char *)word);
813 *-----------------------------------------------------------------------
815 * Expand the given word into a list of words by globbing it looking
816 * in the directories on the given search path.
819 * word the word to expand
820 * path the list of directories in which to find the
822 * expansions the list on which to place the results
825 * A list of words consisting of the files which exist along the search
826 * path matching the given pattern.
829 * Directories may be opened. Who knows?
830 *-----------------------------------------------------------------------
833 Dir_Expand(const char *word, Lst path, Lst expansions)
838 fprintf(debug_file, "Expanding \"%s\"... ", word);
841 cp = strchr(word, '{');
843 DirExpandCurly(word, cp, path, expansions);
845 cp = strchr(word, '/');
848 * The thing has a directory component -- find the first wildcard
851 for (cp = word; *cp; cp++) {
852 if (*cp == '?' || *cp == '[' || *cp == '*' || *cp == '{') {
858 * This one will be fun.
860 DirExpandCurly(word, cp, path, expansions);
862 } else if (*cp != '\0') {
864 * Back up to the start of the component
868 while (cp > word && *cp != '/') {
874 * If the glob isn't in the first component, try and find
875 * all the components up to the one with a wildcard.
878 ((char *)UNCONST(cp))[1] = '\0';
879 dirpath = Dir_FindFile(word, path);
880 ((char *)UNCONST(cp))[1] = sc;
882 * dirpath is null if can't find the leading component
883 * XXX: Dir_FindFile won't find internal components.
884 * i.e. if the path contains ../Etc/Object and we're
885 * looking for Etc, it won't be found. Ah well.
886 * Probably not important.
888 if (dirpath != NULL) {
889 char *dp = &dirpath[strlen(dirpath) - 1];
892 path = Lst_Init(FALSE);
893 (void)Dir_AddDir(path, dirpath);
894 DirExpandInt(cp+1, path, expansions);
895 Lst_Destroy(path, NULL);
899 * Start the search from the local directory
901 DirExpandInt(word, path, expansions);
905 * Return the file -- this should never happen.
907 DirExpandInt(word, path, expansions);
911 * First the files in dot
913 DirMatchFiles(word, dot, expansions);
916 * Then the files in every other directory on the path.
918 DirExpandInt(word, path, expansions);
922 Lst_ForEach(expansions, DirPrintWord, NULL);
923 fprintf(debug_file, "\n");
928 *-----------------------------------------------------------------------
930 * Find if the file with the given name exists in the given path.
933 * The path to the file or NULL. This path is guaranteed to be in a
934 * different part of memory than name and so may be safely free'd.
938 *-----------------------------------------------------------------------
941 DirLookup(Path *p, const char *name MAKE_ATTR_UNUSED, const char *cp,
942 Boolean hasSlash MAKE_ATTR_UNUSED)
944 char *file; /* the current filename to check */
947 fprintf(debug_file, " %s ...\n", p->name);
950 if (Hash_FindEntry(&p->files, cp) == NULL)
953 file = str_concat(p->name, cp, STR_ADDSLASH);
955 fprintf(debug_file, " returning %s\n", file);
964 *-----------------------------------------------------------------------
966 * Find if the file with the given name exists in the given path.
969 * The path to the file or NULL. This path is guaranteed to be in a
970 * different part of memory than name and so may be safely free'd.
973 * If the file is found, it is added in the modification times hash
975 *-----------------------------------------------------------------------
978 DirLookupSubdir(Path *p, const char *name)
980 struct stat stb; /* Buffer for stat, if necessary */
981 char *file; /* the current filename to check */
984 file = str_concat(p->name, name, STR_ADDSLASH);
987 * Checking in dot -- DON'T put a leading ./ on the thing.
989 file = bmake_strdup(name);
993 fprintf(debug_file, "checking %s ...\n", file);
996 if (cached_stat(file, &stb) == 0) {
1005 *-----------------------------------------------------------------------
1007 * Find if the file with the given name exists in the given path.
1010 * The path to the file, the empty string or NULL. If the file is
1011 * the empty string, the search should be terminated.
1012 * This path is guaranteed to be in a different part of memory
1013 * than name and so may be safely free'd.
1017 *-----------------------------------------------------------------------
1020 DirLookupAbs(Path *p, const char *name, const char *cp)
1022 char *p1; /* pointer into p->name */
1023 const char *p2; /* pointer into name */
1026 fprintf(debug_file, " %s ...\n", p->name);
1030 * If the file has a leading path component and that component
1031 * exactly matches the entire name of the current search
1032 * directory, we can attempt another cache lookup. And if we don't
1033 * have a hit, we can safely assume the file does not exist at all.
1035 for (p1 = p->name, p2 = name; *p1 && *p1 == *p2; p1++, p2++) {
1038 if (*p1 != '\0' || p2 != cp - 1) {
1042 if (Hash_FindEntry(&p->files, cp) == NULL) {
1044 fprintf(debug_file, " must be here but isn't -- returning\n");
1046 /* Return empty string: terminates search */
1047 return bmake_strdup("");
1053 fprintf(debug_file, " returning %s\n", name);
1055 return (bmake_strdup(name));
1059 *-----------------------------------------------------------------------
1061 * Find the file given on "." or curdir
1064 * The path to the file or NULL. This path is guaranteed to be in a
1065 * different part of memory than name and so may be safely free'd.
1069 *-----------------------------------------------------------------------
1072 DirFindDot(Boolean hasSlash MAKE_ATTR_UNUSED, const char *name, const char *cp)
1075 if (Hash_FindEntry(&dot->files, cp) != NULL) {
1077 fprintf(debug_file, " in '.'\n");
1081 return (bmake_strdup(name));
1084 Hash_FindEntry(&cur->files, cp) != NULL) {
1086 fprintf(debug_file, " in ${.CURDIR} = %s\n", cur->name);
1090 return str_concat(cur->name, cp, STR_ADDSLASH);
1097 *-----------------------------------------------------------------------
1099 * Find the file with the given name along the given search path.
1102 * name the file to find
1103 * path the Lst of directories to search
1106 * The path to the file or NULL. This path is guaranteed to be in a
1107 * different part of memory than name and so may be safely free'd.
1110 * If the file is found in a directory which is not on the path
1111 * already (either 'name' is absolute or it is a relative path
1112 * [ dir1/.../dirn/file ] which exists below one of the directories
1113 * already on the search path), its directory is added to the end
1114 * of the path on the assumption that there will be more files in
1115 * that directory later on. Sometimes this is true. Sometimes not.
1116 *-----------------------------------------------------------------------
1119 Dir_FindFile(const char *name, Lst path)
1121 LstNode ln; /* a list element */
1122 char *file; /* the current filename to check */
1123 Path *p; /* current path member */
1124 const char *cp; /* Terminal name of file */
1125 Boolean hasLastDot = FALSE; /* true we should search dot last */
1126 Boolean hasSlash; /* true if 'name' contains a / */
1127 struct stat stb; /* Buffer for stat, if necessary */
1128 const char *trailing_dot = ".";
1131 * Find the final component of the name and note whether it has a
1132 * slash in it (the name, I mean)
1134 cp = strrchr(name, '/');
1144 fprintf(debug_file, "Searching for %s ...", name);
1147 if (Lst_Open(path) == FAILURE) {
1149 fprintf(debug_file, "couldn't open path, file not found\n");
1155 if ((ln = Lst_First(path)) != NULL) {
1156 p = (Path *)Lst_Datum(ln);
1160 fprintf(debug_file, "[dot last]...");
1164 fprintf(debug_file, "\n");
1168 * If there's no leading directory components or if the leading
1169 * directory component is exactly `./', consult the cached contents
1170 * of each of the directories on the search path.
1172 if (!hasSlash || (cp - name == 2 && *name == '.')) {
1174 * We look through all the directories on the path seeking one which
1175 * contains the final component of the given name. If such a beast
1176 * is found, we concatenate the directory name and the final
1177 * component and return the resulting string. If we don't find any
1178 * such thing, we go on to phase two...
1180 * No matter what, we always look for the file in the current
1181 * directory before anywhere else (unless we found the magic
1182 * DOTLAST path, in which case we search it last) and we *do not*
1183 * add the ./ to it if it exists.
1184 * This is so there are no conflicts between what the user
1185 * specifies (fish.c) and what pmake finds (./fish.c).
1188 (file = DirFindDot(hasSlash, name, cp)) != NULL) {
1193 while ((ln = Lst_Next(path)) != NULL) {
1194 p = (Path *)Lst_Datum(ln);
1197 if ((file = DirLookup(p, name, cp, hasSlash)) != NULL) {
1204 (file = DirFindDot(hasSlash, name, cp)) != NULL) {
1212 * We didn't find the file on any directory in the search path.
1213 * If the name doesn't contain a slash, that means it doesn't exist.
1214 * If it *does* contain a slash, however, there is still hope: it
1215 * could be in a subdirectory of one of the members of the search
1216 * path. (eg. /usr/include and sys/types.h. The above search would
1217 * fail to turn up types.h in /usr/include, but it *is* in
1218 * /usr/include/sys/types.h).
1219 * [ This no longer applies: If we find such a beast, we assume there
1220 * will be more (what else can we assume?) and add all but the last
1221 * component of the resulting name onto the search path (at the
1223 * This phase is only performed if the file is *not* absolute.
1227 fprintf(debug_file, " failed.\n");
1234 /* we were given a trailing "/" */
1238 if (name[0] != '/') {
1239 Boolean checkedDot = FALSE;
1242 fprintf(debug_file, " Trying subdirectories...\n");
1248 if ((file = DirLookupSubdir(dot, name)) != NULL)
1251 if (cur && (file = DirLookupSubdir(cur, name)) != NULL)
1255 (void)Lst_Open(path);
1256 while ((ln = Lst_Next(path)) != NULL) {
1257 p = (Path *)Lst_Datum(ln);
1265 if ((file = DirLookupSubdir(p, name)) != NULL) {
1273 if (dot && !checkedDot) {
1275 if ((file = DirLookupSubdir(dot, name)) != NULL)
1278 if (cur && (file = DirLookupSubdir(cur, name)) != NULL)
1284 * Already checked by the given name, since . was in the path,
1285 * so no point in proceeding...
1288 fprintf(debug_file, " Checked . already, returning NULL\n");
1293 } else { /* name[0] == '/' */
1296 * For absolute names, compare directory path prefix against the
1297 * the directory path of each member on the search path for an exact
1298 * match. If we have an exact match on any member of the search path,
1299 * use the cached contents of that member to lookup the final file
1300 * component. If that lookup fails we can safely assume that the
1301 * file does not exist at all. This is signified by DirLookupAbs()
1302 * returning an empty string.
1305 fprintf(debug_file, " Trying exact path matches...\n");
1308 if (!hasLastDot && cur && ((file = DirLookupAbs(cur, name, cp))
1310 if (file[0] == '\0') {
1317 (void)Lst_Open(path);
1318 while ((ln = Lst_Next(path)) != NULL) {
1319 p = (Path *)Lst_Datum(ln);
1322 if ((file = DirLookupAbs(p, name, cp)) != NULL) {
1324 if (file[0] == '\0') {
1333 if (hasLastDot && cur && ((file = DirLookupAbs(cur, name, cp))
1335 if (file[0] == '\0') {
1344 * Didn't find it that way, either. Sigh. Phase 3. Add its directory
1345 * onto the search path in any case, just in case, then look for the
1346 * thing in the hash table. If we find it, grand. We return a new
1347 * copy of the name. Otherwise we sadly return a NULL pointer. Sigh.
1348 * Note that if the directory holding the file doesn't exist, this will
1349 * do an extra search of the final directory on the path. Unless something
1350 * weird happens, this search won't succeed and life will be groovy.
1352 * Sigh. We cannot add the directory onto the search path because
1353 * of this amusing case:
1354 * $(INSTALLDIR)/$(FILE): $(FILE)
1356 * $(FILE) exists in $(INSTALLDIR) but not in the current one.
1357 * When searching for $(FILE), we will find it in $(INSTALLDIR)
1358 * b/c we added it here. This is not good...
1361 if (cp == traling_dot) {
1362 cp = strrchr(name, '/');
1366 (void)Dir_AddDir(path, name);
1370 ln = Lst_Last(path);
1374 p = (Path *)Lst_Datum(ln);
1377 if (Hash_FindEntry(&p->files, cp) != NULL) {
1378 return (bmake_strdup(name));
1384 fprintf(debug_file, " Looking for \"%s\" ...\n", name);
1388 if (cached_stat(name, &stb) == 0) {
1389 return (bmake_strdup(name));
1393 fprintf(debug_file, " failed. Returning NULL\n");
1401 *-----------------------------------------------------------------------
1402 * Dir_FindHereOrAbove --
1403 * search for a path starting at a given directory and then working
1404 * our way up towards the root.
1407 * here starting directory
1408 * search_path the path we are looking for
1409 * result the result of a successful search is placed here
1410 * rlen the length of the result buffer
1411 * (typically MAXPATHLEN + 1)
1414 * 0 on failure, 1 on success [in which case the found path is put
1415 * in the result buffer].
1418 *-----------------------------------------------------------------------
1421 Dir_FindHereOrAbove(char *here, char *search_path, char *result, int rlen) {
1424 char dirbase[MAXPATHLEN + 1], *db_end;
1425 char try[MAXPATHLEN + 1], *try_end;
1427 /* copy out our starting point */
1428 snprintf(dirbase, sizeof(dirbase), "%s", here);
1429 db_end = dirbase + strlen(dirbase);
1431 /* loop until we determine a result */
1434 /* try and stat(2) it ... */
1435 snprintf(try, sizeof(try), "%s/%s", dirbase, search_path);
1436 if (cached_stat(try, &st) != -1) {
1438 * success! if we found a file, chop off
1439 * the filename so we return a directory.
1441 if ((st.st_mode & S_IFMT) != S_IFDIR) {
1442 try_end = try + strlen(try);
1443 while (try_end > try && *try_end != '/')
1446 *try_end = 0; /* chop! */
1452 snprintf(result, rlen, "%s", try);
1457 * nope, we didn't find it. if we used up dirbase we've
1458 * reached the root and failed.
1460 if (db_end == dirbase)
1461 break; /* failed! */
1464 * truncate dirbase from the end to move up a dir
1466 while (db_end > dirbase && *db_end != '/')
1468 *db_end = 0; /* chop! */
1479 *-----------------------------------------------------------------------
1481 * Find the modification time of the file described by gn along the
1482 * search path dirSearchPath.
1485 * gn the file whose modification time is desired
1488 * The modification time or 0 if it doesn't exist
1491 * The modification time is placed in the node's mtime slot.
1492 * If the node didn't have a path entry before, and Dir_FindFile
1493 * found one for it, the full name is placed in the path slot.
1494 *-----------------------------------------------------------------------
1497 Dir_MTime(GNode *gn, Boolean recheck)
1499 char *fullName; /* the full pathname of name */
1500 struct stat stb; /* buffer for finding the mod time */
1502 if (gn->type & OP_ARCHV) {
1503 return Arch_MTime(gn);
1504 } else if (gn->type & OP_PHONY) {
1507 } else if (gn->path == NULL) {
1508 if (gn->type & OP_NOPATH)
1511 fullName = Dir_FindFile(gn->name, Suff_FindPath(gn));
1512 if (fullName == NULL && gn->flags & FROM_DEPEND &&
1513 !Lst_IsEmpty(gn->iParents)) {
1516 cp = strrchr(gn->name, '/');
1519 * This is an implied source, and it may have moved,
1520 * see if we can find it via the current .PATH
1524 fullName = Dir_FindFile(cp, Suff_FindPath(gn));
1527 * Put the found file in gn->path
1528 * so that we give that to the compiler.
1530 gn->path = bmake_strdup(fullName);
1531 if (!Job_RunTarget(".STALE", gn->fname))
1533 "%s: %s, %d: ignoring stale %s for %s, "
1534 "found %s\n", progname, gn->fname, gn->lineno,
1535 makeDependfile, gn->name, fullName);
1540 fprintf(debug_file, "Found '%s' as '%s'\n",
1541 gn->name, fullName ? fullName : "(not found)" );
1544 fullName = gn->path;
1547 if (fullName == NULL) {
1548 fullName = bmake_strdup(gn->name);
1551 if (cached_stats(&mtimes, fullName, &stb, recheck ? CST_UPDATE : 0) < 0) {
1552 if (gn->type & OP_MEMBER) {
1553 if (fullName != gn->path)
1555 return Arch_MemMTime(gn);
1561 if (fullName && gn->path == NULL) {
1562 gn->path = fullName;
1565 gn->mtime = stb.st_mtime;
1570 *-----------------------------------------------------------------------
1572 * Add the given name to the end of the given path. The order of
1573 * the arguments is backwards so ParseDoDependency can do a
1574 * Lst_ForEach of its list of paths...
1577 * path the path to which the directory should be
1579 * name the name of the directory to add
1585 * A structure is added to the list and the directory is
1587 *-----------------------------------------------------------------------
1590 Dir_AddDir(Lst path, const char *name)
1592 LstNode ln = NULL; /* node in case Path structure is found */
1593 Path *p = NULL; /* pointer to new Path structure */
1594 DIR *d; /* for reading directory */
1595 struct dirent *dp; /* entry in directory */
1597 if (strcmp(name, ".DOTLAST") == 0) {
1598 ln = Lst_Find(path, name, DirFindName);
1600 return (Path *)Lst_Datum(ln);
1602 dotLast->refCount += 1;
1603 (void)Lst_AtFront(path, dotLast);
1608 ln = Lst_Find(openDirectories, name, DirFindName);
1610 p = (Path *)Lst_Datum(ln);
1611 if (path && Lst_Member(path, p) == NULL) {
1613 (void)Lst_AtEnd(path, p);
1617 fprintf(debug_file, "Caching %s ...", name);
1620 if ((d = opendir(name)) != NULL) {
1621 p = bmake_malloc(sizeof(Path));
1622 p->name = bmake_strdup(name);
1625 Hash_InitTable(&p->files, -1);
1627 while ((dp = readdir(d)) != NULL) {
1628 #if defined(sun) && defined(d_ino) /* d_ino is a sunos4 #define for d_fileno */
1630 * The sun directory library doesn't check for a 0 inode
1631 * (0-inode slots just take up space), so we have to do
1634 if (dp->d_fileno == 0) {
1637 #endif /* sun && d_ino */
1638 (void)Hash_CreateEntry(&p->files, dp->d_name, NULL);
1641 (void)Lst_AtEnd(openDirectories, p);
1643 (void)Lst_AtEnd(path, p);
1646 fprintf(debug_file, "done\n");
1653 *-----------------------------------------------------------------------
1655 * Callback function for duplicating a search path via Lst_Duplicate.
1656 * Ups the reference count for the directory.
1659 * Returns the Path it was given.
1662 * The refCount of the path is incremented.
1664 *-----------------------------------------------------------------------
1667 Dir_CopyDir(void *p)
1669 ((Path *)p)->refCount += 1;
1675 *-----------------------------------------------------------------------
1677 * Make a string by taking all the directories in the given search
1678 * path and preceding them by the given flag. Used by the suffix
1679 * module to create variables for compilers based on suffix search
1683 * flag flag which should precede each directory
1684 * path list of directories
1687 * The string mentioned above. Note that there is no space between
1688 * the given flag and each directory. The empty string is returned if
1689 * Things don't go well.
1693 *-----------------------------------------------------------------------
1696 Dir_MakeFlags(const char *flag, Lst path)
1698 char *str; /* the string which will be returned */
1699 char *s1, *s2;/* the current directory preceded by 'flag' */
1700 LstNode ln; /* the node of the current directory */
1701 Path *p; /* the structure describing the current directory */
1703 str = bmake_strdup("");
1705 if (Lst_Open(path) == SUCCESS) {
1706 while ((ln = Lst_Next(path)) != NULL) {
1707 p = (Path *)Lst_Datum(ln);
1708 s2 = str_concat(flag, p->name, 0);
1709 str = str_concat(s1 = str, s2, STR_ADDSPACE);
1720 *-----------------------------------------------------------------------
1722 * Nuke a directory descriptor, if possible. Callback procedure
1723 * for the suffixes module when destroying a search path.
1726 * pp The directory descriptor to nuke
1732 * If no other path references this directory (refCount == 0),
1733 * the Path and all its data are freed.
1735 *-----------------------------------------------------------------------
1738 Dir_Destroy(void *pp)
1740 Path *p = (Path *)pp;
1743 if (p->refCount == 0) {
1746 ln = Lst_Member(openDirectories, p);
1747 (void)Lst_Remove(openDirectories, ln);
1749 Hash_DeleteTable(&p->files);
1756 *-----------------------------------------------------------------------
1758 * Clear out all elements of the given search path. This is different
1759 * from destroying the list, notice.
1762 * path Path to clear
1768 * The path is set to the empty list.
1770 *-----------------------------------------------------------------------
1773 Dir_ClearPath(Lst path)
1776 while (!Lst_IsEmpty(path)) {
1777 p = (Path *)Lst_DeQueue(path);
1784 *-----------------------------------------------------------------------
1786 * Concatenate two paths, adding the second to the end of the first.
1787 * Makes sure to avoid duplicates.
1797 * Reference counts for added dirs are upped.
1799 *-----------------------------------------------------------------------
1802 Dir_Concat(Lst path1, Lst path2)
1807 for (ln = Lst_First(path2); ln != NULL; ln = Lst_Succ(ln)) {
1808 p = (Path *)Lst_Datum(ln);
1809 if (Lst_Member(path1, p) == NULL) {
1811 (void)Lst_AtEnd(path1, p);
1816 /********** DEBUG INFO **********/
1818 Dir_PrintDirectories(void)
1823 fprintf(debug_file, "#*** Directory Cache:\n");
1824 fprintf(debug_file, "# Stats: %d hits %d misses %d near misses %d losers (%d%%)\n",
1825 hits, misses, nearmisses, bigmisses,
1826 (hits+bigmisses+nearmisses ?
1827 hits * 100 / (hits + bigmisses + nearmisses) : 0));
1828 fprintf(debug_file, "# %-20s referenced\thits\n", "directory");
1829 if (Lst_Open(openDirectories) == SUCCESS) {
1830 while ((ln = Lst_Next(openDirectories)) != NULL) {
1831 p = (Path *)Lst_Datum(ln);
1832 fprintf(debug_file, "# %-20s %10d\t%4d\n", p->name, p->refCount, p->hits);
1834 Lst_Close(openDirectories);
1839 DirPrintDir(void *p, void *dummy MAKE_ATTR_UNUSED)
1841 fprintf(debug_file, "%s ", ((Path *)p)->name);
1846 Dir_PrintPath(Lst path)
1848 Lst_ForEach(path, DirPrintDir, NULL);