src/common.h

   1 /* Common declarations for the tar program.
   2
   3    Copyright 1988, 1992-1994, 1996-1997, 1999-2010, 2012-2017 Free
   4    Software Foundation, Inc.
   5
   6    This file is part of GNU tar.
   7
   8    GNU tar is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    GNU tar is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 /* Declare the GNU tar archive format.  */
  22 #include "tar.h"
  23
  24 /* The checksum field is filled with this while the checksum is computed.  */
  25 #define CHKBLANKS       "        "      /* 8 blanks, no null */
  26
  27 /* Some constants from POSIX are given names.  */
  28 #define NAME_FIELD_SIZE   100
  29 #define PREFIX_FIELD_SIZE 155
  30 #define UNAME_FIELD_SIZE   32
  31 #define GNAME_FIELD_SIZE   32
  32
  33
  34 \f
  35 /* Some various global definitions.  */
  36
  37 /* Name of file to use for interacting with user.  */
  38
  39 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
  40    modules.  Here, we merely set it to "extern" if it is not already set.
  41    GNU tar does depend on the system loader to preset all GLOBAL variables to
  42    neutral (or zero) values, explicit initialization is usually not done.  */
  43 #ifndef GLOBAL
  44 # define GLOBAL extern
  45 #endif
  46
  47 #if 7 <= __GNUC__
  48 # define FALLTHROUGH __attribute__ ((__fallthrough__))
  49 #else
  50 # define FALLTHROUGH ((void) 0)
  51 #endif
  52
  53 #define TAREXIT_SUCCESS PAXEXIT_SUCCESS
  54 #define TAREXIT_DIFFERS PAXEXIT_DIFFERS
  55 #define TAREXIT_FAILURE PAXEXIT_FAILURE
  56
  57 \f
  58 #include "arith.h"
  59 #include <backupfile.h>
  60 #include <exclude.h>
  61 #include <full-write.h>
  62 #include <modechange.h>
  63 #include <quote.h>
  64 #include <safe-read.h>
  65 #include <stat-time.h>
  66 #include <timespec.h>
  67 #define obstack_chunk_alloc xmalloc
  68 #define obstack_chunk_free free
  69 #include <obstack.h>
  70 #include <progname.h>
  71 #include <xvasprintf.h>
  72
  73 #include <paxlib.h>
  74
  75 /* Log base 2 of common values.  */
  76 #define LG_8 3
  77 #define LG_64 6
  78 #define LG_256 8
  79
  80 _GL_INLINE_HEADER_BEGIN
  81 #ifndef COMMON_INLINE
  82 # define COMMON_INLINE _GL_INLINE
  83 #endif
  84 \f
  85 /* Information gleaned from the command line.  */
  86
  87 /* Main command option.  */
  88
  89 enum subcommand
  90 {
  91   UNKNOWN_SUBCOMMAND,           /* none of the following */
  92   APPEND_SUBCOMMAND,            /* -r */
  93   CAT_SUBCOMMAND,               /* -A */
  94   CREATE_SUBCOMMAND,            /* -c */
  95   DELETE_SUBCOMMAND,            /* -D */
  96   DIFF_SUBCOMMAND,              /* -d */
  97   EXTRACT_SUBCOMMAND,           /* -x */
  98   LIST_SUBCOMMAND,              /* -t */
  99   UPDATE_SUBCOMMAND,            /* -u */
 100   TEST_LABEL_SUBCOMMAND,        /* --test-label */
 101 };
 102
 103 GLOBAL enum subcommand subcommand_option;
 104
 105 /* Selected format for output archive.  */
 106 GLOBAL enum archive_format archive_format;
 107
 108 /* Size of each record, once in blocks, once in bytes.  Those two variables
 109    are always related, the second being BLOCKSIZE times the first.  They do
 110    not have _option in their name, even if their values is derived from
 111    option decoding, as these are especially important in tar.  */
 112 GLOBAL int blocking_factor;
 113 GLOBAL size_t record_size;
 114
 115 GLOBAL bool absolute_names_option;
 116
 117 /* Display file times in UTC */
 118 GLOBAL bool utc_option;
 119 /* Output file timestamps to the full resolution */
 120 GLOBAL bool full_time_option;
 121
 122 /* This variable tells how to interpret newer_mtime_option, below.  If zero,
 123    files get archived if their mtime is not less than newer_mtime_option.
 124    If nonzero, files get archived if *either* their ctime or mtime is not less
 125    than newer_mtime_option.  */
 126 GLOBAL int after_date_option;
 127
 128 enum atime_preserve
 129 {
 130   no_atime_preserve,
 131   replace_atime_preserve,
 132   system_atime_preserve
 133 };
 134 GLOBAL enum atime_preserve atime_preserve_option;
 135
 136 GLOBAL bool backup_option;
 137
 138 /* Type of backups being made.  */
 139 GLOBAL enum backup_type backup_type;
 140
 141 GLOBAL bool block_number_option;
 142
 143 GLOBAL unsigned checkpoint_option;
 144 #define DEFAULT_CHECKPOINT 10
 145
 146 /* Specified name of compression program, or "gzip" as implied by -z.  */
 147 GLOBAL const char *use_compress_program_option;
 148
 149 GLOBAL bool dereference_option;
 150 GLOBAL bool hard_dereference_option;
 151
 152 /* Patterns that match file names to be excluded.  */
 153 GLOBAL struct exclude *excluded;
 154
 155 enum exclusion_tag_type
 156   {
 157     exclusion_tag_none,
 158      /* Exclude the directory contents, but preserve the directory
 159         itself and the exclusion tag file */
 160     exclusion_tag_contents,
 161     /* Exclude everything below the directory, preserving the directory
 162        itself */
 163     exclusion_tag_under,
 164     /* Exclude entire directory  */
 165     exclusion_tag_all,
 166   };
 167
 168 /* Specified value to be put into tar file in place of stat () results, or
 169    just null and -1 if such an override should not take place.  */
 170 GLOBAL char const *group_name_option;
 171 GLOBAL gid_t group_option;
 172
 173 GLOBAL bool ignore_failed_read_option;
 174
 175 GLOBAL bool ignore_zeros_option;
 176
 177 GLOBAL bool incremental_option;
 178
 179 /* Specified name of script to run at end of each tape change.  */
 180 GLOBAL const char *info_script_option;
 181
 182 GLOBAL bool interactive_option;
 183
 184 /* If nonzero, extract only Nth occurrence of each named file */
 185 GLOBAL uintmax_t occurrence_option;
 186
 187 enum old_files
 188 {
 189   DEFAULT_OLD_FILES,          /* default */
 190   NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
 191   OVERWRITE_OLD_FILES,        /* --overwrite */
 192   UNLINK_FIRST_OLD_FILES,     /* --unlink-first */
 193   KEEP_OLD_FILES,             /* --keep-old-files */
 194   SKIP_OLD_FILES,             /* --skip-old-files */
 195   KEEP_NEWER_FILES            /* --keep-newer-files */
 196 };
 197 GLOBAL enum old_files old_files_option;
 198
 199 GLOBAL bool keep_directory_symlink_option;
 200
 201 /* Specified file name for incremental list.  */
 202 GLOBAL const char *listed_incremental_option;
 203 /* Incremental dump level */
 204 GLOBAL int incremental_level;
 205 /* Check device numbers when doing incremental dumps. */
 206 GLOBAL bool check_device_option;
 207
 208 /* Specified mode change string.  */
 209 GLOBAL struct mode_change *mode_option;
 210
 211 /* Initial umask, if needed for mode change string.  */
 212 GLOBAL mode_t initial_umask;
 213
 214 GLOBAL bool multi_volume_option;
 215
 216 /* Specified threshold date and time.  Files having an older time stamp
 217    do not get archived (also see after_date_option above).  */
 218 GLOBAL struct timespec newer_mtime_option;
 219
 220 enum set_mtime_option_mode
 221 {
 222   USE_FILE_MTIME,
 223   FORCE_MTIME,
 224   CLAMP_MTIME,
 225 };
 226
 227 /* Override actual mtime if set to FORCE_MTIME or CLAMP_MTIME */
 228 GLOBAL enum set_mtime_option_mode set_mtime_option;
 229 /* Value to use when forcing or clamping the mtime header field. */
 230 GLOBAL struct timespec mtime_option;
 231
 232 /* Return true if mtime_option or newer_mtime_option is initialized.  */
 233 #define TIME_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
 234
 235 /* Return true if the struct stat ST's M time is less than
 236    newer_mtime_option.  */
 237 #define OLDER_STAT_TIME(st, m) \
 238   (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
 239
 240 /* Likewise, for struct tar_stat_info ST.  */
 241 #define OLDER_TAR_STAT_TIME(st, m) \
 242   (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
 243
 244 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR.  */
 245 GLOBAL int recursion_option;
 246
 247 GLOBAL bool numeric_owner_option;
 248
 249 GLOBAL bool one_file_system_option;
 250
 251 /* Create a top-level directory for extracting based on the archive name.  */
 252 GLOBAL bool one_top_level_option;
 253 GLOBAL char *one_top_level_dir;
 254
 255 /* Specified value to be put into tar file in place of stat () results, or
 256    just null and -1 if such an override should not take place.  */
 257 GLOBAL char const *owner_name_option;
 258 GLOBAL uid_t owner_option;
 259
 260 GLOBAL bool recursive_unlink_option;
 261
 262 GLOBAL bool read_full_records_option;
 263
 264 GLOBAL bool remove_files_option;
 265
 266 /* Specified remote shell command.  */
 267 GLOBAL const char *rsh_command_option;
 268
 269 GLOBAL bool same_order_option;
 270
 271 /* If positive, preserve ownership when extracting.  */
 272 GLOBAL int same_owner_option;
 273
 274 /* If positive, preserve permissions when extracting.  */
 275 GLOBAL int same_permissions_option;
 276
 277 /* If positive, save the SELinux context.  */
 278 GLOBAL int selinux_context_option;
 279
 280 /* If positive, save the ACLs.  */
 281 GLOBAL int acls_option;
 282
 283 /* If positive, save the user and root xattrs.  */
 284 GLOBAL int xattrs_option;
 285
 286 /* When set, strip the given number of file name components from the file name
 287    before extracting */
 288 GLOBAL size_t strip_name_components;
 289
 290 GLOBAL bool show_omitted_dirs_option;
 291
 292 GLOBAL bool sparse_option;
 293 GLOBAL unsigned tar_sparse_major;
 294 GLOBAL unsigned tar_sparse_minor;
 295
 296 enum hole_detection_method
 297   {
 298     HOLE_DETECTION_DEFAULT,
 299     HOLE_DETECTION_RAW,
 300     HOLE_DETECTION_SEEK
 301   };
 302
 303 GLOBAL enum hole_detection_method hole_detection;
 304
 305 /* The first entry in names.c:namelist specifies the member name to
 306    start extracting from. Set by add_starting_file() upon seeing the
 307    -K option.
 308 */
 309 GLOBAL bool starting_file_option;
 310
 311 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 312 GLOBAL tarlong tape_length_option;
 313
 314 GLOBAL bool to_stdout_option;
 315
 316 GLOBAL bool totals_option;
 317
 318 GLOBAL bool touch_option;
 319
 320 GLOBAL char *to_command_option;
 321 GLOBAL bool ignore_command_error_option;
 322
 323 /* Restrict some potentially harmful tar options */
 324 GLOBAL bool restrict_option;
 325
 326 /* Return true if the extracted files are not being written to disk */
 327 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
 328
 329 /* Count how many times the option has been set, multiple setting yields
 330    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 331    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 332 GLOBAL int verbose_option;
 333
 334 GLOBAL bool verify_option;
 335
 336 /* Specified name of file containing the volume number.  */
 337 GLOBAL const char *volno_file_option;
 338
 339 /* Specified value or pattern.  */
 340 GLOBAL const char *volume_label_option;
 341 \f
 342 /* Other global variables.  */
 343
 344 /* File descriptor for archive file.  */
 345 GLOBAL int archive;
 346
 347 /* Nonzero when outputting to /dev/null.  */
 348 GLOBAL bool dev_null_output;
 349
 350 /* Timestamps: */
 351 GLOBAL struct timespec start_time;        /* when we started execution */
 352 GLOBAL struct timespec volume_start_time; /* when the current volume was
 353                                              opened*/
 354 GLOBAL struct timespec last_stat_time;    /* when the statistics was last
 355                                              computed */
 356
 357 GLOBAL struct tar_stat_info current_stat_info;
 358
 359 /* List of tape drive names, number of such tape drives,
 360    and current cursor in list.  */
 361 GLOBAL const char **archive_name_array;
 362 GLOBAL size_t archive_names;
 363 GLOBAL const char **archive_name_cursor;
 364
 365 /* Output index file name.  */
 366 GLOBAL char const *index_file_name;
 367
 368 /* Opaque structure for keeping directory meta-data */
 369 struct directory;
 370
 371 /* Structure for keeping track of filenames and lists thereof.  */
 372 struct name
 373   {
 374     struct name *next;          /* Link to the next element */
 375     struct name *prev;          /* Link to the previous element */
 376
 377     char *name;                 /* File name or globbing pattern */
 378     size_t length;              /* cached strlen (name) */
 379     int matching_flags;         /* wildcard flags if name is a pattern */
 380     bool cmdline;               /* true if this name was given in the
 381                                    command line */
 382
 383     int change_dir;             /* Number of the directory to change to.
 384                                    Set with the -C option. */
 385     uintmax_t found_count;      /* number of times a matching file has
 386                                    been found */
 387
 388     /* The following members are used for incremental dumps only,
 389        if this struct name represents a directory;
 390        see incremen.c */
 391     struct directory *directory;/* directory meta-data and contents */
 392     struct name *parent;        /* pointer to the parent hierarchy */
 393     struct name *child;         /* pointer to the first child */
 394     struct name *sibling;       /* pointer to the next sibling */
 395     char *caname;               /* canonical name */
 396   };
 397
 398 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
 399 GLOBAL dev_t ar_dev;
 400 GLOBAL ino_t ar_ino;
 401
 402 /* Flags for reading, searching, and fstatatting files.  */
 403 GLOBAL int open_read_flags;
 404 GLOBAL int open_searchdir_flags;
 405 GLOBAL int fstatat_flags;
 406
 407 GLOBAL int seek_option;
 408 GLOBAL bool seekable_archive;
 409
 410 GLOBAL dev_t root_device;
 411
 412 /* Unquote filenames */
 413 GLOBAL bool unquote_option;
 414
 415 GLOBAL int savedir_sort_order;
 416
 417 /* Show file or archive names after transformation.
 418    In particular, when creating archive in verbose mode, list member names
 419    as stored in the archive */
 420 GLOBAL bool show_transformed_names_option;
 421
 422 /* Delay setting modification times and permissions of extracted directories
 423    until the end of extraction. This variable helps correctly restore directory
 424    timestamps from archives with an unusual member order. It is automatically
 425    set for incremental archives. */
 426 GLOBAL bool delay_directory_restore_option;
 427 \f
 428 /* Declarations for each module.  */
 429
 430 /* FIXME: compare.c should not directly handle the following variable,
 431    instead, this should be done in buffer.c only.  */
 432
 433 enum access_mode
 434 {
 435   ACCESS_READ,
 436   ACCESS_WRITE,
 437   ACCESS_UPDATE
 438 };
 439 extern enum access_mode access_mode;
 440
 441 /* Module buffer.c.  */
 442
 443 extern FILE *stdlis;
 444 extern bool write_archive_to_stdout;
 445 extern char *volume_label;
 446 extern size_t volume_label_count;
 447 extern char *continued_file_name;
 448 extern uintmax_t continued_file_size;
 449 extern uintmax_t continued_file_offset;
 450 extern off_t records_written;
 451
 452 char *drop_volume_label_suffix (const char *label);
 453
 454 size_t available_space_after (union block *pointer);
 455 off_t current_block_ordinal (void);
 456 void close_archive (void);
 457 void closeout_volume_number (void);
 458 double compute_duration (void);
 459 union block *find_next_block (void);
 460 void flush_read (void);
 461 void flush_write (void);
 462 void flush_archive (void);
 463 void init_volume_number (void);
 464 void open_archive (enum access_mode mode);
 465 void print_total_stats (void);
 466 void reset_eof (void);
 467 void set_next_block_after (union block *block);
 468 void clear_read_error_count (void);
 469 void xclose (int fd);
 470 void archive_write_error (ssize_t status) __attribute__ ((noreturn));
 471 void archive_read_error (void);
 472 off_t seek_archive (off_t size);
 473 void set_start_time (void);
 474
 475 #define TF_READ    0
 476 #define TF_WRITE   1
 477 #define TF_DELETED 2
 478 int format_total_stats (FILE *fp, char const *const *formats, int eor, int eol);
 479 void print_total_stats (void);
 480
 481 void mv_begin_write (const char *file_name, off_t totsize, off_t sizeleft);
 482
 483 void mv_begin_read (struct tar_stat_info *st);
 484 void mv_end (void);
 485 void mv_size_left (off_t size);
 486
 487 void buffer_write_global_xheader (void);
 488
 489 const char *first_decompress_program (int *pstate);
 490 const char *next_decompress_program (int *pstate);
 491
 492 /* Module create.c.  */
 493
 494 enum dump_status
 495   {
 496     dump_status_ok,
 497     dump_status_short,
 498     dump_status_fail,
 499     dump_status_not_implemented
 500   };
 501
 502 void add_exclusion_tag (const char *name, enum exclusion_tag_type type,
 503                         bool (*predicate) (int));
 504 bool cachedir_file_p (int fd);
 505 char *get_directory_entries (struct tar_stat_info *st);
 506
 507 void create_archive (void);
 508 void pad_archive (off_t size_left);
 509 void dump_file (struct tar_stat_info *parent, char const *name,
 510                 char const *fullname);
 511 union block *start_header (struct tar_stat_info *st);
 512 void finish_header (struct tar_stat_info *st, union block *header,
 513                     off_t block_ordinal);
 514 void simple_finish_header (union block *header);
 515 union block * write_extended (bool global, struct tar_stat_info *st,
 516                               union block *old_header);
 517 union block *start_private_header (const char *name, size_t size, time_t t);
 518 void write_eot (void);
 519 void check_links (void);
 520 int subfile_open (struct tar_stat_info const *dir, char const *file, int flags);
 521 void restore_parent_fd (struct tar_stat_info const *st);
 522 void exclusion_tag_warning (const char *dirname, const char *tagname,
 523                             const char *message);
 524 enum exclusion_tag_type check_exclusion_tags (struct tar_stat_info const *st,
 525                                               const char **tag_file_name);
 526
 527 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 528 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 529
 530 bool off_to_chars (off_t off, char *buf, size_t size);
 531 bool time_to_chars (time_t t, char *buf, size_t size);
 532
 533 /* Module diffarch.c.  */
 534
 535 extern bool now_verifying;
 536
 537 void diff_archive (void);
 538 void diff_init (void);
 539 void verify_volume (void);
 540
 541 /* Module extract.c.  */
 542
 543 void extr_init (void);
 544 void extract_archive (void);
 545 void extract_finish (void);
 546 bool rename_directory (char *src, char *dst);
 547
 548 void remove_delayed_set_stat (const char *fname);
 549
 550 /* Module delete.c.  */
 551
 552 void delete_archive_members (void);
 553
 554 /* Module incremen.c.  */
 555
 556 struct directory *scan_directory (struct tar_stat_info *st);
 557 const char *directory_contents (struct directory *dir);
 558 const char *safe_directory_contents (struct directory *dir);
 559
 560 void rebase_directory (struct directory *dir,
 561                        const char *samp, size_t slen,
 562                        const char *repl, size_t rlen);
 563
 564 void append_incremental_renames (struct directory *dir);
 565 void show_snapshot_field_ranges (void);
 566 void read_directory_file (void);
 567 void write_directory_file (void);
 568 void purge_directory (char const *directory_name);
 569 void list_dumpdir (char *buffer, size_t size);
 570 void update_parent_directory (struct tar_stat_info *st);
 571
 572 size_t dumpdir_size (const char *p);
 573 bool is_dumpdir (struct tar_stat_info *stat_info);
 574 void clear_directory_table (void);
 575
 576 /* Module list.c.  */
 577
 578 enum read_header
 579 {
 580   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 581   HEADER_SUCCESS,               /* header successfully read and checksummed */
 582   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 583   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 584   HEADER_END_OF_FILE,           /* true end of file while header expected */
 585   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 586 };
 587
 588 /* Operation mode for read_header: */
 589
 590 enum read_header_mode
 591 {
 592   read_header_auto,             /* process extended headers automatically */
 593   read_header_x_raw,            /* return raw extended headers (return
 594                                    HEADER_SUCCESS_EXTENDED) */
 595   read_header_x_global          /* when POSIX global extended header is read,
 596                                    decode it and return
 597                                    HEADER_SUCCESS_EXTENDED */
 598 };
 599 extern union block *current_header;
 600 extern enum archive_format current_format;
 601 extern size_t recent_long_name_blocks;
 602 extern size_t recent_long_link_blocks;
 603
 604 void decode_header (union block *header, struct tar_stat_info *stat_info,
 605                     enum archive_format *format_pointer, int do_user_group);
 606 void transform_stat_info (int typeflag, struct tar_stat_info *stat_info);
 607 char const *tartime (struct timespec t, bool full_time);
 608
 609 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 610 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 611
 612 off_t off_from_header (const char *buf, size_t size);
 613 uintmax_t uintmax_from_header (const char *buf, size_t size);
 614
 615 void list_archive (void);
 616 void test_archive_label (void);
 617 void print_for_mkdir (char *dirname, int length, mode_t mode);
 618 void print_header (struct tar_stat_info *st, union block *blk,
 619                    off_t block_ordinal);
 620 void read_and (void (*do_something) (void));
 621 enum read_header read_header (union block **return_block,
 622                               struct tar_stat_info *info,
 623                               enum read_header_mode m);
 624 enum read_header tar_checksum (union block *header, bool silent);
 625 void skip_file (off_t size);
 626 void skip_member (void);
 627
 628 /* Module misc.c.  */
 629
 630 #define min(a, b) ((a) < (b) ? (a) : (b))
 631 #define max(a, b) ((a) < (b) ? (b) : (a))
 632
 633 char const *quote_n_colon (int n, char const *arg);
 634 void assign_string (char **dest, const char *src);
 635 void assign_string_n (char **string, const char *value, size_t n);
 636 #define ASSIGN_STRING_N(s,v) assign_string_n (s, v, sizeof (v))
 637 int unquote_string (char *str);
 638 char *zap_slashes (char *name);
 639 char *normalize_filename (int cdidx, const char *name);
 640 void normalize_filename_x (char *name);
 641 void replace_prefix (char **pname, const char *samp, size_t slen,
 642                      const char *repl, size_t rlen);
 643 char *tar_savedir (const char *name, int must_exist);
 644
 645 typedef struct namebuf *namebuf_t;
 646 namebuf_t namebuf_create (const char *dir);
 647 void namebuf_free (namebuf_t buf);
 648 char *namebuf_name (namebuf_t buf, const char *name);
 649
 650 const char *tar_dirname (void);
 651
 652 /* Represent N using a signed integer I such that (uintmax_t) I == N.
 653    With a good optimizing compiler, this is equivalent to (intmax_t) i
 654    and requires zero machine instructions.  */
 655 #if ! (UINTMAX_MAX / 2 <= INTMAX_MAX)
 656 # error "represent_uintmax returns intmax_t to represent uintmax_t"
 657 #endif
 658 COMMON_INLINE intmax_t
 659 represent_uintmax (uintmax_t n)
 660 {
 661   if (n <= INTMAX_MAX)
 662     return n;
 663   else
 664     {
 665       /* Avoid signed integer overflow on picky platforms.  */
 666       intmax_t nd = n - INTMAX_MIN;
 667       return nd + INTMAX_MIN;
 668     }
 669 }
 670
 671 enum { SYSINT_BUFSIZE =
 672          max (UINTMAX_STRSIZE_BOUND, INT_BUFSIZE_BOUND (intmax_t)) };
 673 char *sysinttostr (uintmax_t, intmax_t, uintmax_t, char buf[SYSINT_BUFSIZE]);
 674 intmax_t strtosysint (char const *, char **, intmax_t, uintmax_t);
 675 void code_ns_fraction (int ns, char *p);
 676 char const *code_timespec (struct timespec ts, char *sbuf);
 677 enum { BILLION = 1000000000, LOG10_BILLION = 9 };
 678 enum { TIMESPEC_STRSIZE_BOUND =
 679          UINTMAX_STRSIZE_BOUND + LOG10_BILLION + sizeof "-." - 1 };
 680 struct timespec decode_timespec (char const *, char **, bool);
 681
 682 /* Return true if T does not represent an out-of-range or invalid value.  */
 683 COMMON_INLINE bool
 684 valid_timespec (struct timespec t)
 685 {
 686   return 0 <= t.tv_nsec;
 687 }
 688
 689 bool must_be_dot_or_slash (char const *);
 690
 691 enum remove_option
 692 {
 693   ORDINARY_REMOVE_OPTION,
 694   RECURSIVE_REMOVE_OPTION,
 695
 696   /* FIXME: The following value is never used. It seems to be intended
 697      as a placeholder for a hypothetical option that should instruct tar
 698      to recursively remove subdirectories in purge_directory(),
 699      as opposed to the functionality of --recursive-unlink
 700      (RECURSIVE_REMOVE_OPTION value), which removes them in
 701      prepare_to_extract() phase. However, with the addition of more
 702      meta-info to the incremental dumps, this should become unnecessary */
 703   WANT_DIRECTORY_REMOVE_OPTION
 704 };
 705 int remove_any_file (const char *file_name, enum remove_option option);
 706 bool maybe_backup_file (const char *file_name, bool this_is_the_archive);
 707 void undo_last_backup (void);
 708
 709 int deref_stat (char const *name, struct stat *buf);
 710
 711 size_t blocking_read (int fd, void *buf, size_t count);
 712 size_t blocking_write (int fd, void const *buf, size_t count);
 713
 714 extern int chdir_current;
 715 extern int chdir_fd;
 716 int chdir_arg (char const *dir);
 717 void chdir_do (int dir);
 718 int chdir_count (void);
 719
 720 void close_diag (char const *name);
 721 void open_diag (char const *name);
 722 void read_diag_details (char const *name, off_t offset, size_t size);
 723 void readlink_diag (char const *name);
 724 void savedir_diag (char const *name);
 725 void seek_diag_details (char const *name, off_t offset);
 726 void stat_diag (char const *name);
 727 void file_removed_diag (const char *name, bool top_level,
 728                         void (*diagfn) (char const *name));
 729 void write_error_details (char const *name, size_t status, size_t size);
 730 void write_fatal (char const *name) __attribute__ ((noreturn));
 731 void write_fatal_details (char const *name, ssize_t status, size_t size)
 732      __attribute__ ((noreturn));
 733
 734 pid_t xfork (void);
 735 void xpipe (int fd[2]);
 736
 737 void *page_aligned_alloc (void **ptr, size_t size);
 738 int set_file_atime (int fd, int parentfd, char const *file,
 739                     struct timespec atime);
 740
 741 /* Module names.c.  */
 742
 743 extern size_t name_count;
 744 extern struct name *gnu_list_name;
 745
 746 void gid_to_gname (gid_t gid, char **gname);
 747 int gname_to_gid (char const *gname, gid_t *pgid);
 748 void uid_to_uname (uid_t uid, char **uname);
 749 int uname_to_uid (char const *uname, uid_t *puid);
 750
 751 void name_init (void);
 752 bool name_more_files (void);
 753 void name_add_name (const char *name);
 754 void name_term (void);
 755 const char *name_next (int change_dirs);
 756 void name_gather (void);
 757 struct name *addname (char const *string, int change_dir,
 758                       bool cmdline, struct name *parent);
 759 void add_starting_file (char const *file_name);
 760 void remname (struct name *name);
 761 bool name_match (const char *name);
 762 void names_notfound (void);
 763 void label_notfound (void);
 764 void collect_and_sort_names (void);
 765 struct name *name_scan (const char *name);
 766 struct name const *name_from_list (void);
 767 void blank_name_list (void);
 768 char *make_file_name (const char *dir_name, const char *name);
 769 size_t stripped_prefix_len (char const *file_name, size_t num);
 770 bool all_names_found (struct tar_stat_info *st);
 771
 772 void add_avoided_name (char const *name);
 773 bool is_avoided_name (char const *name);
 774
 775 bool contains_dot_dot (char const *name);
 776
 777 #define ISFOUND(c) (occurrence_option == 0                      \
 778                     ? (c)->found_count != 0                     \
 779                     : (c)->found_count == occurrence_option)
 780 #define WASFOUND(c) (occurrence_option == 0                     \
 781                      ? (c)->found_count != 0                    \
 782                      : (c)->found_count >= occurrence_option)
 783
 784 /* Module tar.c.  */
 785
 786 void usage (int);
 787
 788 int confirm (const char *message_action, const char *name);
 789
 790 void tar_stat_init (struct tar_stat_info *st);
 791 bool tar_stat_close (struct tar_stat_info *st);
 792 void tar_stat_destroy (struct tar_stat_info *st);
 793 void usage (int) __attribute__ ((noreturn));
 794 int tar_timespec_cmp (struct timespec a, struct timespec b);
 795 const char *archive_format_string (enum archive_format fmt);
 796 const char *subcommand_string (enum subcommand c);
 797 void set_exit_status (int val);
 798
 799 void request_stdin (const char *option);
 800
 801 /* Where an option comes from: */
 802 enum option_source
 803   {
 804     OPTS_ENVIRON,        /* Environment variable TAR_OPTIONS */
 805     OPTS_COMMAND_LINE,   /* Command line */
 806     OPTS_FILE            /* File supplied by --files-from */
 807   };
 808
 809 /* Option location */
 810 struct option_locus
 811 {
 812   enum option_source source;  /* Option origin */
 813   char const *name;           /* File or variable name */
 814   size_t line;                /* Number of input line if source is OPTS_FILE */
 815   struct option_locus *prev;  /* Previous occurrence of the option of same
 816                                  class */
 817 };
 818
 819 void more_options (int argc, char **argv, struct option_locus *loc);
 820
 821 /* Module update.c.  */
 822
 823 extern char *output_start;
 824
 825 void update_archive (void);
 826
 827 /* Module attrs.c.  */
 828 #include "xattrs.h"
 829
 830 /* Module xheader.c.  */
 831
 832 void xheader_decode (struct tar_stat_info *stat);
 833 void xheader_decode_global (struct xheader *xhdr);
 834 void xheader_store (char const *keyword, struct tar_stat_info *st,
 835                     void const *data);
 836 void xheader_read (struct xheader *xhdr, union block *header, off_t size);
 837 void xheader_write (char type, char *name, time_t t, struct xheader *xhdr);
 838 void xheader_write_global (struct xheader *xhdr);
 839 void xheader_forbid_global (void);
 840 void xheader_finish (struct xheader *hdr);
 841 void xheader_destroy (struct xheader *hdr);
 842 char *xheader_xhdr_name (struct tar_stat_info *st);
 843 char *xheader_ghdr_name (void);
 844 void xheader_set_option (char *string);
 845 void xheader_string_begin (struct xheader *xhdr);
 846 void xheader_string_add (struct xheader *xhdr, char const *s);
 847 bool xheader_string_end (struct xheader *xhdr, char const *keyword);
 848 bool xheader_keyword_deleted_p (const char *kw);
 849 char *xheader_format_name (struct tar_stat_info *st, const char *fmt,
 850                            size_t n);
 851 void xheader_xattr_init (struct tar_stat_info *st);
 852 void xheader_xattr_free (struct xattr_array *vals, size_t sz);
 853 void xheader_xattr_copy (const struct tar_stat_info *st,
 854                          struct xattr_array **vals, size_t *sz);
 855 void xheader_xattr_add (struct tar_stat_info *st,
 856                         const char *key, const char *val, size_t len);
 857
 858 /* Module system.c */
 859
 860 void sys_detect_dev_null_output (void);
 861 void sys_save_archive_dev_ino (void);
 862 void sys_wait_for_child (pid_t, bool);
 863 void sys_spawn_shell (void);
 864 bool sys_compare_uid (struct stat *a, struct stat *b);
 865 bool sys_compare_gid (struct stat *a, struct stat *b);
 866 bool sys_file_is_archive (struct tar_stat_info *p);
 867 bool sys_compare_links (struct stat *link_data, struct stat *stat_data);
 868 int sys_truncate (int fd);
 869 pid_t sys_child_open_for_compress (void);
 870 pid_t sys_child_open_for_uncompress (void);
 871 size_t sys_write_archive_buffer (void);
 872 bool sys_get_archive_stat (void);
 873 int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st);
 874 void sys_wait_command (void);
 875 int sys_exec_info_script (const char **archive_name, int volume_number);
 876 void sys_exec_checkpoint_script (const char *script_name,
 877                                  const char *archive_name,
 878                                  int checkpoint_number);
 879
 880 /* Module compare.c */
 881 void report_difference (struct tar_stat_info *st, const char *message, ...)
 882   __attribute__ ((format (printf, 2, 3)));
 883
 884 /* Module sparse.c */
 885 bool sparse_member_p (struct tar_stat_info *st);
 886 bool sparse_fixup_header (struct tar_stat_info *st);
 887 enum dump_status sparse_dump_file (int, struct tar_stat_info *st);
 888 enum dump_status sparse_extract_file (int fd, struct tar_stat_info *st,
 889                                       off_t *size);
 890 enum dump_status sparse_skip_file (struct tar_stat_info *st);
 891 bool sparse_diff_file (int, struct tar_stat_info *st);
 892
 893 /* Module utf8.c */
 894 bool string_ascii_p (const char *str);
 895 bool utf8_convert (bool to_utf, char const *input, char **output);
 896
 897 /* Module transform.c */
 898 #define XFORM_REGFILE  0x01
 899 #define XFORM_LINK     0x02
 900 #define XFORM_SYMLINK  0x04
 901 #define XFORM_ALL      (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
 902
 903 void set_transform_expr (const char *expr);
 904 bool transform_name (char **pinput, int type);
 905 bool transform_name_fp (char **pinput, int type,
 906                         char *(*fun)(char *, void *), void *);
 907 bool transform_program_p (void);
 908
 909 /* Module suffix.c */
 910 void set_compression_program_by_suffix (const char *name, const char *defprog);
 911 char *strip_compression_suffix (const char *name);
 912
 913 /* Module checkpoint.c */
 914 void checkpoint_compile_action (const char *str);
 915 void checkpoint_finish_compile (void);
 916 void checkpoint_run (bool do_write);
 917 void checkpoint_finish (void);
 918 void checkpoint_flush_actions (void);
 919
 920 /* Module warning.c */
 921 #define WARN_ALONE_ZERO_BLOCK    0x00000001
 922 #define WARN_BAD_DUMPDIR         0x00000002
 923 #define WARN_CACHEDIR            0x00000004
 924 #define WARN_CONTIGUOUS_CAST     0x00000008
 925 #define WARN_FILE_CHANGED        0x00000010
 926 #define WARN_FILE_IGNORED        0x00000020
 927 #define WARN_FILE_REMOVED        0x00000040
 928 #define WARN_FILE_SHRANK         0x00000080
 929 #define WARN_FILE_UNCHANGED      0x00000100
 930 #define WARN_FILENAME_WITH_NULS  0x00000200
 931 #define WARN_IGNORE_ARCHIVE      0x00000400
 932 #define WARN_IGNORE_NEWER        0x00000800
 933 #define WARN_NEW_DIRECTORY       0x00001000
 934 #define WARN_RENAME_DIRECTORY    0x00002000
 935 #define WARN_SYMLINK_CAST        0x00004000
 936 #define WARN_TIMESTAMP           0x00008000
 937 #define WARN_UNKNOWN_CAST        0x00010000
 938 #define WARN_UNKNOWN_KEYWORD     0x00020000
 939 #define WARN_XDEV                0x00040000
 940 #define WARN_DECOMPRESS_PROGRAM  0x00080000
 941 #define WARN_EXISTING_FILE       0x00100000
 942 #define WARN_XATTR_WRITE         0x00200000
 943 #define WARN_RECORD_SIZE         0x00400000
 944 #define WARN_FAILED_READ         0x00800000
 945
 946 /* These warnings are enabled by default in verbose mode: */
 947 #define WARN_VERBOSE_WARNINGS    (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY|\
 948                                   WARN_DECOMPRESS_PROGRAM|WARN_EXISTING_FILE|\
 949                                   WARN_RECORD_SIZE)
 950 #define WARN_ALL                 (~WARN_VERBOSE_WARNINGS)
 951
 952 void set_warning_option (const char *arg);
 953
 954 extern int warning_option;
 955
 956 #define WARNING_ENABLED(opt) (warning_option & (opt))
 957
 958 #define WARNOPT(opt,args)                       \
 959   do                                            \
 960     {                                           \
 961       if (WARNING_ENABLED(opt)) WARN (args);    \
 962     }                                           \
 963   while (0)
 964
 965 /* Module unlink.c */
 966
 967 void queue_deferred_unlink (const char *name, bool is_dir);
 968 void finish_deferred_unlinks (void);
 969
 970 /* Module exit.c */
 971 extern void (*fatal_exit_hook) (void);
 972
 973 /* Module exclist.c */
 974 #define EXCL_DEFAULT       0x00
 975 #define EXCL_RECURSIVE     0x01
 976 #define EXCL_NON_RECURSIVE 0x02
 977
 978 void excfile_add (const char *name, int flags);
 979 void info_attach_exclist (struct tar_stat_info *dir);
 980 void info_free_exclist (struct tar_stat_info *dir);
 981 bool excluded_name (char const *name, struct tar_stat_info *st);
 982 void exclude_vcs_ignores (void);
 983
 984 /* Module map.c */
 985 void owner_map_read (char const *name);
 986 int owner_map_translate (uid_t uid, uid_t *new_uid, char const **new_name);
 987 void group_map_read (char const *file);
 988 int group_map_translate (gid_t gid, gid_t *new_gid, char const **new_name);
 989
 990
 991 _GL_INLINE_HEADER_END