X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Ftar;a=blobdiff_plain;f=src%2Fcommon.h;h=14ae2caddfbb8e3db77bceaa6cef3c4a666fdbe3;hp=24227f4bd7adfb0ced64d404315436bdd37fc759;hb=45ccda119355a1087450039a250359c1d0de0d08;hpb=34795cedb7db68babf7eae672ba47fd486555be8 diff --git a/src/common.h b/src/common.h index 24227f4..14ae2ca 100644 --- a/src/common.h +++ b/src/common.h @@ -1,22 +1,22 @@ /* Common declarations for the tar program. - Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001, - 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, - Inc. + Copyright 1988, 1992-1994, 1996-1997, 1999-2010, 2012-2014 Free + Software Foundation, Inc. - This program is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by the - Free Software Foundation; either version 3, or (at your option) any later - version. + This file is part of GNU tar. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General - Public License for more details. + GNU tar is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 3 of the License, or + (at your option) any later version. - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ + GNU tar is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . */ /* Declare the GNU tar archive format. */ #include "tar.h" @@ -70,6 +70,11 @@ #define LG_8 3 #define LG_64 6 #define LG_256 8 + +_GL_INLINE_HEADER_BEGIN +#ifndef COMMON_INLINE +# define COMMON_INLINE _GL_INLINE +#endif /* Information gleaned from the command line. */ @@ -138,9 +143,6 @@ GLOBAL const char *use_compress_program_option; GLOBAL bool dereference_option; GLOBAL bool hard_dereference_option; -/* Print a message if not all links are dumped */ -GLOBAL int check_links_option; - /* Patterns that match file names to be excluded. */ GLOBAL struct exclude *excluded; @@ -158,7 +160,8 @@ enum exclusion_tag_type }; /* Specified value to be put into tar file in place of stat () results, or - just -1 if such an override should not take place. */ + just null and -1 if such an override should not take place. */ +GLOBAL char const *group_name_option; GLOBAL gid_t group_option; GLOBAL bool ignore_failed_read_option; @@ -182,10 +185,13 @@ enum old_files OVERWRITE_OLD_FILES, /* --overwrite */ UNLINK_FIRST_OLD_FILES, /* --unlink-first */ KEEP_OLD_FILES, /* --keep-old-files */ + SKIP_OLD_FILES, /* --skip-old-files */ KEEP_NEWER_FILES /* --keep-newer-files */ }; GLOBAL enum old_files old_files_option; +GLOBAL bool keep_directory_symlink_option; + /* Specified file name for incremental list. */ GLOBAL const char *listed_incremental_option; /* Incremental dump level */ @@ -229,8 +235,13 @@ GLOBAL bool numeric_owner_option; GLOBAL bool one_file_system_option; +/* Create a top-level directory for extracting based on the archive name. */ +GLOBAL bool one_top_level_option; +GLOBAL char *one_top_level_dir; + /* Specified value to be put into tar file in place of stat () results, or - just -1 if such an override should not take place. */ + just null and -1 if such an override should not take place. */ +GLOBAL char const *owner_name_option; GLOBAL uid_t owner_option; GLOBAL bool recursive_unlink_option; @@ -239,9 +250,6 @@ GLOBAL bool read_full_records_option; GLOBAL bool remove_files_option; -/* Specified rmt command. */ -GLOBAL const char *rmt_command_option; - /* Specified remote shell command. */ GLOBAL const char *rsh_command_option; @@ -253,6 +261,15 @@ GLOBAL int same_owner_option; /* If positive, preserve permissions when extracting. */ GLOBAL int same_permissions_option; +/* If positive, save the SELinux context. */ +GLOBAL int selinux_context_option; + +/* If positive, save the ACLs. */ +GLOBAL int acls_option; + +/* If positive, save the user and root xattrs. */ +GLOBAL int xattrs_option; + /* When set, strip the given number of file name components from the file name before extracting */ GLOBAL size_t strip_name_components; @@ -313,11 +330,10 @@ GLOBAL struct timespec last_stat_time; /* when the statistics was last GLOBAL struct tar_stat_info current_stat_info; -/* List of tape drive names, number of such tape drives, allocated number, +/* List of tape drive names, number of such tape drives, and current cursor in list. */ GLOBAL const char **archive_name_array; GLOBAL size_t archive_names; -GLOBAL size_t allocated_archive_names; GLOBAL const char **archive_name_cursor; /* Output index file name. */ @@ -357,6 +373,11 @@ struct name GLOBAL dev_t ar_dev; GLOBAL ino_t ar_ino; +/* Flags for reading, searching, and fstatatting files. */ +GLOBAL int open_read_flags; +GLOBAL int open_searchdir_flags; +GLOBAL int fstatat_flags; + GLOBAL int seek_option; GLOBAL bool seekable_archive; @@ -410,7 +431,7 @@ size_t available_space_after (union block *pointer); off_t current_block_ordinal (void); void close_archive (void); void closeout_volume_number (void); -void compute_duration (void); +double compute_duration (void); union block *find_next_block (void); void flush_read (void); void flush_write (void); @@ -427,6 +448,12 @@ void archive_read_error (void); off_t seek_archive (off_t size); void set_start_time (void); +#define TF_READ 0 +#define TF_WRITE 1 +#define TF_DELETED 2 +int format_total_stats (FILE *fp, const char **formats, int eor, int eol); +void print_total_stats (void); + void mv_begin_write (const char *file_name, off_t totsize, off_t sizeleft); void mv_begin_read (struct tar_stat_info *st); @@ -435,6 +462,9 @@ void mv_size_left (off_t size); void buffer_write_global_xheader (void); +const char *first_decompress_program (int *pstate); +const char *next_decompress_program (int *pstate); + /* Module create.c. */ enum dump_status @@ -446,12 +476,14 @@ enum dump_status }; void add_exclusion_tag (const char *name, enum exclusion_tag_type type, - bool (*)(const char*)); -bool cachedir_file_p (const char *name); + bool (*predicate) (int)); +bool cachedir_file_p (int fd); +char *get_directory_entries (struct tar_stat_info *st); void create_archive (void); void pad_archive (off_t size_left); -void dump_file (const char *st, bool top_level, dev_t parent_device); +void dump_file (struct tar_stat_info *parent, char const *name, + char const *fullname); union block *start_header (struct tar_stat_info *st); void finish_header (struct tar_stat_info *st, union block *header, off_t block_ordinal); @@ -461,17 +493,17 @@ union block * write_extended (bool global, struct tar_stat_info *st, union block *start_private_header (const char *name, size_t size, time_t t); void write_eot (void); void check_links (void); +int subfile_open (struct tar_stat_info const *dir, char const *file, int flags); +void restore_parent_fd (struct tar_stat_info const *st); void exclusion_tag_warning (const char *dirname, const char *tagname, const char *message); -enum exclusion_tag_type check_exclusion_tags (const char *dirname, +enum exclusion_tag_type check_exclusion_tags (struct tar_stat_info const *st, const char **tag_file_name); #define OFF_TO_CHARS(val, where) off_to_chars (val, where, sizeof (where)) -#define SIZE_TO_CHARS(val, where) size_to_chars (val, where, sizeof (where)) #define TIME_TO_CHARS(val, where) time_to_chars (val, where, sizeof (where)) bool off_to_chars (off_t off, char *buf, size_t size); -bool size_to_chars (size_t v, char *buf, size_t size); bool time_to_chars (time_t t, char *buf, size_t size); /* Module diffarch.c. */ @@ -495,8 +527,7 @@ void delete_archive_members (void); /* Module incremen.c. */ -struct directory *scan_directory (char *dir, dev_t device, bool cmdline); -void name_fill_directory (struct name *name, dev_t device, bool cmdline); +struct directory *scan_directory (struct tar_stat_info *st); const char *directory_contents (struct directory *dir); const char *safe_directory_contents (struct directory *dir); @@ -505,14 +536,16 @@ void rebase_directory (struct directory *dir, const char *repl, size_t rlen); void append_incremental_renames (struct directory *dir); +void show_snapshot_field_ranges (void); void read_directory_file (void); void write_directory_file (void); void purge_directory (char const *directory_name); void list_dumpdir (char *buffer, size_t size); -void update_parent_directory (const char *name); +void update_parent_directory (struct tar_stat_info *st); size_t dumpdir_size (const char *p); bool is_dumpdir (struct tar_stat_info *stat_info); +void clear_directory_table (void); /* Module list.c. */ @@ -544,14 +577,13 @@ extern size_t recent_long_link_blocks; void decode_header (union block *header, struct tar_stat_info *stat_info, enum archive_format *format_pointer, int do_user_group); +void transform_stat_info (int typeflag, struct tar_stat_info *stat_info); char const *tartime (struct timespec t, bool full_time); #define OFF_FROM_HEADER(where) off_from_header (where, sizeof (where)) -#define SIZE_FROM_HEADER(where) size_from_header (where, sizeof (where)) #define UINTMAX_FROM_HEADER(where) uintmax_from_header (where, sizeof (where)) off_t off_from_header (const char *buf, size_t size); -size_t size_from_header (const char *buf, size_t size); uintmax_t uintmax_from_header (const char *buf, size_t size); void list_archive (void); @@ -569,23 +601,64 @@ void skip_member (void); /* Module misc.c. */ +#define min(a, b) ((a) < (b) ? (a) : (b)) +#define max(a, b) ((a) < (b) ? (b) : (a)) void assign_string (char **dest, const char *src); int unquote_string (char *str); char *zap_slashes (char *name); -char *normalize_filename (const char *name); +char *normalize_filename (int cdidx, const char *name); +void normalize_filename_x (char *name); void replace_prefix (char **pname, const char *samp, size_t slen, const char *repl, size_t rlen); +char *tar_savedir (const char *name, int must_exist); typedef struct namebuf *namebuf_t; namebuf_t namebuf_create (const char *dir); void namebuf_free (namebuf_t buf); char *namebuf_name (namebuf_t buf, const char *name); +void namebuf_add_dir (namebuf_t buf, const char *name); +char *namebuf_finish (namebuf_t buf); + +const char *tar_dirname (void); +/* Represent N using a signed integer I such that (uintmax_t) I == N. + With a good optimizing compiler, this is equivalent to (intmax_t) i + and requires zero machine instructions. */ +#if ! (UINTMAX_MAX / 2 <= INTMAX_MAX) +# error "represent_uintmax returns intmax_t to represent uintmax_t" +#endif +COMMON_INLINE intmax_t +represent_uintmax (uintmax_t n) +{ + if (n <= INTMAX_MAX) + return n; + else + { + /* Avoid signed integer overflow on picky platforms. */ + intmax_t nd = n - INTMAX_MIN; + return nd + INTMAX_MIN; + } +} + +enum { SYSINT_BUFSIZE = + max (UINTMAX_STRSIZE_BOUND, INT_BUFSIZE_BOUND (intmax_t)) }; +char *sysinttostr (uintmax_t, intmax_t, uintmax_t, char buf[SYSINT_BUFSIZE]); +intmax_t strtosysint (char const *, char **, intmax_t, uintmax_t); void code_ns_fraction (int ns, char *p); char const *code_timespec (struct timespec ts, char *sbuf); enum { BILLION = 1000000000, LOG10_BILLION = 9 }; enum { TIMESPEC_STRSIZE_BOUND = UINTMAX_STRSIZE_BOUND + LOG10_BILLION + sizeof "-." - 1 }; +struct timespec decode_timespec (char const *, char **, bool); + +/* Return true if T does not represent an out-of-range or invalid value. */ +COMMON_INLINE bool +valid_timespec (struct timespec t) +{ + return 0 <= t.tv_nsec; +} + +bool must_be_dot_or_slash (char const *); enum remove_option { @@ -605,8 +678,13 @@ int remove_any_file (const char *file_name, enum remove_option option); bool maybe_backup_file (const char *file_name, bool this_is_the_archive); void undo_last_backup (void); -int deref_stat (bool deref, char const *name, struct stat *buf); +int deref_stat (char const *name, struct stat *buf); + +size_t blocking_read (int fd, void *buf, size_t count); +size_t blocking_write (int fd, void const *buf, size_t count); +extern int chdir_current; +extern int chdir_fd; int chdir_arg (char const *dir); void chdir_do (int dir); int chdir_count (void); @@ -620,8 +698,6 @@ void seek_diag_details (char const *name, off_t offset); void stat_diag (char const *name); void file_removed_diag (const char *name, bool top_level, void (*diagfn) (char const *name)); -void dir_removed_diag (char const *name, bool top_level, - void (*diagfn) (char const *name)); void write_error_details (char const *name, size_t status, size_t size); void write_fatal (char const *name) __attribute__ ((noreturn)); void write_fatal_details (char const *name, ssize_t status, size_t size) @@ -631,11 +707,12 @@ pid_t xfork (void); void xpipe (int fd[2]); void *page_aligned_alloc (void **ptr, size_t size); -int set_file_atime (int fd, char const *file, - struct timespec const timespec[2]); +int set_file_atime (int fd, int parentfd, char const *file, + struct timespec atime); /* Module names.c. */ +extern size_t name_count; extern struct name *gnu_list_name; void gid_to_gname (gid_t gid, char **gname); @@ -646,6 +723,7 @@ int uname_to_uid (char const *uname, uid_t *puid); void name_init (void); void name_add_name (const char *name, int matching_flags); void name_add_dir (const char *name); +void name_add_file (const char *name, int term); void name_term (void); const char *name_next (int change_dirs); void name_gather (void); @@ -667,7 +745,6 @@ bool excluded_name (char const *name); void add_avoided_name (char const *name); bool is_avoided_name (char const *name); -bool is_individual_file (char const *name); bool contains_dot_dot (char const *name); @@ -683,6 +760,7 @@ void usage (int); int confirm (const char *message_action, const char *name); void tar_stat_init (struct tar_stat_info *st); +bool tar_stat_close (struct tar_stat_info *st); void tar_stat_destroy (struct tar_stat_info *st); void usage (int) __attribute__ ((noreturn)); int tar_timespec_cmp (struct timespec a, struct timespec b); @@ -690,19 +768,25 @@ const char *archive_format_string (enum archive_format fmt); const char *subcommand_string (enum subcommand c); void set_exit_status (int val); +void request_stdin (const char *option); +void more_options (int argc, char **argv); + /* Module update.c. */ extern char *output_start; void update_archive (void); +/* Module attrs.c. */ +#include "xattrs.h" + /* Module xheader.c. */ void xheader_decode (struct tar_stat_info *stat); void xheader_decode_global (struct xheader *xhdr); void xheader_store (char const *keyword, struct tar_stat_info *st, void const *data); -void xheader_read (struct xheader *xhdr, union block *header, size_t size); +void xheader_read (struct xheader *xhdr, union block *header, off_t size); void xheader_write (char type, char *name, time_t t, struct xheader *xhdr); void xheader_write_global (struct xheader *xhdr); void xheader_finish (struct xheader *hdr); @@ -716,6 +800,12 @@ bool xheader_string_end (struct xheader *xhdr, char const *keyword); bool xheader_keyword_deleted_p (const char *kw); char *xheader_format_name (struct tar_stat_info *st, const char *fmt, size_t n); +void xheader_xattr_init (struct tar_stat_info *st); +void xheader_xattr_free (struct xattr_array *vals, size_t sz); +void xheader_xattr_copy (const struct tar_stat_info *st, + struct xattr_array **vals, size_t *sz); +void xheader_xattr_add (struct tar_stat_info *st, + const char *key, const char *val, size_t len); /* Module system.c */ @@ -740,7 +830,8 @@ void sys_exec_checkpoint_script (const char *script_name, int checkpoint_number); /* Module compare.c */ -void report_difference (struct tar_stat_info *st, const char *message, ...); +void report_difference (struct tar_stat_info *st, const char *message, ...) + __attribute__ ((format (printf, 2, 3))); /* Module sparse.c */ bool sparse_member_p (struct tar_stat_info *st); @@ -765,14 +856,18 @@ void set_transform_expr (const char *expr); bool transform_name (char **pinput, int type); bool transform_name_fp (char **pinput, int type, char *(*fun)(char *, void *), void *); +bool transform_program_p (void); /* Module suffix.c */ void set_compression_program_by_suffix (const char *name, const char *defprog); +char *strip_compression_suffix (const char *name); /* Module checkpoint.c */ void checkpoint_compile_action (const char *str); void checkpoint_finish_compile (void); void checkpoint_run (bool do_write); +void checkpoint_finish (void); +void checkpoint_flush_actions (void); /* Module warning.c */ #define WARN_ALONE_ZERO_BLOCK 0x00000001 @@ -794,11 +889,16 @@ void checkpoint_run (bool do_write); #define WARN_UNKNOWN_CAST 0x00010000 #define WARN_UNKNOWN_KEYWORD 0x00020000 #define WARN_XDEV 0x00040000 +#define WARN_DECOMPRESS_PROGRAM 0x00080000 +#define WARN_EXISTING_FILE 0x00100000 +#define WARN_XATTR_WRITE 0x00200000 +#define WARN_RECORD_SIZE 0x00400000 -/* The warnings composing WARN_VERBOSE_WARNINGS are enabled by default - in verbose mode */ -#define WARN_VERBOSE_WARNINGS (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY) -#define WARN_ALL (0xffffffff & ~WARN_VERBOSE_WARNINGS) +/* These warnings are enabled by default in verbose mode: */ +#define WARN_VERBOSE_WARNINGS (WARN_RENAME_DIRECTORY|WARN_NEW_DIRECTORY|\ + WARN_DECOMPRESS_PROGRAM|WARN_EXISTING_FILE|\ + WARN_RECORD_SIZE) +#define WARN_ALL (~WARN_VERBOSE_WARNINGS) void set_warning_option (const char *arg); @@ -818,3 +918,5 @@ void finish_deferred_unlinks (void); /* Module exit.c */ extern void (*fatal_exit_hook) (void); + +_GL_INLINE_HEADER_END