X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=src%2Fcommon.h;h=99c6f6fc2f1a7174da8db7ab89975b320fa92d15;hb=46defea70e9e64010fb7c7e7fca55625779583f9;hp=abcdbbca94541f3eeef89a56a129c0e164108b29;hpb=a65779d55837d7164425f4fd3b9cefe88d250706;p=chaz%2Ftar diff --git a/src/common.h b/src/common.h index abcdbbc..99c6f6f 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, 2004 Free Software Foundation, Inc. + 2003, 2004, 2005, 2006 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,7 +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 @@ -138,7 +114,13 @@ GLOBAL bool utc_option; than newer_mtime_option. */ GLOBAL int after_date_option; -GLOBAL bool atime_preserve_option; +enum atime_preserve +{ + no_atime_preserve, + replace_atime_preserve, + system_atime_preserve +}; +GLOBAL enum atime_preserve atime_preserve_option; GLOBAL bool backup_option; @@ -147,7 +129,15 @@ GLOBAL enum backup_type backup_type; GLOBAL bool block_number_option; -GLOBAL bool checkpoint_option; +GLOBAL unsigned checkpoint_option; + +enum checkpoint_style + { + checkpoint_text, + checkpoint_dot + }; + +GLOBAL enum checkpoint_style checkpoint_style; /* Specified name of compression program, or "gzip" as implied by -z. */ GLOBAL const char *use_compress_program_option; @@ -160,10 +150,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. */ @@ -200,11 +188,10 @@ 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 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 +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). */ @@ -216,9 +203,11 @@ GLOBAL struct timespec newer_mtime_option; /* 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)) + (timespec_cmp (get_stat_##m##time (&(st)), newer_mtime_option) < 0) + +/* Likewise, for struct tar_stat_info ST. */ +#define OLDER_TAR_STAT_TIME(st, m) \ + (timespec_cmp ((st).m##time, newer_mtime_option) < 0) /* Zero if there is no recursion, otherwise FNM_LEADING_DIR. */ GLOBAL int recursion_option; @@ -270,6 +259,15 @@ GLOBAL bool totals_option; GLOBAL bool touch_option; +GLOBAL char *to_command_option; +GLOBAL bool ignore_command_error_option; + +/* Restrict some potentially harmful tar options */ +GLOBAL bool restrict_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. */ @@ -292,20 +290,15 @@ 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; /* List of tape drive names, number of such tape drives, allocated number, and current cursor in list. */ GLOBAL const char **archive_name_array; -GLOBAL int archive_names; -GLOBAL int allocated_archive_names; +GLOBAL size_t archive_names; +GLOBAL size_t allocated_archive_names; GLOBAL const char **archive_name_cursor; /* Output index file name. */ @@ -314,16 +307,17 @@ GLOBAL char const *index_file_name; /* Structure for keeping track of filenames and lists thereof. */ struct name { - struct name *next; - size_t length; /* cached strlen(name) */ + struct name *next; /* Link to the next element */ + int change_dir; /* Number of the directory to change to. + Set with the -C option. */ 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 */ + int explicit; /* this name was explicitely given in the + command line */ + int matching_flags; /* this name is a regexp, not literal */ char const *dir_contents; /* for incremental_option */ - char fake; /* dummy entry */ + + size_t length; /* cached strlen(name) */ char name[1]; }; @@ -331,6 +325,29 @@ 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; + +GLOBAL bool test_label_option; /* Test archive volume label and exit */ + +/* Show file or archive names after transformation. + In particular, when creating archive in verbose mode, list member names + as stored in the archive */ +GLOBAL bool show_transformed_names_option; + +/* Delay setting modification times and permissions of extracted directories + until the end of extraction. This variable helps correctly restore directory + timestamps from archives with an unusual member order. It is automatically + set for incremental archives. */ +GLOBAL bool delay_directory_restore_option; + +/* Warn about implicit use of the wildcards in command line arguments. + (Default for tar prior to 1.15.91, but changed afterwards */ +GLOBAL bool warn_regex_usage; /* Declarations for each module. */ @@ -348,10 +365,11 @@ extern enum access_mode access_mode; /* Module buffer.c. */ extern FILE *stdlis; -extern char *save_name; -extern off_t save_sizeleft; -extern off_t save_totsize; extern bool write_archive_to_stdout; +extern char *volume_label; +extern char *continued_file_name; +extern uintmax_t continued_file_size; +extern uintmax_t continued_file_offset; size_t available_space_after (union block *); off_t current_block_ordinal (void); @@ -370,6 +388,14 @@ 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); + +void mv_begin (struct tar_stat_info *st); +void mv_end (void); +void mv_total_size (off_t size); +void mv_size_left (off_t size); + /* Module create.c. */ @@ -384,10 +410,12 @@ enum dump_status 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 dump_file (const 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 * write_extended (bool global, struct tar_stat_info *st, + union block *old_header); union block *start_private_header (const char *name, size_t size); void write_eot (void); void check_links (void); @@ -404,16 +432,16 @@ void check_links (void); #define UNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf)) #define GNAME_TO_CHARS(name,buf) string_to_chars (name, buf, sizeof(buf)) -void gid_to_chars (gid_t, char *, size_t); -void major_to_chars (major_t, char *, size_t); -void minor_to_chars (minor_t, char *, size_t); -void mode_to_chars (mode_t, char *, size_t); -void off_to_chars (off_t, char *, size_t); -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); +bool gid_to_chars (gid_t, char *, size_t); +bool major_to_chars (major_t, char *, size_t); +bool minor_to_chars (minor_t, char *, size_t); +bool mode_to_chars (mode_t, char *, size_t); +bool off_to_chars (off_t, char *, size_t); +bool size_to_chars (size_t, char *, size_t); +bool time_to_chars (time_t, char *, size_t); +bool uid_to_chars (uid_t, char *, size_t); +bool uintmax_to_chars (uintmax_t, char *, size_t); +void string_to_chars (char const *, char *, size_t); /* Module diffarch.c. */ @@ -425,11 +453,10 @@ 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)); +bool rename_directory (char *src, char *dst); /* Module delete.c. */ @@ -438,9 +465,15 @@ void delete_archive_members (void); /* Module incremen.c. */ char *get_directory_contents (char *, dev_t); +const char *append_incremental_renames (const char *dump); 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); +void update_parent_directory (const char *name); + +size_t dumpdir_size (const char *p); +bool is_dumpdir (struct tar_stat_info *stat_info); /* Module list.c. */ @@ -469,10 +502,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)) @@ -498,7 +528,10 @@ void list_archive (void); 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_primitive (bool raw_extended_headers, + struct tar_stat_info *info); 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); @@ -512,12 +545,26 @@ void assign_string (char **, const char *); char *quote_copy_string (const char *); int unquote_string (char *); +void code_ns_fraction (int, char *); +char const *code_timespec (struct timespec, char *); +enum { BILLION = 1000000000, LOG10_BILLION = 9 }; +enum { TIMESPEC_STRSIZE_BOUND = + UINTMAX_STRSIZE_BOUND + LOG10_BILLION + sizeof "-." - 1 }; + 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); @@ -529,50 +576,13 @@ 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) __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_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 *, size_t, size_t); void write_fatal (char const *) __attribute__ ((noreturn)); void write_fatal_details (char const *, ssize_t, size_t) @@ -581,6 +591,10 @@ 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); +int set_file_atime (int fd, char const *file, + struct timespec const timespec[2]); + /* Module names.c. */ extern struct name *gnu_list_name; @@ -591,21 +605,19 @@ void uid_to_uname (uid_t, char **uname); int uname_to_uid (char const *, uid_t *); void init_names (void); -void name_add (const char *); -void name_init (void); +void name_add_name (const char *, int); +void name_add_dir (const char *name); void name_term (void); -char *name_next (int); -void name_close (void); +const char *name_next (int); void name_gather (void); struct name *addname (char const *, int); int name_match (const char *); void names_notfound (void); void collect_and_sort_names (void); -struct name *name_scan (const char *); +struct name *name_scan (const char *, bool); 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 *); @@ -613,6 +625,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 *); @@ -631,6 +644,9 @@ 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)); +int tar_timespec_cmp (struct timespec a, struct timespec b); +const char *archive_format_string (enum archive_format fmt); +const char *subcommand_string (enum subcommand c); /* Module update.c. */ @@ -642,7 +658,7 @@ void update_archive (void); 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_store (char const *, struct tar_stat_info const *, void const *); void xheader_read (union block *, size_t); void xheader_write (char type, char *name, struct xheader *xhdr); void xheader_write_global (void); @@ -653,10 +669,15 @@ char *xheader_ghdr_name (void); void xheader_write (char, char *, struct xheader *); void xheader_write_global (void); void xheader_set_option (char *string); +void xheader_string_begin (void); +void xheader_string_add (char const *s); +void xheader_string_end (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); /* 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); @@ -667,13 +688,13 @@ 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); -void sys_reset_uid_gid (void); size_t sys_write_archive_buffer (void); bool sys_get_archive_stat (void); -void sys_reset_uid_gid (void); +int sys_exec_command (char *file_name, int typechar, struct tar_stat_info *st); +void sys_wait_command (void); +int sys_exec_info_script (const char **archive_name, int volume_number); /* Module compare.c */ void report_difference (struct tar_stat_info *st, const char *message, ...); @@ -690,3 +711,10 @@ 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); + +/* Module transform.c */ +void set_transform_expr (const char *expr); +bool transform_name (char **pinput); +bool transform_name_fp (char **pinput, char *(*fun)(char *)); + +