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