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