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
11 #include "object-store.h"
14 #include "wildmatch.h"
18 #include "ewah/ewok.h"
19 #include "fsmonitor.h"
20 #include "submodule-config.h"
23 * Tells read_directory_recursive how a file or directory should be treated.
24 * Values are ordered by significance, e.g. if a directory contains both
25 * excluded and untracked files, it is listed as untracked because
26 * path_untracked > path_excluded.
36 * Support data structure for our opendir/readdir/closedir wrappers
40 struct untracked_cache_dir
*untracked
;
47 struct untracked_cache_dir
*ucd
;
50 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
51 struct index_state
*istate
, const char *path
, int len
,
52 struct untracked_cache_dir
*untracked
,
53 int check_only
, int stop_at_first_file
, const struct pathspec
*pathspec
);
54 static int resolve_dtype(int dtype
, struct index_state
*istate
,
55 const char *path
, int len
);
56 struct dirent
*readdir_skip_dot_and_dotdot(DIR *dirp
)
60 while ((e
= readdir(dirp
)) != NULL
) {
61 if (!is_dot_or_dotdot(e
->d_name
))
67 int count_slashes(const char *s
)
76 int fspathcmp(const char *a
, const char *b
)
78 return ignore_case
? strcasecmp(a
, b
) : strcmp(a
, b
);
81 int fspatheq(const char *a
, const char *b
)
83 return !fspathcmp(a
, b
);
86 int fspathncmp(const char *a
, const char *b
, size_t count
)
88 return ignore_case
? strncasecmp(a
, b
, count
) : strncmp(a
, b
, count
);
91 unsigned int fspathhash(const char *str
)
93 return ignore_case
? strihash(str
) : strhash(str
);
96 int git_fnmatch(const struct pathspec_item
*item
,
97 const char *pattern
, const char *string
,
101 if (ps_strncmp(item
, pattern
, string
, prefix
))
106 if (item
->flags
& PATHSPEC_ONESTAR
) {
107 int pattern_len
= strlen(++pattern
);
108 int string_len
= strlen(string
);
109 return string_len
< pattern_len
||
110 ps_strcmp(item
, pattern
,
111 string
+ string_len
- pattern_len
);
113 if (item
->magic
& PATHSPEC_GLOB
)
114 return wildmatch(pattern
, string
,
116 (item
->magic
& PATHSPEC_ICASE
? WM_CASEFOLD
: 0));
118 /* wildmatch has not learned no FNM_PATHNAME mode yet */
119 return wildmatch(pattern
, string
,
120 item
->magic
& PATHSPEC_ICASE
? WM_CASEFOLD
: 0);
123 static int fnmatch_icase_mem(const char *pattern
, int patternlen
,
124 const char *string
, int stringlen
,
128 struct strbuf pat_buf
= STRBUF_INIT
;
129 struct strbuf str_buf
= STRBUF_INIT
;
130 const char *use_pat
= pattern
;
131 const char *use_str
= string
;
133 if (pattern
[patternlen
]) {
134 strbuf_add(&pat_buf
, pattern
, patternlen
);
135 use_pat
= pat_buf
.buf
;
137 if (string
[stringlen
]) {
138 strbuf_add(&str_buf
, string
, stringlen
);
139 use_str
= str_buf
.buf
;
143 flags
|= WM_CASEFOLD
;
144 match_status
= wildmatch(use_pat
, use_str
, flags
);
146 strbuf_release(&pat_buf
);
147 strbuf_release(&str_buf
);
152 static size_t common_prefix_len(const struct pathspec
*pathspec
)
158 * ":(icase)path" is treated as a pathspec full of
159 * wildcard. In other words, only prefix is considered common
160 * prefix. If the pathspec is abc/foo abc/bar, running in
161 * subdir xyz, the common prefix is still xyz, not xyz/abc as
164 GUARD_PATHSPEC(pathspec
,
173 for (n
= 0; n
< pathspec
->nr
; n
++) {
174 size_t i
= 0, len
= 0, item_len
;
175 if (pathspec
->items
[n
].magic
& PATHSPEC_EXCLUDE
)
177 if (pathspec
->items
[n
].magic
& PATHSPEC_ICASE
)
178 item_len
= pathspec
->items
[n
].prefix
;
180 item_len
= pathspec
->items
[n
].nowildcard_len
;
181 while (i
< item_len
&& (n
== 0 || i
< max
)) {
182 char c
= pathspec
->items
[n
].match
[i
];
183 if (c
!= pathspec
->items
[0].match
[i
])
189 if (n
== 0 || len
< max
) {
199 * Returns a copy of the longest leading path common among all
202 char *common_prefix(const struct pathspec
*pathspec
)
204 unsigned long len
= common_prefix_len(pathspec
);
206 return len
? xmemdupz(pathspec
->items
[0].match
, len
) : NULL
;
209 int fill_directory(struct dir_struct
*dir
,
210 struct index_state
*istate
,
211 const struct pathspec
*pathspec
)
216 unsigned exclusive_flags
= DIR_SHOW_IGNORED
| DIR_SHOW_IGNORED_TOO
;
217 if ((dir
->flags
& exclusive_flags
) == exclusive_flags
)
218 BUG("DIR_SHOW_IGNORED and DIR_SHOW_IGNORED_TOO are exclusive");
221 * Calculate common prefix for the pathspec, and
222 * use that to optimize the directory walk
224 prefix_len
= common_prefix_len(pathspec
);
225 prefix
= prefix_len
? pathspec
->items
[0].match
: "";
227 /* Read the directory and prune it */
228 read_directory(dir
, istate
, prefix
, prefix_len
, pathspec
);
233 int within_depth(const char *name
, int namelen
,
234 int depth
, int max_depth
)
236 const char *cp
= name
, *cpe
= name
+ namelen
;
242 if (depth
> max_depth
)
249 * Read the contents of the blob with the given OID into a buffer.
250 * Append a trailing LF to the end if the last line doesn't have one.
253 * -1 when the OID is invalid or unknown or does not refer to a blob.
254 * 0 when the blob is empty.
255 * 1 along with { data, size } of the (possibly augmented) buffer
258 * Optionally updates the given oid_stat with the given OID (when valid).
260 static int do_read_blob(const struct object_id
*oid
, struct oid_stat
*oid_stat
,
261 size_t *size_out
, char **data_out
)
263 enum object_type type
;
270 data
= read_object_file(oid
, &type
, &sz
);
271 if (!data
|| type
!= OBJ_BLOB
) {
277 memset(&oid_stat
->stat
, 0, sizeof(oid_stat
->stat
));
278 oidcpy(&oid_stat
->oid
, oid
);
286 if (data
[sz
- 1] != '\n') {
287 data
= xrealloc(data
, st_add(sz
, 1));
291 *size_out
= xsize_t(sz
);
297 #define DO_MATCH_EXCLUDE (1<<0)
298 #define DO_MATCH_DIRECTORY (1<<1)
299 #define DO_MATCH_LEADING_PATHSPEC (1<<2)
302 * Does the given pathspec match the given name? A match is found if
304 * (1) the pathspec string is leading directory of 'name' ("RECURSIVELY"), or
305 * (2) the pathspec string has a leading part matching 'name' ("LEADING"), or
306 * (3) the pathspec string is a wildcard and matches 'name' ("WILDCARD"), or
307 * (4) the pathspec string is exactly the same as 'name' ("EXACT").
309 * Return value tells which case it was (1-4), or 0 when there is no match.
311 * It may be instructive to look at a small table of concrete examples
312 * to understand the differences between 1, 2, and 4:
315 * | a/b | a/b/ | a/b/c
316 * ------+-----------+-----------+------------
317 * a/b | EXACT | EXACT[1] | LEADING[2]
318 * Names a/b/ | RECURSIVE | EXACT | LEADING[2]
319 * a/b/c | RECURSIVE | RECURSIVE | EXACT
321 * [1] Only if DO_MATCH_DIRECTORY is passed; otherwise, this is NOT a match.
322 * [2] Only if DO_MATCH_LEADING_PATHSPEC is passed; otherwise, not a match.
324 static int match_pathspec_item(struct index_state
*istate
,
325 const struct pathspec_item
*item
, int prefix
,
326 const char *name
, int namelen
, unsigned flags
)
328 /* name/namelen has prefix cut off by caller */
329 const char *match
= item
->match
+ prefix
;
330 int matchlen
= item
->len
- prefix
;
333 * The normal call pattern is:
334 * 1. prefix = common_prefix_len(ps);
335 * 2. prune something, or fill_directory
336 * 3. match_pathspec()
338 * 'prefix' at #1 may be shorter than the command's prefix and
339 * it's ok for #2 to match extra files. Those extras will be
342 * Suppose the pathspec is 'foo' and '../bar' running from
343 * subdir 'xyz'. The common prefix at #1 will be empty, thanks
344 * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
345 * user does not want XYZ/foo, only the "foo" part should be
346 * case-insensitive. We need to filter out XYZ/foo here. In
347 * other words, we do not trust the caller on comparing the
348 * prefix part when :(icase) is involved. We do exact
349 * comparison ourselves.
351 * Normally the caller (common_prefix_len() in fact) does
352 * _exact_ matching on name[-prefix+1..-1] and we do not need
353 * to check that part. Be defensive and check it anyway, in
354 * case common_prefix_len is changed, or a new caller is
355 * introduced that does not use common_prefix_len.
357 * If the penalty turns out too high when prefix is really
358 * long, maybe change it to
359 * strncmp(match, name, item->prefix - prefix)
361 if (item
->prefix
&& (item
->magic
& PATHSPEC_ICASE
) &&
362 strncmp(item
->match
, name
- prefix
, item
->prefix
))
365 if (item
->attr_match_nr
&&
366 !match_pathspec_attrs(istate
, name
, namelen
, item
))
369 /* If the match was just the prefix, we matched */
371 return MATCHED_RECURSIVELY
;
373 if (matchlen
<= namelen
&& !ps_strncmp(item
, match
, name
, matchlen
)) {
374 if (matchlen
== namelen
)
375 return MATCHED_EXACTLY
;
377 if (match
[matchlen
-1] == '/' || name
[matchlen
] == '/')
378 return MATCHED_RECURSIVELY
;
379 } else if ((flags
& DO_MATCH_DIRECTORY
) &&
380 match
[matchlen
- 1] == '/' &&
381 namelen
== matchlen
- 1 &&
382 !ps_strncmp(item
, match
, name
, namelen
))
383 return MATCHED_EXACTLY
;
385 if (item
->nowildcard_len
< item
->len
&&
386 !git_fnmatch(item
, match
, name
,
387 item
->nowildcard_len
- prefix
))
388 return MATCHED_FNMATCH
;
390 /* Perform checks to see if "name" is a leading string of the pathspec */
391 if ( (flags
& DO_MATCH_LEADING_PATHSPEC
) &&
392 !(flags
& DO_MATCH_EXCLUDE
)) {
393 /* name is a literal prefix of the pathspec */
394 int offset
= name
[namelen
-1] == '/' ? 1 : 0;
395 if ((namelen
< matchlen
) &&
396 (match
[namelen
-offset
] == '/') &&
397 !ps_strncmp(item
, match
, name
, namelen
))
398 return MATCHED_RECURSIVELY_LEADING_PATHSPEC
;
400 /* name doesn't match up to the first wild character */
401 if (item
->nowildcard_len
< item
->len
&&
402 ps_strncmp(item
, match
, name
,
403 item
->nowildcard_len
- prefix
))
407 * name has no wildcard, and it didn't match as a leading
408 * pathspec so return.
410 if (item
->nowildcard_len
== item
->len
)
414 * Here is where we would perform a wildmatch to check if
415 * "name" can be matched as a directory (or a prefix) against
416 * the pathspec. Since wildmatch doesn't have this capability
417 * at the present we have to punt and say that it is a match,
418 * potentially returning a false positive
419 * The submodules themselves will be able to perform more
420 * accurate matching to determine if the pathspec matches.
422 return MATCHED_RECURSIVELY_LEADING_PATHSPEC
;
429 * do_match_pathspec() is meant to ONLY be called by
430 * match_pathspec_with_flags(); calling it directly risks pathspecs
431 * like ':!unwanted_path' being ignored.
433 * Given a name and a list of pathspecs, returns the nature of the
434 * closest (i.e. most specific) match of the name to any of the
437 * The caller typically calls this multiple times with the same
438 * pathspec and seen[] array but with different name/namelen
439 * (e.g. entries from the index) and is interested in seeing if and
440 * how each pathspec matches all the names it calls this function
441 * with. A mark is left in the seen[] array for each pathspec element
442 * indicating the closest type of match that element achieved, so if
443 * seen[n] remains zero after multiple invocations, that means the nth
444 * pathspec did not match any names, which could indicate that the
445 * user mistyped the nth pathspec.
447 static int do_match_pathspec(struct index_state
*istate
,
448 const struct pathspec
*ps
,
449 const char *name
, int namelen
,
450 int prefix
, char *seen
,
453 int i
, retval
= 0, exclude
= flags
& DO_MATCH_EXCLUDE
;
465 if (!ps
->recursive
||
466 !(ps
->magic
& PATHSPEC_MAXDEPTH
) ||
468 return MATCHED_RECURSIVELY
;
470 if (within_depth(name
, namelen
, 0, ps
->max_depth
))
471 return MATCHED_EXACTLY
;
479 for (i
= ps
->nr
- 1; i
>= 0; i
--) {
482 if ((!exclude
&& ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
) ||
483 ( exclude
&& !(ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
)))
486 if (seen
&& seen
[i
] == MATCHED_EXACTLY
)
489 * Make exclude patterns optional and never report
490 * "pathspec ':(exclude)foo' matches no files"
492 if (seen
&& ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
)
493 seen
[i
] = MATCHED_FNMATCH
;
494 how
= match_pathspec_item(istate
, ps
->items
+i
, prefix
, name
,
497 (ps
->magic
& PATHSPEC_MAXDEPTH
) &&
498 ps
->max_depth
!= -1 &&
499 how
&& how
!= MATCHED_FNMATCH
) {
500 int len
= ps
->items
[i
].len
;
501 if (name
[len
] == '/')
503 if (within_depth(name
+len
, namelen
-len
, 0, ps
->max_depth
))
504 how
= MATCHED_EXACTLY
;
511 if (seen
&& seen
[i
] < how
)
518 static int match_pathspec_with_flags(struct index_state
*istate
,
519 const struct pathspec
*ps
,
520 const char *name
, int namelen
,
521 int prefix
, char *seen
, unsigned flags
)
523 int positive
, negative
;
524 positive
= do_match_pathspec(istate
, ps
, name
, namelen
,
525 prefix
, seen
, flags
);
526 if (!(ps
->magic
& PATHSPEC_EXCLUDE
) || !positive
)
528 negative
= do_match_pathspec(istate
, ps
, name
, namelen
,
530 flags
| DO_MATCH_EXCLUDE
);
531 return negative
? 0 : positive
;
534 int match_pathspec(struct index_state
*istate
,
535 const struct pathspec
*ps
,
536 const char *name
, int namelen
,
537 int prefix
, char *seen
, int is_dir
)
539 unsigned flags
= is_dir
? DO_MATCH_DIRECTORY
: 0;
540 return match_pathspec_with_flags(istate
, ps
, name
, namelen
,
541 prefix
, seen
, flags
);
545 * Check if a submodule is a superset of the pathspec
547 int submodule_path_match(struct index_state
*istate
,
548 const struct pathspec
*ps
,
549 const char *submodule_name
,
552 int matched
= match_pathspec_with_flags(istate
, ps
, submodule_name
,
553 strlen(submodule_name
),
556 DO_MATCH_LEADING_PATHSPEC
);
560 int report_path_error(const char *ps_matched
,
561 const struct pathspec
*pathspec
)
564 * Make sure all pathspec matched; otherwise it is an error.
567 for (num
= 0; num
< pathspec
->nr
; num
++) {
568 int other
, found_dup
;
573 * The caller might have fed identical pathspec
574 * twice. Do not barf on such a mistake.
575 * FIXME: parse_pathspec should have eliminated
576 * duplicate pathspec.
578 for (found_dup
= other
= 0;
579 !found_dup
&& other
< pathspec
->nr
;
581 if (other
== num
|| !ps_matched
[other
])
583 if (!strcmp(pathspec
->items
[other
].original
,
584 pathspec
->items
[num
].original
))
586 * Ok, we have a match already.
593 error(_("pathspec '%s' did not match any file(s) known to git"),
594 pathspec
->items
[num
].original
);
601 * Return the length of the "simple" part of a path match limiter.
603 int simple_length(const char *match
)
608 unsigned char c
= *match
++;
610 if (c
== '\0' || is_glob_special(c
))
615 int no_wildcard(const char *string
)
617 return string
[simple_length(string
)] == '\0';
620 void parse_path_pattern(const char **pattern
,
625 const char *p
= *pattern
;
630 *flags
|= PATTERN_FLAG_NEGATIVE
;
634 if (len
&& p
[len
- 1] == '/') {
636 *flags
|= PATTERN_FLAG_MUSTBEDIR
;
638 for (i
= 0; i
< len
; i
++) {
643 *flags
|= PATTERN_FLAG_NODIR
;
644 *nowildcardlen
= simple_length(p
);
646 * we should have excluded the trailing slash from 'p' too,
647 * but that's one more allocation. Instead just make sure
648 * nowildcardlen does not exceed real patternlen
650 if (*nowildcardlen
> len
)
651 *nowildcardlen
= len
;
652 if (*p
== '*' && no_wildcard(p
+ 1))
653 *flags
|= PATTERN_FLAG_ENDSWITH
;
658 int pl_hashmap_cmp(const void *cmp_data UNUSED
,
659 const struct hashmap_entry
*a
,
660 const struct hashmap_entry
*b
,
661 const void *key UNUSED
)
663 const struct pattern_entry
*ee1
=
664 container_of(a
, struct pattern_entry
, ent
);
665 const struct pattern_entry
*ee2
=
666 container_of(b
, struct pattern_entry
, ent
);
668 size_t min_len
= ee1
->patternlen
<= ee2
->patternlen
672 return fspathncmp(ee1
->pattern
, ee2
->pattern
, min_len
);
675 static char *dup_and_filter_pattern(const char *pattern
)
679 char *result
= xstrdup(pattern
);
685 /* skip escape characters (once) */
705 static void add_pattern_to_hashsets(struct pattern_list
*pl
, struct path_pattern
*given
)
707 struct pattern_entry
*translated
;
710 const char *prev
, *cur
, *next
;
712 if (!pl
->use_cone_patterns
)
715 if (given
->flags
& PATTERN_FLAG_NEGATIVE
&&
716 given
->flags
& PATTERN_FLAG_MUSTBEDIR
&&
717 !strcmp(given
->pattern
, "/*")) {
722 if (!given
->flags
&& !strcmp(given
->pattern
, "/*")) {
727 if (given
->patternlen
< 2 ||
728 *given
->pattern
!= '/' ||
729 strstr(given
->pattern
, "**")) {
730 /* Not a cone pattern. */
731 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
735 if (!(given
->flags
& PATTERN_FLAG_MUSTBEDIR
) &&
736 strcmp(given
->pattern
, "/*")) {
737 /* Not a cone pattern. */
738 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
742 prev
= given
->pattern
;
743 cur
= given
->pattern
+ 1;
744 next
= given
->pattern
+ 2;
747 /* Watch for glob characters '*', '\', '[', '?' */
748 if (!is_glob_special(*cur
))
751 /* But only if *prev != '\\' */
755 /* But allow the initial '\' */
757 is_glob_special(*next
))
760 /* But a trailing '/' then '*' is fine */
766 /* Not a cone pattern. */
767 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
776 if (given
->patternlen
> 2 &&
777 !strcmp(given
->pattern
+ given
->patternlen
- 2, "/*")) {
778 if (!(given
->flags
& PATTERN_FLAG_NEGATIVE
)) {
779 /* Not a cone pattern. */
780 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
784 truncated
= dup_and_filter_pattern(given
->pattern
);
786 translated
= xmalloc(sizeof(struct pattern_entry
));
787 translated
->pattern
= truncated
;
788 translated
->patternlen
= given
->patternlen
- 2;
789 hashmap_entry_init(&translated
->ent
,
790 fspathhash(translated
->pattern
));
792 if (!hashmap_get_entry(&pl
->recursive_hashmap
,
793 translated
, ent
, NULL
)) {
794 /* We did not see the "parent" included */
795 warning(_("unrecognized negative pattern: '%s'"),
802 hashmap_add(&pl
->parent_hashmap
, &translated
->ent
);
803 hashmap_remove(&pl
->recursive_hashmap
, &translated
->ent
, &data
);
808 if (given
->flags
& PATTERN_FLAG_NEGATIVE
) {
809 warning(_("unrecognized negative pattern: '%s'"),
814 translated
= xmalloc(sizeof(struct pattern_entry
));
816 translated
->pattern
= dup_and_filter_pattern(given
->pattern
);
817 translated
->patternlen
= given
->patternlen
;
818 hashmap_entry_init(&translated
->ent
,
819 fspathhash(translated
->pattern
));
821 hashmap_add(&pl
->recursive_hashmap
, &translated
->ent
);
823 if (hashmap_get_entry(&pl
->parent_hashmap
, translated
, ent
, NULL
)) {
824 /* we already included this at the parent level */
825 warning(_("your sparse-checkout file may have issues: pattern '%s' is repeated"),
833 warning(_("disabling cone pattern matching"));
834 hashmap_clear_and_free(&pl
->parent_hashmap
, struct pattern_entry
, ent
);
835 hashmap_clear_and_free(&pl
->recursive_hashmap
, struct pattern_entry
, ent
);
836 pl
->use_cone_patterns
= 0;
839 static int hashmap_contains_path(struct hashmap
*map
,
840 struct strbuf
*pattern
)
842 struct pattern_entry p
;
844 /* Check straight mapping */
845 p
.pattern
= pattern
->buf
;
846 p
.patternlen
= pattern
->len
;
847 hashmap_entry_init(&p
.ent
, fspathhash(p
.pattern
));
848 return !!hashmap_get_entry(map
, &p
, ent
, NULL
);
851 int hashmap_contains_parent(struct hashmap
*map
,
853 struct strbuf
*buffer
)
857 strbuf_setlen(buffer
, 0);
860 strbuf_addch(buffer
, '/');
862 strbuf_addstr(buffer
, path
);
864 slash_pos
= strrchr(buffer
->buf
, '/');
866 while (slash_pos
> buffer
->buf
) {
867 strbuf_setlen(buffer
, slash_pos
- buffer
->buf
);
869 if (hashmap_contains_path(map
, buffer
))
872 slash_pos
= strrchr(buffer
->buf
, '/');
878 void add_pattern(const char *string
, const char *base
,
879 int baselen
, struct pattern_list
*pl
, int srcpos
)
881 struct path_pattern
*pattern
;
886 parse_path_pattern(&string
, &patternlen
, &flags
, &nowildcardlen
);
887 if (flags
& PATTERN_FLAG_MUSTBEDIR
) {
888 FLEXPTR_ALLOC_MEM(pattern
, pattern
, string
, patternlen
);
890 pattern
= xmalloc(sizeof(*pattern
));
891 pattern
->pattern
= string
;
893 pattern
->patternlen
= patternlen
;
894 pattern
->nowildcardlen
= nowildcardlen
;
895 pattern
->base
= base
;
896 pattern
->baselen
= baselen
;
897 pattern
->flags
= flags
;
898 pattern
->srcpos
= srcpos
;
899 ALLOC_GROW(pl
->patterns
, pl
->nr
+ 1, pl
->alloc
);
900 pl
->patterns
[pl
->nr
++] = pattern
;
903 add_pattern_to_hashsets(pl
, pattern
);
906 static int read_skip_worktree_file_from_index(struct index_state
*istate
,
908 size_t *size_out
, char **data_out
,
909 struct oid_stat
*oid_stat
)
914 pos
= index_name_pos(istate
, path
, len
);
917 if (!ce_skip_worktree(istate
->cache
[pos
]))
920 return do_read_blob(&istate
->cache
[pos
]->oid
, oid_stat
, size_out
, data_out
);
924 * Frees memory within pl which was allocated for exclude patterns and
925 * the file buffer. Does not free pl itself.
927 void clear_pattern_list(struct pattern_list
*pl
)
931 for (i
= 0; i
< pl
->nr
; i
++)
932 free(pl
->patterns
[i
]);
935 hashmap_clear_and_free(&pl
->recursive_hashmap
, struct pattern_entry
, ent
);
936 hashmap_clear_and_free(&pl
->parent_hashmap
, struct pattern_entry
, ent
);
938 memset(pl
, 0, sizeof(*pl
));
941 static void trim_trailing_spaces(char *buf
)
943 char *p
, *last_space
= NULL
;
945 for (p
= buf
; *p
; p
++)
965 * Given a subdirectory name and "dir" of the current directory,
966 * search the subdir in "dir" and return it, or create a new one if it
967 * does not exist in "dir".
969 * If "name" has the trailing slash, it'll be excluded in the search.
971 static struct untracked_cache_dir
*lookup_untracked(struct untracked_cache
*uc
,
972 struct untracked_cache_dir
*dir
,
973 const char *name
, int len
)
976 struct untracked_cache_dir
*d
;
979 if (len
&& name
[len
- 1] == '/')
983 while (last
> first
) {
984 int cmp
, next
= first
+ ((last
- first
) >> 1);
986 cmp
= strncmp(name
, d
->name
, len
);
987 if (!cmp
&& strlen(d
->name
) > len
)
999 FLEX_ALLOC_MEM(d
, name
, name
, len
);
1001 ALLOC_GROW(dir
->dirs
, dir
->dirs_nr
+ 1, dir
->dirs_alloc
);
1002 MOVE_ARRAY(dir
->dirs
+ first
+ 1, dir
->dirs
+ first
,
1003 dir
->dirs_nr
- first
);
1005 dir
->dirs
[first
] = d
;
1009 static void do_invalidate_gitignore(struct untracked_cache_dir
*dir
)
1013 dir
->untracked_nr
= 0;
1014 for (i
= 0; i
< dir
->dirs_nr
; i
++)
1015 do_invalidate_gitignore(dir
->dirs
[i
]);
1018 static void invalidate_gitignore(struct untracked_cache
*uc
,
1019 struct untracked_cache_dir
*dir
)
1021 uc
->gitignore_invalidated
++;
1022 do_invalidate_gitignore(dir
);
1025 static void invalidate_directory(struct untracked_cache
*uc
,
1026 struct untracked_cache_dir
*dir
)
1031 * Invalidation increment here is just roughly correct. If
1032 * untracked_nr or any of dirs[].recurse is non-zero, we
1033 * should increment dir_invalidated too. But that's more
1037 uc
->dir_invalidated
++;
1040 dir
->untracked_nr
= 0;
1041 for (i
= 0; i
< dir
->dirs_nr
; i
++)
1042 dir
->dirs
[i
]->recurse
= 0;
1045 static int add_patterns_from_buffer(char *buf
, size_t size
,
1046 const char *base
, int baselen
,
1047 struct pattern_list
*pl
);
1049 /* Flags for add_patterns() */
1050 #define PATTERN_NOFOLLOW (1<<0)
1053 * Given a file with name "fname", read it (either from disk, or from
1054 * an index if 'istate' is non-null), parse it and store the
1055 * exclude rules in "pl".
1057 * If "oid_stat" is not NULL, compute oid of the exclude file and fill
1058 * stat data from disk (only valid if add_patterns returns zero). If
1059 * oid_stat.valid is non-zero, "oid_stat" must contain good value as input.
1061 static int add_patterns(const char *fname
, const char *base
, int baselen
,
1062 struct pattern_list
*pl
, struct index_state
*istate
,
1063 unsigned flags
, struct oid_stat
*oid_stat
)
1071 if (flags
& PATTERN_NOFOLLOW
)
1072 fd
= open_nofollow(fname
, O_RDONLY
);
1074 fd
= open(fname
, O_RDONLY
);
1076 if (fd
< 0 || fstat(fd
, &st
) < 0) {
1078 warn_on_fopen_errors(fname
);
1083 r
= read_skip_worktree_file_from_index(istate
, fname
,
1089 size
= xsize_t(st
.st_size
);
1092 fill_stat_data(&oid_stat
->stat
, &st
);
1093 oidcpy(&oid_stat
->oid
, the_hash_algo
->empty_blob
);
1094 oid_stat
->valid
= 1;
1099 buf
= xmallocz(size
);
1100 if (read_in_full(fd
, buf
, size
) != size
) {
1109 if (oid_stat
->valid
&&
1110 !match_stat_data_racy(istate
, &oid_stat
->stat
, &st
))
1111 ; /* no content change, oid_stat->oid still good */
1113 (pos
= index_name_pos(istate
, fname
, strlen(fname
))) >= 0 &&
1114 !ce_stage(istate
->cache
[pos
]) &&
1115 ce_uptodate(istate
->cache
[pos
]) &&
1116 !would_convert_to_git(istate
, fname
))
1117 oidcpy(&oid_stat
->oid
,
1118 &istate
->cache
[pos
]->oid
);
1120 hash_object_file(the_hash_algo
, buf
, size
,
1121 OBJ_BLOB
, &oid_stat
->oid
);
1122 fill_stat_data(&oid_stat
->stat
, &st
);
1123 oid_stat
->valid
= 1;
1127 add_patterns_from_buffer(buf
, size
, base
, baselen
, pl
);
1131 static int add_patterns_from_buffer(char *buf
, size_t size
,
1132 const char *base
, int baselen
,
1133 struct pattern_list
*pl
)
1138 hashmap_init(&pl
->recursive_hashmap
, pl_hashmap_cmp
, NULL
, 0);
1139 hashmap_init(&pl
->parent_hashmap
, pl_hashmap_cmp
, NULL
, 0);
1143 if (skip_utf8_bom(&buf
, size
))
1144 size
-= buf
- pl
->filebuf
;
1148 for (i
= 0; i
< size
; i
++) {
1149 if (buf
[i
] == '\n') {
1150 if (entry
!= buf
+ i
&& entry
[0] != '#') {
1151 buf
[i
- (i
&& buf
[i
-1] == '\r')] = 0;
1152 trim_trailing_spaces(entry
);
1153 add_pattern(entry
, base
, baselen
, pl
, lineno
);
1156 entry
= buf
+ i
+ 1;
1162 int add_patterns_from_file_to_list(const char *fname
, const char *base
,
1163 int baselen
, struct pattern_list
*pl
,
1164 struct index_state
*istate
,
1167 return add_patterns(fname
, base
, baselen
, pl
, istate
, flags
, NULL
);
1170 int add_patterns_from_blob_to_list(
1171 struct object_id
*oid
,
1172 const char *base
, int baselen
,
1173 struct pattern_list
*pl
)
1179 r
= do_read_blob(oid
, NULL
, &size
, &buf
);
1183 add_patterns_from_buffer(buf
, size
, base
, baselen
, pl
);
1187 struct pattern_list
*add_pattern_list(struct dir_struct
*dir
,
1188 int group_type
, const char *src
)
1190 struct pattern_list
*pl
;
1191 struct exclude_list_group
*group
;
1193 group
= &dir
->internal
.exclude_list_group
[group_type
];
1194 ALLOC_GROW(group
->pl
, group
->nr
+ 1, group
->alloc
);
1195 pl
= &group
->pl
[group
->nr
++];
1196 memset(pl
, 0, sizeof(*pl
));
1202 * Used to set up core.excludesfile and .git/info/exclude lists.
1204 static void add_patterns_from_file_1(struct dir_struct
*dir
, const char *fname
,
1205 struct oid_stat
*oid_stat
)
1207 struct pattern_list
*pl
;
1209 * catch setup_standard_excludes() that's called before
1210 * dir->untracked is assigned. That function behaves
1211 * differently when dir->untracked is non-NULL.
1213 if (!dir
->untracked
)
1214 dir
->internal
.unmanaged_exclude_files
++;
1215 pl
= add_pattern_list(dir
, EXC_FILE
, fname
);
1216 if (add_patterns(fname
, "", 0, pl
, NULL
, 0, oid_stat
) < 0)
1217 die(_("cannot use %s as an exclude file"), fname
);
1220 void add_patterns_from_file(struct dir_struct
*dir
, const char *fname
)
1222 dir
->internal
.unmanaged_exclude_files
++; /* see validate_untracked_cache() */
1223 add_patterns_from_file_1(dir
, fname
, NULL
);
1226 int match_basename(const char *basename
, int basenamelen
,
1227 const char *pattern
, int prefix
, int patternlen
,
1230 if (prefix
== patternlen
) {
1231 if (patternlen
== basenamelen
&&
1232 !fspathncmp(pattern
, basename
, basenamelen
))
1234 } else if (flags
& PATTERN_FLAG_ENDSWITH
) {
1235 /* "*literal" matching against "fooliteral" */
1236 if (patternlen
- 1 <= basenamelen
&&
1237 !fspathncmp(pattern
+ 1,
1238 basename
+ basenamelen
- (patternlen
- 1),
1242 if (fnmatch_icase_mem(pattern
, patternlen
,
1243 basename
, basenamelen
,
1250 int match_pathname(const char *pathname
, int pathlen
,
1251 const char *base
, int baselen
,
1252 const char *pattern
, int prefix
, int patternlen
)
1258 * match with FNM_PATHNAME; the pattern has base implicitly
1261 if (*pattern
== '/') {
1268 * baselen does not count the trailing slash. base[] may or
1269 * may not end with a trailing slash though.
1271 if (pathlen
< baselen
+ 1 ||
1272 (baselen
&& pathname
[baselen
] != '/') ||
1273 fspathncmp(pathname
, base
, baselen
))
1276 namelen
= baselen
? pathlen
- baselen
- 1 : pathlen
;
1277 name
= pathname
+ pathlen
- namelen
;
1281 * if the non-wildcard part is longer than the
1282 * remaining pathname, surely it cannot match.
1284 if (prefix
> namelen
)
1287 if (fspathncmp(pattern
, name
, prefix
))
1290 patternlen
-= prefix
;
1295 * If the whole pattern did not have a wildcard,
1296 * then our prefix match is all we need; we
1297 * do not need to call fnmatch at all.
1299 if (!patternlen
&& !namelen
)
1303 return fnmatch_icase_mem(pattern
, patternlen
,
1309 * Scan the given exclude list in reverse to see whether pathname
1310 * should be ignored. The first match (i.e. the last on the list), if
1311 * any, determines the fate. Returns the exclude_list element which
1312 * matched, or NULL for undecided.
1314 static struct path_pattern
*last_matching_pattern_from_list(const char *pathname
,
1316 const char *basename
,
1318 struct pattern_list
*pl
,
1319 struct index_state
*istate
)
1321 struct path_pattern
*res
= NULL
; /* undecided */
1325 return NULL
; /* undefined */
1327 for (i
= pl
->nr
- 1; 0 <= i
; i
--) {
1328 struct path_pattern
*pattern
= pl
->patterns
[i
];
1329 const char *exclude
= pattern
->pattern
;
1330 int prefix
= pattern
->nowildcardlen
;
1332 if (pattern
->flags
& PATTERN_FLAG_MUSTBEDIR
) {
1333 *dtype
= resolve_dtype(*dtype
, istate
, pathname
, pathlen
);
1334 if (*dtype
!= DT_DIR
)
1338 if (pattern
->flags
& PATTERN_FLAG_NODIR
) {
1339 if (match_basename(basename
,
1340 pathlen
- (basename
- pathname
),
1341 exclude
, prefix
, pattern
->patternlen
,
1349 assert(pattern
->baselen
== 0 ||
1350 pattern
->base
[pattern
->baselen
- 1] == '/');
1351 if (match_pathname(pathname
, pathlen
,
1353 pattern
->baselen
? pattern
->baselen
- 1 : 0,
1354 exclude
, prefix
, pattern
->patternlen
)) {
1363 * Scan the list of patterns to determine if the ordered list
1364 * of patterns matches on 'pathname'.
1366 * Return 1 for a match, 0 for not matched and -1 for undecided.
1368 enum pattern_match_result
path_matches_pattern_list(
1369 const char *pathname
, int pathlen
,
1370 const char *basename
, int *dtype
,
1371 struct pattern_list
*pl
,
1372 struct index_state
*istate
)
1374 struct path_pattern
*pattern
;
1375 struct strbuf parent_pathname
= STRBUF_INIT
;
1376 int result
= NOT_MATCHED
;
1379 if (!pl
->use_cone_patterns
) {
1380 pattern
= last_matching_pattern_from_list(pathname
, pathlen
, basename
,
1383 if (pattern
->flags
& PATTERN_FLAG_NEGATIVE
)
1395 strbuf_addch(&parent_pathname
, '/');
1396 strbuf_add(&parent_pathname
, pathname
, pathlen
);
1399 * Directory entries are matched if and only if a file
1400 * contained immediately within them is matched. For the
1401 * case of a directory entry, modify the path to create
1402 * a fake filename within this directory, allowing us to
1403 * use the file-base matching logic in an equivalent way.
1405 if (parent_pathname
.len
> 0 &&
1406 parent_pathname
.buf
[parent_pathname
.len
- 1] == '/') {
1407 slash_pos
= parent_pathname
.len
- 1;
1408 strbuf_add(&parent_pathname
, "-", 1);
1410 const char *slash_ptr
= strrchr(parent_pathname
.buf
, '/');
1411 slash_pos
= slash_ptr
? slash_ptr
- parent_pathname
.buf
: 0;
1414 if (hashmap_contains_path(&pl
->recursive_hashmap
,
1415 &parent_pathname
)) {
1416 result
= MATCHED_RECURSIVE
;
1421 /* include every file in root */
1426 strbuf_setlen(&parent_pathname
, slash_pos
);
1428 if (hashmap_contains_path(&pl
->parent_hashmap
, &parent_pathname
)) {
1433 if (hashmap_contains_parent(&pl
->recursive_hashmap
,
1436 result
= MATCHED_RECURSIVE
;
1439 strbuf_release(&parent_pathname
);
1443 int init_sparse_checkout_patterns(struct index_state
*istate
)
1445 if (!core_apply_sparse_checkout
)
1447 if (istate
->sparse_checkout_patterns
)
1450 CALLOC_ARRAY(istate
->sparse_checkout_patterns
, 1);
1452 if (get_sparse_checkout_patterns(istate
->sparse_checkout_patterns
) < 0) {
1453 FREE_AND_NULL(istate
->sparse_checkout_patterns
);
1460 static int path_in_sparse_checkout_1(const char *path
,
1461 struct index_state
*istate
,
1462 int require_cone_mode
)
1465 enum pattern_match_result match
= UNDECIDED
;
1466 const char *end
, *slash
;
1469 * We default to accepting a path if the path is empty, there are no
1470 * patterns, or the patterns are of the wrong type.
1473 init_sparse_checkout_patterns(istate
) ||
1474 (require_cone_mode
&&
1475 !istate
->sparse_checkout_patterns
->use_cone_patterns
))
1479 * If UNDECIDED, use the match from the parent dir (recursively), or
1480 * fall back to NOT_MATCHED at the topmost level. Note that cone mode
1481 * never returns UNDECIDED, so we will execute only one iteration in
1484 for (end
= path
+ strlen(path
);
1485 end
> path
&& match
== UNDECIDED
;
1488 for (slash
= end
- 1; slash
> path
&& *slash
!= '/'; slash
--)
1491 match
= path_matches_pattern_list(path
, end
- path
,
1492 slash
> path
? slash
+ 1 : path
, &dtype
,
1493 istate
->sparse_checkout_patterns
, istate
);
1495 /* We are going to match the parent dir now */
1501 int path_in_sparse_checkout(const char *path
,
1502 struct index_state
*istate
)
1504 return path_in_sparse_checkout_1(path
, istate
, 0);
1507 int path_in_cone_mode_sparse_checkout(const char *path
,
1508 struct index_state
*istate
)
1510 return path_in_sparse_checkout_1(path
, istate
, 1);
1513 static struct path_pattern
*last_matching_pattern_from_lists(
1514 struct dir_struct
*dir
, struct index_state
*istate
,
1515 const char *pathname
, int pathlen
,
1516 const char *basename
, int *dtype_p
)
1519 struct exclude_list_group
*group
;
1520 struct path_pattern
*pattern
;
1521 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
1522 group
= &dir
->internal
.exclude_list_group
[i
];
1523 for (j
= group
->nr
- 1; j
>= 0; j
--) {
1524 pattern
= last_matching_pattern_from_list(
1525 pathname
, pathlen
, basename
, dtype_p
,
1526 &group
->pl
[j
], istate
);
1535 * Loads the per-directory exclude list for the substring of base
1536 * which has a char length of baselen.
1538 static void prep_exclude(struct dir_struct
*dir
,
1539 struct index_state
*istate
,
1540 const char *base
, int baselen
)
1542 struct exclude_list_group
*group
;
1543 struct pattern_list
*pl
;
1544 struct exclude_stack
*stk
= NULL
;
1545 struct untracked_cache_dir
*untracked
;
1548 group
= &dir
->internal
.exclude_list_group
[EXC_DIRS
];
1551 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
1552 * which originate from directories not in the prefix of the
1553 * path being checked.
1555 while ((stk
= dir
->internal
.exclude_stack
) != NULL
) {
1556 if (stk
->baselen
<= baselen
&&
1557 !strncmp(dir
->internal
.basebuf
.buf
, base
, stk
->baselen
))
1559 pl
= &group
->pl
[dir
->internal
.exclude_stack
->exclude_ix
];
1560 dir
->internal
.exclude_stack
= stk
->prev
;
1561 dir
->internal
.pattern
= NULL
;
1562 free((char *)pl
->src
); /* see strbuf_detach() below */
1563 clear_pattern_list(pl
);
1568 /* Skip traversing into sub directories if the parent is excluded */
1569 if (dir
->internal
.pattern
)
1573 * Lazy initialization. All call sites currently just
1574 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1575 * them seems lots of work for little benefit.
1577 if (!dir
->internal
.basebuf
.buf
)
1578 strbuf_init(&dir
->internal
.basebuf
, PATH_MAX
);
1580 /* Read from the parent directories and push them down. */
1581 current
= stk
? stk
->baselen
: -1;
1582 strbuf_setlen(&dir
->internal
.basebuf
, current
< 0 ? 0 : current
);
1584 untracked
= stk
? stk
->ucd
: dir
->untracked
->root
;
1588 while (current
< baselen
) {
1590 struct oid_stat oid_stat
;
1592 CALLOC_ARRAY(stk
, 1);
1597 cp
= strchr(base
+ current
+ 1, '/');
1599 die("oops in prep_exclude");
1602 lookup_untracked(dir
->untracked
,
1605 cp
- base
- current
);
1607 stk
->prev
= dir
->internal
.exclude_stack
;
1608 stk
->baselen
= cp
- base
;
1609 stk
->exclude_ix
= group
->nr
;
1610 stk
->ucd
= untracked
;
1611 pl
= add_pattern_list(dir
, EXC_DIRS
, NULL
);
1612 strbuf_add(&dir
->internal
.basebuf
, base
+ current
, stk
->baselen
- current
);
1613 assert(stk
->baselen
== dir
->internal
.basebuf
.len
);
1615 /* Abort if the directory is excluded */
1618 dir
->internal
.basebuf
.buf
[stk
->baselen
- 1] = 0;
1619 dir
->internal
.pattern
= last_matching_pattern_from_lists(dir
,
1621 dir
->internal
.basebuf
.buf
, stk
->baselen
- 1,
1622 dir
->internal
.basebuf
.buf
+ current
, &dt
);
1623 dir
->internal
.basebuf
.buf
[stk
->baselen
- 1] = '/';
1624 if (dir
->internal
.pattern
&&
1625 dir
->internal
.pattern
->flags
& PATTERN_FLAG_NEGATIVE
)
1626 dir
->internal
.pattern
= NULL
;
1627 if (dir
->internal
.pattern
) {
1628 dir
->internal
.exclude_stack
= stk
;
1633 /* Try to read per-directory file */
1634 oidclr(&oid_stat
.oid
);
1636 if (dir
->exclude_per_dir
&&
1638 * If we know that no files have been added in
1639 * this directory (i.e. valid_cached_dir() has
1640 * been executed and set untracked->valid) ..
1642 (!untracked
|| !untracked
->valid
||
1644 * .. and .gitignore does not exist before
1645 * (i.e. null exclude_oid). Then we can skip
1646 * loading .gitignore, which would result in
1649 !is_null_oid(&untracked
->exclude_oid
))) {
1651 * dir->internal.basebuf gets reused by the traversal,
1652 * but we need fname to remain unchanged to ensure the
1653 * src member of each struct path_pattern correctly
1654 * back-references its source file. Other invocations
1655 * of add_pattern_list provide stable strings, so we
1656 * strbuf_detach() and free() here in the caller.
1658 struct strbuf sb
= STRBUF_INIT
;
1659 strbuf_addbuf(&sb
, &dir
->internal
.basebuf
);
1660 strbuf_addstr(&sb
, dir
->exclude_per_dir
);
1661 pl
->src
= strbuf_detach(&sb
, NULL
);
1662 add_patterns(pl
->src
, pl
->src
, stk
->baselen
, pl
, istate
,
1664 untracked
? &oid_stat
: NULL
);
1667 * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1668 * will first be called in valid_cached_dir() then maybe many
1669 * times more in last_matching_pattern(). When the cache is
1670 * used, last_matching_pattern() will not be called and
1671 * reading .gitignore content will be a waste.
1673 * So when it's called by valid_cached_dir() and we can get
1674 * .gitignore SHA-1 from the index (i.e. .gitignore is not
1675 * modified on work tree), we could delay reading the
1676 * .gitignore content until we absolutely need it in
1677 * last_matching_pattern(). Be careful about ignore rule
1678 * order, though, if you do that.
1681 !oideq(&oid_stat
.oid
, &untracked
->exclude_oid
)) {
1682 invalidate_gitignore(dir
->untracked
, untracked
);
1683 oidcpy(&untracked
->exclude_oid
, &oid_stat
.oid
);
1685 dir
->internal
.exclude_stack
= stk
;
1686 current
= stk
->baselen
;
1688 strbuf_setlen(&dir
->internal
.basebuf
, baselen
);
1692 * Loads the exclude lists for the directory containing pathname, then
1693 * scans all exclude lists to determine whether pathname is excluded.
1694 * Returns the exclude_list element which matched, or NULL for
1697 struct path_pattern
*last_matching_pattern(struct dir_struct
*dir
,
1698 struct index_state
*istate
,
1699 const char *pathname
,
1702 int pathlen
= strlen(pathname
);
1703 const char *basename
= strrchr(pathname
, '/');
1704 basename
= (basename
) ? basename
+1 : pathname
;
1706 prep_exclude(dir
, istate
, pathname
, basename
-pathname
);
1708 if (dir
->internal
.pattern
)
1709 return dir
->internal
.pattern
;
1711 return last_matching_pattern_from_lists(dir
, istate
, pathname
, pathlen
,
1716 * Loads the exclude lists for the directory containing pathname, then
1717 * scans all exclude lists to determine whether pathname is excluded.
1718 * Returns 1 if true, otherwise 0.
1720 int is_excluded(struct dir_struct
*dir
, struct index_state
*istate
,
1721 const char *pathname
, int *dtype_p
)
1723 struct path_pattern
*pattern
=
1724 last_matching_pattern(dir
, istate
, pathname
, dtype_p
);
1726 return pattern
->flags
& PATTERN_FLAG_NEGATIVE
? 0 : 1;
1730 static struct dir_entry
*dir_entry_new(const char *pathname
, int len
)
1732 struct dir_entry
*ent
;
1734 FLEX_ALLOC_MEM(ent
, name
, pathname
, len
);
1739 static struct dir_entry
*dir_add_name(struct dir_struct
*dir
,
1740 struct index_state
*istate
,
1741 const char *pathname
, int len
)
1743 if (index_file_exists(istate
, pathname
, len
, ignore_case
))
1746 ALLOC_GROW(dir
->entries
, dir
->nr
+1, dir
->internal
.alloc
);
1747 return dir
->entries
[dir
->nr
++] = dir_entry_new(pathname
, len
);
1750 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
,
1751 struct index_state
*istate
,
1752 const char *pathname
, int len
)
1754 if (!index_name_is_other(istate
, pathname
, len
))
1757 ALLOC_GROW(dir
->ignored
, dir
->ignored_nr
+1, dir
->internal
.ignored_alloc
);
1758 return dir
->ignored
[dir
->ignored_nr
++] = dir_entry_new(pathname
, len
);
1762 index_nonexistent
= 0,
1768 * Do not use the alphabetically sorted index to look up
1769 * the directory name; instead, use the case insensitive
1772 static enum exist_status
directory_exists_in_index_icase(struct index_state
*istate
,
1773 const char *dirname
, int len
)
1775 struct cache_entry
*ce
;
1777 if (index_dir_exists(istate
, dirname
, len
))
1778 return index_directory
;
1780 ce
= index_file_exists(istate
, dirname
, len
, ignore_case
);
1781 if (ce
&& S_ISGITLINK(ce
->ce_mode
))
1782 return index_gitdir
;
1784 return index_nonexistent
;
1788 * The index sorts alphabetically by entry name, which
1789 * means that a gitlink sorts as '\0' at the end, while
1790 * a directory (which is defined not as an entry, but as
1791 * the files it contains) will sort with the '/' at the
1794 static enum exist_status
directory_exists_in_index(struct index_state
*istate
,
1795 const char *dirname
, int len
)
1800 return directory_exists_in_index_icase(istate
, dirname
, len
);
1802 pos
= index_name_pos(istate
, dirname
, len
);
1805 while (pos
< istate
->cache_nr
) {
1806 const struct cache_entry
*ce
= istate
->cache
[pos
++];
1807 unsigned char endchar
;
1809 if (strncmp(ce
->name
, dirname
, len
))
1811 endchar
= ce
->name
[len
];
1815 return index_directory
;
1816 if (!endchar
&& S_ISGITLINK(ce
->ce_mode
))
1817 return index_gitdir
;
1819 return index_nonexistent
;
1823 * When we find a directory when traversing the filesystem, we
1824 * have three distinct cases:
1827 * - see it as a directory
1830 * and which one we choose depends on a combination of existing
1831 * git index contents and the flags passed into the directory
1832 * traversal routine.
1834 * Case 1: If we *already* have entries in the index under that
1835 * directory name, we always recurse into the directory to see
1838 * Case 2: If we *already* have that directory name as a gitlink,
1839 * we always continue to see it as a gitlink, regardless of whether
1840 * there is an actual git directory there or not (it might not
1841 * be checked out as a subproject!)
1843 * Case 3: if we didn't have it in the index previously, we
1844 * have a few sub-cases:
1846 * (a) if DIR_SHOW_OTHER_DIRECTORIES flag is set, we show it as
1847 * just a directory, unless DIR_HIDE_EMPTY_DIRECTORIES is
1848 * also true, in which case we need to check if it contains any
1849 * untracked and / or ignored files.
1850 * (b) if it looks like a git directory and we don't have the
1851 * DIR_NO_GITLINKS flag, then we treat it as a gitlink, and
1852 * show it as a directory.
1853 * (c) otherwise, we recurse into it.
1855 static enum path_treatment
treat_directory(struct dir_struct
*dir
,
1856 struct index_state
*istate
,
1857 struct untracked_cache_dir
*untracked
,
1858 const char *dirname
, int len
, int baselen
, int excluded
,
1859 const struct pathspec
*pathspec
)
1862 * WARNING: From this function, you can return path_recurse or you
1863 * can call read_directory_recursive() (or neither), but
1864 * you CAN'T DO BOTH.
1866 enum path_treatment state
;
1867 int matches_how
= 0;
1868 int check_only
, stop_early
;
1869 int old_ignored_nr
, old_untracked_nr
;
1870 /* The "len-1" is to strip the final '/' */
1871 enum exist_status status
= directory_exists_in_index(istate
, dirname
, len
-1);
1873 if (status
== index_directory
)
1874 return path_recurse
;
1875 if (status
== index_gitdir
)
1877 if (status
!= index_nonexistent
)
1878 BUG("Unhandled value for directory_exists_in_index: %d\n", status
);
1881 * We don't want to descend into paths that don't match the necessary
1882 * patterns. Clearly, if we don't have a pathspec, then we can't check
1883 * for matching patterns. Also, if (excluded) then we know we matched
1884 * the exclusion patterns so as an optimization we can skip checking
1885 * for matching patterns.
1887 if (pathspec
&& !excluded
) {
1888 matches_how
= match_pathspec_with_flags(istate
, pathspec
,
1892 DO_MATCH_LEADING_PATHSPEC
);
1898 if ((dir
->flags
& DIR_SKIP_NESTED_GIT
) ||
1899 !(dir
->flags
& DIR_NO_GITLINKS
)) {
1901 * Determine if `dirname` is a nested repo by confirming that:
1902 * 1) we are in a nonbare repository, and
1903 * 2) `dirname` is not an immediate parent of `the_repository->gitdir`,
1904 * which could occur if the git_dir or worktree location was
1905 * manually configured by the user; see t2205 testcases 1-3 for
1906 * examples where this matters
1909 struct strbuf sb
= STRBUF_INIT
;
1910 strbuf_addstr(&sb
, dirname
);
1911 nested_repo
= is_nonbare_repository_dir(&sb
);
1914 char *real_dirname
, *real_gitdir
;
1915 strbuf_addstr(&sb
, ".git");
1916 real_dirname
= real_pathdup(sb
.buf
, 1);
1917 real_gitdir
= real_pathdup(the_repository
->gitdir
, 1);
1919 nested_repo
= !!strcmp(real_dirname
, real_gitdir
);
1923 strbuf_release(&sb
);
1926 if ((dir
->flags
& DIR_SKIP_NESTED_GIT
) ||
1927 (matches_how
== MATCHED_RECURSIVELY_LEADING_PATHSPEC
))
1929 return excluded
? path_excluded
: path_untracked
;
1933 if (!(dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
)) {
1935 (dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
1936 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
)) {
1939 * This is an excluded directory and we are
1940 * showing ignored paths that match an exclude
1941 * pattern. (e.g. show directory as ignored
1942 * only if it matches an exclude pattern).
1943 * This path will either be 'path_excluded`
1944 * (if we are showing empty directories or if
1945 * the directory is not empty), or will be
1946 * 'path_none' (empty directory, and we are
1947 * not showing empty directories).
1949 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
1950 return path_excluded
;
1952 if (read_directory_recursive(dir
, istate
, dirname
, len
,
1953 untracked
, 1, 1, pathspec
) == path_excluded
)
1954 return path_excluded
;
1958 return path_recurse
;
1961 assert(dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
);
1964 * If we have a pathspec which could match something _below_ this
1965 * directory (e.g. when checking 'subdir/' having a pathspec like
1966 * 'subdir/some/deep/path/file' or 'subdir/widget-*.c'), then we
1969 if (matches_how
== MATCHED_RECURSIVELY_LEADING_PATHSPEC
)
1970 return path_recurse
;
1972 /* Special cases for where this directory is excluded/ignored */
1975 * If DIR_SHOW_OTHER_DIRECTORIES is set and we're not
1976 * hiding empty directories, there is no need to
1977 * recurse into an ignored directory.
1979 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
1980 return path_excluded
;
1983 * Even if we are hiding empty directories, we can still avoid
1984 * recursing into ignored directories for DIR_SHOW_IGNORED_TOO
1985 * if DIR_SHOW_IGNORED_TOO_MODE_MATCHING is also set.
1987 if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
1988 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
))
1989 return path_excluded
;
1993 * Other than the path_recurse case above, we only need to
1994 * recurse into untracked directories if any of the following
1996 * - DIR_SHOW_IGNORED (because then we need to determine if
1997 * there are ignored entries below)
1998 * - DIR_SHOW_IGNORED_TOO (same as above)
1999 * - DIR_HIDE_EMPTY_DIRECTORIES (because we have to determine if
2000 * the directory is empty)
2003 !(dir
->flags
& (DIR_SHOW_IGNORED
|
2004 DIR_SHOW_IGNORED_TOO
|
2005 DIR_HIDE_EMPTY_DIRECTORIES
))) {
2006 return path_untracked
;
2010 * Even if we don't want to know all the paths under an untracked or
2011 * ignored directory, we may still need to go into the directory to
2012 * determine if it is empty (because with DIR_HIDE_EMPTY_DIRECTORIES,
2013 * an empty directory should be path_none instead of path_excluded or
2016 check_only
= ((dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
) &&
2017 !(dir
->flags
& DIR_SHOW_IGNORED_TOO
));
2020 * However, there's another optimization possible as a subset of
2021 * check_only, based on the cases we have to consider:
2022 * A) Directory matches no exclude patterns:
2023 * * Directory is empty => path_none
2024 * * Directory has an untracked file under it => path_untracked
2025 * * Directory has only ignored files under it => path_excluded
2026 * B) Directory matches an exclude pattern:
2027 * * Directory is empty => path_none
2028 * * Directory has an untracked file under it => path_excluded
2029 * * Directory has only ignored files under it => path_excluded
2030 * In case A, we can exit as soon as we've found an untracked
2031 * file but otherwise have to walk all files. In case B, though,
2032 * we can stop at the first file we find under the directory.
2034 stop_early
= check_only
&& excluded
;
2037 * If /every/ file within an untracked directory is ignored, then
2038 * we want to treat the directory as ignored (for e.g. status
2039 * --porcelain), without listing the individual ignored files
2040 * underneath. To do so, we'll save the current ignored_nr, and
2041 * pop all the ones added after it if it turns out the entire
2042 * directory is ignored. Also, when DIR_SHOW_IGNORED_TOO and
2043 * !DIR_KEEP_UNTRACKED_CONTENTS then we don't want to show
2044 * untracked paths so will need to pop all those off the last
2045 * after we traverse.
2047 old_ignored_nr
= dir
->ignored_nr
;
2048 old_untracked_nr
= dir
->nr
;
2050 /* Actually recurse into dirname now, we'll fixup the state later. */
2051 untracked
= lookup_untracked(dir
->untracked
, untracked
,
2052 dirname
+ baselen
, len
- baselen
);
2053 state
= read_directory_recursive(dir
, istate
, dirname
, len
, untracked
,
2054 check_only
, stop_early
, pathspec
);
2056 /* There are a variety of reasons we may need to fixup the state... */
2057 if (state
== path_excluded
) {
2058 /* state == path_excluded implies all paths under
2059 * dirname were ignored...
2061 * if running e.g. `git status --porcelain --ignored=matching`,
2062 * then we want to see the subpaths that are ignored.
2064 * if running e.g. just `git status --porcelain`, then
2065 * we just want the directory itself to be listed as ignored
2066 * and not the individual paths underneath.
2068 int want_ignored_subpaths
=
2069 ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
2070 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
));
2072 if (want_ignored_subpaths
) {
2074 * with --ignored=matching, we want the subpaths
2075 * INSTEAD of the directory itself.
2080 for (i
= old_ignored_nr
+ 1; i
<dir
->ignored_nr
; ++i
)
2081 FREE_AND_NULL(dir
->ignored
[i
]);
2082 dir
->ignored_nr
= old_ignored_nr
;
2087 * We may need to ignore some of the untracked paths we found while
2088 * traversing subdirectories.
2090 if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
2091 !(dir
->flags
& DIR_KEEP_UNTRACKED_CONTENTS
)) {
2093 for (i
= old_untracked_nr
+ 1; i
<dir
->nr
; ++i
)
2094 FREE_AND_NULL(dir
->entries
[i
]);
2095 dir
->nr
= old_untracked_nr
;
2099 * If there is nothing under the current directory and we are not
2100 * hiding empty directories, then we need to report on the
2101 * untracked or ignored status of the directory itself.
2103 if (state
== path_none
&& !(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
2104 state
= excluded
? path_excluded
: path_untracked
;
2110 * This is an inexact early pruning of any recursive directory
2111 * reading - if the path cannot possibly be in the pathspec,
2112 * return true, and we'll skip it early.
2114 static int simplify_away(const char *path
, int pathlen
,
2115 const struct pathspec
*pathspec
)
2119 if (!pathspec
|| !pathspec
->nr
)
2122 GUARD_PATHSPEC(pathspec
,
2131 for (i
= 0; i
< pathspec
->nr
; i
++) {
2132 const struct pathspec_item
*item
= &pathspec
->items
[i
];
2133 int len
= item
->nowildcard_len
;
2137 if (!ps_strncmp(item
, item
->match
, path
, len
))
2145 * This function tells us whether an excluded path matches a
2146 * list of "interesting" pathspecs. That is, whether a path matched
2147 * by any of the pathspecs could possibly be ignored by excluding
2148 * the specified path. This can happen if:
2150 * 1. the path is mentioned explicitly in the pathspec
2152 * 2. the path is a directory prefix of some element in the
2155 static int exclude_matches_pathspec(const char *path
, int pathlen
,
2156 const struct pathspec
*pathspec
)
2160 if (!pathspec
|| !pathspec
->nr
)
2163 GUARD_PATHSPEC(pathspec
,
2171 for (i
= 0; i
< pathspec
->nr
; i
++) {
2172 const struct pathspec_item
*item
= &pathspec
->items
[i
];
2173 int len
= item
->nowildcard_len
;
2175 if (len
== pathlen
&&
2176 !ps_strncmp(item
, item
->match
, path
, pathlen
))
2178 if (len
> pathlen
&&
2179 item
->match
[pathlen
] == '/' &&
2180 !ps_strncmp(item
, item
->match
, path
, pathlen
))
2186 static int get_index_dtype(struct index_state
*istate
,
2187 const char *path
, int len
)
2190 const struct cache_entry
*ce
;
2192 ce
= index_file_exists(istate
, path
, len
, 0);
2194 if (!ce_uptodate(ce
))
2196 if (S_ISGITLINK(ce
->ce_mode
))
2199 * Nobody actually cares about the
2200 * difference between DT_LNK and DT_REG
2205 /* Try to look it up as a directory */
2206 pos
= index_name_pos(istate
, path
, len
);
2210 while (pos
< istate
->cache_nr
) {
2211 ce
= istate
->cache
[pos
++];
2212 if (strncmp(ce
->name
, path
, len
))
2214 if (ce
->name
[len
] > '/')
2216 if (ce
->name
[len
] < '/')
2218 if (!ce_uptodate(ce
))
2219 break; /* continue? */
2225 static int resolve_dtype(int dtype
, struct index_state
*istate
,
2226 const char *path
, int len
)
2230 if (dtype
!= DT_UNKNOWN
)
2232 dtype
= get_index_dtype(istate
, path
, len
);
2233 if (dtype
!= DT_UNKNOWN
)
2235 if (lstat(path
, &st
))
2237 if (S_ISREG(st
.st_mode
))
2239 if (S_ISDIR(st
.st_mode
))
2241 if (S_ISLNK(st
.st_mode
))
2246 static enum path_treatment
treat_path_fast(struct dir_struct
*dir
,
2247 struct cached_dir
*cdir
,
2248 struct index_state
*istate
,
2249 struct strbuf
*path
,
2251 const struct pathspec
*pathspec
)
2254 * WARNING: From this function, you can return path_recurse or you
2255 * can call read_directory_recursive() (or neither), but
2256 * you CAN'T DO BOTH.
2258 strbuf_setlen(path
, baselen
);
2260 strbuf_addstr(path
, cdir
->file
);
2261 return path_untracked
;
2263 strbuf_addstr(path
, cdir
->ucd
->name
);
2264 /* treat_one_path() does this before it calls treat_directory() */
2265 strbuf_complete(path
, '/');
2266 if (cdir
->ucd
->check_only
)
2268 * check_only is set as a result of treat_directory() getting
2269 * to its bottom. Verify again the same set of directories
2270 * with check_only set.
2272 return read_directory_recursive(dir
, istate
, path
->buf
, path
->len
,
2273 cdir
->ucd
, 1, 0, pathspec
);
2275 * We get path_recurse in the first run when
2276 * directory_exists_in_index() returns index_nonexistent. We
2277 * are sure that new changes in the index does not impact the
2278 * outcome. Return now.
2280 return path_recurse
;
2283 static enum path_treatment
treat_path(struct dir_struct
*dir
,
2284 struct untracked_cache_dir
*untracked
,
2285 struct cached_dir
*cdir
,
2286 struct index_state
*istate
,
2287 struct strbuf
*path
,
2289 const struct pathspec
*pathspec
)
2291 int has_path_in_index
, dtype
, excluded
;
2294 return treat_path_fast(dir
, cdir
, istate
, path
,
2296 if (is_dot_or_dotdot(cdir
->d_name
) || !fspathcmp(cdir
->d_name
, ".git"))
2298 strbuf_setlen(path
, baselen
);
2299 strbuf_addstr(path
, cdir
->d_name
);
2300 if (simplify_away(path
->buf
, path
->len
, pathspec
))
2303 dtype
= resolve_dtype(cdir
->d_type
, istate
, path
->buf
, path
->len
);
2305 /* Always exclude indexed files */
2306 has_path_in_index
= !!index_file_exists(istate
, path
->buf
, path
->len
,
2308 if (dtype
!= DT_DIR
&& has_path_in_index
)
2312 * When we are looking at a directory P in the working tree,
2313 * there are three cases:
2315 * (1) P exists in the index. Everything inside the directory P in
2316 * the working tree needs to go when P is checked out from the
2319 * (2) P does not exist in the index, but there is P/Q in the index.
2320 * We know P will stay a directory when we check out the contents
2321 * of the index, but we do not know yet if there is a directory
2322 * P/Q in the working tree to be killed, so we need to recurse.
2324 * (3) P does not exist in the index, and there is no P/Q in the index
2325 * to require P to be a directory, either. Only in this case, we
2326 * know that everything inside P will not be killed without
2329 if ((dir
->flags
& DIR_COLLECT_KILLED_ONLY
) &&
2330 (dtype
== DT_DIR
) &&
2331 !has_path_in_index
&&
2332 (directory_exists_in_index(istate
, path
->buf
, path
->len
) == index_nonexistent
))
2335 excluded
= is_excluded(dir
, istate
, path
->buf
, &dtype
);
2338 * Excluded? If we don't explicitly want to show
2339 * ignored files, ignore it
2341 if (excluded
&& !(dir
->flags
& (DIR_SHOW_IGNORED
|DIR_SHOW_IGNORED_TOO
)))
2342 return path_excluded
;
2349 * WARNING: Do not ignore/amend the return value from
2350 * treat_directory(), and especially do not change it to return
2351 * path_recurse as that can cause exponential slowdown.
2352 * Instead, modify treat_directory() to return the right value.
2354 strbuf_addch(path
, '/');
2355 return treat_directory(dir
, istate
, untracked
,
2356 path
->buf
, path
->len
,
2357 baselen
, excluded
, pathspec
);
2361 !match_pathspec(istate
, pathspec
, path
->buf
, path
->len
,
2362 0 /* prefix */, NULL
/* seen */,
2366 return path_excluded
;
2367 return path_untracked
;
2371 static void add_untracked(struct untracked_cache_dir
*dir
, const char *name
)
2375 ALLOC_GROW(dir
->untracked
, dir
->untracked_nr
+ 1,
2376 dir
->untracked_alloc
);
2377 dir
->untracked
[dir
->untracked_nr
++] = xstrdup(name
);
2380 static int valid_cached_dir(struct dir_struct
*dir
,
2381 struct untracked_cache_dir
*untracked
,
2382 struct index_state
*istate
,
2383 struct strbuf
*path
,
2392 * With fsmonitor, we can trust the untracked cache's valid field.
2394 refresh_fsmonitor(istate
);
2395 if (!(dir
->untracked
->use_fsmonitor
&& untracked
->valid
)) {
2396 if (lstat(path
->len
? path
->buf
: ".", &st
)) {
2397 memset(&untracked
->stat_data
, 0, sizeof(untracked
->stat_data
));
2400 if (!untracked
->valid
||
2401 match_stat_data_racy(istate
, &untracked
->stat_data
, &st
)) {
2402 fill_stat_data(&untracked
->stat_data
, &st
);
2407 if (untracked
->check_only
!= !!check_only
)
2411 * prep_exclude will be called eventually on this directory,
2412 * but it's called much later in last_matching_pattern(). We
2413 * need it now to determine the validity of the cache for this
2414 * path. The next calls will be nearly no-op, the way
2415 * prep_exclude() is designed.
2417 if (path
->len
&& path
->buf
[path
->len
- 1] != '/') {
2418 strbuf_addch(path
, '/');
2419 prep_exclude(dir
, istate
, path
->buf
, path
->len
);
2420 strbuf_setlen(path
, path
->len
- 1);
2422 prep_exclude(dir
, istate
, path
->buf
, path
->len
);
2424 /* hopefully prep_exclude() haven't invalidated this entry... */
2425 return untracked
->valid
;
2428 static int open_cached_dir(struct cached_dir
*cdir
,
2429 struct dir_struct
*dir
,
2430 struct untracked_cache_dir
*untracked
,
2431 struct index_state
*istate
,
2432 struct strbuf
*path
,
2437 memset(cdir
, 0, sizeof(*cdir
));
2438 cdir
->untracked
= untracked
;
2439 if (valid_cached_dir(dir
, untracked
, istate
, path
, check_only
))
2441 c_path
= path
->len
? path
->buf
: ".";
2442 cdir
->fdir
= opendir(c_path
);
2444 warning_errno(_("could not open directory '%s'"), c_path
);
2445 if (dir
->untracked
) {
2446 invalidate_directory(dir
->untracked
, untracked
);
2447 dir
->untracked
->dir_opened
++;
2454 static int read_cached_dir(struct cached_dir
*cdir
)
2459 de
= readdir_skip_dot_and_dotdot(cdir
->fdir
);
2461 cdir
->d_name
= NULL
;
2462 cdir
->d_type
= DT_UNKNOWN
;
2465 cdir
->d_name
= de
->d_name
;
2466 cdir
->d_type
= DTYPE(de
);
2469 while (cdir
->nr_dirs
< cdir
->untracked
->dirs_nr
) {
2470 struct untracked_cache_dir
*d
= cdir
->untracked
->dirs
[cdir
->nr_dirs
];
2480 if (cdir
->nr_files
< cdir
->untracked
->untracked_nr
) {
2481 struct untracked_cache_dir
*d
= cdir
->untracked
;
2482 cdir
->file
= d
->untracked
[cdir
->nr_files
++];
2488 static void close_cached_dir(struct cached_dir
*cdir
)
2491 closedir(cdir
->fdir
);
2493 * We have gone through this directory and found no untracked
2494 * entries. Mark it valid.
2496 if (cdir
->untracked
) {
2497 cdir
->untracked
->valid
= 1;
2498 cdir
->untracked
->recurse
= 1;
2502 static void add_path_to_appropriate_result_list(struct dir_struct
*dir
,
2503 struct untracked_cache_dir
*untracked
,
2504 struct cached_dir
*cdir
,
2505 struct index_state
*istate
,
2506 struct strbuf
*path
,
2508 const struct pathspec
*pathspec
,
2509 enum path_treatment state
)
2511 /* add the path to the appropriate result list */
2514 if (dir
->flags
& DIR_SHOW_IGNORED
)
2515 dir_add_name(dir
, istate
, path
->buf
, path
->len
);
2516 else if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) ||
2517 ((dir
->flags
& DIR_COLLECT_IGNORED
) &&
2518 exclude_matches_pathspec(path
->buf
, path
->len
,
2520 dir_add_ignored(dir
, istate
, path
->buf
, path
->len
);
2523 case path_untracked
:
2524 if (dir
->flags
& DIR_SHOW_IGNORED
)
2526 dir_add_name(dir
, istate
, path
->buf
, path
->len
);
2528 add_untracked(untracked
, path
->buf
+ baselen
);
2537 * Read a directory tree. We currently ignore anything but
2538 * directories, regular files and symlinks. That's because git
2539 * doesn't handle them at all yet. Maybe that will change some
2542 * Also, we ignore the name ".git" (even if it is not a directory).
2543 * That likely will not change.
2545 * If 'stop_at_first_file' is specified, 'path_excluded' is returned
2546 * to signal that a file was found. This is the least significant value that
2547 * indicates that a file was encountered that does not depend on the order of
2548 * whether an untracked or excluded path was encountered first.
2550 * Returns the most significant path_treatment value encountered in the scan.
2551 * If 'stop_at_first_file' is specified, `path_excluded` is the most
2552 * significant path_treatment value that will be returned.
2555 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
2556 struct index_state
*istate
, const char *base
, int baselen
,
2557 struct untracked_cache_dir
*untracked
, int check_only
,
2558 int stop_at_first_file
, const struct pathspec
*pathspec
)
2561 * WARNING: Do NOT recurse unless path_recurse is returned from
2562 * treat_path(). Recursing on any other return value
2563 * can result in exponential slowdown.
2565 struct cached_dir cdir
;
2566 enum path_treatment state
, subdir_state
, dir_state
= path_none
;
2567 struct strbuf path
= STRBUF_INIT
;
2569 strbuf_add(&path
, base
, baselen
);
2571 if (open_cached_dir(&cdir
, dir
, untracked
, istate
, &path
, check_only
))
2573 dir
->internal
.visited_directories
++;
2576 untracked
->check_only
= !!check_only
;
2578 while (!read_cached_dir(&cdir
)) {
2579 /* check how the file or directory should be treated */
2580 state
= treat_path(dir
, untracked
, &cdir
, istate
, &path
,
2582 dir
->internal
.visited_paths
++;
2584 if (state
> dir_state
)
2587 /* recurse into subdir if instructed by treat_path */
2588 if (state
== path_recurse
) {
2589 struct untracked_cache_dir
*ud
;
2590 ud
= lookup_untracked(dir
->untracked
,
2593 path
.len
- baselen
);
2595 read_directory_recursive(dir
, istate
, path
.buf
,
2597 check_only
, stop_at_first_file
, pathspec
);
2598 if (subdir_state
> dir_state
)
2599 dir_state
= subdir_state
;
2602 !match_pathspec(istate
, pathspec
, path
.buf
, path
.len
,
2603 0 /* prefix */, NULL
,
2604 0 /* do NOT special case dirs */))
2609 if (stop_at_first_file
) {
2611 * If stopping at first file, then
2612 * signal that a file was found by
2613 * returning `path_excluded`. This is
2614 * to return a consistent value
2615 * regardless of whether an ignored or
2616 * excluded file happened to be
2619 * In current usage, the
2620 * `stop_at_first_file` is passed when
2621 * an ancestor directory has matched
2622 * an exclude pattern, so any found
2623 * files will be excluded.
2625 if (dir_state
>= path_excluded
) {
2626 dir_state
= path_excluded
;
2631 /* abort early if maximum state has been reached */
2632 if (dir_state
== path_untracked
) {
2634 add_untracked(untracked
, path
.buf
+ baselen
);
2637 /* skip the add_path_to_appropriate_result_list() */
2641 add_path_to_appropriate_result_list(dir
, untracked
, &cdir
,
2642 istate
, &path
, baselen
,
2645 close_cached_dir(&cdir
);
2647 strbuf_release(&path
);
2652 int cmp_dir_entry(const void *p1
, const void *p2
)
2654 const struct dir_entry
*e1
= *(const struct dir_entry
**)p1
;
2655 const struct dir_entry
*e2
= *(const struct dir_entry
**)p2
;
2657 return name_compare(e1
->name
, e1
->len
, e2
->name
, e2
->len
);
2660 /* check if *out lexically strictly contains *in */
2661 int check_dir_entry_contains(const struct dir_entry
*out
, const struct dir_entry
*in
)
2663 return (out
->len
< in
->len
) &&
2664 (out
->name
[out
->len
- 1] == '/') &&
2665 !memcmp(out
->name
, in
->name
, out
->len
);
2668 static int treat_leading_path(struct dir_struct
*dir
,
2669 struct index_state
*istate
,
2670 const char *path
, int len
,
2671 const struct pathspec
*pathspec
)
2673 struct strbuf sb
= STRBUF_INIT
;
2674 struct strbuf subdir
= STRBUF_INIT
;
2675 int prevlen
, baselen
;
2677 struct cached_dir cdir
;
2678 enum path_treatment state
= path_none
;
2681 * For each directory component of path, we are going to check whether
2682 * that path is relevant given the pathspec. For example, if path is
2684 * then we will ask treat_path() whether we should go into foo, then
2685 * whether we should go into bar, then whether baz is relevant.
2686 * Checking each is important because e.g. if path is
2688 * then we need to check .git to know we shouldn't traverse it.
2689 * If the return from treat_path() is:
2690 * * path_none, for any path, we return false.
2691 * * path_recurse, for all path components, we return true
2692 * * <anything else> for some intermediate component, we make sure
2693 * to add that path to the relevant list but return false
2694 * signifying that we shouldn't recurse into it.
2697 while (len
&& path
[len
- 1] == '/')
2702 memset(&cdir
, 0, sizeof(cdir
));
2703 cdir
.d_type
= DT_DIR
;
2707 prevlen
= baselen
+ !!baselen
;
2708 cp
= path
+ prevlen
;
2709 cp
= memchr(cp
, '/', path
+ len
- cp
);
2713 baselen
= cp
- path
;
2715 strbuf_add(&sb
, path
, baselen
);
2716 if (!is_directory(sb
.buf
))
2719 strbuf_add(&sb
, path
, prevlen
);
2720 strbuf_reset(&subdir
);
2721 strbuf_add(&subdir
, path
+prevlen
, baselen
-prevlen
);
2722 cdir
.d_name
= subdir
.buf
;
2723 state
= treat_path(dir
, NULL
, &cdir
, istate
, &sb
, prevlen
, pathspec
);
2725 if (state
!= path_recurse
)
2726 break; /* do not recurse into it */
2728 break; /* finished checking */
2730 add_path_to_appropriate_result_list(dir
, NULL
, &cdir
, istate
,
2731 &sb
, baselen
, pathspec
,
2734 strbuf_release(&subdir
);
2735 strbuf_release(&sb
);
2736 return state
== path_recurse
;
2739 static const char *get_ident_string(void)
2741 static struct strbuf sb
= STRBUF_INIT
;
2746 if (uname(&uts
) < 0)
2747 die_errno(_("failed to get kernel name and information"));
2748 strbuf_addf(&sb
, "Location %s, system %s", get_git_work_tree(),
2753 static int ident_in_untracked(const struct untracked_cache
*uc
)
2756 * Previous git versions may have saved many NUL separated
2757 * strings in the "ident" field, but it is insane to manage
2758 * many locations, so just take care of the first one.
2761 return !strcmp(uc
->ident
.buf
, get_ident_string());
2764 static void set_untracked_ident(struct untracked_cache
*uc
)
2766 strbuf_reset(&uc
->ident
);
2767 strbuf_addstr(&uc
->ident
, get_ident_string());
2770 * This strbuf used to contain a list of NUL separated
2771 * strings, so save NUL too for backward compatibility.
2773 strbuf_addch(&uc
->ident
, 0);
2776 static unsigned new_untracked_cache_flags(struct index_state
*istate
)
2778 struct repository
*repo
= istate
->repo
;
2782 * This logic is coordinated with the setting of these flags in
2783 * wt-status.c#wt_status_collect_untracked(), and the evaluation
2784 * of the config setting in commit.c#git_status_config()
2786 if (!repo_config_get_string(repo
, "status.showuntrackedfiles", &val
) &&
2787 !strcmp(val
, "all"))
2791 * The default, if "all" is not set, is "normal" - leading us here.
2792 * If the value is "none" then it really doesn't matter.
2794 return DIR_SHOW_OTHER_DIRECTORIES
| DIR_HIDE_EMPTY_DIRECTORIES
;
2797 static void new_untracked_cache(struct index_state
*istate
, int flags
)
2799 struct untracked_cache
*uc
= xcalloc(1, sizeof(*uc
));
2800 strbuf_init(&uc
->ident
, 100);
2801 uc
->exclude_per_dir
= ".gitignore";
2802 uc
->dir_flags
= flags
>= 0 ? flags
: new_untracked_cache_flags(istate
);
2803 set_untracked_ident(uc
);
2804 istate
->untracked
= uc
;
2805 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2808 void add_untracked_cache(struct index_state
*istate
)
2810 if (!istate
->untracked
) {
2811 new_untracked_cache(istate
, -1);
2813 if (!ident_in_untracked(istate
->untracked
)) {
2814 free_untracked_cache(istate
->untracked
);
2815 new_untracked_cache(istate
, -1);
2820 void remove_untracked_cache(struct index_state
*istate
)
2822 if (istate
->untracked
) {
2823 free_untracked_cache(istate
->untracked
);
2824 istate
->untracked
= NULL
;
2825 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2829 static struct untracked_cache_dir
*validate_untracked_cache(struct dir_struct
*dir
,
2831 const struct pathspec
*pathspec
,
2832 struct index_state
*istate
)
2834 struct untracked_cache_dir
*root
;
2835 static int untracked_cache_disabled
= -1;
2837 if (!dir
->untracked
)
2839 if (untracked_cache_disabled
< 0)
2840 untracked_cache_disabled
= git_env_bool("GIT_DISABLE_UNTRACKED_CACHE", 0);
2841 if (untracked_cache_disabled
)
2845 * We only support $GIT_DIR/info/exclude and core.excludesfile
2846 * as the global ignore rule files. Any other additions
2847 * (e.g. from command line) invalidate the cache. This
2848 * condition also catches running setup_standard_excludes()
2849 * before setting dir->untracked!
2851 if (dir
->internal
.unmanaged_exclude_files
)
2855 * Optimize for the main use case only: whole-tree git
2856 * status. More work involved in treat_leading_path() if we
2857 * use cache on just a subset of the worktree. pathspec
2858 * support could make the matter even worse.
2860 if (base_len
|| (pathspec
&& pathspec
->nr
))
2863 /* We don't support collecting ignore files */
2864 if (dir
->flags
& (DIR_SHOW_IGNORED
| DIR_SHOW_IGNORED_TOO
|
2865 DIR_COLLECT_IGNORED
))
2869 * If we use .gitignore in the cache and now you change it to
2870 * .gitexclude, everything will go wrong.
2872 if (dir
->exclude_per_dir
!= dir
->untracked
->exclude_per_dir
&&
2873 strcmp(dir
->exclude_per_dir
, dir
->untracked
->exclude_per_dir
))
2877 * EXC_CMDL is not considered in the cache. If people set it,
2880 if (dir
->internal
.exclude_list_group
[EXC_CMDL
].nr
)
2883 if (!ident_in_untracked(dir
->untracked
)) {
2884 warning(_("untracked cache is disabled on this system or location"));
2889 * If the untracked structure we received does not have the same flags
2890 * as requested in this run, we're going to need to either discard the
2891 * existing structure (and potentially later recreate), or bypass the
2892 * untracked cache mechanism for this run.
2894 if (dir
->flags
!= dir
->untracked
->dir_flags
) {
2896 * If the untracked structure we received does not have the same flags
2897 * as configured, then we need to reset / create a new "untracked"
2898 * structure to match the new config.
2900 * Keeping the saved and used untracked cache consistent with the
2901 * configuration provides an opportunity for frequent users of
2902 * "git status -uall" to leverage the untracked cache by aligning their
2903 * configuration - setting "status.showuntrackedfiles" to "all" or
2904 * "normal" as appropriate.
2906 * Previously using -uall (or setting "status.showuntrackedfiles" to
2907 * "all") was incompatible with untracked cache and *consistently*
2908 * caused surprisingly bad performance (with fscache and fsmonitor
2909 * enabled) on Windows.
2911 * IMPROVEMENT OPPORTUNITY: If we reworked the untracked cache storage
2912 * to not be as bound up with the desired output in a given run,
2913 * and instead iterated through and stored enough information to
2914 * correctly serve both "modes", then users could get peak performance
2915 * with or without '-uall' regardless of their
2916 * "status.showuntrackedfiles" config.
2918 if (dir
->untracked
->dir_flags
!= new_untracked_cache_flags(istate
)) {
2919 free_untracked_cache(istate
->untracked
);
2920 new_untracked_cache(istate
, dir
->flags
);
2921 dir
->untracked
= istate
->untracked
;
2925 * Current untracked cache data is consistent with config, but not
2926 * usable in this request/run; just bypass untracked cache.
2932 if (!dir
->untracked
->root
) {
2933 /* Untracked cache existed but is not initialized; fix that */
2934 FLEX_ALLOC_STR(dir
->untracked
->root
, name
, "");
2935 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2938 /* Validate $GIT_DIR/info/exclude and core.excludesfile */
2939 root
= dir
->untracked
->root
;
2940 if (!oideq(&dir
->internal
.ss_info_exclude
.oid
,
2941 &dir
->untracked
->ss_info_exclude
.oid
)) {
2942 invalidate_gitignore(dir
->untracked
, root
);
2943 dir
->untracked
->ss_info_exclude
= dir
->internal
.ss_info_exclude
;
2945 if (!oideq(&dir
->internal
.ss_excludes_file
.oid
,
2946 &dir
->untracked
->ss_excludes_file
.oid
)) {
2947 invalidate_gitignore(dir
->untracked
, root
);
2948 dir
->untracked
->ss_excludes_file
= dir
->internal
.ss_excludes_file
;
2951 /* Make sure this directory is not dropped out at saving phase */
2956 static void emit_traversal_statistics(struct dir_struct
*dir
,
2957 struct repository
*repo
,
2961 if (!trace2_is_enabled())
2965 trace2_data_string("read_directory", repo
, "path", "");
2967 struct strbuf tmp
= STRBUF_INIT
;
2968 strbuf_add(&tmp
, path
, path_len
);
2969 trace2_data_string("read_directory", repo
, "path", tmp
.buf
);
2970 strbuf_release(&tmp
);
2973 trace2_data_intmax("read_directory", repo
,
2974 "directories-visited", dir
->internal
.visited_directories
);
2975 trace2_data_intmax("read_directory", repo
,
2976 "paths-visited", dir
->internal
.visited_paths
);
2978 if (!dir
->untracked
)
2980 trace2_data_intmax("read_directory", repo
,
2981 "node-creation", dir
->untracked
->dir_created
);
2982 trace2_data_intmax("read_directory", repo
,
2983 "gitignore-invalidation",
2984 dir
->untracked
->gitignore_invalidated
);
2985 trace2_data_intmax("read_directory", repo
,
2986 "directory-invalidation",
2987 dir
->untracked
->dir_invalidated
);
2988 trace2_data_intmax("read_directory", repo
,
2989 "opendir", dir
->untracked
->dir_opened
);
2992 int read_directory(struct dir_struct
*dir
, struct index_state
*istate
,
2993 const char *path
, int len
, const struct pathspec
*pathspec
)
2995 struct untracked_cache_dir
*untracked
;
2997 trace2_region_enter("dir", "read_directory", istate
->repo
);
2998 dir
->internal
.visited_paths
= 0;
2999 dir
->internal
.visited_directories
= 0;
3001 if (has_symlink_leading_path(path
, len
)) {
3002 trace2_region_leave("dir", "read_directory", istate
->repo
);
3006 untracked
= validate_untracked_cache(dir
, len
, pathspec
, istate
);
3009 * make sure untracked cache code path is disabled,
3010 * e.g. prep_exclude()
3012 dir
->untracked
= NULL
;
3013 if (!len
|| treat_leading_path(dir
, istate
, path
, len
, pathspec
))
3014 read_directory_recursive(dir
, istate
, path
, len
, untracked
, 0, 0, pathspec
);
3015 QSORT(dir
->entries
, dir
->nr
, cmp_dir_entry
);
3016 QSORT(dir
->ignored
, dir
->ignored_nr
, cmp_dir_entry
);
3018 emit_traversal_statistics(dir
, istate
->repo
, path
, len
);
3020 trace2_region_leave("dir", "read_directory", istate
->repo
);
3021 if (dir
->untracked
) {
3022 static int force_untracked_cache
= -1;
3024 if (force_untracked_cache
< 0)
3025 force_untracked_cache
=
3026 git_env_bool("GIT_FORCE_UNTRACKED_CACHE", -1);
3027 if (force_untracked_cache
< 0)
3028 force_untracked_cache
= (istate
->repo
->settings
.core_untracked_cache
== UNTRACKED_CACHE_WRITE
);
3029 if (force_untracked_cache
&&
3030 dir
->untracked
== istate
->untracked
&&
3031 (dir
->untracked
->dir_opened
||
3032 dir
->untracked
->gitignore_invalidated
||
3033 dir
->untracked
->dir_invalidated
))
3034 istate
->cache_changed
|= UNTRACKED_CHANGED
;
3035 if (dir
->untracked
!= istate
->untracked
) {
3036 FREE_AND_NULL(dir
->untracked
);
3043 int file_exists(const char *f
)
3046 return lstat(f
, &sb
) == 0;
3049 int repo_file_exists(struct repository
*repo
, const char *path
)
3051 if (repo
!= the_repository
)
3052 BUG("do not know how to check file existence in arbitrary repo");
3054 return file_exists(path
);
3057 static int cmp_icase(char a
, char b
)
3062 return toupper(a
) - toupper(b
);
3067 * Given two normalized paths (a trailing slash is ok), if subdir is
3068 * outside dir, return -1. Otherwise return the offset in subdir that
3069 * can be used as relative path to dir.
3071 int dir_inside_of(const char *subdir
, const char *dir
)
3075 assert(dir
&& subdir
&& *dir
&& *subdir
);
3077 while (*dir
&& *subdir
&& !cmp_icase(*dir
, *subdir
)) {
3083 /* hel[p]/me vs hel[l]/yeah */
3084 if (*dir
&& *subdir
)
3088 return !*dir
? offset
: -1; /* same dir */
3090 /* foo/[b]ar vs foo/[] */
3091 if (is_dir_sep(dir
[-1]))
3092 return is_dir_sep(subdir
[-1]) ? offset
: -1;
3094 /* foo[/]bar vs foo[] */
3095 return is_dir_sep(*subdir
) ? offset
+ 1 : -1;
3098 int is_inside_dir(const char *dir
)
3107 rc
= (dir_inside_of(cwd
, dir
) >= 0);
3112 int is_empty_dir(const char *path
)
3114 DIR *dir
= opendir(path
);
3121 e
= readdir_skip_dot_and_dotdot(dir
);
3129 char *git_url_basename(const char *repo
, int is_bundle
, int is_bare
)
3131 const char *end
= repo
+ strlen(repo
), *start
, *ptr
;
3138 start
= strstr(repo
, "://");
3145 * Skip authentication data. The stripping does happen
3146 * greedily, such that we strip up to the last '@' inside
3149 for (ptr
= start
; ptr
< end
&& !is_dir_sep(*ptr
); ptr
++) {
3155 * Strip trailing spaces, slashes and /.git
3157 while (start
< end
&& (is_dir_sep(end
[-1]) || isspace(end
[-1])))
3159 if (end
- start
> 5 && is_dir_sep(end
[-5]) &&
3160 !strncmp(end
- 4, ".git", 4)) {
3162 while (start
< end
&& is_dir_sep(end
[-1]))
3167 * It should not be possible to overflow `ptrdiff_t` by passing in an
3168 * insanely long URL, but GCC does not know that and will complain
3169 * without this check.
3171 if (end
- start
< 0)
3172 die(_("No directory name could be guessed.\n"
3173 "Please specify a directory on the command line"));
3176 * Strip trailing port number if we've got only a
3177 * hostname (that is, there is no dir separator but a
3178 * colon). This check is required such that we do not
3179 * strip URI's like '/foo/bar:2222.git', which should
3180 * result in a dir '2222' being guessed due to backwards
3183 if (memchr(start
, '/', end
- start
) == NULL
3184 && memchr(start
, ':', end
- start
) != NULL
) {
3186 while (start
< ptr
&& isdigit(ptr
[-1]) && ptr
[-1] != ':')
3188 if (start
< ptr
&& ptr
[-1] == ':')
3193 * Find last component. To remain backwards compatible we
3194 * also regard colons as path separators, such that
3195 * cloning a repository 'foo:bar.git' would result in a
3196 * directory 'bar' being guessed.
3199 while (start
< ptr
&& !is_dir_sep(ptr
[-1]) && ptr
[-1] != ':')
3204 * Strip .{bundle,git}.
3207 strip_suffix_mem(start
, &len
, is_bundle
? ".bundle" : ".git");
3209 if (!len
|| (len
== 1 && *start
== '/'))
3210 die(_("No directory name could be guessed.\n"
3211 "Please specify a directory on the command line"));
3214 dir
= xstrfmt("%.*s.git", (int)len
, start
);
3216 dir
= xstrndup(start
, len
);
3218 * Replace sequences of 'control' characters and whitespace
3219 * with one ascii space, remove leading and trailing spaces.
3223 int prev_space
= 1 /* strip leading whitespace */;
3224 for (end
= dir
; *end
; ++end
) {
3226 if ((unsigned char)ch
< '\x20')
3237 if (out
> dir
&& prev_space
)
3243 void strip_dir_trailing_slashes(char *dir
)
3245 char *end
= dir
+ strlen(dir
);
3247 while (dir
< end
- 1 && is_dir_sep(end
[-1]))
3252 static int remove_dir_recurse(struct strbuf
*path
, int flag
, int *kept_up
)
3256 int ret
= 0, original_len
= path
->len
, len
, kept_down
= 0;
3257 int only_empty
= (flag
& REMOVE_DIR_EMPTY_ONLY
);
3258 int keep_toplevel
= (flag
& REMOVE_DIR_KEEP_TOPLEVEL
);
3259 int purge_original_cwd
= (flag
& REMOVE_DIR_PURGE_ORIGINAL_CWD
);
3260 struct object_id submodule_head
;
3262 if ((flag
& REMOVE_DIR_KEEP_NESTED_GIT
) &&
3263 !resolve_gitlink_ref(path
->buf
, "HEAD", &submodule_head
)) {
3264 /* Do not descend and nuke a nested git work tree. */
3270 flag
&= ~REMOVE_DIR_KEEP_TOPLEVEL
;
3271 dir
= opendir(path
->buf
);
3273 if (errno
== ENOENT
)
3274 return keep_toplevel
? -1 : 0;
3275 else if (errno
== EACCES
&& !keep_toplevel
)
3277 * An empty dir could be removable even if it
3280 return rmdir(path
->buf
);
3284 strbuf_complete(path
, '/');
3287 while ((e
= readdir_skip_dot_and_dotdot(dir
)) != NULL
) {
3290 strbuf_setlen(path
, len
);
3291 strbuf_addstr(path
, e
->d_name
);
3292 if (lstat(path
->buf
, &st
)) {
3293 if (errno
== ENOENT
)
3295 * file disappeared, which is what we
3300 } else if (S_ISDIR(st
.st_mode
)) {
3301 if (!remove_dir_recurse(path
, flag
, &kept_down
))
3302 continue; /* happy */
3303 } else if (!only_empty
&&
3304 (!unlink(path
->buf
) || errno
== ENOENT
)) {
3305 continue; /* happy, too */
3308 /* path too long, stat fails, or non-directory still exists */
3314 strbuf_setlen(path
, original_len
);
3315 if (!ret
&& !keep_toplevel
&& !kept_down
) {
3316 if (!purge_original_cwd
&&
3317 startup_info
->original_cwd
&&
3318 !strcmp(startup_info
->original_cwd
, path
->buf
))
3319 ret
= -1; /* Do not remove current working directory */
3321 ret
= (!rmdir(path
->buf
) || errno
== ENOENT
) ? 0 : -1;
3324 * report the uplevel that it is not an error that we
3325 * did not rmdir() our directory.
3331 int remove_dir_recursively(struct strbuf
*path
, int flag
)
3333 return remove_dir_recurse(path
, flag
, NULL
);
3336 static GIT_PATH_FUNC(git_path_info_exclude
, "info/exclude")
3338 void setup_standard_excludes(struct dir_struct
*dir
)
3340 dir
->exclude_per_dir
= ".gitignore";
3342 /* core.excludesfile defaulting to $XDG_CONFIG_HOME/git/ignore */
3344 excludes_file
= xdg_config_home("ignore");
3345 if (excludes_file
&& !access_or_warn(excludes_file
, R_OK
, 0))
3346 add_patterns_from_file_1(dir
, excludes_file
,
3347 dir
->untracked
? &dir
->internal
.ss_excludes_file
: NULL
);
3349 /* per repository user preference */
3350 if (startup_info
->have_repository
) {
3351 const char *path
= git_path_info_exclude();
3352 if (!access_or_warn(path
, R_OK
, 0))
3353 add_patterns_from_file_1(dir
, path
,
3354 dir
->untracked
? &dir
->internal
.ss_info_exclude
: NULL
);
3358 char *get_sparse_checkout_filename(void)
3360 return git_pathdup("info/sparse-checkout");
3363 int get_sparse_checkout_patterns(struct pattern_list
*pl
)
3366 char *sparse_filename
= get_sparse_checkout_filename();
3368 pl
->use_cone_patterns
= core_sparse_checkout_cone
;
3369 res
= add_patterns_from_file_to_list(sparse_filename
, "", 0, pl
, NULL
, 0);
3371 free(sparse_filename
);
3375 int remove_path(const char *name
)
3379 if (unlink(name
) && !is_missing_file_error(errno
))
3382 slash
= strrchr(name
, '/');
3384 char *dirs
= xstrdup(name
);
3385 slash
= dirs
+ (slash
- name
);
3388 if (startup_info
->original_cwd
&&
3389 !strcmp(startup_info
->original_cwd
, dirs
))
3391 } while (rmdir(dirs
) == 0 && (slash
= strrchr(dirs
, '/')));
3398 * Frees memory within dir which was allocated, and resets fields for further
3399 * use. Does not free dir itself.
3401 void dir_clear(struct dir_struct
*dir
)
3404 struct exclude_list_group
*group
;
3405 struct pattern_list
*pl
;
3406 struct exclude_stack
*stk
;
3407 struct dir_struct
new = DIR_INIT
;
3409 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
3410 group
= &dir
->internal
.exclude_list_group
[i
];
3411 for (j
= 0; j
< group
->nr
; j
++) {
3414 free((char *)pl
->src
);
3415 clear_pattern_list(pl
);
3420 for (i
= 0; i
< dir
->ignored_nr
; i
++)
3421 free(dir
->ignored
[i
]);
3422 for (i
= 0; i
< dir
->nr
; i
++)
3423 free(dir
->entries
[i
]);
3427 stk
= dir
->internal
.exclude_stack
;
3429 struct exclude_stack
*prev
= stk
->prev
;
3433 strbuf_release(&dir
->internal
.basebuf
);
3435 memcpy(dir
, &new, sizeof(*dir
));
3438 struct ondisk_untracked_cache
{
3439 struct stat_data info_exclude_stat
;
3440 struct stat_data excludes_file_stat
;
3444 #define ouc_offset(x) offsetof(struct ondisk_untracked_cache, x)
3447 int index
; /* number of written untracked_cache_dir */
3448 struct ewah_bitmap
*check_only
; /* from untracked_cache_dir */
3449 struct ewah_bitmap
*valid
; /* from untracked_cache_dir */
3450 struct ewah_bitmap
*sha1_valid
; /* set if exclude_sha1 is not null */
3452 struct strbuf sb_stat
;
3453 struct strbuf sb_sha1
;
3456 static void stat_data_to_disk(struct stat_data
*to
, const struct stat_data
*from
)
3458 to
->sd_ctime
.sec
= htonl(from
->sd_ctime
.sec
);
3459 to
->sd_ctime
.nsec
= htonl(from
->sd_ctime
.nsec
);
3460 to
->sd_mtime
.sec
= htonl(from
->sd_mtime
.sec
);
3461 to
->sd_mtime
.nsec
= htonl(from
->sd_mtime
.nsec
);
3462 to
->sd_dev
= htonl(from
->sd_dev
);
3463 to
->sd_ino
= htonl(from
->sd_ino
);
3464 to
->sd_uid
= htonl(from
->sd_uid
);
3465 to
->sd_gid
= htonl(from
->sd_gid
);
3466 to
->sd_size
= htonl(from
->sd_size
);
3469 static void write_one_dir(struct untracked_cache_dir
*untracked
,
3470 struct write_data
*wd
)
3472 struct stat_data stat_data
;
3473 struct strbuf
*out
= &wd
->out
;
3474 unsigned char intbuf
[16];
3475 unsigned int intlen
, value
;
3476 int i
= wd
->index
++;
3479 * untracked_nr should be reset whenever valid is clear, but
3482 if (!untracked
->valid
) {
3483 untracked
->untracked_nr
= 0;
3484 untracked
->check_only
= 0;
3487 if (untracked
->check_only
)
3488 ewah_set(wd
->check_only
, i
);
3489 if (untracked
->valid
) {
3490 ewah_set(wd
->valid
, i
);
3491 stat_data_to_disk(&stat_data
, &untracked
->stat_data
);
3492 strbuf_add(&wd
->sb_stat
, &stat_data
, sizeof(stat_data
));
3494 if (!is_null_oid(&untracked
->exclude_oid
)) {
3495 ewah_set(wd
->sha1_valid
, i
);
3496 strbuf_add(&wd
->sb_sha1
, untracked
->exclude_oid
.hash
,
3497 the_hash_algo
->rawsz
);
3500 intlen
= encode_varint(untracked
->untracked_nr
, intbuf
);
3501 strbuf_add(out
, intbuf
, intlen
);
3503 /* skip non-recurse directories */
3504 for (i
= 0, value
= 0; i
< untracked
->dirs_nr
; i
++)
3505 if (untracked
->dirs
[i
]->recurse
)
3507 intlen
= encode_varint(value
, intbuf
);
3508 strbuf_add(out
, intbuf
, intlen
);
3510 strbuf_add(out
, untracked
->name
, strlen(untracked
->name
) + 1);
3512 for (i
= 0; i
< untracked
->untracked_nr
; i
++)
3513 strbuf_add(out
, untracked
->untracked
[i
],
3514 strlen(untracked
->untracked
[i
]) + 1);
3516 for (i
= 0; i
< untracked
->dirs_nr
; i
++)
3517 if (untracked
->dirs
[i
]->recurse
)
3518 write_one_dir(untracked
->dirs
[i
], wd
);
3521 void write_untracked_extension(struct strbuf
*out
, struct untracked_cache
*untracked
)
3523 struct ondisk_untracked_cache
*ouc
;
3524 struct write_data wd
;
3525 unsigned char varbuf
[16];
3527 const unsigned hashsz
= the_hash_algo
->rawsz
;
3529 CALLOC_ARRAY(ouc
, 1);
3530 stat_data_to_disk(&ouc
->info_exclude_stat
, &untracked
->ss_info_exclude
.stat
);
3531 stat_data_to_disk(&ouc
->excludes_file_stat
, &untracked
->ss_excludes_file
.stat
);
3532 ouc
->dir_flags
= htonl(untracked
->dir_flags
);
3534 varint_len
= encode_varint(untracked
->ident
.len
, varbuf
);
3535 strbuf_add(out
, varbuf
, varint_len
);
3536 strbuf_addbuf(out
, &untracked
->ident
);
3538 strbuf_add(out
, ouc
, sizeof(*ouc
));
3539 strbuf_add(out
, untracked
->ss_info_exclude
.oid
.hash
, hashsz
);
3540 strbuf_add(out
, untracked
->ss_excludes_file
.oid
.hash
, hashsz
);
3541 strbuf_add(out
, untracked
->exclude_per_dir
, strlen(untracked
->exclude_per_dir
) + 1);
3544 if (!untracked
->root
) {
3545 varint_len
= encode_varint(0, varbuf
);
3546 strbuf_add(out
, varbuf
, varint_len
);
3551 wd
.check_only
= ewah_new();
3552 wd
.valid
= ewah_new();
3553 wd
.sha1_valid
= ewah_new();
3554 strbuf_init(&wd
.out
, 1024);
3555 strbuf_init(&wd
.sb_stat
, 1024);
3556 strbuf_init(&wd
.sb_sha1
, 1024);
3557 write_one_dir(untracked
->root
, &wd
);
3559 varint_len
= encode_varint(wd
.index
, varbuf
);
3560 strbuf_add(out
, varbuf
, varint_len
);
3561 strbuf_addbuf(out
, &wd
.out
);
3562 ewah_serialize_strbuf(wd
.valid
, out
);
3563 ewah_serialize_strbuf(wd
.check_only
, out
);
3564 ewah_serialize_strbuf(wd
.sha1_valid
, out
);
3565 strbuf_addbuf(out
, &wd
.sb_stat
);
3566 strbuf_addbuf(out
, &wd
.sb_sha1
);
3567 strbuf_addch(out
, '\0'); /* safe guard for string lists */
3569 ewah_free(wd
.valid
);
3570 ewah_free(wd
.check_only
);
3571 ewah_free(wd
.sha1_valid
);
3572 strbuf_release(&wd
.out
);
3573 strbuf_release(&wd
.sb_stat
);
3574 strbuf_release(&wd
.sb_sha1
);
3577 static void free_untracked(struct untracked_cache_dir
*ucd
)
3582 for (i
= 0; i
< ucd
->dirs_nr
; i
++)
3583 free_untracked(ucd
->dirs
[i
]);
3584 for (i
= 0; i
< ucd
->untracked_nr
; i
++)
3585 free(ucd
->untracked
[i
]);
3586 free(ucd
->untracked
);
3591 void free_untracked_cache(struct untracked_cache
*uc
)
3596 free(uc
->exclude_per_dir_to_free
);
3597 strbuf_release(&uc
->ident
);
3598 free_untracked(uc
->root
);
3604 struct untracked_cache_dir
**ucd
;
3605 struct ewah_bitmap
*check_only
;
3606 struct ewah_bitmap
*valid
;
3607 struct ewah_bitmap
*sha1_valid
;
3608 const unsigned char *data
;
3609 const unsigned char *end
;
3612 static void stat_data_from_disk(struct stat_data
*to
, const unsigned char *data
)
3614 memcpy(to
, data
, sizeof(*to
));
3615 to
->sd_ctime
.sec
= ntohl(to
->sd_ctime
.sec
);
3616 to
->sd_ctime
.nsec
= ntohl(to
->sd_ctime
.nsec
);
3617 to
->sd_mtime
.sec
= ntohl(to
->sd_mtime
.sec
);
3618 to
->sd_mtime
.nsec
= ntohl(to
->sd_mtime
.nsec
);
3619 to
->sd_dev
= ntohl(to
->sd_dev
);
3620 to
->sd_ino
= ntohl(to
->sd_ino
);
3621 to
->sd_uid
= ntohl(to
->sd_uid
);
3622 to
->sd_gid
= ntohl(to
->sd_gid
);
3623 to
->sd_size
= ntohl(to
->sd_size
);
3626 static int read_one_dir(struct untracked_cache_dir
**untracked_
,
3627 struct read_data
*rd
)
3629 struct untracked_cache_dir ud
, *untracked
;
3630 const unsigned char *data
= rd
->data
, *end
= rd
->end
;
3631 const unsigned char *eos
;
3635 memset(&ud
, 0, sizeof(ud
));
3637 value
= decode_varint(&data
);
3641 ud
.untracked_alloc
= value
;
3642 ud
.untracked_nr
= value
;
3643 if (ud
.untracked_nr
)
3644 ALLOC_ARRAY(ud
.untracked
, ud
.untracked_nr
);
3646 ud
.dirs_alloc
= ud
.dirs_nr
= decode_varint(&data
);
3649 ALLOC_ARRAY(ud
.dirs
, ud
.dirs_nr
);
3651 eos
= memchr(data
, '\0', end
- data
);
3652 if (!eos
|| eos
== end
)
3655 *untracked_
= untracked
= xmalloc(st_add3(sizeof(*untracked
), eos
- data
, 1));
3656 memcpy(untracked
, &ud
, sizeof(ud
));
3657 memcpy(untracked
->name
, data
, eos
- data
+ 1);
3660 for (i
= 0; i
< untracked
->untracked_nr
; i
++) {
3661 eos
= memchr(data
, '\0', end
- data
);
3662 if (!eos
|| eos
== end
)
3664 untracked
->untracked
[i
] = xmemdupz(data
, eos
- data
);
3668 rd
->ucd
[rd
->index
++] = untracked
;
3671 for (i
= 0; i
< untracked
->dirs_nr
; i
++) {
3672 if (read_one_dir(untracked
->dirs
+ i
, rd
) < 0)
3678 static void set_check_only(size_t pos
, void *cb
)
3680 struct read_data
*rd
= cb
;
3681 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3685 static void read_stat(size_t pos
, void *cb
)
3687 struct read_data
*rd
= cb
;
3688 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3689 if (rd
->data
+ sizeof(struct stat_data
) > rd
->end
) {
3690 rd
->data
= rd
->end
+ 1;
3693 stat_data_from_disk(&ud
->stat_data
, rd
->data
);
3694 rd
->data
+= sizeof(struct stat_data
);
3698 static void read_oid(size_t pos
, void *cb
)
3700 struct read_data
*rd
= cb
;
3701 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3702 if (rd
->data
+ the_hash_algo
->rawsz
> rd
->end
) {
3703 rd
->data
= rd
->end
+ 1;
3706 oidread(&ud
->exclude_oid
, rd
->data
);
3707 rd
->data
+= the_hash_algo
->rawsz
;
3710 static void load_oid_stat(struct oid_stat
*oid_stat
, const unsigned char *data
,
3711 const unsigned char *sha1
)
3713 stat_data_from_disk(&oid_stat
->stat
, data
);
3714 oidread(&oid_stat
->oid
, sha1
);
3715 oid_stat
->valid
= 1;
3718 struct untracked_cache
*read_untracked_extension(const void *data
, unsigned long sz
)
3720 struct untracked_cache
*uc
;
3721 struct read_data rd
;
3722 const unsigned char *next
= data
, *end
= (const unsigned char *)data
+ sz
;
3726 const char *exclude_per_dir
;
3727 const unsigned hashsz
= the_hash_algo
->rawsz
;
3728 const unsigned offset
= sizeof(struct ondisk_untracked_cache
);
3729 const unsigned exclude_per_dir_offset
= offset
+ 2 * hashsz
;
3731 if (sz
<= 1 || end
[-1] != '\0')
3735 ident_len
= decode_varint(&next
);
3736 if (next
+ ident_len
> end
)
3738 ident
= (const char *)next
;
3741 if (next
+ exclude_per_dir_offset
+ 1 > end
)
3744 CALLOC_ARRAY(uc
, 1);
3745 strbuf_init(&uc
->ident
, ident_len
);
3746 strbuf_add(&uc
->ident
, ident
, ident_len
);
3747 load_oid_stat(&uc
->ss_info_exclude
,
3748 next
+ ouc_offset(info_exclude_stat
),
3750 load_oid_stat(&uc
->ss_excludes_file
,
3751 next
+ ouc_offset(excludes_file_stat
),
3752 next
+ offset
+ hashsz
);
3753 uc
->dir_flags
= get_be32(next
+ ouc_offset(dir_flags
));
3754 exclude_per_dir
= (const char *)next
+ exclude_per_dir_offset
;
3755 uc
->exclude_per_dir
= uc
->exclude_per_dir_to_free
= xstrdup(exclude_per_dir
);
3756 /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
3757 next
+= exclude_per_dir_offset
+ strlen(exclude_per_dir
) + 1;
3761 len
= decode_varint(&next
);
3762 if (next
> end
|| len
== 0)
3765 rd
.valid
= ewah_new();
3766 rd
.check_only
= ewah_new();
3767 rd
.sha1_valid
= ewah_new();
3771 ALLOC_ARRAY(rd
.ucd
, len
);
3773 if (read_one_dir(&uc
->root
, &rd
) || rd
.index
!= len
)
3777 len
= ewah_read_mmap(rd
.valid
, next
, end
- next
);
3782 len
= ewah_read_mmap(rd
.check_only
, next
, end
- next
);
3787 len
= ewah_read_mmap(rd
.sha1_valid
, next
, end
- next
);
3791 ewah_each_bit(rd
.check_only
, set_check_only
, &rd
);
3792 rd
.data
= next
+ len
;
3793 ewah_each_bit(rd
.valid
, read_stat
, &rd
);
3794 ewah_each_bit(rd
.sha1_valid
, read_oid
, &rd
);
3799 ewah_free(rd
.valid
);
3800 ewah_free(rd
.check_only
);
3801 ewah_free(rd
.sha1_valid
);
3804 free_untracked_cache(uc
);
3810 static void invalidate_one_directory(struct untracked_cache
*uc
,
3811 struct untracked_cache_dir
*ucd
)
3813 uc
->dir_invalidated
++;
3815 ucd
->untracked_nr
= 0;
3819 * Normally when an entry is added or removed from a directory,
3820 * invalidating that directory is enough. No need to touch its
3821 * ancestors. When a directory is shown as "foo/bar/" in git-status
3822 * however, deleting or adding an entry may have cascading effect.
3824 * Say the "foo/bar/file" has become untracked, we need to tell the
3825 * untracked_cache_dir of "foo" that "bar/" is not an untracked
3826 * directory any more (because "bar" is managed by foo as an untracked
3829 * Similarly, if "foo/bar/file" moves from untracked to tracked and it
3830 * was the last untracked entry in the entire "foo", we should show
3831 * "foo/" instead. Which means we have to invalidate past "bar" up to
3834 * This function traverses all directories from root to leaf. If there
3835 * is a chance of one of the above cases happening, we invalidate back
3836 * to root. Otherwise we just invalidate the leaf. There may be a more
3837 * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
3838 * detect these cases and avoid unnecessary invalidation, for example,
3839 * checking for the untracked entry named "bar/" in "foo", but for now
3840 * stick to something safe and simple.
3842 static int invalidate_one_component(struct untracked_cache
*uc
,
3843 struct untracked_cache_dir
*dir
,
3844 const char *path
, int len
)
3846 const char *rest
= strchr(path
, '/');
3849 int component_len
= rest
- path
;
3850 struct untracked_cache_dir
*d
=
3851 lookup_untracked(uc
, dir
, path
, component_len
);
3853 invalidate_one_component(uc
, d
, rest
+ 1,
3854 len
- (component_len
+ 1));
3856 invalidate_one_directory(uc
, dir
);
3860 invalidate_one_directory(uc
, dir
);
3861 return uc
->dir_flags
& DIR_SHOW_OTHER_DIRECTORIES
;
3864 void untracked_cache_invalidate_path(struct index_state
*istate
,
3865 const char *path
, int safe_path
)
3867 if (!istate
->untracked
|| !istate
->untracked
->root
)
3869 if (!safe_path
&& !verify_path(path
, 0))
3871 invalidate_one_component(istate
->untracked
, istate
->untracked
->root
,
3872 path
, strlen(path
));
3875 void untracked_cache_remove_from_index(struct index_state
*istate
,
3878 untracked_cache_invalidate_path(istate
, path
, 1);
3881 void untracked_cache_add_to_index(struct index_state
*istate
,
3884 untracked_cache_invalidate_path(istate
, path
, 1);
3887 static void connect_wt_gitdir_in_nested(const char *sub_worktree
,
3888 const char *sub_gitdir
)
3891 struct repository subrepo
;
3892 struct strbuf sub_wt
= STRBUF_INIT
;
3893 struct strbuf sub_gd
= STRBUF_INIT
;
3895 const struct submodule
*sub
;
3897 /* If the submodule has no working tree, we can ignore it. */
3898 if (repo_init(&subrepo
, sub_gitdir
, sub_worktree
))
3901 if (repo_read_index(&subrepo
) < 0)
3902 die(_("index file corrupt in repo %s"), subrepo
.gitdir
);
3904 /* TODO: audit for interaction with sparse-index. */
3905 ensure_full_index(subrepo
.index
);
3906 for (i
= 0; i
< subrepo
.index
->cache_nr
; i
++) {
3907 const struct cache_entry
*ce
= subrepo
.index
->cache
[i
];
3909 if (!S_ISGITLINK(ce
->ce_mode
))
3912 while (i
+ 1 < subrepo
.index
->cache_nr
&&
3913 !strcmp(ce
->name
, subrepo
.index
->cache
[i
+ 1]->name
))
3915 * Skip entries with the same name in different stages
3916 * to make sure an entry is returned only once.
3920 sub
= submodule_from_path(&subrepo
, null_oid(), ce
->name
);
3921 if (!sub
|| !is_submodule_active(&subrepo
, ce
->name
))
3922 /* .gitmodules broken or inactive sub */
3925 strbuf_reset(&sub_wt
);
3926 strbuf_reset(&sub_gd
);
3927 strbuf_addf(&sub_wt
, "%s/%s", sub_worktree
, sub
->path
);
3928 submodule_name_to_gitdir(&sub_gd
, &subrepo
, sub
->name
);
3930 connect_work_tree_and_git_dir(sub_wt
.buf
, sub_gd
.buf
, 1);
3932 strbuf_release(&sub_wt
);
3933 strbuf_release(&sub_gd
);
3934 repo_clear(&subrepo
);
3937 void connect_work_tree_and_git_dir(const char *work_tree_
,
3938 const char *git_dir_
,
3939 int recurse_into_nested
)
3941 struct strbuf gitfile_sb
= STRBUF_INIT
;
3942 struct strbuf cfg_sb
= STRBUF_INIT
;
3943 struct strbuf rel_path
= STRBUF_INIT
;
3944 char *git_dir
, *work_tree
;
3946 /* Prepare .git file */
3947 strbuf_addf(&gitfile_sb
, "%s/.git", work_tree_
);
3948 if (safe_create_leading_directories_const(gitfile_sb
.buf
))
3949 die(_("could not create directories for %s"), gitfile_sb
.buf
);
3951 /* Prepare config file */
3952 strbuf_addf(&cfg_sb
, "%s/config", git_dir_
);
3953 if (safe_create_leading_directories_const(cfg_sb
.buf
))
3954 die(_("could not create directories for %s"), cfg_sb
.buf
);
3956 git_dir
= real_pathdup(git_dir_
, 1);
3957 work_tree
= real_pathdup(work_tree_
, 1);
3959 /* Write .git file */
3960 write_file(gitfile_sb
.buf
, "gitdir: %s",
3961 relative_path(git_dir
, work_tree
, &rel_path
));
3962 /* Update core.worktree setting */
3963 git_config_set_in_file(cfg_sb
.buf
, "core.worktree",
3964 relative_path(work_tree
, git_dir
, &rel_path
));
3966 strbuf_release(&gitfile_sb
);
3967 strbuf_release(&cfg_sb
);
3968 strbuf_release(&rel_path
);
3970 if (recurse_into_nested
)
3971 connect_wt_gitdir_in_nested(work_tree
, git_dir
);
3978 * Migrate the git directory of the given path from old_git_dir to new_git_dir.
3980 void relocate_gitdir(const char *path
, const char *old_git_dir
, const char *new_git_dir
)
3982 if (rename(old_git_dir
, new_git_dir
) < 0)
3983 die_errno(_("could not migrate git directory from '%s' to '%s'"),
3984 old_git_dir
, new_git_dir
);
3986 connect_work_tree_and_git_dir(path
, new_git_dir
, 0);
3989 int path_match_flags(const char *const str
, const enum path_match_flags flags
)
3991 const char *p
= str
;
3993 if (flags
& PATH_MATCH_NATIVE
&&
3994 flags
& PATH_MATCH_XPLATFORM
)
3995 BUG("path_match_flags() must get one match kind, not multiple!");
3996 else if (!(flags
& PATH_MATCH_KINDS_MASK
))
3997 BUG("path_match_flags() must get at least one match kind!");
3999 if (flags
& PATH_MATCH_STARTS_WITH_DOT_SLASH
&&
4000 flags
& PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH
)
4001 BUG("path_match_flags() must get one platform kind, not multiple!");
4002 else if (!(flags
& PATH_MATCH_PLATFORM_MASK
))
4003 BUG("path_match_flags() must get at least one platform kind!");
4007 if (flags
& PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH
&&
4011 if (flags
& PATH_MATCH_NATIVE
)
4012 return is_dir_sep(*p
);
4013 else if (flags
& PATH_MATCH_XPLATFORM
)
4014 return is_xplatform_dir_sep(*p
);