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
 195 timespec_lt (struct timespec a, struct timespec b)
 196 {
 197   return a.tv_sec < b.tv_sec || (a.tv_sec == b.tv_sec && a.tv_nsec < b.tv_nsec);
 198 }
 199
 200 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR.  */
 201 GLOBAL int recursion_option;
 202
 203 GLOBAL bool numeric_owner_option;
 204
 205 GLOBAL bool one_file_system_option;
 206
 207 /* Specified value to be put into tar file in place of stat () results, or
 208    just -1 if such an override should not take place.  */
 209 GLOBAL uid_t owner_option;
 210
 211 GLOBAL bool recursive_unlink_option;
 212
 213 GLOBAL bool read_full_records_option;
 214
 215 GLOBAL bool remove_files_option;
 216
 217 /* Specified rmt command.  */
 218 GLOBAL const char *rmt_command_option;
 219
 220 /* Specified remote shell command.  */
 221 GLOBAL const char *rsh_command_option;
 222
 223 GLOBAL bool same_order_option;
 224
 225 /* If positive, preserve ownership when extracting.  */
 226 GLOBAL int same_owner_option;
 227
 228 /* If positive, preserve permissions when extracting.  */
 229 GLOBAL int same_permissions_option;
 230
 231 /* When set, strip the given number of file name components from the file name
 232    before extracting */
 233 GLOBAL size_t strip_name_components;
 234
 235 GLOBAL bool show_omitted_dirs_option;
 236
 237 GLOBAL bool sparse_option;
 238
 239 GLOBAL bool starting_file_option;
 240
 241 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 242 GLOBAL tarlong tape_length_option;
 243
 244 GLOBAL bool to_stdout_option;
 245
 246 GLOBAL bool totals_option;
 247
 248 GLOBAL bool touch_option;
 249
 250 GLOBAL char *to_command_option;
 251 GLOBAL bool ignore_command_error_option;
 252
 253 /* Return true if the extracted files are not being written to disk */
 254 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
 255
 256 /* Count how many times the option has been set, multiple setting yields
 257    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 258    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 259 GLOBAL int verbose_option;
 260
 261 GLOBAL bool verify_option;
 262
 263 /* Specified name of file containing the volume number.  */
 264 GLOBAL const char *volno_file_option;
 265
 266 /* Specified value or pattern.  */
 267 GLOBAL const char *volume_label_option;
 268 \f
 269 /* Other global variables.  */
 270
 271 /* File descriptor for archive file.  */
 272 GLOBAL int archive;
 273
 274 /* Nonzero when outputting to /dev/null.  */
 275 GLOBAL bool dev_null_output;
 276
 277 /* Timestamp for when we started execution.  */
 278 GLOBAL struct timespec start_time;
 279
 280 GLOBAL struct tar_stat_info current_stat_info;
 281
 282 /* List of tape drive names, number of such tape drives, allocated number,
 283    and current cursor in list.  */
 284 GLOBAL const char **archive_name_array;
 285 GLOBAL int archive_names;
 286 GLOBAL int allocated_archive_names;
 287 GLOBAL const char **archive_name_cursor;
 288
 289 /* Output index file name.  */
 290 GLOBAL char const *index_file_name;
 291
 292 /* Structure for keeping track of filenames and lists thereof.  */
 293 struct name
 294   {
 295     struct name *next;
 296     size_t length;              /* cached strlen(name) */
 297     uintmax_t found_count;      /* number of times a matching file has
 298                                    been found */
 299     int isdir;
 300     char firstch;               /* first char is literally matched */
 301     char regexp;                /* this name is a regexp, not literal */
 302     int change_dir;             /* set with the -C option */
 303     char const *dir_contents;   /* for incremental_option */
 304     char fake;                  /* dummy entry */
 305     char name[1];
 306   };
 307
 308 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 309 GLOBAL dev_t ar_dev;
 310 GLOBAL ino_t ar_ino;
 311
 312 GLOBAL bool seekable_archive;
 313
 314 GLOBAL dev_t root_device;
 315
 316 /* Unquote filenames */
 317 GLOBAL bool unquote_option;
 318 \f
 319 /* Declarations for each module.  */
 320
 321 /* FIXME: compare.c should not directly handle the following variable,
 322    instead, this should be done in buffer.c only.  */
 323
 324 enum access_mode
 325 {
 326   ACCESS_READ,
 327   ACCESS_WRITE,
 328   ACCESS_UPDATE
 329 };
 330 extern enum access_mode access_mode;
 331
 332 /* Module buffer.c.  */
 333
 334 extern FILE *stdlis;
 335 extern char *save_name;
 336 extern off_t save_sizeleft;
 337 extern off_t save_totsize;
 338 extern bool write_archive_to_stdout;
 339
 340 size_t available_space_after (union block *);
 341 off_t current_block_ordinal (void);
 342 void close_archive (void);
 343 void closeout_volume_number (void);
 344 union block *find_next_block (void);
 345 void flush_read (void);
 346 void flush_write (void);
 347 void flush_archive (void);
 348 void init_volume_number (void);
 349 void open_archive (enum access_mode);
 350 void print_total_written (void);
 351 void reset_eof (void);
 352 void set_next_block_after (union block *);
 353 void clear_read_error_count (void);
 354 void xclose (int fd);
 355 void archive_write_error (ssize_t) __attribute__ ((noreturn));
 356 void archive_read_error (void);
 357 off_t seek_archive (off_t size);
 358 void set_start_time (void);
 359
 360 /* Module create.c.  */
 361
 362 enum dump_status
 363   {
 364     dump_status_ok,
 365     dump_status_short,
 366     dump_status_fail,
 367     dump_status_not_implemented
 368   };
 369
 370 bool file_dumpable_p (struct tar_stat_info *);
 371 void create_archive (void);
 372 void pad_archive (off_t size_left);
 373 void dump_file (char *, int, dev_t);
 374 union block *start_header (struct tar_stat_info *st);
 375 void finish_header (struct tar_stat_info *, union block *, off_t);
 376 void simple_finish_header (union block *header);
 377 union block *start_private_header (const char *name, size_t size);
 378 void write_eot (void);
 379 void check_links (void);
 380
 381 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 382 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 383 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
 384 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
 385 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 386 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
 387 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 388 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
 389 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
 390 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 391 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 392
 393 void gid_to_chars (gid_t, char *, size_t);
 394 void major_to_chars (major_t, char *, size_t);
 395 void minor_to_chars (minor_t, char *, size_t);
 396 void mode_to_chars (mode_t, char *, size_t);
 397 void off_to_chars (off_t, char *, size_t);
 398 void size_to_chars (size_t, char *, size_t);
 399 void time_to_chars (time_t, char *, size_t);
 400 void uid_to_chars (uid_t, char *, size_t);
 401 void uintmax_to_chars (uintmax_t, char *, size_t);
 402 void string_to_chars (char const *, char *, size_t);
 403
 404 /* Module diffarch.c.  */
 405
 406 extern bool now_verifying;
 407
 408 void diff_archive (void);
 409 void diff_init (void);
 410 void verify_volume (void);
 411
 412 /* Module extract.c.  */
 413
 414 void extr_init (void);
 415 void extract_archive (void);
 416 void extract_finish (void);
 417
 418 /* Module delete.c.  */
 419
 420 void delete_archive_members (void);
 421
 422 /* Module incremen.c.  */
 423
 424 char *get_directory_contents (char *, dev_t);
 425 void read_directory_file (void);
 426 void write_directory_file (void);
 427 void purge_directory (char const *);
 428
 429 /* Module list.c.  */
 430
 431 enum read_header
 432 {
 433   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 434   HEADER_SUCCESS,               /* header successfully read and checksummed */
 435   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 436   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 437   HEADER_END_OF_FILE,           /* true end of file while header expected */
 438   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 439 };
 440
 441 struct xheader
 442 {
 443   struct obstack *stk;
 444   size_t size;
 445   char *buffer;
 446 };
 447
 448 GLOBAL struct xheader extended_header;
 449 extern union block *current_header;
 450 extern enum archive_format current_format;
 451 extern size_t recent_long_name_blocks;
 452 extern size_t recent_long_link_blocks;
 453
 454 void decode_header (union block *, struct tar_stat_info *,
 455                     enum archive_format *, int);
 456 char const *tartime (struct timespec, bool);
 457
 458 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
 459 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
 460 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
 461 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
 462 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 463 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
 464 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
 465 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
 466 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 467
 468 gid_t gid_from_header (const char *, size_t);
 469 major_t major_from_header (const char *, size_t);
 470 minor_t minor_from_header (const char *, size_t);
 471 mode_t mode_from_header (const char *, size_t);
 472 off_t off_from_header (const char *, size_t);
 473 size_t size_from_header (const char *, size_t);
 474 time_t time_from_header (const char *, size_t);
 475 uid_t uid_from_header (const char *, size_t);
 476 uintmax_t uintmax_from_header (const char *, size_t);
 477
 478 void list_archive (void);
 479 void print_for_mkdir (char *, int, mode_t);
 480 void print_header (struct tar_stat_info *, off_t);
 481 void read_and (void (*) (void));
 482 enum read_header read_header (bool);
 483 enum read_header tar_checksum (union block *header, bool silent);
 484 void skip_file (off_t);
 485 void skip_member (void);
 486
 487 /* Module mangle.c.  */
 488
 489 void extract_mangle (void);
 490
 491 /* Module misc.c.  */
 492
 493 void assign_string (char **, const char *);
 494 char *quote_copy_string (const char *);
 495 int unquote_string (char *);
 496
 497 void code_ns_fraction (int, char *);
 498
 499 size_t dot_dot_prefix_len (char const *);
 500
 501 enum remove_option
 502 {
 503   ORDINARY_REMOVE_OPTION,
 504   RECURSIVE_REMOVE_OPTION,
 505
 506   /* FIXME: The following value is never used. It seems to be intended
 507      as a placeholder for a hypothetical option that should instruct tar
 508      to recursively remove subdirectories in purge_directory(),
 509      as opposed to the functionality of --recursive-unlink
 510      (RECURSIVE_REMOVE_OPTION value), which removes them in
 511      prepare_to_extract() phase. However, with the addition of more
 512      meta-info to the incremental dumps, this should become unnecessary */
 513   WANT_DIRECTORY_REMOVE_OPTION
 514 };
 515 int remove_any_file (const char *, enum remove_option);
 516 bool maybe_backup_file (const char *, int);
 517 void undo_last_backup (void);
 518
 519 int deref_stat (bool, char const *, struct stat *);
 520
 521 int chdir_arg (char const *);
 522 void chdir_do (int);
 523
 524 void close_diag (char const *name);
 525 void open_diag (char const *name);
 526 void read_diag_details (char const *name, off_t offset, size_t size);
 527 void readlink_diag (char const *name);
 528 void savedir_diag (char const *name);
 529 void seek_diag_details (char const *, off_t);
 530 void stat_diag (char const *name);
 531 void write_error_details (char const *, size_t, size_t);
 532 void write_fatal (char const *) __attribute__ ((noreturn));
 533 void write_fatal_details (char const *, ssize_t, size_t)
 534      __attribute__ ((noreturn));
 535
 536 pid_t xfork (void);
 537 void xpipe (int[2]);
 538
 539 void *page_aligned_alloc (void **, size_t);
 540
 541 /* Module names.c.  */
 542
 543 extern struct name *gnu_list_name;
 544
 545 void gid_to_gname (gid_t, char **gname);
 546 int gname_to_gid (char const *, gid_t *);
 547 void uid_to_uname (uid_t, char **uname);
 548 int uname_to_uid (char const *, uid_t *);
 549
 550 void init_names (void);
 551 void name_add (const char *);
 552 void name_init (void);
 553 void name_term (void);
 554 char *name_next (int);
 555 void name_gather (void);
 556 struct name *addname (char const *, int);
 557 int name_match (const char *);
 558 void names_notfound (void);
 559 void collect_and_sort_names (void);
 560 struct name *name_scan (const char *);
 561 char *name_from_list (void);
 562 void blank_name_list (void);
 563 char *new_name (const char *, const char *);
 564 size_t stripped_prefix_len (char const *file_name, size_t num);
 565 bool all_names_found (struct tar_stat_info *);
 566
 567 bool excluded_name (char const *);
 568
 569 void add_avoided_name (char const *);
 570 bool is_avoided_name (char const *);
 571 bool is_individual_file (char const *);
 572
 573 bool contains_dot_dot (char const *);
 574
 575 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 576                     (c)->found_count == occurrence_option)
 577 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
 578                      (c)->found_count >= occurrence_option)
 579
 580 /* Module tar.c.  */
 581
 582 void usage (int);
 583
 584 int confirm (const char *, const char *);
 585 void request_stdin (const char *);
 586
 587 void tar_stat_init (struct tar_stat_info *st);
 588 void tar_stat_destroy (struct tar_stat_info *st);
 589 void usage (int) __attribute__ ((noreturn));
 590
 591 /* Module update.c.  */
 592
 593 extern char *output_start;
 594
 595 void update_archive (void);
 596
 597 /* Module xheader.c.  */
 598
 599 void xheader_decode (struct tar_stat_info *);
 600 void xheader_decode_global (void);
 601 void xheader_store (char const *, struct tar_stat_info const *, void *);
 602 void xheader_read (union block *, size_t);
 603 void xheader_write (char type, char *name, struct xheader *xhdr);
 604 void xheader_write_global (void);
 605 void xheader_finish (struct xheader *);
 606 void xheader_destroy (struct xheader *);
 607 char *xheader_xhdr_name (struct tar_stat_info *st);
 608 char *xheader_ghdr_name (void);
 609 void xheader_write (char, char *, struct xheader *);
 610 void xheader_write_global (void);
 611 void xheader_set_option (char *string);
 612
 613 /* Module system.c */
 614
 615 void sys_detect_dev_null_output (void);
 616 void sys_save_archive_dev_ino (void);
 617 void sys_drain_input_pipe (void);
 618 void sys_wait_for_child (pid_t);
 619 void sys_spawn_shell (void);
 620 bool sys_compare_uid (struct stat *a, struct stat *b);
 621 bool sys_compare_gid (struct stat *a, struct stat *b);
 622 bool sys_file_is_archive (struct tar_stat_info *p);
 623 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 624 int sys_truncate (int fd);
 625 pid_t sys_child_open_for_compress (void);
 626 pid_t sys_child_open_for_uncompress (void);
 627 size_t sys_write_archive_buffer (void);
 628 bool sys_get_archive_stat (void);
 629 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
 630 void sys_wait_command (void);
 631
 632 /* Module compare.c */
 633 void report_difference (struct tar_stat_info *st, const char *message, ...);
 634
 635 /* Module sparse.c */
 636 bool sparse_file_p (struct tar_stat_info *);
 637 bool sparse_member_p (struct tar_stat_info *);
 638 bool sparse_fixup_header (struct tar_stat_info *);
 639 enum dump_status sparse_dump_file (int, struct tar_stat_info *);
 640 enum dump_status sparse_extract_file (int, struct tar_stat_info *, off_t *);
 641 enum dump_status sparse_skip_file (struct tar_stat_info *);
 642 bool sparse_diff_file (int, struct tar_stat_info *);
 643
 644 /* Module utf8.c */
 645 bool string_ascii_p (const char *str);
 646 bool utf8_convert (bool to_utf, char const *input, char **output);
 647
 648
 649 /* FIXME: The following should get moved into gnulib.  */
 650
 651 static inline struct timespec
 652 get_stat_atime (struct stat const *st)
 653 {
 654 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 655   return st->st_atim;
 656 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 657   return st->st_atimespec;
 658 #else
 659   struct timespec t;
 660   t.tv_sec = st->st_atime;
 661 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 662   t.tv_nsec = st->stat.st_atimensec;
 663 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 664   t.tv_nsec = st->stat.st_spare1 * 1000;
 665 # else
 666   t.tv_nsec = 0;
 667 # endif
 668   return t;
 669 #endif
 670 }
 671
 672 static inline struct timespec
 673 get_stat_ctime (struct stat const *st)
 674 {
 675 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 676   return st->st_ctim;
 677 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 678   return st->st_ctimespec;
 679 #else
 680   struct timespec t;
 681   t.tv_sec = st->st_ctime;
 682 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 683   t.tv_nsec = st->stat.st_ctimensec;
 684 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 685   t.tv_nsec = st->stat.st_spare1 * 1000;
 686 # else
 687   t.tv_nsec = 0;
 688 # endif
 689   return t;
 690 #endif
 691 }
 692
 693 static inline struct timespec
 694 get_stat_mtime (struct stat const *st)
 695 {
 696 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 697   return st->st_mtim;
 698 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 699   return st->st_mtimespec;
 700 #else
 701   struct timespec t;
 702   t.tv_sec = st->st_mtime;
 703 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 704   t.tv_nsec = st->stat.st_mtimensec;
 705 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 706   t.tv_nsec = st->stat.st_spare1 * 1000;
 707 # else
 708   t.tv_nsec = 0;
 709 # endif
 710   return t;
 711 #endif
 712 }
 713
 714 static inline void
 715 set_stat_atime (struct stat *st, struct timespec t)
 716 {
 717 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 718   st->st_atim = t;
 719 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 720   st->st_atimespec = t;
 721 #else
 722   st->st_atime = t.tv_sec;
 723 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 724   st->stat.st_atimensec = t.tv_nsec;
 725 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 726   st->stat.st_spare1 = t.tv_nsec / 1000;
 727 # endif
 728 #endif
 729 }
 730
 731 static inline void
 732 set_stat_ctime (struct stat *st, struct timespec t)
 733 {
 734 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 735   st->st_ctim = t;
 736 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 737   st->st_ctimespec = t;
 738 #else
 739   st->st_ctime = t.tv_sec;
 740 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 741   st->stat.st_ctimensec = t.tv_nsec;
 742 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 743   st->stat.st_spare1 = t.tv_nsec / 1000;
 744 # endif
 745 #endif
 746 }
 747
 748 static inline void
 749 set_stat_mtime (struct stat *st, struct timespec t)
 750 {
 751 #if defined HAVE_STRUCT_STAT_ST_ATIM_TV_NSEC
 752   st->st_mtim = t;
 753 #elif defined HAVE_STRUCT_STAT_ST_ATIMESPEC_TV_NSEC
 754   st->st_mtimespec = t;
 755 #else
 756   st->st_mtime = t.tv_sec;
 757 # if defined HAVE_STRUCT_STAT_ST_ATIMENSEC
 758   st->stat.st_mtimensec = t.tv_nsec;
 759 # elif defined HAVE_STRUCT_STAT_ST_SPARE1
 760   st->stat.st_spare1 = t.tv_nsec / 1000;
 761 # endif
 762 #endif
 763 }