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
8 #include "git-compat-util.h"
14 #include "environment.h"
16 #include "name-hash.h"
17 #include "object-file.h"
18 #include "object-store-ll.h"
22 #include "wildmatch.h"
26 #include "ewah/ewok.h"
27 #include "fsmonitor-ll.h"
28 #include "read-cache-ll.h"
30 #include "sparse-index.h"
31 #include "submodule-config.h"
37 * Tells read_directory_recursive how a file or directory should be treated.
38 * Values are ordered by significance, e.g. if a directory contains both
39 * excluded and untracked files, it is listed as untracked because
40 * path_untracked > path_excluded.
50 * Support data structure for our opendir/readdir/closedir wrappers
54 struct untracked_cache_dir
*untracked
;
61 struct untracked_cache_dir
*ucd
;
64 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
65 struct index_state
*istate
, const char *path
, int len
,
66 struct untracked_cache_dir
*untracked
,
67 int check_only
, int stop_at_first_file
, const struct pathspec
*pathspec
);
68 static int resolve_dtype(int dtype
, struct index_state
*istate
,
69 const char *path
, int len
);
70 struct dirent
*readdir_skip_dot_and_dotdot(DIR *dirp
)
74 while ((e
= readdir(dirp
)) != NULL
) {
75 if (!is_dot_or_dotdot(e
->d_name
))
81 int count_slashes(const char *s
)
90 int fspathcmp(const char *a
, const char *b
)
92 return ignore_case
? strcasecmp(a
, b
) : strcmp(a
, b
);
95 int fspatheq(const char *a
, const char *b
)
97 return !fspathcmp(a
, b
);
100 int fspathncmp(const char *a
, const char *b
, size_t count
)
102 return ignore_case
? strncasecmp(a
, b
, count
) : strncmp(a
, b
, count
);
105 unsigned int fspathhash(const char *str
)
107 return ignore_case
? strihash(str
) : strhash(str
);
110 int git_fnmatch(const struct pathspec_item
*item
,
111 const char *pattern
, const char *string
,
115 if (ps_strncmp(item
, pattern
, string
, prefix
))
120 if (item
->flags
& PATHSPEC_ONESTAR
) {
121 int pattern_len
= strlen(++pattern
);
122 int string_len
= strlen(string
);
123 return string_len
< pattern_len
||
124 ps_strcmp(item
, pattern
,
125 string
+ string_len
- pattern_len
);
127 if (item
->magic
& PATHSPEC_GLOB
)
128 return wildmatch(pattern
, string
,
130 (item
->magic
& PATHSPEC_ICASE
? WM_CASEFOLD
: 0));
132 /* wildmatch has not learned no FNM_PATHNAME mode yet */
133 return wildmatch(pattern
, string
,
134 item
->magic
& PATHSPEC_ICASE
? WM_CASEFOLD
: 0);
137 static int fnmatch_icase_mem(const char *pattern
, int patternlen
,
138 const char *string
, int stringlen
,
142 struct strbuf pat_buf
= STRBUF_INIT
;
143 struct strbuf str_buf
= STRBUF_INIT
;
144 const char *use_pat
= pattern
;
145 const char *use_str
= string
;
147 if (pattern
[patternlen
]) {
148 strbuf_add(&pat_buf
, pattern
, patternlen
);
149 use_pat
= pat_buf
.buf
;
151 if (string
[stringlen
]) {
152 strbuf_add(&str_buf
, string
, stringlen
);
153 use_str
= str_buf
.buf
;
157 flags
|= WM_CASEFOLD
;
158 match_status
= wildmatch(use_pat
, use_str
, flags
);
160 strbuf_release(&pat_buf
);
161 strbuf_release(&str_buf
);
166 static size_t common_prefix_len(const struct pathspec
*pathspec
)
172 * ":(icase)path" is treated as a pathspec full of
173 * wildcard. In other words, only prefix is considered common
174 * prefix. If the pathspec is abc/foo abc/bar, running in
175 * subdir xyz, the common prefix is still xyz, not xyz/abc as
178 GUARD_PATHSPEC(pathspec
,
187 for (n
= 0; n
< pathspec
->nr
; n
++) {
188 size_t i
= 0, len
= 0, item_len
;
189 if (pathspec
->items
[n
].magic
& PATHSPEC_EXCLUDE
)
191 if (pathspec
->items
[n
].magic
& PATHSPEC_ICASE
)
192 item_len
= pathspec
->items
[n
].prefix
;
194 item_len
= pathspec
->items
[n
].nowildcard_len
;
195 while (i
< item_len
&& (n
== 0 || i
< max
)) {
196 char c
= pathspec
->items
[n
].match
[i
];
197 if (c
!= pathspec
->items
[0].match
[i
])
203 if (n
== 0 || len
< max
) {
213 * Returns a copy of the longest leading path common among all
216 char *common_prefix(const struct pathspec
*pathspec
)
218 unsigned long len
= common_prefix_len(pathspec
);
220 return len
? xmemdupz(pathspec
->items
[0].match
, len
) : NULL
;
223 int fill_directory(struct dir_struct
*dir
,
224 struct index_state
*istate
,
225 const struct pathspec
*pathspec
)
230 unsigned exclusive_flags
= DIR_SHOW_IGNORED
| DIR_SHOW_IGNORED_TOO
;
231 if ((dir
->flags
& exclusive_flags
) == exclusive_flags
)
232 BUG("DIR_SHOW_IGNORED and DIR_SHOW_IGNORED_TOO are exclusive");
235 * Calculate common prefix for the pathspec, and
236 * use that to optimize the directory walk
238 prefix_len
= common_prefix_len(pathspec
);
239 prefix
= prefix_len
? pathspec
->items
[0].match
: "";
241 /* Read the directory and prune it */
242 read_directory(dir
, istate
, prefix
, prefix_len
, pathspec
);
247 int within_depth(const char *name
, int namelen
,
248 int depth
, int max_depth
)
250 const char *cp
= name
, *cpe
= name
+ namelen
;
256 if (depth
> max_depth
)
263 * Read the contents of the blob with the given OID into a buffer.
264 * Append a trailing LF to the end if the last line doesn't have one.
267 * -1 when the OID is invalid or unknown or does not refer to a blob.
268 * 0 when the blob is empty.
269 * 1 along with { data, size } of the (possibly augmented) buffer
272 * Optionally updates the given oid_stat with the given OID (when valid).
274 static int do_read_blob(const struct object_id
*oid
, struct oid_stat
*oid_stat
,
275 size_t *size_out
, char **data_out
)
277 enum object_type type
;
284 data
= repo_read_object_file(the_repository
, oid
, &type
, &sz
);
285 if (!data
|| type
!= OBJ_BLOB
) {
291 memset(&oid_stat
->stat
, 0, sizeof(oid_stat
->stat
));
292 oidcpy(&oid_stat
->oid
, oid
);
300 if (data
[sz
- 1] != '\n') {
301 data
= xrealloc(data
, st_add(sz
, 1));
305 *size_out
= xsize_t(sz
);
311 #define DO_MATCH_EXCLUDE (1<<0)
312 #define DO_MATCH_DIRECTORY (1<<1)
313 #define DO_MATCH_LEADING_PATHSPEC (1<<2)
316 * Does the given pathspec match the given name? A match is found if
318 * (1) the pathspec string is leading directory of 'name' ("RECURSIVELY"), or
319 * (2) the pathspec string has a leading part matching 'name' ("LEADING"), or
320 * (3) the pathspec string is a wildcard and matches 'name' ("WILDCARD"), or
321 * (4) the pathspec string is exactly the same as 'name' ("EXACT").
323 * Return value tells which case it was (1-4), or 0 when there is no match.
325 * It may be instructive to look at a small table of concrete examples
326 * to understand the differences between 1, 2, and 4:
329 * | a/b | a/b/ | a/b/c
330 * ------+-----------+-----------+------------
331 * a/b | EXACT | EXACT[1] | LEADING[2]
332 * Names a/b/ | RECURSIVE | EXACT | LEADING[2]
333 * a/b/c | RECURSIVE | RECURSIVE | EXACT
335 * [1] Only if DO_MATCH_DIRECTORY is passed; otherwise, this is NOT a match.
336 * [2] Only if DO_MATCH_LEADING_PATHSPEC is passed; otherwise, not a match.
338 static int match_pathspec_item(struct index_state
*istate
,
339 const struct pathspec_item
*item
, int prefix
,
340 const char *name
, int namelen
, unsigned flags
)
342 /* name/namelen has prefix cut off by caller */
343 const char *match
= item
->match
+ prefix
;
344 int matchlen
= item
->len
- prefix
;
347 * The normal call pattern is:
348 * 1. prefix = common_prefix_len(ps);
349 * 2. prune something, or fill_directory
350 * 3. match_pathspec()
352 * 'prefix' at #1 may be shorter than the command's prefix and
353 * it's ok for #2 to match extra files. Those extras will be
356 * Suppose the pathspec is 'foo' and '../bar' running from
357 * subdir 'xyz'. The common prefix at #1 will be empty, thanks
358 * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
359 * user does not want XYZ/foo, only the "foo" part should be
360 * case-insensitive. We need to filter out XYZ/foo here. In
361 * other words, we do not trust the caller on comparing the
362 * prefix part when :(icase) is involved. We do exact
363 * comparison ourselves.
365 * Normally the caller (common_prefix_len() in fact) does
366 * _exact_ matching on name[-prefix+1..-1] and we do not need
367 * to check that part. Be defensive and check it anyway, in
368 * case common_prefix_len is changed, or a new caller is
369 * introduced that does not use common_prefix_len.
371 * If the penalty turns out too high when prefix is really
372 * long, maybe change it to
373 * strncmp(match, name, item->prefix - prefix)
375 if (item
->prefix
&& (item
->magic
& PATHSPEC_ICASE
) &&
376 strncmp(item
->match
, name
- prefix
, item
->prefix
))
379 if (item
->attr_match_nr
&&
380 !match_pathspec_attrs(istate
, name
, namelen
, item
))
383 /* If the match was just the prefix, we matched */
385 return MATCHED_RECURSIVELY
;
387 if (matchlen
<= namelen
&& !ps_strncmp(item
, match
, name
, matchlen
)) {
388 if (matchlen
== namelen
)
389 return MATCHED_EXACTLY
;
391 if (match
[matchlen
-1] == '/' || name
[matchlen
] == '/')
392 return MATCHED_RECURSIVELY
;
393 } else if ((flags
& DO_MATCH_DIRECTORY
) &&
394 match
[matchlen
- 1] == '/' &&
395 namelen
== matchlen
- 1 &&
396 !ps_strncmp(item
, match
, name
, namelen
))
397 return MATCHED_EXACTLY
;
399 if (item
->nowildcard_len
< item
->len
&&
400 !git_fnmatch(item
, match
, name
,
401 item
->nowildcard_len
- prefix
))
402 return MATCHED_FNMATCH
;
404 /* Perform checks to see if "name" is a leading string of the pathspec */
405 if ( (flags
& DO_MATCH_LEADING_PATHSPEC
) &&
406 !(flags
& DO_MATCH_EXCLUDE
)) {
407 /* name is a literal prefix of the pathspec */
408 int offset
= name
[namelen
-1] == '/' ? 1 : 0;
409 if ((namelen
< matchlen
) &&
410 (match
[namelen
-offset
] == '/') &&
411 !ps_strncmp(item
, match
, name
, namelen
))
412 return MATCHED_RECURSIVELY_LEADING_PATHSPEC
;
414 /* name doesn't match up to the first wild character */
415 if (item
->nowildcard_len
< item
->len
&&
416 ps_strncmp(item
, match
, name
,
417 item
->nowildcard_len
- prefix
))
421 * name has no wildcard, and it didn't match as a leading
422 * pathspec so return.
424 if (item
->nowildcard_len
== item
->len
)
428 * Here is where we would perform a wildmatch to check if
429 * "name" can be matched as a directory (or a prefix) against
430 * the pathspec. Since wildmatch doesn't have this capability
431 * at the present we have to punt and say that it is a match,
432 * potentially returning a false positive
433 * The submodules themselves will be able to perform more
434 * accurate matching to determine if the pathspec matches.
436 return MATCHED_RECURSIVELY_LEADING_PATHSPEC
;
443 * do_match_pathspec() is meant to ONLY be called by
444 * match_pathspec_with_flags(); calling it directly risks pathspecs
445 * like ':!unwanted_path' being ignored.
447 * Given a name and a list of pathspecs, returns the nature of the
448 * closest (i.e. most specific) match of the name to any of the
451 * The caller typically calls this multiple times with the same
452 * pathspec and seen[] array but with different name/namelen
453 * (e.g. entries from the index) and is interested in seeing if and
454 * how each pathspec matches all the names it calls this function
455 * with. A mark is left in the seen[] array for each pathspec element
456 * indicating the closest type of match that element achieved, so if
457 * seen[n] remains zero after multiple invocations, that means the nth
458 * pathspec did not match any names, which could indicate that the
459 * user mistyped the nth pathspec.
461 static int do_match_pathspec(struct index_state
*istate
,
462 const struct pathspec
*ps
,
463 const char *name
, int namelen
,
464 int prefix
, char *seen
,
467 int i
, retval
= 0, exclude
= flags
& DO_MATCH_EXCLUDE
;
479 if (!ps
->recursive
||
480 !(ps
->magic
& PATHSPEC_MAXDEPTH
) ||
482 return MATCHED_RECURSIVELY
;
484 if (within_depth(name
, namelen
, 0, ps
->max_depth
))
485 return MATCHED_EXACTLY
;
493 for (i
= ps
->nr
- 1; i
>= 0; i
--) {
496 if ((!exclude
&& ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
) ||
497 ( exclude
&& !(ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
)))
500 if (seen
&& seen
[i
] == MATCHED_EXACTLY
)
503 * Make exclude patterns optional and never report
504 * "pathspec ':(exclude)foo' matches no files"
506 if (seen
&& ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
)
507 seen
[i
] = MATCHED_FNMATCH
;
508 how
= match_pathspec_item(istate
, ps
->items
+i
, prefix
, name
,
511 (ps
->magic
& PATHSPEC_MAXDEPTH
) &&
512 ps
->max_depth
!= -1 &&
513 how
&& how
!= MATCHED_FNMATCH
) {
514 int len
= ps
->items
[i
].len
;
515 if (name
[len
] == '/')
517 if (within_depth(name
+len
, namelen
-len
, 0, ps
->max_depth
))
518 how
= MATCHED_EXACTLY
;
525 if (seen
&& seen
[i
] < how
)
532 static int match_pathspec_with_flags(struct index_state
*istate
,
533 const struct pathspec
*ps
,
534 const char *name
, int namelen
,
535 int prefix
, char *seen
, unsigned flags
)
537 int positive
, negative
;
538 positive
= do_match_pathspec(istate
, ps
, name
, namelen
,
539 prefix
, seen
, flags
);
540 if (!(ps
->magic
& PATHSPEC_EXCLUDE
) || !positive
)
542 negative
= do_match_pathspec(istate
, ps
, name
, namelen
,
544 flags
| DO_MATCH_EXCLUDE
);
545 return negative
? 0 : positive
;
548 int match_pathspec(struct index_state
*istate
,
549 const struct pathspec
*ps
,
550 const char *name
, int namelen
,
551 int prefix
, char *seen
, int is_dir
)
553 unsigned flags
= is_dir
? DO_MATCH_DIRECTORY
: 0;
554 return match_pathspec_with_flags(istate
, ps
, name
, namelen
,
555 prefix
, seen
, flags
);
559 * Check if a submodule is a superset of the pathspec
561 int submodule_path_match(struct index_state
*istate
,
562 const struct pathspec
*ps
,
563 const char *submodule_name
,
566 int matched
= match_pathspec_with_flags(istate
, ps
, submodule_name
,
567 strlen(submodule_name
),
570 DO_MATCH_LEADING_PATHSPEC
);
574 int report_path_error(const char *ps_matched
,
575 const struct pathspec
*pathspec
)
578 * Make sure all pathspec matched; otherwise it is an error.
581 for (num
= 0; num
< pathspec
->nr
; num
++) {
582 int other
, found_dup
;
587 * The caller might have fed identical pathspec
588 * twice. Do not barf on such a mistake.
589 * FIXME: parse_pathspec should have eliminated
590 * duplicate pathspec.
592 for (found_dup
= other
= 0;
593 !found_dup
&& other
< pathspec
->nr
;
595 if (other
== num
|| !ps_matched
[other
])
597 if (!strcmp(pathspec
->items
[other
].original
,
598 pathspec
->items
[num
].original
))
600 * Ok, we have a match already.
607 error(_("pathspec '%s' did not match any file(s) known to git"),
608 pathspec
->items
[num
].original
);
615 * Return the length of the "simple" part of a path match limiter.
617 int simple_length(const char *match
)
622 unsigned char c
= *match
++;
624 if (c
== '\0' || is_glob_special(c
))
629 int no_wildcard(const char *string
)
631 return string
[simple_length(string
)] == '\0';
634 void parse_path_pattern(const char **pattern
,
639 const char *p
= *pattern
;
644 *flags
|= PATTERN_FLAG_NEGATIVE
;
648 if (len
&& p
[len
- 1] == '/') {
650 *flags
|= PATTERN_FLAG_MUSTBEDIR
;
652 for (i
= 0; i
< len
; i
++) {
657 *flags
|= PATTERN_FLAG_NODIR
;
658 *nowildcardlen
= simple_length(p
);
660 * we should have excluded the trailing slash from 'p' too,
661 * but that's one more allocation. Instead just make sure
662 * nowildcardlen does not exceed real patternlen
664 if (*nowildcardlen
> len
)
665 *nowildcardlen
= len
;
666 if (*p
== '*' && no_wildcard(p
+ 1))
667 *flags
|= PATTERN_FLAG_ENDSWITH
;
672 int pl_hashmap_cmp(const void *cmp_data UNUSED
,
673 const struct hashmap_entry
*a
,
674 const struct hashmap_entry
*b
,
675 const void *key UNUSED
)
677 const struct pattern_entry
*ee1
=
678 container_of(a
, struct pattern_entry
, ent
);
679 const struct pattern_entry
*ee2
=
680 container_of(b
, struct pattern_entry
, ent
);
682 size_t min_len
= ee1
->patternlen
<= ee2
->patternlen
686 return fspathncmp(ee1
->pattern
, ee2
->pattern
, min_len
);
689 static char *dup_and_filter_pattern(const char *pattern
)
693 char *result
= xstrdup(pattern
);
699 /* skip escape characters (once) */
719 static void add_pattern_to_hashsets(struct pattern_list
*pl
, struct path_pattern
*given
)
721 struct pattern_entry
*translated
;
724 const char *prev
, *cur
, *next
;
726 if (!pl
->use_cone_patterns
)
729 if (given
->flags
& PATTERN_FLAG_NEGATIVE
&&
730 given
->flags
& PATTERN_FLAG_MUSTBEDIR
&&
731 !strcmp(given
->pattern
, "/*")) {
736 if (!given
->flags
&& !strcmp(given
->pattern
, "/*")) {
741 if (given
->patternlen
< 2 ||
742 *given
->pattern
!= '/' ||
743 strstr(given
->pattern
, "**")) {
744 /* Not a cone pattern. */
745 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
749 if (!(given
->flags
& PATTERN_FLAG_MUSTBEDIR
) &&
750 strcmp(given
->pattern
, "/*")) {
751 /* Not a cone pattern. */
752 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
756 prev
= given
->pattern
;
757 cur
= given
->pattern
+ 1;
758 next
= given
->pattern
+ 2;
761 /* Watch for glob characters '*', '\', '[', '?' */
762 if (!is_glob_special(*cur
))
765 /* But only if *prev != '\\' */
769 /* But allow the initial '\' */
771 is_glob_special(*next
))
774 /* But a trailing '/' then '*' is fine */
780 /* Not a cone pattern. */
781 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
790 if (given
->patternlen
> 2 &&
791 !strcmp(given
->pattern
+ given
->patternlen
- 2, "/*")) {
792 if (!(given
->flags
& PATTERN_FLAG_NEGATIVE
)) {
793 /* Not a cone pattern. */
794 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
798 truncated
= dup_and_filter_pattern(given
->pattern
);
800 translated
= xmalloc(sizeof(struct pattern_entry
));
801 translated
->pattern
= truncated
;
802 translated
->patternlen
= given
->patternlen
- 2;
803 hashmap_entry_init(&translated
->ent
,
804 fspathhash(translated
->pattern
));
806 if (!hashmap_get_entry(&pl
->recursive_hashmap
,
807 translated
, ent
, NULL
)) {
808 /* We did not see the "parent" included */
809 warning(_("unrecognized negative pattern: '%s'"),
816 hashmap_add(&pl
->parent_hashmap
, &translated
->ent
);
817 hashmap_remove(&pl
->recursive_hashmap
, &translated
->ent
, &data
);
822 if (given
->flags
& PATTERN_FLAG_NEGATIVE
) {
823 warning(_("unrecognized negative pattern: '%s'"),
828 translated
= xmalloc(sizeof(struct pattern_entry
));
830 translated
->pattern
= dup_and_filter_pattern(given
->pattern
);
831 translated
->patternlen
= given
->patternlen
;
832 hashmap_entry_init(&translated
->ent
,
833 fspathhash(translated
->pattern
));
835 hashmap_add(&pl
->recursive_hashmap
, &translated
->ent
);
837 if (hashmap_get_entry(&pl
->parent_hashmap
, translated
, ent
, NULL
)) {
838 /* we already included this at the parent level */
839 warning(_("your sparse-checkout file may have issues: pattern '%s' is repeated"),
847 warning(_("disabling cone pattern matching"));
848 hashmap_clear_and_free(&pl
->parent_hashmap
, struct pattern_entry
, ent
);
849 hashmap_clear_and_free(&pl
->recursive_hashmap
, struct pattern_entry
, ent
);
850 pl
->use_cone_patterns
= 0;
853 static int hashmap_contains_path(struct hashmap
*map
,
854 struct strbuf
*pattern
)
856 struct pattern_entry p
;
858 /* Check straight mapping */
859 p
.pattern
= pattern
->buf
;
860 p
.patternlen
= pattern
->len
;
861 hashmap_entry_init(&p
.ent
, fspathhash(p
.pattern
));
862 return !!hashmap_get_entry(map
, &p
, ent
, NULL
);
865 int hashmap_contains_parent(struct hashmap
*map
,
867 struct strbuf
*buffer
)
871 strbuf_setlen(buffer
, 0);
874 strbuf_addch(buffer
, '/');
876 strbuf_addstr(buffer
, path
);
878 slash_pos
= strrchr(buffer
->buf
, '/');
880 while (slash_pos
> buffer
->buf
) {
881 strbuf_setlen(buffer
, slash_pos
- buffer
->buf
);
883 if (hashmap_contains_path(map
, buffer
))
886 slash_pos
= strrchr(buffer
->buf
, '/');
892 void add_pattern(const char *string
, const char *base
,
893 int baselen
, struct pattern_list
*pl
, int srcpos
)
895 struct path_pattern
*pattern
;
900 parse_path_pattern(&string
, &patternlen
, &flags
, &nowildcardlen
);
901 if (flags
& PATTERN_FLAG_MUSTBEDIR
) {
902 FLEXPTR_ALLOC_MEM(pattern
, pattern
, string
, patternlen
);
904 pattern
= xmalloc(sizeof(*pattern
));
905 pattern
->pattern
= string
;
907 pattern
->patternlen
= patternlen
;
908 pattern
->nowildcardlen
= nowildcardlen
;
909 pattern
->base
= base
;
910 pattern
->baselen
= baselen
;
911 pattern
->flags
= flags
;
912 pattern
->srcpos
= srcpos
;
913 ALLOC_GROW(pl
->patterns
, pl
->nr
+ 1, pl
->alloc
);
914 pl
->patterns
[pl
->nr
++] = pattern
;
917 add_pattern_to_hashsets(pl
, pattern
);
920 static int read_skip_worktree_file_from_index(struct index_state
*istate
,
922 size_t *size_out
, char **data_out
,
923 struct oid_stat
*oid_stat
)
928 pos
= index_name_pos(istate
, path
, len
);
931 if (!ce_skip_worktree(istate
->cache
[pos
]))
934 return do_read_blob(&istate
->cache
[pos
]->oid
, oid_stat
, size_out
, data_out
);
938 * Frees memory within pl which was allocated for exclude patterns and
939 * the file buffer. Does not free pl itself.
941 void clear_pattern_list(struct pattern_list
*pl
)
945 for (i
= 0; i
< pl
->nr
; i
++)
946 free(pl
->patterns
[i
]);
949 hashmap_clear_and_free(&pl
->recursive_hashmap
, struct pattern_entry
, ent
);
950 hashmap_clear_and_free(&pl
->parent_hashmap
, struct pattern_entry
, ent
);
952 memset(pl
, 0, sizeof(*pl
));
955 static void trim_trailing_spaces(char *buf
)
957 char *p
, *last_space
= NULL
;
959 for (p
= buf
; *p
; p
++)
979 * Given a subdirectory name and "dir" of the current directory,
980 * search the subdir in "dir" and return it, or create a new one if it
981 * does not exist in "dir".
983 * If "name" has the trailing slash, it'll be excluded in the search.
985 static struct untracked_cache_dir
*lookup_untracked(struct untracked_cache
*uc
,
986 struct untracked_cache_dir
*dir
,
987 const char *name
, int len
)
990 struct untracked_cache_dir
*d
;
993 if (len
&& name
[len
- 1] == '/')
997 while (last
> first
) {
998 int cmp
, next
= first
+ ((last
- first
) >> 1);
1000 cmp
= strncmp(name
, d
->name
, len
);
1001 if (!cmp
&& strlen(d
->name
) > len
)
1013 FLEX_ALLOC_MEM(d
, name
, name
, len
);
1015 ALLOC_GROW(dir
->dirs
, dir
->dirs_nr
+ 1, dir
->dirs_alloc
);
1016 MOVE_ARRAY(dir
->dirs
+ first
+ 1, dir
->dirs
+ first
,
1017 dir
->dirs_nr
- first
);
1019 dir
->dirs
[first
] = d
;
1023 static void do_invalidate_gitignore(struct untracked_cache_dir
*dir
)
1027 dir
->untracked_nr
= 0;
1028 for (i
= 0; i
< dir
->dirs_nr
; i
++)
1029 do_invalidate_gitignore(dir
->dirs
[i
]);
1032 static void invalidate_gitignore(struct untracked_cache
*uc
,
1033 struct untracked_cache_dir
*dir
)
1035 uc
->gitignore_invalidated
++;
1036 do_invalidate_gitignore(dir
);
1039 static void invalidate_directory(struct untracked_cache
*uc
,
1040 struct untracked_cache_dir
*dir
)
1045 * Invalidation increment here is just roughly correct. If
1046 * untracked_nr or any of dirs[].recurse is non-zero, we
1047 * should increment dir_invalidated too. But that's more
1051 uc
->dir_invalidated
++;
1054 dir
->untracked_nr
= 0;
1055 for (i
= 0; i
< dir
->dirs_nr
; i
++)
1056 dir
->dirs
[i
]->recurse
= 0;
1059 static int add_patterns_from_buffer(char *buf
, size_t size
,
1060 const char *base
, int baselen
,
1061 struct pattern_list
*pl
);
1063 /* Flags for add_patterns() */
1064 #define PATTERN_NOFOLLOW (1<<0)
1067 * Given a file with name "fname", read it (either from disk, or from
1068 * an index if 'istate' is non-null), parse it and store the
1069 * exclude rules in "pl".
1071 * If "oid_stat" is not NULL, compute oid of the exclude file and fill
1072 * stat data from disk (only valid if add_patterns returns zero). If
1073 * oid_stat.valid is non-zero, "oid_stat" must contain good value as input.
1075 static int add_patterns(const char *fname
, const char *base
, int baselen
,
1076 struct pattern_list
*pl
, struct index_state
*istate
,
1077 unsigned flags
, struct oid_stat
*oid_stat
)
1085 if (flags
& PATTERN_NOFOLLOW
)
1086 fd
= open_nofollow(fname
, O_RDONLY
);
1088 fd
= open(fname
, O_RDONLY
);
1090 if (fd
< 0 || fstat(fd
, &st
) < 0) {
1092 warn_on_fopen_errors(fname
);
1097 r
= read_skip_worktree_file_from_index(istate
, fname
,
1103 size
= xsize_t(st
.st_size
);
1106 fill_stat_data(&oid_stat
->stat
, &st
);
1107 oidcpy(&oid_stat
->oid
, the_hash_algo
->empty_blob
);
1108 oid_stat
->valid
= 1;
1113 buf
= xmallocz(size
);
1114 if (read_in_full(fd
, buf
, size
) != size
) {
1123 if (oid_stat
->valid
&&
1124 !match_stat_data_racy(istate
, &oid_stat
->stat
, &st
))
1125 ; /* no content change, oid_stat->oid still good */
1127 (pos
= index_name_pos(istate
, fname
, strlen(fname
))) >= 0 &&
1128 !ce_stage(istate
->cache
[pos
]) &&
1129 ce_uptodate(istate
->cache
[pos
]) &&
1130 !would_convert_to_git(istate
, fname
))
1131 oidcpy(&oid_stat
->oid
,
1132 &istate
->cache
[pos
]->oid
);
1134 hash_object_file(the_hash_algo
, buf
, size
,
1135 OBJ_BLOB
, &oid_stat
->oid
);
1136 fill_stat_data(&oid_stat
->stat
, &st
);
1137 oid_stat
->valid
= 1;
1141 add_patterns_from_buffer(buf
, size
, base
, baselen
, pl
);
1145 static int add_patterns_from_buffer(char *buf
, size_t size
,
1146 const char *base
, int baselen
,
1147 struct pattern_list
*pl
)
1152 hashmap_init(&pl
->recursive_hashmap
, pl_hashmap_cmp
, NULL
, 0);
1153 hashmap_init(&pl
->parent_hashmap
, pl_hashmap_cmp
, NULL
, 0);
1157 if (skip_utf8_bom(&buf
, size
))
1158 size
-= buf
- pl
->filebuf
;
1162 for (i
= 0; i
< size
; i
++) {
1163 if (buf
[i
] == '\n') {
1164 if (entry
!= buf
+ i
&& entry
[0] != '#') {
1165 buf
[i
- (i
&& buf
[i
-1] == '\r')] = 0;
1166 trim_trailing_spaces(entry
);
1167 add_pattern(entry
, base
, baselen
, pl
, lineno
);
1170 entry
= buf
+ i
+ 1;
1176 int add_patterns_from_file_to_list(const char *fname
, const char *base
,
1177 int baselen
, struct pattern_list
*pl
,
1178 struct index_state
*istate
,
1181 return add_patterns(fname
, base
, baselen
, pl
, istate
, flags
, NULL
);
1184 int add_patterns_from_blob_to_list(
1185 struct object_id
*oid
,
1186 const char *base
, int baselen
,
1187 struct pattern_list
*pl
)
1193 r
= do_read_blob(oid
, NULL
, &size
, &buf
);
1197 add_patterns_from_buffer(buf
, size
, base
, baselen
, pl
);
1201 struct pattern_list
*add_pattern_list(struct dir_struct
*dir
,
1202 int group_type
, const char *src
)
1204 struct pattern_list
*pl
;
1205 struct exclude_list_group
*group
;
1207 group
= &dir
->internal
.exclude_list_group
[group_type
];
1208 ALLOC_GROW(group
->pl
, group
->nr
+ 1, group
->alloc
);
1209 pl
= &group
->pl
[group
->nr
++];
1210 memset(pl
, 0, sizeof(*pl
));
1216 * Used to set up core.excludesfile and .git/info/exclude lists.
1218 static void add_patterns_from_file_1(struct dir_struct
*dir
, const char *fname
,
1219 struct oid_stat
*oid_stat
)
1221 struct pattern_list
*pl
;
1223 * catch setup_standard_excludes() that's called before
1224 * dir->untracked is assigned. That function behaves
1225 * differently when dir->untracked is non-NULL.
1227 if (!dir
->untracked
)
1228 dir
->internal
.unmanaged_exclude_files
++;
1229 pl
= add_pattern_list(dir
, EXC_FILE
, fname
);
1230 if (add_patterns(fname
, "", 0, pl
, NULL
, 0, oid_stat
) < 0)
1231 die(_("cannot use %s as an exclude file"), fname
);
1234 void add_patterns_from_file(struct dir_struct
*dir
, const char *fname
)
1236 dir
->internal
.unmanaged_exclude_files
++; /* see validate_untracked_cache() */
1237 add_patterns_from_file_1(dir
, fname
, NULL
);
1240 int match_basename(const char *basename
, int basenamelen
,
1241 const char *pattern
, int prefix
, int patternlen
,
1244 if (prefix
== patternlen
) {
1245 if (patternlen
== basenamelen
&&
1246 !fspathncmp(pattern
, basename
, basenamelen
))
1248 } else if (flags
& PATTERN_FLAG_ENDSWITH
) {
1249 /* "*literal" matching against "fooliteral" */
1250 if (patternlen
- 1 <= basenamelen
&&
1251 !fspathncmp(pattern
+ 1,
1252 basename
+ basenamelen
- (patternlen
- 1),
1256 if (fnmatch_icase_mem(pattern
, patternlen
,
1257 basename
, basenamelen
,
1264 int match_pathname(const char *pathname
, int pathlen
,
1265 const char *base
, int baselen
,
1266 const char *pattern
, int prefix
, int patternlen
)
1272 * match with FNM_PATHNAME; the pattern has base implicitly
1275 if (*pattern
== '/') {
1282 * baselen does not count the trailing slash. base[] may or
1283 * may not end with a trailing slash though.
1285 if (pathlen
< baselen
+ 1 ||
1286 (baselen
&& pathname
[baselen
] != '/') ||
1287 fspathncmp(pathname
, base
, baselen
))
1290 namelen
= baselen
? pathlen
- baselen
- 1 : pathlen
;
1291 name
= pathname
+ pathlen
- namelen
;
1295 * if the non-wildcard part is longer than the
1296 * remaining pathname, surely it cannot match.
1298 if (prefix
> namelen
)
1301 if (fspathncmp(pattern
, name
, prefix
))
1304 patternlen
-= prefix
;
1309 * If the whole pattern did not have a wildcard,
1310 * then our prefix match is all we need; we
1311 * do not need to call fnmatch at all.
1313 if (!patternlen
&& !namelen
)
1317 return fnmatch_icase_mem(pattern
, patternlen
,
1323 * Scan the given exclude list in reverse to see whether pathname
1324 * should be ignored. The first match (i.e. the last on the list), if
1325 * any, determines the fate. Returns the exclude_list element which
1326 * matched, or NULL for undecided.
1328 static struct path_pattern
*last_matching_pattern_from_list(const char *pathname
,
1330 const char *basename
,
1332 struct pattern_list
*pl
,
1333 struct index_state
*istate
)
1335 struct path_pattern
*res
= NULL
; /* undecided */
1339 return NULL
; /* undefined */
1341 for (i
= pl
->nr
- 1; 0 <= i
; i
--) {
1342 struct path_pattern
*pattern
= pl
->patterns
[i
];
1343 const char *exclude
= pattern
->pattern
;
1344 int prefix
= pattern
->nowildcardlen
;
1346 if (pattern
->flags
& PATTERN_FLAG_MUSTBEDIR
) {
1347 *dtype
= resolve_dtype(*dtype
, istate
, pathname
, pathlen
);
1348 if (*dtype
!= DT_DIR
)
1352 if (pattern
->flags
& PATTERN_FLAG_NODIR
) {
1353 if (match_basename(basename
,
1354 pathlen
- (basename
- pathname
),
1355 exclude
, prefix
, pattern
->patternlen
,
1363 assert(pattern
->baselen
== 0 ||
1364 pattern
->base
[pattern
->baselen
- 1] == '/');
1365 if (match_pathname(pathname
, pathlen
,
1367 pattern
->baselen
? pattern
->baselen
- 1 : 0,
1368 exclude
, prefix
, pattern
->patternlen
)) {
1377 * Scan the list of patterns to determine if the ordered list
1378 * of patterns matches on 'pathname'.
1380 * Return 1 for a match, 0 for not matched and -1 for undecided.
1382 enum pattern_match_result
path_matches_pattern_list(
1383 const char *pathname
, int pathlen
,
1384 const char *basename
, int *dtype
,
1385 struct pattern_list
*pl
,
1386 struct index_state
*istate
)
1388 struct path_pattern
*pattern
;
1389 struct strbuf parent_pathname
= STRBUF_INIT
;
1390 int result
= NOT_MATCHED
;
1393 if (!pl
->use_cone_patterns
) {
1394 pattern
= last_matching_pattern_from_list(pathname
, pathlen
, basename
,
1397 if (pattern
->flags
& PATTERN_FLAG_NEGATIVE
)
1409 strbuf_addch(&parent_pathname
, '/');
1410 strbuf_add(&parent_pathname
, pathname
, pathlen
);
1413 * Directory entries are matched if and only if a file
1414 * contained immediately within them is matched. For the
1415 * case of a directory entry, modify the path to create
1416 * a fake filename within this directory, allowing us to
1417 * use the file-base matching logic in an equivalent way.
1419 if (parent_pathname
.len
> 0 &&
1420 parent_pathname
.buf
[parent_pathname
.len
- 1] == '/') {
1421 slash_pos
= parent_pathname
.len
- 1;
1422 strbuf_add(&parent_pathname
, "-", 1);
1424 const char *slash_ptr
= strrchr(parent_pathname
.buf
, '/');
1425 slash_pos
= slash_ptr
? slash_ptr
- parent_pathname
.buf
: 0;
1428 if (hashmap_contains_path(&pl
->recursive_hashmap
,
1429 &parent_pathname
)) {
1430 result
= MATCHED_RECURSIVE
;
1435 /* include every file in root */
1440 strbuf_setlen(&parent_pathname
, slash_pos
);
1442 if (hashmap_contains_path(&pl
->parent_hashmap
, &parent_pathname
)) {
1447 if (hashmap_contains_parent(&pl
->recursive_hashmap
,
1450 result
= MATCHED_RECURSIVE
;
1453 strbuf_release(&parent_pathname
);
1457 int init_sparse_checkout_patterns(struct index_state
*istate
)
1459 if (!core_apply_sparse_checkout
)
1461 if (istate
->sparse_checkout_patterns
)
1464 CALLOC_ARRAY(istate
->sparse_checkout_patterns
, 1);
1466 if (get_sparse_checkout_patterns(istate
->sparse_checkout_patterns
) < 0) {
1467 FREE_AND_NULL(istate
->sparse_checkout_patterns
);
1474 static int path_in_sparse_checkout_1(const char *path
,
1475 struct index_state
*istate
,
1476 int require_cone_mode
)
1479 enum pattern_match_result match
= UNDECIDED
;
1480 const char *end
, *slash
;
1483 * We default to accepting a path if the path is empty, there are no
1484 * patterns, or the patterns are of the wrong type.
1487 init_sparse_checkout_patterns(istate
) ||
1488 (require_cone_mode
&&
1489 !istate
->sparse_checkout_patterns
->use_cone_patterns
))
1493 * If UNDECIDED, use the match from the parent dir (recursively), or
1494 * fall back to NOT_MATCHED at the topmost level. Note that cone mode
1495 * never returns UNDECIDED, so we will execute only one iteration in
1498 for (end
= path
+ strlen(path
);
1499 end
> path
&& match
== UNDECIDED
;
1502 for (slash
= end
- 1; slash
> path
&& *slash
!= '/'; slash
--)
1505 match
= path_matches_pattern_list(path
, end
- path
,
1506 slash
> path
? slash
+ 1 : path
, &dtype
,
1507 istate
->sparse_checkout_patterns
, istate
);
1509 /* We are going to match the parent dir now */
1515 int path_in_sparse_checkout(const char *path
,
1516 struct index_state
*istate
)
1518 return path_in_sparse_checkout_1(path
, istate
, 0);
1521 int path_in_cone_mode_sparse_checkout(const char *path
,
1522 struct index_state
*istate
)
1524 return path_in_sparse_checkout_1(path
, istate
, 1);
1527 static struct path_pattern
*last_matching_pattern_from_lists(
1528 struct dir_struct
*dir
, struct index_state
*istate
,
1529 const char *pathname
, int pathlen
,
1530 const char *basename
, int *dtype_p
)
1533 struct exclude_list_group
*group
;
1534 struct path_pattern
*pattern
;
1535 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
1536 group
= &dir
->internal
.exclude_list_group
[i
];
1537 for (j
= group
->nr
- 1; j
>= 0; j
--) {
1538 pattern
= last_matching_pattern_from_list(
1539 pathname
, pathlen
, basename
, dtype_p
,
1540 &group
->pl
[j
], istate
);
1549 * Loads the per-directory exclude list for the substring of base
1550 * which has a char length of baselen.
1552 static void prep_exclude(struct dir_struct
*dir
,
1553 struct index_state
*istate
,
1554 const char *base
, int baselen
)
1556 struct exclude_list_group
*group
;
1557 struct pattern_list
*pl
;
1558 struct exclude_stack
*stk
= NULL
;
1559 struct untracked_cache_dir
*untracked
;
1562 group
= &dir
->internal
.exclude_list_group
[EXC_DIRS
];
1565 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
1566 * which originate from directories not in the prefix of the
1567 * path being checked.
1569 while ((stk
= dir
->internal
.exclude_stack
) != NULL
) {
1570 if (stk
->baselen
<= baselen
&&
1571 !strncmp(dir
->internal
.basebuf
.buf
, base
, stk
->baselen
))
1573 pl
= &group
->pl
[dir
->internal
.exclude_stack
->exclude_ix
];
1574 dir
->internal
.exclude_stack
= stk
->prev
;
1575 dir
->internal
.pattern
= NULL
;
1576 free((char *)pl
->src
); /* see strbuf_detach() below */
1577 clear_pattern_list(pl
);
1582 /* Skip traversing into sub directories if the parent is excluded */
1583 if (dir
->internal
.pattern
)
1587 * Lazy initialization. All call sites currently just
1588 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1589 * them seems lots of work for little benefit.
1591 if (!dir
->internal
.basebuf
.buf
)
1592 strbuf_init(&dir
->internal
.basebuf
, PATH_MAX
);
1594 /* Read from the parent directories and push them down. */
1595 current
= stk
? stk
->baselen
: -1;
1596 strbuf_setlen(&dir
->internal
.basebuf
, current
< 0 ? 0 : current
);
1598 untracked
= stk
? stk
->ucd
: dir
->untracked
->root
;
1602 while (current
< baselen
) {
1604 struct oid_stat oid_stat
;
1606 CALLOC_ARRAY(stk
, 1);
1611 cp
= strchr(base
+ current
+ 1, '/');
1613 die("oops in prep_exclude");
1616 lookup_untracked(dir
->untracked
,
1619 cp
- base
- current
);
1621 stk
->prev
= dir
->internal
.exclude_stack
;
1622 stk
->baselen
= cp
- base
;
1623 stk
->exclude_ix
= group
->nr
;
1624 stk
->ucd
= untracked
;
1625 pl
= add_pattern_list(dir
, EXC_DIRS
, NULL
);
1626 strbuf_add(&dir
->internal
.basebuf
, base
+ current
, stk
->baselen
- current
);
1627 assert(stk
->baselen
== dir
->internal
.basebuf
.len
);
1629 /* Abort if the directory is excluded */
1632 dir
->internal
.basebuf
.buf
[stk
->baselen
- 1] = 0;
1633 dir
->internal
.pattern
= last_matching_pattern_from_lists(dir
,
1635 dir
->internal
.basebuf
.buf
, stk
->baselen
- 1,
1636 dir
->internal
.basebuf
.buf
+ current
, &dt
);
1637 dir
->internal
.basebuf
.buf
[stk
->baselen
- 1] = '/';
1638 if (dir
->internal
.pattern
&&
1639 dir
->internal
.pattern
->flags
& PATTERN_FLAG_NEGATIVE
)
1640 dir
->internal
.pattern
= NULL
;
1641 if (dir
->internal
.pattern
) {
1642 dir
->internal
.exclude_stack
= stk
;
1647 /* Try to read per-directory file */
1648 oidclr(&oid_stat
.oid
);
1650 if (dir
->exclude_per_dir
&&
1652 * If we know that no files have been added in
1653 * this directory (i.e. valid_cached_dir() has
1654 * been executed and set untracked->valid) ..
1656 (!untracked
|| !untracked
->valid
||
1658 * .. and .gitignore does not exist before
1659 * (i.e. null exclude_oid). Then we can skip
1660 * loading .gitignore, which would result in
1663 !is_null_oid(&untracked
->exclude_oid
))) {
1665 * dir->internal.basebuf gets reused by the traversal,
1666 * but we need fname to remain unchanged to ensure the
1667 * src member of each struct path_pattern correctly
1668 * back-references its source file. Other invocations
1669 * of add_pattern_list provide stable strings, so we
1670 * strbuf_detach() and free() here in the caller.
1672 struct strbuf sb
= STRBUF_INIT
;
1673 strbuf_addbuf(&sb
, &dir
->internal
.basebuf
);
1674 strbuf_addstr(&sb
, dir
->exclude_per_dir
);
1675 pl
->src
= strbuf_detach(&sb
, NULL
);
1676 add_patterns(pl
->src
, pl
->src
, stk
->baselen
, pl
, istate
,
1678 untracked
? &oid_stat
: NULL
);
1681 * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1682 * will first be called in valid_cached_dir() then maybe many
1683 * times more in last_matching_pattern(). When the cache is
1684 * used, last_matching_pattern() will not be called and
1685 * reading .gitignore content will be a waste.
1687 * So when it's called by valid_cached_dir() and we can get
1688 * .gitignore SHA-1 from the index (i.e. .gitignore is not
1689 * modified on work tree), we could delay reading the
1690 * .gitignore content until we absolutely need it in
1691 * last_matching_pattern(). Be careful about ignore rule
1692 * order, though, if you do that.
1695 !oideq(&oid_stat
.oid
, &untracked
->exclude_oid
)) {
1696 invalidate_gitignore(dir
->untracked
, untracked
);
1697 oidcpy(&untracked
->exclude_oid
, &oid_stat
.oid
);
1699 dir
->internal
.exclude_stack
= stk
;
1700 current
= stk
->baselen
;
1702 strbuf_setlen(&dir
->internal
.basebuf
, baselen
);
1706 * Loads the exclude lists for the directory containing pathname, then
1707 * scans all exclude lists to determine whether pathname is excluded.
1708 * Returns the exclude_list element which matched, or NULL for
1711 struct path_pattern
*last_matching_pattern(struct dir_struct
*dir
,
1712 struct index_state
*istate
,
1713 const char *pathname
,
1716 int pathlen
= strlen(pathname
);
1717 const char *basename
= strrchr(pathname
, '/');
1718 basename
= (basename
) ? basename
+1 : pathname
;
1720 prep_exclude(dir
, istate
, pathname
, basename
-pathname
);
1722 if (dir
->internal
.pattern
)
1723 return dir
->internal
.pattern
;
1725 return last_matching_pattern_from_lists(dir
, istate
, pathname
, pathlen
,
1730 * Loads the exclude lists for the directory containing pathname, then
1731 * scans all exclude lists to determine whether pathname is excluded.
1732 * Returns 1 if true, otherwise 0.
1734 int is_excluded(struct dir_struct
*dir
, struct index_state
*istate
,
1735 const char *pathname
, int *dtype_p
)
1737 struct path_pattern
*pattern
=
1738 last_matching_pattern(dir
, istate
, pathname
, dtype_p
);
1740 return pattern
->flags
& PATTERN_FLAG_NEGATIVE
? 0 : 1;
1744 static struct dir_entry
*dir_entry_new(const char *pathname
, int len
)
1746 struct dir_entry
*ent
;
1748 FLEX_ALLOC_MEM(ent
, name
, pathname
, len
);
1753 static struct dir_entry
*dir_add_name(struct dir_struct
*dir
,
1754 struct index_state
*istate
,
1755 const char *pathname
, int len
)
1757 if (index_file_exists(istate
, pathname
, len
, ignore_case
))
1760 ALLOC_GROW(dir
->entries
, dir
->nr
+1, dir
->internal
.alloc
);
1761 return dir
->entries
[dir
->nr
++] = dir_entry_new(pathname
, len
);
1764 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
,
1765 struct index_state
*istate
,
1766 const char *pathname
, int len
)
1768 if (!index_name_is_other(istate
, pathname
, len
))
1771 ALLOC_GROW(dir
->ignored
, dir
->ignored_nr
+1, dir
->internal
.ignored_alloc
);
1772 return dir
->ignored
[dir
->ignored_nr
++] = dir_entry_new(pathname
, len
);
1776 index_nonexistent
= 0,
1782 * Do not use the alphabetically sorted index to look up
1783 * the directory name; instead, use the case insensitive
1786 static enum exist_status
directory_exists_in_index_icase(struct index_state
*istate
,
1787 const char *dirname
, int len
)
1789 struct cache_entry
*ce
;
1791 if (index_dir_exists(istate
, dirname
, len
))
1792 return index_directory
;
1794 ce
= index_file_exists(istate
, dirname
, len
, ignore_case
);
1795 if (ce
&& S_ISGITLINK(ce
->ce_mode
))
1796 return index_gitdir
;
1798 return index_nonexistent
;
1802 * The index sorts alphabetically by entry name, which
1803 * means that a gitlink sorts as '\0' at the end, while
1804 * a directory (which is defined not as an entry, but as
1805 * the files it contains) will sort with the '/' at the
1808 static enum exist_status
directory_exists_in_index(struct index_state
*istate
,
1809 const char *dirname
, int len
)
1814 return directory_exists_in_index_icase(istate
, dirname
, len
);
1816 pos
= index_name_pos(istate
, dirname
, len
);
1819 while (pos
< istate
->cache_nr
) {
1820 const struct cache_entry
*ce
= istate
->cache
[pos
++];
1821 unsigned char endchar
;
1823 if (strncmp(ce
->name
, dirname
, len
))
1825 endchar
= ce
->name
[len
];
1829 return index_directory
;
1830 if (!endchar
&& S_ISGITLINK(ce
->ce_mode
))
1831 return index_gitdir
;
1833 return index_nonexistent
;
1837 * When we find a directory when traversing the filesystem, we
1838 * have three distinct cases:
1841 * - see it as a directory
1844 * and which one we choose depends on a combination of existing
1845 * git index contents and the flags passed into the directory
1846 * traversal routine.
1848 * Case 1: If we *already* have entries in the index under that
1849 * directory name, we always recurse into the directory to see
1852 * Case 2: If we *already* have that directory name as a gitlink,
1853 * we always continue to see it as a gitlink, regardless of whether
1854 * there is an actual git directory there or not (it might not
1855 * be checked out as a subproject!)
1857 * Case 3: if we didn't have it in the index previously, we
1858 * have a few sub-cases:
1860 * (a) if DIR_SHOW_OTHER_DIRECTORIES flag is set, we show it as
1861 * just a directory, unless DIR_HIDE_EMPTY_DIRECTORIES is
1862 * also true, in which case we need to check if it contains any
1863 * untracked and / or ignored files.
1864 * (b) if it looks like a git directory and we don't have the
1865 * DIR_NO_GITLINKS flag, then we treat it as a gitlink, and
1866 * show it as a directory.
1867 * (c) otherwise, we recurse into it.
1869 static enum path_treatment
treat_directory(struct dir_struct
*dir
,
1870 struct index_state
*istate
,
1871 struct untracked_cache_dir
*untracked
,
1872 const char *dirname
, int len
, int baselen
, int excluded
,
1873 const struct pathspec
*pathspec
)
1876 * WARNING: From this function, you can return path_recurse or you
1877 * can call read_directory_recursive() (or neither), but
1878 * you CAN'T DO BOTH.
1880 enum path_treatment state
;
1881 int matches_how
= 0;
1882 int check_only
, stop_early
;
1883 int old_ignored_nr
, old_untracked_nr
;
1884 /* The "len-1" is to strip the final '/' */
1885 enum exist_status status
= directory_exists_in_index(istate
, dirname
, len
-1);
1887 if (status
== index_directory
)
1888 return path_recurse
;
1889 if (status
== index_gitdir
)
1891 if (status
!= index_nonexistent
)
1892 BUG("Unhandled value for directory_exists_in_index: %d\n", status
);
1895 * We don't want to descend into paths that don't match the necessary
1896 * patterns. Clearly, if we don't have a pathspec, then we can't check
1897 * for matching patterns. Also, if (excluded) then we know we matched
1898 * the exclusion patterns so as an optimization we can skip checking
1899 * for matching patterns.
1901 if (pathspec
&& !excluded
) {
1902 matches_how
= match_pathspec_with_flags(istate
, pathspec
,
1906 DO_MATCH_LEADING_PATHSPEC
);
1912 if ((dir
->flags
& DIR_SKIP_NESTED_GIT
) ||
1913 !(dir
->flags
& DIR_NO_GITLINKS
)) {
1915 * Determine if `dirname` is a nested repo by confirming that:
1916 * 1) we are in a nonbare repository, and
1917 * 2) `dirname` is not an immediate parent of `the_repository->gitdir`,
1918 * which could occur if the git_dir or worktree location was
1919 * manually configured by the user; see t2205 testcases 1-3 for
1920 * examples where this matters
1923 struct strbuf sb
= STRBUF_INIT
;
1924 strbuf_addstr(&sb
, dirname
);
1925 nested_repo
= is_nonbare_repository_dir(&sb
);
1928 char *real_dirname
, *real_gitdir
;
1929 strbuf_addstr(&sb
, ".git");
1930 real_dirname
= real_pathdup(sb
.buf
, 1);
1931 real_gitdir
= real_pathdup(the_repository
->gitdir
, 1);
1933 nested_repo
= !!strcmp(real_dirname
, real_gitdir
);
1937 strbuf_release(&sb
);
1940 if ((dir
->flags
& DIR_SKIP_NESTED_GIT
) ||
1941 (matches_how
== MATCHED_RECURSIVELY_LEADING_PATHSPEC
))
1943 return excluded
? path_excluded
: path_untracked
;
1947 if (!(dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
)) {
1949 (dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
1950 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
)) {
1953 * This is an excluded directory and we are
1954 * showing ignored paths that match an exclude
1955 * pattern. (e.g. show directory as ignored
1956 * only if it matches an exclude pattern).
1957 * This path will either be 'path_excluded`
1958 * (if we are showing empty directories or if
1959 * the directory is not empty), or will be
1960 * 'path_none' (empty directory, and we are
1961 * not showing empty directories).
1963 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
1964 return path_excluded
;
1966 if (read_directory_recursive(dir
, istate
, dirname
, len
,
1967 untracked
, 1, 1, pathspec
) == path_excluded
)
1968 return path_excluded
;
1972 return path_recurse
;
1975 assert(dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
);
1978 * If we have a pathspec which could match something _below_ this
1979 * directory (e.g. when checking 'subdir/' having a pathspec like
1980 * 'subdir/some/deep/path/file' or 'subdir/widget-*.c'), then we
1983 if (matches_how
== MATCHED_RECURSIVELY_LEADING_PATHSPEC
)
1984 return path_recurse
;
1986 /* Special cases for where this directory is excluded/ignored */
1989 * If DIR_SHOW_OTHER_DIRECTORIES is set and we're not
1990 * hiding empty directories, there is no need to
1991 * recurse into an ignored directory.
1993 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
1994 return path_excluded
;
1997 * Even if we are hiding empty directories, we can still avoid
1998 * recursing into ignored directories for DIR_SHOW_IGNORED_TOO
1999 * if DIR_SHOW_IGNORED_TOO_MODE_MATCHING is also set.
2001 if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
2002 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
))
2003 return path_excluded
;
2007 * Other than the path_recurse case above, we only need to
2008 * recurse into untracked directories if any of the following
2010 * - DIR_SHOW_IGNORED (because then we need to determine if
2011 * there are ignored entries below)
2012 * - DIR_SHOW_IGNORED_TOO (same as above)
2013 * - DIR_HIDE_EMPTY_DIRECTORIES (because we have to determine if
2014 * the directory is empty)
2017 !(dir
->flags
& (DIR_SHOW_IGNORED
|
2018 DIR_SHOW_IGNORED_TOO
|
2019 DIR_HIDE_EMPTY_DIRECTORIES
))) {
2020 return path_untracked
;
2024 * Even if we don't want to know all the paths under an untracked or
2025 * ignored directory, we may still need to go into the directory to
2026 * determine if it is empty (because with DIR_HIDE_EMPTY_DIRECTORIES,
2027 * an empty directory should be path_none instead of path_excluded or
2030 check_only
= ((dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
) &&
2031 !(dir
->flags
& DIR_SHOW_IGNORED_TOO
));
2034 * However, there's another optimization possible as a subset of
2035 * check_only, based on the cases we have to consider:
2036 * A) Directory matches no exclude patterns:
2037 * * Directory is empty => path_none
2038 * * Directory has an untracked file under it => path_untracked
2039 * * Directory has only ignored files under it => path_excluded
2040 * B) Directory matches an exclude pattern:
2041 * * Directory is empty => path_none
2042 * * Directory has an untracked file under it => path_excluded
2043 * * Directory has only ignored files under it => path_excluded
2044 * In case A, we can exit as soon as we've found an untracked
2045 * file but otherwise have to walk all files. In case B, though,
2046 * we can stop at the first file we find under the directory.
2048 stop_early
= check_only
&& excluded
;
2051 * If /every/ file within an untracked directory is ignored, then
2052 * we want to treat the directory as ignored (for e.g. status
2053 * --porcelain), without listing the individual ignored files
2054 * underneath. To do so, we'll save the current ignored_nr, and
2055 * pop all the ones added after it if it turns out the entire
2056 * directory is ignored. Also, when DIR_SHOW_IGNORED_TOO and
2057 * !DIR_KEEP_UNTRACKED_CONTENTS then we don't want to show
2058 * untracked paths so will need to pop all those off the last
2059 * after we traverse.
2061 old_ignored_nr
= dir
->ignored_nr
;
2062 old_untracked_nr
= dir
->nr
;
2064 /* Actually recurse into dirname now, we'll fixup the state later. */
2065 untracked
= lookup_untracked(dir
->untracked
, untracked
,
2066 dirname
+ baselen
, len
- baselen
);
2067 state
= read_directory_recursive(dir
, istate
, dirname
, len
, untracked
,
2068 check_only
, stop_early
, pathspec
);
2070 /* There are a variety of reasons we may need to fixup the state... */
2071 if (state
== path_excluded
) {
2072 /* state == path_excluded implies all paths under
2073 * dirname were ignored...
2075 * if running e.g. `git status --porcelain --ignored=matching`,
2076 * then we want to see the subpaths that are ignored.
2078 * if running e.g. just `git status --porcelain`, then
2079 * we just want the directory itself to be listed as ignored
2080 * and not the individual paths underneath.
2082 int want_ignored_subpaths
=
2083 ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
2084 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
));
2086 if (want_ignored_subpaths
) {
2088 * with --ignored=matching, we want the subpaths
2089 * INSTEAD of the directory itself.
2094 for (i
= old_ignored_nr
+ 1; i
<dir
->ignored_nr
; ++i
)
2095 FREE_AND_NULL(dir
->ignored
[i
]);
2096 dir
->ignored_nr
= old_ignored_nr
;
2101 * We may need to ignore some of the untracked paths we found while
2102 * traversing subdirectories.
2104 if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
2105 !(dir
->flags
& DIR_KEEP_UNTRACKED_CONTENTS
)) {
2107 for (i
= old_untracked_nr
+ 1; i
<dir
->nr
; ++i
)
2108 FREE_AND_NULL(dir
->entries
[i
]);
2109 dir
->nr
= old_untracked_nr
;
2113 * If there is nothing under the current directory and we are not
2114 * hiding empty directories, then we need to report on the
2115 * untracked or ignored status of the directory itself.
2117 if (state
== path_none
&& !(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
2118 state
= excluded
? path_excluded
: path_untracked
;
2124 * This is an inexact early pruning of any recursive directory
2125 * reading - if the path cannot possibly be in the pathspec,
2126 * return true, and we'll skip it early.
2128 static int simplify_away(const char *path
, int pathlen
,
2129 const struct pathspec
*pathspec
)
2133 if (!pathspec
|| !pathspec
->nr
)
2136 GUARD_PATHSPEC(pathspec
,
2145 for (i
= 0; i
< pathspec
->nr
; i
++) {
2146 const struct pathspec_item
*item
= &pathspec
->items
[i
];
2147 int len
= item
->nowildcard_len
;
2151 if (!ps_strncmp(item
, item
->match
, path
, len
))
2159 * This function tells us whether an excluded path matches a
2160 * list of "interesting" pathspecs. That is, whether a path matched
2161 * by any of the pathspecs could possibly be ignored by excluding
2162 * the specified path. This can happen if:
2164 * 1. the path is mentioned explicitly in the pathspec
2166 * 2. the path is a directory prefix of some element in the
2169 static int exclude_matches_pathspec(const char *path
, int pathlen
,
2170 const struct pathspec
*pathspec
)
2174 if (!pathspec
|| !pathspec
->nr
)
2177 GUARD_PATHSPEC(pathspec
,
2185 for (i
= 0; i
< pathspec
->nr
; i
++) {
2186 const struct pathspec_item
*item
= &pathspec
->items
[i
];
2187 int len
= item
->nowildcard_len
;
2189 if (len
== pathlen
&&
2190 !ps_strncmp(item
, item
->match
, path
, pathlen
))
2192 if (len
> pathlen
&&
2193 item
->match
[pathlen
] == '/' &&
2194 !ps_strncmp(item
, item
->match
, path
, pathlen
))
2200 static int get_index_dtype(struct index_state
*istate
,
2201 const char *path
, int len
)
2204 const struct cache_entry
*ce
;
2206 ce
= index_file_exists(istate
, path
, len
, 0);
2208 if (!ce_uptodate(ce
))
2210 if (S_ISGITLINK(ce
->ce_mode
))
2213 * Nobody actually cares about the
2214 * difference between DT_LNK and DT_REG
2219 /* Try to look it up as a directory */
2220 pos
= index_name_pos(istate
, path
, len
);
2224 while (pos
< istate
->cache_nr
) {
2225 ce
= istate
->cache
[pos
++];
2226 if (strncmp(ce
->name
, path
, len
))
2228 if (ce
->name
[len
] > '/')
2230 if (ce
->name
[len
] < '/')
2232 if (!ce_uptodate(ce
))
2233 break; /* continue? */
2239 static int resolve_dtype(int dtype
, struct index_state
*istate
,
2240 const char *path
, int len
)
2244 if (dtype
!= DT_UNKNOWN
)
2246 dtype
= get_index_dtype(istate
, path
, len
);
2247 if (dtype
!= DT_UNKNOWN
)
2249 if (lstat(path
, &st
))
2251 if (S_ISREG(st
.st_mode
))
2253 if (S_ISDIR(st
.st_mode
))
2255 if (S_ISLNK(st
.st_mode
))
2260 static enum path_treatment
treat_path_fast(struct dir_struct
*dir
,
2261 struct cached_dir
*cdir
,
2262 struct index_state
*istate
,
2263 struct strbuf
*path
,
2265 const struct pathspec
*pathspec
)
2268 * WARNING: From this function, you can return path_recurse or you
2269 * can call read_directory_recursive() (or neither), but
2270 * you CAN'T DO BOTH.
2272 strbuf_setlen(path
, baselen
);
2274 strbuf_addstr(path
, cdir
->file
);
2275 return path_untracked
;
2277 strbuf_addstr(path
, cdir
->ucd
->name
);
2278 /* treat_one_path() does this before it calls treat_directory() */
2279 strbuf_complete(path
, '/');
2280 if (cdir
->ucd
->check_only
)
2282 * check_only is set as a result of treat_directory() getting
2283 * to its bottom. Verify again the same set of directories
2284 * with check_only set.
2286 return read_directory_recursive(dir
, istate
, path
->buf
, path
->len
,
2287 cdir
->ucd
, 1, 0, pathspec
);
2289 * We get path_recurse in the first run when
2290 * directory_exists_in_index() returns index_nonexistent. We
2291 * are sure that new changes in the index does not impact the
2292 * outcome. Return now.
2294 return path_recurse
;
2297 static enum path_treatment
treat_path(struct dir_struct
*dir
,
2298 struct untracked_cache_dir
*untracked
,
2299 struct cached_dir
*cdir
,
2300 struct index_state
*istate
,
2301 struct strbuf
*path
,
2303 const struct pathspec
*pathspec
)
2305 int has_path_in_index
, dtype
, excluded
;
2308 return treat_path_fast(dir
, cdir
, istate
, path
,
2310 if (is_dot_or_dotdot(cdir
->d_name
) || !fspathcmp(cdir
->d_name
, ".git"))
2312 strbuf_setlen(path
, baselen
);
2313 strbuf_addstr(path
, cdir
->d_name
);
2314 if (simplify_away(path
->buf
, path
->len
, pathspec
))
2317 dtype
= resolve_dtype(cdir
->d_type
, istate
, path
->buf
, path
->len
);
2319 /* Always exclude indexed files */
2320 has_path_in_index
= !!index_file_exists(istate
, path
->buf
, path
->len
,
2322 if (dtype
!= DT_DIR
&& has_path_in_index
)
2326 * When we are looking at a directory P in the working tree,
2327 * there are three cases:
2329 * (1) P exists in the index. Everything inside the directory P in
2330 * the working tree needs to go when P is checked out from the
2333 * (2) P does not exist in the index, but there is P/Q in the index.
2334 * We know P will stay a directory when we check out the contents
2335 * of the index, but we do not know yet if there is a directory
2336 * P/Q in the working tree to be killed, so we need to recurse.
2338 * (3) P does not exist in the index, and there is no P/Q in the index
2339 * to require P to be a directory, either. Only in this case, we
2340 * know that everything inside P will not be killed without
2343 if ((dir
->flags
& DIR_COLLECT_KILLED_ONLY
) &&
2344 (dtype
== DT_DIR
) &&
2345 !has_path_in_index
&&
2346 (directory_exists_in_index(istate
, path
->buf
, path
->len
) == index_nonexistent
))
2349 excluded
= is_excluded(dir
, istate
, path
->buf
, &dtype
);
2352 * Excluded? If we don't explicitly want to show
2353 * ignored files, ignore it
2355 if (excluded
&& !(dir
->flags
& (DIR_SHOW_IGNORED
|DIR_SHOW_IGNORED_TOO
)))
2356 return path_excluded
;
2363 * WARNING: Do not ignore/amend the return value from
2364 * treat_directory(), and especially do not change it to return
2365 * path_recurse as that can cause exponential slowdown.
2366 * Instead, modify treat_directory() to return the right value.
2368 strbuf_addch(path
, '/');
2369 return treat_directory(dir
, istate
, untracked
,
2370 path
->buf
, path
->len
,
2371 baselen
, excluded
, pathspec
);
2375 !match_pathspec(istate
, pathspec
, path
->buf
, path
->len
,
2376 0 /* prefix */, NULL
/* seen */,
2380 return path_excluded
;
2381 return path_untracked
;
2385 static void add_untracked(struct untracked_cache_dir
*dir
, const char *name
)
2389 ALLOC_GROW(dir
->untracked
, dir
->untracked_nr
+ 1,
2390 dir
->untracked_alloc
);
2391 dir
->untracked
[dir
->untracked_nr
++] = xstrdup(name
);
2394 static int valid_cached_dir(struct dir_struct
*dir
,
2395 struct untracked_cache_dir
*untracked
,
2396 struct index_state
*istate
,
2397 struct strbuf
*path
,
2406 * With fsmonitor, we can trust the untracked cache's valid field.
2408 refresh_fsmonitor(istate
);
2409 if (!(dir
->untracked
->use_fsmonitor
&& untracked
->valid
)) {
2410 if (lstat(path
->len
? path
->buf
: ".", &st
)) {
2411 memset(&untracked
->stat_data
, 0, sizeof(untracked
->stat_data
));
2414 if (!untracked
->valid
||
2415 match_stat_data_racy(istate
, &untracked
->stat_data
, &st
)) {
2416 fill_stat_data(&untracked
->stat_data
, &st
);
2421 if (untracked
->check_only
!= !!check_only
)
2425 * prep_exclude will be called eventually on this directory,
2426 * but it's called much later in last_matching_pattern(). We
2427 * need it now to determine the validity of the cache for this
2428 * path. The next calls will be nearly no-op, the way
2429 * prep_exclude() is designed.
2431 if (path
->len
&& path
->buf
[path
->len
- 1] != '/') {
2432 strbuf_addch(path
, '/');
2433 prep_exclude(dir
, istate
, path
->buf
, path
->len
);
2434 strbuf_setlen(path
, path
->len
- 1);
2436 prep_exclude(dir
, istate
, path
->buf
, path
->len
);
2438 /* hopefully prep_exclude() haven't invalidated this entry... */
2439 return untracked
->valid
;
2442 static int open_cached_dir(struct cached_dir
*cdir
,
2443 struct dir_struct
*dir
,
2444 struct untracked_cache_dir
*untracked
,
2445 struct index_state
*istate
,
2446 struct strbuf
*path
,
2451 memset(cdir
, 0, sizeof(*cdir
));
2452 cdir
->untracked
= untracked
;
2453 if (valid_cached_dir(dir
, untracked
, istate
, path
, check_only
))
2455 c_path
= path
->len
? path
->buf
: ".";
2456 cdir
->fdir
= opendir(c_path
);
2458 warning_errno(_("could not open directory '%s'"), c_path
);
2459 if (dir
->untracked
) {
2460 invalidate_directory(dir
->untracked
, untracked
);
2461 dir
->untracked
->dir_opened
++;
2468 static int read_cached_dir(struct cached_dir
*cdir
)
2473 de
= readdir_skip_dot_and_dotdot(cdir
->fdir
);
2475 cdir
->d_name
= NULL
;
2476 cdir
->d_type
= DT_UNKNOWN
;
2479 cdir
->d_name
= de
->d_name
;
2480 cdir
->d_type
= DTYPE(de
);
2483 while (cdir
->nr_dirs
< cdir
->untracked
->dirs_nr
) {
2484 struct untracked_cache_dir
*d
= cdir
->untracked
->dirs
[cdir
->nr_dirs
];
2494 if (cdir
->nr_files
< cdir
->untracked
->untracked_nr
) {
2495 struct untracked_cache_dir
*d
= cdir
->untracked
;
2496 cdir
->file
= d
->untracked
[cdir
->nr_files
++];
2502 static void close_cached_dir(struct cached_dir
*cdir
)
2505 closedir(cdir
->fdir
);
2507 * We have gone through this directory and found no untracked
2508 * entries. Mark it valid.
2510 if (cdir
->untracked
) {
2511 cdir
->untracked
->valid
= 1;
2512 cdir
->untracked
->recurse
= 1;
2516 static void add_path_to_appropriate_result_list(struct dir_struct
*dir
,
2517 struct untracked_cache_dir
*untracked
,
2518 struct cached_dir
*cdir
,
2519 struct index_state
*istate
,
2520 struct strbuf
*path
,
2522 const struct pathspec
*pathspec
,
2523 enum path_treatment state
)
2525 /* add the path to the appropriate result list */
2528 if (dir
->flags
& DIR_SHOW_IGNORED
)
2529 dir_add_name(dir
, istate
, path
->buf
, path
->len
);
2530 else if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) ||
2531 ((dir
->flags
& DIR_COLLECT_IGNORED
) &&
2532 exclude_matches_pathspec(path
->buf
, path
->len
,
2534 dir_add_ignored(dir
, istate
, path
->buf
, path
->len
);
2537 case path_untracked
:
2538 if (dir
->flags
& DIR_SHOW_IGNORED
)
2540 dir_add_name(dir
, istate
, path
->buf
, path
->len
);
2542 add_untracked(untracked
, path
->buf
+ baselen
);
2551 * Read a directory tree. We currently ignore anything but
2552 * directories, regular files and symlinks. That's because git
2553 * doesn't handle them at all yet. Maybe that will change some
2556 * Also, we ignore the name ".git" (even if it is not a directory).
2557 * That likely will not change.
2559 * If 'stop_at_first_file' is specified, 'path_excluded' is returned
2560 * to signal that a file was found. This is the least significant value that
2561 * indicates that a file was encountered that does not depend on the order of
2562 * whether an untracked or excluded path was encountered first.
2564 * Returns the most significant path_treatment value encountered in the scan.
2565 * If 'stop_at_first_file' is specified, `path_excluded` is the most
2566 * significant path_treatment value that will be returned.
2569 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
2570 struct index_state
*istate
, const char *base
, int baselen
,
2571 struct untracked_cache_dir
*untracked
, int check_only
,
2572 int stop_at_first_file
, const struct pathspec
*pathspec
)
2575 * WARNING: Do NOT recurse unless path_recurse is returned from
2576 * treat_path(). Recursing on any other return value
2577 * can result in exponential slowdown.
2579 struct cached_dir cdir
;
2580 enum path_treatment state
, subdir_state
, dir_state
= path_none
;
2581 struct strbuf path
= STRBUF_INIT
;
2583 strbuf_add(&path
, base
, baselen
);
2585 if (open_cached_dir(&cdir
, dir
, untracked
, istate
, &path
, check_only
))
2587 dir
->internal
.visited_directories
++;
2590 untracked
->check_only
= !!check_only
;
2592 while (!read_cached_dir(&cdir
)) {
2593 /* check how the file or directory should be treated */
2594 state
= treat_path(dir
, untracked
, &cdir
, istate
, &path
,
2596 dir
->internal
.visited_paths
++;
2598 if (state
> dir_state
)
2601 /* recurse into subdir if instructed by treat_path */
2602 if (state
== path_recurse
) {
2603 struct untracked_cache_dir
*ud
;
2604 ud
= lookup_untracked(dir
->untracked
,
2607 path
.len
- baselen
);
2609 read_directory_recursive(dir
, istate
, path
.buf
,
2611 check_only
, stop_at_first_file
, pathspec
);
2612 if (subdir_state
> dir_state
)
2613 dir_state
= subdir_state
;
2616 !match_pathspec(istate
, pathspec
, path
.buf
, path
.len
,
2617 0 /* prefix */, NULL
,
2618 0 /* do NOT special case dirs */))
2623 if (stop_at_first_file
) {
2625 * If stopping at first file, then
2626 * signal that a file was found by
2627 * returning `path_excluded`. This is
2628 * to return a consistent value
2629 * regardless of whether an ignored or
2630 * excluded file happened to be
2633 * In current usage, the
2634 * `stop_at_first_file` is passed when
2635 * an ancestor directory has matched
2636 * an exclude pattern, so any found
2637 * files will be excluded.
2639 if (dir_state
>= path_excluded
) {
2640 dir_state
= path_excluded
;
2645 /* abort early if maximum state has been reached */
2646 if (dir_state
== path_untracked
) {
2648 add_untracked(untracked
, path
.buf
+ baselen
);
2651 /* skip the add_path_to_appropriate_result_list() */
2655 add_path_to_appropriate_result_list(dir
, untracked
, &cdir
,
2656 istate
, &path
, baselen
,
2659 close_cached_dir(&cdir
);
2661 strbuf_release(&path
);
2666 int cmp_dir_entry(const void *p1
, const void *p2
)
2668 const struct dir_entry
*e1
= *(const struct dir_entry
**)p1
;
2669 const struct dir_entry
*e2
= *(const struct dir_entry
**)p2
;
2671 return name_compare(e1
->name
, e1
->len
, e2
->name
, e2
->len
);
2674 /* check if *out lexically strictly contains *in */
2675 int check_dir_entry_contains(const struct dir_entry
*out
, const struct dir_entry
*in
)
2677 return (out
->len
< in
->len
) &&
2678 (out
->name
[out
->len
- 1] == '/') &&
2679 !memcmp(out
->name
, in
->name
, out
->len
);
2682 static int treat_leading_path(struct dir_struct
*dir
,
2683 struct index_state
*istate
,
2684 const char *path
, int len
,
2685 const struct pathspec
*pathspec
)
2687 struct strbuf sb
= STRBUF_INIT
;
2688 struct strbuf subdir
= STRBUF_INIT
;
2689 int prevlen
, baselen
;
2691 struct cached_dir cdir
;
2692 enum path_treatment state
= path_none
;
2695 * For each directory component of path, we are going to check whether
2696 * that path is relevant given the pathspec. For example, if path is
2698 * then we will ask treat_path() whether we should go into foo, then
2699 * whether we should go into bar, then whether baz is relevant.
2700 * Checking each is important because e.g. if path is
2702 * then we need to check .git to know we shouldn't traverse it.
2703 * If the return from treat_path() is:
2704 * * path_none, for any path, we return false.
2705 * * path_recurse, for all path components, we return true
2706 * * <anything else> for some intermediate component, we make sure
2707 * to add that path to the relevant list but return false
2708 * signifying that we shouldn't recurse into it.
2711 while (len
&& path
[len
- 1] == '/')
2716 memset(&cdir
, 0, sizeof(cdir
));
2717 cdir
.d_type
= DT_DIR
;
2721 prevlen
= baselen
+ !!baselen
;
2722 cp
= path
+ prevlen
;
2723 cp
= memchr(cp
, '/', path
+ len
- cp
);
2727 baselen
= cp
- path
;
2729 strbuf_add(&sb
, path
, baselen
);
2730 if (!is_directory(sb
.buf
))
2733 strbuf_add(&sb
, path
, prevlen
);
2734 strbuf_reset(&subdir
);
2735 strbuf_add(&subdir
, path
+prevlen
, baselen
-prevlen
);
2736 cdir
.d_name
= subdir
.buf
;
2737 state
= treat_path(dir
, NULL
, &cdir
, istate
, &sb
, prevlen
, pathspec
);
2739 if (state
!= path_recurse
)
2740 break; /* do not recurse into it */
2742 break; /* finished checking */
2744 add_path_to_appropriate_result_list(dir
, NULL
, &cdir
, istate
,
2745 &sb
, baselen
, pathspec
,
2748 strbuf_release(&subdir
);
2749 strbuf_release(&sb
);
2750 return state
== path_recurse
;
2753 static const char *get_ident_string(void)
2755 static struct strbuf sb
= STRBUF_INIT
;
2760 if (uname(&uts
) < 0)
2761 die_errno(_("failed to get kernel name and information"));
2762 strbuf_addf(&sb
, "Location %s, system %s", get_git_work_tree(),
2767 static int ident_in_untracked(const struct untracked_cache
*uc
)
2770 * Previous git versions may have saved many NUL separated
2771 * strings in the "ident" field, but it is insane to manage
2772 * many locations, so just take care of the first one.
2775 return !strcmp(uc
->ident
.buf
, get_ident_string());
2778 static void set_untracked_ident(struct untracked_cache
*uc
)
2780 strbuf_reset(&uc
->ident
);
2781 strbuf_addstr(&uc
->ident
, get_ident_string());
2784 * This strbuf used to contain a list of NUL separated
2785 * strings, so save NUL too for backward compatibility.
2787 strbuf_addch(&uc
->ident
, 0);
2790 static unsigned new_untracked_cache_flags(struct index_state
*istate
)
2792 struct repository
*repo
= istate
->repo
;
2796 * This logic is coordinated with the setting of these flags in
2797 * wt-status.c#wt_status_collect_untracked(), and the evaluation
2798 * of the config setting in commit.c#git_status_config()
2800 if (!repo_config_get_string(repo
, "status.showuntrackedfiles", &val
) &&
2801 !strcmp(val
, "all"))
2805 * The default, if "all" is not set, is "normal" - leading us here.
2806 * If the value is "none" then it really doesn't matter.
2808 return DIR_SHOW_OTHER_DIRECTORIES
| DIR_HIDE_EMPTY_DIRECTORIES
;
2811 static void new_untracked_cache(struct index_state
*istate
, int flags
)
2813 struct untracked_cache
*uc
= xcalloc(1, sizeof(*uc
));
2814 strbuf_init(&uc
->ident
, 100);
2815 uc
->exclude_per_dir
= ".gitignore";
2816 uc
->dir_flags
= flags
>= 0 ? flags
: new_untracked_cache_flags(istate
);
2817 set_untracked_ident(uc
);
2818 istate
->untracked
= uc
;
2819 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2822 void add_untracked_cache(struct index_state
*istate
)
2824 if (!istate
->untracked
) {
2825 new_untracked_cache(istate
, -1);
2827 if (!ident_in_untracked(istate
->untracked
)) {
2828 free_untracked_cache(istate
->untracked
);
2829 new_untracked_cache(istate
, -1);
2834 void remove_untracked_cache(struct index_state
*istate
)
2836 if (istate
->untracked
) {
2837 free_untracked_cache(istate
->untracked
);
2838 istate
->untracked
= NULL
;
2839 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2843 static struct untracked_cache_dir
*validate_untracked_cache(struct dir_struct
*dir
,
2845 const struct pathspec
*pathspec
,
2846 struct index_state
*istate
)
2848 struct untracked_cache_dir
*root
;
2849 static int untracked_cache_disabled
= -1;
2851 if (!dir
->untracked
)
2853 if (untracked_cache_disabled
< 0)
2854 untracked_cache_disabled
= git_env_bool("GIT_DISABLE_UNTRACKED_CACHE", 0);
2855 if (untracked_cache_disabled
)
2859 * We only support $GIT_DIR/info/exclude and core.excludesfile
2860 * as the global ignore rule files. Any other additions
2861 * (e.g. from command line) invalidate the cache. This
2862 * condition also catches running setup_standard_excludes()
2863 * before setting dir->untracked!
2865 if (dir
->internal
.unmanaged_exclude_files
)
2869 * Optimize for the main use case only: whole-tree git
2870 * status. More work involved in treat_leading_path() if we
2871 * use cache on just a subset of the worktree. pathspec
2872 * support could make the matter even worse.
2874 if (base_len
|| (pathspec
&& pathspec
->nr
))
2877 /* We don't support collecting ignore files */
2878 if (dir
->flags
& (DIR_SHOW_IGNORED
| DIR_SHOW_IGNORED_TOO
|
2879 DIR_COLLECT_IGNORED
))
2883 * If we use .gitignore in the cache and now you change it to
2884 * .gitexclude, everything will go wrong.
2886 if (dir
->exclude_per_dir
!= dir
->untracked
->exclude_per_dir
&&
2887 strcmp(dir
->exclude_per_dir
, dir
->untracked
->exclude_per_dir
))
2891 * EXC_CMDL is not considered in the cache. If people set it,
2894 if (dir
->internal
.exclude_list_group
[EXC_CMDL
].nr
)
2897 if (!ident_in_untracked(dir
->untracked
)) {
2898 warning(_("untracked cache is disabled on this system or location"));
2903 * If the untracked structure we received does not have the same flags
2904 * as requested in this run, we're going to need to either discard the
2905 * existing structure (and potentially later recreate), or bypass the
2906 * untracked cache mechanism for this run.
2908 if (dir
->flags
!= dir
->untracked
->dir_flags
) {
2910 * If the untracked structure we received does not have the same flags
2911 * as configured, then we need to reset / create a new "untracked"
2912 * structure to match the new config.
2914 * Keeping the saved and used untracked cache consistent with the
2915 * configuration provides an opportunity for frequent users of
2916 * "git status -uall" to leverage the untracked cache by aligning their
2917 * configuration - setting "status.showuntrackedfiles" to "all" or
2918 * "normal" as appropriate.
2920 * Previously using -uall (or setting "status.showuntrackedfiles" to
2921 * "all") was incompatible with untracked cache and *consistently*
2922 * caused surprisingly bad performance (with fscache and fsmonitor
2923 * enabled) on Windows.
2925 * IMPROVEMENT OPPORTUNITY: If we reworked the untracked cache storage
2926 * to not be as bound up with the desired output in a given run,
2927 * and instead iterated through and stored enough information to
2928 * correctly serve both "modes", then users could get peak performance
2929 * with or without '-uall' regardless of their
2930 * "status.showuntrackedfiles" config.
2932 if (dir
->untracked
->dir_flags
!= new_untracked_cache_flags(istate
)) {
2933 free_untracked_cache(istate
->untracked
);
2934 new_untracked_cache(istate
, dir
->flags
);
2935 dir
->untracked
= istate
->untracked
;
2939 * Current untracked cache data is consistent with config, but not
2940 * usable in this request/run; just bypass untracked cache.
2946 if (!dir
->untracked
->root
) {
2947 /* Untracked cache existed but is not initialized; fix that */
2948 FLEX_ALLOC_STR(dir
->untracked
->root
, name
, "");
2949 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2952 /* Validate $GIT_DIR/info/exclude and core.excludesfile */
2953 root
= dir
->untracked
->root
;
2954 if (!oideq(&dir
->internal
.ss_info_exclude
.oid
,
2955 &dir
->untracked
->ss_info_exclude
.oid
)) {
2956 invalidate_gitignore(dir
->untracked
, root
);
2957 dir
->untracked
->ss_info_exclude
= dir
->internal
.ss_info_exclude
;
2959 if (!oideq(&dir
->internal
.ss_excludes_file
.oid
,
2960 &dir
->untracked
->ss_excludes_file
.oid
)) {
2961 invalidate_gitignore(dir
->untracked
, root
);
2962 dir
->untracked
->ss_excludes_file
= dir
->internal
.ss_excludes_file
;
2965 /* Make sure this directory is not dropped out at saving phase */
2970 static void emit_traversal_statistics(struct dir_struct
*dir
,
2971 struct repository
*repo
,
2975 if (!trace2_is_enabled())
2979 trace2_data_string("read_directory", repo
, "path", "");
2981 struct strbuf tmp
= STRBUF_INIT
;
2982 strbuf_add(&tmp
, path
, path_len
);
2983 trace2_data_string("read_directory", repo
, "path", tmp
.buf
);
2984 strbuf_release(&tmp
);
2987 trace2_data_intmax("read_directory", repo
,
2988 "directories-visited", dir
->internal
.visited_directories
);
2989 trace2_data_intmax("read_directory", repo
,
2990 "paths-visited", dir
->internal
.visited_paths
);
2992 if (!dir
->untracked
)
2994 trace2_data_intmax("read_directory", repo
,
2995 "node-creation", dir
->untracked
->dir_created
);
2996 trace2_data_intmax("read_directory", repo
,
2997 "gitignore-invalidation",
2998 dir
->untracked
->gitignore_invalidated
);
2999 trace2_data_intmax("read_directory", repo
,
3000 "directory-invalidation",
3001 dir
->untracked
->dir_invalidated
);
3002 trace2_data_intmax("read_directory", repo
,
3003 "opendir", dir
->untracked
->dir_opened
);
3006 int read_directory(struct dir_struct
*dir
, struct index_state
*istate
,
3007 const char *path
, int len
, const struct pathspec
*pathspec
)
3009 struct untracked_cache_dir
*untracked
;
3011 trace2_region_enter("dir", "read_directory", istate
->repo
);
3012 dir
->internal
.visited_paths
= 0;
3013 dir
->internal
.visited_directories
= 0;
3015 if (has_symlink_leading_path(path
, len
)) {
3016 trace2_region_leave("dir", "read_directory", istate
->repo
);
3020 untracked
= validate_untracked_cache(dir
, len
, pathspec
, istate
);
3023 * make sure untracked cache code path is disabled,
3024 * e.g. prep_exclude()
3026 dir
->untracked
= NULL
;
3027 if (!len
|| treat_leading_path(dir
, istate
, path
, len
, pathspec
))
3028 read_directory_recursive(dir
, istate
, path
, len
, untracked
, 0, 0, pathspec
);
3029 QSORT(dir
->entries
, dir
->nr
, cmp_dir_entry
);
3030 QSORT(dir
->ignored
, dir
->ignored_nr
, cmp_dir_entry
);
3032 emit_traversal_statistics(dir
, istate
->repo
, path
, len
);
3034 trace2_region_leave("dir", "read_directory", istate
->repo
);
3035 if (dir
->untracked
) {
3036 static int force_untracked_cache
= -1;
3038 if (force_untracked_cache
< 0)
3039 force_untracked_cache
=
3040 git_env_bool("GIT_FORCE_UNTRACKED_CACHE", -1);
3041 if (force_untracked_cache
< 0)
3042 force_untracked_cache
= (istate
->repo
->settings
.core_untracked_cache
== UNTRACKED_CACHE_WRITE
);
3043 if (force_untracked_cache
&&
3044 dir
->untracked
== istate
->untracked
&&
3045 (dir
->untracked
->dir_opened
||
3046 dir
->untracked
->gitignore_invalidated
||
3047 dir
->untracked
->dir_invalidated
))
3048 istate
->cache_changed
|= UNTRACKED_CHANGED
;
3049 if (dir
->untracked
!= istate
->untracked
) {
3050 FREE_AND_NULL(dir
->untracked
);
3057 int file_exists(const char *f
)
3060 return lstat(f
, &sb
) == 0;
3063 int repo_file_exists(struct repository
*repo
, const char *path
)
3065 if (repo
!= the_repository
)
3066 BUG("do not know how to check file existence in arbitrary repo");
3068 return file_exists(path
);
3071 static int cmp_icase(char a
, char b
)
3076 return toupper(a
) - toupper(b
);
3081 * Given two normalized paths (a trailing slash is ok), if subdir is
3082 * outside dir, return -1. Otherwise return the offset in subdir that
3083 * can be used as relative path to dir.
3085 int dir_inside_of(const char *subdir
, const char *dir
)
3089 assert(dir
&& subdir
&& *dir
&& *subdir
);
3091 while (*dir
&& *subdir
&& !cmp_icase(*dir
, *subdir
)) {
3097 /* hel[p]/me vs hel[l]/yeah */
3098 if (*dir
&& *subdir
)
3102 return !*dir
? offset
: -1; /* same dir */
3104 /* foo/[b]ar vs foo/[] */
3105 if (is_dir_sep(dir
[-1]))
3106 return is_dir_sep(subdir
[-1]) ? offset
: -1;
3108 /* foo[/]bar vs foo[] */
3109 return is_dir_sep(*subdir
) ? offset
+ 1 : -1;
3112 int is_inside_dir(const char *dir
)
3121 rc
= (dir_inside_of(cwd
, dir
) >= 0);
3126 int is_empty_dir(const char *path
)
3128 DIR *dir
= opendir(path
);
3135 e
= readdir_skip_dot_and_dotdot(dir
);
3143 char *git_url_basename(const char *repo
, int is_bundle
, int is_bare
)
3145 const char *end
= repo
+ strlen(repo
), *start
, *ptr
;
3152 start
= strstr(repo
, "://");
3159 * Skip authentication data. The stripping does happen
3160 * greedily, such that we strip up to the last '@' inside
3163 for (ptr
= start
; ptr
< end
&& !is_dir_sep(*ptr
); ptr
++) {
3169 * Strip trailing spaces, slashes and /.git
3171 while (start
< end
&& (is_dir_sep(end
[-1]) || isspace(end
[-1])))
3173 if (end
- start
> 5 && is_dir_sep(end
[-5]) &&
3174 !strncmp(end
- 4, ".git", 4)) {
3176 while (start
< end
&& is_dir_sep(end
[-1]))
3181 * It should not be possible to overflow `ptrdiff_t` by passing in an
3182 * insanely long URL, but GCC does not know that and will complain
3183 * without this check.
3185 if (end
- start
< 0)
3186 die(_("No directory name could be guessed.\n"
3187 "Please specify a directory on the command line"));
3190 * Strip trailing port number if we've got only a
3191 * hostname (that is, there is no dir separator but a
3192 * colon). This check is required such that we do not
3193 * strip URI's like '/foo/bar:2222.git', which should
3194 * result in a dir '2222' being guessed due to backwards
3197 if (memchr(start
, '/', end
- start
) == NULL
3198 && memchr(start
, ':', end
- start
) != NULL
) {
3200 while (start
< ptr
&& isdigit(ptr
[-1]) && ptr
[-1] != ':')
3202 if (start
< ptr
&& ptr
[-1] == ':')
3207 * Find last component. To remain backwards compatible we
3208 * also regard colons as path separators, such that
3209 * cloning a repository 'foo:bar.git' would result in a
3210 * directory 'bar' being guessed.
3213 while (start
< ptr
&& !is_dir_sep(ptr
[-1]) && ptr
[-1] != ':')
3218 * Strip .{bundle,git}.
3221 strip_suffix_mem(start
, &len
, is_bundle
? ".bundle" : ".git");
3223 if (!len
|| (len
== 1 && *start
== '/'))
3224 die(_("No directory name could be guessed.\n"
3225 "Please specify a directory on the command line"));
3228 dir
= xstrfmt("%.*s.git", (int)len
, start
);
3230 dir
= xstrndup(start
, len
);
3232 * Replace sequences of 'control' characters and whitespace
3233 * with one ascii space, remove leading and trailing spaces.
3237 int prev_space
= 1 /* strip leading whitespace */;
3238 for (end
= dir
; *end
; ++end
) {
3240 if ((unsigned char)ch
< '\x20')
3251 if (out
> dir
&& prev_space
)
3257 void strip_dir_trailing_slashes(char *dir
)
3259 char *end
= dir
+ strlen(dir
);
3261 while (dir
< end
- 1 && is_dir_sep(end
[-1]))
3266 static int remove_dir_recurse(struct strbuf
*path
, int flag
, int *kept_up
)
3270 int ret
= 0, original_len
= path
->len
, len
, kept_down
= 0;
3271 int only_empty
= (flag
& REMOVE_DIR_EMPTY_ONLY
);
3272 int keep_toplevel
= (flag
& REMOVE_DIR_KEEP_TOPLEVEL
);
3273 int purge_original_cwd
= (flag
& REMOVE_DIR_PURGE_ORIGINAL_CWD
);
3274 struct object_id submodule_head
;
3276 if ((flag
& REMOVE_DIR_KEEP_NESTED_GIT
) &&
3277 !resolve_gitlink_ref(path
->buf
, "HEAD", &submodule_head
)) {
3278 /* Do not descend and nuke a nested git work tree. */
3284 flag
&= ~REMOVE_DIR_KEEP_TOPLEVEL
;
3285 dir
= opendir(path
->buf
);
3287 if (errno
== ENOENT
)
3288 return keep_toplevel
? -1 : 0;
3289 else if (errno
== EACCES
&& !keep_toplevel
)
3291 * An empty dir could be removable even if it
3294 return rmdir(path
->buf
);
3298 strbuf_complete(path
, '/');
3301 while ((e
= readdir_skip_dot_and_dotdot(dir
)) != NULL
) {
3304 strbuf_setlen(path
, len
);
3305 strbuf_addstr(path
, e
->d_name
);
3306 if (lstat(path
->buf
, &st
)) {
3307 if (errno
== ENOENT
)
3309 * file disappeared, which is what we
3314 } else if (S_ISDIR(st
.st_mode
)) {
3315 if (!remove_dir_recurse(path
, flag
, &kept_down
))
3316 continue; /* happy */
3317 } else if (!only_empty
&&
3318 (!unlink(path
->buf
) || errno
== ENOENT
)) {
3319 continue; /* happy, too */
3322 /* path too long, stat fails, or non-directory still exists */
3328 strbuf_setlen(path
, original_len
);
3329 if (!ret
&& !keep_toplevel
&& !kept_down
) {
3330 if (!purge_original_cwd
&&
3331 startup_info
->original_cwd
&&
3332 !strcmp(startup_info
->original_cwd
, path
->buf
))
3333 ret
= -1; /* Do not remove current working directory */
3335 ret
= (!rmdir(path
->buf
) || errno
== ENOENT
) ? 0 : -1;
3338 * report the uplevel that it is not an error that we
3339 * did not rmdir() our directory.
3345 int remove_dir_recursively(struct strbuf
*path
, int flag
)
3347 return remove_dir_recurse(path
, flag
, NULL
);
3350 static GIT_PATH_FUNC(git_path_info_exclude
, "info/exclude")
3352 void setup_standard_excludes(struct dir_struct
*dir
)
3354 dir
->exclude_per_dir
= ".gitignore";
3356 /* core.excludesfile defaulting to $XDG_CONFIG_HOME/git/ignore */
3358 excludes_file
= xdg_config_home("ignore");
3359 if (excludes_file
&& !access_or_warn(excludes_file
, R_OK
, 0))
3360 add_patterns_from_file_1(dir
, excludes_file
,
3361 dir
->untracked
? &dir
->internal
.ss_excludes_file
: NULL
);
3363 /* per repository user preference */
3364 if (startup_info
->have_repository
) {
3365 const char *path
= git_path_info_exclude();
3366 if (!access_or_warn(path
, R_OK
, 0))
3367 add_patterns_from_file_1(dir
, path
,
3368 dir
->untracked
? &dir
->internal
.ss_info_exclude
: NULL
);
3372 char *get_sparse_checkout_filename(void)
3374 return git_pathdup("info/sparse-checkout");
3377 int get_sparse_checkout_patterns(struct pattern_list
*pl
)
3380 char *sparse_filename
= get_sparse_checkout_filename();
3382 pl
->use_cone_patterns
= core_sparse_checkout_cone
;
3383 res
= add_patterns_from_file_to_list(sparse_filename
, "", 0, pl
, NULL
, 0);
3385 free(sparse_filename
);
3389 int remove_path(const char *name
)
3393 if (unlink(name
) && !is_missing_file_error(errno
))
3396 slash
= strrchr(name
, '/');
3398 char *dirs
= xstrdup(name
);
3399 slash
= dirs
+ (slash
- name
);
3402 if (startup_info
->original_cwd
&&
3403 !strcmp(startup_info
->original_cwd
, dirs
))
3405 } while (rmdir(dirs
) == 0 && (slash
= strrchr(dirs
, '/')));
3412 * Frees memory within dir which was allocated, and resets fields for further
3413 * use. Does not free dir itself.
3415 void dir_clear(struct dir_struct
*dir
)
3418 struct exclude_list_group
*group
;
3419 struct pattern_list
*pl
;
3420 struct exclude_stack
*stk
;
3421 struct dir_struct
new = DIR_INIT
;
3423 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
3424 group
= &dir
->internal
.exclude_list_group
[i
];
3425 for (j
= 0; j
< group
->nr
; j
++) {
3428 free((char *)pl
->src
);
3429 clear_pattern_list(pl
);
3434 for (i
= 0; i
< dir
->ignored_nr
; i
++)
3435 free(dir
->ignored
[i
]);
3436 for (i
= 0; i
< dir
->nr
; i
++)
3437 free(dir
->entries
[i
]);
3441 stk
= dir
->internal
.exclude_stack
;
3443 struct exclude_stack
*prev
= stk
->prev
;
3447 strbuf_release(&dir
->internal
.basebuf
);
3449 memcpy(dir
, &new, sizeof(*dir
));
3452 struct ondisk_untracked_cache
{
3453 struct stat_data info_exclude_stat
;
3454 struct stat_data excludes_file_stat
;
3458 #define ouc_offset(x) offsetof(struct ondisk_untracked_cache, x)
3461 int index
; /* number of written untracked_cache_dir */
3462 struct ewah_bitmap
*check_only
; /* from untracked_cache_dir */
3463 struct ewah_bitmap
*valid
; /* from untracked_cache_dir */
3464 struct ewah_bitmap
*sha1_valid
; /* set if exclude_sha1 is not null */
3466 struct strbuf sb_stat
;
3467 struct strbuf sb_sha1
;
3470 static void stat_data_to_disk(struct stat_data
*to
, const struct stat_data
*from
)
3472 to
->sd_ctime
.sec
= htonl(from
->sd_ctime
.sec
);
3473 to
->sd_ctime
.nsec
= htonl(from
->sd_ctime
.nsec
);
3474 to
->sd_mtime
.sec
= htonl(from
->sd_mtime
.sec
);
3475 to
->sd_mtime
.nsec
= htonl(from
->sd_mtime
.nsec
);
3476 to
->sd_dev
= htonl(from
->sd_dev
);
3477 to
->sd_ino
= htonl(from
->sd_ino
);
3478 to
->sd_uid
= htonl(from
->sd_uid
);
3479 to
->sd_gid
= htonl(from
->sd_gid
);
3480 to
->sd_size
= htonl(from
->sd_size
);
3483 static void write_one_dir(struct untracked_cache_dir
*untracked
,
3484 struct write_data
*wd
)
3486 struct stat_data stat_data
;
3487 struct strbuf
*out
= &wd
->out
;
3488 unsigned char intbuf
[16];
3489 unsigned int intlen
, value
;
3490 int i
= wd
->index
++;
3493 * untracked_nr should be reset whenever valid is clear, but
3496 if (!untracked
->valid
) {
3497 untracked
->untracked_nr
= 0;
3498 untracked
->check_only
= 0;
3501 if (untracked
->check_only
)
3502 ewah_set(wd
->check_only
, i
);
3503 if (untracked
->valid
) {
3504 ewah_set(wd
->valid
, i
);
3505 stat_data_to_disk(&stat_data
, &untracked
->stat_data
);
3506 strbuf_add(&wd
->sb_stat
, &stat_data
, sizeof(stat_data
));
3508 if (!is_null_oid(&untracked
->exclude_oid
)) {
3509 ewah_set(wd
->sha1_valid
, i
);
3510 strbuf_add(&wd
->sb_sha1
, untracked
->exclude_oid
.hash
,
3511 the_hash_algo
->rawsz
);
3514 intlen
= encode_varint(untracked
->untracked_nr
, intbuf
);
3515 strbuf_add(out
, intbuf
, intlen
);
3517 /* skip non-recurse directories */
3518 for (i
= 0, value
= 0; i
< untracked
->dirs_nr
; i
++)
3519 if (untracked
->dirs
[i
]->recurse
)
3521 intlen
= encode_varint(value
, intbuf
);
3522 strbuf_add(out
, intbuf
, intlen
);
3524 strbuf_add(out
, untracked
->name
, strlen(untracked
->name
) + 1);
3526 for (i
= 0; i
< untracked
->untracked_nr
; i
++)
3527 strbuf_add(out
, untracked
->untracked
[i
],
3528 strlen(untracked
->untracked
[i
]) + 1);
3530 for (i
= 0; i
< untracked
->dirs_nr
; i
++)
3531 if (untracked
->dirs
[i
]->recurse
)
3532 write_one_dir(untracked
->dirs
[i
], wd
);
3535 void write_untracked_extension(struct strbuf
*out
, struct untracked_cache
*untracked
)
3537 struct ondisk_untracked_cache
*ouc
;
3538 struct write_data wd
;
3539 unsigned char varbuf
[16];
3541 const unsigned hashsz
= the_hash_algo
->rawsz
;
3543 CALLOC_ARRAY(ouc
, 1);
3544 stat_data_to_disk(&ouc
->info_exclude_stat
, &untracked
->ss_info_exclude
.stat
);
3545 stat_data_to_disk(&ouc
->excludes_file_stat
, &untracked
->ss_excludes_file
.stat
);
3546 ouc
->dir_flags
= htonl(untracked
->dir_flags
);
3548 varint_len
= encode_varint(untracked
->ident
.len
, varbuf
);
3549 strbuf_add(out
, varbuf
, varint_len
);
3550 strbuf_addbuf(out
, &untracked
->ident
);
3552 strbuf_add(out
, ouc
, sizeof(*ouc
));
3553 strbuf_add(out
, untracked
->ss_info_exclude
.oid
.hash
, hashsz
);
3554 strbuf_add(out
, untracked
->ss_excludes_file
.oid
.hash
, hashsz
);
3555 strbuf_add(out
, untracked
->exclude_per_dir
, strlen(untracked
->exclude_per_dir
) + 1);
3558 if (!untracked
->root
) {
3559 varint_len
= encode_varint(0, varbuf
);
3560 strbuf_add(out
, varbuf
, varint_len
);
3565 wd
.check_only
= ewah_new();
3566 wd
.valid
= ewah_new();
3567 wd
.sha1_valid
= ewah_new();
3568 strbuf_init(&wd
.out
, 1024);
3569 strbuf_init(&wd
.sb_stat
, 1024);
3570 strbuf_init(&wd
.sb_sha1
, 1024);
3571 write_one_dir(untracked
->root
, &wd
);
3573 varint_len
= encode_varint(wd
.index
, varbuf
);
3574 strbuf_add(out
, varbuf
, varint_len
);
3575 strbuf_addbuf(out
, &wd
.out
);
3576 ewah_serialize_strbuf(wd
.valid
, out
);
3577 ewah_serialize_strbuf(wd
.check_only
, out
);
3578 ewah_serialize_strbuf(wd
.sha1_valid
, out
);
3579 strbuf_addbuf(out
, &wd
.sb_stat
);
3580 strbuf_addbuf(out
, &wd
.sb_sha1
);
3581 strbuf_addch(out
, '\0'); /* safe guard for string lists */
3583 ewah_free(wd
.valid
);
3584 ewah_free(wd
.check_only
);
3585 ewah_free(wd
.sha1_valid
);
3586 strbuf_release(&wd
.out
);
3587 strbuf_release(&wd
.sb_stat
);
3588 strbuf_release(&wd
.sb_sha1
);
3591 static void free_untracked(struct untracked_cache_dir
*ucd
)
3596 for (i
= 0; i
< ucd
->dirs_nr
; i
++)
3597 free_untracked(ucd
->dirs
[i
]);
3598 for (i
= 0; i
< ucd
->untracked_nr
; i
++)
3599 free(ucd
->untracked
[i
]);
3600 free(ucd
->untracked
);
3605 void free_untracked_cache(struct untracked_cache
*uc
)
3610 free(uc
->exclude_per_dir_to_free
);
3611 strbuf_release(&uc
->ident
);
3612 free_untracked(uc
->root
);
3618 struct untracked_cache_dir
**ucd
;
3619 struct ewah_bitmap
*check_only
;
3620 struct ewah_bitmap
*valid
;
3621 struct ewah_bitmap
*sha1_valid
;
3622 const unsigned char *data
;
3623 const unsigned char *end
;
3626 static void stat_data_from_disk(struct stat_data
*to
, const unsigned char *data
)
3628 memcpy(to
, data
, sizeof(*to
));
3629 to
->sd_ctime
.sec
= ntohl(to
->sd_ctime
.sec
);
3630 to
->sd_ctime
.nsec
= ntohl(to
->sd_ctime
.nsec
);
3631 to
->sd_mtime
.sec
= ntohl(to
->sd_mtime
.sec
);
3632 to
->sd_mtime
.nsec
= ntohl(to
->sd_mtime
.nsec
);
3633 to
->sd_dev
= ntohl(to
->sd_dev
);
3634 to
->sd_ino
= ntohl(to
->sd_ino
);
3635 to
->sd_uid
= ntohl(to
->sd_uid
);
3636 to
->sd_gid
= ntohl(to
->sd_gid
);
3637 to
->sd_size
= ntohl(to
->sd_size
);
3640 static int read_one_dir(struct untracked_cache_dir
**untracked_
,
3641 struct read_data
*rd
)
3643 struct untracked_cache_dir ud
, *untracked
;
3644 const unsigned char *data
= rd
->data
, *end
= rd
->end
;
3645 const unsigned char *eos
;
3649 memset(&ud
, 0, sizeof(ud
));
3651 value
= decode_varint(&data
);
3655 ud
.untracked_alloc
= value
;
3656 ud
.untracked_nr
= value
;
3657 if (ud
.untracked_nr
)
3658 ALLOC_ARRAY(ud
.untracked
, ud
.untracked_nr
);
3660 ud
.dirs_alloc
= ud
.dirs_nr
= decode_varint(&data
);
3663 ALLOC_ARRAY(ud
.dirs
, ud
.dirs_nr
);
3665 eos
= memchr(data
, '\0', end
- data
);
3666 if (!eos
|| eos
== end
)
3669 *untracked_
= untracked
= xmalloc(st_add3(sizeof(*untracked
), eos
- data
, 1));
3670 memcpy(untracked
, &ud
, sizeof(ud
));
3671 memcpy(untracked
->name
, data
, eos
- data
+ 1);
3674 for (i
= 0; i
< untracked
->untracked_nr
; i
++) {
3675 eos
= memchr(data
, '\0', end
- data
);
3676 if (!eos
|| eos
== end
)
3678 untracked
->untracked
[i
] = xmemdupz(data
, eos
- data
);
3682 rd
->ucd
[rd
->index
++] = untracked
;
3685 for (i
= 0; i
< untracked
->dirs_nr
; i
++) {
3686 if (read_one_dir(untracked
->dirs
+ i
, rd
) < 0)
3692 static void set_check_only(size_t pos
, void *cb
)
3694 struct read_data
*rd
= cb
;
3695 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3699 static void read_stat(size_t pos
, void *cb
)
3701 struct read_data
*rd
= cb
;
3702 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3703 if (rd
->data
+ sizeof(struct stat_data
) > rd
->end
) {
3704 rd
->data
= rd
->end
+ 1;
3707 stat_data_from_disk(&ud
->stat_data
, rd
->data
);
3708 rd
->data
+= sizeof(struct stat_data
);
3712 static void read_oid(size_t pos
, void *cb
)
3714 struct read_data
*rd
= cb
;
3715 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3716 if (rd
->data
+ the_hash_algo
->rawsz
> rd
->end
) {
3717 rd
->data
= rd
->end
+ 1;
3720 oidread(&ud
->exclude_oid
, rd
->data
);
3721 rd
->data
+= the_hash_algo
->rawsz
;
3724 static void load_oid_stat(struct oid_stat
*oid_stat
, const unsigned char *data
,
3725 const unsigned char *sha1
)
3727 stat_data_from_disk(&oid_stat
->stat
, data
);
3728 oidread(&oid_stat
->oid
, sha1
);
3729 oid_stat
->valid
= 1;
3732 struct untracked_cache
*read_untracked_extension(const void *data
, unsigned long sz
)
3734 struct untracked_cache
*uc
;
3735 struct read_data rd
;
3736 const unsigned char *next
= data
, *end
= (const unsigned char *)data
+ sz
;
3740 const char *exclude_per_dir
;
3741 const unsigned hashsz
= the_hash_algo
->rawsz
;
3742 const unsigned offset
= sizeof(struct ondisk_untracked_cache
);
3743 const unsigned exclude_per_dir_offset
= offset
+ 2 * hashsz
;
3745 if (sz
<= 1 || end
[-1] != '\0')
3749 ident_len
= decode_varint(&next
);
3750 if (next
+ ident_len
> end
)
3752 ident
= (const char *)next
;
3755 if (next
+ exclude_per_dir_offset
+ 1 > end
)
3758 CALLOC_ARRAY(uc
, 1);
3759 strbuf_init(&uc
->ident
, ident_len
);
3760 strbuf_add(&uc
->ident
, ident
, ident_len
);
3761 load_oid_stat(&uc
->ss_info_exclude
,
3762 next
+ ouc_offset(info_exclude_stat
),
3764 load_oid_stat(&uc
->ss_excludes_file
,
3765 next
+ ouc_offset(excludes_file_stat
),
3766 next
+ offset
+ hashsz
);
3767 uc
->dir_flags
= get_be32(next
+ ouc_offset(dir_flags
));
3768 exclude_per_dir
= (const char *)next
+ exclude_per_dir_offset
;
3769 uc
->exclude_per_dir
= uc
->exclude_per_dir_to_free
= xstrdup(exclude_per_dir
);
3770 /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
3771 next
+= exclude_per_dir_offset
+ strlen(exclude_per_dir
) + 1;
3775 len
= decode_varint(&next
);
3776 if (next
> end
|| len
== 0)
3779 rd
.valid
= ewah_new();
3780 rd
.check_only
= ewah_new();
3781 rd
.sha1_valid
= ewah_new();
3785 ALLOC_ARRAY(rd
.ucd
, len
);
3787 if (read_one_dir(&uc
->root
, &rd
) || rd
.index
!= len
)
3791 len
= ewah_read_mmap(rd
.valid
, next
, end
- next
);
3796 len
= ewah_read_mmap(rd
.check_only
, next
, end
- next
);
3801 len
= ewah_read_mmap(rd
.sha1_valid
, next
, end
- next
);
3805 ewah_each_bit(rd
.check_only
, set_check_only
, &rd
);
3806 rd
.data
= next
+ len
;
3807 ewah_each_bit(rd
.valid
, read_stat
, &rd
);
3808 ewah_each_bit(rd
.sha1_valid
, read_oid
, &rd
);
3813 ewah_free(rd
.valid
);
3814 ewah_free(rd
.check_only
);
3815 ewah_free(rd
.sha1_valid
);
3818 free_untracked_cache(uc
);
3824 static void invalidate_one_directory(struct untracked_cache
*uc
,
3825 struct untracked_cache_dir
*ucd
)
3827 uc
->dir_invalidated
++;
3829 ucd
->untracked_nr
= 0;
3833 * Normally when an entry is added or removed from a directory,
3834 * invalidating that directory is enough. No need to touch its
3835 * ancestors. When a directory is shown as "foo/bar/" in git-status
3836 * however, deleting or adding an entry may have cascading effect.
3838 * Say the "foo/bar/file" has become untracked, we need to tell the
3839 * untracked_cache_dir of "foo" that "bar/" is not an untracked
3840 * directory any more (because "bar" is managed by foo as an untracked
3843 * Similarly, if "foo/bar/file" moves from untracked to tracked and it
3844 * was the last untracked entry in the entire "foo", we should show
3845 * "foo/" instead. Which means we have to invalidate past "bar" up to
3848 * This function traverses all directories from root to leaf. If there
3849 * is a chance of one of the above cases happening, we invalidate back
3850 * to root. Otherwise we just invalidate the leaf. There may be a more
3851 * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
3852 * detect these cases and avoid unnecessary invalidation, for example,
3853 * checking for the untracked entry named "bar/" in "foo", but for now
3854 * stick to something safe and simple.
3856 static int invalidate_one_component(struct untracked_cache
*uc
,
3857 struct untracked_cache_dir
*dir
,
3858 const char *path
, int len
)
3860 const char *rest
= strchr(path
, '/');
3863 int component_len
= rest
- path
;
3864 struct untracked_cache_dir
*d
=
3865 lookup_untracked(uc
, dir
, path
, component_len
);
3867 invalidate_one_component(uc
, d
, rest
+ 1,
3868 len
- (component_len
+ 1));
3870 invalidate_one_directory(uc
, dir
);
3874 invalidate_one_directory(uc
, dir
);
3875 return uc
->dir_flags
& DIR_SHOW_OTHER_DIRECTORIES
;
3878 void untracked_cache_invalidate_path(struct index_state
*istate
,
3879 const char *path
, int safe_path
)
3881 if (!istate
->untracked
|| !istate
->untracked
->root
)
3883 if (!safe_path
&& !verify_path(path
, 0))
3885 invalidate_one_component(istate
->untracked
, istate
->untracked
->root
,
3886 path
, strlen(path
));
3889 void untracked_cache_remove_from_index(struct index_state
*istate
,
3892 untracked_cache_invalidate_path(istate
, path
, 1);
3895 void untracked_cache_add_to_index(struct index_state
*istate
,
3898 untracked_cache_invalidate_path(istate
, path
, 1);
3901 static void connect_wt_gitdir_in_nested(const char *sub_worktree
,
3902 const char *sub_gitdir
)
3905 struct repository subrepo
;
3906 struct strbuf sub_wt
= STRBUF_INIT
;
3907 struct strbuf sub_gd
= STRBUF_INIT
;
3909 const struct submodule
*sub
;
3911 /* If the submodule has no working tree, we can ignore it. */
3912 if (repo_init(&subrepo
, sub_gitdir
, sub_worktree
))
3915 if (repo_read_index(&subrepo
) < 0)
3916 die(_("index file corrupt in repo %s"), subrepo
.gitdir
);
3918 /* TODO: audit for interaction with sparse-index. */
3919 ensure_full_index(subrepo
.index
);
3920 for (i
= 0; i
< subrepo
.index
->cache_nr
; i
++) {
3921 const struct cache_entry
*ce
= subrepo
.index
->cache
[i
];
3923 if (!S_ISGITLINK(ce
->ce_mode
))
3926 while (i
+ 1 < subrepo
.index
->cache_nr
&&
3927 !strcmp(ce
->name
, subrepo
.index
->cache
[i
+ 1]->name
))
3929 * Skip entries with the same name in different stages
3930 * to make sure an entry is returned only once.
3934 sub
= submodule_from_path(&subrepo
, null_oid(), ce
->name
);
3935 if (!sub
|| !is_submodule_active(&subrepo
, ce
->name
))
3936 /* .gitmodules broken or inactive sub */
3939 strbuf_reset(&sub_wt
);
3940 strbuf_reset(&sub_gd
);
3941 strbuf_addf(&sub_wt
, "%s/%s", sub_worktree
, sub
->path
);
3942 submodule_name_to_gitdir(&sub_gd
, &subrepo
, sub
->name
);
3944 connect_work_tree_and_git_dir(sub_wt
.buf
, sub_gd
.buf
, 1);
3946 strbuf_release(&sub_wt
);
3947 strbuf_release(&sub_gd
);
3948 repo_clear(&subrepo
);
3951 void connect_work_tree_and_git_dir(const char *work_tree_
,
3952 const char *git_dir_
,
3953 int recurse_into_nested
)
3955 struct strbuf gitfile_sb
= STRBUF_INIT
;
3956 struct strbuf cfg_sb
= STRBUF_INIT
;
3957 struct strbuf rel_path
= STRBUF_INIT
;
3958 char *git_dir
, *work_tree
;
3960 /* Prepare .git file */
3961 strbuf_addf(&gitfile_sb
, "%s/.git", work_tree_
);
3962 if (safe_create_leading_directories_const(gitfile_sb
.buf
))
3963 die(_("could not create directories for %s"), gitfile_sb
.buf
);
3965 /* Prepare config file */
3966 strbuf_addf(&cfg_sb
, "%s/config", git_dir_
);
3967 if (safe_create_leading_directories_const(cfg_sb
.buf
))
3968 die(_("could not create directories for %s"), cfg_sb
.buf
);
3970 git_dir
= real_pathdup(git_dir_
, 1);
3971 work_tree
= real_pathdup(work_tree_
, 1);
3973 /* Write .git file */
3974 write_file(gitfile_sb
.buf
, "gitdir: %s",
3975 relative_path(git_dir
, work_tree
, &rel_path
));
3976 /* Update core.worktree setting */
3977 git_config_set_in_file(cfg_sb
.buf
, "core.worktree",
3978 relative_path(work_tree
, git_dir
, &rel_path
));
3980 strbuf_release(&gitfile_sb
);
3981 strbuf_release(&cfg_sb
);
3982 strbuf_release(&rel_path
);
3984 if (recurse_into_nested
)
3985 connect_wt_gitdir_in_nested(work_tree
, git_dir
);
3992 * Migrate the git directory of the given path from old_git_dir to new_git_dir.
3994 void relocate_gitdir(const char *path
, const char *old_git_dir
, const char *new_git_dir
)
3996 if (rename(old_git_dir
, new_git_dir
) < 0)
3997 die_errno(_("could not migrate git directory from '%s' to '%s'"),
3998 old_git_dir
, new_git_dir
);
4000 connect_work_tree_and_git_dir(path
, new_git_dir
, 0);
4003 int path_match_flags(const char *const str
, const enum path_match_flags flags
)
4005 const char *p
= str
;
4007 if (flags
& PATH_MATCH_NATIVE
&&
4008 flags
& PATH_MATCH_XPLATFORM
)
4009 BUG("path_match_flags() must get one match kind, not multiple!");
4010 else if (!(flags
& PATH_MATCH_KINDS_MASK
))
4011 BUG("path_match_flags() must get at least one match kind!");
4013 if (flags
& PATH_MATCH_STARTS_WITH_DOT_SLASH
&&
4014 flags
& PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH
)
4015 BUG("path_match_flags() must get one platform kind, not multiple!");
4016 else if (!(flags
& PATH_MATCH_PLATFORM_MASK
))
4017 BUG("path_match_flags() must get at least one platform kind!");
4021 if (flags
& PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH
&&
4025 if (flags
& PATH_MATCH_NATIVE
)
4026 return is_dir_sep(*p
);
4027 else if (flags
& PATH_MATCH_XPLATFORM
)
4028 return is_xplatform_dir_sep(*p
);