1 /* Common declarations for the tar program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
4 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation,
7 This program is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3, or (at your option) any later
12 This program is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
15 Public License for more details.
17 You should have received a copy of the GNU General Public License along
18 with this program; if not, write to the Free Software Foundation, Inc.,
19 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
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 /* Information gleaned from the command line. */
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 */
89 TEST_LABEL_SUBCOMMAND
, /* --test-label */
92 GLOBAL
enum subcommand subcommand_option
;
94 /* Selected format for output archive. */
95 GLOBAL
enum archive_format archive_format
;
97 /* Size of each record, once in blocks, once in bytes. Those two variables
98 are always related, the second being BLOCKSIZE times the first. They do
99 not have _option in their name, even if their values is derived from
100 option decoding, as these are especially important in tar. */
101 GLOBAL
int blocking_factor
;
102 GLOBAL
size_t record_size
;
104 GLOBAL
bool absolute_names_option
;
106 /* Display file times in UTC */
107 GLOBAL
bool utc_option
;
108 /* Output file timestamps to the full resolution */
109 GLOBAL
bool full_time_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
unsigned checkpoint_option
;
133 #define DEFAULT_CHECKPOINT 10
135 /* Specified name of compression program, or "gzip" as implied by -z. */
136 GLOBAL
const char *use_compress_program_option
;
138 GLOBAL
bool dereference_option
;
139 GLOBAL
bool hard_dereference_option
;
141 /* Print a message if not all links are dumped */
142 GLOBAL
int check_links_option
;
144 /* Patterns that match file names to be excluded. */
145 GLOBAL
struct exclude
*excluded
;
147 enum exclusion_tag_type
150 /* Exclude the directory contents, but preserve the directory
151 itself and the exclusion tag file */
152 exclusion_tag_contents
,
153 /* Exclude everything below the directory, preserving the directory
156 /* Exclude entire directory */
160 /* Specified value to be put into tar file in place of stat () results, or
161 just -1 if such an override should not take place. */
162 GLOBAL gid_t group_option
;
164 GLOBAL
bool ignore_failed_read_option
;
166 GLOBAL
bool ignore_zeros_option
;
168 GLOBAL
bool incremental_option
;
170 /* Specified name of script to run at end of each tape change. */
171 GLOBAL
const char *info_script_option
;
173 GLOBAL
bool interactive_option
;
175 /* If nonzero, extract only Nth occurrence of each named file */
176 GLOBAL
uintmax_t occurrence_option
;
180 DEFAULT_OLD_FILES
, /* default */
181 NO_OVERWRITE_DIR_OLD_FILES
, /* --no-overwrite-dir */
182 OVERWRITE_OLD_FILES
, /* --overwrite */
183 UNLINK_FIRST_OLD_FILES
, /* --unlink-first */
184 KEEP_OLD_FILES
, /* --keep-old-files */
185 KEEP_NEWER_FILES
/* --keep-newer-files */
187 GLOBAL
enum old_files old_files_option
;
189 /* Specified file name for incremental list. */
190 GLOBAL
const char *listed_incremental_option
;
191 /* Incremental dump level */
192 GLOBAL
int incremental_level
;
193 /* Check device numbers when doing incremental dumps. */
194 GLOBAL
bool check_device_option
;
196 /* Specified mode change string. */
197 GLOBAL
struct mode_change
*mode_option
;
199 /* Initial umask, if needed for mode change string. */
200 GLOBAL mode_t initial_umask
;
202 GLOBAL
bool multi_volume_option
;
204 /* Specified threshold date and time. Files having an older time stamp
205 do not get archived (also see after_date_option above). */
206 GLOBAL
struct timespec newer_mtime_option
;
208 /* If true, override actual mtime (see below) */
209 GLOBAL
bool set_mtime_option
;
210 /* Value to be put in mtime header field instead of the actual mtime */
211 GLOBAL
struct timespec mtime_option
;
213 /* Return true if newer_mtime_option is initialized. */
214 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
216 /* Return true if the struct stat ST's M time is less than
217 newer_mtime_option. */
218 #define OLDER_STAT_TIME(st, m) \
219 (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
221 /* Likewise, for struct tar_stat_info ST. */
222 #define OLDER_TAR_STAT_TIME(st, m) \
223 (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
225 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
226 GLOBAL
int recursion_option
;
228 GLOBAL
bool numeric_owner_option
;
230 GLOBAL
bool one_file_system_option
;
232 /* Specified value to be put into tar file in place of stat () results, or
233 just -1 if such an override should not take place. */
234 GLOBAL uid_t owner_option
;
236 GLOBAL
bool recursive_unlink_option
;
238 GLOBAL
bool read_full_records_option
;
240 GLOBAL
bool remove_files_option
;
242 /* Specified rmt command. */
243 GLOBAL
const char *rmt_command_option
;
245 /* Specified remote shell command. */
246 GLOBAL
const char *rsh_command_option
;
248 GLOBAL
bool same_order_option
;
250 /* If positive, preserve ownership when extracting. */
251 GLOBAL
int same_owner_option
;
253 /* If positive, preserve permissions when extracting. */
254 GLOBAL
int same_permissions_option
;
256 /* When set, strip the given number of file name components from the file name
258 GLOBAL
size_t strip_name_components
;
260 GLOBAL
bool show_omitted_dirs_option
;
262 GLOBAL
bool sparse_option
;
263 GLOBAL
unsigned tar_sparse_major
;
264 GLOBAL
unsigned tar_sparse_minor
;
266 GLOBAL
bool starting_file_option
;
268 /* Specified maximum byte length of each tape volume (multiple of 1024). */
269 GLOBAL tarlong tape_length_option
;
271 GLOBAL
bool to_stdout_option
;
273 GLOBAL
bool totals_option
;
275 GLOBAL
bool touch_option
;
277 GLOBAL
char *to_command_option
;
278 GLOBAL
bool ignore_command_error_option
;
280 /* Restrict some potentially harmful tar options */
281 GLOBAL
bool restrict_option
;
283 /* Return true if the extracted files are not being written to disk */
284 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
286 /* Count how many times the option has been set, multiple setting yields
287 more verbose behavior. Value 0 means no verbosity, 1 means file name
288 only, 2 means file name and all attributes. More than 2 is just like 2. */
289 GLOBAL
int verbose_option
;
291 GLOBAL
bool verify_option
;
293 /* Specified name of file containing the volume number. */
294 GLOBAL
const char *volno_file_option
;
296 /* Specified value or pattern. */
297 GLOBAL
const char *volume_label_option
;
299 /* Other global variables. */
301 /* File descriptor for archive file. */
304 /* Nonzero when outputting to /dev/null. */
305 GLOBAL
bool dev_null_output
;
308 GLOBAL
struct timespec start_time
; /* when we started execution */
309 GLOBAL
struct timespec volume_start_time
; /* when the current volume was
311 GLOBAL
struct timespec last_stat_time
; /* when the statistics was last
314 GLOBAL
struct tar_stat_info current_stat_info
;
316 /* List of tape drive names, number of such tape drives, allocated number,
317 and current cursor in list. */
318 GLOBAL
const char **archive_name_array
;
319 GLOBAL
size_t archive_names
;
320 GLOBAL
size_t allocated_archive_names
;
321 GLOBAL
const char **archive_name_cursor
;
323 /* Output index file name. */
324 GLOBAL
char const *index_file_name
;
326 /* Opaque structure for keeping directory meta-data */
329 /* Structure for keeping track of filenames and lists thereof. */
332 struct name
*next
; /* Link to the next element */
333 struct name
*prev
; /* Link to the previous element */
335 char *name
; /* File name or globbing pattern */
336 size_t length
; /* cached strlen (name) */
337 int matching_flags
; /* wildcard flags if name is a pattern */
338 bool cmdline
; /* true if this name was given in the
341 int change_dir
; /* Number of the directory to change to.
342 Set with the -C option. */
343 uintmax_t found_count
; /* number of times a matching file has
346 /* The following members are used for incremental dumps only,
347 if this struct name represents a directory;
349 struct directory
*directory
;/* directory meta-data and contents */
350 struct name
*parent
; /* pointer to the parent hierarchy */
351 struct name
*child
; /* pointer to the first child */
352 struct name
*sibling
; /* pointer to the next sibling */
353 char *caname
; /* canonical name */
356 /* Obnoxious test to see if dimwit is trying to dump the archive. */
360 /* Flags for reading and fstatatting arbitrary files. */
361 GLOBAL
int open_read_flags
;
362 GLOBAL
int fstatat_flags
;
364 GLOBAL
int seek_option
;
365 GLOBAL
bool seekable_archive
;
367 GLOBAL dev_t root_device
;
369 /* Unquote filenames */
370 GLOBAL
bool unquote_option
;
372 /* Show file or archive names after transformation.
373 In particular, when creating archive in verbose mode, list member names
374 as stored in the archive */
375 GLOBAL
bool show_transformed_names_option
;
377 /* Delay setting modification times and permissions of extracted directories
378 until the end of extraction. This variable helps correctly restore directory
379 timestamps from archives with an unusual member order. It is automatically
380 set for incremental archives. */
381 GLOBAL
bool delay_directory_restore_option
;
383 /* Warn about implicit use of the wildcards in command line arguments.
384 (Default for tar prior to 1.15.91, but changed afterwards */
385 GLOBAL
bool warn_regex_usage
;
387 /* Declarations for each module. */
389 /* FIXME: compare.c should not directly handle the following variable,
390 instead, this should be done in buffer.c only. */
398 extern enum access_mode access_mode
;
400 /* Module buffer.c. */
403 extern bool write_archive_to_stdout
;
404 extern char *volume_label
;
405 extern size_t volume_label_count
;
406 extern char *continued_file_name
;
407 extern uintmax_t continued_file_size
;
408 extern uintmax_t continued_file_offset
;
409 extern off_t records_written
;
411 char *drop_volume_label_suffix (const char *label
);
413 size_t available_space_after (union block
*pointer
);
414 off_t
current_block_ordinal (void);
415 void close_archive (void);
416 void closeout_volume_number (void);
417 void compute_duration (void);
418 union block
*find_next_block (void);
419 void flush_read (void);
420 void flush_write (void);
421 void flush_archive (void);
422 void init_volume_number (void);
423 void open_archive (enum access_mode mode
);
424 void print_total_stats (void);
425 void reset_eof (void);
426 void set_next_block_after (union block
*block
);
427 void clear_read_error_count (void);
428 void xclose (int fd
);
429 void archive_write_error (ssize_t status
) __attribute__ ((noreturn
));
430 void archive_read_error (void);
431 off_t
seek_archive (off_t size
);
432 void set_start_time (void);
434 void mv_begin_write (const char *file_name
, off_t totsize
, off_t sizeleft
);
436 void mv_begin_read (struct tar_stat_info
*st
);
438 void mv_size_left (off_t size
);
440 void buffer_write_global_xheader (void);
442 /* Module create.c. */
449 dump_status_not_implemented
452 void add_exclusion_tag (const char *name
, enum exclusion_tag_type type
,
453 bool (*predicate
) (int));
454 bool cachedir_file_p (int fd
);
456 void create_archive (void);
457 void pad_archive (off_t size_left
);
458 void dump_file (struct tar_stat_info
*parent
, char const *name
,
459 char const *fullname
);
460 union block
*start_header (struct tar_stat_info
*st
);
461 void finish_header (struct tar_stat_info
*st
, union block
*header
,
462 off_t block_ordinal
);
463 void simple_finish_header (union block
*header
);
464 union block
* write_extended (bool global
, struct tar_stat_info
*st
,
465 union block
*old_header
);
466 union block
*start_private_header (const char *name
, size_t size
, time_t t
);
467 void write_eot (void);
468 void check_links (void);
469 void exclusion_tag_warning (const char *dirname
, const char *tagname
,
470 const char *message
);
471 enum exclusion_tag_type
check_exclusion_tags (int dirfd
,
472 const char **tag_file_name
);
474 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
475 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
477 bool off_to_chars (off_t off
, char *buf
, size_t size
);
478 bool time_to_chars (time_t t
, char *buf
, size_t size
);
480 /* Module diffarch.c. */
482 extern bool now_verifying
;
484 void diff_archive (void);
485 void diff_init (void);
486 void verify_volume (void);
488 /* Module extract.c. */
490 void extr_init (void);
491 void extract_archive (void);
492 void extract_finish (void);
493 bool rename_directory (char *src
, char *dst
);
495 /* Module delete.c. */
497 void delete_archive_members (void);
499 /* Module incremen.c. */
501 struct directory
*scan_directory (struct tar_stat_info
*st
);
502 const char *directory_contents (struct directory
*dir
);
503 const char *safe_directory_contents (struct directory
*dir
);
505 void rebase_directory (struct directory
*dir
,
506 const char *samp
, size_t slen
,
507 const char *repl
, size_t rlen
);
509 void append_incremental_renames (struct directory
*dir
);
510 void read_directory_file (void);
511 void write_directory_file (void);
512 void purge_directory (char const *directory_name
);
513 void list_dumpdir (char *buffer
, size_t size
);
514 void update_parent_directory (struct tar_stat_info
*st
);
516 size_t dumpdir_size (const char *p
);
517 bool is_dumpdir (struct tar_stat_info
*stat_info
);
523 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
524 HEADER_SUCCESS
, /* header successfully read and checksummed */
525 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
526 HEADER_ZERO_BLOCK
, /* zero block where header expected */
527 HEADER_END_OF_FILE
, /* true end of file while header expected */
528 HEADER_FAILURE
/* ill-formed header, or bad checksum */
531 /* Operation mode for read_header: */
533 enum read_header_mode
535 read_header_auto
, /* process extended headers automatically */
536 read_header_x_raw
, /* return raw extended headers (return
537 HEADER_SUCCESS_EXTENDED) */
538 read_header_x_global
/* when POSIX global extended header is read,
540 HEADER_SUCCESS_EXTENDED */
542 extern union block
*current_header
;
543 extern enum archive_format current_format
;
544 extern size_t recent_long_name_blocks
;
545 extern size_t recent_long_link_blocks
;
547 void decode_header (union block
*header
, struct tar_stat_info
*stat_info
,
548 enum archive_format
*format_pointer
, int do_user_group
);
549 char const *tartime (struct timespec t
, bool full_time
);
551 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
552 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
554 off_t
off_from_header (const char *buf
, size_t size
);
555 uintmax_t uintmax_from_header (const char *buf
, size_t size
);
557 void list_archive (void);
558 void test_archive_label (void);
559 void print_for_mkdir (char *dirname
, int length
, mode_t mode
);
560 void print_header (struct tar_stat_info
*st
, union block
*blk
,
561 off_t block_ordinal
);
562 void read_and (void (*do_something
) (void));
563 enum read_header
read_header (union block
**return_block
,
564 struct tar_stat_info
*info
,
565 enum read_header_mode m
);
566 enum read_header
tar_checksum (union block
*header
, bool silent
);
567 void skip_file (off_t size
);
568 void skip_member (void);
572 void assign_string (char **dest
, const char *src
);
573 int unquote_string (char *str
);
574 char *zap_slashes (char *name
);
575 char *normalize_filename (const char *name
);
576 void replace_prefix (char **pname
, const char *samp
, size_t slen
,
577 const char *repl
, size_t rlen
);
579 typedef struct namebuf
*namebuf_t
;
580 namebuf_t
namebuf_create (const char *dir
);
581 void namebuf_free (namebuf_t buf
);
582 char *namebuf_name (namebuf_t buf
, const char *name
);
584 void code_ns_fraction (int ns
, char *p
);
585 char const *code_timespec (struct timespec ts
, char *sbuf
);
586 enum { BILLION
= 1000000000, LOG10_BILLION
= 9 };
587 enum { TIMESPEC_STRSIZE_BOUND
=
588 UINTMAX_STRSIZE_BOUND
+ LOG10_BILLION
+ sizeof "-." - 1 };
592 ORDINARY_REMOVE_OPTION
,
593 RECURSIVE_REMOVE_OPTION
,
595 /* FIXME: The following value is never used. It seems to be intended
596 as a placeholder for a hypothetical option that should instruct tar
597 to recursively remove subdirectories in purge_directory(),
598 as opposed to the functionality of --recursive-unlink
599 (RECURSIVE_REMOVE_OPTION value), which removes them in
600 prepare_to_extract() phase. However, with the addition of more
601 meta-info to the incremental dumps, this should become unnecessary */
602 WANT_DIRECTORY_REMOVE_OPTION
604 int remove_any_file (const char *file_name
, enum remove_option option
);
605 bool maybe_backup_file (const char *file_name
, bool this_is_the_archive
);
606 void undo_last_backup (void);
608 int deref_stat (bool deref
, char const *name
, struct stat
*buf
);
610 extern int chdir_current
;
611 int chdir_arg (char const *dir
);
612 void chdir_do (int dir
);
613 int chdir_count (void);
615 void close_diag (char const *name
);
616 void open_diag (char const *name
);
617 void read_diag_details (char const *name
, off_t offset
, size_t size
);
618 void readlink_diag (char const *name
);
619 void savedir_diag (char const *name
);
620 void seek_diag_details (char const *name
, off_t offset
);
621 void stat_diag (char const *name
);
622 void file_removed_diag (const char *name
, bool top_level
,
623 void (*diagfn
) (char const *name
));
624 void dir_removed_diag (char const *name
, bool top_level
,
625 void (*diagfn
) (char const *name
));
626 void write_error_details (char const *name
, size_t status
, size_t size
);
627 void write_fatal (char const *name
) __attribute__ ((noreturn
));
628 void write_fatal_details (char const *name
, ssize_t status
, size_t size
)
629 __attribute__ ((noreturn
));
632 void xpipe (int fd
[2]);
634 void *page_aligned_alloc (void **ptr
, size_t size
);
635 int set_file_atime (int fd
, char const *file
,
636 struct timespec
const timespec
[2]);
638 /* Module names.c. */
640 extern size_t name_count
;
641 extern struct name
*gnu_list_name
;
643 void gid_to_gname (gid_t gid
, char **gname
);
644 int gname_to_gid (char const *gname
, gid_t
*pgid
);
645 void uid_to_uname (uid_t uid
, char **uname
);
646 int uname_to_uid (char const *uname
, uid_t
*puid
);
648 void name_init (void);
649 void name_add_name (const char *name
, int matching_flags
);
650 void name_add_dir (const char *name
);
651 void name_term (void);
652 const char *name_next (int change_dirs
);
653 void name_gather (void);
654 struct name
*addname (char const *string
, int change_dir
,
655 bool cmdline
, struct name
*parent
);
656 void remname (struct name
*name
);
657 bool name_match (const char *name
);
658 void names_notfound (void);
659 void label_notfound (void);
660 void collect_and_sort_names (void);
661 struct name
*name_scan (const char *name
);
662 struct name
const *name_from_list (void);
663 void blank_name_list (void);
664 char *new_name (const char *dir_name
, const char *name
);
665 size_t stripped_prefix_len (char const *file_name
, size_t num
);
666 bool all_names_found (struct tar_stat_info
*st
);
668 bool excluded_name (char const *name
);
670 void add_avoided_name (char const *name
);
671 bool is_avoided_name (char const *name
);
672 bool is_individual_file (char const *name
);
674 bool contains_dot_dot (char const *name
);
676 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
677 (c)->found_count == occurrence_option)
678 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
679 (c)->found_count >= occurrence_option)
685 int confirm (const char *message_action
, const char *name
);
687 void tar_stat_init (struct tar_stat_info
*st
);
688 void tar_stat_destroy (struct tar_stat_info
*st
);
689 void usage (int) __attribute__ ((noreturn
));
690 int tar_timespec_cmp (struct timespec a
, struct timespec b
);
691 const char *archive_format_string (enum archive_format fmt
);
692 const char *subcommand_string (enum subcommand c
);
693 void set_exit_status (int val
);
695 /* Module update.c. */
697 extern char *output_start
;
699 void update_archive (void);
701 /* Module xheader.c. */
703 void xheader_decode (struct tar_stat_info
*stat
);
704 void xheader_decode_global (struct xheader
*xhdr
);
705 void xheader_store (char const *keyword
, struct tar_stat_info
*st
,
707 void xheader_read (struct xheader
*xhdr
, union block
*header
, size_t size
);
708 void xheader_write (char type
, char *name
, time_t t
, struct xheader
*xhdr
);
709 void xheader_write_global (struct xheader
*xhdr
);
710 void xheader_finish (struct xheader
*hdr
);
711 void xheader_destroy (struct xheader
*hdr
);
712 char *xheader_xhdr_name (struct tar_stat_info
*st
);
713 char *xheader_ghdr_name (void);
714 void xheader_set_option (char *string
);
715 void xheader_string_begin (struct xheader
*xhdr
);
716 void xheader_string_add (struct xheader
*xhdr
, char const *s
);
717 bool xheader_string_end (struct xheader
*xhdr
, char const *keyword
);
718 bool xheader_keyword_deleted_p (const char *kw
);
719 char *xheader_format_name (struct tar_stat_info
*st
, const char *fmt
,
722 /* Module system.c */
724 void sys_detect_dev_null_output (void);
725 void sys_save_archive_dev_ino (void);
726 void sys_wait_for_child (pid_t
, bool);
727 void sys_spawn_shell (void);
728 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
729 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
730 bool sys_file_is_archive (struct tar_stat_info
*p
);
731 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
732 int sys_truncate (int fd
);
733 pid_t
sys_child_open_for_compress (void);
734 pid_t
sys_child_open_for_uncompress (void);
735 size_t sys_write_archive_buffer (void);
736 bool sys_get_archive_stat (void);
737 int sys_exec_command (char *file_name
, int typechar
, struct tar_stat_info
*st
);
738 void sys_wait_command (void);
739 int sys_exec_info_script (const char **archive_name
, int volume_number
);
740 void sys_exec_checkpoint_script (const char *script_name
,
741 const char *archive_name
,
742 int checkpoint_number
);
744 /* Module compare.c */
745 void report_difference (struct tar_stat_info
*st
, const char *message
, ...);
747 /* Module sparse.c */
748 bool sparse_member_p (struct tar_stat_info
*st
);
749 bool sparse_fixup_header (struct tar_stat_info
*st
);
750 enum dump_status
sparse_dump_file (int, struct tar_stat_info
*st
);
751 enum dump_status
sparse_extract_file (int fd
, struct tar_stat_info
*st
,
753 enum dump_status
sparse_skip_file (struct tar_stat_info
*st
);
754 bool sparse_diff_file (int, struct tar_stat_info
*st
);
757 bool string_ascii_p (const char *str
);
758 bool utf8_convert (bool to_utf
, char const *input
, char **output
);
760 /* Module transform.c */
761 #define XFORM_REGFILE 0x01
762 #define XFORM_LINK 0x02
763 #define XFORM_SYMLINK 0x04
764 #define XFORM_ALL (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
766 void set_transform_expr (const char *expr
);
767 bool transform_name (char **pinput
, int type
);
768 bool transform_name_fp (char **pinput
, int type
,
769 char *(*fun
)(char *, void *), void *);
771 /* Module suffix.c */
772 void set_compression_program_by_suffix (const char *name
, const char *defprog
);
774 /* Module checkpoint.c */
775 void checkpoint_compile_action (const char *str
);
776 void checkpoint_finish_compile (void);
777 void checkpoint_run (bool do_write
);
779 /* Module warning.c */
780 #define WARN_ALONE_ZERO_BLOCK 0x00000001
781 #define WARN_BAD_DUMPDIR 0x00000002
782 #define WARN_CACHEDIR 0x00000004
783 #define WARN_CONTIGUOUS_CAST 0x00000008
784 #define WARN_FILE_CHANGED 0x00000010
785 #define WARN_FILE_IGNORED 0x00000020
786 #define WARN_FILE_REMOVED 0x00000040
787 #define WARN_FILE_SHRANK 0x00000080
788 #define WARN_FILE_UNCHANGED 0x00000100
789 #define WARN_FILENAME_WITH_NULS 0x00000200
790 #define WARN_IGNORE_ARCHIVE 0x00000400
791 #define WARN_IGNORE_NEWER 0x00000800
792 #define WARN_NEW_DIRECTORY 0x00001000
793 #define WARN_RENAME_DIRECTORY 0x00002000
794 #define WARN_SYMLINK_CAST 0x00004000
795 #define WARN_TIMESTAMP 0x00008000
796 #define WARN_UNKNOWN_CAST 0x00010000
797 #define WARN_UNKNOWN_KEYWORD 0x00020000
798 #define WARN_XDEV 0x00040000
800 /* The warnings composing WARN_VERBOSE_WARNINGS are enabled by default
802 #define WARN_VERBOSE_WARNINGS (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY)
803 #define WARN_ALL (~WARN_VERBOSE_WARNINGS)
805 void set_warning_option (const char *arg
);
807 extern int warning_option
;
809 #define WARNOPT(opt,args) \
812 if (warning_option & opt) WARN (args); \
816 /* Module unlink.c */
818 void queue_deferred_unlink (const char *name
, bool is_dir
);
819 void finish_deferred_unlinks (void);
822 extern void (*fatal_exit_hook
) (void);