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 /* Specified file name for incremental list. */
194 GLOBAL
const char *listed_incremental_option
;
195 /* Incremental dump level */
196 GLOBAL
int incremental_level
;
197 /* Check device numbers when doing incremental dumps. */
198 GLOBAL
bool check_device_option
;
200 /* Specified mode change string. */
201 GLOBAL
struct mode_change
*mode_option
;
203 /* Initial umask, if needed for mode change string. */
204 GLOBAL mode_t initial_umask
;
206 GLOBAL
bool multi_volume_option
;
208 /* Specified threshold date and time. Files having an older time stamp
209 do not get archived (also see after_date_option above). */
210 GLOBAL
struct timespec newer_mtime_option
;
212 /* If true, override actual mtime (see below) */
213 GLOBAL
bool set_mtime_option
;
214 /* Value to be put in mtime header field instead of the actual mtime */
215 GLOBAL
struct timespec mtime_option
;
217 /* Return true if newer_mtime_option is initialized. */
218 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
220 /* Return true if the struct stat ST's M time is less than
221 newer_mtime_option. */
222 #define OLDER_STAT_TIME(st, m) \
223 (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
225 /* Likewise, for struct tar_stat_info ST. */
226 #define OLDER_TAR_STAT_TIME(st, m) \
227 (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
229 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
230 GLOBAL
int recursion_option
;
232 GLOBAL
bool numeric_owner_option
;
234 GLOBAL
bool one_file_system_option
;
236 /* Specified value to be put into tar file in place of stat () results, or
237 just null and -1 if such an override should not take place. */
238 GLOBAL
char const *owner_name_option
;
239 GLOBAL uid_t owner_option
;
241 GLOBAL
bool recursive_unlink_option
;
243 GLOBAL
bool read_full_records_option
;
245 GLOBAL
bool remove_files_option
;
247 /* Specified remote shell command. */
248 GLOBAL
const char *rsh_command_option
;
250 GLOBAL
bool same_order_option
;
252 /* If positive, preserve ownership when extracting. */
253 GLOBAL
int same_owner_option
;
255 /* If positive, preserve permissions when extracting. */
256 GLOBAL
int same_permissions_option
;
258 /* If positive, save the SELinux context. */
259 GLOBAL
int selinux_context_option
;
261 /* If positive, save the ACLs. */
262 GLOBAL
int acls_option
;
264 /* If positive, save the user and root xattrs. */
265 GLOBAL
int xattrs_option
;
267 /* When set, strip the given number of file name components from the file name
269 GLOBAL
size_t strip_name_components
;
271 GLOBAL
bool show_omitted_dirs_option
;
273 GLOBAL
bool sparse_option
;
274 GLOBAL
unsigned tar_sparse_major
;
275 GLOBAL
unsigned tar_sparse_minor
;
277 GLOBAL
bool starting_file_option
;
279 /* Specified maximum byte length of each tape volume (multiple of 1024). */
280 GLOBAL tarlong tape_length_option
;
282 GLOBAL
bool to_stdout_option
;
284 GLOBAL
bool totals_option
;
286 GLOBAL
bool touch_option
;
288 GLOBAL
char *to_command_option
;
289 GLOBAL
bool ignore_command_error_option
;
291 /* Restrict some potentially harmful tar options */
292 GLOBAL
bool restrict_option
;
294 /* Return true if the extracted files are not being written to disk */
295 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
297 /* Count how many times the option has been set, multiple setting yields
298 more verbose behavior. Value 0 means no verbosity, 1 means file name
299 only, 2 means file name and all attributes. More than 2 is just like 2. */
300 GLOBAL
int verbose_option
;
302 GLOBAL
bool verify_option
;
304 /* Specified name of file containing the volume number. */
305 GLOBAL
const char *volno_file_option
;
307 /* Specified value or pattern. */
308 GLOBAL
const char *volume_label_option
;
310 /* Other global variables. */
312 /* File descriptor for archive file. */
315 /* Nonzero when outputting to /dev/null. */
316 GLOBAL
bool dev_null_output
;
319 GLOBAL
struct timespec start_time
; /* when we started execution */
320 GLOBAL
struct timespec volume_start_time
; /* when the current volume was
322 GLOBAL
struct timespec last_stat_time
; /* when the statistics was last
325 GLOBAL
struct tar_stat_info current_stat_info
;
327 /* List of tape drive names, number of such tape drives,
328 and current cursor in list. */
329 GLOBAL
const char **archive_name_array
;
330 GLOBAL
size_t archive_names
;
331 GLOBAL
const char **archive_name_cursor
;
333 /* Output index file name. */
334 GLOBAL
char const *index_file_name
;
336 /* Opaque structure for keeping directory meta-data */
339 /* Structure for keeping track of filenames and lists thereof. */
342 struct name
*next
; /* Link to the next element */
343 struct name
*prev
; /* Link to the previous element */
345 char *name
; /* File name or globbing pattern */
346 size_t length
; /* cached strlen (name) */
347 int matching_flags
; /* wildcard flags if name is a pattern */
348 bool cmdline
; /* true if this name was given in the
351 int change_dir
; /* Number of the directory to change to.
352 Set with the -C option. */
353 uintmax_t found_count
; /* number of times a matching file has
356 /* The following members are used for incremental dumps only,
357 if this struct name represents a directory;
359 struct directory
*directory
;/* directory meta-data and contents */
360 struct name
*parent
; /* pointer to the parent hierarchy */
361 struct name
*child
; /* pointer to the first child */
362 struct name
*sibling
; /* pointer to the next sibling */
363 char *caname
; /* canonical name */
366 /* Obnoxious test to see if dimwit is trying to dump the archive. */
370 /* Flags for reading, searching, and fstatatting files. */
371 GLOBAL
int open_read_flags
;
372 GLOBAL
int open_searchdir_flags
;
373 GLOBAL
int fstatat_flags
;
375 GLOBAL
int seek_option
;
376 GLOBAL
bool seekable_archive
;
378 GLOBAL dev_t root_device
;
380 /* Unquote filenames */
381 GLOBAL
bool unquote_option
;
383 /* Show file or archive names after transformation.
384 In particular, when creating archive in verbose mode, list member names
385 as stored in the archive */
386 GLOBAL
bool show_transformed_names_option
;
388 /* Delay setting modification times and permissions of extracted directories
389 until the end of extraction. This variable helps correctly restore directory
390 timestamps from archives with an unusual member order. It is automatically
391 set for incremental archives. */
392 GLOBAL
bool delay_directory_restore_option
;
394 /* Warn about implicit use of the wildcards in command line arguments.
395 (Default for tar prior to 1.15.91, but changed afterwards */
396 GLOBAL
bool warn_regex_usage
;
398 /* Declarations for each module. */
400 /* FIXME: compare.c should not directly handle the following variable,
401 instead, this should be done in buffer.c only. */
409 extern enum access_mode access_mode
;
411 /* Module buffer.c. */
414 extern bool write_archive_to_stdout
;
415 extern char *volume_label
;
416 extern size_t volume_label_count
;
417 extern char *continued_file_name
;
418 extern uintmax_t continued_file_size
;
419 extern uintmax_t continued_file_offset
;
420 extern off_t records_written
;
422 char *drop_volume_label_suffix (const char *label
);
424 size_t available_space_after (union block
*pointer
);
425 off_t
current_block_ordinal (void);
426 void close_archive (void);
427 void closeout_volume_number (void);
428 void compute_duration (void);
429 union block
*find_next_block (void);
430 void flush_read (void);
431 void flush_write (void);
432 void flush_archive (void);
433 void init_volume_number (void);
434 void open_archive (enum access_mode mode
);
435 void print_total_stats (void);
436 void reset_eof (void);
437 void set_next_block_after (union block
*block
);
438 void clear_read_error_count (void);
439 void xclose (int fd
);
440 void archive_write_error (ssize_t status
) __attribute__ ((noreturn
));
441 void archive_read_error (void);
442 off_t
seek_archive (off_t size
);
443 void set_start_time (void);
445 void mv_begin_write (const char *file_name
, off_t totsize
, off_t sizeleft
);
447 void mv_begin_read (struct tar_stat_info
*st
);
449 void mv_size_left (off_t size
);
451 void buffer_write_global_xheader (void);
453 const char *first_decompress_program (int *pstate
);
454 const char *next_decompress_program (int *pstate
);
456 /* Module create.c. */
463 dump_status_not_implemented
466 void add_exclusion_tag (const char *name
, enum exclusion_tag_type type
,
467 bool (*predicate
) (int));
468 bool cachedir_file_p (int fd
);
469 char *get_directory_entries (struct tar_stat_info
*st
);
471 void create_archive (void);
472 void pad_archive (off_t size_left
);
473 void dump_file (struct tar_stat_info
*parent
, char const *name
,
474 char const *fullname
);
475 union block
*start_header (struct tar_stat_info
*st
);
476 void finish_header (struct tar_stat_info
*st
, union block
*header
,
477 off_t block_ordinal
);
478 void simple_finish_header (union block
*header
);
479 union block
* write_extended (bool global
, struct tar_stat_info
*st
,
480 union block
*old_header
);
481 union block
*start_private_header (const char *name
, size_t size
, time_t t
);
482 void write_eot (void);
483 void check_links (void);
484 int subfile_open (struct tar_stat_info
const *dir
, char const *file
, int flags
);
485 void restore_parent_fd (struct tar_stat_info
const *st
);
486 void exclusion_tag_warning (const char *dirname
, const char *tagname
,
487 const char *message
);
488 enum exclusion_tag_type
check_exclusion_tags (struct tar_stat_info
const *st
,
489 const char **tag_file_name
);
491 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
492 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
494 bool off_to_chars (off_t off
, char *buf
, size_t size
);
495 bool time_to_chars (time_t t
, char *buf
, size_t size
);
497 /* Module diffarch.c. */
499 extern bool now_verifying
;
501 void diff_archive (void);
502 void diff_init (void);
503 void verify_volume (void);
505 /* Module extract.c. */
507 void extr_init (void);
508 void extract_archive (void);
509 void extract_finish (void);
510 bool rename_directory (char *src
, char *dst
);
512 /* Module delete.c. */
514 void delete_archive_members (void);
516 /* Module incremen.c. */
518 struct directory
*scan_directory (struct tar_stat_info
*st
);
519 const char *directory_contents (struct directory
*dir
);
520 const char *safe_directory_contents (struct directory
*dir
);
522 void rebase_directory (struct directory
*dir
,
523 const char *samp
, size_t slen
,
524 const char *repl
, size_t rlen
);
526 void append_incremental_renames (struct directory
*dir
);
527 void show_snapshot_field_ranges (void);
528 void read_directory_file (void);
529 void write_directory_file (void);
530 void purge_directory (char const *directory_name
);
531 void list_dumpdir (char *buffer
, size_t size
);
532 void update_parent_directory (struct tar_stat_info
*st
);
534 size_t dumpdir_size (const char *p
);
535 bool is_dumpdir (struct tar_stat_info
*stat_info
);
536 void clear_directory_table (void);
542 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
543 HEADER_SUCCESS
, /* header successfully read and checksummed */
544 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
545 HEADER_ZERO_BLOCK
, /* zero block where header expected */
546 HEADER_END_OF_FILE
, /* true end of file while header expected */
547 HEADER_FAILURE
/* ill-formed header, or bad checksum */
550 /* Operation mode for read_header: */
552 enum read_header_mode
554 read_header_auto
, /* process extended headers automatically */
555 read_header_x_raw
, /* return raw extended headers (return
556 HEADER_SUCCESS_EXTENDED) */
557 read_header_x_global
/* when POSIX global extended header is read,
559 HEADER_SUCCESS_EXTENDED */
561 extern union block
*current_header
;
562 extern enum archive_format current_format
;
563 extern size_t recent_long_name_blocks
;
564 extern size_t recent_long_link_blocks
;
566 void decode_header (union block
*header
, struct tar_stat_info
*stat_info
,
567 enum archive_format
*format_pointer
, int do_user_group
);
568 void transform_stat_info (int typeflag
, struct tar_stat_info
*stat_info
);
569 char const *tartime (struct timespec t
, bool full_time
);
571 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
572 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
574 off_t
off_from_header (const char *buf
, size_t size
);
575 uintmax_t uintmax_from_header (const char *buf
, size_t size
);
577 void list_archive (void);
578 void test_archive_label (void);
579 void print_for_mkdir (char *dirname
, int length
, mode_t mode
);
580 void print_header (struct tar_stat_info
*st
, union block
*blk
,
581 off_t block_ordinal
);
582 void read_and (void (*do_something
) (void));
583 enum read_header
read_header (union block
**return_block
,
584 struct tar_stat_info
*info
,
585 enum read_header_mode m
);
586 enum read_header
tar_checksum (union block
*header
, bool silent
);
587 void skip_file (off_t size
);
588 void skip_member (void);
592 #define min(a, b) ((a) < (b) ? (a) : (b))
593 #define max(a, b) ((a) < (b) ? (b) : (a))
594 void assign_string (char **dest
, const char *src
);
595 int unquote_string (char *str
);
596 char *zap_slashes (char *name
);
597 char *normalize_filename (const char *name
);
598 void replace_prefix (char **pname
, const char *samp
, size_t slen
,
599 const char *repl
, size_t rlen
);
600 char *tar_savedir (const char *name
, int must_exist
);
602 typedef struct namebuf
*namebuf_t
;
603 namebuf_t
namebuf_create (const char *dir
);
604 void namebuf_free (namebuf_t buf
);
605 char *namebuf_name (namebuf_t buf
, const char *name
);
607 /* Represent N using a signed integer I such that (uintmax_t) I == N.
608 With a good optimizing compiler, this is equivalent to (intmax_t) i
609 and requires zero machine instructions. */
610 #if ! (UINTMAX_MAX / 2 <= INTMAX_MAX)
611 # error "represent_uintmax returns intmax_t to represent uintmax_t"
613 COMMON_INLINE
intmax_t
614 represent_uintmax (uintmax_t n
)
620 /* Avoid signed integer overflow on picky platforms. */
621 intmax_t nd
= n
- INTMAX_MIN
;
622 return nd
+ INTMAX_MIN
;
626 enum { SYSINT_BUFSIZE
=
627 max (UINTMAX_STRSIZE_BOUND
, INT_BUFSIZE_BOUND (intmax_t)) };
628 char *sysinttostr (uintmax_t, intmax_t, uintmax_t, char buf
[SYSINT_BUFSIZE
]);
629 intmax_t strtosysint (char const *, char **, intmax_t, uintmax_t);
630 void code_ns_fraction (int ns
, char *p
);
631 char const *code_timespec (struct timespec ts
, char *sbuf
);
632 enum { BILLION
= 1000000000, LOG10_BILLION
= 9 };
633 enum { TIMESPEC_STRSIZE_BOUND
=
634 UINTMAX_STRSIZE_BOUND
+ LOG10_BILLION
+ sizeof "-." - 1 };
635 struct timespec
decode_timespec (char const *, char **, bool);
637 /* Return true if T does not represent an out-of-range or invalid value. */
639 valid_timespec (struct timespec t
)
641 return 0 <= t
.tv_nsec
;
644 bool must_be_dot_or_slash (char const *);
648 ORDINARY_REMOVE_OPTION
,
649 RECURSIVE_REMOVE_OPTION
,
651 /* FIXME: The following value is never used. It seems to be intended
652 as a placeholder for a hypothetical option that should instruct tar
653 to recursively remove subdirectories in purge_directory(),
654 as opposed to the functionality of --recursive-unlink
655 (RECURSIVE_REMOVE_OPTION value), which removes them in
656 prepare_to_extract() phase. However, with the addition of more
657 meta-info to the incremental dumps, this should become unnecessary */
658 WANT_DIRECTORY_REMOVE_OPTION
660 int remove_any_file (const char *file_name
, enum remove_option option
);
661 bool maybe_backup_file (const char *file_name
, bool this_is_the_archive
);
662 void undo_last_backup (void);
664 int deref_stat (char const *name
, struct stat
*buf
);
666 size_t blocking_read (int fd
, void *buf
, size_t count
);
667 size_t blocking_write (int fd
, void const *buf
, size_t count
);
669 extern int chdir_current
;
671 int chdir_arg (char const *dir
);
672 void chdir_do (int dir
);
673 int chdir_count (void);
675 void close_diag (char const *name
);
676 void open_diag (char const *name
);
677 void read_diag_details (char const *name
, off_t offset
, size_t size
);
678 void readlink_diag (char const *name
);
679 void savedir_diag (char const *name
);
680 void seek_diag_details (char const *name
, off_t offset
);
681 void stat_diag (char const *name
);
682 void file_removed_diag (const char *name
, bool top_level
,
683 void (*diagfn
) (char const *name
));
684 void write_error_details (char const *name
, size_t status
, size_t size
);
685 void write_fatal (char const *name
) __attribute__ ((noreturn
));
686 void write_fatal_details (char const *name
, ssize_t status
, size_t size
)
687 __attribute__ ((noreturn
));
690 void xpipe (int fd
[2]);
692 void *page_aligned_alloc (void **ptr
, size_t size
);
693 int set_file_atime (int fd
, int parentfd
, char const *file
,
694 struct timespec atime
);
696 /* Module names.c. */
698 extern size_t name_count
;
699 extern struct name
*gnu_list_name
;
701 void gid_to_gname (gid_t gid
, char **gname
);
702 int gname_to_gid (char const *gname
, gid_t
*pgid
);
703 void uid_to_uname (uid_t uid
, char **uname
);
704 int uname_to_uid (char const *uname
, uid_t
*puid
);
706 void name_init (void);
707 void name_add_name (const char *name
, int matching_flags
);
708 void name_add_dir (const char *name
);
709 void name_add_file (const char *name
, int term
);
710 void name_term (void);
711 const char *name_next (int change_dirs
);
712 void name_gather (void);
713 struct name
*addname (char const *string
, int change_dir
,
714 bool cmdline
, struct name
*parent
);
715 void remname (struct name
*name
);
716 bool name_match (const char *name
);
717 void names_notfound (void);
718 void label_notfound (void);
719 void collect_and_sort_names (void);
720 struct name
*name_scan (const char *name
);
721 struct name
const *name_from_list (void);
722 void blank_name_list (void);
723 char *new_name (const char *dir_name
, const char *name
);
724 size_t stripped_prefix_len (char const *file_name
, size_t num
);
725 bool all_names_found (struct tar_stat_info
*st
);
727 bool excluded_name (char const *name
);
729 void add_avoided_name (char const *name
);
730 bool is_avoided_name (char const *name
);
732 bool contains_dot_dot (char const *name
);
734 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
735 (c)->found_count == occurrence_option)
736 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
737 (c)->found_count >= occurrence_option)
743 int confirm (const char *message_action
, const char *name
);
745 void tar_stat_init (struct tar_stat_info
*st
);
746 bool tar_stat_close (struct tar_stat_info
*st
);
747 void tar_stat_destroy (struct tar_stat_info
*st
);
748 void usage (int) __attribute__ ((noreturn
));
749 int tar_timespec_cmp (struct timespec a
, struct timespec b
);
750 const char *archive_format_string (enum archive_format fmt
);
751 const char *subcommand_string (enum subcommand c
);
752 void set_exit_status (int val
);
754 void request_stdin (const char *option
);
755 void more_options (int argc
, char **argv
);
757 /* Module update.c. */
759 extern char *output_start
;
761 void update_archive (void);
763 /* Module attrs.c. */
766 /* Module xheader.c. */
768 void xheader_decode (struct tar_stat_info
*stat
);
769 void xheader_decode_global (struct xheader
*xhdr
);
770 void xheader_store (char const *keyword
, struct tar_stat_info
*st
,
772 void xheader_read (struct xheader
*xhdr
, union block
*header
, off_t size
);
773 void xheader_write (char type
, char *name
, time_t t
, struct xheader
*xhdr
);
774 void xheader_write_global (struct xheader
*xhdr
);
775 void xheader_finish (struct xheader
*hdr
);
776 void xheader_destroy (struct xheader
*hdr
);
777 char *xheader_xhdr_name (struct tar_stat_info
*st
);
778 char *xheader_ghdr_name (void);
779 void xheader_set_option (char *string
);
780 void xheader_string_begin (struct xheader
*xhdr
);
781 void xheader_string_add (struct xheader
*xhdr
, char const *s
);
782 bool xheader_string_end (struct xheader
*xhdr
, char const *keyword
);
783 bool xheader_keyword_deleted_p (const char *kw
);
784 char *xheader_format_name (struct tar_stat_info
*st
, const char *fmt
,
786 void xheader_xattr_init (struct tar_stat_info
*st
);
787 void xheader_xattr_free (struct xattr_array
*vals
, size_t sz
);
788 void xheader_xattr_copy (const struct tar_stat_info
*st
,
789 struct xattr_array
**vals
, size_t *sz
);
790 void xheader_xattr_add (struct tar_stat_info
*st
,
791 const char *key
, const char *val
, size_t len
);
793 /* Module system.c */
795 void sys_detect_dev_null_output (void);
796 void sys_save_archive_dev_ino (void);
797 void sys_wait_for_child (pid_t
, bool);
798 void sys_spawn_shell (void);
799 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
800 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
801 bool sys_file_is_archive (struct tar_stat_info
*p
);
802 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
803 int sys_truncate (int fd
);
804 pid_t
sys_child_open_for_compress (void);
805 pid_t
sys_child_open_for_uncompress (void);
806 size_t sys_write_archive_buffer (void);
807 bool sys_get_archive_stat (void);
808 int sys_exec_command (char *file_name
, int typechar
, struct tar_stat_info
*st
);
809 void sys_wait_command (void);
810 int sys_exec_info_script (const char **archive_name
, int volume_number
);
811 void sys_exec_checkpoint_script (const char *script_name
,
812 const char *archive_name
,
813 int checkpoint_number
);
815 /* Module compare.c */
816 void report_difference (struct tar_stat_info
*st
, const char *message
, ...)
817 __attribute__ ((format (printf
, 2, 3)));
819 /* Module sparse.c */
820 bool sparse_member_p (struct tar_stat_info
*st
);
821 bool sparse_fixup_header (struct tar_stat_info
*st
);
822 enum dump_status
sparse_dump_file (int, struct tar_stat_info
*st
);
823 enum dump_status
sparse_extract_file (int fd
, struct tar_stat_info
*st
,
825 enum dump_status
sparse_skip_file (struct tar_stat_info
*st
);
826 bool sparse_diff_file (int, struct tar_stat_info
*st
);
829 bool string_ascii_p (const char *str
);
830 bool utf8_convert (bool to_utf
, char const *input
, char **output
);
832 /* Module transform.c */
833 #define XFORM_REGFILE 0x01
834 #define XFORM_LINK 0x02
835 #define XFORM_SYMLINK 0x04
836 #define XFORM_ALL (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
838 void set_transform_expr (const char *expr
);
839 bool transform_name (char **pinput
, int type
);
840 bool transform_name_fp (char **pinput
, int type
,
841 char *(*fun
)(char *, void *), void *);
842 bool transform_program_p (void);
844 /* Module suffix.c */
845 void set_compression_program_by_suffix (const char *name
, const char *defprog
);
847 /* Module checkpoint.c */
848 void checkpoint_compile_action (const char *str
);
849 void checkpoint_finish_compile (void);
850 void checkpoint_run (bool do_write
);
852 /* Module warning.c */
853 #define WARN_ALONE_ZERO_BLOCK 0x00000001
854 #define WARN_BAD_DUMPDIR 0x00000002
855 #define WARN_CACHEDIR 0x00000004
856 #define WARN_CONTIGUOUS_CAST 0x00000008
857 #define WARN_FILE_CHANGED 0x00000010
858 #define WARN_FILE_IGNORED 0x00000020
859 #define WARN_FILE_REMOVED 0x00000040
860 #define WARN_FILE_SHRANK 0x00000080
861 #define WARN_FILE_UNCHANGED 0x00000100
862 #define WARN_FILENAME_WITH_NULS 0x00000200
863 #define WARN_IGNORE_ARCHIVE 0x00000400
864 #define WARN_IGNORE_NEWER 0x00000800
865 #define WARN_NEW_DIRECTORY 0x00001000
866 #define WARN_RENAME_DIRECTORY 0x00002000
867 #define WARN_SYMLINK_CAST 0x00004000
868 #define WARN_TIMESTAMP 0x00008000
869 #define WARN_UNKNOWN_CAST 0x00010000
870 #define WARN_UNKNOWN_KEYWORD 0x00020000
871 #define WARN_XDEV 0x00040000
872 #define WARN_DECOMPRESS_PROGRAM 0x00080000
873 #define WARN_EXISTING_FILE 0x00100000
874 #define WARN_XATTR_WRITE 0x00200000
876 /* The warnings composing WARN_VERBOSE_WARNINGS are enabled by default
878 #define WARN_VERBOSE_WARNINGS (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY|\
879 WARN_DECOMPRESS_PROGRAM|WARN_EXISTING_FILE)
880 #define WARN_ALL (~WARN_VERBOSE_WARNINGS)
882 void set_warning_option (const char *arg
);
884 extern int warning_option
;
886 #define WARNOPT(opt,args) \
889 if (warning_option & opt) WARN (args); \
893 /* Module unlink.c */
895 void queue_deferred_unlink (const char *name
, bool is_dir
);
896 void finish_deferred_unlinks (void);
899 extern void (*fatal_exit_hook
) (void);
901 _GL_INLINE_HEADER_END