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 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    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 <timespec.h>
  59 #define obstack_chunk_alloc xmalloc
  60 #define obstack_chunk_free free
  61 #include <obstack.h>
  62
  63 #include <paxlib.h>
  64
  65 /* Log base 2 of common values.  */
  66 #define LG_8 3
  67 #define LG_64 6
  68 #define LG_256 8
  69 \f
  70 /* Information gleaned from the command line.  */
  71
  72 /* Name of this program.  */
  73 GLOBAL const char *program_name;
  74
  75 /* Main command option.  */
  76
  77 enum subcommand
  78 {
  79   UNKNOWN_SUBCOMMAND,           /* none of the following */
  80   APPEND_SUBCOMMAND,            /* -r */
  81   CAT_SUBCOMMAND,               /* -A */
  82   CREATE_SUBCOMMAND,            /* -c */
  83   DELETE_SUBCOMMAND,            /* -D */
  84   DIFF_SUBCOMMAND,              /* -d */
  85   EXTRACT_SUBCOMMAND,           /* -x */
  86   LIST_SUBCOMMAND,              /* -t */
  87   UPDATE_SUBCOMMAND             /* -u */
  88 };
  89
  90 GLOBAL enum subcommand subcommand_option;
  91
  92 /* Selected format for output archive.  */
  93 GLOBAL enum archive_format archive_format;
  94
  95 /* Either NL or NUL, as decided by the --null option.  */
  96 GLOBAL char filename_terminator;
  97
  98 /* Size of each record, once in blocks, once in bytes.  Those two variables
  99    are always related, the second being BLOCKSIZE times the first.  They do
 100    not have _option in their name, even if their values is derived from
 101    option decoding, as these are especially important in tar.  */
 102 GLOBAL int blocking_factor;
 103 GLOBAL size_t record_size;
 104
 105 GLOBAL bool absolute_names_option;
 106
 107 /* Display file times in UTC */
 108 GLOBAL bool utc_option;
 109
 110 /* This variable tells how to interpret newer_mtime_option, below.  If zero,
 111    files get archived if their mtime is not less than newer_mtime_option.
 112    If nonzero, files get archived if *either* their ctime or mtime is not less
 113    than newer_mtime_option.  */
 114 GLOBAL int after_date_option;
 115
 116 GLOBAL bool atime_preserve_option;
 117
 118 GLOBAL bool backup_option;
 119
 120 /* Type of backups being made.  */
 121 GLOBAL enum backup_type backup_type;
 122
 123 GLOBAL bool block_number_option;
 124
 125 GLOBAL bool checkpoint_option;
 126
 127 /* Specified name of compression program, or "gzip" as implied by -z.  */
 128 GLOBAL const char *use_compress_program_option;
 129
 130 GLOBAL bool dereference_option;
 131
 132 /* Print a message if not all links are dumped */
 133 GLOBAL int check_links_option;
 134
 135 /* Patterns that match file names to be excluded.  */
 136 GLOBAL struct exclude *excluded;
 137
 138 /* Exclude directories containing a cache directory tag. */
 139 GLOBAL bool exclude_caches_option;
 140
 141 /* Specified value to be put into tar file in place of stat () results, or
 142    just -1 if such an override should not take place.  */
 143 GLOBAL gid_t group_option;
 144
 145 GLOBAL bool ignore_failed_read_option;
 146
 147 GLOBAL bool ignore_zeros_option;
 148
 149 GLOBAL bool incremental_option;
 150
 151 /* Specified name of script to run at end of each tape change.  */
 152 GLOBAL const char *info_script_option;
 153
 154 GLOBAL bool interactive_option;
 155
 156 /* If nonzero, extract only Nth occurrence of each named file */
 157 GLOBAL uintmax_t occurrence_option;
 158
 159 enum old_files
 160 {
 161   DEFAULT_OLD_FILES,          /* default */
 162   NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
 163   OVERWRITE_OLD_FILES,        /* --overwrite */
 164   UNLINK_FIRST_OLD_FILES,     /* --unlink-first */
 165   KEEP_OLD_FILES,             /* --keep-old-files */
 166   KEEP_NEWER_FILES            /* --keep-newer-files */
 167 };
 168 GLOBAL enum old_files old_files_option;
 169
 170 /* Specified file name for incremental list.  */
 171 GLOBAL const char *listed_incremental_option;
 172
 173 /* Specified mode change string.  */
 174 GLOBAL struct mode_change *mode_option;
 175
 176 /* Initial umask, if needed for mode change string.  */
 177 GLOBAL mode_t initial_umask;
 178
 179 GLOBAL bool multi_volume_option;
 180
 181 /* Specified threshold date and time.  Files having an older time stamp
 182    do not get archived (also see after_date_option above).  */
 183 GLOBAL struct timespec newer_mtime_option;
 184
 185 /* Return true if newer_mtime_option is initialized.  */
 186 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
 187
 188 /* Return true if the struct stat ST's M time is less than
 189    newer_mtime_option.  */
 190 #define OLDER_STAT_TIME(st, m) \
 191   timespec_lt (get_stat_##m##time (&st), newer_mtime_option)
 192
 193 /* Return true if A < B.  */
 194 static inline bool
 195 timespec_lt (struct timespec a, struct timespec b)
 196 {
 197   return (a.tv_sec < b.tv_sec
 198           || (a.tv_sec == b.tv_sec && a.tv_nsec < b.tv_nsec));
 199 }
 200
 201 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR.  */
 202 GLOBAL int recursion_option;
 203
 204 GLOBAL bool numeric_owner_option;
 205
 206 GLOBAL bool one_file_system_option;
 207
 208 /* Specified value to be put into tar file in place of stat () results, or
 209    just -1 if such an override should not take place.  */
 210 GLOBAL uid_t owner_option;
 211
 212 GLOBAL bool recursive_unlink_option;
 213
 214 GLOBAL bool read_full_records_option;
 215
 216 GLOBAL bool remove_files_option;
 217
 218 /* Specified rmt command.  */
 219 GLOBAL const char *rmt_command_option;
 220
 221 /* Specified remote shell command.  */
 222 GLOBAL const char *rsh_command_option;
 223
 224 GLOBAL bool same_order_option;
 225
 226 /* If positive, preserve ownership when extracting.  */
 227 GLOBAL int same_owner_option;
 228
 229 /* If positive, preserve permissions when extracting.  */
 230 GLOBAL int same_permissions_option;
 231
 232 /* When set, strip the given number of file name components from the file name
 233    before extracting */
 234 GLOBAL size_t strip_name_components;
 235
 236 GLOBAL bool show_omitted_dirs_option;
 237
 238 GLOBAL bool sparse_option;
 239
 240 GLOBAL bool starting_file_option;
 241
 242 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 243 GLOBAL tarlong tape_length_option;
 244
 245 GLOBAL bool to_stdout_option;
 246
 247 GLOBAL bool totals_option;
 248
 249 GLOBAL bool touch_option;
 250
 251 GLOBAL char *to_command_option;
 252 GLOBAL bool ignore_command_error_option;
 253
 254 /* Return true if the extracted files are not being written to disk */
 255 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
 256
 257 /* Count how many times the option has been set, multiple setting yields
 258    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 259    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 260 GLOBAL int verbose_option;
 261
 262 GLOBAL bool verify_option;
 263
 264 /* Specified name of file containing the volume number.  */
 265 GLOBAL const char *volno_file_option;
 266
 267 /* Specified value or pattern.  */
 268 GLOBAL const char *volume_label_option;
 269 \f
 270 /* Other global variables.  */
 271
 272 /* File descriptor for archive file.  */
 273 GLOBAL int archive;
 274
 275 /* Nonzero when outputting to /dev/null.  */
 276 GLOBAL bool dev_null_output;
 277
 278 /* Timestamp for when we started execution.  */
 279 GLOBAL struct timespec start_time;
 280
 281 GLOBAL struct tar_stat_info current_stat_info;
 282
 283 /* List of tape drive names, number of such tape drives, allocated number,
 284    and current cursor in list.  */
 285 GLOBAL const char **archive_name_array;
 286 GLOBAL int archive_names;
 287 GLOBAL int allocated_archive_names;
 288 GLOBAL const char **archive_name_cursor;
 289
 290 /* Output index file name.  */
 291 GLOBAL char const *index_file_name;
 292
 293 /* Structure for keeping track of filenames and lists thereof.  */
 294 struct name
 295   {
 296     struct name *next;
 297     size_t length;              /* cached strlen(name) */
 298     uintmax_t found_count;      /* number of times a matching file has
 299                                    been found */
 300     int isdir;
 301     char firstch;               /* first char is literally matched */
 302     char regexp;                /* this name is a regexp, not literal */
 303     int change_dir;             /* set with the -C option */
 304     char const *dir_contents;   /* for incremental_option */
 305     char fake;                  /* dummy entry */
 306     char name[1];
 307   };
 308
 309 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 310 GLOBAL dev_t ar_dev;
 311 GLOBAL ino_t ar_ino;
 312
 313 GLOBAL bool seekable_archive;
 314
 315 GLOBAL dev_t root_device;
 316
 317 /* Unquote filenames */
 318 GLOBAL bool unquote_option;
 319 \f
 320 /* Declarations for each module.  */
 321
 322 /* FIXME: compare.c should not directly handle the following variable,
 323    instead, this should be done in buffer.c only.  */
 324
 325 enum access_mode
 326 {
 327   ACCESS_READ,
 328   ACCESS_WRITE,
 329   ACCESS_UPDATE
 330 };
 331 extern enum access_mode access_mode;
 332
 333 /* Module buffer.c.  */
 334
 335 extern FILE *stdlis;
 336 extern char *save_name;
 337 extern off_t save_sizeleft;
 338 extern off_t save_totsize;
 339 extern bool write_archive_to_stdout;
 340
 341 size_t available_space_after (union block *);
 342 off_t current_block_ordinal (void);
 343 void close_archive (void);
 344 void closeout_volume_number (void);
 345 union block *find_next_block (void);
 346 void flush_read (void);
 347 void flush_write (void);
 348 void flush_archive (void);
 349 void init_volume_number (void);
 350 void open_archive (enum access_mode);
 351 void print_total_written (void);
 352 void reset_eof (void);
 353 void set_next_block_after (union block *);
 354 void clear_read_error_count (void);
 355 void xclose (int fd);
 356 void archive_write_error (ssize_t) __attribute__ ((noreturn));
 357 void archive_read_error (void);
 358 off_t seek_archive (off_t size);
 359 void set_start_time (void);
 360
 361 /* Module create.c.  */
 362
 363 enum dump_status
 364   {
 365     dump_status_ok,
 366     dump_status_short,
 367     dump_status_fail,
 368     dump_status_not_implemented
 369   };
 370
 371 bool file_dumpable_p (struct tar_stat_info *);
 372 void create_archive (void);
 373 void pad_archive (off_t size_left);
 374 void dump_file (char *, int, dev_t);
 375 union block *start_header (struct tar_stat_info *st);
 376 void finish_header (struct tar_stat_info *, union block *, off_t);
 377 void simple_finish_header (union block *header);
 378 union block *start_private_header (const char *name, size_t size);
 379 void write_eot (void);
 380 void check_links (void);
 381
 382 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 383 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 384 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
 385 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
 386 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 387 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
 388 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 389 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
 390 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
 391 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 392 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 393
 394 void gid_to_chars (gid_t, char *, size_t);
 395 void major_to_chars (major_t, char *, size_t);
 396 void minor_to_chars (minor_t, char *, size_t);
 397 void mode_to_chars (mode_t, char *, size_t);
 398 void off_to_chars (off_t, char *, size_t);
 399 void size_to_chars (size_t, char *, size_t);
 400 void time_to_chars (time_t, char *, size_t);
 401 void uid_to_chars (uid_t, char *, size_t);
 402 void uintmax_to_chars (uintmax_t, char *, size_t);
 403 void string_to_chars (char const *, char *, size_t);
 404
 405 /* Module diffarch.c.  */
 406
 407 extern bool now_verifying;
 408
 409 void diff_archive (void);
 410 void diff_init (void);
 411 void verify_volume (void);
 412
 413 /* Module extract.c.  */
 414
 415 void extr_init (void);
 416 void extract_archive (void);
 417 void extract_finish (void);
 418
 419 /* Module delete.c.  */
 420
 421 void delete_archive_members (void);
 422
 423 /* Module incremen.c.  */
 424
 425 char *get_directory_contents (char *, dev_t);
 426 void read_directory_file (void);
 427 void write_directory_file (void);
 428 void purge_directory (char const *);
 429 void list_dumpdir (char *buffer, size_t size);
 430
 431 /* Module list.c.  */
 432
 433 enum read_header
 434 {
 435   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 436   HEADER_SUCCESS,               /* header successfully read and checksummed */
 437   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 438   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 439   HEADER_END_OF_FILE,           /* true end of file while header expected */
 440   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 441 };
 442
 443 struct xheader
 444 {
 445   struct obstack *stk;
 446   size_t size;
 447   char *buffer;
 448 };
 449
 450 GLOBAL struct xheader extended_header;
 451 extern union block *current_header;
 452 extern enum archive_format current_format;
 453 extern size_t recent_long_name_blocks;
 454 extern size_t recent_long_link_blocks;
 455
 456 void decode_header (union block *, struct tar_stat_info *,
 457                     enum archive_format *, int);
 458 char const *tartime (struct timespec, bool);
 459
 460 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
 461 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
 462 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
 463 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
 464 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 465 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
 466 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
 467 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
 468 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 469
 470 gid_t gid_from_header (const char *, size_t);
 471 major_t major_from_header (const char *, size_t);
 472 minor_t minor_from_header (const char *, size_t);
 473 mode_t mode_from_header (const char *, size_t);
 474 off_t off_from_header (const char *, size_t);
 475 size_t size_from_header (const char *, size_t);
 476 time_t time_from_header (const char *, size_t);
 477 uid_t uid_from_header (const char *, size_t);
 478 uintmax_t uintmax_from_header (const char *, size_t);
 479
 480 void list_archive (void);
 481 void print_for_mkdir (char *, int, mode_t);
 482 void print_header (struct tar_stat_info *, off_t);
 483 void read_and (void (*) (void));
 484 enum read_header read_header (bool);
 485 enum read_header tar_checksum (union block *header, bool silent);
 486 void skip_file (off_t);
 487 void skip_member (void);
 488
 489 /* Module mangle.c.  */
 490
 491 void extract_mangle (void);
 492
 493 /* Module misc.c.  */
 494
 495 void assign_string (char **, const char *);
 496 char *quote_copy_string (const char *);
 497 int unquote_string (char *);
 498
 499 void code_ns_fraction (int, char *);
 500
 501 size_t dot_dot_prefix_len (char const *);
 502
 503 enum remove_option
 504 {
 505   ORDINARY_REMOVE_OPTION,
 506   RECURSIVE_REMOVE_OPTION,
 507
 508   /* FIXME: The following value is never used. It seems to be intended
 509      as a placeholder for a hypothetical option that should instruct tar
 510      to recursively remove subdirectories in purge_directory(),
 511      as opposed to the functionality of --recursive-unlink
 512      (RECURSIVE_REMOVE_OPTION value), which removes them in
 513      prepare_to_extract() phase. However, with the addition of more
 514      meta-info to the incremental dumps, this should become unnecessary */
 515   WANT_DIRECTORY_REMOVE_OPTION
 516 };
 517 int remove_any_file (const char *, enum remove_option);
 518 bool maybe_backup_file (const char *, int);
 519 void undo_last_backup (void);
 520
 521 int deref_stat (bool, char const *, struct stat *);
 522
 523 int chdir_arg (char const *);
 524 void chdir_do (int);
 525
 526 void close_diag (char const *name);
 527 void open_diag (char const *name);
 528 void read_diag_details (char const *name, off_t offset, size_t size);
 529 void readlink_diag (char const *name);
 530 void savedir_diag (char const *name);
 531 void seek_diag_details (char const *, off_t);
 532 void stat_diag (char const *name);
 533 void write_error_details (char const *, size_t, size_t);
 534 void write_fatal (char const *) __attribute__ ((noreturn));
 535 void write_fatal_details (char const *, ssize_t, size_t)
 536      __attribute__ ((noreturn));
 537
 538 pid_t xfork (void);
 539 void xpipe (int[2]);
 540
 541 void *page_aligned_alloc (void **, size_t);
 542
 543 /* Module names.c.  */
 544
 545 extern struct name *gnu_list_name;
 546
 547 void gid_to_gname (gid_t, char **gname);
 548 int gname_to_gid (char const *, gid_t *);
 549 void uid_to_uname (uid_t, char **uname);
 550 int uname_to_uid (char const *, uid_t *);
 551
 552 void init_names (void);
 553 void name_add (const char *);
 554 void name_init (void);
 555 void name_term (void);
 556 char *name_next (int);
 557 void name_gather (void);
 558 struct name *addname (char const *, int);
 559 int name_match (const char *);
 560 void names_notfound (void);
 561 void collect_and_sort_names (void);
 562 struct name *name_scan (const char *);
 563 char *name_from_list (void);
 564 void blank_name_list (void);
 565 char *new_name (const char *, const char *);
 566 size_t stripped_prefix_len (char const *file_name, size_t num);
 567 bool all_names_found (struct tar_stat_info *);
 568
 569 bool excluded_name (char const *);
 570
 571 void add_avoided_name (char const *);
 572 bool is_avoided_name (char const *);
 573 bool is_individual_file (char const *);
 574
 575 bool contains_dot_dot (char const *);
 576
 577 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 578                     (c)->found_count == occurrence_option)
 579 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 580                      (c)->found_count >= occurrence_option)
 581
 582 /* Module tar.c.  */
 583
 584 void usage (int);
 585
 586 int confirm (const char *, const char *);
 587 void request_stdin (const char *);
 588
 589 void tar_stat_init (struct tar_stat_info *st);
 590 void tar_stat_destroy (struct tar_stat_info *st);
 591 void usage (int) __attribute__ ((noreturn));
 592
 593 /* Module update.c.  */
 594
 595 extern char *output_start;
 596
 597 void update_archive (void);
 598
 599 /* Module xheader.c.  */
 600
 601 void xheader_decode (struct tar_stat_info *);
 602 void xheader_decode_global (void);
 603 void xheader_store (char const *, struct tar_stat_info const *, void *);
 604 void xheader_read (union block *, size_t);
 605 void xheader_write (char type, char *name, struct xheader *xhdr);
 606 void xheader_write_global (void);
 607 void xheader_finish (struct xheader *);
 608 void xheader_destroy (struct xheader *);
 609 char *xheader_xhdr_name (struct tar_stat_info *st);
 610 char *xheader_ghdr_name (void);
 611 void xheader_write (char, char *, struct xheader *);
 612 void xheader_write_global (void);
 613 void xheader_set_option (char *string);
 614
 615 /* Module system.c */
 616
 617 void sys_detect_dev_null_output (void);
 618 void sys_save_archive_dev_ino (void);
 619 void sys_drain_input_pipe (void);
 620 void sys_wait_for_child (pid_t);
 621 void sys_spawn_shell (void);
 622 bool sys_compare_uid (struct stat *a, struct stat *b);
 623 bool sys_compare_gid (struct stat *a, struct stat *b);
 624 bool sys_file_is_archive (struct tar_stat_info *p);
 625 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 626 int sys_truncate (int fd);
 627 pid_t sys_child_open_for_compress (void);
 628 pid_t sys_child_open_for_uncompress (void);
 629 size_t sys_write_archive_buffer (void);
 630 bool sys_get_archive_stat (void);
 631 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
 632 void sys_wait_command (void);
 633
 634 /* Module compare.c */
 635 void report_difference (struct tar_stat_info *st, const char *message, ...);
 636
 637 /* Module sparse.c */
 638 bool sparse_file_p (struct tar_stat_info *);
 639 bool sparse_member_p (struct tar_stat_info *);
 640 bool sparse_fixup_header (struct tar_stat_info *);
 641 enum dump_status sparse_dump_file (int, struct tar_stat_info *);
 642 enum dump_status sparse_extract_file (int, struct tar_stat_info *, off_t *);
 643 enum dump_status sparse_skip_file (struct tar_stat_info *);
 644 bool sparse_diff_file (int, struct tar_stat_info *);
 645
 646 /* Module utf8.c */
 647 bool string_ascii_p (const char *str);
 648 bool utf8_convert (bool to_utf, char const *input, char **output);
 649
 650
 651 /* FIXME: The following should get moved into gnulib.  */
 652
 653 static inline struct timespec
 654 get_stat_atime (struct stat const *st)
 655 {
 656 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 657   return st->st_atim;
 658 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 659   return st->st_atimespec;
 660 #else
 661   struct timespec t;
 662   t.tv_sec = st->st_atime;
 663 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 664   t.tv_nsec = st->stat.st_atimensec;
 665 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 666   t.tv_nsec = st->stat.st_spare1 * 1000;
 667 # else
 668   t.tv_nsec = 0;
 669 # endif
 670   return t;
 671 #endif
 672 }
 673
 674 static inline struct timespec
 675 get_stat_ctime (struct stat const *st)
 676 {
 677 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 678   return st->st_ctim;
 679 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 680   return st->st_ctimespec;
 681 #else
 682   struct timespec t;
 683   t.tv_sec = st->st_ctime;
 684 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 685   t.tv_nsec = st->stat.st_ctimensec;
 686 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 687   t.tv_nsec = st->stat.st_spare1 * 1000;
 688 # else
 689   t.tv_nsec = 0;
 690 # endif
 691   return t;
 692 #endif
 693 }
 694
 695 static inline struct timespec
 696 get_stat_mtime (struct stat const *st)
 697 {
 698 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 699   return st->st_mtim;
 700 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 701   return st->st_mtimespec;
 702 #else
 703   struct timespec t;
 704   t.tv_sec = st->st_mtime;
 705 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 706   t.tv_nsec = st->stat.st_mtimensec;
 707 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 708   t.tv_nsec = st->stat.st_spare1 * 1000;
 709 # else
 710   t.tv_nsec = 0;
 711 # endif
 712   return t;
 713 #endif
 714 }
 715
 716 static inline void
 717 set_stat_atime (struct stat *st, struct timespec t)
 718 {
 719 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 720   st->st_atim = t;
 721 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 722   st->st_atimespec = t;
 723 #else
 724   st->st_atime = t.tv_sec;
 725 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 726   st->stat.st_atimensec = t.tv_nsec;
 727 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 728   st->stat.st_spare1 = t.tv_nsec / 1000;
 729 # endif
 730 #endif
 731 }
 732
 733 static inline void
 734 set_stat_ctime (struct stat *st, struct timespec t)
 735 {
 736 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 737   st->st_ctim = t;
 738 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 739   st->st_ctimespec = t;
 740 #else
 741   st->st_ctime = t.tv_sec;
 742 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 743   st->stat.st_ctimensec = t.tv_nsec;
 744 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 745   st->stat.st_spare1 = t.tv_nsec / 1000;
 746 # endif
 747 #endif
 748 }
 749
 750 static inline void
 751 set_stat_mtime (struct stat *st, struct timespec t)
 752 {
 753 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 754   st->st_mtim = t;
 755 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 756   st->st_mtimespec = t;
 757 #else
 758   st->st_mtime = t.tv_sec;
 759 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 760   st->stat.st_mtimensec = t.tv_nsec;
 761 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 762   st->stat.st_spare1 = t.tv_nsec / 1000;
 763 # endif
 764 #endif
 765 }