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