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

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