X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fcommon.h;h=ce11d659b1d5248e7d6ff3453af6c9c1b7e7d7e9;hb=46f09016e8219719179da09ee499981911054b5a;hp=9eb90541fb4ab7a3cdce94ac7647ccedaf14dc14;hpb=9373182407473232cc5fa441637c50c64721eab0;p=chaz%2Ftar diff --git a/src/common.h b/src/common.h index 9eb9054..ce11d65 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" @@ -23,6 +23,9 @@ /* The checksum field is filled with this while the checksum is computed. */ #define CHKBLANKS " " /* 8 blanks, no null */ +/* Old GNU stores zero-terminated file name */ +#define OLDGNU_NAME_FIELD_SIZE 99 + /* Some constants from POSIX are given names. */ #define NAME_FIELD_SIZE 100 #define PREFIX_FIELD_SIZE 155 @@ -38,11 +41,6 @@ /* 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. @@ -85,6 +83,10 @@ GLOBAL int exit_status; #include #include #include +#include +#define obstack_chunk_alloc xmalloc +#define obstack_chunk_free free +#include /* Log base 2 of common values. */ #define LG_8 3 @@ -128,6 +130,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 +161,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. */ @@ -176,13 +179,17 @@ GLOBAL const char *info_script_option; GLOBAL bool interactive_option; +/* If nonzero, extract only Nth occurrence of each named file */ +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; @@ -192,15 +199,28 @@ GLOBAL const char *listed_incremental_option; /* Specified mode change string. */ GLOBAL struct mode_change *mode_option; +/* Initial umask, if needed for mode change string. */ +GLOBAL mode_t initial_umask; + GLOBAL bool multi_volume_option; -/* The same variable hold the time, whether mtime or ctime. Just fake a +/* The same variable holds 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 /* 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) \ + ((st).st_##m##time < newer_mtime_option.tv_sec \ + || ((st).st_##m##time == newer_mtime_option.tv_sec \ + && TIMESPEC_NS ((st).st_##m##tim) < newer_mtime_option.tv_nsec)) /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */ GLOBAL int recursion_option; @@ -219,6 +239,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; @@ -230,9 +253,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; @@ -249,6 +272,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. */ @@ -295,7 +324,9 @@ struct name { struct name *next; size_t length; /* cached strlen(name) */ - char found; /* a matching file has been found */ + uintmax_t found_count; /* number of times a matching file has + been found */ + int isdir; char firstch; /* first char is literally matched */ char regexp; /* this name is a regexp, not literal */ int change_dir; /* set with the -C option */ @@ -304,16 +335,16 @@ struct name char name[1]; }; -/* Information about a sparse file. */ -struct sp_array - { - off_t offset; - size_t numbytes; - }; -GLOBAL struct sp_array *sparsearray; +/* Obnoxious test to see if dimwit is trying to dump the archive. */ +GLOBAL dev_t ar_dev; +GLOBAL ino_t ar_ino; + +GLOBAL bool seekable_archive; + +GLOBAL dev_t root_device; -/* Number of elements in sparsearray. */ -GLOBAL int sp_array_size; +/* Unquote filenames */ +GLOBAL bool unquote_option; /* Declarations for each module. */ @@ -349,13 +380,31 @@ void open_archive (enum access_mode); void print_total_written (void); void reset_eof (void); void set_next_block_after (union block *); +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. */ +enum dump_status + { + dump_status_ok, + dump_status_short, + dump_status_fail, + dump_status_not_implemented + }; + +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); -void finish_header (union block *, off_t); -void init_sparsearray (void); +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); @@ -392,9 +441,7 @@ void verify_volume (void); /* Module extract.c. */ -extern bool we_are_root; void extr_init (void); -bool fill_in_sparse_array (void); void extract_archive (void); void extract_finish (void); void fatal_exit (void) __attribute__ ((noreturn)); @@ -408,7 +455,7 @@ 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 *); /* Module list.c. */ @@ -464,9 +511,10 @@ uintmax_t uintmax_from_header (const char *, size_t); void list_archive (void); void print_for_mkdir (char *, int, mode_t); -void print_header (off_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); @@ -486,10 +534,18 @@ 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 *); @@ -504,6 +560,7 @@ 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 *); @@ -512,21 +569,28 @@ 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_fatal_details (char const *, off_t, size_t) __attribute__ ((noreturn)); 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_fatal (char const *); 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 *); @@ -534,7 +598,7 @@ 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)); @@ -542,25 +606,25 @@ 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 *); -bool names_done (void); void names_notfound (void); void collect_and_sort_names (void); struct name *name_scan (const char *); @@ -568,21 +632,34 @@ 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_path_len (char const *file_name, size_t num); +size_t stripped_prefix_len (char const *file_name, size_t num); +bool all_names_found (struct tar_stat_info *); 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 *); +bool removed_prefixes_p (void); + +#define ISFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \ + (c)->found_count == occurrence_option) +#define WASFOUND(c) ((occurrence_option == 0) ? (c)->found_count : \ + (c)->found_count >= occurrence_option) + /* Module tar.c. */ +void usage (int); + int confirm (const char *, const char *); void request_stdin (const char *); -void destroy_stat (struct tar_stat_info *); -bool all_names_found (void); + +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. */ @@ -593,7 +670,51 @@ void update_archive (void); /* Module xheader.c. */ void xheader_decode (struct tar_stat_info *); -void xheader_store (char const *, struct tar_stat_info const *); +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 */ + +void sys_stat_nanoseconds (struct tar_stat_info *); +void sys_detect_dev_null_output (void); +void sys_save_archive_dev_ino (void); +void sys_drain_input_pipe (void); +void sys_wait_for_child (pid_t); +void sys_spawn_shell (void); +bool sys_compare_uid (struct stat *a, struct stat *b); +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); +pid_t sys_child_open_for_compress (void); +pid_t sys_child_open_for_uncompress (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 *); +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);