1 /* Common declarations for the tar program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
4 2003, 2004, 2005 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 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
34 /* Some various global definitions. */
36 /* Name of file to use for interacting with user. */
38 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
39 modules. Here, we merely set it to "extern" if it is not already set.
40 GNU tar does depend on the system loader to preset all GLOBAL variables to
41 neutral (or zero) values, explicit initialization is usually not done. */
43 # define GLOBAL extern
46 #define TAREXIT_SUCCESS PAXEXIT_SUCCESS
47 #define TAREXIT_DIFFERS PAXEXIT_DIFFERS
48 #define TAREXIT_FAILURE PAXEXIT_FAILURE
52 #include <backupfile.h>
54 #include <full-write.h>
55 #include <modechange.h>
57 #include <safe-read.h>
58 #include <stat-time.h>
60 #define obstack_chunk_alloc xmalloc
61 #define obstack_chunk_free free
66 /* Log base 2 of common values. */
71 /* Information gleaned from the command line. */
73 /* Name of this program. */
74 GLOBAL
const char *program_name
;
76 /* Main command option. */
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 */
91 GLOBAL
enum subcommand subcommand_option
;
93 /* Selected format for output archive. */
94 GLOBAL
enum archive_format archive_format
;
96 /* Either NL or NUL, as decided by the --null option. */
97 GLOBAL
char filename_terminator
;
99 /* Size of each record, once in blocks, once in bytes. Those two variables
100 are always related, the second being BLOCKSIZE times the first. They do
101 not have _option in their name, even if their values is derived from
102 option decoding, as these are especially important in tar. */
103 GLOBAL
int blocking_factor
;
104 GLOBAL
size_t record_size
;
106 GLOBAL
bool absolute_names_option
;
108 /* Display file times in UTC */
109 GLOBAL
bool utc_option
;
111 /* This variable tells how to interpret newer_mtime_option, below. If zero,
112 files get archived if their mtime is not less than newer_mtime_option.
113 If nonzero, files get archived if *either* their ctime or mtime is not less
114 than newer_mtime_option. */
115 GLOBAL
int after_date_option
;
120 replace_atime_preserve
,
121 system_atime_preserve
123 GLOBAL
enum atime_preserve atime_preserve_option
;
125 GLOBAL
bool backup_option
;
127 /* Type of backups being made. */
128 GLOBAL
enum backup_type backup_type
;
130 GLOBAL
bool block_number_option
;
132 GLOBAL
bool checkpoint_option
;
134 /* Specified name of compression program, or "gzip" as implied by -z. */
135 GLOBAL
const char *use_compress_program_option
;
137 GLOBAL
bool dereference_option
;
139 /* Print a message if not all links are dumped */
140 GLOBAL
int check_links_option
;
142 /* Patterns that match file names to be excluded. */
143 GLOBAL
struct exclude
*excluded
;
145 /* Exclude directories containing a cache directory tag. */
146 GLOBAL
bool exclude_caches_option
;
148 /* Specified value to be put into tar file in place of stat () results, or
149 just -1 if such an override should not take place. */
150 GLOBAL gid_t group_option
;
152 GLOBAL
bool ignore_failed_read_option
;
154 GLOBAL
bool ignore_zeros_option
;
156 GLOBAL
bool incremental_option
;
158 /* Specified name of script to run at end of each tape change. */
159 GLOBAL
const char *info_script_option
;
161 GLOBAL
bool interactive_option
;
163 /* If nonzero, extract only Nth occurrence of each named file */
164 GLOBAL
uintmax_t occurrence_option
;
168 DEFAULT_OLD_FILES
, /* default */
169 NO_OVERWRITE_DIR_OLD_FILES
, /* --no-overwrite-dir */
170 OVERWRITE_OLD_FILES
, /* --overwrite */
171 UNLINK_FIRST_OLD_FILES
, /* --unlink-first */
172 KEEP_OLD_FILES
, /* --keep-old-files */
173 KEEP_NEWER_FILES
/* --keep-newer-files */
175 GLOBAL
enum old_files old_files_option
;
177 /* Specified file name for incremental list. */
178 GLOBAL
const char *listed_incremental_option
;
180 /* Specified mode change string. */
181 GLOBAL
struct mode_change
*mode_option
;
183 /* Initial umask, if needed for mode change string. */
184 GLOBAL mode_t initial_umask
;
186 GLOBAL
bool multi_volume_option
;
188 /* Specified threshold date and time. Files having an older time stamp
189 do not get archived (also see after_date_option above). */
190 GLOBAL
struct timespec newer_mtime_option
;
192 /* Return true if newer_mtime_option is initialized. */
193 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
195 /* Return true if the struct stat ST's M time is less than
196 newer_mtime_option. */
197 #define OLDER_STAT_TIME(st, m) \
198 (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
200 /* Likewise, for struct tar_stat_info ST. */
201 #define OLDER_TAR_STAT_TIME(st, m) \
202 (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
204 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
205 GLOBAL
int recursion_option
;
207 GLOBAL
bool numeric_owner_option
;
209 GLOBAL
bool one_file_system_option
;
211 /* Specified value to be put into tar file in place of stat () results, or
212 just -1 if such an override should not take place. */
213 GLOBAL uid_t owner_option
;
215 GLOBAL
bool recursive_unlink_option
;
217 GLOBAL
bool read_full_records_option
;
219 GLOBAL
bool remove_files_option
;
221 /* Specified rmt command. */
222 GLOBAL
const char *rmt_command_option
;
224 /* Specified remote shell command. */
225 GLOBAL
const char *rsh_command_option
;
227 GLOBAL
bool same_order_option
;
229 /* If positive, preserve ownership when extracting. */
230 GLOBAL
int same_owner_option
;
232 /* If positive, preserve permissions when extracting. */
233 GLOBAL
int same_permissions_option
;
235 /* When set, strip the given number of file name components from the file name
237 GLOBAL
size_t strip_name_components
;
239 GLOBAL
bool show_omitted_dirs_option
;
241 GLOBAL
bool sparse_option
;
243 GLOBAL
bool starting_file_option
;
245 /* Specified maximum byte length of each tape volume (multiple of 1024). */
246 GLOBAL tarlong tape_length_option
;
248 GLOBAL
bool to_stdout_option
;
250 GLOBAL
bool totals_option
;
252 GLOBAL
bool touch_option
;
254 GLOBAL
char *to_command_option
;
255 GLOBAL
bool ignore_command_error_option
;
257 /* Return true if the extracted files are not being written to disk */
258 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
260 /* Count how many times the option has been set, multiple setting yields
261 more verbose behavior. Value 0 means no verbosity, 1 means file name
262 only, 2 means file name and all attributes. More than 2 is just like 2. */
263 GLOBAL
int verbose_option
;
265 GLOBAL
bool verify_option
;
267 /* Specified name of file containing the volume number. */
268 GLOBAL
const char *volno_file_option
;
270 /* Specified value or pattern. */
271 GLOBAL
const char *volume_label_option
;
273 /* Other global variables. */
275 /* File descriptor for archive file. */
278 /* Nonzero when outputting to /dev/null. */
279 GLOBAL
bool dev_null_output
;
281 /* Timestamp for when we started execution. */
282 GLOBAL
struct timespec start_time
;
284 GLOBAL
struct tar_stat_info current_stat_info
;
286 /* List of tape drive names, number of such tape drives, allocated number,
287 and current cursor in list. */
288 GLOBAL
const char **archive_name_array
;
289 GLOBAL
int archive_names
;
290 GLOBAL
int allocated_archive_names
;
291 GLOBAL
const char **archive_name_cursor
;
293 /* Output index file name. */
294 GLOBAL
char const *index_file_name
;
296 /* Structure for keeping track of filenames and lists thereof. */
300 size_t length
; /* cached strlen(name) */
301 uintmax_t found_count
; /* number of times a matching file has
304 char firstch
; /* first char is literally matched */
305 char regexp
; /* this name is a regexp, not literal */
306 int change_dir
; /* set with the -C option */
307 char const *dir_contents
; /* for incremental_option */
308 char fake
; /* dummy entry */
312 /* Obnoxious test to see if dimwit is trying to dump the archive. */
316 GLOBAL
bool seekable_archive
;
318 GLOBAL dev_t root_device
;
320 /* Unquote filenames */
321 GLOBAL
bool unquote_option
;
323 GLOBAL
bool test_label_option
; /* Test archive volume label and exit */
325 GLOBAL
bool show_stored_names_option
; /* When creating archive in verbose mode,
326 list member names as stored in the
330 /* Declarations for each module. */
332 /* FIXME: compare.c should not directly handle the following variable,
333 instead, this should be done in buffer.c only. */
341 extern enum access_mode access_mode
;
343 /* Module buffer.c. */
346 extern bool write_archive_to_stdout
;
347 extern char *volume_label
;
348 extern char *continued_file_name
;
349 extern uintmax_t continued_file_size
;
350 extern uintmax_t continued_file_offset
;
352 size_t available_space_after (union block
*);
353 off_t
current_block_ordinal (void);
354 void close_archive (void);
355 void closeout_volume_number (void);
356 union block
*find_next_block (void);
357 void flush_read (void);
358 void flush_write (void);
359 void flush_archive (void);
360 void init_volume_number (void);
361 void open_archive (enum access_mode
);
362 void print_total_written (void);
363 void reset_eof (void);
364 void set_next_block_after (union block
*);
365 void clear_read_error_count (void);
366 void xclose (int fd
);
367 void archive_write_error (ssize_t
) __attribute__ ((noreturn
));
368 void archive_read_error (void);
369 off_t
seek_archive (off_t size
);
370 void set_start_time (void);
372 void mv_begin (struct tar_stat_info
*st
);
374 void mv_total_size (off_t size
);
375 void mv_size_left (off_t size
);
378 /* Module create.c. */
385 dump_status_not_implemented
388 bool file_dumpable_p (struct tar_stat_info
*);
389 void create_archive (void);
390 void pad_archive (off_t size_left
);
391 void dump_file (char *, int, dev_t
);
392 union block
*start_header (struct tar_stat_info
*st
);
393 void finish_header (struct tar_stat_info
*, union block
*, off_t
);
394 void simple_finish_header (union block
*header
);
395 union block
* write_extended (bool global
, struct tar_stat_info
*st
,
396 union block
*old_header
);
397 union block
*start_private_header (const char *name
, size_t size
);
398 void write_eot (void);
399 void check_links (void);
401 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
402 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
403 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
404 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
405 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
406 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
407 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
408 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
409 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
410 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
411 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
413 void gid_to_chars (gid_t
, char *, size_t);
414 void major_to_chars (major_t
, char *, size_t);
415 void minor_to_chars (minor_t
, char *, size_t);
416 void mode_to_chars (mode_t
, char *, size_t);
417 void off_to_chars (off_t
, char *, size_t);
418 void size_to_chars (size_t, char *, size_t);
419 void time_to_chars (time_t, char *, size_t);
420 void uid_to_chars (uid_t
, char *, size_t);
421 void uintmax_to_chars (uintmax_t, char *, size_t);
422 void string_to_chars (char const *, char *, size_t);
424 /* Module diffarch.c. */
426 extern bool now_verifying
;
428 void diff_archive (void);
429 void diff_init (void);
430 void verify_volume (void);
432 /* Module extract.c. */
434 void extr_init (void);
435 void extract_archive (void);
436 void extract_finish (void);
438 /* Module delete.c. */
440 void delete_archive_members (void);
442 /* Module incremen.c. */
444 char *get_directory_contents (char *, dev_t
);
445 void read_directory_file (void);
446 void write_directory_file (void);
447 void purge_directory (char const *);
448 void list_dumpdir (char *buffer
, size_t size
);
449 void update_parent_directory (const char *name
);
451 size_t dumpdir_size (const char *p
);
452 void get_gnu_dumpdir (void);
458 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
459 HEADER_SUCCESS
, /* header successfully read and checksummed */
460 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
461 HEADER_ZERO_BLOCK
, /* zero block where header expected */
462 HEADER_END_OF_FILE
, /* true end of file while header expected */
463 HEADER_FAILURE
/* ill-formed header, or bad checksum */
473 GLOBAL
struct xheader extended_header
;
474 extern union block
*current_header
;
475 extern enum archive_format current_format
;
476 extern size_t recent_long_name_blocks
;
477 extern size_t recent_long_link_blocks
;
479 void decode_header (union block
*, struct tar_stat_info
*,
480 enum archive_format
*, int);
481 char const *tartime (struct timespec
, bool);
483 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
484 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
485 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
486 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
487 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
488 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
489 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
490 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
491 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
493 gid_t
gid_from_header (const char *, size_t);
494 major_t
major_from_header (const char *, size_t);
495 minor_t
minor_from_header (const char *, size_t);
496 mode_t
mode_from_header (const char *, size_t);
497 off_t
off_from_header (const char *, size_t);
498 size_t size_from_header (const char *, size_t);
499 time_t time_from_header (const char *, size_t);
500 uid_t
uid_from_header (const char *, size_t);
501 uintmax_t uintmax_from_header (const char *, size_t);
503 void list_archive (void);
504 void print_for_mkdir (char *, int, mode_t
);
505 void print_header (struct tar_stat_info
*, off_t
);
506 void read_and (void (*) (void));
507 enum read_header
read_header (bool);
508 enum read_header
tar_checksum (union block
*header
, bool silent
);
509 void skip_file (off_t
);
510 void skip_member (void);
512 /* Module mangle.c. */
514 void extract_mangle (void);
518 void assign_string (char **, const char *);
519 char *quote_copy_string (const char *);
520 int unquote_string (char *);
522 void code_ns_fraction (int, char *);
523 char const *code_timespec (struct timespec
, char *);
524 enum { BILLION
= 1000000000, LOG10_BILLION
= 9 };
525 enum { TIMESPEC_STRSIZE_BOUND
=
526 UINTMAX_STRSIZE_BOUND
+ LOG10_BILLION
+ sizeof "-." - 1 };
528 size_t dot_dot_prefix_len (char const *);
532 ORDINARY_REMOVE_OPTION
,
533 RECURSIVE_REMOVE_OPTION
,
535 /* FIXME: The following value is never used. It seems to be intended
536 as a placeholder for a hypothetical option that should instruct tar
537 to recursively remove subdirectories in purge_directory(),
538 as opposed to the functionality of --recursive-unlink
539 (RECURSIVE_REMOVE_OPTION value), which removes them in
540 prepare_to_extract() phase. However, with the addition of more
541 meta-info to the incremental dumps, this should become unnecessary */
542 WANT_DIRECTORY_REMOVE_OPTION
544 int remove_any_file (const char *, enum remove_option
);
545 bool maybe_backup_file (const char *, int);
546 void undo_last_backup (void);
548 int deref_stat (bool, char const *, struct stat
*);
550 int chdir_arg (char const *);
553 void close_diag (char const *name
);
554 void open_diag (char const *name
);
555 void read_diag_details (char const *name
, off_t offset
, size_t size
);
556 void readlink_diag (char const *name
);
557 void savedir_diag (char const *name
);
558 void seek_diag_details (char const *, off_t
);
559 void stat_diag (char const *name
);
560 void write_error_details (char const *, size_t, size_t);
561 void write_fatal (char const *) __attribute__ ((noreturn
));
562 void write_fatal_details (char const *, ssize_t
, size_t)
563 __attribute__ ((noreturn
));
568 void *page_aligned_alloc (void **, size_t);
570 /* Module names.c. */
572 extern struct name
*gnu_list_name
;
574 void gid_to_gname (gid_t
, char **gname
);
575 int gname_to_gid (char const *, gid_t
*);
576 void uid_to_uname (uid_t
, char **uname
);
577 int uname_to_uid (char const *, uid_t
*);
579 void init_names (void);
580 void name_add (const char *);
581 void name_init (void);
582 void name_term (void);
583 char *name_next (int);
584 void name_gather (void);
585 struct name
*addname (char const *, int);
586 int name_match (const char *);
587 void names_notfound (void);
588 void collect_and_sort_names (void);
589 struct name
*name_scan (const char *);
590 char *name_from_list (void);
591 void blank_name_list (void);
592 char *new_name (const char *, const char *);
593 size_t stripped_prefix_len (char const *file_name
, size_t num
);
594 bool all_names_found (struct tar_stat_info
*);
596 bool excluded_name (char const *);
598 void add_avoided_name (char const *);
599 bool is_avoided_name (char const *);
600 bool is_individual_file (char const *);
602 bool contains_dot_dot (char const *);
604 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
605 (c)->found_count == occurrence_option)
606 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
607 (c)->found_count >= occurrence_option)
613 int confirm (const char *, const char *);
614 void request_stdin (const char *);
616 void tar_stat_init (struct tar_stat_info
*st
);
617 void tar_stat_destroy (struct tar_stat_info
*st
);
618 void usage (int) __attribute__ ((noreturn
));
619 int tar_timespec_cmp (struct timespec a
, struct timespec b
);
620 const char *archive_format_string (enum archive_format fmt
);
621 const char *subcommand_string (enum subcommand c
);
623 /* Module update.c. */
625 extern char *output_start
;
627 void update_archive (void);
629 /* Module xheader.c. */
631 void xheader_decode (struct tar_stat_info
*);
632 void xheader_decode_global (void);
633 void xheader_store (char const *, struct tar_stat_info
const *, void const *);
634 void xheader_read (union block
*, size_t);
635 void xheader_write (char type
, char *name
, struct xheader
*xhdr
);
636 void xheader_write_global (void);
637 void xheader_finish (struct xheader
*);
638 void xheader_destroy (struct xheader
*);
639 char *xheader_xhdr_name (struct tar_stat_info
*st
);
640 char *xheader_ghdr_name (void);
641 void xheader_write (char, char *, struct xheader
*);
642 void xheader_write_global (void);
643 void xheader_set_option (char *string
);
644 void xheader_string_begin (void);
645 void xheader_string_add (char const *s
);
646 void xheader_string_end (char const *keyword
);
647 bool xheader_keyword_deleted_p (const char *kw
);
648 char *xheader_format_name (struct tar_stat_info
*st
, const char *fmt
,
651 /* Module system.c */
653 void sys_detect_dev_null_output (void);
654 void sys_save_archive_dev_ino (void);
655 void sys_drain_input_pipe (void);
656 void sys_wait_for_child (pid_t
);
657 void sys_spawn_shell (void);
658 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
659 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
660 bool sys_file_is_archive (struct tar_stat_info
*p
);
661 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
662 int sys_truncate (int fd
);
663 pid_t
sys_child_open_for_compress (void);
664 pid_t
sys_child_open_for_uncompress (void);
665 size_t sys_write_archive_buffer (void);
666 bool sys_get_archive_stat (void);
667 int sys_exec_command (char *file_name
, int typechar
, struct tar_stat_info
*st
);
668 void sys_wait_command (void);
669 int sys_exec_info_script (const char *archive_name
, int volume_number
);
671 /* Module compare.c */
672 void report_difference (struct tar_stat_info
*st
, const char *message
, ...);
674 /* Module sparse.c */
675 bool sparse_file_p (struct tar_stat_info
*);
676 bool sparse_member_p (struct tar_stat_info
*);
677 bool sparse_fixup_header (struct tar_stat_info
*);
678 enum dump_status
sparse_dump_file (int, struct tar_stat_info
*);
679 enum dump_status
sparse_extract_file (int, struct tar_stat_info
*, off_t
*);
680 enum dump_status
sparse_skip_file (struct tar_stat_info
*);
681 bool sparse_diff_file (int, struct tar_stat_info
*);
684 bool string_ascii_p (const char *str
);
685 bool utf8_convert (bool to_utf
, char const *input
, char **output
);