t5559: fix test failures with LIB_HTTPD_SSL
[git/debian.git] / dir.c
blobf8a11aa1ec56c2184b8c8d012d9f9b6d833cad56
1 /*
2 * This handles recursive filename detection with exclude
3 * files, index knowledge etc..
5 * Copyright (C) Linus Torvalds, 2005-2006
6 * Junio Hamano, 2005-2006
7 */
8 #include "cache.h"
9 #include "config.h"
10 #include "dir.h"
11 #include "object-store.h"
12 #include "attr.h"
13 #include "refs.h"
14 #include "wildmatch.h"
15 #include "pathspec.h"
16 #include "utf8.h"
17 #include "varint.h"
18 #include "ewah/ewok.h"
19 #include "fsmonitor.h"
20 #include "submodule-config.h"
23 * Tells read_directory_recursive how a file or directory should be treated.
24 * Values are ordered by significance, e.g. if a directory contains both
25 * excluded and untracked files, it is listed as untracked because
26 * path_untracked > path_excluded.
28 enum path_treatment {
29 path_none = 0,
30 path_recurse,
31 path_excluded,
32 path_untracked
36 * Support data structure for our opendir/readdir/closedir wrappers
38 struct cached_dir {
39 DIR *fdir;
40 struct untracked_cache_dir *untracked;
41 int nr_files;
42 int nr_dirs;
44 const char *d_name;
45 int d_type;
46 const char *file;
47 struct untracked_cache_dir *ucd;
50 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
51 struct index_state *istate, const char *path, int len,
52 struct untracked_cache_dir *untracked,
53 int check_only, int stop_at_first_file, const struct pathspec *pathspec);
54 static int resolve_dtype(int dtype, struct index_state *istate,
55 const char *path, int len);
56 struct dirent *readdir_skip_dot_and_dotdot(DIR *dirp)
58 struct dirent *e;
60 while ((e = readdir(dirp)) != NULL) {
61 if (!is_dot_or_dotdot(e->d_name))
62 break;
64 return e;
67 int count_slashes(const char *s)
69 int cnt = 0;
70 while (*s)
71 if (*s++ == '/')
72 cnt++;
73 return cnt;
76 int fspathcmp(const char *a, const char *b)
78 return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
81 int fspatheq(const char *a, const char *b)
83 return !fspathcmp(a, b);
86 int fspathncmp(const char *a, const char *b, size_t count)
88 return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
91 unsigned int fspathhash(const char *str)
93 return ignore_case ? strihash(str) : strhash(str);
96 int git_fnmatch(const struct pathspec_item *item,
97 const char *pattern, const char *string,
98 int prefix)
100 if (prefix > 0) {
101 if (ps_strncmp(item, pattern, string, prefix))
102 return WM_NOMATCH;
103 pattern += prefix;
104 string += prefix;
106 if (item->flags & PATHSPEC_ONESTAR) {
107 int pattern_len = strlen(++pattern);
108 int string_len = strlen(string);
109 return string_len < pattern_len ||
110 ps_strcmp(item, pattern,
111 string + string_len - pattern_len);
113 if (item->magic & PATHSPEC_GLOB)
114 return wildmatch(pattern, string,
115 WM_PATHNAME |
116 (item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0));
117 else
118 /* wildmatch has not learned no FNM_PATHNAME mode yet */
119 return wildmatch(pattern, string,
120 item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0);
123 static int fnmatch_icase_mem(const char *pattern, int patternlen,
124 const char *string, int stringlen,
125 int flags)
127 int match_status;
128 struct strbuf pat_buf = STRBUF_INIT;
129 struct strbuf str_buf = STRBUF_INIT;
130 const char *use_pat = pattern;
131 const char *use_str = string;
133 if (pattern[patternlen]) {
134 strbuf_add(&pat_buf, pattern, patternlen);
135 use_pat = pat_buf.buf;
137 if (string[stringlen]) {
138 strbuf_add(&str_buf, string, stringlen);
139 use_str = str_buf.buf;
142 if (ignore_case)
143 flags |= WM_CASEFOLD;
144 match_status = wildmatch(use_pat, use_str, flags);
146 strbuf_release(&pat_buf);
147 strbuf_release(&str_buf);
149 return match_status;
152 static size_t common_prefix_len(const struct pathspec *pathspec)
154 int n;
155 size_t max = 0;
158 * ":(icase)path" is treated as a pathspec full of
159 * wildcard. In other words, only prefix is considered common
160 * prefix. If the pathspec is abc/foo abc/bar, running in
161 * subdir xyz, the common prefix is still xyz, not xyz/abc as
162 * in non-:(icase).
164 GUARD_PATHSPEC(pathspec,
165 PATHSPEC_FROMTOP |
166 PATHSPEC_MAXDEPTH |
167 PATHSPEC_LITERAL |
168 PATHSPEC_GLOB |
169 PATHSPEC_ICASE |
170 PATHSPEC_EXCLUDE |
171 PATHSPEC_ATTR);
173 for (n = 0; n < pathspec->nr; n++) {
174 size_t i = 0, len = 0, item_len;
175 if (pathspec->items[n].magic & PATHSPEC_EXCLUDE)
176 continue;
177 if (pathspec->items[n].magic & PATHSPEC_ICASE)
178 item_len = pathspec->items[n].prefix;
179 else
180 item_len = pathspec->items[n].nowildcard_len;
181 while (i < item_len && (n == 0 || i < max)) {
182 char c = pathspec->items[n].match[i];
183 if (c != pathspec->items[0].match[i])
184 break;
185 if (c == '/')
186 len = i + 1;
187 i++;
189 if (n == 0 || len < max) {
190 max = len;
191 if (!max)
192 break;
195 return max;
199 * Returns a copy of the longest leading path common among all
200 * pathspecs.
202 char *common_prefix(const struct pathspec *pathspec)
204 unsigned long len = common_prefix_len(pathspec);
206 return len ? xmemdupz(pathspec->items[0].match, len) : NULL;
209 int fill_directory(struct dir_struct *dir,
210 struct index_state *istate,
211 const struct pathspec *pathspec)
213 const char *prefix;
214 size_t prefix_len;
216 unsigned exclusive_flags = DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO;
217 if ((dir->flags & exclusive_flags) == exclusive_flags)
218 BUG("DIR_SHOW_IGNORED and DIR_SHOW_IGNORED_TOO are exclusive");
221 * Calculate common prefix for the pathspec, and
222 * use that to optimize the directory walk
224 prefix_len = common_prefix_len(pathspec);
225 prefix = prefix_len ? pathspec->items[0].match : "";
227 /* Read the directory and prune it */
228 read_directory(dir, istate, prefix, prefix_len, pathspec);
230 return prefix_len;
233 int within_depth(const char *name, int namelen,
234 int depth, int max_depth)
236 const char *cp = name, *cpe = name + namelen;
238 while (cp < cpe) {
239 if (*cp++ != '/')
240 continue;
241 depth++;
242 if (depth > max_depth)
243 return 0;
245 return 1;
249 * Read the contents of the blob with the given OID into a buffer.
250 * Append a trailing LF to the end if the last line doesn't have one.
252 * Returns:
253 * -1 when the OID is invalid or unknown or does not refer to a blob.
254 * 0 when the blob is empty.
255 * 1 along with { data, size } of the (possibly augmented) buffer
256 * when successful.
258 * Optionally updates the given oid_stat with the given OID (when valid).
260 static int do_read_blob(const struct object_id *oid, struct oid_stat *oid_stat,
261 size_t *size_out, char **data_out)
263 enum object_type type;
264 unsigned long sz;
265 char *data;
267 *size_out = 0;
268 *data_out = NULL;
270 data = read_object_file(oid, &type, &sz);
271 if (!data || type != OBJ_BLOB) {
272 free(data);
273 return -1;
276 if (oid_stat) {
277 memset(&oid_stat->stat, 0, sizeof(oid_stat->stat));
278 oidcpy(&oid_stat->oid, oid);
281 if (sz == 0) {
282 free(data);
283 return 0;
286 if (data[sz - 1] != '\n') {
287 data = xrealloc(data, st_add(sz, 1));
288 data[sz++] = '\n';
291 *size_out = xsize_t(sz);
292 *data_out = data;
294 return 1;
297 #define DO_MATCH_EXCLUDE (1<<0)
298 #define DO_MATCH_DIRECTORY (1<<1)
299 #define DO_MATCH_LEADING_PATHSPEC (1<<2)
302 * Does the given pathspec match the given name? A match is found if
304 * (1) the pathspec string is leading directory of 'name' ("RECURSIVELY"), or
305 * (2) the pathspec string has a leading part matching 'name' ("LEADING"), or
306 * (3) the pathspec string is a wildcard and matches 'name' ("WILDCARD"), or
307 * (4) the pathspec string is exactly the same as 'name' ("EXACT").
309 * Return value tells which case it was (1-4), or 0 when there is no match.
311 * It may be instructive to look at a small table of concrete examples
312 * to understand the differences between 1, 2, and 4:
314 * Pathspecs
315 * | a/b | a/b/ | a/b/c
316 * ------+-----------+-----------+------------
317 * a/b | EXACT | EXACT[1] | LEADING[2]
318 * Names a/b/ | RECURSIVE | EXACT | LEADING[2]
319 * a/b/c | RECURSIVE | RECURSIVE | EXACT
321 * [1] Only if DO_MATCH_DIRECTORY is passed; otherwise, this is NOT a match.
322 * [2] Only if DO_MATCH_LEADING_PATHSPEC is passed; otherwise, not a match.
324 static int match_pathspec_item(struct index_state *istate,
325 const struct pathspec_item *item, int prefix,
326 const char *name, int namelen, unsigned flags)
328 /* name/namelen has prefix cut off by caller */
329 const char *match = item->match + prefix;
330 int matchlen = item->len - prefix;
333 * The normal call pattern is:
334 * 1. prefix = common_prefix_len(ps);
335 * 2. prune something, or fill_directory
336 * 3. match_pathspec()
338 * 'prefix' at #1 may be shorter than the command's prefix and
339 * it's ok for #2 to match extra files. Those extras will be
340 * trimmed at #3.
342 * Suppose the pathspec is 'foo' and '../bar' running from
343 * subdir 'xyz'. The common prefix at #1 will be empty, thanks
344 * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
345 * user does not want XYZ/foo, only the "foo" part should be
346 * case-insensitive. We need to filter out XYZ/foo here. In
347 * other words, we do not trust the caller on comparing the
348 * prefix part when :(icase) is involved. We do exact
349 * comparison ourselves.
351 * Normally the caller (common_prefix_len() in fact) does
352 * _exact_ matching on name[-prefix+1..-1] and we do not need
353 * to check that part. Be defensive and check it anyway, in
354 * case common_prefix_len is changed, or a new caller is
355 * introduced that does not use common_prefix_len.
357 * If the penalty turns out too high when prefix is really
358 * long, maybe change it to
359 * strncmp(match, name, item->prefix - prefix)
361 if (item->prefix && (item->magic & PATHSPEC_ICASE) &&
362 strncmp(item->match, name - prefix, item->prefix))
363 return 0;
365 if (item->attr_match_nr &&
366 !match_pathspec_attrs(istate, name, namelen, item))
367 return 0;
369 /* If the match was just the prefix, we matched */
370 if (!*match)
371 return MATCHED_RECURSIVELY;
373 if (matchlen <= namelen && !ps_strncmp(item, match, name, matchlen)) {
374 if (matchlen == namelen)
375 return MATCHED_EXACTLY;
377 if (match[matchlen-1] == '/' || name[matchlen] == '/')
378 return MATCHED_RECURSIVELY;
379 } else if ((flags & DO_MATCH_DIRECTORY) &&
380 match[matchlen - 1] == '/' &&
381 namelen == matchlen - 1 &&
382 !ps_strncmp(item, match, name, namelen))
383 return MATCHED_EXACTLY;
385 if (item->nowildcard_len < item->len &&
386 !git_fnmatch(item, match, name,
387 item->nowildcard_len - prefix))
388 return MATCHED_FNMATCH;
390 /* Perform checks to see if "name" is a leading string of the pathspec */
391 if ( (flags & DO_MATCH_LEADING_PATHSPEC) &&
392 !(flags & DO_MATCH_EXCLUDE)) {
393 /* name is a literal prefix of the pathspec */
394 int offset = name[namelen-1] == '/' ? 1 : 0;
395 if ((namelen < matchlen) &&
396 (match[namelen-offset] == '/') &&
397 !ps_strncmp(item, match, name, namelen))
398 return MATCHED_RECURSIVELY_LEADING_PATHSPEC;
400 /* name doesn't match up to the first wild character */
401 if (item->nowildcard_len < item->len &&
402 ps_strncmp(item, match, name,
403 item->nowildcard_len - prefix))
404 return 0;
407 * name has no wildcard, and it didn't match as a leading
408 * pathspec so return.
410 if (item->nowildcard_len == item->len)
411 return 0;
414 * Here is where we would perform a wildmatch to check if
415 * "name" can be matched as a directory (or a prefix) against
416 * the pathspec. Since wildmatch doesn't have this capability
417 * at the present we have to punt and say that it is a match,
418 * potentially returning a false positive
419 * The submodules themselves will be able to perform more
420 * accurate matching to determine if the pathspec matches.
422 return MATCHED_RECURSIVELY_LEADING_PATHSPEC;
425 return 0;
429 * do_match_pathspec() is meant to ONLY be called by
430 * match_pathspec_with_flags(); calling it directly risks pathspecs
431 * like ':!unwanted_path' being ignored.
433 * Given a name and a list of pathspecs, returns the nature of the
434 * closest (i.e. most specific) match of the name to any of the
435 * pathspecs.
437 * The caller typically calls this multiple times with the same
438 * pathspec and seen[] array but with different name/namelen
439 * (e.g. entries from the index) and is interested in seeing if and
440 * how each pathspec matches all the names it calls this function
441 * with. A mark is left in the seen[] array for each pathspec element
442 * indicating the closest type of match that element achieved, so if
443 * seen[n] remains zero after multiple invocations, that means the nth
444 * pathspec did not match any names, which could indicate that the
445 * user mistyped the nth pathspec.
447 static int do_match_pathspec(struct index_state *istate,
448 const struct pathspec *ps,
449 const char *name, int namelen,
450 int prefix, char *seen,
451 unsigned flags)
453 int i, retval = 0, exclude = flags & DO_MATCH_EXCLUDE;
455 GUARD_PATHSPEC(ps,
456 PATHSPEC_FROMTOP |
457 PATHSPEC_MAXDEPTH |
458 PATHSPEC_LITERAL |
459 PATHSPEC_GLOB |
460 PATHSPEC_ICASE |
461 PATHSPEC_EXCLUDE |
462 PATHSPEC_ATTR);
464 if (!ps->nr) {
465 if (!ps->recursive ||
466 !(ps->magic & PATHSPEC_MAXDEPTH) ||
467 ps->max_depth == -1)
468 return MATCHED_RECURSIVELY;
470 if (within_depth(name, namelen, 0, ps->max_depth))
471 return MATCHED_EXACTLY;
472 else
473 return 0;
476 name += prefix;
477 namelen -= prefix;
479 for (i = ps->nr - 1; i >= 0; i--) {
480 int how;
482 if ((!exclude && ps->items[i].magic & PATHSPEC_EXCLUDE) ||
483 ( exclude && !(ps->items[i].magic & PATHSPEC_EXCLUDE)))
484 continue;
486 if (seen && seen[i] == MATCHED_EXACTLY)
487 continue;
489 * Make exclude patterns optional and never report
490 * "pathspec ':(exclude)foo' matches no files"
492 if (seen && ps->items[i].magic & PATHSPEC_EXCLUDE)
493 seen[i] = MATCHED_FNMATCH;
494 how = match_pathspec_item(istate, ps->items+i, prefix, name,
495 namelen, flags);
496 if (ps->recursive &&
497 (ps->magic & PATHSPEC_MAXDEPTH) &&
498 ps->max_depth != -1 &&
499 how && how != MATCHED_FNMATCH) {
500 int len = ps->items[i].len;
501 if (name[len] == '/')
502 len++;
503 if (within_depth(name+len, namelen-len, 0, ps->max_depth))
504 how = MATCHED_EXACTLY;
505 else
506 how = 0;
508 if (how) {
509 if (retval < how)
510 retval = how;
511 if (seen && seen[i] < how)
512 seen[i] = how;
515 return retval;
518 static int match_pathspec_with_flags(struct index_state *istate,
519 const struct pathspec *ps,
520 const char *name, int namelen,
521 int prefix, char *seen, unsigned flags)
523 int positive, negative;
524 positive = do_match_pathspec(istate, ps, name, namelen,
525 prefix, seen, flags);
526 if (!(ps->magic & PATHSPEC_EXCLUDE) || !positive)
527 return positive;
528 negative = do_match_pathspec(istate, ps, name, namelen,
529 prefix, seen,
530 flags | DO_MATCH_EXCLUDE);
531 return negative ? 0 : positive;
534 int match_pathspec(struct index_state *istate,
535 const struct pathspec *ps,
536 const char *name, int namelen,
537 int prefix, char *seen, int is_dir)
539 unsigned flags = is_dir ? DO_MATCH_DIRECTORY : 0;
540 return match_pathspec_with_flags(istate, ps, name, namelen,
541 prefix, seen, flags);
545 * Check if a submodule is a superset of the pathspec
547 int submodule_path_match(struct index_state *istate,
548 const struct pathspec *ps,
549 const char *submodule_name,
550 char *seen)
552 int matched = match_pathspec_with_flags(istate, ps, submodule_name,
553 strlen(submodule_name),
554 0, seen,
555 DO_MATCH_DIRECTORY |
556 DO_MATCH_LEADING_PATHSPEC);
557 return matched;
560 int report_path_error(const char *ps_matched,
561 const struct pathspec *pathspec)
564 * Make sure all pathspec matched; otherwise it is an error.
566 int num, errors = 0;
567 for (num = 0; num < pathspec->nr; num++) {
568 int other, found_dup;
570 if (ps_matched[num])
571 continue;
573 * The caller might have fed identical pathspec
574 * twice. Do not barf on such a mistake.
575 * FIXME: parse_pathspec should have eliminated
576 * duplicate pathspec.
578 for (found_dup = other = 0;
579 !found_dup && other < pathspec->nr;
580 other++) {
581 if (other == num || !ps_matched[other])
582 continue;
583 if (!strcmp(pathspec->items[other].original,
584 pathspec->items[num].original))
586 * Ok, we have a match already.
588 found_dup = 1;
590 if (found_dup)
591 continue;
593 error(_("pathspec '%s' did not match any file(s) known to git"),
594 pathspec->items[num].original);
595 errors++;
597 return errors;
601 * Return the length of the "simple" part of a path match limiter.
603 int simple_length(const char *match)
605 int len = -1;
607 for (;;) {
608 unsigned char c = *match++;
609 len++;
610 if (c == '\0' || is_glob_special(c))
611 return len;
615 int no_wildcard(const char *string)
617 return string[simple_length(string)] == '\0';
620 void parse_path_pattern(const char **pattern,
621 int *patternlen,
622 unsigned *flags,
623 int *nowildcardlen)
625 const char *p = *pattern;
626 size_t i, len;
628 *flags = 0;
629 if (*p == '!') {
630 *flags |= PATTERN_FLAG_NEGATIVE;
631 p++;
633 len = strlen(p);
634 if (len && p[len - 1] == '/') {
635 len--;
636 *flags |= PATTERN_FLAG_MUSTBEDIR;
638 for (i = 0; i < len; i++) {
639 if (p[i] == '/')
640 break;
642 if (i == len)
643 *flags |= PATTERN_FLAG_NODIR;
644 *nowildcardlen = simple_length(p);
646 * we should have excluded the trailing slash from 'p' too,
647 * but that's one more allocation. Instead just make sure
648 * nowildcardlen does not exceed real patternlen
650 if (*nowildcardlen > len)
651 *nowildcardlen = len;
652 if (*p == '*' && no_wildcard(p + 1))
653 *flags |= PATTERN_FLAG_ENDSWITH;
654 *pattern = p;
655 *patternlen = len;
658 int pl_hashmap_cmp(const void *cmp_data UNUSED,
659 const struct hashmap_entry *a,
660 const struct hashmap_entry *b,
661 const void *key UNUSED)
663 const struct pattern_entry *ee1 =
664 container_of(a, struct pattern_entry, ent);
665 const struct pattern_entry *ee2 =
666 container_of(b, struct pattern_entry, ent);
668 size_t min_len = ee1->patternlen <= ee2->patternlen
669 ? ee1->patternlen
670 : ee2->patternlen;
672 return fspathncmp(ee1->pattern, ee2->pattern, min_len);
675 static char *dup_and_filter_pattern(const char *pattern)
677 char *set, *read;
678 size_t count = 0;
679 char *result = xstrdup(pattern);
681 set = result;
682 read = result;
684 while (*read) {
685 /* skip escape characters (once) */
686 if (*read == '\\')
687 read++;
689 *set = *read;
691 set++;
692 read++;
693 count++;
695 *set = 0;
697 if (count > 2 &&
698 *(set - 1) == '*' &&
699 *(set - 2) == '/')
700 *(set - 2) = 0;
702 return result;
705 static void add_pattern_to_hashsets(struct pattern_list *pl, struct path_pattern *given)
707 struct pattern_entry *translated;
708 char *truncated;
709 char *data = NULL;
710 const char *prev, *cur, *next;
712 if (!pl->use_cone_patterns)
713 return;
715 if (given->flags & PATTERN_FLAG_NEGATIVE &&
716 given->flags & PATTERN_FLAG_MUSTBEDIR &&
717 !strcmp(given->pattern, "/*")) {
718 pl->full_cone = 0;
719 return;
722 if (!given->flags && !strcmp(given->pattern, "/*")) {
723 pl->full_cone = 1;
724 return;
727 if (given->patternlen < 2 ||
728 *given->pattern != '/' ||
729 strstr(given->pattern, "**")) {
730 /* Not a cone pattern. */
731 warning(_("unrecognized pattern: '%s'"), given->pattern);
732 goto clear_hashmaps;
735 if (!(given->flags & PATTERN_FLAG_MUSTBEDIR) &&
736 strcmp(given->pattern, "/*")) {
737 /* Not a cone pattern. */
738 warning(_("unrecognized pattern: '%s'"), given->pattern);
739 goto clear_hashmaps;
742 prev = given->pattern;
743 cur = given->pattern + 1;
744 next = given->pattern + 2;
746 while (*cur) {
747 /* Watch for glob characters '*', '\', '[', '?' */
748 if (!is_glob_special(*cur))
749 goto increment;
751 /* But only if *prev != '\\' */
752 if (*prev == '\\')
753 goto increment;
755 /* But allow the initial '\' */
756 if (*cur == '\\' &&
757 is_glob_special(*next))
758 goto increment;
760 /* But a trailing '/' then '*' is fine */
761 if (*prev == '/' &&
762 *cur == '*' &&
763 *next == 0)
764 goto increment;
766 /* Not a cone pattern. */
767 warning(_("unrecognized pattern: '%s'"), given->pattern);
768 goto clear_hashmaps;
770 increment:
771 prev++;
772 cur++;
773 next++;
776 if (given->patternlen > 2 &&
777 !strcmp(given->pattern + given->patternlen - 2, "/*")) {
778 if (!(given->flags & PATTERN_FLAG_NEGATIVE)) {
779 /* Not a cone pattern. */
780 warning(_("unrecognized pattern: '%s'"), given->pattern);
781 goto clear_hashmaps;
784 truncated = dup_and_filter_pattern(given->pattern);
786 translated = xmalloc(sizeof(struct pattern_entry));
787 translated->pattern = truncated;
788 translated->patternlen = given->patternlen - 2;
789 hashmap_entry_init(&translated->ent,
790 fspathhash(translated->pattern));
792 if (!hashmap_get_entry(&pl->recursive_hashmap,
793 translated, ent, NULL)) {
794 /* We did not see the "parent" included */
795 warning(_("unrecognized negative pattern: '%s'"),
796 given->pattern);
797 free(truncated);
798 free(translated);
799 goto clear_hashmaps;
802 hashmap_add(&pl->parent_hashmap, &translated->ent);
803 hashmap_remove(&pl->recursive_hashmap, &translated->ent, &data);
804 free(data);
805 return;
808 if (given->flags & PATTERN_FLAG_NEGATIVE) {
809 warning(_("unrecognized negative pattern: '%s'"),
810 given->pattern);
811 goto clear_hashmaps;
814 translated = xmalloc(sizeof(struct pattern_entry));
816 translated->pattern = dup_and_filter_pattern(given->pattern);
817 translated->patternlen = given->patternlen;
818 hashmap_entry_init(&translated->ent,
819 fspathhash(translated->pattern));
821 hashmap_add(&pl->recursive_hashmap, &translated->ent);
823 if (hashmap_get_entry(&pl->parent_hashmap, translated, ent, NULL)) {
824 /* we already included this at the parent level */
825 warning(_("your sparse-checkout file may have issues: pattern '%s' is repeated"),
826 given->pattern);
827 goto clear_hashmaps;
830 return;
832 clear_hashmaps:
833 warning(_("disabling cone pattern matching"));
834 hashmap_clear_and_free(&pl->parent_hashmap, struct pattern_entry, ent);
835 hashmap_clear_and_free(&pl->recursive_hashmap, struct pattern_entry, ent);
836 pl->use_cone_patterns = 0;
839 static int hashmap_contains_path(struct hashmap *map,
840 struct strbuf *pattern)
842 struct pattern_entry p;
844 /* Check straight mapping */
845 p.pattern = pattern->buf;
846 p.patternlen = pattern->len;
847 hashmap_entry_init(&p.ent, fspathhash(p.pattern));
848 return !!hashmap_get_entry(map, &p, ent, NULL);
851 int hashmap_contains_parent(struct hashmap *map,
852 const char *path,
853 struct strbuf *buffer)
855 char *slash_pos;
857 strbuf_setlen(buffer, 0);
859 if (path[0] != '/')
860 strbuf_addch(buffer, '/');
862 strbuf_addstr(buffer, path);
864 slash_pos = strrchr(buffer->buf, '/');
866 while (slash_pos > buffer->buf) {
867 strbuf_setlen(buffer, slash_pos - buffer->buf);
869 if (hashmap_contains_path(map, buffer))
870 return 1;
872 slash_pos = strrchr(buffer->buf, '/');
875 return 0;
878 void add_pattern(const char *string, const char *base,
879 int baselen, struct pattern_list *pl, int srcpos)
881 struct path_pattern *pattern;
882 int patternlen;
883 unsigned flags;
884 int nowildcardlen;
886 parse_path_pattern(&string, &patternlen, &flags, &nowildcardlen);
887 if (flags & PATTERN_FLAG_MUSTBEDIR) {
888 FLEXPTR_ALLOC_MEM(pattern, pattern, string, patternlen);
889 } else {
890 pattern = xmalloc(sizeof(*pattern));
891 pattern->pattern = string;
893 pattern->patternlen = patternlen;
894 pattern->nowildcardlen = nowildcardlen;
895 pattern->base = base;
896 pattern->baselen = baselen;
897 pattern->flags = flags;
898 pattern->srcpos = srcpos;
899 ALLOC_GROW(pl->patterns, pl->nr + 1, pl->alloc);
900 pl->patterns[pl->nr++] = pattern;
901 pattern->pl = pl;
903 add_pattern_to_hashsets(pl, pattern);
906 static int read_skip_worktree_file_from_index(struct index_state *istate,
907 const char *path,
908 size_t *size_out, char **data_out,
909 struct oid_stat *oid_stat)
911 int pos, len;
913 len = strlen(path);
914 pos = index_name_pos(istate, path, len);
915 if (pos < 0)
916 return -1;
917 if (!ce_skip_worktree(istate->cache[pos]))
918 return -1;
920 return do_read_blob(&istate->cache[pos]->oid, oid_stat, size_out, data_out);
924 * Frees memory within pl which was allocated for exclude patterns and
925 * the file buffer. Does not free pl itself.
927 void clear_pattern_list(struct pattern_list *pl)
929 int i;
931 for (i = 0; i < pl->nr; i++)
932 free(pl->patterns[i]);
933 free(pl->patterns);
934 free(pl->filebuf);
935 hashmap_clear_and_free(&pl->recursive_hashmap, struct pattern_entry, ent);
936 hashmap_clear_and_free(&pl->parent_hashmap, struct pattern_entry, ent);
938 memset(pl, 0, sizeof(*pl));
941 static void trim_trailing_spaces(char *buf)
943 char *p, *last_space = NULL;
945 for (p = buf; *p; p++)
946 switch (*p) {
947 case ' ':
948 if (!last_space)
949 last_space = p;
950 break;
951 case '\\':
952 p++;
953 if (!*p)
954 return;
955 /* fallthrough */
956 default:
957 last_space = NULL;
960 if (last_space)
961 *last_space = '\0';
965 * Given a subdirectory name and "dir" of the current directory,
966 * search the subdir in "dir" and return it, or create a new one if it
967 * does not exist in "dir".
969 * If "name" has the trailing slash, it'll be excluded in the search.
971 static struct untracked_cache_dir *lookup_untracked(struct untracked_cache *uc,
972 struct untracked_cache_dir *dir,
973 const char *name, int len)
975 int first, last;
976 struct untracked_cache_dir *d;
977 if (!dir)
978 return NULL;
979 if (len && name[len - 1] == '/')
980 len--;
981 first = 0;
982 last = dir->dirs_nr;
983 while (last > first) {
984 int cmp, next = first + ((last - first) >> 1);
985 d = dir->dirs[next];
986 cmp = strncmp(name, d->name, len);
987 if (!cmp && strlen(d->name) > len)
988 cmp = -1;
989 if (!cmp)
990 return d;
991 if (cmp < 0) {
992 last = next;
993 continue;
995 first = next+1;
998 uc->dir_created++;
999 FLEX_ALLOC_MEM(d, name, name, len);
1001 ALLOC_GROW(dir->dirs, dir->dirs_nr + 1, dir->dirs_alloc);
1002 MOVE_ARRAY(dir->dirs + first + 1, dir->dirs + first,
1003 dir->dirs_nr - first);
1004 dir->dirs_nr++;
1005 dir->dirs[first] = d;
1006 return d;
1009 static void do_invalidate_gitignore(struct untracked_cache_dir *dir)
1011 int i;
1012 dir->valid = 0;
1013 dir->untracked_nr = 0;
1014 for (i = 0; i < dir->dirs_nr; i++)
1015 do_invalidate_gitignore(dir->dirs[i]);
1018 static void invalidate_gitignore(struct untracked_cache *uc,
1019 struct untracked_cache_dir *dir)
1021 uc->gitignore_invalidated++;
1022 do_invalidate_gitignore(dir);
1025 static void invalidate_directory(struct untracked_cache *uc,
1026 struct untracked_cache_dir *dir)
1028 int i;
1031 * Invalidation increment here is just roughly correct. If
1032 * untracked_nr or any of dirs[].recurse is non-zero, we
1033 * should increment dir_invalidated too. But that's more
1034 * expensive to do.
1036 if (dir->valid)
1037 uc->dir_invalidated++;
1039 dir->valid = 0;
1040 dir->untracked_nr = 0;
1041 for (i = 0; i < dir->dirs_nr; i++)
1042 dir->dirs[i]->recurse = 0;
1045 static int add_patterns_from_buffer(char *buf, size_t size,
1046 const char *base, int baselen,
1047 struct pattern_list *pl);
1049 /* Flags for add_patterns() */
1050 #define PATTERN_NOFOLLOW (1<<0)
1053 * Given a file with name "fname", read it (either from disk, or from
1054 * an index if 'istate' is non-null), parse it and store the
1055 * exclude rules in "pl".
1057 * If "oid_stat" is not NULL, compute oid of the exclude file and fill
1058 * stat data from disk (only valid if add_patterns returns zero). If
1059 * oid_stat.valid is non-zero, "oid_stat" must contain good value as input.
1061 static int add_patterns(const char *fname, const char *base, int baselen,
1062 struct pattern_list *pl, struct index_state *istate,
1063 unsigned flags, struct oid_stat *oid_stat)
1065 struct stat st;
1066 int r;
1067 int fd;
1068 size_t size = 0;
1069 char *buf;
1071 if (flags & PATTERN_NOFOLLOW)
1072 fd = open_nofollow(fname, O_RDONLY);
1073 else
1074 fd = open(fname, O_RDONLY);
1076 if (fd < 0 || fstat(fd, &st) < 0) {
1077 if (fd < 0)
1078 warn_on_fopen_errors(fname);
1079 else
1080 close(fd);
1081 if (!istate)
1082 return -1;
1083 r = read_skip_worktree_file_from_index(istate, fname,
1084 &size, &buf,
1085 oid_stat);
1086 if (r != 1)
1087 return r;
1088 } else {
1089 size = xsize_t(st.st_size);
1090 if (size == 0) {
1091 if (oid_stat) {
1092 fill_stat_data(&oid_stat->stat, &st);
1093 oidcpy(&oid_stat->oid, the_hash_algo->empty_blob);
1094 oid_stat->valid = 1;
1096 close(fd);
1097 return 0;
1099 buf = xmallocz(size);
1100 if (read_in_full(fd, buf, size) != size) {
1101 free(buf);
1102 close(fd);
1103 return -1;
1105 buf[size++] = '\n';
1106 close(fd);
1107 if (oid_stat) {
1108 int pos;
1109 if (oid_stat->valid &&
1110 !match_stat_data_racy(istate, &oid_stat->stat, &st))
1111 ; /* no content change, oid_stat->oid still good */
1112 else if (istate &&
1113 (pos = index_name_pos(istate, fname, strlen(fname))) >= 0 &&
1114 !ce_stage(istate->cache[pos]) &&
1115 ce_uptodate(istate->cache[pos]) &&
1116 !would_convert_to_git(istate, fname))
1117 oidcpy(&oid_stat->oid,
1118 &istate->cache[pos]->oid);
1119 else
1120 hash_object_file(the_hash_algo, buf, size,
1121 OBJ_BLOB, &oid_stat->oid);
1122 fill_stat_data(&oid_stat->stat, &st);
1123 oid_stat->valid = 1;
1127 add_patterns_from_buffer(buf, size, base, baselen, pl);
1128 return 0;
1131 static int add_patterns_from_buffer(char *buf, size_t size,
1132 const char *base, int baselen,
1133 struct pattern_list *pl)
1135 int i, lineno = 1;
1136 char *entry;
1138 hashmap_init(&pl->recursive_hashmap, pl_hashmap_cmp, NULL, 0);
1139 hashmap_init(&pl->parent_hashmap, pl_hashmap_cmp, NULL, 0);
1141 pl->filebuf = buf;
1143 if (skip_utf8_bom(&buf, size))
1144 size -= buf - pl->filebuf;
1146 entry = buf;
1148 for (i = 0; i < size; i++) {
1149 if (buf[i] == '\n') {
1150 if (entry != buf + i && entry[0] != '#') {
1151 buf[i - (i && buf[i-1] == '\r')] = 0;
1152 trim_trailing_spaces(entry);
1153 add_pattern(entry, base, baselen, pl, lineno);
1155 lineno++;
1156 entry = buf + i + 1;
1159 return 0;
1162 int add_patterns_from_file_to_list(const char *fname, const char *base,
1163 int baselen, struct pattern_list *pl,
1164 struct index_state *istate,
1165 unsigned flags)
1167 return add_patterns(fname, base, baselen, pl, istate, flags, NULL);
1170 int add_patterns_from_blob_to_list(
1171 struct object_id *oid,
1172 const char *base, int baselen,
1173 struct pattern_list *pl)
1175 char *buf;
1176 size_t size;
1177 int r;
1179 r = do_read_blob(oid, NULL, &size, &buf);
1180 if (r != 1)
1181 return r;
1183 add_patterns_from_buffer(buf, size, base, baselen, pl);
1184 return 0;
1187 struct pattern_list *add_pattern_list(struct dir_struct *dir,
1188 int group_type, const char *src)
1190 struct pattern_list *pl;
1191 struct exclude_list_group *group;
1193 group = &dir->exclude_list_group[group_type];
1194 ALLOC_GROW(group->pl, group->nr + 1, group->alloc);
1195 pl = &group->pl[group->nr++];
1196 memset(pl, 0, sizeof(*pl));
1197 pl->src = src;
1198 return pl;
1202 * Used to set up core.excludesfile and .git/info/exclude lists.
1204 static void add_patterns_from_file_1(struct dir_struct *dir, const char *fname,
1205 struct oid_stat *oid_stat)
1207 struct pattern_list *pl;
1209 * catch setup_standard_excludes() that's called before
1210 * dir->untracked is assigned. That function behaves
1211 * differently when dir->untracked is non-NULL.
1213 if (!dir->untracked)
1214 dir->unmanaged_exclude_files++;
1215 pl = add_pattern_list(dir, EXC_FILE, fname);
1216 if (add_patterns(fname, "", 0, pl, NULL, 0, oid_stat) < 0)
1217 die(_("cannot use %s as an exclude file"), fname);
1220 void add_patterns_from_file(struct dir_struct *dir, const char *fname)
1222 dir->unmanaged_exclude_files++; /* see validate_untracked_cache() */
1223 add_patterns_from_file_1(dir, fname, NULL);
1226 int match_basename(const char *basename, int basenamelen,
1227 const char *pattern, int prefix, int patternlen,
1228 unsigned flags)
1230 if (prefix == patternlen) {
1231 if (patternlen == basenamelen &&
1232 !fspathncmp(pattern, basename, basenamelen))
1233 return 1;
1234 } else if (flags & PATTERN_FLAG_ENDSWITH) {
1235 /* "*literal" matching against "fooliteral" */
1236 if (patternlen - 1 <= basenamelen &&
1237 !fspathncmp(pattern + 1,
1238 basename + basenamelen - (patternlen - 1),
1239 patternlen - 1))
1240 return 1;
1241 } else {
1242 if (fnmatch_icase_mem(pattern, patternlen,
1243 basename, basenamelen,
1244 0) == 0)
1245 return 1;
1247 return 0;
1250 int match_pathname(const char *pathname, int pathlen,
1251 const char *base, int baselen,
1252 const char *pattern, int prefix, int patternlen)
1254 const char *name;
1255 int namelen;
1258 * match with FNM_PATHNAME; the pattern has base implicitly
1259 * in front of it.
1261 if (*pattern == '/') {
1262 pattern++;
1263 patternlen--;
1264 prefix--;
1268 * baselen does not count the trailing slash. base[] may or
1269 * may not end with a trailing slash though.
1271 if (pathlen < baselen + 1 ||
1272 (baselen && pathname[baselen] != '/') ||
1273 fspathncmp(pathname, base, baselen))
1274 return 0;
1276 namelen = baselen ? pathlen - baselen - 1 : pathlen;
1277 name = pathname + pathlen - namelen;
1279 if (prefix) {
1281 * if the non-wildcard part is longer than the
1282 * remaining pathname, surely it cannot match.
1284 if (prefix > namelen)
1285 return 0;
1287 if (fspathncmp(pattern, name, prefix))
1288 return 0;
1289 pattern += prefix;
1290 patternlen -= prefix;
1291 name += prefix;
1292 namelen -= prefix;
1295 * If the whole pattern did not have a wildcard,
1296 * then our prefix match is all we need; we
1297 * do not need to call fnmatch at all.
1299 if (!patternlen && !namelen)
1300 return 1;
1303 return fnmatch_icase_mem(pattern, patternlen,
1304 name, namelen,
1305 WM_PATHNAME) == 0;
1309 * Scan the given exclude list in reverse to see whether pathname
1310 * should be ignored. The first match (i.e. the last on the list), if
1311 * any, determines the fate. Returns the exclude_list element which
1312 * matched, or NULL for undecided.
1314 static struct path_pattern *last_matching_pattern_from_list(const char *pathname,
1315 int pathlen,
1316 const char *basename,
1317 int *dtype,
1318 struct pattern_list *pl,
1319 struct index_state *istate)
1321 struct path_pattern *res = NULL; /* undecided */
1322 int i;
1324 if (!pl->nr)
1325 return NULL; /* undefined */
1327 for (i = pl->nr - 1; 0 <= i; i--) {
1328 struct path_pattern *pattern = pl->patterns[i];
1329 const char *exclude = pattern->pattern;
1330 int prefix = pattern->nowildcardlen;
1332 if (pattern->flags & PATTERN_FLAG_MUSTBEDIR) {
1333 *dtype = resolve_dtype(*dtype, istate, pathname, pathlen);
1334 if (*dtype != DT_DIR)
1335 continue;
1338 if (pattern->flags & PATTERN_FLAG_NODIR) {
1339 if (match_basename(basename,
1340 pathlen - (basename - pathname),
1341 exclude, prefix, pattern->patternlen,
1342 pattern->flags)) {
1343 res = pattern;
1344 break;
1346 continue;
1349 assert(pattern->baselen == 0 ||
1350 pattern->base[pattern->baselen - 1] == '/');
1351 if (match_pathname(pathname, pathlen,
1352 pattern->base,
1353 pattern->baselen ? pattern->baselen - 1 : 0,
1354 exclude, prefix, pattern->patternlen)) {
1355 res = pattern;
1356 break;
1359 return res;
1363 * Scan the list of patterns to determine if the ordered list
1364 * of patterns matches on 'pathname'.
1366 * Return 1 for a match, 0 for not matched and -1 for undecided.
1368 enum pattern_match_result path_matches_pattern_list(
1369 const char *pathname, int pathlen,
1370 const char *basename, int *dtype,
1371 struct pattern_list *pl,
1372 struct index_state *istate)
1374 struct path_pattern *pattern;
1375 struct strbuf parent_pathname = STRBUF_INIT;
1376 int result = NOT_MATCHED;
1377 size_t slash_pos;
1379 if (!pl->use_cone_patterns) {
1380 pattern = last_matching_pattern_from_list(pathname, pathlen, basename,
1381 dtype, pl, istate);
1382 if (pattern) {
1383 if (pattern->flags & PATTERN_FLAG_NEGATIVE)
1384 return NOT_MATCHED;
1385 else
1386 return MATCHED;
1389 return UNDECIDED;
1392 if (pl->full_cone)
1393 return MATCHED;
1395 strbuf_addch(&parent_pathname, '/');
1396 strbuf_add(&parent_pathname, pathname, pathlen);
1399 * Directory entries are matched if and only if a file
1400 * contained immediately within them is matched. For the
1401 * case of a directory entry, modify the path to create
1402 * a fake filename within this directory, allowing us to
1403 * use the file-base matching logic in an equivalent way.
1405 if (parent_pathname.len > 0 &&
1406 parent_pathname.buf[parent_pathname.len - 1] == '/') {
1407 slash_pos = parent_pathname.len - 1;
1408 strbuf_add(&parent_pathname, "-", 1);
1409 } else {
1410 const char *slash_ptr = strrchr(parent_pathname.buf, '/');
1411 slash_pos = slash_ptr ? slash_ptr - parent_pathname.buf : 0;
1414 if (hashmap_contains_path(&pl->recursive_hashmap,
1415 &parent_pathname)) {
1416 result = MATCHED_RECURSIVE;
1417 goto done;
1420 if (!slash_pos) {
1421 /* include every file in root */
1422 result = MATCHED;
1423 goto done;
1426 strbuf_setlen(&parent_pathname, slash_pos);
1428 if (hashmap_contains_path(&pl->parent_hashmap, &parent_pathname)) {
1429 result = MATCHED;
1430 goto done;
1433 if (hashmap_contains_parent(&pl->recursive_hashmap,
1434 pathname,
1435 &parent_pathname))
1436 result = MATCHED_RECURSIVE;
1438 done:
1439 strbuf_release(&parent_pathname);
1440 return result;
1443 int init_sparse_checkout_patterns(struct index_state *istate)
1445 if (!core_apply_sparse_checkout)
1446 return 1;
1447 if (istate->sparse_checkout_patterns)
1448 return 0;
1450 CALLOC_ARRAY(istate->sparse_checkout_patterns, 1);
1452 if (get_sparse_checkout_patterns(istate->sparse_checkout_patterns) < 0) {
1453 FREE_AND_NULL(istate->sparse_checkout_patterns);
1454 return -1;
1457 return 0;
1460 static int path_in_sparse_checkout_1(const char *path,
1461 struct index_state *istate,
1462 int require_cone_mode)
1464 int dtype = DT_REG;
1465 enum pattern_match_result match = UNDECIDED;
1466 const char *end, *slash;
1469 * We default to accepting a path if the path is empty, there are no
1470 * patterns, or the patterns are of the wrong type.
1472 if (!*path ||
1473 init_sparse_checkout_patterns(istate) ||
1474 (require_cone_mode &&
1475 !istate->sparse_checkout_patterns->use_cone_patterns))
1476 return 1;
1479 * If UNDECIDED, use the match from the parent dir (recursively), or
1480 * fall back to NOT_MATCHED at the topmost level. Note that cone mode
1481 * never returns UNDECIDED, so we will execute only one iteration in
1482 * this case.
1484 for (end = path + strlen(path);
1485 end > path && match == UNDECIDED;
1486 end = slash) {
1488 for (slash = end - 1; slash > path && *slash != '/'; slash--)
1489 ; /* do nothing */
1491 match = path_matches_pattern_list(path, end - path,
1492 slash > path ? slash + 1 : path, &dtype,
1493 istate->sparse_checkout_patterns, istate);
1495 /* We are going to match the parent dir now */
1496 dtype = DT_DIR;
1498 return match > 0;
1501 int path_in_sparse_checkout(const char *path,
1502 struct index_state *istate)
1504 return path_in_sparse_checkout_1(path, istate, 0);
1507 int path_in_cone_mode_sparse_checkout(const char *path,
1508 struct index_state *istate)
1510 return path_in_sparse_checkout_1(path, istate, 1);
1513 static struct path_pattern *last_matching_pattern_from_lists(
1514 struct dir_struct *dir, struct index_state *istate,
1515 const char *pathname, int pathlen,
1516 const char *basename, int *dtype_p)
1518 int i, j;
1519 struct exclude_list_group *group;
1520 struct path_pattern *pattern;
1521 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1522 group = &dir->exclude_list_group[i];
1523 for (j = group->nr - 1; j >= 0; j--) {
1524 pattern = last_matching_pattern_from_list(
1525 pathname, pathlen, basename, dtype_p,
1526 &group->pl[j], istate);
1527 if (pattern)
1528 return pattern;
1531 return NULL;
1535 * Loads the per-directory exclude list for the substring of base
1536 * which has a char length of baselen.
1538 static void prep_exclude(struct dir_struct *dir,
1539 struct index_state *istate,
1540 const char *base, int baselen)
1542 struct exclude_list_group *group;
1543 struct pattern_list *pl;
1544 struct exclude_stack *stk = NULL;
1545 struct untracked_cache_dir *untracked;
1546 int current;
1548 group = &dir->exclude_list_group[EXC_DIRS];
1551 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
1552 * which originate from directories not in the prefix of the
1553 * path being checked.
1555 while ((stk = dir->exclude_stack) != NULL) {
1556 if (stk->baselen <= baselen &&
1557 !strncmp(dir->basebuf.buf, base, stk->baselen))
1558 break;
1559 pl = &group->pl[dir->exclude_stack->exclude_ix];
1560 dir->exclude_stack = stk->prev;
1561 dir->pattern = NULL;
1562 free((char *)pl->src); /* see strbuf_detach() below */
1563 clear_pattern_list(pl);
1564 free(stk);
1565 group->nr--;
1568 /* Skip traversing into sub directories if the parent is excluded */
1569 if (dir->pattern)
1570 return;
1573 * Lazy initialization. All call sites currently just
1574 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1575 * them seems lots of work for little benefit.
1577 if (!dir->basebuf.buf)
1578 strbuf_init(&dir->basebuf, PATH_MAX);
1580 /* Read from the parent directories and push them down. */
1581 current = stk ? stk->baselen : -1;
1582 strbuf_setlen(&dir->basebuf, current < 0 ? 0 : current);
1583 if (dir->untracked)
1584 untracked = stk ? stk->ucd : dir->untracked->root;
1585 else
1586 untracked = NULL;
1588 while (current < baselen) {
1589 const char *cp;
1590 struct oid_stat oid_stat;
1592 CALLOC_ARRAY(stk, 1);
1593 if (current < 0) {
1594 cp = base;
1595 current = 0;
1596 } else {
1597 cp = strchr(base + current + 1, '/');
1598 if (!cp)
1599 die("oops in prep_exclude");
1600 cp++;
1601 untracked =
1602 lookup_untracked(dir->untracked, untracked,
1603 base + current,
1604 cp - base - current);
1606 stk->prev = dir->exclude_stack;
1607 stk->baselen = cp - base;
1608 stk->exclude_ix = group->nr;
1609 stk->ucd = untracked;
1610 pl = add_pattern_list(dir, EXC_DIRS, NULL);
1611 strbuf_add(&dir->basebuf, base + current, stk->baselen - current);
1612 assert(stk->baselen == dir->basebuf.len);
1614 /* Abort if the directory is excluded */
1615 if (stk->baselen) {
1616 int dt = DT_DIR;
1617 dir->basebuf.buf[stk->baselen - 1] = 0;
1618 dir->pattern = last_matching_pattern_from_lists(dir,
1619 istate,
1620 dir->basebuf.buf, stk->baselen - 1,
1621 dir->basebuf.buf + current, &dt);
1622 dir->basebuf.buf[stk->baselen - 1] = '/';
1623 if (dir->pattern &&
1624 dir->pattern->flags & PATTERN_FLAG_NEGATIVE)
1625 dir->pattern = NULL;
1626 if (dir->pattern) {
1627 dir->exclude_stack = stk;
1628 return;
1632 /* Try to read per-directory file */
1633 oidclr(&oid_stat.oid);
1634 oid_stat.valid = 0;
1635 if (dir->exclude_per_dir &&
1637 * If we know that no files have been added in
1638 * this directory (i.e. valid_cached_dir() has
1639 * been executed and set untracked->valid) ..
1641 (!untracked || !untracked->valid ||
1643 * .. and .gitignore does not exist before
1644 * (i.e. null exclude_oid). Then we can skip
1645 * loading .gitignore, which would result in
1646 * ENOENT anyway.
1648 !is_null_oid(&untracked->exclude_oid))) {
1650 * dir->basebuf gets reused by the traversal, but we
1651 * need fname to remain unchanged to ensure the src
1652 * member of each struct path_pattern correctly
1653 * back-references its source file. Other invocations
1654 * of add_pattern_list provide stable strings, so we
1655 * strbuf_detach() and free() here in the caller.
1657 struct strbuf sb = STRBUF_INIT;
1658 strbuf_addbuf(&sb, &dir->basebuf);
1659 strbuf_addstr(&sb, dir->exclude_per_dir);
1660 pl->src = strbuf_detach(&sb, NULL);
1661 add_patterns(pl->src, pl->src, stk->baselen, pl, istate,
1662 PATTERN_NOFOLLOW,
1663 untracked ? &oid_stat : NULL);
1666 * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1667 * will first be called in valid_cached_dir() then maybe many
1668 * times more in last_matching_pattern(). When the cache is
1669 * used, last_matching_pattern() will not be called and
1670 * reading .gitignore content will be a waste.
1672 * So when it's called by valid_cached_dir() and we can get
1673 * .gitignore SHA-1 from the index (i.e. .gitignore is not
1674 * modified on work tree), we could delay reading the
1675 * .gitignore content until we absolutely need it in
1676 * last_matching_pattern(). Be careful about ignore rule
1677 * order, though, if you do that.
1679 if (untracked &&
1680 !oideq(&oid_stat.oid, &untracked->exclude_oid)) {
1681 invalidate_gitignore(dir->untracked, untracked);
1682 oidcpy(&untracked->exclude_oid, &oid_stat.oid);
1684 dir->exclude_stack = stk;
1685 current = stk->baselen;
1687 strbuf_setlen(&dir->basebuf, baselen);
1691 * Loads the exclude lists for the directory containing pathname, then
1692 * scans all exclude lists to determine whether pathname is excluded.
1693 * Returns the exclude_list element which matched, or NULL for
1694 * undecided.
1696 struct path_pattern *last_matching_pattern(struct dir_struct *dir,
1697 struct index_state *istate,
1698 const char *pathname,
1699 int *dtype_p)
1701 int pathlen = strlen(pathname);
1702 const char *basename = strrchr(pathname, '/');
1703 basename = (basename) ? basename+1 : pathname;
1705 prep_exclude(dir, istate, pathname, basename-pathname);
1707 if (dir->pattern)
1708 return dir->pattern;
1710 return last_matching_pattern_from_lists(dir, istate, pathname, pathlen,
1711 basename, dtype_p);
1715 * Loads the exclude lists for the directory containing pathname, then
1716 * scans all exclude lists to determine whether pathname is excluded.
1717 * Returns 1 if true, otherwise 0.
1719 int is_excluded(struct dir_struct *dir, struct index_state *istate,
1720 const char *pathname, int *dtype_p)
1722 struct path_pattern *pattern =
1723 last_matching_pattern(dir, istate, pathname, dtype_p);
1724 if (pattern)
1725 return pattern->flags & PATTERN_FLAG_NEGATIVE ? 0 : 1;
1726 return 0;
1729 static struct dir_entry *dir_entry_new(const char *pathname, int len)
1731 struct dir_entry *ent;
1733 FLEX_ALLOC_MEM(ent, name, pathname, len);
1734 ent->len = len;
1735 return ent;
1738 static struct dir_entry *dir_add_name(struct dir_struct *dir,
1739 struct index_state *istate,
1740 const char *pathname, int len)
1742 if (index_file_exists(istate, pathname, len, ignore_case))
1743 return NULL;
1745 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
1746 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
1749 struct dir_entry *dir_add_ignored(struct dir_struct *dir,
1750 struct index_state *istate,
1751 const char *pathname, int len)
1753 if (!index_name_is_other(istate, pathname, len))
1754 return NULL;
1756 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
1757 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
1760 enum exist_status {
1761 index_nonexistent = 0,
1762 index_directory,
1763 index_gitdir
1767 * Do not use the alphabetically sorted index to look up
1768 * the directory name; instead, use the case insensitive
1769 * directory hash.
1771 static enum exist_status directory_exists_in_index_icase(struct index_state *istate,
1772 const char *dirname, int len)
1774 struct cache_entry *ce;
1776 if (index_dir_exists(istate, dirname, len))
1777 return index_directory;
1779 ce = index_file_exists(istate, dirname, len, ignore_case);
1780 if (ce && S_ISGITLINK(ce->ce_mode))
1781 return index_gitdir;
1783 return index_nonexistent;
1787 * The index sorts alphabetically by entry name, which
1788 * means that a gitlink sorts as '\0' at the end, while
1789 * a directory (which is defined not as an entry, but as
1790 * the files it contains) will sort with the '/' at the
1791 * end.
1793 static enum exist_status directory_exists_in_index(struct index_state *istate,
1794 const char *dirname, int len)
1796 int pos;
1798 if (ignore_case)
1799 return directory_exists_in_index_icase(istate, dirname, len);
1801 pos = index_name_pos(istate, dirname, len);
1802 if (pos < 0)
1803 pos = -pos-1;
1804 while (pos < istate->cache_nr) {
1805 const struct cache_entry *ce = istate->cache[pos++];
1806 unsigned char endchar;
1808 if (strncmp(ce->name, dirname, len))
1809 break;
1810 endchar = ce->name[len];
1811 if (endchar > '/')
1812 break;
1813 if (endchar == '/')
1814 return index_directory;
1815 if (!endchar && S_ISGITLINK(ce->ce_mode))
1816 return index_gitdir;
1818 return index_nonexistent;
1822 * When we find a directory when traversing the filesystem, we
1823 * have three distinct cases:
1825 * - ignore it
1826 * - see it as a directory
1827 * - recurse into it
1829 * and which one we choose depends on a combination of existing
1830 * git index contents and the flags passed into the directory
1831 * traversal routine.
1833 * Case 1: If we *already* have entries in the index under that
1834 * directory name, we always recurse into the directory to see
1835 * all the files.
1837 * Case 2: If we *already* have that directory name as a gitlink,
1838 * we always continue to see it as a gitlink, regardless of whether
1839 * there is an actual git directory there or not (it might not
1840 * be checked out as a subproject!)
1842 * Case 3: if we didn't have it in the index previously, we
1843 * have a few sub-cases:
1845 * (a) if DIR_SHOW_OTHER_DIRECTORIES flag is set, we show it as
1846 * just a directory, unless DIR_HIDE_EMPTY_DIRECTORIES is
1847 * also true, in which case we need to check if it contains any
1848 * untracked and / or ignored files.
1849 * (b) if it looks like a git directory and we don't have the
1850 * DIR_NO_GITLINKS flag, then we treat it as a gitlink, and
1851 * show it as a directory.
1852 * (c) otherwise, we recurse into it.
1854 static enum path_treatment treat_directory(struct dir_struct *dir,
1855 struct index_state *istate,
1856 struct untracked_cache_dir *untracked,
1857 const char *dirname, int len, int baselen, int excluded,
1858 const struct pathspec *pathspec)
1861 * WARNING: From this function, you can return path_recurse or you
1862 * can call read_directory_recursive() (or neither), but
1863 * you CAN'T DO BOTH.
1865 enum path_treatment state;
1866 int matches_how = 0;
1867 int check_only, stop_early;
1868 int old_ignored_nr, old_untracked_nr;
1869 /* The "len-1" is to strip the final '/' */
1870 enum exist_status status = directory_exists_in_index(istate, dirname, len-1);
1872 if (status == index_directory)
1873 return path_recurse;
1874 if (status == index_gitdir)
1875 return path_none;
1876 if (status != index_nonexistent)
1877 BUG("Unhandled value for directory_exists_in_index: %d\n", status);
1880 * We don't want to descend into paths that don't match the necessary
1881 * patterns. Clearly, if we don't have a pathspec, then we can't check
1882 * for matching patterns. Also, if (excluded) then we know we matched
1883 * the exclusion patterns so as an optimization we can skip checking
1884 * for matching patterns.
1886 if (pathspec && !excluded) {
1887 matches_how = match_pathspec_with_flags(istate, pathspec,
1888 dirname, len,
1889 0 /* prefix */,
1890 NULL /* seen */,
1891 DO_MATCH_LEADING_PATHSPEC);
1892 if (!matches_how)
1893 return path_none;
1897 if ((dir->flags & DIR_SKIP_NESTED_GIT) ||
1898 !(dir->flags & DIR_NO_GITLINKS)) {
1900 * Determine if `dirname` is a nested repo by confirming that:
1901 * 1) we are in a nonbare repository, and
1902 * 2) `dirname` is not an immediate parent of `the_repository->gitdir`,
1903 * which could occur if the git_dir or worktree location was
1904 * manually configured by the user; see t2205 testcases 1-3 for
1905 * examples where this matters
1907 int nested_repo;
1908 struct strbuf sb = STRBUF_INIT;
1909 strbuf_addstr(&sb, dirname);
1910 nested_repo = is_nonbare_repository_dir(&sb);
1912 if (nested_repo) {
1913 char *real_dirname, *real_gitdir;
1914 strbuf_addstr(&sb, ".git");
1915 real_dirname = real_pathdup(sb.buf, 1);
1916 real_gitdir = real_pathdup(the_repository->gitdir, 1);
1918 nested_repo = !!strcmp(real_dirname, real_gitdir);
1919 free(real_gitdir);
1920 free(real_dirname);
1922 strbuf_release(&sb);
1924 if (nested_repo) {
1925 if ((dir->flags & DIR_SKIP_NESTED_GIT) ||
1926 (matches_how == MATCHED_RECURSIVELY_LEADING_PATHSPEC))
1927 return path_none;
1928 return excluded ? path_excluded : path_untracked;
1932 if (!(dir->flags & DIR_SHOW_OTHER_DIRECTORIES)) {
1933 if (excluded &&
1934 (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1935 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING)) {
1938 * This is an excluded directory and we are
1939 * showing ignored paths that match an exclude
1940 * pattern. (e.g. show directory as ignored
1941 * only if it matches an exclude pattern).
1942 * This path will either be 'path_excluded`
1943 * (if we are showing empty directories or if
1944 * the directory is not empty), or will be
1945 * 'path_none' (empty directory, and we are
1946 * not showing empty directories).
1948 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1949 return path_excluded;
1951 if (read_directory_recursive(dir, istate, dirname, len,
1952 untracked, 1, 1, pathspec) == path_excluded)
1953 return path_excluded;
1955 return path_none;
1957 return path_recurse;
1960 assert(dir->flags & DIR_SHOW_OTHER_DIRECTORIES);
1963 * If we have a pathspec which could match something _below_ this
1964 * directory (e.g. when checking 'subdir/' having a pathspec like
1965 * 'subdir/some/deep/path/file' or 'subdir/widget-*.c'), then we
1966 * need to recurse.
1968 if (matches_how == MATCHED_RECURSIVELY_LEADING_PATHSPEC)
1969 return path_recurse;
1971 /* Special cases for where this directory is excluded/ignored */
1972 if (excluded) {
1974 * If DIR_SHOW_OTHER_DIRECTORIES is set and we're not
1975 * hiding empty directories, there is no need to
1976 * recurse into an ignored directory.
1978 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1979 return path_excluded;
1982 * Even if we are hiding empty directories, we can still avoid
1983 * recursing into ignored directories for DIR_SHOW_IGNORED_TOO
1984 * if DIR_SHOW_IGNORED_TOO_MODE_MATCHING is also set.
1986 if ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
1987 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING))
1988 return path_excluded;
1992 * Other than the path_recurse case above, we only need to
1993 * recurse into untracked directories if any of the following
1994 * bits is set:
1995 * - DIR_SHOW_IGNORED (because then we need to determine if
1996 * there are ignored entries below)
1997 * - DIR_SHOW_IGNORED_TOO (same as above)
1998 * - DIR_HIDE_EMPTY_DIRECTORIES (because we have to determine if
1999 * the directory is empty)
2001 if (!excluded &&
2002 !(dir->flags & (DIR_SHOW_IGNORED |
2003 DIR_SHOW_IGNORED_TOO |
2004 DIR_HIDE_EMPTY_DIRECTORIES))) {
2005 return path_untracked;
2009 * Even if we don't want to know all the paths under an untracked or
2010 * ignored directory, we may still need to go into the directory to
2011 * determine if it is empty (because with DIR_HIDE_EMPTY_DIRECTORIES,
2012 * an empty directory should be path_none instead of path_excluded or
2013 * path_untracked).
2015 check_only = ((dir->flags & DIR_HIDE_EMPTY_DIRECTORIES) &&
2016 !(dir->flags & DIR_SHOW_IGNORED_TOO));
2019 * However, there's another optimization possible as a subset of
2020 * check_only, based on the cases we have to consider:
2021 * A) Directory matches no exclude patterns:
2022 * * Directory is empty => path_none
2023 * * Directory has an untracked file under it => path_untracked
2024 * * Directory has only ignored files under it => path_excluded
2025 * B) Directory matches an exclude pattern:
2026 * * Directory is empty => path_none
2027 * * Directory has an untracked file under it => path_excluded
2028 * * Directory has only ignored files under it => path_excluded
2029 * In case A, we can exit as soon as we've found an untracked
2030 * file but otherwise have to walk all files. In case B, though,
2031 * we can stop at the first file we find under the directory.
2033 stop_early = check_only && excluded;
2036 * If /every/ file within an untracked directory is ignored, then
2037 * we want to treat the directory as ignored (for e.g. status
2038 * --porcelain), without listing the individual ignored files
2039 * underneath. To do so, we'll save the current ignored_nr, and
2040 * pop all the ones added after it if it turns out the entire
2041 * directory is ignored. Also, when DIR_SHOW_IGNORED_TOO and
2042 * !DIR_KEEP_UNTRACKED_CONTENTS then we don't want to show
2043 * untracked paths so will need to pop all those off the last
2044 * after we traverse.
2046 old_ignored_nr = dir->ignored_nr;
2047 old_untracked_nr = dir->nr;
2049 /* Actually recurse into dirname now, we'll fixup the state later. */
2050 untracked = lookup_untracked(dir->untracked, untracked,
2051 dirname + baselen, len - baselen);
2052 state = read_directory_recursive(dir, istate, dirname, len, untracked,
2053 check_only, stop_early, pathspec);
2055 /* There are a variety of reasons we may need to fixup the state... */
2056 if (state == path_excluded) {
2057 /* state == path_excluded implies all paths under
2058 * dirname were ignored...
2060 * if running e.g. `git status --porcelain --ignored=matching`,
2061 * then we want to see the subpaths that are ignored.
2063 * if running e.g. just `git status --porcelain`, then
2064 * we just want the directory itself to be listed as ignored
2065 * and not the individual paths underneath.
2067 int want_ignored_subpaths =
2068 ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2069 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING));
2071 if (want_ignored_subpaths) {
2073 * with --ignored=matching, we want the subpaths
2074 * INSTEAD of the directory itself.
2076 state = path_none;
2077 } else {
2078 int i;
2079 for (i = old_ignored_nr + 1; i<dir->ignored_nr; ++i)
2080 FREE_AND_NULL(dir->ignored[i]);
2081 dir->ignored_nr = old_ignored_nr;
2086 * We may need to ignore some of the untracked paths we found while
2087 * traversing subdirectories.
2089 if ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2090 !(dir->flags & DIR_KEEP_UNTRACKED_CONTENTS)) {
2091 int i;
2092 for (i = old_untracked_nr + 1; i<dir->nr; ++i)
2093 FREE_AND_NULL(dir->entries[i]);
2094 dir->nr = old_untracked_nr;
2098 * If there is nothing under the current directory and we are not
2099 * hiding empty directories, then we need to report on the
2100 * untracked or ignored status of the directory itself.
2102 if (state == path_none && !(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
2103 state = excluded ? path_excluded : path_untracked;
2105 return state;
2109 * This is an inexact early pruning of any recursive directory
2110 * reading - if the path cannot possibly be in the pathspec,
2111 * return true, and we'll skip it early.
2113 static int simplify_away(const char *path, int pathlen,
2114 const struct pathspec *pathspec)
2116 int i;
2118 if (!pathspec || !pathspec->nr)
2119 return 0;
2121 GUARD_PATHSPEC(pathspec,
2122 PATHSPEC_FROMTOP |
2123 PATHSPEC_MAXDEPTH |
2124 PATHSPEC_LITERAL |
2125 PATHSPEC_GLOB |
2126 PATHSPEC_ICASE |
2127 PATHSPEC_EXCLUDE |
2128 PATHSPEC_ATTR);
2130 for (i = 0; i < pathspec->nr; i++) {
2131 const struct pathspec_item *item = &pathspec->items[i];
2132 int len = item->nowildcard_len;
2134 if (len > pathlen)
2135 len = pathlen;
2136 if (!ps_strncmp(item, item->match, path, len))
2137 return 0;
2140 return 1;
2144 * This function tells us whether an excluded path matches a
2145 * list of "interesting" pathspecs. That is, whether a path matched
2146 * by any of the pathspecs could possibly be ignored by excluding
2147 * the specified path. This can happen if:
2149 * 1. the path is mentioned explicitly in the pathspec
2151 * 2. the path is a directory prefix of some element in the
2152 * pathspec
2154 static int exclude_matches_pathspec(const char *path, int pathlen,
2155 const struct pathspec *pathspec)
2157 int i;
2159 if (!pathspec || !pathspec->nr)
2160 return 0;
2162 GUARD_PATHSPEC(pathspec,
2163 PATHSPEC_FROMTOP |
2164 PATHSPEC_MAXDEPTH |
2165 PATHSPEC_LITERAL |
2166 PATHSPEC_GLOB |
2167 PATHSPEC_ICASE |
2168 PATHSPEC_EXCLUDE);
2170 for (i = 0; i < pathspec->nr; i++) {
2171 const struct pathspec_item *item = &pathspec->items[i];
2172 int len = item->nowildcard_len;
2174 if (len == pathlen &&
2175 !ps_strncmp(item, item->match, path, pathlen))
2176 return 1;
2177 if (len > pathlen &&
2178 item->match[pathlen] == '/' &&
2179 !ps_strncmp(item, item->match, path, pathlen))
2180 return 1;
2182 return 0;
2185 static int get_index_dtype(struct index_state *istate,
2186 const char *path, int len)
2188 int pos;
2189 const struct cache_entry *ce;
2191 ce = index_file_exists(istate, path, len, 0);
2192 if (ce) {
2193 if (!ce_uptodate(ce))
2194 return DT_UNKNOWN;
2195 if (S_ISGITLINK(ce->ce_mode))
2196 return DT_DIR;
2198 * Nobody actually cares about the
2199 * difference between DT_LNK and DT_REG
2201 return DT_REG;
2204 /* Try to look it up as a directory */
2205 pos = index_name_pos(istate, path, len);
2206 if (pos >= 0)
2207 return DT_UNKNOWN;
2208 pos = -pos-1;
2209 while (pos < istate->cache_nr) {
2210 ce = istate->cache[pos++];
2211 if (strncmp(ce->name, path, len))
2212 break;
2213 if (ce->name[len] > '/')
2214 break;
2215 if (ce->name[len] < '/')
2216 continue;
2217 if (!ce_uptodate(ce))
2218 break; /* continue? */
2219 return DT_DIR;
2221 return DT_UNKNOWN;
2224 static int resolve_dtype(int dtype, struct index_state *istate,
2225 const char *path, int len)
2227 struct stat st;
2229 if (dtype != DT_UNKNOWN)
2230 return dtype;
2231 dtype = get_index_dtype(istate, path, len);
2232 if (dtype != DT_UNKNOWN)
2233 return dtype;
2234 if (lstat(path, &st))
2235 return dtype;
2236 if (S_ISREG(st.st_mode))
2237 return DT_REG;
2238 if (S_ISDIR(st.st_mode))
2239 return DT_DIR;
2240 if (S_ISLNK(st.st_mode))
2241 return DT_LNK;
2242 return dtype;
2245 static enum path_treatment treat_path_fast(struct dir_struct *dir,
2246 struct cached_dir *cdir,
2247 struct index_state *istate,
2248 struct strbuf *path,
2249 int baselen,
2250 const struct pathspec *pathspec)
2253 * WARNING: From this function, you can return path_recurse or you
2254 * can call read_directory_recursive() (or neither), but
2255 * you CAN'T DO BOTH.
2257 strbuf_setlen(path, baselen);
2258 if (!cdir->ucd) {
2259 strbuf_addstr(path, cdir->file);
2260 return path_untracked;
2262 strbuf_addstr(path, cdir->ucd->name);
2263 /* treat_one_path() does this before it calls treat_directory() */
2264 strbuf_complete(path, '/');
2265 if (cdir->ucd->check_only)
2267 * check_only is set as a result of treat_directory() getting
2268 * to its bottom. Verify again the same set of directories
2269 * with check_only set.
2271 return read_directory_recursive(dir, istate, path->buf, path->len,
2272 cdir->ucd, 1, 0, pathspec);
2274 * We get path_recurse in the first run when
2275 * directory_exists_in_index() returns index_nonexistent. We
2276 * are sure that new changes in the index does not impact the
2277 * outcome. Return now.
2279 return path_recurse;
2282 static enum path_treatment treat_path(struct dir_struct *dir,
2283 struct untracked_cache_dir *untracked,
2284 struct cached_dir *cdir,
2285 struct index_state *istate,
2286 struct strbuf *path,
2287 int baselen,
2288 const struct pathspec *pathspec)
2290 int has_path_in_index, dtype, excluded;
2292 if (!cdir->d_name)
2293 return treat_path_fast(dir, cdir, istate, path,
2294 baselen, pathspec);
2295 if (is_dot_or_dotdot(cdir->d_name) || !fspathcmp(cdir->d_name, ".git"))
2296 return path_none;
2297 strbuf_setlen(path, baselen);
2298 strbuf_addstr(path, cdir->d_name);
2299 if (simplify_away(path->buf, path->len, pathspec))
2300 return path_none;
2302 dtype = resolve_dtype(cdir->d_type, istate, path->buf, path->len);
2304 /* Always exclude indexed files */
2305 has_path_in_index = !!index_file_exists(istate, path->buf, path->len,
2306 ignore_case);
2307 if (dtype != DT_DIR && has_path_in_index)
2308 return path_none;
2311 * When we are looking at a directory P in the working tree,
2312 * there are three cases:
2314 * (1) P exists in the index. Everything inside the directory P in
2315 * the working tree needs to go when P is checked out from the
2316 * index.
2318 * (2) P does not exist in the index, but there is P/Q in the index.
2319 * We know P will stay a directory when we check out the contents
2320 * of the index, but we do not know yet if there is a directory
2321 * P/Q in the working tree to be killed, so we need to recurse.
2323 * (3) P does not exist in the index, and there is no P/Q in the index
2324 * to require P to be a directory, either. Only in this case, we
2325 * know that everything inside P will not be killed without
2326 * recursing.
2328 if ((dir->flags & DIR_COLLECT_KILLED_ONLY) &&
2329 (dtype == DT_DIR) &&
2330 !has_path_in_index &&
2331 (directory_exists_in_index(istate, path->buf, path->len) == index_nonexistent))
2332 return path_none;
2334 excluded = is_excluded(dir, istate, path->buf, &dtype);
2337 * Excluded? If we don't explicitly want to show
2338 * ignored files, ignore it
2340 if (excluded && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
2341 return path_excluded;
2343 switch (dtype) {
2344 default:
2345 return path_none;
2346 case DT_DIR:
2348 * WARNING: Do not ignore/amend the return value from
2349 * treat_directory(), and especially do not change it to return
2350 * path_recurse as that can cause exponential slowdown.
2351 * Instead, modify treat_directory() to return the right value.
2353 strbuf_addch(path, '/');
2354 return treat_directory(dir, istate, untracked,
2355 path->buf, path->len,
2356 baselen, excluded, pathspec);
2357 case DT_REG:
2358 case DT_LNK:
2359 if (pathspec &&
2360 !match_pathspec(istate, pathspec, path->buf, path->len,
2361 0 /* prefix */, NULL /* seen */,
2362 0 /* is_dir */))
2363 return path_none;
2364 if (excluded)
2365 return path_excluded;
2366 return path_untracked;
2370 static void add_untracked(struct untracked_cache_dir *dir, const char *name)
2372 if (!dir)
2373 return;
2374 ALLOC_GROW(dir->untracked, dir->untracked_nr + 1,
2375 dir->untracked_alloc);
2376 dir->untracked[dir->untracked_nr++] = xstrdup(name);
2379 static int valid_cached_dir(struct dir_struct *dir,
2380 struct untracked_cache_dir *untracked,
2381 struct index_state *istate,
2382 struct strbuf *path,
2383 int check_only)
2385 struct stat st;
2387 if (!untracked)
2388 return 0;
2391 * With fsmonitor, we can trust the untracked cache's valid field.
2393 refresh_fsmonitor(istate);
2394 if (!(dir->untracked->use_fsmonitor && untracked->valid)) {
2395 if (lstat(path->len ? path->buf : ".", &st)) {
2396 memset(&untracked->stat_data, 0, sizeof(untracked->stat_data));
2397 return 0;
2399 if (!untracked->valid ||
2400 match_stat_data_racy(istate, &untracked->stat_data, &st)) {
2401 fill_stat_data(&untracked->stat_data, &st);
2402 return 0;
2406 if (untracked->check_only != !!check_only)
2407 return 0;
2410 * prep_exclude will be called eventually on this directory,
2411 * but it's called much later in last_matching_pattern(). We
2412 * need it now to determine the validity of the cache for this
2413 * path. The next calls will be nearly no-op, the way
2414 * prep_exclude() is designed.
2416 if (path->len && path->buf[path->len - 1] != '/') {
2417 strbuf_addch(path, '/');
2418 prep_exclude(dir, istate, path->buf, path->len);
2419 strbuf_setlen(path, path->len - 1);
2420 } else
2421 prep_exclude(dir, istate, path->buf, path->len);
2423 /* hopefully prep_exclude() haven't invalidated this entry... */
2424 return untracked->valid;
2427 static int open_cached_dir(struct cached_dir *cdir,
2428 struct dir_struct *dir,
2429 struct untracked_cache_dir *untracked,
2430 struct index_state *istate,
2431 struct strbuf *path,
2432 int check_only)
2434 const char *c_path;
2436 memset(cdir, 0, sizeof(*cdir));
2437 cdir->untracked = untracked;
2438 if (valid_cached_dir(dir, untracked, istate, path, check_only))
2439 return 0;
2440 c_path = path->len ? path->buf : ".";
2441 cdir->fdir = opendir(c_path);
2442 if (!cdir->fdir)
2443 warning_errno(_("could not open directory '%s'"), c_path);
2444 if (dir->untracked) {
2445 invalidate_directory(dir->untracked, untracked);
2446 dir->untracked->dir_opened++;
2448 if (!cdir->fdir)
2449 return -1;
2450 return 0;
2453 static int read_cached_dir(struct cached_dir *cdir)
2455 struct dirent *de;
2457 if (cdir->fdir) {
2458 de = readdir_skip_dot_and_dotdot(cdir->fdir);
2459 if (!de) {
2460 cdir->d_name = NULL;
2461 cdir->d_type = DT_UNKNOWN;
2462 return -1;
2464 cdir->d_name = de->d_name;
2465 cdir->d_type = DTYPE(de);
2466 return 0;
2468 while (cdir->nr_dirs < cdir->untracked->dirs_nr) {
2469 struct untracked_cache_dir *d = cdir->untracked->dirs[cdir->nr_dirs];
2470 if (!d->recurse) {
2471 cdir->nr_dirs++;
2472 continue;
2474 cdir->ucd = d;
2475 cdir->nr_dirs++;
2476 return 0;
2478 cdir->ucd = NULL;
2479 if (cdir->nr_files < cdir->untracked->untracked_nr) {
2480 struct untracked_cache_dir *d = cdir->untracked;
2481 cdir->file = d->untracked[cdir->nr_files++];
2482 return 0;
2484 return -1;
2487 static void close_cached_dir(struct cached_dir *cdir)
2489 if (cdir->fdir)
2490 closedir(cdir->fdir);
2492 * We have gone through this directory and found no untracked
2493 * entries. Mark it valid.
2495 if (cdir->untracked) {
2496 cdir->untracked->valid = 1;
2497 cdir->untracked->recurse = 1;
2501 static void add_path_to_appropriate_result_list(struct dir_struct *dir,
2502 struct untracked_cache_dir *untracked,
2503 struct cached_dir *cdir,
2504 struct index_state *istate,
2505 struct strbuf *path,
2506 int baselen,
2507 const struct pathspec *pathspec,
2508 enum path_treatment state)
2510 /* add the path to the appropriate result list */
2511 switch (state) {
2512 case path_excluded:
2513 if (dir->flags & DIR_SHOW_IGNORED)
2514 dir_add_name(dir, istate, path->buf, path->len);
2515 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
2516 ((dir->flags & DIR_COLLECT_IGNORED) &&
2517 exclude_matches_pathspec(path->buf, path->len,
2518 pathspec)))
2519 dir_add_ignored(dir, istate, path->buf, path->len);
2520 break;
2522 case path_untracked:
2523 if (dir->flags & DIR_SHOW_IGNORED)
2524 break;
2525 dir_add_name(dir, istate, path->buf, path->len);
2526 if (cdir->fdir)
2527 add_untracked(untracked, path->buf + baselen);
2528 break;
2530 default:
2531 break;
2536 * Read a directory tree. We currently ignore anything but
2537 * directories, regular files and symlinks. That's because git
2538 * doesn't handle them at all yet. Maybe that will change some
2539 * day.
2541 * Also, we ignore the name ".git" (even if it is not a directory).
2542 * That likely will not change.
2544 * If 'stop_at_first_file' is specified, 'path_excluded' is returned
2545 * to signal that a file was found. This is the least significant value that
2546 * indicates that a file was encountered that does not depend on the order of
2547 * whether an untracked or excluded path was encountered first.
2549 * Returns the most significant path_treatment value encountered in the scan.
2550 * If 'stop_at_first_file' is specified, `path_excluded` is the most
2551 * significant path_treatment value that will be returned.
2554 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
2555 struct index_state *istate, const char *base, int baselen,
2556 struct untracked_cache_dir *untracked, int check_only,
2557 int stop_at_first_file, const struct pathspec *pathspec)
2560 * WARNING: Do NOT recurse unless path_recurse is returned from
2561 * treat_path(). Recursing on any other return value
2562 * can result in exponential slowdown.
2564 struct cached_dir cdir;
2565 enum path_treatment state, subdir_state, dir_state = path_none;
2566 struct strbuf path = STRBUF_INIT;
2568 strbuf_add(&path, base, baselen);
2570 if (open_cached_dir(&cdir, dir, untracked, istate, &path, check_only))
2571 goto out;
2572 dir->visited_directories++;
2574 if (untracked)
2575 untracked->check_only = !!check_only;
2577 while (!read_cached_dir(&cdir)) {
2578 /* check how the file or directory should be treated */
2579 state = treat_path(dir, untracked, &cdir, istate, &path,
2580 baselen, pathspec);
2581 dir->visited_paths++;
2583 if (state > dir_state)
2584 dir_state = state;
2586 /* recurse into subdir if instructed by treat_path */
2587 if (state == path_recurse) {
2588 struct untracked_cache_dir *ud;
2589 ud = lookup_untracked(dir->untracked, untracked,
2590 path.buf + baselen,
2591 path.len - baselen);
2592 subdir_state =
2593 read_directory_recursive(dir, istate, path.buf,
2594 path.len, ud,
2595 check_only, stop_at_first_file, pathspec);
2596 if (subdir_state > dir_state)
2597 dir_state = subdir_state;
2599 if (pathspec &&
2600 !match_pathspec(istate, pathspec, path.buf, path.len,
2601 0 /* prefix */, NULL,
2602 0 /* do NOT special case dirs */))
2603 state = path_none;
2606 if (check_only) {
2607 if (stop_at_first_file) {
2609 * If stopping at first file, then
2610 * signal that a file was found by
2611 * returning `path_excluded`. This is
2612 * to return a consistent value
2613 * regardless of whether an ignored or
2614 * excluded file happened to be
2615 * encountered 1st.
2617 * In current usage, the
2618 * `stop_at_first_file` is passed when
2619 * an ancestor directory has matched
2620 * an exclude pattern, so any found
2621 * files will be excluded.
2623 if (dir_state >= path_excluded) {
2624 dir_state = path_excluded;
2625 break;
2629 /* abort early if maximum state has been reached */
2630 if (dir_state == path_untracked) {
2631 if (cdir.fdir)
2632 add_untracked(untracked, path.buf + baselen);
2633 break;
2635 /* skip the add_path_to_appropriate_result_list() */
2636 continue;
2639 add_path_to_appropriate_result_list(dir, untracked, &cdir,
2640 istate, &path, baselen,
2641 pathspec, state);
2643 close_cached_dir(&cdir);
2644 out:
2645 strbuf_release(&path);
2647 return dir_state;
2650 int cmp_dir_entry(const void *p1, const void *p2)
2652 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
2653 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
2655 return name_compare(e1->name, e1->len, e2->name, e2->len);
2658 /* check if *out lexically strictly contains *in */
2659 int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in)
2661 return (out->len < in->len) &&
2662 (out->name[out->len - 1] == '/') &&
2663 !memcmp(out->name, in->name, out->len);
2666 static int treat_leading_path(struct dir_struct *dir,
2667 struct index_state *istate,
2668 const char *path, int len,
2669 const struct pathspec *pathspec)
2671 struct strbuf sb = STRBUF_INIT;
2672 struct strbuf subdir = STRBUF_INIT;
2673 int prevlen, baselen;
2674 const char *cp;
2675 struct cached_dir cdir;
2676 enum path_treatment state = path_none;
2679 * For each directory component of path, we are going to check whether
2680 * that path is relevant given the pathspec. For example, if path is
2681 * foo/bar/baz/
2682 * then we will ask treat_path() whether we should go into foo, then
2683 * whether we should go into bar, then whether baz is relevant.
2684 * Checking each is important because e.g. if path is
2685 * .git/info/
2686 * then we need to check .git to know we shouldn't traverse it.
2687 * If the return from treat_path() is:
2688 * * path_none, for any path, we return false.
2689 * * path_recurse, for all path components, we return true
2690 * * <anything else> for some intermediate component, we make sure
2691 * to add that path to the relevant list but return false
2692 * signifying that we shouldn't recurse into it.
2695 while (len && path[len - 1] == '/')
2696 len--;
2697 if (!len)
2698 return 1;
2700 memset(&cdir, 0, sizeof(cdir));
2701 cdir.d_type = DT_DIR;
2702 baselen = 0;
2703 prevlen = 0;
2704 while (1) {
2705 prevlen = baselen + !!baselen;
2706 cp = path + prevlen;
2707 cp = memchr(cp, '/', path + len - cp);
2708 if (!cp)
2709 baselen = len;
2710 else
2711 baselen = cp - path;
2712 strbuf_reset(&sb);
2713 strbuf_add(&sb, path, baselen);
2714 if (!is_directory(sb.buf))
2715 break;
2716 strbuf_reset(&sb);
2717 strbuf_add(&sb, path, prevlen);
2718 strbuf_reset(&subdir);
2719 strbuf_add(&subdir, path+prevlen, baselen-prevlen);
2720 cdir.d_name = subdir.buf;
2721 state = treat_path(dir, NULL, &cdir, istate, &sb, prevlen, pathspec);
2723 if (state != path_recurse)
2724 break; /* do not recurse into it */
2725 if (len <= baselen)
2726 break; /* finished checking */
2728 add_path_to_appropriate_result_list(dir, NULL, &cdir, istate,
2729 &sb, baselen, pathspec,
2730 state);
2732 strbuf_release(&subdir);
2733 strbuf_release(&sb);
2734 return state == path_recurse;
2737 static const char *get_ident_string(void)
2739 static struct strbuf sb = STRBUF_INIT;
2740 struct utsname uts;
2742 if (sb.len)
2743 return sb.buf;
2744 if (uname(&uts) < 0)
2745 die_errno(_("failed to get kernel name and information"));
2746 strbuf_addf(&sb, "Location %s, system %s", get_git_work_tree(),
2747 uts.sysname);
2748 return sb.buf;
2751 static int ident_in_untracked(const struct untracked_cache *uc)
2754 * Previous git versions may have saved many NUL separated
2755 * strings in the "ident" field, but it is insane to manage
2756 * many locations, so just take care of the first one.
2759 return !strcmp(uc->ident.buf, get_ident_string());
2762 static void set_untracked_ident(struct untracked_cache *uc)
2764 strbuf_reset(&uc->ident);
2765 strbuf_addstr(&uc->ident, get_ident_string());
2768 * This strbuf used to contain a list of NUL separated
2769 * strings, so save NUL too for backward compatibility.
2771 strbuf_addch(&uc->ident, 0);
2774 static unsigned new_untracked_cache_flags(struct index_state *istate)
2776 struct repository *repo = istate->repo;
2777 char *val;
2780 * This logic is coordinated with the setting of these flags in
2781 * wt-status.c#wt_status_collect_untracked(), and the evaluation
2782 * of the config setting in commit.c#git_status_config()
2784 if (!repo_config_get_string(repo, "status.showuntrackedfiles", &val) &&
2785 !strcmp(val, "all"))
2786 return 0;
2789 * The default, if "all" is not set, is "normal" - leading us here.
2790 * If the value is "none" then it really doesn't matter.
2792 return DIR_SHOW_OTHER_DIRECTORIES | DIR_HIDE_EMPTY_DIRECTORIES;
2795 static void new_untracked_cache(struct index_state *istate, int flags)
2797 struct untracked_cache *uc = xcalloc(1, sizeof(*uc));
2798 strbuf_init(&uc->ident, 100);
2799 uc->exclude_per_dir = ".gitignore";
2800 uc->dir_flags = flags >= 0 ? flags : new_untracked_cache_flags(istate);
2801 set_untracked_ident(uc);
2802 istate->untracked = uc;
2803 istate->cache_changed |= UNTRACKED_CHANGED;
2806 void add_untracked_cache(struct index_state *istate)
2808 if (!istate->untracked) {
2809 new_untracked_cache(istate, -1);
2810 } else {
2811 if (!ident_in_untracked(istate->untracked)) {
2812 free_untracked_cache(istate->untracked);
2813 new_untracked_cache(istate, -1);
2818 void remove_untracked_cache(struct index_state *istate)
2820 if (istate->untracked) {
2821 free_untracked_cache(istate->untracked);
2822 istate->untracked = NULL;
2823 istate->cache_changed |= UNTRACKED_CHANGED;
2827 static struct untracked_cache_dir *validate_untracked_cache(struct dir_struct *dir,
2828 int base_len,
2829 const struct pathspec *pathspec,
2830 struct index_state *istate)
2832 struct untracked_cache_dir *root;
2833 static int untracked_cache_disabled = -1;
2835 if (!dir->untracked)
2836 return NULL;
2837 if (untracked_cache_disabled < 0)
2838 untracked_cache_disabled = git_env_bool("GIT_DISABLE_UNTRACKED_CACHE", 0);
2839 if (untracked_cache_disabled)
2840 return NULL;
2843 * We only support $GIT_DIR/info/exclude and core.excludesfile
2844 * as the global ignore rule files. Any other additions
2845 * (e.g. from command line) invalidate the cache. This
2846 * condition also catches running setup_standard_excludes()
2847 * before setting dir->untracked!
2849 if (dir->unmanaged_exclude_files)
2850 return NULL;
2853 * Optimize for the main use case only: whole-tree git
2854 * status. More work involved in treat_leading_path() if we
2855 * use cache on just a subset of the worktree. pathspec
2856 * support could make the matter even worse.
2858 if (base_len || (pathspec && pathspec->nr))
2859 return NULL;
2861 /* We don't support collecting ignore files */
2862 if (dir->flags & (DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO |
2863 DIR_COLLECT_IGNORED))
2864 return NULL;
2867 * If we use .gitignore in the cache and now you change it to
2868 * .gitexclude, everything will go wrong.
2870 if (dir->exclude_per_dir != dir->untracked->exclude_per_dir &&
2871 strcmp(dir->exclude_per_dir, dir->untracked->exclude_per_dir))
2872 return NULL;
2875 * EXC_CMDL is not considered in the cache. If people set it,
2876 * skip the cache.
2878 if (dir->exclude_list_group[EXC_CMDL].nr)
2879 return NULL;
2881 if (!ident_in_untracked(dir->untracked)) {
2882 warning(_("untracked cache is disabled on this system or location"));
2883 return NULL;
2887 * If the untracked structure we received does not have the same flags
2888 * as requested in this run, we're going to need to either discard the
2889 * existing structure (and potentially later recreate), or bypass the
2890 * untracked cache mechanism for this run.
2892 if (dir->flags != dir->untracked->dir_flags) {
2894 * If the untracked structure we received does not have the same flags
2895 * as configured, then we need to reset / create a new "untracked"
2896 * structure to match the new config.
2898 * Keeping the saved and used untracked cache consistent with the
2899 * configuration provides an opportunity for frequent users of
2900 * "git status -uall" to leverage the untracked cache by aligning their
2901 * configuration - setting "status.showuntrackedfiles" to "all" or
2902 * "normal" as appropriate.
2904 * Previously using -uall (or setting "status.showuntrackedfiles" to
2905 * "all") was incompatible with untracked cache and *consistently*
2906 * caused surprisingly bad performance (with fscache and fsmonitor
2907 * enabled) on Windows.
2909 * IMPROVEMENT OPPORTUNITY: If we reworked the untracked cache storage
2910 * to not be as bound up with the desired output in a given run,
2911 * and instead iterated through and stored enough information to
2912 * correctly serve both "modes", then users could get peak performance
2913 * with or without '-uall' regardless of their
2914 * "status.showuntrackedfiles" config.
2916 if (dir->untracked->dir_flags != new_untracked_cache_flags(istate)) {
2917 free_untracked_cache(istate->untracked);
2918 new_untracked_cache(istate, dir->flags);
2919 dir->untracked = istate->untracked;
2921 else {
2923 * Current untracked cache data is consistent with config, but not
2924 * usable in this request/run; just bypass untracked cache.
2926 return NULL;
2930 if (!dir->untracked->root) {
2931 /* Untracked cache existed but is not initialized; fix that */
2932 FLEX_ALLOC_STR(dir->untracked->root, name, "");
2933 istate->cache_changed |= UNTRACKED_CHANGED;
2936 /* Validate $GIT_DIR/info/exclude and core.excludesfile */
2937 root = dir->untracked->root;
2938 if (!oideq(&dir->ss_info_exclude.oid,
2939 &dir->untracked->ss_info_exclude.oid)) {
2940 invalidate_gitignore(dir->untracked, root);
2941 dir->untracked->ss_info_exclude = dir->ss_info_exclude;
2943 if (!oideq(&dir->ss_excludes_file.oid,
2944 &dir->untracked->ss_excludes_file.oid)) {
2945 invalidate_gitignore(dir->untracked, root);
2946 dir->untracked->ss_excludes_file = dir->ss_excludes_file;
2949 /* Make sure this directory is not dropped out at saving phase */
2950 root->recurse = 1;
2951 return root;
2954 static void emit_traversal_statistics(struct dir_struct *dir,
2955 struct repository *repo,
2956 const char *path,
2957 int path_len)
2959 if (!trace2_is_enabled())
2960 return;
2962 if (!path_len) {
2963 trace2_data_string("read_directory", repo, "path", "");
2964 } else {
2965 struct strbuf tmp = STRBUF_INIT;
2966 strbuf_add(&tmp, path, path_len);
2967 trace2_data_string("read_directory", repo, "path", tmp.buf);
2968 strbuf_release(&tmp);
2971 trace2_data_intmax("read_directory", repo,
2972 "directories-visited", dir->visited_directories);
2973 trace2_data_intmax("read_directory", repo,
2974 "paths-visited", dir->visited_paths);
2976 if (!dir->untracked)
2977 return;
2978 trace2_data_intmax("read_directory", repo,
2979 "node-creation", dir->untracked->dir_created);
2980 trace2_data_intmax("read_directory", repo,
2981 "gitignore-invalidation",
2982 dir->untracked->gitignore_invalidated);
2983 trace2_data_intmax("read_directory", repo,
2984 "directory-invalidation",
2985 dir->untracked->dir_invalidated);
2986 trace2_data_intmax("read_directory", repo,
2987 "opendir", dir->untracked->dir_opened);
2990 int read_directory(struct dir_struct *dir, struct index_state *istate,
2991 const char *path, int len, const struct pathspec *pathspec)
2993 struct untracked_cache_dir *untracked;
2995 trace2_region_enter("dir", "read_directory", istate->repo);
2996 dir->visited_paths = 0;
2997 dir->visited_directories = 0;
2999 if (has_symlink_leading_path(path, len)) {
3000 trace2_region_leave("dir", "read_directory", istate->repo);
3001 return dir->nr;
3004 untracked = validate_untracked_cache(dir, len, pathspec, istate);
3005 if (!untracked)
3007 * make sure untracked cache code path is disabled,
3008 * e.g. prep_exclude()
3010 dir->untracked = NULL;
3011 if (!len || treat_leading_path(dir, istate, path, len, pathspec))
3012 read_directory_recursive(dir, istate, path, len, untracked, 0, 0, pathspec);
3013 QSORT(dir->entries, dir->nr, cmp_dir_entry);
3014 QSORT(dir->ignored, dir->ignored_nr, cmp_dir_entry);
3016 emit_traversal_statistics(dir, istate->repo, path, len);
3018 trace2_region_leave("dir", "read_directory", istate->repo);
3019 if (dir->untracked) {
3020 static int force_untracked_cache = -1;
3022 if (force_untracked_cache < 0)
3023 force_untracked_cache =
3024 git_env_bool("GIT_FORCE_UNTRACKED_CACHE", -1);
3025 if (force_untracked_cache < 0)
3026 force_untracked_cache = (istate->repo->settings.core_untracked_cache == UNTRACKED_CACHE_WRITE);
3027 if (force_untracked_cache &&
3028 dir->untracked == istate->untracked &&
3029 (dir->untracked->dir_opened ||
3030 dir->untracked->gitignore_invalidated ||
3031 dir->untracked->dir_invalidated))
3032 istate->cache_changed |= UNTRACKED_CHANGED;
3033 if (dir->untracked != istate->untracked) {
3034 FREE_AND_NULL(dir->untracked);
3038 return dir->nr;
3041 int file_exists(const char *f)
3043 struct stat sb;
3044 return lstat(f, &sb) == 0;
3047 int repo_file_exists(struct repository *repo, const char *path)
3049 if (repo != the_repository)
3050 BUG("do not know how to check file existence in arbitrary repo");
3052 return file_exists(path);
3055 static int cmp_icase(char a, char b)
3057 if (a == b)
3058 return 0;
3059 if (ignore_case)
3060 return toupper(a) - toupper(b);
3061 return a - b;
3065 * Given two normalized paths (a trailing slash is ok), if subdir is
3066 * outside dir, return -1. Otherwise return the offset in subdir that
3067 * can be used as relative path to dir.
3069 int dir_inside_of(const char *subdir, const char *dir)
3071 int offset = 0;
3073 assert(dir && subdir && *dir && *subdir);
3075 while (*dir && *subdir && !cmp_icase(*dir, *subdir)) {
3076 dir++;
3077 subdir++;
3078 offset++;
3081 /* hel[p]/me vs hel[l]/yeah */
3082 if (*dir && *subdir)
3083 return -1;
3085 if (!*subdir)
3086 return !*dir ? offset : -1; /* same dir */
3088 /* foo/[b]ar vs foo/[] */
3089 if (is_dir_sep(dir[-1]))
3090 return is_dir_sep(subdir[-1]) ? offset : -1;
3092 /* foo[/]bar vs foo[] */
3093 return is_dir_sep(*subdir) ? offset + 1 : -1;
3096 int is_inside_dir(const char *dir)
3098 char *cwd;
3099 int rc;
3101 if (!dir)
3102 return 0;
3104 cwd = xgetcwd();
3105 rc = (dir_inside_of(cwd, dir) >= 0);
3106 free(cwd);
3107 return rc;
3110 int is_empty_dir(const char *path)
3112 DIR *dir = opendir(path);
3113 struct dirent *e;
3114 int ret = 1;
3116 if (!dir)
3117 return 0;
3119 e = readdir_skip_dot_and_dotdot(dir);
3120 if (e)
3121 ret = 0;
3123 closedir(dir);
3124 return ret;
3127 char *git_url_basename(const char *repo, int is_bundle, int is_bare)
3129 const char *end = repo + strlen(repo), *start, *ptr;
3130 size_t len;
3131 char *dir;
3134 * Skip scheme.
3136 start = strstr(repo, "://");
3137 if (!start)
3138 start = repo;
3139 else
3140 start += 3;
3143 * Skip authentication data. The stripping does happen
3144 * greedily, such that we strip up to the last '@' inside
3145 * the host part.
3147 for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
3148 if (*ptr == '@')
3149 start = ptr + 1;
3153 * Strip trailing spaces, slashes and /.git
3155 while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
3156 end--;
3157 if (end - start > 5 && is_dir_sep(end[-5]) &&
3158 !strncmp(end - 4, ".git", 4)) {
3159 end -= 5;
3160 while (start < end && is_dir_sep(end[-1]))
3161 end--;
3165 * It should not be possible to overflow `ptrdiff_t` by passing in an
3166 * insanely long URL, but GCC does not know that and will complain
3167 * without this check.
3169 if (end - start < 0)
3170 die(_("No directory name could be guessed.\n"
3171 "Please specify a directory on the command line"));
3174 * Strip trailing port number if we've got only a
3175 * hostname (that is, there is no dir separator but a
3176 * colon). This check is required such that we do not
3177 * strip URI's like '/foo/bar:2222.git', which should
3178 * result in a dir '2222' being guessed due to backwards
3179 * compatibility.
3181 if (memchr(start, '/', end - start) == NULL
3182 && memchr(start, ':', end - start) != NULL) {
3183 ptr = end;
3184 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
3185 ptr--;
3186 if (start < ptr && ptr[-1] == ':')
3187 end = ptr - 1;
3191 * Find last component. To remain backwards compatible we
3192 * also regard colons as path separators, such that
3193 * cloning a repository 'foo:bar.git' would result in a
3194 * directory 'bar' being guessed.
3196 ptr = end;
3197 while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
3198 ptr--;
3199 start = ptr;
3202 * Strip .{bundle,git}.
3204 len = end - start;
3205 strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
3207 if (!len || (len == 1 && *start == '/'))
3208 die(_("No directory name could be guessed.\n"
3209 "Please specify a directory on the command line"));
3211 if (is_bare)
3212 dir = xstrfmt("%.*s.git", (int)len, start);
3213 else
3214 dir = xstrndup(start, len);
3216 * Replace sequences of 'control' characters and whitespace
3217 * with one ascii space, remove leading and trailing spaces.
3219 if (*dir) {
3220 char *out = dir;
3221 int prev_space = 1 /* strip leading whitespace */;
3222 for (end = dir; *end; ++end) {
3223 char ch = *end;
3224 if ((unsigned char)ch < '\x20')
3225 ch = '\x20';
3226 if (isspace(ch)) {
3227 if (prev_space)
3228 continue;
3229 prev_space = 1;
3230 } else
3231 prev_space = 0;
3232 *out++ = ch;
3234 *out = '\0';
3235 if (out > dir && prev_space)
3236 out[-1] = '\0';
3238 return dir;
3241 void strip_dir_trailing_slashes(char *dir)
3243 char *end = dir + strlen(dir);
3245 while (dir < end - 1 && is_dir_sep(end[-1]))
3246 end--;
3247 *end = '\0';
3250 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
3252 DIR *dir;
3253 struct dirent *e;
3254 int ret = 0, original_len = path->len, len, kept_down = 0;
3255 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
3256 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
3257 int purge_original_cwd = (flag & REMOVE_DIR_PURGE_ORIGINAL_CWD);
3258 struct object_id submodule_head;
3260 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
3261 !resolve_gitlink_ref(path->buf, "HEAD", &submodule_head)) {
3262 /* Do not descend and nuke a nested git work tree. */
3263 if (kept_up)
3264 *kept_up = 1;
3265 return 0;
3268 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
3269 dir = opendir(path->buf);
3270 if (!dir) {
3271 if (errno == ENOENT)
3272 return keep_toplevel ? -1 : 0;
3273 else if (errno == EACCES && !keep_toplevel)
3275 * An empty dir could be removable even if it
3276 * is unreadable:
3278 return rmdir(path->buf);
3279 else
3280 return -1;
3282 strbuf_complete(path, '/');
3284 len = path->len;
3285 while ((e = readdir_skip_dot_and_dotdot(dir)) != NULL) {
3286 struct stat st;
3288 strbuf_setlen(path, len);
3289 strbuf_addstr(path, e->d_name);
3290 if (lstat(path->buf, &st)) {
3291 if (errno == ENOENT)
3293 * file disappeared, which is what we
3294 * wanted anyway
3296 continue;
3297 /* fall through */
3298 } else if (S_ISDIR(st.st_mode)) {
3299 if (!remove_dir_recurse(path, flag, &kept_down))
3300 continue; /* happy */
3301 } else if (!only_empty &&
3302 (!unlink(path->buf) || errno == ENOENT)) {
3303 continue; /* happy, too */
3306 /* path too long, stat fails, or non-directory still exists */
3307 ret = -1;
3308 break;
3310 closedir(dir);
3312 strbuf_setlen(path, original_len);
3313 if (!ret && !keep_toplevel && !kept_down) {
3314 if (!purge_original_cwd &&
3315 startup_info->original_cwd &&
3316 !strcmp(startup_info->original_cwd, path->buf))
3317 ret = -1; /* Do not remove current working directory */
3318 else
3319 ret = (!rmdir(path->buf) || errno == ENOENT) ? 0 : -1;
3320 } else if (kept_up)
3322 * report the uplevel that it is not an error that we
3323 * did not rmdir() our directory.
3325 *kept_up = !ret;
3326 return ret;
3329 int remove_dir_recursively(struct strbuf *path, int flag)
3331 return remove_dir_recurse(path, flag, NULL);
3334 static GIT_PATH_FUNC(git_path_info_exclude, "info/exclude")
3336 void setup_standard_excludes(struct dir_struct *dir)
3338 dir->exclude_per_dir = ".gitignore";
3340 /* core.excludesfile defaulting to $XDG_CONFIG_HOME/git/ignore */
3341 if (!excludes_file)
3342 excludes_file = xdg_config_home("ignore");
3343 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
3344 add_patterns_from_file_1(dir, excludes_file,
3345 dir->untracked ? &dir->ss_excludes_file : NULL);
3347 /* per repository user preference */
3348 if (startup_info->have_repository) {
3349 const char *path = git_path_info_exclude();
3350 if (!access_or_warn(path, R_OK, 0))
3351 add_patterns_from_file_1(dir, path,
3352 dir->untracked ? &dir->ss_info_exclude : NULL);
3356 char *get_sparse_checkout_filename(void)
3358 return git_pathdup("info/sparse-checkout");
3361 int get_sparse_checkout_patterns(struct pattern_list *pl)
3363 int res;
3364 char *sparse_filename = get_sparse_checkout_filename();
3366 pl->use_cone_patterns = core_sparse_checkout_cone;
3367 res = add_patterns_from_file_to_list(sparse_filename, "", 0, pl, NULL, 0);
3369 free(sparse_filename);
3370 return res;
3373 int remove_path(const char *name)
3375 char *slash;
3377 if (unlink(name) && !is_missing_file_error(errno))
3378 return -1;
3380 slash = strrchr(name, '/');
3381 if (slash) {
3382 char *dirs = xstrdup(name);
3383 slash = dirs + (slash - name);
3384 do {
3385 *slash = '\0';
3386 if (startup_info->original_cwd &&
3387 !strcmp(startup_info->original_cwd, dirs))
3388 break;
3389 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
3390 free(dirs);
3392 return 0;
3396 * Frees memory within dir which was allocated, and resets fields for further
3397 * use. Does not free dir itself.
3399 void dir_clear(struct dir_struct *dir)
3401 int i, j;
3402 struct exclude_list_group *group;
3403 struct pattern_list *pl;
3404 struct exclude_stack *stk;
3405 struct dir_struct new = DIR_INIT;
3407 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
3408 group = &dir->exclude_list_group[i];
3409 for (j = 0; j < group->nr; j++) {
3410 pl = &group->pl[j];
3411 if (i == EXC_DIRS)
3412 free((char *)pl->src);
3413 clear_pattern_list(pl);
3415 free(group->pl);
3418 for (i = 0; i < dir->ignored_nr; i++)
3419 free(dir->ignored[i]);
3420 for (i = 0; i < dir->nr; i++)
3421 free(dir->entries[i]);
3422 free(dir->ignored);
3423 free(dir->entries);
3425 stk = dir->exclude_stack;
3426 while (stk) {
3427 struct exclude_stack *prev = stk->prev;
3428 free(stk);
3429 stk = prev;
3431 strbuf_release(&dir->basebuf);
3433 memcpy(dir, &new, sizeof(*dir));
3436 struct ondisk_untracked_cache {
3437 struct stat_data info_exclude_stat;
3438 struct stat_data excludes_file_stat;
3439 uint32_t dir_flags;
3442 #define ouc_offset(x) offsetof(struct ondisk_untracked_cache, x)
3444 struct write_data {
3445 int index; /* number of written untracked_cache_dir */
3446 struct ewah_bitmap *check_only; /* from untracked_cache_dir */
3447 struct ewah_bitmap *valid; /* from untracked_cache_dir */
3448 struct ewah_bitmap *sha1_valid; /* set if exclude_sha1 is not null */
3449 struct strbuf out;
3450 struct strbuf sb_stat;
3451 struct strbuf sb_sha1;
3454 static void stat_data_to_disk(struct stat_data *to, const struct stat_data *from)
3456 to->sd_ctime.sec = htonl(from->sd_ctime.sec);
3457 to->sd_ctime.nsec = htonl(from->sd_ctime.nsec);
3458 to->sd_mtime.sec = htonl(from->sd_mtime.sec);
3459 to->sd_mtime.nsec = htonl(from->sd_mtime.nsec);
3460 to->sd_dev = htonl(from->sd_dev);
3461 to->sd_ino = htonl(from->sd_ino);
3462 to->sd_uid = htonl(from->sd_uid);
3463 to->sd_gid = htonl(from->sd_gid);
3464 to->sd_size = htonl(from->sd_size);
3467 static void write_one_dir(struct untracked_cache_dir *untracked,
3468 struct write_data *wd)
3470 struct stat_data stat_data;
3471 struct strbuf *out = &wd->out;
3472 unsigned char intbuf[16];
3473 unsigned int intlen, value;
3474 int i = wd->index++;
3477 * untracked_nr should be reset whenever valid is clear, but
3478 * for safety..
3480 if (!untracked->valid) {
3481 untracked->untracked_nr = 0;
3482 untracked->check_only = 0;
3485 if (untracked->check_only)
3486 ewah_set(wd->check_only, i);
3487 if (untracked->valid) {
3488 ewah_set(wd->valid, i);
3489 stat_data_to_disk(&stat_data, &untracked->stat_data);
3490 strbuf_add(&wd->sb_stat, &stat_data, sizeof(stat_data));
3492 if (!is_null_oid(&untracked->exclude_oid)) {
3493 ewah_set(wd->sha1_valid, i);
3494 strbuf_add(&wd->sb_sha1, untracked->exclude_oid.hash,
3495 the_hash_algo->rawsz);
3498 intlen = encode_varint(untracked->untracked_nr, intbuf);
3499 strbuf_add(out, intbuf, intlen);
3501 /* skip non-recurse directories */
3502 for (i = 0, value = 0; i < untracked->dirs_nr; i++)
3503 if (untracked->dirs[i]->recurse)
3504 value++;
3505 intlen = encode_varint(value, intbuf);
3506 strbuf_add(out, intbuf, intlen);
3508 strbuf_add(out, untracked->name, strlen(untracked->name) + 1);
3510 for (i = 0; i < untracked->untracked_nr; i++)
3511 strbuf_add(out, untracked->untracked[i],
3512 strlen(untracked->untracked[i]) + 1);
3514 for (i = 0; i < untracked->dirs_nr; i++)
3515 if (untracked->dirs[i]->recurse)
3516 write_one_dir(untracked->dirs[i], wd);
3519 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked)
3521 struct ondisk_untracked_cache *ouc;
3522 struct write_data wd;
3523 unsigned char varbuf[16];
3524 int varint_len;
3525 const unsigned hashsz = the_hash_algo->rawsz;
3527 CALLOC_ARRAY(ouc, 1);
3528 stat_data_to_disk(&ouc->info_exclude_stat, &untracked->ss_info_exclude.stat);
3529 stat_data_to_disk(&ouc->excludes_file_stat, &untracked->ss_excludes_file.stat);
3530 ouc->dir_flags = htonl(untracked->dir_flags);
3532 varint_len = encode_varint(untracked->ident.len, varbuf);
3533 strbuf_add(out, varbuf, varint_len);
3534 strbuf_addbuf(out, &untracked->ident);
3536 strbuf_add(out, ouc, sizeof(*ouc));
3537 strbuf_add(out, untracked->ss_info_exclude.oid.hash, hashsz);
3538 strbuf_add(out, untracked->ss_excludes_file.oid.hash, hashsz);
3539 strbuf_add(out, untracked->exclude_per_dir, strlen(untracked->exclude_per_dir) + 1);
3540 FREE_AND_NULL(ouc);
3542 if (!untracked->root) {
3543 varint_len = encode_varint(0, varbuf);
3544 strbuf_add(out, varbuf, varint_len);
3545 return;
3548 wd.index = 0;
3549 wd.check_only = ewah_new();
3550 wd.valid = ewah_new();
3551 wd.sha1_valid = ewah_new();
3552 strbuf_init(&wd.out, 1024);
3553 strbuf_init(&wd.sb_stat, 1024);
3554 strbuf_init(&wd.sb_sha1, 1024);
3555 write_one_dir(untracked->root, &wd);
3557 varint_len = encode_varint(wd.index, varbuf);
3558 strbuf_add(out, varbuf, varint_len);
3559 strbuf_addbuf(out, &wd.out);
3560 ewah_serialize_strbuf(wd.valid, out);
3561 ewah_serialize_strbuf(wd.check_only, out);
3562 ewah_serialize_strbuf(wd.sha1_valid, out);
3563 strbuf_addbuf(out, &wd.sb_stat);
3564 strbuf_addbuf(out, &wd.sb_sha1);
3565 strbuf_addch(out, '\0'); /* safe guard for string lists */
3567 ewah_free(wd.valid);
3568 ewah_free(wd.check_only);
3569 ewah_free(wd.sha1_valid);
3570 strbuf_release(&wd.out);
3571 strbuf_release(&wd.sb_stat);
3572 strbuf_release(&wd.sb_sha1);
3575 static void free_untracked(struct untracked_cache_dir *ucd)
3577 int i;
3578 if (!ucd)
3579 return;
3580 for (i = 0; i < ucd->dirs_nr; i++)
3581 free_untracked(ucd->dirs[i]);
3582 for (i = 0; i < ucd->untracked_nr; i++)
3583 free(ucd->untracked[i]);
3584 free(ucd->untracked);
3585 free(ucd->dirs);
3586 free(ucd);
3589 void free_untracked_cache(struct untracked_cache *uc)
3591 if (uc)
3592 free_untracked(uc->root);
3593 free(uc);
3596 struct read_data {
3597 int index;
3598 struct untracked_cache_dir **ucd;
3599 struct ewah_bitmap *check_only;
3600 struct ewah_bitmap *valid;
3601 struct ewah_bitmap *sha1_valid;
3602 const unsigned char *data;
3603 const unsigned char *end;
3606 static void stat_data_from_disk(struct stat_data *to, const unsigned char *data)
3608 memcpy(to, data, sizeof(*to));
3609 to->sd_ctime.sec = ntohl(to->sd_ctime.sec);
3610 to->sd_ctime.nsec = ntohl(to->sd_ctime.nsec);
3611 to->sd_mtime.sec = ntohl(to->sd_mtime.sec);
3612 to->sd_mtime.nsec = ntohl(to->sd_mtime.nsec);
3613 to->sd_dev = ntohl(to->sd_dev);
3614 to->sd_ino = ntohl(to->sd_ino);
3615 to->sd_uid = ntohl(to->sd_uid);
3616 to->sd_gid = ntohl(to->sd_gid);
3617 to->sd_size = ntohl(to->sd_size);
3620 static int read_one_dir(struct untracked_cache_dir **untracked_,
3621 struct read_data *rd)
3623 struct untracked_cache_dir ud, *untracked;
3624 const unsigned char *data = rd->data, *end = rd->end;
3625 const unsigned char *eos;
3626 unsigned int value;
3627 int i;
3629 memset(&ud, 0, sizeof(ud));
3631 value = decode_varint(&data);
3632 if (data > end)
3633 return -1;
3634 ud.recurse = 1;
3635 ud.untracked_alloc = value;
3636 ud.untracked_nr = value;
3637 if (ud.untracked_nr)
3638 ALLOC_ARRAY(ud.untracked, ud.untracked_nr);
3640 ud.dirs_alloc = ud.dirs_nr = decode_varint(&data);
3641 if (data > end)
3642 return -1;
3643 ALLOC_ARRAY(ud.dirs, ud.dirs_nr);
3645 eos = memchr(data, '\0', end - data);
3646 if (!eos || eos == end)
3647 return -1;
3649 *untracked_ = untracked = xmalloc(st_add3(sizeof(*untracked), eos - data, 1));
3650 memcpy(untracked, &ud, sizeof(ud));
3651 memcpy(untracked->name, data, eos - data + 1);
3652 data = eos + 1;
3654 for (i = 0; i < untracked->untracked_nr; i++) {
3655 eos = memchr(data, '\0', end - data);
3656 if (!eos || eos == end)
3657 return -1;
3658 untracked->untracked[i] = xmemdupz(data, eos - data);
3659 data = eos + 1;
3662 rd->ucd[rd->index++] = untracked;
3663 rd->data = data;
3665 for (i = 0; i < untracked->dirs_nr; i++) {
3666 if (read_one_dir(untracked->dirs + i, rd) < 0)
3667 return -1;
3669 return 0;
3672 static void set_check_only(size_t pos, void *cb)
3674 struct read_data *rd = cb;
3675 struct untracked_cache_dir *ud = rd->ucd[pos];
3676 ud->check_only = 1;
3679 static void read_stat(size_t pos, void *cb)
3681 struct read_data *rd = cb;
3682 struct untracked_cache_dir *ud = rd->ucd[pos];
3683 if (rd->data + sizeof(struct stat_data) > rd->end) {
3684 rd->data = rd->end + 1;
3685 return;
3687 stat_data_from_disk(&ud->stat_data, rd->data);
3688 rd->data += sizeof(struct stat_data);
3689 ud->valid = 1;
3692 static void read_oid(size_t pos, void *cb)
3694 struct read_data *rd = cb;
3695 struct untracked_cache_dir *ud = rd->ucd[pos];
3696 if (rd->data + the_hash_algo->rawsz > rd->end) {
3697 rd->data = rd->end + 1;
3698 return;
3700 oidread(&ud->exclude_oid, rd->data);
3701 rd->data += the_hash_algo->rawsz;
3704 static void load_oid_stat(struct oid_stat *oid_stat, const unsigned char *data,
3705 const unsigned char *sha1)
3707 stat_data_from_disk(&oid_stat->stat, data);
3708 oidread(&oid_stat->oid, sha1);
3709 oid_stat->valid = 1;
3712 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz)
3714 struct untracked_cache *uc;
3715 struct read_data rd;
3716 const unsigned char *next = data, *end = (const unsigned char *)data + sz;
3717 const char *ident;
3718 int ident_len;
3719 ssize_t len;
3720 const char *exclude_per_dir;
3721 const unsigned hashsz = the_hash_algo->rawsz;
3722 const unsigned offset = sizeof(struct ondisk_untracked_cache);
3723 const unsigned exclude_per_dir_offset = offset + 2 * hashsz;
3725 if (sz <= 1 || end[-1] != '\0')
3726 return NULL;
3727 end--;
3729 ident_len = decode_varint(&next);
3730 if (next + ident_len > end)
3731 return NULL;
3732 ident = (const char *)next;
3733 next += ident_len;
3735 if (next + exclude_per_dir_offset + 1 > end)
3736 return NULL;
3738 CALLOC_ARRAY(uc, 1);
3739 strbuf_init(&uc->ident, ident_len);
3740 strbuf_add(&uc->ident, ident, ident_len);
3741 load_oid_stat(&uc->ss_info_exclude,
3742 next + ouc_offset(info_exclude_stat),
3743 next + offset);
3744 load_oid_stat(&uc->ss_excludes_file,
3745 next + ouc_offset(excludes_file_stat),
3746 next + offset + hashsz);
3747 uc->dir_flags = get_be32(next + ouc_offset(dir_flags));
3748 exclude_per_dir = (const char *)next + exclude_per_dir_offset;
3749 uc->exclude_per_dir = xstrdup(exclude_per_dir);
3750 /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
3751 next += exclude_per_dir_offset + strlen(exclude_per_dir) + 1;
3752 if (next >= end)
3753 goto done2;
3755 len = decode_varint(&next);
3756 if (next > end || len == 0)
3757 goto done2;
3759 rd.valid = ewah_new();
3760 rd.check_only = ewah_new();
3761 rd.sha1_valid = ewah_new();
3762 rd.data = next;
3763 rd.end = end;
3764 rd.index = 0;
3765 ALLOC_ARRAY(rd.ucd, len);
3767 if (read_one_dir(&uc->root, &rd) || rd.index != len)
3768 goto done;
3770 next = rd.data;
3771 len = ewah_read_mmap(rd.valid, next, end - next);
3772 if (len < 0)
3773 goto done;
3775 next += len;
3776 len = ewah_read_mmap(rd.check_only, next, end - next);
3777 if (len < 0)
3778 goto done;
3780 next += len;
3781 len = ewah_read_mmap(rd.sha1_valid, next, end - next);
3782 if (len < 0)
3783 goto done;
3785 ewah_each_bit(rd.check_only, set_check_only, &rd);
3786 rd.data = next + len;
3787 ewah_each_bit(rd.valid, read_stat, &rd);
3788 ewah_each_bit(rd.sha1_valid, read_oid, &rd);
3789 next = rd.data;
3791 done:
3792 free(rd.ucd);
3793 ewah_free(rd.valid);
3794 ewah_free(rd.check_only);
3795 ewah_free(rd.sha1_valid);
3796 done2:
3797 if (next != end) {
3798 free_untracked_cache(uc);
3799 uc = NULL;
3801 return uc;
3804 static void invalidate_one_directory(struct untracked_cache *uc,
3805 struct untracked_cache_dir *ucd)
3807 uc->dir_invalidated++;
3808 ucd->valid = 0;
3809 ucd->untracked_nr = 0;
3813 * Normally when an entry is added or removed from a directory,
3814 * invalidating that directory is enough. No need to touch its
3815 * ancestors. When a directory is shown as "foo/bar/" in git-status
3816 * however, deleting or adding an entry may have cascading effect.
3818 * Say the "foo/bar/file" has become untracked, we need to tell the
3819 * untracked_cache_dir of "foo" that "bar/" is not an untracked
3820 * directory any more (because "bar" is managed by foo as an untracked
3821 * "file").
3823 * Similarly, if "foo/bar/file" moves from untracked to tracked and it
3824 * was the last untracked entry in the entire "foo", we should show
3825 * "foo/" instead. Which means we have to invalidate past "bar" up to
3826 * "foo".
3828 * This function traverses all directories from root to leaf. If there
3829 * is a chance of one of the above cases happening, we invalidate back
3830 * to root. Otherwise we just invalidate the leaf. There may be a more
3831 * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
3832 * detect these cases and avoid unnecessary invalidation, for example,
3833 * checking for the untracked entry named "bar/" in "foo", but for now
3834 * stick to something safe and simple.
3836 static int invalidate_one_component(struct untracked_cache *uc,
3837 struct untracked_cache_dir *dir,
3838 const char *path, int len)
3840 const char *rest = strchr(path, '/');
3842 if (rest) {
3843 int component_len = rest - path;
3844 struct untracked_cache_dir *d =
3845 lookup_untracked(uc, dir, path, component_len);
3846 int ret =
3847 invalidate_one_component(uc, d, rest + 1,
3848 len - (component_len + 1));
3849 if (ret)
3850 invalidate_one_directory(uc, dir);
3851 return ret;
3854 invalidate_one_directory(uc, dir);
3855 return uc->dir_flags & DIR_SHOW_OTHER_DIRECTORIES;
3858 void untracked_cache_invalidate_path(struct index_state *istate,
3859 const char *path, int safe_path)
3861 if (!istate->untracked || !istate->untracked->root)
3862 return;
3863 if (!safe_path && !verify_path(path, 0))
3864 return;
3865 invalidate_one_component(istate->untracked, istate->untracked->root,
3866 path, strlen(path));
3869 void untracked_cache_remove_from_index(struct index_state *istate,
3870 const char *path)
3872 untracked_cache_invalidate_path(istate, path, 1);
3875 void untracked_cache_add_to_index(struct index_state *istate,
3876 const char *path)
3878 untracked_cache_invalidate_path(istate, path, 1);
3881 static void connect_wt_gitdir_in_nested(const char *sub_worktree,
3882 const char *sub_gitdir)
3884 int i;
3885 struct repository subrepo;
3886 struct strbuf sub_wt = STRBUF_INIT;
3887 struct strbuf sub_gd = STRBUF_INIT;
3889 const struct submodule *sub;
3891 /* If the submodule has no working tree, we can ignore it. */
3892 if (repo_init(&subrepo, sub_gitdir, sub_worktree))
3893 return;
3895 if (repo_read_index(&subrepo) < 0)
3896 die(_("index file corrupt in repo %s"), subrepo.gitdir);
3898 /* TODO: audit for interaction with sparse-index. */
3899 ensure_full_index(subrepo.index);
3900 for (i = 0; i < subrepo.index->cache_nr; i++) {
3901 const struct cache_entry *ce = subrepo.index->cache[i];
3903 if (!S_ISGITLINK(ce->ce_mode))
3904 continue;
3906 while (i + 1 < subrepo.index->cache_nr &&
3907 !strcmp(ce->name, subrepo.index->cache[i + 1]->name))
3909 * Skip entries with the same name in different stages
3910 * to make sure an entry is returned only once.
3912 i++;
3914 sub = submodule_from_path(&subrepo, null_oid(), ce->name);
3915 if (!sub || !is_submodule_active(&subrepo, ce->name))
3916 /* .gitmodules broken or inactive sub */
3917 continue;
3919 strbuf_reset(&sub_wt);
3920 strbuf_reset(&sub_gd);
3921 strbuf_addf(&sub_wt, "%s/%s", sub_worktree, sub->path);
3922 submodule_name_to_gitdir(&sub_gd, &subrepo, sub->name);
3924 connect_work_tree_and_git_dir(sub_wt.buf, sub_gd.buf, 1);
3926 strbuf_release(&sub_wt);
3927 strbuf_release(&sub_gd);
3928 repo_clear(&subrepo);
3931 void connect_work_tree_and_git_dir(const char *work_tree_,
3932 const char *git_dir_,
3933 int recurse_into_nested)
3935 struct strbuf gitfile_sb = STRBUF_INIT;
3936 struct strbuf cfg_sb = STRBUF_INIT;
3937 struct strbuf rel_path = STRBUF_INIT;
3938 char *git_dir, *work_tree;
3940 /* Prepare .git file */
3941 strbuf_addf(&gitfile_sb, "%s/.git", work_tree_);
3942 if (safe_create_leading_directories_const(gitfile_sb.buf))
3943 die(_("could not create directories for %s"), gitfile_sb.buf);
3945 /* Prepare config file */
3946 strbuf_addf(&cfg_sb, "%s/config", git_dir_);
3947 if (safe_create_leading_directories_const(cfg_sb.buf))
3948 die(_("could not create directories for %s"), cfg_sb.buf);
3950 git_dir = real_pathdup(git_dir_, 1);
3951 work_tree = real_pathdup(work_tree_, 1);
3953 /* Write .git file */
3954 write_file(gitfile_sb.buf, "gitdir: %s",
3955 relative_path(git_dir, work_tree, &rel_path));
3956 /* Update core.worktree setting */
3957 git_config_set_in_file(cfg_sb.buf, "core.worktree",
3958 relative_path(work_tree, git_dir, &rel_path));
3960 strbuf_release(&gitfile_sb);
3961 strbuf_release(&cfg_sb);
3962 strbuf_release(&rel_path);
3964 if (recurse_into_nested)
3965 connect_wt_gitdir_in_nested(work_tree, git_dir);
3967 free(work_tree);
3968 free(git_dir);
3972 * Migrate the git directory of the given path from old_git_dir to new_git_dir.
3974 void relocate_gitdir(const char *path, const char *old_git_dir, const char *new_git_dir)
3976 if (rename(old_git_dir, new_git_dir) < 0)
3977 die_errno(_("could not migrate git directory from '%s' to '%s'"),
3978 old_git_dir, new_git_dir);
3980 connect_work_tree_and_git_dir(path, new_git_dir, 0);
3983 int path_match_flags(const char *const str, const enum path_match_flags flags)
3985 const char *p = str;
3987 if (flags & PATH_MATCH_NATIVE &&
3988 flags & PATH_MATCH_XPLATFORM)
3989 BUG("path_match_flags() must get one match kind, not multiple!");
3990 else if (!(flags & PATH_MATCH_KINDS_MASK))
3991 BUG("path_match_flags() must get at least one match kind!");
3993 if (flags & PATH_MATCH_STARTS_WITH_DOT_SLASH &&
3994 flags & PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH)
3995 BUG("path_match_flags() must get one platform kind, not multiple!");
3996 else if (!(flags & PATH_MATCH_PLATFORM_MASK))
3997 BUG("path_match_flags() must get at least one platform kind!");
3999 if (*p++ != '.')
4000 return 0;
4001 if (flags & PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH &&
4002 *p++ != '.')
4003 return 0;
4005 if (flags & PATH_MATCH_NATIVE)
4006 return is_dir_sep(*p);
4007 else if (flags & PATH_MATCH_XPLATFORM)
4008 return is_xplatform_dir_sep(*p);
4009 BUG("unreachable");