1 /* util.c -- functions for initializing new tree elements, and other things.
2 Copyright (C) 1990, 91, 92, 93, 94, 2000, 2003, 2004, 2005 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2, or (at your option)
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
27 #ifdef HAVE_SYS_UTSNAME_H
28 #include <sys/utsname.h>
45 # define _(Text) gettext (Text)
50 # define N_(String) gettext_noop (String)
52 /* See locate.c for explanation as to why not use (String) */
53 # define N_(String) String
57 struct debug_option_assoc
63 static struct debug_option_assoc debugassoc
[] =
65 { "help", DebugHelp
, "Explain the various -D options" },
66 { "tree", DebugExpressionTree
, "Display the expression tree" },
67 { "search",DebugSearch
, "Navigate the directory tree verbosely" },
68 { "stat", DebugStat
, "Trace calls to stat(2) and lstat(2)" },
69 { "rates", DebugSuccessRates
, "Indicate how often each predicate succeeded" },
70 { "opt", DebugExpressionTree
|DebugTreeOpt
, "Show diagnostic information relating to optimisation" },
71 { "exec", DebugExec
, "Show diagnostic information relating to -exec, -execdir, -ok and -okdir" }
73 #define N_DEBUGASSOC (sizeof(debugassoc)/sizeof(debugassoc[0]))
78 /* Add a primary of predicate type PRED_FUNC (described by ENTRY) to the predicate input list.
80 Return a pointer to the predicate node just inserted.
82 Fills in the following cells of the new predicate node:
89 Other cells that need to be filled in are defaulted by
90 get_new_pred_chk_op, which is used to insure that the prior node is
91 either not there at all (we are the very first node) or is an
95 insert_primary_withpred (const struct parser_table
*entry
, PRED_FUNC pred_func
)
97 struct predicate
*new_pred
;
99 new_pred
= get_new_pred_chk_op (entry
);
100 new_pred
->pred_func
= pred_func
;
101 new_pred
->p_name
= entry
->parser_name
;
102 new_pred
->args
.str
= NULL
;
103 new_pred
->p_type
= PRIMARY_TYPE
;
104 new_pred
->p_prec
= NO_PREC
;
108 /* Add a primary described by ENTRY to the predicate input list.
110 Return a pointer to the predicate node just inserted.
112 Fills in the following cells of the new predicate node:
119 Other cells that need to be filled in are defaulted by
120 get_new_pred_chk_op, which is used to insure that the prior node is
121 either not there at all (we are the very first node) or is an
124 insert_primary (const struct parser_table
*entry
)
126 assert(entry
->pred_func
!= NULL
);
127 return insert_primary_withpred(entry
, entry
->pred_func
);
133 show_valid_debug_options(FILE *fp
, int full
)
138 fprintf(fp
, "Valid arguments for -D:\n");
139 for (i
=0; i
<N_DEBUGASSOC
; ++i
)
141 fprintf(fp
, "%-10s %s\n",
143 debugassoc
[i
].docstring
);
148 for (i
=0; i
<N_DEBUGASSOC
; ++i
)
150 fprintf(fp
, "%s%s", (i
>0 ? "|" : ""), debugassoc
[i
].name
);
156 usage (FILE *fp
, int status
, char *msg
)
159 fprintf (fp
, "%s: %s\n", program_name
, msg
);
161 fprintf (fp
, _("Usage: %s [-H] [-L] [-P] [-Olevel] [-D "), program_name
);
162 show_valid_debug_options(fp
, 0);
163 fprintf (fp
, _("] [path...] [expression]\n"));
169 set_stat_placeholders(struct stat
*p
)
171 #if HAVE_STRUCT_STAT_ST_BIRTHTIME
174 #if HAVE_STRUCT_STAT_ST_BIRTHTIMENSEC
175 p
->st_birthtimensec
= 0;
177 #if HAVE_STRUCT_STAT_ST_BIRTHTIMESPEC_TV_NSEC
178 p
->st_birthtimespec
.tv_nsec
= -1;
180 #if HAVE_STRUCT_STAT_ST_BIRTHTIMESPEC_TV_SEC
181 p
->st_birthtimespec
.tv_sec
= 0;
186 /* Get the stat information for a file, if it is
190 get_statinfo (const char *pathname
, const char *name
, struct stat
*p
)
192 /* Set markers in fields so we have a good idea if the implementation
193 * didn't bother to set them (e.g., NetBSD st_birthtimespec for MS-DOS
196 if (!state
.have_stat
)
198 set_stat_placeholders(p
);
199 if (0 == (*options
.xstat
) (name
, p
))
201 if (00000 == p
->st_mode
)
203 /* Savannah bug #16378. */
204 error(0, 0, _("Warning: file %s appears to have mode 0000"),
205 quotearg_n_style(0, options
.err_quoting_style
, name
));
210 if (!options
.ignore_readdir_race
|| (errno
!= ENOENT
) )
212 error (0, errno
, "%s",
213 safely_quote_err_filename(0, pathname
));
214 state
.exit_status
= 1;
219 state
.have_stat
= true;
220 state
.have_type
= true;
221 state
.type
= p
->st_mode
;
227 /* Get the stat/type information for a file, if it is
231 get_info (const char *pathname
,
233 struct predicate
*pred_ptr
)
235 boolean todo
= false;
237 /* If we need the full stat info, or we need the type info but don't
238 * already have it, stat the file now.
240 if (pred_ptr
->need_stat
)
242 else if ((pred_ptr
->need_type
&& (0 == state
.have_type
)))
246 return get_statinfo(pathname
, state
.rel_pathname
, p
);
251 /* Determine if we can use O_NOFOLLOW.
253 #if defined(O_NOFOLLOW)
260 if (0 == uname(&uts
))
262 /* POSIX requires that atof() ignore "unrecognised suffixes". */
263 release
= atof(uts
.release
);
265 if (0 == strcmp("Linux", uts
.sysname
))
267 /* Linux kernels 2.1.126 and earlier ignore the O_NOFOLLOW flag. */
268 return release
>= 2.2; /* close enough */
270 else if (0 == strcmp("FreeBSD", uts
.sysname
))
272 /* FreeBSD 3.0-CURRENT and later support it */
273 return release
>= 3.1;
277 /* Well, O_NOFOLLOW was defined, so we'll try to use it. */
284 /* Examine the predicate list for instances of -execdir or -okdir
285 * which have been terminated with '+' (build argument list) rather
286 * than ';' (singles only). If there are any, run them (this will
287 * have no effect if there are no arguments waiting).
290 do_complete_pending_execdirs(struct predicate
*p
, int dirfd
)
295 assert(state
.execdirs_outstanding
);
297 do_complete_pending_execdirs(p
->pred_left
, dirfd
);
299 if (pred_is(p
, pred_execdir
) || pred_is(p
, pred_okdir
))
301 /* It's an exec-family predicate. p->args.exec_val is valid. */
302 if (p
->args
.exec_vec
.multiple
)
304 struct exec_val
*execp
= &p
->args
.exec_vec
;
306 /* This one was terminated by '+' and so might have some
307 * left... Run it if necessary.
309 if (execp
->state
.todo
)
311 /* There are not-yet-executed arguments. */
312 launch (&execp
->ctl
, &execp
->state
);
317 do_complete_pending_execdirs(p
->pred_right
, dirfd
);
321 complete_pending_execdirs(int dirfd
)
323 if (state
.execdirs_outstanding
)
325 do_complete_pending_execdirs(get_eval_tree(), dirfd
);
326 state
.execdirs_outstanding
= false;
332 /* Examine the predicate list for instances of -exec which have been
333 * terminated with '+' (build argument list) rather than ';' (singles
334 * only). If there are any, run them (this will have no effect if
335 * there are no arguments waiting).
338 complete_pending_execs(struct predicate
*p
)
343 complete_pending_execs(p
->pred_left
);
345 /* It's an exec-family predicate then p->args.exec_val is valid
346 * and we can check it.
348 /* XXX: what about pred_ok() ? */
349 if (pred_is(p
, pred_exec
) && p
->args
.exec_vec
.multiple
)
351 struct exec_val
*execp
= &p
->args
.exec_vec
;
353 /* This one was terminated by '+' and so might have some
354 * left... Run it if necessary. Set state.exit_status if
355 * there are any problems.
357 if (execp
->state
.todo
)
359 /* There are not-yet-executed arguments. */
360 launch (&execp
->ctl
, &execp
->state
);
364 complete_pending_execs(p
->pred_right
);
368 traverse_tree(struct predicate
*tree
,
369 void (*callback
)(struct predicate
*))
372 traverse_tree(tree
->pred_left
, callback
);
376 if (tree
->pred_right
)
377 traverse_tree(tree
->pred_right
, callback
);
381 flush_and_close_output_files(struct predicate
*p
)
383 if (pred_is(p
, pred_fprint
)
384 || pred_is(p
, pred_fprintf
)
385 || pred_is(p
, pred_fls
)
386 || pred_is(p
, pred_fprint0
))
388 FILE *f
= p
->args
.printf_vec
.stream
;
391 if (f
== stdout
|| f
== stderr
)
392 failed
= fflush(p
->args
.printf_vec
.stream
) == EOF
;
394 failed
= fclose(p
->args
.printf_vec
.stream
) == EOF
;
397 nonfatal_file_error(p
->args
.printf_vec
.filename
);
399 else if (pred_is(p
, pred_print
))
401 if (fflush(p
->args
.printf_vec
.stream
) == EOF
)
403 nonfatal_file_error(p
->args
.printf_vec
.filename
);
406 else if (pred_is(p
, pred_ls
) || pred_is(p
, pred_print0
))
408 if (fflush(stdout
) == EOF
)
410 /* XXX: migrate to printf_vec. */
411 nonfatal_file_error("standard output");
416 /* Complete any outstanding commands.
421 struct predicate
*eval_tree
= get_eval_tree();
424 traverse_tree(eval_tree
, complete_pending_execs
);
425 complete_pending_execdirs(get_current_dirfd());
426 traverse_tree(eval_tree
, flush_and_close_output_files
);
430 /* Savannah bug #16378 manifests as an assertion failure in pred_type()
431 * when an NFS server returns st_mode with value 0 (of course the stat(2)
432 * system call is itself returning 0 in this case).
434 #undef DEBUG_SV_BUG_16378
435 #if defined(DEBUG_SV_BUG_16378)
436 static int hook_fstatat(int fd
, const char *name
, struct stat
*p
, int flags
)
438 static int warned
= 0;
442 /* No use of _() here; no point asking translators to translate a debug msg */
444 "Warning: some debug code is enabled for Savannah bug #16378; "
445 "this should not occur in released versions of findutils!");
449 if (0 == strcmp(name
, "./mode0file")
450 || 0 == strcmp(name
, "mode0file"))
452 time_t now
= time(NULL
);
458 p
->st_mode
= 0; /* SV bug #16378 */
460 p
->st_uid
= geteuid();
463 p
->st_blksize
= 32768;
464 p
->st_atime
= now
-1*day
;
465 p
->st_mtime
= now
-2*day
;
466 p
->st_ctime
= now
-3*day
;
470 return fstatat(fd
, name
, p
, flags
);
474 # define fstatat(fd,name,p,flags) hook_fstatat((fd),(name),(p),(flags))
479 fallback_stat(const char *name
, struct stat
*p
, int prev_rv
)
481 /* Our original stat() call failed. Perhaps we can't follow a
482 * symbolic link. If that might be the problem, lstat() the link.
483 * Otherwise, admit defeat.
489 if (options
.debug_options
& DebugStat
)
490 fprintf(stderr
, "fallback_stat(): stat(%s) failed; falling back on lstat()\n", name
);
491 return fstatat(state
.cwd_dir_fd
, name
, p
, AT_SYMLINK_NOFOLLOW
);
498 case EOVERFLOW
: /* EOVERFLOW is not #defined on UNICOS. */
506 /* optionh_stat() implements the stat operation when the -H option is
509 * If the item to be examined is a command-line argument, we follow
510 * symbolic links. If the stat() call fails on the command-line item,
511 * we fall back on the properties of the symbolic link.
513 * If the item to be examined is not a command-line argument, we
514 * examine the link itself.
517 optionh_stat(const char *name
, struct stat
*p
)
519 if (AT_FDCWD
!= state
.cwd_dir_fd
)
520 assert(state
.cwd_dir_fd
>= 0);
521 set_stat_placeholders(p
);
522 if (0 == state
.curdepth
)
524 /* This file is from the command line; deference the link (if it
528 rv
= fstatat(state
.cwd_dir_fd
, name
, p
, 0);
530 return 0; /* success */
532 return fallback_stat(name
, p
, rv
);
536 /* Not a file on the command line; do not dereference the link.
538 return fstatat(state
.cwd_dir_fd
, name
, p
, AT_SYMLINK_NOFOLLOW
);
542 /* optionl_stat() implements the stat operation when the -L option is
543 * in effect. That option makes us examine the thing the symbolic
544 * link points to, not the symbolic link itself.
547 optionl_stat(const char *name
, struct stat
*p
)
550 if (AT_FDCWD
!= state
.cwd_dir_fd
)
551 assert(state
.cwd_dir_fd
>= 0);
553 set_stat_placeholders(p
);
554 rv
= fstatat(state
.cwd_dir_fd
, name
, p
, 0);
556 return 0; /* normal case. */
558 return fallback_stat(name
, p
, rv
);
561 /* optionp_stat() implements the stat operation when the -P option is
562 * in effect (this is also the default). That option makes us examine
563 * the symbolic link itself, not the thing it points to.
566 optionp_stat(const char *name
, struct stat
*p
)
568 assert((state
.cwd_dir_fd
>= 0) || (state
.cwd_dir_fd
==AT_FDCWD
));
569 set_stat_placeholders(p
);
570 return fstatat(state
.cwd_dir_fd
, name
, p
, AT_SYMLINK_NOFOLLOW
);
574 static uintmax_t stat_count
= 0u;
577 debug_stat (const char *file
, struct stat
*bufp
)
580 fprintf (stderr
, "debug_stat (%s)\n", file
);
582 switch (options
.symlink_handling
)
584 case SYMLINK_ALWAYS_DEREF
:
585 return optionl_stat(file
, bufp
);
586 case SYMLINK_DEREF_ARGSONLY
:
587 return optionh_stat(file
, bufp
);
588 case SYMLINK_NEVER_DEREF
:
589 return optionp_stat(file
, bufp
);
598 following_links(void)
600 switch (options
.symlink_handling
)
602 case SYMLINK_ALWAYS_DEREF
:
604 case SYMLINK_DEREF_ARGSONLY
:
605 return (state
.curdepth
== 0);
606 case SYMLINK_NEVER_DEREF
:
613 /* Take a "mode" indicator and fill in the files of 'state'.
616 digest_mode(mode_t mode
,
617 const char *pathname
,
622 /* If we know the type of the directory entry, and it is not a
623 * symbolic link, we may be able to avoid a stat() or lstat() call.
627 if (S_ISLNK(mode
) && following_links())
629 /* mode is wrong because we should have followed the symlink. */
630 if (get_statinfo(pathname
, name
, pstat
) != 0)
632 mode
= state
.type
= pstat
->st_mode
;
633 state
.have_type
= true;
637 state
.have_type
= true;
638 pstat
->st_mode
= state
.type
= mode
;
643 /* Mode is not yet known; may have to stat the file unless we
644 * can deduce that it is not a directory (which is all we need to
645 * know at this stage)
649 state
.have_stat
= false;
650 state
.have_type
= false;;
655 if (get_statinfo(pathname
, name
, pstat
) != 0)
658 /* If -L is in effect and we are dealing with a symlink,
659 * st_mode is the mode of the pointed-to file, while mode is
660 * the mode of the directory entry (S_IFLNK). Hence now
661 * that we have the stat information, override "mode".
663 state
.type
= pstat
->st_mode
;
664 state
.have_type
= true;
673 /* Return true if there are no predicates with no_default_print in
674 predicate list PRED, false if there are any.
675 Returns true if default print should be performed */
678 default_prints (struct predicate
*pred
)
682 if (pred
->no_default_print
)
684 pred
= pred
->pred_next
;
690 looks_like_expression(const char *arg
, boolean leading
)
695 if (arg
[1]) /* "-foo" is an expression. */
698 return false; /* Just "-" is a filename. */
704 return false; /* )x and ,z are not expressions */
706 return !leading
; /* A leading ) or , is not either */
708 /* ( and ! are part of an expression, but (2 and !foo are
724 process_debug_options(char *arg
)
727 char *token_context
= NULL
;
728 const char delimiters
[] = ",";
729 boolean empty
= true;
732 p
= strtok_r(arg
, delimiters
, &token_context
);
737 for (i
=0; i
<N_DEBUGASSOC
; ++i
)
739 if (0 == strcmp(debugassoc
[i
].name
, p
))
741 options
.debug_options
|= debugassoc
[i
].val
;
745 if (i
>= N_DEBUGASSOC
)
747 error(0, 0, _("Ignoring unrecognised debug flag %s"),
748 quotearg_n_style(0, options
.err_quoting_style
, arg
));
750 p
= strtok_r(NULL
, delimiters
, &token_context
);
754 error(1, 0, _("Empty argument to the -D option."));
756 else if (options
.debug_options
& DebugHelp
)
758 show_valid_debug_options(stdout
, 1);
764 process_optimisation_option(const char *arg
)
768 error(1, 0, _("The -O option must be immediately followed by a decimal integer"));
772 unsigned long opt_level
;
775 if (!isdigit( (unsigned char) arg
[0] ))
777 error(1, 0, _("Please specify a decimal number immediately after -O"));
781 int prev_errno
= errno
;
784 opt_level
= strtoul(arg
, &end
, 10);
785 if ( (0==opt_level
) && (end
==arg
) )
787 error(1, 0, _("Please specify a decimal number immediately after -O"));
791 /* unwanted trailing characters. */
792 error(1, 0, _("Invalid optimisation level %s"), arg
);
794 else if ( (ULONG_MAX
==opt_level
) && errno
)
796 error(1, errno
, _("Invalid optimisation level %s"), arg
);
798 else if (opt_level
> USHRT_MAX
)
800 /* tricky to test, as on some platforms USHORT_MAX and ULONG_MAX
801 * can have the same value, though this is unusual.
803 error(1, 0, _("Optimisation level %lu is too high. "
804 "If you want to find files very quickly, "
805 "consider using GNU locate."),
810 options
.optimisation_level
= opt_level
;
818 process_leading_options(int argc
, char *argv
[])
820 int i
, end_of_leading_options
;
822 for (i
=1; (end_of_leading_options
= i
) < argc
; ++i
)
824 if (0 == strcmp("-H", argv
[i
]))
826 /* Meaning: dereference symbolic links on command line, but nowhere else. */
827 set_follow_state(SYMLINK_DEREF_ARGSONLY
);
829 else if (0 == strcmp("-L", argv
[i
]))
831 /* Meaning: dereference all symbolic links. */
832 set_follow_state(SYMLINK_ALWAYS_DEREF
);
834 else if (0 == strcmp("-P", argv
[i
]))
836 /* Meaning: never dereference symbolic links (default). */
837 set_follow_state(SYMLINK_NEVER_DEREF
);
839 else if (0 == strcmp("--", argv
[i
]))
841 /* -- signifies the end of options. */
842 end_of_leading_options
= i
+1; /* Next time start with the next option */
845 else if (0 == strcmp("-D", argv
[i
]))
847 process_debug_options(argv
[i
+1]);
848 ++i
; /* skip the argument too. */
850 else if (0 == strncmp("-O", argv
[i
], 2))
852 process_optimisation_option(argv
[i
]+2);
856 /* Hmm, must be one of
860 end_of_leading_options
= i
; /* Next time start with this option */
864 return end_of_leading_options
;
867 static struct timespec
870 struct timespec retval
;
874 if (0 == gettimeofday(&tv
, NULL
))
876 retval
.tv_sec
= tv
.tv_sec
;
877 retval
.tv_nsec
= tv
.tv_usec
* 1000; /* convert unit from microseconds to nanoseconds */
881 assert(t
!= (time_t)-1);
888 set_option_defaults(struct options
*p
)
890 /* We call check_nofollow() before setlocale() because the numbers
891 * for which we check (in the results of uname) definitiely have "."
892 * as the decimal point indicator even under locales for which that
893 * is not normally true. Hence atof() would do the wrong thing
894 * if we call it after setlocale().
897 p
->open_nofollow_available
= check_nofollow();
899 p
->open_nofollow_available
= false;
902 p
->regex_options
= RE_SYNTAX_EMACS
;
907 p
->literal_control_chars
= false;
912 p
->literal_control_chars
= false; /* may change */
916 p
->do_dir_first
= true;
917 p
->maxdepth
= p
->mindepth
= -1;
918 p
->start_time
= now();
919 p
->cur_day_start
= p
->start_time
.tv_sec
- DAYSECS
;
920 p
->full_days
= false;
921 p
->stay_on_filesystem
= false;
922 p
->ignore_readdir_race
= false;
924 if (getenv("POSIXLY_CORRECT"))
925 p
->output_block_size
= 512;
927 p
->output_block_size
= 1024;
929 p
->debug_options
= 0uL;
930 p
->optimisation_level
= 0;
932 if (getenv("FIND_BLOCK_SIZE"))
934 error (1, 0, _("The environment variable FIND_BLOCK_SIZE is not supported, the only thing that affects the block size is the POSIXLY_CORRECT environment variable"));
937 #if LEAF_OPTIMISATION
938 /* The leaf optimisation is enabled. */
939 p
->no_leaf_check
= false;
941 /* The leaf optimisation is disabled. */
942 p
->no_leaf_check
= true;
945 set_follow_state(SYMLINK_NEVER_DEREF
); /* The default is equivalent to -P. */
947 p
->err_quoting_style
= locale_quoting_style
;
953 * Returns the fd for the directory we started in.
955 int get_start_dirfd(void)
957 return starting_desc
;
964 apply_predicate(const char *pathname
, struct stat
*stat_buf
, struct predicate
*p
)
968 if (p
->need_stat
|| p
->need_type
)
970 /* We may need a stat here. */
971 if (get_info(pathname
, stat_buf
, p
) != 0)
974 if ((p
->pred_func
)(pathname
, stat_buf
, p
))
976 ++(p
->perf
.successes
);
986 /* safely_quote_err_filename
990 safely_quote_err_filename (int n
, char const *arg
)
992 return quotearg_n_style (n
, options
.err_quoting_style
, arg
);
998 report_file_err(int exitval
, int errno_value
, const char *name
)
1000 /* It is important that the errno value is passed in as a function
1001 * argument before we call safely_quote_err_filename(), because otherwise
1002 * we might find that safely_quote_err_filename() changes errno.
1004 if (state
.exit_status
< 1)
1005 state
.exit_status
= 1;
1007 error (exitval
, errno_value
, "%s", safely_quote_err_filename(0, name
));
1014 fatal_file_error(const char *name
)
1016 report_file_err(1, errno
, name
);
1022 nonfatal_file_error(const char *name
)
1024 report_file_err(0, errno
, name
);