Improve listed incremental dumps.

[chaz/tar] / src / common.h

diff --git a/src/common.h b/src/common.h
index 4f1ac6ac0b4055ab715a44bfc9eb246dfa822822..d734b640e2e66f1968504be11351bbb61b8a3c52 100644 (file)
--- a/src/common.h
+++ b/src/common.h
@@ -1,11 +1,11 @@
 /* Common declarations for the tar program.
 
    Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,
 /* Common declarations for the tar program.
 
    Copyright (C) 1988, 1992, 1993, 1994, 1996, 1997, 1999, 2000, 2001,

-   2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+   2003, 2004, 2005, 2006, 2007, 2008, 2009 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
 
    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 2, or (at your option) any later
+   Free Software Foundation; either version 3, or (at your option) any later

    version.
 
    This program is distributed in the hope that it will be useful, but
    version.
 
    This program is distributed in the hope that it will be useful, but


@@ -93,9 +93,6 @@ GLOBAL enum subcommand subcommand_option;
 /* Selected format for output archive.  */
 GLOBAL enum archive_format archive_format;
 
 /* Selected format for output archive.  */
 GLOBAL enum archive_format archive_format;
 

-/* Either NL or NUL, as decided by the --null option.  */
-GLOBAL char filename_terminator;
-

 /* Size of each record, once in blocks, once in bytes.  Those two variables
    are always related, the second being BLOCKSIZE times the first.  They do
    not have _option in their name, even if their values is derived from
 /* Size of each record, once in blocks, once in bytes.  Those two variables
    are always related, the second being BLOCKSIZE times the first.  They do
    not have _option in their name, even if their values is derived from


@@ -130,19 +127,13 @@ GLOBAL enum backup_type backup_type;
 GLOBAL bool block_number_option;
 
 GLOBAL unsigned checkpoint_option;
 GLOBAL bool block_number_option;
 
 GLOBAL unsigned checkpoint_option;

-
-enum checkpoint_style
-  {
-    checkpoint_text,
-    checkpoint_dot
-  };
-
-GLOBAL enum checkpoint_style checkpoint_style;
+#define DEFAULT_CHECKPOINT 10

 
 /* Specified name of compression program, or "gzip" as implied by -z.  */
 GLOBAL const char *use_compress_program_option;
 
 GLOBAL bool dereference_option;
 
 /* Specified name of compression program, or "gzip" as implied by -z.  */
 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;
 
 /* Print a message if not all links are dumped */
 GLOBAL int check_links_option;


@@ -150,8 +141,18 @@ GLOBAL int check_links_option;
 /* Patterns that match file names to be excluded.  */
 GLOBAL struct exclude *excluded;
 
 /* Patterns that match file names to be excluded.  */
 GLOBAL struct exclude *excluded;
 

-/* Exclude directories containing a cache directory tag. */
-GLOBAL bool exclude_caches_option;
+enum exclusion_tag_type
+  {
+    exclusion_tag_none,
+     /* Exclude the directory contents, but preserve the directory
+       itself and the exclusion tag file */
+    exclusion_tag_contents,
+    /* Exclude everything below the directory, preserving the directory
+       itself */
+    exclusion_tag_under,
+    /* Exclude entire directory  */
+    exclusion_tag_all,
+  };

 
 /* Specified value to be put into tar file in place of stat () results, or
    just -1 if such an override should not take place.  */
 
 /* Specified value to be put into tar file in place of stat () results, or
    just -1 if such an override should not take place.  */


@@ -184,6 +185,10 @@ GLOBAL enum old_files old_files_option;
 
 /* Specified file name for incremental list.  */
 GLOBAL const char *listed_incremental_option;
 
 /* Specified file name for incremental list.  */
 GLOBAL const char *listed_incremental_option;

+/* Incremental dump level */
+GLOBAL int incremental_level;
+/* Check device numbers when doing incremental dumps. */
+GLOBAL bool check_device_option;

 
 /* Specified mode change string.  */
 GLOBAL struct mode_change *mode_option;
 
 /* Specified mode change string.  */
 GLOBAL struct mode_change *mode_option;


@@ -254,7 +259,7 @@ GLOBAL bool show_omitted_dirs_option;
 GLOBAL bool sparse_option;
 GLOBAL unsigned tar_sparse_major;
 GLOBAL unsigned tar_sparse_minor;
 GLOBAL bool sparse_option;
 GLOBAL unsigned tar_sparse_major;
 GLOBAL unsigned tar_sparse_minor;

