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