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