1 /* $NetBSD: dir.c,v 1.67 2013/03/05 22:01:43 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.67 2013/03/05 22:01:43 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.67 2013/03/05 22:01:43 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... */
248 static int DirFindName(const void *, const void *);
249 static int DirMatchFiles(const char *, Path *, Lst);
250 static void DirExpandCurly(const char *, const char *, Lst, Lst);
251 static void DirExpandInt(const char *, Lst, Lst);
252 static int DirPrintWord(void *, void *);
253 static int DirPrintDir(void *, void *);
254 static char *DirLookup(Path *, const char *, const char *, Boolean);
255 static char *DirLookupSubdir(Path *, const char *);
256 static char *DirFindDot(Boolean, const char *, const char *);
257 static char *DirLookupAbs(Path *, const char *, const char *);
260 *-----------------------------------------------------------------------
262 * initialize things for this module
268 * some directories may be opened.
269 *-----------------------------------------------------------------------
272 Dir_Init(const char *cdname)
274 dirSearchPath = Lst_Init(FALSE);
275 openDirectories = Lst_Init(FALSE);
276 Hash_InitTable(&mtimes, 0);
280 dotLast = bmake_malloc(sizeof(Path));
281 dotLast->refCount = 1;
283 dotLast->name = bmake_strdup(".DOTLAST");
284 Hash_InitTable(&dotLast->files, -1);
288 * Called by Dir_Init() and whenever .CURDIR is assigned to.
291 Dir_InitCur(const char *cdname)
295 if (cdname != NULL) {
297 * Our build directory is not the same as our source directory.
298 * Keep this one around too.
300 if ((p = Dir_AddDir(NULL, cdname))) {
302 if (cur && cur != p) {
304 * We've been here before, cleanup.
315 *-----------------------------------------------------------------------
317 * (re)initialize "dot" (current/object directory) path hash
323 * some directories may be opened.
324 *-----------------------------------------------------------------------
332 /* Remove old entry from openDirectories, but do not destroy. */
333 ln = Lst_Member(openDirectories, dot);
334 (void)Lst_Remove(openDirectories, ln);
337 dot = Dir_AddDir(NULL, ".");
340 Error("Cannot open `.' (%s)", strerror(errno));
345 * We always need to have dot around, so we increment its reference count
346 * to make sure it's not destroyed.
349 Dir_SetPATH(); /* initialize */
353 *-----------------------------------------------------------------------
355 * cleanup things for this module
362 *-----------------------------------------------------------------------
373 dotLast->refCount -= 1;
374 Dir_Destroy(dotLast);
376 Dir_ClearPath(dirSearchPath);
377 Lst_Destroy(dirSearchPath, NULL);
378 Dir_ClearPath(openDirectories);
379 Lst_Destroy(openDirectories, NULL);
380 Hash_DeleteTable(&mtimes);
385 * We want ${.PATH} to indicate the order in which we will actually
386 * search, so we rebuild it after any .PATH: target.
387 * This is the simplest way to deal with the effect of .DOTLAST.
392 LstNode ln; /* a list element */
394 Boolean hasLastDot = FALSE; /* true we should search dot last */
396 Var_Delete(".PATH", VAR_GLOBAL);
398 if (Lst_Open(dirSearchPath) == SUCCESS) {
399 if ((ln = Lst_First(dirSearchPath)) != NULL) {
400 p = (Path *)Lst_Datum(ln);
403 Var_Append(".PATH", dotLast->name, VAR_GLOBAL);
409 Var_Append(".PATH", dot->name, VAR_GLOBAL);
411 Var_Append(".PATH", cur->name, VAR_GLOBAL);
414 while ((ln = Lst_Next(dirSearchPath)) != NULL) {
415 p = (Path *)Lst_Datum(ln);
418 if (p == dot && hasLastDot)
420 Var_Append(".PATH", p->name, VAR_GLOBAL);
425 Var_Append(".PATH", dot->name, VAR_GLOBAL);
427 Var_Append(".PATH", cur->name, VAR_GLOBAL);
429 Lst_Close(dirSearchPath);
434 *-----------------------------------------------------------------------
436 * See if the Path structure describes the same directory as the
437 * given one by comparing their names. Called from Dir_AddDir via
438 * Lst_Find when searching the list of open directories.
445 * 0 if it is the same. Non-zero otherwise
449 *-----------------------------------------------------------------------
452 DirFindName(const void *p, const void *dname)
454 return (strcmp(((const Path *)p)->name, dname));
458 *-----------------------------------------------------------------------
459 * Dir_HasWildcards --
460 * see if the given name has any wildcard characters in it
461 * be careful not to expand unmatching brackets or braces.
462 * XXX: This code is not 100% correct. ([^]] fails etc.)
463 * I really don't think that make(1) should be expanding
464 * patterns, because then you have to set a mechanism for
465 * escaping the expansion!
471 * returns TRUE if the word should be expanded, FALSE otherwise
475 *-----------------------------------------------------------------------
478 Dir_HasWildcards(char *name)
481 int wild = 0, brace = 0, bracket = 0;
483 for (cp = name; *cp; cp++) {
507 return wild && bracket == 0 && brace == 0;
511 *-----------------------------------------------------------------------
513 * Given a pattern and a Path structure, see if any files
514 * match the pattern and add their names to the 'expansions' list if
515 * any do. This is incomplete -- it doesn't take care of patterns like
516 * src / *src / *.c properly (just *.c on any of the directories), but it
520 * pattern Pattern to look for
521 * p Directory to search
522 * expansion Place to store the results
528 * File names are added to the expansions lst. The directory will be
529 * fully hashed when this is done.
530 *-----------------------------------------------------------------------
533 DirMatchFiles(const char *pattern, Path *p, Lst expansions)
535 Hash_Search search; /* Index into the directory's table */
536 Hash_Entry *entry; /* Current entry in the table */
537 Boolean isDot; /* TRUE if the directory being searched is . */
539 isDot = (*p->name == '.' && p->name[1] == '\0');
541 for (entry = Hash_EnumFirst(&p->files, &search);
543 entry = Hash_EnumNext(&search))
546 * See if the file matches the given pattern. Note we follow the UNIX
547 * convention that dot files will only be found if the pattern
548 * begins with a dot (note also that as a side effect of the hashing
549 * scheme, .* won't match . or .. since they aren't hashed).
551 if (Str_Match(entry->name, pattern) &&
552 ((entry->name[0] != '.') ||
553 (pattern[0] == '.')))
555 (void)Lst_AtEnd(expansions,
556 (isDot ? bmake_strdup(entry->name) :
557 str_concat(p->name, entry->name,
565 *-----------------------------------------------------------------------
567 * Expand curly braces like the C shell. Does this recursively.
568 * Note the special case: if after the piece of the curly brace is
569 * done there are no wildcard characters in the result, the result is
570 * placed on the list WITHOUT CHECKING FOR ITS EXISTENCE.
573 * word Entire word to expand
574 * brace First curly brace in it
575 * path Search path to use
576 * expansions Place to store the expansions
582 * The given list is filled with the expansions...
584 *-----------------------------------------------------------------------
587 DirExpandCurly(const char *word, const char *brace, Lst path, Lst expansions)
589 const char *end; /* Character after the closing brace */
590 const char *cp; /* Current position in brace clause */
591 const char *start; /* Start of current piece of brace clause */
592 int bracelevel; /* Number of braces we've seen. If we see a
593 * right brace when this is 0, we've hit the
594 * end of the clause. */
595 char *file; /* Current expansion */
596 int otherLen; /* The length of the other pieces of the
597 * expansion (chars before and after the
598 * clause in 'word') */
599 char *cp2; /* Pointer for checking for wildcards in
600 * expansion before calling Dir_Expand */
605 * Find the end of the brace clause first, being wary of nested brace
608 for (end = start, bracelevel = 0; *end != '\0'; end++) {
611 } else if ((*end == '}') && (bracelevel-- == 0)) {
616 Error("Unterminated {} clause \"%s\"", start);
621 otherLen = brace - word + strlen(end);
623 for (cp = start; cp < end; cp++) {
625 * Find the end of this piece of the clause.
631 } else if ((*cp == '}') && (bracelevel-- <= 0)) {
637 * Allocate room for the combination and install the three pieces.
639 file = bmake_malloc(otherLen + cp - start + 1);
641 strncpy(file, word, brace-word);
644 strncpy(&file[brace-word], start, cp-start);
646 strcpy(&file[(brace-word)+(cp-start)], end);
649 * See if the result has any wildcards in it. If we find one, call
650 * Dir_Expand right away, telling it to place the result on our list
653 for (cp2 = file; *cp2 != '\0'; cp2++) {
659 Dir_Expand(file, path, expansions);
665 * Hit the end w/o finding any wildcards, so stick the expansion
666 * on the end of the list.
668 (void)Lst_AtEnd(expansions, file);
679 *-----------------------------------------------------------------------
681 * Internal expand routine. Passes through the directories in the
682 * path one by one, calling DirMatchFiles for each. NOTE: This still
683 * doesn't handle patterns in directories...
686 * word Word to expand
687 * path Path on which to look
688 * expansions Place to store the result
694 * Things are added to the expansions list.
696 *-----------------------------------------------------------------------
699 DirExpandInt(const char *word, Lst path, Lst expansions)
701 LstNode ln; /* Current node */
702 Path *p; /* Directory in the node */
704 if (Lst_Open(path) == SUCCESS) {
705 while ((ln = Lst_Next(path)) != NULL) {
706 p = (Path *)Lst_Datum(ln);
707 DirMatchFiles(word, p, expansions);
714 *-----------------------------------------------------------------------
716 * Print a word in the list of expansions. Callback for Dir_Expand
717 * when DEBUG(DIR), via Lst_ForEach.
723 * The passed word is printed, followed by a space.
725 *-----------------------------------------------------------------------
728 DirPrintWord(void *word, void *dummy)
730 fprintf(debug_file, "%s ", (char *)word);
732 return(dummy ? 0 : 0);
736 *-----------------------------------------------------------------------
738 * Expand the given word into a list of words by globbing it looking
739 * in the directories on the given search path.
742 * word the word to expand
743 * path the list of directories in which to find the
745 * expansions the list on which to place the results
748 * A list of words consisting of the files which exist along the search
749 * path matching the given pattern.
752 * Directories may be opened. Who knows?
753 *-----------------------------------------------------------------------
756 Dir_Expand(const char *word, Lst path, Lst expansions)
761 fprintf(debug_file, "Expanding \"%s\"... ", word);
764 cp = strchr(word, '{');
766 DirExpandCurly(word, cp, path, expansions);
768 cp = strchr(word, '/');
771 * The thing has a directory component -- find the first wildcard
774 for (cp = word; *cp; cp++) {
775 if (*cp == '?' || *cp == '[' || *cp == '*' || *cp == '{') {
781 * This one will be fun.
783 DirExpandCurly(word, cp, path, expansions);
785 } else if (*cp != '\0') {
787 * Back up to the start of the component
791 while (cp > word && *cp != '/') {
797 * If the glob isn't in the first component, try and find
798 * all the components up to the one with a wildcard.
801 ((char *)UNCONST(cp))[1] = '\0';
802 dirpath = Dir_FindFile(word, path);
803 ((char *)UNCONST(cp))[1] = sc;
805 * dirpath is null if can't find the leading component
806 * XXX: Dir_FindFile won't find internal components.
807 * i.e. if the path contains ../Etc/Object and we're
808 * looking for Etc, it won't be found. Ah well.
809 * Probably not important.
811 if (dirpath != NULL) {
812 char *dp = &dirpath[strlen(dirpath) - 1];
815 path = Lst_Init(FALSE);
816 (void)Dir_AddDir(path, dirpath);
817 DirExpandInt(cp+1, path, expansions);
818 Lst_Destroy(path, NULL);
822 * Start the search from the local directory
824 DirExpandInt(word, path, expansions);
828 * Return the file -- this should never happen.
830 DirExpandInt(word, path, expansions);
834 * First the files in dot
836 DirMatchFiles(word, dot, expansions);
839 * Then the files in every other directory on the path.
841 DirExpandInt(word, path, expansions);
845 Lst_ForEach(expansions, DirPrintWord, NULL);
846 fprintf(debug_file, "\n");
851 *-----------------------------------------------------------------------
853 * Find if the file with the given name exists in the given path.
856 * The path to the file or NULL. This path is guaranteed to be in a
857 * different part of memory than name and so may be safely free'd.
861 *-----------------------------------------------------------------------
864 DirLookup(Path *p, const char *name MAKE_ATTR_UNUSED, const char *cp,
865 Boolean hasSlash MAKE_ATTR_UNUSED)
867 char *file; /* the current filename to check */
870 fprintf(debug_file, " %s ...\n", p->name);
873 if (Hash_FindEntry(&p->files, cp) == NULL)
876 file = str_concat(p->name, cp, STR_ADDSLASH);
878 fprintf(debug_file, " returning %s\n", file);
887 *-----------------------------------------------------------------------
889 * Find if the file with the given name exists in the given path.
892 * The path to the file or NULL. This path is guaranteed to be in a
893 * different part of memory than name and so may be safely free'd.
896 * If the file is found, it is added in the modification times hash
898 *-----------------------------------------------------------------------
901 DirLookupSubdir(Path *p, const char *name)
903 struct stat stb; /* Buffer for stat, if necessary */
904 Hash_Entry *entry; /* Entry for mtimes table */
905 char *file; /* the current filename to check */
908 file = str_concat(p->name, name, STR_ADDSLASH);
911 * Checking in dot -- DON'T put a leading ./ on the thing.
913 file = bmake_strdup(name);
917 fprintf(debug_file, "checking %s ...\n", file);
920 if (stat(file, &stb) == 0) {
921 if (stb.st_mtime == 0)
924 * Save the modification time so if it's needed, we don't have
928 fprintf(debug_file, " Caching %s for %s\n", Targ_FmtTime(stb.st_mtime),
931 entry = Hash_CreateEntry(&mtimes, file, NULL);
932 Hash_SetTimeValue(entry, stb.st_mtime);
941 *-----------------------------------------------------------------------
943 * Find if the file with the given name exists in the given path.
946 * The path to the file, the empty string or NULL. If the file is
947 * the empty string, the search should be terminated.
948 * This path is guaranteed to be in a different part of memory
949 * than name and so may be safely free'd.
953 *-----------------------------------------------------------------------
956 DirLookupAbs(Path *p, const char *name, const char *cp)
958 char *p1; /* pointer into p->name */
959 const char *p2; /* pointer into name */
962 fprintf(debug_file, " %s ...\n", p->name);
966 * If the file has a leading path component and that component
967 * exactly matches the entire name of the current search
968 * directory, we can attempt another cache lookup. And if we don't
969 * have a hit, we can safely assume the file does not exist at all.
971 for (p1 = p->name, p2 = name; *p1 && *p1 == *p2; p1++, p2++) {
974 if (*p1 != '\0' || p2 != cp - 1) {
978 if (Hash_FindEntry(&p->files, cp) == NULL) {
980 fprintf(debug_file, " must be here but isn't -- returning\n");
982 /* Return empty string: terminates search */
983 return bmake_strdup("");
989 fprintf(debug_file, " returning %s\n", name);
991 return (bmake_strdup(name));
995 *-----------------------------------------------------------------------
997 * Find the file given on "." or curdir
1000 * The path to the file or NULL. This path is guaranteed to be in a
1001 * different part of memory than name and so may be safely free'd.
1005 *-----------------------------------------------------------------------
1008 DirFindDot(Boolean hasSlash MAKE_ATTR_UNUSED, const char *name, const char *cp)
1011 if (Hash_FindEntry(&dot->files, cp) != NULL) {
1013 fprintf(debug_file, " in '.'\n");
1017 return (bmake_strdup(name));
1020 Hash_FindEntry(&cur->files, cp) != NULL) {
1022 fprintf(debug_file, " in ${.CURDIR} = %s\n", cur->name);
1026 return str_concat(cur->name, cp, STR_ADDSLASH);
1033 *-----------------------------------------------------------------------
1035 * Find the file with the given name along the given search path.
1038 * name the file to find
1039 * path the Lst of directories to search
1042 * The path to the file or NULL. This path is guaranteed to be in a
1043 * different part of memory than name and so may be safely free'd.
1046 * If the file is found in a directory which is not on the path
1047 * already (either 'name' is absolute or it is a relative path
1048 * [ dir1/.../dirn/file ] which exists below one of the directories
1049 * already on the search path), its directory is added to the end
1050 * of the path on the assumption that there will be more files in
1051 * that directory later on. Sometimes this is true. Sometimes not.
1052 *-----------------------------------------------------------------------
1055 Dir_FindFile(const char *name, Lst path)
1057 LstNode ln; /* a list element */
1058 char *file; /* the current filename to check */
1059 Path *p; /* current path member */
1060 const char *cp; /* Terminal name of file */
1061 Boolean hasLastDot = FALSE; /* true we should search dot last */
1062 Boolean hasSlash; /* true if 'name' contains a / */
1063 struct stat stb; /* Buffer for stat, if necessary */
1064 Hash_Entry *entry; /* Entry for mtimes table */
1065 const char *trailing_dot = ".";
1068 * Find the final component of the name and note whether it has a
1069 * slash in it (the name, I mean)
1071 cp = strrchr(name, '/');
1081 fprintf(debug_file, "Searching for %s ...", name);
1084 if (Lst_Open(path) == FAILURE) {
1086 fprintf(debug_file, "couldn't open path, file not found\n");
1092 if ((ln = Lst_First(path)) != NULL) {
1093 p = (Path *)Lst_Datum(ln);
1097 fprintf(debug_file, "[dot last]...");
1101 fprintf(debug_file, "\n");
1105 * If there's no leading directory components or if the leading
1106 * directory component is exactly `./', consult the cached contents
1107 * of each of the directories on the search path.
1109 if (!hasSlash || (cp - name == 2 && *name == '.')) {
1111 * We look through all the directories on the path seeking one which
1112 * contains the final component of the given name. If such a beast
1113 * is found, we concatenate the directory name and the final
1114 * component and return the resulting string. If we don't find any
1115 * such thing, we go on to phase two...
1117 * No matter what, we always look for the file in the current
1118 * directory before anywhere else (unless we found the magic
1119 * DOTLAST path, in which case we search it last) and we *do not*
1120 * add the ./ to it if it exists.
1121 * This is so there are no conflicts between what the user
1122 * specifies (fish.c) and what pmake finds (./fish.c).
1125 (file = DirFindDot(hasSlash, name, cp)) != NULL) {
1130 while ((ln = Lst_Next(path)) != NULL) {
1131 p = (Path *)Lst_Datum(ln);
1134 if ((file = DirLookup(p, name, cp, hasSlash)) != NULL) {
1141 (file = DirFindDot(hasSlash, name, cp)) != NULL) {
1149 * We didn't find the file on any directory in the search path.
1150 * If the name doesn't contain a slash, that means it doesn't exist.
1151 * If it *does* contain a slash, however, there is still hope: it
1152 * could be in a subdirectory of one of the members of the search
1153 * path. (eg. /usr/include and sys/types.h. The above search would
1154 * fail to turn up types.h in /usr/include, but it *is* in
1155 * /usr/include/sys/types.h).
1156 * [ This no longer applies: If we find such a beast, we assume there
1157 * will be more (what else can we assume?) and add all but the last
1158 * component of the resulting name onto the search path (at the
1160 * This phase is only performed if the file is *not* absolute.
1164 fprintf(debug_file, " failed.\n");
1171 /* we were given a trailing "/" */
1175 if (name[0] != '/') {
1176 Boolean checkedDot = FALSE;
1179 fprintf(debug_file, " Trying subdirectories...\n");
1185 if ((file = DirLookupSubdir(dot, name)) != NULL)
1188 if (cur && (file = DirLookupSubdir(cur, name)) != NULL)
1192 (void)Lst_Open(path);
1193 while ((ln = Lst_Next(path)) != NULL) {
1194 p = (Path *)Lst_Datum(ln);
1202 if ((file = DirLookupSubdir(p, name)) != NULL) {
1210 if (dot && !checkedDot) {
1212 if ((file = DirLookupSubdir(dot, name)) != NULL)
1215 if (cur && (file = DirLookupSubdir(cur, name)) != NULL)
1221 * Already checked by the given name, since . was in the path,
1222 * so no point in proceeding...
1225 fprintf(debug_file, " Checked . already, returning NULL\n");
1230 } else { /* name[0] == '/' */
1233 * For absolute names, compare directory path prefix against the
1234 * the directory path of each member on the search path for an exact
1235 * match. If we have an exact match on any member of the search path,
1236 * use the cached contents of that member to lookup the final file
1237 * component. If that lookup fails we can safely assume that the
1238 * file does not exist at all. This is signified by DirLookupAbs()
1239 * returning an empty string.
1242 fprintf(debug_file, " Trying exact path matches...\n");
1245 if (!hasLastDot && cur && (file = DirLookupAbs(cur, name, cp)) != NULL)
1246 return *file?file:NULL;
1248 (void)Lst_Open(path);
1249 while ((ln = Lst_Next(path)) != NULL) {
1250 p = (Path *)Lst_Datum(ln);
1253 if ((file = DirLookupAbs(p, name, cp)) != NULL) {
1255 return *file?file:NULL;
1260 if (hasLastDot && cur && (file = DirLookupAbs(cur, name, cp)) != NULL)
1261 return *file?file:NULL;
1265 * Didn't find it that way, either. Sigh. Phase 3. Add its directory
1266 * onto the search path in any case, just in case, then look for the
1267 * thing in the hash table. If we find it, grand. We return a new
1268 * copy of the name. Otherwise we sadly return a NULL pointer. Sigh.
1269 * Note that if the directory holding the file doesn't exist, this will
1270 * do an extra search of the final directory on the path. Unless something
1271 * weird happens, this search won't succeed and life will be groovy.
1273 * Sigh. We cannot add the directory onto the search path because
1274 * of this amusing case:
1275 * $(INSTALLDIR)/$(FILE): $(FILE)
1277 * $(FILE) exists in $(INSTALLDIR) but not in the current one.
1278 * When searching for $(FILE), we will find it in $(INSTALLDIR)
1279 * b/c we added it here. This is not good...
1282 if (cp == traling_dot) {
1283 cp = strrchr(name, '/');
1287 (void)Dir_AddDir(path, name);
1291 ln = Lst_Last(path);
1295 p = (Path *)Lst_Datum(ln);
1298 if (Hash_FindEntry(&p->files, cp) != NULL) {
1299 return (bmake_strdup(name));
1305 fprintf(debug_file, " Looking for \"%s\" ...\n", name);
1309 entry = Hash_FindEntry(&mtimes, name);
1310 if (entry != NULL) {
1312 fprintf(debug_file, " got it (in mtime cache)\n");
1314 return(bmake_strdup(name));
1315 } else if (stat(name, &stb) == 0) {
1316 if (stb.st_mtime == 0)
1318 entry = Hash_CreateEntry(&mtimes, name, NULL);
1320 fprintf(debug_file, " Caching %s for %s\n", Targ_FmtTime(stb.st_mtime),
1323 Hash_SetTimeValue(entry, stb.st_mtime);
1324 return (bmake_strdup(name));
1327 fprintf(debug_file, " failed. Returning NULL\n");
1336 *-----------------------------------------------------------------------
1337 * Dir_FindHereOrAbove --
1338 * search for a path starting at a given directory and then working
1339 * our way up towards the root.
1342 * here starting directory
1343 * search_path the path we are looking for
1344 * result the result of a successful search is placed here
1345 * rlen the length of the result buffer
1346 * (typically MAXPATHLEN + 1)
1349 * 0 on failure, 1 on success [in which case the found path is put
1350 * in the result buffer].
1353 *-----------------------------------------------------------------------
1356 Dir_FindHereOrAbove(char *here, char *search_path, char *result, int rlen) {
1359 char dirbase[MAXPATHLEN + 1], *db_end;
1360 char try[MAXPATHLEN + 1], *try_end;
1362 /* copy out our starting point */
1363 snprintf(dirbase, sizeof(dirbase), "%s", here);
1364 db_end = dirbase + strlen(dirbase);
1366 /* loop until we determine a result */
1369 /* try and stat(2) it ... */
1370 snprintf(try, sizeof(try), "%s/%s", dirbase, search_path);
1371 if (stat(try, &st) != -1) {
1373 * success! if we found a file, chop off
1374 * the filename so we return a directory.
1376 if ((st.st_mode & S_IFMT) != S_IFDIR) {
1377 try_end = try + strlen(try);
1378 while (try_end > try && *try_end != '/')
1381 *try_end = 0; /* chop! */
1387 snprintf(result, rlen, "%s", try);
1392 * nope, we didn't find it. if we used up dirbase we've
1393 * reached the root and failed.
1395 if (db_end == dirbase)
1396 break; /* failed! */
1399 * truncate dirbase from the end to move up a dir
1401 while (db_end > dirbase && *db_end != '/')
1403 *db_end = 0; /* chop! */
1414 *-----------------------------------------------------------------------
1416 * Find the modification time of the file described by gn along the
1417 * search path dirSearchPath.
1420 * gn the file whose modification time is desired
1423 * The modification time or 0 if it doesn't exist
1426 * The modification time is placed in the node's mtime slot.
1427 * If the node didn't have a path entry before, and Dir_FindFile
1428 * found one for it, the full name is placed in the path slot.
1429 *-----------------------------------------------------------------------
1432 Dir_MTime(GNode *gn, Boolean recheck)
1434 char *fullName; /* the full pathname of name */
1435 struct stat stb; /* buffer for finding the mod time */
1438 if (gn->type & OP_ARCHV) {
1439 return Arch_MTime(gn);
1440 } else if (gn->type & OP_PHONY) {
1443 } else if (gn->path == NULL) {
1444 if (gn->type & OP_NOPATH)
1447 fullName = Dir_FindFile(gn->name, Suff_FindPath(gn));
1448 if (fullName == NULL && gn->flags & FROM_DEPEND &&
1449 !Lst_IsEmpty(gn->iParents)) {
1452 cp = strrchr(gn->name, '/');
1455 * This is an implied source, and it may have moved,
1456 * see if we can find it via the current .PATH
1460 fullName = Dir_FindFile(cp, Suff_FindPath(gn));
1463 * Put the found file in gn->path
1464 * so that we give that to the compiler.
1466 gn->path = bmake_strdup(fullName);
1467 if (!Job_RunTarget(".STALE", gn->fname))
1469 "%s: %s, %d: ignoring stale %s for %s, "
1470 "found %s\n", progname, gn->fname, gn->lineno,
1471 makeDependfile, gn->name, fullName);
1476 fprintf(debug_file, "Found '%s' as '%s'\n",
1477 gn->name, fullName ? fullName : "(not found)" );
1480 fullName = gn->path;
1483 if (fullName == NULL) {
1484 fullName = bmake_strdup(gn->name);
1488 entry = Hash_FindEntry(&mtimes, fullName);
1491 if (entry != NULL) {
1493 fprintf(debug_file, "Using cached time %s for %s\n",
1494 Targ_FmtTime(Hash_GetTimeValue(entry)), fullName);
1496 stb.st_mtime = Hash_GetTimeValue(entry);
1497 } else if (stat(fullName, &stb) < 0) {
1498 if (gn->type & OP_MEMBER) {
1499 if (fullName != gn->path)
1501 return Arch_MemMTime(gn);
1506 if (stb.st_mtime == 0) {
1508 * 0 handled specially by the code, if the time is really 0,
1509 * return something else instead
1513 entry = Hash_CreateEntry(&mtimes, fullName, NULL);
1514 Hash_SetTimeValue(entry, stb.st_mtime);
1517 if (fullName && gn->path == NULL) {
1518 gn->path = fullName;
1521 gn->mtime = stb.st_mtime;
1526 *-----------------------------------------------------------------------
1528 * Add the given name to the end of the given path. The order of
1529 * the arguments is backwards so ParseDoDependency can do a
1530 * Lst_ForEach of its list of paths...
1533 * path the path to which the directory should be
1535 * name the name of the directory to add
1541 * A structure is added to the list and the directory is
1543 *-----------------------------------------------------------------------
1546 Dir_AddDir(Lst path, const char *name)
1548 LstNode ln = NULL; /* node in case Path structure is found */
1549 Path *p = NULL; /* pointer to new Path structure */
1550 DIR *d; /* for reading directory */
1551 struct dirent *dp; /* entry in directory */
1553 if (strcmp(name, ".DOTLAST") == 0) {
1554 ln = Lst_Find(path, name, DirFindName);
1556 return (Path *)Lst_Datum(ln);
1558 dotLast->refCount += 1;
1559 (void)Lst_AtFront(path, dotLast);
1564 ln = Lst_Find(openDirectories, name, DirFindName);
1566 p = (Path *)Lst_Datum(ln);
1567 if (path && Lst_Member(path, p) == NULL) {
1569 (void)Lst_AtEnd(path, p);
1573 fprintf(debug_file, "Caching %s ...", name);
1576 if ((d = opendir(name)) != NULL) {
1577 p = bmake_malloc(sizeof(Path));
1578 p->name = bmake_strdup(name);
1581 Hash_InitTable(&p->files, -1);
1583 while ((dp = readdir(d)) != NULL) {
1584 #if defined(sun) && defined(d_ino) /* d_ino is a sunos4 #define for d_fileno */
1586 * The sun directory library doesn't check for a 0 inode
1587 * (0-inode slots just take up space), so we have to do
1590 if (dp->d_fileno == 0) {
1593 #endif /* sun && d_ino */
1594 (void)Hash_CreateEntry(&p->files, dp->d_name, NULL);
1597 (void)Lst_AtEnd(openDirectories, p);
1599 (void)Lst_AtEnd(path, p);
1602 fprintf(debug_file, "done\n");
1609 *-----------------------------------------------------------------------
1611 * Callback function for duplicating a search path via Lst_Duplicate.
1612 * Ups the reference count for the directory.
1615 * Returns the Path it was given.
1618 * The refCount of the path is incremented.
1620 *-----------------------------------------------------------------------
1623 Dir_CopyDir(void *p)
1625 ((Path *)p)->refCount += 1;
1631 *-----------------------------------------------------------------------
1633 * Make a string by taking all the directories in the given search
1634 * path and preceding them by the given flag. Used by the suffix
1635 * module to create variables for compilers based on suffix search
1639 * flag flag which should precede each directory
1640 * path list of directories
1643 * The string mentioned above. Note that there is no space between
1644 * the given flag and each directory. The empty string is returned if
1645 * Things don't go well.
1649 *-----------------------------------------------------------------------
1652 Dir_MakeFlags(const char *flag, Lst path)
1654 char *str; /* the string which will be returned */
1655 char *s1, *s2;/* the current directory preceded by 'flag' */
1656 LstNode ln; /* the node of the current directory */
1657 Path *p; /* the structure describing the current directory */
1659 str = bmake_strdup("");
1661 if (Lst_Open(path) == SUCCESS) {
1662 while ((ln = Lst_Next(path)) != NULL) {
1663 p = (Path *)Lst_Datum(ln);
1664 s2 = str_concat(flag, p->name, 0);
1665 str = str_concat(s1 = str, s2, STR_ADDSPACE);
1676 *-----------------------------------------------------------------------
1678 * Nuke a directory descriptor, if possible. Callback procedure
1679 * for the suffixes module when destroying a search path.
1682 * pp The directory descriptor to nuke
1688 * If no other path references this directory (refCount == 0),
1689 * the Path and all its data are freed.
1691 *-----------------------------------------------------------------------
1694 Dir_Destroy(void *pp)
1696 Path *p = (Path *)pp;
1699 if (p->refCount == 0) {
1702 ln = Lst_Member(openDirectories, p);
1703 (void)Lst_Remove(openDirectories, ln);
1705 Hash_DeleteTable(&p->files);
1712 *-----------------------------------------------------------------------
1714 * Clear out all elements of the given search path. This is different
1715 * from destroying the list, notice.
1718 * path Path to clear
1724 * The path is set to the empty list.
1726 *-----------------------------------------------------------------------
1729 Dir_ClearPath(Lst path)
1732 while (!Lst_IsEmpty(path)) {
1733 p = (Path *)Lst_DeQueue(path);
1740 *-----------------------------------------------------------------------
1742 * Concatenate two paths, adding the second to the end of the first.
1743 * Makes sure to avoid duplicates.
1753 * Reference counts for added dirs are upped.
1755 *-----------------------------------------------------------------------
1758 Dir_Concat(Lst path1, Lst path2)
1763 for (ln = Lst_First(path2); ln != NULL; ln = Lst_Succ(ln)) {
1764 p = (Path *)Lst_Datum(ln);
1765 if (Lst_Member(path1, p) == NULL) {
1767 (void)Lst_AtEnd(path1, p);
1772 /********** DEBUG INFO **********/
1774 Dir_PrintDirectories(void)
1779 fprintf(debug_file, "#*** Directory Cache:\n");
1780 fprintf(debug_file, "# Stats: %d hits %d misses %d near misses %d losers (%d%%)\n",
1781 hits, misses, nearmisses, bigmisses,
1782 (hits+bigmisses+nearmisses ?
1783 hits * 100 / (hits + bigmisses + nearmisses) : 0));
1784 fprintf(debug_file, "# %-20s referenced\thits\n", "directory");
1785 if (Lst_Open(openDirectories) == SUCCESS) {
1786 while ((ln = Lst_Next(openDirectories)) != NULL) {
1787 p = (Path *)Lst_Datum(ln);
1788 fprintf(debug_file, "# %-20s %10d\t%4d\n", p->name, p->refCount, p->hits);
1790 Lst_Close(openDirectories);
1795 DirPrintDir(void *p, void *dummy)
1797 fprintf(debug_file, "%s ", ((Path *)p)->name);
1798 return (dummy ? 0 : 0);
1802 Dir_PrintPath(Lst path)
1804 Lst_ForEach(path, DirPrintDir, NULL);