1 /* defs.h -- data types and declarations.
2 Copyright (C) 1990, 91, 92, 93, 94, 2000, 2004, 2005, 2006 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,
23 #include <sys/types.h>
27 #if defined(HAVE_STRING_H) || defined(STDC_HEADERS)
35 #define strrchr rindex
48 /* The presence of unistd.h is assumed by gnulib these days, so we
49 * might as well assume it too.
63 # include <inttypes.h>
76 # if defined PROTOTYPES || (defined __STDC__ && __STDC__)
77 # define PARAMS(Args) Args
79 # define PARAMS(Args) ()
83 int lstat
PARAMS((const char *__path
, struct stat
*__statbuf
));
84 int stat
PARAMS((const char *__path
, struct stat
*__statbuf
));
86 int optionl_stat
PARAMS((const char *name
, struct stat
*p
));
87 int optionp_stat
PARAMS((const char *name
, struct stat
*p
));
88 int optionh_stat
PARAMS((const char *name
, struct stat
*p
));
89 int debug_stat
PARAMS((const char *file
, struct stat
*bufp
));
91 void set_stat_placeholders
PARAMS((struct stat
*p
));
92 int get_statinfo
PARAMS((const char *pathname
, const char *name
, struct stat
*p
));
94 #if ! defined HAVE_FCHDIR && ! defined fchdir
95 # define fchdir(fd) (-1)
101 # define S_ISUID 0004000
104 # define S_ISGID 0002000
107 # define S_ISVTX 0001000
110 # define S_IRUSR 0000400
113 # define S_IWUSR 0000200
116 # define S_IXUSR 0000100
119 # define S_IRGRP 0000040
122 # define S_IWGRP 0000020
125 # define S_IXGRP 0000010
128 # define S_IROTH 0000004
131 # define S_IWOTH 0000002
134 # define S_IXOTH 0000001
137 #define MODE_WXUSR (S_IWUSR | S_IXUSR)
138 #define MODE_R (S_IRUSR | S_IRGRP | S_IROTH)
139 #define MODE_RW (S_IWUSR | S_IWGRP | S_IWOTH | MODE_R)
140 #define MODE_RWX (S_IXUSR | S_IXGRP | S_IXOTH | MODE_RW)
141 #define MODE_ALL (S_ISUID | S_ISGID | S_ISVTX | MODE_RWX)
145 typedef bool boolean
;
147 /* Not char because of type promotion; NeXT gcc can't handle it. */
156 /* Pointer to a predicate function. */
157 typedef boolean (*PRED_FUNC
)(char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
);
159 /* The number of seconds in a day. */
160 #define DAYSECS 86400
162 /* Argument structures for predicates. */
171 enum permissions_type
188 enum predicate_precedence
200 enum comparison_type kind
;
201 boolean negative
; /* Defined only when representing time_t. */
207 enum permissions_type kind
;
211 /* dir_id is used to support loop detection in find.c and
212 * also to support the -samefile test.
222 enum comparison_type kind
;
230 XVAL_ATIME
, XVAL_BIRTHTIME
, XVAL_CTIME
, XVAL_MTIME
, XVAL_TIME
236 enum comparison_type kind
;
243 boolean multiple
; /* -exec {} \+ denotes multiple argument. */
244 struct buildcmd_control ctl
;
245 struct buildcmd_state state
;
246 char **replace_vec
; /* Command arguments (for ";" style) */
248 boolean use_current_dir
; /* If nonzero, don't chdir to start dir */
249 boolean close_stdin
; /* If true, close stdin in the child. */
250 int dirfd
; /* The directory to do the exec in. */
253 /* The format string for a -printf or -fprintf is chopped into one or
254 more `struct segment', linked together into a list.
255 Each stretch of plain text is a segment, and
256 each \c and `%' conversion is a segment. */
258 /* Special values for the `kind' field of `struct segment'. */
261 KIND_PLAIN
=0, /* Segment containing just plain text. */
262 KIND_STOP
=1, /* \c -- stop printing and flush output. */
263 KIND_FORMAT
, /* Regular format */
268 enum SegmentKind segkind
; /* KIND_FORMAT, KIND_PLAIN, KIND_STOP */
269 char format_char
[2]; /* Format chars if kind is KIND_FORMAT */
270 char *text
; /* Plain text or `%' format string. */
271 int text_len
; /* Length of `text'. */
272 struct segment
*next
; /* Next segment for this predicate. */
277 struct segment
*segment
; /* Linked list of segments. */
278 FILE *stream
; /* Output stream to print on. */
279 boolean dest_is_tty
; /* True if the destination is a terminal. */
280 struct quoting_options
*quote_opts
;
283 /* Profiling information for a predicate */
284 struct predicate_performance_info
286 unsigned long visits
;
287 unsigned long successes
;
290 /* evaluation cost of a predicate */
301 NeedsUserInteraction
,
308 /* Pointer to the function that implements this predicate. */
311 /* Only used for debugging, but defined unconditionally so individual
312 modules can be compiled with -DDEBUG. */
315 /* The type of this node. There are two kinds. The first is real
316 predicates ("primaries") such as -perm, -print, or -exec. The
317 other kind is operators for combining predicates. */
318 enum predicate_type p_type
;
320 /* The precedence of this node. Only has meaning for operators. */
321 enum predicate_precedence p_prec
;
323 /* True if this predicate node produces side effects.
324 If side_effects are produced
325 then optimization will not be performed */
326 boolean side_effects
;
328 /* True if this predicate node requires default print be turned off. */
329 boolean no_default_print
;
331 /* True if this predicate node requires a stat system call to execute. */
334 /* True if this predicate node requires knowledge of the file type. */
337 enum EvaluationCost p_cost
;
339 /* est_success_rate is a number between 0.0 and 1.0 */
340 float est_success_rate
;
342 /* True if this predicate should display control characters literally */
343 boolean literal_control_chars
;
345 /* True if this predicate didn't originate from the user. */
348 /* The raw text of the argument of this predicate. */
351 /* Information needed by the predicate processor.
352 Next to each member are listed the predicates that use it. */
355 char *str
; /* fstype [i]lname [i]name [i]path */
356 struct re_pattern_buffer
*regex
; /* regex */
357 struct exec_val exec_vec
; /* exec ok */
358 struct long_val numinfo
; /* gid inum links uid */
359 struct size_val size
; /* size */
360 uid_t uid
; /* user */
361 gid_t gid
; /* group */
362 struct time_val reftime
; /* newer newerXY anewer cnewer mtime atime ctime mmin amin cmin */
363 struct perm_val perm
; /* perm */
364 struct dir_id fileid
; /* samefile */
365 mode_t type
; /* type */
366 FILE *stream
; /* ls fls fprint0 */
367 struct format_val printf_vec
; /* printf fprintf fprint */
370 /* The next predicate in the user input sequence,
371 which represents the order in which the user supplied the
372 predicates on the command line. */
373 struct predicate
*pred_next
;
375 /* The right and left branches from this node in the expression
376 tree, which represents the order in which the nodes should be
378 struct predicate
*pred_left
;
379 struct predicate
*pred_right
;
381 struct predicate_performance_info perf
;
383 const struct parser_table
* parser_entry
;
386 /* find.c, ftsfind.c */
387 boolean
is_fts_enabled(int *ftsoptions
);
388 int get_start_dirfd(void);
389 int get_current_dirfd(void);
391 /* find library function declarations. */
394 char *dirname
PARAMS((char *path
));
397 void error
PARAMS((int status
, int errnum
, char *message
, ...));
401 char *stpcpy
PARAMS((char *dest
, const char *src
));
405 char *xgetcwd
PARAMS((void));
414 /* find global function declarations. */
417 /* SymlinkOption represents the choice of
418 * -P, -L or -P (default) on the command line.
422 SYMLINK_NEVER_DEREF
, /* Option -P */
423 SYMLINK_ALWAYS_DEREF
, /* Option -L */
424 SYMLINK_DEREF_ARGSONLY
/* Option -H */
426 extern enum SymlinkOption symlink_handling
; /* defined in find.c. */
428 void set_follow_state
PARAMS((enum SymlinkOption opt
));
432 char *filesystem_type
PARAMS((const struct stat
*statp
, const char *path
));
433 char * get_mounted_filesystems (void);
434 dev_t
* get_mounted_devices
PARAMS((size_t *));
440 ARG_OPTION
, /* regular options like -maxdepth */
441 ARG_NOOP
, /* does nothing, returns true, internal use only */
442 ARG_POSITIONAL_OPTION
, /* options whose position is important (-follow) */
443 ARG_TEST
, /* a like -name */
444 ARG_SPECIAL_PARSE
, /* complex to parse, don't eat the test name before calling parse_xx(). */
445 ARG_PUNCTUATION
, /* like -o or ( */
446 ARG_ACTION
/* like -print */
451 /* Pointer to a parser function. */
452 typedef boolean (*PARSE_FUNC
)(const struct parser_table
*p
,
453 char *argv
[], int *arg_ptr
);
458 PARSE_FUNC parser_func
;
463 const struct parser_table
* find_parser
PARAMS((char *search_name
));
464 boolean parse_open
PARAMS((const struct parser_table
* entry
, char *argv
[], int *arg_ptr
));
465 boolean parse_close
PARAMS((const struct parser_table
* entry
, char *argv
[], int *arg_ptr
));
466 boolean parse_print
PARAMS((const struct parser_table
*, char *argv
[], int *arg_ptr
));
467 void pred_sanity_check
PARAMS((const struct predicate
*predicates
));
468 void parse_begin_user_args
PARAMS((char **args
, int argno
, const struct predicate
*last
, const struct predicate
*predicates
));
469 void parse_end_user_args
PARAMS((char **args
, int argno
, const struct predicate
*last
, const struct predicate
*predicates
));
470 boolean parse_openparen
PARAMS((const struct parser_table
* entry
, char *argv
[], int *arg_ptr
));
471 boolean parse_closeparen
PARAMS((const struct parser_table
* entry
, char *argv
[], int *arg_ptr
));
474 boolean pred_amin
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
475 boolean pred_and
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
476 boolean pred_anewer
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
477 boolean pred_atime
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
478 boolean pred_close
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
479 boolean pred_cmin
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
480 boolean pred_cnewer
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
481 boolean pred_comma
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
482 boolean pred_ctime
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
483 boolean pred_delete
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
484 boolean pred_empty
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
485 boolean pred_exec
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
486 boolean pred_execdir
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
487 boolean pred_executable
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
488 boolean pred_false
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
489 boolean pred_fls
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
490 boolean pred_fprint
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
491 boolean pred_fprint0
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
492 boolean pred_fprintf
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
493 boolean pred_fstype
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
494 boolean pred_gid
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
495 boolean pred_group
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
496 boolean pred_ilname
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
497 boolean pred_iname
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
498 boolean pred_inum
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
499 boolean pred_ipath
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
500 boolean pred_links
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
501 boolean pred_lname
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
502 boolean pred_ls
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
503 boolean pred_mmin
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
504 boolean pred_mtime
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
505 boolean pred_name
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
506 boolean pred_negate
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
507 boolean pred_newer
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
508 boolean pred_newerXY
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
509 boolean pred_nogroup
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
510 boolean pred_nouser
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
511 boolean pred_ok
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
512 boolean pred_okdir
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
513 boolean pred_open
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
514 boolean pred_or
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
515 boolean pred_path
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
516 boolean pred_perm
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
517 boolean pred_print
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
518 boolean pred_print0
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
519 boolean pred_prune
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
520 boolean pred_quit
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
521 boolean pred_readable
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
522 boolean pred_regex
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
523 boolean pred_samefile
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
524 boolean pred_size
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
525 boolean pred_true
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
526 boolean pred_type
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
527 boolean pred_uid
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
528 boolean pred_used
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
529 boolean pred_user
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
530 boolean pred_writable
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
531 boolean pred_xtype
PARAMS((char *pathname
, struct stat
*stat_buf
, struct predicate
*pred_ptr
));
535 int launch
PARAMS((const struct buildcmd_control
*ctl
,
536 struct buildcmd_state
*buildstate
));
539 char *find_pred_name
PARAMS((PRED_FUNC pred_func
));
543 void print_predicate
PARAMS((FILE *fp
, const struct predicate
*p
));
544 void print_tree
PARAMS((FILE*, struct predicate
*node
, int indent
));
545 void print_list
PARAMS((FILE*, struct predicate
*node
));
546 void print_optlist
PARAMS((FILE *fp
, const struct predicate
*node
));
547 void show_success_rates(const struct predicate
*node
);
551 struct predicate
* build_expression_tree
PARAMS((int argc
, char *argv
[], int end_of_leading_options
));
552 struct predicate
* get_eval_tree
PARAMS((void));
553 struct predicate
*get_new_pred
PARAMS((const struct parser_table
*entry
));
554 struct predicate
*get_new_pred_chk_op
PARAMS((const struct parser_table
*entry
));
555 float calculate_derived_rates
PARAMS((struct predicate
*p
));
558 struct predicate
*insert_primary
PARAMS((const struct parser_table
*entry
));
559 struct predicate
*insert_primary_withpred
PARAMS((const struct parser_table
*entry
, PRED_FUNC fptr
));
560 void usage
PARAMS((FILE *fp
, int status
, char *msg
));
561 extern boolean
check_nofollow(void);
562 void complete_pending_execs(struct predicate
*p
);
563 void complete_pending_execdirs(int dirfd
); /* Passing dirfd is an unpleasant CodeSmell. */
565 int process_leading_options
PARAMS((int argc
, char *argv
[]));
566 void set_option_defaults
PARAMS((struct options
*p
));
569 #define apply_predicate(pathname, stat_buf_ptr, node) \
570 (*(node)->pred_func)((pathname), (stat_buf_ptr), (node))
572 boolean
apply_predicate(const char *pathname
, struct stat
*stat_buf
, struct predicate
*p
);
575 #define pred_is(node, fn) ( ((node)->pred_func) == (fn) )
579 int get_info
PARAMS((const char *pathname
, struct stat
*p
, struct predicate
*pred_ptr
));
580 int following_links
PARAMS((void));
581 int digest_mode
PARAMS((mode_t mode
, const char *pathname
, const char *name
, struct stat
*pstat
, boolean leaf
));
582 boolean default_prints
PARAMS((struct predicate
*pred
));
583 boolean looks_like_expression
PARAMS((const char *arg
, boolean leading
));
589 DebugExpressionTree
= 1,
595 DebugSuccessRates
= 64
600 /* If true, process directory before contents. True unless -depth given. */
601 boolean do_dir_first
;
603 /* If >=0, don't descend more than this many levels of subdirectories. */
606 /* If >=0, don't process files above this level. */
609 /* If true, do not assume that files in directories with nlink == 2
610 are non-directories. */
611 boolean no_leaf_check
;
613 /* If true, don't cross filesystem boundaries. */
614 boolean stay_on_filesystem
;
616 /* If true, we ignore the problem where we find that a directory entry
617 * no longer exists by the time we get around to processing it.
619 boolean ignore_readdir_race
;
621 /* If true, pass control characters through. If false, escape them
622 * or turn them into harmless things.
624 boolean literal_control_chars
;
626 /* If true, we issue warning messages
630 struct timespec start_time
; /* Time at start of execution. */
632 /* Seconds between 00:00 1/1/70 and either one day before now
633 (the default), or the start of today (if -daystart is given). */
634 time_t cur_day_start
;
636 /* If true, cur_day_start has been adjusted to the start of the day. */
639 int output_block_size
; /* Output block size. */
641 /* bitmask for debug options */
642 unsigned long debug_options
;
644 enum SymlinkOption symlink_handling
;
647 /* Pointer to the function used to stat files. */
648 int (*xstat
) (const char *name
, struct stat
*statbuf
);
651 /* Indicate if we can implement safely_chdir() using the O_NOFOLLOW
654 boolean open_nofollow_available
;
656 /* The variety of regular expression that we support.
657 * The default is POSIX Basic Regular Expressions, but this
658 * can be changed with the positional option, -regextype.
662 /* Optimisation level. One is the default.
664 unsigned short optimisation_level
;
666 extern struct options options
;
671 /* Current depth; 0 means current path is a command line arg. */
674 /* If true, we have called stat on the current path. */
677 /* If true, we know the type of the current path. */
679 mode_t type
; /* this is the actual type */
681 /* The file being operated on, relative to the current directory.
682 Used for stat, readlink, remove, and opendir. */
684 /* The directory fd to which rel_pathname is relative. Thsi is relevant
685 * when we're navigating the hierarchy with fts() and using FTS_CWDFD.
689 /* Length of starting path. */
690 int starting_path_length
;
692 /* If true, don't descend past current directory.
693 Can be set by -prune, -maxdepth, and -xdev/-mount. */
694 boolean stop_at_current_level
;
696 /* Status value to return to system. */
699 /* True if there are any execdirs. This saves us a pair of fchdir()
700 * calls for every directory we leave if it is false. This is just
701 * an optimisation. Set to true if you want to be conservative.
703 boolean execdirs_outstanding
;
707 extern struct state state
;
708 extern char const *starting_dir
;
709 extern int starting_desc
;
710 extern char *program_name
;