Aren/NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8e2247ea41
NetBSD/usr.bin/make/dir.c
rillig 35a8c8e3ca make(1): replace += 1 with ++ and -= 1 with -- 
Just for visual consistency.  The generated code stays exactly the same.
2020-09-28 23:13:57 +00:00

1738 lines
48 KiB
C
Raw Blame History

/* $NetBSD: dir.c,v 1.153 2020/09/28 23:13:57 rillig Exp $ */
/*
* Copyright (c) 1988, 1989, 1990 The Regents of the University of California.
* All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* Copyright (c) 1988, 1989 by Adam de Boor
* Copyright (c) 1989 by Berkeley Softworks
* All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* Adam de Boor.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*-
* dir.c --
* Directory searching using wildcards and/or normal names...
* Used both for source wildcarding in the Makefile and for finding
* implicit sources.
*
* The interface for this module is:
* Dir_Init Initialize the module.
*
* Dir_InitCur Set the cur CachedDir.
*
* Dir_InitDot Set the dot CachedDir.
*
* Dir_End Cleanup the module.
*
* Dir_SetPATH Set ${.PATH} to reflect state of dirSearchPath.
*
* Dir_HasWildcards
* Returns TRUE if the name given it needs to
* be wildcard-expanded.
*
* Dir_Expand Given a pattern and a path, return a Lst of names
* which match the pattern on the search path.
*
* Dir_FindFile Searches for a file on a given search path.
* If it exists, the entire path is returned.
* Otherwise NULL is returned.
*
* Dir_FindHereOrAbove
* Search for a path in the current directory and
* then all the directories above it in turn until
* the path is found or we reach the root ("/").
*
* Dir_MTime Return the modification time of a node. The file
* is searched for along the default search path.
* The path and mtime fields of the node are filled in.
*
* Dir_AddDir Add a directory to a search path.
*
* Dir_MakeFlags Given a search path and a command flag, create
* a string with each of the directories in the path
* preceded by the command flag and all of them
* separated by a space.
*
* Dir_Destroy Destroy an element of a search path. Frees up all
* things that can be freed for the element as long
* as the element is no longer referenced by any other
* search path.
*
* Dir_ClearPath Resets a search path to the empty list.
*
* For debugging:
* Dir_PrintDirectories Print stats about the directory cache.
*/
#include <sys/types.h>
#include <sys/stat.h>
#include <dirent.h>
#include <errno.h>
#include <stdio.h>
#include "make.h"
#include "dir.h"
#include "job.h"
/* "@(#)dir.c 8.2 (Berkeley) 1/2/94" */
MAKE_RCSID("$NetBSD: dir.c,v 1.153 2020/09/28 23:13:57 rillig Exp $");
#define DIR_DEBUG0(text) DEBUG0(DIR, text)
#define DIR_DEBUG1(fmt, arg1) DEBUG1(DIR, fmt, arg1)
#define DIR_DEBUG2(fmt, arg1, arg2) DEBUG2(DIR, fmt, arg1, arg2)
/*
* A search path consists of a list of CachedDir structures. A CachedDir
* has in it the name of the directory and a hash table of all the files
* in the directory. This is used to cut down on the number of system
* calls necessary to find implicit dependents and their like. Since
* these searches are made before any actions are taken, we need not
* worry about the directory changing due to creation commands. If this
* hampers the style of some makefiles, they must be changed.
*
* A list of all previously-read directories is kept in the
* openDirectories Lst. This list is checked first before a directory
* is opened.
*
* The need for the caching of whole directories is brought about by
* the multi-level transformation code in suff.c, which tends to search
* for far more files than regular make does. In the initial
* implementation, the amount of time spent performing "stat" calls was
* truly astronomical. The problem with hashing at the start is,
* of course, that pmake doesn't then detect changes to these directories
* during the course of the make. Three possibilities suggest themselves:
*
* 1) just use stat to test for a file's existence. As mentioned
* above, this is very inefficient due to the number of checks
* engendered by the multi-level transformation code.
* 2) use readdir() and company to search the directories, keeping
* them open between checks. I have tried this and while it
* didn't slow down the process too much, it could severely
* affect the amount of parallelism available as each directory
* open would take another file descriptor out of play for
* handling I/O for another job. Given that it is only recently
* that UNIX OS's have taken to allowing more than 20 or 32
* file descriptors for a process, this doesn't seem acceptable
* to me.
* 3) record the mtime of the directory in the CachedDir structure and
* verify the directory hasn't changed since the contents were
* hashed. This will catch the creation or deletion of files,
* but not the updating of files. However, since it is the
* creation and deletion that is the problem, this could be
* a good thing to do. Unfortunately, if the directory (say ".")
* were fairly large and changed fairly frequently, the constant
* rehashing could seriously degrade performance. It might be
* good in such cases to keep track of the number of rehashes
* and if the number goes over a (small) limit, resort to using
* stat in its place.
*
* An additional thing to consider is that pmake is used primarily
* to create C programs and until recently pcc-based compilers refused
* to allow you to specify where the resulting object file should be
* placed. This forced all objects to be created in the current
* directory. This isn't meant as a full excuse, just an explanation of
* some of the reasons for the caching used here.
*
* One more note: the location of a target's file is only performed
* on the downward traversal of the graph and then only for terminal
* nodes in the graph. This could be construed as wrong in some cases,
* but prevents inadvertent modification of files when the "installed"
* directory for a file is provided in the search path.
*
* Another data structure maintained by this module is an mtime
* cache used when the searching of cached directories fails to find
* a file. In the past, Dir_FindFile would simply perform an access()
* call in such a case to determine if the file could be found using
* just the name given. When this hit, however, all that was gained
* was the knowledge that the file existed. Given that an access() is
* essentially a stat() without the copyout() call, and that the same
* filesystem overhead would have to be incurred in Dir_MTime, it made
* sense to replace the access() with a stat() and record the mtime
* in a cache for when Dir_MTime was actually called.
*/
typedef List CachedDirList;
typedef ListNode CachedDirListNode;
typedef ListNode SearchPathNode;
SearchPath *dirSearchPath; /* main search path */
static CachedDirList *openDirectories; /* the list of all open directories */
/*
* Variables for gathering statistics on the efficiency of the hashing
* mechanism.
*/
static int hits; /* Found in directory cache */
static int misses; /* Sad, but not evil misses */
static int nearmisses; /* Found under search path */
static int bigmisses; /* Sought by itself */
static CachedDir *dot; /* contents of current directory */
static CachedDir *cur; /* contents of current directory, if not dot */
static CachedDir *dotLast; /* a fake path entry indicating we need to
* look for . last */
/* Results of doing a last-resort stat in Dir_FindFile -- if we have to go to
* the system to find the file, we might as well have its mtime on record.
*
* XXX: If this is done way early, there's a chance other rules will have
* already updated the file, in which case we'll update it again. Generally,
* there won't be two rules to update a single file, so this should be ok,
* but... */
static Hash_Table mtimes;
static Hash_Table lmtimes; /* same as mtimes but for lstat */
static void DirExpandInt(const char *, SearchPath *, StringList *);
static char *DirLookup(CachedDir *, const char *, const char *, Boolean);
static char *DirLookupSubdir(CachedDir *, const char *);
static char *DirFindDot(Boolean, const char *, const char *);
static char *DirLookupAbs(CachedDir *, const char *, const char *);
/*
* We use stat(2) a lot, cache the results.
* mtime and mode are all we care about.
*/
struct cache_st {
time_t lmtime; /* lstat */
time_t mtime; /* stat */
mode_t mode;
};
/* minimize changes below */
typedef enum {
CST_LSTAT = 0x01, /* call lstat(2) instead of stat(2) */
CST_UPDATE = 0x02 /* ignore existing cached entry */
} CachedStatsFlags;
/* Returns 0 and the result of stat(2) or lstat(2) in *mst, or -1 on error. */
static int
cached_stats(Hash_Table *htp, const char *pathname, struct make_stat *mst,
CachedStatsFlags flags)
{
Hash_Entry *entry;
struct stat sys_st;
struct cache_st *cst;
int rc;
if (!pathname || !pathname[0])
return -1;
entry = Hash_FindEntry(htp, pathname);
if (entry && !(flags & CST_UPDATE)) {
cst = Hash_GetValue(entry);
mst->mst_mode = cst->mode;
mst->mst_mtime = (flags & CST_LSTAT) ? cst->lmtime : cst->mtime;
if (mst->mst_mtime) {
DIR_DEBUG2("Using cached time %s for %s\n",
Targ_FmtTime(mst->mst_mtime), pathname);
return 0;
}
}
rc = (flags & CST_LSTAT)
? lstat(pathname, &sys_st)
: stat(pathname, &sys_st);
if (rc == -1)
return -1;
if (sys_st.st_mtime == 0)
sys_st.st_mtime = 1; /* avoid confusion with missing file */
mst->mst_mode = sys_st.st_mode;
mst->mst_mtime = sys_st.st_mtime;
if (entry == NULL)
entry = Hash_CreateEntry(htp, pathname, NULL);
if (Hash_GetValue(entry) == NULL) {
Hash_SetValue(entry, bmake_malloc(sizeof(*cst)));
memset(Hash_GetValue(entry), 0, sizeof(*cst));
}
cst = Hash_GetValue(entry);
if (flags & CST_LSTAT) {
cst->lmtime = sys_st.st_mtime;
} else {
cst->mtime = sys_st.st_mtime;
}
cst->mode = sys_st.st_mode;
DIR_DEBUG2(" Caching %s for %s\n",
Targ_FmtTime(sys_st.st_mtime), pathname);
return 0;
}
int
cached_stat(const char *pathname, struct make_stat *st)
{
return cached_stats(&mtimes, pathname, st, 0);
}
int
cached_lstat(const char *pathname, struct make_stat *st)
{
return cached_stats(&lmtimes, pathname, st, CST_LSTAT);
}
/* Initialize things for this module. */
void
Dir_Init(void)
{
dirSearchPath = Lst_Init();
openDirectories = Lst_Init();
Hash_InitTable(&mtimes);
Hash_InitTable(&lmtimes);
}
void
Dir_InitDir(const char *cdname)
{
Dir_InitCur(cdname);
dotLast = bmake_malloc(sizeof(CachedDir));
dotLast->refCount = 1;
dotLast->hits = 0;
dotLast->name = bmake_strdup(".DOTLAST");
Hash_InitTable(&dotLast->files);
}
/*
* Called by Dir_InitDir and whenever .CURDIR is assigned to.
*/
void
Dir_InitCur(const char *cdname)
{
CachedDir *dir;
if (cdname != NULL) {
/*
* Our build directory is not the same as our source directory.
* Keep this one around too.
*/
if ((dir = Dir_AddDir(NULL, cdname))) {
dir->refCount++;
if (cur && cur != dir) {
/*
* We've been here before, cleanup.
*/
cur->refCount--;
Dir_Destroy(cur);
}
cur = dir;
}
}
}
/* (Re)initialize "dot" (current/object directory) path hash.
* Some directories may be opened. */
void
Dir_InitDot(void)
{
if (dot != NULL) {
CachedDirListNode *ln;
/* Remove old entry from openDirectories, but do not destroy. */
ln = Lst_FindDatum(openDirectories, dot);
Lst_Remove(openDirectories, ln);
}
dot = Dir_AddDir(NULL, ".");
if (dot == NULL) {
Error("Cannot open `.' (%s)", strerror(errno));
exit(1);
}
/*
* We always need to have dot around, so we increment its reference count
* to make sure it's not destroyed.
*/
dot->refCount++;
Dir_SetPATH(); /* initialize */
}
/* Clean up things for this module. */
void
Dir_End(void)
{
#ifdef CLEANUP
if (cur) {
cur->refCount--;
Dir_Destroy(cur);
}
dot->refCount--;
dotLast->refCount--;
Dir_Destroy(dotLast);
Dir_Destroy(dot);
Dir_ClearPath(dirSearchPath);
Lst_Free(dirSearchPath);
Dir_ClearPath(openDirectories);
Lst_Free(openDirectories);
Hash_DeleteTable(&mtimes);
#endif
}
/*
* We want ${.PATH} to indicate the order in which we will actually
* search, so we rebuild it after any .PATH: target.
* This is the simplest way to deal with the effect of .DOTLAST.
*/
void
Dir_SetPATH(void)
{
CachedDirListNode *ln;
Boolean hasLastDot = FALSE; /* true if we should search dot last */
Var_Delete(".PATH", VAR_GLOBAL);
Lst_Open(dirSearchPath);
if ((ln = Lst_First(dirSearchPath)) != NULL) {
CachedDir *dir = LstNode_Datum(ln);
if (dir == dotLast) {
hasLastDot = TRUE;
Var_Append(".PATH", dotLast->name, VAR_GLOBAL);
}
}
if (!hasLastDot) {
if (dot)
Var_Append(".PATH", dot->name, VAR_GLOBAL);
if (cur)
Var_Append(".PATH", cur->name, VAR_GLOBAL);
}
while ((ln = Lst_Next(dirSearchPath)) != NULL) {
CachedDir *dir = LstNode_Datum(ln);
if (dir == dotLast)
continue;
if (dir == dot && hasLastDot)
continue;
Var_Append(".PATH", dir->name, VAR_GLOBAL);
}
if (hasLastDot) {
if (dot)
Var_Append(".PATH", dot->name, VAR_GLOBAL);
if (cur)
Var_Append(".PATH", cur->name, VAR_GLOBAL);
}
Lst_Close(dirSearchPath);
}
/* See if the CachedDir structure describes the same directory as the
* given one by comparing their names. Called from Dir_AddDir via
* Lst_Find when searching the list of open directories. */
static Boolean
DirFindName(const void *p, const void *desiredName)
{
const CachedDir *dir = p;
return strcmp(dir->name, desiredName) == 0;
}
/* See if the given name has any wildcard characters in it. Be careful not to
* expand unmatching brackets or braces.
*
* XXX: This code is not 100% correct ([^]] fails etc.). I really don't think
* that make(1) should be expanding patterns, because then you have to set a
* mechanism for escaping the expansion!
*
* Input:
* name name to check
*
* Results:
* returns TRUE if the word should be expanded, FALSE otherwise
*/
Boolean
Dir_HasWildcards(const char *name)
{
const char *cp;
Boolean wild = FALSE;
int braces = 0, brackets = 0;
for (cp = name; *cp; cp++) {
switch (*cp) {
case '{':
braces++;
wild = TRUE;
break;
case '}':
braces--;
break;
case '[':
brackets++;
wild = TRUE;
break;
case ']':
brackets--;
break;
case '?':
case '*':
wild = TRUE;
break;
default:
break;
}
}
return wild && brackets == 0 && braces == 0;
}
/*-
*-----------------------------------------------------------------------
* DirMatchFiles --
* Given a pattern and a CachedDir structure, see if any files
* match the pattern and add their names to the 'expansions' list if
* any do. This is incomplete -- it doesn't take care of patterns like
* src / *src / *.c properly (just *.c on any of the directories), but it
* will do for now.
*
* Input:
* pattern Pattern to look for
* dir Directory to search
* expansion Place to store the results
*
* Side Effects:
* File names are added to the expansions lst. The directory will be
* fully hashed when this is done.
*-----------------------------------------------------------------------
*/
static void
DirMatchFiles(const char *pattern, CachedDir *dir, StringList *expansions)
{
Hash_Search search; /* Index into the directory's table */
Hash_Entry *entry; /* Current entry in the table */
Boolean isDot; /* TRUE if the directory being searched is . */
isDot = (dir->name[0] == '.' && dir->name[1] == '\0');
for (entry = Hash_EnumFirst(&dir->files, &search);
entry != NULL;
entry = Hash_EnumNext(&search))
{
/*
* See if the file matches the given pattern. Note we follow the UNIX
* convention that dot files will only be found if the pattern
* begins with a dot (note also that as a side effect of the hashing
* scheme, .* won't match . or .. since they aren't hashed).
*/
if (Str_Match(entry->name, pattern) &&
((entry->name[0] != '.') ||
(pattern[0] == '.')))
{
Lst_Append(expansions,
(isDot ? bmake_strdup(entry->name) :
str_concat3(dir->name, "/", entry->name)));
}
}
}
/* Find the next closing brace in the string, taking nested braces into
* account. */
static const char *
closing_brace(const char *p)
{
int nest = 0;
while (*p != '\0') {
if (*p == '}' && nest == 0)
break;
if (*p == '{')
nest++;
if (*p == '}')
nest--;
p++;
}
return p;
}
/* Find the next closing brace or comma in the string, taking nested braces
* into account. */
static const char *
separator_comma(const char *p)
{
int nest = 0;
while (*p != '\0') {
if ((*p == '}' || *p == ',') && nest == 0)
break;
if (*p == '{')
nest++;
if (*p == '}')
nest--;
p++;
}
return p;
}
static Boolean
contains_wildcard(const char *p)
{
for (; *p != '\0'; p++) {
switch (*p) {
case '*':
case '?':
case '{':
case '[':
return TRUE;
}
}
return FALSE;
}
static char *
concat3(const char *a, size_t a_len, const char *b, size_t b_len,
const char *c, size_t c_len)
{
size_t s_len = a_len + b_len + c_len;
char *s = bmake_malloc(s_len + 1);
memcpy(s, a, a_len);
memcpy(s + a_len, b, b_len);
memcpy(s + a_len + b_len, c, c_len);
s[s_len] = '\0';
return s;
}
/*-
*-----------------------------------------------------------------------
* DirExpandCurly --
* Expand curly braces like the C shell. Does this recursively.
* Note the special case: if after the piece of the curly brace is
* done there are no wildcard characters in the result, the result is
* placed on the list WITHOUT CHECKING FOR ITS EXISTENCE.
*
* Input:
* word Entire word to expand
* brace First curly brace in it
* path Search path to use
* expansions Place to store the expansions
*
* Results:
* None.
*
* Side Effects:
* The given list is filled with the expansions...
*
*-----------------------------------------------------------------------
*/
static void
DirExpandCurly(const char *word, const char *brace, SearchPath *path,
StringList *expansions)
{
const char *prefix, *middle, *piece, *middle_end, *suffix;
size_t prefix_len, suffix_len;
/* Split the word into prefix '{' middle '}' suffix. */
middle = brace + 1;
middle_end = closing_brace(middle);
if (*middle_end == '\0') {
Error("Unterminated {} clause \"%s\"", middle);
return;
}
prefix = word;
prefix_len = (size_t)(brace - prefix);
suffix = middle_end + 1;
suffix_len = strlen(suffix);
/* Split the middle into pieces, separated by commas. */
piece = middle;
while (piece < middle_end + 1) {
const char *piece_end = separator_comma(piece);
size_t piece_len = (size_t)(piece_end - piece);
char *file = concat3(prefix, prefix_len, piece, piece_len,
suffix, suffix_len);
if (contains_wildcard(file)) {
Dir_Expand(file, path, expansions);
free(file);
} else {
Lst_Append(expansions, file);
}
piece = piece_end + 1; /* skip over the comma or closing brace */
}
}
/*-
*-----------------------------------------------------------------------
* DirExpandInt --
* Internal expand routine. Passes through the directories in the
* path one by one, calling DirMatchFiles for each. NOTE: This still
* doesn't handle patterns in directories...
*
* Input:
* word Word to expand
* path Directory in which to look
* expansions Place to store the result
*
* Results:
* None.
*
* Side Effects:
* Things are added to the expansions list.
*
*-----------------------------------------------------------------------
*/
static void
DirExpandInt(const char *word, SearchPath *path, StringList *expansions)
{
SearchPathNode *ln;
for (ln = path->first; ln != NULL; ln = ln->next) {
CachedDir *dir = ln->datum;
DirMatchFiles(word, dir, expansions);
}
}
static void
DirPrintExpansions(StringList *words)
{
StringListNode *ln;
for (ln = words->first; ln != NULL; ln = ln->next) {
const char *word = ln->datum;
debug_printf("%s ", word);
}
debug_printf("\n");
}
/*-
*-----------------------------------------------------------------------
* Dir_Expand --
* Expand the given word into a list of words by globbing it looking
* in the directories on the given search path.
*
* Input:
* word the word to expand
* path the list of directories in which to find the
* resulting files
* expansions the list on which to place the results
*
* Results:
* A list of words consisting of the files which exist along the search
* path matching the given pattern.
*
* Side Effects:
* Directories may be opened. Who knows?
* Undefined behavior if the word is really in read-only memory.
*-----------------------------------------------------------------------
*/
void
Dir_Expand(const char *word, SearchPath *path, StringList *expansions)
{
const char *cp;
assert(path != NULL);
assert(expansions != NULL);
DIR_DEBUG1("Expanding \"%s\"... ", word);
cp = strchr(word, '{');
if (cp) {
DirExpandCurly(word, cp, path, expansions);
} else {
cp = strchr(word, '/');
if (cp) {
/*
* The thing has a directory component -- find the first wildcard
* in the string.
*/
for (cp = word; *cp; cp++) {
if (*cp == '?' || *cp == '[' || *cp == '*' || *cp == '{') {
break;
}
}
if (*cp == '{') {
/*
* This one will be fun.
*/
DirExpandCurly(word, cp, path, expansions);
return;
} else if (*cp != '\0') {
/*
* Back up to the start of the component
*/
while (cp > word && *cp != '/') {
cp--;
}
if (cp != word) {
char sc;
char *dirpath;
/*
* If the glob isn't in the first component, try and find
* all the components up to the one with a wildcard.
*/
sc = cp[1];
((char *)UNCONST(cp))[1] = '\0';
dirpath = Dir_FindFile(word, path);
((char *)UNCONST(cp))[1] = sc;
/*
* dirpath is null if can't find the leading component
* XXX: Dir_FindFile won't find internal components.
* i.e. if the path contains ../Etc/Object and we're
* looking for Etc, it won't be found. Ah well.
* Probably not important.
*/
if (dirpath != NULL) {
char *dp = &dirpath[strlen(dirpath) - 1];
if (*dp == '/')
*dp = '\0';
path = Lst_Init();
(void)Dir_AddDir(path, dirpath);
DirExpandInt(cp + 1, path, expansions);
Lst_Free(path);
}
} else {
/*
* Start the search from the local directory
*/
DirExpandInt(word, path, expansions);
}
} else {
/*
* Return the file -- this should never happen.
*/
DirExpandInt(word, path, expansions);
}
} else {
/*
* First the files in dot
*/
DirMatchFiles(word, dot, expansions);
/*
* Then the files in every other directory on the path.
*/
DirExpandInt(word, path, expansions);
}
}
if (DEBUG(DIR))
DirPrintExpansions(expansions);
}
/*-
*-----------------------------------------------------------------------
* DirLookup --
* Find if the file with the given name exists in the given path.
*
* Results:
* The path to the file or NULL. This path is guaranteed to be in a
* different part of memory than name and so may be safely free'd.
*
* Side Effects:
* None.
*-----------------------------------------------------------------------
*/
static char *
DirLookup(CachedDir *dir, const char *name MAKE_ATTR_UNUSED, const char *cp,
Boolean hasSlash MAKE_ATTR_UNUSED)
{
char *file; /* the current filename to check */
DIR_DEBUG1(" %s ...\n", dir->name);
if (Hash_FindEntry(&dir->files, cp) == NULL)
return NULL;
file = str_concat3(dir->name, "/", cp);
DIR_DEBUG1(" returning %s\n", file);
dir->hits++;
hits++;
return file;
}
/*-
*-----------------------------------------------------------------------
* DirLookupSubdir --
* Find if the file with the given name exists in the given path.
*
* Results:
* The path to the file or NULL. This path is guaranteed to be in a
* different part of memory than name and so may be safely free'd.
*
* Side Effects:
* If the file is found, it is added in the modification times hash
* table.
*-----------------------------------------------------------------------
*/
static char *
DirLookupSubdir(CachedDir *dir, const char *name)
{
struct make_stat mst;
char *file; /* the current filename to check */
if (dir != dot) {
file = str_concat3(dir->name, "/", name);
} else {
/*
* Checking in dot -- DON'T put a leading ./ on the thing.
*/
file = bmake_strdup(name);
}
DIR_DEBUG1("checking %s ...\n", file);
if (cached_stat(file, &mst) == 0) {
nearmisses++;
return file;
}
free(file);
return NULL;
}
/*-
*-----------------------------------------------------------------------
* DirLookupAbs --
* Find if the file with the given name exists in the given path.
*
* Results:
* The path to the file, the empty string or NULL. If the file is
* the empty string, the search should be terminated.
* This path is guaranteed to be in a different part of memory
* than name and so may be safely free'd.
*
* Side Effects:
* None.
*-----------------------------------------------------------------------
*/
static char *
DirLookupAbs(CachedDir *dir, const char *name, const char *cp)
{
char *p1; /* pointer into dir->name */
const char *p2; /* pointer into name */
DIR_DEBUG1(" %s ...\n", dir->name);
/*
* If the file has a leading path component and that component
* exactly matches the entire name of the current search
* directory, we can attempt another cache lookup. And if we don't
* have a hit, we can safely assume the file does not exist at all.
*/
for (p1 = dir->name, p2 = name; *p1 && *p1 == *p2; p1++, p2++) {
continue;
}
if (*p1 != '\0' || p2 != cp - 1) {
return NULL;
}
if (Hash_FindEntry(&dir->files, cp) == NULL) {
DIR_DEBUG0(" must be here but isn't -- returning\n");
/* Return empty string: terminates search */
return bmake_strdup("");
}
dir->hits++;
hits++;
DIR_DEBUG1(" returning %s\n", name);
return bmake_strdup(name);
}
/*-
*-----------------------------------------------------------------------
* DirFindDot --
* Find the file given on "." or curdir
*
* Results:
* The path to the file or NULL. This path is guaranteed to be in a
* different part of memory than name and so may be safely free'd.
*
* Side Effects:
* Hit counts change
*-----------------------------------------------------------------------
*/
static char *
DirFindDot(Boolean hasSlash MAKE_ATTR_UNUSED, const char *name, const char *cp)
{
if (Hash_FindEntry(&dot->files, cp) != NULL) {
DIR_DEBUG0(" in '.'\n");
hits++;
dot->hits++;
return bmake_strdup(name);
}
if (cur && Hash_FindEntry(&cur->files, cp) != NULL) {
DIR_DEBUG1(" in ${.CURDIR} = %s\n", cur->name);
hits++;
cur->hits++;
return str_concat3(cur->name, "/", cp);
}
return NULL;
}
/*-
*-----------------------------------------------------------------------
* Dir_FindFile --
* Find the file with the given name along the given search path.
*
* Input:
* name the file to find
* path the Lst of directories to search
*
* Results:
* The path to the file or NULL. This path is guaranteed to be in a
* different part of memory than name and so may be safely free'd.
*
* Side Effects:
* If the file is found in a directory which is not on the path
* already (either 'name' is absolute or it is a relative path
* [ dir1/.../dirn/file ] which exists below one of the directories
* already on the search path), its directory is added to the end
* of the path on the assumption that there will be more files in
* that directory later on. Sometimes this is true. Sometimes not.
*-----------------------------------------------------------------------
*/
char *
Dir_FindFile(const char *name, SearchPath *path)
{
SearchPathNode *ln;
char *file; /* the current filename to check */
CachedDir *dir;
const char *base; /* Terminal name of file */
Boolean hasLastDot = FALSE; /* true if we should search dot last */
Boolean hasSlash; /* true if 'name' contains a / */
struct make_stat mst; /* Buffer for stat, if necessary */
const char *trailing_dot = ".";
/*
* Find the final component of the name and note whether it has a
* slash in it (the name, I mean)
*/
base = strrchr(name, '/');
if (base) {
hasSlash = TRUE;
base++;
} else {
hasSlash = FALSE;
base = name;
}
DIR_DEBUG1("Searching for %s ...", name);
if (path == NULL) {
DIR_DEBUG0("couldn't open path, file not found\n");
misses++;
return NULL;
}
Lst_Open(path);
if ((ln = Lst_First(path)) != NULL) {
dir = LstNode_Datum(ln);
if (dir == dotLast) {
hasLastDot = TRUE;
DIR_DEBUG0("[dot last]...");
}
}
DIR_DEBUG0("\n");
/*
* If there's no leading directory components or if the leading
* directory component is exactly `./', consult the cached contents
* of each of the directories on the search path.
*/
if (!hasSlash || (base - name == 2 && *name == '.')) {
/*
* We look through all the directories on the path seeking one which
* contains the final component of the given name. If such a beast
* is found, we concatenate the directory name and the final
* component and return the resulting string. If we don't find any
* such thing, we go on to phase two...
*
* No matter what, we always look for the file in the current
* directory before anywhere else (unless we found the magic
* DOTLAST path, in which case we search it last) and we *do not*
* add the ./ to it if it exists.
* This is so there are no conflicts between what the user
* specifies (fish.c) and what pmake finds (./fish.c).
*/
if (!hasLastDot && (file = DirFindDot(hasSlash, name, base)) != NULL) {
Lst_Close(path);
return file;
}
while ((ln = Lst_Next(path)) != NULL) {
dir = LstNode_Datum(ln);
if (dir == dotLast)
continue;
if ((file = DirLookup(dir, name, base, hasSlash)) != NULL) {
Lst_Close(path);
return file;
}
}
if (hasLastDot && (file = DirFindDot(hasSlash, name, base)) != NULL) {
Lst_Close(path);
return file;
}
}
Lst_Close(path);
/*
* We didn't find the file on any directory in the search path.
* If the name doesn't contain a slash, that means it doesn't exist.
* If it *does* contain a slash, however, there is still hope: it
* could be in a subdirectory of one of the members of the search
* path. (eg. /usr/include and sys/types.h. The above search would
* fail to turn up types.h in /usr/include, but it *is* in
* /usr/include/sys/types.h).
* [ This no longer applies: If we find such a beast, we assume there
* will be more (what else can we assume?) and add all but the last
* component of the resulting name onto the search path (at the
* end).]
* This phase is only performed if the file is *not* absolute.
*/
if (!hasSlash) {
DIR_DEBUG0(" failed.\n");
misses++;
return NULL;
}
if (*base == '\0') {
/* we were given a trailing "/" */
base = trailing_dot;
}
if (name[0] != '/') {
Boolean checkedDot = FALSE;
DIR_DEBUG0(" Trying subdirectories...\n");
if (!hasLastDot) {
if (dot) {
checkedDot = TRUE;
if ((file = DirLookupSubdir(dot, name)) != NULL)
return file;
}
if (cur && (file = DirLookupSubdir(cur, name)) != NULL)
return file;
}
Lst_Open(path);
while ((ln = Lst_Next(path)) != NULL) {
dir = LstNode_Datum(ln);
if (dir == dotLast)
continue;
if (dir == dot) {
if (checkedDot)
continue;
checkedDot = TRUE;
}
if ((file = DirLookupSubdir(dir, name)) != NULL) {
Lst_Close(path);
return file;
}
}
Lst_Close(path);
if (hasLastDot) {
if (dot && !checkedDot) {
checkedDot = TRUE;
if ((file = DirLookupSubdir(dot, name)) != NULL)
return file;
}
if (cur && (file = DirLookupSubdir(cur, name)) != NULL)
return file;
}
if (checkedDot) {
/*
* Already checked by the given name, since . was in the path,
* so no point in proceeding...
*/
DIR_DEBUG0(" Checked . already, returning NULL\n");
return NULL;
}
} else { /* name[0] == '/' */
/*
* For absolute names, compare directory path prefix against the
* the directory path of each member on the search path for an exact
* match. If we have an exact match on any member of the search path,
* use the cached contents of that member to lookup the final file
* component. If that lookup fails we can safely assume that the
* file does not exist at all. This is signified by DirLookupAbs()
* returning an empty string.
*/
DIR_DEBUG0(" Trying exact path matches...\n");
if (!hasLastDot && cur &&
((file = DirLookupAbs(cur, name, base)) != NULL)) {
if (file[0] == '\0') {
free(file);
return NULL;
}
return file;
}
Lst_Open(path);
while ((ln = Lst_Next(path)) != NULL) {
dir = LstNode_Datum(ln);
if (dir == dotLast)
continue;
if ((file = DirLookupAbs(dir, name, base)) != NULL) {
Lst_Close(path);
if (file[0] == '\0') {
free(file);
return NULL;
}
return file;
}
}
Lst_Close(path);
if (hasLastDot && cur &&
((file = DirLookupAbs(cur, name, base)) != NULL)) {
if (file[0] == '\0') {
free(file);
return NULL;
}
return file;
}
}
/*
* Didn't find it that way, either. Sigh. Phase 3. Add its directory
* onto the search path in any case, just in case, then look for the
* thing in the hash table. If we find it, grand. We return a new
* copy of the name. Otherwise we sadly return a NULL pointer. Sigh.
* Note that if the directory holding the file doesn't exist, this will
* do an extra search of the final directory on the path. Unless something
* weird happens, this search won't succeed and life will be groovy.
*
* Sigh. We cannot add the directory onto the search path because
* of this amusing case:
* $(INSTALLDIR)/$(FILE): $(FILE)
*
* $(FILE) exists in $(INSTALLDIR) but not in the current one.
* When searching for $(FILE), we will find it in $(INSTALLDIR)
* b/c we added it here. This is not good...
*/
#ifdef notdef
if (base == trailing_dot) {
base = strrchr(name, '/');
base++;
}
base[-1] = '\0';
(void)Dir_AddDir(path, name);
base[-1] = '/';
bigmisses++;
ln = Lst_Last(path);
if (ln == NULL) {
return NULL;
} else {
dir = LstNode_Datum(ln);
}
if (Hash_FindEntry(&dir->files, base) != NULL) {
return bmake_strdup(name);
} else {
return NULL;
}
#else /* !notdef */
DIR_DEBUG1(" Looking for \"%s\" ...\n", name);
bigmisses++;
if (cached_stat(name, &mst) == 0) {
return bmake_strdup(name);
}
DIR_DEBUG0(" failed. Returning NULL\n");
return NULL;
#endif /* notdef */
}
/*-
*-----------------------------------------------------------------------
* Dir_FindHereOrAbove --
* search for a path starting at a given directory and then working
* our way up towards the root.
*
* Input:
* here starting directory
* search_path the path we are looking for
* result the result of a successful search is placed here
* result_len the length of the result buffer
* (typically MAXPATHLEN + 1)
*
* Results:
* 0 on failure, 1 on success [in which case the found path is put
* in the result buffer].
*
* Side Effects:
*-----------------------------------------------------------------------
*/
Boolean
Dir_FindHereOrAbove(const char *here, const char *search_path,
char *result, int result_len)
{
struct make_stat mst;
char dirbase[MAXPATHLEN + 1], *dirbase_end;
char try[MAXPATHLEN + 1], *try_end;
/* copy out our starting point */
snprintf(dirbase, sizeof(dirbase), "%s", here);
dirbase_end = dirbase + strlen(dirbase);
/* loop until we determine a result */
while (TRUE) {
/* try and stat(2) it ... */
snprintf(try, sizeof(try), "%s/%s", dirbase, search_path);
if (cached_stat(try, &mst) != -1) {
/*
* success! if we found a file, chop off
* the filename so we return a directory.
*/
if ((mst.mst_mode & S_IFMT) != S_IFDIR) {
try_end = try + strlen(try);
while (try_end > try && *try_end != '/')
try_end--;
if (try_end > try)
*try_end = '\0'; /* chop! */
}
snprintf(result, result_len, "%s", try);
return TRUE;
}
/*
* nope, we didn't find it. if we used up dirbase we've
* reached the root and failed.
*/
if (dirbase_end == dirbase)
break; /* failed! */
/*
* truncate dirbase from the end to move up a dir
*/
while (dirbase_end > dirbase && *dirbase_end != '/')
dirbase_end--;
*dirbase_end = '\0'; /* chop! */
} /* while (TRUE) */
return FALSE;
}
/*-
*-----------------------------------------------------------------------
* Dir_MTime --
* Find the modification time of the file described by gn along the
* search path dirSearchPath.
*
* Input:
* gn the file whose modification time is desired
*
* Results:
* The modification time or 0 if it doesn't exist
*
* Side Effects:
* The modification time is placed in the node's mtime slot.
* If the node didn't have a path entry before, and Dir_FindFile
* found one for it, the full name is placed in the path slot.
*-----------------------------------------------------------------------
*/
int
Dir_MTime(GNode *gn, Boolean recheck)
{
char *fullName; /* the full pathname of name */
struct make_stat mst; /* buffer for finding the mod time */
if (gn->type & OP_ARCHV) {
return Arch_MTime(gn);
} else if (gn->type & OP_PHONY) {
gn->mtime = 0;
return 0;
} else if (gn->path == NULL) {
if (gn->type & OP_NOPATH)
fullName = NULL;
else {
fullName = Dir_FindFile(gn->name, Suff_FindPath(gn));
if (fullName == NULL && gn->flags & FROM_DEPEND &&
!Lst_IsEmpty(gn->implicitParents)) {
char *cp;
cp = strrchr(gn->name, '/');
if (cp) {
/*
* This is an implied source, and it may have moved,
* see if we can find it via the current .PATH
*/
cp++;
fullName = Dir_FindFile(cp, Suff_FindPath(gn));
if (fullName) {
/*
* Put the found file in gn->path
* so that we give that to the compiler.
*/
gn->path = bmake_strdup(fullName);
if (!Job_RunTarget(".STALE", gn->fname))
fprintf(stdout,
"%s: %s, %d: ignoring stale %s for %s, "
"found %s\n", progname, gn->fname,
gn->lineno,
makeDependfile, gn->name, fullName);
}
}
}
DIR_DEBUG2("Found '%s' as '%s'\n",
gn->name, fullName ? fullName : "(not found)");
}
} else {
fullName = gn->path;
}
if (fullName == NULL) {
fullName = bmake_strdup(gn->name);
}
if (cached_stats(&mtimes, fullName, &mst, recheck ? CST_UPDATE : 0) < 0) {
if (gn->type & OP_MEMBER) {
if (fullName != gn->path)
free(fullName);
return Arch_MemMTime(gn);
} else {
mst.mst_mtime = 0;
}
}
if (fullName && gn->path == NULL) {
gn->path = fullName;
}
gn->mtime = mst.mst_mtime;
return gn->mtime;
}
/* Read the list of filenames in the directory and store the result
* in openDirectories.
*
* If a path is given, append the directory to that path.
*
* Input:
* path The path to which the directory should be
* added, or NULL to only add the directory to
* openDirectories
* name The name of the directory to add.
* The name is not normalized in any way.
*/
CachedDir *
Dir_AddDir(SearchPath *path, const char *name)
{
SearchPathNode *ln = NULL;
CachedDir *dir = NULL; /* the added directory */
DIR *d;
struct dirent *dp;
if (path != NULL && strcmp(name, ".DOTLAST") == 0) {
ln = Lst_Find(path, DirFindName, name);
if (ln != NULL)
return LstNode_Datum(ln);
dotLast->refCount++;
Lst_Prepend(path, dotLast);
}
if (path != NULL)
ln = Lst_Find(openDirectories, DirFindName, name);
if (ln != NULL) {
dir = LstNode_Datum(ln);
if (Lst_FindDatum(path, dir) == NULL) {
dir->refCount++;
Lst_Append(path, dir);
}
return dir;
}
DIR_DEBUG1("Caching %s ...", name);
if ((d = opendir(name)) != NULL) {
dir = bmake_malloc(sizeof(CachedDir));
dir->name = bmake_strdup(name);
dir->hits = 0;
dir->refCount = 1;
Hash_InitTable(&dir->files);
while ((dp = readdir(d)) != NULL) {
#if defined(sun) && defined(d_ino) /* d_ino is a sunos4 #define for d_fileno */
/*
* The sun directory library doesn't check for a 0 inode
* (0-inode slots just take up space), so we have to do
* it ourselves.
*/
if (dp->d_fileno == 0) {
continue;
}
#endif /* sun && d_ino */
(void)Hash_CreateEntry(&dir->files, dp->d_name, NULL);
}
(void)closedir(d);
Lst_Append(openDirectories, dir);
if (path != NULL)
Lst_Append(path, dir);
}
DIR_DEBUG0("done\n");
return dir;
}
/*-
*-----------------------------------------------------------------------
* Dir_CopyDir --
* Callback function for duplicating a search path via Lst_Copy.
* Ups the reference count for the directory.
*
* Results:
* Returns the Path it was given.
*-----------------------------------------------------------------------
*/
void *
Dir_CopyDir(void *p)
{
CachedDir *dir = (CachedDir *)p;
dir->refCount++;
return p;
}
/*-
*-----------------------------------------------------------------------
* Dir_MakeFlags --
* Make a string by taking all the directories in the given search
* path and preceding them by the given flag. Used by the suffix
* module to create variables for compilers based on suffix search
* paths.
*
* Input:
* flag flag which should precede each directory
* path list of directories
*
* Results:
* The string mentioned above. Note that there is no space between
* the given flag and each directory. The empty string is returned if
* Things don't go well.
*
* Side Effects:
* None
*-----------------------------------------------------------------------
*/
char *
Dir_MakeFlags(const char *flag, SearchPath *path)
{
Buffer buf;
SearchPathNode *ln;
Buf_Init(&buf, 0);
if (path != NULL) {
for (ln = path->first; ln != NULL; ln = ln->next) {
CachedDir *dir = ln->datum;
Buf_AddStr(&buf, " ");
Buf_AddStr(&buf, flag);
Buf_AddStr(&buf, dir->name);
}
}
return Buf_Destroy(&buf, FALSE);
}
/*-
*-----------------------------------------------------------------------
* Dir_Destroy --
* Nuke a directory descriptor, if possible. Callback procedure
* for the suffixes module when destroying a search path.
*
* Input:
* dirp The directory descriptor to nuke
*
* Results:
* None.
*
* Side Effects:
* If no other path references this directory (refCount == 0),
* the CachedDir and all its data are freed.
*
*-----------------------------------------------------------------------
*/
void
Dir_Destroy(void *dirp)
{
CachedDir *dir = dirp;
dir->refCount--;
if (dir->refCount == 0) {
CachedDirListNode *node;
node = Lst_FindDatum(openDirectories, dir);
if (node != NULL)
Lst_Remove(openDirectories, node);
Hash_DeleteTable(&dir->files);
free(dir->name);
free(dir);
}
}
/*-
*-----------------------------------------------------------------------
* Dir_ClearPath --
* Clear out all elements of the given search path. This is different
* from destroying the list, notice.
*
* Input:
* path Path to clear
*
* Results:
* None.
*
* Side Effects:
* The path is set to the empty list.
*
*-----------------------------------------------------------------------
*/
void
Dir_ClearPath(SearchPath *path)
{
while (!Lst_IsEmpty(path)) {
CachedDir *dir = Lst_Dequeue(path);
Dir_Destroy(dir);
}
}
/*-
*-----------------------------------------------------------------------
* Dir_Concat --
* Concatenate two paths, adding the second to the end of the first.
* Makes sure to avoid duplicates.
*
* Input:
* path1 Dest
* path2 Source
*
* Results:
* None
*
* Side Effects:
* Reference counts for added dirs are upped.
*
*-----------------------------------------------------------------------
*/
void
Dir_Concat(SearchPath *path1, SearchPath *path2)
{
SearchPathNode *ln;
for (ln = path2->first; ln != NULL; ln = ln->next) {
CachedDir *dir = ln->datum;
if (Lst_FindDatum(path1, dir) == NULL) {
dir->refCount++;
Lst_Append(path1, dir);
}
}
}
static int
percentage(int num, int den)
{
return den != 0 ? num * 100 / den : 0;
}
/********** DEBUG INFO **********/
void
Dir_PrintDirectories(void)
{
CachedDirListNode *ln;
debug_printf("#*** Directory Cache:\n");
debug_printf("# Stats: %d hits %d misses %d near misses %d losers (%d%%)\n",
hits, misses, nearmisses, bigmisses,
percentage(hits, hits + bigmisses + nearmisses));
debug_printf("# %-20s referenced\thits\n", "directory");
for (ln = openDirectories->first; ln != NULL; ln = ln->next) {
CachedDir *dir = ln->datum;
debug_printf("# %-20s %10d\t%4d\n", dir->name, dir->refCount,
dir->hits);
}
}
void
Dir_PrintPath(SearchPath *path)
{
SearchPathNode *node;
for (node = path->first; node != NULL; node = node->next) {
const CachedDir *dir = node->datum;
debug_printf("%s ", dir->name);
}
}
Reference in New Issue View Git Blame Copy Permalink