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