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 /* Show file or archive names after transformation.
 390    In particular, when creating archive in verbose mode, list member names
 391    as stored in the archive */
 392 GLOBAL bool show_transformed_names_option;
 393
 394 /* Delay setting modification times and permissions of extracted directories
 395    until the end of extraction. This variable helps correctly restore directory
 396    timestamps from archives with an unusual member order. It is automatically
 397    set for incremental archives. */
 398 GLOBAL bool delay_directory_restore_option;
 399
 400 /* Warn about implicit use of the wildcards in command line arguments.
 401    (Default for tar prior to 1.15.91, but changed afterwards */
 402 GLOBAL bool warn_regex_usage;
 403 \f
 404 /* Declarations for each module.  */
 405
 406 /* FIXME: compare.c should not directly handle the following variable,
 407    instead, this should be done in buffer.c only.  */
 408
 409 enum access_mode
 410 {
 411   ACCESS_READ,
 412   ACCESS_WRITE,
 413   ACCESS_UPDATE
 414 };
 415 extern enum access_mode access_mode;
 416
 417 /* Module buffer.c.  */
 418
 419 extern FILE *stdlis;
 420 extern bool write_archive_to_stdout;
 421 extern char *volume_label;
 422 extern size_t volume_label_count;
 423 extern char *continued_file_name;
 424 extern uintmax_t continued_file_size;
 425 extern uintmax_t continued_file_offset;
 426 extern off_t records_written;
 427
 428 char *drop_volume_label_suffix (const char *label);
 429
 430 size_t available_space_after (union block *pointer);
 431 off_t current_block_ordinal (void);
 432 void close_archive (void);
 433 void closeout_volume_number (void);
 434 double compute_duration (void);
 435 union block *find_next_block (void);
 436 void flush_read (void);
 437 void flush_write (void);
 438 void flush_archive (void);
 439 void init_volume_number (void);
 440 void open_archive (enum access_mode mode);
 441 void print_total_stats (void);
 442 void reset_eof (void);
 443 void set_next_block_after (union block *block);
 444 void clear_read_error_count (void);
 445 void xclose (int fd);
 446 void archive_write_error (ssize_t status) __attribute__ ((noreturn));
 447 void archive_read_error (void);
 448 off_t seek_archive (off_t size);
 449 void set_start_time (void);
 450
 451 #define TF_READ    0
 452 #define TF_WRITE   1
 453 #define TF_DELETED 2
 454 int format_total_stats (FILE *fp, const char **formats, int eor, int eol);
 455 void print_total_stats (void);
 456
 457 void mv_begin_write (const char *file_name, off_t totsize, off_t sizeleft);
 458
 459 void mv_begin_read (struct tar_stat_info *st);
 460 void mv_end (void);
 461 void mv_size_left (off_t size);
 462
 463 void buffer_write_global_xheader (void);
 464
 465 const char *first_decompress_program (int *pstate);
 466 const char *next_decompress_program (int *pstate);
 467
 468 /* Module create.c.  */
 469
 470 enum dump_status
 471   {
 472     dump_status_ok,
 473     dump_status_short,
 474     dump_status_fail,
 475     dump_status_not_implemented
 476   };
 477
 478 void add_exclusion_tag (const char *name, enum exclusion_tag_type type,
 479                         bool (*predicate) (int));
 480 bool cachedir_file_p (int fd);
 481 char *get_directory_entries (struct tar_stat_info *st);
 482
 483 void create_archive (void);
 484 void pad_archive (off_t size_left);
 485 void dump_file (struct tar_stat_info *parent, char const *name,
 486                 char const *fullname);
 487 union block *start_header (struct tar_stat_info *st);
 488 void finish_header (struct tar_stat_info *st, union block *header,
 489                     off_t block_ordinal);
 490 void simple_finish_header (union block *header);
 491 union block * write_extended (bool global, struct tar_stat_info *st,
 492                               union block *old_header);
 493 union block *start_private_header (const char *name, size_t size, time_t t);
 494 void write_eot (void);
 495 void check_links (void);
 496 int subfile_open (struct tar_stat_info const *dir, char const *file, int flags);
 497 void restore_parent_fd (struct tar_stat_info const *st);
 498 void exclusion_tag_warning (const char *dirname, const char *tagname,
 499                             const char *message);
 500 enum exclusion_tag_type check_exclusion_tags (struct tar_stat_info const *st,
 501                                               const char **tag_file_name);
 502
 503 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 504 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 505
 506 bool off_to_chars (off_t off, char *buf, size_t size);
 507 bool time_to_chars (time_t t, char *buf, size_t size);
 508
 509 /* Module diffarch.c.  */
 510
 511 extern bool now_verifying;
 512
 513 void diff_archive (void);
 514 void diff_init (void);
 515 void verify_volume (void);
 516
 517 /* Module extract.c.  */
 518
 519 void extr_init (void);
 520 void extract_archive (void);
 521 void extract_finish (void);
 522 bool rename_directory (char *src, char *dst);
 523
 524 /* Module delete.c.  */
 525
 526 void delete_archive_members (void);
 527
 528 /* Module incremen.c.  */
 529
 530 struct directory *scan_directory (struct tar_stat_info *st);
 531 const char *directory_contents (struct directory *dir);
 532 const char *safe_directory_contents (struct directory *dir);
 533
 534 void rebase_directory (struct directory *dir,
 535                        const char *samp, size_t slen,
 536                        const char *repl, size_t rlen);
 537
 538 void append_incremental_renames (struct directory *dir);
 539 void show_snapshot_field_ranges (void);
 540 void read_directory_file (void);
 541 void write_directory_file (void);
 542 void purge_directory (char const *directory_name);
 543 void list_dumpdir (char *buffer, size_t size);
 544 void update_parent_directory (struct tar_stat_info *st);
 545
 546 size_t dumpdir_size (const char *p);
 547 bool is_dumpdir (struct tar_stat_info *stat_info);
 548 void clear_directory_table (void);
 549
 550 /* Module list.c.  */
 551
 552 enum read_header
 553 {
 554   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 555   HEADER_SUCCESS,               /* header successfully read and checksummed */
 556   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 557   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 558   HEADER_END_OF_FILE,           /* true end of file while header expected */
 559   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 560 };
 561
 562 /* Operation mode for read_header: */
 563
 564 enum read_header_mode
 565 {
 566   read_header_auto,             /* process extended headers automatically */
 567   read_header_x_raw,            /* return raw extended headers (return
 568                                    HEADER_SUCCESS_EXTENDED) */
 569   read_header_x_global          /* when POSIX global extended header is read,
 570                                    decode it and return
 571                                    HEADER_SUCCESS_EXTENDED */
 572 };
 573 extern union block *current_header;
 574 extern enum archive_format current_format;
 575 extern size_t recent_long_name_blocks;
 576 extern size_t recent_long_link_blocks;
 577
 578 void decode_header (union block *header, struct tar_stat_info *stat_info,
 579                     enum archive_format *format_pointer, int do_user_group);
 580 void transform_stat_info (int typeflag, struct tar_stat_info *stat_info);
 581 char const *tartime (struct timespec t, bool full_time);
 582
 583 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 584 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 585
 586 off_t off_from_header (const char *buf, size_t size);
 587 uintmax_t uintmax_from_header (const char *buf, size_t size);
 588
 589 void list_archive (void);
 590 void test_archive_label (void);
 591 void print_for_mkdir (char *dirname, int length, mode_t mode);
 592 void print_header (struct tar_stat_info *st, union block *blk,
 593                    off_t block_ordinal);
 594 void read_and (void (*do_something) (void));
 595 enum read_header read_header (union block **return_block,
 596                               struct tar_stat_info *info,
 597                               enum read_header_mode m);
 598 enum read_header tar_checksum (union block *header, bool silent);
 599 void skip_file (off_t size);
 600 void skip_member (void);
 601
 602 /* Module misc.c.  */
 603
 604 #define min(a, b) ((a) < (b) ? (a) : (b))
 605 #define max(a, b) ((a) < (b) ? (b) : (a))
 606 void assign_string (char **dest, const char *src);
 607 int unquote_string (char *str);
 608 char *zap_slashes (char *name);
 609 char *normalize_filename (int cdidx, const char *name);
 610 void normalize_filename_x (char *name);
 611 void replace_prefix (char **pname, const char *samp, size_t slen,
 612                      const char *repl, size_t rlen);
 613 char *tar_savedir (const char *name, int must_exist);
 614
 615 typedef struct namebuf *namebuf_t;
 616 namebuf_t namebuf_create (const char *dir);
 617 void namebuf_free (namebuf_t buf);
 618 char *namebuf_name (namebuf_t buf, const char *name);
 619 void namebuf_add_dir (namebuf_t buf, const char *name);
 620 char *namebuf_finish (namebuf_t buf);
 621
 622 const char *tar_dirname (void);
 623
 624 /* Represent N using a signed integer I such that (uintmax_t) I == N.
 625    With a good optimizing compiler, this is equivalent to (intmax_t) i
 626    and requires zero machine instructions.  */
 627 #if ! (UINTMAX_MAX / 2 <= INTMAX_MAX)
 628 # error "represent_uintmax returns intmax_t to represent uintmax_t"
 629 #endif
 630 COMMON_INLINE intmax_t
 631 represent_uintmax (uintmax_t n)
 632 {
 633   if (n <= INTMAX_MAX)
 634     return n;
 635   else
 636     {
 637       /* Avoid signed integer overflow on picky platforms.  */
 638       intmax_t nd = n - INTMAX_MIN;
 639       return nd + INTMAX_MIN;
 640     }
 641 }
 642
 643 enum { SYSINT_BUFSIZE =
 644          max (UINTMAX_STRSIZE_BOUND, INT_BUFSIZE_BOUND (intmax_t)) };
 645 char *sysinttostr (uintmax_t, intmax_t, uintmax_t, char buf[SYSINT_BUFSIZE]);
 646 intmax_t strtosysint (char const *, char **, intmax_t, uintmax_t);
 647 void code_ns_fraction (int ns, char *p);
 648 char const *code_timespec (struct timespec ts, char *sbuf);
 649 enum { BILLION = 1000000000, LOG10_BILLION = 9 };
 650 enum { TIMESPEC_STRSIZE_BOUND =
 651          UINTMAX_STRSIZE_BOUND + LOG10_BILLION + sizeof "-." - 1 };
 652 struct timespec decode_timespec (char const *, char **, bool);
 653
 654 /* Return true if T does not represent an out-of-range or invalid value.  */
 655 COMMON_INLINE bool
 656 valid_timespec (struct timespec t)
 657 {
 658   return 0 <= t.tv_nsec;
 659 }
 660
 661 bool must_be_dot_or_slash (char const *);
 662
 663 enum remove_option
 664 {
 665   ORDINARY_REMOVE_OPTION,
 666   RECURSIVE_REMOVE_OPTION,
 667
 668   /* FIXME: The following value is never used. It seems to be intended
 669      as a placeholder for a hypothetical option that should instruct tar
 670      to recursively remove subdirectories in purge_directory(),
 671      as opposed to the functionality of --recursive-unlink
 672      (RECURSIVE_REMOVE_OPTION value), which removes them in
 673      prepare_to_extract() phase. However, with the addition of more
 674      meta-info to the incremental dumps, this should become unnecessary */
 675   WANT_DIRECTORY_REMOVE_OPTION
 676 };
 677 int remove_any_file (const char *file_name, enum remove_option option);
 678 bool maybe_backup_file (const char *file_name, bool this_is_the_archive);
 679 void undo_last_backup (void);
 680
 681 int deref_stat (char const *name, struct stat *buf);
 682
 683 size_t blocking_read (int fd, void *buf, size_t count);
 684 size_t blocking_write (int fd, void const *buf, size_t count);
 685
 686 extern int chdir_current;
 687 extern int chdir_fd;
 688 int chdir_arg (char const *dir);
 689 void chdir_do (int dir);
 690 int chdir_count (void);
 691
 692 void close_diag (char const *name);
 693 void open_diag (char const *name);
 694 void read_diag_details (char const *name, off_t offset, size_t size);
 695 void readlink_diag (char const *name);
 696 void savedir_diag (char const *name);
 697 void seek_diag_details (char const *name, off_t offset);
 698 void stat_diag (char const *name);
 699 void file_removed_diag (const char *name, bool top_level,
 700                         void (*diagfn) (char const *name));
 701 void write_error_details (char const *name, size_t status, size_t size);
 702 void write_fatal (char const *name) __attribute__ ((noreturn));
 703 void write_fatal_details (char const *name, ssize_t status, size_t size)
 704      __attribute__ ((noreturn));
 705
 706 pid_t xfork (void);
 707 void xpipe (int fd[2]);
 708
 709 void *page_aligned_alloc (void **ptr, size_t size);
 710 int set_file_atime (int fd, int parentfd, char const *file,
 711                     struct timespec atime);
 712
 713 /* Module names.c.  */
 714
 715 extern size_t name_count;
 716 extern struct name *gnu_list_name;
 717
 718 void gid_to_gname (gid_t gid, char **gname);
 719 int gname_to_gid (char const *gname, gid_t *pgid);
 720 void uid_to_uname (uid_t uid, char **uname);
 721 int uname_to_uid (char const *uname, uid_t *puid);
 722
 723 void name_init (void);
 724 void name_add_name (const char *name, int matching_flags);
 725 void name_add_dir (const char *name);
 726 void name_add_file (const char *name, int term);
 727 void name_term (void);
 728 const char *name_next (int change_dirs);
 729 void name_gather (void);
 730 struct name *addname (char const *string, int change_dir,
 731                       bool cmdline, struct name *parent);
 732 void remname (struct name *name);
 733 bool name_match (const char *name);
 734 void names_notfound (void);
 735 void label_notfound (void);
 736 void collect_and_sort_names (void);
 737 struct name *name_scan (const char *name);
 738 struct name const *name_from_list (void);
 739 void blank_name_list (void);
 740 char *new_name (const char *dir_name, const char *name);
 741 size_t stripped_prefix_len (char const *file_name, size_t num);
 742 bool all_names_found (struct tar_stat_info *st);
 743
 744 bool excluded_name (char const *name);
 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) ? (c)->found_count : \
 752                     (c)->found_count == occurrence_option)
 753 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 754                      (c)->found_count >= occurrence_option)
 755
 756 /* Module tar.c.  */
 757
 758 void usage (int);
 759
 760 int confirm (const char *message_action, const char *name);
 761
 762 void tar_stat_init (struct tar_stat_info *st);
 763 bool tar_stat_close (struct tar_stat_info *st);
 764 void tar_stat_destroy (struct tar_stat_info *st);
 765 void usage (int) __attribute__ ((noreturn));
 766 int tar_timespec_cmp (struct timespec a, struct timespec b);
 767 const char *archive_format_string (enum archive_format fmt);
 768 const char *subcommand_string (enum subcommand c);
 769 void set_exit_status (int val);
 770
 771 void request_stdin (const char *option);
 772 void more_options (int argc, char **argv);
 773
 774 /* Module update.c.  */
 775
 776 extern char *output_start;
 777
 778 void update_archive (void);
 779
 780 /* Module attrs.c.  */
 781 #include "xattrs.h"
 782
 783 /* Module xheader.c.  */
 784
 785 void xheader_decode (struct tar_stat_info *stat);
 786 void xheader_decode_global (struct xheader *xhdr);
 787 void xheader_store (char const *keyword, struct tar_stat_info *st,
 788                     void const *data);
 789 void xheader_read (struct xheader *xhdr, union block *header, off_t size);
 790 void xheader_write (char type, char *name, time_t t, struct xheader *xhdr);
 791 void xheader_write_global (struct xheader *xhdr);
 792 void xheader_finish (struct xheader *hdr);
 793 void xheader_destroy (struct xheader *hdr);
 794 char *xheader_xhdr_name (struct tar_stat_info *st);
 795 char *xheader_ghdr_name (void);
 796 void xheader_set_option (char *string);
 797 void xheader_string_begin (struct xheader *xhdr);
 798 void xheader_string_add (struct xheader *xhdr, char const *s);
 799 bool xheader_string_end (struct xheader *xhdr, char const *keyword);
 800 bool xheader_keyword_deleted_p (const char *kw);
 801 char *xheader_format_name (struct tar_stat_info *st, const char *fmt,
 802                            size_t n);
 803 void xheader_xattr_init (struct tar_stat_info *st);
 804 void xheader_xattr_free (struct xattr_array *vals, size_t sz);
 805 void xheader_xattr_copy (const struct tar_stat_info *st,
 806                          struct xattr_array **vals, size_t *sz);
 807 void xheader_xattr_add (struct tar_stat_info *st,
 808                         const char *key, const char *val, size_t len);
 809
 810 /* Module system.c */
 811
 812 void sys_detect_dev_null_output (void);
 813 void sys_save_archive_dev_ino (void);
 814 void sys_wait_for_child (pid_t, bool);
 815 void sys_spawn_shell (void);
 816 bool sys_compare_uid (struct stat *a, struct stat *b);
 817 bool sys_compare_gid (struct stat *a, struct stat *b);
 818 bool sys_file_is_archive (struct tar_stat_info *p);
 819 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 820 int sys_truncate (int fd);
 821 pid_t sys_child_open_for_compress (void);
 822 pid_t sys_child_open_for_uncompress (void);
 823 size_t sys_write_archive_buffer (void);
 824 bool sys_get_archive_stat (void);
 825 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
 826 void sys_wait_command (void);
 827 int sys_exec_info_script (const char **archive_name, int volume_number);
 828 void sys_exec_checkpoint_script (const char *script_name,
 829                                  const char *archive_name,
 830                                  int checkpoint_number);
 831
 832 /* Module compare.c */
 833 void report_difference (struct tar_stat_info *st, const char *message, ...)
 834   __attribute__ ((format (printf, 2, 3)));
 835
 836 /* Module sparse.c */
 837 bool sparse_member_p (struct tar_stat_info *st);
 838 bool sparse_fixup_header (struct tar_stat_info *st);
 839 enum dump_status sparse_dump_file (int, struct tar_stat_info *st);
 840 enum dump_status sparse_extract_file (int fd, struct tar_stat_info *st,
 841                                       off_t *size);
 842 enum dump_status sparse_skip_file (struct tar_stat_info *st);
 843 bool sparse_diff_file (int, struct tar_stat_info *st);
 844
 845 /* Module utf8.c */
 846 bool string_ascii_p (const char *str);
 847 bool utf8_convert (bool to_utf, char const *input, char **output);
 848
 849 /* Module transform.c */
 850 #define XFORM_REGFILE  0x01
 851 #define XFORM_LINK     0x02
 852 #define XFORM_SYMLINK  0x04
 853 #define XFORM_ALL      (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
 854
 855 void set_transform_expr (const char *expr);
 856 bool transform_name (char **pinput, int type);
 857 bool transform_name_fp (char **pinput, int type,
 858                         char *(*fun)(char *, void *), void *);
 859 bool transform_program_p (void);
 860
 861 /* Module suffix.c */
 862 void set_compression_program_by_suffix (const char *name, const char *defprog);
 863 char *strip_compression_suffix (const char *name);
 864
 865 /* Module checkpoint.c */
 866 void checkpoint_compile_action (const char *str);
 867 void checkpoint_finish_compile (void);
 868 void checkpoint_run (bool do_write);
 869 void checkpoint_finish (void);
 870 void checkpoint_flush_actions (void);
 871
 872 /* Module warning.c */
 873 #define WARN_ALONE_ZERO_BLOCK    0x00000001
 874 #define WARN_BAD_DUMPDIR         0x00000002
 875 #define WARN_CACHEDIR            0x00000004
 876 #define WARN_CONTIGUOUS_CAST     0x00000008
 877 #define WARN_FILE_CHANGED        0x00000010
 878 #define WARN_FILE_IGNORED        0x00000020
 879 #define WARN_FILE_REMOVED        0x00000040
 880 #define WARN_FILE_SHRANK         0x00000080
 881 #define WARN_FILE_UNCHANGED      0x00000100
 882 #define WARN_FILENAME_WITH_NULS  0x00000200
 883 #define WARN_IGNORE_ARCHIVE      0x00000400
 884 #define WARN_IGNORE_NEWER        0x00000800
 885 #define WARN_NEW_DIRECTORY       0x00001000
 886 #define WARN_RENAME_DIRECTORY    0x00002000
 887 #define WARN_SYMLINK_CAST        0x00004000
 888 #define WARN_TIMESTAMP           0x00008000
 889 #define WARN_UNKNOWN_CAST        0x00010000
 890 #define WARN_UNKNOWN_KEYWORD     0x00020000
 891 #define WARN_XDEV                0x00040000
 892 #define WARN_DECOMPRESS_PROGRAM  0x00080000
 893 #define WARN_EXISTING_FILE       0x00100000
 894 #define WARN_XATTR_WRITE         0x00200000
 895 #define WARN_RECORD_SIZE         0x00400000
 896
 897 /* These warnings are enabled by default in verbose mode: */
 898 #define WARN_VERBOSE_WARNINGS    (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY|\
 899                                   WARN_DECOMPRESS_PROGRAM|WARN_EXISTING_FILE|\
 900                                   WARN_RECORD_SIZE)
 901 #define WARN_ALL                 (~WARN_VERBOSE_WARNINGS)
 902
 903 void set_warning_option (const char *arg);
 904
 905 extern int warning_option;
 906
 907 #define WARNOPT(opt,args)                       \
 908   do                                            \
 909     {                                           \
 910       if (warning_option & opt) WARN (args);    \
 911     }                                           \
 912   while (0)
 913
 914 /* Module unlink.c */
 915
 916 void queue_deferred_unlink (const char *name, bool is_dir);
 917 void finish_deferred_unlinks (void);
 918
 919 /* Module exit.c */
 920 extern void (*fatal_exit_hook) (void);
 921
 922 _GL_INLINE_HEADER_END