Skip to content

Commit 4f026fb

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 dfdb1e3 commit 4f026fb

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

dir.c

+28
Original file line numberDiff line numberDiff line change
@@ -1061,13 +1061,41 @@ static int add_patterns(const char *fname, const char *base, int baselen,
10611061
size_t size = 0;
10621062
char *buf;
10631063

1064+
/*
1065+
* A performance optimization for status.
1066+
*
1067+
* During a status scan, git looks in each directory for a .gitignore
1068+
* file before scanning the directory. Since .gitignore files are not
1069+
* that common, we can waste a lot of time looking for files that are
1070+
* not there. Fortunately, the fscache already knows if the directory
1071+
* contains a .gitignore file, since it has already read the directory
1072+
* and it already has the stat-data.
1073+
*
1074+
* If the fscache is enabled, use the fscache-lstat() interlude to see
1075+
* if the file exists (in the fscache hash maps) before trying to open()
1076+
* it.
1077+
*
1078+
* This causes problem when the .gitignore file is a symlink, because
1079+
* we call lstat() rather than stat() on the symlnk and the resulting
1080+
* stat-data is for the symlink itself rather than the target file.
1081+
* We CANNOT use stat() here because the fscache DOES NOT install an
1082+
* interlude for stat() and mingw_stat() always calls "open-fstat-close"
1083+
* on the file and defeats the purpose of the optimization here. Since
1084+
* symlinks are even more rare than .gitignore files, we force a fstat()
1085+
* after our open() to get stat-data for the target file.
1086+
*/
10641087
if (is_fscache_enabled(fname)) {
10651088
if (lstat(fname, &st) < 0) {
10661089
fd = -1;
10671090
} else {
10681091
fd = open(fname, O_RDONLY);
10691092
if (fd < 0)
10701093
warn_on_fopen_errors(fname);
1094+
else if (S_ISLNK(st.st_mode) && fstat(fd, &st) < 0) {
1095+
warn_on_fopen_errors(fname);
1096+
close(fd);
1097+
fd = -1;
1098+
}
10711099
}
10721100
} else {
10731101
if (flags & PATTERN_NOFOLLOW)

0 commit comments

Comments
 (0)