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 "object-store.h"
17 #include "wildmatch.h"
21 #include "ewah/ewok.h"
22 #include "fsmonitor.h"
23 #include "submodule-config.h"
27 * Tells read_directory_recursive how a file or directory should be treated.
28 * Values are ordered by significance, e.g. if a directory contains both
29 * excluded and untracked files, it is listed as untracked because
30 * path_untracked > path_excluded.
40 * Support data structure for our opendir/readdir/closedir wrappers
44 struct untracked_cache_dir
*untracked
;
51 struct untracked_cache_dir
*ucd
;
54 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
55 struct index_state
*istate
, const char *path
, int len
,
56 struct untracked_cache_dir
*untracked
,
57 int check_only
, int stop_at_first_file
, const struct pathspec
*pathspec
);
58 static int resolve_dtype(int dtype
, struct index_state
*istate
,
59 const char *path
, int len
);
60 struct dirent
*readdir_skip_dot_and_dotdot(DIR *dirp
)
64 while ((e
= readdir(dirp
)) != NULL
) {
65 if (!is_dot_or_dotdot(e
->d_name
))
71 int count_slashes(const char *s
)
80 int fspathcmp(const char *a
, const char *b
)
82 return ignore_case
? strcasecmp(a
, b
) : strcmp(a
, b
);
85 int fspatheq(const char *a
, const char *b
)
87 return !fspathcmp(a
, b
);
90 int fspathncmp(const char *a
, const char *b
, size_t count
)
92 return ignore_case
? strncasecmp(a
, b
, count
) : strncmp(a
, b
, count
);
95 unsigned int fspathhash(const char *str
)
97 return ignore_case
? strihash(str
) : strhash(str
);
100 int git_fnmatch(const struct pathspec_item
*item
,
101 const char *pattern
, const char *string
,
105 if (ps_strncmp(item
, pattern
, string
, prefix
))
110 if (item
->flags
& PATHSPEC_ONESTAR
) {
111 int pattern_len
= strlen(++pattern
);
112 int string_len
= strlen(string
);
113 return string_len
< pattern_len
||
114 ps_strcmp(item
, pattern
,
115 string
+ string_len
- pattern_len
);
117 if (item
->magic
& PATHSPEC_GLOB
)
118 return wildmatch(pattern
, string
,
120 (item
->magic
& PATHSPEC_ICASE
? WM_CASEFOLD
: 0));
122 /* wildmatch has not learned no FNM_PATHNAME mode yet */
123 return wildmatch(pattern
, string
,
124 item
->magic
& PATHSPEC_ICASE
? WM_CASEFOLD
: 0);
127 static int fnmatch_icase_mem(const char *pattern
, int patternlen
,
128 const char *string
, int stringlen
,
132 struct strbuf pat_buf
= STRBUF_INIT
;
133 struct strbuf str_buf
= STRBUF_INIT
;
134 const char *use_pat
= pattern
;
135 const char *use_str
= string
;
137 if (pattern
[patternlen
]) {
138 strbuf_add(&pat_buf
, pattern
, patternlen
);
139 use_pat
= pat_buf
.buf
;
141 if (string
[stringlen
]) {
142 strbuf_add(&str_buf
, string
, stringlen
);
143 use_str
= str_buf
.buf
;
147 flags
|= WM_CASEFOLD
;
148 match_status
= wildmatch(use_pat
, use_str
, flags
);
150 strbuf_release(&pat_buf
);
151 strbuf_release(&str_buf
);
156 static size_t common_prefix_len(const struct pathspec
*pathspec
)
162 * ":(icase)path" is treated as a pathspec full of
163 * wildcard. In other words, only prefix is considered common
164 * prefix. If the pathspec is abc/foo abc/bar, running in
165 * subdir xyz, the common prefix is still xyz, not xyz/abc as
168 GUARD_PATHSPEC(pathspec
,
177 for (n
= 0; n
< pathspec
->nr
; n
++) {
178 size_t i
= 0, len
= 0, item_len
;
179 if (pathspec
->items
[n
].magic
& PATHSPEC_EXCLUDE
)
181 if (pathspec
->items
[n
].magic
& PATHSPEC_ICASE
)
182 item_len
= pathspec
->items
[n
].prefix
;
184 item_len
= pathspec
->items
[n
].nowildcard_len
;
185 while (i
< item_len
&& (n
== 0 || i
< max
)) {
186 char c
= pathspec
->items
[n
].match
[i
];
187 if (c
!= pathspec
->items
[0].match
[i
])
193 if (n
== 0 || len
< max
) {
203 * Returns a copy of the longest leading path common among all
206 char *common_prefix(const struct pathspec
*pathspec
)
208 unsigned long len
= common_prefix_len(pathspec
);
210 return len
? xmemdupz(pathspec
->items
[0].match
, len
) : NULL
;
213 int fill_directory(struct dir_struct
*dir
,
214 struct index_state
*istate
,
215 const struct pathspec
*pathspec
)
220 unsigned exclusive_flags
= DIR_SHOW_IGNORED
| DIR_SHOW_IGNORED_TOO
;
221 if ((dir
->flags
& exclusive_flags
) == exclusive_flags
)
222 BUG("DIR_SHOW_IGNORED and DIR_SHOW_IGNORED_TOO are exclusive");
225 * Calculate common prefix for the pathspec, and
226 * use that to optimize the directory walk
228 prefix_len
= common_prefix_len(pathspec
);
229 prefix
= prefix_len
? pathspec
->items
[0].match
: "";
231 /* Read the directory and prune it */
232 read_directory(dir
, istate
, prefix
, prefix_len
, pathspec
);
237 int within_depth(const char *name
, int namelen
,
238 int depth
, int max_depth
)
240 const char *cp
= name
, *cpe
= name
+ namelen
;
246 if (depth
> max_depth
)
253 * Read the contents of the blob with the given OID into a buffer.
254 * Append a trailing LF to the end if the last line doesn't have one.
257 * -1 when the OID is invalid or unknown or does not refer to a blob.
258 * 0 when the blob is empty.
259 * 1 along with { data, size } of the (possibly augmented) buffer
262 * Optionally updates the given oid_stat with the given OID (when valid).
264 static int do_read_blob(const struct object_id
*oid
, struct oid_stat
*oid_stat
,
265 size_t *size_out
, char **data_out
)
267 enum object_type type
;
274 data
= read_object_file(oid
, &type
, &sz
);
275 if (!data
|| type
!= OBJ_BLOB
) {
281 memset(&oid_stat
->stat
, 0, sizeof(oid_stat
->stat
));
282 oidcpy(&oid_stat
->oid
, oid
);
290 if (data
[sz
- 1] != '\n') {
291 data
= xrealloc(data
, st_add(sz
, 1));
295 *size_out
= xsize_t(sz
);
301 #define DO_MATCH_EXCLUDE (1<<0)
302 #define DO_MATCH_DIRECTORY (1<<1)
303 #define DO_MATCH_LEADING_PATHSPEC (1<<2)
306 * Does the given pathspec match the given name? A match is found if
308 * (1) the pathspec string is leading directory of 'name' ("RECURSIVELY"), or
309 * (2) the pathspec string has a leading part matching 'name' ("LEADING"), or
310 * (3) the pathspec string is a wildcard and matches 'name' ("WILDCARD"), or
311 * (4) the pathspec string is exactly the same as 'name' ("EXACT").
313 * Return value tells which case it was (1-4), or 0 when there is no match.
315 * It may be instructive to look at a small table of concrete examples
316 * to understand the differences between 1, 2, and 4:
319 * | a/b | a/b/ | a/b/c
320 * ------+-----------+-----------+------------
321 * a/b | EXACT | EXACT[1] | LEADING[2]
322 * Names a/b/ | RECURSIVE | EXACT | LEADING[2]
323 * a/b/c | RECURSIVE | RECURSIVE | EXACT
325 * [1] Only if DO_MATCH_DIRECTORY is passed; otherwise, this is NOT a match.
326 * [2] Only if DO_MATCH_LEADING_PATHSPEC is passed; otherwise, not a match.
328 static int match_pathspec_item(struct index_state
*istate
,
329 const struct pathspec_item
*item
, int prefix
,
330 const char *name
, int namelen
, unsigned flags
)
332 /* name/namelen has prefix cut off by caller */
333 const char *match
= item
->match
+ prefix
;
334 int matchlen
= item
->len
- prefix
;
337 * The normal call pattern is:
338 * 1. prefix = common_prefix_len(ps);
339 * 2. prune something, or fill_directory
340 * 3. match_pathspec()
342 * 'prefix' at #1 may be shorter than the command's prefix and
343 * it's ok for #2 to match extra files. Those extras will be
346 * Suppose the pathspec is 'foo' and '../bar' running from
347 * subdir 'xyz'. The common prefix at #1 will be empty, thanks
348 * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
349 * user does not want XYZ/foo, only the "foo" part should be
350 * case-insensitive. We need to filter out XYZ/foo here. In
351 * other words, we do not trust the caller on comparing the
352 * prefix part when :(icase) is involved. We do exact
353 * comparison ourselves.
355 * Normally the caller (common_prefix_len() in fact) does
356 * _exact_ matching on name[-prefix+1..-1] and we do not need
357 * to check that part. Be defensive and check it anyway, in
358 * case common_prefix_len is changed, or a new caller is
359 * introduced that does not use common_prefix_len.
361 * If the penalty turns out too high when prefix is really
362 * long, maybe change it to
363 * strncmp(match, name, item->prefix - prefix)
365 if (item
->prefix
&& (item
->magic
& PATHSPEC_ICASE
) &&
366 strncmp(item
->match
, name
- prefix
, item
->prefix
))
369 if (item
->attr_match_nr
&&
370 !match_pathspec_attrs(istate
, name
, namelen
, item
))
373 /* If the match was just the prefix, we matched */
375 return MATCHED_RECURSIVELY
;
377 if (matchlen
<= namelen
&& !ps_strncmp(item
, match
, name
, matchlen
)) {
378 if (matchlen
== namelen
)
379 return MATCHED_EXACTLY
;
381 if (match
[matchlen
-1] == '/' || name
[matchlen
] == '/')
382 return MATCHED_RECURSIVELY
;
383 } else if ((flags
& DO_MATCH_DIRECTORY
) &&
384 match
[matchlen
- 1] == '/' &&
385 namelen
== matchlen
- 1 &&
386 !ps_strncmp(item
, match
, name
, namelen
))
387 return MATCHED_EXACTLY
;
389 if (item
->nowildcard_len
< item
->len
&&
390 !git_fnmatch(item
, match
, name
,
391 item
->nowildcard_len
- prefix
))
392 return MATCHED_FNMATCH
;
394 /* Perform checks to see if "name" is a leading string of the pathspec */
395 if ( (flags
& DO_MATCH_LEADING_PATHSPEC
) &&
396 !(flags
& DO_MATCH_EXCLUDE
)) {
397 /* name is a literal prefix of the pathspec */
398 int offset
= name
[namelen
-1] == '/' ? 1 : 0;
399 if ((namelen
< matchlen
) &&
400 (match
[namelen
-offset
] == '/') &&
401 !ps_strncmp(item
, match
, name
, namelen
))
402 return MATCHED_RECURSIVELY_LEADING_PATHSPEC
;
404 /* name doesn't match up to the first wild character */
405 if (item
->nowildcard_len
< item
->len
&&
406 ps_strncmp(item
, match
, name
,
407 item
->nowildcard_len
- prefix
))
411 * name has no wildcard, and it didn't match as a leading
412 * pathspec so return.
414 if (item
->nowildcard_len
== item
->len
)
418 * Here is where we would perform a wildmatch to check if
419 * "name" can be matched as a directory (or a prefix) against
420 * the pathspec. Since wildmatch doesn't have this capability
421 * at the present we have to punt and say that it is a match,
422 * potentially returning a false positive
423 * The submodules themselves will be able to perform more
424 * accurate matching to determine if the pathspec matches.
426 return MATCHED_RECURSIVELY_LEADING_PATHSPEC
;
433 * do_match_pathspec() is meant to ONLY be called by
434 * match_pathspec_with_flags(); calling it directly risks pathspecs
435 * like ':!unwanted_path' being ignored.
437 * Given a name and a list of pathspecs, returns the nature of the
438 * closest (i.e. most specific) match of the name to any of the
441 * The caller typically calls this multiple times with the same
442 * pathspec and seen[] array but with different name/namelen
443 * (e.g. entries from the index) and is interested in seeing if and
444 * how each pathspec matches all the names it calls this function
445 * with. A mark is left in the seen[] array for each pathspec element
446 * indicating the closest type of match that element achieved, so if
447 * seen[n] remains zero after multiple invocations, that means the nth
448 * pathspec did not match any names, which could indicate that the
449 * user mistyped the nth pathspec.
451 static int do_match_pathspec(struct index_state
*istate
,
452 const struct pathspec
*ps
,
453 const char *name
, int namelen
,
454 int prefix
, char *seen
,
457 int i
, retval
= 0, exclude
= flags
& DO_MATCH_EXCLUDE
;
469 if (!ps
->recursive
||
470 !(ps
->magic
& PATHSPEC_MAXDEPTH
) ||
472 return MATCHED_RECURSIVELY
;
474 if (within_depth(name
, namelen
, 0, ps
->max_depth
))
475 return MATCHED_EXACTLY
;
483 for (i
= ps
->nr
- 1; i
>= 0; i
--) {
486 if ((!exclude
&& ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
) ||
487 ( exclude
&& !(ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
)))
490 if (seen
&& seen
[i
] == MATCHED_EXACTLY
)
493 * Make exclude patterns optional and never report
494 * "pathspec ':(exclude)foo' matches no files"
496 if (seen
&& ps
->items
[i
].magic
& PATHSPEC_EXCLUDE
)
497 seen
[i
] = MATCHED_FNMATCH
;
498 how
= match_pathspec_item(istate
, ps
->items
+i
, prefix
, name
,
501 (ps
->magic
& PATHSPEC_MAXDEPTH
) &&
502 ps
->max_depth
!= -1 &&
503 how
&& how
!= MATCHED_FNMATCH
) {
504 int len
= ps
->items
[i
].len
;
505 if (name
[len
] == '/')
507 if (within_depth(name
+len
, namelen
-len
, 0, ps
->max_depth
))
508 how
= MATCHED_EXACTLY
;
515 if (seen
&& seen
[i
] < how
)
522 static int match_pathspec_with_flags(struct index_state
*istate
,
523 const struct pathspec
*ps
,
524 const char *name
, int namelen
,
525 int prefix
, char *seen
, unsigned flags
)
527 int positive
, negative
;
528 positive
= do_match_pathspec(istate
, ps
, name
, namelen
,
529 prefix
, seen
, flags
);
530 if (!(ps
->magic
& PATHSPEC_EXCLUDE
) || !positive
)
532 negative
= do_match_pathspec(istate
, ps
, name
, namelen
,
534 flags
| DO_MATCH_EXCLUDE
);
535 return negative
? 0 : positive
;
538 int match_pathspec(struct index_state
*istate
,
539 const struct pathspec
*ps
,
540 const char *name
, int namelen
,
541 int prefix
, char *seen
, int is_dir
)
543 unsigned flags
= is_dir
? DO_MATCH_DIRECTORY
: 0;
544 return match_pathspec_with_flags(istate
, ps
, name
, namelen
,
545 prefix
, seen
, flags
);
549 * Check if a submodule is a superset of the pathspec
551 int submodule_path_match(struct index_state
*istate
,
552 const struct pathspec
*ps
,
553 const char *submodule_name
,
556 int matched
= match_pathspec_with_flags(istate
, ps
, submodule_name
,
557 strlen(submodule_name
),
560 DO_MATCH_LEADING_PATHSPEC
);
564 int report_path_error(const char *ps_matched
,
565 const struct pathspec
*pathspec
)
568 * Make sure all pathspec matched; otherwise it is an error.
571 for (num
= 0; num
< pathspec
->nr
; num
++) {
572 int other
, found_dup
;
577 * The caller might have fed identical pathspec
578 * twice. Do not barf on such a mistake.
579 * FIXME: parse_pathspec should have eliminated
580 * duplicate pathspec.
582 for (found_dup
= other
= 0;
583 !found_dup
&& other
< pathspec
->nr
;
585 if (other
== num
|| !ps_matched
[other
])
587 if (!strcmp(pathspec
->items
[other
].original
,
588 pathspec
->items
[num
].original
))
590 * Ok, we have a match already.
597 error(_("pathspec '%s' did not match any file(s) known to git"),
598 pathspec
->items
[num
].original
);
605 * Return the length of the "simple" part of a path match limiter.
607 int simple_length(const char *match
)
612 unsigned char c
= *match
++;
614 if (c
== '\0' || is_glob_special(c
))
619 int no_wildcard(const char *string
)
621 return string
[simple_length(string
)] == '\0';
624 void parse_path_pattern(const char **pattern
,
629 const char *p
= *pattern
;
634 *flags
|= PATTERN_FLAG_NEGATIVE
;
638 if (len
&& p
[len
- 1] == '/') {
640 *flags
|= PATTERN_FLAG_MUSTBEDIR
;
642 for (i
= 0; i
< len
; i
++) {
647 *flags
|= PATTERN_FLAG_NODIR
;
648 *nowildcardlen
= simple_length(p
);
650 * we should have excluded the trailing slash from 'p' too,
651 * but that's one more allocation. Instead just make sure
652 * nowildcardlen does not exceed real patternlen
654 if (*nowildcardlen
> len
)
655 *nowildcardlen
= len
;
656 if (*p
== '*' && no_wildcard(p
+ 1))
657 *flags
|= PATTERN_FLAG_ENDSWITH
;
662 int pl_hashmap_cmp(const void *cmp_data UNUSED
,
663 const struct hashmap_entry
*a
,
664 const struct hashmap_entry
*b
,
665 const void *key UNUSED
)
667 const struct pattern_entry
*ee1
=
668 container_of(a
, struct pattern_entry
, ent
);
669 const struct pattern_entry
*ee2
=
670 container_of(b
, struct pattern_entry
, ent
);
672 size_t min_len
= ee1
->patternlen
<= ee2
->patternlen
676 return fspathncmp(ee1
->pattern
, ee2
->pattern
, min_len
);
679 static char *dup_and_filter_pattern(const char *pattern
)
683 char *result
= xstrdup(pattern
);
689 /* skip escape characters (once) */
709 static void add_pattern_to_hashsets(struct pattern_list
*pl
, struct path_pattern
*given
)
711 struct pattern_entry
*translated
;
714 const char *prev
, *cur
, *next
;
716 if (!pl
->use_cone_patterns
)
719 if (given
->flags
& PATTERN_FLAG_NEGATIVE
&&
720 given
->flags
& PATTERN_FLAG_MUSTBEDIR
&&
721 !strcmp(given
->pattern
, "/*")) {
726 if (!given
->flags
&& !strcmp(given
->pattern
, "/*")) {
731 if (given
->patternlen
< 2 ||
732 *given
->pattern
!= '/' ||
733 strstr(given
->pattern
, "**")) {
734 /* Not a cone pattern. */
735 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
739 if (!(given
->flags
& PATTERN_FLAG_MUSTBEDIR
) &&
740 strcmp(given
->pattern
, "/*")) {
741 /* Not a cone pattern. */
742 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
746 prev
= given
->pattern
;
747 cur
= given
->pattern
+ 1;
748 next
= given
->pattern
+ 2;
751 /* Watch for glob characters '*', '\', '[', '?' */
752 if (!is_glob_special(*cur
))
755 /* But only if *prev != '\\' */
759 /* But allow the initial '\' */
761 is_glob_special(*next
))
764 /* But a trailing '/' then '*' is fine */
770 /* Not a cone pattern. */
771 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
780 if (given
->patternlen
> 2 &&
781 !strcmp(given
->pattern
+ given
->patternlen
- 2, "/*")) {
782 if (!(given
->flags
& PATTERN_FLAG_NEGATIVE
)) {
783 /* Not a cone pattern. */
784 warning(_("unrecognized pattern: '%s'"), given
->pattern
);
788 truncated
= dup_and_filter_pattern(given
->pattern
);
790 translated
= xmalloc(sizeof(struct pattern_entry
));
791 translated
->pattern
= truncated
;
792 translated
->patternlen
= given
->patternlen
- 2;
793 hashmap_entry_init(&translated
->ent
,
794 fspathhash(translated
->pattern
));
796 if (!hashmap_get_entry(&pl
->recursive_hashmap
,
797 translated
, ent
, NULL
)) {
798 /* We did not see the "parent" included */
799 warning(_("unrecognized negative pattern: '%s'"),
806 hashmap_add(&pl
->parent_hashmap
, &translated
->ent
);
807 hashmap_remove(&pl
->recursive_hashmap
, &translated
->ent
, &data
);
812 if (given
->flags
& PATTERN_FLAG_NEGATIVE
) {
813 warning(_("unrecognized negative pattern: '%s'"),
818 translated
= xmalloc(sizeof(struct pattern_entry
));
820 translated
->pattern
= dup_and_filter_pattern(given
->pattern
);
821 translated
->patternlen
= given
->patternlen
;
822 hashmap_entry_init(&translated
->ent
,
823 fspathhash(translated
->pattern
));
825 hashmap_add(&pl
->recursive_hashmap
, &translated
->ent
);
827 if (hashmap_get_entry(&pl
->parent_hashmap
, translated
, ent
, NULL
)) {
828 /* we already included this at the parent level */
829 warning(_("your sparse-checkout file may have issues: pattern '%s' is repeated"),
837 warning(_("disabling cone pattern matching"));
838 hashmap_clear_and_free(&pl
->parent_hashmap
, struct pattern_entry
, ent
);
839 hashmap_clear_and_free(&pl
->recursive_hashmap
, struct pattern_entry
, ent
);
840 pl
->use_cone_patterns
= 0;
843 static int hashmap_contains_path(struct hashmap
*map
,
844 struct strbuf
*pattern
)
846 struct pattern_entry p
;
848 /* Check straight mapping */
849 p
.pattern
= pattern
->buf
;
850 p
.patternlen
= pattern
->len
;
851 hashmap_entry_init(&p
.ent
, fspathhash(p
.pattern
));
852 return !!hashmap_get_entry(map
, &p
, ent
, NULL
);
855 int hashmap_contains_parent(struct hashmap
*map
,
857 struct strbuf
*buffer
)
861 strbuf_setlen(buffer
, 0);
864 strbuf_addch(buffer
, '/');
866 strbuf_addstr(buffer
, path
);
868 slash_pos
= strrchr(buffer
->buf
, '/');
870 while (slash_pos
> buffer
->buf
) {
871 strbuf_setlen(buffer
, slash_pos
- buffer
->buf
);
873 if (hashmap_contains_path(map
, buffer
))
876 slash_pos
= strrchr(buffer
->buf
, '/');
882 void add_pattern(const char *string
, const char *base
,
883 int baselen
, struct pattern_list
*pl
, int srcpos
)
885 struct path_pattern
*pattern
;
890 parse_path_pattern(&string
, &patternlen
, &flags
, &nowildcardlen
);
891 if (flags
& PATTERN_FLAG_MUSTBEDIR
) {
892 FLEXPTR_ALLOC_MEM(pattern
, pattern
, string
, patternlen
);
894 pattern
= xmalloc(sizeof(*pattern
));
895 pattern
->pattern
= string
;
897 pattern
->patternlen
= patternlen
;
898 pattern
->nowildcardlen
= nowildcardlen
;
899 pattern
->base
= base
;
900 pattern
->baselen
= baselen
;
901 pattern
->flags
= flags
;
902 pattern
->srcpos
= srcpos
;
903 ALLOC_GROW(pl
->patterns
, pl
->nr
+ 1, pl
->alloc
);
904 pl
->patterns
[pl
->nr
++] = pattern
;
907 add_pattern_to_hashsets(pl
, pattern
);
910 static int read_skip_worktree_file_from_index(struct index_state
*istate
,
912 size_t *size_out
, char **data_out
,
913 struct oid_stat
*oid_stat
)
918 pos
= index_name_pos(istate
, path
, len
);
921 if (!ce_skip_worktree(istate
->cache
[pos
]))
924 return do_read_blob(&istate
->cache
[pos
]->oid
, oid_stat
, size_out
, data_out
);
928 * Frees memory within pl which was allocated for exclude patterns and
929 * the file buffer. Does not free pl itself.
931 void clear_pattern_list(struct pattern_list
*pl
)
935 for (i
= 0; i
< pl
->nr
; i
++)
936 free(pl
->patterns
[i
]);
939 hashmap_clear_and_free(&pl
->recursive_hashmap
, struct pattern_entry
, ent
);
940 hashmap_clear_and_free(&pl
->parent_hashmap
, struct pattern_entry
, ent
);
942 memset(pl
, 0, sizeof(*pl
));
945 static void trim_trailing_spaces(char *buf
)
947 char *p
, *last_space
= NULL
;
949 for (p
= buf
; *p
; p
++)
969 * Given a subdirectory name and "dir" of the current directory,
970 * search the subdir in "dir" and return it, or create a new one if it
971 * does not exist in "dir".
973 * If "name" has the trailing slash, it'll be excluded in the search.
975 static struct untracked_cache_dir
*lookup_untracked(struct untracked_cache
*uc
,
976 struct untracked_cache_dir
*dir
,
977 const char *name
, int len
)
980 struct untracked_cache_dir
*d
;
983 if (len
&& name
[len
- 1] == '/')
987 while (last
> first
) {
988 int cmp
, next
= first
+ ((last
- first
) >> 1);
990 cmp
= strncmp(name
, d
->name
, len
);
991 if (!cmp
&& strlen(d
->name
) > len
)
1003 FLEX_ALLOC_MEM(d
, name
, name
, len
);
1005 ALLOC_GROW(dir
->dirs
, dir
->dirs_nr
+ 1, dir
->dirs_alloc
);
1006 MOVE_ARRAY(dir
->dirs
+ first
+ 1, dir
->dirs
+ first
,
1007 dir
->dirs_nr
- first
);
1009 dir
->dirs
[first
] = d
;
1013 static void do_invalidate_gitignore(struct untracked_cache_dir
*dir
)
1017 dir
->untracked_nr
= 0;
1018 for (i
= 0; i
< dir
->dirs_nr
; i
++)
1019 do_invalidate_gitignore(dir
->dirs
[i
]);
1022 static void invalidate_gitignore(struct untracked_cache
*uc
,
1023 struct untracked_cache_dir
*dir
)
1025 uc
->gitignore_invalidated
++;
1026 do_invalidate_gitignore(dir
);
1029 static void invalidate_directory(struct untracked_cache
*uc
,
1030 struct untracked_cache_dir
*dir
)
1035 * Invalidation increment here is just roughly correct. If
1036 * untracked_nr or any of dirs[].recurse is non-zero, we
1037 * should increment dir_invalidated too. But that's more
1041 uc
->dir_invalidated
++;
1044 dir
->untracked_nr
= 0;
1045 for (i
= 0; i
< dir
->dirs_nr
; i
++)
1046 dir
->dirs
[i
]->recurse
= 0;
1049 static int add_patterns_from_buffer(char *buf
, size_t size
,
1050 const char *base
, int baselen
,
1051 struct pattern_list
*pl
);
1053 /* Flags for add_patterns() */
1054 #define PATTERN_NOFOLLOW (1<<0)
1057 * Given a file with name "fname", read it (either from disk, or from
1058 * an index if 'istate' is non-null), parse it and store the
1059 * exclude rules in "pl".
1061 * If "oid_stat" is not NULL, compute oid of the exclude file and fill
1062 * stat data from disk (only valid if add_patterns returns zero). If
1063 * oid_stat.valid is non-zero, "oid_stat" must contain good value as input.
1065 static int add_patterns(const char *fname
, const char *base
, int baselen
,
1066 struct pattern_list
*pl
, struct index_state
*istate
,
1067 unsigned flags
, struct oid_stat
*oid_stat
)
1075 if (flags
& PATTERN_NOFOLLOW
)
1076 fd
= open_nofollow(fname
, O_RDONLY
);
1078 fd
= open(fname
, O_RDONLY
);
1080 if (fd
< 0 || fstat(fd
, &st
) < 0) {
1082 warn_on_fopen_errors(fname
);
1087 r
= read_skip_worktree_file_from_index(istate
, fname
,
1093 size
= xsize_t(st
.st_size
);
1096 fill_stat_data(&oid_stat
->stat
, &st
);
1097 oidcpy(&oid_stat
->oid
, the_hash_algo
->empty_blob
);
1098 oid_stat
->valid
= 1;
1103 buf
= xmallocz(size
);
1104 if (read_in_full(fd
, buf
, size
) != size
) {
1113 if (oid_stat
->valid
&&
1114 !match_stat_data_racy(istate
, &oid_stat
->stat
, &st
))
1115 ; /* no content change, oid_stat->oid still good */
1117 (pos
= index_name_pos(istate
, fname
, strlen(fname
))) >= 0 &&
1118 !ce_stage(istate
->cache
[pos
]) &&
1119 ce_uptodate(istate
->cache
[pos
]) &&
1120 !would_convert_to_git(istate
, fname
))
1121 oidcpy(&oid_stat
->oid
,
1122 &istate
->cache
[pos
]->oid
);
1124 hash_object_file(the_hash_algo
, buf
, size
,
1125 OBJ_BLOB
, &oid_stat
->oid
);
1126 fill_stat_data(&oid_stat
->stat
, &st
);
1127 oid_stat
->valid
= 1;
1131 add_patterns_from_buffer(buf
, size
, base
, baselen
, pl
);
1135 static int add_patterns_from_buffer(char *buf
, size_t size
,
1136 const char *base
, int baselen
,
1137 struct pattern_list
*pl
)
1142 hashmap_init(&pl
->recursive_hashmap
, pl_hashmap_cmp
, NULL
, 0);
1143 hashmap_init(&pl
->parent_hashmap
, pl_hashmap_cmp
, NULL
, 0);
1147 if (skip_utf8_bom(&buf
, size
))
1148 size
-= buf
- pl
->filebuf
;
1152 for (i
= 0; i
< size
; i
++) {
1153 if (buf
[i
] == '\n') {
1154 if (entry
!= buf
+ i
&& entry
[0] != '#') {
1155 buf
[i
- (i
&& buf
[i
-1] == '\r')] = 0;
1156 trim_trailing_spaces(entry
);
1157 add_pattern(entry
, base
, baselen
, pl
, lineno
);
1160 entry
= buf
+ i
+ 1;
1166 int add_patterns_from_file_to_list(const char *fname
, const char *base
,
1167 int baselen
, struct pattern_list
*pl
,
1168 struct index_state
*istate
,
1171 return add_patterns(fname
, base
, baselen
, pl
, istate
, flags
, NULL
);
1174 int add_patterns_from_blob_to_list(
1175 struct object_id
*oid
,
1176 const char *base
, int baselen
,
1177 struct pattern_list
*pl
)
1183 r
= do_read_blob(oid
, NULL
, &size
, &buf
);
1187 add_patterns_from_buffer(buf
, size
, base
, baselen
, pl
);
1191 struct pattern_list
*add_pattern_list(struct dir_struct
*dir
,
1192 int group_type
, const char *src
)
1194 struct pattern_list
*pl
;
1195 struct exclude_list_group
*group
;
1197 group
= &dir
->internal
.exclude_list_group
[group_type
];
1198 ALLOC_GROW(group
->pl
, group
->nr
+ 1, group
->alloc
);
1199 pl
= &group
->pl
[group
->nr
++];
1200 memset(pl
, 0, sizeof(*pl
));
1206 * Used to set up core.excludesfile and .git/info/exclude lists.
1208 static void add_patterns_from_file_1(struct dir_struct
*dir
, const char *fname
,
1209 struct oid_stat
*oid_stat
)
1211 struct pattern_list
*pl
;
1213 * catch setup_standard_excludes() that's called before
1214 * dir->untracked is assigned. That function behaves
1215 * differently when dir->untracked is non-NULL.
1217 if (!dir
->untracked
)
1218 dir
->internal
.unmanaged_exclude_files
++;
1219 pl
= add_pattern_list(dir
, EXC_FILE
, fname
);
1220 if (add_patterns(fname
, "", 0, pl
, NULL
, 0, oid_stat
) < 0)
1221 die(_("cannot use %s as an exclude file"), fname
);
1224 void add_patterns_from_file(struct dir_struct
*dir
, const char *fname
)
1226 dir
->internal
.unmanaged_exclude_files
++; /* see validate_untracked_cache() */
1227 add_patterns_from_file_1(dir
, fname
, NULL
);
1230 int match_basename(const char *basename
, int basenamelen
,
1231 const char *pattern
, int prefix
, int patternlen
,
1234 if (prefix
== patternlen
) {
1235 if (patternlen
== basenamelen
&&
1236 !fspathncmp(pattern
, basename
, basenamelen
))
1238 } else if (flags
& PATTERN_FLAG_ENDSWITH
) {
1239 /* "*literal" matching against "fooliteral" */
1240 if (patternlen
- 1 <= basenamelen
&&
1241 !fspathncmp(pattern
+ 1,
1242 basename
+ basenamelen
- (patternlen
- 1),
1246 if (fnmatch_icase_mem(pattern
, patternlen
,
1247 basename
, basenamelen
,
1254 int match_pathname(const char *pathname
, int pathlen
,
1255 const char *base
, int baselen
,
1256 const char *pattern
, int prefix
, int patternlen
)
1262 * match with FNM_PATHNAME; the pattern has base implicitly
1265 if (*pattern
== '/') {
1272 * baselen does not count the trailing slash. base[] may or
1273 * may not end with a trailing slash though.
1275 if (pathlen
< baselen
+ 1 ||
1276 (baselen
&& pathname
[baselen
] != '/') ||
1277 fspathncmp(pathname
, base
, baselen
))
1280 namelen
= baselen
? pathlen
- baselen
- 1 : pathlen
;
1281 name
= pathname
+ pathlen
- namelen
;
1285 * if the non-wildcard part is longer than the
1286 * remaining pathname, surely it cannot match.
1288 if (prefix
> namelen
)
1291 if (fspathncmp(pattern
, name
, prefix
))
1294 patternlen
-= prefix
;
1299 * If the whole pattern did not have a wildcard,
1300 * then our prefix match is all we need; we
1301 * do not need to call fnmatch at all.
1303 if (!patternlen
&& !namelen
)
1307 return fnmatch_icase_mem(pattern
, patternlen
,
1313 * Scan the given exclude list in reverse to see whether pathname
1314 * should be ignored. The first match (i.e. the last on the list), if
1315 * any, determines the fate. Returns the exclude_list element which
1316 * matched, or NULL for undecided.
1318 static struct path_pattern
*last_matching_pattern_from_list(const char *pathname
,
1320 const char *basename
,
1322 struct pattern_list
*pl
,
1323 struct index_state
*istate
)
1325 struct path_pattern
*res
= NULL
; /* undecided */
1329 return NULL
; /* undefined */
1331 for (i
= pl
->nr
- 1; 0 <= i
; i
--) {
1332 struct path_pattern
*pattern
= pl
->patterns
[i
];
1333 const char *exclude
= pattern
->pattern
;
1334 int prefix
= pattern
->nowildcardlen
;
1336 if (pattern
->flags
& PATTERN_FLAG_MUSTBEDIR
) {
1337 *dtype
= resolve_dtype(*dtype
, istate
, pathname
, pathlen
);
1338 if (*dtype
!= DT_DIR
)
1342 if (pattern
->flags
& PATTERN_FLAG_NODIR
) {
1343 if (match_basename(basename
,
1344 pathlen
- (basename
- pathname
),
1345 exclude
, prefix
, pattern
->patternlen
,
1353 assert(pattern
->baselen
== 0 ||
1354 pattern
->base
[pattern
->baselen
- 1] == '/');
1355 if (match_pathname(pathname
, pathlen
,
1357 pattern
->baselen
? pattern
->baselen
- 1 : 0,
1358 exclude
, prefix
, pattern
->patternlen
)) {
1367 * Scan the list of patterns to determine if the ordered list
1368 * of patterns matches on 'pathname'.
1370 * Return 1 for a match, 0 for not matched and -1 for undecided.
1372 enum pattern_match_result
path_matches_pattern_list(
1373 const char *pathname
, int pathlen
,
1374 const char *basename
, int *dtype
,
1375 struct pattern_list
*pl
,
1376 struct index_state
*istate
)
1378 struct path_pattern
*pattern
;
1379 struct strbuf parent_pathname
= STRBUF_INIT
;
1380 int result
= NOT_MATCHED
;
1383 if (!pl
->use_cone_patterns
) {
1384 pattern
= last_matching_pattern_from_list(pathname
, pathlen
, basename
,
1387 if (pattern
->flags
& PATTERN_FLAG_NEGATIVE
)
1399 strbuf_addch(&parent_pathname
, '/');
1400 strbuf_add(&parent_pathname
, pathname
, pathlen
);
1403 * Directory entries are matched if and only if a file
1404 * contained immediately within them is matched. For the
1405 * case of a directory entry, modify the path to create
1406 * a fake filename within this directory, allowing us to
1407 * use the file-base matching logic in an equivalent way.
1409 if (parent_pathname
.len
> 0 &&
1410 parent_pathname
.buf
[parent_pathname
.len
- 1] == '/') {
1411 slash_pos
= parent_pathname
.len
- 1;
1412 strbuf_add(&parent_pathname
, "-", 1);
1414 const char *slash_ptr
= strrchr(parent_pathname
.buf
, '/');
1415 slash_pos
= slash_ptr
? slash_ptr
- parent_pathname
.buf
: 0;
1418 if (hashmap_contains_path(&pl
->recursive_hashmap
,
1419 &parent_pathname
)) {
1420 result
= MATCHED_RECURSIVE
;
1425 /* include every file in root */
1430 strbuf_setlen(&parent_pathname
, slash_pos
);
1432 if (hashmap_contains_path(&pl
->parent_hashmap
, &parent_pathname
)) {
1437 if (hashmap_contains_parent(&pl
->recursive_hashmap
,
1440 result
= MATCHED_RECURSIVE
;
1443 strbuf_release(&parent_pathname
);
1447 int init_sparse_checkout_patterns(struct index_state
*istate
)
1449 if (!core_apply_sparse_checkout
)
1451 if (istate
->sparse_checkout_patterns
)
1454 CALLOC_ARRAY(istate
->sparse_checkout_patterns
, 1);
1456 if (get_sparse_checkout_patterns(istate
->sparse_checkout_patterns
) < 0) {
1457 FREE_AND_NULL(istate
->sparse_checkout_patterns
);
1464 static int path_in_sparse_checkout_1(const char *path
,
1465 struct index_state
*istate
,
1466 int require_cone_mode
)
1469 enum pattern_match_result match
= UNDECIDED
;
1470 const char *end
, *slash
;
1473 * We default to accepting a path if the path is empty, there are no
1474 * patterns, or the patterns are of the wrong type.
1477 init_sparse_checkout_patterns(istate
) ||
1478 (require_cone_mode
&&
1479 !istate
->sparse_checkout_patterns
->use_cone_patterns
))
1483 * If UNDECIDED, use the match from the parent dir (recursively), or
1484 * fall back to NOT_MATCHED at the topmost level. Note that cone mode
1485 * never returns UNDECIDED, so we will execute only one iteration in
1488 for (end
= path
+ strlen(path
);
1489 end
> path
&& match
== UNDECIDED
;
1492 for (slash
= end
- 1; slash
> path
&& *slash
!= '/'; slash
--)
1495 match
= path_matches_pattern_list(path
, end
- path
,
1496 slash
> path
? slash
+ 1 : path
, &dtype
,
1497 istate
->sparse_checkout_patterns
, istate
);
1499 /* We are going to match the parent dir now */
1505 int path_in_sparse_checkout(const char *path
,
1506 struct index_state
*istate
)
1508 return path_in_sparse_checkout_1(path
, istate
, 0);
1511 int path_in_cone_mode_sparse_checkout(const char *path
,
1512 struct index_state
*istate
)
1514 return path_in_sparse_checkout_1(path
, istate
, 1);
1517 static struct path_pattern
*last_matching_pattern_from_lists(
1518 struct dir_struct
*dir
, struct index_state
*istate
,
1519 const char *pathname
, int pathlen
,
1520 const char *basename
, int *dtype_p
)
1523 struct exclude_list_group
*group
;
1524 struct path_pattern
*pattern
;
1525 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
1526 group
= &dir
->internal
.exclude_list_group
[i
];
1527 for (j
= group
->nr
- 1; j
>= 0; j
--) {
1528 pattern
= last_matching_pattern_from_list(
1529 pathname
, pathlen
, basename
, dtype_p
,
1530 &group
->pl
[j
], istate
);
1539 * Loads the per-directory exclude list for the substring of base
1540 * which has a char length of baselen.
1542 static void prep_exclude(struct dir_struct
*dir
,
1543 struct index_state
*istate
,
1544 const char *base
, int baselen
)
1546 struct exclude_list_group
*group
;
1547 struct pattern_list
*pl
;
1548 struct exclude_stack
*stk
= NULL
;
1549 struct untracked_cache_dir
*untracked
;
1552 group
= &dir
->internal
.exclude_list_group
[EXC_DIRS
];
1555 * Pop the exclude lists from the EXCL_DIRS exclude_list_group
1556 * which originate from directories not in the prefix of the
1557 * path being checked.
1559 while ((stk
= dir
->internal
.exclude_stack
) != NULL
) {
1560 if (stk
->baselen
<= baselen
&&
1561 !strncmp(dir
->internal
.basebuf
.buf
, base
, stk
->baselen
))
1563 pl
= &group
->pl
[dir
->internal
.exclude_stack
->exclude_ix
];
1564 dir
->internal
.exclude_stack
= stk
->prev
;
1565 dir
->internal
.pattern
= NULL
;
1566 free((char *)pl
->src
); /* see strbuf_detach() below */
1567 clear_pattern_list(pl
);
1572 /* Skip traversing into sub directories if the parent is excluded */
1573 if (dir
->internal
.pattern
)
1577 * Lazy initialization. All call sites currently just
1578 * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1579 * them seems lots of work for little benefit.
1581 if (!dir
->internal
.basebuf
.buf
)
1582 strbuf_init(&dir
->internal
.basebuf
, PATH_MAX
);
1584 /* Read from the parent directories and push them down. */
1585 current
= stk
? stk
->baselen
: -1;
1586 strbuf_setlen(&dir
->internal
.basebuf
, current
< 0 ? 0 : current
);
1588 untracked
= stk
? stk
->ucd
: dir
->untracked
->root
;
1592 while (current
< baselen
) {
1594 struct oid_stat oid_stat
;
1596 CALLOC_ARRAY(stk
, 1);
1601 cp
= strchr(base
+ current
+ 1, '/');
1603 die("oops in prep_exclude");
1606 lookup_untracked(dir
->untracked
,
1609 cp
- base
- current
);
1611 stk
->prev
= dir
->internal
.exclude_stack
;
1612 stk
->baselen
= cp
- base
;
1613 stk
->exclude_ix
= group
->nr
;
1614 stk
->ucd
= untracked
;
1615 pl
= add_pattern_list(dir
, EXC_DIRS
, NULL
);
1616 strbuf_add(&dir
->internal
.basebuf
, base
+ current
, stk
->baselen
- current
);
1617 assert(stk
->baselen
== dir
->internal
.basebuf
.len
);
1619 /* Abort if the directory is excluded */
1622 dir
->internal
.basebuf
.buf
[stk
->baselen
- 1] = 0;
1623 dir
->internal
.pattern
= last_matching_pattern_from_lists(dir
,
1625 dir
->internal
.basebuf
.buf
, stk
->baselen
- 1,
1626 dir
->internal
.basebuf
.buf
+ current
, &dt
);
1627 dir
->internal
.basebuf
.buf
[stk
->baselen
- 1] = '/';
1628 if (dir
->internal
.pattern
&&
1629 dir
->internal
.pattern
->flags
& PATTERN_FLAG_NEGATIVE
)
1630 dir
->internal
.pattern
= NULL
;
1631 if (dir
->internal
.pattern
) {
1632 dir
->internal
.exclude_stack
= stk
;
1637 /* Try to read per-directory file */
1638 oidclr(&oid_stat
.oid
);
1640 if (dir
->exclude_per_dir
&&
1642 * If we know that no files have been added in
1643 * this directory (i.e. valid_cached_dir() has
1644 * been executed and set untracked->valid) ..
1646 (!untracked
|| !untracked
->valid
||
1648 * .. and .gitignore does not exist before
1649 * (i.e. null exclude_oid). Then we can skip
1650 * loading .gitignore, which would result in
1653 !is_null_oid(&untracked
->exclude_oid
))) {
1655 * dir->internal.basebuf gets reused by the traversal,
1656 * but we need fname to remain unchanged to ensure the
1657 * src member of each struct path_pattern correctly
1658 * back-references its source file. Other invocations
1659 * of add_pattern_list provide stable strings, so we
1660 * strbuf_detach() and free() here in the caller.
1662 struct strbuf sb
= STRBUF_INIT
;
1663 strbuf_addbuf(&sb
, &dir
->internal
.basebuf
);
1664 strbuf_addstr(&sb
, dir
->exclude_per_dir
);
1665 pl
->src
= strbuf_detach(&sb
, NULL
);
1666 add_patterns(pl
->src
, pl
->src
, stk
->baselen
, pl
, istate
,
1668 untracked
? &oid_stat
: NULL
);
1671 * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1672 * will first be called in valid_cached_dir() then maybe many
1673 * times more in last_matching_pattern(). When the cache is
1674 * used, last_matching_pattern() will not be called and
1675 * reading .gitignore content will be a waste.
1677 * So when it's called by valid_cached_dir() and we can get
1678 * .gitignore SHA-1 from the index (i.e. .gitignore is not
1679 * modified on work tree), we could delay reading the
1680 * .gitignore content until we absolutely need it in
1681 * last_matching_pattern(). Be careful about ignore rule
1682 * order, though, if you do that.
1685 !oideq(&oid_stat
.oid
, &untracked
->exclude_oid
)) {
1686 invalidate_gitignore(dir
->untracked
, untracked
);
1687 oidcpy(&untracked
->exclude_oid
, &oid_stat
.oid
);
1689 dir
->internal
.exclude_stack
= stk
;
1690 current
= stk
->baselen
;
1692 strbuf_setlen(&dir
->internal
.basebuf
, baselen
);
1696 * Loads the exclude lists for the directory containing pathname, then
1697 * scans all exclude lists to determine whether pathname is excluded.
1698 * Returns the exclude_list element which matched, or NULL for
1701 struct path_pattern
*last_matching_pattern(struct dir_struct
*dir
,
1702 struct index_state
*istate
,
1703 const char *pathname
,
1706 int pathlen
= strlen(pathname
);
1707 const char *basename
= strrchr(pathname
, '/');
1708 basename
= (basename
) ? basename
+1 : pathname
;
1710 prep_exclude(dir
, istate
, pathname
, basename
-pathname
);
1712 if (dir
->internal
.pattern
)
1713 return dir
->internal
.pattern
;
1715 return last_matching_pattern_from_lists(dir
, istate
, pathname
, pathlen
,
1720 * Loads the exclude lists for the directory containing pathname, then
1721 * scans all exclude lists to determine whether pathname is excluded.
1722 * Returns 1 if true, otherwise 0.
1724 int is_excluded(struct dir_struct
*dir
, struct index_state
*istate
,
1725 const char *pathname
, int *dtype_p
)
1727 struct path_pattern
*pattern
=
1728 last_matching_pattern(dir
, istate
, pathname
, dtype_p
);
1730 return pattern
->flags
& PATTERN_FLAG_NEGATIVE
? 0 : 1;
1734 static struct dir_entry
*dir_entry_new(const char *pathname
, int len
)
1736 struct dir_entry
*ent
;
1738 FLEX_ALLOC_MEM(ent
, name
, pathname
, len
);
1743 static struct dir_entry
*dir_add_name(struct dir_struct
*dir
,
1744 struct index_state
*istate
,
1745 const char *pathname
, int len
)
1747 if (index_file_exists(istate
, pathname
, len
, ignore_case
))
1750 ALLOC_GROW(dir
->entries
, dir
->nr
+1, dir
->internal
.alloc
);
1751 return dir
->entries
[dir
->nr
++] = dir_entry_new(pathname
, len
);
1754 struct dir_entry
*dir_add_ignored(struct dir_struct
*dir
,
1755 struct index_state
*istate
,
1756 const char *pathname
, int len
)
1758 if (!index_name_is_other(istate
, pathname
, len
))
1761 ALLOC_GROW(dir
->ignored
, dir
->ignored_nr
+1, dir
->internal
.ignored_alloc
);
1762 return dir
->ignored
[dir
->ignored_nr
++] = dir_entry_new(pathname
, len
);
1766 index_nonexistent
= 0,
1772 * Do not use the alphabetically sorted index to look up
1773 * the directory name; instead, use the case insensitive
1776 static enum exist_status
directory_exists_in_index_icase(struct index_state
*istate
,
1777 const char *dirname
, int len
)
1779 struct cache_entry
*ce
;
1781 if (index_dir_exists(istate
, dirname
, len
))
1782 return index_directory
;
1784 ce
= index_file_exists(istate
, dirname
, len
, ignore_case
);
1785 if (ce
&& S_ISGITLINK(ce
->ce_mode
))
1786 return index_gitdir
;
1788 return index_nonexistent
;
1792 * The index sorts alphabetically by entry name, which
1793 * means that a gitlink sorts as '\0' at the end, while
1794 * a directory (which is defined not as an entry, but as
1795 * the files it contains) will sort with the '/' at the
1798 static enum exist_status
directory_exists_in_index(struct index_state
*istate
,
1799 const char *dirname
, int len
)
1804 return directory_exists_in_index_icase(istate
, dirname
, len
);
1806 pos
= index_name_pos(istate
, dirname
, len
);
1809 while (pos
< istate
->cache_nr
) {
1810 const struct cache_entry
*ce
= istate
->cache
[pos
++];
1811 unsigned char endchar
;
1813 if (strncmp(ce
->name
, dirname
, len
))
1815 endchar
= ce
->name
[len
];
1819 return index_directory
;
1820 if (!endchar
&& S_ISGITLINK(ce
->ce_mode
))
1821 return index_gitdir
;
1823 return index_nonexistent
;
1827 * When we find a directory when traversing the filesystem, we
1828 * have three distinct cases:
1831 * - see it as a directory
1834 * and which one we choose depends on a combination of existing
1835 * git index contents and the flags passed into the directory
1836 * traversal routine.
1838 * Case 1: If we *already* have entries in the index under that
1839 * directory name, we always recurse into the directory to see
1842 * Case 2: If we *already* have that directory name as a gitlink,
1843 * we always continue to see it as a gitlink, regardless of whether
1844 * there is an actual git directory there or not (it might not
1845 * be checked out as a subproject!)
1847 * Case 3: if we didn't have it in the index previously, we
1848 * have a few sub-cases:
1850 * (a) if DIR_SHOW_OTHER_DIRECTORIES flag is set, we show it as
1851 * just a directory, unless DIR_HIDE_EMPTY_DIRECTORIES is
1852 * also true, in which case we need to check if it contains any
1853 * untracked and / or ignored files.
1854 * (b) if it looks like a git directory and we don't have the
1855 * DIR_NO_GITLINKS flag, then we treat it as a gitlink, and
1856 * show it as a directory.
1857 * (c) otherwise, we recurse into it.
1859 static enum path_treatment
treat_directory(struct dir_struct
*dir
,
1860 struct index_state
*istate
,
1861 struct untracked_cache_dir
*untracked
,
1862 const char *dirname
, int len
, int baselen
, int excluded
,
1863 const struct pathspec
*pathspec
)
1866 * WARNING: From this function, you can return path_recurse or you
1867 * can call read_directory_recursive() (or neither), but
1868 * you CAN'T DO BOTH.
1870 enum path_treatment state
;
1871 int matches_how
= 0;
1872 int check_only
, stop_early
;
1873 int old_ignored_nr
, old_untracked_nr
;
1874 /* The "len-1" is to strip the final '/' */
1875 enum exist_status status
= directory_exists_in_index(istate
, dirname
, len
-1);
1877 if (status
== index_directory
)
1878 return path_recurse
;
1879 if (status
== index_gitdir
)
1881 if (status
!= index_nonexistent
)
1882 BUG("Unhandled value for directory_exists_in_index: %d\n", status
);
1885 * We don't want to descend into paths that don't match the necessary
1886 * patterns. Clearly, if we don't have a pathspec, then we can't check
1887 * for matching patterns. Also, if (excluded) then we know we matched
1888 * the exclusion patterns so as an optimization we can skip checking
1889 * for matching patterns.
1891 if (pathspec
&& !excluded
) {
1892 matches_how
= match_pathspec_with_flags(istate
, pathspec
,
1896 DO_MATCH_LEADING_PATHSPEC
);
1902 if ((dir
->flags
& DIR_SKIP_NESTED_GIT
) ||
1903 !(dir
->flags
& DIR_NO_GITLINKS
)) {
1905 * Determine if `dirname` is a nested repo by confirming that:
1906 * 1) we are in a nonbare repository, and
1907 * 2) `dirname` is not an immediate parent of `the_repository->gitdir`,
1908 * which could occur if the git_dir or worktree location was
1909 * manually configured by the user; see t2205 testcases 1-3 for
1910 * examples where this matters
1913 struct strbuf sb
= STRBUF_INIT
;
1914 strbuf_addstr(&sb
, dirname
);
1915 nested_repo
= is_nonbare_repository_dir(&sb
);
1918 char *real_dirname
, *real_gitdir
;
1919 strbuf_addstr(&sb
, ".git");
1920 real_dirname
= real_pathdup(sb
.buf
, 1);
1921 real_gitdir
= real_pathdup(the_repository
->gitdir
, 1);
1923 nested_repo
= !!strcmp(real_dirname
, real_gitdir
);
1927 strbuf_release(&sb
);
1930 if ((dir
->flags
& DIR_SKIP_NESTED_GIT
) ||
1931 (matches_how
== MATCHED_RECURSIVELY_LEADING_PATHSPEC
))
1933 return excluded
? path_excluded
: path_untracked
;
1937 if (!(dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
)) {
1939 (dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
1940 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
)) {
1943 * This is an excluded directory and we are
1944 * showing ignored paths that match an exclude
1945 * pattern. (e.g. show directory as ignored
1946 * only if it matches an exclude pattern).
1947 * This path will either be 'path_excluded`
1948 * (if we are showing empty directories or if
1949 * the directory is not empty), or will be
1950 * 'path_none' (empty directory, and we are
1951 * not showing empty directories).
1953 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
1954 return path_excluded
;
1956 if (read_directory_recursive(dir
, istate
, dirname
, len
,
1957 untracked
, 1, 1, pathspec
) == path_excluded
)
1958 return path_excluded
;
1962 return path_recurse
;
1965 assert(dir
->flags
& DIR_SHOW_OTHER_DIRECTORIES
);
1968 * If we have a pathspec which could match something _below_ this
1969 * directory (e.g. when checking 'subdir/' having a pathspec like
1970 * 'subdir/some/deep/path/file' or 'subdir/widget-*.c'), then we
1973 if (matches_how
== MATCHED_RECURSIVELY_LEADING_PATHSPEC
)
1974 return path_recurse
;
1976 /* Special cases for where this directory is excluded/ignored */
1979 * If DIR_SHOW_OTHER_DIRECTORIES is set and we're not
1980 * hiding empty directories, there is no need to
1981 * recurse into an ignored directory.
1983 if (!(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
1984 return path_excluded
;
1987 * Even if we are hiding empty directories, we can still avoid
1988 * recursing into ignored directories for DIR_SHOW_IGNORED_TOO
1989 * if DIR_SHOW_IGNORED_TOO_MODE_MATCHING is also set.
1991 if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
1992 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
))
1993 return path_excluded
;
1997 * Other than the path_recurse case above, we only need to
1998 * recurse into untracked directories if any of the following
2000 * - DIR_SHOW_IGNORED (because then we need to determine if
2001 * there are ignored entries below)
2002 * - DIR_SHOW_IGNORED_TOO (same as above)
2003 * - DIR_HIDE_EMPTY_DIRECTORIES (because we have to determine if
2004 * the directory is empty)
2007 !(dir
->flags
& (DIR_SHOW_IGNORED
|
2008 DIR_SHOW_IGNORED_TOO
|
2009 DIR_HIDE_EMPTY_DIRECTORIES
))) {
2010 return path_untracked
;
2014 * Even if we don't want to know all the paths under an untracked or
2015 * ignored directory, we may still need to go into the directory to
2016 * determine if it is empty (because with DIR_HIDE_EMPTY_DIRECTORIES,
2017 * an empty directory should be path_none instead of path_excluded or
2020 check_only
= ((dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
) &&
2021 !(dir
->flags
& DIR_SHOW_IGNORED_TOO
));
2024 * However, there's another optimization possible as a subset of
2025 * check_only, based on the cases we have to consider:
2026 * A) Directory matches no exclude patterns:
2027 * * Directory is empty => path_none
2028 * * Directory has an untracked file under it => path_untracked
2029 * * Directory has only ignored files under it => path_excluded
2030 * B) Directory matches an exclude pattern:
2031 * * Directory is empty => path_none
2032 * * Directory has an untracked file under it => path_excluded
2033 * * Directory has only ignored files under it => path_excluded
2034 * In case A, we can exit as soon as we've found an untracked
2035 * file but otherwise have to walk all files. In case B, though,
2036 * we can stop at the first file we find under the directory.
2038 stop_early
= check_only
&& excluded
;
2041 * If /every/ file within an untracked directory is ignored, then
2042 * we want to treat the directory as ignored (for e.g. status
2043 * --porcelain), without listing the individual ignored files
2044 * underneath. To do so, we'll save the current ignored_nr, and
2045 * pop all the ones added after it if it turns out the entire
2046 * directory is ignored. Also, when DIR_SHOW_IGNORED_TOO and
2047 * !DIR_KEEP_UNTRACKED_CONTENTS then we don't want to show
2048 * untracked paths so will need to pop all those off the last
2049 * after we traverse.
2051 old_ignored_nr
= dir
->ignored_nr
;
2052 old_untracked_nr
= dir
->nr
;
2054 /* Actually recurse into dirname now, we'll fixup the state later. */
2055 untracked
= lookup_untracked(dir
->untracked
, untracked
,
2056 dirname
+ baselen
, len
- baselen
);
2057 state
= read_directory_recursive(dir
, istate
, dirname
, len
, untracked
,
2058 check_only
, stop_early
, pathspec
);
2060 /* There are a variety of reasons we may need to fixup the state... */
2061 if (state
== path_excluded
) {
2062 /* state == path_excluded implies all paths under
2063 * dirname were ignored...
2065 * if running e.g. `git status --porcelain --ignored=matching`,
2066 * then we want to see the subpaths that are ignored.
2068 * if running e.g. just `git status --porcelain`, then
2069 * we just want the directory itself to be listed as ignored
2070 * and not the individual paths underneath.
2072 int want_ignored_subpaths
=
2073 ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
2074 (dir
->flags
& DIR_SHOW_IGNORED_TOO_MODE_MATCHING
));
2076 if (want_ignored_subpaths
) {
2078 * with --ignored=matching, we want the subpaths
2079 * INSTEAD of the directory itself.
2084 for (i
= old_ignored_nr
+ 1; i
<dir
->ignored_nr
; ++i
)
2085 FREE_AND_NULL(dir
->ignored
[i
]);
2086 dir
->ignored_nr
= old_ignored_nr
;
2091 * We may need to ignore some of the untracked paths we found while
2092 * traversing subdirectories.
2094 if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) &&
2095 !(dir
->flags
& DIR_KEEP_UNTRACKED_CONTENTS
)) {
2097 for (i
= old_untracked_nr
+ 1; i
<dir
->nr
; ++i
)
2098 FREE_AND_NULL(dir
->entries
[i
]);
2099 dir
->nr
= old_untracked_nr
;
2103 * If there is nothing under the current directory and we are not
2104 * hiding empty directories, then we need to report on the
2105 * untracked or ignored status of the directory itself.
2107 if (state
== path_none
&& !(dir
->flags
& DIR_HIDE_EMPTY_DIRECTORIES
))
2108 state
= excluded
? path_excluded
: path_untracked
;
2114 * This is an inexact early pruning of any recursive directory
2115 * reading - if the path cannot possibly be in the pathspec,
2116 * return true, and we'll skip it early.
2118 static int simplify_away(const char *path
, int pathlen
,
2119 const struct pathspec
*pathspec
)
2123 if (!pathspec
|| !pathspec
->nr
)
2126 GUARD_PATHSPEC(pathspec
,
2135 for (i
= 0; i
< pathspec
->nr
; i
++) {
2136 const struct pathspec_item
*item
= &pathspec
->items
[i
];
2137 int len
= item
->nowildcard_len
;
2141 if (!ps_strncmp(item
, item
->match
, path
, len
))
2149 * This function tells us whether an excluded path matches a
2150 * list of "interesting" pathspecs. That is, whether a path matched
2151 * by any of the pathspecs could possibly be ignored by excluding
2152 * the specified path. This can happen if:
2154 * 1. the path is mentioned explicitly in the pathspec
2156 * 2. the path is a directory prefix of some element in the
2159 static int exclude_matches_pathspec(const char *path
, int pathlen
,
2160 const struct pathspec
*pathspec
)
2164 if (!pathspec
|| !pathspec
->nr
)
2167 GUARD_PATHSPEC(pathspec
,
2175 for (i
= 0; i
< pathspec
->nr
; i
++) {
2176 const struct pathspec_item
*item
= &pathspec
->items
[i
];
2177 int len
= item
->nowildcard_len
;
2179 if (len
== pathlen
&&
2180 !ps_strncmp(item
, item
->match
, path
, pathlen
))
2182 if (len
> pathlen
&&
2183 item
->match
[pathlen
] == '/' &&
2184 !ps_strncmp(item
, item
->match
, path
, pathlen
))
2190 static int get_index_dtype(struct index_state
*istate
,
2191 const char *path
, int len
)
2194 const struct cache_entry
*ce
;
2196 ce
= index_file_exists(istate
, path
, len
, 0);
2198 if (!ce_uptodate(ce
))
2200 if (S_ISGITLINK(ce
->ce_mode
))
2203 * Nobody actually cares about the
2204 * difference between DT_LNK and DT_REG
2209 /* Try to look it up as a directory */
2210 pos
= index_name_pos(istate
, path
, len
);
2214 while (pos
< istate
->cache_nr
) {
2215 ce
= istate
->cache
[pos
++];
2216 if (strncmp(ce
->name
, path
, len
))
2218 if (ce
->name
[len
] > '/')
2220 if (ce
->name
[len
] < '/')
2222 if (!ce_uptodate(ce
))
2223 break; /* continue? */
2229 static int resolve_dtype(int dtype
, struct index_state
*istate
,
2230 const char *path
, int len
)
2234 if (dtype
!= DT_UNKNOWN
)
2236 dtype
= get_index_dtype(istate
, path
, len
);
2237 if (dtype
!= DT_UNKNOWN
)
2239 if (lstat(path
, &st
))
2241 if (S_ISREG(st
.st_mode
))
2243 if (S_ISDIR(st
.st_mode
))
2245 if (S_ISLNK(st
.st_mode
))
2250 static enum path_treatment
treat_path_fast(struct dir_struct
*dir
,
2251 struct cached_dir
*cdir
,
2252 struct index_state
*istate
,
2253 struct strbuf
*path
,
2255 const struct pathspec
*pathspec
)
2258 * WARNING: From this function, you can return path_recurse or you
2259 * can call read_directory_recursive() (or neither), but
2260 * you CAN'T DO BOTH.
2262 strbuf_setlen(path
, baselen
);
2264 strbuf_addstr(path
, cdir
->file
);
2265 return path_untracked
;
2267 strbuf_addstr(path
, cdir
->ucd
->name
);
2268 /* treat_one_path() does this before it calls treat_directory() */
2269 strbuf_complete(path
, '/');
2270 if (cdir
->ucd
->check_only
)
2272 * check_only is set as a result of treat_directory() getting
2273 * to its bottom. Verify again the same set of directories
2274 * with check_only set.
2276 return read_directory_recursive(dir
, istate
, path
->buf
, path
->len
,
2277 cdir
->ucd
, 1, 0, pathspec
);
2279 * We get path_recurse in the first run when
2280 * directory_exists_in_index() returns index_nonexistent. We
2281 * are sure that new changes in the index does not impact the
2282 * outcome. Return now.
2284 return path_recurse
;
2287 static enum path_treatment
treat_path(struct dir_struct
*dir
,
2288 struct untracked_cache_dir
*untracked
,
2289 struct cached_dir
*cdir
,
2290 struct index_state
*istate
,
2291 struct strbuf
*path
,
2293 const struct pathspec
*pathspec
)
2295 int has_path_in_index
, dtype
, excluded
;
2298 return treat_path_fast(dir
, cdir
, istate
, path
,
2300 if (is_dot_or_dotdot(cdir
->d_name
) || !fspathcmp(cdir
->d_name
, ".git"))
2302 strbuf_setlen(path
, baselen
);
2303 strbuf_addstr(path
, cdir
->d_name
);
2304 if (simplify_away(path
->buf
, path
->len
, pathspec
))
2307 dtype
= resolve_dtype(cdir
->d_type
, istate
, path
->buf
, path
->len
);
2309 /* Always exclude indexed files */
2310 has_path_in_index
= !!index_file_exists(istate
, path
->buf
, path
->len
,
2312 if (dtype
!= DT_DIR
&& has_path_in_index
)
2316 * When we are looking at a directory P in the working tree,
2317 * there are three cases:
2319 * (1) P exists in the index. Everything inside the directory P in
2320 * the working tree needs to go when P is checked out from the
2323 * (2) P does not exist in the index, but there is P/Q in the index.
2324 * We know P will stay a directory when we check out the contents
2325 * of the index, but we do not know yet if there is a directory
2326 * P/Q in the working tree to be killed, so we need to recurse.
2328 * (3) P does not exist in the index, and there is no P/Q in the index
2329 * to require P to be a directory, either. Only in this case, we
2330 * know that everything inside P will not be killed without
2333 if ((dir
->flags
& DIR_COLLECT_KILLED_ONLY
) &&
2334 (dtype
== DT_DIR
) &&
2335 !has_path_in_index
&&
2336 (directory_exists_in_index(istate
, path
->buf
, path
->len
) == index_nonexistent
))
2339 excluded
= is_excluded(dir
, istate
, path
->buf
, &dtype
);
2342 * Excluded? If we don't explicitly want to show
2343 * ignored files, ignore it
2345 if (excluded
&& !(dir
->flags
& (DIR_SHOW_IGNORED
|DIR_SHOW_IGNORED_TOO
)))
2346 return path_excluded
;
2353 * WARNING: Do not ignore/amend the return value from
2354 * treat_directory(), and especially do not change it to return
2355 * path_recurse as that can cause exponential slowdown.
2356 * Instead, modify treat_directory() to return the right value.
2358 strbuf_addch(path
, '/');
2359 return treat_directory(dir
, istate
, untracked
,
2360 path
->buf
, path
->len
,
2361 baselen
, excluded
, pathspec
);
2365 !match_pathspec(istate
, pathspec
, path
->buf
, path
->len
,
2366 0 /* prefix */, NULL
/* seen */,
2370 return path_excluded
;
2371 return path_untracked
;
2375 static void add_untracked(struct untracked_cache_dir
*dir
, const char *name
)
2379 ALLOC_GROW(dir
->untracked
, dir
->untracked_nr
+ 1,
2380 dir
->untracked_alloc
);
2381 dir
->untracked
[dir
->untracked_nr
++] = xstrdup(name
);
2384 static int valid_cached_dir(struct dir_struct
*dir
,
2385 struct untracked_cache_dir
*untracked
,
2386 struct index_state
*istate
,
2387 struct strbuf
*path
,
2396 * With fsmonitor, we can trust the untracked cache's valid field.
2398 refresh_fsmonitor(istate
);
2399 if (!(dir
->untracked
->use_fsmonitor
&& untracked
->valid
)) {
2400 if (lstat(path
->len
? path
->buf
: ".", &st
)) {
2401 memset(&untracked
->stat_data
, 0, sizeof(untracked
->stat_data
));
2404 if (!untracked
->valid
||
2405 match_stat_data_racy(istate
, &untracked
->stat_data
, &st
)) {
2406 fill_stat_data(&untracked
->stat_data
, &st
);
2411 if (untracked
->check_only
!= !!check_only
)
2415 * prep_exclude will be called eventually on this directory,
2416 * but it's called much later in last_matching_pattern(). We
2417 * need it now to determine the validity of the cache for this
2418 * path. The next calls will be nearly no-op, the way
2419 * prep_exclude() is designed.
2421 if (path
->len
&& path
->buf
[path
->len
- 1] != '/') {
2422 strbuf_addch(path
, '/');
2423 prep_exclude(dir
, istate
, path
->buf
, path
->len
);
2424 strbuf_setlen(path
, path
->len
- 1);
2426 prep_exclude(dir
, istate
, path
->buf
, path
->len
);
2428 /* hopefully prep_exclude() haven't invalidated this entry... */
2429 return untracked
->valid
;
2432 static int open_cached_dir(struct cached_dir
*cdir
,
2433 struct dir_struct
*dir
,
2434 struct untracked_cache_dir
*untracked
,
2435 struct index_state
*istate
,
2436 struct strbuf
*path
,
2441 memset(cdir
, 0, sizeof(*cdir
));
2442 cdir
->untracked
= untracked
;
2443 if (valid_cached_dir(dir
, untracked
, istate
, path
, check_only
))
2445 c_path
= path
->len
? path
->buf
: ".";
2446 cdir
->fdir
= opendir(c_path
);
2448 warning_errno(_("could not open directory '%s'"), c_path
);
2449 if (dir
->untracked
) {
2450 invalidate_directory(dir
->untracked
, untracked
);
2451 dir
->untracked
->dir_opened
++;
2458 static int read_cached_dir(struct cached_dir
*cdir
)
2463 de
= readdir_skip_dot_and_dotdot(cdir
->fdir
);
2465 cdir
->d_name
= NULL
;
2466 cdir
->d_type
= DT_UNKNOWN
;
2469 cdir
->d_name
= de
->d_name
;
2470 cdir
->d_type
= DTYPE(de
);
2473 while (cdir
->nr_dirs
< cdir
->untracked
->dirs_nr
) {
2474 struct untracked_cache_dir
*d
= cdir
->untracked
->dirs
[cdir
->nr_dirs
];
2484 if (cdir
->nr_files
< cdir
->untracked
->untracked_nr
) {
2485 struct untracked_cache_dir
*d
= cdir
->untracked
;
2486 cdir
->file
= d
->untracked
[cdir
->nr_files
++];
2492 static void close_cached_dir(struct cached_dir
*cdir
)
2495 closedir(cdir
->fdir
);
2497 * We have gone through this directory and found no untracked
2498 * entries. Mark it valid.
2500 if (cdir
->untracked
) {
2501 cdir
->untracked
->valid
= 1;
2502 cdir
->untracked
->recurse
= 1;
2506 static void add_path_to_appropriate_result_list(struct dir_struct
*dir
,
2507 struct untracked_cache_dir
*untracked
,
2508 struct cached_dir
*cdir
,
2509 struct index_state
*istate
,
2510 struct strbuf
*path
,
2512 const struct pathspec
*pathspec
,
2513 enum path_treatment state
)
2515 /* add the path to the appropriate result list */
2518 if (dir
->flags
& DIR_SHOW_IGNORED
)
2519 dir_add_name(dir
, istate
, path
->buf
, path
->len
);
2520 else if ((dir
->flags
& DIR_SHOW_IGNORED_TOO
) ||
2521 ((dir
->flags
& DIR_COLLECT_IGNORED
) &&
2522 exclude_matches_pathspec(path
->buf
, path
->len
,
2524 dir_add_ignored(dir
, istate
, path
->buf
, path
->len
);
2527 case path_untracked
:
2528 if (dir
->flags
& DIR_SHOW_IGNORED
)
2530 dir_add_name(dir
, istate
, path
->buf
, path
->len
);
2532 add_untracked(untracked
, path
->buf
+ baselen
);
2541 * Read a directory tree. We currently ignore anything but
2542 * directories, regular files and symlinks. That's because git
2543 * doesn't handle them at all yet. Maybe that will change some
2546 * Also, we ignore the name ".git" (even if it is not a directory).
2547 * That likely will not change.
2549 * If 'stop_at_first_file' is specified, 'path_excluded' is returned
2550 * to signal that a file was found. This is the least significant value that
2551 * indicates that a file was encountered that does not depend on the order of
2552 * whether an untracked or excluded path was encountered first.
2554 * Returns the most significant path_treatment value encountered in the scan.
2555 * If 'stop_at_first_file' is specified, `path_excluded` is the most
2556 * significant path_treatment value that will be returned.
2559 static enum path_treatment
read_directory_recursive(struct dir_struct
*dir
,
2560 struct index_state
*istate
, const char *base
, int baselen
,
2561 struct untracked_cache_dir
*untracked
, int check_only
,
2562 int stop_at_first_file
, const struct pathspec
*pathspec
)
2565 * WARNING: Do NOT recurse unless path_recurse is returned from
2566 * treat_path(). Recursing on any other return value
2567 * can result in exponential slowdown.
2569 struct cached_dir cdir
;
2570 enum path_treatment state
, subdir_state
, dir_state
= path_none
;
2571 struct strbuf path
= STRBUF_INIT
;
2573 strbuf_add(&path
, base
, baselen
);
2575 if (open_cached_dir(&cdir
, dir
, untracked
, istate
, &path
, check_only
))
2577 dir
->internal
.visited_directories
++;
2580 untracked
->check_only
= !!check_only
;
2582 while (!read_cached_dir(&cdir
)) {
2583 /* check how the file or directory should be treated */
2584 state
= treat_path(dir
, untracked
, &cdir
, istate
, &path
,
2586 dir
->internal
.visited_paths
++;
2588 if (state
> dir_state
)
2591 /* recurse into subdir if instructed by treat_path */
2592 if (state
== path_recurse
) {
2593 struct untracked_cache_dir
*ud
;
2594 ud
= lookup_untracked(dir
->untracked
,
2597 path
.len
- baselen
);
2599 read_directory_recursive(dir
, istate
, path
.buf
,
2601 check_only
, stop_at_first_file
, pathspec
);
2602 if (subdir_state
> dir_state
)
2603 dir_state
= subdir_state
;
2606 !match_pathspec(istate
, pathspec
, path
.buf
, path
.len
,
2607 0 /* prefix */, NULL
,
2608 0 /* do NOT special case dirs */))
2613 if (stop_at_first_file
) {
2615 * If stopping at first file, then
2616 * signal that a file was found by
2617 * returning `path_excluded`. This is
2618 * to return a consistent value
2619 * regardless of whether an ignored or
2620 * excluded file happened to be
2623 * In current usage, the
2624 * `stop_at_first_file` is passed when
2625 * an ancestor directory has matched
2626 * an exclude pattern, so any found
2627 * files will be excluded.
2629 if (dir_state
>= path_excluded
) {
2630 dir_state
= path_excluded
;
2635 /* abort early if maximum state has been reached */
2636 if (dir_state
== path_untracked
) {
2638 add_untracked(untracked
, path
.buf
+ baselen
);
2641 /* skip the add_path_to_appropriate_result_list() */
2645 add_path_to_appropriate_result_list(dir
, untracked
, &cdir
,
2646 istate
, &path
, baselen
,
2649 close_cached_dir(&cdir
);
2651 strbuf_release(&path
);
2656 int cmp_dir_entry(const void *p1
, const void *p2
)
2658 const struct dir_entry
*e1
= *(const struct dir_entry
**)p1
;
2659 const struct dir_entry
*e2
= *(const struct dir_entry
**)p2
;
2661 return name_compare(e1
->name
, e1
->len
, e2
->name
, e2
->len
);
2664 /* check if *out lexically strictly contains *in */
2665 int check_dir_entry_contains(const struct dir_entry
*out
, const struct dir_entry
*in
)
2667 return (out
->len
< in
->len
) &&
2668 (out
->name
[out
->len
- 1] == '/') &&
2669 !memcmp(out
->name
, in
->name
, out
->len
);
2672 static int treat_leading_path(struct dir_struct
*dir
,
2673 struct index_state
*istate
,
2674 const char *path
, int len
,
2675 const struct pathspec
*pathspec
)
2677 struct strbuf sb
= STRBUF_INIT
;
2678 struct strbuf subdir
= STRBUF_INIT
;
2679 int prevlen
, baselen
;
2681 struct cached_dir cdir
;
2682 enum path_treatment state
= path_none
;
2685 * For each directory component of path, we are going to check whether
2686 * that path is relevant given the pathspec. For example, if path is
2688 * then we will ask treat_path() whether we should go into foo, then
2689 * whether we should go into bar, then whether baz is relevant.
2690 * Checking each is important because e.g. if path is
2692 * then we need to check .git to know we shouldn't traverse it.
2693 * If the return from treat_path() is:
2694 * * path_none, for any path, we return false.
2695 * * path_recurse, for all path components, we return true
2696 * * <anything else> for some intermediate component, we make sure
2697 * to add that path to the relevant list but return false
2698 * signifying that we shouldn't recurse into it.
2701 while (len
&& path
[len
- 1] == '/')
2706 memset(&cdir
, 0, sizeof(cdir
));
2707 cdir
.d_type
= DT_DIR
;
2711 prevlen
= baselen
+ !!baselen
;
2712 cp
= path
+ prevlen
;
2713 cp
= memchr(cp
, '/', path
+ len
- cp
);
2717 baselen
= cp
- path
;
2719 strbuf_add(&sb
, path
, baselen
);
2720 if (!is_directory(sb
.buf
))
2723 strbuf_add(&sb
, path
, prevlen
);
2724 strbuf_reset(&subdir
);
2725 strbuf_add(&subdir
, path
+prevlen
, baselen
-prevlen
);
2726 cdir
.d_name
= subdir
.buf
;
2727 state
= treat_path(dir
, NULL
, &cdir
, istate
, &sb
, prevlen
, pathspec
);
2729 if (state
!= path_recurse
)
2730 break; /* do not recurse into it */
2732 break; /* finished checking */
2734 add_path_to_appropriate_result_list(dir
, NULL
, &cdir
, istate
,
2735 &sb
, baselen
, pathspec
,
2738 strbuf_release(&subdir
);
2739 strbuf_release(&sb
);
2740 return state
== path_recurse
;
2743 static const char *get_ident_string(void)
2745 static struct strbuf sb
= STRBUF_INIT
;
2750 if (uname(&uts
) < 0)
2751 die_errno(_("failed to get kernel name and information"));
2752 strbuf_addf(&sb
, "Location %s, system %s", get_git_work_tree(),
2757 static int ident_in_untracked(const struct untracked_cache
*uc
)
2760 * Previous git versions may have saved many NUL separated
2761 * strings in the "ident" field, but it is insane to manage
2762 * many locations, so just take care of the first one.
2765 return !strcmp(uc
->ident
.buf
, get_ident_string());
2768 static void set_untracked_ident(struct untracked_cache
*uc
)
2770 strbuf_reset(&uc
->ident
);
2771 strbuf_addstr(&uc
->ident
, get_ident_string());
2774 * This strbuf used to contain a list of NUL separated
2775 * strings, so save NUL too for backward compatibility.
2777 strbuf_addch(&uc
->ident
, 0);
2780 static unsigned new_untracked_cache_flags(struct index_state
*istate
)
2782 struct repository
*repo
= istate
->repo
;
2786 * This logic is coordinated with the setting of these flags in
2787 * wt-status.c#wt_status_collect_untracked(), and the evaluation
2788 * of the config setting in commit.c#git_status_config()
2790 if (!repo_config_get_string(repo
, "status.showuntrackedfiles", &val
) &&
2791 !strcmp(val
, "all"))
2795 * The default, if "all" is not set, is "normal" - leading us here.
2796 * If the value is "none" then it really doesn't matter.
2798 return DIR_SHOW_OTHER_DIRECTORIES
| DIR_HIDE_EMPTY_DIRECTORIES
;
2801 static void new_untracked_cache(struct index_state
*istate
, int flags
)
2803 struct untracked_cache
*uc
= xcalloc(1, sizeof(*uc
));
2804 strbuf_init(&uc
->ident
, 100);
2805 uc
->exclude_per_dir
= ".gitignore";
2806 uc
->dir_flags
= flags
>= 0 ? flags
: new_untracked_cache_flags(istate
);
2807 set_untracked_ident(uc
);
2808 istate
->untracked
= uc
;
2809 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2812 void add_untracked_cache(struct index_state
*istate
)
2814 if (!istate
->untracked
) {
2815 new_untracked_cache(istate
, -1);
2817 if (!ident_in_untracked(istate
->untracked
)) {
2818 free_untracked_cache(istate
->untracked
);
2819 new_untracked_cache(istate
, -1);
2824 void remove_untracked_cache(struct index_state
*istate
)
2826 if (istate
->untracked
) {
2827 free_untracked_cache(istate
->untracked
);
2828 istate
->untracked
= NULL
;
2829 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2833 static struct untracked_cache_dir
*validate_untracked_cache(struct dir_struct
*dir
,
2835 const struct pathspec
*pathspec
,
2836 struct index_state
*istate
)
2838 struct untracked_cache_dir
*root
;
2839 static int untracked_cache_disabled
= -1;
2841 if (!dir
->untracked
)
2843 if (untracked_cache_disabled
< 0)
2844 untracked_cache_disabled
= git_env_bool("GIT_DISABLE_UNTRACKED_CACHE", 0);
2845 if (untracked_cache_disabled
)
2849 * We only support $GIT_DIR/info/exclude and core.excludesfile
2850 * as the global ignore rule files. Any other additions
2851 * (e.g. from command line) invalidate the cache. This
2852 * condition also catches running setup_standard_excludes()
2853 * before setting dir->untracked!
2855 if (dir
->internal
.unmanaged_exclude_files
)
2859 * Optimize for the main use case only: whole-tree git
2860 * status. More work involved in treat_leading_path() if we
2861 * use cache on just a subset of the worktree. pathspec
2862 * support could make the matter even worse.
2864 if (base_len
|| (pathspec
&& pathspec
->nr
))
2867 /* We don't support collecting ignore files */
2868 if (dir
->flags
& (DIR_SHOW_IGNORED
| DIR_SHOW_IGNORED_TOO
|
2869 DIR_COLLECT_IGNORED
))
2873 * If we use .gitignore in the cache and now you change it to
2874 * .gitexclude, everything will go wrong.
2876 if (dir
->exclude_per_dir
!= dir
->untracked
->exclude_per_dir
&&
2877 strcmp(dir
->exclude_per_dir
, dir
->untracked
->exclude_per_dir
))
2881 * EXC_CMDL is not considered in the cache. If people set it,
2884 if (dir
->internal
.exclude_list_group
[EXC_CMDL
].nr
)
2887 if (!ident_in_untracked(dir
->untracked
)) {
2888 warning(_("untracked cache is disabled on this system or location"));
2893 * If the untracked structure we received does not have the same flags
2894 * as requested in this run, we're going to need to either discard the
2895 * existing structure (and potentially later recreate), or bypass the
2896 * untracked cache mechanism for this run.
2898 if (dir
->flags
!= dir
->untracked
->dir_flags
) {
2900 * If the untracked structure we received does not have the same flags
2901 * as configured, then we need to reset / create a new "untracked"
2902 * structure to match the new config.
2904 * Keeping the saved and used untracked cache consistent with the
2905 * configuration provides an opportunity for frequent users of
2906 * "git status -uall" to leverage the untracked cache by aligning their
2907 * configuration - setting "status.showuntrackedfiles" to "all" or
2908 * "normal" as appropriate.
2910 * Previously using -uall (or setting "status.showuntrackedfiles" to
2911 * "all") was incompatible with untracked cache and *consistently*
2912 * caused surprisingly bad performance (with fscache and fsmonitor
2913 * enabled) on Windows.
2915 * IMPROVEMENT OPPORTUNITY: If we reworked the untracked cache storage
2916 * to not be as bound up with the desired output in a given run,
2917 * and instead iterated through and stored enough information to
2918 * correctly serve both "modes", then users could get peak performance
2919 * with or without '-uall' regardless of their
2920 * "status.showuntrackedfiles" config.
2922 if (dir
->untracked
->dir_flags
!= new_untracked_cache_flags(istate
)) {
2923 free_untracked_cache(istate
->untracked
);
2924 new_untracked_cache(istate
, dir
->flags
);
2925 dir
->untracked
= istate
->untracked
;
2929 * Current untracked cache data is consistent with config, but not
2930 * usable in this request/run; just bypass untracked cache.
2936 if (!dir
->untracked
->root
) {
2937 /* Untracked cache existed but is not initialized; fix that */
2938 FLEX_ALLOC_STR(dir
->untracked
->root
, name
, "");
2939 istate
->cache_changed
|= UNTRACKED_CHANGED
;
2942 /* Validate $GIT_DIR/info/exclude and core.excludesfile */
2943 root
= dir
->untracked
->root
;
2944 if (!oideq(&dir
->internal
.ss_info_exclude
.oid
,
2945 &dir
->untracked
->ss_info_exclude
.oid
)) {
2946 invalidate_gitignore(dir
->untracked
, root
);
2947 dir
->untracked
->ss_info_exclude
= dir
->internal
.ss_info_exclude
;
2949 if (!oideq(&dir
->internal
.ss_excludes_file
.oid
,
2950 &dir
->untracked
->ss_excludes_file
.oid
)) {
2951 invalidate_gitignore(dir
->untracked
, root
);
2952 dir
->untracked
->ss_excludes_file
= dir
->internal
.ss_excludes_file
;
2955 /* Make sure this directory is not dropped out at saving phase */
2960 static void emit_traversal_statistics(struct dir_struct
*dir
,
2961 struct repository
*repo
,
2965 if (!trace2_is_enabled())
2969 trace2_data_string("read_directory", repo
, "path", "");
2971 struct strbuf tmp
= STRBUF_INIT
;
2972 strbuf_add(&tmp
, path
, path_len
);
2973 trace2_data_string("read_directory", repo
, "path", tmp
.buf
);
2974 strbuf_release(&tmp
);
2977 trace2_data_intmax("read_directory", repo
,
2978 "directories-visited", dir
->internal
.visited_directories
);
2979 trace2_data_intmax("read_directory", repo
,
2980 "paths-visited", dir
->internal
.visited_paths
);
2982 if (!dir
->untracked
)
2984 trace2_data_intmax("read_directory", repo
,
2985 "node-creation", dir
->untracked
->dir_created
);
2986 trace2_data_intmax("read_directory", repo
,
2987 "gitignore-invalidation",
2988 dir
->untracked
->gitignore_invalidated
);
2989 trace2_data_intmax("read_directory", repo
,
2990 "directory-invalidation",
2991 dir
->untracked
->dir_invalidated
);
2992 trace2_data_intmax("read_directory", repo
,
2993 "opendir", dir
->untracked
->dir_opened
);
2996 int read_directory(struct dir_struct
*dir
, struct index_state
*istate
,
2997 const char *path
, int len
, const struct pathspec
*pathspec
)
2999 struct untracked_cache_dir
*untracked
;
3001 trace2_region_enter("dir", "read_directory", istate
->repo
);
3002 dir
->internal
.visited_paths
= 0;
3003 dir
->internal
.visited_directories
= 0;
3005 if (has_symlink_leading_path(path
, len
)) {
3006 trace2_region_leave("dir", "read_directory", istate
->repo
);
3010 untracked
= validate_untracked_cache(dir
, len
, pathspec
, istate
);
3013 * make sure untracked cache code path is disabled,
3014 * e.g. prep_exclude()
3016 dir
->untracked
= NULL
;
3017 if (!len
|| treat_leading_path(dir
, istate
, path
, len
, pathspec
))
3018 read_directory_recursive(dir
, istate
, path
, len
, untracked
, 0, 0, pathspec
);
3019 QSORT(dir
->entries
, dir
->nr
, cmp_dir_entry
);
3020 QSORT(dir
->ignored
, dir
->ignored_nr
, cmp_dir_entry
);
3022 emit_traversal_statistics(dir
, istate
->repo
, path
, len
);
3024 trace2_region_leave("dir", "read_directory", istate
->repo
);
3025 if (dir
->untracked
) {
3026 static int force_untracked_cache
= -1;
3028 if (force_untracked_cache
< 0)
3029 force_untracked_cache
=
3030 git_env_bool("GIT_FORCE_UNTRACKED_CACHE", -1);
3031 if (force_untracked_cache
< 0)
3032 force_untracked_cache
= (istate
->repo
->settings
.core_untracked_cache
== UNTRACKED_CACHE_WRITE
);
3033 if (force_untracked_cache
&&
3034 dir
->untracked
== istate
->untracked
&&
3035 (dir
->untracked
->dir_opened
||
3036 dir
->untracked
->gitignore_invalidated
||
3037 dir
->untracked
->dir_invalidated
))
3038 istate
->cache_changed
|= UNTRACKED_CHANGED
;
3039 if (dir
->untracked
!= istate
->untracked
) {
3040 FREE_AND_NULL(dir
->untracked
);
3047 int file_exists(const char *f
)
3050 return lstat(f
, &sb
) == 0;
3053 int repo_file_exists(struct repository
*repo
, const char *path
)
3055 if (repo
!= the_repository
)
3056 BUG("do not know how to check file existence in arbitrary repo");
3058 return file_exists(path
);
3061 static int cmp_icase(char a
, char b
)
3066 return toupper(a
) - toupper(b
);
3071 * Given two normalized paths (a trailing slash is ok), if subdir is
3072 * outside dir, return -1. Otherwise return the offset in subdir that
3073 * can be used as relative path to dir.
3075 int dir_inside_of(const char *subdir
, const char *dir
)
3079 assert(dir
&& subdir
&& *dir
&& *subdir
);
3081 while (*dir
&& *subdir
&& !cmp_icase(*dir
, *subdir
)) {
3087 /* hel[p]/me vs hel[l]/yeah */
3088 if (*dir
&& *subdir
)
3092 return !*dir
? offset
: -1; /* same dir */
3094 /* foo/[b]ar vs foo/[] */
3095 if (is_dir_sep(dir
[-1]))
3096 return is_dir_sep(subdir
[-1]) ? offset
: -1;
3098 /* foo[/]bar vs foo[] */
3099 return is_dir_sep(*subdir
) ? offset
+ 1 : -1;
3102 int is_inside_dir(const char *dir
)
3111 rc
= (dir_inside_of(cwd
, dir
) >= 0);
3116 int is_empty_dir(const char *path
)
3118 DIR *dir
= opendir(path
);
3125 e
= readdir_skip_dot_and_dotdot(dir
);
3133 char *git_url_basename(const char *repo
, int is_bundle
, int is_bare
)
3135 const char *end
= repo
+ strlen(repo
), *start
, *ptr
;
3142 start
= strstr(repo
, "://");
3149 * Skip authentication data. The stripping does happen
3150 * greedily, such that we strip up to the last '@' inside
3153 for (ptr
= start
; ptr
< end
&& !is_dir_sep(*ptr
); ptr
++) {
3159 * Strip trailing spaces, slashes and /.git
3161 while (start
< end
&& (is_dir_sep(end
[-1]) || isspace(end
[-1])))
3163 if (end
- start
> 5 && is_dir_sep(end
[-5]) &&
3164 !strncmp(end
- 4, ".git", 4)) {
3166 while (start
< end
&& is_dir_sep(end
[-1]))
3171 * It should not be possible to overflow `ptrdiff_t` by passing in an
3172 * insanely long URL, but GCC does not know that and will complain
3173 * without this check.
3175 if (end
- start
< 0)
3176 die(_("No directory name could be guessed.\n"
3177 "Please specify a directory on the command line"));
3180 * Strip trailing port number if we've got only a
3181 * hostname (that is, there is no dir separator but a
3182 * colon). This check is required such that we do not
3183 * strip URI's like '/foo/bar:2222.git', which should
3184 * result in a dir '2222' being guessed due to backwards
3187 if (memchr(start
, '/', end
- start
) == NULL
3188 && memchr(start
, ':', end
- start
) != NULL
) {
3190 while (start
< ptr
&& isdigit(ptr
[-1]) && ptr
[-1] != ':')
3192 if (start
< ptr
&& ptr
[-1] == ':')
3197 * Find last component. To remain backwards compatible we
3198 * also regard colons as path separators, such that
3199 * cloning a repository 'foo:bar.git' would result in a
3200 * directory 'bar' being guessed.
3203 while (start
< ptr
&& !is_dir_sep(ptr
[-1]) && ptr
[-1] != ':')
3208 * Strip .{bundle,git}.
3211 strip_suffix_mem(start
, &len
, is_bundle
? ".bundle" : ".git");
3213 if (!len
|| (len
== 1 && *start
== '/'))
3214 die(_("No directory name could be guessed.\n"
3215 "Please specify a directory on the command line"));
3218 dir
= xstrfmt("%.*s.git", (int)len
, start
);
3220 dir
= xstrndup(start
, len
);
3222 * Replace sequences of 'control' characters and whitespace
3223 * with one ascii space, remove leading and trailing spaces.
3227 int prev_space
= 1 /* strip leading whitespace */;
3228 for (end
= dir
; *end
; ++end
) {
3230 if ((unsigned char)ch
< '\x20')
3241 if (out
> dir
&& prev_space
)
3247 void strip_dir_trailing_slashes(char *dir
)
3249 char *end
= dir
+ strlen(dir
);
3251 while (dir
< end
- 1 && is_dir_sep(end
[-1]))
3256 static int remove_dir_recurse(struct strbuf
*path
, int flag
, int *kept_up
)
3260 int ret
= 0, original_len
= path
->len
, len
, kept_down
= 0;
3261 int only_empty
= (flag
& REMOVE_DIR_EMPTY_ONLY
);
3262 int keep_toplevel
= (flag
& REMOVE_DIR_KEEP_TOPLEVEL
);
3263 int purge_original_cwd
= (flag
& REMOVE_DIR_PURGE_ORIGINAL_CWD
);
3264 struct object_id submodule_head
;
3266 if ((flag
& REMOVE_DIR_KEEP_NESTED_GIT
) &&
3267 !resolve_gitlink_ref(path
->buf
, "HEAD", &submodule_head
)) {
3268 /* Do not descend and nuke a nested git work tree. */
3274 flag
&= ~REMOVE_DIR_KEEP_TOPLEVEL
;
3275 dir
= opendir(path
->buf
);
3277 if (errno
== ENOENT
)
3278 return keep_toplevel
? -1 : 0;
3279 else if (errno
== EACCES
&& !keep_toplevel
)
3281 * An empty dir could be removable even if it
3284 return rmdir(path
->buf
);
3288 strbuf_complete(path
, '/');
3291 while ((e
= readdir_skip_dot_and_dotdot(dir
)) != NULL
) {
3294 strbuf_setlen(path
, len
);
3295 strbuf_addstr(path
, e
->d_name
);
3296 if (lstat(path
->buf
, &st
)) {
3297 if (errno
== ENOENT
)
3299 * file disappeared, which is what we
3304 } else if (S_ISDIR(st
.st_mode
)) {
3305 if (!remove_dir_recurse(path
, flag
, &kept_down
))
3306 continue; /* happy */
3307 } else if (!only_empty
&&
3308 (!unlink(path
->buf
) || errno
== ENOENT
)) {
3309 continue; /* happy, too */
3312 /* path too long, stat fails, or non-directory still exists */
3318 strbuf_setlen(path
, original_len
);
3319 if (!ret
&& !keep_toplevel
&& !kept_down
) {
3320 if (!purge_original_cwd
&&
3321 startup_info
->original_cwd
&&
3322 !strcmp(startup_info
->original_cwd
, path
->buf
))
3323 ret
= -1; /* Do not remove current working directory */
3325 ret
= (!rmdir(path
->buf
) || errno
== ENOENT
) ? 0 : -1;
3328 * report the uplevel that it is not an error that we
3329 * did not rmdir() our directory.
3335 int remove_dir_recursively(struct strbuf
*path
, int flag
)
3337 return remove_dir_recurse(path
, flag
, NULL
);
3340 static GIT_PATH_FUNC(git_path_info_exclude
, "info/exclude")
3342 void setup_standard_excludes(struct dir_struct
*dir
)
3344 dir
->exclude_per_dir
= ".gitignore";
3346 /* core.excludesfile defaulting to $XDG_CONFIG_HOME/git/ignore */
3348 excludes_file
= xdg_config_home("ignore");
3349 if (excludes_file
&& !access_or_warn(excludes_file
, R_OK
, 0))
3350 add_patterns_from_file_1(dir
, excludes_file
,
3351 dir
->untracked
? &dir
->internal
.ss_excludes_file
: NULL
);
3353 /* per repository user preference */
3354 if (startup_info
->have_repository
) {
3355 const char *path
= git_path_info_exclude();
3356 if (!access_or_warn(path
, R_OK
, 0))
3357 add_patterns_from_file_1(dir
, path
,
3358 dir
->untracked
? &dir
->internal
.ss_info_exclude
: NULL
);
3362 char *get_sparse_checkout_filename(void)
3364 return git_pathdup("info/sparse-checkout");
3367 int get_sparse_checkout_patterns(struct pattern_list
*pl
)
3370 char *sparse_filename
= get_sparse_checkout_filename();
3372 pl
->use_cone_patterns
= core_sparse_checkout_cone
;
3373 res
= add_patterns_from_file_to_list(sparse_filename
, "", 0, pl
, NULL
, 0);
3375 free(sparse_filename
);
3379 int remove_path(const char *name
)
3383 if (unlink(name
) && !is_missing_file_error(errno
))
3386 slash
= strrchr(name
, '/');
3388 char *dirs
= xstrdup(name
);
3389 slash
= dirs
+ (slash
- name
);
3392 if (startup_info
->original_cwd
&&
3393 !strcmp(startup_info
->original_cwd
, dirs
))
3395 } while (rmdir(dirs
) == 0 && (slash
= strrchr(dirs
, '/')));
3402 * Frees memory within dir which was allocated, and resets fields for further
3403 * use. Does not free dir itself.
3405 void dir_clear(struct dir_struct
*dir
)
3408 struct exclude_list_group
*group
;
3409 struct pattern_list
*pl
;
3410 struct exclude_stack
*stk
;
3411 struct dir_struct
new = DIR_INIT
;
3413 for (i
= EXC_CMDL
; i
<= EXC_FILE
; i
++) {
3414 group
= &dir
->internal
.exclude_list_group
[i
];
3415 for (j
= 0; j
< group
->nr
; j
++) {
3418 free((char *)pl
->src
);
3419 clear_pattern_list(pl
);
3424 for (i
= 0; i
< dir
->ignored_nr
; i
++)
3425 free(dir
->ignored
[i
]);
3426 for (i
= 0; i
< dir
->nr
; i
++)
3427 free(dir
->entries
[i
]);
3431 stk
= dir
->internal
.exclude_stack
;
3433 struct exclude_stack
*prev
= stk
->prev
;
3437 strbuf_release(&dir
->internal
.basebuf
);
3439 memcpy(dir
, &new, sizeof(*dir
));
3442 struct ondisk_untracked_cache
{
3443 struct stat_data info_exclude_stat
;
3444 struct stat_data excludes_file_stat
;
3448 #define ouc_offset(x) offsetof(struct ondisk_untracked_cache, x)
3451 int index
; /* number of written untracked_cache_dir */
3452 struct ewah_bitmap
*check_only
; /* from untracked_cache_dir */
3453 struct ewah_bitmap
*valid
; /* from untracked_cache_dir */
3454 struct ewah_bitmap
*sha1_valid
; /* set if exclude_sha1 is not null */
3456 struct strbuf sb_stat
;
3457 struct strbuf sb_sha1
;
3460 static void stat_data_to_disk(struct stat_data
*to
, const struct stat_data
*from
)
3462 to
->sd_ctime
.sec
= htonl(from
->sd_ctime
.sec
);
3463 to
->sd_ctime
.nsec
= htonl(from
->sd_ctime
.nsec
);
3464 to
->sd_mtime
.sec
= htonl(from
->sd_mtime
.sec
);
3465 to
->sd_mtime
.nsec
= htonl(from
->sd_mtime
.nsec
);
3466 to
->sd_dev
= htonl(from
->sd_dev
);
3467 to
->sd_ino
= htonl(from
->sd_ino
);
3468 to
->sd_uid
= htonl(from
->sd_uid
);
3469 to
->sd_gid
= htonl(from
->sd_gid
);
3470 to
->sd_size
= htonl(from
->sd_size
);
3473 static void write_one_dir(struct untracked_cache_dir
*untracked
,
3474 struct write_data
*wd
)
3476 struct stat_data stat_data
;
3477 struct strbuf
*out
= &wd
->out
;
3478 unsigned char intbuf
[16];
3479 unsigned int intlen
, value
;
3480 int i
= wd
->index
++;
3483 * untracked_nr should be reset whenever valid is clear, but
3486 if (!untracked
->valid
) {
3487 untracked
->untracked_nr
= 0;
3488 untracked
->check_only
= 0;
3491 if (untracked
->check_only
)
3492 ewah_set(wd
->check_only
, i
);
3493 if (untracked
->valid
) {
3494 ewah_set(wd
->valid
, i
);
3495 stat_data_to_disk(&stat_data
, &untracked
->stat_data
);
3496 strbuf_add(&wd
->sb_stat
, &stat_data
, sizeof(stat_data
));
3498 if (!is_null_oid(&untracked
->exclude_oid
)) {
3499 ewah_set(wd
->sha1_valid
, i
);
3500 strbuf_add(&wd
->sb_sha1
, untracked
->exclude_oid
.hash
,
3501 the_hash_algo
->rawsz
);
3504 intlen
= encode_varint(untracked
->untracked_nr
, intbuf
);
3505 strbuf_add(out
, intbuf
, intlen
);
3507 /* skip non-recurse directories */
3508 for (i
= 0, value
= 0; i
< untracked
->dirs_nr
; i
++)
3509 if (untracked
->dirs
[i
]->recurse
)
3511 intlen
= encode_varint(value
, intbuf
);
3512 strbuf_add(out
, intbuf
, intlen
);
3514 strbuf_add(out
, untracked
->name
, strlen(untracked
->name
) + 1);
3516 for (i
= 0; i
< untracked
->untracked_nr
; i
++)
3517 strbuf_add(out
, untracked
->untracked
[i
],
3518 strlen(untracked
->untracked
[i
]) + 1);
3520 for (i
= 0; i
< untracked
->dirs_nr
; i
++)
3521 if (untracked
->dirs
[i
]->recurse
)
3522 write_one_dir(untracked
->dirs
[i
], wd
);
3525 void write_untracked_extension(struct strbuf
*out
, struct untracked_cache
*untracked
)
3527 struct ondisk_untracked_cache
*ouc
;
3528 struct write_data wd
;
3529 unsigned char varbuf
[16];
3531 const unsigned hashsz
= the_hash_algo
->rawsz
;
3533 CALLOC_ARRAY(ouc
, 1);
3534 stat_data_to_disk(&ouc
->info_exclude_stat
, &untracked
->ss_info_exclude
.stat
);
3535 stat_data_to_disk(&ouc
->excludes_file_stat
, &untracked
->ss_excludes_file
.stat
);
3536 ouc
->dir_flags
= htonl(untracked
->dir_flags
);
3538 varint_len
= encode_varint(untracked
->ident
.len
, varbuf
);
3539 strbuf_add(out
, varbuf
, varint_len
);
3540 strbuf_addbuf(out
, &untracked
->ident
);
3542 strbuf_add(out
, ouc
, sizeof(*ouc
));
3543 strbuf_add(out
, untracked
->ss_info_exclude
.oid
.hash
, hashsz
);
3544 strbuf_add(out
, untracked
->ss_excludes_file
.oid
.hash
, hashsz
);
3545 strbuf_add(out
, untracked
->exclude_per_dir
, strlen(untracked
->exclude_per_dir
) + 1);
3548 if (!untracked
->root
) {
3549 varint_len
= encode_varint(0, varbuf
);
3550 strbuf_add(out
, varbuf
, varint_len
);
3555 wd
.check_only
= ewah_new();
3556 wd
.valid
= ewah_new();
3557 wd
.sha1_valid
= ewah_new();
3558 strbuf_init(&wd
.out
, 1024);
3559 strbuf_init(&wd
.sb_stat
, 1024);
3560 strbuf_init(&wd
.sb_sha1
, 1024);
3561 write_one_dir(untracked
->root
, &wd
);
3563 varint_len
= encode_varint(wd
.index
, varbuf
);
3564 strbuf_add(out
, varbuf
, varint_len
);
3565 strbuf_addbuf(out
, &wd
.out
);
3566 ewah_serialize_strbuf(wd
.valid
, out
);
3567 ewah_serialize_strbuf(wd
.check_only
, out
);
3568 ewah_serialize_strbuf(wd
.sha1_valid
, out
);
3569 strbuf_addbuf(out
, &wd
.sb_stat
);
3570 strbuf_addbuf(out
, &wd
.sb_sha1
);
3571 strbuf_addch(out
, '\0'); /* safe guard for string lists */
3573 ewah_free(wd
.valid
);
3574 ewah_free(wd
.check_only
);
3575 ewah_free(wd
.sha1_valid
);
3576 strbuf_release(&wd
.out
);
3577 strbuf_release(&wd
.sb_stat
);
3578 strbuf_release(&wd
.sb_sha1
);
3581 static void free_untracked(struct untracked_cache_dir
*ucd
)
3586 for (i
= 0; i
< ucd
->dirs_nr
; i
++)
3587 free_untracked(ucd
->dirs
[i
]);
3588 for (i
= 0; i
< ucd
->untracked_nr
; i
++)
3589 free(ucd
->untracked
[i
]);
3590 free(ucd
->untracked
);
3595 void free_untracked_cache(struct untracked_cache
*uc
)
3600 free(uc
->exclude_per_dir_to_free
);
3601 strbuf_release(&uc
->ident
);
3602 free_untracked(uc
->root
);
3608 struct untracked_cache_dir
**ucd
;
3609 struct ewah_bitmap
*check_only
;
3610 struct ewah_bitmap
*valid
;
3611 struct ewah_bitmap
*sha1_valid
;
3612 const unsigned char *data
;
3613 const unsigned char *end
;
3616 static void stat_data_from_disk(struct stat_data
*to
, const unsigned char *data
)
3618 memcpy(to
, data
, sizeof(*to
));
3619 to
->sd_ctime
.sec
= ntohl(to
->sd_ctime
.sec
);
3620 to
->sd_ctime
.nsec
= ntohl(to
->sd_ctime
.nsec
);
3621 to
->sd_mtime
.sec
= ntohl(to
->sd_mtime
.sec
);
3622 to
->sd_mtime
.nsec
= ntohl(to
->sd_mtime
.nsec
);
3623 to
->sd_dev
= ntohl(to
->sd_dev
);
3624 to
->sd_ino
= ntohl(to
->sd_ino
);
3625 to
->sd_uid
= ntohl(to
->sd_uid
);
3626 to
->sd_gid
= ntohl(to
->sd_gid
);
3627 to
->sd_size
= ntohl(to
->sd_size
);
3630 static int read_one_dir(struct untracked_cache_dir
**untracked_
,
3631 struct read_data
*rd
)
3633 struct untracked_cache_dir ud
, *untracked
;
3634 const unsigned char *data
= rd
->data
, *end
= rd
->end
;
3635 const unsigned char *eos
;
3639 memset(&ud
, 0, sizeof(ud
));
3641 value
= decode_varint(&data
);
3645 ud
.untracked_alloc
= value
;
3646 ud
.untracked_nr
= value
;
3647 if (ud
.untracked_nr
)
3648 ALLOC_ARRAY(ud
.untracked
, ud
.untracked_nr
);
3650 ud
.dirs_alloc
= ud
.dirs_nr
= decode_varint(&data
);
3653 ALLOC_ARRAY(ud
.dirs
, ud
.dirs_nr
);
3655 eos
= memchr(data
, '\0', end
- data
);
3656 if (!eos
|| eos
== end
)
3659 *untracked_
= untracked
= xmalloc(st_add3(sizeof(*untracked
), eos
- data
, 1));
3660 memcpy(untracked
, &ud
, sizeof(ud
));
3661 memcpy(untracked
->name
, data
, eos
- data
+ 1);
3664 for (i
= 0; i
< untracked
->untracked_nr
; i
++) {
3665 eos
= memchr(data
, '\0', end
- data
);
3666 if (!eos
|| eos
== end
)
3668 untracked
->untracked
[i
] = xmemdupz(data
, eos
- data
);
3672 rd
->ucd
[rd
->index
++] = untracked
;
3675 for (i
= 0; i
< untracked
->dirs_nr
; i
++) {
3676 if (read_one_dir(untracked
->dirs
+ i
, rd
) < 0)
3682 static void set_check_only(size_t pos
, void *cb
)
3684 struct read_data
*rd
= cb
;
3685 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3689 static void read_stat(size_t pos
, void *cb
)
3691 struct read_data
*rd
= cb
;
3692 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3693 if (rd
->data
+ sizeof(struct stat_data
) > rd
->end
) {
3694 rd
->data
= rd
->end
+ 1;
3697 stat_data_from_disk(&ud
->stat_data
, rd
->data
);
3698 rd
->data
+= sizeof(struct stat_data
);
3702 static void read_oid(size_t pos
, void *cb
)
3704 struct read_data
*rd
= cb
;
3705 struct untracked_cache_dir
*ud
= rd
->ucd
[pos
];
3706 if (rd
->data
+ the_hash_algo
->rawsz
> rd
->end
) {
3707 rd
->data
= rd
->end
+ 1;
3710 oidread(&ud
->exclude_oid
, rd
->data
);
3711 rd
->data
+= the_hash_algo
->rawsz
;
3714 static void load_oid_stat(struct oid_stat
*oid_stat
, const unsigned char *data
,
3715 const unsigned char *sha1
)
3717 stat_data_from_disk(&oid_stat
->stat
, data
);
3718 oidread(&oid_stat
->oid
, sha1
);
3719 oid_stat
->valid
= 1;
3722 struct untracked_cache
*read_untracked_extension(const void *data
, unsigned long sz
)
3724 struct untracked_cache
*uc
;
3725 struct read_data rd
;
3726 const unsigned char *next
= data
, *end
= (const unsigned char *)data
+ sz
;
3730 const char *exclude_per_dir
;
3731 const unsigned hashsz
= the_hash_algo
->rawsz
;
3732 const unsigned offset
= sizeof(struct ondisk_untracked_cache
);
3733 const unsigned exclude_per_dir_offset
= offset
+ 2 * hashsz
;
3735 if (sz
<= 1 || end
[-1] != '\0')
3739 ident_len
= decode_varint(&next
);
3740 if (next
+ ident_len
> end
)
3742 ident
= (const char *)next
;
3745 if (next
+ exclude_per_dir_offset
+ 1 > end
)
3748 CALLOC_ARRAY(uc
, 1);
3749 strbuf_init(&uc
->ident
, ident_len
);
3750 strbuf_add(&uc
->ident
, ident
, ident_len
);
3751 load_oid_stat(&uc
->ss_info_exclude
,
3752 next
+ ouc_offset(info_exclude_stat
),
3754 load_oid_stat(&uc
->ss_excludes_file
,
3755 next
+ ouc_offset(excludes_file_stat
),
3756 next
+ offset
+ hashsz
);
3757 uc
->dir_flags
= get_be32(next
+ ouc_offset(dir_flags
));
3758 exclude_per_dir
= (const char *)next
+ exclude_per_dir_offset
;
3759 uc
->exclude_per_dir
= uc
->exclude_per_dir_to_free
= xstrdup(exclude_per_dir
);
3760 /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
3761 next
+= exclude_per_dir_offset
+ strlen(exclude_per_dir
) + 1;
3765 len
= decode_varint(&next
);
3766 if (next
> end
|| len
== 0)
3769 rd
.valid
= ewah_new();
3770 rd
.check_only
= ewah_new();
3771 rd
.sha1_valid
= ewah_new();
3775 ALLOC_ARRAY(rd
.ucd
, len
);
3777 if (read_one_dir(&uc
->root
, &rd
) || rd
.index
!= len
)
3781 len
= ewah_read_mmap(rd
.valid
, next
, end
- next
);
3786 len
= ewah_read_mmap(rd
.check_only
, next
, end
- next
);
3791 len
= ewah_read_mmap(rd
.sha1_valid
, next
, end
- next
);
3795 ewah_each_bit(rd
.check_only
, set_check_only
, &rd
);
3796 rd
.data
= next
+ len
;
3797 ewah_each_bit(rd
.valid
, read_stat
, &rd
);
3798 ewah_each_bit(rd
.sha1_valid
, read_oid
, &rd
);
3803 ewah_free(rd
.valid
);
3804 ewah_free(rd
.check_only
);
3805 ewah_free(rd
.sha1_valid
);
3808 free_untracked_cache(uc
);
3814 static void invalidate_one_directory(struct untracked_cache
*uc
,
3815 struct untracked_cache_dir
*ucd
)
3817 uc
->dir_invalidated
++;
3819 ucd
->untracked_nr
= 0;
3823 * Normally when an entry is added or removed from a directory,
3824 * invalidating that directory is enough. No need to touch its
3825 * ancestors. When a directory is shown as "foo/bar/" in git-status
3826 * however, deleting or adding an entry may have cascading effect.
3828 * Say the "foo/bar/file" has become untracked, we need to tell the
3829 * untracked_cache_dir of "foo" that "bar/" is not an untracked
3830 * directory any more (because "bar" is managed by foo as an untracked
3833 * Similarly, if "foo/bar/file" moves from untracked to tracked and it
3834 * was the last untracked entry in the entire "foo", we should show
3835 * "foo/" instead. Which means we have to invalidate past "bar" up to
3838 * This function traverses all directories from root to leaf. If there
3839 * is a chance of one of the above cases happening, we invalidate back
3840 * to root. Otherwise we just invalidate the leaf. There may be a more
3841 * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
3842 * detect these cases and avoid unnecessary invalidation, for example,
3843 * checking for the untracked entry named "bar/" in "foo", but for now
3844 * stick to something safe and simple.
3846 static int invalidate_one_component(struct untracked_cache
*uc
,
3847 struct untracked_cache_dir
*dir
,
3848 const char *path
, int len
)
3850 const char *rest
= strchr(path
, '/');
3853 int component_len
= rest
- path
;
3854 struct untracked_cache_dir
*d
=
3855 lookup_untracked(uc
, dir
, path
, component_len
);
3857 invalidate_one_component(uc
, d
, rest
+ 1,
3858 len
- (component_len
+ 1));
3860 invalidate_one_directory(uc
, dir
);
3864 invalidate_one_directory(uc
, dir
);
3865 return uc
->dir_flags
& DIR_SHOW_OTHER_DIRECTORIES
;
3868 void untracked_cache_invalidate_path(struct index_state
*istate
,
3869 const char *path
, int safe_path
)
3871 if (!istate
->untracked
|| !istate
->untracked
->root
)
3873 if (!safe_path
&& !verify_path(path
, 0))
3875 invalidate_one_component(istate
->untracked
, istate
->untracked
->root
,
3876 path
, strlen(path
));
3879 void untracked_cache_remove_from_index(struct index_state
*istate
,
3882 untracked_cache_invalidate_path(istate
, path
, 1);
3885 void untracked_cache_add_to_index(struct index_state
*istate
,
3888 untracked_cache_invalidate_path(istate
, path
, 1);
3891 static void connect_wt_gitdir_in_nested(const char *sub_worktree
,
3892 const char *sub_gitdir
)
3895 struct repository subrepo
;
3896 struct strbuf sub_wt
= STRBUF_INIT
;
3897 struct strbuf sub_gd
= STRBUF_INIT
;
3899 const struct submodule
*sub
;
3901 /* If the submodule has no working tree, we can ignore it. */
3902 if (repo_init(&subrepo
, sub_gitdir
, sub_worktree
))
3905 if (repo_read_index(&subrepo
) < 0)
3906 die(_("index file corrupt in repo %s"), subrepo
.gitdir
);
3908 /* TODO: audit for interaction with sparse-index. */
3909 ensure_full_index(subrepo
.index
);
3910 for (i
= 0; i
< subrepo
.index
->cache_nr
; i
++) {
3911 const struct cache_entry
*ce
= subrepo
.index
->cache
[i
];
3913 if (!S_ISGITLINK(ce
->ce_mode
))
3916 while (i
+ 1 < subrepo
.index
->cache_nr
&&
3917 !strcmp(ce
->name
, subrepo
.index
->cache
[i
+ 1]->name
))
3919 * Skip entries with the same name in different stages
3920 * to make sure an entry is returned only once.
3924 sub
= submodule_from_path(&subrepo
, null_oid(), ce
->name
);
3925 if (!sub
|| !is_submodule_active(&subrepo
, ce
->name
))
3926 /* .gitmodules broken or inactive sub */
3929 strbuf_reset(&sub_wt
);
3930 strbuf_reset(&sub_gd
);
3931 strbuf_addf(&sub_wt
, "%s/%s", sub_worktree
, sub
->path
);
3932 submodule_name_to_gitdir(&sub_gd
, &subrepo
, sub
->name
);
3934 connect_work_tree_and_git_dir(sub_wt
.buf
, sub_gd
.buf
, 1);
3936 strbuf_release(&sub_wt
);
3937 strbuf_release(&sub_gd
);
3938 repo_clear(&subrepo
);
3941 void connect_work_tree_and_git_dir(const char *work_tree_
,
3942 const char *git_dir_
,
3943 int recurse_into_nested
)
3945 struct strbuf gitfile_sb
= STRBUF_INIT
;
3946 struct strbuf cfg_sb
= STRBUF_INIT
;
3947 struct strbuf rel_path
= STRBUF_INIT
;
3948 char *git_dir
, *work_tree
;
3950 /* Prepare .git file */
3951 strbuf_addf(&gitfile_sb
, "%s/.git", work_tree_
);
3952 if (safe_create_leading_directories_const(gitfile_sb
.buf
))
3953 die(_("could not create directories for %s"), gitfile_sb
.buf
);
3955 /* Prepare config file */
3956 strbuf_addf(&cfg_sb
, "%s/config", git_dir_
);
3957 if (safe_create_leading_directories_const(cfg_sb
.buf
))
3958 die(_("could not create directories for %s"), cfg_sb
.buf
);
3960 git_dir
= real_pathdup(git_dir_
, 1);
3961 work_tree
= real_pathdup(work_tree_
, 1);
3963 /* Write .git file */
3964 write_file(gitfile_sb
.buf
, "gitdir: %s",
3965 relative_path(git_dir
, work_tree
, &rel_path
));
3966 /* Update core.worktree setting */
3967 git_config_set_in_file(cfg_sb
.buf
, "core.worktree",
3968 relative_path(work_tree
, git_dir
, &rel_path
));
3970 strbuf_release(&gitfile_sb
);
3971 strbuf_release(&cfg_sb
);
3972 strbuf_release(&rel_path
);
3974 if (recurse_into_nested
)
3975 connect_wt_gitdir_in_nested(work_tree
, git_dir
);
3982 * Migrate the git directory of the given path from old_git_dir to new_git_dir.
3984 void relocate_gitdir(const char *path
, const char *old_git_dir
, const char *new_git_dir
)
3986 if (rename(old_git_dir
, new_git_dir
) < 0)
3987 die_errno(_("could not migrate git directory from '%s' to '%s'"),
3988 old_git_dir
, new_git_dir
);
3990 connect_work_tree_and_git_dir(path
, new_git_dir
, 0);
3993 int path_match_flags(const char *const str
, const enum path_match_flags flags
)
3995 const char *p
= str
;
3997 if (flags
& PATH_MATCH_NATIVE
&&
3998 flags
& PATH_MATCH_XPLATFORM
)
3999 BUG("path_match_flags() must get one match kind, not multiple!");
4000 else if (!(flags
& PATH_MATCH_KINDS_MASK
))
4001 BUG("path_match_flags() must get at least one match kind!");
4003 if (flags
& PATH_MATCH_STARTS_WITH_DOT_SLASH
&&
4004 flags
& PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH
)
4005 BUG("path_match_flags() must get one platform kind, not multiple!");
4006 else if (!(flags
& PATH_MATCH_PLATFORM_MASK
))
4007 BUG("path_match_flags() must get at least one platform kind!");
4011 if (flags
& PATH_MATCH_STARTS_WITH_DOT_DOT_SLASH
&&
4015 if (flags
& PATH_MATCH_NATIVE
)
4016 return is_dir_sep(*p
);
4017 else if (flags
& PATH_MATCH_XPLATFORM
)
4018 return is_xplatform_dir_sep(*p
);