Skip to content

Commit b7d5acc

Browse files
jeffhostetlerdscho
authored andcommitted
dir.c: regression fix for add_excludes with fscache
Fix regression described in: #1392 which was introduced in: b235337 Problem Symptoms ================ When the user has a .gitignore file that is a symlink, the fscache optimization introduced above caused the stat-data from the symlink, rather that of the target file, to be returned. Later when the ignore file was read, the buffer length did not match the stat.st_size field and we called die("cannot use <path> as an exclude file") Optimization Rationale ====================== The above optimization calls lstat() before open() primarily to ask fscache if the file exists. It gets the current stat-data as a side effect essentially for free (since we already have it in memory). If the file does not exist, it does not need to call open(). And since very few directories have .gitignore files, we can greatly reduce time spent in the filesystem. Discussion of Fix ================= The above optimization calls lstat() rather than stat() because the fscache only intercepts lstat() calls. Calls to stat() stay directed to the mingw_stat() completly bypassing fscache. Furthermore, calls to mingw_stat() always call {open, fstat, close} so that symlinks are properly dereferenced, which adds *additional* open/close calls on top of what the original code in dir.c is doing. Since the problem only manifests for symlinks, we add code to overwrite the stat-data when the path is a symlink. This preserves the effect of the performance gains provided by the fscache in the normal case. Signed-off-by: Jeff Hostetler <[email protected]>
1 parent b278999 commit b7d5acc

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

dir.c

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1092,13 +1092,41 @@ static int add_patterns(const char *fname, const char *base, int baselen,
10921092
size_t size = 0;
10931093
char *buf;
10941094

1095+
/*
1096+
* A performance optimization for status.
1097+
*
1098+
* During a status scan, git looks in each directory for a .gitignore
1099+
* file before scanning the directory. Since .gitignore files are not
1100+
* that common, we can waste a lot of time looking for files that are
1101+
* not there. Fortunately, the fscache already knows if the directory
1102+
* contains a .gitignore file, since it has already read the directory
1103+
* and it already has the stat-data.
1104+
*
1105+
* If the fscache is enabled, use the fscache-lstat() interlude to see
1106+
* if the file exists (in the fscache hash maps) before trying to open()
1107+
* it.
1108+
*
1109+
* This causes problem when the .gitignore file is a symlink, because
1110+
* we call lstat() rather than stat() on the symlnk and the resulting
1111+
* stat-data is for the symlink itself rather than the target file.
1112+
* We CANNOT use stat() here because the fscache DOES NOT install an
1113+
* interlude for stat() and mingw_stat() always calls "open-fstat-close"
1114+
* on the file and defeats the purpose of the optimization here. Since
1115+
* symlinks are even more rare than .gitignore files, we force a fstat()
1116+
* after our open() to get stat-data for the target file.
1117+
*/
10951118
if (is_fscache_enabled(fname)) {
10961119
if (lstat(fname, &st) < 0) {
10971120
fd = -1;
10981121
} else {
10991122
fd = open(fname, O_RDONLY);
11001123
if (fd < 0)
11011124
warn_on_fopen_errors(fname);
1125+
else if (S_ISLNK(st.st_mode) && fstat(fd, &st) < 0) {
1126+
warn_on_fopen_errors(fname);
1127+
close(fd);
1128+
fd = -1;
1129+
}
11021130
}
11031131
} else {
11041132
if (flags & PATTERN_NOFOLLOW)

0 commit comments

Comments
 (0)