-  
+

 GLOBAL bool starting_file_option;
 
 /* Specified maximum byte length of each tape volume (multiple of 1024).  */
 GLOBAL bool starting_file_option;
 
 /* Specified maximum byte length of each tape volume (multiple of 1024).  */


@@ -296,7 +301,7 @@ GLOBAL int archive;
 /* Nonzero when outputting to /dev/null.  */
 GLOBAL bool dev_null_output;
 
 /* Nonzero when outputting to /dev/null.  */
 GLOBAL bool dev_null_output;
 

-/* Timestamps: */ 
+/* Timestamps: */

 GLOBAL struct timespec start_time;        /* when we started execution */
 GLOBAL struct timespec volume_start_time; /* when the current volume was
                                             opened*/
 GLOBAL struct timespec start_time;        /* when we started execution */
 GLOBAL struct timespec volume_start_time; /* when the current volume was
                                             opened*/


@@ -319,15 +324,22 @@ GLOBAL char const *index_file_name;
 struct name
   {
     struct name *next;          /* Link to the next element */
 struct name
   {
     struct name *next;          /* Link to the next element */

+    struct name *prev;          /* Link to the previous 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 matching_flags;                /* this name is a regexp, not literal */
     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 matching_flags;                /* this name is a regexp, not literal */

-    char const *dir_contents;  /* for incremental_option */
-
+    

     size_t length;             /* cached strlen(name) */
     size_t length;             /* cached strlen(name) */

-    char name[1];
+    char *name;
+
+    /* The following members are used for incremental dumps only */
+    char const *dir_contents;  /* directory contents  */
+    struct name *parent;        /* pointer to the parent hierarchy */
+    struct name *child;         /* pointer to the first child */
+    struct name *sibling;       /* pointer to the next sibling */
+    char *caname;               /* canonical name */ 

   };
 
 /* Obnoxious test to see if dimwit is trying to dump the archive.  */
   };
 
 /* Obnoxious test to see if dimwit is trying to dump the archive.  */


@@ -406,6 +418,7 @@ void mv_end (void);
 void mv_total_size (off_t size);
 void mv_size_left (off_t size);
 
 void mv_total_size (off_t size);
 void mv_size_left (off_t size);
 

+void buffer_write_global_xheader (void);

 
 /* Module create.c.  */
 
 
 /* Module create.c.  */
 


@@ -417,6 +430,10 @@ enum dump_status
     dump_status_not_implemented
   };
 
     dump_status_not_implemented
   };
 

+void add_exclusion_tag (const char *name, enum exclusion_tag_type type,
+                       bool (*)(const char*));
+bool cachedir_file_p (const char *name);
+

 bool file_dumpable_p (struct tar_stat_info *st);
 void create_archive (void);
 void pad_archive (off_t size_left);
 bool file_dumpable_p (struct tar_stat_info *st);
 void create_archive (void);
 void pad_archive (off_t size_left);


@@ -430,7 +447,11 @@ union block * write_extended (bool global, struct tar_stat_info *st,
 union block *start_private_header (const char *name, size_t size);
 void write_eot (void);
 void check_links (void);
 union block *start_private_header (const char *name, size_t size);
 void write_eot (void);
 void check_links (void);

-
+void exclusion_tag_warning (const char *dirname, const char *tagname,
+                           const char *message);
+enum exclusion_tag_type check_exclusion_tags (const char *dirname,
+                                             const char **tag_file_name);
+     

 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))
 #define GID_TO_CHARS(val, where) gid_to_chars (val, where, sizeof (where))
 #define MAJOR_TO_CHARS(val, where) major_to_chars (val, where, sizeof (where))
 #define MINOR_TO_CHARS(val, where) minor_to_chars (val, where, sizeof (where))


@@ -474,8 +495,18 @@ bool rename_directory (char *src, char *dst);
 void delete_archive_members (void);
 
 /* Module incremen.c.  */
 void delete_archive_members (void);
 
 /* Module incremen.c.  */

+typedef struct dumpdir *dumpdir_t;
+typedef struct dumpdir_iter *dumpdir_iter_t;

 
 

