1 /* Common declarations for the tar program.
3 Copyright 1988, 1992-1994, 1996-1997, 1999-2010, 2012-2013 Free
4 Software Foundation, Inc.
6 This file is part of GNU tar.
8 GNU tar is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 GNU tar is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 /* Declare the GNU tar archive format. */
24 /* The checksum field is filled with this while the checksum is computed. */
25 #define CHKBLANKS " " /* 8 blanks, no null */
27 /* Some constants from POSIX are given names. */
28 #define NAME_FIELD_SIZE 100
29 #define PREFIX_FIELD_SIZE 155
30 #define UNAME_FIELD_SIZE 32
31 #define GNAME_FIELD_SIZE 32
35 /* Some various global definitions. */
37 /* Name of file to use for interacting with user. */
39 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
40 modules. Here, we merely set it to "extern" if it is not already set.
41 GNU tar does depend on the system loader to preset all GLOBAL variables to
42 neutral (or zero) values, explicit initialization is usually not done. */
44 # define GLOBAL extern
47 #define TAREXIT_SUCCESS PAXEXIT_SUCCESS
48 #define TAREXIT_DIFFERS PAXEXIT_DIFFERS
49 #define TAREXIT_FAILURE PAXEXIT_FAILURE
53 #include <backupfile.h>
55 #include <full-write.h>
56 #include <modechange.h>
58 #include <safe-read.h>
59 #include <stat-time.h>
61 #define obstack_chunk_alloc xmalloc
62 #define obstack_chunk_free free
65 #include <xvasprintf.h>
69 /* Log base 2 of common values. */
74 _GL_INLINE_HEADER_BEGIN
76 # define COMMON_INLINE _GL_INLINE
79 /* Information gleaned from the command line. */
81 /* Main command option. */
85 UNKNOWN_SUBCOMMAND
, /* none of the following */
86 APPEND_SUBCOMMAND
, /* -r */
87 CAT_SUBCOMMAND
, /* -A */
88 CREATE_SUBCOMMAND
, /* -c */
89 DELETE_SUBCOMMAND
, /* -D */
90 DIFF_SUBCOMMAND
, /* -d */
91 EXTRACT_SUBCOMMAND
, /* -x */
92 LIST_SUBCOMMAND
, /* -t */
93 UPDATE_SUBCOMMAND
, /* -u */
94 TEST_LABEL_SUBCOMMAND
, /* --test-label */
97 GLOBAL
enum subcommand subcommand_option
;
99 /* Selected format for output archive. */
100 GLOBAL
enum archive_format archive_format
;
102 /* Size of each record, once in blocks, once in bytes. Those two variables
103 are always related, the second being BLOCKSIZE times the first. They do
104 not have _option in their name, even if their values is derived from
105 option decoding, as these are especially important in tar. */
106 GLOBAL
int blocking_factor
;
107 GLOBAL
size_t record_size
;
109 GLOBAL
bool absolute_names_option
;
111 /* Display file times in UTC */
112 GLOBAL
bool utc_option
;
113 /* Output file timestamps to the full resolution */
114 GLOBAL
bool full_time_option
;
116 /* This variable tells how to interpret newer_mtime_option, below. If zero,
117 files get archived if their mtime is not less than newer_mtime_option.
118 If nonzero, files get archived if *either* their ctime or mtime is not less
119 than newer_mtime_option. */
120 GLOBAL
int after_date_option
;
125 replace_atime_preserve
,
126 system_atime_preserve
128 GLOBAL
enum atime_preserve atime_preserve_option
;
130 GLOBAL
bool backup_option
;
132 /* Type of backups being made. */
133 GLOBAL
enum backup_type backup_type
;
135 GLOBAL
bool block_number_option
;
137 GLOBAL
unsigned checkpoint_option
;
138 #define DEFAULT_CHECKPOINT 10
140 /* Specified name of compression program, or "gzip" as implied by -z. */
141 GLOBAL
const char *use_compress_program_option
;
143 GLOBAL
bool dereference_option
;
144 GLOBAL
bool hard_dereference_option
;
146 /* Patterns that match file names to be excluded. */
147 GLOBAL
struct exclude
*excluded
;
149 enum exclusion_tag_type
152 /* Exclude the directory contents, but preserve the directory
153 itself and the exclusion tag file */
154 exclusion_tag_contents
,
155 /* Exclude everything below the directory, preserving the directory
158 /* Exclude entire directory */
162 /* Specified value to be put into tar file in place of stat () results, or
163 just null and -1 if such an override should not take place. */
164 GLOBAL
char const *group_name_option
;
165 GLOBAL gid_t group_option
;
167 GLOBAL
bool ignore_failed_read_option
;
169 GLOBAL
bool ignore_zeros_option
;
171 GLOBAL
bool incremental_option
;
173 /* Specified name of script to run at end of each tape change. */
174 GLOBAL
const char *info_script_option
;
176 GLOBAL
bool interactive_option
;
178 /* If nonzero, extract only Nth occurrence of each named file */
179 GLOBAL
uintmax_t occurrence_option
;
183 DEFAULT_OLD_FILES
, /* default */
184 NO_OVERWRITE_DIR_OLD_FILES
, /* --no-overwrite-dir */
185 OVERWRITE_OLD_FILES
, /* --overwrite */
186 UNLINK_FIRST_OLD_FILES
, /* --unlink-first */
187 KEEP_OLD_FILES
, /* --keep-old-files */
188 SKIP_OLD_FILES
, /* --skip-old-files */
189 KEEP_NEWER_FILES
/* --keep-newer-files */
191 GLOBAL
enum old_files old_files_option
;
193 GLOBAL
bool keep_directory_symlink_option
;
195 /* Specified file name for incremental list. */
196 GLOBAL
const char *listed_incremental_option
;
197 /* Incremental dump level */
198 GLOBAL
int incremental_level
;
199 /* Check device numbers when doing incremental dumps. */
200 GLOBAL
bool check_device_option
;
202 /* Specified mode change string. */
203 GLOBAL
struct mode_change
*mode_option
;
205 /* Initial umask, if needed for mode change string. */
206 GLOBAL mode_t initial_umask
;
208 GLOBAL
bool multi_volume_option
;
210 /* Specified threshold date and time. Files having an older time stamp
211 do not get archived (also see after_date_option above). */
212 GLOBAL
struct timespec newer_mtime_option
;
214 /* If true, override actual mtime (see below) */
215 GLOBAL
bool set_mtime_option
;
216 /* Value to be put in mtime header field instead of the actual mtime */
217 GLOBAL
struct timespec mtime_option
;
219 /* Return true if newer_mtime_option is initialized. */
220 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
222 /* Return true if the struct stat ST's M time is less than
223 newer_mtime_option. */
224 #define OLDER_STAT_TIME(st, m) \
225 (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
227 /* Likewise, for struct tar_stat_info ST. */
228 #define OLDER_TAR_STAT_TIME(st, m) \
229 (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
231 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
232 GLOBAL
int recursion_option
;
234 GLOBAL
bool numeric_owner_option
;
236 GLOBAL
bool one_file_system_option
;
238 /* Specified value to be put into tar file in place of stat () results, or
239 just null and -1 if such an override should not take place. */
240 GLOBAL
char const *owner_name_option
;
241 GLOBAL uid_t owner_option
;
243 GLOBAL
bool recursive_unlink_option
;
245 GLOBAL
bool read_full_records_option
;
247 GLOBAL
bool remove_files_option
;
249 /* Specified remote shell command. */
250 GLOBAL
const char *rsh_command_option
;
252 GLOBAL
bool same_order_option
;
254 /* If positive, preserve ownership when extracting. */
255 GLOBAL
int same_owner_option
;
257 /* If positive, preserve permissions when extracting. */
258 GLOBAL
int same_permissions_option
;
260 /* If positive, save the SELinux context. */
261 GLOBAL
int selinux_context_option
;
263 /* If positive, save the ACLs. */
264 GLOBAL
int acls_option
;
266 /* If positive, save the user and root xattrs. */
267 GLOBAL
int xattrs_option
;
269 /* When set, strip the given number of file name components from the file name
271 GLOBAL
size_t strip_name_components
;
273 GLOBAL
bool show_omitted_dirs_option
;
275 GLOBAL
bool sparse_option
;
276 GLOBAL
unsigned tar_sparse_major
;
277 GLOBAL
unsigned tar_sparse_minor
;
279 GLOBAL
bool starting_file_option
;
281 /* Specified maximum byte length of each tape volume (multiple of 1024). */
282 GLOBAL tarlong tape_length_option
;
284 GLOBAL
bool to_stdout_option
;
286 GLOBAL
bool totals_option
;
288 GLOBAL
bool touch_option
;
290 GLOBAL
char *to_command_option
;
291 GLOBAL
bool ignore_command_error_option
;
293 /* Restrict some potentially harmful tar options */
294 GLOBAL
bool restrict_option
;
296 /* Return true if the extracted files are not being written to disk */
297 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
299 /* Count how many times the option has been set, multiple setting yields
300 more verbose behavior. Value 0 means no verbosity, 1 means file name
301 only, 2 means file name and all attributes. More than 2 is just like 2. */
302 GLOBAL
int verbose_option
;
304 GLOBAL
bool verify_option
;
306 /* Specified name of file containing the volume number. */
307 GLOBAL
const char *volno_file_option
;
309 /* Specified value or pattern. */
310 GLOBAL
const char *volume_label_option
;
312 /* Other global variables. */
314 /* File descriptor for archive file. */
317 /* Nonzero when outputting to /dev/null. */
318 GLOBAL
bool dev_null_output
;
321 GLOBAL
struct timespec start_time
; /* when we started execution */
322 GLOBAL
struct timespec volume_start_time
; /* when the current volume was
324 GLOBAL
struct timespec last_stat_time
; /* when the statistics was last
327 GLOBAL
struct tar_stat_info current_stat_info
;
329 /* List of tape drive names, number of such tape drives,
330 and current cursor in list. */
331 GLOBAL
const char **archive_name_array
;
332 GLOBAL
size_t archive_names
;
333 GLOBAL
const char **archive_name_cursor
;
335 /* Output index file name. */
336 GLOBAL
char const *index_file_name
;
338 /* Opaque structure for keeping directory meta-data */
341 /* Structure for keeping track of filenames and lists thereof. */
344 struct name
*next
; /* Link to the next element */
345 struct name
*prev
; /* Link to the previous element */
347 char *name
; /* File name or globbing pattern */
348 size_t length
; /* cached strlen (name) */
349 int matching_flags
; /* wildcard flags if name is a pattern */
350 bool cmdline
; /* true if this name was given in the
353 int change_dir
; /* Number of the directory to change to.
354 Set with the -C option. */
355 uintmax_t found_count
; /* number of times a matching file has
358 /* The following members are used for incremental dumps only,
359 if this struct name represents a directory;
361 struct directory
*directory
;/* directory meta-data and contents */
362 struct name
*parent
; /* pointer to the parent hierarchy */
363 struct name
*child
; /* pointer to the first child */
364 struct name
*sibling
; /* pointer to the next sibling */
365 char *caname
; /* canonical name */
368 /* Obnoxious test to see if dimwit is trying to dump the archive. */
372 /* Flags for reading, searching, and fstatatting files. */
373 GLOBAL
int open_read_flags
;
374 GLOBAL
int open_searchdir_flags
;
375 GLOBAL
int fstatat_flags
;
377 GLOBAL
int seek_option
;
378 GLOBAL
bool seekable_archive
;
380 GLOBAL dev_t root_device
;
382 /* Unquote filenames */
383 GLOBAL
bool unquote_option
;
385 /* Show file or archive names after transformation.
386 In particular, when creating archive in verbose mode, list member names
387 as stored in the archive */
388 GLOBAL
bool show_transformed_names_option
;
390 /* Delay setting modification times and permissions of extracted directories
391 until the end of extraction. This variable helps correctly restore directory
392 timestamps from archives with an unusual member order. It is automatically
393 set for incremental archives. */
394 GLOBAL
bool delay_directory_restore_option
;
396 /* Warn about implicit use of the wildcards in command line arguments.
397 (Default for tar prior to 1.15.91, but changed afterwards */
398 GLOBAL
bool warn_regex_usage
;
400 /* Declarations for each module. */
402 /* FIXME: compare.c should not directly handle the following variable,
403 instead, this should be done in buffer.c only. */
411 extern enum access_mode access_mode
;
413 /* Module buffer.c. */
416 extern bool write_archive_to_stdout
;
417 extern char *volume_label
;
418 extern size_t volume_label_count
;
419 extern char *continued_file_name
;
420 extern uintmax_t continued_file_size
;
421 extern uintmax_t continued_file_offset
;
422 extern off_t records_written
;
424 char *drop_volume_label_suffix (const char *label
);
426 size_t available_space_after (union block
*pointer
);
427 off_t
current_block_ordinal (void);
428 void close_archive (void);
429 void closeout_volume_number (void);
430 double compute_duration (void);
431 union block
*find_next_block (void);
432 void flush_read (void);
433 void flush_write (void);
434 void flush_archive (void);
435 void init_volume_number (void);
436 void open_archive (enum access_mode mode
);
437 void print_total_stats (void);
438 void reset_eof (void);
439 void set_next_block_after (union block
*block
);
440 void clear_read_error_count (void);
441 void xclose (int fd
);
442 void archive_write_error (ssize_t status
) __attribute__ ((noreturn
));
443 void archive_read_error (void);
444 off_t
seek_archive (off_t size
);
445 void set_start_time (void);
450 int format_total_stats (FILE *fp
, const char **formats
, int eor
, int eol
);
451 void print_total_stats (void);
453 void mv_begin_write (const char *file_name
, off_t totsize
, off_t sizeleft
);
455 void mv_begin_read (struct tar_stat_info
*st
);
457 void mv_size_left (off_t size
);
459 void buffer_write_global_xheader (void);
461 const char *first_decompress_program (int *pstate
);
462 const char *next_decompress_program (int *pstate
);
464 /* Module create.c. */
471 dump_status_not_implemented
474 void add_exclusion_tag (const char *name
, enum exclusion_tag_type type
,
475 bool (*predicate
) (int));
476 bool cachedir_file_p (int fd
);
477 char *get_directory_entries (struct tar_stat_info
*st
);
479 void create_archive (void);
480 void pad_archive (off_t size_left
);
481 void dump_file (struct tar_stat_info
*parent
, char const *name
,
482 char const *fullname
);
483 union block
*start_header (struct tar_stat_info
*st
);
484 void finish_header (struct tar_stat_info
*st
, union block
*header
,
485 off_t block_ordinal
);
486 void simple_finish_header (union block
*header
);
487 union block
* write_extended (bool global
, struct tar_stat_info
*st
,
488 union block
*old_header
);
489 union block
*start_private_header (const char *name
, size_t size
, time_t t
);
490 void write_eot (void);
491 void check_links (void);
492 int subfile_open (struct tar_stat_info
const *dir
, char const *file
, int flags
);
493 void restore_parent_fd (struct tar_stat_info
const *st
);
494 void exclusion_tag_warning (const char *dirname
, const char *tagname
,
495 const char *message
);
496 enum exclusion_tag_type
check_exclusion_tags (struct tar_stat_info
const *st
,
497 const char **tag_file_name
);
499 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
500 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
502 bool off_to_chars (off_t off
, char *buf
, size_t size
);
503 bool time_to_chars (time_t t
, char *buf
, size_t size
);
505 /* Module diffarch.c. */
507 extern bool now_verifying
;
509 void diff_archive (void);
510 void diff_init (void);
511 void verify_volume (void);
513 /* Module extract.c. */
515 void extr_init (void);
516 void extract_archive (void);
517 void extract_finish (void);
518 bool rename_directory (char *src
, char *dst
);
520 /* Module delete.c. */
522 void delete_archive_members (void);
524 /* Module incremen.c. */
526 struct directory
*scan_directory (struct tar_stat_info
*st
);
527 const char *directory_contents (struct directory
*dir
);
528 const char *safe_directory_contents (struct directory
*dir
);
530 void rebase_directory (struct directory
*dir
,
531 const char *samp
, size_t slen
,
532 const char *repl
, size_t rlen
);
534 void append_incremental_renames (struct directory
*dir
);
535 void show_snapshot_field_ranges (void);
536 void read_directory_file (void);
537 void write_directory_file (void);
538 void purge_directory (char const *directory_name
);
539 void list_dumpdir (char *buffer
, size_t size
);
540 void update_parent_directory (struct tar_stat_info
*st
);
542 size_t dumpdir_size (const char *p
);
543 bool is_dumpdir (struct tar_stat_info
*stat_info
);
544 void clear_directory_table (void);
550 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
551 HEADER_SUCCESS
, /* header successfully read and checksummed */
552 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
553 HEADER_ZERO_BLOCK
, /* zero block where header expected */
554 HEADER_END_OF_FILE
, /* true end of file while header expected */
555 HEADER_FAILURE
/* ill-formed header, or bad checksum */
558 /* Operation mode for read_header: */
560 enum read_header_mode
562 read_header_auto
, /* process extended headers automatically */
563 read_header_x_raw
, /* return raw extended headers (return
564 HEADER_SUCCESS_EXTENDED) */
565 read_header_x_global
/* when POSIX global extended header is read,
567 HEADER_SUCCESS_EXTENDED */
569 extern union block
*current_header
;
570 extern enum archive_format current_format
;
571 extern size_t recent_long_name_blocks
;
572 extern size_t recent_long_link_blocks
;
574 void decode_header (union block
*header
, struct tar_stat_info
*stat_info
,
575 enum archive_format
*format_pointer
, int do_user_group
);
576 void transform_stat_info (int typeflag
, struct tar_stat_info
*stat_info
);
577 char const *tartime (struct timespec t
, bool full_time
);
579 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
580 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
582 off_t
off_from_header (const char *buf
, size_t size
);
583 uintmax_t uintmax_from_header (const char *buf
, size_t size
);
585 void list_archive (void);
586 void test_archive_label (void);
587 void print_for_mkdir (char *dirname
, int length
, mode_t mode
);
588 void print_header (struct tar_stat_info
*st
, union block
*blk
,
589 off_t block_ordinal
);
590 void read_and (void (*do_something
) (void));
591 enum read_header
read_header (union block
**return_block
,
592 struct tar_stat_info
*info
,
593 enum read_header_mode m
);
594 enum read_header
tar_checksum (union block
*header
, bool silent
);
595 void skip_file (off_t size
);
596 void skip_member (void);
600 #define min(a, b) ((a) < (b) ? (a) : (b))
601 #define max(a, b) ((a) < (b) ? (b) : (a))
602 void assign_string (char **dest
, const char *src
);
603 int unquote_string (char *str
);
604 char *zap_slashes (char *name
);
605 char *normalize_filename (int cdidx
, const char *name
);
606 void normalize_filename_x (char *name
);
607 void replace_prefix (char **pname
, const char *samp
, size_t slen
,
608 const char *repl
, size_t rlen
);
609 char *tar_savedir (const char *name
, int must_exist
);
611 typedef struct namebuf
*namebuf_t
;
612 namebuf_t
namebuf_create (const char *dir
);
613 void namebuf_free (namebuf_t buf
);
614 char *namebuf_name (namebuf_t buf
, const char *name
);
615 void namebuf_add_dir (namebuf_t buf
, const char *name
);
616 char *namebuf_finish (namebuf_t buf
);
618 const char *tar_dirname (void);
620 /* Represent N using a signed integer I such that (uintmax_t) I == N.
621 With a good optimizing compiler, this is equivalent to (intmax_t) i
622 and requires zero machine instructions. */
623 #if ! (UINTMAX_MAX / 2 <= INTMAX_MAX)
624 # error "represent_uintmax returns intmax_t to represent uintmax_t"
626 COMMON_INLINE
intmax_t
627 represent_uintmax (uintmax_t n
)
633 /* Avoid signed integer overflow on picky platforms. */
634 intmax_t nd
= n
- INTMAX_MIN
;
635 return nd
+ INTMAX_MIN
;
639 enum { SYSINT_BUFSIZE
=
640 max (UINTMAX_STRSIZE_BOUND
, INT_BUFSIZE_BOUND (intmax_t)) };
641 char *sysinttostr (uintmax_t, intmax_t, uintmax_t, char buf
[SYSINT_BUFSIZE
]);
642 intmax_t strtosysint (char const *, char **, intmax_t, uintmax_t);
643 void code_ns_fraction (int ns
, char *p
);
644 char const *code_timespec (struct timespec ts
, char *sbuf
);
645 enum { BILLION
= 1000000000, LOG10_BILLION
= 9 };
646 enum { TIMESPEC_STRSIZE_BOUND
=
647 UINTMAX_STRSIZE_BOUND
+ LOG10_BILLION
+ sizeof "-." - 1 };
648 struct timespec
decode_timespec (char const *, char **, bool);
650 /* Return true if T does not represent an out-of-range or invalid value. */
652 valid_timespec (struct timespec t
)
654 return 0 <= t
.tv_nsec
;
657 bool must_be_dot_or_slash (char const *);
661 ORDINARY_REMOVE_OPTION
,
662 RECURSIVE_REMOVE_OPTION
,
664 /* FIXME: The following value is never used. It seems to be intended
665 as a placeholder for a hypothetical option that should instruct tar
666 to recursively remove subdirectories in purge_directory(),
667 as opposed to the functionality of --recursive-unlink
668 (RECURSIVE_REMOVE_OPTION value), which removes them in
669 prepare_to_extract() phase. However, with the addition of more
670 meta-info to the incremental dumps, this should become unnecessary */
671 WANT_DIRECTORY_REMOVE_OPTION
673 int remove_any_file (const char *file_name
, enum remove_option option
);
674 bool maybe_backup_file (const char *file_name
, bool this_is_the_archive
);
675 void undo_last_backup (void);
677 int deref_stat (char const *name
, struct stat
*buf
);
679 size_t blocking_read (int fd
, void *buf
, size_t count
);
680 size_t blocking_write (int fd
, void const *buf
, size_t count
);
682 extern int chdir_current
;
684 int chdir_arg (char const *dir
);
685 void chdir_do (int dir
);
686 int chdir_count (void);
688 void close_diag (char const *name
);
689 void open_diag (char const *name
);
690 void read_diag_details (char const *name
, off_t offset
, size_t size
);
691 void readlink_diag (char const *name
);
692 void savedir_diag (char const *name
);
693 void seek_diag_details (char const *name
, off_t offset
);
694 void stat_diag (char const *name
);
695 void file_removed_diag (const char *name
, bool top_level
,
696 void (*diagfn
) (char const *name
));
697 void write_error_details (char const *name
, size_t status
, size_t size
);
698 void write_fatal (char const *name
) __attribute__ ((noreturn
));
699 void write_fatal_details (char const *name
, ssize_t status
, size_t size
)
700 __attribute__ ((noreturn
));
703 void xpipe (int fd
[2]);
705 void *page_aligned_alloc (void **ptr
, size_t size
);
706 int set_file_atime (int fd
, int parentfd
, char const *file
,
707 struct timespec atime
);
709 /* Module names.c. */
711 extern size_t name_count
;
712 extern struct name
*gnu_list_name
;
714 void gid_to_gname (gid_t gid
, char **gname
);
715 int gname_to_gid (char const *gname
, gid_t
*pgid
);
716 void uid_to_uname (uid_t uid
, char **uname
);
717 int uname_to_uid (char const *uname
, uid_t
*puid
);
719 void name_init (void);
720 void name_add_name (const char *name
, int matching_flags
);
721 void name_add_dir (const char *name
);
722 void name_add_file (const char *name
, int term
);
723 void name_term (void);
724 const char *name_next (int change_dirs
);
725 void name_gather (void);
726 struct name
*addname (char const *string
, int change_dir
,
727 bool cmdline
, struct name
*parent
);
728 void remname (struct name
*name
);
729 bool name_match (const char *name
);
730 void names_notfound (void);
731 void label_notfound (void);
732 void collect_and_sort_names (void);
733 struct name
*name_scan (const char *name
);
734 struct name
const *name_from_list (void);
735 void blank_name_list (void);
736 char *new_name (const char *dir_name
, const char *name
);
737 size_t stripped_prefix_len (char const *file_name
, size_t num
);
738 bool all_names_found (struct tar_stat_info
*st
);
740 bool excluded_name (char const *name
);
742 void add_avoided_name (char const *name
);
743 bool is_avoided_name (char const *name
);
745 bool contains_dot_dot (char const *name
);
747 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
748 (c)->found_count == occurrence_option)
749 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
750 (c)->found_count >= occurrence_option)
756 int confirm (const char *message_action
, const char *name
);
758 void tar_stat_init (struct tar_stat_info
*st
);
759 bool tar_stat_close (struct tar_stat_info
*st
);
760 void tar_stat_destroy (struct tar_stat_info
*st
);
761 void usage (int) __attribute__ ((noreturn
));
762 int tar_timespec_cmp (struct timespec a
, struct timespec b
);
763 const char *archive_format_string (enum archive_format fmt
);
764 const char *subcommand_string (enum subcommand c
);
765 void set_exit_status (int val
);
767 void request_stdin (const char *option
);
768 void more_options (int argc
, char **argv
);
770 /* Module update.c. */
772 extern char *output_start
;
774 void update_archive (void);
776 /* Module attrs.c. */
779 /* Module xheader.c. */
781 void xheader_decode (struct tar_stat_info
*stat
);
782 void xheader_decode_global (struct xheader
*xhdr
);
783 void xheader_store (char const *keyword
, struct tar_stat_info
*st
,
785 void xheader_read (struct xheader
*xhdr
, union block
*header
, off_t size
);
786 void xheader_write (char type
, char *name
, time_t t
, struct xheader
*xhdr
);
787 void xheader_write_global (struct xheader
*xhdr
);
788 void xheader_finish (struct xheader
*hdr
);
789 void xheader_destroy (struct xheader
*hdr
);
790 char *xheader_xhdr_name (struct tar_stat_info
*st
);
791 char *xheader_ghdr_name (void);
792 void xheader_set_option (char *string
);
793 void xheader_string_begin (struct xheader
*xhdr
);
794 void xheader_string_add (struct xheader
*xhdr
, char const *s
);
795 bool xheader_string_end (struct xheader
*xhdr
, char const *keyword
);
796 bool xheader_keyword_deleted_p (const char *kw
);
797 char *xheader_format_name (struct tar_stat_info
*st
, const char *fmt
,
799 void xheader_xattr_init (struct tar_stat_info
*st
);
800 void xheader_xattr_free (struct xattr_array
*vals
, size_t sz
);
801 void xheader_xattr_copy (const struct tar_stat_info
*st
,
802 struct xattr_array
**vals
, size_t *sz
);
803 void xheader_xattr_add (struct tar_stat_info
*st
,
804 const char *key
, const char *val
, size_t len
);
806 /* Module system.c */
808 void sys_detect_dev_null_output (void);
809 void sys_save_archive_dev_ino (void);
810 void sys_wait_for_child (pid_t
, bool);
811 void sys_spawn_shell (void);
812 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
813 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
814 bool sys_file_is_archive (struct tar_stat_info
*p
);
815 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
816 int sys_truncate (int fd
);
817 pid_t
sys_child_open_for_compress (void);
818 pid_t
sys_child_open_for_uncompress (void);
819 size_t sys_write_archive_buffer (void);
820 bool sys_get_archive_stat (void);
821 int sys_exec_command (char *file_name
, int typechar
, struct tar_stat_info
*st
);
822 void sys_wait_command (void);
823 int sys_exec_info_script (const char **archive_name
, int volume_number
);
824 void sys_exec_checkpoint_script (const char *script_name
,
825 const char *archive_name
,
826 int checkpoint_number
);
828 /* Module compare.c */
829 void report_difference (struct tar_stat_info
*st
, const char *message
, ...)
830 __attribute__ ((format (printf
, 2, 3)));
832 /* Module sparse.c */
833 bool sparse_member_p (struct tar_stat_info
*st
);
834 bool sparse_fixup_header (struct tar_stat_info
*st
);
835 enum dump_status
sparse_dump_file (int, struct tar_stat_info
*st
);
836 enum dump_status
sparse_extract_file (int fd
, struct tar_stat_info
*st
,
838 enum dump_status
sparse_skip_file (struct tar_stat_info
*st
);
839 bool sparse_diff_file (int, struct tar_stat_info
*st
);
842 bool string_ascii_p (const char *str
);
843 bool utf8_convert (bool to_utf
, char const *input
, char **output
);
845 /* Module transform.c */
846 #define XFORM_REGFILE 0x01
847 #define XFORM_LINK 0x02
848 #define XFORM_SYMLINK 0x04
849 #define XFORM_ALL (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
851 void set_transform_expr (const char *expr
);
852 bool transform_name (char **pinput
, int type
);
853 bool transform_name_fp (char **pinput
, int type
,
854 char *(*fun
)(char *, void *), void *);
855 bool transform_program_p (void);
857 /* Module suffix.c */
858 void set_compression_program_by_suffix (const char *name
, const char *defprog
);
860 /* Module checkpoint.c */
861 void checkpoint_compile_action (const char *str
);
862 void checkpoint_finish_compile (void);
863 void checkpoint_run (bool do_write
);
864 void checkpoint_finish (void);
865 void checkpoint_flush_actions (void);
867 /* Module warning.c */
868 #define WARN_ALONE_ZERO_BLOCK 0x00000001
869 #define WARN_BAD_DUMPDIR 0x00000002
870 #define WARN_CACHEDIR 0x00000004
871 #define WARN_CONTIGUOUS_CAST 0x00000008
872 #define WARN_FILE_CHANGED 0x00000010
873 #define WARN_FILE_IGNORED 0x00000020
874 #define WARN_FILE_REMOVED 0x00000040
875 #define WARN_FILE_SHRANK 0x00000080
876 #define WARN_FILE_UNCHANGED 0x00000100
877 #define WARN_FILENAME_WITH_NULS 0x00000200
878 #define WARN_IGNORE_ARCHIVE 0x00000400
879 #define WARN_IGNORE_NEWER 0x00000800
880 #define WARN_NEW_DIRECTORY 0x00001000
881 #define WARN_RENAME_DIRECTORY 0x00002000
882 #define WARN_SYMLINK_CAST 0x00004000
883 #define WARN_TIMESTAMP 0x00008000
884 #define WARN_UNKNOWN_CAST 0x00010000
885 #define WARN_UNKNOWN_KEYWORD 0x00020000
886 #define WARN_XDEV 0x00040000
887 #define WARN_DECOMPRESS_PROGRAM 0x00080000
888 #define WARN_EXISTING_FILE 0x00100000
889 #define WARN_XATTR_WRITE 0x00200000
890 #define WARN_RECORD_SIZE 0x00400000
892 /* These warnings are enabled by default in verbose mode: */
893 #define WARN_VERBOSE_WARNINGS (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY|\
894 WARN_DECOMPRESS_PROGRAM|WARN_EXISTING_FILE|\
896 #define WARN_ALL (~WARN_VERBOSE_WARNINGS)
898 void set_warning_option (const char *arg
);
900 extern int warning_option
;
902 #define WARNOPT(opt,args) \
905 if (warning_option & opt) WARN (args); \
909 /* Module unlink.c */
911 void queue_deferred_unlink (const char *name
, bool is_dir
);
912 void finish_deferred_unlinks (void);
915 extern void (*fatal_exit_hook
) (void);
917 _GL_INLINE_HEADER_END