1 /* Common declarations for the tar program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
4 2003, 2004 Free Software Foundation, Inc.
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
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.
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. */
20 /* Declare the GNU tar archive format. */
23 /* The checksum field is filled with this while the checksum is computed. */
24 #define CHKBLANKS " " /* 8 blanks, no null */
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
33 #define MAXOCTAL11 017777777777L
34 #define MAXOCTAL7 07777777
38 /* Some various global definitions. */
40 /* Name of file to use for interacting with user. */
42 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
43 modules. Here, we merely set it to "extern" if it is not already set.
44 GNU tar does depend on the system loader to preset all GLOBAL variables to
45 neutral (or zero) values, explicit initialization is usually not done. */
47 # define GLOBAL extern
50 /* Exit status for GNU tar. Let's try to keep this list as simple as
51 possible. -d option strongly invites a status different for unequal
52 comparison and other errors. */
53 GLOBAL
int exit_status
;
55 #define TAREXIT_SUCCESS 0
56 #define TAREXIT_DIFFERS 1
57 #define TAREXIT_FAILURE 2
59 /* Both WARN and ERROR write a message on stderr and continue processing,
60 however ERROR manages so tar will exit unsuccessfully. FATAL_ERROR
61 writes a message on stderr and aborts immediately, with another message
62 line telling so. USAGE_ERROR works like FATAL_ERROR except that the
63 other message line suggests trying --help. All four macros accept a
64 single argument of the form ((0, errno, _("FORMAT"), Args...)). errno
65 is zero when the error is not being detected by the system. */
70 (error Args, exit_status = TAREXIT_FAILURE)
71 #define FATAL_ERROR(Args) \
72 (error Args, fatal_exit ())
73 #define USAGE_ERROR(Args) \
74 (error Args, usage (TAREXIT_FAILURE))
77 #include <backupfile.h>
79 #include <full-write.h>
80 #include <modechange.h>
82 #include <safe-read.h>
85 /* Log base 2 of common values. */
90 /* Information gleaned from the command line. */
92 /* Name of this program. */
93 GLOBAL
const char *program_name
;
95 /* Main command option. */
99 UNKNOWN_SUBCOMMAND
, /* none of the following */
100 APPEND_SUBCOMMAND
, /* -r */
101 CAT_SUBCOMMAND
, /* -A */
102 CREATE_SUBCOMMAND
, /* -c */
103 DELETE_SUBCOMMAND
, /* -D */
104 DIFF_SUBCOMMAND
, /* -d */
105 EXTRACT_SUBCOMMAND
, /* -x */
106 LIST_SUBCOMMAND
, /* -t */
107 UPDATE_SUBCOMMAND
/* -u */
110 GLOBAL
enum subcommand subcommand_option
;
112 /* Selected format for output archive. */
113 GLOBAL
enum archive_format archive_format
;
115 /* Either NL or NUL, as decided by the --null option. */
116 GLOBAL
char filename_terminator
;
118 /* Size of each record, once in blocks, once in bytes. Those two variables
119 are always related, the second being BLOCKSIZE times the first. They do
120 not have _option in their name, even if their values is derived from
121 option decoding, as these are especially important in tar. */
122 GLOBAL
int blocking_factor
;
123 GLOBAL
size_t record_size
;
125 GLOBAL
bool absolute_names_option
;
127 /* Display file times in UTC */
128 GLOBAL
bool utc_option
;
130 /* This variable tells how to interpret newer_mtime_option, below. If zero,
131 files get archived if their mtime is not less than newer_mtime_option.
132 If nonzero, files get archived if *either* their ctime or mtime is not less
133 than newer_mtime_option. */
134 GLOBAL
int after_date_option
;
136 GLOBAL
bool atime_preserve_option
;
138 GLOBAL
bool backup_option
;
140 /* Type of backups being made. */
141 GLOBAL
enum backup_type backup_type
;
143 GLOBAL
bool block_number_option
;
145 GLOBAL
bool checkpoint_option
;
147 /* Specified name of compression program, or "gzip" as implied by -z. */
148 GLOBAL
const char *use_compress_program_option
;
150 GLOBAL
bool dereference_option
;
152 /* Print a message if not all links are dumped */
153 GLOBAL
int check_links_option
;
155 /* Patterns that match file names to be excluded. */
156 GLOBAL
struct exclude
*excluded
;
158 /* Specified file containing names to work on. */
159 GLOBAL
const char *files_from_option
;
161 /* Specified value to be put into tar file in place of stat () results, or
162 just -1 if such an override should not take place. */
163 GLOBAL gid_t group_option
;
165 GLOBAL
bool ignore_failed_read_option
;
167 GLOBAL
bool ignore_zeros_option
;
169 GLOBAL
bool incremental_option
;
171 /* Specified name of script to run at end of each tape change. */
172 GLOBAL
const char *info_script_option
;
174 GLOBAL
bool interactive_option
;
176 /* If nonzero, extract only Nth occurrence of each named file */
177 GLOBAL
uintmax_t occurrence_option
;
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 KEEP_NEWER_FILES
/* --keep-newer-files */
188 GLOBAL
enum old_files old_files_option
;
190 /* Specified file name for incremental list. */
191 GLOBAL
const char *listed_incremental_option
;
193 /* Specified mode change string. */
194 GLOBAL
struct mode_change
*mode_option
;
196 GLOBAL
bool multi_volume_option
;
198 /* The same variable holds the time, whether mtime or ctime. Just fake a
199 non-existing option, for making the code clearer, elsewhere. */
200 #define newer_ctime_option newer_mtime_option
202 /* Specified threshold date and time. Files having an older time stamp
203 do not get archived (also see after_date_option above). */
204 GLOBAL
struct timespec newer_mtime_option
;
206 /* Return true if newer_mtime_option is initialized. */
207 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
209 /* Return true if the struct stat ST's M time is less than
210 newer_mtime_option. */
211 #define OLDER_STAT_TIME(st, m) \
212 ((st).st_##m##time < newer_mtime_option.tv_sec \
213 || ((st).st_##m##time == newer_mtime_option.tv_sec \
214 && TIMESPEC_NS ((st).st_##m##tim) < newer_mtime_option.tv_nsec))
216 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
217 GLOBAL
int recursion_option
;
219 GLOBAL
bool numeric_owner_option
;
221 GLOBAL
bool one_file_system_option
;
223 /* Specified value to be put into tar file in place of stat () results, or
224 just -1 if such an override should not take place. */
225 GLOBAL uid_t owner_option
;
227 GLOBAL
bool recursive_unlink_option
;
229 GLOBAL
bool read_full_records_option
;
231 GLOBAL
bool remove_files_option
;
233 /* Specified rmt command. */
234 GLOBAL
const char *rmt_command_option
;
236 /* Specified remote shell command. */
237 GLOBAL
const char *rsh_command_option
;
239 GLOBAL
bool same_order_option
;
241 /* If positive, preserve ownership when extracting. */
242 GLOBAL
int same_owner_option
;
244 /* If positive, preserve permissions when extracting. */
245 GLOBAL
int same_permissions_option
;
247 /* When set, strip the given number of file name components from the file name
249 GLOBAL
size_t strip_name_components
;
251 GLOBAL
bool show_omitted_dirs_option
;
253 GLOBAL
bool sparse_option
;
255 GLOBAL
bool starting_file_option
;
257 /* Specified maximum byte length of each tape volume (multiple of 1024). */
258 GLOBAL tarlong tape_length_option
;
260 GLOBAL
bool to_stdout_option
;
262 GLOBAL
bool totals_option
;
264 GLOBAL
bool touch_option
;
266 /* Count how many times the option has been set, multiple setting yields
267 more verbose behavior. Value 0 means no verbosity, 1 means file name
268 only, 2 means file name and all attributes. More than 2 is just like 2. */
269 GLOBAL
int verbose_option
;
271 GLOBAL
bool verify_option
;
273 /* Specified name of file containing the volume number. */
274 GLOBAL
const char *volno_file_option
;
276 /* Specified value or pattern. */
277 GLOBAL
const char *volume_label_option
;
279 /* Other global variables. */
281 /* File descriptor for archive file. */
284 /* Nonzero when outputting to /dev/null. */
285 GLOBAL
bool dev_null_output
;
287 /* Timestamp for when we started execution. */
288 #if HAVE_CLOCK_GETTIME
289 GLOBAL
struct timespec start_timespec
;
290 # define start_time (start_timespec.tv_sec)
292 GLOBAL
time_t start_time
;
295 GLOBAL
struct tar_stat_info current_stat_info
;
297 /* List of tape drive names, number of such tape drives, allocated number,
298 and current cursor in list. */
299 GLOBAL
const char **archive_name_array
;
300 GLOBAL
int archive_names
;
301 GLOBAL
int allocated_archive_names
;
302 GLOBAL
const char **archive_name_cursor
;
304 /* Output index file name. */
305 GLOBAL
char const *index_file_name
;
307 /* Structure for keeping track of filenames and lists thereof. */
311 size_t length
; /* cached strlen(name) */
312 uintmax_t found_count
; /* number of times a matching file has
315 char firstch
; /* first char is literally matched */
316 char regexp
; /* this name is a regexp, not literal */
317 int change_dir
; /* set with the -C option */
318 char const *dir_contents
; /* for incremental_option */
319 char fake
; /* dummy entry */
323 /* Obnoxious test to see if dimwit is trying to dump the archive. */
327 GLOBAL
bool seekable_archive
;
329 GLOBAL dev_t root_device
;
332 /* Declarations for each module. */
334 /* FIXME: compare.c should not directly handle the following variable,
335 instead, this should be done in buffer.c only. */
343 extern enum access_mode access_mode
;
345 /* Module buffer.c. */
348 extern char *save_name
;
349 extern off_t save_sizeleft
;
350 extern off_t save_totsize
;
351 extern bool write_archive_to_stdout
;
353 size_t available_space_after (union block
*);
354 off_t
current_block_ordinal (void);
355 void close_archive (void);
356 void closeout_volume_number (void);
357 union block
*find_next_block (void);
358 void flush_read (void);
359 void flush_write (void);
360 void flush_archive (void);
361 void init_volume_number (void);
362 void open_archive (enum access_mode
);
363 void print_total_written (void);
364 void reset_eof (void);
365 void set_next_block_after (union block
*);
366 void clear_read_error_count (void);
367 void xclose (int fd
);
368 void archive_write_error (ssize_t
) __attribute__ ((noreturn
));
369 void archive_read_error (void);
370 off_t
seek_archive (off_t size
);
371 void set_start_time (void);
373 /* Module create.c. */
380 dump_status_not_implemented
383 bool file_dumpable_p (struct tar_stat_info
*);
384 void create_archive (void);
385 void pad_archive (off_t size_left
);
386 void dump_file (char *, int, dev_t
);
387 union block
*start_header (struct tar_stat_info
*st
);
388 void finish_header (struct tar_stat_info
*, union block
*, off_t
);
389 void simple_finish_header (union block
*header
);
390 union block
*start_private_header (const char *name
, size_t size
);
391 void write_eot (void);
392 void check_links (void);
394 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
395 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
396 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
397 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
398 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
399 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
400 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
401 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
402 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
403 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
404 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
406 void gid_to_chars (gid_t
, char *, size_t);
407 void major_to_chars (major_t
, char *, size_t);
408 void minor_to_chars (minor_t
, char *, size_t);
409 void mode_to_chars (mode_t
, char *, size_t);
410 void off_to_chars (off_t
, char *, size_t);
411 void size_to_chars (size_t, char *, size_t);
412 void time_to_chars (time_t, char *, size_t);
413 void uid_to_chars (uid_t
, char *, size_t);
414 void uintmax_to_chars (uintmax_t, char *, size_t);
415 void string_to_chars (char *, char *, size_t);
417 /* Module diffarch.c. */
419 extern bool now_verifying
;
421 void diff_archive (void);
422 void diff_init (void);
423 void verify_volume (void);
425 /* Module extract.c. */
427 extern bool we_are_root
;
428 void extr_init (void);
429 void extract_archive (void);
430 void extract_finish (void);
431 void fatal_exit (void) __attribute__ ((noreturn
));
433 /* Module delete.c. */
435 void delete_archive_members (void);
437 /* Module incremen.c. */
439 char *get_directory_contents (char *, dev_t
);
440 void read_directory_file (void);
441 void write_directory_file (void);
442 void purge_directory (char const *);
448 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
449 HEADER_SUCCESS
, /* header successfully read and checksummed */
450 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
451 HEADER_ZERO_BLOCK
, /* zero block where header expected */
452 HEADER_END_OF_FILE
, /* true end of file while header expected */
453 HEADER_FAILURE
/* ill-formed header, or bad checksum */
463 GLOBAL
struct xheader extended_header
;
464 extern union block
*current_header
;
465 extern enum archive_format current_format
;
466 extern size_t recent_long_name_blocks
;
467 extern size_t recent_long_link_blocks
;
469 void decode_header (union block
*, struct tar_stat_info
*,
470 enum archive_format
*, int);
471 #define STRINGIFY_BIGINT(i, b) \
472 stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
473 char *stringify_uintmax_t_backwards (uintmax_t, char *);
474 char const *tartime (time_t);
476 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
477 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
478 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
479 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
480 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
481 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
482 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
483 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
484 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
486 gid_t
gid_from_header (const char *, size_t);
487 major_t
major_from_header (const char *, size_t);
488 minor_t
minor_from_header (const char *, size_t);
489 mode_t
mode_from_header (const char *, size_t);
490 off_t
off_from_header (const char *, size_t);
491 size_t size_from_header (const char *, size_t);
492 time_t time_from_header (const char *, size_t);
493 uid_t
uid_from_header (const char *, size_t);
494 uintmax_t uintmax_from_header (const char *, size_t);
496 void list_archive (void);
497 void print_for_mkdir (char *, int, mode_t
);
498 void print_header (struct tar_stat_info
*, off_t
);
499 void read_and (void (*) (void));
500 enum read_header
read_header (bool);
501 void skip_file (off_t
);
502 void skip_member (void);
504 /* Module mangle.c. */
506 void extract_mangle (void);
510 void assign_string (char **, const char *);
511 char *quote_copy_string (const char *);
512 int unquote_string (char *);
514 size_t dot_dot_prefix_len (char const *);
518 ORDINARY_REMOVE_OPTION
,
519 RECURSIVE_REMOVE_OPTION
,
520 WANT_DIRECTORY_REMOVE_OPTION
522 int remove_any_file (const char *, enum remove_option
);
523 bool maybe_backup_file (const char *, int);
524 void undo_last_backup (void);
526 int deref_stat (bool, char const *, struct stat
*);
528 int chdir_arg (char const *);
531 void decode_mode (mode_t
, char *);
533 void chdir_fatal (char const *) __attribute__ ((noreturn
));
534 void chmod_error_details (char const *, mode_t
);
535 void chown_error_details (char const *, uid_t
, gid_t
);
536 void close_error (char const *);
537 void close_warn (char const *);
538 void close_diag (char const *name
);
539 void exec_fatal (char const *) __attribute__ ((noreturn
));
540 void link_error (char const *, char const *);
541 void mkdir_error (char const *);
542 void mkfifo_error (char const *);
543 void mknod_error (char const *);
544 void open_error (char const *);
545 void open_fatal (char const *) __attribute__ ((noreturn
));
546 void open_warn (char const *);
547 void open_diag (char const *name
);
548 void read_error (char const *);
549 void read_error_details (char const *, off_t
, size_t);
550 void read_fatal (char const *) __attribute__ ((noreturn
));
551 void read_fatal_details (char const *, off_t
, size_t) __attribute__ ((noreturn
));
552 void read_warn_details (char const *, off_t
, size_t);
553 void read_diag_details (char const *name
, off_t offset
, size_t size
);
554 void readlink_error (char const *);
555 void readlink_warn (char const *);
556 void readlink_diag (char const *name
);
557 void savedir_error (char const *);
558 void savedir_warn (char const *);
559 void savedir_diag (char const *name
);
560 void seek_error (char const *);
561 void seek_error_details (char const *, off_t
);
562 void seek_warn (char const *);
563 void seek_warn_details (char const *, off_t
);
564 void seek_diag_details (char const *, off_t
);
565 void stat_error (char const *);
566 void stat_warn (char const *);
567 void stat_diag (char const *name
);
568 void symlink_error (char const *, char const *);
569 void truncate_error (char const *);
570 void truncate_warn (char const *);
571 void unlink_error (char const *);
572 void utime_error (char const *);
573 void waitpid_error (char const *);
574 void write_error (char const *);
575 void write_error_details (char const *, size_t, size_t);
576 void write_fatal (char const *) __attribute__ ((noreturn
));
577 void write_fatal_details (char const *, ssize_t
, size_t)
578 __attribute__ ((noreturn
));
583 void *page_aligned_alloc (void **, size_t);
585 /* Module names.c. */
587 extern struct name
*gnu_list_name
;
589 void gid_to_gname (gid_t
, char **gname
);
590 int gname_to_gid (char const *, gid_t
*);
591 void uid_to_uname (uid_t
, char **uname
);
592 int uname_to_uid (char const *, uid_t
*);
594 void init_names (void);
595 void name_add (const char *);
596 void name_init (void);
597 void name_term (void);
598 char *name_next (int);
599 void name_close (void);
600 void name_gather (void);
601 struct name
*addname (char const *, int);
602 int name_match (const char *);
603 void names_notfound (void);
604 void collect_and_sort_names (void);
605 struct name
*name_scan (const char *);
606 char *name_from_list (void);
607 void blank_name_list (void);
608 char *new_name (const char *, const char *);
609 char *safer_name_suffix (char const *, bool);
610 size_t stripped_prefix_len (char const *file_name
, size_t num
);
611 bool all_names_found (struct tar_stat_info
*);
613 bool excluded_name (char const *);
615 void add_avoided_name (char const *);
616 bool is_avoided_name (char const *);
617 bool is_individual_file (char const *);
619 bool contains_dot_dot (char const *);
621 bool removed_prefixes_p (void);
623 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
624 (c)->found_count == occurrence_option)
625 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
626 (c)->found_count >= occurrence_option)
632 int confirm (const char *, const char *);
633 void request_stdin (const char *);
635 void tar_stat_init (struct tar_stat_info
*st
);
636 void tar_stat_destroy (struct tar_stat_info
*st
);
637 void usage (int) __attribute__ ((noreturn
));
639 /* Module update.c. */
641 extern char *output_start
;
643 void update_archive (void);
645 /* Module xheader.c. */
647 void xheader_decode (struct tar_stat_info
*);
648 void xheader_decode_global (void);
649 void xheader_store (char const *, struct tar_stat_info
const *, void *);
650 void xheader_read (union block
*, size_t);
651 void xheader_write (char type
, char *name
, struct xheader
*xhdr
);
652 void xheader_write_global (void);
653 void xheader_finish (struct xheader
*);
654 void xheader_destroy (struct xheader
*);
655 char *xheader_xhdr_name (struct tar_stat_info
*st
);
656 char *xheader_ghdr_name (void);
657 void xheader_write (char, char *, struct xheader
*);
658 void xheader_write_global (void);
659 void xheader_set_option (char *string
);
661 /* Module system.c */
663 void sys_stat_nanoseconds (struct tar_stat_info
*);
664 void sys_detect_dev_null_output (void);
665 void sys_save_archive_dev_ino (void);
666 void sys_drain_input_pipe (void);
667 void sys_wait_for_child (pid_t
);
668 void sys_spawn_shell (void);
669 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
670 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
671 bool sys_file_is_archive (struct tar_stat_info
*p
);
672 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
673 int sys_truncate (int fd
);
674 pid_t
sys_child_open_for_compress (void);
675 pid_t
sys_child_open_for_uncompress (void);
676 size_t sys_write_archive_buffer (void);
677 bool sys_get_archive_stat (void);
679 /* Module compare.c */
680 void report_difference (struct tar_stat_info
*st
, const char *message
, ...);
682 /* Module sparse.c */
683 bool sparse_file_p (struct tar_stat_info
*);
684 bool sparse_member_p (struct tar_stat_info
*);
685 bool sparse_fixup_header (struct tar_stat_info
*);
686 enum dump_status
sparse_dump_file (int, struct tar_stat_info
*);
687 enum dump_status
sparse_extract_file (int, struct tar_stat_info
*, off_t
*);
688 enum dump_status
sparse_skip_file (struct tar_stat_info
*);
689 bool sparse_diff_file (int, struct tar_stat_info
*);
692 bool string_ascii_p (const char *str
);
693 bool utf8_convert (bool to_utf
, char const *input
, char **output
);