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