1 /* Common declarations for the tar program.
3 Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
4 2003 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>
89 /* Log base 2 of common values. */
94 /* Information gleaned from the command line. */
96 /* Name of this program. */
97 GLOBAL
const char *program_name
;
99 /* Main command option. */
103 UNKNOWN_SUBCOMMAND
, /* none of the following */
104 APPEND_SUBCOMMAND
, /* -r */
105 CAT_SUBCOMMAND
, /* -A */
106 CREATE_SUBCOMMAND
, /* -c */
107 DELETE_SUBCOMMAND
, /* -D */
108 DIFF_SUBCOMMAND
, /* -d */
109 EXTRACT_SUBCOMMAND
, /* -x */
110 LIST_SUBCOMMAND
, /* -t */
111 UPDATE_SUBCOMMAND
/* -u */
114 GLOBAL
enum subcommand subcommand_option
;
116 /* Selected format for output archive. */
117 GLOBAL
enum archive_format archive_format
;
119 /* Either NL or NUL, as decided by the --null option. */
120 GLOBAL
char filename_terminator
;
122 /* Size of each record, once in blocks, once in bytes. Those two variables
123 are always related, the second being BLOCKSIZE times the first. They do
124 not have _option in their name, even if their values is derived from
125 option decoding, as these are especially important in tar. */
126 GLOBAL
int blocking_factor
;
127 GLOBAL
size_t record_size
;
129 GLOBAL
bool absolute_names_option
;
131 /* Display file times in UTC */
132 GLOBAL
bool utc_option
;
134 /* This variable tells how to interpret newer_mtime_option, below. If zero,
135 files get archived if their mtime is not less than newer_mtime_option.
136 If nonzero, files get archived if *either* their ctime or mtime is not less
137 than newer_mtime_option. */
138 GLOBAL
int after_date_option
;
140 GLOBAL
bool atime_preserve_option
;
142 GLOBAL
bool backup_option
;
144 /* Type of backups being made. */
145 GLOBAL
enum backup_type backup_type
;
147 GLOBAL
bool block_number_option
;
149 GLOBAL
bool checkpoint_option
;
151 /* Specified name of compression program, or "gzip" as implied by -z. */
152 GLOBAL
const char *use_compress_program_option
;
154 GLOBAL
bool dereference_option
;
156 /* Print a message if not all links are dumped */
157 GLOBAL
int check_links_option
;
159 /* Patterns that match file names to be excluded. */
160 GLOBAL
struct exclude
*excluded
;
162 /* Specified file containing names to work on. */
163 GLOBAL
const char *files_from_option
;
165 GLOBAL
bool force_local_option
;
167 /* Specified value to be put into tar file in place of stat () results, or
168 just -1 if such an override should not take place. */
169 GLOBAL gid_t group_option
;
171 GLOBAL
bool ignore_failed_read_option
;
173 GLOBAL
bool ignore_zeros_option
;
175 GLOBAL
bool incremental_option
;
177 /* Specified name of script to run at end of each tape change. */
178 GLOBAL
const char *info_script_option
;
180 GLOBAL
bool interactive_option
;
182 /* If nonzero, extract only Nth occurrence of each named file */
183 GLOBAL
uintmax_t occurrence_option
;
187 DEFAULT_OLD_FILES
, /* default */
188 NO_OVERWRITE_DIR_OLD_FILES
, /* --no-overwrite-dir */
189 OVERWRITE_OLD_FILES
, /* --overwrite */
190 UNLINK_FIRST_OLD_FILES
, /* --unlink-first */
191 KEEP_OLD_FILES
, /* --keep-old-files */
192 KEEP_NEWER_FILES
, /* --keep-newer-files */
194 GLOBAL
enum old_files old_files_option
;
196 /* Specified file name for incremental list. */
197 GLOBAL
const char *listed_incremental_option
;
199 /* Specified mode change string. */
200 GLOBAL
struct mode_change
*mode_option
;
202 GLOBAL
bool multi_volume_option
;
204 /* The same variable hold the time, whether mtime or ctime. Just fake a
205 non-existing option, for making the code clearer, elsewhere. */
206 #define newer_ctime_option newer_mtime_option
208 /* Specified threshold date and time. Files having an older time stamp
209 do not get archived (also see after_date_option above). */
210 GLOBAL
time_t newer_mtime_option
;
212 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
213 GLOBAL
int recursion_option
;
215 GLOBAL
bool numeric_owner_option
;
217 GLOBAL
bool one_file_system_option
;
219 /* Specified value to be put into tar file in place of stat () results, or
220 just -1 if such an override should not take place. */
221 GLOBAL uid_t owner_option
;
223 GLOBAL
bool recursive_unlink_option
;
225 GLOBAL
bool read_full_records_option
;
227 GLOBAL
bool remove_files_option
;
229 /* Specified remote shell command. */
230 GLOBAL
const char *rsh_command_option
;
232 GLOBAL
bool same_order_option
;
234 /* If positive, preserve ownership when extracting. */
235 GLOBAL
int same_owner_option
;
237 /* If positive, preserve permissions when extracting. */
238 GLOBAL
int same_permissions_option
;
240 /* When set, strip the given number of path elements from the file name
242 GLOBAL
size_t strip_path_elements
;
244 GLOBAL
bool show_omitted_dirs_option
;
246 GLOBAL
bool sparse_option
;
248 GLOBAL
bool starting_file_option
;
250 /* Specified maximum byte length of each tape volume (multiple of 1024). */
251 GLOBAL tarlong tape_length_option
;
253 GLOBAL
bool to_stdout_option
;
255 GLOBAL
bool totals_option
;
257 GLOBAL
bool touch_option
;
259 /* Count how many times the option has been set, multiple setting yields
260 more verbose behavior. Value 0 means no verbosity, 1 means file name
261 only, 2 means file name and all attributes. More than 2 is just like 2. */
262 GLOBAL
int verbose_option
;
264 GLOBAL
bool verify_option
;
266 /* Specified name of file containing the volume number. */
267 GLOBAL
const char *volno_file_option
;
269 /* Specified value or pattern. */
270 GLOBAL
const char *volume_label_option
;
272 /* Other global variables. */
274 /* File descriptor for archive file. */
277 /* Nonzero when outputting to /dev/null. */
278 GLOBAL
bool dev_null_output
;
280 /* Timestamp for when we started execution. */
281 #if HAVE_CLOCK_GETTIME
282 GLOBAL
struct timespec start_timespec
;
283 # define start_time (start_timespec.tv_sec)
285 GLOBAL
time_t start_time
;
288 GLOBAL
struct tar_stat_info current_stat_info
;
290 /* List of tape drive names, number of such tape drives, allocated number,
291 and current cursor in list. */
292 GLOBAL
const char **archive_name_array
;
293 GLOBAL
int archive_names
;
294 GLOBAL
int allocated_archive_names
;
295 GLOBAL
const char **archive_name_cursor
;
297 /* Output index file name. */
298 GLOBAL
char const *index_file_name
;
300 /* Structure for keeping track of filenames and lists thereof. */
304 size_t length
; /* cached strlen(name) */
305 uintmax_t found_count
; /* number of times a matching file has
308 char firstch
; /* first char is literally matched */
309 char regexp
; /* this name is a regexp, not literal */
310 int change_dir
; /* set with the -C option */
311 char const *dir_contents
; /* for incremental_option */
312 char fake
; /* dummy entry */
316 /* Obnoxious test to see if dimwit is trying to dump the archive. */
321 /* Declarations for each module. */
323 /* FIXME: compare.c should not directly handle the following variable,
324 instead, this should be done in buffer.c only. */
332 extern enum access_mode access_mode
;
334 /* Module buffer.c. */
337 extern char *save_name
;
338 extern off_t save_sizeleft
;
339 extern off_t save_totsize
;
340 extern bool write_archive_to_stdout
;
342 size_t available_space_after (union block
*);
343 off_t
current_block_ordinal (void);
344 void close_archive (void);
345 void closeout_volume_number (void);
346 union block
*find_next_block (void);
347 void flush_read (void);
348 void flush_write (void);
349 void flush_archive (void);
350 void init_volume_number (void);
351 void open_archive (enum access_mode
);
352 void print_total_written (void);
353 void reset_eof (void);
354 void set_next_block_after (union block
*);
355 void clear_read_error_count (void);
356 void xclose (int fd
);
357 void archive_write_error (ssize_t
) __attribute__ ((noreturn
));
358 void archive_read_error (void);
360 /* Module create.c. */
367 dump_status_not_implemented
370 bool file_dumpable_p (struct tar_stat_info
*stat
);
371 void create_archive (void);
372 void pad_archive (off_t size_left
);
373 void dump_file (char *, int, dev_t
);
374 union block
*start_header (struct tar_stat_info
*st
);
375 void finish_header (struct tar_stat_info
*, union block
*, off_t
);
376 void simple_finish_header (union block
*header
);
377 union block
*start_private_header (const char *name
, size_t size
);
378 void write_eot (void);
379 void check_links (void);
381 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
382 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
383 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
384 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
385 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
386 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
387 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
388 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
389 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
390 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
391 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
393 void gid_to_chars (gid_t
, char *, size_t);
394 void major_to_chars (major_t
, char *, size_t);
395 void minor_to_chars (minor_t
, char *, size_t);
396 void mode_to_chars (mode_t
, char *, size_t);
397 void off_to_chars (off_t
, char *, size_t);
398 void size_to_chars (size_t, char *, size_t);
399 void time_to_chars (time_t, char *, size_t);
400 void uid_to_chars (uid_t
, char *, size_t);
401 void uintmax_to_chars (uintmax_t, char *, size_t);
402 void string_to_chars (char *, char *, size_t);
404 /* Module diffarch.c. */
406 extern bool now_verifying
;
408 void diff_archive (void);
409 void diff_init (void);
410 void verify_volume (void);
412 /* Module extract.c. */
414 extern bool we_are_root
;
415 void extr_init (void);
416 void extract_archive (void);
417 void extract_finish (void);
418 void fatal_exit (void) __attribute__ ((noreturn
));
420 /* Module delete.c. */
422 void delete_archive_members (void);
424 /* Module incremen.c. */
426 char *get_directory_contents (char *, dev_t
);
427 void read_directory_file (void);
428 void write_directory_file (void);
429 void gnu_restore (char const *);
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 #define STRINGIFY_BIGINT(i, b) \
459 stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
460 char *stringify_uintmax_t_backwards (uintmax_t, char *);
461 char const *tartime (time_t);
463 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
464 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
465 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
466 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
467 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
468 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
469 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
470 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
471 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
473 gid_t
gid_from_header (const char *, size_t);
474 major_t
major_from_header (const char *, size_t);
475 minor_t
minor_from_header (const char *, size_t);
476 mode_t
mode_from_header (const char *, size_t);
477 off_t
off_from_header (const char *, size_t);
478 size_t size_from_header (const char *, size_t);
479 time_t time_from_header (const char *, size_t);
480 uid_t
uid_from_header (const char *, size_t);
481 uintmax_t uintmax_from_header (const char *, size_t);
483 void list_archive (void);
484 void print_for_mkdir (char *, int, mode_t
);
485 void print_header (struct tar_stat_info
*, off_t
);
486 void read_and (void (*) (void));
487 enum read_header
read_header (bool);
488 void skip_file (off_t
);
489 void skip_member (void);
491 /* Module mangle.c. */
493 void extract_mangle (void);
497 void assign_string (char **, const char *);
498 char *quote_copy_string (const char *);
499 int unquote_string (char *);
501 size_t dot_dot_prefix_len (char const *);
505 ORDINARY_REMOVE_OPTION
,
506 RECURSIVE_REMOVE_OPTION
,
507 WANT_DIRECTORY_REMOVE_OPTION
509 int remove_any_file (const char *, enum remove_option
);
510 bool maybe_backup_file (const char *, int);
511 void undo_last_backup (void);
513 int deref_stat (bool, char const *, struct stat
*);
515 int chdir_arg (char const *);
518 void decode_mode (mode_t
, char *);
520 void chdir_fatal (char const *) __attribute__ ((noreturn
));
521 void chmod_error_details (char const *, mode_t
);
522 void chown_error_details (char const *, uid_t
, gid_t
);
523 void close_error (char const *);
524 void close_warn (char const *);
525 void close_diag (char const *name
);
526 void exec_fatal (char const *) __attribute__ ((noreturn
));
527 void link_error (char const *, char const *);
528 void mkdir_error (char const *);
529 void mkfifo_error (char const *);
530 void mknod_error (char const *);
531 void open_error (char const *);
532 void open_fatal (char const *) __attribute__ ((noreturn
));
533 void open_warn (char const *);
534 void open_diag (char const *name
);
535 void read_error (char const *);
536 void read_error_details (char const *, off_t
, size_t);
537 void read_fatal (char const *) __attribute__ ((noreturn
));
538 void read_fatal_details (char const *, off_t
, size_t);
539 void read_warn_details (char const *, off_t
, size_t);
540 void read_diag_details (char const *name
, off_t offset
, size_t size
);
541 void readlink_error (char const *);
542 void readlink_warn (char const *);
543 void readlink_diag (char const *name
);
544 void savedir_error (char const *);
545 void savedir_warn (char const *);
546 void savedir_diag (char const *name
);
547 void seek_error (char const *);
548 void seek_error_details (char const *, off_t
);
549 void seek_warn (char const *);
550 void seek_warn_details (char const *, off_t
);
551 void seek_diag_details (char const *, off_t
);
552 void stat_error (char const *);
553 void stat_warn (char const *);
554 void stat_diag (char const *name
);
555 void symlink_error (char const *, char const *);
556 void truncate_error (char const *);
557 void truncate_warn (char const *);
558 void unlink_error (char const *);
559 void utime_error (char const *);
560 void waitpid_error (char const *);
561 void write_error (char const *);
562 void write_error_details (char const *, ssize_t
, size_t);
563 void write_fatal (char const *) __attribute__ ((noreturn
));
564 void write_fatal_details (char const *, ssize_t
, size_t)
565 __attribute__ ((noreturn
));
570 /* Module names.c. */
572 extern struct name
*gnu_list_name
;
574 void gid_to_gname (gid_t
, char **gname
);
575 int gname_to_gid (char *gname
, gid_t
*);
576 void uid_to_uname (uid_t
, char **uname
);
577 int uname_to_uid (char *uname
, uid_t
*);
579 void init_names (void);
580 void name_add (const char *);
581 void name_init (int, char *const *);
582 void name_term (void);
583 char *name_next (int);
584 void name_close (void);
585 void name_gather (void);
586 struct name
*addname (char const *, int);
587 int name_match (const char *);
588 void names_notfound (void);
589 void collect_and_sort_names (void);
590 struct name
*name_scan (const char *);
591 char *name_from_list (void);
592 void blank_name_list (void);
593 char *new_name (const char *, const char *);
594 char *safer_name_suffix (char const *, bool);
595 size_t stripped_prefix_len (char const *file_name
, size_t num
);
596 bool all_names_found (struct tar_stat_info
*);
598 bool excluded_name (char const *);
600 void add_avoided_name (char const *);
601 bool is_avoided_name (char const *);
603 bool contains_dot_dot (char const *);
605 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
606 (c)->found_count == occurrence_option)
607 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
608 (c)->found_count >= occurrence_option)
612 int confirm (const char *, const char *);
613 void request_stdin (const char *);
615 void tar_stat_init (struct tar_stat_info
*st
);
616 void tar_stat_destroy (struct tar_stat_info
*st
);
617 void usage (int) __attribute__ ((noreturn
));
619 /* Module update.c. */
621 extern char *output_start
;
623 void update_archive (void);
625 /* Module xheader.c. */
627 void xheader_decode (struct tar_stat_info
*);
628 void xheader_decode_global (void);
629 void xheader_store (char const *, struct tar_stat_info
const *, void *);
630 void xheader_read (union block
*, size_t);
631 void xheader_write (char type
, char *name
, struct xheader
*xhdr
);
632 void xheader_write_global (void);
633 void xheader_finish (struct xheader
*);
634 void xheader_destroy (struct xheader
*);
635 char *xheader_xhdr_name (struct tar_stat_info
*st
);
636 char *xheader_ghdr_name (void);
637 void xheader_set_option (char *string
);
639 /* Module system.c */
641 void sys_stat_nanoseconds (struct tar_stat_info
*stat
);
642 void sys_detect_dev_null_output (void);
643 void sys_save_archive_dev_ino (void);
644 void sys_drain_input_pipe (void);
645 void sys_wait_for_child (pid_t
);
646 void sys_spawn_shell (void);
647 bool sys_compare_uid (struct stat
*a
, struct stat
*b
);
648 bool sys_compare_gid (struct stat
*a
, struct stat
*b
);
649 bool sys_file_is_archive (struct tar_stat_info
*p
);
650 bool sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
651 int sys_truncate (int fd
);
652 void sys_reset_uid_gid (void);
653 pid_t
sys_child_open_for_compress (void);
654 pid_t
sys_child_open_for_uncompress (void);
655 ssize_t
sys_write_archive_buffer (void);
656 bool sys_get_archive_stat (void);
657 void sys_reset_uid_gid (void);
659 /* Module compare.c */
660 void report_difference (struct tar_stat_info
*st
, const char *message
, ...);
662 /* Module sparse.c */
663 bool sparse_file_p (struct tar_stat_info
*stat
);
664 bool sparse_member_p (struct tar_stat_info
*stat
);
665 bool sparse_fixup_header (struct tar_stat_info
*stat
);
666 enum dump_status
sparse_dump_file (int fd
, struct tar_stat_info
*stat
);
667 enum dump_status
sparse_extract_file (int fd
, struct tar_stat_info
*stat
, off_t
*size
);
668 enum dump_status
sparse_skip_file (struct tar_stat_info
*stat
);
669 bool sparse_diff_file (int fd
, struct tar_stat_info
*stat
);
672 bool string_ascii_p (const char *str
);
673 bool utf8_convert(bool to_utf
, const char *input
, char **output
);