X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fcommon.h;h=be7f35d15dbfa7f52c584c2eae362a1f7855fc20;hb=2f800ce3fb9c38360e1b6dac70ee0d8ceae72c6a;hp=12b056871b5198ce689fc0309e85bf4010263837;hpb=4dcf7987f8af01af6d665716892381160f3a667a;p=chaz%2Ftar diff --git a/src/common.h b/src/common.h index 12b0568..be7f35d 100644 --- a/src/common.h +++ b/src/common.h @@ -1,7 +1,7 @@ /* Common declarations for the tar program. Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001, - 2003 Free Software Foundation, Inc. + 2003, 2004, 2005 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 @@ -15,7 +15,7 @@ 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., - 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ /* Declare the GNU tar archive format. */ #include "tar.h" @@ -29,20 +29,11 @@ #define UNAME_FIELD_SIZE 32 #define GNAME_FIELD_SIZE 32 -/* FIXME */ -#define MAXOCTAL11 017777777777L -#define MAXOCTAL7 07777777 - /* Some various global definitions. */ /* Name of file to use for interacting with user. */ -#if MSDOS -# define TTY_NAME "con" -#else -# define TTY_NAME "/dev/tty" -#endif /* GLOBAL is defined to empty in tar.c only, and left alone in other *.c modules. Here, we merely set it to "extern" if it is not already set. @@ -52,31 +43,10 @@ # define GLOBAL extern #endif -/* Exit status for GNU tar. Let's try to keep this list as simple as - possible. -d option strongly invites a status different for unequal - comparison and other errors. */ -GLOBAL int exit_status; - -#define TAREXIT_SUCCESS 0 -#define TAREXIT_DIFFERS 1 -#define TAREXIT_FAILURE 2 - -/* Both WARN and ERROR write a message on stderr and continue processing, - however ERROR manages so tar will exit unsuccessfully. FATAL_ERROR - writes a message on stderr and aborts immediately, with another message - line telling so. USAGE_ERROR works like FATAL_ERROR except that the - other message line suggests trying --help. All four macros accept a - single argument of the form ((0, errno, _("FORMAT"), Args...)). errno - is zero when the error is not being detected by the system. */ - -#define WARN(Args) \ - error Args -#define ERROR(Args) \ - (error Args, exit_status = TAREXIT_FAILURE) -#define FATAL_ERROR(Args) \ - (error Args, fatal_exit ()) -#define USAGE_ERROR(Args) \ - (error Args, usage (TAREXIT_FAILURE)) +#define TAREXIT_SUCCESS PAXEXIT_SUCCESS +#define TAREXIT_DIFFERS PAXEXIT_DIFFERS +#define TAREXIT_FAILURE PAXEXIT_FAILURE + #include "arith.h" #include @@ -85,6 +55,13 @@ GLOBAL int exit_status; #include #include #include +#include +#include +#define obstack_chunk_alloc xmalloc +#define obstack_chunk_free free +#include + +#include /* Log base 2 of common values. */ #define LG_8 3 @@ -128,6 +105,9 @@ GLOBAL size_t record_size; GLOBAL bool absolute_names_option; +/* Display file times in UTC */ +GLOBAL bool utc_option; + /* This variable tells how to interpret newer_mtime_option, below. If zero, files get archived if their mtime is not less than newer_mtime_option. If nonzero, files get archived if *either* their ctime or mtime is not less @@ -156,10 +136,8 @@ GLOBAL int check_links_option; /* Patterns that match file names to be excluded. */ GLOBAL struct exclude *excluded; -/* Specified file containing names to work on. */ -GLOBAL const char *files_from_option; - -GLOBAL bool force_local_option; +/* Exclude directories containing a cache directory tag. */ +GLOBAL bool exclude_caches_option; /* Specified value to be put into tar file in place of stat () results, or just -1 if such an override should not take place. */ @@ -181,11 +159,12 @@ GLOBAL uintmax_t occurrence_option; enum old_files { - DEFAULT_OLD_FILES, /* default */ + DEFAULT_OLD_FILES, /* default */ NO_OVERWRITE_DIR_OLD_FILES, /* --no-overwrite-dir */ - OVERWRITE_OLD_FILES, /* --overwrite */ - UNLINK_FIRST_OLD_FILES, /* --unlink-first */ - KEEP_OLD_FILES /* --keep-old-files */ + OVERWRITE_OLD_FILES, /* --overwrite */ + UNLINK_FIRST_OLD_FILES, /* --unlink-first */ + KEEP_OLD_FILES, /* --keep-old-files */ + KEEP_NEWER_FILES /* --keep-newer-files */ }; GLOBAL enum old_files old_files_option; @@ -195,15 +174,22 @@ GLOBAL const char *listed_incremental_option; /* Specified mode change string. */ GLOBAL struct mode_change *mode_option; -GLOBAL bool multi_volume_option; +/* Initial umask, if needed for mode change string. */ +GLOBAL mode_t initial_umask; -/* The same variable hold the time, whether mtime or ctime. Just fake a - non-existing option, for making the code clearer, elsewhere. */ -#define newer_ctime_option newer_mtime_option +GLOBAL bool multi_volume_option; /* Specified threshold date and time. Files having an older time stamp do not get archived (also see after_date_option above). */ -GLOBAL time_t newer_mtime_option; +GLOBAL struct timespec newer_mtime_option; + +/* Return true if newer_mtime_option is initialized. */ +#define NEWER_OPTION_INITIALIZED(opt) (0 <= (opt).tv_nsec) + +/* Return true if the struct stat ST's M time is less than + newer_mtime_option. */ +#define OLDER_STAT_TIME(st, m) \ + (timespec_cmp (get_stat_##m##time (&st), newer_mtime_option) < 0) /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */ GLOBAL int recursion_option; @@ -222,6 +208,9 @@ 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; @@ -233,9 +222,9 @@ GLOBAL int same_owner_option; /* If positive, preserve permissions when extracting. */ GLOBAL int same_permissions_option; -/* When set, strip the given number of path elements from the file name +/* When set, strip the given number of file name components from the file name before extracting */ -GLOBAL size_t strip_path_elements; +GLOBAL size_t strip_name_components; GLOBAL bool show_omitted_dirs_option; @@ -252,6 +241,12 @@ GLOBAL bool totals_option; GLOBAL bool touch_option; +GLOBAL char *to_command_option; +GLOBAL bool ignore_command_error_option; + +/* Return true if the extracted files are not being written to disk */ +#define EXTRACT_OVER_PIPE (to_stdout_option || to_command_option) + /* Count how many times the option has been set, multiple setting yields more verbose behavior. Value 0 means no verbosity, 1 means file name only, 2 means file name and all attributes. More than 2 is just like 2. */ @@ -274,12 +269,7 @@ GLOBAL int archive; GLOBAL bool dev_null_output; /* Timestamp for when we started execution. */ -#if HAVE_CLOCK_GETTIME - GLOBAL struct timespec start_timespec; -# define start_time (start_timespec.tv_sec) -#else - GLOBAL time_t start_time; -#endif +GLOBAL struct timespec start_time; GLOBAL struct tar_stat_info current_stat_info; @@ -313,6 +303,12 @@ struct name GLOBAL dev_t ar_dev; GLOBAL ino_t ar_ino; +GLOBAL bool seekable_archive; + +GLOBAL dev_t root_device; + +/* Unquote filenames */ +GLOBAL bool unquote_option; /* Declarations for each module. */ @@ -352,6 +348,8 @@ void clear_read_error_count (void); void xclose (int fd); void archive_write_error (ssize_t) __attribute__ ((noreturn)); void archive_read_error (void); +off_t seek_archive (off_t size); +void set_start_time (void); /* Module create.c. */ @@ -363,12 +361,14 @@ enum dump_status dump_status_not_implemented }; -bool file_dumpable_p (struct tar_stat_info *stat); +bool file_dumpable_p (struct tar_stat_info *); void create_archive (void); void pad_archive (off_t size_left); void dump_file (char *, int, dev_t); union block *start_header (struct tar_stat_info *st); void finish_header (struct tar_stat_info *, union block *, off_t); +void simple_finish_header (union block *header); +union block *start_private_header (const char *name, size_t size); void write_eot (void); void check_links (void); @@ -393,7 +393,7 @@ void size_to_chars (size_t, char *, size_t); void time_to_chars (time_t, char *, size_t); void uid_to_chars (uid_t, char *, size_t); void uintmax_to_chars (uintmax_t, char *, size_t); -void string_to_chars (char *, char *, size_t); +void string_to_chars (char const *, char *, size_t); /* Module diffarch.c. */ @@ -405,11 +405,9 @@ void verify_volume (void); /* Module extract.c. */ -extern bool we_are_root; void extr_init (void); void extract_archive (void); void extract_finish (void); -void fatal_exit (void) __attribute__ ((noreturn)); /* Module delete.c. */ @@ -420,7 +418,8 @@ void delete_archive_members (void); char *get_directory_contents (char *, dev_t); void read_directory_file (void); void write_directory_file (void); -void gnu_restore (char const *); +void purge_directory (char const *); +void list_dumpdir (char *buffer, size_t size); /* Module list.c. */ @@ -449,10 +448,7 @@ extern size_t recent_long_link_blocks; void decode_header (union block *, struct tar_stat_info *, enum archive_format *, int); -#define STRINGIFY_BIGINT(i, b) \ - stringify_uintmax_t_backwards ((uintmax_t) (i), (b) + UINTMAX_STRSIZE_BOUND) -char *stringify_uintmax_t_backwards (uintmax_t, char *); -char const *tartime (time_t); +char const *tartime (struct timespec, bool); #define GID_FROM_HEADER(where) gid_from_header (where, sizeof (where)) #define MAJOR_FROM_HEADER(where) major_from_header (where, sizeof (where)) @@ -479,6 +475,7 @@ void print_for_mkdir (char *, int, mode_t); void print_header (struct tar_stat_info *, off_t); void read_and (void (*) (void)); enum read_header read_header (bool); +enum read_header tar_checksum (union block *header, bool silent); void skip_file (off_t); void skip_member (void); @@ -492,16 +489,26 @@ void assign_string (char **, const char *); char *quote_copy_string (const char *); int unquote_string (char *); +void code_ns_fraction (int, char *); + size_t dot_dot_prefix_len (char const *); enum remove_option { ORDINARY_REMOVE_OPTION, RECURSIVE_REMOVE_OPTION, + + /* FIXME: The following value is never used. It seems to be intended + as a placeholder for a hypothetical option that should instruct tar + to recursively remove subdirectories in purge_directory(), + as opposed to the functionality of --recursive-unlink + (RECURSIVE_REMOVE_OPTION value), which removes them in + prepare_to_extract() phase. However, with the addition of more + meta-info to the incremental dumps, this should become unnecessary */ WANT_DIRECTORY_REMOVE_OPTION }; int remove_any_file (const char *, enum remove_option); -int maybe_backup_file (const char *, int); +bool maybe_backup_file (const char *, int); void undo_last_backup (void); int deref_stat (bool, char const *, struct stat *); @@ -509,51 +516,14 @@ int deref_stat (bool, char const *, struct stat *); int chdir_arg (char const *); void chdir_do (int); -void decode_mode (mode_t, char *); - -void chdir_fatal (char const *) __attribute__ ((noreturn)); -void chmod_error_details (char const *, mode_t); -void chown_error_details (char const *, uid_t, gid_t); -void close_error (char const *); -void close_warn (char const *); void close_diag (char const *name); -void exec_fatal (char const *) __attribute__ ((noreturn)); -void link_error (char const *, char const *); -void mkdir_error (char const *); -void mkfifo_error (char const *); -void mknod_error (char const *); -void open_error (char const *); -void open_fatal (char const *) __attribute__ ((noreturn)); -void open_warn (char const *); void open_diag (char const *name); -void read_error (char const *); -void read_error_details (char const *, off_t, size_t); -void read_fatal (char const *) __attribute__ ((noreturn)); -void read_fatal_details (char const *, off_t, size_t); -void read_warn_details (char const *, off_t, size_t); void read_diag_details (char const *name, off_t offset, size_t size); -void readlink_error (char const *); -void readlink_warn (char const *); void readlink_diag (char const *name); -void savedir_error (char const *); -void savedir_warn (char const *); void savedir_diag (char const *name); -void seek_error (char const *); -void seek_error_details (char const *, off_t); -void seek_warn (char const *); -void seek_warn_details (char const *, off_t); void seek_diag_details (char const *, off_t); -void stat_error (char const *); -void stat_warn (char const *); void stat_diag (char const *name); -void symlink_error (char const *, char const *); -void truncate_error (char const *); -void truncate_warn (char const *); -void unlink_error (char const *); -void utime_error (char const *); -void waitpid_error (char const *); -void write_error (char const *); -void write_error_details (char const *, ssize_t, size_t); +void write_error_details (char const *, size_t, size_t); void write_fatal (char const *) __attribute__ ((noreturn)); void write_fatal_details (char const *, ssize_t, size_t) __attribute__ ((noreturn)); @@ -561,21 +531,22 @@ void write_fatal_details (char const *, ssize_t, size_t) pid_t xfork (void); void xpipe (int[2]); +void *page_aligned_alloc (void **, size_t); + /* Module names.c. */ extern struct name *gnu_list_name; void gid_to_gname (gid_t, char **gname); -int gname_to_gid (char *gname, gid_t *); +int gname_to_gid (char const *, gid_t *); void uid_to_uname (uid_t, char **uname); -int uname_to_uid (char *uname, uid_t *); +int uname_to_uid (char const *, uid_t *); void init_names (void); void name_add (const char *); -void name_init (int, char *const *); +void name_init (void); void name_term (void); char *name_next (int); -void name_close (void); void name_gather (void); struct name *addname (char const *, int); int name_match (const char *); @@ -585,7 +556,6 @@ struct name *name_scan (const char *); char *name_from_list (void); void blank_name_list (void); char *new_name (const char *, const char *); -char *safer_name_suffix (char const *, bool); size_t stripped_prefix_len (char const *file_name, size_t num); bool all_names_found (struct tar_stat_info *); @@ -593,6 +563,7 @@ bool excluded_name (char const *); void add_avoided_name (char const *); bool is_avoided_name (char const *); +bool is_individual_file (char const *); bool contains_dot_dot (char const *); @@ -603,11 +574,14 @@ bool contains_dot_dot (char const *); /* Module tar.c. */ +void usage (int); + int confirm (const char *, const char *); void request_stdin (const char *); void tar_stat_init (struct tar_stat_info *st); void tar_stat_destroy (struct tar_stat_info *st); +void usage (int) __attribute__ ((noreturn)); /* Module update.c. */ @@ -618,10 +592,18 @@ void update_archive (void); /* Module xheader.c. */ void xheader_decode (struct tar_stat_info *); +void xheader_decode_global (void); void xheader_store (char const *, struct tar_stat_info const *, void *); void xheader_read (union block *, size_t); +void xheader_write (char type, char *name, struct xheader *xhdr); +void xheader_write_global (void); void xheader_finish (struct xheader *); void xheader_destroy (struct xheader *); +char *xheader_xhdr_name (struct tar_stat_info *st); +char *xheader_ghdr_name (void); +void xheader_write (char, char *, struct xheader *); +void xheader_write_global (void); +void xheader_set_option (char *string); /* Module system.c */ @@ -635,17 +617,25 @@ bool sys_compare_gid (struct stat *a, struct stat *b); bool sys_file_is_archive (struct tar_stat_info *p); bool sys_compare_links (struct stat *link_data, struct stat *stat_data); int sys_truncate (int fd); -void sys_reset_uid_gid (void); pid_t sys_child_open_for_compress (void); pid_t sys_child_open_for_uncompress (void); -ssize_t sys_write_archive_buffer (void); +size_t sys_write_archive_buffer (void); bool sys_get_archive_stat (void); +int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st); +void sys_wait_command (void); /* Module compare.c */ void report_difference (struct tar_stat_info *st, const char *message, ...); /* Module sparse.c */ -bool sparse_file_p (struct tar_stat_info *stat); -enum dump_status sparse_dump_file (int fd, struct tar_stat_info *stat); -enum dump_status sparse_extract_file (int fd, struct tar_stat_info *stat, off_t *size); -bool sparse_diff_file (int fd, struct tar_stat_info *stat); +bool sparse_file_p (struct tar_stat_info *); +bool sparse_member_p (struct tar_stat_info *); +bool sparse_fixup_header (struct tar_stat_info *); +enum dump_status sparse_dump_file (int, struct tar_stat_info *); +enum dump_status sparse_extract_file (int, struct tar_stat_info *, off_t *); +enum dump_status sparse_skip_file (struct tar_stat_info *); +bool sparse_diff_file (int, struct tar_stat_info *); + +/* Module utf8.c */ +bool string_ascii_p (const char *str); +bool utf8_convert (bool to_utf, char const *input, char **output);