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