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 /* This variable tells how to interpret newer_mtime_option, below. If zero,
132 files get archived if their mtime is not less than newer_mtime_option.
133 If nonzero, files get archived if *either* their ctime or mtime is not less
134 than newer_mtime_option. */
135 GLOBAL
int after_date_option
;
137 GLOBAL
bool atime_preserve_option
;
139 GLOBAL
bool backup_option
;
141 /* Type of backups being made. */
142 GLOBAL
enum backup_type backup_type
;
144 GLOBAL
bool block_number_option
;
146 GLOBAL
bool checkpoint_option
;
148 /* Specified name of compression program, or "gzip" as implied by -z. */
149 GLOBAL
const char *use_compress_program_option
;
151 GLOBAL
bool dereference_option
;
153 /* Print a message if not all links are dumped */
154 GLOBAL
int check_links_option
;
156 /* Patterns that match file names to be excluded. */
157 GLOBAL
struct exclude
*excluded
;
159 /* Specified file containing names to work on. */
160 GLOBAL
const char *files_from_option
;
162 GLOBAL
bool force_local_option
;
164 /* Specified value to be put into tar file in place of stat () results, or
165 just -1 if such an override should not take place. */
166 GLOBAL gid_t group_option
;
168 GLOBAL
bool ignore_failed_read_option
;
170 GLOBAL
bool ignore_zeros_option
;
172 GLOBAL
bool incremental_option
;
174 /* Specified name of script to run at end of each tape change. */
175 GLOBAL
const char *info_script_option
;
177 GLOBAL
bool interactive_option
;
179 /* If nonzero, extract only Nth occurrence of each named file */
180 GLOBAL
uintmax_t occurrence_option
;
184 DEFAULT_OLD_FILES
, /* default */
185 NO_OVERWRITE_DIR_OLD_FILES
, /* --no-overwrite-dir */
186 OVERWRITE_OLD_FILES
, /* --overwrite */
187 UNLINK_FIRST_OLD_FILES
, /* --unlink-first */
188 KEEP_OLD_FILES
/* --keep-old-files */
190 GLOBAL
enum old_files old_files_option
;
192 /* Specified file name for incremental list. */
193 GLOBAL
const char *listed_incremental_option
;
195 /* Specified mode change string. */
196 GLOBAL
struct mode_change
*mode_option
;
198 GLOBAL
bool multi_volume_option
;
200 /* The same variable hold the time, whether mtime or ctime. Just fake a
201 non-existing option, for making the code clearer, elsewhere. */
202 #define newer_ctime_option newer_mtime_option
204 /* Specified threshold date and time. Files having an older time stamp
205 do not get archived (also see after_date_option above). */
206 GLOBAL
time_t newer_mtime_option
;
208 /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */
209 GLOBAL
int recursion_option
;
211 GLOBAL
bool numeric_owner_option
;
213 GLOBAL
bool one_file_system_option
;
215 /* Specified value to be put into tar file in place of stat () results, or
216 just -1 if such an override should not take place. */
217 GLOBAL uid_t owner_option
;
219 GLOBAL
bool recursive_unlink_option
;
221 GLOBAL
bool read_full_records_option
;
223 GLOBAL
bool remove_files_option
;
225 /* Specified remote shell command. */
226 GLOBAL
const char *rsh_command_option
;
228 GLOBAL
bool same_order_option
;
230 /* If positive, preserve ownership when extracting. */
231 GLOBAL
int same_owner_option
;
233 /* If positive, preserve permissions when extracting. */
234 GLOBAL
int same_permissions_option
;
236 /* When set, strip the given number of path elements from the file name
238 GLOBAL
size_t strip_path_elements
;
240 GLOBAL
bool show_omitted_dirs_option
;
242 GLOBAL
bool sparse_option
;
244 GLOBAL
bool starting_file_option
;
246 /* Specified maximum byte length of each tape volume (multiple of 1024). */
247 GLOBAL tarlong tape_length_option
;
249 GLOBAL
bool to_stdout_option
;
251 GLOBAL
bool totals_option
;
253 GLOBAL
bool touch_option
;
255 /* Count how many times the option has been set, multiple setting yields
256 more verbose behavior. Value 0 means no verbosity, 1 means file name
257 only, 2 means file name and all attributes. More than 2 is just like 2. */
258 GLOBAL
int verbose_option
;
260 GLOBAL
bool verify_option
;
262 /* Specified name of file containing the volume number. */
263 GLOBAL
const char *volno_file_option
;
265 /* Specified value or pattern. */
266 GLOBAL
const char *volume_label_option
;
268 /* Other global variables. */
270 /* File descriptor for archive file. */
273 /* Nonzero when outputting to /dev/null. */
274 GLOBAL
bool dev_null_output
;
276 /* Timestamp for when we started execution. */
277 #if HAVE_CLOCK_GETTIME
278 GLOBAL
struct timespec start_timespec
;
279 # define start_time (start_timespec.tv_sec)
281 GLOBAL
time_t start_time
;
284 GLOBAL
struct tar_stat_info current_stat_info
;
286 /* List of tape drive names, number of such tape drives, allocated number,
287 and current cursor in list. */
288 GLOBAL
const char **archive_name_array
;
289 GLOBAL
int archive_names
;
290 GLOBAL
int allocated_archive_names
;
291 GLOBAL
const char **archive_name_cursor
;
293 /* Output index file name. */
294 GLOBAL
char const *index_file_name
;
296 /* Structure for keeping track of filenames and lists thereof. */
300 size_t length
; /* cached strlen(name) */
301 uintmax_t found_count
; /* number of times a matching file has
304 char firstch
; /* first char is literally matched */
305 char regexp
; /* this name is a regexp, not literal */
306 int change_dir
; /* set with the -C option */
307 char const *dir_contents
; /* for incremental_option */
308 char fake
; /* dummy entry */
312 /* Information about a sparse file. */
318 GLOBAL
struct sp_array
*sparsearray
;
320 /* Number of elements in sparsearray. */
321 GLOBAL
int sp_array_size
;
323 /* Obnoxious test to see if dimwit is trying to dump the archive. */
328 /* Declarations for each module. */
330 /* FIXME: compare.c should not directly handle the following variable,
331 instead, this should be done in buffer.c only. */
339 extern enum access_mode access_mode
;
341 /* Module buffer.c. */
344 extern char *save_name
;
345 extern off_t save_sizeleft
;
346 extern off_t save_totsize
;
347 extern bool write_archive_to_stdout
;
349 size_t available_space_after (union block
*);
350 off_t
current_block_ordinal (void);
351 void close_archive (void);
352 void closeout_volume_number (void);
353 union block
*find_next_block (void);
354 void flush_read (void);
355 void flush_write (void);
356 void flush_archive (void);
357 void init_volume_number (void);
358 void open_archive (enum access_mode
);
359 void print_total_written (void);
360 void reset_eof (void);
361 void set_next_block_after (union block
*);
362 void clear_read_error_count (void);
363 void xclose (int fd
);
364 void archive_write_error (ssize_t
) __attribute__ ((noreturn
));
365 void archive_read_error (void);
367 /* Module create.c. */
369 void create_archive (void);
370 void dump_file (char *, int, dev_t
);
371 void finish_header (union block
*, off_t
);
372 void init_sparsearray (void);
373 void write_eot (void);
374 void check_links (void);
376 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
377 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
378 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
379 #define MODE_TO_CHARS(val, where) mode_to_chars (val, where, sizeof (where))
380 #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where))
381 #define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where))
382 #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where))
383 #define UID_TO_CHARS(val, where) uid_to_chars (val, where, sizeof (where))
384 #define UINTMAX_TO_CHARS(val, where) uintmax_to_chars (val, where, sizeof (where))
385 #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
386 #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf))
388 void gid_to_chars (gid_t
, char *, size_t);
389 void major_to_chars (major_t
, char *, size_t);
390 void minor_to_chars (minor_t
, char *, size_t);
391 void mode_to_chars (mode_t
, char *, size_t);
392 void off_to_chars (off_t
, char *, size_t);
393 void size_to_chars (size_t, char *, size_t);
394 void time_to_chars (time_t, char *, size_t);
395 void uid_to_chars (uid_t
, char *, size_t);
396 void uintmax_to_chars (uintmax_t, char *, size_t);
397 void string_to_chars (char *, char *, size_t);
399 /* Module diffarch.c. */
401 extern bool now_verifying
;
403 void diff_archive (void);
404 void diff_init (void);
405 void verify_volume (void);
407 /* Module extract.c. */
409 extern bool we_are_root
;
410 void extr_init (void);
411 bool fill_in_sparse_array (void);
412 void extract_archive (void);
413 void extract_finish (void);
414 void fatal_exit (void) __attribute__ ((noreturn
));
416 /* Module delete.c. */
418 void delete_archive_members (void);
420 /* Module incremen.c. */
422 char *get_directory_contents (char *, dev_t
);
423 void read_directory_file (void);
424 void write_directory_file (void);
425 void gnu_restore (char const *);
431 HEADER_STILL_UNREAD
, /* for when read_header has not been called */
432 HEADER_SUCCESS
, /* header successfully read and checksummed */
433 HEADER_SUCCESS_EXTENDED
, /* likewise, but we got an extended header */
434 HEADER_ZERO_BLOCK
, /* zero block where header expected */
435 HEADER_END_OF_FILE
, /* true end of file while header expected */
436 HEADER_FAILURE
/* ill-formed header, or bad checksum */
446 GLOBAL
struct xheader extended_header
;
447 extern union block
*current_header
;
448 extern enum archive_format current_format
;
449 extern size_t recent_long_name_blocks
;
450 extern size_t recent_long_link_blocks
;
452 void decode_header (union block
*, struct tar_stat_info
*,
453 enum archive_format
*, int);
454 #define STRINGIFY_BIGINT(i, b) \
455 stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND)
456 char *stringify_uintmax_t_backwards (uintmax_t, char *);
457 char const *tartime (time_t);
459 #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where))
460 #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where))
461 #define MINOR_FROM_HEADER(where) minor_from_header (where, sizeof (where))
462 #define MODE_FROM_HEADER(where) mode_from_header (where, sizeof (where))
463 #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where))
464 #define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where))
465 #define TIME_FROM_HEADER(where) time_from_header (where, sizeof (where))
466 #define UID_FROM_HEADER(where) uid_from_header (where, sizeof (where))
467 #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where))
469 gid_t
gid_from_header (const char *, size_t);
470 major_t
major_from_header (const char *, size_t);
471 minor_t
minor_from_header (const char *, size_t);
472 mode_t
mode_from_header (const char *, size_t);
473 off_t
off_from_header (const char *, size_t);
474 size_t size_from_header (const char *, size_t);
475 time_t time_from_header (const char *, size_t);
476 uid_t
uid_from_header (const char *, size_t);
477 uintmax_t uintmax_from_header (const char *, size_t);
479 void list_archive (void);
480 void print_for_mkdir (char *, int, mode_t
);
481 void print_header (off_t
);
482 void read_and (void (*) (void));
483 enum read_header
read_header (bool);
484 void skip_file (off_t
);
485 void skip_member (void);
487 /* Module mangle.c. */
489 void extract_mangle (void);
493 void assign_string (char **, const char *);
494 char *quote_copy_string (const char *);
495 int unquote_string (char *);
497 size_t dot_dot_prefix_len (char const *);
501 ORDINARY_REMOVE_OPTION
,
502 RECURSIVE_REMOVE_OPTION
,
503 WANT_DIRECTORY_REMOVE_OPTION
505 int remove_any_file (const char *, enum remove_option
);
506 int maybe_backup_file (const char *, int);
507 void undo_last_backup (void);
509 int deref_stat (bool, char const *, struct stat
*);
511 int chdir_arg (char const *);
514 void decode_mode (mode_t
, char *);
516 void chdir_fatal (char const *) __attribute__ ((noreturn
));
517 void chmod_error_details (char const *, mode_t
);
518 void chown_error_details (char const *, uid_t
, gid_t
);
519 void close_error (char const *);
520 void close_warn (char const *);
521 void exec_fatal (char const *) __attribute__ ((noreturn
));
522 void link_error (char const *, char const *);
523 void mkdir_error (char const *);
524 void mkfifo_error (char const *);
525 void mknod_error (char const *);
526 void open_error (char const *);
527 void open_fatal (char const *) __attribute__ ((noreturn
));
528 void open_warn (char const *);
529 void read_error (char const *);
530 void read_error_details (char const *, off_t
, size_t);
531 void read_fatal (char const *) __attribute__ ((noreturn
));
532 void read_fatal_details (char const *, off_t
, size_t);
533 void read_warn_details (char const *, off_t
, size_t);
534 void readlink_error (char const *);
535 void readlink_warn (char const *);
536 void savedir_error (char const *);
537 void savedir_warn (char const *);
538 void seek_error (char const *);
539 void seek_error_details (char const *, off_t
);
540 void seek_warn (char const *);
541 void seek_warn_details (char const *, off_t
);
542 void stat_error (char const *);
543 void stat_warn (char const *);
544 void symlink_error (char const *, char const *);
545 void truncate_error (char const *);
546 void truncate_warn (char const *);
547 void unlink_error (char const *);
548 void utime_error (char const *);
549 void waitpid_error (char const *);
550 void write_error (char const *);
551 void write_error_details (char const *, ssize_t
, size_t);
552 void write_fatal (char const *) __attribute__ ((noreturn
));
553 void write_fatal_details (char const *, ssize_t
, size_t)
554 __attribute__ ((noreturn
));
559 /* Module names.c. */
561 extern struct name
*gnu_list_name
;
563 void gid_to_gname (gid_t
, char **gname
);
564 int gname_to_gid (char *gname
, gid_t
*);
565 void uid_to_uname (uid_t
, char **uname
);
566 int uname_to_uid (char *uname
, uid_t
*);
568 void init_names (void);
569 void name_add (const char *);
570 void name_init (int, char *const *);
571 void name_term (void);
572 char *name_next (int);
573 void name_close (void);
574 void name_gather (void);
575 struct name
*addname (char const *, int);
576 int name_match (const char *);
577 void names_notfound (void);
578 void collect_and_sort_names (void);
579 struct name
*name_scan (const char *);
580 char *name_from_list (void);
581 void blank_name_list (void);
582 char *new_name (const char *, const char *);
583 char *safer_name_suffix (char const *, bool);
584 size_t stripped_prefix_len (char const *file_name
, size_t num
);
585 bool all_names_found (struct tar_stat_info
*);
587 bool excluded_name (char const *);
589 void add_avoided_name (char const *);
590 bool is_avoided_name (char const *);
592 bool contains_dot_dot (char const *);
594 #define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
595 (c)->found_count == occurrence_option)
596 #define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \
597 (c)->found_count >= occurrence_option)
601 int confirm (const char *, const char *);
602 void request_stdin (const char *);
603 void destroy_stat (struct tar_stat_info
*);
605 /* Module update.c. */
607 extern char *output_start
;
609 void update_archive (void);
611 /* Module xheader.c. */
613 void xheader_decode (struct tar_stat_info
*);
614 void xheader_store (char const *, struct tar_stat_info
const *);
615 void xheader_read (union block
*, size_t);
616 void xheader_finish (struct xheader
*);
617 void xheader_destroy (struct xheader
*);
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 void sys_compare_uid_gid (struct stat
*a
, struct stat
*b
);
627 bool sys_file_is_archive (struct tar_stat_info
*p
);
628 void sys_compare_links (struct stat
*link_data
, struct stat
*stat_data
);
629 int sys_truncate (int fd
);
630 void sys_reset_uid_gid (void);
631 pid_t
sys_child_open_for_compress (void);
632 pid_t
sys_child_open_for_uncompress (void);
633 ssize_t
sys_write_archive_buffer (void);
634 bool sys_get_archive_stat (void);
636 /* Module compare.c */
637 void report_difference (const char *message
, ...);