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