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 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 3, 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
64 #include <xvasprintf.h>
68 /* Log base 2 of common values. */
73 /* Information gleaned from the command line. */
75 /* Main command option. */
79 UNKNOWN_SUBCOMMAND
, /* none of the following */
80 APPEND_SUBCOMMAND
, /* -r */
81 CAT_SUBCOMMAND
, /* -A */
82 CREATE_SUBCOMMAND
, /* -c */
83 DELETE_SUBCOMMAND
, /* -D */
84 DIFF_SUBCOMMAND
, /* -d */
85 EXTRACT_SUBCOMMAND
, /* -x */
86 LIST_SUBCOMMAND
, /* -t */
87 UPDATE_SUBCOMMAND
/* -u */
90 GLOBAL
enum subcommand subcommand_option
;
92 /* Selected format for output archive. */
93 GLOBAL
enum archive_format archive_format
;
95 /* Size of each record, once in blocks, once in bytes. Those two variables
96 are always related, the second being BLOCKSIZE times the first. They do
97 not have _option in their name, even if their values is derived from
98 option decoding, as these are especially important in tar. */
99 GLOBAL
int blocking_factor
;
100 GLOBAL
size_t record_size
;
102 GLOBAL
bool absolute_names_option
;
104 /* Display file times in UTC */
105 GLOBAL
bool utc_option
;
107 /* This variable tells how to interpret newer_mtime_option, below. If zero,
108 files get archived if their mtime is not less than newer_mtime_option.
109 If nonzero, files get archived if *either* their ctime or mtime is not less
110 than newer_mtime_option. */
111 GLOBAL
int after_date_option
;
116 replace_atime_preserve
,
117 system_atime_preserve
119 GLOBAL
enum atime_preserve atime_preserve_option
;
121 GLOBAL
bool backup_option
;
123 /* Type of backups being made. */
124 GLOBAL
enum backup_type backup_type
;
126 GLOBAL
bool block_number_option
;
128 GLOBAL
unsigned checkpoint_option
;
129 #define DEFAULT_CHECKPOINT 10
131 /* Specified name of compression program, or "gzip" as implied by -z. */
132 GLOBAL
const char *use_compress_program_option
;
134 GLOBAL
bool dereference_option
;
135 GLOBAL
bool hard_dereference_option
;
137 /* Print a message if not all links are dumped */
138 GLOBAL
int check_links_option
;
140 /* Patterns that match file names to be excluded. */
141 GLOBAL
struct exclude
*excluded
;
143 enum exclusion_tag_type
146 /* Exclude the directory contents, but preserve the directory
147 itself and the exclusion tag file */
148 exclusion_tag_contents
,
149 /* Exclude everything below the directory, preserving the directory
152 /* Exclude entire directory */
156 /* Specified value to be put into tar file in place of stat () results, or
157 just -1 if such an override should not take place. */
158 GLOBAL gid_t group_option
;
160 GLOBAL
bool ignore_failed_read_option
;
162 GLOBAL
bool ignore_zeros_option
;
164 GLOBAL
bool incremental_option
;
166 /* Specified name of script to run at end of each tape change. */
167 GLOBAL
const char *info_script_option
;
169 GLOBAL
bool interactive_option
;
171 /* If nonzero, extract only Nth occurrence of each named file */
172 GLOBAL
uintmax_t occurrence_option
;
176 DEFAULT_OLD_FILES
, /* default */
177 NO_OVERWRITE_DIR_OLD_FILES
, /* --no-overwrite-dir */
178 OVERWRITE_OLD_FILES
, /* --overwrite */
179 UNLINK_FIRST_OLD_FILES
, /* --unlink-first */
180 KEEP_OLD_FILES
, /* --keep-old-files */
181 KEEP_NEWER_FILES
/* --keep-newer-files */
183 GLOBAL
enum old_files old_files_option
;
185 /* Specified file name for incremental list. */
186 GLOBAL
const char *listed_incremental_option
;
187 /* Incremental dump level */
188 GLOBAL
int incremental_level
;
189 /* Check device numbers when doing incremental dumps. */
190 GLOBAL
bool check_device_option
;
192 /* Specified mode change string. */
193 GLOBAL
struct mode_change
*mode_option
;
195 /* Initial umask, if needed for mode change string. */
196 GLOBAL mode_t initial_umask
;
198 GLOBAL
bool multi_volume_option
;
200 /* Specified threshold date and time. Files having an older time stamp
201 do not get archived (also see after_date_option above). */
202 GLOBAL
struct timespec newer_mtime_option
;
204 /* If true, override actual mtime (see below) */
205 GLOBAL
bool set_mtime_option
;
206 /* Value to be put in mtime header field instead of the actual mtime */
207 GLOBAL
struct timespec mtime_option
;
209 /* Return true if newer_mtime_option is initialized. */
210 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
212 /* Return true if the struct stat ST's M time is less than
213 newer_mtime_option. */
214 #define OLDER_STAT_TIME(st, m) \
215 (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
217 /* Likewise, for struct tar_stat_info ST. */
218 #define OLDER_TAR_STAT_TIME(st, m) \
219 (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
221 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
222 GLOBAL
int recursion_option
;
224 GLOBAL
bool numeric_owner_option
;
226 GLOBAL
bool one_file_system_option
;
228 /* Specified value to be put into tar file in place of stat () results, or
229 just -1 if such an override should not take place. */
230 GLOBAL uid_t owner_option
;
232 GLOBAL
bool recursive_unlink_option
;
234 GLOBAL
bool read_full_records_option
;
236 GLOBAL
bool remove_files_option
;
238 /* Specified rmt command. */
239 GLOBAL
const char *rmt_command_option
;
241 /* Specified remote shell command. */
242 GLOBAL
const char *rsh_command_option
;
244 GLOBAL
bool same_order_option
;
246 /* If positive, preserve ownership when extracting. */
247 GLOBAL
int same_owner_option
;
249 /* If positive, preserve permissions when extracting. */
250 GLOBAL
int same_permissions_option
;
252 /* When set, strip the given number of file name components from the file name
254 GLOBAL
size_t strip_name_components
;
256 GLOBAL
bool show_omitted_dirs_option
;
258 GLOBAL
bool sparse_option
;
259 GLOBAL
unsigned tar_sparse_major
;
260 GLOBAL
unsigned tar_sparse_minor
;
262 GLOBAL
bool starting_file_option
;
264 /* Specified maximum byte length of each tape volume (multiple of 1024). */
265 GLOBAL tarlong tape_length_option
;
267 GLOBAL
bool to_stdout_option
;
269 GLOBAL
bool totals_option
;
271 GLOBAL
bool touch_option
;
273 GLOBAL
char *to_command_option
;
274 GLOBAL
bool ignore_command_error_option
;
276 /* Restrict some potentially harmful tar options */
277 GLOBAL
bool restrict_option
;
279 /* Return true if the extracted files are not being written to disk */
280 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
282 /* Count how many times the option has been set, multiple setting yields
283 more verbose behavior. Value 0 means no verbosity, 1 means file name
284 only, 2 means file name and all attributes. More than 2 is just like 2. */
285 GLOBAL
int verbose_option
;
287 GLOBAL
bool verify_option
;
289 /* Specified name of file containing the volume number. */
290 GLOBAL
const char *volno_file_option
;
292 /* Specified value or pattern. */
293 GLOBAL
const char *volume_label_option
;
295 /* Other global variables. */
297 /* File descriptor for archive file. */
300 /* Nonzero when outputting to /dev/null. */
301 GLOBAL
bool dev_null_output
;
304 GLOBAL
struct timespec start_time
; /* when we started execution */
305 GLOBAL
struct timespec volume_start_time
; /* when the current volume was
307 GLOBAL
struct timespec last_stat_time
; /* when the statistics was last
310 GLOBAL
struct tar_stat_info current_stat_info
;
312 /* List of tape drive names, number of such tape drives, allocated number,
313 and current cursor in list. */
314 GLOBAL
const char **archive_name_array
;
315 GLOBAL
size_t archive_names
;
316 GLOBAL
size_t allocated_archive_names
;
317 GLOBAL
const char **archive_name_cursor
;
319 /* Output index file name. */
320 GLOBAL
char const *index_file_name
;
322 /* Opaque structure for keeping directory meta-data */
325 /* Structure for keeping track of filenames and lists thereof. */
328 struct name
*next
; /* Link to the next element */
329 struct name
*prev
; /* Link to the previous element */
331 char *name
; /* File name or globbing pattern */
332 size_t length
; /* cached strlen (name) */
333 int matching_flags
; /* wildcard flags if name is a pattern */
334 bool cmdline
; /* true if this name was given in the
337 int change_dir
; /* Number of the directory to change to.
338 Set with the -C option. */
339 uintmax_t found_count
; /* number of times a matching file has
342 /* The following members are used for incremental dumps only,
343 if this struct name represents a directory;
345 struct directory
*directory
;/* directory meta-data and contents */
346 struct name
*parent
; /* pointer to the parent hierarchy */
347 struct name
*child
; /* pointer to the first child */
348 struct name
*sibling
; /* pointer to the next sibling */
349 char *caname
; /* canonical name */
352 /* Obnoxious test to see if dimwit is trying to dump the archive. */
356 GLOBAL
int seek_option
;
357 GLOBAL
bool seekable_archive
;
359 GLOBAL dev_t root_device
;
361 /* Unquote filenames */
362 GLOBAL
bool unquote_option
;
364 GLOBAL
bool test_label_option
; /* Test archive volume label and exit */
366 /* Show file or archive names after transformation.
367 In particular, when creating archive in verbose mode, list member names
368 as stored in the archive */
369 GLOBAL
bool show_transformed_names_option
;
371 /* Delay setting modification times and permissions of extracted directories
372 until the end of extraction. This variable helps correctly restore directory
373 timestamps from archives with an unusual member order. It is automatically
374 set for incremental archives. */
375 GLOBAL
bool delay_directory_restore_option
;
377 /* Warn about implicit use of the wildcards in command line arguments.
378 (Default for tar prior to 1.15.91, but changed afterwards */
379 GLOBAL
bool warn_regex_usage
;
381 /* Declarations for each module. */
383 /* FIXME: compare.c should not directly handle the following variable,
384 instead, this should be done in buffer.c only. */
392 extern enum access_mode access_mode
;
394 /* Module buffer.c. */
397 extern bool write_archive_to_stdout
;
398 extern char *volume_label
;
399 extern char *continued_file_name
;
400 extern uintmax_t continued_file_size
;
401 extern uintmax_t continued_file_offset
;
402 extern off_t records_written
;
404 size_t available_space_after (union block
*pointer
);
405 off_t
current_block_ordinal (void);
406 void close_archive (void);
407 void closeout_volume_number (void);
408 void compute_duration (void);
409 union block
*find_next_block (void);
410 void flush_read (void);
411 void flush_write (void);
412 void flush_archive (void);
413 void init_volume_number (void);
414 void open_archive (enum access_mode mode
);
415 void print_total_stats (void);
416 void reset_eof (void);
417 void set_next_block_after (union block
*block
);
418 void clear_read_error_count (void);
419 void xclose (int fd
);
420 void archive_write_error (ssize_t status
) __attribute__ ((noreturn
));
421 void archive_read_error (void);
422 off_t
seek_archive (off_t size
);
423 void set_start_time (void);
425 void mv_begin (struct tar_stat_info
*st
);
427 void mv_total_size (off_t size
);
428 void mv_size_left (off_t size
);
430 void buffer_write_global_xheader (void);
432 /* Module create.c. */
439 dump_status_not_implemented
442 void add_exclusion_tag (const char *name
, enum exclusion_tag_type type
,
443 bool (*)(const char*));
444 bool cachedir_file_p (const char *name
);
446 bool file_dumpable_p (struct tar_stat_info
*st
);
447 void create_archive (void);
448 void pad_archive (off_t size_left
);
449 void dump_file (const char *st
, bool top_level
, dev_t parent_device
);
450 union block
*start_header (struct tar_stat_info
*st
);
451 void finish_header (struct tar_stat_info
*st
, union block
*header
,
452 off_t block_ordinal
);
453 void simple_finish_header (union block
*header
);
454 union block
* write_extended (bool global
, struct tar_stat_info
*st
,
455 union block
*old_header
);
456 union block
*start_private_header (const char *name
, size_t size
, time_t t
);
457 void write_eot (void);
458 void check_links (void);
459 void exclusion_tag_warning (const char *dirname
, const char *tagname
,
460 const char *message
);
461 enum exclusion_tag_type
check_exclusion_tags (const char *dirname
,
462 const char **tag_file_name
);
464 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
465 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
466 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
467 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
468 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
469 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
470 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
471 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
472 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
473 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
474 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
476 bool gid_to_chars (gid_t gid
, char *buf
, size_t size
);
477 bool major_to_chars (major_t m
, char *buf
, size_t size
);
478 bool minor_to_chars (minor_t m
, char *buf
, size_t size
);
479 bool mode_to_chars (mode_t m
, char *buf
, size_t size
);
480 bool off_to_chars (off_t off
, char *buf
, size_t size
);
481 bool size_to_chars (size_t v
, char *buf
, size_t size
);
482 bool time_to_chars (time_t t
, char *buf
, size_t size
);
483 bool uid_to_chars (uid_t uid
, char *buf
, size_t size
);
484 bool uintmax_to_chars (uintmax_t v
, char *buf
, size_t size
);
485 void string_to_chars (char const *s
, char *buf
, size_t size
);
487 /* Module diffarch.c. */
489 extern bool now_verifying
;
491 void diff_archive (void);
492 void diff_init (void);
493 void verify_volume (void);
495 /* Module extract.c. */
497 void extr_init (void);
498 void extract_archive (void);
499 void extract_finish (void);
500 bool rename_directory (char *src
, char *dst
);
502 /* Module delete.c. */
504 void delete_archive_members (void);
506 /* Module incremen.c. */
507 typedef struct dumpdir
*dumpdir_t
;
508 typedef struct dumpdir_iter
*dumpdir_iter_t
;
510 dumpdir_t
dumpdir_create0 (const char *contents
, const char *cmask
);
511 dumpdir_t
dumpdir_create (const char *contents
);
512 void dumpdir_free (dumpdir_t
);
513 char *dumpdir_locate (dumpdir_t dump
, const char *name
);
514 char *dumpdir_next (dumpdir_iter_t itr
);
515 char *dumpdir_first (dumpdir_t dump
, int all
, dumpdir_iter_t
*pitr
);
517 struct directory
*scan_directory (char *dir
, dev_t device
, bool cmdline
);
518 void name_fill_directory (struct name
*name
, dev_t device
, bool cmdline
);
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 read_directory_file (void);
528 void write_directory_file (void);
529 void purge_directory (char const *directory_name
);
530 void list_dumpdir (char *buffer
, size_t size
);
531 void update_parent_directory (const char *name
);
533 size_t dumpdir_size (const char *p
);
534 bool is_dumpdir (struct tar_stat_info
*stat_info
);
540 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
541 HEADER_SUCCESS
, /* header successfully read and checksummed */
542 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
543 HEADER_ZERO_BLOCK
, /* zero block where header expected */
544 HEADER_END_OF_FILE
, /* true end of file while header expected */
545 HEADER_FAILURE
/* ill-formed header, or bad checksum */
548 extern union block
*current_header
;
549 extern enum archive_format current_format
;
550 extern size_t recent_long_name_blocks
;
551 extern size_t recent_long_link_blocks
;
553 void decode_header (union block
*header
, struct tar_stat_info
*stat_info
,
554 enum archive_format
*format_pointer
, int do_user_group
);
555 char const *tartime (struct timespec t
, bool full_time
);
557 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
558 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
559 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
560 #define MODE_FROM_HEADER(where, hbits) \
561 mode_from_header (where, sizeof (where), hbits)
562 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
563 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
564 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
565 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
566 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
568 gid_t
gid_from_header (const char *buf
, size_t size
);
569 major_t
major_from_header (const char *buf
, size_t size
);
570 minor_t
minor_from_header (const char *buf
, size_t size
);
571 mode_t
mode_from_header (const char *buf
, size_t size
, unsigned *hbits
);
572 off_t
off_from_header (const char *buf
, size_t size
);
573 size_t size_from_header (const char *buf
, size_t size
);
574 time_t time_from_header (const char *buf
, size_t size
);
575 uid_t
uid_from_header (const char *buf
, size_t size
);
576 uintmax_t uintmax_from_header (const char *buf
, size_t size
);
578 void list_archive (void);
579 void print_for_mkdir (char *dirname
, int length
, mode_t mode
);
580 void print_header (struct tar_stat_info
*st
, off_t block_ordinal
);
581 void read_and (void (*do_something
) (void));
582 enum read_header
read_header_primitive (bool raw_extended_headers
,
583 struct tar_stat_info
*info
);
584 enum read_header
read_header (bool raw_extended_headers
);
585 enum read_header
tar_checksum (union block
*header
, bool silent
);
586 void skip_file (off_t size
);
587 void skip_member (void);
591 void assign_string (char **dest
, const char *src
);
592 char *quote_copy_string (const char *str
);
593 int unquote_string (char *str
);
594 char *zap_slashes (char *name
);
595 char *normalize_filename (const char *name
);
596 void replace_prefix (char **pname
, const char *samp
, size_t slen
,
597 const char *repl
, size_t rlen
);
599 typedef struct namebuf
*namebuf_t
;
600 namebuf_t
namebuf_create (const char *dir
);
601 void namebuf_free (namebuf_t buf
);
602 char *namebuf_name (namebuf_t buf
, const char *name
);
604 void code_ns_fraction (int ns
, char *p
);
605 char const *code_timespec (struct timespec ts
, char *sbuf
);
606 enum { BILLION
= 1000000000, LOG10_BILLION
= 9 };
607 enum { TIMESPEC_STRSIZE_BOUND
=
608 UINTMAX_STRSIZE_BOUND
+ LOG10_BILLION
+ sizeof "-." - 1 };
612 ORDINARY_REMOVE_OPTION
,
613 RECURSIVE_REMOVE_OPTION
,
615 /* FIXME: The following value is never used. It seems to be intended
616 as a placeholder for a hypothetical option that should instruct tar
617 to recursively remove subdirectories in purge_directory(),
618 as opposed to the functionality of --recursive-unlink
619 (RECURSIVE_REMOVE_OPTION value), which removes them in
620 prepare_to_extract() phase. However, with the addition of more
621 meta-info to the incremental dumps, this should become unnecessary */
622 WANT_DIRECTORY_REMOVE_OPTION
624 int remove_any_file (const char *file_name
, enum remove_option option
);
625 bool maybe_backup_file (const char *file_name
, bool this_is_the_archive
);
626 void undo_last_backup (void);
628 int deref_stat (bool deref
, char const *name
, struct stat
*buf
);
630 int chdir_arg (char const *dir
);
631 void chdir_do (int dir
);
632 int chdir_count (void);
634 void close_diag (char const *name
);
635 void open_diag (char const *name
);
636 void read_diag_details (char const *name
, off_t offset
, size_t size
);
637 void readlink_diag (char const *name
);
638 void savedir_diag (char const *name
);
639 void seek_diag_details (char const *name
, off_t offset
);
640 void stat_diag (char const *name
);
641 void file_removed_diag (const char *name
, bool top_level
,
642 void (*diagfn
) (char const *name
));
643 void dir_removed_diag (char const *name
, bool top_level
,
644 void (*diagfn
) (char const *name
));
645 void write_error_details (char const *name
, size_t status
, size_t size
);
646 void write_fatal (char const *name
) __attribute__ ((noreturn
));
647 void write_fatal_details (char const *name
, ssize_t status
, size_t size
)
648 __attribute__ ((noreturn
));
651 void xpipe (int fd
[2]);
653 void *page_aligned_alloc (void **ptr
, size_t size
);
654 int set_file_atime (int fd
, char const *file
,
655 struct timespec
const timespec
[2]);
657 /* Module names.c. */
659 extern struct name
*gnu_list_name
;
661 void gid_to_gname (gid_t gid
, char **gname
);
662 int gname_to_gid (char const *gname
, gid_t
*pgid
);
663 void uid_to_uname (uid_t uid
, char **uname
);
664 int uname_to_uid (char const *uname
, uid_t
*puid
);
666 void name_init (void);
667 void name_add_name (const char *name
, int matching_flags
);
668 void name_add_dir (const char *name
);
669 void name_term (void);
670 const char *name_next (int change_dirs
);
671 void name_gather (void);
672 struct name
*addname (char const *string
, int change_dir
,
673 bool cmdline
, struct name
*parent
);
674 void remname (struct name
*name
);
675 bool name_match (const char *name
);
676 void names_notfound (void);
677 void collect_and_sort_names (void);
678 struct name
*name_scan (const char *name
);
679 struct name
const *name_from_list (void);
680 void blank_name_list (void);
681 char *new_name (const char *dir_name
, const char *name
);
682 size_t stripped_prefix_len (char const *file_name
, size_t num
);
683 bool all_names_found (struct tar_stat_info
*st
);
685 bool excluded_name (char const *name
);
687 void add_avoided_name (char const *name
);
688 bool is_avoided_name (char const *name
);
689 bool is_individual_file (char const *name
);
691 bool contains_dot_dot (char const *name
);
693 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
694 (c)->found_count == occurrence_option)
695 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
696 (c)->found_count >= occurrence_option)
702 int confirm (const char *message_action
, const char *name
);
703 void request_stdin (const char *option
);
705 void tar_stat_init (struct tar_stat_info
*st
);
706 void tar_stat_destroy (struct tar_stat_info
*st
);
707 void usage (int) __attribute__ ((noreturn
));
708 int tar_timespec_cmp (struct timespec a
, struct timespec b
);
709 const char *archive_format_string (enum archive_format fmt
);
710 const char *subcommand_string (enum subcommand c
);
711 void set_exit_status (int val
);
713 /* Module update.c. */
715 extern char *output_start
;
717 void update_archive (void);
719 /* Module xheader.c. */
721 void xheader_init (struct xheader
*xhdr
);
722 void xheader_decode (struct tar_stat_info
*stat
);
723 void xheader_decode_global (struct xheader
*xhdr
);
724 void xheader_store (char const *keyword
, struct tar_stat_info
*st
,
726 void xheader_read (struct xheader
*xhdr
, union block
*header
, size_t size
);
727 void xheader_write (char type
, char *name
, time_t t
, struct xheader
*xhdr
);
728 void xheader_write_global (struct xheader
*xhdr
);
729 void xheader_finish (struct xheader
*hdr
);
730 void xheader_destroy (struct xheader
*hdr
);
731 char *xheader_xhdr_name (struct tar_stat_info
*st
);
732 char *xheader_ghdr_name (void);
733 void xheader_set_option (char *string
);
734 void xheader_string_begin (struct xheader
*xhdr
);
735 void xheader_string_add (struct xheader
*xhdr
, char const *s
);
736 bool xheader_string_end (struct xheader
*xhdr
, char const *keyword
);
737 bool xheader_keyword_deleted_p (const char *kw
);
738 char *xheader_format_name (struct tar_stat_info
*st
, const char *fmt
,
741 /* Module system.c */
743 void sys_detect_dev_null_output (void);
744 void sys_save_archive_dev_ino (void);
745 void sys_wait_for_child (pid_t
, bool);
746 void sys_spawn_shell (void);
747 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
748 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
749 bool sys_file_is_archive (struct tar_stat_info
*p
);
750 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
751 int sys_truncate (int fd
);
752 pid_t
sys_child_open_for_compress (void);
753 pid_t
sys_child_open_for_uncompress (void);
754 size_t sys_write_archive_buffer (void);
755 bool sys_get_archive_stat (void);
756 int sys_exec_command (char *file_name
, int typechar
, struct tar_stat_info
*st
);
757 void sys_wait_command (void);
758 int sys_exec_info_script (const char **archive_name
, int volume_number
);
759 void sys_exec_checkpoint_script (const char *script_name
,
760 const char *archive_name
,
761 int checkpoint_number
);
763 /* Module compare.c */
764 void report_difference (struct tar_stat_info
*st
, const char *message
, ...);
766 /* Module sparse.c */
767 bool sparse_member_p (struct tar_stat_info
*st
);
768 bool sparse_fixup_header (struct tar_stat_info
*st
);
769 enum dump_status
sparse_dump_file (int, struct tar_stat_info
*st
);
770 enum dump_status
sparse_extract_file (int fd
, struct tar_stat_info
*st
,
772 enum dump_status
sparse_skip_file (struct tar_stat_info
*st
);
773 bool sparse_diff_file (int, struct tar_stat_info
*st
);
776 bool string_ascii_p (const char *str
);
777 bool utf8_convert (bool to_utf
, char const *input
, char **output
);
779 /* Module transform.c */
780 #define XFORM_REGFILE 0x01
781 #define XFORM_LINK 0x02
782 #define XFORM_SYMLINK 0x04
783 #define XFORM_ALL (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
785 void set_transform_expr (const char *expr
);
786 bool transform_name (char **pinput
, int type
);
787 bool transform_member_name (char **pinput
, int type
);
788 bool transform_name_fp (char **pinput
, int type
,
789 char *(*fun
)(char *, void *), void *);
791 /* Module suffix.c */
792 void set_comression_program_by_suffix (const char *name
, const char *defprog
);
794 /* Module checkpoint.c */
795 void checkpoint_compile_action (const char *str
);
796 void checkpoint_finish_compile (void);
797 void checkpoint_run (bool do_write
);
799 /* Module warning.c */
800 #define WARN_ALONE_ZERO_BLOCK 0x00000001
801 #define WARN_BAD_DUMPDIR 0x00000002
802 #define WARN_CACHEDIR 0x00000004
803 #define WARN_CONTIGUOUS_CAST 0x00000008
804 #define WARN_FILE_CHANGED 0x00000010
805 #define WARN_FILE_IGNORED 0x00000020
806 #define WARN_FILE_REMOVED 0x00000040
807 #define WARN_FILE_SHRANK 0x00000080
808 #define WARN_FILE_UNCHANGED 0x00000100
809 #define WARN_FILENAME_WITH_NULS 0x00000200
810 #define WARN_IGNORE_ARCHIVE 0x00000400
811 #define WARN_IGNORE_NEWER 0x00000800
812 #define WARN_NEW_DIRECTORY 0x00001000
813 #define WARN_RENAME_DIRECTORY 0x00002000
814 #define WARN_SYMLINK_CAST 0x00004000
815 #define WARN_TIMESTAMP 0x00008000
816 #define WARN_UNKNOWN_CAST 0x00010000
817 #define WARN_UNKNOWN_KEYWORD 0x00020000
818 #define WARN_XDEV 0x00040000
820 /* The warnings composing WARN_VERBOSE_WARNINGS are enabled by default
822 #define WARN_VERBOSE_WARNINGS (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY)
823 #define WARN_ALL (0xffffffff & ~WARN_VERBOSE_WARNINGS)
825 void set_warning_option (const char *arg
);
827 extern int warning_option
;
829 #define WARNOPT(opt,args) \
832 if (warning_option & opt) WARN (args); \
836 /* Module unlink.c */
838 void queue_deferred_unlink (const char *name
, bool is_dir
);
839 void finish_deferred_unlinks (void);
842 extern void (*fatal_exit_hook
) (void);