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