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