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 "object-store.h"
16 #include "wildmatch.h"
20 #include "ewah/ewok.h"
21 #include "fsmonitor.h"
22 #include "submodule-config.h"
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 struct index_state *istate, const char *path, int len,
53 struct untracked_cache_dir *untracked,
54 int check_only, int stop_at_first_file, const struct pathspec *pathspec);
55 static int get_dtype(struct dirent *de, struct index_state *istate,
56 const char *path, int len);
58 int count_slashes(const char *s)
67 int fspathcmp(const char *a, const char *b)
69 return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
72 int fspathncmp(const char *a, const char *b, size_t count)
74 return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
77 int git_fnmatch(const struct pathspec_item *item,
78 const char *pattern, const char *string,
82 if (ps_strncmp(item, pattern, string, prefix))
87 if (item->flags & PATHSPEC_ONESTAR) {
88 int pattern_len = strlen(++pattern);
89 int string_len = strlen(string);
90 return string_len < pattern_len ||
91 ps_strcmp(item, pattern,
92 string + string_len - pattern_len);
94 if (item->magic & PATHSPEC_GLOB)
95 return wildmatch(pattern, string,
97 (item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0));
99 /* wildmatch has not learned no FNM_PATHNAME mode yet */
100 return wildmatch(pattern, string,
101 item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0);
104 static int fnmatch_icase_mem(const char *pattern, int patternlen,
105 const char *string, int stringlen,
109 struct strbuf pat_buf = STRBUF_INIT;
110 struct strbuf str_buf = STRBUF_INIT;
111 const char *use_pat = pattern;
112 const char *use_str = string;
114 if (pattern[patternlen]) {
115 strbuf_add(&pat_buf, pattern, patternlen);
116 use_pat = pat_buf.buf;
118 if (string[stringlen]) {
119 strbuf_add(&str_buf, string, stringlen);
120 use_str = str_buf.buf;
124 flags |= WM_CASEFOLD;
125 match_status = wildmatch(use_pat, use_str, flags);
127 strbuf_release(&pat_buf);
128 strbuf_release(&str_buf);
133 static size_t common_prefix_len(const struct pathspec *pathspec)
139 * ":(icase)path" is treated as a pathspec full of
140 * wildcard. In other words, only prefix is considered common
141 * prefix. If the pathspec is abc/foo abc/bar, running in
142 * subdir xyz, the common prefix is still xyz, not xuz/abc as
145 GUARD_PATHSPEC(pathspec,
154 for (n = 0; n < pathspec->nr; n++) {
155 size_t i = 0, len = 0, item_len;
156 if (pathspec->items[n].magic & PATHSPEC_EXCLUDE)
158 if (pathspec->items[n].magic & PATHSPEC_ICASE)
159 item_len = pathspec->items[n].prefix;
161 item_len = pathspec->items[n].nowildcard_len;
162 while (i < item_len && (n == 0 || i < max)) {
163 char c = pathspec->items[n].match[i];
164 if (c != pathspec->items[0].match[i])
170 if (n == 0 || len < max) {
180 * Returns a copy of the longest leading path common among all
183 char *common_prefix(const struct pathspec *pathspec)
185 unsigned long len = common_prefix_len(pathspec);
187 return len ? xmemdupz(pathspec->items[0].match, len) : NULL;
190 int fill_directory(struct dir_struct *dir,
191 struct index_state *istate,
192 const struct pathspec *pathspec)
198 * Calculate common prefix for the pathspec, and
199 * use that to optimize the directory walk
201 prefix_len = common_prefix_len(pathspec);
202 prefix = prefix_len ? pathspec->items[0].match : "";
204 /* Read the directory and prune it */
205 read_directory(dir, istate, prefix, prefix_len, pathspec);
210 int within_depth(const char *name, int namelen,
211 int depth, int max_depth)
213 const char *cp = name, *cpe = name + namelen;
219 if (depth > max_depth)
226 * Read the contents of the blob with the given OID into a buffer.
227 * Append a trailing LF to the end if the last line doesn't have one.
230 * -1 when the OID is invalid or unknown or does not refer to a blob.
231 * 0 when the blob is empty.
232 * 1 along with { data, size } of the (possibly augmented) buffer
235 * Optionally updates the given oid_stat with the given OID (when valid).
237 static int do_read_blob(const struct object_id *oid, struct oid_stat *oid_stat,
238 size_t *size_out, char **data_out)
240 enum object_type type;
247 data = read_object_file(oid, &type, &sz);
248 if (!data || type != OBJ_BLOB) {
254 memset(&oid_stat->stat, 0, sizeof(oid_stat->stat));
255 oidcpy(&oid_stat->oid, oid);
263 if (data[sz - 1] != '\n') {
264 data = xrealloc(data, st_add(sz, 1));
268 *size_out = xsize_t(sz);
274 #define DO_MATCH_EXCLUDE (1<<0)
275 #define DO_MATCH_DIRECTORY (1<<1)
276 #define DO_MATCH_SUBMODULE (1<<2)
279 * Does 'match' match the given name?
280 * A match is found if
282 * (1) the 'match' string is leading directory of 'name', or
283 * (2) the 'match' string is a wildcard and matches 'name', or
284 * (3) the 'match' string is exactly the same as 'name'.
286 * and the return value tells which case it was.
288 * It returns 0 when there is no match.
290 static int match_pathspec_item(const struct index_state *istate,
291 const struct pathspec_item *item, int prefix,
292 const char *name, int namelen, unsigned flags)
294 /* name/namelen has prefix cut off by caller */
295 const char *match = item->match + prefix;
296 int matchlen = item->len - prefix;
299 * The normal call pattern is:
300 * 1. prefix = common_prefix_len(ps);
301 * 2. prune something, or fill_directory
302 * 3. match_pathspec()
304 * 'prefix' at #1 may be shorter than the command's prefix and
305 * it's ok for #2 to match extra files. Those extras will be
308 * Suppose the pathspec is 'foo' and '../bar' running from
309 * subdir 'xyz'. The common prefix at #1 will be empty, thanks
310 * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
311 * user does not want XYZ/foo, only the "foo" part should be
312 * case-insensitive. We need to filter out XYZ/foo here. In
313 * other words, we do not trust the caller on comparing the
314 * prefix part when :(icase) is involved. We do exact
315 * comparison ourselves.
317 * Normally the caller (common_prefix_len() in fact) does
318 * _exact_ matching on name[-prefix+1..-1] and we do not need
319 * to check that part. Be defensive and check it anyway, in
320 * case common_prefix_len is changed, or a new caller is
321 * introduced that does not use common_prefix_len.
323 * If the penalty turns out too high when prefix is really
324 * long, maybe change it to
325 * strncmp(match, name, item->prefix - prefix)
327 if (item->prefix && (item->magic & PATHSPEC_ICASE) &&
328 strncmp(item->match, name - prefix, item->prefix))
331 if (item->attr_match_nr &&
332 !match_pathspec_attrs(istate, name, namelen, item))
335 /* If the match was just the prefix, we matched */
337 return MATCHED_RECURSIVELY;
339 if (matchlen <= namelen && !ps_strncmp(item, match, name, matchlen)) {
340 if (matchlen == namelen)
341 return MATCHED_EXACTLY;
343 if (match[matchlen-1] == '/' || name[matchlen] == '/')
344 return MATCHED_RECURSIVELY;
345 } else if ((flags & DO_MATCH_DIRECTORY) &&
346 match[matchlen - 1] == '/' &&
347 namelen == matchlen - 1 &&
348 !ps_strncmp(item, match, name, namelen))
349 return MATCHED_EXACTLY;
351 if (item->nowildcard_len < item->len &&
352 !git_fnmatch(item, match, name,
353 item->nowildcard_len - prefix))
354 return MATCHED_FNMATCH;
356 /* Perform checks to see if "name" is a super set of the pathspec */
357 if (flags & DO_MATCH_SUBMODULE) {
358 /* name is a literal prefix of the pathspec */
359 if ((namelen < matchlen) &&
360 (match[namelen] == '/') &&
361 !ps_strncmp(item, match, name, namelen))
362 return MATCHED_RECURSIVELY;
364 /* name" doesn't match up to the first wild character */
365 if (item->nowildcard_len < item->len &&
366 ps_strncmp(item, match, name,
367 item->nowildcard_len - prefix))
371 * Here is where we would perform a wildmatch to check if
372 * "name" can be matched as a directory (or a prefix) against
373 * the pathspec. Since wildmatch doesn't have this capability
374 * at the present we have to punt and say that it is a match,
375 * potentially returning a false positive
376 * The submodules themselves will be able to perform more
377 * accurate matching to determine if the pathspec matches.
379 return MATCHED_RECURSIVELY;
386 * Given a name and a list of pathspecs, returns the nature of the
387 * closest (i.e. most specific) match of the name to any of the
390 * The caller typically calls this multiple times with the same
391 * pathspec and seen[] array but with different name/namelen
392 * (e.g. entries from the index) and is interested in seeing if and
393 * how each pathspec matches all the names it calls this function
394 * with. A mark is left in the seen[] array for each pathspec element
395 * indicating the closest type of match that element achieved, so if
396 * seen[n] remains zero after multiple invocations, that means the nth
397 * pathspec did not match any names, which could indicate that the
398 * user mistyped the nth pathspec.
400 static int do_match_pathspec(const struct index_state *istate,
401 const struct pathspec *ps,
402 const char *name, int namelen,
403 int prefix, char *seen,
406 int i, retval = 0, exclude = flags & DO_MATCH_EXCLUDE;
418 if (!ps->recursive ||
419 !(ps->magic & PATHSPEC_MAXDEPTH) ||
421 return MATCHED_RECURSIVELY;
423 if (within_depth(name, namelen, 0, ps->max_depth))
424 return MATCHED_EXACTLY;
432 for (i = ps->nr - 1; i >= 0; i--) {
435 if ((!exclude && ps->items[i].magic & PATHSPEC_EXCLUDE) ||
436 ( exclude && !(ps->items[i].magic & PATHSPEC_EXCLUDE)))
439 if (seen && seen[i] == MATCHED_EXACTLY)
442 * Make exclude patterns optional and never report
443 * "pathspec ':(exclude)foo' matches no files"
445 if (seen && ps->items[i].magic & PATHSPEC_EXCLUDE)
446 seen[i] = MATCHED_FNMATCH;
447 how = match_pathspec_item(istate, ps->items+i, prefix, name,
450 (ps->magic & PATHSPEC_MAXDEPTH) &&
451 ps->max_depth != -1 &&
452 how && how != MATCHED_FNMATCH) {
453 int len = ps->items[i].len;
454 if (name[len] == '/')
456 if (within_depth(name+len, namelen-len, 0, ps->max_depth))
457 how = MATCHED_EXACTLY;
464 if (seen && seen[i] < how)
471 int match_pathspec(const struct index_state *istate,
472 const struct pathspec *ps,
473 const char *name, int namelen,
474 int prefix, char *seen, int is_dir)
476 int positive, negative;
477 unsigned flags = is_dir ? DO_MATCH_DIRECTORY : 0;
478 positive = do_match_pathspec(istate, ps, name, namelen,
479 prefix, seen, flags);
480 if (!(ps->magic & PATHSPEC_EXCLUDE) || !positive)
482 negative = do_match_pathspec(istate, ps, name, namelen,
484 flags | DO_MATCH_EXCLUDE);
485 return negative ? 0 : positive;
489 * Check if a submodule is a superset of the pathspec
491 int submodule_path_match(const struct index_state *istate,
492 const struct pathspec *ps,
493 const char *submodule_name,
496 int matched = do_match_pathspec(istate, ps, submodule_name,
497 strlen(submodule_name),
504 int report_path_error(const char *ps_matched,
505 const struct pathspec *pathspec)
508 * Make sure all pathspec matched; otherwise it is an error.
511 for (num = 0; num < pathspec->nr; num++) {
512 int other, found_dup;
517 * The caller might have fed identical pathspec
518 * twice. Do not barf on such a mistake.
519 * FIXME: parse_pathspec should have eliminated
520 * duplicate pathspec.
522 for (found_dup = other = 0;
523 !found_dup && other < pathspec->nr;
525 if (other == num || !ps_matched[other])
527 if (!strcmp(pathspec->items[other].original,
528 pathspec->items[num].original))
530 * Ok, we have a match already.
537 error(_("pathspec '%s' did not match any file(s) known to git"),
538 pathspec->items[num].original);
545 * Return the length of the "simple" part of a path match limiter.
547 int simple_length(const char *match)
552 unsigned char c = *match++;
554 if (c == '\0' || is_glob_special(c))
559 int no_wildcard(const char *string)
561 return string[simple_length(string)] == '\0';
564 void parse_path_pattern(const char **pattern,
569 const char *p = *pattern;
574 *flags |= PATTERN_FLAG_NEGATIVE;
578 if (len && p[len - 1] == '/') {
580 *flags |= PATTERN_FLAG_MUSTBEDIR;
582 for (i = 0; i < len; i++) {
587 *flags |= PATTERN_FLAG_NODIR;
588 *nowildcardlen = simple_length(p);
590 * we should have excluded the trailing slash from 'p' too,
591 * but that's one more allocation. Instead just make sure
592 * nowildcardlen does not exceed real patternlen
594 if (*nowildcardlen > len)
595 *nowildcardlen = len;
596 if (*p == '*' && no_wildcard(p + 1))
597 *flags |= PATTERN_FLAG_ENDSWITH;
602 void add_pattern(const char *string, const char *base,
603 int baselen, struct pattern_list *pl, int srcpos)
605 struct path_pattern *pattern;
610 parse_path_pattern(&string, &patternlen, &flags, &nowildcardlen);
611 if (flags & PATTERN_FLAG_MUSTBEDIR) {
612 FLEXPTR_ALLOC_MEM(pattern, pattern, string, patternlen);
614 pattern = xmalloc(sizeof(*pattern));
615 pattern->pattern = string;
617 pattern->patternlen = patternlen;
618 pattern->nowildcardlen = nowildcardlen;
619 pattern->base = base;
620 pattern->baselen = baselen;
621 pattern->flags = flags;
622 pattern->srcpos = srcpos;
623 ALLOC_GROW(pl->patterns, pl->nr + 1, pl->alloc);
624 pl->patterns[pl->nr++] = pattern;
628 static int read_skip_worktree_file_from_index(const struct index_state *istate,
630 size_t *size_out, char **data_out,
631 struct oid_stat *oid_stat)
636 pos = index_name_pos(istate, path, len);
639 if (!ce_skip_worktree(istate->cache[pos]))
642 return do_read_blob(&istate->cache[pos]->oid, oid_stat, size_out, data_out);
646 * Frees memory within pl which was allocated for exclude patterns and
647 * the file buffer. Does not free pl itself.
649 void clear_pattern_list(struct pattern_list *pl)
653 for (i = 0; i < pl->nr; i++)
654 free(pl->patterns[i]);
658 memset(pl, 0, sizeof(*pl));
661 static void trim_trailing_spaces(char *buf)
663 char *p, *last_space = NULL;
665 for (p = buf; *p; p++)
685 * Given a subdirectory name and "dir" of the current directory,
686 * search the subdir in "dir" and return it, or create a new one if it
687 * does not exist in "dir".
689 * If "name" has the trailing slash, it'll be excluded in the search.
691 static struct untracked_cache_dir *lookup_untracked(struct untracked_cache *uc,
692 struct untracked_cache_dir *dir,
693 const char *name, int len)
696 struct untracked_cache_dir *d;
699 if (len && name[len - 1] == '/')
703 while (last > first) {
704 int cmp, next = first + ((last - first) >> 1);
706 cmp = strncmp(name, d->name, len);
707 if (!cmp && strlen(d->name) > len)
719 FLEX_ALLOC_MEM(d, name, name, len);
721 ALLOC_GROW(dir->dirs, dir->dirs_nr + 1, dir->dirs_alloc);
722 MOVE_ARRAY(dir->dirs + first + 1, dir->dirs + first,
723 dir->dirs_nr - first);
725 dir->dirs[first] = d;
729 static void do_invalidate_gitignore(struct untracked_cache_dir *dir)
733 dir->untracked_nr = 0;
734 for (i = 0; i < dir->dirs_nr; i++)
735 do_invalidate_gitignore(dir->dirs[i]);
738 static void invalidate_gitignore(struct untracked_cache *uc,
739 struct untracked_cache_dir *dir)
741 uc->gitignore_invalidated++;
742 do_invalidate_gitignore(dir);
745 static void invalidate_directory(struct untracked_cache *uc,
746 struct untracked_cache_dir *dir)
751 * Invalidation increment here is just roughly correct. If
752 * untracked_nr or any of dirs[].recurse is non-zero, we
753 * should increment dir_invalidated too. But that's more
757 uc->dir_invalidated++;
760 dir->untracked_nr = 0;
761 for (i = 0; i < dir->dirs_nr; i++)
762 dir->dirs[i]->recurse = 0;
765 static int add_patterns_from_buffer(char *buf, size_t size,
766 const char *base, int baselen,
767 struct pattern_list *pl);
770 * Given a file with name "fname", read it (either from disk, or from
771 * an index if 'istate' is non-null), parse it and store the
772 * exclude rules in "pl".
774 * If "ss" is not NULL, compute SHA-1 of the exclude file and fill
775 * stat data from disk (only valid if add_patterns returns zero). If
776 * ss_valid is non-zero, "ss" must contain good value as input.
778 static int add_patterns(const char *fname, const char *base, int baselen,
779 struct pattern_list *pl, struct index_state *istate,
780 struct oid_stat *oid_stat)
788 fd = open(fname, O_RDONLY);
789 if (fd < 0 || fstat(fd, &st) < 0) {
791 warn_on_fopen_errors(fname);
796 r = read_skip_worktree_file_from_index(istate, fname,
802 size = xsize_t(st.st_size);
805 fill_stat_data(&oid_stat->stat, &st);
806 oidcpy(&oid_stat->oid, the_hash_algo->empty_blob);
812 buf = xmallocz(size);
813 if (read_in_full(fd, buf, size) != size) {
822 if (oid_stat->valid &&
823 !match_stat_data_racy(istate, &oid_stat->stat, &st))
824 ; /* no content change, ss->sha1 still good */
826 (pos = index_name_pos(istate, fname, strlen(fname))) >= 0 &&
827 !ce_stage(istate->cache[pos]) &&
828 ce_uptodate(istate->cache[pos]) &&
829 !would_convert_to_git(istate, fname))
830 oidcpy(&oid_stat->oid,
831 &istate->cache[pos]->oid);
833 hash_object_file(buf, size, "blob",
835 fill_stat_data(&oid_stat->stat, &st);
840 add_patterns_from_buffer(buf, size, base, baselen, pl);
844 static int add_patterns_from_buffer(char *buf, size_t size,
845 const char *base, int baselen,
846 struct pattern_list *pl)
853 if (skip_utf8_bom(&buf, size))
854 size -= buf - pl->filebuf;
858 for (i = 0; i < size; i++) {
859 if (buf[i] == '\n') {
860 if (entry != buf + i && entry[0] != '#') {
861 buf[i - (i && buf[i-1] == '\r')] = 0;
862 trim_trailing_spaces(entry);
863 add_pattern(entry, base, baselen, pl, lineno);
872 int add_patterns_from_file_to_list(const char *fname, const char *base,
873 int baselen, struct pattern_list *pl,
874 struct index_state *istate)
876 return add_patterns(fname, base, baselen, pl, istate, NULL);
879 int add_patterns_from_blob_to_list(
880 struct object_id *oid,
881 const char *base, int baselen,
882 struct pattern_list *pl)
888 r = do_read_blob(oid, NULL, &size, &buf);
892 add_patterns_from_buffer(buf, size, base, baselen, pl);
896 struct pattern_list *add_pattern_list(struct dir_struct *dir,
897 int group_type, const char *src)
899 struct pattern_list *pl;
900 struct exclude_list_group *group;
902 group = &dir->exclude_list_group[group_type];
903 ALLOC_GROW(group->pl, group->nr + 1, group->alloc);
904 pl = &group->pl[group->nr++];
905 memset(pl, 0, sizeof(*pl));
911 * Used to set up core.excludesfile and .git/info/exclude lists.
913 static void add_patterns_from_file_1(struct dir_struct *dir, const char *fname,
914 struct oid_stat *oid_stat)
916 struct pattern_list *pl;
918 * catch setup_standard_excludes() that's called before
919 * dir->untracked is assigned. That function behaves
920 * differently when dir->untracked is non-NULL.
923 dir->unmanaged_exclude_files++;
924 pl = add_pattern_list(dir, EXC_FILE, fname);
925 if (add_patterns(fname, "", 0, pl, NULL, oid_stat) < 0)
926 die(_("cannot use %s as an exclude file"), fname);
929 void add_patterns_from_file(struct dir_struct *dir, const char *fname)
931 dir->unmanaged_exclude_files++; /* see validate_untracked_cache() */
932 add_patterns_from_file_1(dir, fname, NULL);
935 int match_basename(const char *basename, int basenamelen,
936 const char *pattern, int prefix, int patternlen,
939 if (prefix == patternlen) {
940 if (patternlen == basenamelen &&
941 !fspathncmp(pattern, basename, basenamelen))
943 } else if (flags & PATTERN_FLAG_ENDSWITH) {
944 /* "*literal" matching against "fooliteral" */
945 if (patternlen - 1 <= basenamelen &&
946 !fspathncmp(pattern + 1,
947 basename + basenamelen - (patternlen - 1),
951 if (fnmatch_icase_mem(pattern, patternlen,
952 basename, basenamelen,
959 int match_pathname(const char *pathname, int pathlen,
960 const char *base, int baselen,
961 const char *pattern, int prefix, int patternlen,
968 * match with FNM_PATHNAME; the pattern has base implicitly
971 if (*pattern == '/') {
978 * baselen does not count the trailing slash. base[] may or
979 * may not end with a trailing slash though.
981 if (pathlen < baselen + 1 ||
982 (baselen && pathname[baselen] != '/') ||
983 fspathncmp(pathname, base, baselen))
986 namelen = baselen ? pathlen - baselen - 1 : pathlen;
987 name = pathname + pathlen - namelen;
991 * if the non-wildcard part is longer than the
992 * remaining pathname, surely it cannot match.
994 if (prefix > namelen)
997 if (fspathncmp(pattern, name, prefix))
1000 patternlen -= prefix;
1005 * If the whole pattern did not have a wildcard,
1006 * then our prefix match is all we need; we
1007 * do not need to call fnmatch at all.
1009 if (!patternlen && !namelen)
1013 return fnmatch_icase_mem(pattern, patternlen,
1019 * Scan the given exclude list in reverse to see whether pathname
1020 * should be ignored. The first match (i.e. the last on the list), if
1021 * any, determines the fate. Returns the exclude_list element which
1022 * matched, or NULL for undecided.
1024 static struct path_pattern *last_matching_pattern_from_list(const char *pathname,
1026 const char *basename,
1028 struct pattern_list *pl,
1029 struct index_state *istate)
1031 struct path_pattern *res = NULL; /* undecided */
1035 return NULL; /* undefined */
1037 for (i = pl->nr - 1; 0 <= i; i--) {
1038 struct path_pattern *pattern = pl->patterns[i];
1039 const char *exclude = pattern->pattern;
1040 int prefix = pattern->nowildcardlen;
1042 if (pattern->flags & PATTERN_FLAG_MUSTBEDIR) {
1043 if (*dtype == DT_UNKNOWN)
1044 *dtype = get_dtype(NULL, istate, pathname, pathlen);
1045 if (*dtype != DT_DIR)
1049 if (pattern->flags & PATTERN_FLAG_NODIR) {
1050 if (match_basename(basename,
1051 pathlen - (basename - pathname),
1052 exclude, prefix, pattern->patternlen,
1060 assert(pattern->baselen == 0 ||
1061 pattern->base[pattern->baselen - 1] == '/');
1062 if (match_pathname(pathname, pathlen,
1064 pattern->baselen ? pattern->baselen - 1 : 0,
1065 exclude, prefix, pattern->patternlen,
1075 * Scan the list of patterns to determine if the ordered list
1076 * of patterns matches on 'pathname'.
1078 * Return 1 for a match, 0 for not matched and -1 for undecided.
1080 enum pattern_match_result path_matches_pattern_list(
1081 const char *pathname, int pathlen,
1082 const char *basename, int *dtype,
1083 struct pattern_list *pl,
1084 struct index_state *istate)
1086 struct path_pattern *pattern;
1087 pattern = last_matching_pattern_from_list(pathname, pathlen, basename,
1090 if (pattern->flags & PATTERN_FLAG_NEGATIVE)
1099 static struct path_pattern *last_matching_pattern_from_lists(
1100 struct dir_struct *dir, struct index_state *istate,
1101 const char *pathname, int pathlen,
1102 const char *basename, int *dtype_p)
1105 struct exclude_list_group *group;
1106 struct path_pattern *pattern;
1107 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1108 group = &dir->exclude_list_group[i];
1109 for (j = group->nr - 1; j >= 0; j--) {
1110 pattern = last_matching_pattern_from_list(
1111 pathname, pathlen, basename, dtype_p,
1112 &group->pl[j], istate);
1121 * Loads the per-directory exclude list for the substring of base
1122 * which has a char length of baselen.
1124 static void prep_exclude(struct dir_struct *dir,
1125 struct index_state *istate,
1126 const char *base, int baselen)
1128 struct exclude_list_group *group;
1129 struct pattern_list *pl;
1130 struct exclude_stack *stk = NULL;
1131 struct untracked_cache_dir *untracked;
1134 group = &dir->exclude_list_group[EXC_DIRS];
1137 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
1138 * which originate from directories not in the prefix of the
1139 * path being checked.
1141 while ((stk = dir->exclude_stack) != NULL) {
1142 if (stk->baselen <= baselen &&
1143 !strncmp(dir->basebuf.buf, base, stk->baselen))
1145 pl = &group->pl[dir->exclude_stack->exclude_ix];
1146 dir->exclude_stack = stk->prev;
1147 dir->pattern = NULL;
1148 free((char *)pl->src); /* see strbuf_detach() below */
1149 clear_pattern_list(pl);
1154 /* Skip traversing into sub directories if the parent is excluded */
1159 * Lazy initialization. All call sites currently just
1160 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1161 * them seems lots of work for little benefit.
1163 if (!dir->basebuf.buf)
1164 strbuf_init(&dir->basebuf, PATH_MAX);
1166 /* Read from the parent directories and push them down. */
1167 current = stk ? stk->baselen : -1;
1168 strbuf_setlen(&dir->basebuf, current < 0 ? 0 : current);
1170 untracked = stk ? stk->ucd : dir->untracked->root;
1174 while (current < baselen) {
1176 struct oid_stat oid_stat;
1178 stk = xcalloc(1, sizeof(*stk));
1183 cp = strchr(base + current + 1, '/');
1185 die("oops in prep_exclude");
1188 lookup_untracked(dir->untracked, untracked,
1190 cp - base - current);
1192 stk->prev = dir->exclude_stack;
1193 stk->baselen = cp - base;
1194 stk->exclude_ix = group->nr;
1195 stk->ucd = untracked;
1196 pl = add_pattern_list(dir, EXC_DIRS, NULL);
1197 strbuf_add(&dir->basebuf, base + current, stk->baselen - current);
1198 assert(stk->baselen == dir->basebuf.len);
1200 /* Abort if the directory is excluded */
1203 dir->basebuf.buf[stk->baselen - 1] = 0;
1204 dir->pattern = last_matching_pattern_from_lists(dir,
1206 dir->basebuf.buf, stk->baselen - 1,
1207 dir->basebuf.buf + current, &dt);
1208 dir->basebuf.buf[stk->baselen - 1] = '/';
1210 dir->pattern->flags & PATTERN_FLAG_NEGATIVE)
1211 dir->pattern = NULL;
1213 dir->exclude_stack = stk;
1218 /* Try to read per-directory file */
1219 oidclr(&oid_stat.oid);
1221 if (dir->exclude_per_dir &&
1223 * If we know that no files have been added in
1224 * this directory (i.e. valid_cached_dir() has
1225 * been executed and set untracked->valid) ..
1227 (!untracked || !untracked->valid ||
1229 * .. and .gitignore does not exist before
1230 * (i.e. null exclude_oid). Then we can skip
1231 * loading .gitignore, which would result in
1234 !is_null_oid(&untracked->exclude_oid))) {
1236 * dir->basebuf gets reused by the traversal, but we
1237 * need fname to remain unchanged to ensure the src
1238 * member of each struct path_pattern correctly
1239 * back-references its source file. Other invocations
1240 * of add_pattern_list provide stable strings, so we
1241 * strbuf_detach() and free() here in the caller.
1243 struct strbuf sb = STRBUF_INIT;
1244 strbuf_addbuf(&sb, &dir->basebuf);
1245 strbuf_addstr(&sb, dir->exclude_per_dir);
1246 pl->src = strbuf_detach(&sb, NULL);
1247 add_patterns(pl->src, pl->src, stk->baselen, pl, istate,
1248 untracked ? &oid_stat : NULL);
1251 * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1252 * will first be called in valid_cached_dir() then maybe many
1253 * times more in last_matching_pattern(). When the cache is
1254 * used, last_matching_pattern() will not be called and
1255 * reading .gitignore content will be a waste.
1257 * So when it's called by valid_cached_dir() and we can get
1258 * .gitignore SHA-1 from the index (i.e. .gitignore is not
1259 * modified on work tree), we could delay reading the
1260 * .gitignore content until we absolutely need it in
1261 * last_matching_pattern(). Be careful about ignore rule
1262 * order, though, if you do that.
1265 !oideq(&oid_stat.oid, &untracked->exclude_oid)) {
1266 invalidate_gitignore(dir->untracked, untracked);
1267 oidcpy(&untracked->exclude_oid, &oid_stat.oid);
1269 dir->exclude_stack = stk;
1270 current = stk->baselen;
1272 strbuf_setlen(&dir->basebuf, baselen);
1276 * Loads the exclude lists for the directory containing pathname, then
1277 * scans all exclude lists to determine whether pathname is excluded.
1278 * Returns the exclude_list element which matched, or NULL for
1281 struct path_pattern *last_matching_pattern(struct dir_struct *dir,
1282 struct index_state *istate,
1283 const char *pathname,
1286 int pathlen = strlen(pathname);
1287 const char *basename = strrchr(pathname, '/');
1288 basename = (basename) ? basename+1 : pathname;
1290 prep_exclude(dir, istate, pathname, basename-pathname);
1293 return dir->pattern;
1295 return last_matching_pattern_from_lists(dir, istate, pathname, pathlen,
1300 * Loads the exclude lists for the directory containing pathname, then
1301 * scans all exclude lists to determine whether pathname is excluded.
1302 * Returns 1 if true, otherwise 0.
1304 int is_excluded(struct dir_struct *dir, struct index_state *istate,
1305 const char *pathname, int *dtype_p)
1307 struct path_pattern *pattern =
1308 last_matching_pattern(dir, istate, pathname, dtype_p);
1310 return pattern->flags & PATTERN_FLAG_NEGATIVE ? 0 : 1;
1314 static struct dir_entry *dir_entry_new(const char *pathname, int len)
1316 struct dir_entry *ent;
1318 FLEX_ALLOC_MEM(ent, name, pathname, len);
1323 static struct dir_entry *dir_add_name(struct dir_struct *dir,
1324 struct index_state *istate,
1325 const char *pathname, int len)
1327 if (index_file_exists(istate, pathname, len, ignore_case))
1330 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
1331 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
1334 struct dir_entry *dir_add_ignored(struct dir_struct *dir,
1335 struct index_state *istate,
1336 const char *pathname, int len)
1338 if (!index_name_is_other(istate, pathname, len))
1341 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
1342 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
1346 index_nonexistent = 0,
1352 * Do not use the alphabetically sorted index to look up
1353 * the directory name; instead, use the case insensitive
1356 static enum exist_status directory_exists_in_index_icase(struct index_state *istate,
1357 const char *dirname, int len)
1359 struct cache_entry *ce;
1361 if (index_dir_exists(istate, dirname, len))
1362 return index_directory;
1364 ce = index_file_exists(istate, dirname, len, ignore_case);
1365 if (ce && S_ISGITLINK(ce->ce_mode))
1366 return index_gitdir;
1368 return index_nonexistent;
1372 * The index sorts alphabetically by entry name, which
1373 * means that a gitlink sorts as '\0' at the end, while
1374 * a directory (which is defined not as an entry, but as
1375 * the files it contains) will sort with the '/' at the
1378 static enum exist_status directory_exists_in_index(struct index_state *istate,
1379 const char *dirname, int len)
1384 return directory_exists_in_index_icase(istate, dirname, len);
1386 pos = index_name_pos(istate, dirname, len);
1389 while (pos < istate->cache_nr) {
1390 const struct cache_entry *ce = istate->cache[pos++];
1391 unsigned char endchar;
1393 if (strncmp(ce->name, dirname, len))
1395 endchar = ce->name[len];
1399 return index_directory;
1400 if (!endchar && S_ISGITLINK(ce->ce_mode))
1401 return index_gitdir;
1403 return index_nonexistent;
1407 * When we find a directory when traversing the filesystem, we
1408 * have three distinct cases:
1411 * - see it as a directory
1414 * and which one we choose depends on a combination of existing
1415 * git index contents and the flags passed into the directory
1416 * traversal routine.
1418 * Case 1: If we *already* have entries in the index under that
1419 * directory name, we always recurse into the directory to see
1422 * Case 2: If we *already* have that directory name as a gitlink,
1423 * we always continue to see it as a gitlink, regardless of whether
1424 * there is an actual git directory there or not (it might not
1425 * be checked out as a subproject!)
1427 * Case 3: if we didn't have it in the index previously, we
1428 * have a few sub-cases:
1430 * (a) if "show_other_directories" is true, we show it as
1431 * just a directory, unless "hide_empty_directories" is
1432 * also true, in which case we need to check if it contains any
1433 * untracked and / or ignored files.
1434 * (b) if it looks like a git directory, and we don't have
1435 * 'no_gitlinks' set we treat it as a gitlink, and show it
1437 * (c) otherwise, we recurse into it.
1439 static enum path_treatment treat_directory(struct dir_struct *dir,
1440 struct index_state *istate,
1441 struct untracked_cache_dir *untracked,
1442 const char *dirname, int len, int baselen, int exclude,
1443 const struct pathspec *pathspec)
1445 /* The "len-1" is to strip the final '/' */
1446 switch (directory_exists_in_index(istate, dirname, len-1)) {
1447 case index_directory:
1448 return path_recurse;
1453 case index_nonexistent:
1454 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
1457 (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1458 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING)) {
1461 * This is an excluded directory and we are
1462 * showing ignored paths that match an exclude
1463 * pattern. (e.g. show directory as ignored
1464 * only if it matches an exclude pattern).
1465 * This path will either be 'path_excluded`
1466 * (if we are showing empty directories or if
1467 * the directory is not empty), or will be
1468 * 'path_none' (empty directory, and we are
1469 * not showing empty directories).
1471 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1472 return path_excluded;
1474 if (read_directory_recursive(dir, istate, dirname, len,
1475 untracked, 1, 1, pathspec) == path_excluded)
1476 return path_excluded;
1480 if (!(dir->flags & DIR_NO_GITLINKS)) {
1481 struct strbuf sb = STRBUF_INIT;
1482 strbuf_addstr(&sb, dirname);
1483 if (is_nonbare_repository_dir(&sb))
1484 return exclude ? path_excluded : path_untracked;
1485 strbuf_release(&sb);
1487 return path_recurse;
1490 /* This is the "show_other_directories" case */
1492 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1493 return exclude ? path_excluded : path_untracked;
1495 untracked = lookup_untracked(dir->untracked, untracked,
1496 dirname + baselen, len - baselen);
1499 * If this is an excluded directory, then we only need to check if
1500 * the directory contains any files.
1502 return read_directory_recursive(dir, istate, dirname, len,
1503 untracked, 1, exclude, pathspec);
1507 * This is an inexact early pruning of any recursive directory
1508 * reading - if the path cannot possibly be in the pathspec,
1509 * return true, and we'll skip it early.
1511 static int simplify_away(const char *path, int pathlen,
1512 const struct pathspec *pathspec)
1516 if (!pathspec || !pathspec->nr)
1519 GUARD_PATHSPEC(pathspec,
1528 for (i = 0; i < pathspec->nr; i++) {
1529 const struct pathspec_item *item = &pathspec->items[i];
1530 int len = item->nowildcard_len;
1534 if (!ps_strncmp(item, item->match, path, len))
1542 * This function tells us whether an excluded path matches a
1543 * list of "interesting" pathspecs. That is, whether a path matched
1544 * by any of the pathspecs could possibly be ignored by excluding
1545 * the specified path. This can happen if:
1547 * 1. the path is mentioned explicitly in the pathspec
1549 * 2. the path is a directory prefix of some element in the
1552 static int exclude_matches_pathspec(const char *path, int pathlen,
1553 const struct pathspec *pathspec)
1557 if (!pathspec || !pathspec->nr)
1560 GUARD_PATHSPEC(pathspec,
1568 for (i = 0; i < pathspec->nr; i++) {
1569 const struct pathspec_item *item = &pathspec->items[i];
1570 int len = item->nowildcard_len;
1572 if (len == pathlen &&
1573 !ps_strncmp(item, item->match, path, pathlen))
1575 if (len > pathlen &&
1576 item->match[pathlen] == '/' &&
1577 !ps_strncmp(item, item->match, path, pathlen))
1583 static int get_index_dtype(struct index_state *istate,
1584 const char *path, int len)
1587 const struct cache_entry *ce;
1589 ce = index_file_exists(istate, path, len, 0);
1591 if (!ce_uptodate(ce))
1593 if (S_ISGITLINK(ce->ce_mode))
1596 * Nobody actually cares about the
1597 * difference between DT_LNK and DT_REG
1602 /* Try to look it up as a directory */
1603 pos = index_name_pos(istate, path, len);
1607 while (pos < istate->cache_nr) {
1608 ce = istate->cache[pos++];
1609 if (strncmp(ce->name, path, len))
1611 if (ce->name[len] > '/')
1613 if (ce->name[len] < '/')
1615 if (!ce_uptodate(ce))
1616 break; /* continue? */
1622 static int get_dtype(struct dirent *de, struct index_state *istate,
1623 const char *path, int len)
1625 int dtype = de ? DTYPE(de) : DT_UNKNOWN;
1628 if (dtype != DT_UNKNOWN)
1630 dtype = get_index_dtype(istate, path, len);
1631 if (dtype != DT_UNKNOWN)
1633 if (lstat(path, &st))
1635 if (S_ISREG(st.st_mode))
1637 if (S_ISDIR(st.st_mode))
1639 if (S_ISLNK(st.st_mode))
1644 static enum path_treatment treat_one_path(struct dir_struct *dir,
1645 struct untracked_cache_dir *untracked,
1646 struct index_state *istate,
1647 struct strbuf *path,
1649 const struct pathspec *pathspec,
1650 int dtype, struct dirent *de)
1653 int has_path_in_index = !!index_file_exists(istate, path->buf, path->len, ignore_case);
1654 enum path_treatment path_treatment;
1656 if (dtype == DT_UNKNOWN)
1657 dtype = get_dtype(de, istate, path->buf, path->len);
1659 /* Always exclude indexed files */
1660 if (dtype != DT_DIR && has_path_in_index)
1664 * When we are looking at a directory P in the working tree,
1665 * there are three cases:
1667 * (1) P exists in the index. Everything inside the directory P in
1668 * the working tree needs to go when P is checked out from the
1671 * (2) P does not exist in the index, but there is P/Q in the index.
1672 * We know P will stay a directory when we check out the contents
1673 * of the index, but we do not know yet if there is a directory
1674 * P/Q in the working tree to be killed, so we need to recurse.
1676 * (3) P does not exist in the index, and there is no P/Q in the index
1677 * to require P to be a directory, either. Only in this case, we
1678 * know that everything inside P will not be killed without
1681 if ((dir->flags & DIR_COLLECT_KILLED_ONLY) &&
1682 (dtype == DT_DIR) &&
1683 !has_path_in_index &&
1684 (directory_exists_in_index(istate, path->buf, path->len) == index_nonexistent))
1687 exclude = is_excluded(dir, istate, path->buf, &dtype);
1690 * Excluded? If we don't explicitly want to show
1691 * ignored files, ignore it
1693 if (exclude && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
1694 return path_excluded;
1700 strbuf_addch(path, '/');
1701 path_treatment = treat_directory(dir, istate, untracked,
1702 path->buf, path->len,
1703 baselen, exclude, pathspec);
1705 * If 1) we only want to return directories that
1706 * match an exclude pattern and 2) this directory does
1707 * not match an exclude pattern but all of its
1708 * contents are excluded, then indicate that we should
1709 * recurse into this directory (instead of marking the
1710 * directory itself as an ignored path).
1713 path_treatment == path_excluded &&
1714 (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1715 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING))
1716 return path_recurse;
1717 return path_treatment;
1720 return exclude ? path_excluded : path_untracked;
1724 static enum path_treatment treat_path_fast(struct dir_struct *dir,
1725 struct untracked_cache_dir *untracked,
1726 struct cached_dir *cdir,
1727 struct index_state *istate,
1728 struct strbuf *path,
1730 const struct pathspec *pathspec)
1732 strbuf_setlen(path, baselen);
1734 strbuf_addstr(path, cdir->file);
1735 return path_untracked;
1737 strbuf_addstr(path, cdir->ucd->name);
1738 /* treat_one_path() does this before it calls treat_directory() */
1739 strbuf_complete(path, '/');
1740 if (cdir->ucd->check_only)
1742 * check_only is set as a result of treat_directory() getting
1743 * to its bottom. Verify again the same set of directories
1744 * with check_only set.
1746 return read_directory_recursive(dir, istate, path->buf, path->len,
1747 cdir->ucd, 1, 0, pathspec);
1749 * We get path_recurse in the first run when
1750 * directory_exists_in_index() returns index_nonexistent. We
1751 * are sure that new changes in the index does not impact the
1752 * outcome. Return now.
1754 return path_recurse;
1757 static enum path_treatment treat_path(struct dir_struct *dir,
1758 struct untracked_cache_dir *untracked,
1759 struct cached_dir *cdir,
1760 struct index_state *istate,
1761 struct strbuf *path,
1763 const struct pathspec *pathspec)
1766 struct dirent *de = cdir->de;
1769 return treat_path_fast(dir, untracked, cdir, istate, path,
1771 if (is_dot_or_dotdot(de->d_name) || !fspathcmp(de->d_name, ".git"))
1773 strbuf_setlen(path, baselen);
1774 strbuf_addstr(path, de->d_name);
1775 if (simplify_away(path->buf, path->len, pathspec))
1779 return treat_one_path(dir, untracked, istate, path, baselen, pathspec, dtype, de);
1782 static void add_untracked(struct untracked_cache_dir *dir, const char *name)
1786 ALLOC_GROW(dir->untracked, dir->untracked_nr + 1,
1787 dir->untracked_alloc);
1788 dir->untracked[dir->untracked_nr++] = xstrdup(name);
1791 static int valid_cached_dir(struct dir_struct *dir,
1792 struct untracked_cache_dir *untracked,
1793 struct index_state *istate,
1794 struct strbuf *path,
1803 * With fsmonitor, we can trust the untracked cache's valid field.
1805 refresh_fsmonitor(istate);
1806 if (!(dir->untracked->use_fsmonitor && untracked->valid)) {
1807 if (lstat(path->len ? path->buf : ".", &st)) {
1808 memset(&untracked->stat_data, 0, sizeof(untracked->stat_data));
1811 if (!untracked->valid ||
1812 match_stat_data_racy(istate, &untracked->stat_data, &st)) {
1813 fill_stat_data(&untracked->stat_data, &st);
1818 if (untracked->check_only != !!check_only)
1822 * prep_exclude will be called eventually on this directory,
1823 * but it's called much later in last_matching_pattern(). We
1824 * need it now to determine the validity of the cache for this
1825 * path. The next calls will be nearly no-op, the way
1826 * prep_exclude() is designed.
1828 if (path->len && path->buf[path->len - 1] != '/') {
1829 strbuf_addch(path, '/');
1830 prep_exclude(dir, istate, path->buf, path->len);
1831 strbuf_setlen(path, path->len - 1);
1833 prep_exclude(dir, istate, path->buf, path->len);
1835 /* hopefully prep_exclude() haven't invalidated this entry... */
1836 return untracked->valid;
1839 static int open_cached_dir(struct cached_dir *cdir,
1840 struct dir_struct *dir,
1841 struct untracked_cache_dir *untracked,
1842 struct index_state *istate,
1843 struct strbuf *path,
1848 memset(cdir, 0, sizeof(*cdir));
1849 cdir->untracked = untracked;
1850 if (valid_cached_dir(dir, untracked, istate, path, check_only))
1852 c_path = path->len ? path->buf : ".";
1853 cdir->fdir = opendir(c_path);
1855 warning_errno(_("could not open directory '%s'"), c_path);
1856 if (dir->untracked) {
1857 invalidate_directory(dir->untracked, untracked);
1858 dir->untracked->dir_opened++;
1865 static int read_cached_dir(struct cached_dir *cdir)
1868 cdir->de = readdir(cdir->fdir);
1873 while (cdir->nr_dirs < cdir->untracked->dirs_nr) {
1874 struct untracked_cache_dir *d = cdir->untracked->dirs[cdir->nr_dirs];
1884 if (cdir->nr_files < cdir->untracked->untracked_nr) {
1885 struct untracked_cache_dir *d = cdir->untracked;
1886 cdir->file = d->untracked[cdir->nr_files++];
1892 static void close_cached_dir(struct cached_dir *cdir)
1895 closedir(cdir->fdir);
1897 * We have gone through this directory and found no untracked
1898 * entries. Mark it valid.
1900 if (cdir->untracked) {
1901 cdir->untracked->valid = 1;
1902 cdir->untracked->recurse = 1;
1907 * Read a directory tree. We currently ignore anything but
1908 * directories, regular files and symlinks. That's because git
1909 * doesn't handle them at all yet. Maybe that will change some
1912 * Also, we ignore the name ".git" (even if it is not a directory).
1913 * That likely will not change.
1915 * If 'stop_at_first_file' is specified, 'path_excluded' is returned
1916 * to signal that a file was found. This is the least significant value that
1917 * indicates that a file was encountered that does not depend on the order of
1918 * whether an untracked or exluded path was encountered first.
1920 * Returns the most significant path_treatment value encountered in the scan.
1921 * If 'stop_at_first_file' is specified, `path_excluded` is the most
1922 * significant path_treatment value that will be returned.
1925 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
1926 struct index_state *istate, const char *base, int baselen,
1927 struct untracked_cache_dir *untracked, int check_only,
1928 int stop_at_first_file, const struct pathspec *pathspec)
1930 struct cached_dir cdir;
1931 enum path_treatment state, subdir_state, dir_state = path_none;
1932 struct strbuf path = STRBUF_INIT;
1934 strbuf_add(&path, base, baselen);
1936 if (open_cached_dir(&cdir, dir, untracked, istate, &path, check_only))
1940 untracked->check_only = !!check_only;
1942 while (!read_cached_dir(&cdir)) {
1943 /* check how the file or directory should be treated */
1944 state = treat_path(dir, untracked, &cdir, istate, &path,
1947 if (state > dir_state)
1950 /* recurse into subdir if instructed by treat_path */
1951 if ((state == path_recurse) ||
1952 ((state == path_untracked) &&
1953 (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1954 (get_dtype(cdir.de, istate, path.buf, path.len) == DT_DIR))) {
1955 struct untracked_cache_dir *ud;
1956 ud = lookup_untracked(dir->untracked, untracked,
1958 path.len - baselen);
1960 read_directory_recursive(dir, istate, path.buf,
1962 check_only, stop_at_first_file, pathspec);
1963 if (subdir_state > dir_state)
1964 dir_state = subdir_state;
1968 if (stop_at_first_file) {
1970 * If stopping at first file, then
1971 * signal that a file was found by
1972 * returning `path_excluded`. This is
1973 * to return a consistent value
1974 * regardless of whether an ignored or
1975 * excluded file happened to be
1978 * In current usage, the
1979 * `stop_at_first_file` is passed when
1980 * an ancestor directory has matched
1981 * an exclude pattern, so any found
1982 * files will be excluded.
1984 if (dir_state >= path_excluded) {
1985 dir_state = path_excluded;
1990 /* abort early if maximum state has been reached */
1991 if (dir_state == path_untracked) {
1993 add_untracked(untracked, path.buf + baselen);
1996 /* skip the dir_add_* part */
2000 /* add the path to the appropriate result list */
2003 if (dir->flags & DIR_SHOW_IGNORED)
2004 dir_add_name(dir, istate, path.buf, path.len);
2005 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
2006 ((dir->flags & DIR_COLLECT_IGNORED) &&
2007 exclude_matches_pathspec(path.buf, path.len,
2009 dir_add_ignored(dir, istate, path.buf, path.len);
2012 case path_untracked:
2013 if (dir->flags & DIR_SHOW_IGNORED)
2015 dir_add_name(dir, istate, path.buf, path.len);
2017 add_untracked(untracked, path.buf + baselen);
2024 close_cached_dir(&cdir);
2026 strbuf_release(&path);
2031 int cmp_dir_entry(const void *p1, const void *p2)
2033 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
2034 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
2036 return name_compare(e1->name, e1->len, e2->name, e2->len);
2039 /* check if *out lexically strictly contains *in */
2040 int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in)
2042 return (out->len < in->len) &&
2043 (out->name[out->len - 1] == '/') &&
2044 !memcmp(out->name, in->name, out->len);
2047 static int treat_leading_path(struct dir_struct *dir,
2048 struct index_state *istate,
2049 const char *path, int len,
2050 const struct pathspec *pathspec)
2052 struct strbuf sb = STRBUF_INIT;
2053 int baselen, rc = 0;
2055 int old_flags = dir->flags;
2057 while (len && path[len - 1] == '/')
2062 dir->flags &= ~DIR_SHOW_OTHER_DIRECTORIES;
2064 cp = path + baselen + !!baselen;
2065 cp = memchr(cp, '/', path + len - cp);
2069 baselen = cp - path;
2070 strbuf_setlen(&sb, 0);
2071 strbuf_add(&sb, path, baselen);
2072 if (!is_directory(sb.buf))
2074 if (simplify_away(sb.buf, sb.len, pathspec))
2076 if (treat_one_path(dir, NULL, istate, &sb, baselen, pathspec,
2077 DT_DIR, NULL) == path_none)
2078 break; /* do not recurse into it */
2079 if (len <= baselen) {
2081 break; /* finished checking */
2084 strbuf_release(&sb);
2085 dir->flags = old_flags;
2089 static const char *get_ident_string(void)
2091 static struct strbuf sb = STRBUF_INIT;
2096 if (uname(&uts) < 0)
2097 die_errno(_("failed to get kernel name and information"));
2098 strbuf_addf(&sb, "Location %s, system %s", get_git_work_tree(),
2103 static int ident_in_untracked(const struct untracked_cache *uc)
2106 * Previous git versions may have saved many NUL separated
2107 * strings in the "ident" field, but it is insane to manage
2108 * many locations, so just take care of the first one.
2111 return !strcmp(uc->ident.buf, get_ident_string());
2114 static void set_untracked_ident(struct untracked_cache *uc)
2116 strbuf_reset(&uc->ident);
2117 strbuf_addstr(&uc->ident, get_ident_string());
2120 * This strbuf used to contain a list of NUL separated
2121 * strings, so save NUL too for backward compatibility.
2123 strbuf_addch(&uc->ident, 0);
2126 static void new_untracked_cache(struct index_state *istate)
2128 struct untracked_cache *uc = xcalloc(1, sizeof(*uc));
2129 strbuf_init(&uc->ident, 100);
2130 uc->exclude_per_dir = ".gitignore";
2131 /* should be the same flags used by git-status */
2132 uc->dir_flags = DIR_SHOW_OTHER_DIRECTORIES | DIR_HIDE_EMPTY_DIRECTORIES;
2133 set_untracked_ident(uc);
2134 istate->untracked = uc;
2135 istate->cache_changed |= UNTRACKED_CHANGED;
2138 void add_untracked_cache(struct index_state *istate)
2140 if (!istate->untracked) {
2141 new_untracked_cache(istate);
2143 if (!ident_in_untracked(istate->untracked)) {
2144 free_untracked_cache(istate->untracked);
2145 new_untracked_cache(istate);
2150 void remove_untracked_cache(struct index_state *istate)
2152 if (istate->untracked) {
2153 free_untracked_cache(istate->untracked);
2154 istate->untracked = NULL;
2155 istate->cache_changed |= UNTRACKED_CHANGED;
2159 static struct untracked_cache_dir *validate_untracked_cache(struct dir_struct *dir,
2161 const struct pathspec *pathspec)
2163 struct untracked_cache_dir *root;
2164 static int untracked_cache_disabled = -1;
2166 if (!dir->untracked)
2168 if (untracked_cache_disabled < 0)
2169 untracked_cache_disabled = git_env_bool("GIT_DISABLE_UNTRACKED_CACHE", 0);
2170 if (untracked_cache_disabled)
2174 * We only support $GIT_DIR/info/exclude and core.excludesfile
2175 * as the global ignore rule files. Any other additions
2176 * (e.g. from command line) invalidate the cache. This
2177 * condition also catches running setup_standard_excludes()
2178 * before setting dir->untracked!
2180 if (dir->unmanaged_exclude_files)
2184 * Optimize for the main use case only: whole-tree git
2185 * status. More work involved in treat_leading_path() if we
2186 * use cache on just a subset of the worktree. pathspec
2187 * support could make the matter even worse.
2189 if (base_len || (pathspec && pathspec->nr))
2192 /* Different set of flags may produce different results */
2193 if (dir->flags != dir->untracked->dir_flags ||
2195 * See treat_directory(), case index_nonexistent. Without
2196 * this flag, we may need to also cache .git file content
2197 * for the resolve_gitlink_ref() call, which we don't.
2199 !(dir->flags & DIR_SHOW_OTHER_DIRECTORIES) ||
2200 /* We don't support collecting ignore files */
2201 (dir->flags & (DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO |
2202 DIR_COLLECT_IGNORED)))
2206 * If we use .gitignore in the cache and now you change it to
2207 * .gitexclude, everything will go wrong.
2209 if (dir->exclude_per_dir != dir->untracked->exclude_per_dir &&
2210 strcmp(dir->exclude_per_dir, dir->untracked->exclude_per_dir))
2214 * EXC_CMDL is not considered in the cache. If people set it,
2217 if (dir->exclude_list_group[EXC_CMDL].nr)
2220 if (!ident_in_untracked(dir->untracked)) {
2221 warning(_("untracked cache is disabled on this system or location"));
2225 if (!dir->untracked->root) {
2226 const int len = sizeof(*dir->untracked->root);
2227 dir->untracked->root = xmalloc(len);
2228 memset(dir->untracked->root, 0, len);
2231 /* Validate $GIT_DIR/info/exclude and core.excludesfile */
2232 root = dir->untracked->root;
2233 if (!oideq(&dir->ss_info_exclude.oid,
2234 &dir->untracked->ss_info_exclude.oid)) {
2235 invalidate_gitignore(dir->untracked, root);
2236 dir->untracked->ss_info_exclude = dir->ss_info_exclude;
2238 if (!oideq(&dir->ss_excludes_file.oid,
2239 &dir->untracked->ss_excludes_file.oid)) {
2240 invalidate_gitignore(dir->untracked, root);
2241 dir->untracked->ss_excludes_file = dir->ss_excludes_file;
2244 /* Make sure this directory is not dropped out at saving phase */
2249 int read_directory(struct dir_struct *dir, struct index_state *istate,
2250 const char *path, int len, const struct pathspec *pathspec)
2252 struct untracked_cache_dir *untracked;
2254 trace_performance_enter();
2256 if (has_symlink_leading_path(path, len)) {
2257 trace_performance_leave("read directory %.*s", len, path);
2261 untracked = validate_untracked_cache(dir, len, pathspec);
2264 * make sure untracked cache code path is disabled,
2265 * e.g. prep_exclude()
2267 dir->untracked = NULL;
2268 if (!len || treat_leading_path(dir, istate, path, len, pathspec))
2269 read_directory_recursive(dir, istate, path, len, untracked, 0, 0, pathspec);
2270 QSORT(dir->entries, dir->nr, cmp_dir_entry);
2271 QSORT(dir->ignored, dir->ignored_nr, cmp_dir_entry);
2274 * If DIR_SHOW_IGNORED_TOO is set, read_directory_recursive() will
2275 * also pick up untracked contents of untracked dirs; by default
2276 * we discard these, but given DIR_KEEP_UNTRACKED_CONTENTS we do not.
2278 if ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2279 !(dir->flags & DIR_KEEP_UNTRACKED_CONTENTS)) {
2282 /* remove from dir->entries untracked contents of untracked dirs */
2283 for (i = j = 0; j < dir->nr; j++) {
2285 check_dir_entry_contains(dir->entries[i - 1], dir->entries[j])) {
2286 FREE_AND_NULL(dir->entries[j]);
2288 dir->entries[i++] = dir->entries[j];
2295 trace_performance_leave("read directory %.*s", len, path);
2296 if (dir->untracked) {
2297 static int force_untracked_cache = -1;
2298 static struct trace_key trace_untracked_stats = TRACE_KEY_INIT(UNTRACKED_STATS);
2300 if (force_untracked_cache < 0)
2301 force_untracked_cache =
2302 git_env_bool("GIT_FORCE_UNTRACKED_CACHE", 0);
2303 trace_printf_key(&trace_untracked_stats,
2304 "node creation: %u\n"
2305 "gitignore invalidation: %u\n"
2306 "directory invalidation: %u\n"
2308 dir->untracked->dir_created,
2309 dir->untracked->gitignore_invalidated,
2310 dir->untracked->dir_invalidated,
2311 dir->untracked->dir_opened);
2312 if (force_untracked_cache &&
2313 dir->untracked == istate->untracked &&
2314 (dir->untracked->dir_opened ||
2315 dir->untracked->gitignore_invalidated ||
2316 dir->untracked->dir_invalidated))
2317 istate->cache_changed |= UNTRACKED_CHANGED;
2318 if (dir->untracked != istate->untracked) {
2319 FREE_AND_NULL(dir->untracked);
2325 int file_exists(const char *f)
2328 return lstat(f, &sb) == 0;
2331 int repo_file_exists(struct repository *repo, const char *path)
2333 if (repo != the_repository)
2334 BUG("do not know how to check file existence in arbitrary repo");
2336 return file_exists(path);
2339 static int cmp_icase(char a, char b)
2344 return toupper(a) - toupper(b);
2349 * Given two normalized paths (a trailing slash is ok), if subdir is
2350 * outside dir, return -1. Otherwise return the offset in subdir that
2351 * can be used as relative path to dir.
2353 int dir_inside_of(const char *subdir, const char *dir)
2357 assert(dir && subdir && *dir && *subdir);
2359 while (*dir && *subdir && !cmp_icase(*dir, *subdir)) {
2365 /* hel[p]/me vs hel[l]/yeah */
2366 if (*dir && *subdir)
2370 return !*dir ? offset : -1; /* same dir */
2372 /* foo/[b]ar vs foo/[] */
2373 if (is_dir_sep(dir[-1]))
2374 return is_dir_sep(subdir[-1]) ? offset : -1;
2376 /* foo[/]bar vs foo[] */
2377 return is_dir_sep(*subdir) ? offset + 1 : -1;
2380 int is_inside_dir(const char *dir)
2389 rc = (dir_inside_of(cwd, dir) >= 0);
2394 int is_empty_dir(const char *path)
2396 DIR *dir = opendir(path);
2403 while ((e = readdir(dir)) != NULL)
2404 if (!is_dot_or_dotdot(e->d_name)) {
2413 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
2417 int ret = 0, original_len = path->len, len, kept_down = 0;
2418 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
2419 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
2420 struct object_id submodule_head;
2422 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
2423 !resolve_gitlink_ref(path->buf, "HEAD", &submodule_head)) {
2424 /* Do not descend and nuke a nested git work tree. */
2430 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
2431 dir = opendir(path->buf);
2433 if (errno == ENOENT)
2434 return keep_toplevel ? -1 : 0;
2435 else if (errno == EACCES && !keep_toplevel)
2437 * An empty dir could be removable even if it
2440 return rmdir(path->buf);
2444 strbuf_complete(path, '/');
2447 while ((e = readdir(dir)) != NULL) {
2449 if (is_dot_or_dotdot(e->d_name))
2452 strbuf_setlen(path, len);
2453 strbuf_addstr(path, e->d_name);
2454 if (lstat(path->buf, &st)) {
2455 if (errno == ENOENT)
2457 * file disappeared, which is what we
2462 } else if (S_ISDIR(st.st_mode)) {
2463 if (!remove_dir_recurse(path, flag, &kept_down))
2464 continue; /* happy */
2465 } else if (!only_empty &&
2466 (!unlink(path->buf) || errno == ENOENT)) {
2467 continue; /* happy, too */
2470 /* path too long, stat fails, or non-directory still exists */
2476 strbuf_setlen(path, original_len);
2477 if (!ret && !keep_toplevel && !kept_down)
2478 ret = (!rmdir(path->buf) || errno == ENOENT) ? 0 : -1;
2481 * report the uplevel that it is not an error that we
2482 * did not rmdir() our directory.
2488 int remove_dir_recursively(struct strbuf *path, int flag)
2490 return remove_dir_recurse(path, flag, NULL);
2493 static GIT_PATH_FUNC(git_path_info_exclude, "info/exclude")
2495 void setup_standard_excludes(struct dir_struct *dir)
2497 dir->exclude_per_dir = ".gitignore";
2499 /* core.excludesfile defaulting to $XDG_CONFIG_HOME/git/ignore */
2501 excludes_file = xdg_config_home("ignore");
2502 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
2503 add_patterns_from_file_1(dir, excludes_file,
2504 dir->untracked ? &dir->ss_excludes_file : NULL);
2506 /* per repository user preference */
2507 if (startup_info->have_repository) {
2508 const char *path = git_path_info_exclude();
2509 if (!access_or_warn(path, R_OK, 0))
2510 add_patterns_from_file_1(dir, path,
2511 dir->untracked ? &dir->ss_info_exclude : NULL);
2515 int remove_path(const char *name)
2519 if (unlink(name) && !is_missing_file_error(errno))
2522 slash = strrchr(name, '/');
2524 char *dirs = xstrdup(name);
2525 slash = dirs + (slash - name);
2528 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
2535 * Frees memory within dir which was allocated for exclude lists and
2536 * the exclude_stack. Does not free dir itself.
2538 void clear_directory(struct dir_struct *dir)
2541 struct exclude_list_group *group;
2542 struct pattern_list *pl;
2543 struct exclude_stack *stk;
2545 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
2546 group = &dir->exclude_list_group[i];
2547 for (j = 0; j < group->nr; j++) {
2550 free((char *)pl->src);
2551 clear_pattern_list(pl);
2556 stk = dir->exclude_stack;
2558 struct exclude_stack *prev = stk->prev;
2562 strbuf_release(&dir->basebuf);
2565 struct ondisk_untracked_cache {
2566 struct stat_data info_exclude_stat;
2567 struct stat_data excludes_file_stat;
2571 #define ouc_offset(x) offsetof(struct ondisk_untracked_cache, x)
2574 int index; /* number of written untracked_cache_dir */
2575 struct ewah_bitmap *check_only; /* from untracked_cache_dir */
2576 struct ewah_bitmap *valid; /* from untracked_cache_dir */
2577 struct ewah_bitmap *sha1_valid; /* set if exclude_sha1 is not null */
2579 struct strbuf sb_stat;
2580 struct strbuf sb_sha1;
2583 static void stat_data_to_disk(struct stat_data *to, const struct stat_data *from)
2585 to->sd_ctime.sec = htonl(from->sd_ctime.sec);
2586 to->sd_ctime.nsec = htonl(from->sd_ctime.nsec);
2587 to->sd_mtime.sec = htonl(from->sd_mtime.sec);
2588 to->sd_mtime.nsec = htonl(from->sd_mtime.nsec);
2589 to->sd_dev = htonl(from->sd_dev);
2590 to->sd_ino = htonl(from->sd_ino);
2591 to->sd_uid = htonl(from->sd_uid);
2592 to->sd_gid = htonl(from->sd_gid);
2593 to->sd_size = htonl(from->sd_size);
2596 static void write_one_dir(struct untracked_cache_dir *untracked,
2597 struct write_data *wd)
2599 struct stat_data stat_data;
2600 struct strbuf *out = &wd->out;
2601 unsigned char intbuf[16];
2602 unsigned int intlen, value;
2603 int i = wd->index++;
2606 * untracked_nr should be reset whenever valid is clear, but
2609 if (!untracked->valid) {
2610 untracked->untracked_nr = 0;
2611 untracked->check_only = 0;
2614 if (untracked->check_only)
2615 ewah_set(wd->check_only, i);
2616 if (untracked->valid) {
2617 ewah_set(wd->valid, i);
2618 stat_data_to_disk(&stat_data, &untracked->stat_data);
2619 strbuf_add(&wd->sb_stat, &stat_data, sizeof(stat_data));
2621 if (!is_null_oid(&untracked->exclude_oid)) {
2622 ewah_set(wd->sha1_valid, i);
2623 strbuf_add(&wd->sb_sha1, untracked->exclude_oid.hash,
2624 the_hash_algo->rawsz);
2627 intlen = encode_varint(untracked->untracked_nr, intbuf);
2628 strbuf_add(out, intbuf, intlen);
2630 /* skip non-recurse directories */
2631 for (i = 0, value = 0; i < untracked->dirs_nr; i++)
2632 if (untracked->dirs[i]->recurse)
2634 intlen = encode_varint(value, intbuf);
2635 strbuf_add(out, intbuf, intlen);
2637 strbuf_add(out, untracked->name, strlen(untracked->name) + 1);
2639 for (i = 0; i < untracked->untracked_nr; i++)
2640 strbuf_add(out, untracked->untracked[i],
2641 strlen(untracked->untracked[i]) + 1);
2643 for (i = 0; i < untracked->dirs_nr; i++)
2644 if (untracked->dirs[i]->recurse)
2645 write_one_dir(untracked->dirs[i], wd);
2648 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked)
2650 struct ondisk_untracked_cache *ouc;
2651 struct write_data wd;
2652 unsigned char varbuf[16];
2654 const unsigned hashsz = the_hash_algo->rawsz;
2656 ouc = xcalloc(1, sizeof(*ouc));
2657 stat_data_to_disk(&ouc->info_exclude_stat, &untracked->ss_info_exclude.stat);
2658 stat_data_to_disk(&ouc->excludes_file_stat, &untracked->ss_excludes_file.stat);
2659 ouc->dir_flags = htonl(untracked->dir_flags);
2661 varint_len = encode_varint(untracked->ident.len, varbuf);
2662 strbuf_add(out, varbuf, varint_len);
2663 strbuf_addbuf(out, &untracked->ident);
2665 strbuf_add(out, ouc, sizeof(*ouc));
2666 strbuf_add(out, untracked->ss_info_exclude.oid.hash, hashsz);
2667 strbuf_add(out, untracked->ss_excludes_file.oid.hash, hashsz);
2668 strbuf_add(out, untracked->exclude_per_dir, strlen(untracked->exclude_per_dir) + 1);
2671 if (!untracked->root) {
2672 varint_len = encode_varint(0, varbuf);
2673 strbuf_add(out, varbuf, varint_len);
2678 wd.check_only = ewah_new();
2679 wd.valid = ewah_new();
2680 wd.sha1_valid = ewah_new();
2681 strbuf_init(&wd.out, 1024);
2682 strbuf_init(&wd.sb_stat, 1024);
2683 strbuf_init(&wd.sb_sha1, 1024);
2684 write_one_dir(untracked->root, &wd);
2686 varint_len = encode_varint(wd.index, varbuf);
2687 strbuf_add(out, varbuf, varint_len);
2688 strbuf_addbuf(out, &wd.out);
2689 ewah_serialize_strbuf(wd.valid, out);
2690 ewah_serialize_strbuf(wd.check_only, out);
2691 ewah_serialize_strbuf(wd.sha1_valid, out);
2692 strbuf_addbuf(out, &wd.sb_stat);
2693 strbuf_addbuf(out, &wd.sb_sha1);
2694 strbuf_addch(out, '\0'); /* safe guard for string lists */
2696 ewah_free(wd.valid);
2697 ewah_free(wd.check_only);
2698 ewah_free(wd.sha1_valid);
2699 strbuf_release(&wd.out);
2700 strbuf_release(&wd.sb_stat);
2701 strbuf_release(&wd.sb_sha1);
2704 static void free_untracked(struct untracked_cache_dir *ucd)
2709 for (i = 0; i < ucd->dirs_nr; i++)
2710 free_untracked(ucd->dirs[i]);
2711 for (i = 0; i < ucd->untracked_nr; i++)
2712 free(ucd->untracked[i]);
2713 free(ucd->untracked);
2718 void free_untracked_cache(struct untracked_cache *uc)
2721 free_untracked(uc->root);
2727 struct untracked_cache_dir **ucd;
2728 struct ewah_bitmap *check_only;
2729 struct ewah_bitmap *valid;
2730 struct ewah_bitmap *sha1_valid;
2731 const unsigned char *data;
2732 const unsigned char *end;
2735 static void stat_data_from_disk(struct stat_data *to, const unsigned char *data)
2737 memcpy(to, data, sizeof(*to));
2738 to->sd_ctime.sec = ntohl(to->sd_ctime.sec);
2739 to->sd_ctime.nsec = ntohl(to->sd_ctime.nsec);
2740 to->sd_mtime.sec = ntohl(to->sd_mtime.sec);
2741 to->sd_mtime.nsec = ntohl(to->sd_mtime.nsec);
2742 to->sd_dev = ntohl(to->sd_dev);
2743 to->sd_ino = ntohl(to->sd_ino);
2744 to->sd_uid = ntohl(to->sd_uid);
2745 to->sd_gid = ntohl(to->sd_gid);
2746 to->sd_size = ntohl(to->sd_size);
2749 static int read_one_dir(struct untracked_cache_dir **untracked_,
2750 struct read_data *rd)
2752 struct untracked_cache_dir ud, *untracked;
2753 const unsigned char *data = rd->data, *end = rd->end;
2754 const unsigned char *eos;
2758 memset(&ud, 0, sizeof(ud));
2760 value = decode_varint(&data);
2764 ud.untracked_alloc = value;
2765 ud.untracked_nr = value;
2766 if (ud.untracked_nr)
2767 ALLOC_ARRAY(ud.untracked, ud.untracked_nr);
2769 ud.dirs_alloc = ud.dirs_nr = decode_varint(&data);
2772 ALLOC_ARRAY(ud.dirs, ud.dirs_nr);
2774 eos = memchr(data, '\0', end - data);
2775 if (!eos || eos == end)
2778 *untracked_ = untracked = xmalloc(st_add3(sizeof(*untracked), eos - data, 1));
2779 memcpy(untracked, &ud, sizeof(ud));
2780 memcpy(untracked->name, data, eos - data + 1);
2783 for (i = 0; i < untracked->untracked_nr; i++) {
2784 eos = memchr(data, '\0', end - data);
2785 if (!eos || eos == end)
2787 untracked->untracked[i] = xmemdupz(data, eos - data);
2791 rd->ucd[rd->index++] = untracked;
2794 for (i = 0; i < untracked->dirs_nr; i++) {
2795 if (read_one_dir(untracked->dirs + i, rd) < 0)
2801 static void set_check_only(size_t pos, void *cb)
2803 struct read_data *rd = cb;
2804 struct untracked_cache_dir *ud = rd->ucd[pos];
2808 static void read_stat(size_t pos, void *cb)
2810 struct read_data *rd = cb;
2811 struct untracked_cache_dir *ud = rd->ucd[pos];
2812 if (rd->data + sizeof(struct stat_data) > rd->end) {
2813 rd->data = rd->end + 1;
2816 stat_data_from_disk(&ud->stat_data, rd->data);
2817 rd->data += sizeof(struct stat_data);
2821 static void read_oid(size_t pos, void *cb)
2823 struct read_data *rd = cb;
2824 struct untracked_cache_dir *ud = rd->ucd[pos];
2825 if (rd->data + the_hash_algo->rawsz > rd->end) {
2826 rd->data = rd->end + 1;
2829 hashcpy(ud->exclude_oid.hash, rd->data);
2830 rd->data += the_hash_algo->rawsz;
2833 static void load_oid_stat(struct oid_stat *oid_stat, const unsigned char *data,
2834 const unsigned char *sha1)
2836 stat_data_from_disk(&oid_stat->stat, data);
2837 hashcpy(oid_stat->oid.hash, sha1);
2838 oid_stat->valid = 1;
2841 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz)
2843 struct untracked_cache *uc;
2844 struct read_data rd;
2845 const unsigned char *next = data, *end = (const unsigned char *)data + sz;
2849 const char *exclude_per_dir;
2850 const unsigned hashsz = the_hash_algo->rawsz;
2851 const unsigned offset = sizeof(struct ondisk_untracked_cache);
2852 const unsigned exclude_per_dir_offset = offset + 2 * hashsz;
2854 if (sz <= 1 || end[-1] != '\0')
2858 ident_len = decode_varint(&next);
2859 if (next + ident_len > end)
2861 ident = (const char *)next;
2864 if (next + exclude_per_dir_offset + 1 > end)
2867 uc = xcalloc(1, sizeof(*uc));
2868 strbuf_init(&uc->ident, ident_len);
2869 strbuf_add(&uc->ident, ident, ident_len);
2870 load_oid_stat(&uc->ss_info_exclude,
2871 next + ouc_offset(info_exclude_stat),
2873 load_oid_stat(&uc->ss_excludes_file,
2874 next + ouc_offset(excludes_file_stat),
2875 next + offset + hashsz);
2876 uc->dir_flags = get_be32(next + ouc_offset(dir_flags));
2877 exclude_per_dir = (const char *)next + exclude_per_dir_offset;
2878 uc->exclude_per_dir = xstrdup(exclude_per_dir);
2879 /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
2880 next += exclude_per_dir_offset + strlen(exclude_per_dir) + 1;
2884 len = decode_varint(&next);
2885 if (next > end || len == 0)
2888 rd.valid = ewah_new();
2889 rd.check_only = ewah_new();
2890 rd.sha1_valid = ewah_new();
2894 ALLOC_ARRAY(rd.ucd, len);
2896 if (read_one_dir(&uc->root, &rd) || rd.index != len)
2900 len = ewah_read_mmap(rd.valid, next, end - next);
2905 len = ewah_read_mmap(rd.check_only, next, end - next);
2910 len = ewah_read_mmap(rd.sha1_valid, next, end - next);
2914 ewah_each_bit(rd.check_only, set_check_only, &rd);
2915 rd.data = next + len;
2916 ewah_each_bit(rd.valid, read_stat, &rd);
2917 ewah_each_bit(rd.sha1_valid, read_oid, &rd);
2922 ewah_free(rd.valid);
2923 ewah_free(rd.check_only);
2924 ewah_free(rd.sha1_valid);
2927 free_untracked_cache(uc);
2933 static void invalidate_one_directory(struct untracked_cache *uc,
2934 struct untracked_cache_dir *ucd)
2936 uc->dir_invalidated++;
2938 ucd->untracked_nr = 0;
2942 * Normally when an entry is added or removed from a directory,
2943 * invalidating that directory is enough. No need to touch its
2944 * ancestors. When a directory is shown as "foo/bar/" in git-status
2945 * however, deleting or adding an entry may have cascading effect.
2947 * Say the "foo/bar/file" has become untracked, we need to tell the
2948 * untracked_cache_dir of "foo" that "bar/" is not an untracked
2949 * directory any more (because "bar" is managed by foo as an untracked
2952 * Similarly, if "foo/bar/file" moves from untracked to tracked and it
2953 * was the last untracked entry in the entire "foo", we should show
2954 * "foo/" instead. Which means we have to invalidate past "bar" up to
2957 * This function traverses all directories from root to leaf. If there
2958 * is a chance of one of the above cases happening, we invalidate back
2959 * to root. Otherwise we just invalidate the leaf. There may be a more
2960 * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
2961 * detect these cases and avoid unnecessary invalidation, for example,
2962 * checking for the untracked entry named "bar/" in "foo", but for now
2963 * stick to something safe and simple.
2965 static int invalidate_one_component(struct untracked_cache *uc,
2966 struct untracked_cache_dir *dir,
2967 const char *path, int len)
2969 const char *rest = strchr(path, '/');
2972 int component_len = rest - path;
2973 struct untracked_cache_dir *d =
2974 lookup_untracked(uc, dir, path, component_len);
2976 invalidate_one_component(uc, d, rest + 1,
2977 len - (component_len + 1));
2979 invalidate_one_directory(uc, dir);
2983 invalidate_one_directory(uc, dir);
2984 return uc->dir_flags & DIR_SHOW_OTHER_DIRECTORIES;
2987 void untracked_cache_invalidate_path(struct index_state *istate,
2988 const char *path, int safe_path)
2990 if (!istate->untracked || !istate->untracked->root)
2992 if (!safe_path && !verify_path(path, 0))
2994 invalidate_one_component(istate->untracked, istate->untracked->root,
2995 path, strlen(path));
2998 void untracked_cache_remove_from_index(struct index_state *istate,
3001 untracked_cache_invalidate_path(istate, path, 1);
3004 void untracked_cache_add_to_index(struct index_state *istate,
3007 untracked_cache_invalidate_path(istate, path, 1);
3010 static void connect_wt_gitdir_in_nested(const char *sub_worktree,
3011 const char *sub_gitdir)
3014 struct repository subrepo;
3015 struct strbuf sub_wt = STRBUF_INIT;
3016 struct strbuf sub_gd = STRBUF_INIT;
3018 const struct submodule *sub;
3020 /* If the submodule has no working tree, we can ignore it. */
3021 if (repo_init(&subrepo, sub_gitdir, sub_worktree))
3024 if (repo_read_index(&subrepo) < 0)
3025 die(_("index file corrupt in repo %s"), subrepo.gitdir);
3027 for (i = 0; i < subrepo.index->cache_nr; i++) {
3028 const struct cache_entry *ce = subrepo.index->cache[i];
3030 if (!S_ISGITLINK(ce->ce_mode))
3033 while (i + 1 < subrepo.index->cache_nr &&
3034 !strcmp(ce->name, subrepo.index->cache[i + 1]->name))
3036 * Skip entries with the same name in different stages
3037 * to make sure an entry is returned only once.
3041 sub = submodule_from_path(&subrepo, &null_oid, ce->name);
3042 if (!sub || !is_submodule_active(&subrepo, ce->name))
3043 /* .gitmodules broken or inactive sub */
3046 strbuf_reset(&sub_wt);
3047 strbuf_reset(&sub_gd);
3048 strbuf_addf(&sub_wt, "%s/%s", sub_worktree, sub->path);
3049 strbuf_addf(&sub_gd, "%s/modules/%s", sub_gitdir, sub->name);
3051 connect_work_tree_and_git_dir(sub_wt.buf, sub_gd.buf, 1);
3053 strbuf_release(&sub_wt);
3054 strbuf_release(&sub_gd);
3055 repo_clear(&subrepo);
3058 void connect_work_tree_and_git_dir(const char *work_tree_,
3059 const char *git_dir_,
3060 int recurse_into_nested)
3062 struct strbuf gitfile_sb = STRBUF_INIT;
3063 struct strbuf cfg_sb = STRBUF_INIT;
3064 struct strbuf rel_path = STRBUF_INIT;
3065 char *git_dir, *work_tree;
3067 /* Prepare .git file */
3068 strbuf_addf(&gitfile_sb, "%s/.git", work_tree_);
3069 if (safe_create_leading_directories_const(gitfile_sb.buf))
3070 die(_("could not create directories for %s"), gitfile_sb.buf);
3072 /* Prepare config file */
3073 strbuf_addf(&cfg_sb, "%s/config", git_dir_);
3074 if (safe_create_leading_directories_const(cfg_sb.buf))
3075 die(_("could not create directories for %s"), cfg_sb.buf);
3077 git_dir = real_pathdup(git_dir_, 1);
3078 work_tree = real_pathdup(work_tree_, 1);
3080 /* Write .git file */
3081 write_file(gitfile_sb.buf, "gitdir: %s",
3082 relative_path(git_dir, work_tree, &rel_path));
3083 /* Update core.worktree setting */
3084 git_config_set_in_file(cfg_sb.buf, "core.worktree",
3085 relative_path(work_tree, git_dir, &rel_path));
3087 strbuf_release(&gitfile_sb);
3088 strbuf_release(&cfg_sb);
3089 strbuf_release(&rel_path);
3091 if (recurse_into_nested)
3092 connect_wt_gitdir_in_nested(work_tree, git_dir);
3099 * Migrate the git directory of the given path from old_git_dir to new_git_dir.
3101 void relocate_gitdir(const char *path, const char *old_git_dir, const char *new_git_dir)
3103 if (rename(old_git_dir, new_git_dir) < 0)
3104 die_errno(_("could not migrate git directory from '%s' to '%s'"),
3105 old_git_dir, new_git_dir);
3107 connect_work_tree_and_git_dir(path, new_git_dir, 0);