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