1 /* Common declarations for the tar program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
4 2003, 2004 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 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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
33 #define MAXOCTAL11 017777777777L
34 #define MAXOCTAL7 07777777
38 /* Some various global definitions. */
40 /* Name of file to use for interacting with user. */
42 # define TTY_NAME "con"
44 # define TTY_NAME "/dev/tty"
47 /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c
48 modules. Here, we merely set it to "extern" if it is not already set.
49 GNU tar does depend on the system loader to preset all GLOBAL variables to
50 neutral (or zero) values, explicit initialization is usually not done. */
52 # define GLOBAL extern
55 /* Exit status for GNU tar. Let's try to keep this list as simple as
56 possible. -d option strongly invites a status different for unequal
57 comparison and other errors. */
58 GLOBAL
int exit_status
;
60 #define TAREXIT_SUCCESS 0
61 #define TAREXIT_DIFFERS 1
62 #define TAREXIT_FAILURE 2
64 /* Both WARN and ERROR write a message on stderr and continue processing,
65 however ERROR manages so tar will exit unsuccessfully. FATAL_ERROR
66 writes a message on stderr and aborts immediately, with another message
67 line telling so. USAGE_ERROR works like FATAL_ERROR except that the
68 other message line suggests trying --help. All four macros accept a
69 single argument of the form ((0, errno, _("FORMAT"), Args...)). errno
70 is zero when the error is not being detected by the system. */
75 (error Args, exit_status = TAREXIT_FAILURE)
76 #define FATAL_ERROR(Args) \
77 (error Args, fatal_exit ())
78 #define USAGE_ERROR(Args) \
79 (error Args, usage (TAREXIT_FAILURE))
82 #include <backupfile.h>
84 #include <full-write.h>
85 #include <modechange.h>
87 #include <safe-read.h>
90 /* Log base 2 of common values. */
95 /* Information gleaned from the command line. */
97 /* Name of this program. */
98 GLOBAL
const char *program_name
;
100 /* Main command option. */
104 UNKNOWN_SUBCOMMAND
, /* none of the following */
105 APPEND_SUBCOMMAND
, /* -r */
106 CAT_SUBCOMMAND
, /* -A */
107 CREATE_SUBCOMMAND
, /* -c */
108 DELETE_SUBCOMMAND
, /* -D */
109 DIFF_SUBCOMMAND
, /* -d */
110 EXTRACT_SUBCOMMAND
, /* -x */
111 LIST_SUBCOMMAND
, /* -t */
112 UPDATE_SUBCOMMAND
/* -u */
115 GLOBAL
enum subcommand subcommand_option
;
117 /* Selected format for output archive. */
118 GLOBAL
enum archive_format archive_format
;
120 /* Either NL or NUL, as decided by the --null option. */
121 GLOBAL
char filename_terminator
;
123 /* Size of each record, once in blocks, once in bytes. Those two variables
124 are always related, the second being BLOCKSIZE times the first. They do
125 not have _option in their name, even if their values is derived from
126 option decoding, as these are especially important in tar. */
127 GLOBAL
int blocking_factor
;
128 GLOBAL
size_t record_size
;
130 GLOBAL
bool absolute_names_option
;
132 /* Display file times in UTC */
133 GLOBAL
bool utc_option
;
135 /* This variable tells how to interpret newer_mtime_option, below. If zero,
136 files get archived if their mtime is not less than newer_mtime_option.
137 If nonzero, files get archived if *either* their ctime or mtime is not less
138 than newer_mtime_option. */
139 GLOBAL
int after_date_option
;
141 GLOBAL
bool atime_preserve_option
;
143 GLOBAL
bool backup_option
;
145 /* Type of backups being made. */
146 GLOBAL
enum backup_type backup_type
;
148 GLOBAL
bool block_number_option
;
150 GLOBAL
bool checkpoint_option
;
152 /* Specified name of compression program, or "gzip" as implied by -z. */
153 GLOBAL
const char *use_compress_program_option
;
155 GLOBAL
bool dereference_option
;
157 /* Print a message if not all links are dumped */
158 GLOBAL
int check_links_option
;
160 /* Patterns that match file names to be excluded. */
161 GLOBAL
struct exclude
*excluded
;
163 /* Specified file containing names to work on. */
164 GLOBAL
const char *files_from_option
;
166 GLOBAL
bool force_local_option
;
168 /* Specified value to be put into tar file in place of stat () results, or
169 just -1 if such an override should not take place. */
170 GLOBAL gid_t group_option
;
172 GLOBAL
bool ignore_failed_read_option
;
174 GLOBAL
bool ignore_zeros_option
;
176 GLOBAL
bool incremental_option
;
178 /* Specified name of script to run at end of each tape change. */
179 GLOBAL
const char *info_script_option
;
181 GLOBAL
bool interactive_option
;
183 /* If nonzero, extract only Nth occurrence of each named file */
184 GLOBAL
uintmax_t occurrence_option
;
188 DEFAULT_OLD_FILES
, /* default */
189 NO_OVERWRITE_DIR_OLD_FILES
, /* --no-overwrite-dir */
190 OVERWRITE_OLD_FILES
, /* --overwrite */
191 UNLINK_FIRST_OLD_FILES
, /* --unlink-first */
192 KEEP_OLD_FILES
, /* --keep-old-files */
193 KEEP_NEWER_FILES
/* --keep-newer-files */
195 GLOBAL
enum old_files old_files_option
;
197 /* Specified file name for incremental list. */
198 GLOBAL
const char *listed_incremental_option
;
200 /* Specified mode change string. */
201 GLOBAL
struct mode_change
*mode_option
;
203 GLOBAL
bool multi_volume_option
;
205 /* The same variable holds the time, whether mtime or ctime. Just fake a
206 non-existing option, for making the code clearer, elsewhere. */
207 #define newer_ctime_option newer_mtime_option
209 /* Specified threshold date and time. Files having an older time stamp
210 do not get archived (also see after_date_option above). */
211 GLOBAL
struct timespec newer_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 ((st).st_##m##time < newer_mtime_option.tv_sec \
220 || ((st).st_##m##time == newer_mtime_option.tv_sec \
221 && TIMESPEC_NS ((st).st_##m##tim) < newer_mtime_option.tv_nsec))
223 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
224 GLOBAL
int recursion_option
;
226 GLOBAL
bool numeric_owner_option
;
228 GLOBAL
bool one_file_system_option
;
230 /* Specified value to be put into tar file in place of stat () results, or
231 just -1 if such an override should not take place. */
232 GLOBAL uid_t owner_option
;
234 GLOBAL
bool recursive_unlink_option
;
236 GLOBAL
bool read_full_records_option
;
238 GLOBAL
bool remove_files_option
;
240 /* Specified rmt command. */
241 GLOBAL
const char *rmt_command_option
;
243 /* Specified remote shell command. */
244 GLOBAL
const char *rsh_command_option
;
246 GLOBAL
bool same_order_option
;
248 /* If positive, preserve ownership when extracting. */
249 GLOBAL
int same_owner_option
;
251 /* If positive, preserve permissions when extracting. */
252 GLOBAL
int same_permissions_option
;
254 /* When set, strip the given number of file name components from the file name
256 GLOBAL
size_t strip_name_components
;
258 GLOBAL
bool show_omitted_dirs_option
;
260 GLOBAL
bool sparse_option
;
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 /* Count how many times the option has been set, multiple setting yields
274 more verbose behavior. Value 0 means no verbosity, 1 means file name
275 only, 2 means file name and all attributes. More than 2 is just like 2. */
276 GLOBAL
int verbose_option
;
278 GLOBAL
bool verify_option
;
280 /* Specified name of file containing the volume number. */
281 GLOBAL
const char *volno_file_option
;
283 /* Specified value or pattern. */
284 GLOBAL
const char *volume_label_option
;
286 /* Other global variables. */
288 /* File descriptor for archive file. */
291 /* Nonzero when outputting to /dev/null. */
292 GLOBAL
bool dev_null_output
;
294 /* Timestamp for when we started execution. */
295 #if HAVE_CLOCK_GETTIME
296 GLOBAL
struct timespec start_timespec
;
297 # define start_time (start_timespec.tv_sec)
299 GLOBAL
time_t start_time
;
302 GLOBAL
struct tar_stat_info current_stat_info
;
304 /* List of tape drive names, number of such tape drives, allocated number,
305 and current cursor in list. */
306 GLOBAL
const char **archive_name_array
;
307 GLOBAL
int archive_names
;
308 GLOBAL
int allocated_archive_names
;
309 GLOBAL
const char **archive_name_cursor
;
311 /* Output index file name. */
312 GLOBAL
char const *index_file_name
;
314 /* Structure for keeping track of filenames and lists thereof. */
318 size_t length
; /* cached strlen(name) */
319 uintmax_t found_count
; /* number of times a matching file has
322 char firstch
; /* first char is literally matched */
323 char regexp
; /* this name is a regexp, not literal */
324 int change_dir
; /* set with the -C option */
325 char const *dir_contents
; /* for incremental_option */
326 char fake
; /* dummy entry */
330 /* Obnoxious test to see if dimwit is trying to dump the archive. */
335 /* Declarations for each module. */
337 /* FIXME: compare.c should not directly handle the following variable,
338 instead, this should be done in buffer.c only. */
346 extern enum access_mode access_mode
;
348 /* Module buffer.c. */
351 extern char *save_name
;
352 extern off_t save_sizeleft
;
353 extern off_t save_totsize
;
354 extern bool write_archive_to_stdout
;
356 size_t available_space_after (union block
*);
357 off_t
current_block_ordinal (void);
358 void close_archive (void);
359 void closeout_volume_number (void);
360 union block
*find_next_block (void);
361 void flush_read (void);
362 void flush_write (void);
363 void flush_archive (void);
364 void init_volume_number (void);
365 void open_archive (enum access_mode
);
366 void print_total_written (void);
367 void reset_eof (void);
368 void set_next_block_after (union block
*);
369 void clear_read_error_count (void);
370 void xclose (int fd
);
371 void archive_write_error (ssize_t
) __attribute__ ((noreturn
));
372 void archive_read_error (void);
374 /* Module create.c. */
381 dump_status_not_implemented
384 bool file_dumpable_p (struct tar_stat_info
*);
385 void create_archive (void);
386 void pad_archive (off_t size_left
);
387 void dump_file (char *, int, dev_t
);
388 union block
*start_header (struct tar_stat_info
*st
);
389 void finish_header (struct tar_stat_info
*, union block
*, off_t
);
390 void simple_finish_header (union block
*header
);
391 union block
*start_private_header (const char *name
, size_t size
);
392 void write_eot (void);
393 void check_links (void);
395 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
396 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
397 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
398 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
399 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
400 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
401 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
402 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
403 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
404 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
405 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
407 void gid_to_chars (gid_t
, char *, size_t);
408 void major_to_chars (major_t
, char *, size_t);
409 void minor_to_chars (minor_t
, char *, size_t);
410 void mode_to_chars (mode_t
, char *, size_t);
411 void off_to_chars (off_t
, char *, size_t);
412 void size_to_chars (size_t, char *, size_t);
413 void time_to_chars (time_t, char *, size_t);
414 void uid_to_chars (uid_t
, char *, size_t);
415 void uintmax_to_chars (uintmax_t, char *, size_t);
416 void string_to_chars (char *, char *, size_t);
418 /* Module diffarch.c. */
420 extern bool now_verifying
;
422 void diff_archive (void);
423 void diff_init (void);
424 void verify_volume (void);
426 /* Module extract.c. */
428 extern bool we_are_root
;
429 void extr_init (void);
430 void extract_archive (void);
431 void extract_finish (void);
432 void fatal_exit (void) __attribute__ ((noreturn
));
434 /* Module delete.c. */
436 void delete_archive_members (void);
438 /* Module incremen.c. */
440 char *get_directory_contents (char *, dev_t
);
441 void read_directory_file (void);
442 void write_directory_file (void);
443 void gnu_restore (char const *);
449 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
450 HEADER_SUCCESS
, /* header successfully read and checksummed */
451 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
452 HEADER_ZERO_BLOCK
, /* zero block where header expected */
453 HEADER_END_OF_FILE
, /* true end of file while header expected */
454 HEADER_FAILURE
/* ill-formed header, or bad checksum */
464 GLOBAL
struct xheader extended_header
;
465 extern union block
*current_header
;
466 extern enum archive_format current_format
;
467 extern size_t recent_long_name_blocks
;
468 extern size_t recent_long_link_blocks
;
470 void decode_header (union block
*, struct tar_stat_info
*,
471 enum archive_format
*, int);
472 #define STRINGIFY_BIGINT(i, b) \
473 stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
474 char *stringify_uintmax_t_backwards (uintmax_t, char *);
475 char const *tartime (time_t);
477 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
478 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
479 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
480 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
481 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
482 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
483 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
484 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
485 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
487 gid_t
gid_from_header (const char *, size_t);
488 major_t
major_from_header (const char *, size_t);
489 minor_t
minor_from_header (const char *, size_t);
490 mode_t
mode_from_header (const char *, size_t);
491 off_t
off_from_header (const char *, size_t);
492 size_t size_from_header (const char *, size_t);
493 time_t time_from_header (const char *, size_t);
494 uid_t
uid_from_header (const char *, size_t);
495 uintmax_t uintmax_from_header (const char *, size_t);
497 void list_archive (void);
498 void print_for_mkdir (char *, int, mode_t
);
499 void print_header (struct tar_stat_info
*, off_t
);
500 void read_and (void (*) (void));
501 enum read_header
read_header (bool);
502 void skip_file (off_t
);
503 void skip_member (void);
505 /* Module mangle.c. */
507 void extract_mangle (void);
511 void assign_string (char **, const char *);
512 char *quote_copy_string (const char *);
513 int unquote_string (char *);
515 size_t dot_dot_prefix_len (char const *);
519 ORDINARY_REMOVE_OPTION
,
520 RECURSIVE_REMOVE_OPTION
,
521 WANT_DIRECTORY_REMOVE_OPTION
523 int remove_any_file (const char *, enum remove_option
);
524 bool maybe_backup_file (const char *, int);
525 void undo_last_backup (void);
527 int deref_stat (bool, char const *, struct stat
*);
529 int chdir_arg (char const *);
532 void decode_mode (mode_t
, char *);
534 void chdir_fatal (char const *) __attribute__ ((noreturn
));
535 void chmod_error_details (char const *, mode_t
);
536 void chown_error_details (char const *, uid_t
, gid_t
);
537 void close_error (char const *);
538 void close_warn (char const *);
539 void close_diag (char const *name
);
540 void exec_fatal (char const *) __attribute__ ((noreturn
));
541 void link_error (char const *, char const *);
542 void mkdir_error (char const *);
543 void mkfifo_error (char const *);
544 void mknod_error (char const *);
545 void open_error (char const *);
546 void open_fatal (char const *) __attribute__ ((noreturn
));
547 void open_warn (char const *);
548 void open_diag (char const *name
);
549 void read_error (char const *);
550 void read_error_details (char const *, off_t
, size_t);
551 void read_fatal (char const *) __attribute__ ((noreturn
));
552 void read_fatal_details (char const *, off_t
, size_t) __attribute__ ((noreturn
));
553 void read_warn_details (char const *, off_t
, size_t);
554 void read_diag_details (char const *name
, off_t offset
, size_t size
);
555 void readlink_error (char const *);
556 void readlink_warn (char const *);
557 void readlink_diag (char const *name
);
558 void savedir_error (char const *);
559 void savedir_warn (char const *);
560 void savedir_diag (char const *name
);
561 void seek_error (char const *);
562 void seek_error_details (char const *, off_t
);
563 void seek_warn (char const *);
564 void seek_warn_details (char const *, off_t
);
565 void seek_diag_details (char const *, off_t
);
566 void stat_error (char const *);
567 void stat_warn (char const *);
568 void stat_diag (char const *name
);
569 void symlink_error (char const *, char const *);
570 void truncate_error (char const *);
571 void truncate_warn (char const *);
572 void unlink_error (char const *);
573 void utime_error (char const *);
574 void waitpid_error (char const *);
575 void write_error (char const *);
576 void write_error_details (char const *, size_t, size_t);
577 void write_fatal (char const *) __attribute__ ((noreturn
));
578 void write_fatal_details (char const *, ssize_t
, size_t)
579 __attribute__ ((noreturn
));
584 /* Module names.c. */
586 extern struct name
*gnu_list_name
;
588 void gid_to_gname (gid_t
, char **gname
);
589 int gname_to_gid (char const *, gid_t
*);
590 void uid_to_uname (uid_t
, char **uname
);
591 int uname_to_uid (char const *, uid_t
*);
593 void init_names (void);
594 void name_add (const char *);
595 void name_init (void);
596 void name_term (void);
597 char *name_next (int);
598 void name_close (void);
599 void name_gather (void);
600 struct name
*addname (char const *, int);
601 int name_match (const char *);
602 void names_notfound (void);
603 void collect_and_sort_names (void);
604 struct name
*name_scan (const char *);
605 char *name_from_list (void);
606 void blank_name_list (void);
607 char *new_name (const char *, const char *);
608 char *safer_name_suffix (char const *, bool);
609 size_t stripped_prefix_len (char const *file_name
, size_t num
);
610 bool all_names_found (struct tar_stat_info
*);
612 bool excluded_name (char const *);
614 void add_avoided_name (char const *);
615 bool is_avoided_name (char const *);
617 bool contains_dot_dot (char const *);
619 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
620 (c)->found_count == occurrence_option)
621 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
622 (c)->found_count >= occurrence_option)
628 int confirm (const char *, const char *);
629 void request_stdin (const char *);
631 void tar_stat_init (struct tar_stat_info
*st
);
632 void tar_stat_destroy (struct tar_stat_info
*st
);
633 void usage (int) __attribute__ ((noreturn
));
635 /* Module update.c. */
637 extern char *output_start
;
639 void update_archive (void);
641 /* Module xheader.c. */
643 void xheader_decode (struct tar_stat_info
*);
644 void xheader_decode_global (void);
645 void xheader_store (char const *, struct tar_stat_info
const *, void *);
646 void xheader_read (union block
*, size_t);
647 void xheader_write (char type
, char *name
, struct xheader
*xhdr
);
648 void xheader_write_global (void);
649 void xheader_finish (struct xheader
*);
650 void xheader_destroy (struct xheader
*);
651 char *xheader_xhdr_name (struct tar_stat_info
*st
);
652 char *xheader_ghdr_name (void);
653 void xheader_write (char, char *, struct xheader
*);
654 void xheader_write_global (void);
655 void xheader_set_option (char *string
);
657 /* Module system.c */
659 void sys_stat_nanoseconds (struct tar_stat_info
*);
660 void sys_detect_dev_null_output (void);
661 void sys_save_archive_dev_ino (void);
662 void sys_drain_input_pipe (void);
663 void sys_wait_for_child (pid_t
);
664 void sys_spawn_shell (void);
665 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
666 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
667 bool sys_file_is_archive (struct tar_stat_info
*p
);
668 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
669 int sys_truncate (int fd
);
670 void sys_reset_uid_gid (void);
671 pid_t
sys_child_open_for_compress (void);
672 pid_t
sys_child_open_for_uncompress (void);
673 void sys_reset_uid_gid (void);
674 size_t sys_write_archive_buffer (void);
675 bool sys_get_archive_stat (void);
676 void sys_reset_uid_gid (void);
678 /* Module compare.c */
679 void report_difference (struct tar_stat_info
*st
, const char *message
, ...);
681 /* Module sparse.c */
682 bool sparse_file_p (struct tar_stat_info
*);
683 bool sparse_member_p (struct tar_stat_info
*);
684 bool sparse_fixup_header (struct tar_stat_info
*);
685 enum dump_status
sparse_dump_file (int, struct tar_stat_info
*);
686 enum dump_status
sparse_extract_file (int, struct tar_stat_info
*, off_t
*);
687 enum dump_status
sparse_skip_file (struct tar_stat_info
*);
688 bool sparse_diff_file (int, struct tar_stat_info
*);
691 bool string_ascii_p (const char *str
);
692 bool utf8_convert (bool to_utf
, char const *input
, char **output
);