Merge branch 'ra/rev-parse-exclude-glob'
[git] / dir.c
1 /*
2  * This handles recursive filename detection with exclude
3  * files, index knowledge etc..
4  *
5  * See Documentation/technical/api-directory-listing.txt
6  *
7  * Copyright (C) Linus Torvalds, 2005-2006
8  *               Junio Hamano, 2005-2006
9  */
10 #define NO_THE_INDEX_COMPATIBILITY_MACROS
11 #include "cache.h"
12 #include "config.h"
13 #include "dir.h"
14 #include "object-store.h"
15 #include "attr.h"
16 #include "refs.h"
17 #include "wildmatch.h"
18 #include "pathspec.h"
19 #include "utf8.h"
20 #include "varint.h"
21 #include "ewah/ewok.h"
22 #include "fsmonitor.h"
23 #include "submodule-config.h"
24
25 /*
26  * Tells read_directory_recursive how a file or directory should be treated.
27  * Values are ordered by significance, e.g. if a directory contains both
28  * excluded and untracked files, it is listed as untracked because
29  * path_untracked > path_excluded.
30  */
31 enum path_treatment {
32         path_none = 0,
33         path_recurse,
34         path_excluded,
35         path_untracked
36 };
37
38 /*
39  * Support data structure for our opendir/readdir/closedir wrappers
40  */
41 struct cached_dir {
42         DIR *fdir;
43         struct untracked_cache_dir *untracked;
44         int nr_files;
45         int nr_dirs;
46
47         struct dirent *de;
48         const char *file;
49         struct untracked_cache_dir *ucd;
50 };
51
52 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
53         struct index_state *istate, const char *path, int len,
54         struct untracked_cache_dir *untracked,
55         int check_only, int stop_at_first_file, const struct pathspec *pathspec);
56 static int get_dtype(struct dirent *de, struct index_state *istate,
57                      const char *path, int len);
58
59 int count_slashes(const char *s)
60 {
61         int cnt = 0;
62         while (*s)
63                 if (*s++ == '/')
64                         cnt++;
65         return cnt;
66 }
67
68 int fspathcmp(const char *a, const char *b)
69 {
70         return ignore_case ? strcasecmp(a, b) : strcmp(a, b);
71 }
72
73 int fspathncmp(const char *a, const char *b, size_t count)
74 {
75         return ignore_case ? strncasecmp(a, b, count) : strncmp(a, b, count);
76 }
77
78 int git_fnmatch(const struct pathspec_item *item,
79                 const char *pattern, const char *string,
80                 int prefix)
81 {
82         if (prefix > 0) {
83                 if (ps_strncmp(item, pattern, string, prefix))
84                         return WM_NOMATCH;
85                 pattern += prefix;
86                 string += prefix;
87         }
88         if (item->flags & PATHSPEC_ONESTAR) {
89                 int pattern_len = strlen(++pattern);
90                 int string_len = strlen(string);
91                 return string_len < pattern_len ||
92                         ps_strcmp(item, pattern,
93                                   string + string_len - pattern_len);
94         }
95         if (item->magic & PATHSPEC_GLOB)
96                 return wildmatch(pattern, string,
97                                  WM_PATHNAME |
98                                  (item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0));
99         else
100                 /* wildmatch has not learned no FNM_PATHNAME mode yet */
101                 return wildmatch(pattern, string,
102                                  item->magic & PATHSPEC_ICASE ? WM_CASEFOLD : 0);
103 }
104
105 static int fnmatch_icase_mem(const char *pattern, int patternlen,
106                              const char *string, int stringlen,
107                              int flags)
108 {
109         int match_status;
110         struct strbuf pat_buf = STRBUF_INIT;
111         struct strbuf str_buf = STRBUF_INIT;
112         const char *use_pat = pattern;
113         const char *use_str = string;
114
115         if (pattern[patternlen]) {
116                 strbuf_add(&pat_buf, pattern, patternlen);
117                 use_pat = pat_buf.buf;
118         }
119         if (string[stringlen]) {
120                 strbuf_add(&str_buf, string, stringlen);
121                 use_str = str_buf.buf;
122         }
123
124         if (ignore_case)
125                 flags |= WM_CASEFOLD;
126         match_status = wildmatch(use_pat, use_str, flags);
127
128         strbuf_release(&pat_buf);
129         strbuf_release(&str_buf);
130
131         return match_status;
132 }
133
134 static size_t common_prefix_len(const struct pathspec *pathspec)
135 {
136         int n;
137         size_t max = 0;
138
139         /*
140          * ":(icase)path" is treated as a pathspec full of
141          * wildcard. In other words, only prefix is considered common
142          * prefix. If the pathspec is abc/foo abc/bar, running in
143          * subdir xyz, the common prefix is still xyz, not xuz/abc as
144          * in non-:(icase).
145          */
146         GUARD_PATHSPEC(pathspec,
147                        PATHSPEC_FROMTOP |
148                        PATHSPEC_MAXDEPTH |
149                        PATHSPEC_LITERAL |
150                        PATHSPEC_GLOB |
151                        PATHSPEC_ICASE |
152                        PATHSPEC_EXCLUDE |
153                        PATHSPEC_ATTR);
154
155         for (n = 0; n < pathspec->nr; n++) {
156                 size_t i = 0, len = 0, item_len;
157                 if (pathspec->items[n].magic & PATHSPEC_EXCLUDE)
158                         continue;
159                 if (pathspec->items[n].magic & PATHSPEC_ICASE)
160                         item_len = pathspec->items[n].prefix;
161                 else
162                         item_len = pathspec->items[n].nowildcard_len;
163                 while (i < item_len && (n == 0 || i < max)) {
164                         char c = pathspec->items[n].match[i];
165                         if (c != pathspec->items[0].match[i])
166                                 break;
167                         if (c == '/')
168                                 len = i + 1;
169                         i++;
170                 }
171                 if (n == 0 || len < max) {
172                         max = len;
173                         if (!max)
174                                 break;
175                 }
176         }
177         return max;
178 }
179
180 /*
181  * Returns a copy of the longest leading path common among all
182  * pathspecs.
183  */
184 char *common_prefix(const struct pathspec *pathspec)
185 {
186         unsigned long len = common_prefix_len(pathspec);
187
188         return len ? xmemdupz(pathspec->items[0].match, len) : NULL;
189 }
190
191 int fill_directory(struct dir_struct *dir,
192                    struct index_state *istate,
193                    const struct pathspec *pathspec)
194 {
195         const char *prefix;
196         size_t prefix_len;
197
198         /*
199          * Calculate common prefix for the pathspec, and
200          * use that to optimize the directory walk
201          */
202         prefix_len = common_prefix_len(pathspec);
203         prefix = prefix_len ? pathspec->items[0].match : "";
204
205         /* Read the directory and prune it */
206         read_directory(dir, istate, prefix, prefix_len, pathspec);
207
208         return prefix_len;
209 }
210
211 int within_depth(const char *name, int namelen,
212                         int depth, int max_depth)
213 {
214         const char *cp = name, *cpe = name + namelen;
215
216         while (cp < cpe) {
217                 if (*cp++ != '/')
218                         continue;
219                 depth++;
220                 if (depth > max_depth)
221                         return 0;
222         }
223         return 1;
224 }
225
226 /*
227  * Read the contents of the blob with the given OID into a buffer.
228  * Append a trailing LF to the end if the last line doesn't have one.
229  *
230  * Returns:
231  *    -1 when the OID is invalid or unknown or does not refer to a blob.
232  *     0 when the blob is empty.
233  *     1 along with { data, size } of the (possibly augmented) buffer
234  *       when successful.
235  *
236  * Optionally updates the given oid_stat with the given OID (when valid).
237  */
238 static int do_read_blob(const struct object_id *oid, struct oid_stat *oid_stat,
239                         size_t *size_out, char **data_out)
240 {
241         enum object_type type;
242         unsigned long sz;
243         char *data;
244
245         *size_out = 0;
246         *data_out = NULL;
247
248         data = read_object_file(oid, &type, &sz);
249         if (!data || type != OBJ_BLOB) {
250                 free(data);
251                 return -1;
252         }
253
254         if (oid_stat) {
255                 memset(&oid_stat->stat, 0, sizeof(oid_stat->stat));
256                 oidcpy(&oid_stat->oid, oid);
257         }
258
259         if (sz == 0) {
260                 free(data);
261                 return 0;
262         }
263
264         if (data[sz - 1] != '\n') {
265                 data = xrealloc(data, st_add(sz, 1));
266                 data[sz++] = '\n';
267         }
268
269         *size_out = xsize_t(sz);
270         *data_out = data;
271
272         return 1;
273 }
274
275 #define DO_MATCH_EXCLUDE   (1<<0)
276 #define DO_MATCH_DIRECTORY (1<<1)
277 #define DO_MATCH_SUBMODULE (1<<2)
278
279 static int match_attrs(const struct index_state *istate,
280                        const char *name, int namelen,
281                        const struct pathspec_item *item)
282 {
283         int i;
284         char *to_free = NULL;
285
286         if (name[namelen])
287                 name = to_free = xmemdupz(name, namelen);
288
289         git_check_attr(istate, name, item->attr_check);
290
291         free(to_free);
292
293         for (i = 0; i < item->attr_match_nr; i++) {
294                 const char *value;
295                 int matched;
296                 enum attr_match_mode match_mode;
297
298                 value = item->attr_check->items[i].value;
299                 match_mode = item->attr_match[i].match_mode;
300
301                 if (ATTR_TRUE(value))
302                         matched = (match_mode == MATCH_SET);
303                 else if (ATTR_FALSE(value))
304                         matched = (match_mode == MATCH_UNSET);
305                 else if (ATTR_UNSET(value))
306                         matched = (match_mode == MATCH_UNSPECIFIED);
307                 else
308                         matched = (match_mode == MATCH_VALUE &&
309                                    !strcmp(item->attr_match[i].value, value));
310                 if (!matched)
311                         return 0;
312         }
313
314         return 1;
315 }
316
317 /*
318  * Does 'match' match the given name?
319  * A match is found if
320  *
321  * (1) the 'match' string is leading directory of 'name', or
322  * (2) the 'match' string is a wildcard and matches 'name', or
323  * (3) the 'match' string is exactly the same as 'name'.
324  *
325  * and the return value tells which case it was.
326  *
327  * It returns 0 when there is no match.
328  */
329 static int match_pathspec_item(const struct index_state *istate,
330                                const struct pathspec_item *item, int prefix,
331                                const char *name, int namelen, unsigned flags)
332 {
333         /* name/namelen has prefix cut off by caller */
334         const char *match = item->match + prefix;
335         int matchlen = item->len - prefix;
336
337         /*
338          * The normal call pattern is:
339          * 1. prefix = common_prefix_len(ps);
340          * 2. prune something, or fill_directory
341          * 3. match_pathspec()
342          *
343          * 'prefix' at #1 may be shorter than the command's prefix and
344          * it's ok for #2 to match extra files. Those extras will be
345          * trimmed at #3.
346          *
347          * Suppose the pathspec is 'foo' and '../bar' running from
348          * subdir 'xyz'. The common prefix at #1 will be empty, thanks
349          * to "../". We may have xyz/foo _and_ XYZ/foo after #2. The
350          * user does not want XYZ/foo, only the "foo" part should be
351          * case-insensitive. We need to filter out XYZ/foo here. In
352          * other words, we do not trust the caller on comparing the
353          * prefix part when :(icase) is involved. We do exact
354          * comparison ourselves.
355          *
356          * Normally the caller (common_prefix_len() in fact) does
357          * _exact_ matching on name[-prefix+1..-1] and we do not need
358          * to check that part. Be defensive and check it anyway, in
359          * case common_prefix_len is changed, or a new caller is
360          * introduced that does not use common_prefix_len.
361          *
362          * If the penalty turns out too high when prefix is really
363          * long, maybe change it to
364          * strncmp(match, name, item->prefix - prefix)
365          */
366         if (item->prefix && (item->magic & PATHSPEC_ICASE) &&
367             strncmp(item->match, name - prefix, item->prefix))
368                 return 0;
369
370         if (item->attr_match_nr && !match_attrs(istate, name, namelen, item))
371                 return 0;
372
373         /* If the match was just the prefix, we matched */
374         if (!*match)
375                 return MATCHED_RECURSIVELY;
376
377         if (matchlen <= namelen && !ps_strncmp(item, match, name, matchlen)) {
378                 if (matchlen == namelen)
379                         return MATCHED_EXACTLY;
380
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;
388
389         if (item->nowildcard_len < item->len &&
390             !git_fnmatch(item, match, name,
391                          item->nowildcard_len - prefix))
392                 return MATCHED_FNMATCH;
393
394         /* Perform checks to see if "name" is a super set of the pathspec */
395         if (flags & DO_MATCH_SUBMODULE) {
396                 /* name is a literal prefix of the pathspec */
397                 if ((namelen < matchlen) &&
398                     (match[namelen] == '/') &&
399                     !ps_strncmp(item, match, name, namelen))
400                         return MATCHED_RECURSIVELY;
401
402                 /* name" doesn't match up to the first wild character */
403                 if (item->nowildcard_len < item->len &&
404                     ps_strncmp(item, match, name,
405                                item->nowildcard_len - prefix))
406                         return 0;
407
408                 /*
409                  * Here is where we would perform a wildmatch to check if
410                  * "name" can be matched as a directory (or a prefix) against
411                  * the pathspec.  Since wildmatch doesn't have this capability
412                  * at the present we have to punt and say that it is a match,
413                  * potentially returning a false positive
414                  * The submodules themselves will be able to perform more
415                  * accurate matching to determine if the pathspec matches.
416                  */
417                 return MATCHED_RECURSIVELY;
418         }
419
420         return 0;
421 }
422
423 /*
424  * Given a name and a list of pathspecs, returns the nature of the
425  * closest (i.e. most specific) match of the name to any of the
426  * pathspecs.
427  *
428  * The caller typically calls this multiple times with the same
429  * pathspec and seen[] array but with different name/namelen
430  * (e.g. entries from the index) and is interested in seeing if and
431  * how each pathspec matches all the names it calls this function
432  * with.  A mark is left in the seen[] array for each pathspec element
433  * indicating the closest type of match that element achieved, so if
434  * seen[n] remains zero after multiple invocations, that means the nth
435  * pathspec did not match any names, which could indicate that the
436  * user mistyped the nth pathspec.
437  */
438 static int do_match_pathspec(const struct index_state *istate,
439                              const struct pathspec *ps,
440                              const char *name, int namelen,
441                              int prefix, char *seen,
442                              unsigned flags)
443 {
444         int i, retval = 0, exclude = flags & DO_MATCH_EXCLUDE;
445
446         GUARD_PATHSPEC(ps,
447                        PATHSPEC_FROMTOP |
448                        PATHSPEC_MAXDEPTH |
449                        PATHSPEC_LITERAL |
450                        PATHSPEC_GLOB |
451                        PATHSPEC_ICASE |
452                        PATHSPEC_EXCLUDE |
453                        PATHSPEC_ATTR);
454
455         if (!ps->nr) {
456                 if (!ps->recursive ||
457                     !(ps->magic & PATHSPEC_MAXDEPTH) ||
458                     ps->max_depth == -1)
459                         return MATCHED_RECURSIVELY;
460
461                 if (within_depth(name, namelen, 0, ps->max_depth))
462                         return MATCHED_EXACTLY;
463                 else
464                         return 0;
465         }
466
467         name += prefix;
468         namelen -= prefix;
469
470         for (i = ps->nr - 1; i >= 0; i--) {
471                 int how;
472
473                 if ((!exclude &&   ps->items[i].magic & PATHSPEC_EXCLUDE) ||
474                     ( exclude && !(ps->items[i].magic & PATHSPEC_EXCLUDE)))
475                         continue;
476
477                 if (seen && seen[i] == MATCHED_EXACTLY)
478                         continue;
479                 /*
480                  * Make exclude patterns optional and never report
481                  * "pathspec ':(exclude)foo' matches no files"
482                  */
483                 if (seen && ps->items[i].magic & PATHSPEC_EXCLUDE)
484                         seen[i] = MATCHED_FNMATCH;
485                 how = match_pathspec_item(istate, ps->items+i, prefix, name,
486                                           namelen, flags);
487                 if (ps->recursive &&
488                     (ps->magic & PATHSPEC_MAXDEPTH) &&
489                     ps->max_depth != -1 &&
490                     how && how != MATCHED_FNMATCH) {
491                         int len = ps->items[i].len;
492                         if (name[len] == '/')
493                                 len++;
494                         if (within_depth(name+len, namelen-len, 0, ps->max_depth))
495                                 how = MATCHED_EXACTLY;
496                         else
497                                 how = 0;
498                 }
499                 if (how) {
500                         if (retval < how)
501                                 retval = how;
502                         if (seen && seen[i] < how)
503                                 seen[i] = how;
504                 }
505         }
506         return retval;
507 }
508
509 int match_pathspec(const struct index_state *istate,
510                    const struct pathspec *ps,
511                    const char *name, int namelen,
512                    int prefix, char *seen, int is_dir)
513 {
514         int positive, negative;
515         unsigned flags = is_dir ? DO_MATCH_DIRECTORY : 0;
516         positive = do_match_pathspec(istate, ps, name, namelen,
517                                      prefix, seen, flags);
518         if (!(ps->magic & PATHSPEC_EXCLUDE) || !positive)
519                 return positive;
520         negative = do_match_pathspec(istate, ps, name, namelen,
521                                      prefix, seen,
522                                      flags | DO_MATCH_EXCLUDE);
523         return negative ? 0 : positive;
524 }
525
526 /**
527  * Check if a submodule is a superset of the pathspec
528  */
529 int submodule_path_match(const struct index_state *istate,
530                          const struct pathspec *ps,
531                          const char *submodule_name,
532                          char *seen)
533 {
534         int matched = do_match_pathspec(istate, ps, submodule_name,
535                                         strlen(submodule_name),
536                                         0, seen,
537                                         DO_MATCH_DIRECTORY |
538                                         DO_MATCH_SUBMODULE);
539         return matched;
540 }
541
542 int report_path_error(const char *ps_matched,
543                       const struct pathspec *pathspec,
544                       const char *prefix)
545 {
546         /*
547          * Make sure all pathspec matched; otherwise it is an error.
548          */
549         int num, errors = 0;
550         for (num = 0; num < pathspec->nr; num++) {
551                 int other, found_dup;
552
553                 if (ps_matched[num])
554                         continue;
555                 /*
556                  * The caller might have fed identical pathspec
557                  * twice.  Do not barf on such a mistake.
558                  * FIXME: parse_pathspec should have eliminated
559                  * duplicate pathspec.
560                  */
561                 for (found_dup = other = 0;
562                      !found_dup && other < pathspec->nr;
563                      other++) {
564                         if (other == num || !ps_matched[other])
565                                 continue;
566                         if (!strcmp(pathspec->items[other].original,
567                                     pathspec->items[num].original))
568                                 /*
569                                  * Ok, we have a match already.
570                                  */
571                                 found_dup = 1;
572                 }
573                 if (found_dup)
574                         continue;
575
576                 error(_("pathspec '%s' did not match any file(s) known to git"),
577                       pathspec->items[num].original);
578                 errors++;
579         }
580         return errors;
581 }
582
583 /*
584  * Return the length of the "simple" part of a path match limiter.
585  */
586 int simple_length(const char *match)
587 {
588         int len = -1;
589
590         for (;;) {
591                 unsigned char c = *match++;
592                 len++;
593                 if (c == '\0' || is_glob_special(c))
594                         return len;
595         }
596 }
597
598 int no_wildcard(const char *string)
599 {
600         return string[simple_length(string)] == '\0';
601 }
602
603 void parse_exclude_pattern(const char **pattern,
604                            int *patternlen,
605                            unsigned *flags,
606                            int *nowildcardlen)
607 {
608         const char *p = *pattern;
609         size_t i, len;
610
611         *flags = 0;
612         if (*p == '!') {
613                 *flags |= EXC_FLAG_NEGATIVE;
614                 p++;
615         }
616         len = strlen(p);
617         if (len && p[len - 1] == '/') {
618                 len--;
619                 *flags |= EXC_FLAG_MUSTBEDIR;
620         }
621         for (i = 0; i < len; i++) {
622                 if (p[i] == '/')
623                         break;
624         }
625         if (i == len)
626                 *flags |= EXC_FLAG_NODIR;
627         *nowildcardlen = simple_length(p);
628         /*
629          * we should have excluded the trailing slash from 'p' too,
630          * but that's one more allocation. Instead just make sure
631          * nowildcardlen does not exceed real patternlen
632          */
633         if (*nowildcardlen > len)
634                 *nowildcardlen = len;
635         if (*p == '*' && no_wildcard(p + 1))
636                 *flags |= EXC_FLAG_ENDSWITH;
637         *pattern = p;
638         *patternlen = len;
639 }
640
641 void add_exclude(const char *string, const char *base,
642                  int baselen, struct exclude_list *el, int srcpos)
643 {
644         struct exclude *x;
645         int patternlen;
646         unsigned flags;
647         int nowildcardlen;
648
649         parse_exclude_pattern(&string, &patternlen, &flags, &nowildcardlen);
650         if (flags & EXC_FLAG_MUSTBEDIR) {
651                 FLEXPTR_ALLOC_MEM(x, pattern, string, patternlen);
652         } else {
653                 x = xmalloc(sizeof(*x));
654                 x->pattern = string;
655         }
656         x->patternlen = patternlen;
657         x->nowildcardlen = nowildcardlen;
658         x->base = base;
659         x->baselen = baselen;
660         x->flags = flags;
661         x->srcpos = srcpos;
662         ALLOC_GROW(el->excludes, el->nr + 1, el->alloc);
663         el->excludes[el->nr++] = x;
664         x->el = el;
665 }
666
667 static int read_skip_worktree_file_from_index(const struct index_state *istate,
668                                               const char *path,
669                                               size_t *size_out, char **data_out,
670                                               struct oid_stat *oid_stat)
671 {
672         int pos, len;
673
674         len = strlen(path);
675         pos = index_name_pos(istate, path, len);
676         if (pos < 0)
677                 return -1;
678         if (!ce_skip_worktree(istate->cache[pos]))
679                 return -1;
680
681         return do_read_blob(&istate->cache[pos]->oid, oid_stat, size_out, data_out);
682 }
683
684 /*
685  * Frees memory within el which was allocated for exclude patterns and
686  * the file buffer.  Does not free el itself.
687  */
688 void clear_exclude_list(struct exclude_list *el)
689 {
690         int i;
691
692         for (i = 0; i < el->nr; i++)
693                 free(el->excludes[i]);
694         free(el->excludes);
695         free(el->filebuf);
696
697         memset(el, 0, sizeof(*el));
698 }
699
700 static void trim_trailing_spaces(char *buf)
701 {
702         char *p, *last_space = NULL;
703
704         for (p = buf; *p; p++)
705                 switch (*p) {
706                 case ' ':
707                         if (!last_space)
708                                 last_space = p;
709                         break;
710                 case '\\':
711                         p++;
712                         if (!*p)
713                                 return;
714                         /* fallthrough */
715                 default:
716                         last_space = NULL;
717                 }
718
719         if (last_space)
720                 *last_space = '\0';
721 }
722
723 /*
724  * Given a subdirectory name and "dir" of the current directory,
725  * search the subdir in "dir" and return it, or create a new one if it
726  * does not exist in "dir".
727  *
728  * If "name" has the trailing slash, it'll be excluded in the search.
729  */
730 static struct untracked_cache_dir *lookup_untracked(struct untracked_cache *uc,
731                                                     struct untracked_cache_dir *dir,
732                                                     const char *name, int len)
733 {
734         int first, last;
735         struct untracked_cache_dir *d;
736         if (!dir)
737                 return NULL;
738         if (len && name[len - 1] == '/')
739                 len--;
740         first = 0;
741         last = dir->dirs_nr;
742         while (last > first) {
743                 int cmp, next = (last + first) >> 1;
744                 d = dir->dirs[next];
745                 cmp = strncmp(name, d->name, len);
746                 if (!cmp && strlen(d->name) > len)
747                         cmp = -1;
748                 if (!cmp)
749                         return d;
750                 if (cmp < 0) {
751                         last = next;
752                         continue;
753                 }
754                 first = next+1;
755         }
756
757         uc->dir_created++;
758         FLEX_ALLOC_MEM(d, name, name, len);
759
760         ALLOC_GROW(dir->dirs, dir->dirs_nr + 1, dir->dirs_alloc);
761         MOVE_ARRAY(dir->dirs + first + 1, dir->dirs + first,
762                    dir->dirs_nr - first);
763         dir->dirs_nr++;
764         dir->dirs[first] = d;
765         return d;
766 }
767
768 static void do_invalidate_gitignore(struct untracked_cache_dir *dir)
769 {
770         int i;
771         dir->valid = 0;
772         dir->untracked_nr = 0;
773         for (i = 0; i < dir->dirs_nr; i++)
774                 do_invalidate_gitignore(dir->dirs[i]);
775 }
776
777 static void invalidate_gitignore(struct untracked_cache *uc,
778                                  struct untracked_cache_dir *dir)
779 {
780         uc->gitignore_invalidated++;
781         do_invalidate_gitignore(dir);
782 }
783
784 static void invalidate_directory(struct untracked_cache *uc,
785                                  struct untracked_cache_dir *dir)
786 {
787         int i;
788
789         /*
790          * Invalidation increment here is just roughly correct. If
791          * untracked_nr or any of dirs[].recurse is non-zero, we
792          * should increment dir_invalidated too. But that's more
793          * expensive to do.
794          */
795         if (dir->valid)
796                 uc->dir_invalidated++;
797
798         dir->valid = 0;
799         dir->untracked_nr = 0;
800         for (i = 0; i < dir->dirs_nr; i++)
801                 dir->dirs[i]->recurse = 0;
802 }
803
804 static int add_excludes_from_buffer(char *buf, size_t size,
805                                     const char *base, int baselen,
806                                     struct exclude_list *el);
807
808 /*
809  * Given a file with name "fname", read it (either from disk, or from
810  * an index if 'istate' is non-null), parse it and store the
811  * exclude rules in "el".
812  *
813  * If "ss" is not NULL, compute SHA-1 of the exclude file and fill
814  * stat data from disk (only valid if add_excludes returns zero). If
815  * ss_valid is non-zero, "ss" must contain good value as input.
816  */
817 static int add_excludes(const char *fname, const char *base, int baselen,
818                         struct exclude_list *el, struct index_state *istate,
819                         struct oid_stat *oid_stat)
820 {
821         struct stat st;
822         int r;
823         int fd;
824         size_t size = 0;
825         char *buf;
826
827         fd = open(fname, O_RDONLY);
828         if (fd < 0 || fstat(fd, &st) < 0) {
829                 if (fd < 0)
830                         warn_on_fopen_errors(fname);
831                 else
832                         close(fd);
833                 if (!istate)
834                         return -1;
835                 r = read_skip_worktree_file_from_index(istate, fname,
836                                                        &size, &buf,
837                                                        oid_stat);
838                 if (r != 1)
839                         return r;
840         } else {
841                 size = xsize_t(st.st_size);
842                 if (size == 0) {
843                         if (oid_stat) {
844                                 fill_stat_data(&oid_stat->stat, &st);
845                                 oidcpy(&oid_stat->oid, the_hash_algo->empty_blob);
846                                 oid_stat->valid = 1;
847                         }
848                         close(fd);
849                         return 0;
850                 }
851                 buf = xmallocz(size);
852                 if (read_in_full(fd, buf, size) != size) {
853                         free(buf);
854                         close(fd);
855                         return -1;
856                 }
857                 buf[size++] = '\n';
858                 close(fd);
859                 if (oid_stat) {
860                         int pos;
861                         if (oid_stat->valid &&
862                             !match_stat_data_racy(istate, &oid_stat->stat, &st))
863                                 ; /* no content change, ss->sha1 still good */
864                         else if (istate &&
865                                  (pos = index_name_pos(istate, fname, strlen(fname))) >= 0 &&
866                                  !ce_stage(istate->cache[pos]) &&
867                                  ce_uptodate(istate->cache[pos]) &&
868                                  !would_convert_to_git(istate, fname))
869                                 oidcpy(&oid_stat->oid,
870                                        &istate->cache[pos]->oid);
871                         else
872                                 hash_object_file(buf, size, "blob",
873                                                  &oid_stat->oid);
874                         fill_stat_data(&oid_stat->stat, &st);
875                         oid_stat->valid = 1;
876                 }
877         }
878
879         add_excludes_from_buffer(buf, size, base, baselen, el);
880         return 0;
881 }
882
883 static int add_excludes_from_buffer(char *buf, size_t size,
884                                     const char *base, int baselen,
885                                     struct exclude_list *el)
886 {
887         int i, lineno = 1;
888         char *entry;
889
890         el->filebuf = buf;
891
892         if (skip_utf8_bom(&buf, size))
893                 size -= buf - el->filebuf;
894
895         entry = buf;
896
897         for (i = 0; i < size; i++) {
898                 if (buf[i] == '\n') {
899                         if (entry != buf + i && entry[0] != '#') {
900                                 buf[i - (i && buf[i-1] == '\r')] = 0;
901                                 trim_trailing_spaces(entry);
902                                 add_exclude(entry, base, baselen, el, lineno);
903                         }
904                         lineno++;
905                         entry = buf + i + 1;
906                 }
907         }
908         return 0;
909 }
910
911 int add_excludes_from_file_to_list(const char *fname, const char *base,
912                                    int baselen, struct exclude_list *el,
913                                    struct index_state *istate)
914 {
915         return add_excludes(fname, base, baselen, el, istate, NULL);
916 }
917
918 int add_excludes_from_blob_to_list(
919         struct object_id *oid,
920         const char *base, int baselen,
921         struct exclude_list *el)
922 {
923         char *buf;
924         size_t size;
925         int r;
926
927         r = do_read_blob(oid, NULL, &size, &buf);
928         if (r != 1)
929                 return r;
930
931         add_excludes_from_buffer(buf, size, base, baselen, el);
932         return 0;
933 }
934
935 struct exclude_list *add_exclude_list(struct dir_struct *dir,
936                                       int group_type, const char *src)
937 {
938         struct exclude_list *el;
939         struct exclude_list_group *group;
940
941         group = &dir->exclude_list_group[group_type];
942         ALLOC_GROW(group->el, group->nr + 1, group->alloc);
943         el = &group->el[group->nr++];
944         memset(el, 0, sizeof(*el));
945         el->src = src;
946         return el;
947 }
948
949 /*
950  * Used to set up core.excludesfile and .git/info/exclude lists.
951  */
952 static void add_excludes_from_file_1(struct dir_struct *dir, const char *fname,
953                                      struct oid_stat *oid_stat)
954 {
955         struct exclude_list *el;
956         /*
957          * catch setup_standard_excludes() that's called before
958          * dir->untracked is assigned. That function behaves
959          * differently when dir->untracked is non-NULL.
960          */
961         if (!dir->untracked)
962                 dir->unmanaged_exclude_files++;
963         el = add_exclude_list(dir, EXC_FILE, fname);
964         if (add_excludes(fname, "", 0, el, NULL, oid_stat) < 0)
965                 die(_("cannot use %s as an exclude file"), fname);
966 }
967
968 void add_excludes_from_file(struct dir_struct *dir, const char *fname)
969 {
970         dir->unmanaged_exclude_files++; /* see validate_untracked_cache() */
971         add_excludes_from_file_1(dir, fname, NULL);
972 }
973
974 int match_basename(const char *basename, int basenamelen,
975                    const char *pattern, int prefix, int patternlen,
976                    unsigned flags)
977 {
978         if (prefix == patternlen) {
979                 if (patternlen == basenamelen &&
980                     !fspathncmp(pattern, basename, basenamelen))
981                         return 1;
982         } else if (flags & EXC_FLAG_ENDSWITH) {
983                 /* "*literal" matching against "fooliteral" */
984                 if (patternlen - 1 <= basenamelen &&
985                     !fspathncmp(pattern + 1,
986                                    basename + basenamelen - (patternlen - 1),
987                                    patternlen - 1))
988                         return 1;
989         } else {
990                 if (fnmatch_icase_mem(pattern, patternlen,
991                                       basename, basenamelen,
992                                       0) == 0)
993                         return 1;
994         }
995         return 0;
996 }
997
998 int match_pathname(const char *pathname, int pathlen,
999                    const char *base, int baselen,
1000                    const char *pattern, int prefix, int patternlen,
1001                    unsigned flags)
1002 {
1003         const char *name;
1004         int namelen;
1005
1006         /*
1007          * match with FNM_PATHNAME; the pattern has base implicitly
1008          * in front of it.
1009          */
1010         if (*pattern == '/') {
1011                 pattern++;
1012                 patternlen--;
1013                 prefix--;
1014         }
1015
1016         /*
1017          * baselen does not count the trailing slash. base[] may or
1018          * may not end with a trailing slash though.
1019          */
1020         if (pathlen < baselen + 1 ||
1021             (baselen && pathname[baselen] != '/') ||
1022             fspathncmp(pathname, base, baselen))
1023                 return 0;
1024
1025         namelen = baselen ? pathlen - baselen - 1 : pathlen;
1026         name = pathname + pathlen - namelen;
1027
1028         if (prefix) {
1029                 /*
1030                  * if the non-wildcard part is longer than the
1031                  * remaining pathname, surely it cannot match.
1032                  */
1033                 if (prefix > namelen)
1034                         return 0;
1035
1036                 if (fspathncmp(pattern, name, prefix))
1037                         return 0;
1038                 pattern += prefix;
1039                 patternlen -= prefix;
1040                 name    += prefix;
1041                 namelen -= prefix;
1042
1043                 /*
1044                  * If the whole pattern did not have a wildcard,
1045                  * then our prefix match is all we need; we
1046                  * do not need to call fnmatch at all.
1047                  */
1048                 if (!patternlen && !namelen)
1049                         return 1;
1050         }
1051
1052         return fnmatch_icase_mem(pattern, patternlen,
1053                                  name, namelen,
1054                                  WM_PATHNAME) == 0;
1055 }
1056
1057 /*
1058  * Scan the given exclude list in reverse to see whether pathname
1059  * should be ignored.  The first match (i.e. the last on the list), if
1060  * any, determines the fate.  Returns the exclude_list element which
1061  * matched, or NULL for undecided.
1062  */
1063 static struct exclude *last_exclude_matching_from_list(const char *pathname,
1064                                                        int pathlen,
1065                                                        const char *basename,
1066                                                        int *dtype,
1067                                                        struct exclude_list *el,
1068                                                        struct index_state *istate)
1069 {
1070         struct exclude *exc = NULL; /* undecided */
1071         int i;
1072
1073         if (!el->nr)
1074                 return NULL;    /* undefined */
1075
1076         for (i = el->nr - 1; 0 <= i; i--) {
1077                 struct exclude *x = el->excludes[i];
1078                 const char *exclude = x->pattern;
1079                 int prefix = x->nowildcardlen;
1080
1081                 if (x->flags & EXC_FLAG_MUSTBEDIR) {
1082                         if (*dtype == DT_UNKNOWN)
1083                                 *dtype = get_dtype(NULL, istate, pathname, pathlen);
1084                         if (*dtype != DT_DIR)
1085                                 continue;
1086                 }
1087
1088                 if (x->flags & EXC_FLAG_NODIR) {
1089                         if (match_basename(basename,
1090                                            pathlen - (basename - pathname),
1091                                            exclude, prefix, x->patternlen,
1092                                            x->flags)) {
1093                                 exc = x;
1094                                 break;
1095                         }
1096                         continue;
1097                 }
1098
1099                 assert(x->baselen == 0 || x->base[x->baselen - 1] == '/');
1100                 if (match_pathname(pathname, pathlen,
1101                                    x->base, x->baselen ? x->baselen - 1 : 0,
1102                                    exclude, prefix, x->patternlen, x->flags)) {
1103                         exc = x;
1104                         break;
1105                 }
1106         }
1107         return exc;
1108 }
1109
1110 /*
1111  * Scan the list and let the last match determine the fate.
1112  * Return 1 for exclude, 0 for include and -1 for undecided.
1113  */
1114 int is_excluded_from_list(const char *pathname,
1115                           int pathlen, const char *basename, int *dtype,
1116                           struct exclude_list *el, struct index_state *istate)
1117 {
1118         struct exclude *exclude;
1119         exclude = last_exclude_matching_from_list(pathname, pathlen, basename,
1120                                                   dtype, el, istate);
1121         if (exclude)
1122                 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
1123         return -1; /* undecided */
1124 }
1125
1126 static struct exclude *last_exclude_matching_from_lists(struct dir_struct *dir,
1127                                                         struct index_state *istate,
1128                 const char *pathname, int pathlen, const char *basename,
1129                 int *dtype_p)
1130 {
1131         int i, j;
1132         struct exclude_list_group *group;
1133         struct exclude *exclude;
1134         for (i = EXC_CMDL; i <= EXC_FILE; i++) {
1135                 group = &dir->exclude_list_group[i];
1136                 for (j = group->nr - 1; j >= 0; j--) {
1137                         exclude = last_exclude_matching_from_list(
1138                                 pathname, pathlen, basename, dtype_p,
1139                                 &group->el[j], istate);
1140                         if (exclude)
1141                                 return exclude;
1142                 }
1143         }
1144         return NULL;
1145 }
1146
1147 /*
1148  * Loads the per-directory exclude list for the substring of base
1149  * which has a char length of baselen.
1150  */
1151 static void prep_exclude(struct dir_struct *dir,
1152                          struct index_state *istate,
1153                          const char *base, int baselen)
1154 {
1155         struct exclude_list_group *group;
1156         struct exclude_list *el;
1157         struct exclude_stack *stk = NULL;
1158         struct untracked_cache_dir *untracked;
1159         int current;
1160
1161         group = &dir->exclude_list_group[EXC_DIRS];
1162
1163         /*
1164          * Pop the exclude lists from the EXCL_DIRS exclude_list_group
1165          * which originate from directories not in the prefix of the
1166          * path being checked.
1167          */
1168         while ((stk = dir->exclude_stack) != NULL) {
1169                 if (stk->baselen <= baselen &&
1170                     !strncmp(dir->basebuf.buf, base, stk->baselen))
1171                         break;
1172                 el = &group->el[dir->exclude_stack->exclude_ix];
1173                 dir->exclude_stack = stk->prev;
1174                 dir->exclude = NULL;
1175                 free((char *)el->src); /* see strbuf_detach() below */
1176                 clear_exclude_list(el);
1177                 free(stk);
1178                 group->nr--;
1179         }
1180
1181         /* Skip traversing into sub directories if the parent is excluded */
1182         if (dir->exclude)
1183                 return;
1184
1185         /*
1186          * Lazy initialization. All call sites currently just
1187          * memset(dir, 0, sizeof(*dir)) before use. Changing all of
1188          * them seems lots of work for little benefit.
1189          */
1190         if (!dir->basebuf.buf)
1191                 strbuf_init(&dir->basebuf, PATH_MAX);
1192
1193         /* Read from the parent directories and push them down. */
1194         current = stk ? stk->baselen : -1;
1195         strbuf_setlen(&dir->basebuf, current < 0 ? 0 : current);
1196         if (dir->untracked)
1197                 untracked = stk ? stk->ucd : dir->untracked->root;
1198         else
1199                 untracked = NULL;
1200
1201         while (current < baselen) {
1202                 const char *cp;
1203                 struct oid_stat oid_stat;
1204
1205                 stk = xcalloc(1, sizeof(*stk));
1206                 if (current < 0) {
1207                         cp = base;
1208                         current = 0;
1209                 } else {
1210                         cp = strchr(base + current + 1, '/');
1211                         if (!cp)
1212                                 die("oops in prep_exclude");
1213                         cp++;
1214                         untracked =
1215                                 lookup_untracked(dir->untracked, untracked,
1216                                                  base + current,
1217                                                  cp - base - current);
1218                 }
1219                 stk->prev = dir->exclude_stack;
1220                 stk->baselen = cp - base;
1221                 stk->exclude_ix = group->nr;
1222                 stk->ucd = untracked;
1223                 el = add_exclude_list(dir, EXC_DIRS, NULL);
1224                 strbuf_add(&dir->basebuf, base + current, stk->baselen - current);
1225                 assert(stk->baselen == dir->basebuf.len);
1226
1227                 /* Abort if the directory is excluded */
1228                 if (stk->baselen) {
1229                         int dt = DT_DIR;
1230                         dir->basebuf.buf[stk->baselen - 1] = 0;
1231                         dir->exclude = last_exclude_matching_from_lists(dir,
1232                                                                         istate,
1233                                 dir->basebuf.buf, stk->baselen - 1,
1234                                 dir->basebuf.buf + current, &dt);
1235                         dir->basebuf.buf[stk->baselen - 1] = '/';
1236                         if (dir->exclude &&
1237                             dir->exclude->flags & EXC_FLAG_NEGATIVE)
1238                                 dir->exclude = NULL;
1239                         if (dir->exclude) {
1240                                 dir->exclude_stack = stk;
1241                                 return;
1242                         }
1243                 }
1244
1245                 /* Try to read per-directory file */
1246                 oidclr(&oid_stat.oid);
1247                 oid_stat.valid = 0;
1248                 if (dir->exclude_per_dir &&
1249                     /*
1250                      * If we know that no files have been added in
1251                      * this directory (i.e. valid_cached_dir() has
1252                      * been executed and set untracked->valid) ..
1253                      */
1254                     (!untracked || !untracked->valid ||
1255                      /*
1256                       * .. and .gitignore does not exist before
1257                       * (i.e. null exclude_oid). Then we can skip
1258                       * loading .gitignore, which would result in
1259                       * ENOENT anyway.
1260                       */
1261                      !is_null_oid(&untracked->exclude_oid))) {
1262                         /*
1263                          * dir->basebuf gets reused by the traversal, but we
1264                          * need fname to remain unchanged to ensure the src
1265                          * member of each struct exclude correctly
1266                          * back-references its source file.  Other invocations
1267                          * of add_exclude_list provide stable strings, so we
1268                          * strbuf_detach() and free() here in the caller.
1269                          */
1270                         struct strbuf sb = STRBUF_INIT;
1271                         strbuf_addbuf(&sb, &dir->basebuf);
1272                         strbuf_addstr(&sb, dir->exclude_per_dir);
1273                         el->src = strbuf_detach(&sb, NULL);
1274                         add_excludes(el->src, el->src, stk->baselen, el, istate,
1275                                      untracked ? &oid_stat : NULL);
1276                 }
1277                 /*
1278                  * NEEDSWORK: when untracked cache is enabled, prep_exclude()
1279                  * will first be called in valid_cached_dir() then maybe many
1280                  * times more in last_exclude_matching(). When the cache is
1281                  * used, last_exclude_matching() will not be called and
1282                  * reading .gitignore content will be a waste.
1283                  *
1284                  * So when it's called by valid_cached_dir() and we can get
1285                  * .gitignore SHA-1 from the index (i.e. .gitignore is not
1286                  * modified on work tree), we could delay reading the
1287                  * .gitignore content until we absolutely need it in
1288                  * last_exclude_matching(). Be careful about ignore rule
1289                  * order, though, if you do that.
1290                  */
1291                 if (untracked &&
1292                     !oideq(&oid_stat.oid, &untracked->exclude_oid)) {
1293                         invalidate_gitignore(dir->untracked, untracked);
1294                         oidcpy(&untracked->exclude_oid, &oid_stat.oid);
1295                 }
1296                 dir->exclude_stack = stk;
1297                 current = stk->baselen;
1298         }
1299         strbuf_setlen(&dir->basebuf, baselen);
1300 }
1301
1302 /*
1303  * Loads the exclude lists for the directory containing pathname, then
1304  * scans all exclude lists to determine whether pathname is excluded.
1305  * Returns the exclude_list element which matched, or NULL for
1306  * undecided.
1307  */
1308 struct exclude *last_exclude_matching(struct dir_struct *dir,
1309                                       struct index_state *istate,
1310                                       const char *pathname,
1311                                       int *dtype_p)
1312 {
1313         int pathlen = strlen(pathname);
1314         const char *basename = strrchr(pathname, '/');
1315         basename = (basename) ? basename+1 : pathname;
1316
1317         prep_exclude(dir, istate, pathname, basename-pathname);
1318
1319         if (dir->exclude)
1320                 return dir->exclude;
1321
1322         return last_exclude_matching_from_lists(dir, istate, pathname, pathlen,
1323                         basename, dtype_p);
1324 }
1325
1326 /*
1327  * Loads the exclude lists for the directory containing pathname, then
1328  * scans all exclude lists to determine whether pathname is excluded.
1329  * Returns 1 if true, otherwise 0.
1330  */
1331 int is_excluded(struct dir_struct *dir, struct index_state *istate,
1332                 const char *pathname, int *dtype_p)
1333 {
1334         struct exclude *exclude =
1335                 last_exclude_matching(dir, istate, pathname, dtype_p);
1336         if (exclude)
1337                 return exclude->flags & EXC_FLAG_NEGATIVE ? 0 : 1;
1338         return 0;
1339 }
1340
1341 static struct dir_entry *dir_entry_new(const char *pathname, int len)
1342 {
1343         struct dir_entry *ent;
1344
1345         FLEX_ALLOC_MEM(ent, name, pathname, len);
1346         ent->len = len;
1347         return ent;
1348 }
1349
1350 static struct dir_entry *dir_add_name(struct dir_struct *dir,
1351                                       struct index_state *istate,
1352                                       const char *pathname, int len)
1353 {
1354         if (index_file_exists(istate, pathname, len, ignore_case))
1355                 return NULL;
1356
1357         ALLOC_GROW(dir->entries, dir->nr+1, dir->alloc);
1358         return dir->entries[dir->nr++] = dir_entry_new(pathname, len);
1359 }
1360
1361 struct dir_entry *dir_add_ignored(struct dir_struct *dir,
1362                                   struct index_state *istate,
1363                                   const char *pathname, int len)
1364 {
1365         if (!index_name_is_other(istate, pathname, len))
1366                 return NULL;
1367
1368         ALLOC_GROW(dir->ignored, dir->ignored_nr+1, dir->ignored_alloc);
1369         return dir->ignored[dir->ignored_nr++] = dir_entry_new(pathname, len);
1370 }
1371
1372 enum exist_status {
1373         index_nonexistent = 0,
1374         index_directory,
1375         index_gitdir
1376 };
1377
1378 /*
1379  * Do not use the alphabetically sorted index to look up
1380  * the directory name; instead, use the case insensitive
1381  * directory hash.
1382  */
1383 static enum exist_status directory_exists_in_index_icase(struct index_state *istate,
1384                                                          const char *dirname, int len)
1385 {
1386         struct cache_entry *ce;
1387
1388         if (index_dir_exists(istate, dirname, len))
1389                 return index_directory;
1390
1391         ce = index_file_exists(istate, dirname, len, ignore_case);
1392         if (ce && S_ISGITLINK(ce->ce_mode))
1393                 return index_gitdir;
1394
1395         return index_nonexistent;
1396 }
1397
1398 /*
1399  * The index sorts alphabetically by entry name, which
1400  * means that a gitlink sorts as '\0' at the end, while
1401  * a directory (which is defined not as an entry, but as
1402  * the files it contains) will sort with the '/' at the
1403  * end.
1404  */
1405 static enum exist_status directory_exists_in_index(struct index_state *istate,
1406                                                    const char *dirname, int len)
1407 {
1408         int pos;
1409
1410         if (ignore_case)
1411                 return directory_exists_in_index_icase(istate, dirname, len);
1412
1413         pos = index_name_pos(istate, dirname, len);
1414         if (pos < 0)
1415                 pos = -pos-1;
1416         while (pos < istate->cache_nr) {
1417                 const struct cache_entry *ce = istate->cache[pos++];
1418                 unsigned char endchar;
1419
1420                 if (strncmp(ce->name, dirname, len))
1421                         break;
1422                 endchar = ce->name[len];
1423                 if (endchar > '/')
1424                         break;
1425                 if (endchar == '/')
1426                         return index_directory;
1427                 if (!endchar && S_ISGITLINK(ce->ce_mode))
1428                         return index_gitdir;
1429         }
1430         return index_nonexistent;
1431 }
1432
1433 /*
1434  * When we find a directory when traversing the filesystem, we
1435  * have three distinct cases:
1436  *
1437  *  - ignore it
1438  *  - see it as a directory
1439  *  - recurse into it
1440  *
1441  * and which one we choose depends on a combination of existing
1442  * git index contents and the flags passed into the directory
1443  * traversal routine.
1444  *
1445  * Case 1: If we *already* have entries in the index under that
1446  * directory name, we always recurse into the directory to see
1447  * all the files.
1448  *
1449  * Case 2: If we *already* have that directory name as a gitlink,
1450  * we always continue to see it as a gitlink, regardless of whether
1451  * there is an actual git directory there or not (it might not
1452  * be checked out as a subproject!)
1453  *
1454  * Case 3: if we didn't have it in the index previously, we
1455  * have a few sub-cases:
1456  *
1457  *  (a) if "show_other_directories" is true, we show it as
1458  *      just a directory, unless "hide_empty_directories" is
1459  *      also true, in which case we need to check if it contains any
1460  *      untracked and / or ignored files.
1461  *  (b) if it looks like a git directory, and we don't have
1462  *      'no_gitlinks' set we treat it as a gitlink, and show it
1463  *      as a directory.
1464  *  (c) otherwise, we recurse into it.
1465  */
1466 static enum path_treatment treat_directory(struct dir_struct *dir,
1467         struct index_state *istate,
1468         struct untracked_cache_dir *untracked,
1469         const char *dirname, int len, int baselen, int exclude,
1470         const struct pathspec *pathspec)
1471 {
1472         /* The "len-1" is to strip the final '/' */
1473         switch (directory_exists_in_index(istate, dirname, len-1)) {
1474         case index_directory:
1475                 return path_recurse;
1476
1477         case index_gitdir:
1478                 return path_none;
1479
1480         case index_nonexistent:
1481                 if (dir->flags & DIR_SHOW_OTHER_DIRECTORIES)
1482                         break;
1483                 if (exclude &&
1484                         (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1485                         (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING)) {
1486
1487                         /*
1488                          * This is an excluded directory and we are
1489                          * showing ignored paths that match an exclude
1490                          * pattern.  (e.g. show directory as ignored
1491                          * only if it matches an exclude pattern).
1492                          * This path will either be 'path_excluded`
1493                          * (if we are showing empty directories or if
1494                          * the directory is not empty), or will be
1495                          * 'path_none' (empty directory, and we are
1496                          * not showing empty directories).
1497                          */
1498                         if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1499                                 return path_excluded;
1500
1501                         if (read_directory_recursive(dir, istate, dirname, len,
1502                                                      untracked, 1, 1, pathspec) == path_excluded)
1503                                 return path_excluded;
1504
1505                         return path_none;
1506                 }
1507                 if (!(dir->flags & DIR_NO_GITLINKS)) {
1508                         struct object_id oid;
1509                         if (resolve_gitlink_ref(dirname, "HEAD", &oid) == 0)
1510                                 return exclude ? path_excluded : path_untracked;
1511                 }
1512                 return path_recurse;
1513         }
1514
1515         /* This is the "show_other_directories" case */
1516
1517         if (!(dir->flags & DIR_HIDE_EMPTY_DIRECTORIES))
1518                 return exclude ? path_excluded : path_untracked;
1519
1520         untracked = lookup_untracked(dir->untracked, untracked,
1521                                      dirname + baselen, len - baselen);
1522
1523         /*
1524          * If this is an excluded directory, then we only need to check if
1525          * the directory contains any files.
1526          */
1527         return read_directory_recursive(dir, istate, dirname, len,
1528                                         untracked, 1, exclude, pathspec);
1529 }
1530
1531 /*
1532  * This is an inexact early pruning of any recursive directory
1533  * reading - if the path cannot possibly be in the pathspec,
1534  * return true, and we'll skip it early.
1535  */
1536 static int simplify_away(const char *path, int pathlen,
1537                          const struct pathspec *pathspec)
1538 {
1539         int i;
1540
1541         if (!pathspec || !pathspec->nr)
1542                 return 0;
1543
1544         GUARD_PATHSPEC(pathspec,
1545                        PATHSPEC_FROMTOP |
1546                        PATHSPEC_MAXDEPTH |
1547                        PATHSPEC_LITERAL |
1548                        PATHSPEC_GLOB |
1549                        PATHSPEC_ICASE |
1550                        PATHSPEC_EXCLUDE |
1551                        PATHSPEC_ATTR);
1552
1553         for (i = 0; i < pathspec->nr; i++) {
1554                 const struct pathspec_item *item = &pathspec->items[i];
1555                 int len = item->nowildcard_len;
1556
1557                 if (len > pathlen)
1558                         len = pathlen;
1559                 if (!ps_strncmp(item, item->match, path, len))
1560                         return 0;
1561         }
1562
1563         return 1;
1564 }
1565
1566 /*
1567  * This function tells us whether an excluded path matches a
1568  * list of "interesting" pathspecs. That is, whether a path matched
1569  * by any of the pathspecs could possibly be ignored by excluding
1570  * the specified path. This can happen if:
1571  *
1572  *   1. the path is mentioned explicitly in the pathspec
1573  *
1574  *   2. the path is a directory prefix of some element in the
1575  *      pathspec
1576  */
1577 static int exclude_matches_pathspec(const char *path, int pathlen,
1578                                     const struct pathspec *pathspec)
1579 {
1580         int i;
1581
1582         if (!pathspec || !pathspec->nr)
1583                 return 0;
1584
1585         GUARD_PATHSPEC(pathspec,
1586                        PATHSPEC_FROMTOP |
1587                        PATHSPEC_MAXDEPTH |
1588                        PATHSPEC_LITERAL |
1589                        PATHSPEC_GLOB |
1590                        PATHSPEC_ICASE |
1591                        PATHSPEC_EXCLUDE);
1592
1593         for (i = 0; i < pathspec->nr; i++) {
1594                 const struct pathspec_item *item = &pathspec->items[i];
1595                 int len = item->nowildcard_len;
1596
1597                 if (len == pathlen &&
1598                     !ps_strncmp(item, item->match, path, pathlen))
1599                         return 1;
1600                 if (len > pathlen &&
1601                     item->match[pathlen] == '/' &&
1602                     !ps_strncmp(item, item->match, path, pathlen))
1603                         return 1;
1604         }
1605         return 0;
1606 }
1607
1608 static int get_index_dtype(struct index_state *istate,
1609                            const char *path, int len)
1610 {
1611         int pos;
1612         const struct cache_entry *ce;
1613
1614         ce = index_file_exists(istate, path, len, 0);
1615         if (ce) {
1616                 if (!ce_uptodate(ce))
1617                         return DT_UNKNOWN;
1618                 if (S_ISGITLINK(ce->ce_mode))
1619                         return DT_DIR;
1620                 /*
1621                  * Nobody actually cares about the
1622                  * difference between DT_LNK and DT_REG
1623                  */
1624                 return DT_REG;
1625         }
1626
1627         /* Try to look it up as a directory */
1628         pos = index_name_pos(istate, path, len);
1629         if (pos >= 0)
1630                 return DT_UNKNOWN;
1631         pos = -pos-1;
1632         while (pos < istate->cache_nr) {
1633                 ce = istate->cache[pos++];
1634                 if (strncmp(ce->name, path, len))
1635                         break;
1636                 if (ce->name[len] > '/')
1637                         break;
1638                 if (ce->name[len] < '/')
1639                         continue;
1640                 if (!ce_uptodate(ce))
1641                         break;  /* continue? */
1642                 return DT_DIR;
1643         }
1644         return DT_UNKNOWN;
1645 }
1646
1647 static int get_dtype(struct dirent *de, struct index_state *istate,
1648                      const char *path, int len)
1649 {
1650         int dtype = de ? DTYPE(de) : DT_UNKNOWN;
1651         struct stat st;
1652
1653         if (dtype != DT_UNKNOWN)
1654                 return dtype;
1655         dtype = get_index_dtype(istate, path, len);
1656         if (dtype != DT_UNKNOWN)
1657                 return dtype;
1658         if (lstat(path, &st))
1659                 return dtype;
1660         if (S_ISREG(st.st_mode))
1661                 return DT_REG;
1662         if (S_ISDIR(st.st_mode))
1663                 return DT_DIR;
1664         if (S_ISLNK(st.st_mode))
1665                 return DT_LNK;
1666         return dtype;
1667 }
1668
1669 static enum path_treatment treat_one_path(struct dir_struct *dir,
1670                                           struct untracked_cache_dir *untracked,
1671                                           struct index_state *istate,
1672                                           struct strbuf *path,
1673                                           int baselen,
1674                                           const struct pathspec *pathspec,
1675                                           int dtype, struct dirent *de)
1676 {
1677         int exclude;
1678         int has_path_in_index = !!index_file_exists(istate, path->buf, path->len, ignore_case);
1679         enum path_treatment path_treatment;
1680
1681         if (dtype == DT_UNKNOWN)
1682                 dtype = get_dtype(de, istate, path->buf, path->len);
1683
1684         /* Always exclude indexed files */
1685         if (dtype != DT_DIR && has_path_in_index)
1686                 return path_none;
1687
1688         /*
1689          * When we are looking at a directory P in the working tree,
1690          * there are three cases:
1691          *
1692          * (1) P exists in the index.  Everything inside the directory P in
1693          * the working tree needs to go when P is checked out from the
1694          * index.
1695          *
1696          * (2) P does not exist in the index, but there is P/Q in the index.
1697          * We know P will stay a directory when we check out the contents
1698          * of the index, but we do not know yet if there is a directory
1699          * P/Q in the working tree to be killed, so we need to recurse.
1700          *
1701          * (3) P does not exist in the index, and there is no P/Q in the index
1702          * to require P to be a directory, either.  Only in this case, we
1703          * know that everything inside P will not be killed without
1704          * recursing.
1705          */
1706         if ((dir->flags & DIR_COLLECT_KILLED_ONLY) &&
1707             (dtype == DT_DIR) &&
1708             !has_path_in_index &&
1709             (directory_exists_in_index(istate, path->buf, path->len) == index_nonexistent))
1710                 return path_none;
1711
1712         exclude = is_excluded(dir, istate, path->buf, &dtype);
1713
1714         /*
1715          * Excluded? If we don't explicitly want to show
1716          * ignored files, ignore it
1717          */
1718         if (exclude && !(dir->flags & (DIR_SHOW_IGNORED|DIR_SHOW_IGNORED_TOO)))
1719                 return path_excluded;
1720
1721         switch (dtype) {
1722         default:
1723                 return path_none;
1724         case DT_DIR:
1725                 strbuf_addch(path, '/');
1726                 path_treatment = treat_directory(dir, istate, untracked,
1727                                                  path->buf, path->len,
1728                                                  baselen, exclude, pathspec);
1729                 /*
1730                  * If 1) we only want to return directories that
1731                  * match an exclude pattern and 2) this directory does
1732                  * not match an exclude pattern but all of its
1733                  * contents are excluded, then indicate that we should
1734                  * recurse into this directory (instead of marking the
1735                  * directory itself as an ignored path).
1736                  */
1737                 if (!exclude &&
1738                     path_treatment == path_excluded &&
1739                     (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1740                     (dir->flags & DIR_SHOW_IGNORED_TOO_MODE_MATCHING))
1741                         return path_recurse;
1742                 return path_treatment;
1743         case DT_REG:
1744         case DT_LNK:
1745                 return exclude ? path_excluded : path_untracked;
1746         }
1747 }
1748
1749 static enum path_treatment treat_path_fast(struct dir_struct *dir,
1750                                            struct untracked_cache_dir *untracked,
1751                                            struct cached_dir *cdir,
1752                                            struct index_state *istate,
1753                                            struct strbuf *path,
1754                                            int baselen,
1755                                            const struct pathspec *pathspec)
1756 {
1757         strbuf_setlen(path, baselen);
1758         if (!cdir->ucd) {
1759                 strbuf_addstr(path, cdir->file);
1760                 return path_untracked;
1761         }
1762         strbuf_addstr(path, cdir->ucd->name);
1763         /* treat_one_path() does this before it calls treat_directory() */
1764         strbuf_complete(path, '/');
1765         if (cdir->ucd->check_only)
1766                 /*
1767                  * check_only is set as a result of treat_directory() getting
1768                  * to its bottom. Verify again the same set of directories
1769                  * with check_only set.
1770                  */
1771                 return read_directory_recursive(dir, istate, path->buf, path->len,
1772                                                 cdir->ucd, 1, 0, pathspec);
1773         /*
1774          * We get path_recurse in the first run when
1775          * directory_exists_in_index() returns index_nonexistent. We
1776          * are sure that new changes in the index does not impact the
1777          * outcome. Return now.
1778          */
1779         return path_recurse;
1780 }
1781
1782 static enum path_treatment treat_path(struct dir_struct *dir,
1783                                       struct untracked_cache_dir *untracked,
1784                                       struct cached_dir *cdir,
1785                                       struct index_state *istate,
1786                                       struct strbuf *path,
1787                                       int baselen,
1788                                       const struct pathspec *pathspec)
1789 {
1790         int dtype;
1791         struct dirent *de = cdir->de;
1792
1793         if (!de)
1794                 return treat_path_fast(dir, untracked, cdir, istate, path,
1795                                        baselen, pathspec);
1796         if (is_dot_or_dotdot(de->d_name) || !fspathcmp(de->d_name, ".git"))
1797                 return path_none;
1798         strbuf_setlen(path, baselen);
1799         strbuf_addstr(path, de->d_name);
1800         if (simplify_away(path->buf, path->len, pathspec))
1801                 return path_none;
1802
1803         dtype = DTYPE(de);
1804         return treat_one_path(dir, untracked, istate, path, baselen, pathspec, dtype, de);
1805 }
1806
1807 static void add_untracked(struct untracked_cache_dir *dir, const char *name)
1808 {
1809         if (!dir)
1810                 return;
1811         ALLOC_GROW(dir->untracked, dir->untracked_nr + 1,
1812                    dir->untracked_alloc);
1813         dir->untracked[dir->untracked_nr++] = xstrdup(name);
1814 }
1815
1816 static int valid_cached_dir(struct dir_struct *dir,
1817                             struct untracked_cache_dir *untracked,
1818                             struct index_state *istate,
1819                             struct strbuf *path,
1820                             int check_only)
1821 {
1822         struct stat st;
1823
1824         if (!untracked)
1825                 return 0;
1826
1827         /*
1828          * With fsmonitor, we can trust the untracked cache's valid field.
1829          */
1830         refresh_fsmonitor(istate);
1831         if (!(dir->untracked->use_fsmonitor && untracked->valid)) {
1832                 if (lstat(path->len ? path->buf : ".", &st)) {
1833                         memset(&untracked->stat_data, 0, sizeof(untracked->stat_data));
1834                         return 0;
1835                 }
1836                 if (!untracked->valid ||
1837                         match_stat_data_racy(istate, &untracked->stat_data, &st)) {
1838                         fill_stat_data(&untracked->stat_data, &st);
1839                         return 0;
1840                 }
1841         }
1842
1843         if (untracked->check_only != !!check_only)
1844                 return 0;
1845
1846         /*
1847          * prep_exclude will be called eventually on this directory,
1848          * but it's called much later in last_exclude_matching(). We
1849          * need it now to determine the validity of the cache for this
1850          * path. The next calls will be nearly no-op, the way
1851          * prep_exclude() is designed.
1852          */
1853         if (path->len && path->buf[path->len - 1] != '/') {
1854                 strbuf_addch(path, '/');
1855                 prep_exclude(dir, istate, path->buf, path->len);
1856                 strbuf_setlen(path, path->len - 1);
1857         } else
1858                 prep_exclude(dir, istate, path->buf, path->len);
1859
1860         /* hopefully prep_exclude() haven't invalidated this entry... */
1861         return untracked->valid;
1862 }
1863
1864 static int open_cached_dir(struct cached_dir *cdir,
1865                            struct dir_struct *dir,
1866                            struct untracked_cache_dir *untracked,
1867                            struct index_state *istate,
1868                            struct strbuf *path,
1869                            int check_only)
1870 {
1871         const char *c_path;
1872
1873         memset(cdir, 0, sizeof(*cdir));
1874         cdir->untracked = untracked;
1875         if (valid_cached_dir(dir, untracked, istate, path, check_only))
1876                 return 0;
1877         c_path = path->len ? path->buf : ".";
1878         cdir->fdir = opendir(c_path);
1879         if (!cdir->fdir)
1880                 warning_errno(_("could not open directory '%s'"), c_path);
1881         if (dir->untracked) {
1882                 invalidate_directory(dir->untracked, untracked);
1883                 dir->untracked->dir_opened++;
1884         }
1885         if (!cdir->fdir)
1886                 return -1;
1887         return 0;
1888 }
1889
1890 static int read_cached_dir(struct cached_dir *cdir)
1891 {
1892         if (cdir->fdir) {
1893                 cdir->de = readdir(cdir->fdir);
1894                 if (!cdir->de)
1895                         return -1;
1896                 return 0;
1897         }
1898         while (cdir->nr_dirs < cdir->untracked->dirs_nr) {
1899                 struct untracked_cache_dir *d = cdir->untracked->dirs[cdir->nr_dirs];
1900                 if (!d->recurse) {
1901                         cdir->nr_dirs++;
1902                         continue;
1903                 }
1904                 cdir->ucd = d;
1905                 cdir->nr_dirs++;
1906                 return 0;
1907         }
1908         cdir->ucd = NULL;
1909         if (cdir->nr_files < cdir->untracked->untracked_nr) {
1910                 struct untracked_cache_dir *d = cdir->untracked;
1911                 cdir->file = d->untracked[cdir->nr_files++];
1912                 return 0;
1913         }
1914         return -1;
1915 }
1916
1917 static void close_cached_dir(struct cached_dir *cdir)
1918 {
1919         if (cdir->fdir)
1920                 closedir(cdir->fdir);
1921         /*
1922          * We have gone through this directory and found no untracked
1923          * entries. Mark it valid.
1924          */
1925         if (cdir->untracked) {
1926                 cdir->untracked->valid = 1;
1927                 cdir->untracked->recurse = 1;
1928         }
1929 }
1930
1931 /*
1932  * Read a directory tree. We currently ignore anything but
1933  * directories, regular files and symlinks. That's because git
1934  * doesn't handle them at all yet. Maybe that will change some
1935  * day.
1936  *
1937  * Also, we ignore the name ".git" (even if it is not a directory).
1938  * That likely will not change.
1939  *
1940  * If 'stop_at_first_file' is specified, 'path_excluded' is returned
1941  * to signal that a file was found. This is the least significant value that
1942  * indicates that a file was encountered that does not depend on the order of
1943  * whether an untracked or exluded path was encountered first.
1944  *
1945  * Returns the most significant path_treatment value encountered in the scan.
1946  * If 'stop_at_first_file' is specified, `path_excluded` is the most
1947  * significant path_treatment value that will be returned.
1948  */
1949
1950 static enum path_treatment read_directory_recursive(struct dir_struct *dir,
1951         struct index_state *istate, const char *base, int baselen,
1952         struct untracked_cache_dir *untracked, int check_only,
1953         int stop_at_first_file, const struct pathspec *pathspec)
1954 {
1955         struct cached_dir cdir;
1956         enum path_treatment state, subdir_state, dir_state = path_none;
1957         struct strbuf path = STRBUF_INIT;
1958
1959         strbuf_add(&path, base, baselen);
1960
1961         if (open_cached_dir(&cdir, dir, untracked, istate, &path, check_only))
1962                 goto out;
1963
1964         if (untracked)
1965                 untracked->check_only = !!check_only;
1966
1967         while (!read_cached_dir(&cdir)) {
1968                 /* check how the file or directory should be treated */
1969                 state = treat_path(dir, untracked, &cdir, istate, &path,
1970                                    baselen, pathspec);
1971
1972                 if (state > dir_state)
1973                         dir_state = state;
1974
1975                 /* recurse into subdir if instructed by treat_path */
1976                 if ((state == path_recurse) ||
1977                         ((state == path_untracked) &&
1978                          (dir->flags & DIR_SHOW_IGNORED_TOO) &&
1979                          (get_dtype(cdir.de, istate, path.buf, path.len) == DT_DIR))) {
1980                         struct untracked_cache_dir *ud;
1981                         ud = lookup_untracked(dir->untracked, untracked,
1982                                               path.buf + baselen,
1983                                               path.len - baselen);
1984                         subdir_state =
1985                                 read_directory_recursive(dir, istate, path.buf,
1986                                                          path.len, ud,
1987                                                          check_only, stop_at_first_file, pathspec);
1988                         if (subdir_state > dir_state)
1989                                 dir_state = subdir_state;
1990                 }
1991
1992                 if (check_only) {
1993                         if (stop_at_first_file) {
1994                                 /*
1995                                  * If stopping at first file, then
1996                                  * signal that a file was found by
1997                                  * returning `path_excluded`. This is
1998                                  * to return a consistent value
1999                                  * regardless of whether an ignored or
2000                                  * excluded file happened to be
2001                                  * encountered 1st.
2002                                  *
2003                                  * In current usage, the
2004                                  * `stop_at_first_file` is passed when
2005                                  * an ancestor directory has matched
2006                                  * an exclude pattern, so any found
2007                                  * files will be excluded.
2008                                  */
2009                                 if (dir_state >= path_excluded) {
2010                                         dir_state = path_excluded;
2011                                         break;
2012                                 }
2013                         }
2014
2015                         /* abort early if maximum state has been reached */
2016                         if (dir_state == path_untracked) {
2017                                 if (cdir.fdir)
2018                                         add_untracked(untracked, path.buf + baselen);
2019                                 break;
2020                         }
2021                         /* skip the dir_add_* part */
2022                         continue;
2023                 }
2024
2025                 /* add the path to the appropriate result list */
2026                 switch (state) {
2027                 case path_excluded:
2028                         if (dir->flags & DIR_SHOW_IGNORED)
2029                                 dir_add_name(dir, istate, path.buf, path.len);
2030                         else if ((dir->flags & DIR_SHOW_IGNORED_TOO) ||
2031                                 ((dir->flags & DIR_COLLECT_IGNORED) &&
2032                                 exclude_matches_pathspec(path.buf, path.len,
2033                                                          pathspec)))
2034                                 dir_add_ignored(dir, istate, path.buf, path.len);
2035                         break;
2036
2037                 case path_untracked:
2038                         if (dir->flags & DIR_SHOW_IGNORED)
2039                                 break;
2040                         dir_add_name(dir, istate, path.buf, path.len);
2041                         if (cdir.fdir)
2042                                 add_untracked(untracked, path.buf + baselen);
2043                         break;
2044
2045                 default:
2046                         break;
2047                 }
2048         }
2049         close_cached_dir(&cdir);
2050  out:
2051         strbuf_release(&path);
2052
2053         return dir_state;
2054 }
2055
2056 int cmp_dir_entry(const void *p1, const void *p2)
2057 {
2058         const struct dir_entry *e1 = *(const struct dir_entry **)p1;
2059         const struct dir_entry *e2 = *(const struct dir_entry **)p2;
2060
2061         return name_compare(e1->name, e1->len, e2->name, e2->len);
2062 }
2063
2064 /* check if *out lexically strictly contains *in */
2065 int check_dir_entry_contains(const struct dir_entry *out, const struct dir_entry *in)
2066 {
2067         return (out->len < in->len) &&
2068                 (out->name[out->len - 1] == '/') &&
2069                 !memcmp(out->name, in->name, out->len);
2070 }
2071
2072 static int treat_leading_path(struct dir_struct *dir,
2073                               struct index_state *istate,
2074                               const char *path, int len,
2075                               const struct pathspec *pathspec)
2076 {
2077         struct strbuf sb = STRBUF_INIT;
2078         int baselen, rc = 0;
2079         const char *cp;
2080         int old_flags = dir->flags;
2081
2082         while (len && path[len - 1] == '/')
2083                 len--;
2084         if (!len)
2085                 return 1;
2086         baselen = 0;
2087         dir->flags &= ~DIR_SHOW_OTHER_DIRECTORIES;
2088         while (1) {
2089                 cp = path + baselen + !!baselen;
2090                 cp = memchr(cp, '/', path + len - cp);
2091                 if (!cp)
2092                         baselen = len;
2093                 else
2094                         baselen = cp - path;
2095                 strbuf_setlen(&sb, 0);
2096                 strbuf_add(&sb, path, baselen);
2097                 if (!is_directory(sb.buf))
2098                         break;
2099                 if (simplify_away(sb.buf, sb.len, pathspec))
2100                         break;
2101                 if (treat_one_path(dir, NULL, istate, &sb, baselen, pathspec,
2102                                    DT_DIR, NULL) == path_none)
2103                         break; /* do not recurse into it */
2104                 if (len <= baselen) {
2105                         rc = 1;
2106                         break; /* finished checking */
2107                 }
2108         }
2109         strbuf_release(&sb);
2110         dir->flags = old_flags;
2111         return rc;
2112 }
2113
2114 static const char *get_ident_string(void)
2115 {
2116         static struct strbuf sb = STRBUF_INIT;
2117         struct utsname uts;
2118
2119         if (sb.len)
2120                 return sb.buf;
2121         if (uname(&uts) < 0)
2122                 die_errno(_("failed to get kernel name and information"));
2123         strbuf_addf(&sb, "Location %s, system %s", get_git_work_tree(),
2124                     uts.sysname);
2125         return sb.buf;
2126 }
2127
2128 static int ident_in_untracked(const struct untracked_cache *uc)
2129 {
2130         /*
2131          * Previous git versions may have saved many NUL separated
2132          * strings in the "ident" field, but it is insane to manage
2133          * many locations, so just take care of the first one.
2134          */
2135
2136         return !strcmp(uc->ident.buf, get_ident_string());
2137 }
2138
2139 static void set_untracked_ident(struct untracked_cache *uc)
2140 {
2141         strbuf_reset(&uc->ident);
2142         strbuf_addstr(&uc->ident, get_ident_string());
2143
2144         /*
2145          * This strbuf used to contain a list of NUL separated
2146          * strings, so save NUL too for backward compatibility.
2147          */
2148         strbuf_addch(&uc->ident, 0);
2149 }
2150
2151 static void new_untracked_cache(struct index_state *istate)
2152 {
2153         struct untracked_cache *uc = xcalloc(1, sizeof(*uc));
2154         strbuf_init(&uc->ident, 100);
2155         uc->exclude_per_dir = ".gitignore";
2156         /* should be the same flags used by git-status */
2157         uc->dir_flags = DIR_SHOW_OTHER_DIRECTORIES | DIR_HIDE_EMPTY_DIRECTORIES;
2158         set_untracked_ident(uc);
2159         istate->untracked = uc;
2160         istate->cache_changed |= UNTRACKED_CHANGED;
2161 }
2162
2163 void add_untracked_cache(struct index_state *istate)
2164 {
2165         if (!istate->untracked) {
2166                 new_untracked_cache(istate);
2167         } else {
2168                 if (!ident_in_untracked(istate->untracked)) {
2169                         free_untracked_cache(istate->untracked);
2170                         new_untracked_cache(istate);
2171                 }
2172         }
2173 }
2174
2175 void remove_untracked_cache(struct index_state *istate)
2176 {
2177         if (istate->untracked) {
2178                 free_untracked_cache(istate->untracked);
2179                 istate->untracked = NULL;
2180                 istate->cache_changed |= UNTRACKED_CHANGED;
2181         }
2182 }
2183
2184 static struct untracked_cache_dir *validate_untracked_cache(struct dir_struct *dir,
2185                                                       int base_len,
2186                                                       const struct pathspec *pathspec)
2187 {
2188         struct untracked_cache_dir *root;
2189         static int untracked_cache_disabled = -1;
2190
2191         if (!dir->untracked)
2192                 return NULL;
2193         if (untracked_cache_disabled < 0)
2194                 untracked_cache_disabled = git_env_bool("GIT_DISABLE_UNTRACKED_CACHE", 0);
2195         if (untracked_cache_disabled)
2196                 return NULL;
2197
2198         /*
2199          * We only support $GIT_DIR/info/exclude and core.excludesfile
2200          * as the global ignore rule files. Any other additions
2201          * (e.g. from command line) invalidate the cache. This
2202          * condition also catches running setup_standard_excludes()
2203          * before setting dir->untracked!
2204          */
2205         if (dir->unmanaged_exclude_files)
2206                 return NULL;
2207
2208         /*
2209          * Optimize for the main use case only: whole-tree git
2210          * status. More work involved in treat_leading_path() if we
2211          * use cache on just a subset of the worktree. pathspec
2212          * support could make the matter even worse.
2213          */
2214         if (base_len || (pathspec && pathspec->nr))
2215                 return NULL;
2216
2217         /* Different set of flags may produce different results */
2218         if (dir->flags != dir->untracked->dir_flags ||
2219             /*
2220              * See treat_directory(), case index_nonexistent. Without
2221              * this flag, we may need to also cache .git file content
2222              * for the resolve_gitlink_ref() call, which we don't.
2223              */
2224             !(dir->flags & DIR_SHOW_OTHER_DIRECTORIES) ||
2225             /* We don't support collecting ignore files */
2226             (dir->flags & (DIR_SHOW_IGNORED | DIR_SHOW_IGNORED_TOO |
2227                            DIR_COLLECT_IGNORED)))
2228                 return NULL;
2229
2230         /*
2231          * If we use .gitignore in the cache and now you change it to
2232          * .gitexclude, everything will go wrong.
2233          */
2234         if (dir->exclude_per_dir != dir->untracked->exclude_per_dir &&
2235             strcmp(dir->exclude_per_dir, dir->untracked->exclude_per_dir))
2236                 return NULL;
2237
2238         /*
2239          * EXC_CMDL is not considered in the cache. If people set it,
2240          * skip the cache.
2241          */
2242         if (dir->exclude_list_group[EXC_CMDL].nr)
2243                 return NULL;
2244
2245         if (!ident_in_untracked(dir->untracked)) {
2246                 warning(_("untracked cache is disabled on this system or location"));
2247                 return NULL;
2248         }
2249
2250         if (!dir->untracked->root) {
2251                 const int len = sizeof(*dir->untracked->root);
2252                 dir->untracked->root = xmalloc(len);
2253                 memset(dir->untracked->root, 0, len);
2254         }
2255
2256         /* Validate $GIT_DIR/info/exclude and core.excludesfile */
2257         root = dir->untracked->root;
2258         if (!oideq(&dir->ss_info_exclude.oid,
2259                    &dir->untracked->ss_info_exclude.oid)) {
2260                 invalidate_gitignore(dir->untracked, root);
2261                 dir->untracked->ss_info_exclude = dir->ss_info_exclude;
2262         }
2263         if (!oideq(&dir->ss_excludes_file.oid,
2264                    &dir->untracked->ss_excludes_file.oid)) {
2265                 invalidate_gitignore(dir->untracked, root);
2266                 dir->untracked->ss_excludes_file = dir->ss_excludes_file;
2267         }
2268
2269         /* Make sure this directory is not dropped out at saving phase */
2270         root->recurse = 1;
2271         return root;
2272 }
2273
2274 int read_directory(struct dir_struct *dir, struct index_state *istate,
2275                    const char *path, int len, const struct pathspec *pathspec)
2276 {
2277         struct untracked_cache_dir *untracked;
2278
2279         trace_performance_enter();
2280
2281         if (has_symlink_leading_path(path, len)) {
2282                 trace_performance_leave("read directory %.*s", len, path);
2283                 return dir->nr;
2284         }
2285
2286         untracked = validate_untracked_cache(dir, len, pathspec);
2287         if (!untracked)
2288                 /*
2289                  * make sure untracked cache code path is disabled,
2290                  * e.g. prep_exclude()
2291                  */
2292                 dir->untracked = NULL;
2293         if (!len || treat_leading_path(dir, istate, path, len, pathspec))
2294                 read_directory_recursive(dir, istate, path, len, untracked, 0, 0, pathspec);
2295         QSORT(dir->entries, dir->nr, cmp_dir_entry);
2296         QSORT(dir->ignored, dir->ignored_nr, cmp_dir_entry);
2297
2298         /*
2299          * If DIR_SHOW_IGNORED_TOO is set, read_directory_recursive() will
2300          * also pick up untracked contents of untracked dirs; by default
2301          * we discard these, but given DIR_KEEP_UNTRACKED_CONTENTS we do not.
2302          */
2303         if ((dir->flags & DIR_SHOW_IGNORED_TOO) &&
2304                      !(dir->flags & DIR_KEEP_UNTRACKED_CONTENTS)) {
2305                 int i, j;
2306
2307                 /* remove from dir->entries untracked contents of untracked dirs */
2308                 for (i = j = 0; j < dir->nr; j++) {
2309                         if (i &&
2310                             check_dir_entry_contains(dir->entries[i - 1], dir->entries[j])) {
2311                                 FREE_AND_NULL(dir->entries[j]);
2312                         } else {
2313                                 dir->entries[i++] = dir->entries[j];
2314                         }
2315                 }
2316
2317                 dir->nr = i;
2318         }
2319
2320         trace_performance_leave("read directory %.*s", len, path);
2321         if (dir->untracked) {
2322                 static int force_untracked_cache = -1;
2323                 static struct trace_key trace_untracked_stats = TRACE_KEY_INIT(UNTRACKED_STATS);
2324
2325                 if (force_untracked_cache < 0)
2326                         force_untracked_cache =
2327                                 git_env_bool("GIT_FORCE_UNTRACKED_CACHE", 0);
2328                 trace_printf_key(&trace_untracked_stats,
2329                                  "node creation: %u\n"
2330                                  "gitignore invalidation: %u\n"
2331                                  "directory invalidation: %u\n"
2332                                  "opendir: %u\n",
2333                                  dir->untracked->dir_created,
2334                                  dir->untracked->gitignore_invalidated,
2335                                  dir->untracked->dir_invalidated,
2336                                  dir->untracked->dir_opened);
2337                 if (force_untracked_cache &&
2338                         dir->untracked == istate->untracked &&
2339                     (dir->untracked->dir_opened ||
2340                      dir->untracked->gitignore_invalidated ||
2341                      dir->untracked->dir_invalidated))
2342                         istate->cache_changed |= UNTRACKED_CHANGED;
2343                 if (dir->untracked != istate->untracked) {
2344                         FREE_AND_NULL(dir->untracked);
2345                 }
2346         }
2347         return dir->nr;
2348 }
2349
2350 int file_exists(const char *f)
2351 {
2352         struct stat sb;
2353         return lstat(f, &sb) == 0;
2354 }
2355
2356 static int cmp_icase(char a, char b)
2357 {
2358         if (a == b)
2359                 return 0;
2360         if (ignore_case)
2361                 return toupper(a) - toupper(b);
2362         return a - b;
2363 }
2364
2365 /*
2366  * Given two normalized paths (a trailing slash is ok), if subdir is
2367  * outside dir, return -1.  Otherwise return the offset in subdir that
2368  * can be used as relative path to dir.
2369  */
2370 int dir_inside_of(const char *subdir, const char *dir)
2371 {
2372         int offset = 0;
2373
2374         assert(dir && subdir && *dir && *subdir);
2375
2376         while (*dir && *subdir && !cmp_icase(*dir, *subdir)) {
2377                 dir++;
2378                 subdir++;
2379                 offset++;
2380         }
2381
2382         /* hel[p]/me vs hel[l]/yeah */
2383         if (*dir && *subdir)
2384                 return -1;
2385
2386         if (!*subdir)
2387                 return !*dir ? offset : -1; /* same dir */
2388
2389         /* foo/[b]ar vs foo/[] */
2390         if (is_dir_sep(dir[-1]))
2391                 return is_dir_sep(subdir[-1]) ? offset : -1;
2392
2393         /* foo[/]bar vs foo[] */
2394         return is_dir_sep(*subdir) ? offset + 1 : -1;
2395 }
2396
2397 int is_inside_dir(const char *dir)
2398 {
2399         char *cwd;
2400         int rc;
2401
2402         if (!dir)
2403                 return 0;
2404
2405         cwd = xgetcwd();
2406         rc = (dir_inside_of(cwd, dir) >= 0);
2407         free(cwd);
2408         return rc;
2409 }
2410
2411 int is_empty_dir(const char *path)
2412 {
2413         DIR *dir = opendir(path);
2414         struct dirent *e;
2415         int ret = 1;
2416
2417         if (!dir)
2418                 return 0;
2419
2420         while ((e = readdir(dir)) != NULL)
2421                 if (!is_dot_or_dotdot(e->d_name)) {
2422                         ret = 0;
2423                         break;
2424                 }
2425
2426         closedir(dir);
2427         return ret;
2428 }
2429
2430 static int remove_dir_recurse(struct strbuf *path, int flag, int *kept_up)
2431 {
2432         DIR *dir;
2433         struct dirent *e;
2434         int ret = 0, original_len = path->len, len, kept_down = 0;
2435         int only_empty = (flag & REMOVE_DIR_EMPTY_ONLY);
2436         int keep_toplevel = (flag & REMOVE_DIR_KEEP_TOPLEVEL);
2437         struct object_id submodule_head;
2438
2439         if ((flag & REMOVE_DIR_KEEP_NESTED_GIT) &&
2440             !resolve_gitlink_ref(path->buf, "HEAD", &submodule_head)) {
2441                 /* Do not descend and nuke a nested git work tree. */
2442                 if (kept_up)
2443                         *kept_up = 1;
2444                 return 0;
2445         }
2446
2447         flag &= ~REMOVE_DIR_KEEP_TOPLEVEL;
2448         dir = opendir(path->buf);
2449         if (!dir) {
2450                 if (errno == ENOENT)
2451                         return keep_toplevel ? -1 : 0;
2452                 else if (errno == EACCES && !keep_toplevel)
2453                         /*
2454                          * An empty dir could be removable even if it
2455                          * is unreadable:
2456                          */
2457                         return rmdir(path->buf);
2458                 else
2459                         return -1;
2460         }
2461         strbuf_complete(path, '/');
2462
2463         len = path->len;
2464         while ((e = readdir(dir)) != NULL) {
2465                 struct stat st;
2466                 if (is_dot_or_dotdot(e->d_name))
2467                         continue;
2468
2469                 strbuf_setlen(path, len);
2470                 strbuf_addstr(path, e->d_name);
2471                 if (lstat(path->buf, &st)) {
2472                         if (errno == ENOENT)
2473                                 /*
2474                                  * file disappeared, which is what we
2475                                  * wanted anyway
2476                                  */
2477                                 continue;
2478                         /* fall thru */
2479                 } else if (S_ISDIR(st.st_mode)) {
2480                         if (!remove_dir_recurse(path, flag, &kept_down))
2481                                 continue; /* happy */
2482                 } else if (!only_empty &&
2483                            (!unlink(path->buf) || errno == ENOENT)) {
2484                         continue; /* happy, too */
2485                 }
2486
2487                 /* path too long, stat fails, or non-directory still exists */
2488                 ret = -1;
2489                 break;
2490         }
2491         closedir(dir);
2492
2493         strbuf_setlen(path, original_len);
2494         if (!ret && !keep_toplevel && !kept_down)
2495                 ret = (!rmdir(path->buf) || errno == ENOENT) ? 0 : -1;
2496         else if (kept_up)
2497                 /*
2498                  * report the uplevel that it is not an error that we
2499                  * did not rmdir() our directory.
2500                  */
2501                 *kept_up = !ret;
2502         return ret;
2503 }
2504
2505 int remove_dir_recursively(struct strbuf *path, int flag)
2506 {
2507         return remove_dir_recurse(path, flag, NULL);
2508 }
2509
2510 static GIT_PATH_FUNC(git_path_info_exclude, "info/exclude")
2511
2512 void setup_standard_excludes(struct dir_struct *dir)
2513 {
2514         dir->exclude_per_dir = ".gitignore";
2515
2516         /* core.excludesfile defaulting to $XDG_CONFIG_HOME/git/ignore */
2517         if (!excludes_file)
2518                 excludes_file = xdg_config_home("ignore");
2519         if (excludes_file && !access_or_warn(excludes_file, R_OK, 0))
2520                 add_excludes_from_file_1(dir, excludes_file,
2521                                          dir->untracked ? &dir->ss_excludes_file : NULL);
2522
2523         /* per repository user preference */
2524         if (startup_info->have_repository) {
2525                 const char *path = git_path_info_exclude();
2526                 if (!access_or_warn(path, R_OK, 0))
2527                         add_excludes_from_file_1(dir, path,
2528                                                  dir->untracked ? &dir->ss_info_exclude : NULL);
2529         }
2530 }
2531
2532 int remove_path(const char *name)
2533 {
2534         char *slash;
2535
2536         if (unlink(name) && !is_missing_file_error(errno))
2537                 return -1;
2538
2539         slash = strrchr(name, '/');
2540         if (slash) {
2541                 char *dirs = xstrdup(name);
2542                 slash = dirs + (slash - name);
2543                 do {
2544                         *slash = '\0';
2545                 } while (rmdir(dirs) == 0 && (slash = strrchr(dirs, '/')));
2546                 free(dirs);
2547         }
2548         return 0;
2549 }
2550
2551 /*
2552  * Frees memory within dir which was allocated for exclude lists and
2553  * the exclude_stack.  Does not free dir itself.
2554  */
2555 void clear_directory(struct dir_struct *dir)
2556 {
2557         int i, j;
2558         struct exclude_list_group *group;
2559         struct exclude_list *el;
2560         struct exclude_stack *stk;
2561
2562         for (i = EXC_CMDL; i <= EXC_FILE; i++) {
2563                 group = &dir->exclude_list_group[i];
2564                 for (j = 0; j < group->nr; j++) {
2565                         el = &group->el[j];
2566                         if (i == EXC_DIRS)
2567                                 free((char *)el->src);
2568                         clear_exclude_list(el);
2569                 }
2570                 free(group->el);
2571         }
2572
2573         stk = dir->exclude_stack;
2574         while (stk) {
2575                 struct exclude_stack *prev = stk->prev;
2576                 free(stk);
2577                 stk = prev;
2578         }
2579         strbuf_release(&dir->basebuf);
2580 }
2581
2582 struct ondisk_untracked_cache {
2583         struct stat_data info_exclude_stat;
2584         struct stat_data excludes_file_stat;
2585         uint32_t dir_flags;
2586         unsigned char info_exclude_sha1[20];
2587         unsigned char excludes_file_sha1[20];
2588         char exclude_per_dir[FLEX_ARRAY];
2589 };
2590
2591 #define ouc_offset(x) offsetof(struct ondisk_untracked_cache, x)
2592 #define ouc_size(len) (ouc_offset(exclude_per_dir) + len + 1)
2593
2594 struct write_data {
2595         int index;         /* number of written untracked_cache_dir */
2596         struct ewah_bitmap *check_only; /* from untracked_cache_dir */
2597         struct ewah_bitmap *valid;      /* from untracked_cache_dir */
2598         struct ewah_bitmap *sha1_valid; /* set if exclude_sha1 is not null */
2599         struct strbuf out;
2600         struct strbuf sb_stat;
2601         struct strbuf sb_sha1;
2602 };
2603
2604 static void stat_data_to_disk(struct stat_data *to, const struct stat_data *from)
2605 {
2606         to->sd_ctime.sec  = htonl(from->sd_ctime.sec);
2607         to->sd_ctime.nsec = htonl(from->sd_ctime.nsec);
2608         to->sd_mtime.sec  = htonl(from->sd_mtime.sec);
2609         to->sd_mtime.nsec = htonl(from->sd_mtime.nsec);
2610         to->sd_dev        = htonl(from->sd_dev);
2611         to->sd_ino        = htonl(from->sd_ino);
2612         to->sd_uid        = htonl(from->sd_uid);
2613         to->sd_gid        = htonl(from->sd_gid);
2614         to->sd_size       = htonl(from->sd_size);
2615 }
2616
2617 static void write_one_dir(struct untracked_cache_dir *untracked,
2618                           struct write_data *wd)
2619 {
2620         struct stat_data stat_data;
2621         struct strbuf *out = &wd->out;
2622         unsigned char intbuf[16];
2623         unsigned int intlen, value;
2624         int i = wd->index++;
2625
2626         /*
2627          * untracked_nr should be reset whenever valid is clear, but
2628          * for safety..
2629          */
2630         if (!untracked->valid) {
2631                 untracked->untracked_nr = 0;
2632                 untracked->check_only = 0;
2633         }
2634
2635         if (untracked->check_only)
2636                 ewah_set(wd->check_only, i);
2637         if (untracked->valid) {
2638                 ewah_set(wd->valid, i);
2639                 stat_data_to_disk(&stat_data, &untracked->stat_data);
2640                 strbuf_add(&wd->sb_stat, &stat_data, sizeof(stat_data));
2641         }
2642         if (!is_null_oid(&untracked->exclude_oid)) {
2643                 ewah_set(wd->sha1_valid, i);
2644                 strbuf_add(&wd->sb_sha1, untracked->exclude_oid.hash,
2645                            the_hash_algo->rawsz);
2646         }
2647
2648         intlen = encode_varint(untracked->untracked_nr, intbuf);
2649         strbuf_add(out, intbuf, intlen);
2650
2651         /* skip non-recurse directories */
2652         for (i = 0, value = 0; i < untracked->dirs_nr; i++)
2653                 if (untracked->dirs[i]->recurse)
2654                         value++;
2655         intlen = encode_varint(value, intbuf);
2656         strbuf_add(out, intbuf, intlen);
2657
2658         strbuf_add(out, untracked->name, strlen(untracked->name) + 1);
2659
2660         for (i = 0; i < untracked->untracked_nr; i++)
2661                 strbuf_add(out, untracked->untracked[i],
2662                            strlen(untracked->untracked[i]) + 1);
2663
2664         for (i = 0; i < untracked->dirs_nr; i++)
2665                 if (untracked->dirs[i]->recurse)
2666                         write_one_dir(untracked->dirs[i], wd);
2667 }
2668
2669 void write_untracked_extension(struct strbuf *out, struct untracked_cache *untracked)
2670 {
2671         struct ondisk_untracked_cache *ouc;
2672         struct write_data wd;
2673         unsigned char varbuf[16];
2674         int varint_len;
2675         size_t len = strlen(untracked->exclude_per_dir);
2676
2677         FLEX_ALLOC_MEM(ouc, exclude_per_dir, untracked->exclude_per_dir, len);
2678         stat_data_to_disk(&ouc->info_exclude_stat, &untracked->ss_info_exclude.stat);
2679         stat_data_to_disk(&ouc->excludes_file_stat, &untracked->ss_excludes_file.stat);
2680         hashcpy(ouc->info_exclude_sha1, untracked->ss_info_exclude.oid.hash);
2681         hashcpy(ouc->excludes_file_sha1, untracked->ss_excludes_file.oid.hash);
2682         ouc->dir_flags = htonl(untracked->dir_flags);
2683
2684         varint_len = encode_varint(untracked->ident.len, varbuf);
2685         strbuf_add(out, varbuf, varint_len);
2686         strbuf_addbuf(out, &untracked->ident);
2687
2688         strbuf_add(out, ouc, ouc_size(len));
2689         FREE_AND_NULL(ouc);
2690
2691         if (!untracked->root) {
2692                 varint_len = encode_varint(0, varbuf);
2693                 strbuf_add(out, varbuf, varint_len);
2694                 return;
2695         }
2696
2697         wd.index      = 0;
2698         wd.check_only = ewah_new();
2699         wd.valid      = ewah_new();
2700         wd.sha1_valid = ewah_new();
2701         strbuf_init(&wd.out, 1024);
2702         strbuf_init(&wd.sb_stat, 1024);
2703         strbuf_init(&wd.sb_sha1, 1024);
2704         write_one_dir(untracked->root, &wd);
2705
2706         varint_len = encode_varint(wd.index, varbuf);
2707         strbuf_add(out, varbuf, varint_len);
2708         strbuf_addbuf(out, &wd.out);
2709         ewah_serialize_strbuf(wd.valid, out);
2710         ewah_serialize_strbuf(wd.check_only, out);
2711         ewah_serialize_strbuf(wd.sha1_valid, out);
2712         strbuf_addbuf(out, &wd.sb_stat);
2713         strbuf_addbuf(out, &wd.sb_sha1);
2714         strbuf_addch(out, '\0'); /* safe guard for string lists */
2715
2716         ewah_free(wd.valid);
2717         ewah_free(wd.check_only);
2718         ewah_free(wd.sha1_valid);
2719         strbuf_release(&wd.out);
2720         strbuf_release(&wd.sb_stat);
2721         strbuf_release(&wd.sb_sha1);
2722 }
2723
2724 static void free_untracked(struct untracked_cache_dir *ucd)
2725 {
2726         int i;
2727         if (!ucd)
2728                 return;
2729         for (i = 0; i < ucd->dirs_nr; i++)
2730                 free_untracked(ucd->dirs[i]);
2731         for (i = 0; i < ucd->untracked_nr; i++)
2732                 free(ucd->untracked[i]);
2733         free(ucd->untracked);
2734         free(ucd->dirs);
2735         free(ucd);
2736 }
2737
2738 void free_untracked_cache(struct untracked_cache *uc)
2739 {
2740         if (uc)
2741                 free_untracked(uc->root);
2742         free(uc);
2743 }
2744
2745 struct read_data {
2746         int index;
2747         struct untracked_cache_dir **ucd;
2748         struct ewah_bitmap *check_only;
2749         struct ewah_bitmap *valid;
2750         struct ewah_bitmap *sha1_valid;
2751         const unsigned char *data;
2752         const unsigned char *end;
2753 };
2754
2755 static void stat_data_from_disk(struct stat_data *to, const unsigned char *data)
2756 {
2757         memcpy(to, data, sizeof(*to));
2758         to->sd_ctime.sec  = ntohl(to->sd_ctime.sec);
2759         to->sd_ctime.nsec = ntohl(to->sd_ctime.nsec);
2760         to->sd_mtime.sec  = ntohl(to->sd_mtime.sec);
2761         to->sd_mtime.nsec = ntohl(to->sd_mtime.nsec);
2762         to->sd_dev        = ntohl(to->sd_dev);
2763         to->sd_ino        = ntohl(to->sd_ino);
2764         to->sd_uid        = ntohl(to->sd_uid);
2765         to->sd_gid        = ntohl(to->sd_gid);
2766         to->sd_size       = ntohl(to->sd_size);
2767 }
2768
2769 static int read_one_dir(struct untracked_cache_dir **untracked_,
2770                         struct read_data *rd)
2771 {
2772         struct untracked_cache_dir ud, *untracked;
2773         const unsigned char *next, *data = rd->data, *end = rd->end;
2774         unsigned int value;
2775         int i, len;
2776
2777         memset(&ud, 0, sizeof(ud));
2778
2779         next = data;
2780         value = decode_varint(&next);
2781         if (next > end)
2782                 return -1;
2783         ud.recurse         = 1;
2784         ud.untracked_alloc = value;
2785         ud.untracked_nr    = value;
2786         if (ud.untracked_nr)
2787                 ALLOC_ARRAY(ud.untracked, ud.untracked_nr);
2788         data = next;
2789
2790         next = data;
2791         ud.dirs_alloc = ud.dirs_nr = decode_varint(&next);
2792         if (next > end)
2793                 return -1;
2794         ALLOC_ARRAY(ud.dirs, ud.dirs_nr);
2795         data = next;
2796
2797         len = strlen((const char *)data);
2798         next = data + len + 1;
2799         if (next > rd->end)
2800                 return -1;
2801         *untracked_ = untracked = xmalloc(st_add(sizeof(*untracked), len));
2802         memcpy(untracked, &ud, sizeof(ud));
2803         memcpy(untracked->name, data, len + 1);
2804         data = next;
2805
2806         for (i = 0; i < untracked->untracked_nr; i++) {
2807                 len = strlen((const char *)data);
2808                 next = data + len + 1;
2809                 if (next > rd->end)
2810                         return -1;
2811                 untracked->untracked[i] = xstrdup((const char*)data);
2812                 data = next;
2813         }
2814
2815         rd->ucd[rd->index++] = untracked;
2816         rd->data = data;
2817
2818         for (i = 0; i < untracked->dirs_nr; i++) {
2819                 len = read_one_dir(untracked->dirs + i, rd);
2820                 if (len < 0)
2821                         return -1;
2822         }
2823         return 0;
2824 }
2825
2826 static void set_check_only(size_t pos, void *cb)
2827 {
2828         struct read_data *rd = cb;
2829         struct untracked_cache_dir *ud = rd->ucd[pos];
2830         ud->check_only = 1;
2831 }
2832
2833 static void read_stat(size_t pos, void *cb)
2834 {
2835         struct read_data *rd = cb;
2836         struct untracked_cache_dir *ud = rd->ucd[pos];
2837         if (rd->data + sizeof(struct stat_data) > rd->end) {
2838                 rd->data = rd->end + 1;
2839                 return;
2840         }
2841         stat_data_from_disk(&ud->stat_data, rd->data);
2842         rd->data += sizeof(struct stat_data);
2843         ud->valid = 1;
2844 }
2845
2846 static void read_oid(size_t pos, void *cb)
2847 {
2848         struct read_data *rd = cb;
2849         struct untracked_cache_dir *ud = rd->ucd[pos];
2850         if (rd->data + the_hash_algo->rawsz > rd->end) {
2851                 rd->data = rd->end + 1;
2852                 return;
2853         }
2854         hashcpy(ud->exclude_oid.hash, rd->data);
2855         rd->data += the_hash_algo->rawsz;
2856 }
2857
2858 static void load_oid_stat(struct oid_stat *oid_stat, const unsigned char *data,
2859                           const unsigned char *sha1)
2860 {
2861         stat_data_from_disk(&oid_stat->stat, data);
2862         hashcpy(oid_stat->oid.hash, sha1);
2863         oid_stat->valid = 1;
2864 }
2865
2866 struct untracked_cache *read_untracked_extension(const void *data, unsigned long sz)
2867 {
2868         struct untracked_cache *uc;
2869         struct read_data rd;
2870         const unsigned char *next = data, *end = (const unsigned char *)data + sz;
2871         const char *ident;
2872         int ident_len;
2873         ssize_t len;
2874         const char *exclude_per_dir;
2875
2876         if (sz <= 1 || end[-1] != '\0')
2877                 return NULL;
2878         end--;
2879
2880         ident_len = decode_varint(&next);
2881         if (next + ident_len > end)
2882                 return NULL;
2883         ident = (const char *)next;
2884         next += ident_len;
2885
2886         if (next + ouc_size(0) > end)
2887                 return NULL;
2888
2889         uc = xcalloc(1, sizeof(*uc));
2890         strbuf_init(&uc->ident, ident_len);
2891         strbuf_add(&uc->ident, ident, ident_len);
2892         load_oid_stat(&uc->ss_info_exclude,
2893                       next + ouc_offset(info_exclude_stat),
2894                       next + ouc_offset(info_exclude_sha1));
2895         load_oid_stat(&uc->ss_excludes_file,
2896                       next + ouc_offset(excludes_file_stat),
2897                       next + ouc_offset(excludes_file_sha1));
2898         uc->dir_flags = get_be32(next + ouc_offset(dir_flags));
2899         exclude_per_dir = (const char *)next + ouc_offset(exclude_per_dir);
2900         uc->exclude_per_dir = xstrdup(exclude_per_dir);
2901         /* NUL after exclude_per_dir is covered by sizeof(*ouc) */
2902         next += ouc_size(strlen(exclude_per_dir));
2903         if (next >= end)
2904                 goto done2;
2905
2906         len = decode_varint(&next);
2907         if (next > end || len == 0)
2908                 goto done2;
2909
2910         rd.valid      = ewah_new();
2911         rd.check_only = ewah_new();
2912         rd.sha1_valid = ewah_new();
2913         rd.data       = next;
2914         rd.end        = end;
2915         rd.index      = 0;
2916         ALLOC_ARRAY(rd.ucd, len);
2917
2918         if (read_one_dir(&uc->root, &rd) || rd.index != len)
2919                 goto done;
2920
2921         next = rd.data;
2922         len = ewah_read_mmap(rd.valid, next, end - next);
2923         if (len < 0)
2924                 goto done;
2925
2926         next += len;
2927         len = ewah_read_mmap(rd.check_only, next, end - next);
2928         if (len < 0)
2929                 goto done;
2930
2931         next += len;
2932         len = ewah_read_mmap(rd.sha1_valid, next, end - next);
2933         if (len < 0)
2934                 goto done;
2935
2936         ewah_each_bit(rd.check_only, set_check_only, &rd);
2937         rd.data = next + len;
2938         ewah_each_bit(rd.valid, read_stat, &rd);
2939         ewah_each_bit(rd.sha1_valid, read_oid, &rd);
2940         next = rd.data;
2941
2942 done:
2943         free(rd.ucd);
2944         ewah_free(rd.valid);
2945         ewah_free(rd.check_only);
2946         ewah_free(rd.sha1_valid);
2947 done2:
2948         if (next != end) {
2949                 free_untracked_cache(uc);
2950                 uc = NULL;
2951         }
2952         return uc;
2953 }
2954
2955 static void invalidate_one_directory(struct untracked_cache *uc,
2956                                      struct untracked_cache_dir *ucd)
2957 {
2958         uc->dir_invalidated++;
2959         ucd->valid = 0;
2960         ucd->untracked_nr = 0;
2961 }
2962
2963 /*
2964  * Normally when an entry is added or removed from a directory,
2965  * invalidating that directory is enough. No need to touch its
2966  * ancestors. When a directory is shown as "foo/bar/" in git-status
2967  * however, deleting or adding an entry may have cascading effect.
2968  *
2969  * Say the "foo/bar/file" has become untracked, we need to tell the
2970  * untracked_cache_dir of "foo" that "bar/" is not an untracked
2971  * directory any more (because "bar" is managed by foo as an untracked
2972  * "file").
2973  *
2974  * Similarly, if "foo/bar/file" moves from untracked to tracked and it
2975  * was the last untracked entry in the entire "foo", we should show
2976  * "foo/" instead. Which means we have to invalidate past "bar" up to
2977  * "foo".
2978  *
2979  * This function traverses all directories from root to leaf. If there
2980  * is a chance of one of the above cases happening, we invalidate back
2981  * to root. Otherwise we just invalidate the leaf. There may be a more
2982  * sophisticated way than checking for SHOW_OTHER_DIRECTORIES to
2983  * detect these cases and avoid unnecessary invalidation, for example,
2984  * checking for the untracked entry named "bar/" in "foo", but for now
2985  * stick to something safe and simple.
2986  */
2987 static int invalidate_one_component(struct untracked_cache *uc,
2988                                     struct untracked_cache_dir *dir,
2989                                     const char *path, int len)
2990 {
2991         const char *rest = strchr(path, '/');
2992
2993         if (rest) {
2994                 int component_len = rest - path;
2995                 struct untracked_cache_dir *d =
2996                         lookup_untracked(uc, dir, path, component_len);
2997                 int ret =
2998                         invalidate_one_component(uc, d, rest + 1,
2999                                                  len - (component_len + 1));
3000                 if (ret)
3001                         invalidate_one_directory(uc, dir);
3002                 return ret;
3003         }
3004
3005         invalidate_one_directory(uc, dir);
3006         return uc->dir_flags & DIR_SHOW_OTHER_DIRECTORIES;
3007 }
3008
3009 void untracked_cache_invalidate_path(struct index_state *istate,
3010                                      const char *path, int safe_path)
3011 {
3012         if (!istate->untracked || !istate->untracked->root)
3013                 return;
3014         if (!safe_path && !verify_path(path, 0))
3015                 return;
3016         invalidate_one_component(istate->untracked, istate->untracked->root,
3017                                  path, strlen(path));
3018 }
3019
3020 void untracked_cache_remove_from_index(struct index_state *istate,
3021                                        const char *path)
3022 {
3023         untracked_cache_invalidate_path(istate, path, 1);
3024 }
3025
3026 void untracked_cache_add_to_index(struct index_state *istate,
3027                                   const char *path)
3028 {
3029         untracked_cache_invalidate_path(istate, path, 1);
3030 }
3031
3032 static void connect_wt_gitdir_in_nested(const char *sub_worktree,
3033                                         const char *sub_gitdir)
3034 {
3035         int i;
3036         struct repository subrepo;
3037         struct strbuf sub_wt = STRBUF_INIT;
3038         struct strbuf sub_gd = STRBUF_INIT;
3039
3040         const struct submodule *sub;
3041
3042         /* If the submodule has no working tree, we can ignore it. */
3043         if (repo_init(&subrepo, sub_gitdir, sub_worktree))
3044                 return;
3045
3046         if (repo_read_index(&subrepo) < 0)
3047                 die(_("index file corrupt in repo %s"), subrepo.gitdir);
3048
3049         for (i = 0; i < subrepo.index->cache_nr; i++) {
3050                 const struct cache_entry *ce = subrepo.index->cache[i];
3051
3052                 if (!S_ISGITLINK(ce->ce_mode))
3053                         continue;
3054
3055                 while (i + 1 < subrepo.index->cache_nr &&
3056                        !strcmp(ce->name, subrepo.index->cache[i + 1]->name))
3057                         /*
3058                          * Skip entries with the same name in different stages
3059                          * to make sure an entry is returned only once.
3060                          */
3061                         i++;
3062
3063                 sub = submodule_from_path(&subrepo, &null_oid, ce->name);
3064                 if (!sub || !is_submodule_active(&subrepo, ce->name))
3065                         /* .gitmodules broken or inactive sub */
3066                         continue;
3067
3068                 strbuf_reset(&sub_wt);
3069                 strbuf_reset(&sub_gd);
3070                 strbuf_addf(&sub_wt, "%s/%s", sub_worktree, sub->path);
3071                 strbuf_addf(&sub_gd, "%s/modules/%s", sub_gitdir, sub->name);
3072
3073                 connect_work_tree_and_git_dir(sub_wt.buf, sub_gd.buf, 1);
3074         }
3075         strbuf_release(&sub_wt);
3076         strbuf_release(&sub_gd);
3077         repo_clear(&subrepo);
3078 }
3079
3080 void connect_work_tree_and_git_dir(const char *work_tree_,
3081                                    const char *git_dir_,
3082                                    int recurse_into_nested)
3083 {
3084         struct strbuf gitfile_sb = STRBUF_INIT;
3085         struct strbuf cfg_sb = STRBUF_INIT;
3086         struct strbuf rel_path = STRBUF_INIT;
3087         char *git_dir, *work_tree;
3088
3089         /* Prepare .git file */
3090         strbuf_addf(&gitfile_sb, "%s/.git", work_tree_);
3091         if (safe_create_leading_directories_const(gitfile_sb.buf))
3092                 die(_("could not create directories for %s"), gitfile_sb.buf);
3093
3094         /* Prepare config file */
3095         strbuf_addf(&cfg_sb, "%s/config", git_dir_);
3096         if (safe_create_leading_directories_const(cfg_sb.buf))
3097                 die(_("could not create directories for %s"), cfg_sb.buf);
3098
3099         git_dir = real_pathdup(git_dir_, 1);
3100         work_tree = real_pathdup(work_tree_, 1);
3101
3102         /* Write .git file */
3103         write_file(gitfile_sb.buf, "gitdir: %s",
3104                    relative_path(git_dir, work_tree, &rel_path));
3105         /* Update core.worktree setting */
3106         git_config_set_in_file(cfg_sb.buf, "core.worktree",
3107                                relative_path(work_tree, git_dir, &rel_path));
3108
3109         strbuf_release(&gitfile_sb);
3110         strbuf_release(&cfg_sb);
3111         strbuf_release(&rel_path);
3112
3113         if (recurse_into_nested)
3114                 connect_wt_gitdir_in_nested(work_tree, git_dir);
3115
3116         free(work_tree);
3117         free(git_dir);
3118 }
3119
3120 /*
3121  * Migrate the git directory of the given path from old_git_dir to new_git_dir.
3122  */
3123 void relocate_gitdir(const char *path, const char *old_git_dir, const char *new_git_dir)
3124 {
3125         if (rename(old_git_dir, new_git_dir) < 0)
3126                 die_errno(_("could not migrate git directory from '%s' to '%s'"),
3127                         old_git_dir, new_git_dir);
3128
3129         connect_work_tree_and_git_dir(path, new_git_dir, 0);
3130 }