Dogcows Code - chaz/tar/blob - src/common.h

   1 /* Common declarations for the tar program.
   2
   3    Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
   4    2003, 2004 Free Software Foundation, Inc.
   5
   6    This program is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by the
   8    Free Software Foundation; either version 2, or (at your option) any later
   9    version.
  10
  11    This program is distributed in the hope that it will be useful, but
  12    WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
  14    Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License along
  17    with this program; if not, write to the Free Software Foundation, Inc.,
  18    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 /* Declare the GNU tar archive format.  */
  21 #include "tar.h"
  22
  23 /* The checksum field is filled with this while the checksum is computed.  */
  24 #define CHKBLANKS       "        "      /* 8 blanks, no null */
  25
  26 /* Some constants from POSIX are given names.  */
  27 #define NAME_FIELD_SIZE   100
  28 #define PREFIX_FIELD_SIZE 155
  29 #define UNAME_FIELD_SIZE   32
  30 #define GNAME_FIELD_SIZE   32
  31
  32 /* FIXME */
  33 #define MAXOCTAL11      017777777777L
  34 #define MAXOCTAL7       07777777
  35
  36
  37 \f
  38 /* Some various global definitions.  */
  39
  40 /* Name of file to use for interacting with user.  */
  41 #if MSDOS
  42 # define TTY_NAME "con"
  43 #else
  44 # define TTY_NAME "/dev/tty"
  45 #endif
  46
  47 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
  48    modules.  Here, we merely set it to "extern" if it is not already set.
  49    GNU tar does depend on the system loader to preset all GLOBAL variables to
  50    neutral (or zero) values, explicit initialization is usually not done.  */
  51 #ifndef GLOBAL
  52 # define GLOBAL extern
  53 #endif
  54
  55 /* Exit status for GNU tar.  Let's try to keep this list as simple as
  56    possible.  -d option strongly invites a status different for unequal
  57    comparison and other errors.  */
  58 GLOBAL int exit_status;
  59
  60 #define TAREXIT_SUCCESS 0
  61 #define TAREXIT_DIFFERS 1
  62 #define TAREXIT_FAILURE 2
  63
  64 /* Both WARN and ERROR write a message on stderr and continue processing,
  65    however ERROR manages so tar will exit unsuccessfully.  FATAL_ERROR
  66    writes a message on stderr and aborts immediately, with another message
  67    line telling so.  USAGE_ERROR works like FATAL_ERROR except that the
  68    other message line suggests trying --help.  All four macros accept a
  69    single argument of the form ((0, errno, _("FORMAT"), Args...)).  errno
  70    is zero when the error is not being detected by the system.  */
  71
  72 #define WARN(Args) \
  73   error Args
  74 #define ERROR(Args) \
  75   (error Args, exit_status = TAREXIT_FAILURE)
  76 #define FATAL_ERROR(Args) \
  77   (error Args, fatal_exit ())
  78 #define USAGE_ERROR(Args) \
  79   (error Args, usage (TAREXIT_FAILURE))
  80 \f
  81 #include "arith.h"
  82 #include <backupfile.h>
  83 #include <exclude.h>
  84 #include <full-write.h>
  85 #include <modechange.h>
  86 #include <quote.h>
  87 #include <safe-read.h>
  88 #include <timespec.h>
  89
  90 /* Log base 2 of common values.  */
  91 #define LG_8 3
  92 #define LG_64 6
  93 #define LG_256 8
  94 \f
  95 /* Information gleaned from the command line.  */
  96
  97 /* Name of this program.  */
  98 GLOBAL const char *program_name;
  99
 100 /* Main command option.  */
 101
 102 enum subcommand
 103 {
 104   UNKNOWN_SUBCOMMAND,           /* none of the following */
 105   APPEND_SUBCOMMAND,            /* -r */
 106   CAT_SUBCOMMAND,               /* -A */
 107   CREATE_SUBCOMMAND,            /* -c */
 108   DELETE_SUBCOMMAND,            /* -D */
 109   DIFF_SUBCOMMAND,              /* -d */
 110   EXTRACT_SUBCOMMAND,           /* -x */
 111   LIST_SUBCOMMAND,              /* -t */
 112   UPDATE_SUBCOMMAND             /* -u */
 113 };
 114
 115 GLOBAL enum subcommand subcommand_option;
 116
 117 /* Selected format for output archive.  */
 118 GLOBAL enum archive_format archive_format;
 119
 120 /* Either NL or NUL, as decided by the --null option.  */
 121 GLOBAL char filename_terminator;
 122
 123 /* Size of each record, once in blocks, once in bytes.  Those two variables
 124    are always related, the second being BLOCKSIZE times the first.  They do
 125    not have _option in their name, even if their values is derived from
 126    option decoding, as these are especially important in tar.  */
 127 GLOBAL int blocking_factor;
 128 GLOBAL size_t record_size;
 129
 130 GLOBAL bool absolute_names_option;
 131
 132 /* Display file times in UTC */
 133 GLOBAL bool utc_option;
 134
 135 /* This variable tells how to interpret newer_mtime_option, below.  If zero,
 136    files get archived if their mtime is not less than newer_mtime_option.
 137    If nonzero, files get archived if *either* their ctime or mtime is not less
 138    than newer_mtime_option.  */
 139 GLOBAL int after_date_option;
 140
 141 GLOBAL bool atime_preserve_option;
 142
 143 GLOBAL bool backup_option;
 144
 145 /* Type of backups being made.  */
 146 GLOBAL enum backup_type backup_type;
 147
 148 GLOBAL bool block_number_option;
 149
 150 GLOBAL bool checkpoint_option;
 151
 152 /* Specified name of compression program, or "gzip" as implied by -z.  */
 153 GLOBAL const char *use_compress_program_option;
 154
 155 GLOBAL bool dereference_option;
 156
 157 /* Print a message if not all links are dumped */
 158 GLOBAL int check_links_option;
 159
 160 /* Patterns that match file names to be excluded.  */
 161 GLOBAL struct exclude *excluded;
 162
 163 /* Specified file containing names to work on.  */
 164 GLOBAL const char *files_from_option;
 165
 166 GLOBAL bool force_local_option;
 167
 168 /* Specified value to be put into tar file in place of stat () results, or
 169    just -1 if such an override should not take place.  */
 170 GLOBAL gid_t group_option;
 171
 172 GLOBAL bool ignore_failed_read_option;
 173
 174 GLOBAL bool ignore_zeros_option;
 175
 176 GLOBAL bool incremental_option;
 177
 178 /* Specified name of script to run at end of each tape change.  */
 179 GLOBAL const char *info_script_option;
 180
 181 GLOBAL bool interactive_option;
 182
 183 /* If nonzero, extract only Nth occurrence of each named file */
 184 GLOBAL uintmax_t occurrence_option;
 185
 186 enum old_files
 187 {
 188   DEFAULT_OLD_FILES,          /* default */
 189   NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
 190   OVERWRITE_OLD_FILES,        /* --overwrite */
 191   UNLINK_FIRST_OLD_FILES,     /* --unlink-first */
 192   KEEP_OLD_FILES,             /* --keep-old-files */
 193   KEEP_NEWER_FILES            /* --keep-newer-files */
 194 };
 195 GLOBAL enum old_files old_files_option;
 196
 197 /* Specified file name for incremental list.  */
 198 GLOBAL const char *listed_incremental_option;
 199
 200 /* Specified mode change string.  */
 201 GLOBAL struct mode_change *mode_option;
 202
 203 GLOBAL bool multi_volume_option;
 204
 205 /* The same variable holds the time, whether mtime or ctime.  Just fake a
 206    non-existing option, for making the code clearer, elsewhere.  */
 207 #define newer_ctime_option newer_mtime_option
 208
 209 /* Specified threshold date and time.  Files having an older time stamp
 210    do not get archived (also see after_date_option above).  */
 211 GLOBAL struct timespec newer_mtime_option;
 212
 213 /* Return true if newer_mtime_option is initialized.  */
 214 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
 215
 216 /* Return true if the struct stat ST's M time is less than
 217    newer_mtime_option.  */
 218 #define OLDER_STAT_TIME(st, m) \
 219   ((st).st_##m##time < newer_mtime_option.tv_sec \
 220    || ((st).st_##m##time == newer_mtime_option.tv_sec \
 221        && TIMESPEC_NS ((st).st_##m##tim) < newer_mtime_option.tv_nsec))
 222
 223 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR.  */
 224 GLOBAL int recursion_option;
 225
 226 GLOBAL bool numeric_owner_option;
 227
 228 GLOBAL bool one_file_system_option;
 229
 230 /* Specified value to be put into tar file in place of stat () results, or
 231    just -1 if such an override should not take place.  */
 232 GLOBAL uid_t owner_option;
 233
 234 GLOBAL bool recursive_unlink_option;
 235
 236 GLOBAL bool read_full_records_option;
 237
 238 GLOBAL bool remove_files_option;
 239
 240 /* Specified rmt command.  */
 241 GLOBAL const char *rmt_command_option;
 242
 243 /* Specified remote shell command.  */
 244 GLOBAL const char *rsh_command_option;
 245
 246 GLOBAL bool same_order_option;
 247
 248 /* If positive, preserve ownership when extracting.  */
 249 GLOBAL int same_owner_option;
 250
 251 /* If positive, preserve permissions when extracting.  */
 252 GLOBAL int same_permissions_option;
 253
 254 /* When set, strip the given number of file name components from the file name
 255    before extracting */
 256 GLOBAL size_t strip_name_components;
 257
 258 GLOBAL bool show_omitted_dirs_option;
 259
 260 GLOBAL bool sparse_option;
 261
 262 GLOBAL bool starting_file_option;
 263
 264 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 265 GLOBAL tarlong tape_length_option;
 266
 267 GLOBAL bool to_stdout_option;
 268
 269 GLOBAL bool totals_option;
 270
 271 GLOBAL bool touch_option;
 272
 273 /* Count how many times the option has been set, multiple setting yields
 274    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 275    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 276 GLOBAL int verbose_option;
 277
 278 GLOBAL bool verify_option;
 279
 280 /* Specified name of file containing the volume number.  */
 281 GLOBAL const char *volno_file_option;
 282
 283 /* Specified value or pattern.  */
 284 GLOBAL const char *volume_label_option;
 285 \f
 286 /* Other global variables.  */
 287
 288 /* File descriptor for archive file.  */
 289 GLOBAL int archive;
 290
 291 /* Nonzero when outputting to /dev/null.  */
 292 GLOBAL bool dev_null_output;
 293
 294 /* Timestamp for when we started execution.  */
 295 #if HAVE_CLOCK_GETTIME
 296   GLOBAL struct timespec start_timespec;
 297 # define start_time (start_timespec.tv_sec)
 298 #else
 299   GLOBAL time_t start_time;
 300 #endif
 301
 302 GLOBAL struct tar_stat_info current_stat_info;
 303
 304 /* List of tape drive names, number of such tape drives, allocated number,
 305    and current cursor in list.  */
 306 GLOBAL const char **archive_name_array;
 307 GLOBAL int archive_names;
 308 GLOBAL int allocated_archive_names;
 309 GLOBAL const char **archive_name_cursor;
 310
 311 /* Output index file name.  */
 312 GLOBAL char const *index_file_name;
 313
 314 /* Structure for keeping track of filenames and lists thereof.  */
 315 struct name
 316   {
 317     struct name *next;
 318     size_t length;              /* cached strlen(name) */
 319     uintmax_t found_count;      /* number of times a matching file has
 320                                    been found */
 321     int isdir;
 322     char firstch;               /* first char is literally matched */
 323     char regexp;                /* this name is a regexp, not literal */
 324     int change_dir;             /* set with the -C option */
 325     char const *dir_contents;   /* for incremental_option */
 326     char fake;                  /* dummy entry */
 327     char name[1];
 328   };
 329
 330 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 331 GLOBAL dev_t ar_dev;
 332 GLOBAL ino_t ar_ino;
 333
 334 GLOBAL bool seekable_archive;
 335
 336 GLOBAL dev_t root_device;
 337
 338 \f
 339 /* Declarations for each module.  */
 340
 341 /* FIXME: compare.c should not directly handle the following variable,
 342    instead, this should be done in buffer.c only.  */
 343
 344 enum access_mode
 345 {
 346   ACCESS_READ,
 347   ACCESS_WRITE,
 348   ACCESS_UPDATE
 349 };
 350 extern enum access_mode access_mode;
 351
 352 /* Module buffer.c.  */
 353
 354 extern FILE *stdlis;
 355 extern char *save_name;
 356 extern off_t save_sizeleft;
 357 extern off_t save_totsize;
 358 extern bool write_archive_to_stdout;
 359
 360 size_t available_space_after (union block *);
 361 off_t current_block_ordinal (void);
 362 void close_archive (void);
 363 void closeout_volume_number (void);
 364 union block *find_next_block (void);
 365 void flush_read (void);
 366 void flush_write (void);
 367 void flush_archive (void);
 368 void init_volume_number (void);
 369 void open_archive (enum access_mode);
 370 void print_total_written (void);
 371 void reset_eof (void);
 372 void set_next_block_after (union block *);
 373 void clear_read_error_count (void);
 374 void xclose (int fd);
 375 void archive_write_error (ssize_t) __attribute__ ((noreturn));
 376 void archive_read_error (void);
 377 off_t seek_archive (off_t size);
 378
 379 /* Module create.c.  */
 380
 381 enum dump_status
 382   {
 383     dump_status_ok,
 384     dump_status_short,
 385     dump_status_fail,
 386     dump_status_not_implemented
 387   };
 388
 389 bool file_dumpable_p (struct tar_stat_info *);
 390 void create_archive (void);
 391 void pad_archive (off_t size_left);
 392 void dump_file (char *, int, dev_t);
 393 union block *start_header (struct tar_stat_info *st);
 394 void finish_header (struct tar_stat_info *, union block *, off_t);
 395 void simple_finish_header (union block *header);
 396 union block *start_private_header (const char *name, size_t size);
 397 void write_eot (void);
 398 void check_links (void);
 399
 400 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 401 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 402 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
 403 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
 404 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 405 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
 406 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 407 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
 408 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
 409 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 410 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 411
 412 void gid_to_chars (gid_t, char *, size_t);
 413 void major_to_chars (major_t, char *, size_t);
 414 void minor_to_chars (minor_t, char *, size_t);
 415 void mode_to_chars (mode_t, char *, size_t);
 416 void off_to_chars (off_t, char *, size_t);
 417 void size_to_chars (size_t, char *, size_t);
 418 void time_to_chars (time_t, char *, size_t);
 419 void uid_to_chars (uid_t, char *, size_t);
 420 void uintmax_to_chars (uintmax_t, char *, size_t);
 421 void string_to_chars (char *, char *, size_t);
 422
 423 /* Module diffarch.c.  */
 424
 425 extern bool now_verifying;
 426
 427 void diff_archive (void);
 428 void diff_init (void);
 429 void verify_volume (void);
 430
 431 /* Module extract.c.  */
 432
 433 extern bool we_are_root;
 434 void extr_init (void);
 435 void extract_archive (void);
 436 void extract_finish (void);
 437 void fatal_exit (void) __attribute__ ((noreturn));
 438
 439 /* Module delete.c.  */
 440
 441 void delete_archive_members (void);
 442
 443 /* Module incremen.c.  */
 444
 445 char *get_directory_contents (char *, dev_t);
 446 void read_directory_file (void);
 447 void write_directory_file (void);
 448 void purge_directory (char const *);
 449
 450 /* Module list.c.  */
 451
 452 enum read_header
 453 {
 454   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 455   HEADER_SUCCESS,               /* header successfully read and checksummed */
 456   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 457   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 458   HEADER_END_OF_FILE,           /* true end of file while header expected */
 459   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 460 };
 461
 462 struct xheader
 463 {
 464   struct obstack *stk;
 465   size_t size;
 466   char *buffer;
 467 };
 468
 469 GLOBAL struct xheader extended_header;
 470 extern union block *current_header;
 471 extern enum archive_format current_format;
 472 extern size_t recent_long_name_blocks;
 473 extern size_t recent_long_link_blocks;
 474
 475 void decode_header (union block *, struct tar_stat_info *,
 476                     enum archive_format *, int);
 477 #define STRINGIFY_BIGINT(i, b) \
 478   stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
 479 char *stringify_uintmax_t_backwards (uintmax_t, char *);
 480 char const *tartime (time_t);
 481
 482 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
 483 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
 484 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
 485 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
 486 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 487 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
 488 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
 489 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
 490 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 491
 492 gid_t gid_from_header (const char *, size_t);
 493 major_t major_from_header (const char *, size_t);
 494 minor_t minor_from_header (const char *, size_t);
 495 mode_t mode_from_header (const char *, size_t);
 496 off_t off_from_header (const char *, size_t);
 497 size_t size_from_header (const char *, size_t);
 498 time_t time_from_header (const char *, size_t);
 499 uid_t uid_from_header (const char *, size_t);
 500 uintmax_t uintmax_from_header (const char *, size_t);
 501
 502 void list_archive (void);
 503 void print_for_mkdir (char *, int, mode_t);
 504 void print_header (struct tar_stat_info *, off_t);
 505 void read_and (void (*) (void));
 506 enum read_header read_header (bool);
 507 void skip_file (off_t);
 508 void skip_member (void);
 509
 510 /* Module mangle.c.  */
 511
 512 void extract_mangle (void);
 513
 514 /* Module misc.c.  */
 515
 516 void assign_string (char **, const char *);
 517 char *quote_copy_string (const char *);
 518 int unquote_string (char *);
 519
 520 size_t dot_dot_prefix_len (char const *);
 521
 522 enum remove_option
 523 {
 524   ORDINARY_REMOVE_OPTION,
 525   RECURSIVE_REMOVE_OPTION,
 526   WANT_DIRECTORY_REMOVE_OPTION
 527 };
 528 int remove_any_file (const char *, enum remove_option);
 529 bool maybe_backup_file (const char *, int);
 530 void undo_last_backup (void);
 531
 532 int deref_stat (bool, char const *, struct stat *);
 533
 534 int chdir_arg (char const *);
 535 void chdir_do (int);
 536
 537 void decode_mode (mode_t, char *);
 538
 539 void chdir_fatal (char const *) __attribute__ ((noreturn));
 540 void chmod_error_details (char const *, mode_t);
 541 void chown_error_details (char const *, uid_t, gid_t);
 542 void close_error (char const *);
 543 void close_warn (char const *);
 544 void close_diag (char const *name);
 545 void exec_fatal (char const *) __attribute__ ((noreturn));
 546 void link_error (char const *, char const *);
 547 void mkdir_error (char const *);
 548 void mkfifo_error (char const *);
 549 void mknod_error (char const *);
 550 void open_error (char const *);
 551 void open_fatal (char const *) __attribute__ ((noreturn));
 552 void open_warn (char const *);
 553 void open_diag (char const *name);
 554 void read_error (char const *);
 555 void read_error_details (char const *, off_t, size_t);
 556 void read_fatal (char const *) __attribute__ ((noreturn));
 557 void read_fatal_details (char const *, off_t, size_t) __attribute__ ((noreturn));
 558 void read_warn_details (char const *, off_t, size_t);
 559 void read_diag_details (char const *name, off_t offset, size_t size);
 560 void readlink_error (char const *);
 561 void readlink_warn (char const *);
 562 void readlink_diag (char const *name);
 563 void savedir_error (char const *);
 564 void savedir_warn (char const *);
 565 void savedir_diag (char const *name);
 566 void seek_error (char const *);
 567 void seek_error_details (char const *, off_t);
 568 void seek_warn (char const *);
 569 void seek_warn_details (char const *, off_t);
 570 void seek_diag_details (char const *, off_t);
 571 void stat_error (char const *);
 572 void stat_warn (char const *);
 573 void stat_diag (char const *name);
 574 void symlink_error (char const *, char const *);
 575 void truncate_error (char const *);
 576 void truncate_warn (char const *);
 577 void unlink_error (char const *);
 578 void utime_error (char const *);
 579 void waitpid_error (char const *);
 580 void write_error (char const *);
 581 void write_error_details (char const *, size_t, size_t);
 582 void write_fatal (char const *) __attribute__ ((noreturn));
 583 void write_fatal_details (char const *, ssize_t, size_t)
 584      __attribute__ ((noreturn));
 585
 586 pid_t xfork (void);
 587 void xpipe (int[2]);
 588
 589 void *page_aligned_alloc (void **, size_t);
 590
 591 /* Module names.c.  */
 592
 593 extern struct name *gnu_list_name;
 594
 595 void gid_to_gname (gid_t, char **gname);
 596 int gname_to_gid (char const *, gid_t *);
 597 void uid_to_uname (uid_t, char **uname);
 598 int uname_to_uid (char const *, uid_t *);
 599
 600 void init_names (void);
 601 void name_add (const char *);
 602 void name_init (void);
 603 void name_term (void);
 604 char *name_next (int);
 605 void name_close (void);
 606 void name_gather (void);
 607 struct name *addname (char const *, int);
 608 int name_match (const char *);
 609 void names_notfound (void);
 610 void collect_and_sort_names (void);
 611 struct name *name_scan (const char *);
 612 char *name_from_list (void);
 613 void blank_name_list (void);
 614 char *new_name (const char *, const char *);
 615 char *safer_name_suffix (char const *, bool);
 616 size_t stripped_prefix_len (char const *file_name, size_t num);
 617 bool all_names_found (struct tar_stat_info *);
 618
 619 bool excluded_name (char const *);
 620
 621 void add_avoided_name (char const *);
 622 bool is_avoided_name (char const *);
 623
 624 bool contains_dot_dot (char const *);
 625
 626 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 627                     (c)->found_count == occurrence_option)
 628 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 629                      (c)->found_count >= occurrence_option)
 630
 631 /* Module tar.c.  */
 632
 633 void usage (int);
 634
 635 int confirm (const char *, const char *);
 636 void request_stdin (const char *);
 637
 638 void tar_stat_init (struct tar_stat_info *st);
 639 void tar_stat_destroy (struct tar_stat_info *st);
 640 void usage (int) __attribute__ ((noreturn));
 641
 642 /* Module update.c.  */
 643
 644 extern char *output_start;
 645
 646 void update_archive (void);
 647
 648 /* Module xheader.c.  */
 649
 650 void xheader_decode (struct tar_stat_info *);
 651 void xheader_decode_global (void);
 652 void xheader_store (char const *, struct tar_stat_info const *, void *);
 653 void xheader_read (union block *, size_t);
 654 void xheader_write (char type, char *name, struct xheader *xhdr);
 655 void xheader_write_global (void);
 656 void xheader_finish (struct xheader *);
 657 void xheader_destroy (struct xheader *);
 658 char *xheader_xhdr_name (struct tar_stat_info *st);
 659 char *xheader_ghdr_name (void);
 660 void xheader_write (char, char *, struct xheader *);
 661 void xheader_write_global (void);
 662 void xheader_set_option (char *string);
 663
 664 /* Module system.c */
 665
 666 void sys_stat_nanoseconds (struct tar_stat_info *);
 667 void sys_detect_dev_null_output (void);
 668 void sys_save_archive_dev_ino (void);
 669 void sys_drain_input_pipe (void);
 670 void sys_wait_for_child (pid_t);
 671 void sys_spawn_shell (void);
 672 bool sys_compare_uid (struct stat *a, struct stat *b);
 673 bool sys_compare_gid (struct stat *a, struct stat *b);
 674 bool sys_file_is_archive (struct tar_stat_info *p);
 675 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 676 int sys_truncate (int fd);
 677 void sys_reset_uid_gid (void);
 678 pid_t sys_child_open_for_compress (void);
 679 pid_t sys_child_open_for_uncompress (void);
 680 void sys_reset_uid_gid (void);
 681 size_t sys_write_archive_buffer (void);
 682 bool sys_get_archive_stat (void);
 683 void sys_reset_uid_gid (void);
 684
 685 /* Module compare.c */
 686 void report_difference (struct tar_stat_info *st, const char *message, ...);
 687
 688 /* Module sparse.c */
 689 bool sparse_file_p (struct tar_stat_info *);
 690 bool sparse_member_p (struct tar_stat_info *);
 691 bool sparse_fixup_header (struct tar_stat_info *);
 692 enum dump_status sparse_dump_file (int, struct tar_stat_info *);
 693 enum dump_status sparse_extract_file (int, struct tar_stat_info *, off_t *);
 694 enum dump_status sparse_skip_file (struct tar_stat_info *);
 695 bool sparse_diff_file (int, struct tar_stat_info *);
 696
 697 /* Module utf8.c */
 698 bool string_ascii_p (const char *str);
 699 bool utf8_convert (bool to_utf, char const *input, char **output);