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 /* 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 GLOBAL bool multi_volume_option;
 203
 204 /* The same variable holds the time, whether mtime or ctime.  Just fake a
 205    non-existing option, for making the code clearer, elsewhere.  */
 206 #define newer_ctime_option newer_mtime_option
 207
 208 /* Specified threshold date and time.  Files having an older time stamp
 209    do not get archived (also see after_date_option above).  */
 210 GLOBAL struct timespec newer_mtime_option;
 211
 212 /* Return true if newer_mtime_option is initialized.  */
 213 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
 214
 215 /* Return true if the struct stat ST's M time is less than
 216    newer_mtime_option.  */
 217 #define OLDER_STAT_TIME(st, m) \
 218   ((st).st_##m##time < newer_mtime_option.tv_sec \
 219    || ((st).st_##m##time == newer_mtime_option.tv_sec \
 220        && TIMESPEC_NS ((st).st_##m##tim) < newer_mtime_option.tv_nsec))
 221
 222 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR.  */
 223 GLOBAL int recursion_option;
 224
 225 GLOBAL bool numeric_owner_option;
 226
 227 GLOBAL bool one_file_system_option;
 228
 229 /* Specified value to be put into tar file in place of stat () results, or
 230    just -1 if such an override should not take place.  */
 231 GLOBAL uid_t owner_option;
 232
 233 GLOBAL bool recursive_unlink_option;
 234
 235 GLOBAL bool read_full_records_option;
 236
 237 GLOBAL bool remove_files_option;
 238
 239 /* Specified rmt command.  */
 240 GLOBAL const char *rmt_command_option;
 241
 242 /* Specified remote shell command.  */
 243 GLOBAL const char *rsh_command_option;
 244
 245 GLOBAL bool same_order_option;
 246
 247 /* If positive, preserve ownership when extracting.  */
 248 GLOBAL int same_owner_option;
 249
 250 /* If positive, preserve permissions when extracting.  */
 251 GLOBAL int same_permissions_option;
 252
 253 /* When set, strip the given number of file name components from the file name
 254    before extracting */
 255 GLOBAL size_t strip_name_components;
 256
 257 GLOBAL bool show_omitted_dirs_option;
 258
 259 GLOBAL bool sparse_option;
 260
 261 GLOBAL bool starting_file_option;
 262
 263 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 264 GLOBAL tarlong tape_length_option;
 265
 266 GLOBAL bool to_stdout_option;
 267
 268 GLOBAL bool totals_option;
 269
 270 GLOBAL bool touch_option;
 271
 272 /* Count how many times the option has been set, multiple setting yields
 273    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 274    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 275 GLOBAL int verbose_option;
 276
 277 GLOBAL bool verify_option;
 278
 279 /* Specified name of file containing the volume number.  */
 280 GLOBAL const char *volno_file_option;
 281
 282 /* Specified value or pattern.  */
 283 GLOBAL const char *volume_label_option;
 284 \f
 285 /* Other global variables.  */
 286
 287 /* File descriptor for archive file.  */
 288 GLOBAL int archive;
 289
 290 /* Nonzero when outputting to /dev/null.  */
 291 GLOBAL bool dev_null_output;
 292
 293 /* Timestamp for when we started execution.  */
 294 #if HAVE_CLOCK_GETTIME
 295   GLOBAL struct timespec start_timespec;
 296 # define start_time (start_timespec.tv_sec)
 297 #else
 298   GLOBAL time_t start_time;
 299 #endif
 300
 301 GLOBAL struct tar_stat_info current_stat_info;
 302
 303 /* List of tape drive names, number of such tape drives, allocated number,
 304    and current cursor in list.  */
 305 GLOBAL const char **archive_name_array;
 306 GLOBAL int archive_names;
 307 GLOBAL int allocated_archive_names;
 308 GLOBAL const char **archive_name_cursor;
 309
 310 /* Output index file name.  */
 311 GLOBAL char const *index_file_name;
 312
 313 /* Structure for keeping track of filenames and lists thereof.  */
 314 struct name
 315   {
 316     struct name *next;
 317     size_t length;              /* cached strlen(name) */
 318     uintmax_t found_count;      /* number of times a matching file has
 319                                    been found */
 320     int isdir;
 321     char firstch;               /* first char is literally matched */
 322     char regexp;                /* this name is a regexp, not literal */
 323     int change_dir;             /* set with the -C option */
 324     char const *dir_contents;   /* for incremental_option */
 325     char fake;                  /* dummy entry */
 326     char name[1];
 327   };
 328
 329 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 330 GLOBAL dev_t ar_dev;
 331 GLOBAL ino_t ar_ino;
 332
 333 GLOBAL bool seekable_archive;
 334
 335 GLOBAL dev_t root_device;
 336
 337 /* Unquote filenames */
 338 GLOBAL bool unquote_option;
 339 \f
 340 /* Declarations for each module.  */
 341
 342 /* FIXME: compare.c should not directly handle the following variable,
 343    instead, this should be done in buffer.c only.  */
 344
 345 enum access_mode
 346 {
 347   ACCESS_READ,
 348   ACCESS_WRITE,
 349   ACCESS_UPDATE
 350 };
 351 extern enum access_mode access_mode;
 352
 353 /* Module buffer.c.  */
 354
 355 extern FILE *stdlis;
 356 extern char *save_name;
 357 extern off_t save_sizeleft;
 358 extern off_t save_totsize;
 359 extern bool write_archive_to_stdout;
 360
 361 size_t available_space_after (union block *);
 362 off_t current_block_ordinal (void);
 363 void close_archive (void);
 364 void closeout_volume_number (void);
 365 union block *find_next_block (void);
 366 void flush_read (void);
 367 void flush_write (void);
 368 void flush_archive (void);
 369 void init_volume_number (void);
 370 void open_archive (enum access_mode);
 371 void print_total_written (void);
 372 void reset_eof (void);
 373 void set_next_block_after (union block *);
 374 void clear_read_error_count (void);
 375 void xclose (int fd);
 376 void archive_write_error (ssize_t) __attribute__ ((noreturn));
 377 void archive_read_error (void);
 378 off_t seek_archive (off_t size);
 379 void set_start_time (void);
 380
 381 /* Module create.c.  */
 382
 383 enum dump_status
 384   {
 385     dump_status_ok,
 386     dump_status_short,
 387     dump_status_fail,
 388     dump_status_not_implemented
 389   };
 390
 391 bool file_dumpable_p (struct tar_stat_info *);
 392 void create_archive (void);
 393 void pad_archive (off_t size_left);
 394 void dump_file (char *, int, dev_t);
 395 union block *start_header (struct tar_stat_info *st);
 396 void finish_header (struct tar_stat_info *, union block *, off_t);
 397 void simple_finish_header (union block *header);
 398 union block *start_private_header (const char *name, size_t size);
 399 void write_eot (void);
 400 void check_links (void);
 401
 402 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 403 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 404 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
 405 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
 406 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 407 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
 408 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 409 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
 410 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
 411 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 412 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 413
 414 void gid_to_chars (gid_t, char *, size_t);
 415 void major_to_chars (major_t, char *, size_t);
 416 void minor_to_chars (minor_t, char *, size_t);
 417 void mode_to_chars (mode_t, char *, size_t);
 418 void off_to_chars (off_t, char *, size_t);
 419 void size_to_chars (size_t, char *, size_t);
 420 void time_to_chars (time_t, char *, size_t);
 421 void uid_to_chars (uid_t, char *, size_t);
 422 void uintmax_to_chars (uintmax_t, char *, size_t);
 423 void string_to_chars (char *, char *, size_t);
 424
 425 /* Module diffarch.c.  */
 426
 427 extern bool now_verifying;
 428
 429 void diff_archive (void);
 430 void diff_init (void);
 431 void verify_volume (void);
 432
 433 /* Module extract.c.  */
 434
 435 extern bool we_are_root;
 436 void extr_init (void);
 437 void extract_archive (void);
 438 void extract_finish (void);
 439 void fatal_exit (void) __attribute__ ((noreturn));
 440
 441 /* Module delete.c.  */
 442
 443 void delete_archive_members (void);
 444
 445 /* Module incremen.c.  */
 446
 447 char *get_directory_contents (char *, dev_t);
 448 void read_directory_file (void);
 449 void write_directory_file (void);
 450 void purge_directory (char const *);
 451
 452 /* Module list.c.  */
 453
 454 enum read_header
 455 {
 456   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 457   HEADER_SUCCESS,               /* header successfully read and checksummed */
 458   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 459   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 460   HEADER_END_OF_FILE,           /* true end of file while header expected */
 461   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 462 };
 463
 464 struct xheader
 465 {
 466   struct obstack *stk;
 467   size_t size;
 468   char *buffer;
 469 };
 470
 471 GLOBAL struct xheader extended_header;
 472 extern union block *current_header;
 473 extern enum archive_format current_format;
 474 extern size_t recent_long_name_blocks;
 475 extern size_t recent_long_link_blocks;
 476
 477 void decode_header (union block *, struct tar_stat_info *,
 478                     enum archive_format *, int);
 479 #define STRINGIFY_BIGINT(i, b) \
 480   stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
 481 char *stringify_uintmax_t_backwards (uintmax_t, char *);
 482 char const *tartime (time_t);
 483
 484 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
 485 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
 486 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
 487 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
 488 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 489 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
 490 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
 491 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
 492 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 493
 494 gid_t gid_from_header (const char *, size_t);
 495 major_t major_from_header (const char *, size_t);
 496 minor_t minor_from_header (const char *, size_t);
 497 mode_t mode_from_header (const char *, size_t);
 498 off_t off_from_header (const char *, size_t);
 499 size_t size_from_header (const char *, size_t);
 500 time_t time_from_header (const char *, size_t);
 501 uid_t uid_from_header (const char *, size_t);
 502 uintmax_t uintmax_from_header (const char *, size_t);
 503
 504 void list_archive (void);
 505 void print_for_mkdir (char *, int, mode_t);
 506 void print_header (struct tar_stat_info *, off_t);
 507 void read_and (void (*) (void));
 508 enum read_header read_header (bool);
 509 enum read_header tar_checksum (union block *header, bool silent);
 510 void skip_file (off_t);
 511 void skip_member (void);
 512
 513 /* Module mangle.c.  */
 514
 515 void extract_mangle (void);
 516
 517 /* Module misc.c.  */
 518
 519 void assign_string (char **, const char *);
 520 char *quote_copy_string (const char *);
 521 int unquote_string (char *);
 522
 523 size_t dot_dot_prefix_len (char const *);
 524
 525 enum remove_option
 526 {
 527   ORDINARY_REMOVE_OPTION,
 528   RECURSIVE_REMOVE_OPTION,
 529
 530   /* FIXME: The following value is never used. It seems to be intended
 531      as a placeholder for a hypothetical option that should instruct tar
 532      to recursively remove subdirectories in purge_directory(),
 533      as opposed to the functionality of --recursive-unlink
 534      (RECURSIVE_REMOVE_OPTION value), which removes them in
 535      prepare_to_extract() phase. However, with the addition of more
 536      meta-info to the incremental dumps, this should become unnecessary */
 537   WANT_DIRECTORY_REMOVE_OPTION
 538 };
 539 int remove_any_file (const char *, enum remove_option);
 540 bool maybe_backup_file (const char *, int);
 541 void undo_last_backup (void);
 542
 543 int deref_stat (bool, char const *, struct stat *);
 544
 545 int chdir_arg (char const *);
 546 void chdir_do (int);
 547
 548 void decode_mode (mode_t, char *);
 549
 550 void chdir_fatal (char const *) __attribute__ ((noreturn));
 551 void chmod_error_details (char const *, mode_t);
 552 void chown_error_details (char const *, uid_t, gid_t);
 553 void close_error (char const *);
 554 void close_warn (char const *);
 555 void close_diag (char const *name);
 556 void exec_fatal (char const *) __attribute__ ((noreturn));
 557 void link_error (char const *, char const *);
 558 void mkdir_error (char const *);
 559 void mkfifo_error (char const *);
 560 void mknod_error (char const *);
 561 void open_error (char const *);
 562 void open_fatal (char const *) __attribute__ ((noreturn));
 563 void open_warn (char const *);
 564 void open_diag (char const *name);
 565 void read_error (char const *);
 566 void read_error_details (char const *, off_t, size_t);
 567 void read_fatal (char const *) __attribute__ ((noreturn));
 568 void read_fatal_details (char const *, off_t, size_t) __attribute__ ((noreturn));
 569 void read_warn_details (char const *, off_t, size_t);
 570 void read_diag_details (char const *name, off_t offset, size_t size);
 571 void readlink_error (char const *);
 572 void readlink_warn (char const *);
 573 void readlink_diag (char const *name);
 574 void savedir_error (char const *);
 575 void savedir_warn (char const *);
 576 void savedir_diag (char const *name);
 577 void seek_error (char const *);
 578 void seek_error_details (char const *, off_t);
 579 void seek_warn (char const *);
 580 void seek_warn_details (char const *, off_t);
 581 void seek_diag_details (char const *, off_t);
 582 void stat_fatal (char const *);
 583 void stat_error (char const *);
 584 void stat_warn (char const *);
 585 void stat_diag (char const *name);
 586 void symlink_error (char const *, char const *);
 587 void truncate_error (char const *);
 588 void truncate_warn (char const *);
 589 void unlink_error (char const *);
 590 void utime_error (char const *);
 591 void waitpid_error (char const *);
 592 void write_error (char const *);
 593 void write_error_details (char const *, size_t, size_t);
 594 void write_fatal (char const *) __attribute__ ((noreturn));
 595 void write_fatal_details (char const *, ssize_t, size_t)
 596      __attribute__ ((noreturn));
 597
 598 pid_t xfork (void);
 599 void xpipe (int[2]);
 600
 601 void *page_aligned_alloc (void **, size_t);
 602
 603 /* Module names.c.  */
 604
 605 extern struct name *gnu_list_name;
 606
 607 void gid_to_gname (gid_t, char **gname);
 608 int gname_to_gid (char const *, gid_t *);
 609 void uid_to_uname (uid_t, char **uname);
 610 int uname_to_uid (char const *, uid_t *);
 611
 612 void init_names (void);
 613 void name_add (const char *);
 614 void name_init (void);
 615 void name_term (void);
 616 char *name_next (int);
 617 void name_gather (void);
 618 struct name *addname (char const *, int);
 619 int name_match (const char *);
 620 void names_notfound (void);
 621 void collect_and_sort_names (void);
 622 struct name *name_scan (const char *);
 623 char *name_from_list (void);
 624 void blank_name_list (void);
 625 char *new_name (const char *, const char *);
 626 char *safer_name_suffix (char const *, bool);
 627 size_t stripped_prefix_len (char const *file_name, size_t num);
 628 bool all_names_found (struct tar_stat_info *);
 629
 630 bool excluded_name (char const *);
 631
 632 void add_avoided_name (char const *);
 633 bool is_avoided_name (char const *);
 634 bool is_individual_file (char const *);
 635
 636 bool contains_dot_dot (char const *);
 637
 638 bool removed_prefixes_p (void);
 639
 640 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 641                     (c)->found_count == occurrence_option)
 642 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 643                      (c)->found_count >= occurrence_option)
 644
 645 /* Module tar.c.  */
 646
 647 void usage (int);
 648
 649 int confirm (const char *, const char *);
 650 void request_stdin (const char *);
 651
 652 void tar_stat_init (struct tar_stat_info *st);
 653 void tar_stat_destroy (struct tar_stat_info *st);
 654 void usage (int) __attribute__ ((noreturn));
 655
 656 /* Module update.c.  */
 657
 658 extern char *output_start;
 659
 660 void update_archive (void);
 661
 662 /* Module xheader.c.  */
 663
 664 void xheader_decode (struct tar_stat_info *);
 665 void xheader_decode_global (void);
 666 void xheader_store (char const *, struct tar_stat_info const *, void *);
 667 void xheader_read (union block *, size_t);
 668 void xheader_write (char type, char *name, struct xheader *xhdr);
 669 void xheader_write_global (void);
 670 void xheader_finish (struct xheader *);
 671 void xheader_destroy (struct xheader *);
 672 char *xheader_xhdr_name (struct tar_stat_info *st);
 673 char *xheader_ghdr_name (void);
 674 void xheader_write (char, char *, struct xheader *);
 675 void xheader_write_global (void);
 676 void xheader_set_option (char *string);
 677
 678 /* Module system.c */
 679
 680 void sys_stat_nanoseconds (struct tar_stat_info *);
 681 void sys_detect_dev_null_output (void);
 682 void sys_save_archive_dev_ino (void);
 683 void sys_drain_input_pipe (void);
 684 void sys_wait_for_child (pid_t);
 685 void sys_spawn_shell (void);
 686 bool sys_compare_uid (struct stat *a, struct stat *b);
 687 bool sys_compare_gid (struct stat *a, struct stat *b);
 688 bool sys_file_is_archive (struct tar_stat_info *p);
 689 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 690 int sys_truncate (int fd);
 691 pid_t sys_child_open_for_compress (void);
 692 pid_t sys_child_open_for_uncompress (void);
 693 size_t sys_write_archive_buffer (void);
 694 bool sys_get_archive_stat (void);
 695
 696 /* Module compare.c */
 697 void report_difference (struct tar_stat_info *st, const char *message, ...);
 698
 699 /* Module sparse.c */
 700 bool sparse_file_p (struct tar_stat_info *);
 701 bool sparse_member_p (struct tar_stat_info *);
 702 bool sparse_fixup_header (struct tar_stat_info *);
 703 enum dump_status sparse_dump_file (int, struct tar_stat_info *);
 704 enum dump_status sparse_extract_file (int, struct tar_stat_info *, off_t *);
 705 enum dump_status sparse_skip_file (struct tar_stat_info *);
 706 bool sparse_diff_file (int, struct tar_stat_info *);
 707
 708 /* Module utf8.c */
 709 bool string_ascii_p (const char *str);
 710 bool utf8_convert (bool to_utf, char const *input, char **output);