src/common.h

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