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