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 GLOBAL bool show_omitted_dirs_option;
 234
 235 GLOBAL bool sparse_option;
 236
 237 GLOBAL bool starting_file_option;
 238
 239 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 240 GLOBAL tarlong tape_length_option;
 241
 242 GLOBAL bool to_stdout_option;
 243
 244 GLOBAL bool totals_option;
 245
 246 GLOBAL bool touch_option;
 247
 248 /* Count how many times the option has been set, multiple setting yields
 249    more verbose behavior.  Value 0 means no verbosity, 1 means file name
 250    only, 2 means file name and all attributes.  More than 2 is just like 2.  */
 251 GLOBAL int verbose_option;
 252
 253 GLOBAL bool verify_option;
 254
 255 /* Specified name of file containing the volume number.  */
 256 GLOBAL const char *volno_file_option;
 257
 258 /* Specified value or pattern.  */
 259 GLOBAL const char *volume_label_option;
 260 \f
 261 /* Other global variables.  */
 262
 263 /* File descriptor for archive file.  */
 264 GLOBAL int archive;
 265
 266 /* Nonzero when outputting to /dev/null.  */
 267 GLOBAL bool dev_null_output;
 268
 269 /* Timestamp for when we started execution.  */
 270 #if HAVE_CLOCK_GETTIME
 271   GLOBAL struct timespec start_timespec;
 272 # define start_time (start_timespec.tv_sec)
 273 #else
 274   GLOBAL time_t start_time;
 275 #endif
 276
 277 GLOBAL struct tar_stat_info current_stat_info;
 278
 279 /* List of tape drive names, number of such tape drives, allocated number,
 280    and current cursor in list.  */
 281 GLOBAL const char **archive_name_array;
 282 GLOBAL int archive_names;
 283 GLOBAL int allocated_archive_names;
 284 GLOBAL const char **archive_name_cursor;
 285
 286 /* Output index file name.  */
 287 GLOBAL char const *index_file_name;
 288
 289 /* Structure for keeping track of filenames and lists thereof.  */
 290 struct name
 291   {
 292     struct name *next;
 293     size_t length;              /* cached strlen(name) */
 294     char found;                 /* a matching file has been found */
 295     char firstch;               /* first char is literally matched */
 296     char regexp;                /* this name is a regexp, not literal */
 297     int change_dir;             /* set with the -C option */
 298     char const *dir_contents;   /* for incremental_option */
 299     char fake;                  /* dummy entry */
 300     char name[1];
 301   };
 302
 303 /* Information about a sparse file.  */
 304 struct sp_array
 305   {
 306     off_t offset;
 307     size_t numbytes;
 308   };
 309 GLOBAL struct sp_array *sparsearray;
 310
 311 /* Number of elements in sparsearray.  */
 312 GLOBAL int sp_array_size;
 313 \f
 314 /* Declarations for each module.  */
 315
 316 /* FIXME: compare.c should not directly handle the following variable,
 317    instead, this should be done in buffer.c only.  */
 318
 319 enum access_mode
 320 {
 321   ACCESS_READ,
 322   ACCESS_WRITE,
 323   ACCESS_UPDATE
 324 };
 325 extern enum access_mode access_mode;
 326
 327 /* Module buffer.c.  */
 328
 329 extern FILE *stdlis;
 330 extern char *save_name;
 331 extern off_t save_sizeleft;
 332 extern off_t save_totsize;
 333 extern bool write_archive_to_stdout;
 334
 335 size_t available_space_after (union block *);
 336 off_t current_block_ordinal (void);
 337 void close_archive (void);
 338 void closeout_volume_number (void);
 339 union block *find_next_block (void);
 340 void flush_read (void);
 341 void flush_write (void);
 342 void flush_archive (void);
 343 void init_volume_number (void);
 344 void open_archive (enum access_mode);
 345 void print_total_written (void);
 346 void reset_eof (void);
 347 void set_next_block_after (union block *);
 348
 349 /* Module create.c.  */
 350
 351 void create_archive (void);
 352 void dump_file (char *, int, dev_t);
 353 void finish_header (union block *, off_t);
 354 void init_sparsearray (void);
 355 void write_eot (void);
 356 void check_links (void);
 357
 358 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 359 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 360 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
 361 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
 362 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
 363 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
 364 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
 365 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
 366 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
 367 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 368 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
 369
 370 void gid_to_chars (gid_t, char *, size_t);
 371 void major_to_chars (major_t, char *, size_t);
 372 void minor_to_chars (minor_t, char *, size_t);
 373 void mode_to_chars (mode_t, char *, size_t);
 374 void off_to_chars (off_t, char *, size_t);
 375 void size_to_chars (size_t, char *, size_t);
 376 void time_to_chars (time_t, char *, size_t);
 377 void uid_to_chars (uid_t, char *, size_t);
 378 void uintmax_to_chars (uintmax_t, char *, size_t);
 379 void string_to_chars (char *, char *, size_t);
 380
 381 /* Module diffarch.c.  */
 382
 383 extern bool now_verifying;
 384
 385 void diff_archive (void);
 386 void diff_init (void);
 387 void verify_volume (void);
 388
 389 /* Module extract.c.  */
 390
 391 extern bool we_are_root;
 392 void extr_init (void);
 393 bool fill_in_sparse_array (void);
 394 void extract_archive (void);
 395 void extract_finish (void);
 396 void fatal_exit (void) __attribute__ ((noreturn));
 397
 398 /* Module delete.c.  */
 399
 400 void delete_archive_members (void);
 401
 402 /* Module incremen.c.  */
 403
 404 char *get_directory_contents (char *, dev_t);
 405 void read_directory_file (void);
 406 void write_directory_file (void);
 407 void gnu_restore (char const *);
 408
 409 /* Module list.c.  */
 410
 411 enum read_header
 412 {
 413   HEADER_STILL_UNREAD,          /* for when read_header has not been called */
 414   HEADER_SUCCESS,               /* header successfully read and checksummed */
 415   HEADER_SUCCESS_EXTENDED,      /* likewise, but we got an extended header */
 416   HEADER_ZERO_BLOCK,            /* zero block where header expected */
 417   HEADER_END_OF_FILE,           /* true end of file while header expected */
 418   HEADER_FAILURE                /* ill-formed header, or bad checksum */
 419 };
 420
 421 struct xheader
 422 {
 423   struct obstack *stk;
 424   size_t size;
 425   char *buffer;
 426 };
 427
 428 GLOBAL struct xheader extended_header;
 429 extern union block *current_header;
 430 extern enum archive_format current_format;
 431 extern size_t recent_long_name_blocks;
 432 extern size_t recent_long_link_blocks;
 433
 434 void decode_header (union block *, struct tar_stat_info *,
 435                     enum archive_format *, int);
 436 #define STRINGIFY_BIGINT(i, b) \
 437   stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
 438 char *stringify_uintmax_t_backwards (uintmax_t, char *);
 439 char const *tartime (time_t);
 440
 441 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
 442 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
 443 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
 444 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
 445 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
 446 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
 447 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
 448 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
 449 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
 450
 451 gid_t gid_from_header (const char *, size_t);
 452 major_t major_from_header (const char *, size_t);
 453 minor_t minor_from_header (const char *, size_t);
 454 mode_t mode_from_header (const char *, size_t);
 455 off_t off_from_header (const char *, size_t);
 456 size_t size_from_header (const char *, size_t);
 457 time_t time_from_header (const char *, size_t);
 458 uid_t uid_from_header (const char *, size_t);
 459 uintmax_t uintmax_from_header (const char *, size_t);
 460
 461 void list_archive (void);
 462 void print_for_mkdir (char *, int, mode_t);
 463 void print_header (off_t);
 464 void read_and (void (*) (void));
 465 enum read_header read_header (bool);
 466 void skip_file (off_t);
 467 void skip_member (void);
 468
 469 /* Module mangle.c.  */
 470
 471 void extract_mangle (void);
 472
 473 /* Module misc.c.  */
 474
 475 void assign_string (char **, const char *);
 476 char *quote_copy_string (const char *);
 477 int unquote_string (char *);
 478
 479 size_t dot_dot_prefix_len (char const *);
 480
 481 enum remove_option
 482 {
 483   ORDINARY_REMOVE_OPTION,
 484   RECURSIVE_REMOVE_OPTION,
 485   WANT_DIRECTORY_REMOVE_OPTION
 486 };
 487 int remove_any_file (const char *, enum remove_option);
 488 int maybe_backup_file (const char *, int);
 489 void undo_last_backup (void);
 490
 491 int deref_stat (bool, char const *, struct stat *);
 492
 493 int chdir_arg (char const *);
 494 void chdir_do (int);
 495
 496 void decode_mode (mode_t, char *);
 497
 498 void chdir_fatal (char const *) __attribute__ ((noreturn));
 499 void chmod_error_details (char const *, mode_t);
 500 void chown_error_details (char const *, uid_t, gid_t);
 501 void close_error (char const *);
 502 void close_warn (char const *);
 503 void exec_fatal (char const *) __attribute__ ((noreturn));
 504 void link_error (char const *, char const *);
 505 void mkdir_error (char const *);
 506 void mkfifo_error (char const *);
 507 void mknod_error (char const *);
 508 void open_error (char const *);
 509 void open_fatal (char const *) __attribute__ ((noreturn));
 510 void open_warn (char const *);
 511 void read_error (char const *);
 512 void read_error_details (char const *, off_t, size_t);
 513 void read_fatal (char const *) __attribute__ ((noreturn));
 514 void read_fatal_details (char const *, off_t, size_t);
 515 void read_warn_details (char const *, off_t, size_t);
 516 void readlink_error (char const *);
 517 void readlink_warn (char const *);
 518 void savedir_error (char const *);
 519 void savedir_warn (char const *);
 520 void seek_error (char const *);
 521 void seek_error_details (char const *, off_t);
 522 void seek_warn (char const *);
 523 void seek_warn_details (char const *, off_t);
 524 void stat_error (char const *);
 525 void stat_warn (char const *);
 526 void symlink_error (char const *, char const *);
 527 void truncate_error (char const *);
 528 void truncate_warn (char const *);
 529 void unlink_error (char const *);
 530 void utime_error (char const *);
 531 void waitpid_error (char const *);
 532 void write_error (char const *);
 533 void write_error_details (char const *, ssize_t, size_t);
 534 void write_fatal (char const *) __attribute__ ((noreturn));
 535 void write_fatal_details (char const *, ssize_t, size_t)
 536      __attribute__ ((noreturn));
 537
 538 pid_t xfork (void);
 539 void xpipe (int[2]);
 540
 541 /* Module names.c.  */
 542
 543 extern struct name *gnu_list_name;
 544
 545 void gid_to_gname (gid_t, char **gname);
 546 int gname_to_gid (char *gname, gid_t *);
 547 void uid_to_uname (uid_t, char **uname);
 548 int uname_to_uid (char *uname, uid_t *);
 549
 550 void init_names (void);
 551 void name_add (const char *);
 552 void name_init (int, char *const *);
 553 void name_term (void);
 554 char *name_next (int);
 555 void name_close (void);
 556 void name_gather (void);
 557 struct name *addname (char const *, int);
 558 int name_match (const char *);
 559 void names_notfound (void);
 560 void collect_and_sort_names (void);
 561 struct name *name_scan (const char *);
 562 char *name_from_list (void);
 563 void blank_name_list (void);
 564 char *new_name (const char *, const char *);
 565 char *safer_name_suffix (char const *, bool);
 566
 567 bool excluded_name (char const *);
 568
 569 void add_avoided_name (char const *);
 570 bool is_avoided_name (char const *);
 571
 572 bool contains_dot_dot (char const *);
 573
 574 /* Module tar.c.  */
 575
 576 int confirm (const char *, const char *);
 577 void request_stdin (const char *);
 578 void destroy_stat (struct tar_stat_info *);
 579
 580 /* Module update.c.  */
 581
 582 extern char *output_start;
 583
 584 void update_archive (void);
 585
 586 /* Module xheader.c.  */
 587
 588 void xheader_decode (struct tar_stat_info *);
 589 void xheader_store (char const *, struct tar_stat_info const *);
 590 void xheader_read (union block *, size_t);
 591 void xheader_finish (struct xheader *);
 592 void xheader_destroy (struct xheader *);