fast-import: use mem_pool_calloc()
[git.git] / dir.c
blob16fdb03f2a51c9505b3cc9da2d9a908f3e4ae119
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 "git-compat-util.h"
9 #include "abspath.h"
10 #include "config.h"
11 #include "convert.h"
12 #include "dir.h"
13 #include "environment.h"
14 #include "gettext.h"
15 #include "name-hash.h"
16 #include "object-file.h"
17 #include "object-store-ll.h"
18 #include "path.h"
19 #include "attr.h"
20 #include "refs.h"
21 #include "wildmatch.h"
22 #include "pathspec.h"
23 #include "utf8.h"
24 #include "varint.h"
25 #include "ewah/ewok.h"
26 #include "fsmonitor-ll.h"
27 #include "read-cache-ll.h"
28 #include "setup.h"
29 #include "sparse-index.h"
30 #include "submodule-config.h"
31 #include "symlinks.h"
32 #include "trace2.h"
33 #include "tree.h"
36 * Tells read_directory_recursive how a file or directory should be treated.
37 * Values are ordered by significance, e.g. if a directory contains both
38 * excluded and untracked files, it is listed as untracked because
39 * path_untracked > path_excluded.
41 enum path_treatment {
42 path_none = 0,
43 path_recurse,
44 path_excluded,
45 path_untracked
49 * Support data structure for our opendir/readdir/closedir wrappers
51 struct cached_dir {
52 DIR *fdir;
53 struct untracked_cache_dir *untracked;
54 int nr_files;
55 int nr_dirs;
57 const char *d_name;
58 int d_type;
59 const char *file;
60 struct untracked_cache_dir *ucd;
63 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
64 struct index_state *istate, const char *path, int len,
65 struct untracked_cache_dir *untracked,
66 int check_only, int stop_at_first_file, const struct pathspec *pathspec);
67 static int resolve_dtype(int dtype, struct index_state *istate,
68 const char *path, int len);
69 struct dirent *readdir_skip_dot_and_dotdot(DIR *dirp)
71 struct dirent *e;
73 while ((e = readdir(dirp)) != NULL) {
74 if (!is_dot_or_dotdot(e->d_name))
75 break;
77 return e;
80 int count_slashes(const char *s)
82 int cnt = 0;
83 while (*s)
84 if (*s++ == '/')
85 cnt++;
86 return cnt;
89 int fspathcmp(const char *a, const char *b)
91 return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
94 int fspatheq(const char *a, const char *b)
96 return !fspathcmp(a, b);
99 int fspathncmp(const char *a, const char *b, size_t count)
101 return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
104 unsigned int fspathhash(const char *str)
106 return ignore_case ? strihash(str) : strhash(str);
109 int git_fnmatch(const struct pathspec_item *item,
110 const char *pattern, const char *string,
111 int prefix)
113 if (prefix > 0) {
114 if (ps_strncmp(item, pattern, string, prefix))
115 return WM_NOMATCH;
116 pattern += prefix;
117 string += prefix;
119 if (item->flags & PATHSPEC_ONESTAR) {
120 int pattern_len = strlen(++pattern);
121 int string_len = strlen(string);
122 return string_len < pattern_len ||
123 ps_strcmp(item, pattern,
124 string + string_len - pattern_len);
126 if (item->magic & PATHSPEC_GLOB)
127 return wildmatch(pattern, string,
128 WM_PATHNAME |
129 (item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0));
130 else
131 /* wildmatch has not learned no FNM_PATHNAME mode yet */
132 return wildmatch(pattern, string,
133 item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0);
136 static int fnmatch_icase_mem(const char *pattern, int patternlen,
137 const char *string, int stringlen,
138 int flags)
140 int match_status;
141 struct strbuf pat_buf = STRBUF_INIT;
142 struct strbuf str_buf = STRBUF_INIT;
143 const char *use_pat = pattern;
144 const char *use_str = string;
146 if (pattern[patternlen]) {
147 strbuf_add(&pat_buf, pattern, patternlen);
148 use_pat = pat_buf.buf;
150 if (string[stringlen]) {
151 strbuf_add(&str_buf, string, stringlen);
152 use_str = str_buf.buf;
155 if (ignore_case)
156 flags |= WM_CASEFOLD;
157 match_status = wildmatch(use_pat, use_str, flags);
159 strbuf_release(&pat_buf);
160 strbuf_release(&str_buf);
162 return match_status;
165 static size_t common_prefix_len(const struct pathspec *pathspec)
167 int n;
168 size_t max = 0;
171 * ":(icase)path" is treated as a pathspec full of
172 * wildcard. In other words, only prefix is considered common
173 * prefix. If the pathspec is abc/foo abc/bar, running in
174 * subdir xyz, the common prefix is still xyz, not xyz/abc as
175 * in non-:(icase).
177 GUARD_PATHSPEC(pathspec,
178 PATHSPEC_FROMTOP |
179 PATHSPEC_MAXDEPTH |
180 PATHSPEC_LITERAL |
181 PATHSPEC_GLOB |
182 PATHSPEC_ICASE |
183 PATHSPEC_EXCLUDE |
184 PATHSPEC_ATTR);
186 for (n = 0; n < pathspec->nr; n++) {
187 size_t i = 0, len = 0, item_len;
188 if (pathspec->items[n].magic & PATHSPEC_EXCLUDE)
189 continue;
190 if (pathspec->items[n].magic & PATHSPEC_ICASE)
191 item_len = pathspec->items[n].prefix;
192 else
193 item_len = pathspec->items[n].nowildcard_len;
194 while (i < item_len && (n == 0 || i < max)) {
195 char c = pathspec->items[n].match[i];
196 if (c != pathspec->items[0].match[i])
197 break;
198 if (c == '/')
199 len = i + 1;
200 i++;
202 if (n == 0 || len < max) {
203 max = len;
204 if (!max)
205 break;
208 return max;
212 * Returns a copy of the longest leading path common among all
213 * pathspecs.
215 char *common_prefix(const struct pathspec *pathspec)
217 unsigned long len = common_prefix_len(pathspec);
219 return len ? xmemdupz(pathspec->items[0].match, len) : NULL;
222 int fill_directory(struct dir_struct *dir,
223 struct index_state *istate,
224 const struct pathspec *pathspec)
226 const char *prefix;
227 size_t prefix_len;
229 unsigned exclusive_flags = DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO;
230 if ((dir->flags & exclusive_flags) == exclusive_flags)
231 BUG("DIR_SHOW_IGNORED and DIR_SHOW_IGNORED_TOO are exclusive");
234 * Calculate common prefix for the pathspec, and
235 * use that to optimize the directory walk
237 prefix_len = common_prefix_len(pathspec);
238 prefix = prefix_len ? pathspec->items[0].match : "";
240 /* Read the directory and prune it */
241 read_directory(dir, istate, prefix, prefix_len, pathspec);
243 return prefix_len;
246 int within_depth(const char *name, int namelen,
247 int depth, int max_depth)
249 const char *cp = name, *cpe = name + namelen;
251 while (cp < cpe) {
252 if (*cp++ != '/')
253 continue;
254 depth++;
255 if (depth > max_depth)
256 return 0;
258 return 1;
262 * Read the contents of the blob with the given OID into a buffer.
263 * Append a trailing LF to the end if the last line doesn't have one.
265 * Returns:
266 * -1 when the OID is invalid or unknown or does not refer to a blob.
267 * 0 when the blob is empty.
268 * 1 along with { data, size } of the (possibly augmented) buffer
269 * when successful.
271 * Optionally updates the given oid_stat with the given OID (when valid).
273 static int do_read_blob(const struct object_id *oid, struct oid_stat *oid_stat,
274 size_t *size_out, char **data_out)
276 enum object_type type;
277 unsigned long sz;
278 char *data;
280 *size_out = 0;
281 *data_out = NULL;
283 data = repo_read_object_file(the_repository, oid, &type, &sz);
284 if (!data || type != OBJ_BLOB) {
285 free(data);
286 return -1;
289 if (oid_stat) {
290 memset(&oid_stat->stat, 0, sizeof(oid_stat->stat));
291 oidcpy(&oid_stat->oid, oid);
294 if (sz == 0) {
295 free(data);
296 return 0;
299 if (data[sz - 1] != '\n') {
300 data = xrealloc(data, st_add(sz, 1));
301 data[sz++] = '\n';
304 *size_out = xsize_t(sz);
305 *data_out = data;
307 return 1;
310 #define DO_MATCH_EXCLUDE (1<<0)
311 #define DO_MATCH_DIRECTORY (1<<1)
312 #define DO_MATCH_LEADING_PATHSPEC (1<<2)
315 * Does the given pathspec match the given name? A match is found if
317 * (1) the pathspec string is leading directory of 'name' ("RECURSIVELY"), or
318 * (2) the pathspec string has a leading part matching 'name' ("LEADING"), or
319 * (3) the pathspec string is a wildcard and matches 'name' ("WILDCARD"), or
320 * (4) the pathspec string is exactly the same as 'name' ("EXACT").
322 * Return value tells which case it was (1-4), or 0 when there is no match.
324 * It may be instructive to look at a small table of concrete examples
325 * to understand the differences between 1, 2, and 4:
327 * Pathspecs
328 * | a/b | a/b/ | a/b/c
329 * ------+-----------+-----------+------------
330 * a/b | EXACT | EXACT[1] | LEADING[2]
331 * Names a/b/ | RECURSIVE | EXACT | LEADING[2]
332 * a/b/c | RECURSIVE | RECURSIVE | EXACT
334 * [1] Only if DO_MATCH_DIRECTORY is passed; otherwise, this is NOT a match.
335 * [2] Only if DO_MATCH_LEADING_PATHSPEC is passed; otherwise, not a match.
337 static int match_pathspec_item(struct index_state *istate,
338 const struct pathspec_item *item, int prefix,
339 const char *name, int namelen, unsigned flags)
341 /* name/namelen has prefix cut off by caller */
342 const char *match = item->match + prefix;
343 int matchlen = item->len - prefix;
346 * The normal call pattern is:
347 * 1. prefix = common_prefix_len(ps);
348 * 2. prune something, or fill_directory
349 * 3. match_pathspec()
351 * 'prefix' at #1 may be shorter than the command's prefix and
352 * it's ok for #2 to match extra files. Those extras will be
353 * trimmed at #3.
355 * Suppose the pathspec is 'foo' and '../bar' running from
356 * subdir 'xyz'. The common prefix at #1 will be empty, thanks
357 * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
358 * user does not want XYZ/foo, only the "foo" part should be
359 * case-insensitive. We need to filter out XYZ/foo here. In
360 * other words, we do not trust the caller on comparing the
361 * prefix part when :(icase) is involved. We do exact
362 * comparison ourselves.
364 * Normally the caller (common_prefix_len() in fact) does
365 * _exact_ matching on name[-prefix+1..-1] and we do not need
366 * to check that part. Be defensive and check it anyway, in
367 * case common_prefix_len is changed, or a new caller is
368 * introduced that does not use common_prefix_len.
370 * If the penalty turns out too high when prefix is really
371 * long, maybe change it to
372 * strncmp(match, name, item->prefix - prefix)
374 if (item->prefix && (item->magic & PATHSPEC_ICASE) &&
375 strncmp(item->match, name - prefix, item->prefix))
376 return 0;
378 if (item->attr_match_nr &&
379 !match_pathspec_attrs(istate, name - prefix, namelen + prefix, item))
380 return 0;
382 /* If the match was just the prefix, we matched */
383 if (!*match)
384 return MATCHED_RECURSIVELY;
386 if (matchlen <= namelen && !ps_strncmp(item, match, name, matchlen)) {
387 if (matchlen == namelen)
388 return MATCHED_EXACTLY;
390 if (match[matchlen-1] == '/' || name[matchlen] == '/')
391 return MATCHED_RECURSIVELY;
392 } else if ((flags & DO_MATCH_DIRECTORY) &&
393 match[matchlen - 1] == '/' &&
394 namelen == matchlen - 1 &&
395 !ps_strncmp(item, match, name, namelen))
396 return MATCHED_EXACTLY;
398 if (item->nowildcard_len < item->len &&
399 !git_fnmatch(item, match, name,
400 item->nowildcard_len - prefix))
401 return MATCHED_FNMATCH;
403 /* Perform checks to see if "name" is a leading string of the pathspec */
404 if ( (flags & DO_MATCH_LEADING_PATHSPEC) &&
405 !(flags & DO_MATCH_EXCLUDE)) {
406 /* name is a literal prefix of the pathspec */
407 int offset = name[namelen-1] == '/' ? 1 : 0;
408 if ((namelen < matchlen) &&
409 (match[namelen-offset] == '/') &&
410 !ps_strncmp(item, match, name, namelen))
411 return MATCHED_RECURSIVELY_LEADING_PATHSPEC;
413 /* name doesn't match up to the first wild character */
414 if (item->nowildcard_len < item->len &&
415 ps_strncmp(item, match, name,
416 item->nowildcard_len - prefix))
417 return 0;
420 * name has no wildcard, and it didn't match as a leading
421 * pathspec so return.
423 if (item->nowildcard_len == item->len)
424 return 0;
427 * Here is where we would perform a wildmatch to check if
428 * "name" can be matched as a directory (or a prefix) against
429 * the pathspec. Since wildmatch doesn't have this capability
430 * at the present we have to punt and say that it is a match,
431 * potentially returning a false positive
432 * The submodules themselves will be able to perform more
433 * accurate matching to determine if the pathspec matches.
435 return MATCHED_RECURSIVELY_LEADING_PATHSPEC;
438 return 0;
442 * do_match_pathspec() is meant to ONLY be called by
443 * match_pathspec_with_flags(); calling it directly risks pathspecs
444 * like ':!unwanted_path' being ignored.
446 * Given a name and a list of pathspecs, returns the nature of the
447 * closest (i.e. most specific) match of the name to any of the
448 * pathspecs.
450 * The caller typically calls this multiple times with the same
451 * pathspec and seen[] array but with different name/namelen
452 * (e.g. entries from the index) and is interested in seeing if and
453 * how each pathspec matches all the names it calls this function
454 * with. A mark is left in the seen[] array for each pathspec element
455 * indicating the closest type of match that element achieved, so if
456 * seen[n] remains zero after multiple invocations, that means the nth
457 * pathspec did not match any names, which could indicate that the
458 * user mistyped the nth pathspec.
460 static int do_match_pathspec(struct index_state *istate,
461 const struct pathspec *ps,
462 const char *name, int namelen,
463 int prefix, char *seen,
464 unsigned flags)
466 int i, retval = 0, exclude = flags & DO_MATCH_EXCLUDE;
468 GUARD_PATHSPEC(ps,
469 PATHSPEC_FROMTOP |
470 PATHSPEC_MAXDEPTH |
471 PATHSPEC_LITERAL |
472 PATHSPEC_GLOB |
473 PATHSPEC_ICASE |
474 PATHSPEC_EXCLUDE |
475 PATHSPEC_ATTR);
477 if (!ps->nr) {
478 if (!ps->recursive ||
479 !(ps->magic & PATHSPEC_MAXDEPTH) ||
480 ps->max_depth == -1)
481 return MATCHED_RECURSIVELY;
483 if (within_depth(name, namelen, 0, ps->max_depth))
484 return MATCHED_EXACTLY;
485 else
486 return 0;
489 name += prefix;
490 namelen -= prefix;
492 for (i = ps->nr - 1; i >= 0; i--) {
493 int how;
495 if ((!exclude && ps->items[i].magic & PATHSPEC_EXCLUDE) ||
496 ( exclude && !(ps->items[i].magic & PATHSPEC_EXCLUDE)))
497 continue;
499 if (seen && seen[i] == MATCHED_EXACTLY)
500 continue;
502 * Make exclude patterns optional and never report
503 * "pathspec ':(exclude)foo' matches no files"
505 if (seen && ps->items[i].magic & PATHSPEC_EXCLUDE)
506 seen[i] = MATCHED_FNMATCH;
507 how = match_pathspec_item(istate, ps->items+i, prefix, name,
508 namelen, flags);
509 if (ps->recursive &&
510 (ps->magic & PATHSPEC_MAXDEPTH) &&
511 ps->max_depth != -1 &&
512 how && how != MATCHED_FNMATCH) {
513 int len = ps->items[i].len;
514 if (name[len] == '/')
515 len++;
516 if (within_depth(name+len, namelen-len, 0, ps->max_depth))
517 how = MATCHED_EXACTLY;
518 else
519 how = 0;
521 if (how) {
522 if (retval < how)
523 retval = how;
524 if (seen && seen[i] < how)
525 seen[i] = how;
528 return retval;
531 static int match_pathspec_with_flags(struct index_state *istate,
532 const struct pathspec *ps,
533 const char *name, int namelen,
534 int prefix, char *seen, unsigned flags)
536 int positive, negative;
537 positive = do_match_pathspec(istate, ps, name, namelen,
538 prefix, seen, flags);
539 if (!(ps->magic & PATHSPEC_EXCLUDE) || !positive)
540 return positive;
541 negative = do_match_pathspec(istate, ps, name, namelen,
542 prefix, seen,
543 flags | DO_MATCH_EXCLUDE);
544 return negative ? 0 : positive;
547 int match_pathspec(struct index_state *istate,
548 const struct pathspec *ps,
549 const char *name, int namelen,
550 int prefix, char *seen, int is_dir)
552 unsigned flags = is_dir ? DO_MATCH_DIRECTORY : 0;
553 return match_pathspec_with_flags(istate, ps, name, namelen,
554 prefix, seen, flags);
558 * Check if a submodule is a superset of the pathspec
560 int submodule_path_match(struct index_state *istate,
561 const struct pathspec *ps,
562 const char *submodule_name,
563 char *seen)
565 int matched = match_pathspec_with_flags(istate, ps, submodule_name,
566 strlen(submodule_name),
567 0, seen,
568 DO_MATCH_DIRECTORY |
569 DO_MATCH_LEADING_PATHSPEC);
570 return matched;
573 int report_path_error(const char *ps_matched,
574 const struct pathspec *pathspec)
577 * Make sure all pathspec matched; otherwise it is an error.
579 int num, errors = 0;
580 for (num = 0; num < pathspec->nr; num++) {
581 int other, found_dup;
583 if (ps_matched[num])
584 continue;
586 * The caller might have fed identical pathspec
587 * twice. Do not barf on such a mistake.
588 * FIXME: parse_pathspec should have eliminated
589 * duplicate pathspec.
591 for (found_dup = other = 0;
592 !found_dup && other < pathspec->nr;
593 other++) {
594 if (other == num || !ps_matched[other])
595 continue;
596 if (!strcmp(pathspec->items[other].original,
597 pathspec->items[num].original))
599 * Ok, we have a match already.
601 found_dup = 1;
603 if (found_dup)
604 continue;
606 error(_("pathspec '%s' did not match any file(s) known to git"),
607 pathspec->items[num].original);
608 errors++;
610 return errors;
614 * Return the length of the "simple" part of a path match limiter.
616 int simple_length(const char *match)
618 int len = -1;
620 for (;;) {
621 unsigned char c = *match++;
622 len++;
623 if (c == '\0' || is_glob_special(c))
624 return len;
628 int no_wildcard(const char *string)
630 return string[simple_length(string)] == '\0';
633 void parse_path_pattern(const char **pattern,
634 int *patternlen,
635 unsigned *flags,
636 int *nowildcardlen)
638 const char *p = *pattern;
639 size_t i, len;
641 *flags = 0;
642 if (*p == '!') {
643 *flags |= PATTERN_FLAG_NEGATIVE;
644 p++;
646 len = strlen(p);
647 if (len && p[len - 1] == '/') {
648 len--;
649 *flags |= PATTERN_FLAG_MUSTBEDIR;
651 for (i = 0; i < len; i++) {
652 if (p[i] == '/')
653 break;
655 if (i == len)
656 *flags |= PATTERN_FLAG_NODIR;
657 *nowildcardlen = simple_length(p);
659 * we should have excluded the trailing slash from 'p' too,
660 * but that's one more allocation. Instead just make sure
661 * nowildcardlen does not exceed real patternlen
663 if (*nowildcardlen > len)
664 *nowildcardlen = len;
665 if (*p == '*' && no_wildcard(p + 1))
666 *flags |= PATTERN_FLAG_ENDSWITH;
667 *pattern = p;
668 *patternlen = len;
671 int pl_hashmap_cmp(const void *cmp_data UNUSED,
672 const struct hashmap_entry *a,
673 const struct hashmap_entry *b,
674 const void *key UNUSED)
676 const struct pattern_entry *ee1 =
677 container_of(a, struct pattern_entry, ent);
678 const struct pattern_entry *ee2 =
679 container_of(b, struct pattern_entry, ent);
681 size_t min_len = ee1->patternlen <= ee2->patternlen
682 ? ee1->patternlen
683 : ee2->patternlen;
685 return fspathncmp(ee1->pattern, ee2->pattern, min_len);
688 static char *dup_and_filter_pattern(const char *pattern)
690 char *set, *read;
691 size_t count = 0;
692 char *result = xstrdup(pattern);
694 set = result;
695 read = result;
697 while (*read) {
698 /* skip escape characters (once) */
699 if (*read == '\\')
700 read++;
702 *set = *read;
704 set++;
705 read++;
706 count++;
708 *set = 0;
710 if (count > 2 &&
711 *(set - 1) == '*' &&
712 *(set - 2) == '/')
713 *(set - 2) = 0;
715 return result;
718 static void add_pattern_to_hashsets(struct pattern_list *pl, struct path_pattern *given)
720 struct pattern_entry *translated;
721 char *truncated;
722 char *data = NULL;
723 const char *prev, *cur, *next;
725 if (!pl->use_cone_patterns)
726 return;
728 if (given->flags & PATTERN_FLAG_NEGATIVE &&
729 given->flags & PATTERN_FLAG_MUSTBEDIR &&
730 !strcmp(given->pattern, "/*")) {
731 pl->full_cone = 0;
732 return;
735 if (!given->flags && !strcmp(given->pattern, "/*")) {
736 pl->full_cone = 1;
737 return;
740 if (given->patternlen < 2 ||
741 *given->pattern != '/' ||
742 strstr(given->pattern, "**")) {
743 /* Not a cone pattern. */
744 warning(_("unrecognized pattern: '%s'"), given->pattern);
745 goto clear_hashmaps;
748 if (!(given->flags & PATTERN_FLAG_MUSTBEDIR) &&
749 strcmp(given->pattern, "/*")) {
750 /* Not a cone pattern. */
751 warning(_("unrecognized pattern: '%s'"), given->pattern);
752 goto clear_hashmaps;
755 prev = given->pattern;
756 cur = given->pattern + 1;
757 next = given->pattern + 2;
759 while (*cur) {
760 /* Watch for glob characters '*', '\', '[', '?' */
761 if (!is_glob_special(*cur))
762 goto increment;
764 /* But only if *prev != '\\' */
765 if (*prev == '\\')
766 goto increment;
768 /* But allow the initial '\' */
769 if (*cur == '\\' &&
770 is_glob_special(*next))
771 goto increment;
773 /* But a trailing '/' then '*' is fine */
774 if (*prev == '/' &&
775 *cur == '*' &&
776 *next == 0)
777 goto increment;
779 /* Not a cone pattern. */
780 warning(_("unrecognized pattern: '%s'"), given->pattern);
781 goto clear_hashmaps;
783 increment:
784 prev++;
785 cur++;
786 next++;
789 if (given->patternlen > 2 &&
790 !strcmp(given->pattern + given->patternlen - 2, "/*")) {
791 if (!(given->flags & PATTERN_FLAG_NEGATIVE)) {
792 /* Not a cone pattern. */
793 warning(_("unrecognized pattern: '%s'"), given->pattern);
794 goto clear_hashmaps;
797 truncated = dup_and_filter_pattern(given->pattern);
799 translated = xmalloc(sizeof(struct pattern_entry));
800 translated->pattern = truncated;
801 translated->patternlen = given->patternlen - 2;
802 hashmap_entry_init(&translated->ent,
803 fspathhash(translated->pattern));
805 if (!hashmap_get_entry(&pl->recursive_hashmap,
806 translated, ent, NULL)) {
807 /* We did not see the "parent" included */
808 warning(_("unrecognized negative pattern: '%s'"),
809 given->pattern);
810 free(truncated);
811 free(translated);
812 goto clear_hashmaps;
815 hashmap_add(&pl->parent_hashmap, &translated->ent);
816 hashmap_remove(&pl->recursive_hashmap, &translated->ent, &data);
817 free(data);
818 return;
821 if (given->flags & PATTERN_FLAG_NEGATIVE) {
822 warning(_("unrecognized negative pattern: '%s'"),
823 given->pattern);
824 goto clear_hashmaps;
827 translated = xmalloc(sizeof(struct pattern_entry));
829 translated->pattern = dup_and_filter_pattern(given->pattern);
830 translated->patternlen = given->patternlen;
831 hashmap_entry_init(&translated->ent,
832 fspathhash(translated->pattern));
834 hashmap_add(&pl->recursive_hashmap, &translated->ent);
836 if (hashmap_get_entry(&pl->parent_hashmap, translated, ent, NULL)) {
837 /* we already included this at the parent level */
838 warning(_("your sparse-checkout file may have issues: pattern '%s' is repeated"),
839 given->pattern);
840 goto clear_hashmaps;
843 return;
845 clear_hashmaps:
846 warning(_("disabling cone pattern matching"));
847 hashmap_clear_and_free(&pl->parent_hashmap, struct pattern_entry, ent);
848 hashmap_clear_and_free(&pl->recursive_hashmap, struct pattern_entry, ent);
849 pl->use_cone_patterns = 0;
852 static int hashmap_contains_path(struct hashmap *map,
853 struct strbuf *pattern)
855 struct pattern_entry p;
857 /* Check straight mapping */
858 p.pattern = pattern->buf;
859 p.patternlen = pattern->len;
860 hashmap_entry_init(&p.ent, fspathhash(p.pattern));
861 return !!hashmap_get_entry(map, &p, ent, NULL);
864 int hashmap_contains_parent(struct hashmap *map,
865 const char *path,
866 struct strbuf *buffer)
868 char *slash_pos;
870 strbuf_setlen(buffer, 0);
872 if (path[0] != '/')
873 strbuf_addch(buffer, '/');
875 strbuf_addstr(buffer, path);
877 slash_pos = strrchr(buffer->buf, '/');
879 while (slash_pos > buffer->buf) {
880 strbuf_setlen(buffer, slash_pos - buffer->buf);
882 if (hashmap_contains_path(map, buffer))
883 return 1;
885 slash_pos = strrchr(buffer->buf, '/');
888 return 0;
891 void add_pattern(const char *string, const char *base,
892 int baselen, struct pattern_list *pl, int srcpos)
894 struct path_pattern *pattern;
895 int patternlen;
896 unsigned flags;
897 int nowildcardlen;
899 parse_path_pattern(&string, &patternlen, &flags, &nowildcardlen);
900 if (flags & PATTERN_FLAG_MUSTBEDIR) {
901 FLEXPTR_ALLOC_MEM(pattern, pattern, string, patternlen);
902 } else {
903 pattern = xmalloc(sizeof(*pattern));
904 pattern->pattern = string;
906 pattern->patternlen = patternlen;
907 pattern->nowildcardlen = nowildcardlen;
908 pattern->base = base;
909 pattern->baselen = baselen;
910 pattern->flags = flags;
911 pattern->srcpos = srcpos;
912 ALLOC_GROW(pl->patterns, pl->nr + 1, pl->alloc);
913 pl->patterns[pl->nr++] = pattern;
914 pattern->pl = pl;
916 add_pattern_to_hashsets(pl, pattern);
919 static int read_skip_worktree_file_from_index(struct index_state *istate,
920 const char *path,
921 size_t *size_out, char **data_out,
922 struct oid_stat *oid_stat)
924 int pos, len;
926 len = strlen(path);
927 pos = index_name_pos(istate, path, len);
928 if (pos < 0)
929 return -1;
930 if (!ce_skip_worktree(istate->cache[pos]))
931 return -1;
933 return do_read_blob(&istate->cache[pos]->oid, oid_stat, size_out, data_out);
937 * Frees memory within pl which was allocated for exclude patterns and
938 * the file buffer. Does not free pl itself.
940 void clear_pattern_list(struct pattern_list *pl)
942 int i;
944 for (i = 0; i < pl->nr; i++)
945 free(pl->patterns[i]);
946 free(pl->patterns);
947 free(pl->filebuf);
948 hashmap_clear_and_free(&pl->recursive_hashmap, struct pattern_entry, ent);
949 hashmap_clear_and_free(&pl->parent_hashmap, struct pattern_entry, ent);
951 memset(pl, 0, sizeof(*pl));
954 static void trim_trailing_spaces(char *buf)
956 char *p, *last_space = NULL;
958 for (p = buf; *p; p++)
959 switch (*p) {
960 case ' ':
961 if (!last_space)
962 last_space = p;
963 break;
964 case '\\':
965 p++;
966 if (!*p)
967 return;
968 /* fallthrough */
969 default:
970 last_space = NULL;
973 if (last_space)
974 *last_space = '\0';
978 * Given a subdirectory name and "dir" of the current directory,
979 * search the subdir in "dir" and return it, or create a new one if it
980 * does not exist in "dir".
982 * If "name" has the trailing slash, it'll be excluded in the search.
984 static struct untracked_cache_dir *lookup_untracked(struct untracked_cache *uc,
985 struct untracked_cache_dir *dir,
986 const char *name, int len)
988 int first, last;
989 struct untracked_cache_dir *d;
990 if (!dir)
991 return NULL;
992 if (len && name[len - 1] == '/')
993 len--;
994 first = 0;
995 last = dir->dirs_nr;
996 while (last > first) {
997 int cmp, next = first + ((last - first) >> 1);
998 d = dir->dirs[next];
999 cmp = strncmp(name, d->name, len);
1000 if (!cmp && strlen(d->name) > len)
1001 cmp = -1;
1002 if (!cmp)
1003 return d;
1004 if (cmp < 0) {
1005 last = next;
1006 continue;
1008 first = next+1;
1011 uc->dir_created++;
1012 FLEX_ALLOC_MEM(d, name, name, len);
1014 ALLOC_GROW(dir->dirs, dir->dirs_nr + 1, dir->dirs_alloc);
1015 MOVE_ARRAY(dir->dirs + first + 1, dir->dirs + first,
1016 dir->dirs_nr - first);
1017 dir->dirs_nr++;
1018 dir->dirs[first] = d;
1019 return d;
1022 static void do_invalidate_gitignore(struct untracked_cache_dir *dir)
1024 int i;
1025 dir->valid = 0;
1026 dir->untracked_nr = 0;
1027 for (i = 0; i < dir->dirs_nr; i++)
1028 do_invalidate_gitignore(dir->dirs[i]);
1031 static void invalidate_gitignore(struct untracked_cache *uc,
1032 struct untracked_cache_dir *dir)
1034 uc->gitignore_invalidated++;
1035 do_invalidate_gitignore(dir);
1038 static void invalidate_directory(struct untracked_cache *uc,
1039 struct untracked_cache_dir *dir)
1041 int i;
1044 * Invalidation increment here is just roughly correct. If
1045 * untracked_nr or any of dirs[].recurse is non-zero, we
1046 * should increment dir_invalidated too. But that's more
1047 * expensive to do.
1049 if (dir->valid)
1050 uc->dir_invalidated++;
1052 dir->valid = 0;
1053 dir->untracked_nr = 0;
1054 for (i = 0; i < dir->dirs_nr; i++)
1055 dir->dirs[i]->recurse = 0;
1058 static int add_patterns_from_buffer(char *buf, size_t size,
1059 const char *base, int baselen,
1060 struct pattern_list *pl);
1062 /* Flags for add_patterns() */
1063 #define PATTERN_NOFOLLOW (1<<0)
1066 * Given a file with name "fname", read it (either from disk, or from
1067 * an index if 'istate' is non-null), parse it and store the
1068 * exclude rules in "pl".
1070 * If "oid_stat" is not NULL, compute oid of the exclude file and fill
1071 * stat data from disk (only valid if add_patterns returns zero). If
1072 * oid_stat.valid is non-zero, "oid_stat" must contain good value as input.
1074 static int add_patterns(const char *fname, const char *base, int baselen,
1075 struct pattern_list *pl, struct index_state *istate,
1076 unsigned flags, struct oid_stat *oid_stat)
1078 struct stat st;
1079 int r;
1080 int fd;
1081 size_t size = 0;
1082 char *buf;
1084 if (flags & PATTERN_NOFOLLOW)
1085 fd = open_nofollow(fname, O_RDONLY);
1086 else
1087 fd = open(fname, O_RDONLY);
1089 if (fd < 0 || fstat(fd, &st) < 0) {
1090 if (fd < 0)
1091 warn_on_fopen_errors(fname);
1092 else
1093 close(fd);
1094 if (!istate)
1095 return -1;
1096 r = read_skip_worktree_file_from_index(istate, fname,
1097 &size, &buf,
1098 oid_stat);
1099 if (r != 1)
1100 return r;
1101 } else {
1102 size = xsize_t(st.st_size);
1103 if (size == 0) {
1104 if (oid_stat) {
1105 fill_stat_data(&oid_stat->stat, &st);
1106 oidcpy(&oid_stat->oid, the_hash_algo->empty_blob);
1107 oid_stat->valid = 1;
1109 close(fd);
1110 return 0;
1112 buf = xmallocz(size);
1113 if (read_in_full(fd, buf, size) != size) {
1114 free(buf);
1115 close(fd);
1116 return -1;
1118 buf[size++] = '\n';
1119 close(fd);
1120 if (oid_stat) {
1121 int pos;
1122 if (oid_stat->valid &&
1123 !match_stat_data_racy(istate, &oid_stat->stat, &st))
1124 ; /* no content change, oid_stat->oid still good */
1125 else if (istate &&
1126 (pos = index_name_pos(istate, fname, strlen(fname))) >= 0 &&
1127 !ce_stage(istate->cache[pos]) &&
1128 ce_uptodate(istate->cache[pos]) &&
1129 !would_convert_to_git(istate, fname))
1130 oidcpy(&oid_stat->oid,
1131 &istate->cache[pos]->oid);
1132 else
1133 hash_object_file(the_hash_algo, buf, size,
1134 OBJ_BLOB, &oid_stat->oid);
1135 fill_stat_data(&oid_stat->stat, &st);
1136 oid_stat->valid = 1;
1140 add_patterns_from_buffer(buf, size, base, baselen, pl);
1141 return 0;
1144 static int add_patterns_from_buffer(char *buf, size_t size,
1145 const char *base, int baselen,
1146 struct pattern_list *pl)
1148 int i, lineno = 1;
1149 char *entry;
1151 hashmap_init(&pl->recursive_hashmap, pl_hashmap_cmp, NULL, 0);
1152 hashmap_init(&pl->parent_hashmap, pl_hashmap_cmp, NULL, 0);
1154 pl->filebuf = buf;
1156 if (skip_utf8_bom(&buf, size))
1157 size -= buf - pl->filebuf;
1159 entry = buf;
1161 for (i = 0; i < size; i++) {
1162 if (buf[i] == '\n') {
1163 if (entry != buf + i && entry[0] != '#') {
1164 buf[i - (i && buf[i-1] == '\r')] = 0;
1165 trim_trailing_spaces(entry);
1166 add_pattern(entry, base, baselen, pl, lineno);
1168 lineno++;
1169 entry = buf + i + 1;
1172 return 0;
1175 int add_patterns_from_file_to_list(const char *fname, const char *base,
1176 int baselen, struct pattern_list *pl,
1177 struct index_state *istate,
1178 unsigned flags)
1180 return add_patterns(fname, base, baselen, pl, istate, flags, NULL);
1183 int add_patterns_from_blob_to_list(
1184 struct object_id *oid,
1185 const char *base, int baselen,
1186 struct pattern_list *pl)
1188 char *buf;
1189 size_t size;
1190 int r;
1192 r = do_read_blob(oid, NULL, &size, &buf);
1193 if (r != 1)
1194 return r;
1196 add_patterns_from_buffer(buf, size, base, baselen, pl);
1197 return 0;
1200 struct pattern_list *add_pattern_list(struct dir_struct *dir,
1201 int group_type, const char *src)
1203 struct pattern_list *pl;
1204 struct exclude_list_group *group;
1206 group = &dir->internal.exclude_list_group[group_type];
1207 ALLOC_GROW(group->pl, group->nr + 1, group->alloc);
1208 pl = &group->pl[group->nr++];
1209 memset(pl, 0, sizeof(*pl));
1210 pl->src = src;
1211 return pl;
1215 * Used to set up core.excludesfile and .git/info/exclude lists.
1217 static void add_patterns_from_file_1(struct dir_struct *dir, const char *fname,
1218 struct oid_stat *oid_stat)
1220 struct pattern_list *pl;
1222 * catch setup_standard_excludes() that's called before
1223 * dir->untracked is assigned. That function behaves
1224 * differently when dir->untracked is non-NULL.
1226 if (!dir->untracked)
1227 dir->internal.unmanaged_exclude_files++;
1228 pl = add_pattern_list(dir, EXC_FILE, fname);
1229 if (add_patterns(fname, "", 0, pl, NULL, 0, oid_stat) < 0)
1230 die(_("cannot use %s as an exclude file"), fname);
1233 void add_patterns_from_file(struct dir_struct *dir, const char *fname)
1235 dir->internal.unmanaged_exclude_files++; /* see validate_untracked_cache() */
1236 add_patterns_from_file_1(dir, fname, NULL);
1239 int match_basename(const char *basename, int basenamelen,
1240 const char *pattern, int prefix, int patternlen,
1241 unsigned flags)
1243 if (prefix == patternlen) {
1244 if (patternlen == basenamelen &&
1245 !fspathncmp(pattern, basename, basenamelen))
1246 return 1;
1247 } else if (flags & PATTERN_FLAG_ENDSWITH) {
1248 /* "*literal" matching against "fooliteral" */
1249 if (patternlen - 1 <= basenamelen &&
1250 !fspathncmp(pattern + 1,
1251 basename + basenamelen - (patternlen - 1),
1252 patternlen - 1))
1253 return 1;
1254 } else {
1255 if (fnmatch_icase_mem(pattern, patternlen,
1256 basename, basenamelen,
1257 0) == 0)
1258 return 1;
1260 return 0;
1263 int match_pathname(const char *pathname, int pathlen,
1264 const char *base, int baselen,
1265 const char *pattern, int prefix, int patternlen)
1267 const char *name;
1268 int namelen;
1271 * match with FNM_PATHNAME; the pattern has base implicitly
1272 * in front of it.
1274 if (*pattern == '/') {
1275 pattern++;
1276 patternlen--;
1277 prefix--;
1281 * baselen does not count the trailing slash. base[] may or
1282 * may not end with a trailing slash though.
1284 if (pathlen < baselen + 1 ||
1285 (baselen && pathname[baselen] != '/') ||
1286 fspathncmp(pathname, base, baselen))
1287 return 0;
1289 namelen = baselen ? pathlen - baselen - 1 : pathlen;
1290 name = pathname + pathlen - namelen;
1292 if (prefix) {
1294 * if the non-wildcard part is longer than the
1295 * remaining pathname, surely it cannot match.
1297 if (prefix > namelen)
1298 return 0;
1300 if (fspathncmp(pattern, name, prefix))
1301 return 0;
1302 pattern += prefix;
1303 patternlen -= prefix;
1304 name += prefix;
1305 namelen -= prefix;
1308 * If the whole pattern did not have a wildcard,
1309 * then our prefix match is all we need; we
1310 * do not need to call fnmatch at all.
1312 if (!patternlen && !namelen)
1313 return 1;
1316 return fnmatch_icase_mem(pattern, patternlen,
1317 name, namelen,
1318 WM_PATHNAME) == 0;
1322 * Scan the given exclude list in reverse to see whether pathname
1323 * should be ignored. The first match (i.e. the last on the list), if
1324 * any, determines the fate. Returns the exclude_list element which
1325 * matched, or NULL for undecided.
1327 static struct path_pattern *last_matching_pattern_from_list(const char *pathname,
1328 int pathlen,
1329 const char *basename,
1330 int *dtype,
1331 struct pattern_list *pl,
1332 struct index_state *istate)
1334 struct path_pattern *res = NULL; /* undecided */
1335 int i;
1337 if (!pl->nr)
1338 return NULL; /* undefined */
1340 for (i = pl->nr - 1; 0 <= i; i--) {
1341 struct path_pattern *pattern = pl->patterns[i];
1342 const char *exclude = pattern->pattern;
1343 int prefix = pattern->nowildcardlen;
1345 if (pattern->flags & PATTERN_FLAG_MUSTBEDIR) {
1346 *dtype = resolve_dtype(*dtype, istate, pathname, pathlen);
1347 if (*dtype != DT_DIR)
1348 continue;
1351 if (pattern->flags & PATTERN_FLAG_NODIR) {
1352 if (match_basename(basename,
1353 pathlen - (basename - pathname),
1354 exclude, prefix, pattern->patternlen,
1355 pattern->flags)) {
1356 res = pattern;
1357 break;
1359 continue;
1362 assert(pattern->baselen == 0 ||
1363 pattern->base[pattern->baselen - 1] == '/');
1364 if (match_pathname(pathname, pathlen,
1365 pattern->base,
1366 pattern->baselen ? pattern->baselen - 1 : 0,
1367 exclude, prefix, pattern->patternlen)) {
1368 res = pattern;
1369 break;
1372 return res;
1376 * Scan the list of patterns to determine if the ordered list
1377 * of patterns matches on 'pathname'.
1379 * Return 1 for a match, 0 for not matched and -1 for undecided.
1381 enum pattern_match_result path_matches_pattern_list(
1382 const char *pathname, int pathlen,
1383 const char *basename, int *dtype,
1384 struct pattern_list *pl,
1385 struct index_state *istate)
1387 struct path_pattern *pattern;
1388 struct strbuf parent_pathname = STRBUF_INIT;
1389 int result = NOT_MATCHED;
1390 size_t slash_pos;
1392 if (!pl->use_cone_patterns) {
1393 pattern = last_matching_pattern_from_list(pathname, pathlen, basename,
1394 dtype, pl, istate);
1395 if (pattern) {
1396 if (pattern->flags & PATTERN_FLAG_NEGATIVE)
1397 return NOT_MATCHED;
1398 else
1399 return MATCHED;
1402 return UNDECIDED;
1405 if (pl->full_cone)
1406 return MATCHED;
1408 strbuf_addch(&parent_pathname, '/');
1409 strbuf_add(&parent_pathname, pathname, pathlen);
1412 * Directory entries are matched if and only if a file
1413 * contained immediately within them is matched. For the
1414 * case of a directory entry, modify the path to create
1415 * a fake filename within this directory, allowing us to
1416 * use the file-base matching logic in an equivalent way.
1418 if (parent_pathname.len > 0 &&
1419 parent_pathname.buf[parent_pathname.len - 1] == '/') {
1420 slash_pos = parent_pathname.len - 1;
1421 strbuf_add(&parent_pathname, "-", 1);
1422 } else {
1423 const char *slash_ptr = strrchr(parent_pathname.buf, '/');
1424 slash_pos = slash_ptr ? slash_ptr - parent_pathname.buf : 0;
1427 if (hashmap_contains_path(&pl->recursive_hashmap,
1428 &parent_pathname)) {
1429 result = MATCHED_RECURSIVE;
1430 goto done;
1433 if (!slash_pos) {
1434 /* include every file in root */
1435 result = MATCHED;
1436 goto done;
1439 strbuf_setlen(&parent_pathname, slash_pos);
1441 if (hashmap_contains_path(&pl->parent_hashmap, &parent_pathname)) {
1442 result = MATCHED;
1443 goto done;
1446 if (hashmap_contains_parent(&pl->recursive_hashmap,
1447 pathname,
1448 &parent_pathname))
1449 result = MATCHED_RECURSIVE;
1451 done:
1452 strbuf_release(&parent_pathname);
1453 return result;
1456 int init_sparse_checkout_patterns(struct index_state *istate)
1458 if (!core_apply_sparse_checkout)
1459 return 1;
1460 if (istate->sparse_checkout_patterns)
1461 return 0;
1463 CALLOC_ARRAY(istate->sparse_checkout_patterns, 1);
1465 if (get_sparse_checkout_patterns(istate->sparse_checkout_patterns) < 0) {
1466 FREE_AND_NULL(istate->sparse_checkout_patterns);
1467 return -1;
1470 return 0;
1473 static int path_in_sparse_checkout_1(const char *path,
1474 struct index_state *istate,
1475 int require_cone_mode)
1477 int dtype = DT_REG;
1478 enum pattern_match_result match = UNDECIDED;
1479 const char *end, *slash;
1482 * We default to accepting a path if the path is empty, there are no
1483 * patterns, or the patterns are of the wrong type.
1485 if (!*path ||
1486 init_sparse_checkout_patterns(istate) ||
1487 (require_cone_mode &&
1488 !istate->sparse_checkout_patterns->use_cone_patterns))
1489 return 1;
1492 * If UNDECIDED, use the match from the parent dir (recursively), or
1493 * fall back to NOT_MATCHED at the topmost level. Note that cone mode
1494 * never returns UNDECIDED, so we will execute only one iteration in
1495 * this case.
1497 for (end = path + strlen(path);
1498 end > path && match == UNDECIDED;
1499 end = slash) {
1501 for (slash = end - 1; slash > path && *slash != '/'; slash--)
1502 ; /* do nothing */
1504 match = path_matches_pattern_list(path, end - path,
1505 slash > path ? slash + 1 : path, &dtype,
1506 istate->sparse_checkout_patterns, istate);
1508 /* We are going to match the parent dir now */
1509 dtype = DT_DIR;
1511 return match > 0;
1514 int path_in_sparse_checkout(const char *path,
1515 struct index_state *istate)
1517 return path_in_sparse_checkout_1(path, istate, 0);
1520 int path_in_cone_mode_sparse_checkout(const char *path,
1521 struct index_state *istate)
1523 return path_in_sparse_checkout_1(path, istate, 1);
1526 static struct path_pattern *last_matching_pattern_from_lists(
1527 struct dir_struct *dir, struct index_state *istate,
1528 const char *pathname, int pathlen,
1529 const char *basename, int *dtype_p)
1531 int i, j;
1532 struct exclude_list_group *group;
1533 struct path_pattern *pattern;
1534 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1535 group = &dir->internal.exclude_list_group[i];
1536 for (j = group->nr - 1; j >= 0; j--) {
1537 pattern = last_matching_pattern_from_list(
1538 pathname, pathlen, basename, dtype_p,
1539 &group->pl[j], istate);
1540 if (pattern)
1541 return pattern;
1544 return NULL;
1548 * Loads the per-directory exclude list for the substring of base
1549 * which has a char length of baselen.
1551 static void prep_exclude(struct dir_struct *dir,
1552 struct index_state *istate,
1553 const char *base, int baselen)
1555 struct exclude_list_group *group;
1556 struct pattern_list *pl;
1557 struct exclude_stack *stk = NULL;
1558 struct untracked_cache_dir *untracked;
1559 int current;
1561 group = &dir->internal.exclude_list_group[EXC_DIRS];
1564 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
1565 * which originate from directories not in the prefix of the
1566 * path being checked.
1568 while ((stk = dir->internal.exclude_stack) != NULL) {
1569 if (stk->baselen <= baselen &&
1570 !strncmp(dir->internal.basebuf.buf, base, stk->baselen))
1571 break;
1572 pl = &group->pl[dir->internal.exclude_stack->exclude_ix];
1573 dir->internal.exclude_stack = stk->prev;
1574 dir->internal.pattern = NULL;
1575 free((char *)pl->src); /* see strbuf_detach() below */
1576 clear_pattern_list(pl);
1577 free(stk);
1578 group->nr--;
1581 /* Skip traversing into sub directories if the parent is excluded */
1582 if (dir->internal.pattern)
1583 return;
1586 * Lazy initialization. All call sites currently just
1587 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1588 * them seems lots of work for little benefit.
1590 if (!dir->internal.basebuf.buf)
1591 strbuf_init(&dir->internal.basebuf, PATH_MAX);
1593 /* Read from the parent directories and push them down. */
1594 current = stk ? stk->baselen : -1;
1595 strbuf_setlen(&dir->internal.basebuf, current < 0 ? 0 : current);
1596 if (dir->untracked)
1597 untracked = stk ? stk->ucd : dir->untracked->root;
1598 else
1599 untracked = NULL;
1601 while (current < baselen) {
1602 const char *cp;
1603 struct oid_stat oid_stat;
1605 CALLOC_ARRAY(stk, 1);
1606 if (current < 0) {
1607 cp = base;
1608 current = 0;
1609 } else {
1610 cp = strchr(base + current + 1, '/');
1611 if (!cp)
1612 die("oops in prep_exclude");
1613 cp++;
1614 untracked =
1615 lookup_untracked(dir->untracked,
1616 untracked,
1617 base + current,
1618 cp - base - current);
1620 stk->prev = dir->internal.exclude_stack;
1621 stk->baselen = cp - base;
1622 stk->exclude_ix = group->nr;
1623 stk->ucd = untracked;
1624 pl = add_pattern_list(dir, EXC_DIRS, NULL);
1625 strbuf_add(&dir->internal.basebuf, base + current, stk->baselen - current);
1626 assert(stk->baselen == dir->internal.basebuf.len);
1628 /* Abort if the directory is excluded */
1629 if (stk->baselen) {
1630 int dt = DT_DIR;
1631 dir->internal.basebuf.buf[stk->baselen - 1] = 0;
1632 dir->internal.pattern = last_matching_pattern_from_lists(dir,
1633 istate,
1634 dir->internal.basebuf.buf, stk->baselen - 1,
1635 dir->internal.basebuf.buf + current, &dt);
1636 dir->internal.basebuf.buf[stk->baselen - 1] = '/';
1637 if (dir->internal.pattern &&
1638 dir->internal.pattern->flags & PATTERN_FLAG_NEGATIVE)
1639 dir->internal.pattern = NULL;
1640 if (dir->internal.pattern) {
1641 dir->internal.exclude_stack = stk;
1642 return;
1646 /* Try to read per-directory file */
1647 oidclr(&oid_stat.oid);
1648 oid_stat.valid = 0;
1649 if (dir->exclude_per_dir &&
1651 * If we know that no files have been added in
1652 * this directory (i.e. valid_cached_dir() has
1653 * been executed and set untracked->valid) ..
1655 (!untracked || !untracked->valid ||
1657 * .. and .gitignore does not exist before
1658 * (i.e. null exclude_oid). Then we can skip
1659 * loading .gitignore, which would result in
1660 * ENOENT anyway.
1662 !is_null_oid(&untracked->exclude_oid))) {
1664 * dir->internal.basebuf gets reused by the traversal,
1665 * but we need fname to remain unchanged to ensure the
1666 * src member of each struct path_pattern correctly
1667 * back-references its source file. Other invocations
1668 * of add_pattern_list provide stable strings, so we
1669 * strbuf_detach() and free() here in the caller.
1671 struct strbuf sb = STRBUF_INIT;
1672 strbuf_addbuf(&sb, &dir->internal.basebuf);
1673 strbuf_addstr(&sb, dir->exclude_per_dir);
1674 pl->src = strbuf_detach(&sb, NULL);
1675 add_patterns(pl->src, pl->src, stk->baselen, pl, istate,
1676 PATTERN_NOFOLLOW,
1677 untracked ? &oid_stat : NULL);
1680 * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1681 * will first be called in valid_cached_dir() then maybe many
1682 * times more in last_matching_pattern(). When the cache is
1683 * used, last_matching_pattern() will not be called and
1684 * reading .gitignore content will be a waste.
1686 * So when it's called by valid_cached_dir() and we can get
1687 * .gitignore SHA-1 from the index (i.e. .gitignore is not
1688 * modified on work tree), we could delay reading the
1689 * .gitignore content until we absolutely need it in
1690 * last_matching_pattern(). Be careful about ignore rule
1691 * order, though, if you do that.
1693 if (untracked &&
1694 !oideq(&oid_stat.oid, &untracked->exclude_oid)) {
1695 invalidate_gitignore(dir->untracked, untracked);
1696 oidcpy(&untracked->exclude_oid, &oid_stat.oid);
1698 dir->internal.exclude_stack = stk;
1699 current = stk->baselen;
1701 strbuf_setlen(&dir->internal.basebuf, baselen);
1705 * Loads the exclude lists for the directory containing pathname, then
1706 * scans all exclude lists to determine whether pathname is excluded.
1707 * Returns the exclude_list element which matched, or NULL for
1708 * undecided.
1710 struct path_pattern *last_matching_pattern(struct dir_struct *dir,
1711 struct index_state *istate,
1712 const char *pathname,
1713 int *dtype_p)
1715 int pathlen = strlen(pathname);
1716 const char *basename = strrchr(pathname, '/');
1717 basename = (basename) ? basename+1 : pathname;
1719 prep_exclude(dir, istate, pathname, basename-pathname);
1721 if (dir->internal.pattern)
1722 return dir->internal.pattern;
1724 return last_matching_pattern_from_lists(dir, istate, pathname, pathlen,
1725 basename, dtype_p);
1729 * Loads the exclude lists for the directory containing pathname, then
1730 * scans all exclude lists to determine whether pathname is excluded.
1731 * Returns 1 if true, otherwise 0.
1733 int is_excluded(struct dir_struct *dir, struct index_state *istate,
1734 const char *pathname, int *dtype_p)
1736 struct path_pattern *pattern =
1737 last_matching_pattern(dir, istate, pathname, dtype_p);
1738 if (pattern)
1739 return pattern->flags & PATTERN_FLAG_NEGATIVE ? 0 : 1;
1740 return 0;
1743 static struct dir_entry *dir_entry_new(const char *pathname, int len)
1745 struct dir_entry *ent;
1747 FLEX_ALLOC_MEM(ent, name, pathname, len);
1748 ent->len = len;
1749 return ent;
1752 static struct dir_entry *dir_add_name(struct dir_struct *dir,
1753 struct index_state *istate,
1754 const char *pathname, int len)
1756 if (index_file_exists(istate, pathname, len, ignore_case))
1757 return NULL;
1759 ALLOC_GROW(dir->entries, dir->nr+1, dir->internal.alloc);
1760 return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
1763 struct dir_entry *dir_add_ignored(struct dir_struct *dir,
1764 struct index_state *istate,
1765 const char *pathname, int len)
1767 if (!index_name_is_other(istate, pathname, len))
1768 return NULL;
1770 ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->internal.ignored_alloc);
1771 return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
1774 enum exist_status {
1775 index_nonexistent = 0,
1776 index_directory,
1777 index_gitdir
1781 * Do not use the alphabetically sorted index to look up
1782 * the directory name; instead, use the case insensitive
1783 * directory hash.
1785 static enum exist_status directory_exists_in_index_icase(struct index_state *istate,
1786 const char *dirname, int len)
1788 struct cache_entry *ce;
1790 if (index_dir_exists(istate, dirname, len))
1791 return index_directory;
1793 ce = index_file_exists(istate, dirname, len, ignore_case);
1794 if (ce && S_ISGITLINK(ce->ce_mode))
1795 return index_gitdir;
1797 return index_nonexistent;
1801 * The index sorts alphabetically by entry name, which
1802 * means that a gitlink sorts as '\0' at the end, while
1803 * a directory (which is defined not as an entry, but as
1804 * the files it contains) will sort with the '/' at the
1805 * end.
1807 static enum exist_status directory_exists_in_index(struct index_state *istate,
1808 const char *dirname, int len)
1810 int pos;
1812 if (ignore_case)
1813 return directory_exists_in_index_icase(istate, dirname, len);
1815 pos = index_name_pos(istate, dirname, len);
1816 if (pos < 0)
1817 pos = -pos-1;
1818 while (pos < istate->cache_nr) {
1819 const struct cache_entry *ce = istate->cache[pos++];
1820 unsigned char endchar;
1822 if (strncmp(ce->name, dirname, len))
1823 break;
1824 endchar = ce->name[len];
1825 if (endchar > '/')
1826 break;
1827 if (endchar == '/')
1828 return index_directory;
1829 if (!endchar && S_ISGITLINK(ce->ce_mode))
1830 return index_gitdir;
1832 return index_nonexistent;
1836 * When we find a directory when traversing the filesystem, we
1837 * have three distinct cases:
1839 * - ignore it
1840 * - see it as a directory
1841 * - recurse into it
1843 * and which one we choose depends on a combination of existing
1844 * git index contents and the flags passed into the directory
1845 * traversal routine.
1847 * Case 1: If we *already* have entries in the index under that
1848 * directory name, we always recurse into the directory to see
1849 * all the files.
1851 * Case 2: If we *already* have that directory name as a gitlink,
1852 * we always continue to see it as a gitlink, regardless of whether
1853 * there is an actual git directory there or not (it might not
1854 * be checked out as a subproject!)
1856 * Case 3: if we didn't have it in the index previously, we
1857 * have a few sub-cases:
1859 * (a) if DIR_SHOW_OTHER_DIRECTORIES flag is set, we show it as
1860 * just a directory, unless DIR_HIDE_EMPTY_DIRECTORIES is
1861 * also true, in which case we need to check if it contains any
1862 * untracked and / or ignored files.
1863 * (b) if it looks like a git directory and we don't have the
1864 * DIR_NO_GITLINKS flag, then we treat it as a gitlink, and
1865 * show it as a directory.
1866 * (c) otherwise, we recurse into it.
1868 static enum path_treatment treat_directory(struct dir_struct *dir,
1869 struct index_state *istate,
1870 struct untracked_cache_dir *untracked,
1871 const char *dirname, int len, int baselen, int excluded,
1872 const struct pathspec *pathspec)
1875 * WARNING: From this function, you can return path_recurse or you
1876 * can call read_directory_recursive() (or neither), but
1877 * you CAN'T DO BOTH.
1879 enum path_treatment state;
1880 int matches_how = 0;
1881 int check_only, stop_early;
1882 int old_ignored_nr, old_untracked_nr;
1883 /* The "len-1" is to strip the final '/' */
1884 enum exist_status status = directory_exists_in_index(istate, dirname, len-1);
1886 if (status == index_directory)
1887 return path_recurse;
1888 if (status == index_gitdir)
1889 return path_none;
1890 if (status != index_nonexistent)
1891 BUG("Unhandled value for directory_exists_in_index: %d\n", status);
1894 * We don't want to descend into paths that don't match the necessary
1895 * patterns. Clearly, if we don't have a pathspec, then we can't check
1896 * for matching patterns. Also, if (excluded) then we know we matched
1897 * the exclusion patterns so as an optimization we can skip checking
1898 * for matching patterns.
1900 if (pathspec && !excluded) {
1901 matches_how = match_pathspec_with_flags(istate, pathspec,
1902 dirname, len,
1903 0 /* prefix */,
1904 NULL /* seen */,
1905 DO_MATCH_LEADING_PATHSPEC);
1906 if (!matches_how)
1907 return path_none;
1911 if ((dir->flags & DIR_SKIP_NESTED_GIT) ||
1912 !(dir->flags & DIR_NO_GITLINKS)) {
1914 * Determine if `dirname` is a nested repo by confirming that:
1915 * 1) we are in a nonbare repository, and
1916 * 2) `dirname` is not an immediate parent of `the_repository->gitdir`,
1917 * which could occur if the git_dir or worktree location was
1918 * manually configured by the user; see t2205 testcases 1-3 for
1919 * examples where this matters
1921 int nested_repo;
1922 struct strbuf sb = STRBUF_INIT;
1923 strbuf_addstr(&sb, dirname);
1924 nested_repo = is_nonbare_repository_dir(&sb);
1926 if (nested_repo) {
1927 char *real_dirname, *real_gitdir;
1928 strbuf_addstr(&sb, ".git");
1929 real_dirname = real_pathdup(sb.buf, 1);
1930 real_gitdir = real_pathdup(the_repository->gitdir, 1);
1932 nested_repo = !!strcmp(real_dirname, real_gitdir);
1933 free(real_gitdir);
1934 free(real_dirname);
1936 strbuf_release(&sb);
1938 if (nested_repo) {
1939 if ((dir->flags & DIR_SKIP_NESTED_GIT) ||
1940 (matches_how == MATCHED_RECURSIVELY_LEADING_PATHSPEC))
1941 return path_none;
1942 return excluded ? path_excluded : path_untracked;
1946 if (!(dir->flags & DIR_SHOW_OTHER_DIRECTORIES)) {
1947 if (excluded &&
1948 (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1949 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING)) {
1952 * This is an excluded directory and we are
1953 * showing ignored paths that match an exclude
1954 * pattern. (e.g. show directory as ignored
1955 * only if it matches an exclude pattern).
1956 * This path will either be 'path_excluded`
1957 * (if we are showing empty directories or if
1958 * the directory is not empty), or will be
1959 * 'path_none' (empty directory, and we are
1960 * not showing empty directories).
1962 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1963 return path_excluded;
1965 if (read_directory_recursive(dir, istate, dirname, len,
1966 untracked, 1, 1, pathspec) == path_excluded)
1967 return path_excluded;
1969 return path_none;
1971 return path_recurse;
1974 assert(dir->flags & DIR_SHOW_OTHER_DIRECTORIES);
1977 * If we have a pathspec which could match something _below_ this
1978 * directory (e.g. when checking 'subdir/' having a pathspec like
1979 * 'subdir/some/deep/path/file' or 'subdir/widget-*.c'), then we
1980 * need to recurse.
1982 if (matches_how == MATCHED_RECURSIVELY_LEADING_PATHSPEC)
1983 return path_recurse;
1985 /* Special cases for where this directory is excluded/ignored */
1986 if (excluded) {
1988 * If DIR_SHOW_OTHER_DIRECTORIES is set and we're not
1989 * hiding empty directories, there is no need to
1990 * recurse into an ignored directory.
1992 if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1993 return path_excluded;
1996 * Even if we are hiding empty directories, we can still avoid
1997 * recursing into ignored directories for DIR_SHOW_IGNORED_TOO
1998 * if DIR_SHOW_IGNORED_TOO_MODE_MATCHING is also set.
2000 if ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2001 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING))
2002 return path_excluded;
2006 * Other than the path_recurse case above, we only need to
2007 * recurse into untracked directories if any of the following
2008 * bits is set:
2009 * - DIR_SHOW_IGNORED (because then we need to determine if
2010 * there are ignored entries below)
2011 * - DIR_SHOW_IGNORED_TOO (same as above)
2012 * - DIR_HIDE_EMPTY_DIRECTORIES (because we have to determine if
2013 * the directory is empty)
2015 if (!excluded &&
2016 !(dir->flags & (DIR_SHOW_IGNORED |
2017 DIR_SHOW_IGNORED_TOO |
2018 DIR_HIDE_EMPTY_DIRECTORIES))) {
2019 return path_untracked;
2023 * Even if we don't want to know all the paths under an untracked or
2024 * ignored directory, we may still need to go into the directory to
2025 * determine if it is empty (because with DIR_HIDE_EMPTY_DIRECTORIES,
2026 * an empty directory should be path_none instead of path_excluded or
2027 * path_untracked).
2029 check_only = ((dir->flags & DIR_HIDE_EMPTY_DIRECTORIES) &&
2030 !(dir->flags & DIR_SHOW_IGNORED_TOO));
2033 * However, there's another optimization possible as a subset of
2034 * check_only, based on the cases we have to consider:
2035 * A) Directory matches no exclude patterns:
2036 * * Directory is empty => path_none
2037 * * Directory has an untracked file under it => path_untracked
2038 * * Directory has only ignored files under it => path_excluded
2039 * B) Directory matches an exclude pattern:
2040 * * Directory is empty => path_none
2041 * * Directory has an untracked file under it => path_excluded
2042 * * Directory has only ignored files under it => path_excluded
2043 * In case A, we can exit as soon as we've found an untracked
2044 * file but otherwise have to walk all files. In case B, though,
2045 * we can stop at the first file we find under the directory.
2047 stop_early = check_only && excluded;
2050 * If /every/ file within an untracked directory is ignored, then
2051 * we want to treat the directory as ignored (for e.g. status
2052 * --porcelain), without listing the individual ignored files
2053 * underneath. To do so, we'll save the current ignored_nr, and
2054 * pop all the ones added after it if it turns out the entire
2055 * directory is ignored. Also, when DIR_SHOW_IGNORED_TOO and
2056 * !DIR_KEEP_UNTRACKED_CONTENTS then we don't want to show
2057 * untracked paths so will need to pop all those off the last
2058 * after we traverse.
2060 old_ignored_nr = dir->ignored_nr;
2061 old_untracked_nr = dir->nr;
2063 /* Actually recurse into dirname now, we'll fixup the state later. */
2064 untracked = lookup_untracked(dir->untracked, untracked,
2065 dirname + baselen, len - baselen);
2066 state = read_directory_recursive(dir, istate, dirname, len, untracked,
2067 check_only, stop_early, pathspec);
2069 /* There are a variety of reasons we may need to fixup the state... */
2070 if (state == path_excluded) {
2071 /* state == path_excluded implies all paths under
2072 * dirname were ignored...
2074 * if running e.g. `git status --porcelain --ignored=matching`,
2075 * then we want to see the subpaths that are ignored.
2077 * if running e.g. just `git status --porcelain`, then
2078 * we just want the directory itself to be listed as ignored
2079 * and not the individual paths underneath.
2081 int want_ignored_subpaths =
2082 ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2083 (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING));
2085 if (want_ignored_subpaths) {
2087 * with --ignored=matching, we want the subpaths
2088 * INSTEAD of the directory itself.
2090 state = path_none;
2091 } else {
2092 int i;
2093 for (i = old_ignored_nr + 1; i<dir->ignored_nr; ++i)
2094 FREE_AND_NULL(dir->ignored[i]);
2095 dir->ignored_nr = old_ignored_nr;
2100 * We may need to ignore some of the untracked paths we found while
2101 * traversing subdirectories.
2103 if ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2104 !(dir->flags & DIR_KEEP_UNTRACKED_CONTENTS)) {
2105 int i;
2106 for (i = old_untracked_nr + 1; i<dir->nr; ++i)
2107 FREE_AND_NULL(dir->entries[i]);
2108 dir->nr = old_untracked_nr;
2112 * If there is nothing under the current directory and we are not
2113 * hiding empty directories, then we need to report on the
2114 * untracked or ignored status of the directory itself.
2116 if (state == path_none && !(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
2117 state = excluded ? path_excluded : path_untracked;
2119 return state;
2123 * This is an inexact early pruning of any recursive directory
2124 * reading - if the path cannot possibly be in the pathspec,
2125 * return true, and we'll skip it early.
2127 static int simplify_away(const char *path, int pathlen,
2128 const struct pathspec *pathspec)
2130 int i;
2132 if (!pathspec || !pathspec->nr)
2133 return 0;
2135 GUARD_PATHSPEC(pathspec,
2136 PATHSPEC_FROMTOP |
2137 PATHSPEC_MAXDEPTH |
2138 PATHSPEC_LITERAL |
2139 PATHSPEC_GLOB |
2140 PATHSPEC_ICASE |
2141 PATHSPEC_EXCLUDE |
2142 PATHSPEC_ATTR);
2144 for (i = 0; i < pathspec->nr; i++) {
2145 const struct pathspec_item *item = &pathspec->items[i];
2146 int len = item->nowildcard_len;
2148 if (len > pathlen)
2149 len = pathlen;
2150 if (!ps_strncmp(item, item->match, path, len))
2151 return 0;
2154 return 1;
2158 * This function tells us whether an excluded path matches a
2159 * list of "interesting" pathspecs. That is, whether a path matched
2160 * by any of the pathspecs could possibly be ignored by excluding
2161 * the specified path. This can happen if:
2163 * 1. the path is mentioned explicitly in the pathspec
2165 * 2. the path is a directory prefix of some element in the
2166 * pathspec
2168 static int exclude_matches_pathspec(const char *path, int pathlen,
2169 const struct pathspec *pathspec)
2171 int i;
2173 if (!pathspec || !pathspec->nr)
2174 return 0;
2176 GUARD_PATHSPEC(pathspec,
2177 PATHSPEC_FROMTOP |
2178 PATHSPEC_MAXDEPTH |
2179 PATHSPEC_LITERAL |
2180 PATHSPEC_GLOB |
2181 PATHSPEC_ICASE |
2182 PATHSPEC_EXCLUDE);
2184 for (i = 0; i < pathspec->nr; i++) {
2185 const struct pathspec_item *item = &pathspec->items[i];
2186 int len = item->nowildcard_len;
2188 if (len == pathlen &&
2189 !ps_strncmp(item, item->match, path, pathlen))
2190 return 1;
2191 if (len > pathlen &&
2192 item->match[pathlen] == '/' &&
2193 !ps_strncmp(item, item->match, path, pathlen))
2194 return 1;
2196 return 0;
2199 static int get_index_dtype(struct index_state *istate,
2200 const char *path, int len)
2202 int pos;
2203 const struct cache_entry *ce;
2205 ce = index_file_exists(istate, path, len, 0);
2206 if (ce) {
2207 if (!ce_uptodate(ce))
2208 return DT_UNKNOWN;
2209 if (S_ISGITLINK(ce->ce_mode))
2210 return DT_DIR;
2212 * Nobody actually cares about the
2213 * difference between DT_LNK and DT_REG
2215 return DT_REG;
2218 /* Try to look it up as a directory */
2219 pos = index_name_pos(istate, path, len);
2220 if (pos >= 0)
2221 return DT_UNKNOWN;
2222 pos = -pos-1;
2223 while (pos < istate->cache_nr) {
2224 ce = istate->cache[pos++];
2225 if (strncmp(ce->name, path, len))
2226 break;
2227 if (ce->name[len] > '/')
2228 break;
2229 if (ce->name[len] < '/')
2230 continue;
2231 if (!ce_uptodate(ce))
2232 break; /* continue? */
2233 return DT_DIR;
2235 return DT_UNKNOWN;
2238 unsigned char get_dtype(struct dirent *e, struct strbuf *path,
2239 int follow_symlink)
2241 struct stat st;
2242 unsigned char dtype = DTYPE(e);
2243 size_t base_path_len;
2245 if (dtype != DT_UNKNOWN && !(follow_symlink && dtype == DT_LNK))
2246 return dtype;
2249 * d_type unknown or unfollowed symlink, try to fall back on [l]stat
2250 * results. If [l]stat fails, explicitly set DT_UNKNOWN.
2252 base_path_len = path->len;
2253 strbuf_addstr(path, e->d_name);
2254 if ((follow_symlink && stat(path->buf, &st)) ||
2255 (!follow_symlink && lstat(path->buf, &st)))
2256 goto cleanup;
2258 /* determine d_type from st_mode */
2259 if (S_ISREG(st.st_mode))
2260 dtype = DT_REG;
2261 else if (S_ISDIR(st.st_mode))
2262 dtype = DT_DIR;
2263 else if (S_ISLNK(st.st_mode))
2264 dtype = DT_LNK;
2266 cleanup:
2267 strbuf_setlen(path, base_path_len);
2268 return dtype;
2271 static int resolve_dtype(int dtype, struct index_state *istate,
2272 const char *path, int len)
2274 struct stat st;
2276 if (dtype != DT_UNKNOWN)
2277 return dtype;
2278 dtype = get_index_dtype(istate, path, len);
2279 if (dtype != DT_UNKNOWN)
2280 return dtype;
2281 if (lstat(path, &st))
2282 return dtype;
2283 if (S_ISREG(st.st_mode))
2284 return DT_REG;
2285 if (S_ISDIR(st.st_mode))
2286 return DT_DIR;
2287 if (S_ISLNK(st.st_mode))
2288 return DT_LNK;
2289 return dtype;
2292 static enum path_treatment treat_path_fast(struct dir_struct *dir,
2293 struct cached_dir *cdir,
2294 struct index_state *istate,
2295 struct strbuf *path,
2296 int baselen,
2297 const struct pathspec *pathspec)
2300 * WARNING: From this function, you can return path_recurse or you
2301 * can call read_directory_recursive() (or neither), but
2302 * you CAN'T DO BOTH.
2304 strbuf_setlen(path, baselen);
2305 if (!cdir->ucd) {
2306 strbuf_addstr(path, cdir->file);
2307 return path_untracked;
2309 strbuf_addstr(path, cdir->ucd->name);
2310 /* treat_one_path() does this before it calls treat_directory() */
2311 strbuf_complete(path, '/');
2312 if (cdir->ucd->check_only)
2314 * check_only is set as a result of treat_directory() getting
2315 * to its bottom. Verify again the same set of directories
2316 * with check_only set.
2318 return read_directory_recursive(dir, istate, path->buf, path->len,
2319 cdir->ucd, 1, 0, pathspec);
2321 * We get path_recurse in the first run when
2322 * directory_exists_in_index() returns index_nonexistent. We
2323 * are sure that new changes in the index does not impact the
2324 * outcome. Return now.
2326 return path_recurse;
2329 static enum path_treatment treat_path(struct dir_struct *dir,
2330 struct untracked_cache_dir *untracked,
2331 struct cached_dir *cdir,
2332 struct index_state *istate,
2333 struct strbuf *path,
2334 int baselen,
2335 const struct pathspec *pathspec)
2337 int has_path_in_index, dtype, excluded;
2339 if (!cdir->d_name)
2340 return treat_path_fast(dir, cdir, istate, path,
2341 baselen, pathspec);
2342 if (is_dot_or_dotdot(cdir->d_name) || !fspathcmp(cdir->d_name, ".git"))
2343 return path_none;
2344 strbuf_setlen(path, baselen);
2345 strbuf_addstr(path, cdir->d_name);
2346 if (simplify_away(path->buf, path->len, pathspec))
2347 return path_none;
2349 dtype = resolve_dtype(cdir->d_type, istate, path->buf, path->len);
2351 /* Always exclude indexed files */
2352 has_path_in_index = !!index_file_exists(istate, path->buf, path->len,
2353 ignore_case);
2354 if (dtype != DT_DIR && has_path_in_index)
2355 return path_none;
2358 * When we are looking at a directory P in the working tree,
2359 * there are three cases:
2361 * (1) P exists in the index. Everything inside the directory P in
2362 * the working tree needs to go when P is checked out from the
2363 * index.
2365 * (2) P does not exist in the index, but there is P/Q in the index.
2366 * We know P will stay a directory when we check out the contents
2367 * of the index, but we do not know yet if there is a directory
2368 * P/Q in the working tree to be killed, so we need to recurse.
2370 * (3) P does not exist in the index, and there is no P/Q in the index
2371 * to require P to be a directory, either. Only in this case, we
2372 * know that everything inside P will not be killed without
2373 * recursing.
2375 if ((dir->flags & DIR_COLLECT_KILLED_ONLY) &&
2376 (dtype == DT_DIR) &&
2377 !has_path_in_index &&
2378 (directory_exists_in_index(istate, path->buf, path->len) == index_nonexistent))
2379 return path_none;
2381 excluded = is_excluded(dir, istate, path->buf, &dtype);
2384 * Excluded? If we don't explicitly want to show
2385 * ignored files, ignore it
2387 if (excluded && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
2388 return path_excluded;
2390 switch (dtype) {
2391 default:
2392 return path_none;
2393 case DT_DIR:
2395 * WARNING: Do not ignore/amend the return value from
2396 * treat_directory(), and especially do not change it to return
2397 * path_recurse as that can cause exponential slowdown.
2398 * Instead, modify treat_directory() to return the right value.
2400 strbuf_addch(path, '/');
2401 return treat_directory(dir, istate, untracked,
2402 path->buf, path->len,
2403 baselen, excluded, pathspec);
2404 case DT_REG:
2405 case DT_LNK:
2406 if (pathspec &&
2407 !match_pathspec(istate, pathspec, path->buf, path->len,
2408 0 /* prefix */, NULL /* seen */,
2409 0 /* is_dir */))
2410 return path_none;
2411 if (excluded)
2412 return path_excluded;
2413 return path_untracked;
2417 static void add_untracked(struct untracked_cache_dir *dir, const char *name)
2419 if (!dir)
2420 return;
2421 ALLOC_GROW(dir->untracked, dir->untracked_nr + 1,
2422 dir->untracked_alloc);
2423 dir->untracked[dir->untracked_nr++] = xstrdup(name);
2426 static int valid_cached_dir(struct dir_struct *dir,
2427 struct untracked_cache_dir *untracked,
2428 struct index_state *istate,
2429 struct strbuf *path,
2430 int check_only)
2432 struct stat st;
2434 if (!untracked)
2435 return 0;
2438 * With fsmonitor, we can trust the untracked cache's valid field.
2440 refresh_fsmonitor(istate);
2441 if (!(dir->untracked->use_fsmonitor && untracked->valid)) {
2442 if (lstat(path->len ? path->buf : ".", &st)) {
2443 memset(&untracked->stat_data, 0, sizeof(untracked->stat_data));
2444 return 0;
2446 if (!untracked->valid ||
2447 match_stat_data_racy(istate, &untracked->stat_data, &st)) {
2448 fill_stat_data(&untracked->stat_data, &st);
2449 return 0;
2453 if (untracked->check_only != !!check_only)
2454 return 0;
2457 * prep_exclude will be called eventually on this directory,
2458 * but it's called much later in last_matching_pattern(). We
2459 * need it now to determine the validity of the cache for this
2460 * path. The next calls will be nearly no-op, the way
2461 * prep_exclude() is designed.
2463 if (path->len && path->buf[path->len - 1] != '/') {
2464 strbuf_addch(path, '/');
2465 prep_exclude(dir, istate, path->buf, path->len);
2466 strbuf_setlen(path, path->len - 1);
2467 } else
2468 prep_exclude(dir, istate, path->buf, path->len);
2470 /* hopefully prep_exclude() haven't invalidated this entry... */
2471 return untracked->valid;
2474 static int open_cached_dir(struct cached_dir *cdir,
2475 struct dir_struct *dir,
2476 struct untracked_cache_dir *untracked,
2477 struct index_state *istate,
2478 struct strbuf *path,
2479 int check_only)
2481 const char *c_path;
2483 memset(cdir, 0, sizeof(*cdir));
2484 cdir->untracked = untracked;
2485 if (valid_cached_dir(dir, untracked, istate, path, check_only))
2486 return 0;
2487 c_path = path->len ? path->buf : ".";
2488 cdir->fdir = opendir(c_path);
2489 if (!cdir->fdir)
2490 warning_errno(_("could not open directory '%s'"), c_path);
2491 if (dir->untracked) {
2492 invalidate_directory(dir->untracked, untracked);
2493 dir->untracked->dir_opened++;
2495 if (!cdir->fdir)
2496 return -1;
2497 return 0;
2500 static int read_cached_dir(struct cached_dir *cdir)
2502 struct dirent *de;
2504 if (cdir->fdir) {
2505 de = readdir_skip_dot_and_dotdot(cdir->fdir);
2506 if (!de) {
2507 cdir->d_name = NULL;
2508 cdir->d_type = DT_UNKNOWN;
2509 return -1;
2511 cdir->d_name = de->d_name;
2512 cdir->d_type = DTYPE(de);
2513 return 0;
2515 while (cdir->nr_dirs < cdir->untracked->dirs_nr) {
2516 struct untracked_cache_dir *d = cdir->untracked->dirs[cdir->nr_dirs];
2517 if (!d->recurse) {
2518 cdir->nr_dirs++;
2519 continue;
2521 cdir->ucd = d;
2522 cdir->nr_dirs++;
2523 return 0;
2525 cdir->ucd = NULL;
2526 if (cdir->nr_files < cdir->untracked->untracked_nr) {
2527 struct untracked_cache_dir *d = cdir->untracked;
2528 cdir->file = d->untracked[cdir->nr_files++];
2529 return 0;
2531 return -1;
2534 static void close_cached_dir(struct cached_dir *cdir)
2536 if (cdir->fdir)
2537 closedir(cdir->fdir);
2539 * We have gone through this directory and found no untracked
2540 * entries. Mark it valid.
2542 if (cdir->untracked) {
2543 cdir->untracked->valid = 1;
2544 cdir->untracked->recurse = 1;
2548 static void add_path_to_appropriate_result_list(struct dir_struct *dir,
2549 struct untracked_cache_dir *untracked,
2550 struct cached_dir *cdir,
2551 struct index_state *istate,
2552 struct strbuf *path,
2553 int baselen,
2554 const struct pathspec *pathspec,
2555 enum path_treatment state)
2557 /* add the path to the appropriate result list */
2558 switch (state) {
2559 case path_excluded:
2560 if (dir->flags & DIR_SHOW_IGNORED)
2561 dir_add_name(dir, istate, path->buf, path->len);
2562 else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
2563 ((dir->flags & DIR_COLLECT_IGNORED) &&
2564 exclude_matches_pathspec(path->buf, path->len,
2565 pathspec)))
2566 dir_add_ignored(dir, istate, path->buf, path->len);
2567 break;
2569 case path_untracked:
2570 if (dir->flags & DIR_SHOW_IGNORED)
2571 break;
2572 dir_add_name(dir, istate, path->buf, path->len);
2573 if (cdir->fdir)
2574 add_untracked(untracked, path->buf + baselen);
2575 break;
2577 default:
2578 break;
2583 * Read a directory tree. We currently ignore anything but
2584 * directories, regular files and symlinks. That's because git
2585 * doesn't handle them at all yet. Maybe that will change some
2586 * day.
2588 * Also, we ignore the name ".git" (even if it is not a directory).
2589 * That likely will not change.
2591 * If 'stop_at_first_file' is specified, 'path_excluded' is returned
2592 * to signal that a file was found. This is the least significant value that
2593 * indicates that a file was encountered that does not depend on the order of
2594 * whether an untracked or excluded path was encountered first.
2596 * Returns the most significant path_treatment value encountered in the scan.
2597 * If 'stop_at_first_file' is specified, `path_excluded` is the most
2598 * significant path_treatment value that will be returned.
2601 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
2602 struct index_state *istate, const char *base, int baselen,
2603 struct untracked_cache_dir *untracked, int check_only,
2604 int stop_at_first_file, const struct pathspec *pathspec)
2607 * WARNING: Do NOT recurse unless path_recurse is returned from
2608 * treat_path(). Recursing on any other return value
2609 * can result in exponential slowdown.
2611 struct cached_dir cdir;
2612 enum path_treatment state, subdir_state, dir_state = path_none;
2613 struct strbuf path = STRBUF_INIT;
2615 strbuf_add(&path, base, baselen);
2617 if (open_cached_dir(&cdir, dir, untracked, istate, &path, check_only))
2618 goto out;
2619 dir->internal.visited_directories++;
2621 if (untracked)
2622 untracked->check_only = !!check_only;
2624 while (!read_cached_dir(&cdir)) {
2625 /* check how the file or directory should be treated */
2626 state = treat_path(dir, untracked, &cdir, istate, &path,
2627 baselen, pathspec);
2628 dir->internal.visited_paths++;
2630 if (state > dir_state)
2631 dir_state = state;
2633 /* recurse into subdir if instructed by treat_path */
2634 if (state == path_recurse) {
2635 struct untracked_cache_dir *ud;
2636 ud = lookup_untracked(dir->untracked,
2637 untracked,
2638 path.buf + baselen,
2639 path.len - baselen);
2640 subdir_state =
2641 read_directory_recursive(dir, istate, path.buf,
2642 path.len, ud,
2643 check_only, stop_at_first_file, pathspec);
2644 if (subdir_state > dir_state)
2645 dir_state = subdir_state;
2647 if (pathspec &&
2648 !match_pathspec(istate, pathspec, path.buf, path.len,
2649 0 /* prefix */, NULL,
2650 0 /* do NOT special case dirs */))
2651 state = path_none;
2654 if (check_only) {
2655 if (stop_at_first_file) {
2657 * If stopping at first file, then
2658 * signal that a file was found by
2659 * returning `path_excluded`. This is
2660 * to return a consistent value
2661 * regardless of whether an ignored or
2662 * excluded file happened to be
2663 * encountered 1st.
2665 * In current usage, the
2666 * `stop_at_first_file` is passed when
2667 * an ancestor directory has matched
2668 * an exclude pattern, so any found
2669 * files will be excluded.
2671 if (dir_state >= path_excluded) {
2672 dir_state = path_excluded;
2673 break;
2677 /* abort early if maximum state has been reached */
2678 if (dir_state == path_untracked) {
2679 if (cdir.fdir)
2680 add_untracked(untracked, path.buf + baselen);
2681 break;
2683 /* skip the add_path_to_appropriate_result_list() */
2684 continue;
2687 add_path_to_appropriate_result_list(dir, untracked, &cdir,
2688 istate, &path, baselen,
2689 pathspec, state);
2691 close_cached_dir(&cdir);
2692 out:
2693 strbuf_release(&path);
2695 return dir_state;
2698 int cmp_dir_entry(const void *p1, const void *p2)
2700 const struct dir_entry *e1 = *(const struct dir_entry **)p1;
2701 const struct dir_entry *e2 = *(const struct dir_entry **)p2;
2703 return name_compare(e1->name, e1->len, e2->name, e2->len);
2706 /* check if *out lexically strictly contains *in */
2707 int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in)
2709 return (out->len < in->len) &&
2710 (out->name[out->len - 1] == '/') &&
2711 !memcmp(out->name, in->name, out->len);
2714 static int treat_leading_path(struct dir_struct *dir,
2715 struct index_state *istate,
2716 const char *path, int len,
2717 const struct pathspec *pathspec)
2719 struct strbuf sb = STRBUF_INIT;
2720 struct strbuf subdir = STRBUF_INIT;
2721 int prevlen, baselen;
2722 const char *cp;
2723 struct cached_dir cdir;
2724 enum path_treatment state = path_none;
2727 * For each directory component of path, we are going to check whether
2728 * that path is relevant given the pathspec. For example, if path is
2729 * foo/bar/baz/
2730 * then we will ask treat_path() whether we should go into foo, then
2731 * whether we should go into bar, then whether baz is relevant.
2732 * Checking each is important because e.g. if path is
2733 * .git/info/
2734 * then we need to check .git to know we shouldn't traverse it.
2735 * If the return from treat_path() is:
2736 * * path_none, for any path, we return false.
2737 * * path_recurse, for all path components, we return true
2738 * * <anything else> for some intermediate component, we make sure
2739 * to add that path to the relevant list but return false
2740 * signifying that we shouldn't recurse into it.
2743 while (len && path[len - 1] == '/')
2744 len--;
2745 if (!len)
2746 return 1;
2748 memset(&cdir, 0, sizeof(cdir));
2749 cdir.d_type = DT_DIR;
2750 baselen = 0;
2751 prevlen = 0;
2752 while (1) {
2753 prevlen = baselen + !!baselen;
2754 cp = path + prevlen;
2755 cp = memchr(cp, '/', path + len - cp);
2756 if (!cp)
2757 baselen = len;
2758 else
2759 baselen = cp - path;
2760 strbuf_reset(&sb);
2761 strbuf_add(&sb, path, baselen);
2762 if (!is_directory(sb.buf))
2763 break;
2764 strbuf_reset(&sb);
2765 strbuf_add(&sb, path, prevlen);
2766 strbuf_reset(&subdir);
2767 strbuf_add(&subdir, path+prevlen, baselen-prevlen);
2768 cdir.d_name = subdir.buf;
2769 state = treat_path(dir, NULL, &cdir, istate, &sb, prevlen, pathspec);
2771 if (state != path_recurse)
2772 break; /* do not recurse into it */
2773 if (len <= baselen)
2774 break; /* finished checking */
2776 add_path_to_appropriate_result_list(dir, NULL, &cdir, istate,
2777 &sb, baselen, pathspec,
2778 state);
2780 strbuf_release(&subdir);
2781 strbuf_release(&sb);
2782 return state == path_recurse;
2785 static const char *get_ident_string(void)
2787 static struct strbuf sb = STRBUF_INIT;
2788 struct utsname uts;
2790 if (sb.len)
2791 return sb.buf;
2792 if (uname(&uts) < 0)
2793 die_errno(_("failed to get kernel name and information"));
2794 strbuf_addf(&sb, "Location %s, system %s", get_git_work_tree(),
2795 uts.sysname);
2796 return sb.buf;
2799 static int ident_in_untracked(const struct untracked_cache *uc)
2802 * Previous git versions may have saved many NUL separated
2803 * strings in the "ident" field, but it is insane to manage
2804 * many locations, so just take care of the first one.
2807 return !strcmp(uc->ident.buf, get_ident_string());
2810 static void set_untracked_ident(struct untracked_cache *uc)
2812 strbuf_reset(&uc->ident);
2813 strbuf_addstr(&uc->ident, get_ident_string());
2816 * This strbuf used to contain a list of NUL separated
2817 * strings, so save NUL too for backward compatibility.
2819 strbuf_addch(&uc->ident, 0);
2822 static unsigned new_untracked_cache_flags(struct index_state *istate)
2824 struct repository *repo = istate->repo;
2825 char *val;
2828 * This logic is coordinated with the setting of these flags in
2829 * wt-status.c#wt_status_collect_untracked(), and the evaluation
2830 * of the config setting in commit.c#git_status_config()
2832 if (!repo_config_get_string(repo, "status.showuntrackedfiles", &val) &&
2833 !strcmp(val, "all"))
2834 return 0;
2837 * The default, if "all" is not set, is "normal" - leading us here.
2838 * If the value is "none" then it really doesn't matter.
2840 return DIR_SHOW_OTHER_DIRECTORIES | DIR_HIDE_EMPTY_DIRECTORIES;
2843 static void new_untracked_cache(struct index_state *istate, int flags)
2845 struct untracked_cache *uc = xcalloc(1, sizeof(*uc));
2846 strbuf_init(&uc->ident, 100);
2847 uc->exclude_per_dir = ".gitignore";
2848 uc->dir_flags = flags >= 0 ? flags : new_untracked_cache_flags(istate);
2849 set_untracked_ident(uc);
2850 istate->untracked = uc;
2851 istate->cache_changed |= UNTRACKED_CHANGED;
2854 void add_untracked_cache(struct index_state *istate)
2856 if (!istate->untracked) {
2857 new_untracked_cache(istate, -1);
2858 } else {
2859 if (!ident_in_untracked(istate->untracked)) {
2860 free_untracked_cache(istate->untracked);
2861 new_untracked_cache(istate, -1);
2866 void remove_untracked_cache(struct index_state *istate)
2868 if (istate->untracked) {
2869 free_untracked_cache(istate->untracked);
2870 istate->untracked = NULL;
2871 istate->cache_changed |= UNTRACKED_CHANGED;
2875 static struct untracked_cache_dir *validate_untracked_cache(struct dir_struct *dir,
2876 int base_len,
2877 const struct pathspec *pathspec,
2878 struct index_state *istate)
2880 struct untracked_cache_dir *root;
2881 static int untracked_cache_disabled = -1;
2883 if (!dir->untracked)
2884 return NULL;
2885 if (untracked_cache_disabled < 0)
2886 untracked_cache_disabled = git_env_bool("GIT_DISABLE_UNTRACKED_CACHE", 0);
2887 if (untracked_cache_disabled)
2888 return NULL;
2891 * We only support $GIT_DIR/info/exclude and core.excludesfile
2892 * as the global ignore rule files. Any other additions
2893 * (e.g. from command line) invalidate the cache. This
2894 * condition also catches running setup_standard_excludes()
2895 * before setting dir->untracked!
2897 if (dir->internal.unmanaged_exclude_files)
2898 return NULL;
2901 * Optimize for the main use case only: whole-tree git
2902 * status. More work involved in treat_leading_path() if we
2903 * use cache on just a subset of the worktree. pathspec
2904 * support could make the matter even worse.
2906 if (base_len || (pathspec && pathspec->nr))
2907 return NULL;
2909 /* We don't support collecting ignore files */
2910 if (dir->flags & (DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO |
2911 DIR_COLLECT_IGNORED))
2912 return NULL;
2915 * If we use .gitignore in the cache and now you change it to
2916 * .gitexclude, everything will go wrong.
2918 if (dir->exclude_per_dir != dir->untracked->exclude_per_dir &&
2919 strcmp(dir->exclude_per_dir, dir->untracked->exclude_per_dir))
2920 return NULL;
2923 * EXC_CMDL is not considered in the cache. If people set it,
2924 * skip the cache.
2926 if (dir->internal.exclude_list_group[EXC_CMDL].nr)
2927 return NULL;
2929 if (!ident_in_untracked(dir->untracked)) {
2930 warning(_("untracked cache is disabled on this system or location"));
2931 return NULL;
2935 * If the untracked structure we received does not have the same flags
2936 * as requested in this run, we're going to need to either discard the
2937 * existing structure (and potentially later recreate), or bypass the
2938 * untracked cache mechanism for this run.
2940 if (dir->flags != dir->untracked->dir_flags) {
2942 * If the untracked structure we received does not have the same flags
2943 * as configured, then we need to reset / create a new "untracked"
2944 * structure to match the new config.
2946 * Keeping the saved and used untracked cache consistent with the
2947 * configuration provides an opportunity for frequent users of
2948 * "git status -uall" to leverage the untracked cache by aligning their
2949 * configuration - setting "status.showuntrackedfiles" to "all" or
2950 * "normal" as appropriate.
2952 * Previously using -uall (or setting "status.showuntrackedfiles" to
2953 * "all") was incompatible with untracked cache and *consistently*
2954 * caused surprisingly bad performance (with fscache and fsmonitor
2955 * enabled) on Windows.
2957 * IMPROVEMENT OPPORTUNITY: If we reworked the untracked cache storage
2958 * to not be as bound up with the desired output in a given run,
2959 * and instead iterated through and stored enough information to
2960 * correctly serve both "modes", then users could get peak performance
2961 * with or without '-uall' regardless of their
2962 * "status.showuntrackedfiles" config.
2964 if (dir->untracked->dir_flags != new_untracked_cache_flags(istate)) {
2965 free_untracked_cache(istate->untracked);
2966 new_untracked_cache(istate, dir->flags);
2967 dir->untracked = istate->untracked;
2969 else {
2971 * Current untracked cache data is consistent with config, but not
2972 * usable in this request/run; just bypass untracked cache.
2974 return NULL;
2978 if (!dir->untracked->root) {
2979 /* Untracked cache existed but is not initialized; fix that */
2980 FLEX_ALLOC_STR(dir->untracked->root, name, "");
2981 istate->cache_changed |= UNTRACKED_CHANGED;
2984 /* Validate $GIT_DIR/info/exclude and core.excludesfile */
2985 root = dir->untracked->root;
2986 if (!oideq(&dir->internal.ss_info_exclude.oid,
2987 &dir->untracked->ss_info_exclude.oid)) {
2988 invalidate_gitignore(dir->untracked, root);
2989 dir->untracked->ss_info_exclude = dir->internal.ss_info_exclude;
2991 if (!oideq(&dir->internal.ss_excludes_file.oid,
2992 &dir->untracked->ss_excludes_file.oid)) {
2993 invalidate_gitignore(dir->untracked, root);
2994 dir->untracked->ss_excludes_file = dir->internal.ss_excludes_file;
2997 /* Make sure this directory is not dropped out at saving phase */
2998 root->recurse = 1;
2999 return root;
3002 static void emit_traversal_statistics(struct dir_struct *dir,
3003 struct repository *repo,
3004 const char *path,
3005 int path_len)
3007 if (!trace2_is_enabled())
3008 return;
3010 if (!path_len) {
3011 trace2_data_string("read_directory", repo, "path", "");
3012 } else {
3013 struct strbuf tmp = STRBUF_INIT;
3014 strbuf_add(&tmp, path, path_len);
3015 trace2_data_string("read_directory", repo, "path", tmp.buf);
3016 strbuf_release(&tmp);
3019 trace2_data_intmax("read_directory", repo,
3020 "directories-visited", dir->internal.visited_directories);
3021 trace2_data_intmax("read_directory", repo,
3022 "paths-visited", dir->internal.visited_paths);
3024 if (!dir->untracked)
3025 return;
3026 trace2_data_intmax("read_directory", repo,
3027 "node-creation", dir->untracked->dir_created);
3028 trace2_data_intmax("read_directory", repo,
3029 "gitignore-invalidation",
3030 dir->untracked->gitignore_invalidated);
3031 trace2_data_intmax("read_directory", repo,
3032 "directory-invalidation",
3033 dir->untracked->dir_invalidated);
3034 trace2_data_intmax("read_directory", repo,
3035 "opendir", dir->untracked->dir_opened);
3038 int read_directory(struct dir_struct *dir, struct index_state *istate,
3039 const char *path, int len, const struct pathspec *pathspec)
3041 struct untracked_cache_dir *untracked;
3043 trace2_region_enter("dir", "read_directory", istate->repo);
3044 dir->internal.visited_paths = 0;
3045 dir->internal.visited_directories = 0;
3047 if (has_symlink_leading_path(path, len)) {
3048 trace2_region_leave("dir", "read_directory", istate->repo);
3049 return dir->nr;
3052 untracked = validate_untracked_cache(dir, len, pathspec, istate);
3053 if (!untracked)
3055 * make sure untracked cache code path is disabled,
3056 * e.g. prep_exclude()
3058 dir->untracked = NULL;
3059 if (!len || treat_leading_path(dir, istate, path, len, pathspec))
3060 read_directory_recursive(dir, istate, path, len, untracked, 0, 0, pathspec);
3061 QSORT(dir->entries, dir->nr, cmp_dir_entry);
3062 QSORT(dir->ignored, dir->ignored_nr, cmp_dir_entry);
3064 emit_traversal_statistics(dir, istate->repo, path, len);
3066 trace2_region_leave("dir", "read_directory", istate->repo);
3067 if (dir->untracked) {
3068 static int force_untracked_cache = -1;
3070 if (force_untracked_cache < 0)
3071 force_untracked_cache =
3072 git_env_bool("GIT_FORCE_UNTRACKED_CACHE", -1);
3073 if (force_untracked_cache < 0)
3074 force_untracked_cache = (istate->repo->settings.core_untracked_cache == UNTRACKED_CACHE_WRITE);
3075 if (force_untracked_cache &&
3076 dir->untracked == istate->untracked &&
3077 (dir->untracked->dir_opened ||
3078 dir->untracked->gitignore_invalidated ||
3079 dir->untracked->dir_invalidated))
3080 istate->cache_changed |= UNTRACKED_CHANGED;
3081 if (dir->untracked != istate->untracked) {
3082 FREE_AND_NULL(dir->untracked);
3086 return dir->nr;
3089 int file_exists(const char *f)
3091 struct stat sb;
3092 return lstat(f, &sb) == 0;
3095 int repo_file_exists(struct repository *repo, const char *path)
3097 if (repo != the_repository)
3098 BUG("do not know how to check file existence in arbitrary repo");
3100 return file_exists(path);
3103 static int cmp_icase(char a, char b)
3105 if (a == b)
3106 return 0;
3107 if (ignore_case)
3108 return toupper(a) - toupper(b);
3109 return a - b;
3113 * Given two normalized paths (a trailing slash is ok), if subdir is
3114 * outside dir, return -1. Otherwise return the offset in subdir that
3115 * can be used as relative path to dir.
3117 int dir_inside_of(const char *subdir, const char *dir)
3119 int offset = 0;
3121 assert(dir && subdir && *dir && *subdir);
3123 while (*dir && *subdir && !cmp_icase(*dir, *subdir)) {
3124 dir++;
3125 subdir++;
3126 offset++;
3129 /* hel[p]/me vs hel[l]/yeah */
3130 if (*dir && *subdir)
3131 return -1;
3133 if (!*subdir)
3134 return !*dir ? offset : -1; /* same dir */
3136 /* foo/[b]ar vs foo/[] */
3137 if (is_dir_sep(dir[-1]))
3138 return is_dir_sep(subdir[-1]) ? offset : -1;
3140 /* foo[/]bar vs foo[] */
3141 return is_dir_sep(*subdir) ? offset + 1 : -1;
3144 int is_inside_dir(const char *dir)
3146 char *cwd;
3147 int rc;
3149 if (!dir)
3150 return 0;
3152 cwd = xgetcwd();
3153 rc = (dir_inside_of(cwd, dir) >= 0);
3154 free(cwd);
3155 return rc;
3158 int is_empty_dir(const char *path)
3160 DIR *dir = opendir(path);
3161 struct dirent *e;
3162 int ret = 1;
3164 if (!dir)
3165 return 0;
3167 e = readdir_skip_dot_and_dotdot(dir);
3168 if (e)
3169 ret = 0;
3171 closedir(dir);
3172 return ret;
3175 char *git_url_basename(const char *repo, int is_bundle, int is_bare)
3177 const char *end = repo + strlen(repo), *start, *ptr;
3178 size_t len;
3179 char *dir;
3182 * Skip scheme.
3184 start = strstr(repo, "://");
3185 if (!start)
3186 start = repo;
3187 else
3188 start += 3;
3191 * Skip authentication data. The stripping does happen
3192 * greedily, such that we strip up to the last '@' inside
3193 * the host part.
3195 for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
3196 if (*ptr == '@')
3197 start = ptr + 1;
3201 * Strip trailing spaces, slashes and /.git
3203 while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
3204 end--;
3205 if (end - start > 5 && is_dir_sep(end[-5]) &&
3206 !strncmp(end - 4, ".git", 4)) {
3207 end -= 5;
3208 while (start < end && is_dir_sep(end[-1]))
3209 end--;
3213 * It should not be possible to overflow `ptrdiff_t` by passing in an
3214 * insanely long URL, but GCC does not know that and will complain
3215 * without this check.
3217 if (end - start < 0)
3218 die(_("No directory name could be guessed.\n"
3219 "Please specify a directory on the command line"));
3222 * Strip trailing port number if we've got only a
3223 * hostname (that is, there is no dir separator but a
3224 * colon). This check is required such that we do not
3225 * strip URI's like '/foo/bar:2222.git', which should
3226 * result in a dir '2222' being guessed due to backwards
3227 * compatibility.
3229 if (memchr(start, '/', end - start) == NULL
3230 && memchr(start, ':', end - start) != NULL) {
3231 ptr = end;
3232 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
3233 ptr--;
3234 if (start < ptr && ptr[-1] == ':')
3235 end = ptr - 1;
3239 * Find last component. To remain backwards compatible we
3240 * also regard colons as path separators, such that
3241 * cloning a repository 'foo:bar.git' would result in a
3242 * directory 'bar' being guessed.
3244 ptr = end;
3245 while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
3246 ptr--;
3247 start = ptr;
3250 * Strip .{bundle,git}.
3252 len = end - start;
3253 strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
3255 if (!len || (len == 1 && *start == '/'))
3256 die(_("No directory name could be guessed.\n"
3257 "Please specify a directory on the command line"));
3259 if (is_bare)
3260 dir = xstrfmt("%.*s.git", (int)len, start);
3261 else
3262 dir = xstrndup(start, len);
3264 * Replace sequences of 'control' characters and whitespace
3265 * with one ascii space, remove leading and trailing spaces.
3267 if (*dir) {
3268 char *out = dir;
3269 int prev_space = 1 /* strip leading whitespace */;
3270 for (end = dir; *end; ++end) {
3271 char ch = *end;
3272 if ((unsigned char)ch < '\x20')
3273 ch = '\x20';
3274 if (isspace(ch)) {
3275 if (prev_space)
3276 continue;
3277 prev_space = 1;
3278 } else
3279 prev_space = 0;
3280 *out++ = ch;
3282 *out = '\0';
3283 if (out > dir && prev_space)
3284 out[-1] = '\0';
3286 return dir;
3289 void strip_dir_trailing_slashes(char *dir)
3291 char *end = dir + strlen(dir);
3293 while (dir < end - 1 && is_dir_sep(end[-1]))
3294 end--;
3295 *end = '\0';
3298 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
3300 DIR *dir;
3301 struct dirent *e;
3302 int ret = 0, original_len = path->len, len, kept_down = 0;
3303 int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
3304 int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
3305 int purge_original_cwd = (flag & REMOVE_DIR_PURGE_ORIGINAL_CWD);
3306 struct object_id submodule_head;
3308 if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
3309 !resolve_gitlink_ref(path->buf, "HEAD", &submodule_head)) {
3310 /* Do not descend and nuke a nested git work tree. */
3311 if (kept_up)
3312 *kept_up = 1;
3313 return 0;
3316 flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
3317 dir = opendir(path->buf);
3318 if (!dir) {
3319 if (errno == ENOENT)
3320 return keep_toplevel ? -1 : 0;
3321 else if (errno == EACCES && !keep_toplevel)
3323 * An empty dir could be removable even if it
3324 * is unreadable:
3326 return rmdir(path->buf);
3327 else
3328 return -1;
3330 strbuf_complete(path, '/');
3332 len = path->len;
3333 while ((e = readdir_skip_dot_and_dotdot(dir)) != NULL) {
3334 struct stat st;
3336 strbuf_setlen(path, len);
3337 strbuf_addstr(path, e->d_name);
3338 if (lstat(path->buf, &st)) {
3339 if (errno == ENOENT)
3341 * file disappeared, which is what we
3342 * wanted anyway
3344 continue;
3345 /* fall through */
3346 } else if (S_ISDIR(st.st_mode)) {
3347 if (!remove_dir_recurse(path, flag, &kept_down))
3348 continue; /* happy */
3349 } else if (!only_empty &&
3350 (!unlink(path->buf) || errno == ENOENT)) {
3351 continue; /* happy, too */
3354 /* path too long, stat fails, or non-directory still exists */
3355 ret = -1;
3356 break;
3358 closedir(dir);
3360 strbuf_setlen(path, original_len);
3361 if (!ret && !keep_toplevel && !kept_down) {
3362 if (!purge_original_cwd &&
3363 startup_info->original_cwd &&
3364 !strcmp(startup_info->original_cwd, path->buf))
3365 ret = -1; /* Do not remove current working directory */
3366 else
3367 ret = (!rmdir(path->buf) || errno == ENOENT) ? 0 : -1;
3368 } else if (kept_up)
3370 * report the uplevel that it is not an error that we
3371 * did not rmdir() our directory.
3373 *kept_up = !ret;
3374 return ret;
3377 int remove_dir_recursively(struct strbuf *path, int flag)
3379 return remove_dir_recurse(path, flag, NULL);
3382 static GIT_PATH_FUNC(git_path_info_exclude, "info/exclude")
3384 void setup_standard_excludes(struct dir_struct *dir)
3386 dir->exclude_per_dir = ".gitignore";
3388 /* core.excludesfile defaulting to $XDG_CONFIG_HOME/git/ignore */
3389 if (!excludes_file)
3390 excludes_file = xdg_config_home("ignore");
3391 if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
3392 add_patterns_from_file_1(dir, excludes_file,
3393 dir->untracked ? &dir->internal.ss_excludes_file : NULL);
3395 /* per repository user preference */
3396 if (startup_info->have_repository) {
3397 const char *path = git_path_info_exclude();
3398 if (!access_or_warn(path, R_OK, 0))
3399 add_patterns_from_file_1(dir, path,
3400 dir->untracked ? &dir->internal.ss_info_exclude : NULL);
3404 char *get_sparse_checkout_filename(void)
3406 return git_pathdup("info/sparse-checkout");
3409 int get_sparse_checkout_patterns(struct pattern_list *pl)
3411 int res;
3412 char *sparse_filename = get_sparse_checkout_filename();
3414 pl->use_cone_patterns = core_sparse_checkout_cone;
3415 res = add_patterns_from_file_to_list(sparse_filename, "", 0, pl, NULL, 0);
3417 free(sparse_filename);
3418 return res;
3421 int remove_path(const char *name)
3423 char *slash;
3425 if (unlink(name) && !is_missing_file_error(errno))
3426 return -1;
3428 slash = strrchr(name, '/');
3429 if (slash) {
3430 char *dirs = xstrdup(name);
3431 slash = dirs + (slash - name);
3432 do {
3433 *slash = '\0';
3434 if (startup_info->original_cwd &&
3435 !strcmp(startup_info->original_cwd, dirs))
3436 break;
3437 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
3438 free(dirs);
3440 return 0;
3444 * Frees memory within dir which was allocated, and resets fields for further
3445 * use. Does not free dir itself.
3447 void dir_clear(struct dir_struct *dir)
3449 int i, j;
3450 struct exclude_list_group *group;
3451 struct pattern_list *pl;
3452 struct exclude_stack *stk;
3453 struct dir_struct new = DIR_INIT;
3455 for (i = EXC_CMDL; i <= EXC_FILE; i++) {
3456 group = &dir->internal.exclude_list_group[i];
3457 for (j = 0; j < group->nr; j++) {
3458 pl = &group->pl[j];
3459 if (i == EXC_DIRS)
3460 free((char *)pl->src);
3461 clear_pattern_list(pl);
3463 free(group->pl);
3466 for (i = 0; i < dir->ignored_nr; i++)
3467 free(dir->ignored[i]);
3468 for (i = 0; i < dir->nr; i++)
3469 free(dir->entries[i]);
3470 free(dir->ignored);
3471 free(dir->entries);
3473 stk = dir->internal.exclude_stack;
3474 while (stk) {
3475 struct exclude_stack *prev = stk->prev;
3476 free(stk);
3477 stk = prev;
3479 strbuf_release(&dir->internal.basebuf);
3481 memcpy(dir, &new, sizeof(*dir));
3484 struct ondisk_untracked_cache {
3485 struct stat_data info_exclude_stat;
3486 struct stat_data excludes_file_stat;
3487 uint32_t dir_flags;
3490 #define ouc_offset(x) offsetof(struct ondisk_untracked_cache, x)
3492 struct write_data {
3493 int index; /* number of written untracked_cache_dir */
3494 struct ewah_bitmap *check_only; /* from untracked_cache_dir */
3495 struct ewah_bitmap *valid; /* from untracked_cache_dir */
3496 struct ewah_bitmap *sha1_valid; /* set if exclude_sha1 is not null */
3497 struct strbuf out;
3498 struct strbuf sb_stat;
3499 struct strbuf sb_sha1;
3502 static void stat_data_to_disk(struct stat_data *to, const struct stat_data *from)
3504 to->sd_ctime.sec = htonl(from->sd_ctime.sec);
3505 to->sd_ctime.nsec = htonl(from->sd_ctime.nsec);
3506 to->sd_mtime.sec = htonl(from->sd_mtime.sec);
3507 to->sd_mtime.nsec = htonl(from->sd_mtime.nsec);
3508 to->sd_dev = htonl(from->sd_dev);
3509 to->sd_ino = htonl(from->sd_ino);
3510 to->sd_uid = htonl(from->sd_uid);
3511 to->sd_gid = htonl(from->sd_gid);
3512 to->sd_size = htonl(from->sd_size);
3515 static void write_one_dir(struct untracked_cache_dir *untracked,
3516 struct write_data *wd)
3518 struct stat_data stat_data;
3519 struct strbuf *out = &wd->out;
3520 unsigned char intbuf[16];
3521 unsigned int intlen, value;
3522 int i = wd->index++;
3525 * untracked_nr should be reset whenever valid is clear, but
3526 * for safety..
3528 if (!untracked->valid) {
3529 untracked->untracked_nr = 0;
3530 untracked->check_only = 0;
3533 if (untracked->check_only)
3534 ewah_set(wd->check_only, i);
3535 if (untracked->valid) {
3536 ewah_set(wd->valid, i);
3537 stat_data_to_disk(&stat_data, &untracked->stat_data);
3538 strbuf_add(&wd->sb_stat, &stat_data, sizeof(stat_data));
3540 if (!is_null_oid(&untracked->exclude_oid)) {
3541 ewah_set(wd->sha1_valid, i);
3542 strbuf_add(&wd->sb_sha1, untracked->exclude_oid.hash,
3543 the_hash_algo->rawsz);
3546 intlen = encode_varint(untracked->untracked_nr, intbuf);
3547 strbuf_add(out, intbuf, intlen);
3549 /* skip non-recurse directories */
3550 for (i = 0, value = 0; i < untracked->dirs_nr; i++)
3551 if (untracked->dirs[i]->recurse)
3552 value++;
3553 intlen = encode_varint(value, intbuf);
3554 strbuf_add(out, intbuf, intlen);
3556 strbuf_add(out, untracked->name, strlen(untracked->name) + 1);
3558 for (i = 0; i < untracked->untracked_nr; i++)
3559 strbuf_add(out, untracked->untracked[i],
3560 strlen(untracked->untracked[i]) + 1);
3562 for (i = 0; i < untracked->dirs_nr; i++)
3563 if (untracked->dirs[i]->recurse)
3564 write_one_dir(untracked->dirs[i], wd);
3567 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked)
3569 struct ondisk_untracked_cache *ouc;
3570 struct write_data wd;
3571 unsigned char varbuf[16];
3572 int varint_len;
3573 const unsigned hashsz = the_hash_algo->rawsz;
3575 CALLOC_ARRAY(ouc, 1);
3576 stat_data_to_disk(&ouc->info_exclude_stat, &untracked->ss_info_exclude.stat);
3577 stat_data_to_disk(&ouc->excludes_file_stat, &untracked->ss_excludes_file.stat);
3578 ouc->dir_flags = htonl(untracked->dir_flags);
3580 varint_len = encode_varint(untracked->ident.len, varbuf);
3581 strbuf_add(out, varbuf, varint_len);
3582 strbuf_addbuf(out, &untracked->ident);
3584 strbuf_add(out, ouc, sizeof(*ouc));
3585 strbuf_add(out, untracked->ss_info_exclude.oid.hash, hashsz);
3586 strbuf_add(out, untracked->ss_excludes_file.oid.hash, hashsz);
3587 strbuf_add(out, untracked->exclude_per_dir, strlen(untracked->exclude_per_dir) + 1);
3588 FREE_AND_NULL(ouc);
3590 if (!untracked->root) {
3591 varint_len = encode_varint(0, varbuf);
3592 strbuf_add(out, varbuf, varint_len);
3593 return;
3596 wd.index = 0;
3597 wd.check_only = ewah_new();
3598 wd.valid = ewah_new();
3599 wd.sha1_valid = ewah_new();
3600 strbuf_init(&wd.out, 1024);
3601 strbuf_init(&wd.sb_stat, 1024);
3602 strbuf_init(&wd.sb_sha1, 1024);
3603 write_one_dir(untracked->root, &wd);
3605 varint_len = encode_varint(wd.index, varbuf);
3606 strbuf_add(out, varbuf, varint_len);
3607 strbuf_addbuf(out, &wd.out);
3608 ewah_serialize_strbuf(wd.valid, out);
3609 ewah_serialize_strbuf(wd.check_only, out);
3610 ewah_serialize_strbuf(wd.sha1_valid, out);
3611 strbuf_addbuf(out, &wd.sb_stat);
3612 strbuf_addbuf(out, &wd.sb_sha1);
3613 strbuf_addch(out, '\0'); /* safe guard for string lists */
3615 ewah_free(wd.valid);
3616 ewah_free(wd.check_only);
3617 ewah_free(wd.sha1_valid);
3618 strbuf_release(&wd.out);
3619 strbuf_release(&wd.sb_stat);
3620 strbuf_release(&wd.sb_sha1);
3623 static void free_untracked(struct untracked_cache_dir *ucd)
3625 int i;
3626 if (!ucd)
3627 return;
3628 for (i = 0; i < ucd->dirs_nr; i++)
3629 free_untracked(ucd->dirs[i]);
3630 for (i = 0; i < ucd->untracked_nr; i++)
3631 free(ucd->untracked[i]);
3632 free(ucd->untracked);
3633 free(ucd->dirs);
3634 free(ucd);
3637 void free_untracked_cache(struct untracked_cache *uc)
3639 if (!uc)
3640 return;
3642 free(uc->exclude_per_dir_to_free);
3643 strbuf_release(&uc->ident);
3644 free_untracked(uc->root);
3645 free(uc);
3648 struct read_data {
3649 int index;
3650 struct untracked_cache_dir **ucd;
3651 struct ewah_bitmap *check_only;
3652 struct ewah_bitmap *valid;
3653 struct ewah_bitmap *sha1_valid;
3654 const unsigned char *data;
3655 const unsigned char *end;
3658 static void stat_data_from_disk(struct stat_data *to, const unsigned char *data)
3660 memcpy(to, data, sizeof(*to));
3661 to->sd_ctime.sec = ntohl(to->sd_ctime.sec);
3662 to->sd_ctime.nsec = ntohl(to->sd_ctime.nsec);
3663 to->sd_mtime.sec = ntohl(to->sd_mtime.sec);
3664 to->sd_mtime.nsec = ntohl(to->sd_mtime.nsec);
3665 to->sd_dev = ntohl(to->sd_dev);
3666 to->sd_ino = ntohl(to->sd_ino);
3667 to->sd_uid = ntohl(to->sd_uid);
3668 to->sd_gid = ntohl(to->sd_gid);
3669 to->sd_size = ntohl(to->sd_size);
3672 static int read_one_dir(struct untracked_cache_dir **untracked_,
3673 struct read_data *rd)
3675 struct untracked_cache_dir ud, *untracked;
3676 const unsigned char *data = rd->data, *end = rd->end;
3677 const unsigned char *eos;
3678 unsigned int value;
3679 int i;
3681 memset(&ud, 0, sizeof(ud));
3683 value = decode_varint(&data);
3684 if (data > end)
3685 return -1;
3686 ud.recurse = 1;
3687 ud.untracked_alloc = value;
3688 ud.untracked_nr = value;
3689 if (ud.untracked_nr)
3690 ALLOC_ARRAY(ud.untracked, ud.untracked_nr);
3692 ud.dirs_alloc = ud.dirs_nr = decode_varint(&data);
3693 if (data > end)
3694 return -1;
3695 ALLOC_ARRAY(ud.dirs, ud.dirs_nr);
3697 eos = memchr(data, '\0', end - data);
3698 if (!eos || eos == end)
3699 return -1;
3701 *untracked_ = untracked = xmalloc(st_add3(sizeof(*untracked), eos - data, 1));
3702 memcpy(untracked, &ud, sizeof(ud));
3703 memcpy(untracked->name, data, eos - data + 1);
3704 data = eos + 1;
3706 for (i = 0; i < untracked->untracked_nr; i++) {
3707 eos = memchr(data, '\0', end - data);
3708 if (!eos || eos == end)
3709 return -1;
3710 untracked->untracked[i] = xmemdupz(data, eos - data);
3711 data = eos + 1;
3714 rd->ucd[rd->index++] = untracked;
3715 rd->data = data;
3717 for (i = 0; i < untracked->dirs_nr; i++) {
3718 if (read_one_dir(untracked->dirs + i, rd) < 0)
3719 return -1;
3721 return 0;
3724 static void set_check_only(size_t pos, void *cb)
3726 struct read_data *rd = cb;
3727 struct untracked_cache_dir *ud = rd->ucd[pos];
3728 ud->check_only = 1;
3731 static void read_stat(size_t pos, void *cb)
3733 struct read_data *rd = cb;
3734 struct untracked_cache_dir *ud = rd->ucd[pos];
3735 if (rd->data + sizeof(struct stat_data) > rd->end) {
3736 rd->data = rd->end + 1;
3737 return;
3739 stat_data_from_disk(&ud->stat_data, rd->data);
3740 rd->data += sizeof(struct stat_data);
3741 ud->valid = 1;
3744 static void read_oid(size_t pos, void *cb)
3746 struct read_data *rd = cb;
3747 struct untracked_cache_dir *ud = rd->ucd[pos];
3748 if (rd->data + the_hash_algo->rawsz > rd->end) {
3749 rd->data = rd->end + 1;
3750 return;
3752 oidread(&ud->exclude_oid, rd->data);
3753 rd->data += the_hash_algo->rawsz;
3756 static void load_oid_stat(struct oid_stat *oid_stat, const unsigned char *data,
3757 const unsigned char *sha1)
3759 stat_data_from_disk(&oid_stat->stat, data);
3760 oidread(&oid_stat->oid, sha1);
3761 oid_stat->valid = 1;
3764 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz)
3766 struct untracked_cache *uc;
3767 struct read_data rd;
3768 const unsigned char *next = data, *end = (const unsigned char *)data + sz;
3769 const char *ident;
3770 int ident_len;
3771 ssize_t len;
3772 const char *exclude_per_dir;
3773 const unsigned hashsz = the_hash_algo->rawsz;
3774 const unsigned offset = sizeof(struct ondisk_untracked_cache);
3775 const unsigned exclude_per_dir_offset = offset + 2 * hashsz;
3777 if (sz <= 1 || end[-1] != '\0')
3778 return NULL;
3779 end--;
3781 ident_len = decode_varint(&next);
3782 if (next + ident_len > end)
3783 return NULL;
3784 ident = (const char *)next;
3785 next += ident_len;
3787 if (next + exclude_per_dir_offset + 1 > end)
3788 return NULL;
3790 CALLOC_ARRAY(uc, 1);
3791 strbuf_init(&uc->ident, ident_len);
3792 strbuf_add(&uc->ident, ident, ident_len);
3793 load_oid_stat(&uc->ss_info_exclude,
3794 next + ouc_offset(info_exclude_stat),
3795 next + offset);
3796 load_oid_stat(&uc->ss_excludes_file,
3797 next + ouc_offset(excludes_file_stat),
3798 next + offset + hashsz);
3799 uc->dir_flags = get_be32(next + ouc_offset(dir_flags));
3800 exclude_per_dir = (const char *)next + exclude_per_dir_offset;
3801 uc->exclude_per_dir = uc->exclude_per_dir_to_free = xstrdup(exclude_per_dir);
3802 /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
3803 next += exclude_per_dir_offset + strlen(exclude_per_dir) + 1;
3804 if (next >= end)
3805 goto done2;
3807 len = decode_varint(&next);
3808 if (next > end || len == 0)
3809 goto done2;
3811 rd.valid = ewah_new();
3812 rd.check_only = ewah_new();
3813 rd.sha1_valid = ewah_new();
3814 rd.data = next;
3815 rd.end = end;
3816 rd.index = 0;
3817 ALLOC_ARRAY(rd.ucd, len);
3819 if (read_one_dir(&uc->root, &rd) || rd.index != len)
3820 goto done;
3822 next = rd.data;
3823 len = ewah_read_mmap(rd.valid, next, end - next);
3824 if (len < 0)
3825 goto done;
3827 next += len;
3828 len = ewah_read_mmap(rd.check_only, next, end - next);
3829 if (len < 0)
3830 goto done;
3832 next += len;
3833 len = ewah_read_mmap(rd.sha1_valid, next, end - next);
3834 if (len < 0)
3835 goto done;
3837 ewah_each_bit(rd.check_only, set_check_only, &rd);
3838 rd.data = next + len;
3839 ewah_each_bit(rd.valid, read_stat, &rd);
3840 ewah_each_bit(rd.sha1_valid, read_oid, &rd);
3841 next = rd.data;
3843 done:
3844 free(rd.ucd);
3845 ewah_free(rd.valid);
3846 ewah_free(rd.check_only);
3847 ewah_free(rd.sha1_valid);
3848 done2:
3849 if (next != end) {
3850 free_untracked_cache(uc);
3851 uc = NULL;
3853 return uc;
3856 static void invalidate_one_directory(struct untracked_cache *uc,
3857 struct untracked_cache_dir *ucd)
3859 uc->dir_invalidated++;
3860 ucd->valid = 0;
3861 ucd->untracked_nr = 0;
3865 * Normally when an entry is added or removed from a directory,
3866 * invalidating that directory is enough. No need to touch its
3867 * ancestors. When a directory is shown as "foo/bar/" in git-status
3868 * however, deleting or adding an entry may have cascading effect.
3870 * Say the "foo/bar/file" has become untracked, we need to tell the
3871 * untracked_cache_dir of "foo" that "bar/" is not an untracked
3872 * directory any more (because "bar" is managed by foo as an untracked
3873 * "file").
3875 * Similarly, if "foo/bar/file" moves from untracked to tracked and it
3876 * was the last untracked entry in the entire "foo", we should show
3877 * "foo/" instead. Which means we have to invalidate past "bar" up to
3878 * "foo".
3880 * This function traverses all directories from root to leaf. If there
3881 * is a chance of one of the above cases happening, we invalidate back
3882 * to root. Otherwise we just invalidate the leaf. There may be a more
3883 * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
3884 * detect these cases and avoid unnecessary invalidation, for example,
3885 * checking for the untracked entry named "bar/" in "foo", but for now
3886 * stick to something safe and simple.
3888 static int invalidate_one_component(struct untracked_cache *uc,
3889 struct untracked_cache_dir *dir,
3890 const char *path, int len)
3892 const char *rest = strchr(path, '/');
3894 if (rest) {
3895 int component_len = rest - path;
3896 struct untracked_cache_dir *d =
3897 lookup_untracked(uc, dir, path, component_len);
3898 int ret =
3899 invalidate_one_component(uc, d, rest + 1,
3900 len - (component_len + 1));
3901 if (ret)
3902 invalidate_one_directory(uc, dir);
3903 return ret;
3906 invalidate_one_directory(uc, dir);
3907 return uc->dir_flags & DIR_SHOW_OTHER_DIRECTORIES;
3910 void untracked_cache_invalidate_path(struct index_state *istate,
3911 const char *path, int safe_path)
3913 if (!istate->untracked || !istate->untracked->root)
3914 return;
3915 if (!safe_path && !verify_path(path, 0))
3916 return;
3917 invalidate_one_component(istate->untracked, istate->untracked->root,
3918 path, strlen(path));
3921 void untracked_cache_remove_from_index(struct index_state *istate,
3922 const char *path)
3924 untracked_cache_invalidate_path(istate, path, 1);
3927 void untracked_cache_add_to_index(struct index_state *istate,
3928 const char *path)
3930 untracked_cache_invalidate_path(istate, path, 1);
3933 static void connect_wt_gitdir_in_nested(const char *sub_worktree,
3934 const char *sub_gitdir)
3936 int i;
3937 struct repository subrepo;
3938 struct strbuf sub_wt = STRBUF_INIT;
3939 struct strbuf sub_gd = STRBUF_INIT;
3941 const struct submodule *sub;
3943 /* If the submodule has no working tree, we can ignore it. */
3944 if (repo_init(&subrepo, sub_gitdir, sub_worktree))
3945 return;
3947 if (repo_read_index(&subrepo) < 0)
3948 die(_("index file corrupt in repo %s"), subrepo.gitdir);
3950 /* TODO: audit for interaction with sparse-index. */
3951 ensure_full_index(subrepo.index);
3952 for (i = 0; i < subrepo.index->cache_nr; i++) {
3953 const struct cache_entry *ce = subrepo.index->cache[i];
3955 if (!S_ISGITLINK(ce->ce_mode))
3956 continue;
3958 while (i + 1 < subrepo.index->cache_nr &&
3959 !strcmp(ce->name, subrepo.index->cache[i + 1]->name))
3961 * Skip entries with the same name in different stages
3962 * to make sure an entry is returned only once.
3964 i++;
3966 sub = submodule_from_path(&subrepo, null_oid(), ce->name);
3967 if (!sub || !is_submodule_active(&subrepo, ce->name))
3968 /* .gitmodules broken or inactive sub */
3969 continue;
3971 strbuf_reset(&sub_wt);
3972 strbuf_reset(&sub_gd);
3973 strbuf_addf(&sub_wt, "%s/%s", sub_worktree, sub->path);
3974 submodule_name_to_gitdir(&sub_gd, &subrepo, sub->name);
3976 connect_work_tree_and_git_dir(sub_wt.buf, sub_gd.buf, 1);
3978 strbuf_release(&sub_wt);
3979 strbuf_release(&sub_gd);
3980 repo_clear(&subrepo);
3983 void connect_work_tree_and_git_dir(const char *work_tree_,
3984 const char *git_dir_,
3985 int recurse_into_nested)
3987 struct strbuf gitfile_sb = STRBUF_INIT;
3988 struct strbuf cfg_sb = STRBUF_INIT;
3989 struct strbuf rel_path = STRBUF_INIT;
3990 char *git_dir, *work_tree;
3992 /* Prepare .git file */
3993 strbuf_addf(&gitfile_sb, "%s/.git", work_tree_);
3994 if (safe_create_leading_directories_const(gitfile_sb.buf))
3995 die(_("could not create directories for %s"), gitfile_sb.buf);
3997 /* Prepare config file */
3998 strbuf_addf(&cfg_sb, "%s/config", git_dir_);
3999 if (safe_create_leading_directories_const(cfg_sb.buf))
4000 die(_("could not create directories for %s"), cfg_sb.buf);
4002 git_dir = real_pathdup(git_dir_, 1);
4003 work_tree = real_pathdup(work_tree_, 1);
4005 /* Write .git file */
4006 write_file(gitfile_sb.buf, "gitdir: %s",
4007 relative_path(git_dir, work_tree, &rel_path));
4008 /* Update core.worktree setting */
4009 git_config_set_in_file(cfg_sb.buf, "core.worktree",
4010 relative_path(work_tree, git_dir, &rel_path));
4012 strbuf_release(&gitfile_sb);
4013 strbuf_release(&cfg_sb);
4014 strbuf_release(&rel_path);
4016 if (recurse_into_nested)
4017 connect_wt_gitdir_in_nested(work_tree, git_dir);
4019 free(work_tree);
4020 free(git_dir);
4024 * Migrate the git directory of the given path from old_git_dir to new_git_dir.
4026 void relocate_gitdir(const char *path, const char *old_git_dir, const char *new_git_dir)
4028 if (rename(old_git_dir, new_git_dir) < 0)
4029 die_errno(_("could not migrate git directory from '%s' to '%s'"),
4030 old_git_dir, new_git_dir);
4032 connect_work_tree_and_git_dir(path, new_git_dir, 0);
4035 int path_match_flags(const char *const str, const enum path_match_flags flags)
4037 const char *p = str;
4039 if (flags & PATH_MATCH_NATIVE &&
4040 flags & PATH_MATCH_XPLATFORM)
4041 BUG("path_match_flags() must get one match kind, not multiple!");
4042 else if (!(flags & PATH_MATCH_KINDS_MASK))
4043 BUG("path_match_flags() must get at least one match kind!");
4045 if (flags & PATH_MATCH_STARTS_WITH_DOT_SLASH &&
4046 flags & PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH)
4047 BUG("path_match_flags() must get one platform kind, not multiple!");
4048 else if (!(flags & PATH_MATCH_PLATFORM_MASK))
4049 BUG("path_match_flags() must get at least one platform kind!");
4051 if (*p++ != '.')
4052 return 0;
4053 if (flags & PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH &&
4054 *p++ != '.')
4055 return 0;
4057 if (flags & PATH_MATCH_NATIVE)
4058 return is_dir_sep(*p);
4059 else if (flags & PATH_MATCH_XPLATFORM)
4060 return is_xplatform_dir_sep(*p);
4061 BUG("unreachable");