-char *get_directory_contents (char *dir_name, dev_t device);
+dumpdir_t dumpdir_create0 (const char *contents, const char *cmask);
+dumpdir_t dumpdir_create (const char *contents);
+void dumpdir_free (dumpdir_t);
+char *dumpdir_locate (dumpdir_t dump, const char *name);
+char *dumpdir_next (dumpdir_iter_t itr);
+char *dumpdir_first (dumpdir_t dump, int all, dumpdir_iter_t *pitr);
+
+
+const char *scan_directory (char *dir_name, dev_t device, bool cmdline);

 const char *append_incremental_renames (const char *dump);
 void read_directory_file (void);
 void write_directory_file (void);
 const char *append_incremental_renames (const char *dump);
 void read_directory_file (void);
 void write_directory_file (void);


@@ -498,14 +529,6 @@ enum read_header
   HEADER_FAILURE               /* ill-formed header, or bad checksum */
 };
 
   HEADER_FAILURE               /* ill-formed header, or bad checksum */
 };
 

-struct xheader
-{
-  struct obstack *stk;
-  size_t size;
-  char *buffer;
-};
-
-GLOBAL struct xheader extended_header;

 extern union block *current_header;
 extern enum archive_format current_format;
 extern size_t recent_long_name_blocks;
 extern union block *current_header;
 extern enum archive_format current_format;
 extern size_t recent_long_name_blocks;


@@ -546,15 +569,13 @@ enum read_header tar_checksum (union block *header, bool silent);
 void skip_file (off_t size);
 void skip_member (void);
 
 void skip_file (off_t size);
 void skip_member (void);
 

-/* Module mangle.c.  */
-
-void extract_mangle (void);
-

 /* Module misc.c.  */
 
 void assign_string (char **dest, const char *src);
 char *quote_copy_string (const char *str);
 int unquote_string (char *str);
 /* Module misc.c.  */
 
 void assign_string (char **dest, const char *src);
 char *quote_copy_string (const char *str);
 int unquote_string (char *str);

+char *zap_slashes (char *name);
+char *normalize_filename (const char *name);

 
 void code_ns_fraction (int ns, char *p);
 char const *code_timespec (struct timespec ts, char *sbuf);
 
 void code_ns_fraction (int ns, char *p);
 char const *code_timespec (struct timespec ts, char *sbuf);


@@ -584,6 +605,7 @@ int deref_stat (bool deref, char const *name, struct stat *buf);
 
 int chdir_arg (char const *dir);
 void chdir_do (int dir);
 
 int chdir_arg (char const *dir);
 void chdir_do (int dir);

+int chdir_count (void);

 
 void close_diag (char const *name);
 void open_diag (char const *name);
 
 void close_diag (char const *name);
 void open_diag (char const *name);


@@ -619,7 +641,7 @@ void name_add_dir (const char *name);
 void name_term (void);
 const char *name_next (int change_dirs);
 void name_gather (void);
 void name_term (void);
 const char *name_next (int change_dirs);
 void name_gather (void);

-struct name *addname (char const *string, int change_dir);
+struct name *addname (char const *string, int change_dir, struct name *parent);

 bool name_match (const char *name);
 void names_notfound (void);
 void collect_and_sort_names (void);
 bool name_match (const char *name);
 void names_notfound (void);
 void collect_and_sort_names (void);


@@ -665,23 +687,22 @@ void update_archive (void);
 
 /* Module xheader.c.  */
 
 
 /* Module xheader.c.  */
 

+void xheader_init (struct xheader *xhdr);

 void xheader_decode (struct tar_stat_info *stat);
 void xheader_decode (struct tar_stat_info *stat);

-void xheader_decode_global (void);
-void xheader_store (char const *keyword, struct tar_stat_info const *st,
+void xheader_decode_global (struct xheader *xhdr);
+void xheader_store (char const *keyword, struct tar_stat_info *st,

                    void const *data);
                    void const *data);

-void xheader_read (union block *header, size_t size);
+void xheader_read (struct xheader *xhdr, union block *header, size_t size);

 void xheader_write (char type, char *name, struct xheader *xhdr);
 void xheader_write (char type, char *name, struct xheader *xhdr);

-void xheader_write_global (void);
+void xheader_write_global (struct xheader *xhdr);

 void xheader_finish (struct xheader *hdr);
 void xheader_destroy (struct xheader *hdr);
 char *xheader_xhdr_name (struct tar_stat_info *st);
 char *xheader_ghdr_name (void);
 void xheader_finish (struct xheader *hdr);
 void xheader_destroy (struct xheader *hdr);
 char *xheader_xhdr_name (struct tar_stat_info *st);
 char *xheader_ghdr_name (void);

