find/defs.h

   1 /* defs.h -- data types and declarations.
   2    Copyright (C) 1990, 91, 92, 93, 94, 2000, 2004 Free Software Foundation, Inc.
   3
   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)
   7    any later version.
   8
   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.
  13
  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., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
  17    USA.
  18 */
  19 #ifndef INC_DEFS_H
  20 #define INC_DEFS_H 1
  21
  22 #include <config.h>
  23 #include <sys/types.h>
  24 #include <sys/stat.h>
  25 #include <stdio.h>
  26
  27 #if defined(HAVE_STRING_H) || defined(STDC_HEADERS)
  28 #include <string.h>
  29 #else
  30 #include <strings.h>
  31 #ifndef strchr
  32 #define strchr index
  33 #endif
  34 #ifndef strrchr
  35 #define strrchr rindex
  36 #endif
  37 #endif
  38
  39 #include <errno.h>
  40 #ifndef errno
  41 extern int errno;
  42 #endif
  43
  44 #ifdef STDC_HEADERS
  45 #include <stdlib.h>
  46 #endif
  47
  48 #ifdef HAVE_UNISTD_H
  49 #include <unistd.h>
  50 #endif
  51
  52 #include <time.h>
  53
  54 #if HAVE_LIMITS_H
  55 # include <limits.h>
  56 #endif
  57 #ifndef CHAR_BIT
  58 # define CHAR_BIT 8
  59 #endif
  60
  61 #if HAVE_INTTYPES_H
  62 # include <inttypes.h>
  63 #endif
  64
  65 #include "regex.h"
  66
  67 #ifndef S_IFLNK
  68 #define lstat stat
  69 #endif
  70
  71 # ifndef PARAMS
  72 #  if defined PROTOTYPES || (defined __STDC__ && __STDC__)
  73 #   define PARAMS(Args) Args
  74 #  else
  75 #   define PARAMS(Args) ()
  76 #  endif
  77 # endif
  78
  79 int lstat PARAMS((const char *__path, struct stat *__statbuf));
  80 int stat PARAMS((const char *__path, struct stat *__statbuf));
  81
  82 int optionl_stat PARAMS((const char *name, struct stat *p));
  83 int optionp_stat PARAMS((const char *name, struct stat *p));
  84 int optionh_stat PARAMS((const char *name, struct stat *p));
  85
  86 int get_statinfo PARAMS((const char *pathname, const char *name, struct stat *p));
  87
  88
  89
  90 #ifndef S_ISUID
  91 # define S_ISUID 0004000
  92 #endif
  93 #ifndef S_ISGID
  94 # define S_ISGID 0002000
  95 #endif
  96 #ifndef S_ISVTX
  97 # define S_ISVTX 0001000
  98 #endif
  99 #ifndef S_IRUSR
 100 # define S_IRUSR 0000400
 101 #endif
 102 #ifndef S_IWUSR
 103 # define S_IWUSR 0000200
 104 #endif
 105 #ifndef S_IXUSR
 106 # define S_IXUSR 0000100
 107 #endif
 108 #ifndef S_IRGRP
 109 # define S_IRGRP 0000040
 110 #endif
 111 #ifndef S_IWGRP
 112 # define S_IWGRP 0000020
 113 #endif
 114 #ifndef S_IXGRP
 115 # define S_IXGRP 0000010
 116 #endif
 117 #ifndef S_IROTH
 118 # define S_IROTH 0000004
 119 #endif
 120 #ifndef S_IWOTH
 121 # define S_IWOTH 0000002
 122 #endif
 123 #ifndef S_IXOTH
 124 # define S_IXOTH 0000001
 125 #endif
 126
 127 #define MODE_WXUSR      (S_IWUSR | S_IXUSR)
 128 #define MODE_R          (S_IRUSR | S_IRGRP | S_IROTH)
 129 #define MODE_RW         (S_IWUSR | S_IWGRP | S_IWOTH | MODE_R)
 130 #define MODE_RWX        (S_IXUSR | S_IXGRP | S_IXOTH | MODE_RW)
 131 #define MODE_ALL        (S_ISUID | S_ISGID | S_ISVTX | MODE_RWX)
 132
 133 #if 1
 134 #include <stdbool.h>
 135 typedef bool boolean;
 136 #else
 137 /* Not char because of type promotion; NeXT gcc can't handle it.  */
 138 typedef int boolean;
 139 #define         true    1
 140 #define         false   0
 141 #endif
 142
 143 /* Pointer to function returning boolean. */
 144 typedef boolean (*PFB)();
 145
 146 /* The number of seconds in a day. */
 147 #define         DAYSECS     86400
 148
 149 /* Argument structures for predicates. */
 150
 151 enum comparison_type
 152 {
 153   COMP_GT,
 154   COMP_LT,
 155   COMP_EQ
 156 };
 157
 158 enum permissions_type
 159 {
 160   PERM_AT_LEAST,
 161   PERM_ANY,
 162   PERM_EXACT
 163 };
 164
 165 enum predicate_type
 166 {
 167   NO_TYPE,
 168   PRIMARY_TYPE,
 169   UNI_OP,
 170   BI_OP,
 171   OPEN_PAREN,
 172   CLOSE_PAREN
 173 };
 174
 175 enum predicate_precedence
 176 {
 177   NO_PREC,
 178   COMMA_PREC,
 179   OR_PREC,
 180   AND_PREC,
 181   NEGATE_PREC,
 182   MAX_PREC
 183 };
 184
 185 struct long_val
 186 {
 187   enum comparison_type kind;
 188   boolean negative;             /* Defined only when representing time_t.  */
 189   uintmax_t l_val;
 190 };
 191
 192 struct perm_val
 193 {
 194   enum permissions_type kind;
 195   mode_t val;
 196 };
 197
 198 /* dir_id is used to support loop detection in find.c and
 199  * also to support the -samefile test.
 200  */
 201 struct dir_id
 202 {
 203   ino_t ino;
 204   dev_t dev;
 205 };
 206
 207 struct size_val
 208 {
 209   enum comparison_type kind;
 210   int blocksize;
 211   uintmax_t size;
 212 };
 213
 214 #define NEW_EXEC 1
 215 /*
 216 #undef NEW_EXEC
 217 */
 218
 219 #if !defined(NEW_EXEC)
 220 struct path_arg
 221 {
 222   short offset;                 /* Offset in `vec' of this arg. */
 223   short count;                  /* Number of path replacements in this arg. */
 224   char *origarg;                /* Arg with "{}" intact. */
 225 };
 226 #endif
 227
 228 #include "buildcmd.h"
 229
 230 struct exec_val
 231 {
 232 #if defined(NEW_EXEC)
 233   /* new-style */
 234   boolean multiple;             /* -exec {} \+ denotes multiple argument. */
 235   struct buildcmd_control ctl;
 236   struct buildcmd_state   state;
 237   char **replace_vec;           /* Command arguments (for ";" style) */
 238   int num_args;
 239   boolean use_current_dir;      /* If nonzero, don't chdir to start dir */
 240 #else
 241   struct path_arg *paths;       /* Array of args with path replacements. */
 242   char **vec;                   /* Array of args to pass to program. */
 243 #endif
 244 };
 245
 246 /* The format string for a -printf or -fprintf is chopped into one or
 247    more `struct segment', linked together into a list.
 248    Each stretch of plain text is a segment, and
 249    each \c and `%' conversion is a segment. */
 250
 251 /* Special values for the `kind' field of `struct segment'. */
 252 #define KIND_PLAIN 0            /* Segment containing just plain text. */
 253 #define KIND_STOP 1             /* \c -- stop printing and flush output. */
 254
 255 struct segment
 256 {
 257   int kind;                     /* Format chars or KIND_{PLAIN,STOP}. */
 258   char *text;                   /* Plain text or `%' format string. */
 259   int text_len;                 /* Length of `text'. */
 260   struct segment *next;         /* Next segment for this predicate. */
 261 };
 262
 263 struct format_val
 264 {
 265   struct segment *segment;      /* Linked list of segments. */
 266   FILE *stream;                 /* Output stream to print on. */
 267 };
 268
 269 struct predicate
 270 {
 271   /* Pointer to the function that implements this predicate.  */
 272   PFB pred_func;
 273
 274   /* Only used for debugging, but defined unconditionally so individual
 275      modules can be compiled with -DDEBUG.  */
 276   char *p_name;
 277
 278   /* The type of this node.  There are two kinds.  The first is real
 279      predicates ("primaries") such as -perm, -print, or -exec.  The
 280      other kind is operators for combining predicates. */
 281   enum predicate_type p_type;
 282
 283   /* The precedence of this node.  Only has meaning for operators. */
 284   enum predicate_precedence p_prec;
 285
 286   /* True if this predicate node produces side effects.
 287      If side_effects are produced
 288      then optimization will not be performed */
 289   boolean side_effects;
 290
 291   /* True if this predicate node requires default print be turned off. */
 292   boolean no_default_print;
 293
 294   /* True if this predicate node requires a stat system call to execute. */
 295   boolean need_stat;
 296
 297   /* True if this predicate node requires knowledge of the file type. */
 298   boolean need_type;
 299
 300   /* Information needed by the predicate processor.
 301      Next to each member are listed the predicates that use it. */
 302   union
 303   {
 304     char *str;                  /* fstype [i]lname [i]name [i]path */
 305     struct re_pattern_buffer *regex; /* regex */
 306     struct exec_val exec_vec;   /* exec ok */
 307     struct long_val info;       /* atime ctime gid inum links mtime
 308                                    size uid */
 309     struct size_val size;       /* size */
 310     uid_t uid;                  /* user */
 311     gid_t gid;                  /* group */
 312     time_t time;                /* newer */
 313     struct perm_val perm;       /* perm */
 314     struct dir_id   fileid;     /* samefile */
 315     mode_t type;                /* type */
 316     FILE *stream;               /* fprint fprint0 */
 317     struct format_val printf_vec; /* printf fprintf */
 318   } args;
 319
 320   /* The next predicate in the user input sequence,
 321      which repesents the order in which the user supplied the
 322      predicates on the command line. */
 323   struct predicate *pred_next;
 324
 325   /* The right and left branches from this node in the expression
 326      tree, which represents the order in which the nodes should be
 327      processed. */
 328   struct predicate *pred_left;
 329   struct predicate *pred_right;
 330 };
 331
 332 /* find.c. */
 333 int get_info PARAMS((const char *pathname, const char *name, struct stat *p, struct predicate *pred_ptr));
 334
 335
 336 /* find library function declarations.  */
 337
 338 /* dirname.c */
 339 char *dirname PARAMS((char *path));
 340
 341 /* error.c */
 342 void error PARAMS((int status, int errnum, char *message, ...));
 343
 344 /* listfile.c */
 345 void list_file PARAMS((char *name, char *relname, struct stat *statp, time_t current_time, int output_block_size, FILE *stream));
 346 char *get_link_name PARAMS((char *name, char *relname));
 347
 348 /* stpcpy.c */
 349 #if !HAVE_STPCPY
 350 char *stpcpy PARAMS((char *dest, const char *src));
 351 #endif
 352
 353 /* xgetcwd.c */
 354 char *xgetcwd PARAMS((void));
 355
 356 /* xmalloc.c */
 357 #if __STDC__
 358 #define VOID void
 359 #else
 360 #define VOID char
 361 #endif
 362
 363 /* find global function declarations.  */
 364
 365 /* find.c */
 366 /* SymlinkOption represents the choice of
 367  * -P, -L or -P (default) on the command line.
 368  */
 369 enum SymlinkOption
 370   {
 371     SYMLINK_NEVER_DEREF,        /* Option -P */
 372     SYMLINK_ALWAYS_DEREF,       /* Option -L */
 373     SYMLINK_DEREF_ARGSONLY      /* Option -H */
 374   };
 375 extern enum SymlinkOption symlink_handling; /* defined in find.c. */
 376
 377 void set_follow_state PARAMS((enum SymlinkOption opt));
 378 void cleanup(void);
 379
 380 /* fstype.c */
 381 char *filesystem_type PARAMS((const struct stat *statp));
 382 char * get_mounted_filesystems (void);
 383 dev_t * get_mounted_devices PARAMS((size_t *));
 384
 385 /* parser.c */
 386 PFB find_parser PARAMS((char *search_name));
 387 boolean parse_close PARAMS((char *argv[], int *arg_ptr));
 388 boolean parse_open PARAMS((char *argv[], int *arg_ptr));
 389 boolean parse_print PARAMS((char *argv[], int *arg_ptr));
 390
 391 /* pred.c */
 392 boolean pred_amin PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 393 boolean pred_and PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 394 boolean pred_anewer PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 395 boolean pred_atime PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 396 boolean pred_close PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 397 boolean pred_cmin PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 398 boolean pred_cnewer PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 399 boolean pred_comma PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 400 boolean pred_ctime PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 401 boolean pred_delete PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 402 boolean pred_empty PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 403 boolean pred_exec PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 404 boolean pred_execdir PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 405 boolean pred_false PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 406 boolean pred_fls PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 407 boolean pred_fprint PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 408 boolean pred_fprint0 PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 409 boolean pred_fprintf PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 410 boolean pred_fstype PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 411 boolean pred_gid PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 412 boolean pred_group PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 413 boolean pred_ilname PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 414 boolean pred_iname PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 415 boolean pred_inum PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 416 boolean pred_ipath PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 417 boolean pred_links PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 418 boolean pred_lname PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 419 boolean pred_ls PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 420 boolean pred_mmin PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 421 boolean pred_mtime PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 422 boolean pred_name PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 423 boolean pred_negate PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 424 boolean pred_newer PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 425 boolean pred_nogroup PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 426 boolean pred_nouser PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 427 boolean pred_ok PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 428 boolean pred_okdir PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 429 boolean pred_open PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 430 boolean pred_or PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 431 boolean pred_path PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 432 boolean pred_perm PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 433 boolean pred_print PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 434 boolean pred_print0 PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 435 boolean pred_prune PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 436 boolean pred_quit PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 437 boolean pred_regex PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 438 boolean pred_samefile PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 439 boolean pred_size PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 440 boolean pred_true PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 441 boolean pred_type PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 442 boolean pred_uid PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 443 boolean pred_used PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 444 boolean pred_user PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 445 boolean pred_xtype PARAMS((char *pathname, struct stat *stat_buf, struct predicate *pred_ptr));
 446
 447 int launch PARAMS((const struct buildcmd_control *ctl,
 448                    struct buildcmd_state *buildstate));
 449
 450
 451 char *find_pred_name PARAMS((PFB pred_func));
 452
 453
 454
 455 #ifdef DEBUG
 456 void print_tree PARAMS((FILE*, struct predicate *node, int indent));
 457 void print_list PARAMS((FILE*, struct predicate *node));
 458 void print_optlist PARAMS((FILE *fp, struct predicate *node));
 459 #endif /* DEBUG */
 460
 461 /* tree.c */
 462 struct predicate *
 463 get_expr PARAMS((struct predicate **input, short int prev_prec));
 464 boolean opt_expr PARAMS((struct predicate **eval_treep));
 465 boolean mark_stat PARAMS((struct predicate *tree));
 466 boolean mark_type PARAMS((struct predicate *tree));
 467
 468 /* util.c */
 469 struct predicate *get_new_pred PARAMS((void));
 470 struct predicate *get_new_pred_chk_op PARAMS((void));
 471 struct predicate *insert_primary PARAMS((boolean (*pred_func )()));
 472 void usage PARAMS((char *msg));
 473
 474 extern char *program_name;
 475 extern struct predicate *predicates;
 476 extern struct predicate *last_pred;
 477
 478 struct options
 479 {
 480   /* If true, process directory before contents.  True unless -depth given. */
 481   boolean do_dir_first;
 482
 483   /* If >=0, don't descend more than this many levels of subdirectories. */
 484   int maxdepth;
 485
 486   /* If >=0, don't process files above this level. */
 487   int mindepth;
 488
 489   /* If true, do not assume that files in directories with nlink == 2
 490      are non-directories. */
 491   boolean no_leaf_check;
 492
 493   /* If true, don't cross filesystem boundaries. */
 494   boolean stay_on_filesystem;
 495
 496   /* If true, we ignore the problem where we find that a directory entry
 497    * no longer exists by the time we get around to processing it.
 498    */
 499   boolean ignore_readdir_race;
 500
 501 /* If true, we issue warning messages
 502  */
 503   boolean warnings;
 504   time_t start_time;            /* Time at start of execution.  */
 505
 506   /* Seconds between 00:00 1/1/70 and either one day before now
 507      (the default), or the start of today (if -daystart is given). */
 508   time_t cur_day_start;
 509
 510   /* If true, cur_day_start has been adjusted to the start of the day. */
 511   boolean full_days;
 512
 513   int output_block_size;        /* Output block size.  */
 514
 515   enum SymlinkOption symlink_handling;
 516
 517
 518   /* Pointer to the function used to stat files. */
 519   int (*xstat) (const char *name, struct stat *statbuf);
 520 };
 521 extern struct options options;
 522
 523
 524 struct state
 525 {
 526   /* Current depth; 0 means current path is a command line arg. */
 527   int curdepth;
 528
 529   /* If true, we have called stat on the current path. */
 530   boolean have_stat;
 531
 532   /* If true, we know the type of the current path. */
 533   boolean have_type;
 534   mode_t type;                  /* this is the actual type */
 535
 536   /* The file being operated on, relative to the current directory.
 537      Used for stat, readlink, remove, and opendir.  */
 538   char *rel_pathname;
 539
 540   /* Length of current path. */
 541   int path_length;
 542
 543   /* If true, don't descend past current directory.
 544      Can be set by -prune, -maxdepth, and -xdev/-mount. */
 545   boolean stop_at_current_level;
 546
 547   /* Status value to return to system. */
 548   int exit_status;
 549 };
 550 extern struct state state;
 551
 552 extern char const *starting_dir;
 553 extern int starting_desc;
 554 #if ! defined HAVE_FCHDIR && ! defined fchdir
 555 # define fchdir(fd) (-1)
 556 #endif
 557
 558 #endif