Git 2.19.5
[git] / builtin / ls-files.c
1 /*
2  * This merges the file listing in the directory cache index
3  * with the actual working directory list, and shows different
4  * combinations of the two.
5  *
6  * Copyright (C) Linus Torvalds, 2005
7  */
8 #define NO_THE_INDEX_COMPATIBILITY_MACROS
9 #include "cache.h"
10 #include "repository.h"
11 #include "config.h"
12 #include "quote.h"
13 #include "dir.h"
14 #include "builtin.h"
15 #include "tree.h"
16 #include "parse-options.h"
17 #include "resolve-undo.h"
18 #include "string-list.h"
19 #include "pathspec.h"
20 #include "run-command.h"
21 #include "submodule.h"
22 #include "submodule-config.h"
23
24 static int abbrev;
25 static int show_deleted;
26 static int show_cached;
27 static int show_others;
28 static int show_stage;
29 static int show_unmerged;
30 static int show_resolve_undo;
31 static int show_modified;
32 static int show_killed;
33 static int show_valid_bit;
34 static int show_fsmonitor_bit;
35 static int line_terminator = '\n';
36 static int debug_mode;
37 static int show_eol;
38 static int recurse_submodules;
39
40 static const char *prefix;
41 static int max_prefix_len;
42 static int prefix_len;
43 static struct pathspec pathspec;
44 static int error_unmatch;
45 static char *ps_matched;
46 static const char *with_tree;
47 static int exc_given;
48 static int exclude_args;
49
50 static const char *tag_cached = "";
51 static const char *tag_unmerged = "";
52 static const char *tag_removed = "";
53 static const char *tag_other = "";
54 static const char *tag_killed = "";
55 static const char *tag_modified = "";
56 static const char *tag_skip_worktree = "";
57 static const char *tag_resolve_undo = "";
58
59 static void write_eolinfo(const struct index_state *istate,
60                           const struct cache_entry *ce, const char *path)
61 {
62         if (show_eol) {
63                 struct stat st;
64                 const char *i_txt = "";
65                 const char *w_txt = "";
66                 const char *a_txt = get_convert_attr_ascii(istate, path);
67                 if (ce && S_ISREG(ce->ce_mode))
68                         i_txt = get_cached_convert_stats_ascii(istate,
69                                                                ce->name);
70                 if (!lstat(path, &st) && S_ISREG(st.st_mode))
71                         w_txt = get_wt_convert_stats_ascii(path);
72                 printf("i/%-5s w/%-5s attr/%-17s\t", i_txt, w_txt, a_txt);
73         }
74 }
75
76 static void write_name(const char *name)
77 {
78         /*
79          * With "--full-name", prefix_len=0; this caller needs to pass
80          * an empty string in that case (a NULL is good for "").
81          */
82         write_name_quoted_relative(name, prefix_len ? prefix : NULL,
83                                    stdout, line_terminator);
84 }
85
86 static const char *get_tag(const struct cache_entry *ce, const char *tag)
87 {
88         static char alttag[4];
89
90         if (tag && *tag && ((show_valid_bit && (ce->ce_flags & CE_VALID)) ||
91                 (show_fsmonitor_bit && (ce->ce_flags & CE_FSMONITOR_VALID)))) {
92                 memcpy(alttag, tag, 3);
93
94                 if (isalpha(tag[0])) {
95                         alttag[0] = tolower(tag[0]);
96                 } else if (tag[0] == '?') {
97                         alttag[0] = '!';
98                 } else {
99                         alttag[0] = 'v';
100                         alttag[1] = tag[0];
101                         alttag[2] = ' ';
102                         alttag[3] = 0;
103                 }
104
105                 tag = alttag;
106         }
107
108         return tag;
109 }
110
111 static void print_debug(const struct cache_entry *ce)
112 {
113         if (debug_mode) {
114                 const struct stat_data *sd = &ce->ce_stat_data;
115
116                 printf("  ctime: %d:%d\n", sd->sd_ctime.sec, sd->sd_ctime.nsec);
117                 printf("  mtime: %d:%d\n", sd->sd_mtime.sec, sd->sd_mtime.nsec);
118                 printf("  dev: %d\tino: %d\n", sd->sd_dev, sd->sd_ino);
119                 printf("  uid: %d\tgid: %d\n", sd->sd_uid, sd->sd_gid);
120                 printf("  size: %d\tflags: %x\n", sd->sd_size, ce->ce_flags);
121         }
122 }
123
124 static void show_dir_entry(const struct index_state *istate,
125                            const char *tag, struct dir_entry *ent)
126 {
127         int len = max_prefix_len;
128
129         if (len > ent->len)
130                 die("git ls-files: internal error - directory entry not superset of prefix");
131
132         if (!dir_path_match(istate, ent, &pathspec, len, ps_matched))
133                 return;
134
135         fputs(tag, stdout);
136         write_eolinfo(istate, NULL, ent->name);
137         write_name(ent->name);
138 }
139
140 static void show_other_files(const struct index_state *istate,
141                              const struct dir_struct *dir)
142 {
143         int i;
144
145         for (i = 0; i < dir->nr; i++) {
146                 struct dir_entry *ent = dir->entries[i];
147                 if (!index_name_is_other(istate, ent->name, ent->len))
148                         continue;
149                 show_dir_entry(istate, tag_other, ent);
150         }
151 }
152
153 static void show_killed_files(const struct index_state *istate,
154                               const struct dir_struct *dir)
155 {
156         int i;
157         for (i = 0; i < dir->nr; i++) {
158                 struct dir_entry *ent = dir->entries[i];
159                 char *cp, *sp;
160                 int pos, len, killed = 0;
161
162                 for (cp = ent->name; cp - ent->name < ent->len; cp = sp + 1) {
163                         sp = strchr(cp, '/');
164                         if (!sp) {
165                                 /* If ent->name is prefix of an entry in the
166                                  * cache, it will be killed.
167                                  */
168                                 pos = index_name_pos(istate, ent->name, ent->len);
169                                 if (0 <= pos)
170                                         BUG("killed-file %.*s not found",
171                                                 ent->len, ent->name);
172                                 pos = -pos - 1;
173                                 while (pos < istate->cache_nr &&
174                                        ce_stage(istate->cache[pos]))
175                                         pos++; /* skip unmerged */
176                                 if (istate->cache_nr <= pos)
177                                         break;
178                                 /* pos points at a name immediately after
179                                  * ent->name in the cache.  Does it expect
180                                  * ent->name to be a directory?
181                                  */
182                                 len = ce_namelen(istate->cache[pos]);
183                                 if ((ent->len < len) &&
184                                     !strncmp(istate->cache[pos]->name,
185                                              ent->name, ent->len) &&
186                                     istate->cache[pos]->name[ent->len] == '/')
187                                         killed = 1;
188                                 break;
189                         }
190                         if (0 <= index_name_pos(istate, ent->name, sp - ent->name)) {
191                                 /* If any of the leading directories in
192                                  * ent->name is registered in the cache,
193                                  * ent->name will be killed.
194                                  */
195                                 killed = 1;
196                                 break;
197                         }
198                 }
199                 if (killed)
200                         show_dir_entry(istate, tag_killed, dir->entries[i]);
201         }
202 }
203
204 static void show_files(struct repository *repo, struct dir_struct *dir);
205
206 static void show_submodule(struct repository *superproject,
207                            struct dir_struct *dir, const char *path)
208 {
209         struct repository submodule;
210
211         if (repo_submodule_init(&submodule, superproject, path))
212                 return;
213
214         if (repo_read_index(&submodule) < 0)
215                 die("index file corrupt");
216
217         show_files(&submodule, dir);
218
219         repo_clear(&submodule);
220 }
221
222 static void show_ce(struct repository *repo, struct dir_struct *dir,
223                     const struct cache_entry *ce, const char *fullname,
224                     const char *tag)
225 {
226         if (max_prefix_len > strlen(fullname))
227                 die("git ls-files: internal error - cache entry not superset of prefix");
228
229         if (recurse_submodules && S_ISGITLINK(ce->ce_mode) &&
230             is_submodule_active(repo, ce->name)) {
231                 show_submodule(repo, dir, ce->name);
232         } else if (match_pathspec(repo->index, &pathspec, fullname, strlen(fullname),
233                                   max_prefix_len, ps_matched,
234                                   S_ISDIR(ce->ce_mode) ||
235                                   S_ISGITLINK(ce->ce_mode))) {
236                 tag = get_tag(ce, tag);
237
238                 if (!show_stage) {
239                         fputs(tag, stdout);
240                 } else {
241                         printf("%s%06o %s %d\t",
242                                tag,
243                                ce->ce_mode,
244                                find_unique_abbrev(&ce->oid, abbrev),
245                                ce_stage(ce));
246                 }
247                 write_eolinfo(repo->index, ce, fullname);
248                 write_name(fullname);
249                 print_debug(ce);
250         }
251 }
252
253 static void show_ru_info(const struct index_state *istate)
254 {
255         struct string_list_item *item;
256
257         if (!istate->resolve_undo)
258                 return;
259
260         for_each_string_list_item(item, istate->resolve_undo) {
261                 const char *path = item->string;
262                 struct resolve_undo_info *ui = item->util;
263                 int i, len;
264
265                 len = strlen(path);
266                 if (len < max_prefix_len)
267                         continue; /* outside of the prefix */
268                 if (!match_pathspec(istate, &pathspec, path, len,
269                                     max_prefix_len, ps_matched, 0))
270                         continue; /* uninterested */
271                 for (i = 0; i < 3; i++) {
272                         if (!ui->mode[i])
273                                 continue;
274                         printf("%s%06o %s %d\t", tag_resolve_undo, ui->mode[i],
275                                find_unique_abbrev(&ui->oid[i], abbrev),
276                                i + 1);
277                         write_name(path);
278                 }
279         }
280 }
281
282 static int ce_excluded(struct dir_struct *dir, struct index_state *istate,
283                        const char *fullname, const struct cache_entry *ce)
284 {
285         int dtype = ce_to_dtype(ce);
286         return is_excluded(dir, istate, fullname, &dtype);
287 }
288
289 static void construct_fullname(struct strbuf *out, const struct repository *repo,
290                                const struct cache_entry *ce)
291 {
292         strbuf_reset(out);
293         if (repo->submodule_prefix)
294                 strbuf_addstr(out, repo->submodule_prefix);
295         strbuf_addstr(out, ce->name);
296 }
297
298 static void show_files(struct repository *repo, struct dir_struct *dir)
299 {
300         int i;
301         struct strbuf fullname = STRBUF_INIT;
302
303         /* For cached/deleted files we don't need to even do the readdir */
304         if (show_others || show_killed) {
305                 if (!show_others)
306                         dir->flags |= DIR_COLLECT_KILLED_ONLY;
307                 fill_directory(dir, repo->index, &pathspec);
308                 if (show_others)
309                         show_other_files(repo->index, dir);
310                 if (show_killed)
311                         show_killed_files(repo->index, dir);
312         }
313         if (show_cached || show_stage) {
314                 for (i = 0; i < repo->index->cache_nr; i++) {
315                         const struct cache_entry *ce = repo->index->cache[i];
316
317                         construct_fullname(&fullname, repo, ce);
318
319                         if ((dir->flags & DIR_SHOW_IGNORED) &&
320                             !ce_excluded(dir, repo->index, fullname.buf, ce))
321                                 continue;
322                         if (show_unmerged && !ce_stage(ce))
323                                 continue;
324                         if (ce->ce_flags & CE_UPDATE)
325                                 continue;
326                         show_ce(repo, dir, ce, fullname.buf,
327                                 ce_stage(ce) ? tag_unmerged :
328                                 (ce_skip_worktree(ce) ? tag_skip_worktree :
329                                  tag_cached));
330                 }
331         }
332         if (show_deleted || show_modified) {
333                 for (i = 0; i < repo->index->cache_nr; i++) {
334                         const struct cache_entry *ce = repo->index->cache[i];
335                         struct stat st;
336                         int err;
337
338                         construct_fullname(&fullname, repo, ce);
339
340                         if ((dir->flags & DIR_SHOW_IGNORED) &&
341                             !ce_excluded(dir, repo->index, fullname.buf, ce))
342                                 continue;
343                         if (ce->ce_flags & CE_UPDATE)
344                                 continue;
345                         if (ce_skip_worktree(ce))
346                                 continue;
347                         err = lstat(fullname.buf, &st);
348                         if (show_deleted && err)
349                                 show_ce(repo, dir, ce, fullname.buf, tag_removed);
350                         if (show_modified && ie_modified(repo->index, ce, &st, 0))
351                                 show_ce(repo, dir, ce, fullname.buf, tag_modified);
352                 }
353         }
354
355         strbuf_release(&fullname);
356 }
357
358 /*
359  * Prune the index to only contain stuff starting with "prefix"
360  */
361 static void prune_index(struct index_state *istate,
362                         const char *prefix, size_t prefixlen)
363 {
364         int pos;
365         unsigned int first, last;
366
367         if (!prefix || !istate->cache_nr)
368                 return;
369         pos = index_name_pos(istate, prefix, prefixlen);
370         if (pos < 0)
371                 pos = -pos-1;
372         first = pos;
373         last = istate->cache_nr;
374         while (last > first) {
375                 int next = (last + first) >> 1;
376                 const struct cache_entry *ce = istate->cache[next];
377                 if (!strncmp(ce->name, prefix, prefixlen)) {
378                         first = next+1;
379                         continue;
380                 }
381                 last = next;
382         }
383         MOVE_ARRAY(istate->cache, istate->cache + pos, last - pos);
384         istate->cache_nr = last - pos;
385 }
386
387 static int get_common_prefix_len(const char *common_prefix)
388 {
389         int common_prefix_len;
390
391         if (!common_prefix)
392                 return 0;
393
394         common_prefix_len = strlen(common_prefix);
395
396         /*
397          * If the prefix has a trailing slash, strip it so that submodules wont
398          * be pruned from the index.
399          */
400         if (common_prefix[common_prefix_len - 1] == '/')
401                 common_prefix_len--;
402
403         return common_prefix_len;
404 }
405
406 /*
407  * Read the tree specified with --with-tree option
408  * (typically, HEAD) into stage #1 and then
409  * squash them down to stage #0.  This is used for
410  * --error-unmatch to list and check the path patterns
411  * that were given from the command line.  We are not
412  * going to write this index out.
413  */
414 void overlay_tree_on_index(struct index_state *istate,
415                            const char *tree_name, const char *prefix)
416 {
417         struct tree *tree;
418         struct object_id oid;
419         struct pathspec pathspec;
420         struct cache_entry *last_stage0 = NULL;
421         int i;
422
423         if (get_oid(tree_name, &oid))
424                 die("tree-ish %s not found.", tree_name);
425         tree = parse_tree_indirect(&oid);
426         if (!tree)
427                 die("bad tree-ish %s", tree_name);
428
429         /* Hoist the unmerged entries up to stage #3 to make room */
430         for (i = 0; i < istate->cache_nr; i++) {
431                 struct cache_entry *ce = istate->cache[i];
432                 if (!ce_stage(ce))
433                         continue;
434                 ce->ce_flags |= CE_STAGEMASK;
435         }
436
437         if (prefix) {
438                 static const char *(matchbuf[1]);
439                 matchbuf[0] = NULL;
440                 parse_pathspec(&pathspec, PATHSPEC_ALL_MAGIC,
441                                PATHSPEC_PREFER_CWD, prefix, matchbuf);
442         } else
443                 memset(&pathspec, 0, sizeof(pathspec));
444         if (read_tree(tree, 1, &pathspec, istate))
445                 die("unable to read tree entries %s", tree_name);
446
447         for (i = 0; i < istate->cache_nr; i++) {
448                 struct cache_entry *ce = istate->cache[i];
449                 switch (ce_stage(ce)) {
450                 case 0:
451                         last_stage0 = ce;
452                         /* fallthru */
453                 default:
454                         continue;
455                 case 1:
456                         /*
457                          * If there is stage #0 entry for this, we do not
458                          * need to show it.  We use CE_UPDATE bit to mark
459                          * such an entry.
460                          */
461                         if (last_stage0 &&
462                             !strcmp(last_stage0->name, ce->name))
463                                 ce->ce_flags |= CE_UPDATE;
464                 }
465         }
466 }
467
468 static const char * const ls_files_usage[] = {
469         N_("git ls-files [<options>] [<file>...]"),
470         NULL
471 };
472
473 static int option_parse_exclude(const struct option *opt,
474                                 const char *arg, int unset)
475 {
476         struct string_list *exclude_list = opt->value;
477
478         exc_given = 1;
479         string_list_append(exclude_list, arg);
480
481         return 0;
482 }
483
484 static int option_parse_exclude_from(const struct option *opt,
485                                      const char *arg, int unset)
486 {
487         struct dir_struct *dir = opt->value;
488
489         exc_given = 1;
490         add_excludes_from_file(dir, arg);
491
492         return 0;
493 }
494
495 static int option_parse_exclude_standard(const struct option *opt,
496                                          const char *arg, int unset)
497 {
498         struct dir_struct *dir = opt->value;
499
500         exc_given = 1;
501         setup_standard_excludes(dir);
502
503         return 0;
504 }
505
506 int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
507 {
508         int require_work_tree = 0, show_tag = 0, i;
509         const char *max_prefix;
510         struct dir_struct dir;
511         struct exclude_list *el;
512         struct string_list exclude_list = STRING_LIST_INIT_NODUP;
513         struct option builtin_ls_files_options[] = {
514                 /* Think twice before adding "--nul" synonym to this */
515                 OPT_SET_INT('z', NULL, &line_terminator,
516                         N_("paths are separated with NUL character"), '\0'),
517                 OPT_BOOL('t', NULL, &show_tag,
518                         N_("identify the file status with tags")),
519                 OPT_BOOL('v', NULL, &show_valid_bit,
520                         N_("use lowercase letters for 'assume unchanged' files")),
521                 OPT_BOOL('f', NULL, &show_fsmonitor_bit,
522                         N_("use lowercase letters for 'fsmonitor clean' files")),
523                 OPT_BOOL('c', "cached", &show_cached,
524                         N_("show cached files in the output (default)")),
525                 OPT_BOOL('d', "deleted", &show_deleted,
526                         N_("show deleted files in the output")),
527                 OPT_BOOL('m', "modified", &show_modified,
528                         N_("show modified files in the output")),
529                 OPT_BOOL('o', "others", &show_others,
530                         N_("show other files in the output")),
531                 OPT_BIT('i', "ignored", &dir.flags,
532                         N_("show ignored files in the output"),
533                         DIR_SHOW_IGNORED),
534                 OPT_BOOL('s', "stage", &show_stage,
535                         N_("show staged contents' object name in the output")),
536                 OPT_BOOL('k', "killed", &show_killed,
537                         N_("show files on the filesystem that need to be removed")),
538                 OPT_BIT(0, "directory", &dir.flags,
539                         N_("show 'other' directories' names only"),
540                         DIR_SHOW_OTHER_DIRECTORIES),
541                 OPT_BOOL(0, "eol", &show_eol, N_("show line endings of files")),
542                 OPT_NEGBIT(0, "empty-directory", &dir.flags,
543                         N_("don't show empty directories"),
544                         DIR_HIDE_EMPTY_DIRECTORIES),
545                 OPT_BOOL('u', "unmerged", &show_unmerged,
546                         N_("show unmerged files in the output")),
547                 OPT_BOOL(0, "resolve-undo", &show_resolve_undo,
548                             N_("show resolve-undo information")),
549                 { OPTION_CALLBACK, 'x', "exclude", &exclude_list, N_("pattern"),
550                         N_("skip files matching pattern"),
551                         0, option_parse_exclude },
552                 { OPTION_CALLBACK, 'X', "exclude-from", &dir, N_("file"),
553                         N_("exclude patterns are read from <file>"),
554                         0, option_parse_exclude_from },
555                 OPT_STRING(0, "exclude-per-directory", &dir.exclude_per_dir, N_("file"),
556                         N_("read additional per-directory exclude patterns in <file>")),
557                 { OPTION_CALLBACK, 0, "exclude-standard", &dir, NULL,
558                         N_("add the standard git exclusions"),
559                         PARSE_OPT_NOARG, option_parse_exclude_standard },
560                 OPT_SET_INT_F(0, "full-name", &prefix_len,
561                               N_("make the output relative to the project top directory"),
562                               0, PARSE_OPT_NONEG),
563                 OPT_BOOL(0, "recurse-submodules", &recurse_submodules,
564                         N_("recurse through submodules")),
565                 OPT_BOOL(0, "error-unmatch", &error_unmatch,
566                         N_("if any <file> is not in the index, treat this as an error")),
567                 OPT_STRING(0, "with-tree", &with_tree, N_("tree-ish"),
568                         N_("pretend that paths removed since <tree-ish> are still present")),
569                 OPT__ABBREV(&abbrev),
570                 OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
571                 OPT_END()
572         };
573
574         if (argc == 2 && !strcmp(argv[1], "-h"))
575                 usage_with_options(ls_files_usage, builtin_ls_files_options);
576
577         memset(&dir, 0, sizeof(dir));
578         prefix = cmd_prefix;
579         if (prefix)
580                 prefix_len = strlen(prefix);
581         git_config(git_default_config, NULL);
582
583         if (repo_read_index(the_repository) < 0)
584                 die("index file corrupt");
585
586         argc = parse_options(argc, argv, prefix, builtin_ls_files_options,
587                         ls_files_usage, 0);
588         el = add_exclude_list(&dir, EXC_CMDL, "--exclude option");
589         for (i = 0; i < exclude_list.nr; i++) {
590                 add_exclude(exclude_list.items[i].string, "", 0, el, --exclude_args);
591         }
592         if (show_tag || show_valid_bit || show_fsmonitor_bit) {
593                 tag_cached = "H ";
594                 tag_unmerged = "M ";
595                 tag_removed = "R ";
596                 tag_modified = "C ";
597                 tag_other = "? ";
598                 tag_killed = "K ";
599                 tag_skip_worktree = "S ";
600                 tag_resolve_undo = "U ";
601         }
602         if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
603                 require_work_tree = 1;
604         if (show_unmerged)
605                 /*
606                  * There's no point in showing unmerged unless
607                  * you also show the stage information.
608                  */
609                 show_stage = 1;
610         if (dir.exclude_per_dir)
611                 exc_given = 1;
612
613         if (require_work_tree && !is_inside_work_tree())
614                 setup_work_tree();
615
616         if (recurse_submodules &&
617             (show_stage || show_deleted || show_others || show_unmerged ||
618              show_killed || show_modified || show_resolve_undo || with_tree))
619                 die("ls-files --recurse-submodules unsupported mode");
620
621         if (recurse_submodules && error_unmatch)
622                 die("ls-files --recurse-submodules does not support "
623                     "--error-unmatch");
624
625         parse_pathspec(&pathspec, 0,
626                        PATHSPEC_PREFER_CWD,
627                        prefix, argv);
628
629         /*
630          * Find common prefix for all pathspec's
631          * This is used as a performance optimization which unfortunately cannot
632          * be done when recursing into submodules because when a pathspec is
633          * given which spans repository boundaries you can't simply remove the
634          * submodule entry because the pathspec may match something inside the
635          * submodule.
636          */
637         if (recurse_submodules)
638                 max_prefix = NULL;
639         else
640                 max_prefix = common_prefix(&pathspec);
641         max_prefix_len = get_common_prefix_len(max_prefix);
642
643         prune_index(the_repository->index, max_prefix, max_prefix_len);
644
645         /* Treat unmatching pathspec elements as errors */
646         if (pathspec.nr && error_unmatch)
647                 ps_matched = xcalloc(pathspec.nr, 1);
648
649         if ((dir.flags & DIR_SHOW_IGNORED) && !exc_given)
650                 die("ls-files --ignored needs some exclude pattern");
651
652         /* With no flags, we default to showing the cached files */
653         if (!(show_stage || show_deleted || show_others || show_unmerged ||
654               show_killed || show_modified || show_resolve_undo))
655                 show_cached = 1;
656
657         if (with_tree) {
658                 /*
659                  * Basic sanity check; show-stages and show-unmerged
660                  * would not make any sense with this option.
661                  */
662                 if (show_stage || show_unmerged)
663                         die("ls-files --with-tree is incompatible with -s or -u");
664                 overlay_tree_on_index(the_repository->index, with_tree, max_prefix);
665         }
666
667         show_files(the_repository, &dir);
668
669         if (show_resolve_undo)
670                 show_ru_info(the_repository->index);
671
672         if (ps_matched) {
673                 int bad;
674                 bad = report_path_error(ps_matched, &pathspec, prefix);
675                 if (bad)
676                         fprintf(stderr, "Did you forget to 'git add'?\n");
677
678                 return bad ? 1 : 0;
679         }
680
681         UNLEAK(dir);
682         return 0;
683 }