1 /* Common declarations for the tar program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
4 2003, 2004, 2005 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any later
11 This program is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
14 Public License for more details.
16 You should have received a copy of the GNU General Public License along
17 with this program; if not, write to the Free Software Foundation, Inc.,
18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
20 /* Declare the GNU tar archive format. */
23 /* The checksum field is filled with this while the checksum is computed. */
24 #define CHKBLANKS " " /* 8 blanks, no null */
26 /* Some constants from POSIX are given names. */
27 #define NAME_FIELD_SIZE 100
28 #define PREFIX_FIELD_SIZE 155
29 #define UNAME_FIELD_SIZE 32
30 #define GNAME_FIELD_SIZE 32
34 /* Some various global definitions. */
36 /* Name of file to use for interacting with user. */
38 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
39 modules. Here, we merely set it to "extern" if it is not already set.
40 GNU tar does depend on the system loader to preset all GLOBAL variables to
41 neutral (or zero) values, explicit initialization is usually not done. */
43 # define GLOBAL extern
46 #define TAREXIT_SUCCESS PAXEXIT_SUCCESS
47 #define TAREXIT_DIFFERS PAXEXIT_DIFFERS
48 #define TAREXIT_FAILURE PAXEXIT_FAILURE
52 #include <backupfile.h>
54 #include <full-write.h>
55 #include <modechange.h>
57 #include <safe-read.h>
58 #include <stat-time.h>
60 #define obstack_chunk_alloc xmalloc
61 #define obstack_chunk_free free
66 /* Log base 2 of common values. */
71 /* Information gleaned from the command line. */
73 /* Name of this program. */
74 GLOBAL
const char *program_name
;
76 /* Main command option. */
80 UNKNOWN_SUBCOMMAND
, /* none of the following */
81 APPEND_SUBCOMMAND
, /* -r */
82 CAT_SUBCOMMAND
, /* -A */
83 CREATE_SUBCOMMAND
, /* -c */
84 DELETE_SUBCOMMAND
, /* -D */
85 DIFF_SUBCOMMAND
, /* -d */
86 EXTRACT_SUBCOMMAND
, /* -x */
87 LIST_SUBCOMMAND
, /* -t */
88 UPDATE_SUBCOMMAND
/* -u */
91 GLOBAL
enum subcommand subcommand_option
;
93 /* Selected format for output archive. */
94 GLOBAL
enum archive_format archive_format
;
96 /* Either NL or NUL, as decided by the --null option. */
97 GLOBAL
char filename_terminator
;
99 /* Size of each record, once in blocks, once in bytes. Those two variables
100 are always related, the second being BLOCKSIZE times the first. They do
101 not have _option in their name, even if their values is derived from
102 option decoding, as these are especially important in tar. */
103 GLOBAL
int blocking_factor
;
104 GLOBAL
size_t record_size
;
106 GLOBAL
bool absolute_names_option
;
108 /* Display file times in UTC */
109 GLOBAL
bool utc_option
;
111 /* This variable tells how to interpret newer_mtime_option, below. If zero,
112 files get archived if their mtime is not less than newer_mtime_option.
113 If nonzero, files get archived if *either* their ctime or mtime is not less
114 than newer_mtime_option. */
115 GLOBAL
int after_date_option
;
117 GLOBAL
bool atime_preserve_option
;
119 GLOBAL
bool backup_option
;
121 /* Type of backups being made. */
122 GLOBAL
enum backup_type backup_type
;
124 GLOBAL
bool block_number_option
;
126 GLOBAL
bool checkpoint_option
;
128 /* Specified name of compression program, or "gzip" as implied by -z. */
129 GLOBAL
const char *use_compress_program_option
;
131 GLOBAL
bool dereference_option
;
133 /* Print a message if not all links are dumped */
134 GLOBAL
int check_links_option
;
136 /* Patterns that match file names to be excluded. */
137 GLOBAL
struct exclude
*excluded
;
139 /* Exclude directories containing a cache directory tag. */
140 GLOBAL
bool exclude_caches_option
;
142 /* Specified value to be put into tar file in place of stat () results, or
143 just -1 if such an override should not take place. */
144 GLOBAL gid_t group_option
;
146 GLOBAL
bool ignore_failed_read_option
;
148 GLOBAL
bool ignore_zeros_option
;
150 GLOBAL
bool incremental_option
;
152 /* Specified name of script to run at end of each tape change. */
153 GLOBAL
const char *info_script_option
;
155 GLOBAL
bool interactive_option
;
157 /* If nonzero, extract only Nth occurrence of each named file */
158 GLOBAL
uintmax_t occurrence_option
;
162 DEFAULT_OLD_FILES
, /* default */
163 NO_OVERWRITE_DIR_OLD_FILES
, /* --no-overwrite-dir */
164 OVERWRITE_OLD_FILES
, /* --overwrite */
165 UNLINK_FIRST_OLD_FILES
, /* --unlink-first */
166 KEEP_OLD_FILES
, /* --keep-old-files */
167 KEEP_NEWER_FILES
/* --keep-newer-files */
169 GLOBAL
enum old_files old_files_option
;
171 /* Specified file name for incremental list. */
172 GLOBAL
const char *listed_incremental_option
;
174 /* Specified mode change string. */
175 GLOBAL
struct mode_change
*mode_option
;
177 /* Initial umask, if needed for mode change string. */
178 GLOBAL mode_t initial_umask
;
180 GLOBAL
bool multi_volume_option
;
182 /* Specified threshold date and time. Files having an older time stamp
183 do not get archived (also see after_date_option above). */
184 GLOBAL
struct timespec newer_mtime_option
;
186 /* Return true if newer_mtime_option is initialized. */
187 #define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec)
189 /* Return true if the struct stat ST's M time is less than
190 newer_mtime_option. */
191 #define OLDER_STAT_TIME(st, m) \
192 (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0)
194 /* Likewise, for struct tar_stat_info ST. */
195 #define OLDER_TAR_STAT_TIME(st, m) \
196 (timespec_cmp ((st).m##time, newer_mtime_option) < 0)
198 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
199 GLOBAL
int recursion_option
;
201 GLOBAL
bool numeric_owner_option
;
203 GLOBAL
bool one_file_system_option
;
205 /* Specified value to be put into tar file in place of stat () results, or
206 just -1 if such an override should not take place. */
207 GLOBAL uid_t owner_option
;
209 GLOBAL
bool recursive_unlink_option
;
211 GLOBAL
bool read_full_records_option
;
213 GLOBAL
bool remove_files_option
;
215 /* Specified rmt command. */
216 GLOBAL
const char *rmt_command_option
;
218 /* Specified remote shell command. */
219 GLOBAL
const char *rsh_command_option
;
221 GLOBAL
bool same_order_option
;
223 /* If positive, preserve ownership when extracting. */
224 GLOBAL
int same_owner_option
;
226 /* If positive, preserve permissions when extracting. */
227 GLOBAL
int same_permissions_option
;
229 /* When set, strip the given number of file name components from the file name
231 GLOBAL
size_t strip_name_components
;
233 GLOBAL
bool show_omitted_dirs_option
;
235 GLOBAL
bool sparse_option
;
237 GLOBAL
bool starting_file_option
;
239 /* Specified maximum byte length of each tape volume (multiple of 1024). */
240 GLOBAL tarlong tape_length_option
;
242 GLOBAL
bool to_stdout_option
;
244 GLOBAL
bool totals_option
;
246 GLOBAL
bool touch_option
;
248 GLOBAL
char *to_command_option
;
249 GLOBAL
bool ignore_command_error_option
;
251 /* Return true if the extracted files are not being written to disk */
252 #define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option)
254 /* Count how many times the option has been set, multiple setting yields
255 more verbose behavior. Value 0 means no verbosity, 1 means file name
256 only, 2 means file name and all attributes. More than 2 is just like 2. */
257 GLOBAL
int verbose_option
;
259 GLOBAL
bool verify_option
;
261 /* Specified name of file containing the volume number. */
262 GLOBAL
const char *volno_file_option
;
264 /* Specified value or pattern. */
265 GLOBAL
const char *volume_label_option
;
267 /* Other global variables. */
269 /* File descriptor for archive file. */
272 /* Nonzero when outputting to /dev/null. */
273 GLOBAL
bool dev_null_output
;
275 /* Timestamp for when we started execution. */
276 GLOBAL
struct timespec start_time
;
278 GLOBAL
struct tar_stat_info current_stat_info
;
280 /* List of tape drive names, number of such tape drives, allocated number,
281 and current cursor in list. */
282 GLOBAL
const char **archive_name_array
;
283 GLOBAL
int archive_names
;
284 GLOBAL
int allocated_archive_names
;
285 GLOBAL
const char **archive_name_cursor
;
287 /* Output index file name. */
288 GLOBAL
char const *index_file_name
;
290 /* Structure for keeping track of filenames and lists thereof. */
294 size_t length
; /* cached strlen(name) */
295 uintmax_t found_count
; /* number of times a matching file has
298 char firstch
; /* first char is literally matched */
299 char regexp
; /* this name is a regexp, not literal */
300 int change_dir
; /* set with the -C option */
301 char const *dir_contents
; /* for incremental_option */
302 char fake
; /* dummy entry */
306 /* Obnoxious test to see if dimwit is trying to dump the archive. */
310 GLOBAL
bool seekable_archive
;
312 GLOBAL dev_t root_device
;
314 /* Unquote filenames */
315 GLOBAL
bool unquote_option
;
317 GLOBAL
bool test_label_option
;
320 /* Declarations for each module. */
322 /* FIXME: compare.c should not directly handle the following variable,
323 instead, this should be done in buffer.c only. */
331 extern enum access_mode access_mode
;
333 /* Module buffer.c. */
336 extern char *save_name
;
337 extern off_t save_sizeleft
;
338 extern off_t save_totsize
;
339 extern bool write_archive_to_stdout
;
341 size_t available_space_after (union block
*);
342 off_t
current_block_ordinal (void);
343 void close_archive (void);
344 void closeout_volume_number (void);
345 union block
*find_next_block (void);
346 void flush_read (void);
347 void flush_write (void);
348 void flush_archive (void);
349 void init_volume_number (void);
350 void open_archive (enum access_mode
);
351 void print_total_written (void);
352 void reset_eof (void);
353 void set_next_block_after (union block
*);
354 void clear_read_error_count (void);
355 void xclose (int fd
);
356 void archive_write_error (ssize_t
) __attribute__ ((noreturn
));
357 void archive_read_error (void);
358 off_t
seek_archive (off_t size
);
359 void set_start_time (void);
361 /* Module create.c. */
368 dump_status_not_implemented
371 bool file_dumpable_p (struct tar_stat_info
*);
372 void create_archive (void);
373 void pad_archive (off_t size_left
);
374 void dump_file (char *, int, dev_t
);
375 union block
*start_header (struct tar_stat_info
*st
);
376 void finish_header (struct tar_stat_info
*, union block
*, off_t
);
377 void simple_finish_header (union block
*header
);
378 union block
*start_private_header (const char *name
, size_t size
);
379 void write_eot (void);
380 void check_links (void);
382 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
383 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
384 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
385 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
386 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
387 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
388 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
389 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
390 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
391 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
392 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
394 void gid_to_chars (gid_t
, char *, size_t);
395 void major_to_chars (major_t
, char *, size_t);
396 void minor_to_chars (minor_t
, char *, size_t);
397 void mode_to_chars (mode_t
, char *, size_t);
398 void off_to_chars (off_t
, char *, size_t);
399 void size_to_chars (size_t, char *, size_t);
400 void time_to_chars (time_t, char *, size_t);
401 void uid_to_chars (uid_t
, char *, size_t);
402 void uintmax_to_chars (uintmax_t, char *, size_t);
403 void string_to_chars (char const *, char *, size_t);
405 /* Module diffarch.c. */
407 extern bool now_verifying
;
409 void diff_archive (void);
410 void diff_init (void);
411 void verify_volume (void);
413 /* Module extract.c. */
415 void extr_init (void);
416 void extract_archive (void);
417 void extract_finish (void);
419 /* Module delete.c. */
421 void delete_archive_members (void);
423 /* Module incremen.c. */
425 char *get_directory_contents (char *, dev_t
);
426 void read_directory_file (void);
427 void write_directory_file (void);
428 void purge_directory (char const *);
429 void list_dumpdir (char *buffer
, size_t size
);
435 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
436 HEADER_SUCCESS
, /* header successfully read and checksummed */
437 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
438 HEADER_ZERO_BLOCK
, /* zero block where header expected */
439 HEADER_END_OF_FILE
, /* true end of file while header expected */
440 HEADER_FAILURE
/* ill-formed header, or bad checksum */
450 GLOBAL
struct xheader extended_header
;
451 extern union block
*current_header
;
452 extern enum archive_format current_format
;
453 extern size_t recent_long_name_blocks
;
454 extern size_t recent_long_link_blocks
;
456 void decode_header (union block
*, struct tar_stat_info
*,
457 enum archive_format
*, int);
458 char const *tartime (struct timespec
, bool);
460 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
461 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
462 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
463 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
464 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
465 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
466 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
467 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
468 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
470 gid_t
gid_from_header (const char *, size_t);
471 major_t
major_from_header (const char *, size_t);
472 minor_t
minor_from_header (const char *, size_t);
473 mode_t
mode_from_header (const char *, size_t);
474 off_t
off_from_header (const char *, size_t);
475 size_t size_from_header (const char *, size_t);
476 time_t time_from_header (const char *, size_t);
477 uid_t
uid_from_header (const char *, size_t);
478 uintmax_t uintmax_from_header (const char *, size_t);
480 void list_archive (void);
481 void print_for_mkdir (char *, int, mode_t
);
482 void print_header (struct tar_stat_info
*, off_t
);
483 void read_and (void (*) (void));
484 enum read_header
read_header (bool);
485 enum read_header
tar_checksum (union block
*header
, bool silent
);
486 void skip_file (off_t
);
487 void skip_member (void);
489 /* Module mangle.c. */
491 void extract_mangle (void);
495 void assign_string (char **, const char *);
496 char *quote_copy_string (const char *);
497 int unquote_string (char *);
499 void code_ns_fraction (int, char *);
500 char const *code_timespec (struct timespec
, char *);
501 enum { BILLION
= 1000000000, LOG10_BILLION
= 9 };
502 enum { TIMESPEC_STRSIZE_BOUND
=
503 UINTMAX_STRSIZE_BOUND
+ LOG10_BILLION
+ sizeof "-." - 1 };
505 size_t dot_dot_prefix_len (char const *);
509 ORDINARY_REMOVE_OPTION
,
510 RECURSIVE_REMOVE_OPTION
,
512 /* FIXME: The following value is never used. It seems to be intended
513 as a placeholder for a hypothetical option that should instruct tar
514 to recursively remove subdirectories in purge_directory(),
515 as opposed to the functionality of --recursive-unlink
516 (RECURSIVE_REMOVE_OPTION value), which removes them in
517 prepare_to_extract() phase. However, with the addition of more
518 meta-info to the incremental dumps, this should become unnecessary */
519 WANT_DIRECTORY_REMOVE_OPTION
521 int remove_any_file (const char *, enum remove_option
);
522 bool maybe_backup_file (const char *, int);
523 void undo_last_backup (void);
525 int deref_stat (bool, char const *, struct stat
*);
527 int chdir_arg (char const *);
530 void close_diag (char const *name
);
531 void open_diag (char const *name
);
532 void read_diag_details (char const *name
, off_t offset
, size_t size
);
533 void readlink_diag (char const *name
);
534 void savedir_diag (char const *name
);
535 void seek_diag_details (char const *, off_t
);
536 void stat_diag (char const *name
);
537 void write_error_details (char const *, size_t, size_t);
538 void write_fatal (char const *) __attribute__ ((noreturn
));
539 void write_fatal_details (char const *, ssize_t
, size_t)
540 __attribute__ ((noreturn
));
545 void *page_aligned_alloc (void **, size_t);
547 /* Module names.c. */
549 extern struct name
*gnu_list_name
;
551 void gid_to_gname (gid_t
, char **gname
);
552 int gname_to_gid (char const *, gid_t
*);
553 void uid_to_uname (uid_t
, char **uname
);
554 int uname_to_uid (char const *, uid_t
*);
556 void init_names (void);
557 void name_add (const char *);
558 void name_init (void);
559 void name_term (void);
560 char *name_next (int);
561 void name_gather (void);
562 struct name
*addname (char const *, int);
563 int name_match (const char *);
564 void names_notfound (void);
565 void collect_and_sort_names (void);
566 struct name
*name_scan (const char *);
567 char *name_from_list (void);
568 void blank_name_list (void);
569 char *new_name (const char *, const char *);
570 size_t stripped_prefix_len (char const *file_name
, size_t num
);
571 bool all_names_found (struct tar_stat_info
*);
573 bool excluded_name (char const *);
575 void add_avoided_name (char const *);
576 bool is_avoided_name (char const *);
577 bool is_individual_file (char const *);
579 bool contains_dot_dot (char const *);
581 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
582 (c)->found_count == occurrence_option)
583 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
584 (c)->found_count >= occurrence_option)
590 int confirm (const char *, const char *);
591 void request_stdin (const char *);
593 void tar_stat_init (struct tar_stat_info
*st
);
594 void tar_stat_destroy (struct tar_stat_info
*st
);
595 void usage (int) __attribute__ ((noreturn
));
597 /* Module update.c. */
599 extern char *output_start
;
601 void update_archive (void);
603 /* Module xheader.c. */
605 void xheader_decode (struct tar_stat_info
*);
606 void xheader_decode_global (void);
607 void xheader_store (char const *, struct tar_stat_info
const *, void *);
608 void xheader_read (union block
*, size_t);
609 void xheader_write (char type
, char *name
, struct xheader
*xhdr
);
610 void xheader_write_global (void);
611 void xheader_finish (struct xheader
*);
612 void xheader_destroy (struct xheader
*);
613 char *xheader_xhdr_name (struct tar_stat_info
*st
);
614 char *xheader_ghdr_name (void);
615 void xheader_write (char, char *, struct xheader
*);
616 void xheader_write_global (void);
617 void xheader_set_option (char *string
);
619 /* Module system.c */
621 void sys_detect_dev_null_output (void);
622 void sys_save_archive_dev_ino (void);
623 void sys_drain_input_pipe (void);
624 void sys_wait_for_child (pid_t
);
625 void sys_spawn_shell (void);
626 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
627 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
628 bool sys_file_is_archive (struct tar_stat_info
*p
);
629 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
630 int sys_truncate (int fd
);
631 pid_t
sys_child_open_for_compress (void);
632 pid_t
sys_child_open_for_uncompress (void);
633 size_t sys_write_archive_buffer (void);
634 bool sys_get_archive_stat (void);
635 int sys_exec_command (char *file_name
, int typechar
, struct tar_stat_info
*st
);
636 void sys_wait_command (void);
638 /* Module compare.c */
639 void report_difference (struct tar_stat_info
*st
, const char *message
, ...);
641 /* Module sparse.c */
642 bool sparse_file_p (struct tar_stat_info
*);
643 bool sparse_member_p (struct tar_stat_info
*);
644 bool sparse_fixup_header (struct tar_stat_info
*);
645 enum dump_status
sparse_dump_file (int, struct tar_stat_info
*);
646 enum dump_status
sparse_extract_file (int, struct tar_stat_info
*, off_t
*);
647 enum dump_status
sparse_skip_file (struct tar_stat_info
*);
648 bool sparse_diff_file (int, struct tar_stat_info
*);
651 bool string_ascii_p (const char *str
);
652 bool utf8_convert (bool to_utf
, char const *input
, char **output
);