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

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