clean: improve performance when removing lots of directories

"git clean" uses resolve_gitlink_ref() to check for the presence of nested git repositories, but it has the drawback of creating a ref_cache entry for every directory that should potentially be cleaned. The linear search through the ref_cache list causes a massive performance hit for large number of directories. Modify clean.c:remove_dirs to use setup.c:is_git_directory and setup.c:read_gitfile_gently instead. Both these functions will open files and parse contents when they find something that looks like a git repository. This is ok from a performance standpoint since finding repository candidates should be comparatively rare. Using is_git_directory and read_gitfile_gently should give a more standardized check for what is and what isn't a git repository but also gives three behavioral changes. The first change is that we will now detect and avoid cleaning empty nested git repositories (only init run). This is desirable. Second, we will no longer die when cleaning a file named ".git" with garbage content (it will be cleaned instead). This is also desirable. The last change is that we will detect and avoid cleaning empty bare repositories that have been placed in a directory named ".git". This is not desirable but should have no real user impact since we already fail to clean non-empty bare repositories in the same scenario. This is thus deemed acceptable. On top of this we add some extra precautions. If read_gitfile_gently fails to open the git file, read the git file or verify the path in the git file we assume that the path with the git file is a valid repository and avoid cleaning. Update t7300 to reflect these changes in behavior. The time to clean an untracked directory containing 100000 sub directories went from 61s to 1.7s after this change. Helped-by: Jeff King <peff@peff.net> Signed-off-by: Erik Elfström <erik.elfstrom@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Erik Elfström committed Jun 15, 2015 at 21:39 UTC 0179ca7a626e0a6c7bf5eaccf88dead307306dee
2 files changed +30 -10
builtin/clean.c
+26 -4
@@ -10,7 +10,6 @@
10 #include "cache.h"
11 #include "dir.h"
12 #include "parse-options.h"
13 -#include "refs.h"
13 #include "string-list.h"
14 #include "quote.h"
15 #include "column.h"
@@ -148,6 +147,31 @@ static int exclude_cb(const struct option *opt, const char *arg, int unset)
147 return 0;
148 }
149
150 +/*
151 + * Return 1 if the given path is the root of a git repository or
152 + * submodule else 0. Will not return 1 for bare repositories with the
153 + * exception of creating a bare repository in "foo/.git" and calling
154 + * is_git_repository("foo").
155 + */
156 +static int is_git_repository(struct strbuf *path)
157 +{
158 + int ret = 0;
159 + int gitfile_error;
160 + size_t orig_path_len = path->len;
161 + assert(orig_path_len != 0);
162 + if (path->buf[orig_path_len - 1] != '/')
163 + strbuf_addch(path, '/');
164 + strbuf_addstr(path, ".git");
165 + if (read_gitfile_gently(path->buf, &gitfile_error) || is_git_directory(path->buf))
166 + ret = 1;
167 + if (gitfile_error == READ_GITFILE_ERR_OPEN_FAILED ||
168 + gitfile_error == READ_GITFILE_ERR_READ_FAILED)
169 + ret = 1; /* This could be a real .git file, take the
170 + * safe option and avoid cleaning */
171 + strbuf_setlen(path, orig_path_len);
172 + return ret;
173 +}
174 +
175 static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,
176 int dry_run, int quiet, int *dir_gone)
177 {
@@ -155,13 +179,11 @@ static int remove_dirs(struct strbuf *path, const char *prefix, int force_flag,
179 struct strbuf quoted = STRBUF_INIT;
180 struct dirent *e;
181 int res = 0, ret = 0, gone = 1, original_len = path->len, len;
158 - unsigned char submodule_head[20];
182 struct string_list dels = STRING_LIST_INIT_DUP;
183
184 *dir_gone = 1;
185
163 - if ((force_flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
164 - !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
186 + if ((force_flag & REMOVE_DIR_KEEP_NESTED_GIT) && is_git_repository(path)) {
187 if (!quiet) {
188 quote_path_relative(path->buf, prefix, &quoted);
189 printf(dry_run ? _(msg_would_skip_git_dir) : _(msg_skip_git_dir),
t/t7300-clean.sh
+4 -6
@@ -455,7 +455,7 @@ test_expect_success 'nested git work tree' '
455 ! test -d bar
456 '
457
458 -test_expect_failure 'should clean things that almost look like git but are not' '
458 +test_expect_success 'should clean things that almost look like git but are not' '
459 rm -fr almost_git almost_bare_git almost_submodule &&
460 mkdir -p almost_git/.git/objects &&
461 mkdir -p almost_git/.git/refs &&
@@ -468,8 +468,6 @@ test_expect_failure 'should clean things that almost look like git but are not'
468 garbage
469 EOF
470 test_when_finished "rm -rf almost_*" &&
471 - ## This will fail due to die("Invalid gitfile format: %s", path); in
472 - ## setup.c:read_gitfile.
471 git clean -f -d &&
472 test_path_is_missing almost_git &&
473 test_path_is_missing almost_bare_git &&
@@ -501,7 +499,7 @@ test_expect_success 'should not clean submodules' '
499 test_path_is_missing to_clean
500 '
501
504 -test_expect_failure 'should avoid cleaning possible submodules' '
502 +test_expect_success 'should avoid cleaning possible submodules' '
503 rm -fr to_clean possible_sub1 &&
504 mkdir to_clean possible_sub1 &&
505 test_when_finished "rm -rf possible_sub*" &&
@@ -515,7 +513,7 @@ test_expect_failure 'should avoid cleaning possible submodules' '
513 test_path_is_missing to_clean
514 '
515
518 -test_expect_failure 'nested (empty) git should be kept' '
516 +test_expect_success 'nested (empty) git should be kept' '
517 rm -fr empty_repo to_clean &&
518 git init empty_repo &&
519 mkdir to_clean &&
@@ -537,7 +535,7 @@ test_expect_success 'nested bare repositories should be cleaned' '
535 test_path_is_missing subdir
536 '
537
540 -test_expect_success 'nested (empty) bare repositories should be cleaned even when in .git' '
538 +test_expect_failure 'nested (empty) bare repositories should be cleaned even when in .git' '
539 rm -fr strange_bare &&
540 mkdir strange_bare &&
541 git init --bare strange_bare/.git &&