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 Free Software Foundation, Inc.
   5
   6    This program is free software; you can redistribute it and/or modify it
   7    under the terms of the GNU General Public License as published by the
   8    Free Software Foundation; either version 2, or (at your option) any later
   9    version.
  10
  11    This program is distributed in the hope that it will be useful, but
  12    WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
  14    Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License along
  17    with this program; if not, write to the Free Software Foundation, Inc.,
  18    59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 /* Declare the GNU tar archive format.  */
  21 #include "tar.h"
  22
  23 /* The checksum field is filled with this while the checksum is computed.  */
  24 #define CHKBLANKS       "        "      /* 8 blanks, no null */
  25
  26 /* Some constants from POSIX are given names.  */
  27 #define NAME_FIELD_SIZE   100
  28 #define PREFIX_FIELD_SIZE 155
  29 #define UNAME_FIELD_SIZE   32
  30 #define GNAME_FIELD_SIZE   32
  31
  32 /* FIXME */
  33 #define MAXOCTAL11      017777777777L
  34 #define MAXOCTAL7       07777777
  35
  36
  37 \f
  38 /* Some various global definitions.  */
  39
  40 /* Name of file to use for interacting with user.  */
  41 #if MSDOS
  42 # define TTY_NAME "con"
  43 #else
  44 # define TTY_NAME "/dev/tty"
  45 #endif
  46
  47 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
  48    modules.  Here, we merely set it to "extern" if it is not already set.
  49    GNU tar does depend on the system loader to preset all GLOBAL variables to
  50    neutral (or zero) values, explicit initialization is usually not done.  */
  51 #ifndef GLOBAL
  52 # define GLOBAL extern
  53 #endif
  54
  55 /* Exit status for GNU tar.  Let's try to keep this list as simple as
  56    possible.  -d option strongly invites a status different for unequal
  57    comparison and other errors.  */
  58 GLOBAL int exit_status;
  59
  60 #define TAREXIT_SUCCESS 0
  61 #define TAREXIT_DIFFERS 1
  62 #define TAREXIT_FAILURE 2
  63
  64 /* Both WARN and ERROR write a message on stderr and continue processing,
  65    however ERROR manages so tar will exit unsuccessfully.  FATAL_ERROR
  66    writes a message on stderr and aborts immediately, with another message
  67    line telling so.  USAGE_ERROR works like FATAL_ERROR except that the
  68    other message line suggests trying --help.  All four macros accept a
  69    single argument of the form ((0, errno, _("FORMAT"), Args...)).  errno
  70    is zero when the error is not being detected by the system.  */
  71
  72 #define WARN(Args) \
  73   error Args
  74 #define ERROR(Args) \
  75   (error Args, exit_status = TAREXIT_FAILURE)
  76 #define FATAL_ERROR(Args) \
  77   (error Args, fatal_exit ())
  78 #define USAGE_ERROR(Args) \
  79   (error Args, usage (TAREXIT_FAILURE))
  80 \f
  81 #include "arith.h"
  82 #include <backupfile.h>
  83 #include <exclude.h>
  84 #include <full-write.h>
  85 #include <modechange.h>
  86 #include <quote.h>
  87 #include <safe-read.h>
  88
  89 /* Log base 2 of common values.  */
  90 #define LG_8 3
  91 #define LG_64 6
  92 #define LG_256 8
  93 \f
  94 /* Information gleaned from the command line.  */
  95
  96 /* Name of this program.  */
  97 GLOBAL const char *program_name;
  98
  99 /* Main command option.  */
 100
 101 enum subcommand
 102 {
 103   UNKNOWN_SUBCOMMAND,           /* none of the following */
 104   APPEND_SUBCOMMAND,            /* -r */
 105   CAT_SUBCOMMAND,               /* -A */
 106   CREATE_SUBCOMMAND,            /* -c */
 107   DELETE_SUBCOMMAND,            /* -D */
 108   DIFF_SUBCOMMAND,              /* -d */
 109   EXTRACT_SUBCOMMAND,           /* -x */
 110   LIST_SUBCOMMAND,              /* -t */
 111   UPDATE_SUBCOMMAND             /* -u */
 112 };
 113
 114 GLOBAL enum subcommand subcommand_option;
 115
 116 /* Selected format for output archive.  */
 117 GLOBAL enum archive_format archive_format;
 118
 119 /* Either NL or NUL, as decided by the --null option.  */
 120 GLOBAL char filename_terminator;
 121
 122 /* Size of each record, once in blocks, once in bytes.  Those two variables
 123    are always related, the second being BLOCKSIZE times the first.  They do
 124    not have _option in their name, even if their values is derived from
 125    option decoding, as these are especially important in tar.  */
 126 GLOBAL int blocking_factor;
 127 GLOBAL size_t record_size;
 128
 129 GLOBAL bool absolute_names_option;
 130
 131 /* This variable tells how to interpret newer_mtime_option, below.  If zero,
 132    files get archived if their mtime is not less than newer_mtime_option.
 133    If nonzero, files get archived if *either* their ctime or mtime is not less
 134    than newer_mtime_option.  */
 135 GLOBAL int after_date_option;
 136
 137 GLOBAL bool atime_preserve_option;
 138
 139 GLOBAL bool backup_option;
 140
 141 /* Type of backups being made.  */
 142 GLOBAL enum backup_type backup_type;
 143
 144 GLOBAL bool block_number_option;
 145
 146 GLOBAL bool checkpoint_option;
 147
 148 /* Specified name of compression program, or "gzip" as implied by -z.  */
 149 GLOBAL const char *use_compress_program_option;
 150
 151 GLOBAL bool dereference_option;
 152
 153 /* Print a message if not all links are dumped */
 154 GLOBAL int check_links_option;
 155
 156 /* Patterns that match file names to be excluded.  */
 157 GLOBAL struct exclude *excluded;
 158
 159 /* Specified file containing names to work on.  */
 160 GLOBAL const char *files_from_option;
 161
 162 GLOBAL bool force_local_option;
 163
 164 /* Specified value to be put into tar file in place of stat () results, or
 165    just -1 if such an override should not take place.  */
 166 GLOBAL gid_t group_option;
 167
 168 GLOBAL bool ignore_failed_read_option;
 169
 170 GLOBAL bool ignore_zeros_option;
 171
 172 GLOBAL bool incremental_option;
 173
 174 /* Specified name of script to run at end of each tape change.  */
 175 GLOBAL const char *info_script_option;
 176
 177 GLOBAL bool interactive_option;
 178
 179 enum old_files
 180 {
 181   DEFAULT_OLD_FILES, /* default */
 182   NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */
 183   OVERWRITE_OLD_FILES, /* --overwrite */
 184   UNLINK_FIRST_OLD_FILES, /* --unlink-first */
 185   KEEP_OLD_FILES /* --keep-old-files */
 186 };
 187 GLOBAL enum old_files old_files_option;
 188
 189 /* Specified file name for incremental list.  */
 190 GLOBAL const char *listed_incremental_option;
 191
 192 /* Specified mode change string.  */
 193 GLOBAL struct mode_change *mode_option;
 194
 195 GLOBAL bool multi_volume_option;
 196
 197 /* The same variable hold the time, whether mtime or ctime.  Just fake a
 198    non-existing option, for making the code clearer, elsewhere.  */
 199 #define newer_ctime_option newer_mtime_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 time_t newer_mtime_option;
 204
 205 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR.  */
 206 GLOBAL int recursion_option;
 207
 208 GLOBAL bool numeric_owner_option;
 209
 210 GLOBAL bool one_file_system_option;
 211
 212 /* Specified value to be put into tar file in place of stat () results, or
 213    just -1 if such an override should not take place.  */
 214 GLOBAL uid_t owner_option;
 215
 216 GLOBAL bool recursive_unlink_option;
 217
 218 GLOBAL bool read_full_records_option;
 219
 220 GLOBAL bool remove_files_option;
 221
 222 /* Specified remote shell command.  */
 223 GLOBAL const char *rsh_command_option;
 224
 225 GLOBAL bool same_order_option;
 226
 227 /* If positive, preserve ownership when extracting.  */
 228 GLOBAL int same_owner_option;
 229
 230 /* If positive, preserve permissions when extracting.  */
 231 GLOBAL int same_permissions_option;
 232
 233 /* When set, strip the given number of path elements from the file name
 234    before extracting */
 235 GLOBAL size_t strip_path_elements;
 236
 237 GLOBAL bool show_omitted_dirs_option;
 238
 239 GLOBAL bool sparse_option;
 240
 241 GLOBAL bool starting_file_option;
 242
 243 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 244 GLOBAL tarlong tape_length_option;
 245
 246 GLOBAL bool to_stdout_option;
 247
 248 GLOBAL bool totals_option;
 249
 250 GLOBAL bool touch_option;
 251
 252 /* Count how many times the option has been set, multiple setting yields
 253    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 254    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 255 GLOBAL int verbose_option;
 256
 257 GLOBAL bool verify_option;
 258
 259 /* Specified name of file containing the volume number.  */
 260 GLOBAL const char *volno_file_option;
 261
 262 /* Specified value or pattern.  */
 263 GLOBAL const char *volume_label_option;
 264 \f
 265 /* Other global variables.  */
 266
 267 /* File descriptor for archive file.  */
 268 GLOBAL int archive;
 269
 270 /* Nonzero when outputting to /dev/null.  */
 271 GLOBAL bool dev_null_output;
 272
 273 /* Timestamp for when we started execution.  */
 274 #if HAVE_CLOCK_GETTIME
 275   GLOBAL struct timespec start_timespec;
 276 # define start_time (start_timespec.tv_sec)
 277 #else
 278   GLOBAL time_t start_time;
 279 #endif
 280
 281 GLOBAL struct tar_stat_info current_stat_info;
 282
 283 /* List of tape drive names, number of such tape drives, allocated number,
 284    and current cursor in list.  */
 285 GLOBAL const char **archive_name_array;
 286 GLOBAL int archive_names;
 287 GLOBAL int allocated_archive_names;
 288 GLOBAL const char **archive_name_cursor;
 289
 290 /* Output index file name.  */
 291 GLOBAL char const *index_file_name;
 292
 293 /* Structure for keeping track of filenames and lists thereof.  */
 294 struct name
 295   {
 296     struct name *next;
 297     size_t length;              /* cached strlen(name) */
 298     char found;                 /* a matching file has been found */
 299     char firstch;               /* first char is literally matched */
 300     char regexp;                /* this name is a regexp, not literal */
 301     int change_dir;             /* set with the -C option */
 302     char const *dir_contents;   /* for incremental_option */
 303     char fake;                  /* dummy entry */
 304     char name[1];
 305   };
 306
 307 /* Information about a sparse file.  */
 308 struct sp_array
 309   {
 310     off_t offset;
 311     size_t numbytes;
 312   };
 313 GLOBAL struct sp_array *sparsearray;
 314
 315 /* Number of elements in sparsearray.  */
 316 GLOBAL int sp_array_size;
 317 \f
 318 /* Declarations for each module.  */
 319
 320 /* FIXME: compare.c should not directly handle the following variable,
 321    instead, this should be done in buffer.c only.  */
 322
 323 enum access_mode
 324 {
 325   ACCESS_READ,
 326   ACCESS_WRITE,
 327   ACCESS_UPDATE
 328 };
 329 extern enum access_mode access_mode;
 330
 331 /* Module buffer.c.  */
 332
 333 extern FILE *stdlis;
 334 extern char *save_name;
 335 extern off_t save_sizeleft;
 336 extern off_t save_totsize;
 337 extern bool write_archive_to_stdout;
 338
 339 size_t available_space_after (union block *);
 340 off_t current_block_ordinal (void);
 341 void close_archive (void);
 342 void closeout_volume_number (void);
 343 union block *find_next_block (void);
 344 void flush_read (void);
 345 void flush_write (void);
 346 void flush_archive (void);
 347 void init_volume_number (void);
 348 void open_archive (enum access_mode);
 349 void print_total_written (void);
 350 void reset_eof (void);
 351 void set_next_block_after (union block *);
 352
 353 /* Module create.c.  */
 354
 355 void create_archive (void);
 356 void dump_file (char *, int, dev_t);
 357 void finish_header (union block *, off_t);
 358 void init_sparsearray (void);
 359 void write_eot (void);
 360 void check_links (void);
 361
 362 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 363 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 364 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
 365 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
 366 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 367 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
 368 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 369 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
 370 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
 371 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 372 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 373
 374 void gid_to_chars (gid_t, char *, size_t);
 375 void major_to_chars (major_t, char *, size_t);
 376 void minor_to_chars (minor_t, char *, size_t);
 377 void mode_to_chars (mode_t, char *, size_t);
 378 void off_to_chars (off_t, char *, size_t);
 379 void size_to_chars (size_t, char *, size_t);
 380 void time_to_chars (time_t, char *, size_t);
 381 void uid_to_chars (uid_t, char *, size_t);
 382 void uintmax_to_chars (uintmax_t, char *, size_t);
 383 void string_to_chars (char *, char *, size_t);
 384
 385 /* Module diffarch.c.  */
 386
 387 extern bool now_verifying;
 388
 389 void diff_archive (void);
 390 void diff_init (void);
 391 void verify_volume (void);
 392
 393 /* Module extract.c.  */
 394
 395 extern bool we_are_root;
 396 void extr_init (void);
 397 bool fill_in_sparse_array (void);
 398 void extract_archive (void);
 399 void extract_finish (void);
 400 void fatal_exit (void) __attribute__ ((noreturn));
 401
 402 /* Module delete.c.  */
 403
 404 void delete_archive_members (void);
 405
 406 /* Module incremen.c.  */
 407
 408 char *get_directory_contents (char *, dev_t);
 409 void read_directory_file (void);
 410 void write_directory_file (void);
 411 void gnu_restore (char const *);
 412
 413 /* Module list.c.  */
 414
 415 enum read_header
 416 {
 417   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 418   HEADER_SUCCESS,               /* header successfully read and checksummed */
 419   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 420   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 421   HEADER_END_OF_FILE,           /* true end of file while header expected */
 422   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 423 };
 424
 425 struct xheader
 426 {
 427   struct obstack *stk;
 428   size_t size;
 429   char *buffer;
 430 };
 431
 432 GLOBAL struct xheader extended_header;
 433 extern union block *current_header;
 434 extern enum archive_format current_format;
 435 extern size_t recent_long_name_blocks;
 436 extern size_t recent_long_link_blocks;
 437
 438 void decode_header (union block *, struct tar_stat_info *,
 439                     enum archive_format *, int);
 440 #define STRINGIFY_BIGINT(i, b) \
 441   stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
 442 char *stringify_uintmax_t_backwards (uintmax_t, char *);
 443 char const *tartime (time_t);
 444
 445 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
 446 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
 447 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
 448 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
 449 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 450 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
 451 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
 452 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
 453 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 454
 455 gid_t gid_from_header (const char *, size_t);
 456 major_t major_from_header (const char *, size_t);
 457 minor_t minor_from_header (const char *, size_t);
 458 mode_t mode_from_header (const char *, size_t);
 459 off_t off_from_header (const char *, size_t);
 460 size_t size_from_header (const char *, size_t);
 461 time_t time_from_header (const char *, size_t);
 462 uid_t uid_from_header (const char *, size_t);
 463 uintmax_t uintmax_from_header (const char *, size_t);
 464
 465 void list_archive (void);
 466 void print_for_mkdir (char *, int, mode_t);
 467 void print_header (off_t);
 468 void read_and (void (*) (void));
 469 enum read_header read_header (bool);
 470 void skip_file (off_t);
 471 void skip_member (void);
 472
 473 /* Module mangle.c.  */
 474
 475 void extract_mangle (void);
 476
 477 /* Module misc.c.  */
 478
 479 void assign_string (char **, const char *);
 480 char *quote_copy_string (const char *);
 481 int unquote_string (char *);
 482
 483 size_t dot_dot_prefix_len (char const *);
 484
 485 enum remove_option
 486 {
 487   ORDINARY_REMOVE_OPTION,
 488   RECURSIVE_REMOVE_OPTION,
 489   WANT_DIRECTORY_REMOVE_OPTION
 490 };
 491 int remove_any_file (const char *, enum remove_option);
 492 int maybe_backup_file (const char *, int);
 493 void undo_last_backup (void);
 494
 495 int deref_stat (bool, char const *, struct stat *);
 496
 497 int chdir_arg (char const *);
 498 void chdir_do (int);
 499
 500 void decode_mode (mode_t, char *);
 501
 502 void chdir_fatal (char const *) __attribute__ ((noreturn));
 503 void chmod_error_details (char const *, mode_t);
 504 void chown_error_details (char const *, uid_t, gid_t);
 505 void close_error (char const *);
 506 void close_warn (char const *);
 507 void exec_fatal (char const *) __attribute__ ((noreturn));
 508 void link_error (char const *, char const *);
 509 void mkdir_error (char const *);
 510 void mkfifo_error (char const *);
 511 void mknod_error (char const *);
 512 void open_error (char const *);
 513 void open_fatal (char const *) __attribute__ ((noreturn));
 514 void open_warn (char const *);
 515 void read_error (char const *);
 516 void read_error_details (char const *, off_t, size_t);
 517 void read_fatal (char const *) __attribute__ ((noreturn));
 518 void read_fatal_details (char const *, off_t, size_t);
 519 void read_warn_details (char const *, off_t, size_t);
 520 void readlink_error (char const *);
 521 void readlink_warn (char const *);
 522 void savedir_error (char const *);
 523 void savedir_warn (char const *);
 524 void seek_error (char const *);
 525 void seek_error_details (char const *, off_t);
 526 void seek_warn (char const *);
 527 void seek_warn_details (char const *, off_t);
 528 void stat_error (char const *);
 529 void stat_warn (char const *);
 530 void symlink_error (char const *, char const *);
 531 void truncate_error (char const *);
 532 void truncate_warn (char const *);
 533 void unlink_error (char const *);
 534 void utime_error (char const *);
 535 void waitpid_error (char const *);
 536 void write_error (char const *);
 537 void write_error_details (char const *, ssize_t, size_t);
 538 void write_fatal (char const *) __attribute__ ((noreturn));
 539 void write_fatal_details (char const *, ssize_t, size_t)
 540      __attribute__ ((noreturn));
 541
 542 pid_t xfork (void);
 543 void xpipe (int[2]);
 544
 545 /* Module names.c.  */
 546
 547 extern struct name *gnu_list_name;
 548
 549 void gid_to_gname (gid_t, char **gname);
 550 int gname_to_gid (char *gname, gid_t *);
 551 void uid_to_uname (uid_t, char **uname);
 552 int uname_to_uid (char *uname, uid_t *);
 553
 554 void init_names (void);
 555 void name_add (const char *);
 556 void name_init (int, char *const *);
 557 void name_term (void);
 558 char *name_next (int);
 559 void name_close (void);
 560 void name_gather (void);
 561 struct name *addname (char const *, int);
 562 int name_match (const char *);
 563 void names_notfound (void);
 564 void collect_and_sort_names (void);
 565 struct name *name_scan (const char *);
 566 char *name_from_list (void);
 567 void blank_name_list (void);
 568 char *new_name (const char *, const char *);
 569 char *safer_name_suffix (char const *, bool);
 570 size_t stripped_path_len (char const *file_name, size_t num);
 571
 572 bool excluded_name (char const *);
 573
 574 void add_avoided_name (char const *);
 575 bool is_avoided_name (char const *);
 576
 577 bool contains_dot_dot (char const *);
 578
 579 /* Module tar.c.  */
 580
 581 int confirm (const char *, const char *);
 582 void request_stdin (const char *);
 583 void destroy_stat (struct tar_stat_info *);
 584
 585 /* Module update.c.  */
 586
 587 extern char *output_start;
 588
 589 void update_archive (void);
 590
 591 /* Module xheader.c.  */
 592
 593 void xheader_decode (struct tar_stat_info *);
 594 void xheader_store (char const *, struct tar_stat_info const *);
 595 void xheader_read (union block *, size_t);
 596 void xheader_finish (struct xheader *);
 597 void xheader_destroy (struct xheader *);