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, 2007, 2008, 2009, 2010 Free Software Foundation,
   5    Inc.
   6
   7    This program is free software; you can redistribute it and/or modify it
   8    under the terms of the GNU General Public License as published by the
   9    Free Software Foundation; either version 3, or (at your option) any later
  10    version.
  11
  12    This program is distributed in the hope that it will be useful, but
  13    WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
  15    Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License along
  18    with this program; if not, write to the Free Software Foundation, Inc.,
  19    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  20
  21 /* Declare the GNU tar archive format.  */
  22 #include "tar.h"
  23
  24 /* The checksum field is filled with this while the checksum is computed.  */
  25 #define CHKBLANKS       "        "      /* 8 blanks, no null */
  26
  27 /* Some constants from POSIX are given names.  */
  28 #define NAME_FIELD_SIZE   100
  29 #define PREFIX_FIELD_SIZE 155
  30 #define UNAME_FIELD_SIZE   32
  31 #define GNAME_FIELD_SIZE   32
  32
  33
  34 \f
  35 /* Some various global definitions.  */
  36
  37 /* Name of file to use for interacting with user.  */
  38
  39 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
  40    modules.  Here, we merely set it to "extern" if it is not already set.
  41    GNU tar does depend on the system loader to preset all GLOBAL variables to
  42    neutral (or zero) values, explicit initialization is usually not done.  */
  43 #ifndef GLOBAL
  44 # define GLOBAL extern
  45 #endif
  46
  47 #define TAREXIT_SUCCESS PAXEXIT_SUCCESS
  48 #define TAREXIT_DIFFERS PAXEXIT_DIFFERS
  49 #define TAREXIT_FAILURE PAXEXIT_FAILURE
  50
  51 \f
  52 #include "arith.h"
  53 #include <backupfile.h>
  54 #include <exclude.h>
  55 #include <full-write.h>
  56 #include <modechange.h>
  57 #include <quote.h>
  58 #include <safe-read.h>
  59 #include <stat-time.h>
  60 #include <timespec.h>
  61 #define obstack_chunk_alloc xmalloc
  62 #define obstack_chunk_free free
  63 #include <obstack.h>
  64 #include <progname.h>
  65 #include <xvasprintf.h>
  66
  67 #include <paxlib.h>
  68
  69 /* Log base 2 of common values.  */
  70 #define LG_8 3
  71 #define LG_64 6
  72 #define LG_256 8
  73 \f
  74 /* Information gleaned from the command line.  */
  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   TEST_LABEL_SUBCOMMAND,        /* --test-label */
  90 };
  91
  92 GLOBAL enum subcommand subcommand_option;
  93
  94 /* Selected format for output archive.  */
  95 GLOBAL enum archive_format archive_format;
  96
  97 /* Size of each record, once in blocks, once in bytes.  Those two variables
  98    are always related, the second being BLOCKSIZE times the first.  They do
  99    not have _option in their name, even if their values is derived from
 100    option decoding, as these are especially important in tar.  */
 101 GLOBAL int blocking_factor;
 102 GLOBAL size_t record_size;
 103
 104 GLOBAL bool absolute_names_option;
 105
 106 /* Display file times in UTC */
 107 GLOBAL bool utc_option;
 108 /* Output file timestamps to the full resolution */
 109 GLOBAL bool full_time_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 #define DEFAULT_CHECKPOINT 10
 134
 135 /* Specified name of compression program, or "gzip" as implied by -z.  */
 136 GLOBAL const char *use_compress_program_option;
 137
 138 GLOBAL bool dereference_option;
 139 GLOBAL bool hard_dereference_option;
 140
 141 /* Print a message if not all links are dumped */
 142 GLOBAL int check_links_option;
 143
 144 /* Patterns that match file names to be excluded.  */
 145 GLOBAL struct exclude *excluded;
 146
 147 enum exclusion_tag_type
 148   {
 149     exclusion_tag_none,
 150      /* Exclude the directory contents, but preserve the directory
 151         itself and the exclusion tag file */
 152     exclusion_tag_contents,
 153     /* Exclude everything below the directory, preserving the directory
 154        itself */
 155     exclusion_tag_under,
 156     /* Exclude entire directory  */
 157     exclusion_tag_all,
 158   };
 159
 160 /* Specified value to be put into tar file in place of stat () results, or
 161    just null and -1 if such an override should not take place.  */
 162 GLOBAL char const *group_name_option;
 163 GLOBAL gid_t group_option;
 164
 165 GLOBAL bool ignore_failed_read_option;
 166
 167 GLOBAL bool ignore_zeros_option;
 168
 169 GLOBAL bool incremental_option;
 170
 171 /* Specified name of script to run at end of each tape change.  */
 172 GLOBAL const char *info_script_option;
 173
 174 GLOBAL bool interactive_option;
 175
 176 /* If nonzero, extract only Nth occurrence of each named file */
 177 GLOBAL uintmax_t occurrence_option;
 178
 179 enum old_files
 180 {
 181   DEFAULT_OLD_FILES,          /* default */
 182   NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
 183   OVERWRITE_OLD_FILES,        /* --overwrite */
 184   UNLINK_FIRST_OLD_FILES,     /* --unlink-first */
 185   KEEP_OLD_FILES,             /* --keep-old-files */
 186   KEEP_NEWER_FILES            /* --keep-newer-files */
 187 };
 188 GLOBAL enum old_files old_files_option;
 189
 190 /* Specified file name for incremental list.  */
 191 GLOBAL const char *listed_incremental_option;
 192 /* Incremental dump level */
 193 GLOBAL int incremental_level;
 194 /* Check device numbers when doing incremental dumps. */
 195 GLOBAL bool check_device_option;
 196
 197 /* Specified mode change string.  */
 198 GLOBAL struct mode_change *mode_option;
 199
 200 /* Initial umask, if needed for mode change string.  */
 201 GLOBAL mode_t initial_umask;
 202
 203 GLOBAL bool multi_volume_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 /* If true, override actual mtime (see below) */
 210 GLOBAL bool set_mtime_option;
 211 /* Value to be put in mtime header field instead of the actual mtime */
 212 GLOBAL struct timespec mtime_option;
 213
 214 /* Return true if newer_mtime_option is initialized.  */
 215 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
 216
 217 /* Return true if the struct stat ST's M time is less than
 218    newer_mtime_option.  */
 219 #define OLDER_STAT_TIME(st, m) \
 220   (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
 221
 222 /* Likewise, for struct tar_stat_info ST.  */
 223 #define OLDER_TAR_STAT_TIME(st, m) \
 224   (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
 225
 226 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR.  */
 227 GLOBAL int recursion_option;
 228
 229 GLOBAL bool numeric_owner_option;
 230
 231 GLOBAL bool one_file_system_option;
 232
 233 /* Specified value to be put into tar file in place of stat () results, or
 234    just null and -1 if such an override should not take place.  */
 235 GLOBAL char const *owner_name_option;
 236 GLOBAL uid_t owner_option;
 237
 238 GLOBAL bool recursive_unlink_option;
 239
 240 GLOBAL bool read_full_records_option;
 241
 242 GLOBAL bool remove_files_option;
 243
 244 /* Specified rmt command.  */
 245 GLOBAL const char *rmt_command_option;
 246
 247 /* Specified remote shell command.  */
 248 GLOBAL const char *rsh_command_option;
 249
 250 GLOBAL bool same_order_option;
 251
 252 /* If positive, preserve ownership when extracting.  */
 253 GLOBAL int same_owner_option;
 254
 255 /* If positive, preserve permissions when extracting.  */
 256 GLOBAL int same_permissions_option;
 257
 258 /* When set, strip the given number of file name components from the file name
 259    before extracting */
 260 GLOBAL size_t strip_name_components;
 261
 262 GLOBAL bool show_omitted_dirs_option;
 263
 264 GLOBAL bool sparse_option;
 265 GLOBAL unsigned tar_sparse_major;
 266 GLOBAL unsigned tar_sparse_minor;
 267
 268 GLOBAL bool starting_file_option;
 269
 270 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 271 GLOBAL tarlong tape_length_option;
 272
 273 GLOBAL bool to_stdout_option;
 274
 275 GLOBAL bool totals_option;
 276
 277 GLOBAL bool touch_option;
 278
 279 GLOBAL char *to_command_option;
 280 GLOBAL bool ignore_command_error_option;
 281
 282 /* Restrict some potentially harmful tar options */
 283 GLOBAL bool restrict_option;
 284
 285 /* Return true if the extracted files are not being written to disk */
 286 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
 287
 288 /* Count how many times the option has been set, multiple setting yields
 289    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 290    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 291 GLOBAL int verbose_option;
 292
 293 GLOBAL bool verify_option;
 294
 295 /* Specified name of file containing the volume number.  */
 296 GLOBAL const char *volno_file_option;
 297
 298 /* Specified value or pattern.  */
 299 GLOBAL const char *volume_label_option;
 300 \f
 301 /* Other global variables.  */
 302
 303 /* File descriptor for archive file.  */
 304 GLOBAL int archive;
 305
 306 /* Nonzero when outputting to /dev/null.  */
 307 GLOBAL bool dev_null_output;
 308
 309 /* Timestamps: */
 310 GLOBAL struct timespec start_time;        /* when we started execution */
 311 GLOBAL struct timespec volume_start_time; /* when the current volume was
 312                                              opened*/
 313 GLOBAL struct timespec last_stat_time;    /* when the statistics was last
 314                                              computed */
 315
 316 GLOBAL struct tar_stat_info current_stat_info;
 317
 318 /* List of tape drive names, number of such tape drives, allocated number,
 319    and current cursor in list.  */
 320 GLOBAL const char **archive_name_array;
 321 GLOBAL size_t archive_names;
 322 GLOBAL size_t allocated_archive_names;
 323 GLOBAL const char **archive_name_cursor;
 324
 325 /* Output index file name.  */
 326 GLOBAL char const *index_file_name;
 327
 328 /* Opaque structure for keeping directory meta-data */
 329 struct directory;
 330
 331 /* Structure for keeping track of filenames and lists thereof.  */
 332 struct name
 333   {
 334     struct name *next;          /* Link to the next element */
 335     struct name *prev;          /* Link to the previous element */
 336
 337     char *name;                 /* File name or globbing pattern */
 338     size_t length;              /* cached strlen (name) */
 339     int matching_flags;         /* wildcard flags if name is a pattern */
 340     bool cmdline;               /* true if this name was given in the
 341                                    command line */
 342
 343     int change_dir;             /* Number of the directory to change to.
 344                                    Set with the -C option. */
 345     uintmax_t found_count;      /* number of times a matching file has
 346                                    been found */
 347
 348     /* The following members are used for incremental dumps only,
 349        if this struct name represents a directory;
 350        see incremen.c */
 351     struct directory *directory;/* directory meta-data and contents */
 352     struct name *parent;        /* pointer to the parent hierarchy */
 353     struct name *child;         /* pointer to the first child */
 354     struct name *sibling;       /* pointer to the next sibling */
 355     char *caname;               /* canonical name */
 356   };
 357
 358 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 359 GLOBAL dev_t ar_dev;
 360 GLOBAL ino_t ar_ino;
 361
 362 /* Flags for reading, searching, and fstatatting files.  */
 363 GLOBAL int open_read_flags;
 364 GLOBAL int open_searchdir_flags;
 365 GLOBAL int fstatat_flags;
 366
 367 GLOBAL int seek_option;
 368 GLOBAL bool seekable_archive;
 369
 370 GLOBAL dev_t root_device;
 371
 372 /* Unquote filenames */
 373 GLOBAL bool unquote_option;
 374
 375 /* Show file or archive names after transformation.
 376    In particular, when creating archive in verbose mode, list member names
 377    as stored in the archive */
 378 GLOBAL bool show_transformed_names_option;
 379
 380 /* Delay setting modification times and permissions of extracted directories
 381    until the end of extraction. This variable helps correctly restore directory
 382    timestamps from archives with an unusual member order. It is automatically
 383    set for incremental archives. */
 384 GLOBAL bool delay_directory_restore_option;
 385
 386 /* Warn about implicit use of the wildcards in command line arguments.
 387    (Default for tar prior to 1.15.91, but changed afterwards */
 388 GLOBAL bool warn_regex_usage;
 389 \f
 390 /* Declarations for each module.  */
 391
 392 /* FIXME: compare.c should not directly handle the following variable,
 393    instead, this should be done in buffer.c only.  */
 394
 395 enum access_mode
 396 {
 397   ACCESS_READ,
 398   ACCESS_WRITE,
 399   ACCESS_UPDATE
 400 };
 401 extern enum access_mode access_mode;
 402
 403 /* Module buffer.c.  */
 404
 405 extern FILE *stdlis;
 406 extern bool write_archive_to_stdout;
 407 extern char *volume_label;
 408 extern size_t volume_label_count;
 409 extern char *continued_file_name;
 410 extern uintmax_t continued_file_size;
 411 extern uintmax_t continued_file_offset;
 412 extern off_t records_written;
 413
 414 char *drop_volume_label_suffix (const char *label);
 415
 416 size_t available_space_after (union block *pointer);
 417 off_t current_block_ordinal (void);
 418 void close_archive (void);
 419 void closeout_volume_number (void);
 420 void compute_duration (void);
 421 union block *find_next_block (void);
 422 void flush_read (void);
 423 void flush_write (void);
 424 void flush_archive (void);
 425 void init_volume_number (void);
 426 void open_archive (enum access_mode mode);
 427 void print_total_stats (void);
 428 void reset_eof (void);
 429 void set_next_block_after (union block *block);
 430 void clear_read_error_count (void);
 431 void xclose (int fd);
 432 void archive_write_error (ssize_t status) __attribute__ ((noreturn));
 433 void archive_read_error (void);
 434 off_t seek_archive (off_t size);
 435 void set_start_time (void);
 436
 437 void mv_begin_write (const char *file_name, off_t totsize, off_t sizeleft);
 438
 439 void mv_begin_read (struct tar_stat_info *st);
 440 void mv_end (void);
 441 void mv_size_left (off_t size);
 442
 443 void buffer_write_global_xheader (void);
 444
 445 const char *first_decompress_program (int *pstate);
 446 const char *next_decompress_program (int *pstate);
 447
 448 /* Module create.c.  */
 449
 450 enum dump_status
 451   {
 452     dump_status_ok,
 453     dump_status_short,
 454     dump_status_fail,
 455     dump_status_not_implemented
 456   };
 457
 458 void add_exclusion_tag (const char *name, enum exclusion_tag_type type,
 459                         bool (*predicate) (int));
 460 bool cachedir_file_p (int fd);
 461 char *get_directory_entries (struct tar_stat_info *st);
 462
 463 void create_archive (void);
 464 void pad_archive (off_t size_left);
 465 void dump_file (struct tar_stat_info *parent, char const *name,
 466                 char const *fullname);
 467 union block *start_header (struct tar_stat_info *st);
 468 void finish_header (struct tar_stat_info *st, union block *header,
 469                     off_t block_ordinal);
 470 void simple_finish_header (union block *header);
 471 union block * write_extended (bool global, struct tar_stat_info *st,
 472                               union block *old_header);
 473 union block *start_private_header (const char *name, size_t size, time_t t);
 474 void write_eot (void);
 475 void check_links (void);
 476 int subfile_open (struct tar_stat_info const *dir, char const *file, int flags);
 477 void restore_parent_fd (struct tar_stat_info const *st);
 478 void exclusion_tag_warning (const char *dirname, const char *tagname,
 479                             const char *message);
 480 enum exclusion_tag_type check_exclusion_tags (struct tar_stat_info const *st,
 481                                               const char **tag_file_name);
 482
 483 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 484 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 485
 486 bool off_to_chars (off_t off, char *buf, size_t size);
 487 bool time_to_chars (time_t t, char *buf, size_t size);
 488
 489 /* Module diffarch.c.  */
 490
 491 extern bool now_verifying;
 492
 493 void diff_archive (void);
 494 void diff_init (void);
 495 void verify_volume (void);
 496
 497 /* Module extract.c.  */
 498
 499 void extr_init (void);
 500 void extract_archive (void);
 501 void extract_finish (void);
 502 bool rename_directory (char *src, char *dst);
 503
 504 /* Module delete.c.  */
 505
 506 void delete_archive_members (void);
 507
 508 /* Module incremen.c.  */
 509
 510 struct directory *scan_directory (struct tar_stat_info *st);
 511 const char *directory_contents (struct directory *dir);
 512 const char *safe_directory_contents (struct directory *dir);
 513
 514 void rebase_directory (struct directory *dir,
 515                        const char *samp, size_t slen,
 516                        const char *repl, size_t rlen);
 517
 518 void append_incremental_renames (struct directory *dir);
 519 void read_directory_file (void);
 520 void write_directory_file (void);
 521 void purge_directory (char const *directory_name);
 522 void list_dumpdir (char *buffer, size_t size);
 523 void update_parent_directory (struct tar_stat_info *st);
 524
 525 size_t dumpdir_size (const char *p);
 526 bool is_dumpdir (struct tar_stat_info *stat_info);
 527 void clear_directory_table (void);
 528
 529 /* Module list.c.  */
 530
 531 enum read_header
 532 {
 533   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 534   HEADER_SUCCESS,               /* header successfully read and checksummed */
 535   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 536   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 537   HEADER_END_OF_FILE,           /* true end of file while header expected */
 538   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 539 };
 540
 541 /* Operation mode for read_header: */
 542
 543 enum read_header_mode
 544 {
 545   read_header_auto,             /* process extended headers automatically */
 546   read_header_x_raw,            /* return raw extended headers (return
 547                                    HEADER_SUCCESS_EXTENDED) */
 548   read_header_x_global          /* when POSIX global extended header is read,
 549                                    decode it and return
 550                                    HEADER_SUCCESS_EXTENDED */
 551 };
 552 extern union block *current_header;
 553 extern enum archive_format current_format;
 554 extern size_t recent_long_name_blocks;
 555 extern size_t recent_long_link_blocks;
 556
 557 void decode_header (union block *header, struct tar_stat_info *stat_info,
 558                     enum archive_format *format_pointer, int do_user_group);
 559 void transform_stat_info (int typeflag, struct tar_stat_info *stat_info);
 560 char const *tartime (struct timespec t, bool full_time);
 561
 562 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 563 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 564
 565 off_t off_from_header (const char *buf, size_t size);
 566 uintmax_t uintmax_from_header (const char *buf, size_t size);
 567
 568 void list_archive (void);
 569 void test_archive_label (void);
 570 void print_for_mkdir (char *dirname, int length, mode_t mode);
 571 void print_header (struct tar_stat_info *st, union block *blk,
 572                    off_t block_ordinal);
 573 void read_and (void (*do_something) (void));
 574 enum read_header read_header (union block **return_block,
 575                               struct tar_stat_info *info,
 576                               enum read_header_mode m);
 577 enum read_header tar_checksum (union block *header, bool silent);
 578 void skip_file (off_t size);
 579 void skip_member (void);
 580
 581 /* Module misc.c.  */
 582
 583 void assign_string (char **dest, const char *src);
 584 int unquote_string (char *str);
 585 char *zap_slashes (char *name);
 586 char *normalize_filename (const char *name);
 587 void replace_prefix (char **pname, const char *samp, size_t slen,
 588                      const char *repl, size_t rlen);
 589
 590 typedef struct namebuf *namebuf_t;
 591 namebuf_t namebuf_create (const char *dir);
 592 void namebuf_free (namebuf_t buf);
 593 char *namebuf_name (namebuf_t buf, const char *name);
 594
 595 void code_ns_fraction (int ns, char *p);
 596 char const *code_timespec (struct timespec ts, char *sbuf);
 597 enum { BILLION = 1000000000, LOG10_BILLION = 9 };
 598 enum { TIMESPEC_STRSIZE_BOUND =
 599          UINTMAX_STRSIZE_BOUND + LOG10_BILLION + sizeof "-." - 1 };
 600
 601 bool must_be_dot_or_slash (char const *);
 602
 603 enum remove_option
 604 {
 605   ORDINARY_REMOVE_OPTION,
 606   RECURSIVE_REMOVE_OPTION,
 607
 608   /* FIXME: The following value is never used. It seems to be intended
 609      as a placeholder for a hypothetical option that should instruct tar
 610      to recursively remove subdirectories in purge_directory(),
 611      as opposed to the functionality of --recursive-unlink
 612      (RECURSIVE_REMOVE_OPTION value), which removes them in
 613      prepare_to_extract() phase. However, with the addition of more
 614      meta-info to the incremental dumps, this should become unnecessary */
 615   WANT_DIRECTORY_REMOVE_OPTION
 616 };
 617 int remove_any_file (const char *file_name, enum remove_option option);
 618 bool maybe_backup_file (const char *file_name, bool this_is_the_archive);
 619 void undo_last_backup (void);
 620
 621 int deref_stat (char const *name, struct stat *buf);
 622
 623 extern int chdir_current;
 624 extern int chdir_fd;
 625 int chdir_arg (char const *dir);
 626 void chdir_do (int dir);
 627 int chdir_count (void);
 628
 629 void close_diag (char const *name);
 630 void open_diag (char const *name);
 631 void read_diag_details (char const *name, off_t offset, size_t size);
 632 void readlink_diag (char const *name);
 633 void savedir_diag (char const *name);
 634 void seek_diag_details (char const *name, off_t offset);
 635 void stat_diag (char const *name);
 636 void file_removed_diag (const char *name, bool top_level,
 637                         void (*diagfn) (char const *name));
 638 void write_error_details (char const *name, size_t status, size_t size);
 639 void write_fatal (char const *name) __attribute__ ((noreturn));
 640 void write_fatal_details (char const *name, ssize_t status, size_t size)
 641      __attribute__ ((noreturn));
 642
 643 pid_t xfork (void);
 644 void xpipe (int fd[2]);
 645
 646 void *page_aligned_alloc (void **ptr, size_t size);
 647 int set_file_atime (int fd, int parentfd, char const *file,
 648                     struct timespec atime);
 649
 650 /* Module names.c.  */
 651
 652 extern size_t name_count;
 653 extern struct name *gnu_list_name;
 654
 655 void gid_to_gname (gid_t gid, char **gname);
 656 int gname_to_gid (char const *gname, gid_t *pgid);
 657 void uid_to_uname (uid_t uid, char **uname);
 658 int uname_to_uid (char const *uname, uid_t *puid);
 659
 660 void name_init (void);
 661 void name_add_name (const char *name, int matching_flags);
 662 void name_add_dir (const char *name);
 663 void name_term (void);
 664 const char *name_next (int change_dirs);
 665 void name_gather (void);
 666 struct name *addname (char const *string, int change_dir,
 667                       bool cmdline, struct name *parent);
 668 void remname (struct name *name);
 669 bool name_match (const char *name);
 670 void names_notfound (void);
 671 void label_notfound (void);
 672 void collect_and_sort_names (void);
 673 struct name *name_scan (const char *name);
 674 struct name const *name_from_list (void);
 675 void blank_name_list (void);
 676 char *new_name (const char *dir_name, const char *name);
 677 size_t stripped_prefix_len (char const *file_name, size_t num);
 678 bool all_names_found (struct tar_stat_info *st);
 679
 680 bool excluded_name (char const *name);
 681
 682 void add_avoided_name (char const *name);
 683 bool is_avoided_name (char const *name);
 684
 685 bool contains_dot_dot (char const *name);
 686
 687 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 688                     (c)->found_count == occurrence_option)
 689 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 690                      (c)->found_count >= occurrence_option)
 691
 692 /* Module tar.c.  */
 693
 694 void usage (int);
 695
 696 int confirm (const char *message_action, const char *name);
 697
 698 void tar_stat_init (struct tar_stat_info *st);
 699 bool tar_stat_close (struct tar_stat_info *st);
 700 void tar_stat_destroy (struct tar_stat_info *st);
 701 void usage (int) __attribute__ ((noreturn));
 702 int tar_timespec_cmp (struct timespec a, struct timespec b);
 703 const char *archive_format_string (enum archive_format fmt);
 704 const char *subcommand_string (enum subcommand c);
 705 void set_exit_status (int val);
 706
 707 /* Module update.c.  */
 708
 709 extern char *output_start;
 710
 711 void update_archive (void);
 712
 713 /* Module xheader.c.  */
 714
 715 void xheader_decode (struct tar_stat_info *stat);
 716 void xheader_decode_global (struct xheader *xhdr);
 717 void xheader_store (char const *keyword, struct tar_stat_info *st,
 718                     void const *data);
 719 void xheader_read (struct xheader *xhdr, union block *header, size_t size);
 720 void xheader_write (char type, char *name, time_t t, struct xheader *xhdr);
 721 void xheader_write_global (struct xheader *xhdr);
 722 void xheader_finish (struct xheader *hdr);
 723 void xheader_destroy (struct xheader *hdr);
 724 char *xheader_xhdr_name (struct tar_stat_info *st);
 725 char *xheader_ghdr_name (void);
 726 void xheader_set_option (char *string);
 727 void xheader_string_begin (struct xheader *xhdr);
 728 void xheader_string_add (struct xheader *xhdr, char const *s);
 729 bool xheader_string_end (struct xheader *xhdr, char const *keyword);
 730 bool xheader_keyword_deleted_p (const char *kw);
 731 char *xheader_format_name (struct tar_stat_info *st, const char *fmt,
 732                            size_t n);
 733
 734 /* Module system.c */
 735
 736 void sys_detect_dev_null_output (void);
 737 void sys_save_archive_dev_ino (void);
 738 void sys_wait_for_child (pid_t, bool);
 739 void sys_spawn_shell (void);
 740 bool sys_compare_uid (struct stat *a, struct stat *b);
 741 bool sys_compare_gid (struct stat *a, struct stat *b);
 742 bool sys_file_is_archive (struct tar_stat_info *p);
 743 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 744 int sys_truncate (int fd);
 745 pid_t sys_child_open_for_compress (void);
 746 pid_t sys_child_open_for_uncompress (void);
 747 size_t sys_write_archive_buffer (void);
 748 bool sys_get_archive_stat (void);
 749 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
 750 void sys_wait_command (void);
 751 int sys_exec_info_script (const char **archive_name, int volume_number);
 752 void sys_exec_checkpoint_script (const char *script_name,
 753                                  const char *archive_name,
 754                                  int checkpoint_number);
 755
 756 /* Module compare.c */
 757 void report_difference (struct tar_stat_info *st, const char *message, ...);
 758
 759 /* Module sparse.c */
 760 bool sparse_member_p (struct tar_stat_info *st);
 761 bool sparse_fixup_header (struct tar_stat_info *st);
 762 enum dump_status sparse_dump_file (int, struct tar_stat_info *st);
 763 enum dump_status sparse_extract_file (int fd, struct tar_stat_info *st,
 764                                       off_t *size);
 765 enum dump_status sparse_skip_file (struct tar_stat_info *st);
 766 bool sparse_diff_file (int, struct tar_stat_info *st);
 767
 768 /* Module utf8.c */
 769 bool string_ascii_p (const char *str);
 770 bool utf8_convert (bool to_utf, char const *input, char **output);
 771
 772 /* Module transform.c */
 773 #define XFORM_REGFILE  0x01
 774 #define XFORM_LINK     0x02
 775 #define XFORM_SYMLINK  0x04
 776 #define XFORM_ALL      (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
 777
 778 void set_transform_expr (const char *expr);
 779 bool transform_name (char **pinput, int type);
 780 bool transform_name_fp (char **pinput, int type,
 781                         char *(*fun)(char *, void *), void *);
 782 bool transform_program_p (void);
 783
 784 /* Module suffix.c */
 785 void set_compression_program_by_suffix (const char *name, const char *defprog);
 786
 787 /* Module checkpoint.c */
 788 void checkpoint_compile_action (const char *str);
 789 void checkpoint_finish_compile (void);
 790 void checkpoint_run (bool do_write);
 791
 792 /* Module warning.c */
 793 #define WARN_ALONE_ZERO_BLOCK    0x00000001
 794 #define WARN_BAD_DUMPDIR         0x00000002
 795 #define WARN_CACHEDIR            0x00000004
 796 #define WARN_CONTIGUOUS_CAST     0x00000008
 797 #define WARN_FILE_CHANGED        0x00000010
 798 #define WARN_FILE_IGNORED        0x00000020
 799 #define WARN_FILE_REMOVED        0x00000040
 800 #define WARN_FILE_SHRANK         0x00000080
 801 #define WARN_FILE_UNCHANGED      0x00000100
 802 #define WARN_FILENAME_WITH_NULS  0x00000200
 803 #define WARN_IGNORE_ARCHIVE      0x00000400
 804 #define WARN_IGNORE_NEWER        0x00000800
 805 #define WARN_NEW_DIRECTORY       0x00001000
 806 #define WARN_RENAME_DIRECTORY    0x00002000
 807 #define WARN_SYMLINK_CAST        0x00004000
 808 #define WARN_TIMESTAMP           0x00008000
 809 #define WARN_UNKNOWN_CAST        0x00010000
 810 #define WARN_UNKNOWN_KEYWORD     0x00020000
 811 #define WARN_XDEV                0x00040000
 812 #define WARN_DECOMPRESS_PROGRAM  0x00080000
 813
 814 /* The warnings composing WARN_VERBOSE_WARNINGS are enabled by default
 815    in verbose mode */
 816 #define WARN_VERBOSE_WARNINGS    (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY|\
 817                                   WARN_DECOMPRESS_PROGRAM)
 818 #define WARN_ALL                 (~WARN_VERBOSE_WARNINGS)
 819
 820 void set_warning_option (const char *arg);
 821
 822 extern int warning_option;
 823
 824 #define WARNOPT(opt,args)                       \
 825   do                                            \
 826     {                                           \
 827       if (warning_option & opt) WARN (args);    \
 828     }                                           \
 829   while (0)
 830
 831 /* Module unlink.c */
 832
 833 void queue_deferred_unlink (const char *name, bool is_dir);
 834 void finish_deferred_unlinks (void);
 835
 836 /* Module exit.c */
 837 extern void (*fatal_exit_hook) (void);