Git 2.35.8
[git.git] / dir.c
blob689c98cb4a0ea6bb56bab6f7d20dfde365d35edb
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 *unused_cmp_data,
659 const struct hashmap_entry *a,
660 const struct hashmap_entry *b,
661 const void *key)
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 if (ignore_case)
673 return strncasecmp(ee1->pattern, ee2->pattern, min_len);
674 return strncmp(ee1->pattern, ee2->pattern, min_len);
677 static char *dup_and_filter_pattern(const char *pattern)
679 char *set, *read;
680 size_t count = 0;
681 char *result = xstrdup(pattern);
683 set = result;
684 read = result;
686 while (*read) {
687 /* skip escape characters (once) */
688 if (*read == '\\')
689 read++;
691 *set = *read;
693 set++;
694 read++;
695 count++;
697 *set = 0;
699 if (count > 2 &&
700 *(set - 1) == '*' &&
701 *(set - 2) == '/')
702 *(set - 2) = 0;
704 return result;
707 static void add_pattern_to_hashsets(struct pattern_list *pl, struct path_pattern *given)
709 struct pattern_entry *translated;
710 char *truncated;
711 char *data = NULL;
712 const char *prev, *cur, *next;
714 if (!pl->use_cone_patterns)
715 return;
717 if (given->flags & PATTERN_FLAG_NEGATIVE &&
718 given->flags & PATTERN_FLAG_MUSTBEDIR &&
719 !strcmp(given->pattern, "/*")) {
720 pl->full_cone = 0;
721 return;
724 if (!given->flags && !strcmp(given->pattern, "/*")) {
725 pl->full_cone = 1;
726 return;
729 if (given->patternlen < 2 ||
730 *given->pattern != '/' ||
731 strstr(given->pattern, "**")) {
732 /* Not a cone pattern. */
733 warning(_("unrecognized pattern: '%s'"), given->pattern);
734 goto clear_hashmaps;
737 prev = given->pattern;
738 cur = given->pattern + 1;
739 next = given->pattern + 2;
741 while (*cur) {
742 /* Watch for glob characters '*', '\', '[', '?' */
743 if (!is_glob_special(*cur))
744 goto increment;
746 /* But only if *prev != '\\' */
747 if (*prev == '\\')
748 goto increment;
750 /* But allow the initial '\' */
751 if (*cur == '\\' &&
752 is_glob_special(*next))
753 goto increment;
755 /* But a trailing '/' then '*' is fine */
756 if (*prev == '/' &&
757 *cur == '*' &&
758 *next == 0)
759 goto increment;
761 /* Not a cone pattern. */
762 warning(_("unrecognized pattern: '%s'"), given->pattern);
763 goto clear_hashmaps;
765 increment:
766 prev++;
767 cur++;
768 next++;
771 if (given->patternlen > 2 &&
772 !strcmp(given->pattern + given->patternlen - 2, "/*")) {
773 if (!(given->flags & PATTERN_FLAG_NEGATIVE)) {
774 /* Not a cone pattern. */
775 warning(_("unrecognized pattern: '%s'"), given->pattern);
776 goto clear_hashmaps;
779 truncated = dup_and_filter_pattern(given->pattern);
781 translated = xmalloc(sizeof(struct pattern_entry));
782 translated->pattern = truncated;
783 translated->patternlen = given->patternlen - 2;
784 hashmap_entry_init(&translated->ent,
785 fspathhash(translated->pattern));
787 if (!hashmap_get_entry(&pl->recursive_hashmap,
788 translated, ent, NULL)) {
789 /* We did not see the "parent" included */
790 warning(_("unrecognized negative pattern: '%s'"),
791 given->pattern);
792 free(truncated);
793 free(translated);
794 goto clear_hashmaps;
797 hashmap_add(&pl->parent_hashmap, &translated->ent);
798 hashmap_remove(&pl->recursive_hashmap, &translated->ent, &data);
799 free(data);
800 return;
803 if (given->flags & PATTERN_FLAG_NEGATIVE) {
804 warning(_("unrecognized negative pattern: '%s'"),
805 given->pattern);
806 goto clear_hashmaps;
809 translated = xmalloc(sizeof(struct pattern_entry));
811 translated->pattern = dup_and_filter_pattern(given->pattern);
812 translated->patternlen = given->patternlen;
813 hashmap_entry_init(&translated->ent,
814 fspathhash(translated->pattern));
816 hashmap_add(&pl->recursive_hashmap, &translated->ent);
818 if (hashmap_get_entry(&pl->parent_hashmap, translated, ent, NULL)) {
819 /* we already included this at the parent level */
820 warning(_("your sparse-checkout file may have issues: pattern '%s' is repeated"),
821 given->pattern);
822 goto clear_hashmaps;
825 return;
827 clear_hashmaps:
828 warning(_("disabling cone pattern matching"));
829 hashmap_clear_and_free(&pl->parent_hashmap, struct pattern_entry, ent);
830 hashmap_clear_and_free(&pl->recursive_hashmap, struct pattern_entry, ent);
831 pl->use_cone_patterns = 0;
834 static int hashmap_contains_path(struct hashmap *map,
835 struct strbuf *pattern)
837 struct pattern_entry p;
839 /* Check straight mapping */
840 p.pattern = pattern->buf;
841 p.patternlen = pattern->len;
842 hashmap_entry_init(&p.ent, fspathhash(p.pattern));
843 return !!hashmap_get_entry(map, &p, ent, NULL);
846 int hashmap_contains_parent(struct hashmap *map,
847 const char *path,
848 struct strbuf *buffer)
850 char *slash_pos;
852 strbuf_setlen(buffer, 0);
854 if (path[0] != '/')
855 strbuf_addch(buffer, '/');
857 strbuf_addstr(buffer, path);
859 slash_pos = strrchr(buffer->buf, '/');
861 while (slash_pos > buffer->buf) {
862 strbuf_setlen(buffer, slash_pos - buffer->buf);
864 if (hashmap_contains_path(map, buffer))
865 return 1;
867 slash_pos = strrchr(buffer->buf, '/');
870 return 0;
873 void add_pattern(const char *string, const char *base,
874 int baselen, struct pattern_list *pl, int srcpos)
876 struct path_pattern *pattern;
877 int patternlen;
878 unsigned flags;
879 int nowildcardlen;
881 parse_path_pattern(&string, &patternlen, &flags, &nowildcardlen);
882 if (flags & PATTERN_FLAG_MUSTBEDIR) {
883 FLEXPTR_ALLOC_MEM(pattern, pattern, string, patternlen);
884 } else {
885 pattern = xmalloc(sizeof(*pattern));
886 pattern->pattern = string;
888 pattern->patternlen = patternlen;
889 pattern->nowildcardlen = nowildcardlen;
890 pattern->base = base;
891 pattern->baselen = baselen;
892 pattern->flags = flags;
893 pattern->srcpos = srcpos;
894 ALLOC_GROW(pl->patterns, pl->nr + 1, pl->alloc);
895 pl->patterns[pl->nr++] = pattern;
896 pattern->pl = pl;
898 add_pattern_to_hashsets(pl, pattern);
901 static int read_skip_worktree_file_from_index(struct index_state *istate,
902 const char *path,
903 size_t *size_out, char **data_out,
904 struct oid_stat *oid_stat)
906 int pos, len;
908 len = strlen(path);
909 pos = index_name_pos(istate, path, len);
910 if (pos < 0)
911 return -1;
912 if (!ce_skip_worktree(istate->cache[pos]))
913 return -1;
915 return do_read_blob(&istate->cache[pos]->oid, oid_stat, size_out, data_out);
919 * Frees memory within pl which was allocated for exclude patterns and
920 * the file buffer. Does not free pl itself.
922 void clear_pattern_list(struct pattern_list *pl)
924 int i;
926 for (i = 0; i < pl->nr; i++)
927 free(pl->patterns[i]);
928 free(pl->patterns);
929 free(pl->filebuf);
930 hashmap_clear_and_free(&pl->recursive_hashmap, struct pattern_entry, ent);
931 hashmap_clear_and_free(&pl->parent_hashmap, struct pattern_entry, ent);
933 memset(pl, 0, sizeof(*pl));
936 static void trim_trailing_spaces(char *buf)
938 char *p, *last_space = NULL;
940 for (p = buf; *p; p++)
941 switch (*p) {
942 case ' ':
943 if (!last_space)
944 last_space = p;
945 break;
946 case '\\':
947 p++;
948 if (!*p)
949 return;
950 /* fallthrough */
951 default:
952 last_space = NULL;
955 if (last_space)
956 *last_space = '\0';
960 * Given a subdirectory name and "dir" of the current directory,
961 * search the subdir in "dir" and return it, or create a new one if it
962 * does not exist in "dir".
964 * If "name" has the trailing slash, it'll be excluded in the search.
966 static struct untracked_cache_dir *lookup_untracked(struct untracked_cache *uc,
967 struct untracked_cache_dir *dir,
968 const char *name, int len)
970 int first, last;
971 struct untracked_cache_dir *d;
972 if (!dir)
973 return NULL;
974 if (len && name[len - 1] == '/')
975 len--;
976 first = 0;
977 last = dir->dirs_nr;
978 while (last > first) {
979 int cmp, next = first + ((last - first) >> 1);
980 d = dir->dirs[next];
981 cmp = strncmp(name, d->name, len);
982 if (!cmp && strlen(d->name) > len)
983 cmp = -1;
984 if (!cmp)
985 return d;
986 if (cmp < 0) {
987 last = next;
988 continue;
990 first = next+1;
993 uc->dir_created++;
994 FLEX_ALLOC_MEM(d, name, name, len);
996 ALLOC_GROW(dir->dirs, dir->dirs_nr + 1, dir->dirs_alloc);
997 MOVE_ARRAY(dir->dirs + first + 1, dir->dirs + first,
998 dir->dirs_nr - first);
999 dir->dirs_nr++;
1000 dir->dirs[first] = d;
1001 return d;
1004 static void do_invalidate_gitignore(struct untracked_cache_dir *dir)
1006 int i;
1007 dir->valid = 0;
1008 dir->untracked_nr = 0;
1009 for (i = 0; i < dir->dirs_nr; i++)
1010 do_invalidate_gitignore(dir->dirs[i]);
1013 static void invalidate_gitignore(struct untracked_cache *uc,
1014 struct untracked_cache_dir *dir)
1016 uc->gitignore_invalidated++;
1017 do_invalidate_gitignore(dir);
1020 static void invalidate_directory(struct untracked_cache *uc,
1021 struct untracked_cache_dir *dir)
1023 int i;
1026 * Invalidation increment here is just roughly correct. If
1027 * untracked_nr or any of dirs[].recurse is non-zero, we
1028 * should increment dir_invalidated too. But that's more
1029 * expensive to do.
1031 if (dir->valid)
1032 uc->dir_invalidated++;
1034 dir->valid = 0;
1035 dir->untracked_nr = 0;
1036 for (i = 0; i < dir->dirs_nr; i++)
1037 dir->dirs[i]->recurse = 0;
1040 static int add_patterns_from_buffer(char *buf, size_t size,
1041 const char *base, int baselen,
1042 struct pattern_list *pl);
1044 /* Flags for add_patterns() */
1045 #define PATTERN_NOFOLLOW (1<<0)
1048 * Given a file with name "fname", read it (either from disk, or from
1049 * an index if 'istate' is non-null), parse it and store the
1050 * exclude rules in "pl".
1052 * If "oid_stat" is not NULL, compute oid of the exclude file and fill
1053 * stat data from disk (only valid if add_patterns returns zero). If
1054 * oid_stat.valid is non-zero, "oid_stat" must contain good value as input.
1056 static int add_patterns(const char *fname, const char *base, int baselen,
1057 struct pattern_list *pl, struct index_state *istate,
1058 unsigned flags, struct oid_stat *oid_stat)
1060 struct stat st;
1061 int r;
1062 int fd;
1063 size_t size = 0;
1064 char *buf;
1066 if (flags & PATTERN_NOFOLLOW)
1067 fd = open_nofollow(fname, O_RDONLY);
1068 else
1069 fd = open(fname, O_RDONLY);
1071 if (fd < 0 || fstat(fd, &st) < 0) {
1072 if (fd < 0)
1073 warn_on_fopen_errors(fname);
1074 else
1075 close(fd);
1076 if (!istate)
1077 return -1;
1078 r = read_skip_worktree_file_from_index(istate, fname,
1079 &size, &buf,
1080 oid_stat);
1081 if (r != 1)
1082 return r;
1083 } else {
1084 size = xsize_t(st.st_size);
1085 if (size == 0) {
1086 if (oid_stat) {
1087 fill_stat_data(&oid_stat->stat, &st);
1088 oidcpy(&oid_stat->oid, the_hash_algo->empty_blob);
1089 oid_stat->valid = 1;
1091 close(fd);
1092 return 0;
1094 buf = xmallocz(size);
1095 if (read_in_full(fd, buf, size) != size) {
1096 free(buf);
1097 close(fd);
1098 return -1;
1100 buf[size++] = '\n';
1101 close(fd);
1102 if (oid_stat) {
1103 int pos;
1104 if (oid_stat->valid &&
1105 !match_stat_data_racy(istate, &oid_stat->stat, &st))
1106 ; /* no content change, oid_stat->oid still good */
1107 else if (istate &&
1108 (pos = index_name_pos(istate, fname, strlen(fname))) >= 0 &&
1109 !ce_stage(istate->cache[pos]) &&
1110 ce_uptodate(istate->cache[pos]) &&
1111 !would_convert_to_git(istate, fname))
1112 oidcpy(&oid_stat->oid,
1113 &istate->cache[pos]->oid);
1114 else
1115 hash_object_file(the_hash_algo, buf, size,
1116 "blob", &oid_stat->oid);
1117 fill_stat_data(&oid_stat->stat, &st);
1118 oid_stat->valid = 1;
1122 add_patterns_from_buffer(buf, size, base, baselen, pl);
1123 return 0;
1126 static int add_patterns_from_buffer(char *buf, size_t size,
1127 const char *base, int baselen,
1128 struct pattern_list *pl)
1130 int i, lineno = 1;
1131 char *entry;
1133 hashmap_init(&pl->recursive_hashmap, pl_hashmap_cmp, NULL, 0);
1134 hashmap_init(&pl->parent_hashmap, pl_hashmap_cmp, NULL, 0);
1136 pl->filebuf = buf;
1138 if (skip_utf8_bom(&buf, size))
1139 size -= buf - pl->filebuf;
1141 entry = buf;
1143 for (i = 0; i < size; i++) {
1144 if (buf[i] == '\n') {
1145 if (entry != buf + i && entry[0] != '#') {
1146 buf[i - (i && buf[i-1] == '\r')] = 0;
1147 trim_trailing_spaces(entry);
1148 add_pattern(entry, base, baselen, pl, lineno);
1150 lineno++;
1151 entry = buf + i + 1;
1154 return 0;
1157 int add_patterns_from_file_to_list(const char *fname, const char *base,
1158 int baselen, struct pattern_list *pl,
1159 struct index_state *istate,
1160 unsigned flags)
1162 return add_patterns(fname, base, baselen, pl, istate, flags, NULL);
1165 int add_patterns_from_blob_to_list(
1166 struct object_id *oid,
1167 const char *base, int baselen,
1168 struct pattern_list *pl)
1170 char *buf;
1171 size_t size;
1172 int r;
1174 r = do_read_blob(oid, NULL, &size, &buf);
1175 if (r != 1)
1176 return r;
1178 add_patterns_from_buffer(buf, size, base, baselen, pl);
1179 return 0;
1182 struct pattern_list *add_pattern_list(struct dir_struct *dir,
1183 int group_type, const char *src)
1185 struct pattern_list *pl;
1186 struct exclude_list_group *group;
1188 group = &dir->exclude_list_group[group_type];
1189 ALLOC_GROW(group->pl, group->nr + 1, group->alloc);
1190 pl = &group->pl[group->nr++];
1191 memset(pl, 0, sizeof(*pl));
1192 pl->src = src;
1193 return pl;
1197 * Used to set up core.excludesfile and .git/info/exclude lists.
1199 static void add_patterns_from_file_1(struct dir_struct *dir, const char *fname,
1200 struct oid_stat *oid_stat)
1202 struct pattern_list *pl;
1204 * catch setup_standard_excludes() that's called before
1205 * dir->untracked is assigned. That function behaves
1206 * differently when dir->untracked is non-NULL.
1208 if (!dir->untracked)
1209 dir->unmanaged_exclude_files++;
1210 pl = add_pattern_list(dir, EXC_FILE, fname);
1211 if (add_patterns(fname, "", 0, pl, NULL, 0, oid_stat) < 0)
1212 die(_("cannot use %s as an exclude file"), fname);
1215 void add_patterns_from_file(struct dir_struct *dir, const char *fname)
1217 dir->unmanaged_exclude_files++; /* see validate_untracked_cache() */
1218 add_patterns_from_file_1(dir, fname, NULL);
1221 int match_basename(const char *basename, int basenamelen,
1222 const char *pattern, int prefix, int patternlen,
1223 unsigned flags)
1225 if (prefix == patternlen) {
1226 if (patternlen == basenamelen &&
1227 !fspathncmp(pattern, basename, basenamelen))
1228 return 1;
1229 } else if (flags & PATTERN_FLAG_ENDSWITH) {
1230 /* "*literal" matching against "fooliteral" */
1231 if (patternlen - 1 <= basenamelen &&
1232 !fspathncmp(pattern + 1,
1233 basename + basenamelen - (patternlen - 1),
1234 patternlen - 1))
1235 return 1;
1236 } else {
1237 if (fnmatch_icase_mem(pattern, patternlen,
1238 basename, basenamelen,
1239 0) == 0)
1240 return 1;
1242 return 0;
1245 int match_pathname(const char *pathname, int pathlen,
1246 const char *base, int baselen,
1247 const char *pattern, int prefix, int patternlen,
1248 unsigned flags)
1250 const char *name;
1251 int namelen;
1254 * match with FNM_PATHNAME; the pattern has base implicitly
1255 * in front of it.
1257 if (*pattern == '/') {
1258 pattern++;
1259 patternlen--;
1260 prefix--;
1264 * baselen does not count the trailing slash. base[] may or
1265 * may not end with a trailing slash though.
1267 if (pathlen < baselen + 1 ||
1268 (baselen && pathname[baselen] != '/') ||
1269 fspathncmp(pathname, base, baselen))
1270 return 0;
1272 namelen = baselen ? pathlen - baselen - 1 : pathlen;
1273 name = pathname + pathlen - namelen;
1275 if (prefix) {
1277 * if the non-wildcard part is longer than the
1278 * remaining pathname, surely it cannot match.
1280 if (prefix > namelen)
1281 return 0;
1283 if (fspathncmp(pattern, name, prefix))
1284 return 0;
1285 pattern += prefix;
1286 patternlen -= prefix;
1287 name += prefix;
1288 namelen -= prefix;
1291 * If the whole pattern did not have a wildcard,
1292 * then our prefix match is all we need; we
1293 * do not need to call fnmatch at all.
1295 if (!patternlen && !namelen)
1296 return 1;
1299 return fnmatch_icase_mem(pattern, patternlen,
1300 name, namelen,
1301 WM_PATHNAME) == 0;
1305 * Scan the given exclude list in reverse to see whether pathname
1306 * should be ignored. The first match (i.e. the last on the list), if
1307 * any, determines the fate. Returns the exclude_list element which
1308 * matched, or NULL for undecided.
1310 static struct path_pattern *last_matching_pattern_from_list(const char *pathname,
1311 int pathlen,
1312 const char *basename,
1313 int *dtype,
1314 struct pattern_list *pl,
1315 struct index_state *istate)
1317 struct path_pattern *res = NULL; /* undecided */
1318 int i;
1320 if (!pl->nr)
1321 return NULL; /* undefined */
1323 for (i = pl->nr - 1; 0 <= i; i--) {
1324 struct path_pattern *pattern = pl->patterns[i];
1325 const char *exclude = pattern->pattern;
1326 int prefix = pattern->nowildcardlen;
1328 if (pattern->flags & PATTERN_FLAG_MUSTBEDIR) {
1329 *dtype = resolve_dtype(*dtype, istate, pathname, pathlen);
1330 if (*dtype != DT_DIR)
1331 continue;
1334 if (pattern->flags & PATTERN_FLAG_NODIR) {
1335 if (match_basename(basename,
1336 pathlen - (basename - pathname),
1337 exclude, prefix, pattern->patternlen,
1338 pattern->flags)) {
1339 res = pattern;
1340 break;
1342 continue;
1345 assert(pattern->baselen == 0 ||
1346 pattern->base[pattern->baselen - 1] == '/');
1347 if (match_pathname(pathname, pathlen,
1348 pattern->base,
1349 pattern->baselen ? pattern->baselen - 1 : 0,
1350 exclude, prefix, pattern->patternlen,
1351 pattern->flags)) {
1352 res = pattern;
1353 break;
1356 return res;
1360 * Scan the list of patterns to determine if the ordered list
1361 * of patterns matches on 'pathname'.
1363 * Return 1 for a match, 0 for not matched and -1 for undecided.
1365 enum pattern_match_result path_matches_pattern_list(
1366 const char *pathname, int pathlen,
1367 const char *basename, int *dtype,
1368 struct pattern_list *pl,
1369 struct index_state *istate)
1371 struct path_pattern *pattern;
1372 struct strbuf parent_pathname = STRBUF_INIT;
1373 int result = NOT_MATCHED;
1374 size_t slash_pos;
1376 if (!pl->use_cone_patterns) {
1377 pattern = last_matching_pattern_from_list(pathname, pathlen, basename,
1378 dtype, pl, istate);
1379 if (pattern) {
1380 if (pattern->flags & PATTERN_FLAG_NEGATIVE)
1381 return NOT_MATCHED;
1382 else
1383 return MATCHED;
1386 return UNDECIDED;
1389 if (pl->full_cone)
1390 return MATCHED;
1392 strbuf_addch(&parent_pathname, '/');
1393 strbuf_add(&parent_pathname, pathname, pathlen);
1396 * Directory entries are matched if and only if a file
1397 * contained immediately within them is matched. For the
1398 * case of a directory entry, modify the path to create
1399 * a fake filename within this directory, allowing us to
1400 * use the file-base matching logic in an equivalent way.
1402 if (parent_pathname.len > 0 &&
1403 parent_pathname.buf[parent_pathname.len - 1] == '/') {
1404 slash_pos = parent_pathname.len - 1;
1405 strbuf_add(&parent_pathname, "-", 1);
1406 } else {
1407 const char *slash_ptr = strrchr(parent_pathname.buf, '/');
1408 slash_pos = slash_ptr ? slash_ptr - parent_pathname.buf : 0;
1411 if (hashmap_contains_path(&pl->recursive_hashmap,
1412 &parent_pathname)) {
1413 result = MATCHED_RECURSIVE;
1414 goto done;
1417 if (!slash_pos) {
1418 /* include every file in root */
1419 result = MATCHED;
1420 goto done;
1423 strbuf_setlen(&parent_pathname, slash_pos);
1425 if (hashmap_contains_path(&pl->parent_hashmap, &parent_pathname)) {
1426 result = MATCHED;
1427 goto done;
1430 if (hashmap_contains_parent(&pl->recursive_hashmap,
1431 pathname,
1432 &parent_pathname))
1433 result = MATCHED_RECURSIVE;
1435 done:
1436 strbuf_release(&parent_pathname);
1437 return result;
1440 int init_sparse_checkout_patterns(struct index_state *istate)
1442 if (!core_apply_sparse_checkout)
1443 return 1;
1444 if (istate->sparse_checkout_patterns)
1445 return 0;
1447 CALLOC_ARRAY(istate->sparse_checkout_patterns, 1);
1449 if (get_sparse_checkout_patterns(istate->sparse_checkout_patterns) < 0) {
1450 FREE_AND_NULL(istate->sparse_checkout_patterns);
1451 return -1;
1454 return 0;
1457 static int path_in_sparse_checkout_1(const char *path,
1458 struct index_state *istate,
1459 int require_cone_mode)
1461 int dtype = DT_REG;
1462 enum pattern_match_result match = UNDECIDED;
1463 const char *end, *slash;
1466 * We default to accepting a path if there are no patterns or
1467 * they are of the wrong type.
1469 if (init_sparse_checkout_patterns(istate) ||
1470 (require_cone_mode &&
1471 !istate->sparse_checkout_patterns->use_cone_patterns))
1472 return 1;
1475 * If UNDECIDED, use the match from the parent dir (recursively), or
1476 * fall back to NOT_MATCHED at the topmost level. Note that cone mode
1477 * never returns UNDECIDED, so we will execute only one iteration in
1478 * this case.
1480 for (end = path + strlen(path);
1481 end > path && match == UNDECIDED;
1482 end = slash) {
1484 for (slash = end - 1; slash > path && *slash != '/'; slash--)
1485 ; /* do nothing */
1487 match = path_matches_pattern_list(path, end - path,
1488 slash > path ? slash + 1 : path, &dtype,
1489 istate->sparse_checkout_patterns, istate);
1491 /* We are going to match the parent dir now */
1492 dtype = DT_DIR;
1494 return match > 0;
1497 int path_in_sparse_checkout(const char *path,
1498 struct index_state *istate)
1500 return path_in_sparse_checkout_1(path, istate, 0);
1503 int path_in_cone_mode_sparse_checkout(const char *path,
1504 struct index_state *istate)
1506 return path_in_sparse_checkout_1(path, istate, 1);
1509 static struct path_pattern *last_matching_pattern_from_lists(
1510 struct dir_struct *dir, struct index_state *istate,
1511 const char *pathname, int pathlen,
1512 const char *basename, int *dtype_p)
1514 int i, j;
1515 struct exclude_list_group *group;
1516 struct path_pattern *pattern;
1517 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1518 group = &dir->exclude_list_group[i];
1519 for (j = group->nr - 1; j >= 0; j--) {
1520 pattern = last_matching_pattern_from_list(
1521 pathname, pathlen, basename, dtype_p,
1522 &group->pl[j], istate);
1523 if (pattern)
1524 return pattern;
1527 return NULL;
1531 * Loads the per-directory exclude list for the substring of base
1532 * which has a char length of baselen.
1534 static void prep_exclude(struct dir_struct *dir,
1535 struct index_state *istate,
1536 const char *base, int baselen)
1538 struct exclude_list_group *group;
1539 struct pattern_list *pl;
1540 struct exclude_stack *stk = NULL;
1541 struct untracked_cache_dir *untracked;
1542 int current;
1544 group = &dir->exclude_list_group[EXC_DIRS];
1547 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
1548 * which originate from directories not in the prefix of the
1549 * path being checked.
1551 while ((stk = dir->exclude_stack) != NULL) {
1552 if (stk->baselen <= baselen &&
1553 !strncmp(dir->basebuf.buf, base, stk->baselen))
1554 break;
1555 pl = &group->pl[dir->exclude_stack->exclude_ix];
1556 dir->exclude_stack = stk->prev;
1557 dir->pattern = NULL;
1558 free((char *)pl->src); /* see strbuf_detach() below */
1559 clear_pattern_list(pl);
1560 free(stk);
1561 group->nr--;
1564 /* Skip traversing into sub directories if the parent is excluded */
1565 if (dir->pattern)
1566 return;
1569 * Lazy initialization. All call sites currently just
1570 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1571 * them seems lots of work for little benefit.
1573 if (!dir->basebuf.buf)
1574 strbuf_init(&dir->basebuf, PATH_MAX);
1576 /* Read from the parent directories and push them down. */
1577 current = stk ? stk->baselen : -1;
1578 strbuf_setlen(&dir->basebuf, current < 0 ? 0 : current);
1579 if (dir->untracked)
1580 untracked = stk ? stk->ucd : dir->untracked->root;
1581 else
1582 untracked = NULL;
1584 while (current < baselen) {
1585 const char *cp;
1586 struct oid_stat oid_stat;
1588 CALLOC_ARRAY(stk, 1);
1589 if (current < 0) {
1590 cp = base;
1591 current = 0;
1592 } else {
1593 cp = strchr(base + current + 1, '/');
1594 if (!cp)
1595 die("oops in prep_exclude");
1596 cp++;
1597 untracked =
1598 lookup_untracked(dir->untracked, untracked,
1599 base + current,
1600 cp - base - current);
1602 stk->prev = dir->exclude_stack;
1603 stk->baselen = cp - base;
1604 stk->exclude_ix = group->nr;
1605 stk->ucd = untracked;
1606 pl = add_pattern_list(dir, EXC_DIRS, NULL);
1607 strbuf_add(&dir->basebuf, base + current, stk->baselen - current);
1608 assert(stk->baselen == dir->basebuf.len);
1610 /* Abort if the directory is excluded */
1611 if (stk->baselen) {
1612 int dt = DT_DIR;
1613 dir->basebuf.buf[stk->baselen - 1] = 0;
1614 dir->pattern = last_matching_pattern_from_lists(dir,
1615 istate,
1616 dir->basebuf.buf, stk->baselen - 1,
1617 dir->basebuf.buf + current, &dt);
1618 dir->basebuf.buf[stk->baselen - 1] = '/';
1619 if (dir->pattern &&
1620 dir->pattern->flags & PATTERN_FLAG_NEGATIVE)
1621 dir->pattern = NULL;
1622 if (dir->pattern) {
1623 dir->exclude_stack = stk;
1624 return;
1628 /* Try to read per-directory file */
1629 oidclr(&oid_stat.oid);
1630 oid_stat.valid = 0;
1631 if (dir->exclude_per_dir &&
1633 * If we know that no files have been added in
1634 * this directory (i.e. valid_cached_dir() has
1635 * been executed and set untracked->valid) ..
1637 (!untracked || !untracked->valid ||
1639 * .. and .gitignore does not exist before
1640 * (i.e. null exclude_oid). Then we can skip
1641 * loading .gitignore, which would result in
1642 * ENOENT anyway.
1644 !is_null_oid(&untracked->exclude_oid))) {
1646 * dir->basebuf gets reused by the traversal, but we
1647 * need fname to remain unchanged to ensure the src
1648 * member of each struct path_pattern correctly
1649 * back-references its source file. Other invocations
1650 * of add_pattern_list provide stable strings, so we
1651 * strbuf_detach() and free() here in the caller.
1653 struct strbuf sb = STRBUF_INIT;
1654 strbuf_addbuf(&sb, &dir->basebuf);
1655 strbuf_addstr(&sb, dir->exclude_per_dir);
1656 pl->src = strbuf_detach(&sb, NULL);
1657 add_patterns(pl->src, pl->src, stk->baselen, pl, istate,
1658 PATTERN_NOFOLLOW,
1659 untracked ? &oid_stat : NULL);
1662 * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1663 * will first be called in valid_cached_dir() then maybe many
1664 * times more in last_matching_pattern(). When the cache is
1665 * used, last_matching_pattern() will not be called and
1666 * reading .gitignore content will be a waste.
1668 * So when it's called by valid_cached_dir() and we can get
1669 * .gitignore SHA-1 from the index (i.e. .gitignore is not
1670 * modified on work tree), we could delay reading the
1671 * .gitignore content until we absolutely need it in
1672 * last_matching_pattern(). Be careful about ignore rule
1673 * order, though, if you do that.
1675 if (untracked &&
1676 !oideq(&oid_stat.oid, &untracked->exclude_oid)) {
1677 invalidate_gitignore(dir->untracked, untracked);
1678 oidcpy(&untracked->exclude_oid, &oid_stat.oid);
1680 dir->exclude_stack = stk;
1681 current = stk->baselen;
1683 strbuf_setlen(&dir->basebuf, baselen);
1687 * Loads the exclude lists for the directory containing pathname, then
1688 * scans all exclude lists to determine whether pathname is excluded.
1689 * Returns the exclude_list element which matched, or NULL for
1690 * undecided.
1692 struct path_pattern *last_matching_pattern(struct dir_struct *dir,
1693 struct index_state *istate,
1694 const char *pathname,
1695 int *dtype_p)
1697 int pathlen = strlen(pathname);
1698 const char *basename = strrchr(pathname, '/');
1699 basename = (basename) ? basename+1 : pathname;
1701 prep_exclude(dir, istate, pathname, basename-pathname);
1703 if (dir->pattern)
1704 return dir->pattern;
1706 return last_matching_pattern_from_lists(dir, istate, pathname, pathlen,
1707 basename, dtype_p);
1711 * Loads the exclude lists for the directory containing pathname, then
1712 * scans all exclude lists to determine whether pathname is excluded.
1713 * Returns 1 if true, otherwise 0.
1715 int is_excluded(struct dir_struct *dir, struct index_state *istate,
1716 const char *pathname, int *dtype_p)
1718 struct path_pattern *pattern =
1719 last_matching_pattern(dir, istate, pathname, dtype_p);
1720 if (pattern)
1721 return pattern->flags & PATTERN_FLAG_NEGATIVE ? 0 : 1;
1722 return 0;
1725 static struct dir_entry *dir_entry_new(const char *pathname, int len)
1727 struct dir_entry *ent;
1729 FLEX_ALLOC_MEM(ent, name, pathname, len);
1730 ent->len = len;
1731 return ent;
1734 static struct dir_entry *dir_add_name(struct dir_struct *dir,
1735 struct index_state *istate,
1736 const char *pathname, int len)
1738 if (index_file_exists(istate, pathname, len, ignore_case))
1739 return NULL;
1741 ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
1742 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
1745 struct dir_entry *dir_add_ignored(struct dir_struct *dir,
1746 struct index_state *istate,
1747 const char *pathname, int len)
1749 if (!index_name_is_other(istate, pathname, len))
1750 return NULL;
1752 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
1753 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
1756 enum exist_status {
1757 index_nonexistent = 0,
1758 index_directory,
1759 index_gitdir
1763 * Do not use the alphabetically sorted index to look up
1764 * the directory name; instead, use the case insensitive
1765 * directory hash.
1767 static enum exist_status directory_exists_in_index_icase(struct index_state *istate,
1768 const char *dirname, int len)
1770 struct cache_entry *ce;
1772 if (index_dir_exists(istate, dirname, len))
1773 return index_directory;
1775 ce = index_file_exists(istate, dirname, len, ignore_case);
1776 if (ce && S_ISGITLINK(ce->ce_mode))
1777 return index_gitdir;
1779 return index_nonexistent;
1783 * The index sorts alphabetically by entry name, which
1784 * means that a gitlink sorts as '\0' at the end, while
1785 * a directory (which is defined not as an entry, but as
1786 * the files it contains) will sort with the '/' at the
1787 * end.
1789 static enum exist_status directory_exists_in_index(struct index_state *istate,
1790 const char *dirname, int len)
1792 int pos;
1794 if (ignore_case)
1795 return directory_exists_in_index_icase(istate, dirname, len);
1797 pos = index_name_pos(istate, dirname, len);
1798 if (pos < 0)
1799 pos = -pos-1;
1800 while (pos < istate->cache_nr) {
1801 const struct cache_entry *ce = istate->cache[pos++];
1802 unsigned char endchar;
1804 if (strncmp(ce->name, dirname, len))
1805 break;
1806 endchar = ce->name[len];
1807 if (endchar > '/')
1808 break;
1809 if (endchar == '/')
1810 return index_directory;
1811 if (!endchar && S_ISGITLINK(ce->ce_mode))
1812 return index_gitdir;
1814 return index_nonexistent;
1818 * When we find a directory when traversing the filesystem, we
1819 * have three distinct cases:
1821 * - ignore it
1822 * - see it as a directory
1823 * - recurse into it
1825 * and which one we choose depends on a combination of existing
1826 * git index contents and the flags passed into the directory
1827 * traversal routine.
1829 * Case 1: If we *already* have entries in the index under that
1830 * directory name, we always recurse into the directory to see
1831 * all the files.
1833 * Case 2: If we *already* have that directory name as a gitlink,
1834 * we always continue to see it as a gitlink, regardless of whether
1835 * there is an actual git directory there or not (it might not
1836 * be checked out as a subproject!)
1838 * Case 3: if we didn't have it in the index previously, we
1839 * have a few sub-cases:
1841 * (a) if DIR_SHOW_OTHER_DIRECTORIES flag is set, we show it as
1842 * just a directory, unless DIR_HIDE_EMPTY_DIRECTORIES is
1843 * also true, in which case we need to check if it contains any
1844 * untracked and / or ignored files.
1845 * (b) if it looks like a git directory and we don't have the
1846 * DIR_NO_GITLINKS flag, then we treat it as a gitlink, and
1847 * show it as a directory.
1848 * (c) otherwise, we recurse into it.
1850 static enum path_treatment treat_directory(struct dir_struct *dir,
1851 struct index_state *istate,
1852 struct untracked_cache_dir *untracked,
1853 const char *dirname, int len, int baselen, int excluded,
1854 const struct pathspec *pathspec)
1857 * WARNING: From this function, you can return path_recurse or you
1858 * can call read_directory_recursive() (or neither), but
1859 * you CAN'T DO BOTH.
1861 enum path_treatment state;
1862 int matches_how = 0;
1863 int nested_repo = 0, check_only, stop_early;
1864 int old_ignored_nr, old_untracked_nr;
1865 /* The "len-1" is to strip the final '/' */
1866 enum exist_status status = directory_exists_in_index(istate, dirname, len-1);
1868 if (status == index_directory)
1869 return path_recurse;
1870 if (status == index_gitdir)
1871 return path_none;
1872 if (status != index_nonexistent)
1873 BUG("Unhandled value for directory_exists_in_index: %d\n", status);
1876 * We don't want to descend into paths that don't match the necessary
1877 * patterns. Clearly, if we don't have a pathspec, then we can't check
1878 * for matching patterns. Also, if (excluded) then we know we matched
1879 * the exclusion patterns so as an optimization we can skip checking
1880 * for matching patterns.
1882 if (pathspec && !excluded) {
1883 matches_how = match_pathspec_with_flags(istate, pathspec,
1884 dirname, len,
1885 0 /* prefix */,
1886 NULL /* seen */,
1887 DO_MATCH_LEADING_PATHSPEC);
1888 if (!matches_how)
1889 return path_none;
1893 if ((dir->flags & DIR_SKIP_NESTED_GIT) ||
1894 !(dir->flags & DIR_NO_GITLINKS)) {
1895 struct strbuf sb = STRBUF_INIT;
1896 strbuf_addstr(&sb, dirname);
1897 nested_repo = is_nonbare_repository_dir(&sb);
1898 strbuf_release(&sb);
1900 if (nested_repo) {
1901 if ((dir->flags & DIR_SKIP_NESTED_GIT) ||
1902 (matches_how == MATCHED_RECURSIVELY_LEADING_PATHSPEC))
1903 return path_none;
1904 return excluded ? path_excluded : path_untracked;
1907 if (!(dir->flags & DIR_SHOW_OTHER_DIRECTORIES)) {
1908 if (excluded &&
1909 (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1910 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING)) {
1913 * This is an excluded directory and we are
1914 * showing ignored paths that match an exclude
1915 * pattern. (e.g. show directory as ignored
1916 * only if it matches an exclude pattern).
1917 * This path will either be 'path_excluded`
1918 * (if we are showing empty directories or if
1919 * the directory is not empty), or will be
1920 * 'path_none' (empty directory, and we are
1921 * not showing empty directories).
1923 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1924 return path_excluded;
1926 if (read_directory_recursive(dir, istate, dirname, len,
1927 untracked, 1, 1, pathspec) == path_excluded)
1928 return path_excluded;
1930 return path_none;
1932 return path_recurse;
1935 assert(dir->flags & DIR_SHOW_OTHER_DIRECTORIES);
1938 * If we have a pathspec which could match something _below_ this
1939 * directory (e.g. when checking 'subdir/' having a pathspec like
1940 * 'subdir/some/deep/path/file' or 'subdir/widget-*.c'), then we
1941 * need to recurse.
1943 if (matches_how == MATCHED_RECURSIVELY_LEADING_PATHSPEC)
1944 return path_recurse;
1946 /* Special cases for where this directory is excluded/ignored */
1947 if (excluded) {
1949 * If DIR_SHOW_OTHER_DIRECTORIES is set and we're not
1950 * hiding empty directories, there is no need to
1951 * recurse into an ignored directory.
1953 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1954 return path_excluded;
1957 * Even if we are hiding empty directories, we can still avoid
1958 * recursing into ignored directories for DIR_SHOW_IGNORED_TOO
1959 * if DIR_SHOW_IGNORED_TOO_MODE_MATCHING is also set.
1961 if ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
1962 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING))
1963 return path_excluded;
1967 * Other than the path_recurse case above, we only need to
1968 * recurse into untracked directories if any of the following
1969 * bits is set:
1970 * - DIR_SHOW_IGNORED (because then we need to determine if
1971 * there are ignored entries below)
1972 * - DIR_SHOW_IGNORED_TOO (same as above)
1973 * - DIR_HIDE_EMPTY_DIRECTORIES (because we have to determine if
1974 * the directory is empty)
1976 if (!excluded &&
1977 !(dir->flags & (DIR_SHOW_IGNORED |
1978 DIR_SHOW_IGNORED_TOO |
1979 DIR_HIDE_EMPTY_DIRECTORIES))) {
1980 return path_untracked;
1984 * Even if we don't want to know all the paths under an untracked or
1985 * ignored directory, we may still need to go into the directory to
1986 * determine if it is empty (because with DIR_HIDE_EMPTY_DIRECTORIES,
1987 * an empty directory should be path_none instead of path_excluded or
1988 * path_untracked).
1990 check_only = ((dir->flags & DIR_HIDE_EMPTY_DIRECTORIES) &&
1991 !(dir->flags & DIR_SHOW_IGNORED_TOO));
1994 * However, there's another optimization possible as a subset of
1995 * check_only, based on the cases we have to consider:
1996 * A) Directory matches no exclude patterns:
1997 * * Directory is empty => path_none
1998 * * Directory has an untracked file under it => path_untracked
1999 * * Directory has only ignored files under it => path_excluded
2000 * B) Directory matches an exclude pattern:
2001 * * Directory is empty => path_none
2002 * * Directory has an untracked file under it => path_excluded
2003 * * Directory has only ignored files under it => path_excluded
2004 * In case A, we can exit as soon as we've found an untracked
2005 * file but otherwise have to walk all files. In case B, though,
2006 * we can stop at the first file we find under the directory.
2008 stop_early = check_only && excluded;
2011 * If /every/ file within an untracked directory is ignored, then
2012 * we want to treat the directory as ignored (for e.g. status
2013 * --porcelain), without listing the individual ignored files
2014 * underneath. To do so, we'll save the current ignored_nr, and
2015 * pop all the ones added after it if it turns out the entire
2016 * directory is ignored. Also, when DIR_SHOW_IGNORED_TOO and
2017 * !DIR_KEEP_UNTRACKED_CONTENTS then we don't want to show
2018 * untracked paths so will need to pop all those off the last
2019 * after we traverse.
2021 old_ignored_nr = dir->ignored_nr;
2022 old_untracked_nr = dir->nr;
2024 /* Actually recurse into dirname now, we'll fixup the state later. */
2025 untracked = lookup_untracked(dir->untracked, untracked,
2026 dirname + baselen, len - baselen);
2027 state = read_directory_recursive(dir, istate, dirname, len, untracked,
2028 check_only, stop_early, pathspec);
2030 /* There are a variety of reasons we may need to fixup the state... */
2031 if (state == path_excluded) {
2032 /* state == path_excluded implies all paths under
2033 * dirname were ignored...
2035 * if running e.g. `git status --porcelain --ignored=matching`,
2036 * then we want to see the subpaths that are ignored.
2038 * if running e.g. just `git status --porcelain`, then
2039 * we just want the directory itself to be listed as ignored
2040 * and not the individual paths underneath.
2042 int want_ignored_subpaths =
2043 ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2044 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING));
2046 if (want_ignored_subpaths) {
2048 * with --ignored=matching, we want the subpaths
2049 * INSTEAD of the directory itself.
2051 state = path_none;
2052 } else {
2053 int i;
2054 for (i = old_ignored_nr + 1; i<dir->ignored_nr; ++i)
2055 FREE_AND_NULL(dir->ignored[i]);
2056 dir->ignored_nr = old_ignored_nr;
2061 * We may need to ignore some of the untracked paths we found while
2062 * traversing subdirectories.
2064 if ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2065 !(dir->flags & DIR_KEEP_UNTRACKED_CONTENTS)) {
2066 int i;
2067 for (i = old_untracked_nr + 1; i<dir->nr; ++i)
2068 FREE_AND_NULL(dir->entries[i]);
2069 dir->nr = old_untracked_nr;
2073 * If there is nothing under the current directory and we are not
2074 * hiding empty directories, then we need to report on the
2075 * untracked or ignored status of the directory itself.
2077 if (state == path_none && !(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
2078 state = excluded ? path_excluded : path_untracked;
2080 return state;
2084 * This is an inexact early pruning of any recursive directory
2085 * reading - if the path cannot possibly be in the pathspec,
2086 * return true, and we'll skip it early.
2088 static int simplify_away(const char *path, int pathlen,
2089 const struct pathspec *pathspec)
2091 int i;
2093 if (!pathspec || !pathspec->nr)
2094 return 0;
2096 GUARD_PATHSPEC(pathspec,
2097 PATHSPEC_FROMTOP |
2098 PATHSPEC_MAXDEPTH |
2099 PATHSPEC_LITERAL |
2100 PATHSPEC_GLOB |
2101 PATHSPEC_ICASE |
2102 PATHSPEC_EXCLUDE |
2103 PATHSPEC_ATTR);
2105 for (i = 0; i < pathspec->nr; i++) {
2106 const struct pathspec_item *item = &pathspec->items[i];
2107 int len = item->nowildcard_len;
2109 if (len > pathlen)
2110 len = pathlen;
2111 if (!ps_strncmp(item, item->match, path, len))
2112 return 0;
2115 return 1;
2119 * This function tells us whether an excluded path matches a
2120 * list of "interesting" pathspecs. That is, whether a path matched
2121 * by any of the pathspecs could possibly be ignored by excluding
2122 * the specified path. This can happen if:
2124 * 1. the path is mentioned explicitly in the pathspec
2126 * 2. the path is a directory prefix of some element in the
2127 * pathspec
2129 static int exclude_matches_pathspec(const char *path, int pathlen,
2130 const struct pathspec *pathspec)
2132 int i;
2134 if (!pathspec || !pathspec->nr)
2135 return 0;
2137 GUARD_PATHSPEC(pathspec,
2138 PATHSPEC_FROMTOP |
2139 PATHSPEC_MAXDEPTH |
2140 PATHSPEC_LITERAL |
2141 PATHSPEC_GLOB |
2142 PATHSPEC_ICASE |
2143 PATHSPEC_EXCLUDE);
2145 for (i = 0; i < pathspec->nr; i++) {
2146 const struct pathspec_item *item = &pathspec->items[i];
2147 int len = item->nowildcard_len;
2149 if (len == pathlen &&
2150 !ps_strncmp(item, item->match, path, pathlen))
2151 return 1;
2152 if (len > pathlen &&
2153 item->match[pathlen] == '/' &&
2154 !ps_strncmp(item, item->match, path, pathlen))
2155 return 1;
2157 return 0;
2160 static int get_index_dtype(struct index_state *istate,
2161 const char *path, int len)
2163 int pos;
2164 const struct cache_entry *ce;
2166 ce = index_file_exists(istate, path, len, 0);
2167 if (ce) {
2168 if (!ce_uptodate(ce))
2169 return DT_UNKNOWN;
2170 if (S_ISGITLINK(ce->ce_mode))
2171 return DT_DIR;
2173 * Nobody actually cares about the
2174 * difference between DT_LNK and DT_REG
2176 return DT_REG;
2179 /* Try to look it up as a directory */
2180 pos = index_name_pos(istate, path, len);
2181 if (pos >= 0)
2182 return DT_UNKNOWN;
2183 pos = -pos-1;
2184 while (pos < istate->cache_nr) {
2185 ce = istate->cache[pos++];
2186 if (strncmp(ce->name, path, len))
2187 break;
2188 if (ce->name[len] > '/')
2189 break;
2190 if (ce->name[len] < '/')
2191 continue;
2192 if (!ce_uptodate(ce))
2193 break; /* continue? */
2194 return DT_DIR;
2196 return DT_UNKNOWN;
2199 static int resolve_dtype(int dtype, struct index_state *istate,
2200 const char *path, int len)
2202 struct stat st;
2204 if (dtype != DT_UNKNOWN)
2205 return dtype;
2206 dtype = get_index_dtype(istate, path, len);
2207 if (dtype != DT_UNKNOWN)
2208 return dtype;
2209 if (lstat(path, &st))
2210 return dtype;
2211 if (S_ISREG(st.st_mode))
2212 return DT_REG;
2213 if (S_ISDIR(st.st_mode))
2214 return DT_DIR;
2215 if (S_ISLNK(st.st_mode))
2216 return DT_LNK;
2217 return dtype;
2220 static enum path_treatment treat_path_fast(struct dir_struct *dir,
2221 struct cached_dir *cdir,
2222 struct index_state *istate,
2223 struct strbuf *path,
2224 int baselen,
2225 const struct pathspec *pathspec)
2228 * WARNING: From this function, you can return path_recurse or you
2229 * can call read_directory_recursive() (or neither), but
2230 * you CAN'T DO BOTH.
2232 strbuf_setlen(path, baselen);
2233 if (!cdir->ucd) {
2234 strbuf_addstr(path, cdir->file);
2235 return path_untracked;
2237 strbuf_addstr(path, cdir->ucd->name);
2238 /* treat_one_path() does this before it calls treat_directory() */
2239 strbuf_complete(path, '/');
2240 if (cdir->ucd->check_only)
2242 * check_only is set as a result of treat_directory() getting
2243 * to its bottom. Verify again the same set of directories
2244 * with check_only set.
2246 return read_directory_recursive(dir, istate, path->buf, path->len,
2247 cdir->ucd, 1, 0, pathspec);
2249 * We get path_recurse in the first run when
2250 * directory_exists_in_index() returns index_nonexistent. We
2251 * are sure that new changes in the index does not impact the
2252 * outcome. Return now.
2254 return path_recurse;
2257 static enum path_treatment treat_path(struct dir_struct *dir,
2258 struct untracked_cache_dir *untracked,
2259 struct cached_dir *cdir,
2260 struct index_state *istate,
2261 struct strbuf *path,
2262 int baselen,
2263 const struct pathspec *pathspec)
2265 int has_path_in_index, dtype, excluded;
2267 if (!cdir->d_name)
2268 return treat_path_fast(dir, cdir, istate, path,
2269 baselen, pathspec);
2270 if (is_dot_or_dotdot(cdir->d_name) || !fspathcmp(cdir->d_name, ".git"))
2271 return path_none;
2272 strbuf_setlen(path, baselen);
2273 strbuf_addstr(path, cdir->d_name);
2274 if (simplify_away(path->buf, path->len, pathspec))
2275 return path_none;
2277 dtype = resolve_dtype(cdir->d_type, istate, path->buf, path->len);
2279 /* Always exclude indexed files */
2280 has_path_in_index = !!index_file_exists(istate, path->buf, path->len,
2281 ignore_case);
2282 if (dtype != DT_DIR && has_path_in_index)
2283 return path_none;
2286 * When we are looking at a directory P in the working tree,
2287 * there are three cases:
2289 * (1) P exists in the index. Everything inside the directory P in
2290 * the working tree needs to go when P is checked out from the
2291 * index.
2293 * (2) P does not exist in the index, but there is P/Q in the index.
2294 * We know P will stay a directory when we check out the contents
2295 * of the index, but we do not know yet if there is a directory
2296 * P/Q in the working tree to be killed, so we need to recurse.
2298 * (3) P does not exist in the index, and there is no P/Q in the index
2299 * to require P to be a directory, either. Only in this case, we
2300 * know that everything inside P will not be killed without
2301 * recursing.
2303 if ((dir->flags & DIR_COLLECT_KILLED_ONLY) &&
2304 (dtype == DT_DIR) &&
2305 !has_path_in_index &&
2306 (directory_exists_in_index(istate, path->buf, path->len) == index_nonexistent))
2307 return path_none;
2309 excluded = is_excluded(dir, istate, path->buf, &dtype);
2312 * Excluded? If we don't explicitly want to show
2313 * ignored files, ignore it
2315 if (excluded && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
2316 return path_excluded;
2318 switch (dtype) {
2319 default:
2320 return path_none;
2321 case DT_DIR:
2323 * WARNING: Do not ignore/amend the return value from
2324 * treat_directory(), and especially do not change it to return
2325 * path_recurse as that can cause exponential slowdown.
2326 * Instead, modify treat_directory() to return the right value.
2328 strbuf_addch(path, '/');
2329 return treat_directory(dir, istate, untracked,
2330 path->buf, path->len,
2331 baselen, excluded, pathspec);
2332 case DT_REG:
2333 case DT_LNK:
2334 if (pathspec &&
2335 !match_pathspec(istate, pathspec, path->buf, path->len,
2336 0 /* prefix */, NULL /* seen */,
2337 0 /* is_dir */))
2338 return path_none;
2339 if (excluded)
2340 return path_excluded;
2341 return path_untracked;
2345 static void add_untracked(struct untracked_cache_dir *dir, const char *name)
2347 if (!dir)
2348 return;
2349 ALLOC_GROW(dir->untracked, dir->untracked_nr + 1,
2350 dir->untracked_alloc);
2351 dir->untracked[dir->untracked_nr++] = xstrdup(name);
2354 static int valid_cached_dir(struct dir_struct *dir,
2355 struct untracked_cache_dir *untracked,
2356 struct index_state *istate,
2357 struct strbuf *path,
2358 int check_only)
2360 struct stat st;
2362 if (!untracked)
2363 return 0;
2366 * With fsmonitor, we can trust the untracked cache's valid field.
2368 refresh_fsmonitor(istate);
2369 if (!(dir->untracked->use_fsmonitor && untracked->valid)) {
2370 if (lstat(path->len ? path->buf : ".", &st)) {
2371 memset(&untracked->stat_data, 0, sizeof(untracked->stat_data));
2372 return 0;
2374 if (!untracked->valid ||
2375 match_stat_data_racy(istate, &untracked->stat_data, &st)) {
2376 fill_stat_data(&untracked->stat_data, &st);
2377 return 0;
2381 if (untracked->check_only != !!check_only)
2382 return 0;
2385 * prep_exclude will be called eventually on this directory,
2386 * but it's called much later in last_matching_pattern(). We
2387 * need it now to determine the validity of the cache for this
2388 * path. The next calls will be nearly no-op, the way
2389 * prep_exclude() is designed.
2391 if (path->len && path->buf[path->len - 1] != '/') {
2392 strbuf_addch(path, '/');
2393 prep_exclude(dir, istate, path->buf, path->len);
2394 strbuf_setlen(path, path->len - 1);
2395 } else
2396 prep_exclude(dir, istate, path->buf, path->len);
2398 /* hopefully prep_exclude() haven't invalidated this entry... */
2399 return untracked->valid;
2402 static int open_cached_dir(struct cached_dir *cdir,
2403 struct dir_struct *dir,
2404 struct untracked_cache_dir *untracked,
2405 struct index_state *istate,
2406 struct strbuf *path,
2407 int check_only)
2409 const char *c_path;
2411 memset(cdir, 0, sizeof(*cdir));
2412 cdir->untracked = untracked;
2413 if (valid_cached_dir(dir, untracked, istate, path, check_only))
2414 return 0;
2415 c_path = path->len ? path->buf : ".";
2416 cdir->fdir = opendir(c_path);
2417 if (!cdir->fdir)
2418 warning_errno(_("could not open directory '%s'"), c_path);
2419 if (dir->untracked) {
2420 invalidate_directory(dir->untracked, untracked);
2421 dir->untracked->dir_opened++;
2423 if (!cdir->fdir)
2424 return -1;
2425 return 0;
2428 static int read_cached_dir(struct cached_dir *cdir)
2430 struct dirent *de;
2432 if (cdir->fdir) {
2433 de = readdir_skip_dot_and_dotdot(cdir->fdir);
2434 if (!de) {
2435 cdir->d_name = NULL;
2436 cdir->d_type = DT_UNKNOWN;
2437 return -1;
2439 cdir->d_name = de->d_name;
2440 cdir->d_type = DTYPE(de);
2441 return 0;
2443 while (cdir->nr_dirs < cdir->untracked->dirs_nr) {
2444 struct untracked_cache_dir *d = cdir->untracked->dirs[cdir->nr_dirs];
2445 if (!d->recurse) {
2446 cdir->nr_dirs++;
2447 continue;
2449 cdir->ucd = d;
2450 cdir->nr_dirs++;
2451 return 0;
2453 cdir->ucd = NULL;
2454 if (cdir->nr_files < cdir->untracked->untracked_nr) {
2455 struct untracked_cache_dir *d = cdir->untracked;
2456 cdir->file = d->untracked[cdir->nr_files++];
2457 return 0;
2459 return -1;
2462 static void close_cached_dir(struct cached_dir *cdir)
2464 if (cdir->fdir)
2465 closedir(cdir->fdir);
2467 * We have gone through this directory and found no untracked
2468 * entries. Mark it valid.
2470 if (cdir->untracked) {
2471 cdir->untracked->valid = 1;
2472 cdir->untracked->recurse = 1;
2476 static void add_path_to_appropriate_result_list(struct dir_struct *dir,
2477 struct untracked_cache_dir *untracked,
2478 struct cached_dir *cdir,
2479 struct index_state *istate,
2480 struct strbuf *path,
2481 int baselen,
2482 const struct pathspec *pathspec,
2483 enum path_treatment state)
2485 /* add the path to the appropriate result list */
2486 switch (state) {
2487 case path_excluded:
2488 if (dir->flags & DIR_SHOW_IGNORED)
2489 dir_add_name(dir, istate, path->buf, path->len);
2490 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
2491 ((dir->flags & DIR_COLLECT_IGNORED) &&
2492 exclude_matches_pathspec(path->buf, path->len,
2493 pathspec)))
2494 dir_add_ignored(dir, istate, path->buf, path->len);
2495 break;
2497 case path_untracked:
2498 if (dir->flags & DIR_SHOW_IGNORED)
2499 break;
2500 dir_add_name(dir, istate, path->buf, path->len);
2501 if (cdir->fdir)
2502 add_untracked(untracked, path->buf + baselen);
2503 break;
2505 default:
2506 break;
2511 * Read a directory tree. We currently ignore anything but
2512 * directories, regular files and symlinks. That's because git
2513 * doesn't handle them at all yet. Maybe that will change some
2514 * day.
2516 * Also, we ignore the name ".git" (even if it is not a directory).
2517 * That likely will not change.
2519 * If 'stop_at_first_file' is specified, 'path_excluded' is returned
2520 * to signal that a file was found. This is the least significant value that
2521 * indicates that a file was encountered that does not depend on the order of
2522 * whether an untracked or excluded path was encountered first.
2524 * Returns the most significant path_treatment value encountered in the scan.
2525 * If 'stop_at_first_file' is specified, `path_excluded` is the most
2526 * significant path_treatment value that will be returned.
2529 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
2530 struct index_state *istate, const char *base, int baselen,
2531 struct untracked_cache_dir *untracked, int check_only,
2532 int stop_at_first_file, const struct pathspec *pathspec)
2535 * WARNING: Do NOT recurse unless path_recurse is returned from
2536 * treat_path(). Recursing on any other return value
2537 * can result in exponential slowdown.
2539 struct cached_dir cdir;
2540 enum path_treatment state, subdir_state, dir_state = path_none;
2541 struct strbuf path = STRBUF_INIT;
2543 strbuf_add(&path, base, baselen);
2545 if (open_cached_dir(&cdir, dir, untracked, istate, &path, check_only))
2546 goto out;
2547 dir->visited_directories++;
2549 if (untracked)
2550 untracked->check_only = !!check_only;
2552 while (!read_cached_dir(&cdir)) {
2553 /* check how the file or directory should be treated */
2554 state = treat_path(dir, untracked, &cdir, istate, &path,
2555 baselen, pathspec);
2556 dir->visited_paths++;
2558 if (state > dir_state)
2559 dir_state = state;
2561 /* recurse into subdir if instructed by treat_path */
2562 if (state == path_recurse) {
2563 struct untracked_cache_dir *ud;
2564 ud = lookup_untracked(dir->untracked, untracked,
2565 path.buf + baselen,
2566 path.len - baselen);
2567 subdir_state =
2568 read_directory_recursive(dir, istate, path.buf,
2569 path.len, ud,
2570 check_only, stop_at_first_file, pathspec);
2571 if (subdir_state > dir_state)
2572 dir_state = subdir_state;
2574 if (pathspec &&
2575 !match_pathspec(istate, pathspec, path.buf, path.len,
2576 0 /* prefix */, NULL,
2577 0 /* do NOT special case dirs */))
2578 state = path_none;
2581 if (check_only) {
2582 if (stop_at_first_file) {
2584 * If stopping at first file, then
2585 * signal that a file was found by
2586 * returning `path_excluded`. This is
2587 * to return a consistent value
2588 * regardless of whether an ignored or
2589 * excluded file happened to be
2590 * encountered 1st.
2592 * In current usage, the
2593 * `stop_at_first_file` is passed when
2594 * an ancestor directory has matched
2595 * an exclude pattern, so any found
2596 * files will be excluded.
2598 if (dir_state >= path_excluded) {
2599 dir_state = path_excluded;
2600 break;
2604 /* abort early if maximum state has been reached */
2605 if (dir_state == path_untracked) {
2606 if (cdir.fdir)
2607 add_untracked(untracked, path.buf + baselen);
2608 break;
2610 /* skip the add_path_to_appropriate_result_list() */
2611 continue;
2614 add_path_to_appropriate_result_list(dir, untracked, &cdir,
2615 istate, &path, baselen,
2616 pathspec, state);
2618 close_cached_dir(&cdir);
2619 out:
2620 strbuf_release(&path);
2622 return dir_state;
2625 int cmp_dir_entry(const void *p1, const void *p2)
2627 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
2628 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
2630 return name_compare(e1->name, e1->len, e2->name, e2->len);
2633 /* check if *out lexically strictly contains *in */
2634 int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in)
2636 return (out->len < in->len) &&
2637 (out->name[out->len - 1] == '/') &&
2638 !memcmp(out->name, in->name, out->len);
2641 static int treat_leading_path(struct dir_struct *dir,
2642 struct index_state *istate,
2643 const char *path, int len,
2644 const struct pathspec *pathspec)
2646 struct strbuf sb = STRBUF_INIT;
2647 struct strbuf subdir = STRBUF_INIT;
2648 int prevlen, baselen;
2649 const char *cp;
2650 struct cached_dir cdir;
2651 enum path_treatment state = path_none;
2654 * For each directory component of path, we are going to check whether
2655 * that path is relevant given the pathspec. For example, if path is
2656 * foo/bar/baz/
2657 * then we will ask treat_path() whether we should go into foo, then
2658 * whether we should go into bar, then whether baz is relevant.
2659 * Checking each is important because e.g. if path is
2660 * .git/info/
2661 * then we need to check .git to know we shouldn't traverse it.
2662 * If the return from treat_path() is:
2663 * * path_none, for any path, we return false.
2664 * * path_recurse, for all path components, we return true
2665 * * <anything else> for some intermediate component, we make sure
2666 * to add that path to the relevant list but return false
2667 * signifying that we shouldn't recurse into it.
2670 while (len && path[len - 1] == '/')
2671 len--;
2672 if (!len)
2673 return 1;
2675 memset(&cdir, 0, sizeof(cdir));
2676 cdir.d_type = DT_DIR;
2677 baselen = 0;
2678 prevlen = 0;
2679 while (1) {
2680 prevlen = baselen + !!baselen;
2681 cp = path + prevlen;
2682 cp = memchr(cp, '/', path + len - cp);
2683 if (!cp)
2684 baselen = len;
2685 else
2686 baselen = cp - path;
2687 strbuf_reset(&sb);
2688 strbuf_add(&sb, path, baselen);
2689 if (!is_directory(sb.buf))
2690 break;
2691 strbuf_reset(&sb);
2692 strbuf_add(&sb, path, prevlen);
2693 strbuf_reset(&subdir);
2694 strbuf_add(&subdir, path+prevlen, baselen-prevlen);
2695 cdir.d_name = subdir.buf;
2696 state = treat_path(dir, NULL, &cdir, istate, &sb, prevlen, pathspec);
2698 if (state != path_recurse)
2699 break; /* do not recurse into it */
2700 if (len <= baselen)
2701 break; /* finished checking */
2703 add_path_to_appropriate_result_list(dir, NULL, &cdir, istate,
2704 &sb, baselen, pathspec,
2705 state);
2707 strbuf_release(&subdir);
2708 strbuf_release(&sb);
2709 return state == path_recurse;
2712 static const char *get_ident_string(void)
2714 static struct strbuf sb = STRBUF_INIT;
2715 struct utsname uts;
2717 if (sb.len)
2718 return sb.buf;
2719 if (uname(&uts) < 0)
2720 die_errno(_("failed to get kernel name and information"));
2721 strbuf_addf(&sb, "Location %s, system %s", get_git_work_tree(),
2722 uts.sysname);
2723 return sb.buf;
2726 static int ident_in_untracked(const struct untracked_cache *uc)
2729 * Previous git versions may have saved many NUL separated
2730 * strings in the "ident" field, but it is insane to manage
2731 * many locations, so just take care of the first one.
2734 return !strcmp(uc->ident.buf, get_ident_string());
2737 static void set_untracked_ident(struct untracked_cache *uc)
2739 strbuf_reset(&uc->ident);
2740 strbuf_addstr(&uc->ident, get_ident_string());
2743 * This strbuf used to contain a list of NUL separated
2744 * strings, so save NUL too for backward compatibility.
2746 strbuf_addch(&uc->ident, 0);
2749 static void new_untracked_cache(struct index_state *istate)
2751 struct untracked_cache *uc = xcalloc(1, sizeof(*uc));
2752 strbuf_init(&uc->ident, 100);
2753 uc->exclude_per_dir = ".gitignore";
2754 /* should be the same flags used by git-status */
2755 uc->dir_flags = DIR_SHOW_OTHER_DIRECTORIES | DIR_HIDE_EMPTY_DIRECTORIES;
2756 set_untracked_ident(uc);
2757 istate->untracked = uc;
2758 istate->cache_changed |= UNTRACKED_CHANGED;
2761 void add_untracked_cache(struct index_state *istate)
2763 if (!istate->untracked) {
2764 new_untracked_cache(istate);
2765 } else {
2766 if (!ident_in_untracked(istate->untracked)) {
2767 free_untracked_cache(istate->untracked);
2768 new_untracked_cache(istate);
2773 void remove_untracked_cache(struct index_state *istate)
2775 if (istate->untracked) {
2776 free_untracked_cache(istate->untracked);
2777 istate->untracked = NULL;
2778 istate->cache_changed |= UNTRACKED_CHANGED;
2782 static struct untracked_cache_dir *validate_untracked_cache(struct dir_struct *dir,
2783 int base_len,
2784 const struct pathspec *pathspec)
2786 struct untracked_cache_dir *root;
2787 static int untracked_cache_disabled = -1;
2789 if (!dir->untracked)
2790 return NULL;
2791 if (untracked_cache_disabled < 0)
2792 untracked_cache_disabled = git_env_bool("GIT_DISABLE_UNTRACKED_CACHE", 0);
2793 if (untracked_cache_disabled)
2794 return NULL;
2797 * We only support $GIT_DIR/info/exclude and core.excludesfile
2798 * as the global ignore rule files. Any other additions
2799 * (e.g. from command line) invalidate the cache. This
2800 * condition also catches running setup_standard_excludes()
2801 * before setting dir->untracked!
2803 if (dir->unmanaged_exclude_files)
2804 return NULL;
2807 * Optimize for the main use case only: whole-tree git
2808 * status. More work involved in treat_leading_path() if we
2809 * use cache on just a subset of the worktree. pathspec
2810 * support could make the matter even worse.
2812 if (base_len || (pathspec && pathspec->nr))
2813 return NULL;
2815 /* Different set of flags may produce different results */
2816 if (dir->flags != dir->untracked->dir_flags ||
2818 * See treat_directory(), case index_nonexistent. Without
2819 * this flag, we may need to also cache .git file content
2820 * for the resolve_gitlink_ref() call, which we don't.
2822 !(dir->flags & DIR_SHOW_OTHER_DIRECTORIES) ||
2823 /* We don't support collecting ignore files */
2824 (dir->flags & (DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO |
2825 DIR_COLLECT_IGNORED)))
2826 return NULL;
2829 * If we use .gitignore in the cache and now you change it to
2830 * .gitexclude, everything will go wrong.
2832 if (dir->exclude_per_dir != dir->untracked->exclude_per_dir &&
2833 strcmp(dir->exclude_per_dir, dir->untracked->exclude_per_dir))
2834 return NULL;
2837 * EXC_CMDL is not considered in the cache. If people set it,
2838 * skip the cache.
2840 if (dir->exclude_list_group[EXC_CMDL].nr)
2841 return NULL;
2843 if (!ident_in_untracked(dir->untracked)) {
2844 warning(_("untracked cache is disabled on this system or location"));
2845 return NULL;
2848 if (!dir->untracked->root)
2849 FLEX_ALLOC_STR(dir->untracked->root, name, "");
2851 /* Validate $GIT_DIR/info/exclude and core.excludesfile */
2852 root = dir->untracked->root;
2853 if (!oideq(&dir->ss_info_exclude.oid,
2854 &dir->untracked->ss_info_exclude.oid)) {
2855 invalidate_gitignore(dir->untracked, root);
2856 dir->untracked->ss_info_exclude = dir->ss_info_exclude;
2858 if (!oideq(&dir->ss_excludes_file.oid,
2859 &dir->untracked->ss_excludes_file.oid)) {
2860 invalidate_gitignore(dir->untracked, root);
2861 dir->untracked->ss_excludes_file = dir->ss_excludes_file;
2864 /* Make sure this directory is not dropped out at saving phase */
2865 root->recurse = 1;
2866 return root;
2869 static void emit_traversal_statistics(struct dir_struct *dir,
2870 struct repository *repo,
2871 const char *path,
2872 int path_len)
2874 if (!trace2_is_enabled())
2875 return;
2877 if (!path_len) {
2878 trace2_data_string("read_directory", repo, "path", "");
2879 } else {
2880 struct strbuf tmp = STRBUF_INIT;
2881 strbuf_add(&tmp, path, path_len);
2882 trace2_data_string("read_directory", repo, "path", tmp.buf);
2883 strbuf_release(&tmp);
2886 trace2_data_intmax("read_directory", repo,
2887 "directories-visited", dir->visited_directories);
2888 trace2_data_intmax("read_directory", repo,
2889 "paths-visited", dir->visited_paths);
2891 if (!dir->untracked)
2892 return;
2893 trace2_data_intmax("read_directory", repo,
2894 "node-creation", dir->untracked->dir_created);
2895 trace2_data_intmax("read_directory", repo,
2896 "gitignore-invalidation",
2897 dir->untracked->gitignore_invalidated);
2898 trace2_data_intmax("read_directory", repo,
2899 "directory-invalidation",
2900 dir->untracked->dir_invalidated);
2901 trace2_data_intmax("read_directory", repo,
2902 "opendir", dir->untracked->dir_opened);
2905 int read_directory(struct dir_struct *dir, struct index_state *istate,
2906 const char *path, int len, const struct pathspec *pathspec)
2908 struct untracked_cache_dir *untracked;
2910 trace2_region_enter("dir", "read_directory", istate->repo);
2911 dir->visited_paths = 0;
2912 dir->visited_directories = 0;
2914 if (has_symlink_leading_path(path, len)) {
2915 trace2_region_leave("dir", "read_directory", istate->repo);
2916 return dir->nr;
2919 untracked = validate_untracked_cache(dir, len, pathspec);
2920 if (!untracked)
2922 * make sure untracked cache code path is disabled,
2923 * e.g. prep_exclude()
2925 dir->untracked = NULL;
2926 if (!len || treat_leading_path(dir, istate, path, len, pathspec))
2927 read_directory_recursive(dir, istate, path, len, untracked, 0, 0, pathspec);
2928 QSORT(dir->entries, dir->nr, cmp_dir_entry);
2929 QSORT(dir->ignored, dir->ignored_nr, cmp_dir_entry);
2931 emit_traversal_statistics(dir, istate->repo, path, len);
2933 trace2_region_leave("dir", "read_directory", istate->repo);
2934 if (dir->untracked) {
2935 static int force_untracked_cache = -1;
2937 if (force_untracked_cache < 0)
2938 force_untracked_cache =
2939 git_env_bool("GIT_FORCE_UNTRACKED_CACHE", 0);
2940 if (force_untracked_cache &&
2941 dir->untracked == istate->untracked &&
2942 (dir->untracked->dir_opened ||
2943 dir->untracked->gitignore_invalidated ||
2944 dir->untracked->dir_invalidated))
2945 istate->cache_changed |= UNTRACKED_CHANGED;
2946 if (dir->untracked != istate->untracked) {
2947 FREE_AND_NULL(dir->untracked);
2951 return dir->nr;
2954 int file_exists(const char *f)
2956 struct stat sb;
2957 return lstat(f, &sb) == 0;
2960 int repo_file_exists(struct repository *repo, const char *path)
2962 if (repo != the_repository)
2963 BUG("do not know how to check file existence in arbitrary repo");
2965 return file_exists(path);
2968 static int cmp_icase(char a, char b)
2970 if (a == b)
2971 return 0;
2972 if (ignore_case)
2973 return toupper(a) - toupper(b);
2974 return a - b;
2978 * Given two normalized paths (a trailing slash is ok), if subdir is
2979 * outside dir, return -1. Otherwise return the offset in subdir that
2980 * can be used as relative path to dir.
2982 int dir_inside_of(const char *subdir, const char *dir)
2984 int offset = 0;
2986 assert(dir && subdir && *dir && *subdir);
2988 while (*dir && *subdir && !cmp_icase(*dir, *subdir)) {
2989 dir++;
2990 subdir++;
2991 offset++;
2994 /* hel[p]/me vs hel[l]/yeah */
2995 if (*dir && *subdir)
2996 return -1;
2998 if (!*subdir)
2999 return !*dir ? offset : -1; /* same dir */
3001 /* foo/[b]ar vs foo/[] */
3002 if (is_dir_sep(dir[-1]))
3003 return is_dir_sep(subdir[-1]) ? offset : -1;
3005 /* foo[/]bar vs foo[] */
3006 return is_dir_sep(*subdir) ? offset + 1 : -1;
3009 int is_inside_dir(const char *dir)
3011 char *cwd;
3012 int rc;
3014 if (!dir)
3015 return 0;
3017 cwd = xgetcwd();
3018 rc = (dir_inside_of(cwd, dir) >= 0);
3019 free(cwd);
3020 return rc;
3023 int is_empty_dir(const char *path)
3025 DIR *dir = opendir(path);
3026 struct dirent *e;
3027 int ret = 1;
3029 if (!dir)
3030 return 0;
3032 e = readdir_skip_dot_and_dotdot(dir);
3033 if (e)
3034 ret = 0;
3036 closedir(dir);
3037 return ret;
3040 char *git_url_basename(const char *repo, int is_bundle, int is_bare)
3042 const char *end = repo + strlen(repo), *start, *ptr;
3043 size_t len;
3044 char *dir;
3047 * Skip scheme.
3049 start = strstr(repo, "://");
3050 if (start == NULL)
3051 start = repo;
3052 else
3053 start += 3;
3056 * Skip authentication data. The stripping does happen
3057 * greedily, such that we strip up to the last '@' inside
3058 * the host part.
3060 for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
3061 if (*ptr == '@')
3062 start = ptr + 1;
3066 * Strip trailing spaces, slashes and /.git
3068 while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
3069 end--;
3070 if (end - start > 5 && is_dir_sep(end[-5]) &&
3071 !strncmp(end - 4, ".git", 4)) {
3072 end -= 5;
3073 while (start < end && is_dir_sep(end[-1]))
3074 end--;
3078 * It should not be possible to overflow `ptrdiff_t` by passing in an
3079 * insanely long URL, but GCC does not know that and will complain
3080 * without this check.
3082 if (end - start < 0)
3083 die(_("No directory name could be guessed.\n"
3084 "Please specify a directory on the command line"));
3087 * Strip trailing port number if we've got only a
3088 * hostname (that is, there is no dir separator but a
3089 * colon). This check is required such that we do not
3090 * strip URI's like '/foo/bar:2222.git', which should
3091 * result in a dir '2222' being guessed due to backwards
3092 * compatibility.
3094 if (memchr(start, '/', end - start) == NULL
3095 && memchr(start, ':', end - start) != NULL) {
3096 ptr = end;
3097 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
3098 ptr--;
3099 if (start < ptr && ptr[-1] == ':')
3100 end = ptr - 1;
3104 * Find last component. To remain backwards compatible we
3105 * also regard colons as path separators, such that
3106 * cloning a repository 'foo:bar.git' would result in a
3107 * directory 'bar' being guessed.
3109 ptr = end;
3110 while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
3111 ptr--;
3112 start = ptr;
3115 * Strip .{bundle,git}.
3117 len = end - start;
3118 strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
3120 if (!len || (len == 1 && *start == '/'))
3121 die(_("No directory name could be guessed.\n"
3122 "Please specify a directory on the command line"));
3124 if (is_bare)
3125 dir = xstrfmt("%.*s.git", (int)len, start);
3126 else
3127 dir = xstrndup(start, len);
3129 * Replace sequences of 'control' characters and whitespace
3130 * with one ascii space, remove leading and trailing spaces.
3132 if (*dir) {
3133 char *out = dir;
3134 int prev_space = 1 /* strip leading whitespace */;
3135 for (end = dir; *end; ++end) {
3136 char ch = *end;
3137 if ((unsigned char)ch < '\x20')
3138 ch = '\x20';
3139 if (isspace(ch)) {
3140 if (prev_space)
3141 continue;
3142 prev_space = 1;
3143 } else
3144 prev_space = 0;
3145 *out++ = ch;
3147 *out = '\0';
3148 if (out > dir && prev_space)
3149 out[-1] = '\0';
3151 return dir;
3154 void strip_dir_trailing_slashes(char *dir)
3156 char *end = dir + strlen(dir);
3158 while (dir < end - 1 && is_dir_sep(end[-1]))
3159 end--;
3160 *end = '\0';
3163 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
3165 DIR *dir;
3166 struct dirent *e;
3167 int ret = 0, original_len = path->len, len, kept_down = 0;
3168 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
3169 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
3170 int purge_original_cwd = (flag & REMOVE_DIR_PURGE_ORIGINAL_CWD);
3171 struct object_id submodule_head;
3173 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
3174 !resolve_gitlink_ref(path->buf, "HEAD", &submodule_head)) {
3175 /* Do not descend and nuke a nested git work tree. */
3176 if (kept_up)
3177 *kept_up = 1;
3178 return 0;
3181 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
3182 dir = opendir(path->buf);
3183 if (!dir) {
3184 if (errno == ENOENT)
3185 return keep_toplevel ? -1 : 0;
3186 else if (errno == EACCES && !keep_toplevel)
3188 * An empty dir could be removable even if it
3189 * is unreadable:
3191 return rmdir(path->buf);
3192 else
3193 return -1;
3195 strbuf_complete(path, '/');
3197 len = path->len;
3198 while ((e = readdir_skip_dot_and_dotdot(dir)) != NULL) {
3199 struct stat st;
3201 strbuf_setlen(path, len);
3202 strbuf_addstr(path, e->d_name);
3203 if (lstat(path->buf, &st)) {
3204 if (errno == ENOENT)
3206 * file disappeared, which is what we
3207 * wanted anyway
3209 continue;
3210 /* fall through */
3211 } else if (S_ISDIR(st.st_mode)) {
3212 if (!remove_dir_recurse(path, flag, &kept_down))
3213 continue; /* happy */
3214 } else if (!only_empty &&
3215 (!unlink(path->buf) || errno == ENOENT)) {
3216 continue; /* happy, too */
3219 /* path too long, stat fails, or non-directory still exists */
3220 ret = -1;
3221 break;
3223 closedir(dir);
3225 strbuf_setlen(path, original_len);
3226 if (!ret && !keep_toplevel && !kept_down) {
3227 if (!purge_original_cwd &&
3228 startup_info->original_cwd &&
3229 !strcmp(startup_info->original_cwd, path->buf))
3230 ret = -1; /* Do not remove current working directory */
3231 else
3232 ret = (!rmdir(path->buf) || errno == ENOENT) ? 0 : -1;
3233 } else if (kept_up)
3235 * report the uplevel that it is not an error that we
3236 * did not rmdir() our directory.
3238 *kept_up = !ret;
3239 return ret;
3242 int remove_dir_recursively(struct strbuf *path, int flag)
3244 return remove_dir_recurse(path, flag, NULL);
3247 static GIT_PATH_FUNC(git_path_info_exclude, "info/exclude")
3249 void setup_standard_excludes(struct dir_struct *dir)
3251 dir->exclude_per_dir = ".gitignore";
3253 /* core.excludesfile defaulting to $XDG_CONFIG_HOME/git/ignore */
3254 if (!excludes_file)
3255 excludes_file = xdg_config_home("ignore");
3256 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
3257 add_patterns_from_file_1(dir, excludes_file,
3258 dir->untracked ? &dir->ss_excludes_file : NULL);
3260 /* per repository user preference */
3261 if (startup_info->have_repository) {
3262 const char *path = git_path_info_exclude();
3263 if (!access_or_warn(path, R_OK, 0))
3264 add_patterns_from_file_1(dir, path,
3265 dir->untracked ? &dir->ss_info_exclude : NULL);
3269 char *get_sparse_checkout_filename(void)
3271 return git_pathdup("info/sparse-checkout");
3274 int get_sparse_checkout_patterns(struct pattern_list *pl)
3276 int res;
3277 char *sparse_filename = get_sparse_checkout_filename();
3279 pl->use_cone_patterns = core_sparse_checkout_cone;
3280 res = add_patterns_from_file_to_list(sparse_filename, "", 0, pl, NULL, 0);
3282 free(sparse_filename);
3283 return res;
3286 int remove_path(const char *name)
3288 char *slash;
3290 if (unlink(name) && !is_missing_file_error(errno))
3291 return -1;
3293 slash = strrchr(name, '/');
3294 if (slash) {
3295 char *dirs = xstrdup(name);
3296 slash = dirs + (slash - name);
3297 do {
3298 *slash = '\0';
3299 if (startup_info->original_cwd &&
3300 !strcmp(startup_info->original_cwd, dirs))
3301 break;
3302 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
3303 free(dirs);
3305 return 0;
3309 * Frees memory within dir which was allocated, and resets fields for further
3310 * use. Does not free dir itself.
3312 void dir_clear(struct dir_struct *dir)
3314 int i, j;
3315 struct exclude_list_group *group;
3316 struct pattern_list *pl;
3317 struct exclude_stack *stk;
3318 struct dir_struct new = DIR_INIT;
3320 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
3321 group = &dir->exclude_list_group[i];
3322 for (j = 0; j < group->nr; j++) {
3323 pl = &group->pl[j];
3324 if (i == EXC_DIRS)
3325 free((char *)pl->src);
3326 clear_pattern_list(pl);
3328 free(group->pl);
3331 for (i = 0; i < dir->ignored_nr; i++)
3332 free(dir->ignored[i]);
3333 for (i = 0; i < dir->nr; i++)
3334 free(dir->entries[i]);
3335 free(dir->ignored);
3336 free(dir->entries);
3338 stk = dir->exclude_stack;
3339 while (stk) {
3340 struct exclude_stack *prev = stk->prev;
3341 free(stk);
3342 stk = prev;
3344 strbuf_release(&dir->basebuf);
3346 memcpy(dir, &new, sizeof(*dir));
3349 struct ondisk_untracked_cache {
3350 struct stat_data info_exclude_stat;
3351 struct stat_data excludes_file_stat;
3352 uint32_t dir_flags;
3355 #define ouc_offset(x) offsetof(struct ondisk_untracked_cache, x)
3357 struct write_data {
3358 int index; /* number of written untracked_cache_dir */
3359 struct ewah_bitmap *check_only; /* from untracked_cache_dir */
3360 struct ewah_bitmap *valid; /* from untracked_cache_dir */
3361 struct ewah_bitmap *sha1_valid; /* set if exclude_sha1 is not null */
3362 struct strbuf out;
3363 struct strbuf sb_stat;
3364 struct strbuf sb_sha1;
3367 static void stat_data_to_disk(struct stat_data *to, const struct stat_data *from)
3369 to->sd_ctime.sec = htonl(from->sd_ctime.sec);
3370 to->sd_ctime.nsec = htonl(from->sd_ctime.nsec);
3371 to->sd_mtime.sec = htonl(from->sd_mtime.sec);
3372 to->sd_mtime.nsec = htonl(from->sd_mtime.nsec);
3373 to->sd_dev = htonl(from->sd_dev);
3374 to->sd_ino = htonl(from->sd_ino);
3375 to->sd_uid = htonl(from->sd_uid);
3376 to->sd_gid = htonl(from->sd_gid);
3377 to->sd_size = htonl(from->sd_size);
3380 static void write_one_dir(struct untracked_cache_dir *untracked,
3381 struct write_data *wd)
3383 struct stat_data stat_data;
3384 struct strbuf *out = &wd->out;
3385 unsigned char intbuf[16];
3386 unsigned int intlen, value;
3387 int i = wd->index++;
3390 * untracked_nr should be reset whenever valid is clear, but
3391 * for safety..
3393 if (!untracked->valid) {
3394 untracked->untracked_nr = 0;
3395 untracked->check_only = 0;
3398 if (untracked->check_only)
3399 ewah_set(wd->check_only, i);
3400 if (untracked->valid) {
3401 ewah_set(wd->valid, i);
3402 stat_data_to_disk(&stat_data, &untracked->stat_data);
3403 strbuf_add(&wd->sb_stat, &stat_data, sizeof(stat_data));
3405 if (!is_null_oid(&untracked->exclude_oid)) {
3406 ewah_set(wd->sha1_valid, i);
3407 strbuf_add(&wd->sb_sha1, untracked->exclude_oid.hash,
3408 the_hash_algo->rawsz);
3411 intlen = encode_varint(untracked->untracked_nr, intbuf);
3412 strbuf_add(out, intbuf, intlen);
3414 /* skip non-recurse directories */
3415 for (i = 0, value = 0; i < untracked->dirs_nr; i++)
3416 if (untracked->dirs[i]->recurse)
3417 value++;
3418 intlen = encode_varint(value, intbuf);
3419 strbuf_add(out, intbuf, intlen);
3421 strbuf_add(out, untracked->name, strlen(untracked->name) + 1);
3423 for (i = 0; i < untracked->untracked_nr; i++)
3424 strbuf_add(out, untracked->untracked[i],
3425 strlen(untracked->untracked[i]) + 1);
3427 for (i = 0; i < untracked->dirs_nr; i++)
3428 if (untracked->dirs[i]->recurse)
3429 write_one_dir(untracked->dirs[i], wd);
3432 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked)
3434 struct ondisk_untracked_cache *ouc;
3435 struct write_data wd;
3436 unsigned char varbuf[16];
3437 int varint_len;
3438 const unsigned hashsz = the_hash_algo->rawsz;
3440 CALLOC_ARRAY(ouc, 1);
3441 stat_data_to_disk(&ouc->info_exclude_stat, &untracked->ss_info_exclude.stat);
3442 stat_data_to_disk(&ouc->excludes_file_stat, &untracked->ss_excludes_file.stat);
3443 ouc->dir_flags = htonl(untracked->dir_flags);
3445 varint_len = encode_varint(untracked->ident.len, varbuf);
3446 strbuf_add(out, varbuf, varint_len);
3447 strbuf_addbuf(out, &untracked->ident);
3449 strbuf_add(out, ouc, sizeof(*ouc));
3450 strbuf_add(out, untracked->ss_info_exclude.oid.hash, hashsz);
3451 strbuf_add(out, untracked->ss_excludes_file.oid.hash, hashsz);
3452 strbuf_add(out, untracked->exclude_per_dir, strlen(untracked->exclude_per_dir) + 1);
3453 FREE_AND_NULL(ouc);
3455 if (!untracked->root) {
3456 varint_len = encode_varint(0, varbuf);
3457 strbuf_add(out, varbuf, varint_len);
3458 return;
3461 wd.index = 0;
3462 wd.check_only = ewah_new();
3463 wd.valid = ewah_new();
3464 wd.sha1_valid = ewah_new();
3465 strbuf_init(&wd.out, 1024);
3466 strbuf_init(&wd.sb_stat, 1024);
3467 strbuf_init(&wd.sb_sha1, 1024);
3468 write_one_dir(untracked->root, &wd);
3470 varint_len = encode_varint(wd.index, varbuf);
3471 strbuf_add(out, varbuf, varint_len);
3472 strbuf_addbuf(out, &wd.out);
3473 ewah_serialize_strbuf(wd.valid, out);
3474 ewah_serialize_strbuf(wd.check_only, out);
3475 ewah_serialize_strbuf(wd.sha1_valid, out);
3476 strbuf_addbuf(out, &wd.sb_stat);
3477 strbuf_addbuf(out, &wd.sb_sha1);
3478 strbuf_addch(out, '\0'); /* safe guard for string lists */
3480 ewah_free(wd.valid);
3481 ewah_free(wd.check_only);
3482 ewah_free(wd.sha1_valid);
3483 strbuf_release(&wd.out);
3484 strbuf_release(&wd.sb_stat);
3485 strbuf_release(&wd.sb_sha1);
3488 static void free_untracked(struct untracked_cache_dir *ucd)
3490 int i;
3491 if (!ucd)
3492 return;
3493 for (i = 0; i < ucd->dirs_nr; i++)
3494 free_untracked(ucd->dirs[i]);
3495 for (i = 0; i < ucd->untracked_nr; i++)
3496 free(ucd->untracked[i]);
3497 free(ucd->untracked);
3498 free(ucd->dirs);
3499 free(ucd);
3502 void free_untracked_cache(struct untracked_cache *uc)
3504 if (uc)
3505 free_untracked(uc->root);
3506 free(uc);
3509 struct read_data {
3510 int index;
3511 struct untracked_cache_dir **ucd;
3512 struct ewah_bitmap *check_only;
3513 struct ewah_bitmap *valid;
3514 struct ewah_bitmap *sha1_valid;
3515 const unsigned char *data;
3516 const unsigned char *end;
3519 static void stat_data_from_disk(struct stat_data *to, const unsigned char *data)
3521 memcpy(to, data, sizeof(*to));
3522 to->sd_ctime.sec = ntohl(to->sd_ctime.sec);
3523 to->sd_ctime.nsec = ntohl(to->sd_ctime.nsec);
3524 to->sd_mtime.sec = ntohl(to->sd_mtime.sec);
3525 to->sd_mtime.nsec = ntohl(to->sd_mtime.nsec);
3526 to->sd_dev = ntohl(to->sd_dev);
3527 to->sd_ino = ntohl(to->sd_ino);
3528 to->sd_uid = ntohl(to->sd_uid);
3529 to->sd_gid = ntohl(to->sd_gid);
3530 to->sd_size = ntohl(to->sd_size);
3533 static int read_one_dir(struct untracked_cache_dir **untracked_,
3534 struct read_data *rd)
3536 struct untracked_cache_dir ud, *untracked;
3537 const unsigned char *data = rd->data, *end = rd->end;
3538 const unsigned char *eos;
3539 unsigned int value;
3540 int i;
3542 memset(&ud, 0, sizeof(ud));
3544 value = decode_varint(&data);
3545 if (data > end)
3546 return -1;
3547 ud.recurse = 1;
3548 ud.untracked_alloc = value;
3549 ud.untracked_nr = value;
3550 if (ud.untracked_nr)
3551 ALLOC_ARRAY(ud.untracked, ud.untracked_nr);
3553 ud.dirs_alloc = ud.dirs_nr = decode_varint(&data);
3554 if (data > end)
3555 return -1;
3556 ALLOC_ARRAY(ud.dirs, ud.dirs_nr);
3558 eos = memchr(data, '\0', end - data);
3559 if (!eos || eos == end)
3560 return -1;
3562 *untracked_ = untracked = xmalloc(st_add3(sizeof(*untracked), eos - data, 1));
3563 memcpy(untracked, &ud, sizeof(ud));
3564 memcpy(untracked->name, data, eos - data + 1);
3565 data = eos + 1;
3567 for (i = 0; i < untracked->untracked_nr; i++) {
3568 eos = memchr(data, '\0', end - data);
3569 if (!eos || eos == end)
3570 return -1;
3571 untracked->untracked[i] = xmemdupz(data, eos - data);
3572 data = eos + 1;
3575 rd->ucd[rd->index++] = untracked;
3576 rd->data = data;
3578 for (i = 0; i < untracked->dirs_nr; i++) {
3579 if (read_one_dir(untracked->dirs + i, rd) < 0)
3580 return -1;
3582 return 0;
3585 static void set_check_only(size_t pos, void *cb)
3587 struct read_data *rd = cb;
3588 struct untracked_cache_dir *ud = rd->ucd[pos];
3589 ud->check_only = 1;
3592 static void read_stat(size_t pos, void *cb)
3594 struct read_data *rd = cb;
3595 struct untracked_cache_dir *ud = rd->ucd[pos];
3596 if (rd->data + sizeof(struct stat_data) > rd->end) {
3597 rd->data = rd->end + 1;
3598 return;
3600 stat_data_from_disk(&ud->stat_data, rd->data);
3601 rd->data += sizeof(struct stat_data);
3602 ud->valid = 1;
3605 static void read_oid(size_t pos, void *cb)
3607 struct read_data *rd = cb;
3608 struct untracked_cache_dir *ud = rd->ucd[pos];
3609 if (rd->data + the_hash_algo->rawsz > rd->end) {
3610 rd->data = rd->end + 1;
3611 return;
3613 oidread(&ud->exclude_oid, rd->data);
3614 rd->data += the_hash_algo->rawsz;
3617 static void load_oid_stat(struct oid_stat *oid_stat, const unsigned char *data,
3618 const unsigned char *sha1)
3620 stat_data_from_disk(&oid_stat->stat, data);
3621 oidread(&oid_stat->oid, sha1);
3622 oid_stat->valid = 1;
3625 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz)
3627 struct untracked_cache *uc;
3628 struct read_data rd;
3629 const unsigned char *next = data, *end = (const unsigned char *)data + sz;
3630 const char *ident;
3631 int ident_len;
3632 ssize_t len;
3633 const char *exclude_per_dir;
3634 const unsigned hashsz = the_hash_algo->rawsz;
3635 const unsigned offset = sizeof(struct ondisk_untracked_cache);
3636 const unsigned exclude_per_dir_offset = offset + 2 * hashsz;
3638 if (sz <= 1 || end[-1] != '\0')
3639 return NULL;
3640 end--;
3642 ident_len = decode_varint(&next);
3643 if (next + ident_len > end)
3644 return NULL;
3645 ident = (const char *)next;
3646 next += ident_len;
3648 if (next + exclude_per_dir_offset + 1 > end)
3649 return NULL;
3651 CALLOC_ARRAY(uc, 1);
3652 strbuf_init(&uc->ident, ident_len);
3653 strbuf_add(&uc->ident, ident, ident_len);
3654 load_oid_stat(&uc->ss_info_exclude,
3655 next + ouc_offset(info_exclude_stat),
3656 next + offset);
3657 load_oid_stat(&uc->ss_excludes_file,
3658 next + ouc_offset(excludes_file_stat),
3659 next + offset + hashsz);
3660 uc->dir_flags = get_be32(next + ouc_offset(dir_flags));
3661 exclude_per_dir = (const char *)next + exclude_per_dir_offset;
3662 uc->exclude_per_dir = xstrdup(exclude_per_dir);
3663 /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
3664 next += exclude_per_dir_offset + strlen(exclude_per_dir) + 1;
3665 if (next >= end)
3666 goto done2;
3668 len = decode_varint(&next);
3669 if (next > end || len == 0)
3670 goto done2;
3672 rd.valid = ewah_new();
3673 rd.check_only = ewah_new();
3674 rd.sha1_valid = ewah_new();
3675 rd.data = next;
3676 rd.end = end;
3677 rd.index = 0;
3678 ALLOC_ARRAY(rd.ucd, len);
3680 if (read_one_dir(&uc->root, &rd) || rd.index != len)
3681 goto done;
3683 next = rd.data;
3684 len = ewah_read_mmap(rd.valid, next, end - next);
3685 if (len < 0)
3686 goto done;
3688 next += len;
3689 len = ewah_read_mmap(rd.check_only, next, end - next);
3690 if (len < 0)
3691 goto done;
3693 next += len;
3694 len = ewah_read_mmap(rd.sha1_valid, next, end - next);
3695 if (len < 0)
3696 goto done;
3698 ewah_each_bit(rd.check_only, set_check_only, &rd);
3699 rd.data = next + len;
3700 ewah_each_bit(rd.valid, read_stat, &rd);
3701 ewah_each_bit(rd.sha1_valid, read_oid, &rd);
3702 next = rd.data;
3704 done:
3705 free(rd.ucd);
3706 ewah_free(rd.valid);
3707 ewah_free(rd.check_only);
3708 ewah_free(rd.sha1_valid);
3709 done2:
3710 if (next != end) {
3711 free_untracked_cache(uc);
3712 uc = NULL;
3714 return uc;
3717 static void invalidate_one_directory(struct untracked_cache *uc,
3718 struct untracked_cache_dir *ucd)
3720 uc->dir_invalidated++;
3721 ucd->valid = 0;
3722 ucd->untracked_nr = 0;
3726 * Normally when an entry is added or removed from a directory,
3727 * invalidating that directory is enough. No need to touch its
3728 * ancestors. When a directory is shown as "foo/bar/" in git-status
3729 * however, deleting or adding an entry may have cascading effect.
3731 * Say the "foo/bar/file" has become untracked, we need to tell the
3732 * untracked_cache_dir of "foo" that "bar/" is not an untracked
3733 * directory any more (because "bar" is managed by foo as an untracked
3734 * "file").
3736 * Similarly, if "foo/bar/file" moves from untracked to tracked and it
3737 * was the last untracked entry in the entire "foo", we should show
3738 * "foo/" instead. Which means we have to invalidate past "bar" up to
3739 * "foo".
3741 * This function traverses all directories from root to leaf. If there
3742 * is a chance of one of the above cases happening, we invalidate back
3743 * to root. Otherwise we just invalidate the leaf. There may be a more
3744 * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
3745 * detect these cases and avoid unnecessary invalidation, for example,
3746 * checking for the untracked entry named "bar/" in "foo", but for now
3747 * stick to something safe and simple.
3749 static int invalidate_one_component(struct untracked_cache *uc,
3750 struct untracked_cache_dir *dir,
3751 const char *path, int len)
3753 const char *rest = strchr(path, '/');
3755 if (rest) {
3756 int component_len = rest - path;
3757 struct untracked_cache_dir *d =
3758 lookup_untracked(uc, dir, path, component_len);
3759 int ret =
3760 invalidate_one_component(uc, d, rest + 1,
3761 len - (component_len + 1));
3762 if (ret)
3763 invalidate_one_directory(uc, dir);
3764 return ret;
3767 invalidate_one_directory(uc, dir);
3768 return uc->dir_flags & DIR_SHOW_OTHER_DIRECTORIES;
3771 void untracked_cache_invalidate_path(struct index_state *istate,
3772 const char *path, int safe_path)
3774 if (!istate->untracked || !istate->untracked->root)
3775 return;
3776 if (!safe_path && !verify_path(path, 0))
3777 return;
3778 invalidate_one_component(istate->untracked, istate->untracked->root,
3779 path, strlen(path));
3782 void untracked_cache_remove_from_index(struct index_state *istate,
3783 const char *path)
3785 untracked_cache_invalidate_path(istate, path, 1);
3788 void untracked_cache_add_to_index(struct index_state *istate,
3789 const char *path)
3791 untracked_cache_invalidate_path(istate, path, 1);
3794 static void connect_wt_gitdir_in_nested(const char *sub_worktree,
3795 const char *sub_gitdir)
3797 int i;
3798 struct repository subrepo;
3799 struct strbuf sub_wt = STRBUF_INIT;
3800 struct strbuf sub_gd = STRBUF_INIT;
3802 const struct submodule *sub;
3804 /* If the submodule has no working tree, we can ignore it. */
3805 if (repo_init(&subrepo, sub_gitdir, sub_worktree))
3806 return;
3808 if (repo_read_index(&subrepo) < 0)
3809 die(_("index file corrupt in repo %s"), subrepo.gitdir);
3811 /* TODO: audit for interaction with sparse-index. */
3812 ensure_full_index(subrepo.index);
3813 for (i = 0; i < subrepo.index->cache_nr; i++) {
3814 const struct cache_entry *ce = subrepo.index->cache[i];
3816 if (!S_ISGITLINK(ce->ce_mode))
3817 continue;
3819 while (i + 1 < subrepo.index->cache_nr &&
3820 !strcmp(ce->name, subrepo.index->cache[i + 1]->name))
3822 * Skip entries with the same name in different stages
3823 * to make sure an entry is returned only once.
3825 i++;
3827 sub = submodule_from_path(&subrepo, null_oid(), ce->name);
3828 if (!sub || !is_submodule_active(&subrepo, ce->name))
3829 /* .gitmodules broken or inactive sub */
3830 continue;
3832 strbuf_reset(&sub_wt);
3833 strbuf_reset(&sub_gd);
3834 strbuf_addf(&sub_wt, "%s/%s", sub_worktree, sub->path);
3835 submodule_name_to_gitdir(&sub_gd, &subrepo, sub->name);
3837 connect_work_tree_and_git_dir(sub_wt.buf, sub_gd.buf, 1);
3839 strbuf_release(&sub_wt);
3840 strbuf_release(&sub_gd);
3841 repo_clear(&subrepo);
3844 void connect_work_tree_and_git_dir(const char *work_tree_,
3845 const char *git_dir_,
3846 int recurse_into_nested)
3848 struct strbuf gitfile_sb = STRBUF_INIT;
3849 struct strbuf cfg_sb = STRBUF_INIT;
3850 struct strbuf rel_path = STRBUF_INIT;
3851 char *git_dir, *work_tree;
3853 /* Prepare .git file */
3854 strbuf_addf(&gitfile_sb, "%s/.git", work_tree_);
3855 if (safe_create_leading_directories_const(gitfile_sb.buf))
3856 die(_("could not create directories for %s"), gitfile_sb.buf);
3858 /* Prepare config file */
3859 strbuf_addf(&cfg_sb, "%s/config", git_dir_);
3860 if (safe_create_leading_directories_const(cfg_sb.buf))
3861 die(_("could not create directories for %s"), cfg_sb.buf);
3863 git_dir = real_pathdup(git_dir_, 1);
3864 work_tree = real_pathdup(work_tree_, 1);
3866 /* Write .git file */
3867 write_file(gitfile_sb.buf, "gitdir: %s",
3868 relative_path(git_dir, work_tree, &rel_path));
3869 /* Update core.worktree setting */
3870 git_config_set_in_file(cfg_sb.buf, "core.worktree",
3871 relative_path(work_tree, git_dir, &rel_path));
3873 strbuf_release(&gitfile_sb);
3874 strbuf_release(&cfg_sb);
3875 strbuf_release(&rel_path);
3877 if (recurse_into_nested)
3878 connect_wt_gitdir_in_nested(work_tree, git_dir);
3880 free(work_tree);
3881 free(git_dir);
3885 * Migrate the git directory of the given path from old_git_dir to new_git_dir.
3887 void relocate_gitdir(const char *path, const char *old_git_dir, const char *new_git_dir)
3889 if (rename(old_git_dir, new_git_dir) < 0)
3890 die_errno(_("could not migrate git directory from '%s' to '%s'"),
3891 old_git_dir, new_git_dir);
3893 connect_work_tree_and_git_dir(path, new_git_dir, 0);