-void xheader_write (char type, char *name, struct xheader *xhdr);
-void xheader_write_global (void);

 void xheader_set_option (char *string);
 void xheader_set_option (char *string);

-void xheader_string_begin (void);
-void xheader_string_add (char const *s);
-bool xheader_string_end (char const *keyword);
+void xheader_string_begin (struct xheader *xhdr);
+void xheader_string_add (struct xheader *xhdr, char const *s);
+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);
 bool xheader_keyword_deleted_p (const char *kw);
 char *xheader_format_name (struct tar_stat_info *st, const char *fmt,
                           size_t n);


@@ -690,8 +711,7 @@ char *xheader_format_name (struct tar_stat_info *st, const char *fmt,
 
 void sys_detect_dev_null_output (void);
 void sys_save_archive_dev_ino (void);
 
 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_wait_for_child (pid_t, bool);

 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);
 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);


@@ -705,12 +725,14 @@ 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);
 int sys_exec_info_script (const char **archive_name, int volume_number);
 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);

+void sys_exec_checkpoint_script (const char *script_name,
+                                const char *archive_name,
+                                int checkpoint_number);

 
 /* Module compare.c */
 void report_difference (struct tar_stat_info *st, const char *message, ...);
 
 /* Module sparse.c */
 
 /* 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 *st);

 bool sparse_member_p (struct tar_stat_info *st);
 bool sparse_fixup_header (struct tar_stat_info *st);
 enum dump_status sparse_dump_file (int, struct tar_stat_info *st);
 bool sparse_member_p (struct tar_stat_info *st);
 bool sparse_fixup_header (struct tar_stat_info *st);
 enum dump_status sparse_dump_file (int, struct tar_stat_info *st);


@@ -724,8 +746,59 @@ bool string_ascii_p (const char *str);
 bool utf8_convert (bool to_utf, char const *input, char **output);
 
 /* Module transform.c */
 bool utf8_convert (bool to_utf, char const *input, char **output);
 
 /* Module transform.c */

+#define XFORM_REGFILE  0x01
+#define XFORM_LINK     0x02
+#define XFORM_SYMLINK  0x04
+#define XFORM_ALL      (XFORM_REGFILE|XFORM_LINK|XFORM_SYMLINK)
+

 void set_transform_expr (const char *expr);
 void set_transform_expr (const char *expr);

-bool transform_name (char **pinput);
-bool transform_name_fp (char **pinput, char *(*fun)(char *));
-     
-     
+bool transform_name (char **pinput, int type);
+bool transform_member_name (char **pinput, int type);
+bool transform_name_fp (char **pinput, int type,
+                       char *(*fun)(char *, void *), void *);
+
+/* Module suffix.c */
+void set_comression_program_by_suffix (const char *name, const char *defprog);
+
+/* Module checkpoint.c */
+void checkpoint_compile_action (const char *str);
+void checkpoint_finish_compile (void);
+void checkpoint_run (bool do_write);
+
+/* Module warning.c */
+#define WARN_ALONE_ZERO_BLOCK    0x00000001
+#define WARN_BAD_DUMPDIR         0x00000002
+#define WARN_CACHEDIR            0x00000004
+#define WARN_CONTIGUOUS_CAST     0x00000008
+#define WARN_FILE_CHANGED        0x00000010
+#define WARN_FILE_IGNORED        0x00000020
+#define WARN_FILE_REMOVED        0x00000040
+#define WARN_FILE_SHRANK         0x00000080
+#define WARN_FILE_UNCHANGED      0x00000100
+#define WARN_FILENAME_WITH_NULS  0x00000200
+#define WARN_IGNORE_ARCHIVE      0x00000400
+#define WARN_IGNORE_NEWER        0x00000800
+#define WARN_NEW_DIRECTORY       0x00001000
+#define WARN_RENAME_DIRECTORY    0x00002000
+#define WARN_SYMLINK_CAST        0x00004000
+#define WARN_TIMESTAMP           0x00008000
+#define WARN_UNKNOWN_CAST        0x00010000
+#define WARN_UNKNOWN_KEYWORD     0x00020000
+#define WARN_XDEV                0x00040000
+
+/* 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)
+
+void set_warning_option (const char *arg);
+
+extern int warning_option;
+
+#define WARNOPT(opt,args)                      \
+  do                                           \
+    {                                          \
+      if (warning_option & opt) WARN (args);   \
+    }                                          \
+  while (0)
+