Dogcows Code - chaz/tar/blob - src/common.h

   1 /* Common declarations for the tar program.
   2
   3    Copyright 1988, 1992-1994, 1996-1997, 1999-2010, 2012-2014 Free
   4    Software Foundation, Inc.
   5
   6    This file is part of GNU tar.
   7
   8    GNU tar is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    GNU tar is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  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
  74 _GL_INLINE_HEADER_BEGIN
  75 #ifndef COMMON_INLINE
  76 # define COMMON_INLINE _GL_INLINE
  77 #endif
  78 \f
  79 /* Information gleaned from the command line.  */
  80
  81 /* Main command option.  */
  82
  83 enum subcommand
  84 {
  85   UNKNOWN_SUBCOMMAND,           /* none of the following */
  86   APPEND_SUBCOMMAND,            /* -r */
  87   CAT_SUBCOMMAND,               /* -A */
  88   CREATE_SUBCOMMAND,            /* -c */
  89   DELETE_SUBCOMMAND,            /* -D */
  90   DIFF_SUBCOMMAND,              /* -d */
  91   EXTRACT_SUBCOMMAND,           /* -x */
  92   LIST_SUBCOMMAND,              /* -t */
  93   UPDATE_SUBCOMMAND,            /* -u */
  94   TEST_LABEL_SUBCOMMAND,        /* --test-label */
  95 };
  96
  97 GLOBAL enum subcommand subcommand_option;
  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 /* Patterns that match file names to be excluded.  */
 147 GLOBAL struct exclude *excluded;
 148
 149 enum exclusion_tag_type
 150   {
 151     exclusion_tag_none,
 152      /* Exclude the directory contents, but preserve the directory
 153         itself and the exclusion tag file */
 154     exclusion_tag_contents,
 155     /* Exclude everything below the directory, preserving the directory
 156        itself */
 157     exclusion_tag_under,
 158     /* Exclude entire directory  */
 159     exclusion_tag_all,
 160   };
 161
 162 /* Specified value to be put into tar file in place of stat () results, or
 163    just null and -1 if such an override should not take place.  */
 164 GLOBAL char const *group_name_option;
 165 GLOBAL gid_t group_option;
 166
 167 GLOBAL bool ignore_failed_read_option;
 168
 169 GLOBAL bool ignore_zeros_option;
 170
 171 GLOBAL bool incremental_option;
 172
 173 /* Specified name of script to run at end of each tape change.  */
 174 GLOBAL const char *info_script_option;
 175
 176 GLOBAL bool interactive_option;
 177
 178 /* If nonzero, extract only Nth occurrence of each named file */
 179 GLOBAL uintmax_t occurrence_option;
 180
 181 enum old_files
 182 {
 183   DEFAULT_OLD_FILES,          /* default */
 184   NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
 185   OVERWRITE_OLD_FILES,        /* --overwrite */
 186   UNLINK_FIRST_OLD_FILES,     /* --unlink-first */
 187   KEEP_OLD_FILES,             /* --keep-old-files */
 188   SKIP_OLD_FILES,             /* --skip-old-files */
 189   KEEP_NEWER_FILES            /* --keep-newer-files */
 190 };
 191 GLOBAL enum old_files old_files_option;
 192
 193 GLOBAL bool keep_directory_symlink_option;
 194
 195 /* Specified file name for incremental list.  */
 196 GLOBAL const char *listed_incremental_option;
 197 /* Incremental dump level */
 198 GLOBAL int incremental_level;
 199 /* Check device numbers when doing incremental dumps. */
 200 GLOBAL bool check_device_option;
 201
 202 /* Specified mode change string.  */
 203 GLOBAL struct mode_change *mode_option;
 204
 205 /* Initial umask, if needed for mode change string.  */
 206 GLOBAL mode_t initial_umask;
 207
 208 GLOBAL bool multi_volume_option;
 209
 210 /* Specified threshold date and time.  Files having an older time stamp
 211    do not get archived (also see after_date_option above).  */
 212 GLOBAL struct timespec newer_mtime_option;
 213
 214 /* If true, override actual mtime (see below) */
 215 GLOBAL bool set_mtime_option;
 216 /* Value to be put in mtime header field instead of the actual mtime */
 217 GLOBAL struct timespec mtime_option;
 218
 219 /* Return true if newer_mtime_option is initialized.  */
 220 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
 221
 222 /* Return true if the struct stat ST's M time is less than
 223    newer_mtime_option.  */
 224 #define OLDER_STAT_TIME(st, m) \
 225   (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
 226
 227 /* Likewise, for struct tar_stat_info ST.  */
 228 #define OLDER_TAR_STAT_TIME(st, m) \
 229   (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
 230
 231 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR.  */
 232 GLOBAL int recursion_option;
 233
 234 GLOBAL bool numeric_owner_option;
 235
 236 GLOBAL bool one_file_system_option;
 237
 238 /* Create a top-level directory for extracting based on the archive name.  */
 239 GLOBAL bool one_top_level_option;
 240 GLOBAL char *one_top_level_dir;
 241
 242 /* Specified value to be put into tar file in place of stat () results, or
 243    just null and -1 if such an override should not take place.  */
 244 GLOBAL char const *owner_name_option;
 245 GLOBAL uid_t owner_option;
 246
 247 GLOBAL bool recursive_unlink_option;
 248
 249 GLOBAL bool read_full_records_option;
 250
 251 GLOBAL bool remove_files_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,
 334    and current cursor in list.  */
 335 GLOBAL const char **archive_name_array;
 336 GLOBAL size_t archive_names;
 337 GLOBAL const char **archive_name_cursor;
 338
 339 /* Output index file name.  */
 340 GLOBAL char const *index_file_name;
 341
 342 /* Opaque structure for keeping directory meta-data */
 343 struct directory;
 344
 345 /* Structure for keeping track of filenames and lists thereof.  */
 346 struct name
 347   {
 348     struct name *next;          /* Link to the next element */
 349     struct name *prev;          /* Link to the previous element */
 350
 351     char *name;                 /* File name or globbing pattern */
 352     size_t length;              /* cached strlen (name) */
 353     int matching_flags;         /* wildcard flags if name is a pattern */
 354     bool cmdline;               /* true if this name was given in the
 355                                    command line */
 356
 357     int change_dir;             /* Number of the directory to change to.
 358                                    Set with the -C option. */
 359     uintmax_t found_count;      /* number of times a matching file has
 360                                    been found */
 361
 362     /* The following members are used for incremental dumps only,
 363        if this struct name represents a directory;
 364        see incremen.c */
 365     struct directory *directory;/* directory meta-data and contents */
 366     struct name *parent;        /* pointer to the parent hierarchy */
 367     struct name *child;         /* pointer to the first child */
 368     struct name *sibling;       /* pointer to the next sibling */
 369     char *caname;               /* canonical name */
 370   };
 371
 372 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 373 GLOBAL dev_t ar_dev;
 374 GLOBAL ino_t ar_ino;
 375
 376 /* Flags for reading, searching, and fstatatting files.  */
 377 GLOBAL int open_read_flags;
 378 GLOBAL int open_searchdir_flags;
 379 GLOBAL int fstatat_flags;
 380
 381 GLOBAL int seek_option;
 382 GLOBAL bool seekable_archive;
 383
 384 GLOBAL dev_t root_device;
 385
 386 /* Unquote filenames */
 387 GLOBAL bool unquote_option;
 388
 389 GLOBAL int savedir_sort_order;
 390
 391 /* Show file or archive names after transformation.
 392    In particular, when creating archive in verbose mode, list member names
 393    as stored in the archive */
 394 GLOBAL bool show_transformed_names_option;
 395
 396 /* Delay setting modification times and permissions of extracted directories
 397    until the end of extraction. This variable helps correctly restore directory
 398    timestamps from archives with an unusual member order. It is automatically
 399    set for incremental archives. */
 400 GLOBAL bool delay_directory_restore_option;
 401
 402 /* Warn about implicit use of the wildcards in command line arguments.
 403    (Default for tar prior to 1.15.91, but changed afterwards */
 404 GLOBAL bool warn_regex_usage;
 405 \f
 406 /* Declarations for each module.  */
 407
 408 /* FIXME: compare.c should not directly handle the following variable,
 409    instead, this should be done in buffer.c only.  */
 410
 411 enum access_mode
 412 {
 413   ACCESS_READ,
 414   ACCESS_WRITE,
 415   ACCESS_UPDATE
 416 };
 417 extern enum access_mode access_mode;
 418
 419 /* Module buffer.c.  */
 420
 421 extern FILE *stdlis;
 422 extern bool write_archive_to_stdout;
 423 extern char *volume_label;
 424 extern size_t volume_label_count;
 425 extern char *continued_file_name;
 426 extern uintmax_t continued_file_size;
 427 extern uintmax_t continued_file_offset;
 428 extern off_t records_written;
 429
 430 char *drop_volume_label_suffix (const char *label);
 431
 432 size_t available_space_after (union block *pointer);
 433 off_t current_block_ordinal (void);
 434 void close_archive (void);
 435 void closeout_volume_number (void);
 436 double compute_duration (void);
 437 union block *find_next_block (void);
 438 void flush_read (void);
 439 void flush_write (void);
 440 void flush_archive (void);
 441 void init_volume_number (void);
 442 void open_archive (enum access_mode mode);
 443 void print_total_stats (void);
 444 void reset_eof (void);
 445 void set_next_block_after (union block *block);
 446 void clear_read_error_count (void);
 447 void xclose (int fd);
 448 void archive_write_error (ssize_t status) __attribute__ ((noreturn));
 449 void archive_read_error (void);
 450 off_t seek_archive (off_t size);
 451 void set_start_time (void);
 452
 453 #define TF_READ    0
 454 #define TF_WRITE   1
 455 #define TF_DELETED 2
 456 int format_total_stats (FILE *fp, const char **formats, int eor, int eol);
 457 void print_total_stats (void);
 458
 459 void mv_begin_write (const char *file_name, off_t totsize, off_t sizeleft);
 460
 461 void mv_begin_read (struct tar_stat_info *st);
 462 void mv_end (void);
 463 void mv_size_left (off_t size);
 464
 465 void buffer_write_global_xheader (void);
 466
 467 const char *first_decompress_program (int *pstate);
 468 const char *next_decompress_program (int *pstate);
 469
 470 /* Module create.c.  */
 471
 472 enum dump_status
 473   {
 474     dump_status_ok,
 475     dump_status_short,
 476     dump_status_fail,
 477     dump_status_not_implemented
 478   };
 479
 480 void add_exclusion_tag (const char *name, enum exclusion_tag_type type,
 481                         bool (*predicate) (int));
 482 bool cachedir_file_p (int fd);
 483 char *get_directory_entries (struct tar_stat_info *st);
 484
 485 void create_archive (void);
 486 void pad_archive (off_t size_left);
 487 void dump_file (struct tar_stat_info *parent, char const *name,
 488                 char const *fullname);
 489 union block *start_header (struct tar_stat_info *st);
 490 void finish_header (struct tar_stat_info *st, union block *header,
 491                     off_t block_ordinal);
 492 void simple_finish_header (union block *header);
 493 union block * write_extended (bool global, struct tar_stat_info *st,
 494                               union block *old_header);
 495 union block *start_private_header (const char *name, size_t size, time_t t);
 496 void write_eot (void);
 497 void check_links (void);
 498 int subfile_open (struct tar_stat_info const *dir, char const *file, int flags);
 499 void restore_parent_fd (struct tar_stat_info const *st);
 500 void exclusion_tag_warning (const char *dirname, const char *tagname,
 501                             const char *message);
 502 enum exclusion_tag_type check_exclusion_tags (struct tar_stat_info const *st,
 503                                               const char **tag_file_name);
 504
 505 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 506 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 507
 508 bool off_to_chars (off_t off, char *buf, size_t size);
 509 bool time_to_chars (time_t t, char *buf, size_t size);
 510
 511 /* Module diffarch.c.  */
 512
 513 extern bool now_verifying;
 514
 515 void diff_archive (void);
 516 void diff_init (void);
 517 void verify_volume (void);
 518
 519 /* Module extract.c.  */
 520
 521 void extr_init (void);
 522 void extract_archive (void);
 523 void extract_finish (void);
 524 bool rename_directory (char *src, char *dst);
 525
 526 /* Module delete.c.  */
 527
 528 void delete_archive_members (void);
 529
 530 /* Module incremen.c.  */
 531
 532 struct directory *scan_directory (struct tar_stat_info *st);
 533 const char *directory_contents (struct directory *dir);
 534 const char *safe_directory_contents (struct directory *dir);
 535
 536 void rebase_directory (struct directory *dir,
 537                        const char *samp, size_t slen,
 538                        const char *repl, size_t rlen);
 539
 540 void append_incremental_renames (struct directory *dir);
 541 void show_snapshot_field_ranges (void);
 542 void read_directory_file (void);
 543 void write_directory_file (void);
 544 void purge_directory (char const *directory_name);
 545 void list_dumpdir (char *buffer, size_t size);
 546 void update_parent_directory (struct tar_stat_info *st);
 547
 548 size_t dumpdir_size (const char *p);
 549 bool is_dumpdir (struct tar_stat_info *stat_info);
 550 void clear_directory_table (void);
 551
 552 /* Module list.c.  */
 553
 554 enum read_header
 555 {
 556   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 557   HEADER_SUCCESS,               /* header successfully read and checksummed */
 558   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 559   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 560   HEADER_END_OF_FILE,           /* true end of file while header expected */
 561   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 562 };
 563
 564 /* Operation mode for read_header: */
 565
 566 enum read_header_mode
 567 {
 568   read_header_auto,             /* process extended headers automatically */
 569   read_header_x_raw,            /* return raw extended headers (return
 570                                    HEADER_SUCCESS_EXTENDED) */
 571   read_header_x_global          /* when POSIX global extended header is read,
 572                                    decode it and return
 573                                    HEADER_SUCCESS_EXTENDED */
 574 };
 575 extern union block *current_header;
 576 extern enum archive_format current_format;
 577 extern size_t recent_long_name_blocks;
 578 extern size_t recent_long_link_blocks;
 579
 580 void decode_header (union block *header, struct tar_stat_info *stat_info,
 581                     enum archive_format *format_pointer, int do_user_group);
 582 void transform_stat_info (int typeflag, struct tar_stat_info *stat_info);
 583 char const *tartime (struct timespec t, bool full_time);
 584
 585 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 586 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 587
 588 off_t off_from_header (const char *buf, size_t size);
 589 uintmax_t uintmax_from_header (const char *buf, size_t size);
 590
 591 void list_archive (void);
 592 void test_archive_label (void);
 593 void print_for_mkdir (char *dirname, int length, mode_t mode);
 594 void print_header (struct tar_stat_info *st, union block *blk,
 595                    off_t block_ordinal);
 596 void read_and (void (*do_something) (void));
 597 enum read_header read_header (union block **return_block,
 598                               struct tar_stat_info *info,
 599                               enum read_header_mode m);
 600 enum read_header tar_checksum (union block *header, bool silent);
 601 void skip_file (off_t size);
 602 void skip_member (void);
 603
 604 /* Module misc.c.  */
 605
 606 #define min(a, b) ((a) < (b) ? (a) : (b))
 607 #define max(a, b) ((a) < (b) ? (b) : (a))
 608 void assign_string (char **dest, const char *src);
 609 int unquote_string (char *str);
 610 char *zap_slashes (char *name);
 611 char *normalize_filename (int cdidx, const char *name);
 612 void normalize_filename_x (char *name);
 613 void replace_prefix (char **pname, const char *samp, size_t slen,
 614                      const char *repl, size_t rlen);
 615 char *tar_savedir (const char *name, int must_exist);
 616
 617 typedef struct namebuf *namebuf_t;
 618 namebuf_t namebuf_create (const char *dir);
 619 void namebuf_free (namebuf_t buf);
 620 char *namebuf_name (namebuf_t buf, const char *name);
 621 void namebuf_add_dir (namebuf_t buf, const char *name);
 622 char *namebuf_finish (namebuf_t buf);
 623
 624 const char *tar_dirname (void);
 625
 626 /* Represent N using a signed integer I such that (uintmax_t) I == N.
 627    With a good optimizing compiler, this is equivalent to (intmax_t) i
 628    and requires zero machine instructions.  */
 629 #if ! (UINTMAX_MAX / 2 <= INTMAX_MAX)
 630 # error "represent_uintmax returns intmax_t to represent uintmax_t"
 631 #endif
 632 COMMON_INLINE intmax_t
 633 represent_uintmax (uintmax_t n)
 634 {
 635   if (n <= INTMAX_MAX)
 636     return n;
 637   else
 638     {
 639       /* Avoid signed integer overflow on picky platforms.  */
 640       intmax_t nd = n - INTMAX_MIN;
 641       return nd + INTMAX_MIN;
 642     }
 643 }
 644
 645 enum { SYSINT_BUFSIZE =
 646          max (UINTMAX_STRSIZE_BOUND, INT_BUFSIZE_BOUND (intmax_t)) };
 647 char *sysinttostr (uintmax_t, intmax_t, uintmax_t, char buf[SYSINT_BUFSIZE]);
 648 intmax_t strtosysint (char const *, char **, intmax_t, uintmax_t);
 649 void code_ns_fraction (int ns, char *p);
 650 char const *code_timespec (struct timespec ts, char *sbuf);
 651 enum { BILLION = 1000000000, LOG10_BILLION = 9 };
 652 enum { TIMESPEC_STRSIZE_BOUND =
 653          UINTMAX_STRSIZE_BOUND + LOG10_BILLION + sizeof "-." - 1 };
 654 struct timespec decode_timespec (char const *, char **, bool);
 655
 656 /* Return true if T does not represent an out-of-range or invalid value.  */
 657 COMMON_INLINE bool
 658 valid_timespec (struct timespec t)
 659 {
 660   return 0 <= t.tv_nsec;
 661 }
 662
 663 bool must_be_dot_or_slash (char const *);
 664
 665 enum remove_option
 666 {
 667   ORDINARY_REMOVE_OPTION,
 668   RECURSIVE_REMOVE_OPTION,
 669
 670   /* FIXME: The following value is never used. It seems to be intended
 671      as a placeholder for a hypothetical option that should instruct tar
 672      to recursively remove subdirectories in purge_directory(),
 673      as opposed to the functionality of --recursive-unlink
 674      (RECURSIVE_REMOVE_OPTION value), which removes them in
 675      prepare_to_extract() phase. However, with the addition of more
 676      meta-info to the incremental dumps, this should become unnecessary */
 677   WANT_DIRECTORY_REMOVE_OPTION
 678 };
 679 int remove_any_file (const char *file_name, enum remove_option option);
 680 bool maybe_backup_file (const char *file_name, bool this_is_the_archive);
 681 void undo_last_backup (void);
 682
 683 int deref_stat (char const *name, struct stat *buf);
 684
 685 size_t blocking_read (int fd, void *buf, size_t count);
 686 size_t blocking_write (int fd, void const *buf, size_t count);
 687
 688 extern int chdir_current;
 689 extern int chdir_fd;
 690 int chdir_arg (char const *dir);
 691 void chdir_do (int dir);
 692 int chdir_count (void);
 693
 694 void close_diag (char const *name);
 695 void open_diag (char const *name);
 696 void read_diag_details (char const *name, off_t offset, size_t size);
 697 void readlink_diag (char const *name);
 698 void savedir_diag (char const *name);
 699 void seek_diag_details (char const *name, off_t offset);
 700 void stat_diag (char const *name);
 701 void file_removed_diag (const char *name, bool top_level,
 702                         void (*diagfn) (char const *name));
 703 void write_error_details (char const *name, size_t status, size_t size);
 704 void write_fatal (char const *name) __attribute__ ((noreturn));
 705 void write_fatal_details (char const *name, ssize_t status, size_t size)
 706      __attribute__ ((noreturn));
 707
 708 pid_t xfork (void);
 709 void xpipe (int fd[2]);
 710
 711 void *page_aligned_alloc (void **ptr, size_t size);
 712 int set_file_atime (int fd, int parentfd, char const *file,
 713                     struct timespec atime);
 714
 715 /* Module names.c.  */
 716
 717 extern size_t name_count;
 718 extern struct name *gnu_list_name;
 719
 720 void gid_to_gname (gid_t gid, char **gname);
 721 int gname_to_gid (char const *gname, gid_t *pgid);
 722 void uid_to_uname (uid_t uid, char **uname);
 723 int uname_to_uid (char const *uname, uid_t *puid);
 724
 725 void name_init (void);
 726 void name_add_name (const char *name, int matching_flags);
 727 void name_add_dir (const char *name);
 728 void name_add_file (const char *name, int term, int matching_flags);
 729 void name_term (void);
 730 const char *name_next (int change_dirs);
 731 void name_gather (void);
 732 struct name *addname (char const *string, int change_dir,
 733                       bool cmdline, struct name *parent);
 734 void remname (struct name *name);
 735 bool name_match (const char *name);
 736 void names_notfound (void);
 737 void label_notfound (void);
 738 void collect_and_sort_names (void);
 739 struct name *name_scan (const char *name);
 740 struct name const *name_from_list (void);
 741 void blank_name_list (void);
 742 char *new_name (const char *dir_name, const char *name);
 743 size_t stripped_prefix_len (char const *file_name, size_t num);
 744 bool all_names_found (struct tar_stat_info *st);
 745
 746 void add_avoided_name (char const *name);
 747 bool is_avoided_name (char const *name);
 748
 749 bool contains_dot_dot (char const *name);
 750
 751 #define ISFOUND(c) (occurrence_option == 0                      \
 752                     ? (c)->found_count != 0                     \
 753                     : (c)->found_count == occurrence_option)
 754 #define WASFOUND(c) (occurrence_option == 0                     \
 755                      ? (c)->found_count != 0                    \
 756                      : (c)->found_count >= occurrence_option)
 757
 758 /* Module tar.c.  */
 759
 760 void usage (int);
 761
 762 int confirm (const char *message_action, const char *name);
 763
 764 void tar_stat_init (struct tar_stat_info *st);
 765 bool tar_stat_close (struct tar_stat_info *st);
 766 void tar_stat_destroy (struct tar_stat_info *st);
 767 void usage (int) __attribute__ ((noreturn));
 768 int tar_timespec_cmp (struct timespec a, struct timespec b);
 769 const char *archive_format_string (enum archive_format fmt);
 770 const char *subcommand_string (enum subcommand c);
 771 void set_exit_status (int val);
 772
 773 void request_stdin (const char *option);
 774 void more_options (int argc, char **argv);
 775
 776 /* Module update.c.  */
 777
 778 extern char *output_start;
 779
 780 void update_archive (void);
 781
 782 /* Module attrs.c.  */
 783 #include "xattrs.h"
 784
 785 /* Module xheader.c.  */
 786
 787 void xheader_decode (struct tar_stat_info *stat);
 788 void xheader_decode_global (struct xheader *xhdr);
 789 void xheader_store (char const *keyword, struct tar_stat_info *st,
 790                     void const *data);
 791 void xheader_read (struct xheader *xhdr, union block *header, off_t size);
 792 void xheader_write (char type, char *name, time_t t, struct xheader *xhdr);
 793 void xheader_write_global (struct xheader *xhdr);
 794 void xheader_finish (struct xheader *hdr);
 795 void xheader_destroy (struct xheader *hdr);
 796 char *xheader_xhdr_name (struct tar_stat_info *st);
 797 char *xheader_ghdr_name (void);
 798 void xheader_set_option (char *string);
 799 void xheader_string_begin (struct xheader *xhdr);
 800 void xheader_string_add (struct xheader *xhdr, char const *s);
 801 bool xheader_string_end (struct xheader *xhdr, char const *keyword);
 802 bool xheader_keyword_deleted_p (const char *kw);
 803 char *xheader_format_name (struct tar_stat_info *st, const char *fmt,
 804                            size_t n);
 805 void xheader_xattr_init (struct tar_stat_info *st);
 806 void xheader_xattr_free (struct xattr_array *vals, size_t sz);
 807 void xheader_xattr_copy (const struct tar_stat_info *st,
 808                          struct xattr_array **vals, size_t *sz);
 809 void xheader_xattr_add (struct tar_stat_info *st,
 810                         const char *key, const char *val, size_t len);
 811
 812 /* Module system.c */
 813
 814 void sys_detect_dev_null_output (void);
 815 void sys_save_archive_dev_ino (void);
 816 void sys_wait_for_child (pid_t, bool);
 817 void sys_spawn_shell (void);
 818 bool sys_compare_uid (struct stat *a, struct stat *b);
 819 bool sys_compare_gid (struct stat *a, struct stat *b);
 820 bool sys_file_is_archive (struct tar_stat_info *p);
 821 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 822 int sys_truncate (int fd);
 823 pid_t sys_child_open_for_compress (void);
 824 pid_t sys_child_open_for_uncompress (void);
 825 size_t sys_write_archive_buffer (void);
 826 bool sys_get_archive_stat (void);
 827 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
 828 void sys_wait_command (void);
 829 int sys_exec_info_script (const char **archive_name, int volume_number);
 830 void sys_exec_checkpoint_script (const char *script_name,
 831                                  const char *archive_name,
 832                                  int checkpoint_number);
 833
 834 /* Module compare.c */
 835 void report_difference (struct tar_stat_info *st, const char *message, ...)
 836   __attribute__ ((format (printf, 2, 3)));
 837
 838 /* Module sparse.c */
 839 bool sparse_member_p (struct tar_stat_info *st);
 840 bool sparse_fixup_header (struct tar_stat_info *st);
 841 enum dump_status sparse_dump_file (int, struct tar_stat_info *st);
 842 enum dump_status sparse_extract_file (int fd, struct tar_stat_info *st,
 843                                       off_t *size);
 844 enum dump_status sparse_skip_file (struct tar_stat_info *st);
 845 bool sparse_diff_file (int, struct tar_stat_info *st);
 846
 847 /* Module utf8.c */
 848 bool string_ascii_p (const char *str);
 849 bool utf8_convert (bool to_utf, char const *input, char **output);
 850
 851 /* Module transform.c */
 852 #define XFORM_REGFILE  0x01
 853 #define XFORM_LINK     0x02
 854 #define XFORM_SYMLINK  0x04
 855 #define XFORM_ALL      (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
 856
 857 void set_transform_expr (const char *expr);
 858 bool transform_name (char **pinput, int type);
 859 bool transform_name_fp (char **pinput, int type,
 860                         char *(*fun)(char *, void *), void *);
 861 bool transform_program_p (void);
 862
 863 /* Module suffix.c */
 864 void set_compression_program_by_suffix (const char *name, const char *defprog);
 865 char *strip_compression_suffix (const char *name);
 866
 867 /* Module checkpoint.c */
 868 void checkpoint_compile_action (const char *str);
 869 void checkpoint_finish_compile (void);
 870 void checkpoint_run (bool do_write);
 871 void checkpoint_finish (void);
 872 void checkpoint_flush_actions (void);
 873
 874 /* Module warning.c */
 875 #define WARN_ALONE_ZERO_BLOCK    0x00000001
 876 #define WARN_BAD_DUMPDIR         0x00000002
 877 #define WARN_CACHEDIR            0x00000004
 878 #define WARN_CONTIGUOUS_CAST     0x00000008
 879 #define WARN_FILE_CHANGED        0x00000010
 880 #define WARN_FILE_IGNORED        0x00000020
 881 #define WARN_FILE_REMOVED        0x00000040
 882 #define WARN_FILE_SHRANK         0x00000080
 883 #define WARN_FILE_UNCHANGED      0x00000100
 884 #define WARN_FILENAME_WITH_NULS  0x00000200
 885 #define WARN_IGNORE_ARCHIVE      0x00000400
 886 #define WARN_IGNORE_NEWER        0x00000800
 887 #define WARN_NEW_DIRECTORY       0x00001000
 888 #define WARN_RENAME_DIRECTORY    0x00002000
 889 #define WARN_SYMLINK_CAST        0x00004000
 890 #define WARN_TIMESTAMP           0x00008000
 891 #define WARN_UNKNOWN_CAST        0x00010000
 892 #define WARN_UNKNOWN_KEYWORD     0x00020000
 893 #define WARN_XDEV                0x00040000
 894 #define WARN_DECOMPRESS_PROGRAM  0x00080000
 895 #define WARN_EXISTING_FILE       0x00100000
 896 #define WARN_XATTR_WRITE         0x00200000
 897 #define WARN_RECORD_SIZE         0x00400000
 898
 899 /* These warnings are enabled by default in verbose mode: */
 900 #define WARN_VERBOSE_WARNINGS    (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY|\
 901                                   WARN_DECOMPRESS_PROGRAM|WARN_EXISTING_FILE|\
 902                                   WARN_RECORD_SIZE)
 903 #define WARN_ALL                 (~WARN_VERBOSE_WARNINGS)
 904
 905 void set_warning_option (const char *arg);
 906
 907 extern int warning_option;
 908
 909 #define WARNOPT(opt,args)                       \
 910   do                                            \
 911     {                                           \
 912       if (warning_option & opt) WARN (args);    \
 913     }                                           \
 914   while (0)
 915
 916 /* Module unlink.c */
 917
 918 void queue_deferred_unlink (const char *name, bool is_dir);
 919 void finish_deferred_unlinks (void);
 920
 921 /* Module exit.c */
 922 extern void (*fatal_exit_hook) (void);
 923
 924 /* Module exclist.c */
 925 #define EXCL_DEFAULT       0x00
 926 #define EXCL_RECURSIVE     0x01
 927 #define EXCL_NON_RECURSIVE 0x02
 928
 929 void excfile_add (const char *name, int flags);
 930 void info_attach_exclist (struct tar_stat_info *dir);
 931 void info_cleanup_exclist (struct tar_stat_info *dir);
 932 void info_free_exclist (struct tar_stat_info *dir);
 933 bool excluded_name (char const *name, struct tar_stat_info *st);
 934 void exclude_vcs_ignores (void);
 935
 936 _GL_INLINE_HEADER_END