git.cworth.org Git - 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, 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 -1 if such an override should not take place.  */
 162 GLOBAL gid_t group_option;
 163
 164 GLOBAL bool ignore_failed_read_option;
 165
 166 GLOBAL bool ignore_zeros_option;
 167
 168 GLOBAL bool incremental_option;
 169
 170 /* Specified name of script to run at end of each tape change.  */
 171 GLOBAL const char *info_script_option;
 172
 173 GLOBAL bool interactive_option;
 174
 175 /* If nonzero, extract only Nth occurrence of each named file */
 176 GLOBAL uintmax_t occurrence_option;
 177
 178 enum old_files
 179 {
 180   DEFAULT_OLD_FILES,          /* default */
 181   NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
 182   OVERWRITE_OLD_FILES,        /* --overwrite */
 183   UNLINK_FIRST_OLD_FILES,     /* --unlink-first */
 184   KEEP_OLD_FILES,             /* --keep-old-files */
 185   KEEP_NEWER_FILES            /* --keep-newer-files */
 186 };
 187 GLOBAL enum old_files old_files_option;
 188
 189 /* Specified file name for incremental list.  */
 190 GLOBAL const char *listed_incremental_option;
 191 /* Incremental dump level */
 192 GLOBAL int incremental_level;
 193 /* Check device numbers when doing incremental dumps. */
 194 GLOBAL bool check_device_option;
 195
 196 /* Specified mode change string.  */
 197 GLOBAL struct mode_change *mode_option;
 198
 199 /* Initial umask, if needed for mode change string.  */
 200 GLOBAL mode_t initial_umask;
 201
 202 GLOBAL bool multi_volume_option;
 203
 204 /* Specified threshold date and time.  Files having an older time stamp
 205    do not get archived (also see after_date_option above).  */
 206 GLOBAL struct timespec newer_mtime_option;
 207
 208 /* If true, override actual mtime (see below) */
 209 GLOBAL bool set_mtime_option;
 210 /* Value to be put in mtime header field instead of the actual mtime */
 211 GLOBAL struct timespec mtime_option;
 212
 213 /* Return true if newer_mtime_option is initialized.  */
 214 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
 215
 216 /* Return true if the struct stat ST's M time is less than
 217    newer_mtime_option.  */
 218 #define OLDER_STAT_TIME(st, m) \
 219   (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
 220
 221 /* Likewise, for struct tar_stat_info ST.  */
 222 #define OLDER_TAR_STAT_TIME(st, m) \
 223   (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
 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 GLOBAL unsigned tar_sparse_major;
 264 GLOBAL unsigned tar_sparse_minor;
 265
 266 GLOBAL bool starting_file_option;
 267
 268 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 269 GLOBAL tarlong tape_length_option;
 270
 271 GLOBAL bool to_stdout_option;
 272
 273 GLOBAL bool totals_option;
 274
 275 GLOBAL bool touch_option;
 276
 277 GLOBAL char *to_command_option;
 278 GLOBAL bool ignore_command_error_option;
 279
 280 /* Restrict some potentially harmful tar options */
 281 GLOBAL bool restrict_option;
 282
 283 /* Return true if the extracted files are not being written to disk */
 284 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
 285
 286 /* Count how many times the option has been set, multiple setting yields
 287    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 288    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 289 GLOBAL int verbose_option;
 290
 291 GLOBAL bool verify_option;
 292
 293 /* Specified name of file containing the volume number.  */
 294 GLOBAL const char *volno_file_option;
 295
 296 /* Specified value or pattern.  */
 297 GLOBAL const char *volume_label_option;
 298 \f
 299 /* Other global variables.  */
 300
 301 /* File descriptor for archive file.  */
 302 GLOBAL int archive;
 303
 304 /* Nonzero when outputting to /dev/null.  */
 305 GLOBAL bool dev_null_output;
 306
 307 /* Timestamps: */
 308 GLOBAL struct timespec start_time;        /* when we started execution */
 309 GLOBAL struct timespec volume_start_time; /* when the current volume was
 310                                              opened*/
 311 GLOBAL struct timespec last_stat_time;    /* when the statistics was last
 312                                              computed */
 313
 314 GLOBAL struct tar_stat_info current_stat_info;
 315
 316 /* List of tape drive names, number of such tape drives, allocated number,
 317    and current cursor in list.  */
 318 GLOBAL const char **archive_name_array;
 319 GLOBAL size_t archive_names;
 320 GLOBAL size_t allocated_archive_names;
 321 GLOBAL const char **archive_name_cursor;
 322
 323 /* Output index file name.  */
 324 GLOBAL char const *index_file_name;
 325
 326 /* Opaque structure for keeping directory meta-data */
 327 struct directory;
 328
 329 /* Structure for keeping track of filenames and lists thereof.  */
 330 struct name
 331   {
 332     struct name *next;          /* Link to the next element */
 333     struct name *prev;          /* Link to the previous element */
 334
 335     char *name;                 /* File name or globbing pattern */
 336     size_t length;              /* cached strlen (name) */
 337     int matching_flags;         /* wildcard flags if name is a pattern */
 338     bool cmdline;               /* true if this name was given in the
 339                                    command line */
 340
 341     int change_dir;             /* Number of the directory to change to.
 342                                    Set with the -C option. */
 343     uintmax_t found_count;      /* number of times a matching file has
 344                                    been found */
 345
 346     /* The following members are used for incremental dumps only,
 347        if this struct name represents a directory;
 348        see incremen.c */
 349     struct directory *directory;/* directory meta-data and contents */
 350     struct name *parent;        /* pointer to the parent hierarchy */
 351     struct name *child;         /* pointer to the first child */
 352     struct name *sibling;       /* pointer to the next sibling */
 353     char *caname;               /* canonical name */
 354   };
 355
 356 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 357 GLOBAL dev_t ar_dev;
 358 GLOBAL ino_t ar_ino;
 359
 360 /* Flags for reading, searching, and fstatatting files.  */
 361 GLOBAL int open_read_flags;
 362 GLOBAL int open_searchdir_flags;
 363 GLOBAL int fstatat_flags;
 364
 365 GLOBAL int seek_option;
 366 GLOBAL bool seekable_archive;
 367
 368 GLOBAL dev_t root_device;
 369
 370 /* Unquote filenames */
 371 GLOBAL bool unquote_option;
 372
 373 /* Show file or archive names after transformation.
 374    In particular, when creating archive in verbose mode, list member names
 375    as stored in the archive */
 376 GLOBAL bool show_transformed_names_option;
 377
 378 /* Delay setting modification times and permissions of extracted directories
 379    until the end of extraction. This variable helps correctly restore directory
 380    timestamps from archives with an unusual member order. It is automatically
 381    set for incremental archives. */
 382 GLOBAL bool delay_directory_restore_option;
 383
 384 /* Warn about implicit use of the wildcards in command line arguments.
 385    (Default for tar prior to 1.15.91, but changed afterwards */
 386 GLOBAL bool warn_regex_usage;
 387 \f
 388 /* Declarations for each module.  */
 389
 390 /* FIXME: compare.c should not directly handle the following variable,
 391    instead, this should be done in buffer.c only.  */
 392
 393 enum access_mode
 394 {
 395   ACCESS_READ,
 396   ACCESS_WRITE,
 397   ACCESS_UPDATE
 398 };
 399 extern enum access_mode access_mode;
 400
 401 /* Module buffer.c.  */
 402
 403 extern FILE *stdlis;
 404 extern bool write_archive_to_stdout;
 405 extern char *volume_label;
 406 extern size_t volume_label_count;
 407 extern char *continued_file_name;
 408 extern uintmax_t continued_file_size;
 409 extern uintmax_t continued_file_offset;
 410 extern off_t records_written;
 411
 412 char *drop_volume_label_suffix (const char *label);
 413
 414 size_t available_space_after (union block *pointer);
 415 off_t current_block_ordinal (void);
 416 void close_archive (void);
 417 void closeout_volume_number (void);
 418 void compute_duration (void);
 419 union block *find_next_block (void);
 420 void flush_read (void);
 421 void flush_write (void);
 422 void flush_archive (void);
 423 void init_volume_number (void);
 424 void open_archive (enum access_mode mode);
 425 void print_total_stats (void);
 426 void reset_eof (void);
 427 void set_next_block_after (union block *block);
 428 void clear_read_error_count (void);
 429 void xclose (int fd);
 430 void archive_write_error (ssize_t status) __attribute__ ((noreturn));
 431 void archive_read_error (void);
 432 off_t seek_archive (off_t size);
 433 void set_start_time (void);
 434
 435 void mv_begin_write (const char *file_name, off_t totsize, off_t sizeleft);
 436
 437 void mv_begin_read (struct tar_stat_info *st);
 438 void mv_end (void);
 439 void mv_size_left (off_t size);
 440
 441 void buffer_write_global_xheader (void);
 442
 443 /* Module create.c.  */
 444
 445 enum dump_status
 446   {
 447     dump_status_ok,
 448     dump_status_short,
 449     dump_status_fail,
 450     dump_status_not_implemented
 451   };
 452
 453 void add_exclusion_tag (const char *name, enum exclusion_tag_type type,
 454                         bool (*predicate) (int));
 455 bool cachedir_file_p (int fd);
 456 char *get_directory_entries (struct tar_stat_info *st);
 457
 458 void create_archive (void);
 459 void pad_archive (off_t size_left);
 460 void dump_file (struct tar_stat_info *parent, char const *name,
 461                 char const *fullname);
 462 union block *start_header (struct tar_stat_info *st);
 463 void finish_header (struct tar_stat_info *st, union block *header,
 464                     off_t block_ordinal);
 465 void simple_finish_header (union block *header);
 466 union block * write_extended (bool global, struct tar_stat_info *st,
 467                               union block *old_header);
 468 union block *start_private_header (const char *name, size_t size, time_t t);
 469 void write_eot (void);
 470 void check_links (void);
 471 int subfile_open (struct tar_stat_info const *dir, char const *file, int flags);
 472 void restore_parent_fd (struct tar_stat_info const *st);
 473 void exclusion_tag_warning (const char *dirname, const char *tagname,
 474                             const char *message);
 475 enum exclusion_tag_type check_exclusion_tags (struct tar_stat_info const *st,
 476                                               const char **tag_file_name);
 477
 478 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 479 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 480
 481 bool off_to_chars (off_t off, char *buf, size_t size);
 482 bool time_to_chars (time_t t, char *buf, size_t size);
 483
 484 /* Module diffarch.c.  */
 485
 486 extern bool now_verifying;
 487
 488 void diff_archive (void);
 489 void diff_init (void);
 490 void verify_volume (void);
 491
 492 /* Module extract.c.  */
 493
 494 void extr_init (void);
 495 void extract_archive (void);
 496 void extract_finish (void);
 497 bool rename_directory (char *src, char *dst);
 498
 499 /* Module delete.c.  */
 500
 501 void delete_archive_members (void);
 502
 503 /* Module incremen.c.  */
 504
 505 struct directory *scan_directory (struct tar_stat_info *st);
 506 const char *directory_contents (struct directory *dir);
 507 const char *safe_directory_contents (struct directory *dir);
 508
 509 void rebase_directory (struct directory *dir,
 510                        const char *samp, size_t slen,
 511                        const char *repl, size_t rlen);
 512
 513 void append_incremental_renames (struct directory *dir);
 514 void read_directory_file (void);
 515 void write_directory_file (void);
 516 void purge_directory (char const *directory_name);
 517 void list_dumpdir (char *buffer, size_t size);
 518 void update_parent_directory (struct tar_stat_info *st);
 519
 520 size_t dumpdir_size (const char *p);
 521 bool is_dumpdir (struct tar_stat_info *stat_info);
 522
 523 /* Module list.c.  */
 524
 525 enum read_header
 526 {
 527   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 528   HEADER_SUCCESS,               /* header successfully read and checksummed */
 529   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 530   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 531   HEADER_END_OF_FILE,           /* true end of file while header expected */
 532   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 533 };
 534
 535 /* Operation mode for read_header: */
 536
 537 enum read_header_mode
 538 {
 539   read_header_auto,             /* process extended headers automatically */
 540   read_header_x_raw,            /* return raw extended headers (return
 541                                    HEADER_SUCCESS_EXTENDED) */
 542   read_header_x_global          /* when POSIX global extended header is read,
 543                                    decode it and return
 544                                    HEADER_SUCCESS_EXTENDED */
 545 };
 546 extern union block *current_header;
 547 extern enum archive_format current_format;
 548 extern size_t recent_long_name_blocks;
 549 extern size_t recent_long_link_blocks;
 550
 551 void decode_header (union block *header, struct tar_stat_info *stat_info,
 552                     enum archive_format *format_pointer, int do_user_group);
 553 char const *tartime (struct timespec t, bool full_time);
 554
 555 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 556 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 557
 558 off_t off_from_header (const char *buf, size_t size);
 559 uintmax_t uintmax_from_header (const char *buf, size_t size);
 560
 561 void list_archive (void);
 562 void test_archive_label (void);
 563 void print_for_mkdir (char *dirname, int length, mode_t mode);
 564 void print_header (struct tar_stat_info *st, union block *blk,
 565                    off_t block_ordinal);
 566 void read_and (void (*do_something) (void));
 567 enum read_header read_header (union block **return_block,
 568                               struct tar_stat_info *info,
 569                               enum read_header_mode m);
 570 enum read_header tar_checksum (union block *header, bool silent);
 571 void skip_file (off_t size);
 572 void skip_member (void);
 573
 574 /* Module misc.c.  */
 575
 576 void assign_string (char **dest, const char *src);
 577 int unquote_string (char *str);
 578 char *zap_slashes (char *name);
 579 char *normalize_filename (const char *name);
 580 void replace_prefix (char **pname, const char *samp, size_t slen,
 581                      const char *repl, size_t rlen);
 582
 583 typedef struct namebuf *namebuf_t;
 584 namebuf_t namebuf_create (const char *dir);
 585 void namebuf_free (namebuf_t buf);
 586 char *namebuf_name (namebuf_t buf, const char *name);
 587
 588 void code_ns_fraction (int ns, char *p);
 589 char const *code_timespec (struct timespec ts, char *sbuf);
 590 enum { BILLION = 1000000000, LOG10_BILLION = 9 };
 591 enum { TIMESPEC_STRSIZE_BOUND =
 592          UINTMAX_STRSIZE_BOUND + LOG10_BILLION + sizeof "-." - 1 };
 593
 594 bool must_be_dot_or_slash (char const *);
 595
 596 enum remove_option
 597 {
 598   ORDINARY_REMOVE_OPTION,
 599   RECURSIVE_REMOVE_OPTION,
 600
 601   /* FIXME: The following value is never used. It seems to be intended
 602      as a placeholder for a hypothetical option that should instruct tar
 603      to recursively remove subdirectories in purge_directory(),
 604      as opposed to the functionality of --recursive-unlink
 605      (RECURSIVE_REMOVE_OPTION value), which removes them in
 606      prepare_to_extract() phase. However, with the addition of more
 607      meta-info to the incremental dumps, this should become unnecessary */
 608   WANT_DIRECTORY_REMOVE_OPTION
 609 };
 610 int remove_any_file (const char *file_name, enum remove_option option);
 611 bool maybe_backup_file (const char *file_name, bool this_is_the_archive);
 612 void undo_last_backup (void);
 613
 614 int deref_stat (char const *name, struct stat *buf);
 615
 616 extern int chdir_current;
 617 extern int chdir_fd;
 618 int chdir_arg (char const *dir);
 619 void chdir_do (int dir);
 620 int chdir_count (void);
 621
 622 void close_diag (char const *name);
 623 void open_diag (char const *name);
 624 void read_diag_details (char const *name, off_t offset, size_t size);
 625 void readlink_diag (char const *name);
 626 void savedir_diag (char const *name);
 627 void seek_diag_details (char const *name, off_t offset);
 628 void stat_diag (char const *name);
 629 void file_removed_diag (const char *name, bool top_level,
 630                         void (*diagfn) (char const *name));
 631 void dir_removed_diag (char const *name, bool top_level,
 632                        void (*diagfn) (char const *name));
 633 void write_error_details (char const *name, size_t status, size_t size);
 634 void write_fatal (char const *name) __attribute__ ((noreturn));
 635 void write_fatal_details (char const *name, ssize_t status, size_t size)
 636      __attribute__ ((noreturn));
 637
 638 pid_t xfork (void);
 639 void xpipe (int fd[2]);
 640
 641 void *page_aligned_alloc (void **ptr, size_t size);
 642 int set_file_atime (int fd, int parentfd, char const *file,
 643                     struct timespec atime);
 644
 645 /* Module names.c.  */
 646
 647 extern size_t name_count;
 648 extern struct name *gnu_list_name;
 649
 650 void gid_to_gname (gid_t gid, char **gname);
 651 int gname_to_gid (char const *gname, gid_t *pgid);
 652 void uid_to_uname (uid_t uid, char **uname);
 653 int uname_to_uid (char const *uname, uid_t *puid);
 654
 655 void name_init (void);
 656 void name_add_name (const char *name, int matching_flags);
 657 void name_add_dir (const char *name);
 658 void name_term (void);
 659 const char *name_next (int change_dirs);
 660 void name_gather (void);
 661 struct name *addname (char const *string, int change_dir,
 662                       bool cmdline, struct name *parent);
 663 void remname (struct name *name);
 664 bool name_match (const char *name);
 665 void names_notfound (void);
 666 void label_notfound (void);
 667 void collect_and_sort_names (void);
 668 struct name *name_scan (const char *name);
 669 struct name const *name_from_list (void);
 670 void blank_name_list (void);
 671 char *new_name (const char *dir_name, const char *name);
 672 size_t stripped_prefix_len (char const *file_name, size_t num);
 673 bool all_names_found (struct tar_stat_info *st);
 674
 675 bool excluded_name (char const *name);
 676
 677 void add_avoided_name (char const *name);
 678 bool is_avoided_name (char const *name);
 679 bool is_individual_file (char const *name);
 680
 681 bool contains_dot_dot (char const *name);
 682
 683 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 684                     (c)->found_count == occurrence_option)
 685 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 686                      (c)->found_count >= occurrence_option)
 687
 688 /* Module tar.c.  */
 689
 690 void usage (int);
 691
 692 int confirm (const char *message_action, const char *name);
 693
 694 void tar_stat_init (struct tar_stat_info *st);
 695 bool tar_stat_close (struct tar_stat_info *st);
 696 void tar_stat_destroy (struct tar_stat_info *st);
 697 void usage (int) __attribute__ ((noreturn));
 698 int tar_timespec_cmp (struct timespec a, struct timespec b);
 699 const char *archive_format_string (enum archive_format fmt);
 700 const char *subcommand_string (enum subcommand c);
 701 void set_exit_status (int val);
 702
 703 /* Module update.c.  */
 704
 705 extern char *output_start;
 706
 707 void update_archive (void);
 708
 709 /* Module xheader.c.  */
 710
 711 void xheader_decode (struct tar_stat_info *stat);
 712 void xheader_decode_global (struct xheader *xhdr);
 713 void xheader_store (char const *keyword, struct tar_stat_info *st,
 714                     void const *data);
 715 void xheader_read (struct xheader *xhdr, union block *header, size_t size);
 716 void xheader_write (char type, char *name, time_t t, struct xheader *xhdr);
 717 void xheader_write_global (struct xheader *xhdr);
 718 void xheader_finish (struct xheader *hdr);
 719 void xheader_destroy (struct xheader *hdr);
 720 char *xheader_xhdr_name (struct tar_stat_info *st);
 721 char *xheader_ghdr_name (void);
 722 void xheader_set_option (char *string);
 723 void xheader_string_begin (struct xheader *xhdr);
 724 void xheader_string_add (struct xheader *xhdr, char const *s);
 725 bool xheader_string_end (struct xheader *xhdr, char const *keyword);
 726 bool xheader_keyword_deleted_p (const char *kw);
 727 char *xheader_format_name (struct tar_stat_info *st, const char *fmt,
 728                            size_t n);
 729
 730 /* Module system.c */
 731
 732 void sys_detect_dev_null_output (void);
 733 void sys_save_archive_dev_ino (void);
 734 void sys_wait_for_child (pid_t, bool);
 735 void sys_spawn_shell (void);
 736 bool sys_compare_uid (struct stat *a, struct stat *b);
 737 bool sys_compare_gid (struct stat *a, struct stat *b);
 738 bool sys_file_is_archive (struct tar_stat_info *p);
 739 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 740 int sys_truncate (int fd);
 741 pid_t sys_child_open_for_compress (void);
 742 pid_t sys_child_open_for_uncompress (void);
 743 size_t sys_write_archive_buffer (void);
 744 bool sys_get_archive_stat (void);
 745 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
 746 void sys_wait_command (void);
 747 int sys_exec_info_script (const char **archive_name, int volume_number);
 748 void sys_exec_checkpoint_script (const char *script_name,
 749                                  const char *archive_name,
 750                                  int checkpoint_number);
 751
 752 /* Module compare.c */
 753 void report_difference (struct tar_stat_info *st, const char *message, ...);
 754
 755 /* Module sparse.c */
 756 bool sparse_member_p (struct tar_stat_info *st);
 757 bool sparse_fixup_header (struct tar_stat_info *st);
 758 enum dump_status sparse_dump_file (int, struct tar_stat_info *st);
 759 enum dump_status sparse_extract_file (int fd, struct tar_stat_info *st,
 760                                       off_t *size);
 761 enum dump_status sparse_skip_file (struct tar_stat_info *st);
 762 bool sparse_diff_file (int, struct tar_stat_info *st);
 763
 764 /* Module utf8.c */
 765 bool string_ascii_p (const char *str);
 766 bool utf8_convert (bool to_utf, char const *input, char **output);
 767
 768 /* Module transform.c */
 769 #define XFORM_REGFILE  0x01
 770 #define XFORM_LINK     0x02
 771 #define XFORM_SYMLINK  0x04
 772 #define XFORM_ALL      (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
 773
 774 void set_transform_expr (const char *expr);
 775 bool transform_name (char **pinput, int type);
 776 bool transform_name_fp (char **pinput, int type,
 777                         char *(*fun)(char *, void *), void *);
 778
 779 /* Module suffix.c */
 780 void set_compression_program_by_suffix (const char *name, const char *defprog);
 781
 782 /* Module checkpoint.c */
 783 void checkpoint_compile_action (const char *str);
 784 void checkpoint_finish_compile (void);
 785 void checkpoint_run (bool do_write);
 786
 787 /* Module warning.c */
 788 #define WARN_ALONE_ZERO_BLOCK    0x00000001
 789 #define WARN_BAD_DUMPDIR         0x00000002
 790 #define WARN_CACHEDIR            0x00000004
 791 #define WARN_CONTIGUOUS_CAST     0x00000008
 792 #define WARN_FILE_CHANGED        0x00000010
 793 #define WARN_FILE_IGNORED        0x00000020
 794 #define WARN_FILE_REMOVED        0x00000040
 795 #define WARN_FILE_SHRANK         0x00000080
 796 #define WARN_FILE_UNCHANGED      0x00000100
 797 #define WARN_FILENAME_WITH_NULS  0x00000200
 798 #define WARN_IGNORE_ARCHIVE      0x00000400
 799 #define WARN_IGNORE_NEWER        0x00000800
 800 #define WARN_NEW_DIRECTORY       0x00001000
 801 #define WARN_RENAME_DIRECTORY    0x00002000
 802 #define WARN_SYMLINK_CAST        0x00004000
 803 #define WARN_TIMESTAMP           0x00008000
 804 #define WARN_UNKNOWN_CAST        0x00010000
 805 #define WARN_UNKNOWN_KEYWORD     0x00020000
 806 #define WARN_XDEV                0x00040000
 807
 808 /* The warnings composing WARN_VERBOSE_WARNINGS are enabled by default
 809    in verbose mode */
 810 #define WARN_VERBOSE_WARNINGS    (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY)
 811 #define WARN_ALL                 (~WARN_VERBOSE_WARNINGS)
 812
 813 void set_warning_option (const char *arg);
 814
 815 extern int warning_option;
 816
 817 #define WARNOPT(opt,args)                       \
 818   do                                            \
 819     {                                           \
 820       if (warning_option & opt) WARN (args);    \
 821     }                                           \
 822   while (0)
 823
 824 /* Module unlink.c */
 825
 826 void queue_deferred_unlink (const char *name, bool is_dir);
 827 void finish_deferred_unlinks (void);
 828
 829 /* Module exit.c */
 830 extern void (*fatal_exit_hook) (void);