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 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 2, 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    59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 /* Old GNU stores zero-terminated file name */
  27 #define OLDGNU_NAME_FIELD_SIZE   99
  28
  29 /* Some constants from POSIX are given names.  */
  30 #define NAME_FIELD_SIZE   100
  31 #define PREFIX_FIELD_SIZE 155
  32 #define UNAME_FIELD_SIZE   32
  33 #define GNAME_FIELD_SIZE   32
  34
  35 /* FIXME */
  36 #define MAXOCTAL11      017777777777L
  37 #define MAXOCTAL7       07777777
  38
  39
  40 \f
  41 /* Some various global definitions.  */
  42
  43 /* Name of file to use for interacting with user.  */
  44
  45 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
  46    modules.  Here, we merely set it to "extern" if it is not already set.
  47    GNU tar does depend on the system loader to preset all GLOBAL variables to
  48    neutral (or zero) values, explicit initialization is usually not done.  */
  49 #ifndef GLOBAL
  50 # define GLOBAL extern
  51 #endif
  52
  53 /* Exit status for GNU tar.  Let's try to keep this list as simple as
  54    possible.  -d option strongly invites a status different for unequal
  55    comparison and other errors.  */
  56 GLOBAL int exit_status;
  57
  58 #define TAREXIT_SUCCESS 0
  59 #define TAREXIT_DIFFERS 1
  60 #define TAREXIT_FAILURE 2
  61
  62 /* Both WARN and ERROR write a message on stderr and continue processing,
  63    however ERROR manages so tar will exit unsuccessfully.  FATAL_ERROR
  64    writes a message on stderr and aborts immediately, with another message
  65    line telling so.  USAGE_ERROR works like FATAL_ERROR except that the
  66    other message line suggests trying --help.  All four macros accept a
  67    single argument of the form ((0, errno, _("FORMAT"), Args...)).  errno
  68    is zero when the error is not being detected by the system.  */
  69
  70 #define WARN(Args) \
  71   error Args
  72 #define ERROR(Args) \
  73   (error Args, exit_status = TAREXIT_FAILURE)
  74 #define FATAL_ERROR(Args) \
  75   (error Args, fatal_exit ())
  76 #define USAGE_ERROR(Args) \
  77   (error Args, usage (TAREXIT_FAILURE))
  78 \f
  79 #include "arith.h"
  80 #include <backupfile.h>
  81 #include <exclude.h>
  82 #include <full-write.h>
  83 #include <modechange.h>
  84 #include <quote.h>
  85 #include <safe-read.h>
  86 #include <timespec.h>
  87 #define obstack_chunk_alloc xmalloc
  88 #define obstack_chunk_free free
  89 #include <obstack.h>
  90
  91 /* Log base 2 of common values.  */
  92 #define LG_8 3
  93 #define LG_64 6
  94 #define LG_256 8
  95 \f
  96 /* Information gleaned from the command line.  */
  97
  98 /* Name of this program.  */
  99 GLOBAL const char *program_name;
 100
 101 /* Main command option.  */
 102
 103 enum subcommand
 104 {
 105   UNKNOWN_SUBCOMMAND,           /* none of the following */
 106   APPEND_SUBCOMMAND,            /* -r */
 107   CAT_SUBCOMMAND,               /* -A */
 108   CREATE_SUBCOMMAND,            /* -c */
 109   DELETE_SUBCOMMAND,            /* -D */
 110   DIFF_SUBCOMMAND,              /* -d */
 111   EXTRACT_SUBCOMMAND,           /* -x */
 112   LIST_SUBCOMMAND,              /* -t */
 113   UPDATE_SUBCOMMAND             /* -u */
 114 };
 115
 116 GLOBAL enum subcommand subcommand_option;
 117
 118 /* Selected format for output archive.  */
 119 GLOBAL enum archive_format archive_format;
 120
 121 /* Either NL or NUL, as decided by the --null option.  */
 122 GLOBAL char filename_terminator;
 123
 124 /* Size of each record, once in blocks, once in bytes.  Those two variables
 125    are always related, the second being BLOCKSIZE times the first.  They do
 126    not have _option in their name, even if their values is derived from
 127    option decoding, as these are especially important in tar.  */
 128 GLOBAL int blocking_factor;
 129 GLOBAL size_t record_size;
 130
 131 GLOBAL bool absolute_names_option;
 132
 133 /* Display file times in UTC */
 134 GLOBAL bool utc_option;
 135
 136 /* This variable tells how to interpret newer_mtime_option, below.  If zero,
 137    files get archived if their mtime is not less than newer_mtime_option.
 138    If nonzero, files get archived if *either* their ctime or mtime is not less
 139    than newer_mtime_option.  */
 140 GLOBAL int after_date_option;
 141
 142 GLOBAL bool atime_preserve_option;
 143
 144 GLOBAL bool backup_option;
 145
 146 /* Type of backups being made.  */
 147 GLOBAL enum backup_type backup_type;
 148
 149 GLOBAL bool block_number_option;
 150
 151 GLOBAL bool checkpoint_option;
 152
 153 /* Specified name of compression program, or "gzip" as implied by -z.  */
 154 GLOBAL const char *use_compress_program_option;
 155
 156 GLOBAL bool dereference_option;
 157
 158 /* Print a message if not all links are dumped */
 159 GLOBAL int check_links_option;
 160
 161 /* Patterns that match file names to be excluded.  */
 162 GLOBAL struct exclude *excluded;
 163
 164 /* Exclude directories containing a cache directory tag. */
 165 GLOBAL bool exclude_caches_option;
 166
 167 /* Specified value to be put into tar file in place of stat () results, or
 168    just -1 if such an override should not take place.  */
 169 GLOBAL gid_t group_option;
 170
 171 GLOBAL bool ignore_failed_read_option;
 172
 173 GLOBAL bool ignore_zeros_option;
 174
 175 GLOBAL bool incremental_option;
 176
 177 /* Specified name of script to run at end of each tape change.  */
 178 GLOBAL const char *info_script_option;
 179
 180 GLOBAL bool interactive_option;
 181
 182 /* If nonzero, extract only Nth occurrence of each named file */
 183 GLOBAL uintmax_t occurrence_option;
 184
 185 enum old_files
 186 {
 187   DEFAULT_OLD_FILES,          /* default */
 188   NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
 189   OVERWRITE_OLD_FILES,        /* --overwrite */
 190   UNLINK_FIRST_OLD_FILES,     /* --unlink-first */
 191   KEEP_OLD_FILES,             /* --keep-old-files */
 192   KEEP_NEWER_FILES            /* --keep-newer-files */
 193 };
 194 GLOBAL enum old_files old_files_option;
 195
 196 /* Specified file name for incremental list.  */
 197 GLOBAL const char *listed_incremental_option;
 198
 199 /* Specified mode change string.  */
 200 GLOBAL struct mode_change *mode_option;
 201
 202 GLOBAL bool multi_volume_option;
 203
 204 /* The same variable holds the time, whether mtime or ctime.  Just fake a
 205    non-existing option, for making the code clearer, elsewhere.  */
 206 #define newer_ctime_option newer_mtime_option
 207
 208 /* Specified threshold date and time.  Files having an older time stamp
 209    do not get archived (also see after_date_option above).  */
 210 GLOBAL struct timespec newer_mtime_option;
 211
 212 /* Return true if newer_mtime_option is initialized.  */
 213 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
 214
 215 /* Return true if the struct stat ST's M time is less than
 216    newer_mtime_option.  */
 217 #define OLDER_STAT_TIME(st, m) \
 218   ((st).st_##m##time < newer_mtime_option.tv_sec \
 219    || ((st).st_##m##time == newer_mtime_option.tv_sec \
 220        && TIMESPEC_NS ((st).st_##m##tim) < newer_mtime_option.tv_nsec))
 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
 261 GLOBAL bool starting_file_option;
 262
 263 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 264 GLOBAL tarlong tape_length_option;
 265
 266 GLOBAL bool to_stdout_option;
 267
 268 GLOBAL bool totals_option;
 269
 270 GLOBAL bool touch_option;
 271
 272 GLOBAL char *to_command_option;
 273 GLOBAL bool ignore_command_error_option;
 274
 275 /* Return true if the extracted files are not being written to disk */
 276 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
 277
 278 /* Count how many times the option has been set, multiple setting yields
 279    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 280    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 281 GLOBAL int verbose_option;
 282
 283 GLOBAL bool verify_option;
 284
 285 /* Specified name of file containing the volume number.  */
 286 GLOBAL const char *volno_file_option;
 287
 288 /* Specified value or pattern.  */
 289 GLOBAL const char *volume_label_option;
 290 \f
 291 /* Other global variables.  */
 292
 293 /* File descriptor for archive file.  */
 294 GLOBAL int archive;
 295
 296 /* Nonzero when outputting to /dev/null.  */
 297 GLOBAL bool dev_null_output;
 298
 299 /* Timestamp for when we started execution.  */
 300 #if HAVE_CLOCK_GETTIME
 301   GLOBAL struct timespec start_timespec;
 302 # define start_time (start_timespec.tv_sec)
 303 #else
 304   GLOBAL time_t start_time;
 305 #endif
 306
 307 GLOBAL struct tar_stat_info current_stat_info;
 308
 309 /* List of tape drive names, number of such tape drives, allocated number,
 310    and current cursor in list.  */
 311 GLOBAL const char **archive_name_array;
 312 GLOBAL int archive_names;
 313 GLOBAL int allocated_archive_names;
 314 GLOBAL const char **archive_name_cursor;
 315
 316 /* Output index file name.  */
 317 GLOBAL char const *index_file_name;
 318
 319 /* Structure for keeping track of filenames and lists thereof.  */
 320 struct name
 321   {
 322     struct name *next;
 323     size_t length;              /* cached strlen(name) */
 324     uintmax_t found_count;      /* number of times a matching file has
 325                                    been found */
 326     int isdir;
 327     char firstch;               /* first char is literally matched */
 328     char regexp;                /* this name is a regexp, not literal */
 329     int change_dir;             /* set with the -C option */
 330     char const *dir_contents;   /* for incremental_option */
 331     char fake;                  /* dummy entry */
 332     char name[1];
 333   };
 334
 335 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 336 GLOBAL dev_t ar_dev;
 337 GLOBAL ino_t ar_ino;
 338
 339 GLOBAL bool seekable_archive;
 340
 341 GLOBAL dev_t root_device;
 342
 343 /* Unquote filenames */
 344 GLOBAL bool unquote_option;
 345 \f
 346 /* Declarations for each module.  */
 347
 348 /* FIXME: compare.c should not directly handle the following variable,
 349    instead, this should be done in buffer.c only.  */
 350
 351 enum access_mode
 352 {
 353   ACCESS_READ,
 354   ACCESS_WRITE,
 355   ACCESS_UPDATE
 356 };
 357 extern enum access_mode access_mode;
 358
 359 /* Module buffer.c.  */
 360
 361 extern FILE *stdlis;
 362 extern char *save_name;
 363 extern off_t save_sizeleft;
 364 extern off_t save_totsize;
 365 extern bool write_archive_to_stdout;
 366
 367 size_t available_space_after (union block *);
 368 off_t current_block_ordinal (void);
 369 void close_archive (void);
 370 void closeout_volume_number (void);
 371 union block *find_next_block (void);
 372 void flush_read (void);
 373 void flush_write (void);
 374 void flush_archive (void);
 375 void init_volume_number (void);
 376 void open_archive (enum access_mode);
 377 void print_total_written (void);
 378 void reset_eof (void);
 379 void set_next_block_after (union block *);
 380 void clear_read_error_count (void);
 381 void xclose (int fd);
 382 void archive_write_error (ssize_t) __attribute__ ((noreturn));
 383 void archive_read_error (void);
 384 off_t seek_archive (off_t size);
 385 void set_start_time (void);
 386
 387 /* Module create.c.  */
 388
 389 enum dump_status
 390   {
 391     dump_status_ok,
 392     dump_status_short,
 393     dump_status_fail,
 394     dump_status_not_implemented
 395   };
 396
 397 bool file_dumpable_p (struct tar_stat_info *);
 398 void create_archive (void);
 399 void pad_archive (off_t size_left);
 400 void dump_file (char *, int, dev_t);
 401 union block *start_header (struct tar_stat_info *st);
 402 void finish_header (struct tar_stat_info *, union block *, off_t);
 403 void simple_finish_header (union block *header);
 404 union block *start_private_header (const char *name, size_t size);
 405 void write_eot (void);
 406 void check_links (void);
 407
 408 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 409 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 410 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
 411 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
 412 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 413 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
 414 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 415 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
 416 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
 417 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 418 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 419
 420 void gid_to_chars (gid_t, char *, size_t);
 421 void major_to_chars (major_t, char *, size_t);
 422 void minor_to_chars (minor_t, char *, size_t);
 423 void mode_to_chars (mode_t, char *, size_t);
 424 void off_to_chars (off_t, char *, size_t);
 425 void size_to_chars (size_t, char *, size_t);
 426 void time_to_chars (time_t, char *, size_t);
 427 void uid_to_chars (uid_t, char *, size_t);
 428 void uintmax_to_chars (uintmax_t, char *, size_t);
 429 void string_to_chars (char *, char *, size_t);
 430
 431 /* Module diffarch.c.  */
 432
 433 extern bool now_verifying;
 434
 435 void diff_archive (void);
 436 void diff_init (void);
 437 void verify_volume (void);
 438
 439 /* Module extract.c.  */
 440
 441 extern bool we_are_root;
 442 void extr_init (void);
 443 void extract_archive (void);
 444 void extract_finish (void);
 445 void fatal_exit (void) __attribute__ ((noreturn));
 446
 447 /* Module delete.c.  */
 448
 449 void delete_archive_members (void);
 450
 451 /* Module incremen.c.  */
 452
 453 char *get_directory_contents (char *, dev_t);
 454 void read_directory_file (void);
 455 void write_directory_file (void);
 456 void purge_directory (char const *);
 457
 458 /* Module list.c.  */
 459
 460 enum read_header
 461 {
 462   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 463   HEADER_SUCCESS,               /* header successfully read and checksummed */
 464   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 465   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 466   HEADER_END_OF_FILE,           /* true end of file while header expected */
 467   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 468 };
 469
 470 struct xheader
 471 {
 472   struct obstack *stk;
 473   size_t size;
 474   char *buffer;
 475 };
 476
 477 GLOBAL struct xheader extended_header;
 478 extern union block *current_header;
 479 extern enum archive_format current_format;
 480 extern size_t recent_long_name_blocks;
 481 extern size_t recent_long_link_blocks;
 482
 483 void decode_header (union block *, struct tar_stat_info *,
 484                     enum archive_format *, int);
 485 #define STRINGIFY_BIGINT(i, b) \
 486   stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
 487 char *stringify_uintmax_t_backwards (uintmax_t, char *);
 488 char const *tartime (time_t);
 489
 490 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
 491 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
 492 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
 493 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
 494 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 495 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
 496 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
 497 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
 498 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 499
 500 gid_t gid_from_header (const char *, size_t);
 501 major_t major_from_header (const char *, size_t);
 502 minor_t minor_from_header (const char *, size_t);
 503 mode_t mode_from_header (const char *, size_t);
 504 off_t off_from_header (const char *, size_t);
 505 size_t size_from_header (const char *, size_t);
 506 time_t time_from_header (const char *, size_t);
 507 uid_t uid_from_header (const char *, size_t);
 508 uintmax_t uintmax_from_header (const char *, size_t);
 509
 510 void list_archive (void);
 511 void print_for_mkdir (char *, int, mode_t);
 512 void print_header (struct tar_stat_info *, off_t);
 513 void read_and (void (*) (void));
 514 enum read_header read_header (bool);
 515 enum read_header tar_checksum (union block *header, bool silent);
 516 void skip_file (off_t);
 517 void skip_member (void);
 518
 519 /* Module mangle.c.  */
 520
 521 void extract_mangle (void);
 522
 523 /* Module misc.c.  */
 524
 525 void assign_string (char **, const char *);
 526 char *quote_copy_string (const char *);
 527 int unquote_string (char *);
 528
 529 size_t dot_dot_prefix_len (char const *);
 530
 531 enum remove_option
 532 {
 533   ORDINARY_REMOVE_OPTION,
 534   RECURSIVE_REMOVE_OPTION,
 535
 536   /* FIXME: The following value is never used. It seems to be intended
 537      as a placeholder for a hypothetical option that should instruct tar
 538      to recursively remove subdirectories in purge_directory(),
 539      as opposed to the functionality of --recursive-unlink
 540      (RECURSIVE_REMOVE_OPTION value), which removes them in
 541      prepare_to_extract() phase. However, with the addition of more
 542      meta-info to the incremental dumps, this should become unnecessary */
 543   WANT_DIRECTORY_REMOVE_OPTION
 544 };
 545 int remove_any_file (const char *, enum remove_option);
 546 bool maybe_backup_file (const char *, int);
 547 void undo_last_backup (void);
 548
 549 int deref_stat (bool, char const *, struct stat *);
 550
 551 int chdir_arg (char const *);
 552 void chdir_do (int);
 553
 554 void decode_mode (mode_t, char *);
 555
 556 void chdir_fatal (char const *) __attribute__ ((noreturn));
 557 void chmod_error_details (char const *, mode_t);
 558 void chown_error_details (char const *, uid_t, gid_t);
 559 void close_error (char const *);
 560 void close_warn (char const *);
 561 void close_diag (char const *name);
 562 void exec_fatal (char const *) __attribute__ ((noreturn));
 563 void link_error (char const *, char const *);
 564 void mkdir_error (char const *);
 565 void mkfifo_error (char const *);
 566 void mknod_error (char const *);
 567 void open_error (char const *);
 568 void open_fatal (char const *) __attribute__ ((noreturn));
 569 void open_warn (char const *);
 570 void open_diag (char const *name);
 571 void read_error (char const *);
 572 void read_error_details (char const *, off_t, size_t);
 573 void read_fatal (char const *) __attribute__ ((noreturn));
 574 void read_fatal_details (char const *, off_t, size_t) __attribute__ ((noreturn));
 575 void read_warn_details (char const *, off_t, size_t);
 576 void read_diag_details (char const *name, off_t offset, size_t size);
 577 void readlink_error (char const *);
 578 void readlink_warn (char const *);
 579 void readlink_diag (char const *name);
 580 void savedir_error (char const *);
 581 void savedir_warn (char const *);
 582 void savedir_diag (char const *name);
 583 void seek_error (char const *);
 584 void seek_error_details (char const *, off_t);
 585 void seek_warn (char const *);
 586 void seek_warn_details (char const *, off_t);
 587 void seek_diag_details (char const *, off_t);
 588 void stat_fatal (char const *);
 589 void stat_error (char const *);
 590 void stat_warn (char const *);
 591 void stat_diag (char const *name);
 592 void symlink_error (char const *, char const *);
 593 void truncate_error (char const *);
 594 void truncate_warn (char const *);
 595 void unlink_error (char const *);
 596 void utime_error (char const *);
 597 void waitpid_error (char const *);
 598 void write_error (char const *);
 599 void write_error_details (char const *, size_t, size_t);
 600 void write_fatal (char const *) __attribute__ ((noreturn));
 601 void write_fatal_details (char const *, ssize_t, size_t)
 602      __attribute__ ((noreturn));
 603
 604 pid_t xfork (void);
 605 void xpipe (int[2]);
 606
 607 void *page_aligned_alloc (void **, size_t);
 608
 609 /* Module names.c.  */
 610
 611 extern struct name *gnu_list_name;
 612
 613 void gid_to_gname (gid_t, char **gname);
 614 int gname_to_gid (char const *, gid_t *);
 615 void uid_to_uname (uid_t, char **uname);
 616 int uname_to_uid (char const *, uid_t *);
 617
 618 void init_names (void);
 619 void name_add (const char *);
 620 void name_init (void);
 621 void name_term (void);
 622 char *name_next (int);
 623 void name_gather (void);
 624 struct name *addname (char const *, int);
 625 int name_match (const char *);
 626 void names_notfound (void);
 627 void collect_and_sort_names (void);
 628 struct name *name_scan (const char *);
 629 char *name_from_list (void);
 630 void blank_name_list (void);
 631 char *new_name (const char *, const char *);
 632 char *safer_name_suffix (char const *, bool);
 633 size_t stripped_prefix_len (char const *file_name, size_t num);
 634 bool all_names_found (struct tar_stat_info *);
 635
 636 bool excluded_name (char const *);
 637
 638 void add_avoided_name (char const *);
 639 bool is_avoided_name (char const *);
 640 bool is_individual_file (char const *);
 641
 642 bool contains_dot_dot (char const *);
 643
 644 bool removed_prefixes_p (void);
 645
 646 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 647                     (c)->found_count == occurrence_option)
 648 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 649                      (c)->found_count >= occurrence_option)
 650
 651 /* Module tar.c.  */
 652
 653 void usage (int);
 654
 655 int confirm (const char *, const char *);
 656 void request_stdin (const char *);
 657
 658 void tar_stat_init (struct tar_stat_info *st);
 659 void tar_stat_destroy (struct tar_stat_info *st);
 660 void usage (int) __attribute__ ((noreturn));
 661
 662 /* Module update.c.  */
 663
 664 extern char *output_start;
 665
 666 void update_archive (void);
 667
 668 /* Module xheader.c.  */
 669
 670 void xheader_decode (struct tar_stat_info *);
 671 void xheader_decode_global (void);
 672 void xheader_store (char const *, struct tar_stat_info const *, void *);
 673 void xheader_read (union block *, size_t);
 674 void xheader_write (char type, char *name, struct xheader *xhdr);
 675 void xheader_write_global (void);
 676 void xheader_finish (struct xheader *);
 677 void xheader_destroy (struct xheader *);
 678 char *xheader_xhdr_name (struct tar_stat_info *st);
 679 char *xheader_ghdr_name (void);
 680 void xheader_write (char, char *, struct xheader *);
 681 void xheader_write_global (void);
 682 void xheader_set_option (char *string);
 683
 684 /* Module system.c */
 685
 686 void sys_stat_nanoseconds (struct tar_stat_info *);
 687 void sys_detect_dev_null_output (void);
 688 void sys_save_archive_dev_ino (void);
 689 void sys_drain_input_pipe (void);
 690 void sys_wait_for_child (pid_t);
 691 void sys_spawn_shell (void);
 692 bool sys_compare_uid (struct stat *a, struct stat *b);
 693 bool sys_compare_gid (struct stat *a, struct stat *b);
 694 bool sys_file_is_archive (struct tar_stat_info *p);
 695 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 696 int sys_truncate (int fd);
 697 pid_t sys_child_open_for_compress (void);
 698 pid_t sys_child_open_for_uncompress (void);
 699 size_t sys_write_archive_buffer (void);
 700 bool sys_get_archive_stat (void);
 701 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
 702 void sys_wait_command (void);
 703
 704 /* Module compare.c */
 705 void report_difference (struct tar_stat_info *st, const char *message, ...);
 706
 707 /* Module sparse.c */
 708 bool sparse_file_p (struct tar_stat_info *);
 709 bool sparse_member_p (struct tar_stat_info *);
 710 bool sparse_fixup_header (struct tar_stat_info *);
 711 enum dump_status sparse_dump_file (int, struct tar_stat_info *);
 712 enum dump_status sparse_extract_file (int, struct tar_stat_info *, off_t *);
 713 enum dump_status sparse_skip_file (struct tar_stat_info *);
 714 bool sparse_diff_file (int, struct tar_stat_info *);
 715
 716 /* Module utf8.c */
 717 bool string_ascii_p (const char *str);
 718 bool utf8_convert (bool to_utf, char const *input, char **output);