1 /* GNU dump extensions to tar.
3 Copyright 1988, 1992-1994, 1996-1997, 1999-2001, 2003-2009, 2013
4 Free Software Foundation, Inc.
6 This file is part of GNU tar.
8 GNU tar is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 GNU tar is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 /* Incremental dump specialities. */
28 /* Which child files to save under a directory. */
36 #define DIRF_INIT 0x0001 /* directory structure is initialized
37 (procdir called at least once) */
38 #define DIRF_NFS 0x0002 /* directory is mounted on nfs */
39 #define DIRF_FOUND 0x0004 /* directory is found on fs */
40 #define DIRF_NEW 0x0008 /* directory is new (not found
41 in the previous dump) */
42 #define DIRF_RENAMED 0x0010 /* directory is renamed */
44 #define DIR_IS_INITED(d) ((d)->flags & DIRF_INIT)
45 #define DIR_IS_NFS(d) ((d)->flags & DIRF_NFS)
46 #define DIR_IS_FOUND(d) ((d)->flags & DIRF_FOUND)
47 /* #define DIR_IS_NEW(d) ((d)->flags & DIRF_NEW) FIXME: not used */
48 #define DIR_IS_RENAMED(d) ((d)->flags & DIRF_RENAMED)
50 #define DIR_SET_FLAG(d,f) (d)->flags |= (f)
51 #define DIR_CLEAR_FLAG(d,f) (d)->flags &= ~(f)
53 struct dumpdir /* Dump directory listing */
55 char *contents; /* Actual contents */
56 size_t total; /* Total number of elements */
57 size_t elc; /* Number of D/N/Y elements. */
58 char **elv; /* Array of D/N/Y elements */
61 /* Directory attributes. */
64 struct directory *next;
65 struct timespec mtime; /* Modification time */
66 dev_t device_number; /* device number for directory */
67 ino_t inode_number; /* inode number for directory */
68 struct dumpdir *dump; /* Directory contents */
69 struct dumpdir *idump; /* Initial contents if the directory was
71 enum children children; /* What to save under this directory */
72 unsigned flags; /* See DIRF_ macros above */
73 struct directory *orig; /* If the directory was renamed, points to
74 the original directory structure */
75 const char *tagfile; /* Tag file, if the directory falls under
76 exclusion_tag_under */
77 char *caname; /* canonical name */
78 char *name; /* file name of directory */
81 static struct dumpdir *
82 dumpdir_create0 (const char *contents, const char *cmask)
85 size_t i, total, ctsize, len;
89 for (i = 0, total = 0, ctsize = 1, q = contents; *q; total++, q += len)
93 if (!cmask || strchr (cmask, *q))
96 dump = xmalloc (sizeof (*dump) + ctsize);
97 dump->contents = (char*)(dump + 1);
98 memcpy (dump->contents, contents, ctsize);
101 dump->elv = xcalloc (i + 1, sizeof (dump->elv[0]));
103 for (i = 0, p = dump->contents; *p; p += strlen (p) + 1)
105 if (!cmask || strchr (cmask, *p))
106 dump->elv[i++] = p + 1;
112 static struct dumpdir *
113 dumpdir_create (const char *contents)
115 return dumpdir_create0 (contents, "YND");
119 dumpdir_free (struct dumpdir *dump)
126 compare_dirnames (const void *first, const void *second)
128 char const *const *name1 = first;
129 char const *const *name2 = second;
130 return strcmp (*name1, *name2);
133 /* Locate NAME in the dumpdir array DUMP.
134 Return pointer to the slot in DUMP->contents, or NULL if not found */
136 dumpdir_locate (struct dumpdir *dump, const char *name)
142 ptr = bsearch (&name, dump->elv, dump->elc, sizeof (dump->elv[0]),
144 return ptr ? *ptr - 1: NULL;
149 struct dumpdir *dump; /* Dumpdir being iterated */
150 int all; /* Iterate over all entries, not only D/N/Y */
151 size_t next; /* Index of the next element */
155 dumpdir_next (struct dumpdir_iter *itr)
157 size_t cur = itr->next;
162 ret = itr->dump->contents + cur;
165 itr->next += strlen (ret) + 1;
167 else if (cur < itr->dump->elc)
169 ret = itr->dump->elv[cur] - 1;
177 dumpdir_first (struct dumpdir *dump, int all, struct dumpdir_iter **pitr)
179 struct dumpdir_iter *itr = xmalloc (sizeof (*itr));
184 return dumpdir_next (itr);
187 /* Return size in bytes of the dumpdir array P */
189 dumpdir_size (const char *p)
195 size_t size = strlen (p) + 1;
203 static struct directory *dirhead, *dirtail;
204 static Hash_table *directory_table;
205 static Hash_table *directory_meta_table;
207 #if HAVE_ST_FSTYPE_STRING
208 static char const nfs_string[] = "nfs";
209 # define NFS_FILE_STAT(st) (strcmp ((st).st_fstype, nfs_string) == 0)
211 # define ST_DEV_MSB(st) (~ (dev_t) 0 << (sizeof (st).st_dev * CHAR_BIT - 1))
212 # define NFS_FILE_STAT(st) (((st).st_dev & ST_DEV_MSB (st)) != 0)
215 /* Calculate the hash of a directory. */
217 hash_directory_canonical_name (void const *entry, size_t n_buckets)
219 struct directory const *directory = entry;
220 return hash_string (directory->caname, n_buckets);
223 /* Compare two directories for equality of their names. */
225 compare_directory_canonical_names (void const *entry1, void const *entry2)
227 struct directory const *directory1 = entry1;
228 struct directory const *directory2 = entry2;
229 return strcmp (directory1->caname, directory2->caname) == 0;
233 hash_directory_meta (void const *entry, size_t n_buckets)
235 struct directory const *directory = entry;
236 /* FIXME: Work out a better algorytm */
237 return (directory->device_number + directory->inode_number) % n_buckets;
240 /* Compare two directories for equality of their device and inode numbers. */
242 compare_directory_meta (void const *entry1, void const *entry2)
244 struct directory const *directory1 = entry1;
245 struct directory const *directory2 = entry2;
246 return directory1->device_number == directory2->device_number
247 && directory1->inode_number == directory2->inode_number;
250 /* Make a directory entry for given relative NAME and canonical name CANAME.
251 The latter is "stolen", i.e. the returned directory contains pointer to
253 static struct directory *
254 make_directory (const char *name, char *caname)
256 size_t namelen = strlen (name);
257 struct directory *directory = xmalloc (sizeof (*directory));
258 directory->next = NULL;
259 directory->dump = directory->idump = NULL;
260 directory->orig = NULL;
261 directory->flags = false;
262 if (namelen > 1 && ISSLASH (name[namelen - 1]))
264 directory->name = xmalloc (namelen + 1);
265 memcpy (directory->name, name, namelen);
266 directory->name[namelen] = 0;
267 directory->caname = caname;
268 directory->tagfile = NULL;
273 free_directory (struct directory *dir)
280 static struct directory *
281 attach_directory (const char *name)
283 char *cname = normalize_filename (chdir_current, name);
284 struct directory *dir = make_directory (name, cname);
295 dirlist_replace_prefix (const char *pref, const char *repl)
297 struct directory *dp;
298 size_t pref_len = strlen (pref);
299 size_t repl_len = strlen (repl);
300 for (dp = dirhead; dp; dp = dp->next)
301 replace_prefix (&dp->name, pref, pref_len, repl, repl_len);
305 clear_directory_table (void)
307 struct directory *dp;
310 hash_clear (directory_table);
311 if (directory_meta_table)
312 hash_clear (directory_meta_table);
313 for (dp = dirhead; dp; )
315 struct directory *next = dp->next;
319 dirhead = dirtail = NULL;
322 /* Create and link a new directory entry for directory NAME, having a
323 device number DEV and an inode number INO, with NFS indicating
324 whether it is an NFS device and FOUND indicating whether we have
325 found that the directory exists. */
326 static struct directory *
327 note_directory (char const *name, struct timespec mtime,
328 dev_t dev, ino_t ino, bool nfs, bool found,
329 const char *contents)
331 struct directory *directory = attach_directory (name);
333 directory->mtime = mtime;
334 directory->device_number = dev;
335 directory->inode_number = ino;
336 directory->children = CHANGED_CHILDREN;
338 DIR_SET_FLAG (directory, DIRF_NFS);
340 DIR_SET_FLAG (directory, DIRF_FOUND);
342 directory->dump = dumpdir_create (contents);
344 directory->dump = NULL;
346 if (! ((directory_table
347 || (directory_table = hash_initialize (0, 0,
348 hash_directory_canonical_name,
349 compare_directory_canonical_names,
351 && hash_insert (directory_table, directory)))
354 if (! ((directory_meta_table
355 || (directory_meta_table = hash_initialize (0, 0,
357 compare_directory_meta,
359 && hash_insert (directory_meta_table, directory)))
365 /* Return a directory entry for a given file NAME, or zero if none found. */
366 static struct directory *
367 find_directory (const char *name)
369 if (! directory_table)
373 char *caname = normalize_filename (chdir_current, name);
374 struct directory *dir = make_directory (name, caname);
375 struct directory *ret = hash_lookup (directory_table, dir);
376 free_directory (dir);
382 /* Remove directory entry for the given CANAME */
384 remove_directory (const char *caname)
386 struct directory *dir = make_directory (caname, xstrdup (caname));
387 struct directory *ret = hash_delete (directory_table, dir);
389 free_directory (ret);
390 free_directory (dir);
394 /* If first OLD_PREFIX_LEN bytes of DIR->NAME name match OLD_PREFIX,
395 replace them with NEW_PREFIX. */
397 rebase_directory (struct directory *dir,
398 const char *old_prefix, size_t old_prefix_len,
399 const char *new_prefix, size_t new_prefix_len)
401 replace_prefix (&dir->name, old_prefix, old_prefix_len,
402 new_prefix, new_prefix_len);
405 /* Return a directory entry for a given combination of device and inode
406 numbers, or zero if none found. */
407 static struct directory *
408 find_directory_meta (dev_t dev, ino_t ino)
410 if (! directory_meta_table)
414 struct directory *dir = make_directory ("", NULL);
415 struct directory *ret;
416 dir->device_number = dev;
417 dir->inode_number = ino;
418 ret = hash_lookup (directory_meta_table, dir);
419 free_directory (dir);
425 update_parent_directory (struct tar_stat_info *parent)
427 struct directory *directory = find_directory (parent->orig_file_name);
431 if (fstat (parent->fd, &st) != 0)
432 stat_diag (directory->name);
434 directory->mtime = get_stat_mtime (&st);
438 #define PD_FORCE_CHILDREN 0x10
439 #define PD_FORCE_INIT 0x20
440 #define PD_CHILDREN(f) ((f) & 3)
442 static struct directory *
443 procdir (const char *name_buffer, struct tar_stat_info *st,
447 struct directory *directory;
448 struct stat *stat_data = &st->stat;
449 bool nfs = NFS_FILE_STAT (*stat_data);
450 bool perhaps_renamed = false;
452 if ((directory = find_directory (name_buffer)) != NULL)
454 if (DIR_IS_INITED (directory))
456 if (flag & PD_FORCE_INIT)
458 assign_string (&directory->name, name_buffer);
462 *entry = 'N'; /* Avoid duplicating this directory */
467 if (strcmp (directory->name, name_buffer))
473 /* With NFS, the same file can have two different devices
474 if an NFS directory is mounted in multiple locations,
475 which is relatively common when automounting.
476 To avoid spurious incremental redumping of
477 directories, consider all NFS devices as equal,
478 relying on the i-node to establish differences. */
480 if (! ((!check_device_option
481 || (DIR_IS_NFS (directory) && nfs)
482 || directory->device_number == stat_data->st_dev)
483 && directory->inode_number == stat_data->st_ino))
485 /* FIXME: find_directory_meta ignores nfs */
486 struct directory *d = find_directory_meta (stat_data->st_dev,
490 if (strcmp (d->name, name_buffer))
492 WARNOPT (WARN_RENAME_DIRECTORY,
494 _("%s: Directory has been renamed from %s"),
495 quotearg_colon (name_buffer),
496 quote_n (1, d->name)));
498 DIR_SET_FLAG (directory, DIRF_RENAMED);
499 dirlist_replace_prefix (d->name, name_buffer);
501 directory->children = CHANGED_CHILDREN;
505 perhaps_renamed = true;
506 directory->children = ALL_CHILDREN;
507 directory->device_number = stat_data->st_dev;
508 directory->inode_number = stat_data->st_ino;
511 DIR_SET_FLAG (directory, DIRF_NFS);
514 directory->children = CHANGED_CHILDREN;
516 DIR_SET_FLAG (directory, DIRF_FOUND);
520 struct directory *d = find_directory_meta (stat_data->st_dev,
523 directory = note_directory (name_buffer,
524 get_stat_mtime (stat_data),
533 if (strcmp (d->name, name_buffer))
535 WARNOPT (WARN_RENAME_DIRECTORY,
536 (0, 0, _("%s: Directory has been renamed from %s"),
537 quotearg_colon (name_buffer),
538 quote_n (1, d->name)));
540 DIR_SET_FLAG (directory, DIRF_RENAMED);
541 dirlist_replace_prefix (d->name, name_buffer);
543 directory->children = CHANGED_CHILDREN;
547 DIR_SET_FLAG (directory, DIRF_NEW);
548 WARNOPT (WARN_NEW_DIRECTORY,
549 (0, 0, _("%s: Directory is new"),
550 quotearg_colon (name_buffer)));
551 directory->children =
552 (listed_incremental_option
553 || (OLDER_STAT_TIME (*stat_data, m)
554 || (after_date_option
555 && OLDER_STAT_TIME (*stat_data, c))))
561 if (one_file_system_option && st->parent
562 && stat_data->st_dev != st->parent->stat.st_dev)
566 _("%s: directory is on a different filesystem; not dumped"),
567 quotearg_colon (directory->name)));
568 directory->children = NO_CHILDREN;
569 /* If there is any dumpdir info in that directory, remove it */
572 dumpdir_free (directory->dump);
573 directory->dump = NULL;
575 perhaps_renamed = false;
578 else if (flag & PD_FORCE_CHILDREN)
580 directory->children = PD_CHILDREN(flag);
581 if (directory->children == NO_CHILDREN)
586 WARNOPT (WARN_RENAME_DIRECTORY,
587 (0, 0, _("%s: Directory has been renamed"),
588 quotearg_colon (name_buffer)));
590 DIR_SET_FLAG (directory, DIRF_INIT);
592 if (directory->children != NO_CHILDREN)
594 const char *tag_file_name;
596 switch (check_exclusion_tags (st, &tag_file_name))
598 case exclusion_tag_all:
599 /* This warning can be duplicated by code in dump_file0, but only
600 in case when the topmost directory being archived contains
602 exclusion_tag_warning (name_buffer, tag_file_name,
603 _("directory not dumped"));
605 directory->children = NO_CHILDREN;
608 case exclusion_tag_contents:
609 exclusion_tag_warning (name_buffer, tag_file_name,
610 _("contents not dumped"));
611 directory->children = NO_CHILDREN;
612 directory->tagfile = tag_file_name;
615 case exclusion_tag_under:
616 exclusion_tag_warning (name_buffer, tag_file_name,
617 _("contents not dumped"));
618 directory->tagfile = tag_file_name;
621 case exclusion_tag_none:
629 /* Compare dumpdir array from DIRECTORY with directory listing DIR and
630 build a new dumpdir template.
632 DIR must be returned by a previous call to savedir().
634 File names in DIRECTORY->dump->contents must be sorted
637 DIRECTORY->dump is replaced with the created template. Each entry is
638 prefixed with ' ' if it was present in DUMP and with 'Y' otherwise. */
641 makedumpdir (struct directory *directory, const char *dir)
644 dirsize, /* Number of elements in DIR */
645 len; /* Length of DIR, including terminating nul */
648 char *new_dump, *new_dump_ptr;
649 struct dumpdir *dump;
651 if (directory->children == ALL_CHILDREN)
653 else if (DIR_IS_RENAMED (directory))
654 dump = directory->orig->idump ?
655 directory->orig->idump : directory->orig->dump;
657 dump = directory->dump;
659 /* Count the size of DIR and the number of elements it contains */
662 for (p = dir; *p; p += strlen (p) + 1, dirsize++)
663 len += strlen (p) + 2;
666 /* Create a sorted directory listing */
667 array = xcalloc (dirsize, sizeof array[0]);
668 for (i = 0, p = dir; *p; p += strlen (p) + 1, i++)
671 qsort (array, dirsize, sizeof (array[0]), compare_dirnames);
673 /* Prepare space for new dumpdir */
674 new_dump = xmalloc (len);
675 new_dump_ptr = new_dump;
677 /* Fill in the dumpdir template */
678 for (i = 0; i < dirsize; i++)
680 const char *loc = dumpdir_locate (dump, array[i]);
683 if (directory->tagfile)
689 else if (directory->tagfile)
690 *new_dump_ptr++ = 'I';
692 *new_dump_ptr++ = 'Y'; /* New entry */
694 /* Copy the file name */
695 for (p = array[i]; (*new_dump_ptr++ = *p++); )
699 directory->idump = directory->dump;
700 directory->dump = dumpdir_create0 (new_dump, NULL);
705 /* Create a dumpdir containing only one entry: that for the
708 maketagdumpdir (struct directory *directory)
710 size_t len = strlen (directory->tagfile) + 1;
711 char *new_dump = xmalloc (len + 2);
713 memcpy (new_dump + 1, directory->tagfile, len);
714 new_dump[len + 1] = 0;
716 directory->idump = directory->dump;
717 directory->dump = dumpdir_create0 (new_dump, NULL);
721 /* Recursively scan the directory identified by ST. */
723 scan_directory (struct tar_stat_info *st)
725 char const *dir = st->orig_file_name;
726 char *dirp = get_directory_entries (st);
727 dev_t device = st->stat.st_dev;
728 bool cmdline = ! st->parent;
731 struct directory *directory;
740 directory = procdir (tmp, st,
741 (cmdline ? PD_FORCE_INIT : 0),
746 nbuf = namebuf_create (dir);
750 if (directory->children != NO_CHILDREN)
752 char *entry; /* directory entry being scanned */
753 struct dumpdir_iter *itr;
755 makedumpdir (directory, dirp);
757 for (entry = dumpdir_first (directory->dump, 1, &itr);
759 entry = dumpdir_next (itr))
761 char *full_name = namebuf_name (nbuf, entry + 1);
763 if (*entry == 'I') /* Ignored entry */
765 else if (excluded_name (full_name))
770 void (*diag) (char const *) = 0;
771 struct tar_stat_info stsub;
772 tar_stat_init (&stsub);
779 else if (fstatat (fd, entry + 1, &stsub.stat,
782 else if (S_ISDIR (stsub.stat.st_mode))
784 int subfd = subfile_open (st, entry + 1,
791 if (fstat (subfd, &stsub.stat) != 0)
798 file_removed_diag (full_name, false, diag);
801 else if (S_ISDIR (stsub.stat.st_mode))
804 if (!recursion_option)
805 pd_flag |= PD_FORCE_CHILDREN | NO_CHILDREN;
806 else if (directory->children == ALL_CHILDREN)
807 pd_flag |= PD_FORCE_CHILDREN | ALL_CHILDREN;
811 procdir (full_name, &stsub, pd_flag, entry);
812 restore_parent_fd (&stsub);
814 else if (one_file_system_option &&
815 device != stsub.stat.st_dev)
817 else if (*entry == 'Y')
818 /* New entry, skip further checks */;
819 /* FIXME: if (S_ISHIDDEN (stat_data.st_mode))?? */
820 else if (OLDER_STAT_TIME (stsub.stat, m)
821 && (!after_date_option
822 || OLDER_STAT_TIME (stsub.stat, c)))
827 tar_stat_destroy (&stsub);
832 else if (directory->tagfile)
833 maketagdumpdir (directory);
843 /* Return pointer to the contents of the directory DIR */
845 directory_contents (struct directory *dir)
849 return dir->dump ? dir->dump->contents : NULL;
852 /* A "safe" version of directory_contents, which never returns NULL. */
854 safe_directory_contents (struct directory *dir)
856 const char *ret = directory_contents (dir);
857 return ret ? ret : "\0\0\0\0";
862 obstack_code_rename (struct obstack *stk, char const *from, char const *to)
866 s = from[0] == 0 ? from :
867 safer_name_suffix (from, false, absolute_names_option);
868 obstack_1grow (stk, 'R');
869 obstack_grow (stk, s, strlen (s) + 1);
872 safer_name_suffix (to, false, absolute_names_option);
873 obstack_1grow (stk, 'T');
874 obstack_grow (stk, s, strlen (s) + 1);
878 store_rename (struct directory *dir, struct obstack *stk)
880 if (DIR_IS_RENAMED (dir))
882 struct directory *prev, *p;
884 /* Detect eventual cycles and clear DIRF_RENAMED flag, so these entries
885 are ignored when hit by this function next time.
886 If the chain forms a cycle, prev points to the entry DIR is renamed
887 from. In this case it still retains DIRF_RENAMED flag, which will be
888 cleared in the 'else' branch below */
889 for (prev = dir; prev && prev->orig != dir; prev = prev->orig)
890 DIR_CLEAR_FLAG (prev, DIRF_RENAMED);
894 for (p = dir; p && p->orig; p = p->orig)
895 obstack_code_rename (stk, p->orig->name, p->name);
901 DIR_CLEAR_FLAG (prev, DIRF_RENAMED);
903 /* Break the cycle by using a temporary name for one of its
905 First, create a temp name stub entry. */
906 temp_name = dir_name (dir->name);
907 obstack_1grow (stk, 'X');
908 obstack_grow (stk, temp_name, strlen (temp_name) + 1);
910 obstack_code_rename (stk, dir->name, "");
912 for (p = dir; p != prev; p = p->orig)
913 obstack_code_rename (stk, p->orig->name, p->name);
915 obstack_code_rename (stk, "", prev->name);
921 append_incremental_renames (struct directory *dir)
925 struct directory *dp;
932 dump = directory_contents (dir);
935 size = dumpdir_size (dump) - 1;
936 obstack_grow (&stk, dump, size);
941 for (dp = dirhead; dp; dp = dp->next)
942 store_rename (dp, &stk);
944 /* FIXME: Is this the right thing to do when DIR is null? */
945 if (dir && obstack_object_size (&stk) != size)
947 obstack_1grow (&stk, 0);
948 dumpdir_free (dir->dump);
949 dir->dump = dumpdir_create (obstack_finish (&stk));
951 obstack_free (&stk, NULL);
956 static FILE *listed_incremental_stream;
958 /* Version of incremental format snapshots (directory files) used by this
959 tar. Currently it is supposed to be a single decimal number. 0 means
960 incremental snapshots as per tar version before 1.15.2.
962 The current tar version supports incremental versions from
963 0 up to TAR_INCREMENTAL_VERSION, inclusive.
964 It is able to create only snapshots of TAR_INCREMENTAL_VERSION */
966 #define TAR_INCREMENTAL_VERSION 2
968 /* Read incremental snapshot formats 0 and 1 */
970 read_incr_db_01 (int version, const char *initbuf)
981 if (getline (&buf, &bufsize, listed_incremental_stream) <= 0)
983 read_error (listed_incremental_option);
991 buf = strdup (initbuf);
992 bufsize = strlen (buf) + 1;
995 newer_mtime_option = decode_timespec (buf, &ebuf, false);
997 if (! valid_timespec (newer_mtime_option))
998 ERROR ((0, errno, "%s:%ld: %s",
999 quotearg_colon (listed_incremental_option),
1001 _("Invalid time stamp")));
1004 if (version == 1 && *ebuf)
1006 char const *buf_ns = ebuf + 1;
1008 u = strtoumax (buf_ns, &ebuf, 10);
1009 if (!errno && BILLION <= u)
1011 if (errno || buf_ns == ebuf)
1013 ERROR ((0, errno, "%s:%ld: %s",
1014 quotearg_colon (listed_incremental_option),
1016 _("Invalid time stamp")));
1017 newer_mtime_option.tv_sec = TYPE_MINIMUM (time_t);
1018 newer_mtime_option.tv_nsec = -1;
1021 newer_mtime_option.tv_nsec = u;
1025 while (0 < (n = getline (&buf, &bufsize, listed_incremental_stream)))
1029 bool nfs = buf[0] == '+';
1030 char *strp = buf + nfs;
1031 struct timespec mtime;
1035 if (buf[n - 1] == '\n')
1040 mtime = decode_timespec (strp, &ebuf, false);
1042 if (!valid_timespec (mtime) || *strp != ' ')
1043 ERROR ((0, errno, "%s:%ld: %s",
1044 quotearg_colon (listed_incremental_option), lineno,
1045 _("Invalid modification time")));
1048 u = strtoumax (strp, &ebuf, 10);
1049 if (!errno && BILLION <= u)
1051 if (errno || strp == ebuf || *ebuf != ' ')
1053 ERROR ((0, errno, "%s:%ld: %s",
1054 quotearg_colon (listed_incremental_option), lineno,
1055 _("Invalid modification time (nanoseconds)")));
1063 mtime.tv_sec = mtime.tv_nsec = 0;
1065 dev = strtosysint (strp, &ebuf,
1066 TYPE_MINIMUM (dev_t), TYPE_MAXIMUM (dev_t));
1068 if (errno || *strp != ' ')
1069 ERROR ((0, errno, "%s:%ld: %s",
1070 quotearg_colon (listed_incremental_option), lineno,
1071 _("Invalid device number")));
1073 ino = strtosysint (strp, &ebuf,
1074 TYPE_MINIMUM (ino_t), TYPE_MAXIMUM (ino_t));
1076 if (errno || *strp != ' ')
1077 ERROR ((0, errno, "%s:%ld: %s",
1078 quotearg_colon (listed_incremental_option), lineno,
1079 _("Invalid inode number")));
1082 unquote_string (strp);
1083 note_directory (strp, mtime, dev, ino, nfs, false, NULL);
1088 /* Read a nul-terminated string from FP and store it in STK.
1089 Store the number of bytes read (including nul terminator) in PCOUNT.
1091 Return the last character read or EOF on end of file. */
1093 read_obstack (FILE *fp, struct obstack *stk, size_t *pcount)
1098 for (i = 0, c = getc (fp); c != EOF && c != 0; c = getc (fp), i++)
1099 obstack_1grow (stk, c);
1100 obstack_1grow (stk, 0);
1106 /* Read from file FP a null-terminated string and convert it to an
1107 integer. FIELDNAME is the intended use of the integer, useful for
1108 diagnostics. MIN_VAL and MAX_VAL are its minimum and maximum
1109 permissible values; MIN_VAL must be nonpositive and MAX_VAL positive.
1110 Store into *PVAL the resulting value, converted to intmax_t.
1112 Throw a fatal error if the string cannot be converted or if the
1113 converted value is out of range.
1115 Return true if successful, false if end of file. */
1118 read_num (FILE *fp, char const *fieldname,
1119 intmax_t min_val, uintmax_t max_val, intmax_t *pval)
1122 char buf[INT_BUFSIZE_BOUND (intmax_t)];
1123 char offbuf[INT_BUFSIZE_BOUND (off_t)];
1124 char minbuf[INT_BUFSIZE_BOUND (intmax_t)];
1125 char maxbuf[INT_BUFSIZE_BOUND (intmax_t)];
1126 int conversion_errno;
1128 bool negative = c == '-';
1130 for (i = 0; (i == 0 && negative) || ISDIGIT (c); i++)
1133 if (i == sizeof buf - 1)
1135 _("%s: byte %s: %s %.*s... too long"),
1136 quotearg_colon (listed_incremental_option),
1137 offtostr (ftello (fp), offbuf),
1138 fieldname, i + 1, buf));
1147 read_fatal (listed_incremental_option);
1149 FATAL_ERROR ((0, 0, "%s: %s",
1150 quotearg_colon (listed_incremental_option),
1151 _("Unexpected EOF in snapshot file")));
1157 _("%s: byte %s: %s %s followed by invalid byte 0x%02x"),
1158 quotearg_colon (listed_incremental_option),
1159 offtostr (ftello (fp), offbuf),
1160 fieldname, buf, c));
1162 *pval = strtosysint (buf, NULL, min_val, max_val);
1163 conversion_errno = errno;
1165 switch (conversion_errno)
1168 FATAL_ERROR ((0, conversion_errno,
1169 _("%s: byte %s: (valid range %s..%s)\n\t%s %s"),
1170 quotearg_colon (listed_incremental_option),
1171 offtostr (ftello (fp), offbuf),
1172 imaxtostr (min_val, minbuf),
1173 umaxtostr (max_val, maxbuf), fieldname, buf));
1175 FATAL_ERROR ((0, conversion_errno,
1176 _("%s: byte %s: %s %s"),
1177 quotearg_colon (listed_incremental_option),
1178 offtostr (ftello (fp), offbuf), fieldname, buf));
1186 /* Read from FP two NUL-terminated strings representing a struct
1187 timespec. Return the resulting value in PVAL.
1189 Throw a fatal error if the string cannot be converted. */
1192 read_timespec (FILE *fp, struct timespec *pval)
1196 if (read_num (fp, "sec", TYPE_MINIMUM (time_t), TYPE_MAXIMUM (time_t), &s)
1197 && read_num (fp, "nsec", 0, BILLION - 1, &ns))
1204 FATAL_ERROR ((0, 0, "%s: %s",
1205 quotearg_colon (listed_incremental_option),
1206 _("Unexpected EOF in snapshot file")));
1210 /* Read incremental snapshot format 2 */
1212 read_incr_db_2 (void)
1215 char offbuf[INT_BUFSIZE_BOUND (off_t)];
1217 obstack_init (&stk);
1219 read_timespec (listed_incremental_stream, &newer_mtime_option);
1224 struct timespec mtime;
1232 if (! read_num (listed_incremental_stream, "nfs", 0, 1, &i))
1233 return; /* Normal return */
1237 read_timespec (listed_incremental_stream, &mtime);
1239 if (! read_num (listed_incremental_stream, "dev",
1240 TYPE_MINIMUM (dev_t), TYPE_MAXIMUM (dev_t), &i))
1244 if (! read_num (listed_incremental_stream, "ino",
1245 TYPE_MINIMUM (ino_t), TYPE_MAXIMUM (ino_t), &i))
1249 if (read_obstack (listed_incremental_stream, &stk, &s))
1252 name = obstack_finish (&stk);
1254 while (read_obstack (listed_incremental_stream, &stk, &s) == 0 && s > 1)
1256 if (getc (listed_incremental_stream) != 0)
1257 FATAL_ERROR ((0, 0, _("%s: byte %s: %s"),
1258 quotearg_colon (listed_incremental_option),
1259 offtostr (ftello (listed_incremental_stream), offbuf),
1260 _("Missing record terminator")));
1262 content = obstack_finish (&stk);
1263 note_directory (name, mtime, dev, ino, nfs, false, content);
1264 obstack_free (&stk, content);
1266 FATAL_ERROR ((0, 0, "%s: %s",
1267 quotearg_colon (listed_incremental_option),
1268 _("Unexpected EOF in snapshot file")));
1271 /* Display (to stdout) the range of allowed values for each field
1272 in the snapshot file. The array below should be kept in sync
1273 with any changes made to the read_num() calls in the parsing
1274 loop inside read_incr_db_2().
1276 (This function is invoked via the --show-snapshot-field-ranges
1277 command line option.) */
1281 char const *fieldname;
1286 static struct field_range const field_ranges[] = {
1288 { "timestamp_sec", TYPE_MINIMUM (time_t), TYPE_MAXIMUM (time_t) },
1289 { "timestamp_nsec", 0, BILLION - 1 },
1290 { "dev", TYPE_MINIMUM (dev_t), TYPE_MAXIMUM (dev_t) },
1291 { "ino", TYPE_MINIMUM (ino_t), TYPE_MAXIMUM (ino_t) },
1296 show_snapshot_field_ranges (void)
1298 struct field_range const *p;
1299 char minbuf[max (SYSINT_BUFSIZE, INT_BUFSIZE_BOUND (intmax_t))];
1300 char maxbuf[max (SYSINT_BUFSIZE, INT_BUFSIZE_BOUND (uintmax_t))];
1302 printf("This tar's snapshot file field ranges are\n");
1303 printf (" (%-15s => [ %s, %s ]):\n\n", "field name", "min", "max");
1305 for (p=field_ranges; p->fieldname != NULL; p++)
1307 printf (" %-15s => [ %s, %s ],\n", p->fieldname,
1308 sysinttostr (p->min_val, p->min_val, p->max_val, minbuf),
1309 sysinttostr (p->max_val, p->min_val, p->max_val, maxbuf));
1316 /* Read incremental snapshot file (directory file).
1317 If the file has older incremental version, make sure that it is processed
1318 correctly and that tar will use the most conservative backup method among
1319 possible alternatives (i.e. prefer ALL_CHILDREN over CHANGED_CHILDREN,
1320 etc.) This ensures that the snapshots are updated to the recent version
1321 without any loss of data. */
1323 read_directory_file (void)
1328 int flags = O_RDWR | O_CREAT;
1330 if (incremental_level == 0)
1332 /* Open the file for both read and write. That way, we can write
1333 it later without having to reopen it, and don't have to worry if
1334 we chdir in the meantime. */
1335 fd = open (listed_incremental_option, flags, MODE_RW);
1338 open_error (listed_incremental_option);
1342 listed_incremental_stream = fdopen (fd, "r+");
1343 if (! listed_incremental_stream)
1345 open_error (listed_incremental_option);
1350 /* Consume the first name from the name list and reset the
1351 list afterwards. This is done to change to the new
1352 directory, if the first name is a chdir request (-C dir),
1353 which is necessary to recreate absolute file names. */
1357 if (0 < getline (&buf, &bufsize, listed_incremental_stream))
1360 uintmax_t incremental_version;
1362 if (strncmp (buf, PACKAGE_NAME, sizeof PACKAGE_NAME - 1) == 0)
1364 ebuf = buf + sizeof PACKAGE_NAME - 1;
1366 ERROR((1, 0, _("Bad incremental file format")));
1367 for (; *ebuf != '-'; ebuf++)
1369 ERROR((1, 0, _("Bad incremental file format")));
1371 incremental_version = strtoumax (ebuf + 1, NULL, 10);
1374 incremental_version = 0;
1376 switch (incremental_version)
1380 read_incr_db_01 (incremental_version, buf);
1383 case TAR_INCREMENTAL_VERSION:
1388 ERROR ((1, 0, _("Unsupported incremental format version: %"PRIuMAX),
1389 incremental_version));
1394 if (ferror (listed_incremental_stream))
1395 read_error (listed_incremental_option);
1399 /* Output incremental data for the directory ENTRY to the file DATA.
1400 Return nonzero if successful, preserving errno on write failure. */
1402 write_directory_file_entry (void *entry, void *data)
1404 struct directory const *directory = entry;
1407 if (DIR_IS_FOUND (directory))
1409 char buf[max (SYSINT_BUFSIZE, INT_BUFSIZE_BOUND (intmax_t))];
1412 s = DIR_IS_NFS (directory) ? "1" : "0";
1413 fwrite (s, 2, 1, fp);
1414 s = sysinttostr (directory->mtime.tv_sec, TYPE_MINIMUM (time_t),
1415 TYPE_MAXIMUM (time_t), buf);
1416 fwrite (s, strlen (s) + 1, 1, fp);
1417 s = imaxtostr (directory->mtime.tv_nsec, buf);
1418 fwrite (s, strlen (s) + 1, 1, fp);
1419 s = sysinttostr (directory->device_number,
1420 TYPE_MINIMUM (dev_t), TYPE_MAXIMUM (dev_t), buf);
1421 fwrite (s, strlen (s) + 1, 1, fp);
1422 s = sysinttostr (directory->inode_number,
1423 TYPE_MINIMUM (ino_t), TYPE_MAXIMUM (ino_t), buf);
1424 fwrite (s, strlen (s) + 1, 1, fp);
1426 fwrite (directory->name, strlen (directory->name) + 1, 1, fp);
1427 if (directory->dump)
1430 struct dumpdir_iter *itr;
1432 for (p = dumpdir_first (directory->dump, 0, &itr);
1434 p = dumpdir_next (itr))
1435 fwrite (p, strlen (p) + 1, 1, fp);
1438 fwrite ("\0\0", 2, 1, fp);
1441 return ! ferror (fp);
1445 write_directory_file (void)
1447 FILE *fp = listed_incremental_stream;
1448 char buf[UINTMAX_STRSIZE_BOUND];
1454 if (fseeko (fp, 0L, SEEK_SET) != 0)
1455 seek_error (listed_incremental_option);
1456 if (sys_truncate (fileno (fp)) != 0)
1457 truncate_error (listed_incremental_option);
1459 fprintf (fp, "%s-%s-%d\n", PACKAGE_NAME, PACKAGE_VERSION,
1460 TAR_INCREMENTAL_VERSION);
1462 s = (TYPE_SIGNED (time_t)
1463 ? imaxtostr (start_time.tv_sec, buf)
1464 : umaxtostr (start_time.tv_sec, buf));
1465 fwrite (s, strlen (s) + 1, 1, fp);
1466 s = umaxtostr (start_time.tv_nsec, buf);
1467 fwrite (s, strlen (s) + 1, 1, fp);
1469 if (! ferror (fp) && directory_table)
1470 hash_do_for_each (directory_table, write_directory_file_entry, fp);
1473 write_error (listed_incremental_option);
1474 if (fclose (fp) != 0)
1475 close_error (listed_incremental_option);
1479 /* Restoration of incremental dumps. */
1482 get_gnu_dumpdir (struct tar_stat_info *stat_info)
1486 union block *data_block;
1490 size = stat_info->stat.st_size;
1492 archive_dir = xmalloc (size);
1495 set_next_block_after (current_header);
1496 mv_begin_read (stat_info);
1498 for (; size > 0; size -= copied)
1500 mv_size_left (size);
1501 data_block = find_next_block ();
1503 ERROR ((1, 0, _("Unexpected EOF in archive")));
1504 copied = available_space_after (data_block);
1507 memcpy (to, data_block->buffer, copied);
1509 set_next_block_after ((union block *)
1510 (data_block->buffer + copied - 1));
1515 stat_info->dumpdir = archive_dir;
1516 stat_info->skipped = true; /* For skip_member() and friends
1517 to work correctly */
1520 /* Return T if STAT_INFO represents a dumpdir archive member.
1521 Note: can invalidate current_header. It happens if flush_archive()
1522 gets called within get_gnu_dumpdir() */
1524 is_dumpdir (struct tar_stat_info *stat_info)
1526 if (stat_info->is_dumpdir && !stat_info->dumpdir)
1527 get_gnu_dumpdir (stat_info);
1528 return stat_info->is_dumpdir;
1532 dumpdir_ok (char *dumpdir)
1535 int has_tempdir = 0;
1538 for (p = dumpdir; *p; p += strlen (p) + 1)
1540 if (expect && *p != expect)
1543 _("Malformed dumpdir: expected '%c' but found %#3o"),
1553 _("Malformed dumpdir: 'X' duplicated")));
1566 _("Malformed dumpdir: empty name in 'R'")));
1579 _("Malformed dumpdir: 'T' not preceeded by 'R'")));
1582 if (p[1] == 0 && !has_tempdir)
1585 _("Malformed dumpdir: empty name in 'T'")));
1597 /* FIXME: bail out? */
1605 _("Malformed dumpdir: expected '%c' but found end of data"),
1611 WARNOPT (WARN_BAD_DUMPDIR,
1612 (0, 0, _("Malformed dumpdir: 'X' never used")));
1617 /* Examine the directories under directory_name and delete any
1618 files that were not there at the time of the back-up. */
1620 try_purge_directory (char const *directory_name)
1623 char *cur, *arc, *p;
1624 char *temp_stub = NULL;
1625 struct dumpdir *dump;
1627 if (!is_dumpdir (¤t_stat_info))
1630 current_dir = tar_savedir (directory_name, 0);
1633 /* The directory doesn't exist now. It'll be created. In any
1634 case, we don't have to delete any files out of it. */
1637 /* Verify if dump directory is sane */
1638 if (!dumpdir_ok (current_stat_info.dumpdir))
1641 /* Process renames */
1642 for (arc = current_stat_info.dumpdir; *arc; arc += strlen (arc) + 1)
1646 #define TEMP_DIR_TEMPLATE "tar.XXXXXX"
1647 size_t len = strlen (arc + 1);
1648 temp_stub = xrealloc (temp_stub, len + 1 + sizeof TEMP_DIR_TEMPLATE);
1649 memcpy (temp_stub, arc + 1, len);
1650 temp_stub[len] = '/';
1651 memcpy (temp_stub + len + 1, TEMP_DIR_TEMPLATE,
1652 sizeof TEMP_DIR_TEMPLATE);
1653 if (!mkdtemp (temp_stub))
1656 _("Cannot create temporary directory using template %s"),
1657 quote (temp_stub)));
1663 else if (*arc == 'R')
1667 arc += strlen (arc) + 1;
1670 /* Ensure that neither source nor destination are absolute file
1671 names (unless permitted by -P option), and that they do not
1672 contain dubious parts (e.g. ../).
1674 This is an extra safety precaution. Besides, it might be
1675 necessary to extract from archives created with tar versions
1679 src = safer_name_suffix (src, false, absolute_names_option);
1681 dst = safer_name_suffix (dst, false, absolute_names_option);
1688 if (!rename_directory (src, dst))
1692 /* FIXME: Make sure purge_directory(dst) will return
1701 /* Process deletes */
1702 dump = dumpdir_create (current_stat_info.dumpdir);
1704 for (cur = current_dir; *cur; cur += strlen (cur) + 1)
1709 p = new_name (directory_name, cur);
1711 if (deref_stat (p, &st) != 0)
1713 if (errno != ENOENT) /* FIXME: Maybe keep a list of renamed
1714 dirs and check it here? */
1717 WARN ((0, 0, _("%s: Not purging directory: unable to stat"),
1718 quotearg_colon (p)));
1723 if (!(entry = dumpdir_locate (dump, cur))
1724 || (*entry == 'D' && !S_ISDIR (st.st_mode))
1725 || (*entry == 'Y' && S_ISDIR (st.st_mode)))
1727 if (one_file_system_option && st.st_dev != root_device)
1730 _("%s: directory is on a different device: not purging"),
1731 quotearg_colon (p)));
1735 if (! interactive_option || confirm ("delete", p))
1738 fprintf (stdlis, _("%s: Deleting %s\n"),
1739 program_name, quote (p));
1740 if (! remove_any_file (p, RECURSIVE_REMOVE_OPTION))
1743 ERROR ((0, e, _("%s: Cannot remove"), quotearg_colon (p)));
1749 dumpdir_free (dump);
1756 purge_directory (char const *directory_name)
1758 if (!try_purge_directory (directory_name))
1763 list_dumpdir (char *buffer, size_t size)
1776 fprintf (stdlis, "%c", *buffer);
1779 fprintf (stdlis, " ");
1787 fputc ('\n', stdlis);
1794 fputc (*buffer, stdlis);