]> Dogcows Code - chaz/tar/blobdiff - src/common.h
* NEWS: New option --atime-preserve=system, which uses O_NOATIME.
[chaz/tar] / src / common.h
index 39ae6edfaffc5b5c203b831d1abd07a712be1436..77c353bc46a25a5124bf18bb99e2d0577afa7af3 100644 (file)
@@ -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 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"
 /* 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
 #define UNAME_FIELD_SIZE   32
 #define GNAME_FIELD_SIZE   32
 
-/* FIXME */
-#define MAXOCTAL11      017777777777L
-#define MAXOCTAL7       07777777
-
 
 \f
 /* Some various global definitions.  */
 # 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
+
 \f
 #include "arith.h"
 #include <backupfile.h>
@@ -83,11 +55,14 @@ GLOBAL int exit_status;
 #include <modechange.h>
 #include <quote.h>
 #include <safe-read.h>
+#include <stat-time.h>
 #include <timespec.h>
 #define obstack_chunk_alloc xmalloc
 #define obstack_chunk_free free
 #include <obstack.h>
 
+#include <paxlib.h>
+
 /* Log base 2 of common values.  */
 #define LG_8 3
 #define LG_64 6
@@ -139,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;
 
@@ -199,11 +180,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).  */
@@ -215,9 +195,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;
@@ -272,6 +254,9 @@ 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.  */
@@ -294,12 +279,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;
 
@@ -339,6 +319,13 @@ GLOBAL dev_t root_device;
 
 /* Unquote filenames */
 GLOBAL bool unquote_option;
+
+GLOBAL bool test_label_option; /* Test archive volume label and exit */
+
+GLOBAL bool show_stored_names_option; /* When creating archive in verbose mode,
+                                        list member names as stored in the
+                                        archive */
+
 \f
 /* Declarations for each module.  */
 
@@ -356,10 +343,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);
@@ -381,6 +369,12 @@ 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.  */
 
 enum dump_status
@@ -398,6 +392,8 @@ 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 * 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);
@@ -423,7 +419,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.  */
 
@@ -435,11 +431,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.  */
 
@@ -451,6 +445,11 @@ char *get_directory_contents (char *, dev_t);
 void read_directory_file (void);
 void write_directory_file (void);
 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);
+void get_gnu_dumpdir (void);
 
 /* Module list.c.  */
 
@@ -479,10 +478,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))
@@ -523,6 +519,12 @@ 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
@@ -537,7 +539,7 @@ enum remove_option
      (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  
+  WANT_DIRECTORY_REMOVE_OPTION
 };
 int remove_any_file (const char *, enum remove_option);
 bool maybe_backup_file (const char *, int);
@@ -548,51 +550,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_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 *);
-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)
@@ -626,7 +590,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 *);
 
@@ -638,8 +601,6 @@ 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 : \
@@ -655,6 +616,7 @@ 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);
 
 /* Module update.c.  */
 
@@ -666,7 +628,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);
@@ -677,10 +639,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);
This page took 0.032294 seconds and 4 git commands to generate.