2 * This handles recursive filename detection with exclude
3 * files, index knowledge etc..
5 * See Documentation/technical/api-directory-listing.txt
7 * Copyright (C) Linus Torvalds, 2005-2006
8 * Junio Hamano, 2005-2006
13 #include "wildmatch.h"
17 #include "ewah/ewok.h"
19 struct path_simplify {
25 * Tells read_directory_recursive how a file or directory should be treated.
26 * Values are ordered by significance, e.g. if a directory contains both
27 * excluded and untracked files, it is listed as untracked because
28 * path_untracked > path_excluded.
38 * Support data structure for our opendir/readdir/closedir wrappers
42 struct untracked_cache_dir *untracked;
48 struct untracked_cache_dir *ucd;
51 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
52 const char *path, int len, struct untracked_cache_dir *untracked,
53 int check_only, const struct path_simplify *simplify);
54 static int get_dtype(struct dirent *de, const char *path, int len);
56 int fspathcmp(const char *a, const char *b)
58 return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
61 int fspathncmp(const char *a, const char *b, size_t count)
63 return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
66 int git_fnmatch(const struct pathspec_item *item,
67 const char *pattern, const char *string,
71 if (ps_strncmp(item, pattern, string, prefix))
76 if (item->flags & PATHSPEC_ONESTAR) {
77 int pattern_len = strlen(++pattern);
78 int string_len = strlen(string);
79 return string_len < pattern_len ||
80 ps_strcmp(item, pattern,
81 string + string_len - pattern_len);
83 if (item->magic & PATHSPEC_GLOB)
84 return wildmatch(pattern, string,
86 (item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0),
89 /* wildmatch has not learned no FNM_PATHNAME mode yet */
90 return wildmatch(pattern, string,
91 item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0,
95 static int fnmatch_icase_mem(const char *pattern, int patternlen,
96 const char *string, int stringlen,
100 struct strbuf pat_buf = STRBUF_INIT;
101 struct strbuf str_buf = STRBUF_INIT;
102 const char *use_pat = pattern;
103 const char *use_str = string;
105 if (pattern[patternlen]) {
106 strbuf_add(&pat_buf, pattern, patternlen);
107 use_pat = pat_buf.buf;
109 if (string[stringlen]) {
110 strbuf_add(&str_buf, string, stringlen);
111 use_str = str_buf.buf;
115 flags |= WM_CASEFOLD;
116 match_status = wildmatch(use_pat, use_str, flags, NULL);
118 strbuf_release(&pat_buf);
119 strbuf_release(&str_buf);
124 static size_t common_prefix_len(const struct pathspec *pathspec)
130 * ":(icase)path" is treated as a pathspec full of
131 * wildcard. In other words, only prefix is considered common
132 * prefix. If the pathspec is abc/foo abc/bar, running in
133 * subdir xyz, the common prefix is still xyz, not xuz/abc as
136 GUARD_PATHSPEC(pathspec,
144 for (n = 0; n < pathspec->nr; n++) {
145 size_t i = 0, len = 0, item_len;
146 if (pathspec->items[n].magic & PATHSPEC_EXCLUDE)
148 if (pathspec->items[n].magic & PATHSPEC_ICASE)
149 item_len = pathspec->items[n].prefix;
151 item_len = pathspec->items[n].nowildcard_len;
152 while (i < item_len && (n == 0 || i < max)) {
153 char c = pathspec->items[n].match[i];
154 if (c != pathspec->items[0].match[i])
160 if (n == 0 || len < max) {
170 * Returns a copy of the longest leading path common among all
173 char *common_prefix(const struct pathspec *pathspec)
175 unsigned long len = common_prefix_len(pathspec);
177 return len ? xmemdupz(pathspec->items[0].match, len) : NULL;
180 int fill_directory(struct dir_struct *dir, const struct pathspec *pathspec)
185 * Calculate common prefix for the pathspec, and
186 * use that to optimize the directory walk
188 len = common_prefix_len(pathspec);
190 /* Read the directory and prune it */
191 read_directory(dir, pathspec->nr ? pathspec->_raw[0] : "", len, pathspec);
195 int within_depth(const char *name, int namelen,
196 int depth, int max_depth)
198 const char *cp = name, *cpe = name + namelen;
204 if (depth > max_depth)
210 #define DO_MATCH_EXCLUDE 1
211 #define DO_MATCH_DIRECTORY 2
214 * Does 'match' match the given name?
215 * A match is found if
217 * (1) the 'match' string is leading directory of 'name', or
218 * (2) the 'match' string is a wildcard and matches 'name', or
219 * (3) the 'match' string is exactly the same as 'name'.
221 * and the return value tells which case it was.
223 * It returns 0 when there is no match.
225 static int match_pathspec_item(const struct pathspec_item *item, int prefix,
226 const char *name, int namelen, unsigned flags)
228 /* name/namelen has prefix cut off by caller */
229 const char *match = item->match + prefix;
230 int matchlen = item->len - prefix;
233 * The normal call pattern is:
234 * 1. prefix = common_prefix_len(ps);
235 * 2. prune something, or fill_directory
236 * 3. match_pathspec()
238 * 'prefix' at #1 may be shorter than the command's prefix and
239 * it's ok for #2 to match extra files. Those extras will be
242 * Suppose the pathspec is 'foo' and '../bar' running from
243 * subdir 'xyz'. The common prefix at #1 will be empty, thanks
244 * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
245 * user does not want XYZ/foo, only the "foo" part should be
246 * case-insensitive. We need to filter out XYZ/foo here. In
247 * other words, we do not trust the caller on comparing the
248 * prefix part when :(icase) is involved. We do exact
249 * comparison ourselves.
251 * Normally the caller (common_prefix_len() in fact) does
252 * _exact_ matching on name[-prefix+1..-1] and we do not need
253 * to check that part. Be defensive and check it anyway, in
254 * case common_prefix_len is changed, or a new caller is
255 * introduced that does not use common_prefix_len.
257 * If the penalty turns out too high when prefix is really
258 * long, maybe change it to
259 * strncmp(match, name, item->prefix - prefix)
261 if (item->prefix && (item->magic & PATHSPEC_ICASE) &&
262 strncmp(item->match, name - prefix, item->prefix))
265 /* If the match was just the prefix, we matched */
267 return MATCHED_RECURSIVELY;
269 if (matchlen <= namelen && !ps_strncmp(item, match, name, matchlen)) {
270 if (matchlen == namelen)
271 return MATCHED_EXACTLY;
273 if (match[matchlen-1] == '/' || name[matchlen] == '/')
274 return MATCHED_RECURSIVELY;
275 } else if ((flags & DO_MATCH_DIRECTORY) &&
276 match[matchlen - 1] == '/' &&
277 namelen == matchlen - 1 &&
278 !ps_strncmp(item, match, name, namelen))
279 return MATCHED_EXACTLY;
281 if (item->nowildcard_len < item->len &&
282 !git_fnmatch(item, match, name,
283 item->nowildcard_len - prefix))
284 return MATCHED_FNMATCH;
290 * Given a name and a list of pathspecs, returns the nature of the
291 * closest (i.e. most specific) match of the name to any of the
294 * The caller typically calls this multiple times with the same
295 * pathspec and seen[] array but with different name/namelen
296 * (e.g. entries from the index) and is interested in seeing if and
297 * how each pathspec matches all the names it calls this function
298 * with. A mark is left in the seen[] array for each pathspec element
299 * indicating the closest type of match that element achieved, so if
300 * seen[n] remains zero after multiple invocations, that means the nth
301 * pathspec did not match any names, which could indicate that the
302 * user mistyped the nth pathspec.
304 static int do_match_pathspec(const struct pathspec *ps,
305 const char *name, int namelen,
306 int prefix, char *seen,
309 int i, retval = 0, exclude = flags & DO_MATCH_EXCLUDE;
320 if (!ps->recursive ||
321 !(ps->magic & PATHSPEC_MAXDEPTH) ||
323 return MATCHED_RECURSIVELY;
325 if (within_depth(name, namelen, 0, ps->max_depth))
326 return MATCHED_EXACTLY;
334 for (i = ps->nr - 1; i >= 0; i--) {
337 if ((!exclude && ps->items[i].magic & PATHSPEC_EXCLUDE) ||
338 ( exclude && !(ps->items[i].magic & PATHSPEC_EXCLUDE)))
341 if (seen && seen[i] == MATCHED_EXACTLY)
344 * Make exclude patterns optional and never report
345 * "pathspec ':(exclude)foo' matches no files"
347 if (seen && ps->items[i].magic & PATHSPEC_EXCLUDE)
348 seen[i] = MATCHED_FNMATCH;
349 how = match_pathspec_item(ps->items+i, prefix, name,
352 (ps->magic & PATHSPEC_MAXDEPTH) &&
353 ps->max_depth != -1 &&
354 how && how != MATCHED_FNMATCH) {
355 int len = ps->items[i].len;
356 if (name[len] == '/')
358 if (within_depth(name+len, namelen-len, 0, ps->max_depth))
359 how = MATCHED_EXACTLY;
366 if (seen && seen[i] < how)
373 int match_pathspec(const struct pathspec *ps,
374 const char *name, int namelen,
375 int prefix, char *seen, int is_dir)
377 int positive, negative;
378 unsigned flags = is_dir ? DO_MATCH_DIRECTORY : 0;
379 positive = do_match_pathspec(ps, name, namelen,
380 prefix, seen, flags);
381 if (!(ps->magic & PATHSPEC_EXCLUDE) || !positive)
383 negative = do_match_pathspec(ps, name, namelen,
385 flags | DO_MATCH_EXCLUDE);
386 return negative ? 0 : positive;
389 int report_path_error(const char *ps_matched,
390 const struct pathspec *pathspec,
394 * Make sure all pathspec matched; otherwise it is an error.
397 for (num = 0; num < pathspec->nr; num++) {
398 int other, found_dup;
403 * The caller might have fed identical pathspec
404 * twice. Do not barf on such a mistake.
405 * FIXME: parse_pathspec should have eliminated
406 * duplicate pathspec.
408 for (found_dup = other = 0;
409 !found_dup && other < pathspec->nr;
411 if (other == num || !ps_matched[other])
413 if (!strcmp(pathspec->items[other].original,
414 pathspec->items[num].original))
416 * Ok, we have a match already.
423 error("pathspec '%s' did not match any file(s) known to git.",
424 pathspec->items[num].original);
431 * Return the length of the "simple" part of a path match limiter.
433 int simple_length(const char *match)
438 unsigned char c = *match++;
440 if (c == '\0' || is_glob_special(c))
445 int no_wildcard(const char *string)
447 return string[simple_length(string)] == '\0';
450 void parse_exclude_pattern(const char **pattern,
455 const char *p = *pattern;
460 *flags |= EXC_FLAG_NEGATIVE;
464 if (len && p[len - 1] == '/') {
466 *flags |= EXC_FLAG_MUSTBEDIR;
468 for (i = 0; i < len; i++) {
473 *flags |= EXC_FLAG_NODIR;
474 *nowildcardlen = simple_length(p);
476 * we should have excluded the trailing slash from 'p' too,
477 * but that's one more allocation. Instead just make sure
478 * nowildcardlen does not exceed real patternlen
480 if (*nowildcardlen > len)
481 *nowildcardlen = len;
482 if (*p == '*' && no_wildcard(p + 1))
483 *flags |= EXC_FLAG_ENDSWITH;
488 void add_exclude(const char *string, const char *base,
489 int baselen, struct exclude_list *el, int srcpos)
496 parse_exclude_pattern(&string, &patternlen, &flags, &nowildcardlen);
497 if (flags & EXC_FLAG_MUSTBEDIR) {
498 FLEXPTR_ALLOC_MEM(x, pattern, string, patternlen);
500 x = xmalloc(sizeof(*x));
503 x->patternlen = patternlen;
504 x->nowildcardlen = nowildcardlen;
506 x->baselen = baselen;
509 ALLOC_GROW(el->excludes, el->nr + 1, el->alloc);
510 el->excludes[el->nr++] = x;
514 static void *read_skip_worktree_file_from_index(const char *path, size_t *size,
515 struct sha1_stat *sha1_stat)
519 enum object_type type;
523 pos = cache_name_pos(path, len);
526 if (!ce_skip_worktree(active_cache[pos]))
528 data = read_sha1_file(active_cache[pos]->sha1, &type, &sz);
529 if (!data || type != OBJ_BLOB) {
535 memset(&sha1_stat->stat, 0, sizeof(sha1_stat->stat));
536 hashcpy(sha1_stat->sha1, active_cache[pos]->sha1);
542 * Frees memory within el which was allocated for exclude patterns and
543 * the file buffer. Does not free el itself.
545 void clear_exclude_list(struct exclude_list *el)
549 for (i = 0; i < el->nr; i++)
550 free(el->excludes[i]);
554 memset(el, 0, sizeof(*el));
557 static void trim_trailing_spaces(char *buf)
559 char *p, *last_space = NULL;
561 for (p = buf; *p; p++)
581 * Given a subdirectory name and "dir" of the current directory,
582 * search the subdir in "dir" and return it, or create a new one if it
583 * does not exist in "dir".
585 * If "name" has the trailing slash, it'll be excluded in the search.
587 static struct untracked_cache_dir *lookup_untracked(struct untracked_cache *uc,
588 struct untracked_cache_dir *dir,
589 const char *name, int len)
592 struct untracked_cache_dir *d;
595 if (len && name[len - 1] == '/')
599 while (last > first) {
600 int cmp, next = (last + first) >> 1;
602 cmp = strncmp(name, d->name, len);
603 if (!cmp && strlen(d->name) > len)
615 FLEX_ALLOC_MEM(d, name, name, len);
617 ALLOC_GROW(dir->dirs, dir->dirs_nr + 1, dir->dirs_alloc);
618 memmove(dir->dirs + first + 1, dir->dirs + first,
619 (dir->dirs_nr - first) * sizeof(*dir->dirs));
621 dir->dirs[first] = d;
625 static void do_invalidate_gitignore(struct untracked_cache_dir *dir)
629 dir->untracked_nr = 0;
630 for (i = 0; i < dir->dirs_nr; i++)
631 do_invalidate_gitignore(dir->dirs[i]);
634 static void invalidate_gitignore(struct untracked_cache *uc,
635 struct untracked_cache_dir *dir)
637 uc->gitignore_invalidated++;
638 do_invalidate_gitignore(dir);
641 static void invalidate_directory(struct untracked_cache *uc,
642 struct untracked_cache_dir *dir)
645 uc->dir_invalidated++;
647 dir->untracked_nr = 0;
648 for (i = 0; i < dir->dirs_nr; i++)
649 dir->dirs[i]->recurse = 0;
653 * Given a file with name "fname", read it (either from disk, or from
654 * the index if "check_index" is non-zero), parse it and store the
655 * exclude rules in "el".
657 * If "ss" is not NULL, compute SHA-1 of the exclude file and fill
658 * stat data from disk (only valid if add_excludes returns zero). If
659 * ss_valid is non-zero, "ss" must contain good value as input.
661 static int add_excludes(const char *fname, const char *base, int baselen,
662 struct exclude_list *el, int check_index,
663 struct sha1_stat *sha1_stat)
666 int fd, i, lineno = 1;
670 fd = open(fname, O_RDONLY);
671 if (fd < 0 || fstat(fd, &st) < 0) {
673 warn_on_inaccessible(fname);
677 (buf = read_skip_worktree_file_from_index(fname, &size, sha1_stat)) == NULL)
683 if (buf[size-1] != '\n') {
684 buf = xrealloc(buf, st_add(size, 1));
688 size = xsize_t(st.st_size);
691 fill_stat_data(&sha1_stat->stat, &st);
692 hashcpy(sha1_stat->sha1, EMPTY_BLOB_SHA1_BIN);
693 sha1_stat->valid = 1;
698 buf = xmallocz(size);
699 if (read_in_full(fd, buf, size) != size) {
708 if (sha1_stat->valid &&
709 !match_stat_data_racy(&the_index, &sha1_stat->stat, &st))
710 ; /* no content change, ss->sha1 still good */
711 else if (check_index &&
712 (pos = cache_name_pos(fname, strlen(fname))) >= 0 &&
713 !ce_stage(active_cache[pos]) &&
714 ce_uptodate(active_cache[pos]) &&
715 !would_convert_to_git(fname))
716 hashcpy(sha1_stat->sha1, active_cache[pos]->sha1);
718 hash_sha1_file(buf, size, "blob", sha1_stat->sha1);
719 fill_stat_data(&sha1_stat->stat, &st);
720 sha1_stat->valid = 1;
726 if (skip_utf8_bom(&buf, size))
727 size -= buf - el->filebuf;
731 for (i = 0; i < size; i++) {
732 if (buf[i] == '\n') {
733 if (entry != buf + i && entry[0] != '#') {
734 buf[i - (i && buf[i-1] == '\r')] = 0;
735 trim_trailing_spaces(entry);
736 add_exclude(entry, base, baselen, el, lineno);
745 int add_excludes_from_file_to_list(const char *fname, const char *base,
746 int baselen, struct exclude_list *el,
749 return add_excludes(fname, base, baselen, el, check_index, NULL);
752 struct exclude_list *add_exclude_list(struct dir_struct *dir,
753 int group_type, const char *src)
755 struct exclude_list *el;
756 struct exclude_list_group *group;
758 group = &dir->exclude_list_group[group_type];
759 ALLOC_GROW(group->el, group->nr + 1, group->alloc);
760 el = &group->el[group->nr++];
761 memset(el, 0, sizeof(*el));
767 * Used to set up core.excludesfile and .git/info/exclude lists.
769 static void add_excludes_from_file_1(struct dir_struct *dir, const char *fname,
770 struct sha1_stat *sha1_stat)
772 struct exclude_list *el;
774 * catch setup_standard_excludes() that's called before
775 * dir->untracked is assigned. That function behaves
776 * differently when dir->untracked is non-NULL.
779 dir->unmanaged_exclude_files++;
780 el = add_exclude_list(dir, EXC_FILE, fname);
781 if (add_excludes(fname, "", 0, el, 0, sha1_stat) < 0)
782 die("cannot use %s as an exclude file", fname);
785 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
787 dir->unmanaged_exclude_files++; /* see validate_untracked_cache() */
788 add_excludes_from_file_1(dir, fname, NULL);
791 int match_basename(const char *basename, int basenamelen,
792 const char *pattern, int prefix, int patternlen,
795 if (prefix == patternlen) {
796 if (patternlen == basenamelen &&
797 !fspathncmp(pattern, basename, basenamelen))
799 } else if (flags & EXC_FLAG_ENDSWITH) {
800 /* "*literal" matching against "fooliteral" */
801 if (patternlen - 1 <= basenamelen &&
802 !fspathncmp(pattern + 1,
803 basename + basenamelen - (patternlen - 1),
807 if (fnmatch_icase_mem(pattern, patternlen,
808 basename, basenamelen,
815 int match_pathname(const char *pathname, int pathlen,
816 const char *base, int baselen,
817 const char *pattern, int prefix, int patternlen,
824 * match with FNM_PATHNAME; the pattern has base implicitly
827 if (*pattern == '/') {
834 * baselen does not count the trailing slash. base[] may or
835 * may not end with a trailing slash though.
837 if (pathlen < baselen + 1 ||
838 (baselen && pathname[baselen] != '/') ||
839 fspathncmp(pathname, base, baselen))
842 namelen = baselen ? pathlen - baselen - 1 : pathlen;
843 name = pathname + pathlen - namelen;
847 * if the non-wildcard part is longer than the
848 * remaining pathname, surely it cannot match.
850 if (prefix > namelen)
853 if (fspathncmp(pattern, name, prefix))
856 patternlen -= prefix;
861 * If the whole pattern did not have a wildcard,
862 * then our prefix match is all we need; we
863 * do not need to call fnmatch at all.
865 if (!patternlen && !namelen)
869 return fnmatch_icase_mem(pattern, patternlen,
875 * Scan the given exclude list in reverse to see whether pathname
876 * should be ignored. The first match (i.e. the last on the list), if
877 * any, determines the fate. Returns the exclude_list element which
878 * matched, or NULL for undecided.
880 static struct exclude *last_exclude_matching_from_list(const char *pathname,
882 const char *basename,
884 struct exclude_list *el)
886 struct exclude *exc = NULL; /* undecided */
890 return NULL; /* undefined */
892 for (i = el->nr - 1; 0 <= i; i--) {
893 struct exclude *x = el->excludes[i];
894 const char *exclude = x->pattern;
895 int prefix = x->nowildcardlen;
897 if (x->flags & EXC_FLAG_MUSTBEDIR) {
898 if (*dtype == DT_UNKNOWN)
899 *dtype = get_dtype(NULL, pathname, pathlen);
900 if (*dtype != DT_DIR)
904 if (x->flags & EXC_FLAG_NODIR) {
905 if (match_basename(basename,
906 pathlen - (basename - pathname),
907 exclude, prefix, x->patternlen,
915 assert(x->baselen == 0 || x->base[x->baselen - 1] == '/');
916 if (match_pathname(pathname, pathlen,
917 x->base, x->baselen ? x->baselen - 1 : 0,
918 exclude, prefix, x->patternlen, x->flags)) {
927 * Scan the list and let the last match determine the fate.
928 * Return 1 for exclude, 0 for include and -1 for undecided.
930 int is_excluded_from_list(const char *pathname,
931 int pathlen, const char *basename, int *dtype,
932 struct exclude_list *el)
934 struct exclude *exclude;
935 exclude = last_exclude_matching_from_list(pathname, pathlen, basename, dtype, el);
937 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
938 return -1; /* undecided */
941 static struct exclude *last_exclude_matching_from_lists(struct dir_struct *dir,
942 const char *pathname, int pathlen, const char *basename,
946 struct exclude_list_group *group;
947 struct exclude *exclude;
948 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
949 group = &dir->exclude_list_group[i];
950 for (j = group->nr - 1; j >= 0; j--) {
951 exclude = last_exclude_matching_from_list(
952 pathname, pathlen, basename, dtype_p,
962 * Loads the per-directory exclude list for the substring of base
963 * which has a char length of baselen.
965 static void prep_exclude(struct dir_struct *dir, const char *base, int baselen)
967 struct exclude_list_group *group;
968 struct exclude_list *el;
969 struct exclude_stack *stk = NULL;
970 struct untracked_cache_dir *untracked;
973 group = &dir->exclude_list_group[EXC_DIRS];
976 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
977 * which originate from directories not in the prefix of the
978 * path being checked.
980 while ((stk = dir->exclude_stack) != NULL) {
981 if (stk->baselen <= baselen &&
982 !strncmp(dir->basebuf.buf, base, stk->baselen))
984 el = &group->el[dir->exclude_stack->exclude_ix];
985 dir->exclude_stack = stk->prev;
987 free((char *)el->src); /* see strbuf_detach() below */
988 clear_exclude_list(el);
993 /* Skip traversing into sub directories if the parent is excluded */
998 * Lazy initialization. All call sites currently just
999 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1000 * them seems lots of work for little benefit.
1002 if (!dir->basebuf.buf)
1003 strbuf_init(&dir->basebuf, PATH_MAX);
1005 /* Read from the parent directories and push them down. */
1006 current = stk ? stk->baselen : -1;
1007 strbuf_setlen(&dir->basebuf, current < 0 ? 0 : current);
1009 untracked = stk ? stk->ucd : dir->untracked->root;
1013 while (current < baselen) {
1015 struct sha1_stat sha1_stat;
1017 stk = xcalloc(1, sizeof(*stk));
1022 cp = strchr(base + current + 1, '/');
1024 die("oops in prep_exclude");
1027 lookup_untracked(dir->untracked, untracked,
1029 cp - base - current);
1031 stk->prev = dir->exclude_stack;
1032 stk->baselen = cp - base;
1033 stk->exclude_ix = group->nr;
1034 stk->ucd = untracked;
1035 el = add_exclude_list(dir, EXC_DIRS, NULL);
1036 strbuf_add(&dir->basebuf, base + current, stk->baselen - current);
1037 assert(stk->baselen == dir->basebuf.len);
1039 /* Abort if the directory is excluded */
1042 dir->basebuf.buf[stk->baselen - 1] = 0;
1043 dir->exclude = last_exclude_matching_from_lists(dir,
1044 dir->basebuf.buf, stk->baselen - 1,
1045 dir->basebuf.buf + current, &dt);
1046 dir->basebuf.buf[stk->baselen - 1] = '/';
1048 dir->exclude->flags & EXC_FLAG_NEGATIVE)
1049 dir->exclude = NULL;
1051 dir->exclude_stack = stk;
1056 /* Try to read per-directory file */
1057 hashclr(sha1_stat.sha1);
1058 sha1_stat.valid = 0;
1059 if (dir->exclude_per_dir &&
1061 * If we know that no files have been added in
1062 * this directory (i.e. valid_cached_dir() has
1063 * been executed and set untracked->valid) ..
1065 (!untracked || !untracked->valid ||
1067 * .. and .gitignore does not exist before
1068 * (i.e. null exclude_sha1). Then we can skip
1069 * loading .gitignore, which would result in
1072 !is_null_sha1(untracked->exclude_sha1))) {
1074 * dir->basebuf gets reused by the traversal, but we
1075 * need fname to remain unchanged to ensure the src
1076 * member of each struct exclude correctly
1077 * back-references its source file. Other invocations
1078 * of add_exclude_list provide stable strings, so we
1079 * strbuf_detach() and free() here in the caller.
1081 struct strbuf sb = STRBUF_INIT;
1082 strbuf_addbuf(&sb, &dir->basebuf);
1083 strbuf_addstr(&sb, dir->exclude_per_dir);
1084 el->src = strbuf_detach(&sb, NULL);
1085 add_excludes(el->src, el->src, stk->baselen, el, 1,
1086 untracked ? &sha1_stat : NULL);
1089 * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1090 * will first be called in valid_cached_dir() then maybe many
1091 * times more in last_exclude_matching(). When the cache is
1092 * used, last_exclude_matching() will not be called and
1093 * reading .gitignore content will be a waste.
1095 * So when it's called by valid_cached_dir() and we can get
1096 * .gitignore SHA-1 from the index (i.e. .gitignore is not
1097 * modified on work tree), we could delay reading the
1098 * .gitignore content until we absolutely need it in
1099 * last_exclude_matching(). Be careful about ignore rule
1100 * order, though, if you do that.
1103 hashcmp(sha1_stat.sha1, untracked->exclude_sha1)) {
1104 invalidate_gitignore(dir->untracked, untracked);
1105 hashcpy(untracked->exclude_sha1, sha1_stat.sha1);
1107 dir->exclude_stack = stk;
1108 current = stk->baselen;
1110 strbuf_setlen(&dir->basebuf, baselen);
1114 * Loads the exclude lists for the directory containing pathname, then
1115 * scans all exclude lists to determine whether pathname is excluded.
1116 * Returns the exclude_list element which matched, or NULL for
1119 struct exclude *last_exclude_matching(struct dir_struct *dir,
1120 const char *pathname,
1123 int pathlen = strlen(pathname);
1124 const char *basename = strrchr(pathname, '/');
1125 basename = (basename) ? basename+1 : pathname;
1127 prep_exclude(dir, pathname, basename-pathname);
1130 return dir->exclude;
1132 return last_exclude_matching_from_lists(dir, pathname, pathlen,
1137 * Loads the exclude lists for the directory containing pathname, then
1138 * scans all exclude lists to determine whether pathname is excluded.
1139 * Returns 1 if true, otherwise 0.
1141 int is_excluded(struct dir_struct *dir, const char *pathname, int *dtype_p)
1143 struct exclude *exclude =
1144 last_exclude_matching(dir, pathname, dtype_p);
1146 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
1150 static struct dir_entry *dir_entry_new(const char *pathname, int len)
1152 struct dir_entry *ent;
1154 FLEX_ALLOC_MEM(ent, name, pathname, len);
1159 static struct dir_entry *dir_add_name(struct dir_struct *dir, const char *pathname, int len)
1161 if (cache_file_exists(pathname, len, ignore_case))
1164 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
1165 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
1168 struct dir_entry *dir_add_ignored(struct dir_struct *dir, const char *pathname, int len)
1170 if (!cache_name_is_other(pathname, len))
1173 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
1174 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
1178 index_nonexistent = 0,
1184 * Do not use the alphabetically sorted index to look up
1185 * the directory name; instead, use the case insensitive
1188 static enum exist_status directory_exists_in_index_icase(const char *dirname, int len)
1190 struct cache_entry *ce;
1192 if (cache_dir_exists(dirname, len))
1193 return index_directory;
1195 ce = cache_file_exists(dirname, len, ignore_case);
1196 if (ce && S_ISGITLINK(ce->ce_mode))
1197 return index_gitdir;
1199 return index_nonexistent;
1203 * The index sorts alphabetically by entry name, which
1204 * means that a gitlink sorts as '\0' at the end, while
1205 * a directory (which is defined not as an entry, but as
1206 * the files it contains) will sort with the '/' at the
1209 static enum exist_status directory_exists_in_index(const char *dirname, int len)
1214 return directory_exists_in_index_icase(dirname, len);
1216 pos = cache_name_pos(dirname, len);
1219 while (pos < active_nr) {
1220 const struct cache_entry *ce = active_cache[pos++];
1221 unsigned char endchar;
1223 if (strncmp(ce->name, dirname, len))
1225 endchar = ce->name[len];
1229 return index_directory;
1230 if (!endchar && S_ISGITLINK(ce->ce_mode))
1231 return index_gitdir;
1233 return index_nonexistent;
1237 * When we find a directory when traversing the filesystem, we
1238 * have three distinct cases:
1241 * - see it as a directory
1244 * and which one we choose depends on a combination of existing
1245 * git index contents and the flags passed into the directory
1246 * traversal routine.
1248 * Case 1: If we *already* have entries in the index under that
1249 * directory name, we always recurse into the directory to see
1252 * Case 2: If we *already* have that directory name as a gitlink,
1253 * we always continue to see it as a gitlink, regardless of whether
1254 * there is an actual git directory there or not (it might not
1255 * be checked out as a subproject!)
1257 * Case 3: if we didn't have it in the index previously, we
1258 * have a few sub-cases:
1260 * (a) if "show_other_directories" is true, we show it as
1261 * just a directory, unless "hide_empty_directories" is
1262 * also true, in which case we need to check if it contains any
1263 * untracked and / or ignored files.
1264 * (b) if it looks like a git directory, and we don't have
1265 * 'no_gitlinks' set we treat it as a gitlink, and show it
1267 * (c) otherwise, we recurse into it.
1269 static enum path_treatment treat_directory(struct dir_struct *dir,
1270 struct untracked_cache_dir *untracked,
1271 const char *dirname, int len, int baselen, int exclude,
1272 const struct path_simplify *simplify)
1274 /* The "len-1" is to strip the final '/' */
1275 switch (directory_exists_in_index(dirname, len-1)) {
1276 case index_directory:
1277 return path_recurse;
1282 case index_nonexistent:
1283 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
1285 if (!(dir->flags & DIR_NO_GITLINKS)) {
1286 unsigned char sha1[20];
1287 if (resolve_gitlink_ref(dirname, "HEAD", sha1) == 0)
1288 return path_untracked;
1290 return path_recurse;
1293 /* This is the "show_other_directories" case */
1295 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1296 return exclude ? path_excluded : path_untracked;
1298 untracked = lookup_untracked(dir->untracked, untracked,
1299 dirname + baselen, len - baselen);
1300 return read_directory_recursive(dir, dirname, len,
1301 untracked, 1, simplify);
1305 * This is an inexact early pruning of any recursive directory
1306 * reading - if the path cannot possibly be in the pathspec,
1307 * return true, and we'll skip it early.
1309 static int simplify_away(const char *path, int pathlen, const struct path_simplify *simplify)
1313 const char *match = simplify->path;
1314 int len = simplify->len;
1320 if (!memcmp(path, match, len))
1330 * This function tells us whether an excluded path matches a
1331 * list of "interesting" pathspecs. That is, whether a path matched
1332 * by any of the pathspecs could possibly be ignored by excluding
1333 * the specified path. This can happen if:
1335 * 1. the path is mentioned explicitly in the pathspec
1337 * 2. the path is a directory prefix of some element in the
1340 static int exclude_matches_pathspec(const char *path, int len,
1341 const struct path_simplify *simplify)
1344 for (; simplify->path; simplify++) {
1345 if (len == simplify->len
1346 && !memcmp(path, simplify->path, len))
1348 if (len < simplify->len
1349 && simplify->path[len] == '/'
1350 && !memcmp(path, simplify->path, len))
1357 static int get_index_dtype(const char *path, int len)
1360 const struct cache_entry *ce;
1362 ce = cache_file_exists(path, len, 0);
1364 if (!ce_uptodate(ce))
1366 if (S_ISGITLINK(ce->ce_mode))
1369 * Nobody actually cares about the
1370 * difference between DT_LNK and DT_REG
1375 /* Try to look it up as a directory */
1376 pos = cache_name_pos(path, len);
1380 while (pos < active_nr) {
1381 ce = active_cache[pos++];
1382 if (strncmp(ce->name, path, len))
1384 if (ce->name[len] > '/')
1386 if (ce->name[len] < '/')
1388 if (!ce_uptodate(ce))
1389 break; /* continue? */
1395 static int get_dtype(struct dirent *de, const char *path, int len)
1397 int dtype = de ? DTYPE(de) : DT_UNKNOWN;
1400 if (dtype != DT_UNKNOWN)
1402 dtype = get_index_dtype(path, len);
1403 if (dtype != DT_UNKNOWN)
1405 if (lstat(path, &st))
1407 if (S_ISREG(st.st_mode))
1409 if (S_ISDIR(st.st_mode))
1411 if (S_ISLNK(st.st_mode))
1416 static enum path_treatment treat_one_path(struct dir_struct *dir,
1417 struct untracked_cache_dir *untracked,
1418 struct strbuf *path,
1420 const struct path_simplify *simplify,
1421 int dtype, struct dirent *de)
1424 int has_path_in_index = !!cache_file_exists(path->buf, path->len, ignore_case);
1426 if (dtype == DT_UNKNOWN)
1427 dtype = get_dtype(de, path->buf, path->len);
1429 /* Always exclude indexed files */
1430 if (dtype != DT_DIR && has_path_in_index)
1434 * When we are looking at a directory P in the working tree,
1435 * there are three cases:
1437 * (1) P exists in the index. Everything inside the directory P in
1438 * the working tree needs to go when P is checked out from the
1441 * (2) P does not exist in the index, but there is P/Q in the index.
1442 * We know P will stay a directory when we check out the contents
1443 * of the index, but we do not know yet if there is a directory
1444 * P/Q in the working tree to be killed, so we need to recurse.
1446 * (3) P does not exist in the index, and there is no P/Q in the index
1447 * to require P to be a directory, either. Only in this case, we
1448 * know that everything inside P will not be killed without
1451 if ((dir->flags & DIR_COLLECT_KILLED_ONLY) &&
1452 (dtype == DT_DIR) &&
1453 !has_path_in_index &&
1454 (directory_exists_in_index(path->buf, path->len) == index_nonexistent))
1457 exclude = is_excluded(dir, path->buf, &dtype);
1460 * Excluded? If we don't explicitly want to show
1461 * ignored files, ignore it
1463 if (exclude && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
1464 return path_excluded;
1470 strbuf_addch(path, '/');
1471 return treat_directory(dir, untracked, path->buf, path->len,
1472 baselen, exclude, simplify);
1475 return exclude ? path_excluded : path_untracked;
1479 static enum path_treatment treat_path_fast(struct dir_struct *dir,
1480 struct untracked_cache_dir *untracked,
1481 struct cached_dir *cdir,
1482 struct strbuf *path,
1484 const struct path_simplify *simplify)
1486 strbuf_setlen(path, baselen);
1488 strbuf_addstr(path, cdir->file);
1489 return path_untracked;
1491 strbuf_addstr(path, cdir->ucd->name);
1492 /* treat_one_path() does this before it calls treat_directory() */
1493 strbuf_complete(path, '/');
1494 if (cdir->ucd->check_only)
1496 * check_only is set as a result of treat_directory() getting
1497 * to its bottom. Verify again the same set of directories
1498 * with check_only set.
1500 return read_directory_recursive(dir, path->buf, path->len,
1501 cdir->ucd, 1, simplify);
1503 * We get path_recurse in the first run when
1504 * directory_exists_in_index() returns index_nonexistent. We
1505 * are sure that new changes in the index does not impact the
1506 * outcome. Return now.
1508 return path_recurse;
1511 static enum path_treatment treat_path(struct dir_struct *dir,
1512 struct untracked_cache_dir *untracked,
1513 struct cached_dir *cdir,
1514 struct strbuf *path,
1516 const struct path_simplify *simplify)
1519 struct dirent *de = cdir->de;
1522 return treat_path_fast(dir, untracked, cdir, path,
1524 if (is_dot_or_dotdot(de->d_name) || !strcmp(de->d_name, ".git"))
1526 strbuf_setlen(path, baselen);
1527 strbuf_addstr(path, de->d_name);
1528 if (simplify_away(path->buf, path->len, simplify))
1532 return treat_one_path(dir, untracked, path, baselen, simplify, dtype, de);
1535 static void add_untracked(struct untracked_cache_dir *dir, const char *name)
1539 ALLOC_GROW(dir->untracked, dir->untracked_nr + 1,
1540 dir->untracked_alloc);
1541 dir->untracked[dir->untracked_nr++] = xstrdup(name);
1544 static int valid_cached_dir(struct dir_struct *dir,
1545 struct untracked_cache_dir *untracked,
1546 struct strbuf *path,
1554 if (stat(path->len ? path->buf : ".", &st)) {
1555 invalidate_directory(dir->untracked, untracked);
1556 memset(&untracked->stat_data, 0, sizeof(untracked->stat_data));
1559 if (!untracked->valid ||
1560 match_stat_data_racy(&the_index, &untracked->stat_data, &st)) {
1561 if (untracked->valid)
1562 invalidate_directory(dir->untracked, untracked);
1563 fill_stat_data(&untracked->stat_data, &st);
1567 if (untracked->check_only != !!check_only) {
1568 invalidate_directory(dir->untracked, untracked);
1573 * prep_exclude will be called eventually on this directory,
1574 * but it's called much later in last_exclude_matching(). We
1575 * need it now to determine the validity of the cache for this
1576 * path. The next calls will be nearly no-op, the way
1577 * prep_exclude() is designed.
1579 if (path->len && path->buf[path->len - 1] != '/') {
1580 strbuf_addch(path, '/');
1581 prep_exclude(dir, path->buf, path->len);
1582 strbuf_setlen(path, path->len - 1);
1584 prep_exclude(dir, path->buf, path->len);
1586 /* hopefully prep_exclude() haven't invalidated this entry... */
1587 return untracked->valid;
1590 static int open_cached_dir(struct cached_dir *cdir,
1591 struct dir_struct *dir,
1592 struct untracked_cache_dir *untracked,
1593 struct strbuf *path,
1596 memset(cdir, 0, sizeof(*cdir));
1597 cdir->untracked = untracked;
1598 if (valid_cached_dir(dir, untracked, path, check_only))
1600 cdir->fdir = opendir(path->len ? path->buf : ".");
1602 dir->untracked->dir_opened++;
1608 static int read_cached_dir(struct cached_dir *cdir)
1611 cdir->de = readdir(cdir->fdir);
1616 while (cdir->nr_dirs < cdir->untracked->dirs_nr) {
1617 struct untracked_cache_dir *d = cdir->untracked->dirs[cdir->nr_dirs];
1627 if (cdir->nr_files < cdir->untracked->untracked_nr) {
1628 struct untracked_cache_dir *d = cdir->untracked;
1629 cdir->file = d->untracked[cdir->nr_files++];
1635 static void close_cached_dir(struct cached_dir *cdir)
1638 closedir(cdir->fdir);
1640 * We have gone through this directory and found no untracked
1641 * entries. Mark it valid.
1643 if (cdir->untracked) {
1644 cdir->untracked->valid = 1;
1645 cdir->untracked->recurse = 1;
1650 * Read a directory tree. We currently ignore anything but
1651 * directories, regular files and symlinks. That's because git
1652 * doesn't handle them at all yet. Maybe that will change some
1655 * Also, we ignore the name ".git" (even if it is not a directory).
1656 * That likely will not change.
1658 * Returns the most significant path_treatment value encountered in the scan.
1660 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
1661 const char *base, int baselen,
1662 struct untracked_cache_dir *untracked, int check_only,
1663 const struct path_simplify *simplify)
1665 struct cached_dir cdir;
1666 enum path_treatment state, subdir_state, dir_state = path_none;
1667 struct strbuf path = STRBUF_INIT;
1669 strbuf_add(&path, base, baselen);
1671 if (open_cached_dir(&cdir, dir, untracked, &path, check_only))
1675 untracked->check_only = !!check_only;
1677 while (!read_cached_dir(&cdir)) {
1678 /* check how the file or directory should be treated */
1679 state = treat_path(dir, untracked, &cdir, &path, baselen, simplify);
1681 if (state > dir_state)
1684 /* recurse into subdir if instructed by treat_path */
1685 if (state == path_recurse) {
1686 struct untracked_cache_dir *ud;
1687 ud = lookup_untracked(dir->untracked, untracked,
1689 path.len - baselen);
1691 read_directory_recursive(dir, path.buf, path.len,
1692 ud, check_only, simplify);
1693 if (subdir_state > dir_state)
1694 dir_state = subdir_state;
1698 /* abort early if maximum state has been reached */
1699 if (dir_state == path_untracked) {
1701 add_untracked(untracked, path.buf + baselen);
1704 /* skip the dir_add_* part */
1708 /* add the path to the appropriate result list */
1711 if (dir->flags & DIR_SHOW_IGNORED)
1712 dir_add_name(dir, path.buf, path.len);
1713 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
1714 ((dir->flags & DIR_COLLECT_IGNORED) &&
1715 exclude_matches_pathspec(path.buf, path.len,
1717 dir_add_ignored(dir, path.buf, path.len);
1720 case path_untracked:
1721 if (dir->flags & DIR_SHOW_IGNORED)
1723 dir_add_name(dir, path.buf, path.len);
1725 add_untracked(untracked, path.buf + baselen);
1732 close_cached_dir(&cdir);
1734 strbuf_release(&path);
1739 static int cmp_name(const void *p1, const void *p2)
1741 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
1742 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
1744 return name_compare(e1->name, e1->len, e2->name, e2->len);
1747 static struct path_simplify *create_simplify(const char **pathspec)
1750 struct path_simplify *simplify = NULL;
1755 for (nr = 0 ; ; nr++) {
1757 ALLOC_GROW(simplify, nr + 1, alloc);
1758 match = *pathspec++;
1761 simplify[nr].path = match;
1762 simplify[nr].len = simple_length(match);
1764 simplify[nr].path = NULL;
1765 simplify[nr].len = 0;
1769 static void free_simplify(struct path_simplify *simplify)
1774 static int treat_leading_path(struct dir_struct *dir,
1775 const char *path, int len,
1776 const struct path_simplify *simplify)
1778 struct strbuf sb = STRBUF_INIT;
1779 int baselen, rc = 0;
1781 int old_flags = dir->flags;
1783 while (len && path[len - 1] == '/')
1788 dir->flags &= ~DIR_SHOW_OTHER_DIRECTORIES;
1790 cp = path + baselen + !!baselen;
1791 cp = memchr(cp, '/', path + len - cp);
1795 baselen = cp - path;
1796 strbuf_setlen(&sb, 0);
1797 strbuf_add(&sb, path, baselen);
1798 if (!is_directory(sb.buf))
1800 if (simplify_away(sb.buf, sb.len, simplify))
1802 if (treat_one_path(dir, NULL, &sb, baselen, simplify,
1803 DT_DIR, NULL) == path_none)
1804 break; /* do not recurse into it */
1805 if (len <= baselen) {
1807 break; /* finished checking */
1810 strbuf_release(&sb);
1811 dir->flags = old_flags;
1815 static const char *get_ident_string(void)
1817 static struct strbuf sb = STRBUF_INIT;
1822 if (uname(&uts) < 0)
1823 die_errno(_("failed to get kernel name and information"));
1824 strbuf_addf(&sb, "Location %s, system %s", get_git_work_tree(),
1829 static int ident_in_untracked(const struct untracked_cache *uc)
1832 * Previous git versions may have saved many NUL separated
1833 * strings in the "ident" field, but it is insane to manage
1834 * many locations, so just take care of the first one.
1837 return !strcmp(uc->ident.buf, get_ident_string());
1840 static void set_untracked_ident(struct untracked_cache *uc)
1842 strbuf_reset(&uc->ident);
1843 strbuf_addstr(&uc->ident, get_ident_string());
1846 * This strbuf used to contain a list of NUL separated
1847 * strings, so save NUL too for backward compatibility.
1849 strbuf_addch(&uc->ident, 0);
1852 static void new_untracked_cache(struct index_state *istate)
1854 struct untracked_cache *uc = xcalloc(1, sizeof(*uc));
1855 strbuf_init(&uc->ident, 100);
1856 uc->exclude_per_dir = ".gitignore";
1857 /* should be the same flags used by git-status */
1858 uc->dir_flags = DIR_SHOW_OTHER_DIRECTORIES | DIR_HIDE_EMPTY_DIRECTORIES;
1859 set_untracked_ident(uc);
1860 istate->untracked = uc;
1861 istate->cache_changed |= UNTRACKED_CHANGED;
1864 void add_untracked_cache(struct index_state *istate)
1866 if (!istate->untracked) {
1867 new_untracked_cache(istate);
1869 if (!ident_in_untracked(istate->untracked)) {
1870 free_untracked_cache(istate->untracked);
1871 new_untracked_cache(istate);
1876 void remove_untracked_cache(struct index_state *istate)
1878 if (istate->untracked) {
1879 free_untracked_cache(istate->untracked);
1880 istate->untracked = NULL;
1881 istate->cache_changed |= UNTRACKED_CHANGED;
1885 static struct untracked_cache_dir *validate_untracked_cache(struct dir_struct *dir,
1887 const struct pathspec *pathspec)
1889 struct untracked_cache_dir *root;
1891 if (!dir->untracked || getenv("GIT_DISABLE_UNTRACKED_CACHE"))
1895 * We only support $GIT_DIR/info/exclude and core.excludesfile
1896 * as the global ignore rule files. Any other additions
1897 * (e.g. from command line) invalidate the cache. This
1898 * condition also catches running setup_standard_excludes()
1899 * before setting dir->untracked!
1901 if (dir->unmanaged_exclude_files)
1905 * Optimize for the main use case only: whole-tree git
1906 * status. More work involved in treat_leading_path() if we
1907 * use cache on just a subset of the worktree. pathspec
1908 * support could make the matter even worse.
1910 if (base_len || (pathspec && pathspec->nr))
1913 /* Different set of flags may produce different results */
1914 if (dir->flags != dir->untracked->dir_flags ||
1916 * See treat_directory(), case index_nonexistent. Without
1917 * this flag, we may need to also cache .git file content
1918 * for the resolve_gitlink_ref() call, which we don't.
1920 !(dir->flags & DIR_SHOW_OTHER_DIRECTORIES) ||
1921 /* We don't support collecting ignore files */
1922 (dir->flags & (DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO |
1923 DIR_COLLECT_IGNORED)))
1927 * If we use .gitignore in the cache and now you change it to
1928 * .gitexclude, everything will go wrong.
1930 if (dir->exclude_per_dir != dir->untracked->exclude_per_dir &&
1931 strcmp(dir->exclude_per_dir, dir->untracked->exclude_per_dir))
1935 * EXC_CMDL is not considered in the cache. If people set it,
1938 if (dir->exclude_list_group[EXC_CMDL].nr)
1941 if (!ident_in_untracked(dir->untracked)) {
1942 warning(_("Untracked cache is disabled on this system or location."));
1946 if (!dir->untracked->root) {
1947 const int len = sizeof(*dir->untracked->root);
1948 dir->untracked->root = xmalloc(len);
1949 memset(dir->untracked->root, 0, len);
1952 /* Validate $GIT_DIR/info/exclude and core.excludesfile */
1953 root = dir->untracked->root;
1954 if (hashcmp(dir->ss_info_exclude.sha1,
1955 dir->untracked->ss_info_exclude.sha1)) {
1956 invalidate_gitignore(dir->untracked, root);
1957 dir->untracked->ss_info_exclude = dir->ss_info_exclude;
1959 if (hashcmp(dir->ss_excludes_file.sha1,
1960 dir->untracked->ss_excludes_file.sha1)) {
1961 invalidate_gitignore(dir->untracked, root);
1962 dir->untracked->ss_excludes_file = dir->ss_excludes_file;
1965 /* Make sure this directory is not dropped out at saving phase */
1970 int read_directory(struct dir_struct *dir, const char *path, int len, const struct pathspec *pathspec)
1972 struct path_simplify *simplify;
1973 struct untracked_cache_dir *untracked;
1976 * Check out create_simplify()
1979 GUARD_PATHSPEC(pathspec,
1987 if (has_symlink_leading_path(path, len))
1991 * exclude patterns are treated like positive ones in
1992 * create_simplify. Usually exclude patterns should be a
1993 * subset of positive ones, which has no impacts on
1994 * create_simplify().
1996 simplify = create_simplify(pathspec ? pathspec->_raw : NULL);
1997 untracked = validate_untracked_cache(dir, len, pathspec);
2000 * make sure untracked cache code path is disabled,
2001 * e.g. prep_exclude()
2003 dir->untracked = NULL;
2004 if (!len || treat_leading_path(dir, path, len, simplify))
2005 read_directory_recursive(dir, path, len, untracked, 0, simplify);
2006 free_simplify(simplify);
2007 qsort(dir->entries, dir->nr, sizeof(struct dir_entry *), cmp_name);
2008 qsort(dir->ignored, dir->ignored_nr, sizeof(struct dir_entry *), cmp_name);
2009 if (dir->untracked) {
2010 static struct trace_key trace_untracked_stats = TRACE_KEY_INIT(UNTRACKED_STATS);
2011 trace_printf_key(&trace_untracked_stats,
2012 "node creation: %u\n"
2013 "gitignore invalidation: %u\n"
2014 "directory invalidation: %u\n"
2016 dir->untracked->dir_created,
2017 dir->untracked->gitignore_invalidated,
2018 dir->untracked->dir_invalidated,
2019 dir->untracked->dir_opened);
2020 if (dir->untracked == the_index.untracked &&
2021 (dir->untracked->dir_opened ||
2022 dir->untracked->gitignore_invalidated ||
2023 dir->untracked->dir_invalidated))
2024 the_index.cache_changed |= UNTRACKED_CHANGED;
2025 if (dir->untracked != the_index.untracked) {
2026 free(dir->untracked);
2027 dir->untracked = NULL;
2033 int file_exists(const char *f)
2036 return lstat(f, &sb) == 0;
2039 static int cmp_icase(char a, char b)
2044 return toupper(a) - toupper(b);
2049 * Given two normalized paths (a trailing slash is ok), if subdir is
2050 * outside dir, return -1. Otherwise return the offset in subdir that
2051 * can be used as relative path to dir.
2053 int dir_inside_of(const char *subdir, const char *dir)
2057 assert(dir && subdir && *dir && *subdir);
2059 while (*dir && *subdir && !cmp_icase(*dir, *subdir)) {
2065 /* hel[p]/me vs hel[l]/yeah */
2066 if (*dir && *subdir)
2070 return !*dir ? offset : -1; /* same dir */
2072 /* foo/[b]ar vs foo/[] */
2073 if (is_dir_sep(dir[-1]))
2074 return is_dir_sep(subdir[-1]) ? offset : -1;
2076 /* foo[/]bar vs foo[] */
2077 return is_dir_sep(*subdir) ? offset + 1 : -1;
2080 int is_inside_dir(const char *dir)
2089 rc = (dir_inside_of(cwd, dir) >= 0);
2094 int is_empty_dir(const char *path)
2096 DIR *dir = opendir(path);
2103 while ((e = readdir(dir)) != NULL)
2104 if (!is_dot_or_dotdot(e->d_name)) {
2113 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
2117 int ret = 0, original_len = path->len, len, kept_down = 0;
2118 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
2119 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
2120 unsigned char submodule_head[20];
2122 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
2123 !resolve_gitlink_ref(path->buf, "HEAD", submodule_head)) {
2124 /* Do not descend and nuke a nested git work tree. */
2130 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
2131 dir = opendir(path->buf);
2133 if (errno == ENOENT)
2134 return keep_toplevel ? -1 : 0;
2135 else if (errno == EACCES && !keep_toplevel)
2137 * An empty dir could be removable even if it
2140 return rmdir(path->buf);
2144 strbuf_complete(path, '/');
2147 while ((e = readdir(dir)) != NULL) {
2149 if (is_dot_or_dotdot(e->d_name))
2152 strbuf_setlen(path, len);
2153 strbuf_addstr(path, e->d_name);
2154 if (lstat(path->buf, &st)) {
2155 if (errno == ENOENT)
2157 * file disappeared, which is what we
2162 } else if (S_ISDIR(st.st_mode)) {
2163 if (!remove_dir_recurse(path, flag, &kept_down))
2164 continue; /* happy */
2165 } else if (!only_empty &&
2166 (!unlink(path->buf) || errno == ENOENT)) {
2167 continue; /* happy, too */
2170 /* path too long, stat fails, or non-directory still exists */
2176 strbuf_setlen(path, original_len);
2177 if (!ret && !keep_toplevel && !kept_down)
2178 ret = (!rmdir(path->buf) || errno == ENOENT) ? 0 : -1;
2181 * report the uplevel that it is not an error that we
2182 * did not rmdir() our directory.
2188 int remove_dir_recursively(struct strbuf *path, int flag)
2190 return remove_dir_recurse(path, flag, NULL);
2193 static GIT_PATH_FUNC(git_path_info_exclude, "info/exclude")
2195 void setup_standard_excludes(struct dir_struct *dir)
2199 dir->exclude_per_dir = ".gitignore";
2201 /* core.excludefile defaulting to $XDG_HOME/git/ignore */
2203 excludes_file = xdg_config_home("ignore");
2204 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
2205 add_excludes_from_file_1(dir, excludes_file,
2206 dir->untracked ? &dir->ss_excludes_file : NULL);
2208 /* per repository user preference */
2209 path = git_path_info_exclude();
2210 if (!access_or_warn(path, R_OK, 0))
2211 add_excludes_from_file_1(dir, path,
2212 dir->untracked ? &dir->ss_info_exclude : NULL);
2215 int remove_path(const char *name)
2219 if (unlink(name) && errno != ENOENT && errno != ENOTDIR)
2222 slash = strrchr(name, '/');
2224 char *dirs = xstrdup(name);
2225 slash = dirs + (slash - name);
2228 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
2235 * Frees memory within dir which was allocated for exclude lists and
2236 * the exclude_stack. Does not free dir itself.
2238 void clear_directory(struct dir_struct *dir)
2241 struct exclude_list_group *group;
2242 struct exclude_list *el;
2243 struct exclude_stack *stk;
2245 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
2246 group = &dir->exclude_list_group[i];
2247 for (j = 0; j < group->nr; j++) {
2250 free((char *)el->src);
2251 clear_exclude_list(el);
2256 stk = dir->exclude_stack;
2258 struct exclude_stack *prev = stk->prev;
2262 strbuf_release(&dir->basebuf);
2265 struct ondisk_untracked_cache {
2266 struct stat_data info_exclude_stat;
2267 struct stat_data excludes_file_stat;
2269 unsigned char info_exclude_sha1[20];
2270 unsigned char excludes_file_sha1[20];
2271 char exclude_per_dir[FLEX_ARRAY];
2274 #define ouc_size(len) (offsetof(struct ondisk_untracked_cache, exclude_per_dir) + len + 1)
2277 int index; /* number of written untracked_cache_dir */
2278 struct ewah_bitmap *check_only; /* from untracked_cache_dir */
2279 struct ewah_bitmap *valid; /* from untracked_cache_dir */
2280 struct ewah_bitmap *sha1_valid; /* set if exclude_sha1 is not null */
2282 struct strbuf sb_stat;
2283 struct strbuf sb_sha1;
2286 static void stat_data_to_disk(struct stat_data *to, const struct stat_data *from)
2288 to->sd_ctime.sec = htonl(from->sd_ctime.sec);
2289 to->sd_ctime.nsec = htonl(from->sd_ctime.nsec);
2290 to->sd_mtime.sec = htonl(from->sd_mtime.sec);
2291 to->sd_mtime.nsec = htonl(from->sd_mtime.nsec);
2292 to->sd_dev = htonl(from->sd_dev);
2293 to->sd_ino = htonl(from->sd_ino);
2294 to->sd_uid = htonl(from->sd_uid);
2295 to->sd_gid = htonl(from->sd_gid);
2296 to->sd_size = htonl(from->sd_size);
2299 static void write_one_dir(struct untracked_cache_dir *untracked,
2300 struct write_data *wd)
2302 struct stat_data stat_data;
2303 struct strbuf *out = &wd->out;
2304 unsigned char intbuf[16];
2305 unsigned int intlen, value;
2306 int i = wd->index++;
2309 * untracked_nr should be reset whenever valid is clear, but
2312 if (!untracked->valid) {
2313 untracked->untracked_nr = 0;
2314 untracked->check_only = 0;
2317 if (untracked->check_only)
2318 ewah_set(wd->check_only, i);
2319 if (untracked->valid) {
2320 ewah_set(wd->valid, i);
2321 stat_data_to_disk(&stat_data, &untracked->stat_data);
2322 strbuf_add(&wd->sb_stat, &stat_data, sizeof(stat_data));
2324 if (!is_null_sha1(untracked->exclude_sha1)) {
2325 ewah_set(wd->sha1_valid, i);
2326 strbuf_add(&wd->sb_sha1, untracked->exclude_sha1, 20);
2329 intlen = encode_varint(untracked->untracked_nr, intbuf);
2330 strbuf_add(out, intbuf, intlen);
2332 /* skip non-recurse directories */
2333 for (i = 0, value = 0; i < untracked->dirs_nr; i++)
2334 if (untracked->dirs[i]->recurse)
2336 intlen = encode_varint(value, intbuf);
2337 strbuf_add(out, intbuf, intlen);
2339 strbuf_add(out, untracked->name, strlen(untracked->name) + 1);
2341 for (i = 0; i < untracked->untracked_nr; i++)
2342 strbuf_add(out, untracked->untracked[i],
2343 strlen(untracked->untracked[i]) + 1);
2345 for (i = 0; i < untracked->dirs_nr; i++)
2346 if (untracked->dirs[i]->recurse)
2347 write_one_dir(untracked->dirs[i], wd);
2350 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked)
2352 struct ondisk_untracked_cache *ouc;
2353 struct write_data wd;
2354 unsigned char varbuf[16];
2356 size_t len = strlen(untracked->exclude_per_dir);
2358 FLEX_ALLOC_MEM(ouc, exclude_per_dir, untracked->exclude_per_dir, len);
2359 stat_data_to_disk(&ouc->info_exclude_stat, &untracked->ss_info_exclude.stat);
2360 stat_data_to_disk(&ouc->excludes_file_stat, &untracked->ss_excludes_file.stat);
2361 hashcpy(ouc->info_exclude_sha1, untracked->ss_info_exclude.sha1);
2362 hashcpy(ouc->excludes_file_sha1, untracked->ss_excludes_file.sha1);
2363 ouc->dir_flags = htonl(untracked->dir_flags);
2365 varint_len = encode_varint(untracked->ident.len, varbuf);
2366 strbuf_add(out, varbuf, varint_len);
2367 strbuf_add(out, untracked->ident.buf, untracked->ident.len);
2369 strbuf_add(out, ouc, ouc_size(len));
2373 if (!untracked->root) {
2374 varint_len = encode_varint(0, varbuf);
2375 strbuf_add(out, varbuf, varint_len);
2380 wd.check_only = ewah_new();
2381 wd.valid = ewah_new();
2382 wd.sha1_valid = ewah_new();
2383 strbuf_init(&wd.out, 1024);
2384 strbuf_init(&wd.sb_stat, 1024);
2385 strbuf_init(&wd.sb_sha1, 1024);
2386 write_one_dir(untracked->root, &wd);
2388 varint_len = encode_varint(wd.index, varbuf);
2389 strbuf_add(out, varbuf, varint_len);
2390 strbuf_addbuf(out, &wd.out);
2391 ewah_serialize_strbuf(wd.valid, out);
2392 ewah_serialize_strbuf(wd.check_only, out);
2393 ewah_serialize_strbuf(wd.sha1_valid, out);
2394 strbuf_addbuf(out, &wd.sb_stat);
2395 strbuf_addbuf(out, &wd.sb_sha1);
2396 strbuf_addch(out, '\0'); /* safe guard for string lists */
2398 ewah_free(wd.valid);
2399 ewah_free(wd.check_only);
2400 ewah_free(wd.sha1_valid);
2401 strbuf_release(&wd.out);
2402 strbuf_release(&wd.sb_stat);
2403 strbuf_release(&wd.sb_sha1);
2406 static void free_untracked(struct untracked_cache_dir *ucd)
2411 for (i = 0; i < ucd->dirs_nr; i++)
2412 free_untracked(ucd->dirs[i]);
2413 for (i = 0; i < ucd->untracked_nr; i++)
2414 free(ucd->untracked[i]);
2415 free(ucd->untracked);
2420 void free_untracked_cache(struct untracked_cache *uc)
2423 free_untracked(uc->root);
2429 struct untracked_cache_dir **ucd;
2430 struct ewah_bitmap *check_only;
2431 struct ewah_bitmap *valid;
2432 struct ewah_bitmap *sha1_valid;
2433 const unsigned char *data;
2434 const unsigned char *end;
2437 static void stat_data_from_disk(struct stat_data *to, const struct stat_data *from)
2439 to->sd_ctime.sec = get_be32(&from->sd_ctime.sec);
2440 to->sd_ctime.nsec = get_be32(&from->sd_ctime.nsec);
2441 to->sd_mtime.sec = get_be32(&from->sd_mtime.sec);
2442 to->sd_mtime.nsec = get_be32(&from->sd_mtime.nsec);
2443 to->sd_dev = get_be32(&from->sd_dev);
2444 to->sd_ino = get_be32(&from->sd_ino);
2445 to->sd_uid = get_be32(&from->sd_uid);
2446 to->sd_gid = get_be32(&from->sd_gid);
2447 to->sd_size = get_be32(&from->sd_size);
2450 static int read_one_dir(struct untracked_cache_dir **untracked_,
2451 struct read_data *rd)
2453 struct untracked_cache_dir ud, *untracked;
2454 const unsigned char *next, *data = rd->data, *end = rd->end;
2458 memset(&ud, 0, sizeof(ud));
2461 value = decode_varint(&next);
2465 ud.untracked_alloc = value;
2466 ud.untracked_nr = value;
2467 if (ud.untracked_nr)
2468 ALLOC_ARRAY(ud.untracked, ud.untracked_nr);
2472 ud.dirs_alloc = ud.dirs_nr = decode_varint(&next);
2475 ALLOC_ARRAY(ud.dirs, ud.dirs_nr);
2478 len = strlen((const char *)data);
2479 next = data + len + 1;
2482 *untracked_ = untracked = xmalloc(st_add(sizeof(*untracked), len));
2483 memcpy(untracked, &ud, sizeof(ud));
2484 memcpy(untracked->name, data, len + 1);
2487 for (i = 0; i < untracked->untracked_nr; i++) {
2488 len = strlen((const char *)data);
2489 next = data + len + 1;
2492 untracked->untracked[i] = xstrdup((const char*)data);
2496 rd->ucd[rd->index++] = untracked;
2499 for (i = 0; i < untracked->dirs_nr; i++) {
2500 len = read_one_dir(untracked->dirs + i, rd);
2507 static void set_check_only(size_t pos, void *cb)
2509 struct read_data *rd = cb;
2510 struct untracked_cache_dir *ud = rd->ucd[pos];
2514 static void read_stat(size_t pos, void *cb)
2516 struct read_data *rd = cb;
2517 struct untracked_cache_dir *ud = rd->ucd[pos];
2518 if (rd->data + sizeof(struct stat_data) > rd->end) {
2519 rd->data = rd->end + 1;
2522 stat_data_from_disk(&ud->stat_data, (struct stat_data *)rd->data);
2523 rd->data += sizeof(struct stat_data);
2527 static void read_sha1(size_t pos, void *cb)
2529 struct read_data *rd = cb;
2530 struct untracked_cache_dir *ud = rd->ucd[pos];
2531 if (rd->data + 20 > rd->end) {
2532 rd->data = rd->end + 1;
2535 hashcpy(ud->exclude_sha1, rd->data);
2539 static void load_sha1_stat(struct sha1_stat *sha1_stat,
2540 const struct stat_data *stat,
2541 const unsigned char *sha1)
2543 stat_data_from_disk(&sha1_stat->stat, stat);
2544 hashcpy(sha1_stat->sha1, sha1);
2545 sha1_stat->valid = 1;
2548 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz)
2550 const struct ondisk_untracked_cache *ouc;
2551 struct untracked_cache *uc;
2552 struct read_data rd;
2553 const unsigned char *next = data, *end = (const unsigned char *)data + sz;
2557 if (sz <= 1 || end[-1] != '\0')
2561 ident_len = decode_varint(&next);
2562 if (next + ident_len > end)
2564 ident = (const char *)next;
2567 ouc = (const struct ondisk_untracked_cache *)next;
2568 if (next + ouc_size(0) > end)
2571 uc = xcalloc(1, sizeof(*uc));
2572 strbuf_init(&uc->ident, ident_len);
2573 strbuf_add(&uc->ident, ident, ident_len);
2574 load_sha1_stat(&uc->ss_info_exclude, &ouc->info_exclude_stat,
2575 ouc->info_exclude_sha1);
2576 load_sha1_stat(&uc->ss_excludes_file, &ouc->excludes_file_stat,
2577 ouc->excludes_file_sha1);
2578 uc->dir_flags = get_be32(&ouc->dir_flags);
2579 uc->exclude_per_dir = xstrdup(ouc->exclude_per_dir);
2580 /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
2581 next += ouc_size(strlen(ouc->exclude_per_dir));
2585 len = decode_varint(&next);
2586 if (next > end || len == 0)
2589 rd.valid = ewah_new();
2590 rd.check_only = ewah_new();
2591 rd.sha1_valid = ewah_new();
2595 ALLOC_ARRAY(rd.ucd, len);
2597 if (read_one_dir(&uc->root, &rd) || rd.index != len)
2601 len = ewah_read_mmap(rd.valid, next, end - next);
2606 len = ewah_read_mmap(rd.check_only, next, end - next);
2611 len = ewah_read_mmap(rd.sha1_valid, next, end - next);
2615 ewah_each_bit(rd.check_only, set_check_only, &rd);
2616 rd.data = next + len;
2617 ewah_each_bit(rd.valid, read_stat, &rd);
2618 ewah_each_bit(rd.sha1_valid, read_sha1, &rd);
2623 ewah_free(rd.valid);
2624 ewah_free(rd.check_only);
2625 ewah_free(rd.sha1_valid);
2628 free_untracked_cache(uc);
2634 static void invalidate_one_directory(struct untracked_cache *uc,
2635 struct untracked_cache_dir *ucd)
2637 uc->dir_invalidated++;
2639 ucd->untracked_nr = 0;
2643 * Normally when an entry is added or removed from a directory,
2644 * invalidating that directory is enough. No need to touch its
2645 * ancestors. When a directory is shown as "foo/bar/" in git-status
2646 * however, deleting or adding an entry may have cascading effect.
2648 * Say the "foo/bar/file" has become untracked, we need to tell the
2649 * untracked_cache_dir of "foo" that "bar/" is not an untracked
2650 * directory any more (because "bar" is managed by foo as an untracked
2653 * Similarly, if "foo/bar/file" moves from untracked to tracked and it
2654 * was the last untracked entry in the entire "foo", we should show
2655 * "foo/" instead. Which means we have to invalidate past "bar" up to
2658 * This function traverses all directories from root to leaf. If there
2659 * is a chance of one of the above cases happening, we invalidate back
2660 * to root. Otherwise we just invalidate the leaf. There may be a more
2661 * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
2662 * detect these cases and avoid unnecessary invalidation, for example,
2663 * checking for the untracked entry named "bar/" in "foo", but for now
2664 * stick to something safe and simple.
2666 static int invalidate_one_component(struct untracked_cache *uc,
2667 struct untracked_cache_dir *dir,
2668 const char *path, int len)
2670 const char *rest = strchr(path, '/');
2673 int component_len = rest - path;
2674 struct untracked_cache_dir *d =
2675 lookup_untracked(uc, dir, path, component_len);
2677 invalidate_one_component(uc, d, rest + 1,
2678 len - (component_len + 1));
2680 invalidate_one_directory(uc, dir);
2684 invalidate_one_directory(uc, dir);
2685 return uc->dir_flags & DIR_SHOW_OTHER_DIRECTORIES;
2688 void untracked_cache_invalidate_path(struct index_state *istate,
2691 if (!istate->untracked || !istate->untracked->root)
2693 invalidate_one_component(istate->untracked, istate->untracked->root,
2694 path, strlen(path));
2697 void untracked_cache_remove_from_index(struct index_state *istate,
2700 untracked_cache_invalidate_path(istate, path);
2703 void untracked_cache_add_to_index(struct index_state *istate,
2706 untracked_cache_invalidate_path(istate, path);