Tweaking the license text a bit more.
[rsync/rsync.git] / hlink.c
diff --git a/hlink.c b/hlink.c
index 495c0a8..e9e76cd 100644 (file)
--- a/hlink.c
+++ b/hlink.c
-/* 
-   Copyright (C) Andrew Tridgell 1996
-   Copyright (C) Paul Mackerras 1996
-   
-   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 of the License, or
-   (at your option) any later version.
-   
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License for more details.
-   
-   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., 675 Mass Ave, Cambridge, MA 02139, USA.
-*/
+/*
+ * Routines to support hard-linking.
+ *
+ * Copyright (C) 1996 Andrew Tridgell
+ * Copyright (C) 1996 Paul Mackerras
+ * Copyright (C) 2002 Martin Pool <mbp@samba.org>
+ * Copyright (C) 2004-2007 Wayne Davison
+ *
+ * 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 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, visit the http://fsf.org website.
+ */
 
 #include "rsync.h"
 
-extern int am_server;
-extern int dry_run;
 extern int verbose;
+extern int dry_run;
+extern int do_xfers;
+extern int link_dest;
+extern int preserve_acls;
+extern int make_backups;
+extern int protocol_version;
+extern int remove_source_files;
+extern int stdout_format_has_i;
+extern int maybe_ATTRS_REPORT;
+extern char *basis_dir[];
+extern struct file_list *cur_flist;
+#ifdef ICONV_OPTION
+extern int ic_ndx;
+#endif
+
+#ifdef SUPPORT_HARD_LINKS
+
+#define HASH_LOAD_LIMIT(size) ((size)*3/4)
+
+struct ihash_table {
+       int32 size;
+       int32 entries;
+       struct idev_node *buckets;
+} *dev_tbl;
+
+static struct idev_node *ihash_node(struct ihash_table *tbl, int64 key);
+
+/* Starting with protocol 30, we use a simple hashtable on the sending side
+ * for hashing the st_dev and st_ino info.  The receiving side gets told
+ * (via flags and a "group index") which items are hard-linked together, so
+ * we can avoid the pool of dev+inode data. */
+
+static struct ihash_table *ihash_create(int size)
+{
+       struct ihash_table *tbl;
+
+       /* Pick a power of 2 that can hold the requested size. */
+       if (size & (size-1) || size < 16) {
+               int req = size;
+               size = 16;
+               while (size < req)
+                       size *= 2;
+       }
+
+       if (!(tbl = new(struct ihash_table))
+        || !(tbl->buckets = new_array(struct idev_node, size)))
+               out_of_memory("ihash_create");
+       memset(tbl->buckets, 0, size * sizeof tbl->buckets[0]);
+       tbl->size = size;
+       tbl->entries = 0;
+
+       return tbl;
+}
 
-#if SUPPORT_HARD_LINKS
-static int hlink_compare(struct file_struct *f1,struct file_struct *f2)
+static void ihash_destroy(struct ihash_table *tbl)
 {
-  if (!S_ISREG(f1->mode) && !S_ISREG(f2->mode)) return 0;
-  if (!S_ISREG(f1->mode)) return -1;
-  if (!S_ISREG(f2->mode)) return 1;
+       free(tbl->buckets);
+       free(tbl);
+}
 
-  if (f1->dev != f2->dev) 
-    return (f1->dev - f2->dev);
+void init_hard_links(void)
+{
+       dev_tbl = ihash_create(16);
+}
+
+static void expand_ihash(struct ihash_table *tbl)
+{
+       struct idev_node *old_buckets = tbl->buckets;
+       int size = tbl->size * 2;
+       int i;
 
-  if (f1->inode != f2->inode) 
-    return (f1->inode - f2->inode);
+       if (!(tbl->buckets = new_array(struct idev_node, size)))
+               out_of_memory("ihash_create");
+       memset(tbl->buckets, 0, size * sizeof (struct idev_node));
+       tbl->size = size;
+       tbl->entries = 0;
+
+       for (i = size / 2; i-- > 0; ) {
+               int64 key = old_buckets[i].key;
+               if (key == 0)
+                       continue;
+               ihash_node(tbl, key)->data = old_buckets[i].data;
+       }
 
-  return file_compare(f1,f2);
+       free(old_buckets);
 }
 
+/* This returns the node for the indicated key, either newly created,
+ * or already existing. */
+static struct idev_node *ihash_node(struct ihash_table *tbl, int64 key)
+{
+       uint32 bkt;
+
+       if (tbl->entries > HASH_LOAD_LIMIT(tbl->size))
+               expand_ihash(tbl);
+
+#if SIZEOF_INT64 < 8
+       /* Based on Jenkins One-at-a-time hash. */
+       {
+               uchar *keyp = (uchar*)&key;
+               int i;
+
+               for (bkt = 0, i = 0; i < SIZEOF_INT64; i++) {
+                       bkt += keyp[i];
+                       bkt += (bkt << 10);
+                       bkt ^= (bkt >> 6);
+               }
+               bkt += (bkt << 3);
+               bkt ^= (bkt >> 11);
+               bkt += (bkt << 15);
+       }
+#else
+#define rot(x,k) (((x)<<(k)) ^ ((x)>>(32-(k))))
+       /* Based on Jenkins hashword() from lookup3.c. */
+       {
+               uint32 a, b, c;
+
+               /* Set up the internal state */
+               a = b = c = 0xdeadbeef + (8 << 2);
 
-static struct file_struct *hlink_list = NULL;
-static int hlink_count=0;
+               b += (uint32)(key >> 32);
+               a += (uint32)key;
+               c ^= b; c -= rot(b, 14);
+               a ^= c; a -= rot(c, 11);
+               b ^= a; b -= rot(a, 25);
+               c ^= b; c -= rot(b, 16);
+               a ^= c; a -= rot(c, 4);
+               b ^= a; b -= rot(a, 14);
+               c ^= b; c -= rot(b, 24);
+               bkt = c;
+       }
 #endif
 
-void init_hard_links(struct file_list *flist)
+       /* If it already exists, return it. */
+       while (1) {
+               bkt &= tbl->size - 1;
+               if (tbl->buckets[bkt].key == key)
+                       return &tbl->buckets[bkt];
+               if (tbl->buckets[bkt].key == 0)
+                       break;
+               bkt++;
+       }
+
+       /* Otherwise, take over this empty spot and then return it. */
+       tbl->buckets[bkt].key = key;
+       tbl->entries++;
+       return &tbl->buckets[bkt];
+}
+
+struct idev_node *idev_node(int64 dev, int64 ino)
+{
+       static struct idev_node *dev_node = NULL;
+       struct ihash_table *tbl;
+
+       if (!dev_node || dev_node->key != dev) {
+               /* We keep a separate hash table of inodes for every device. */
+               dev_node = ihash_node(dev_tbl, dev);
+               if (!(tbl = dev_node->data))
+                       tbl = dev_node->data = ihash_create(512);
+       } else
+               tbl = dev_node->data;
+
+       return ihash_node(tbl, ino);
+}
+
+void idev_destroy(void)
+{
+       int i;
+
+       for (i = 0; i < dev_tbl->size; i++) {
+               if (dev_tbl->buckets[i].data)
+                       ihash_destroy(dev_tbl->buckets[i].data);
+       }
+
+       ihash_destroy(dev_tbl);
+}
+
+static int hlink_compare_gnum(int *int1, int *int2)
 {
-#if SUPPORT_HARD_LINKS
-  if (flist->count < 2) return;
+       struct file_struct *f1 = cur_flist->sorted[*int1];
+       struct file_struct *f2 = cur_flist->sorted[*int2];
+       int32 gnum1 = F_HL_GNUM(f1);
+       int32 gnum2 = F_HL_GNUM(f2);
 
-  if (hlink_list) free(hlink_list);
-    
-  if (!(hlink_list = 
-       (struct file_struct *)malloc(sizeof(hlink_list[0])*flist->count)))
-    out_of_memory("init_hard_links");
+       if (gnum1 != gnum2)
+               return gnum1 > gnum2 ? 1 : -1;
 
-  bcopy((char *)flist->files,
-       (char *)hlink_list,
-       sizeof(hlink_list[0])*flist->count);
+       return *int1 > *int2 ? 1 : -1;
+}
+
+static void match_gnums(int32 *ndx_list, int ndx_count)
+{
+       int32 from, prev;
+       struct file_struct *file, *file_next;
+       int32 gnum, gnum_next;
 
-  qsort(hlink_list,flist->count,
-       sizeof(hlink_list[0]),
-       (int (*)())hlink_compare);
+       qsort(ndx_list, ndx_count, sizeof ndx_list[0],
+            (int (*)()) hlink_compare_gnum);
 
-  hlink_count=flist->count;
+       for (from = 0; from < ndx_count; from++) {
+               for (file = cur_flist->sorted[ndx_list[from]], gnum = F_HL_GNUM(file), prev = -1;
+                    from < ndx_count-1;
+                    file = file_next, gnum = gnum_next, from++) /*SHARED ITERATOR*/
+               {
+                       file_next = cur_flist->sorted[ndx_list[from+1]];
+                       gnum_next = F_HL_GNUM(file_next);
+                       if (gnum != gnum_next)
+                               break;
+                       if (prev < 0)
+                               file->flags |= FLAG_HLINK_FIRST;
+                       F_HL_PREV(file) = prev;
+                       /* The linked list must use raw ndx values. */
+#ifdef ICONV_OPTION
+                       if (ic_ndx)
+                               prev = F_NDX(file);
+                       else
 #endif
+                               prev = ndx_list[from];
+               }
+               if (prev < 0)
+                       file->flags &= ~FLAG_HLINKED;
+               else {
+                       file->flags |= FLAG_HLINK_LAST;
+                       F_HL_PREV(file) = prev;
+               }
+       }
+}
+
+/* Analyze the hard-links in the file-list by creating a list of all the
+ * items that have hlink data, sorting them, and matching up identical
+ * values into clusters.  These will be a single linked list from last
+ * to first when we're done. */
+void match_hard_links(void)
+{
+       int i, ndx_count = 0;
+       int32 *ndx_list;
+
+       if (!(ndx_list = new_array(int32, cur_flist->used)))
+               out_of_memory("match_hard_links");
+
+       for (i = 0; i < cur_flist->used; i++) {
+               if (F_IS_HLINKED(cur_flist->sorted[i]))
+                       ndx_list[ndx_count++] = i;
+       }
+
+       if (ndx_count)
+               match_gnums(ndx_list, ndx_count);
+
+       free(ndx_list);
+       if (protocol_version < 30)
+               idev_destroy();
 }
 
-/* check if a file should be skipped because it is the same as an
-   earlier hard link */
-int check_hard_link(struct file_struct *file)
+static int maybe_hard_link(struct file_struct *file, int ndx,
+                          const char *fname, int statret, statx *sxp,
+                          const char *oldname, STRUCT_STAT *old_stp,
+                          const char *realname, int itemizing, enum logcode code)
 {
-#if SUPPORT_HARD_LINKS
-  int low=0,high=hlink_count-1;
-  int mid=0,ret=0;
-
-  if (!hlink_list || !S_ISREG(file->mode)) return 0;
-
-  while (low != high) {
-    mid = (low+high)/2;
-    ret = hlink_compare(&hlink_list[mid],file);
-    if (ret == 0) break;
-    if (ret > 0) 
-      high=mid;
-    else
-      low=mid+1;
-  }
-
-  if (hlink_compare(&hlink_list[mid],file) != 0) return 0;
-
-  if (mid > 0 &&
-      S_ISREG(hlink_list[mid-1].mode) &&
-      file->dev == hlink_list[mid-1].dev &&
-      file->inode == hlink_list[mid-1].inode)
-    return 1;
+       if (statret == 0) {
+               if (sxp->st.st_dev == old_stp->st_dev
+                && sxp->st.st_ino == old_stp->st_ino) {
+                       if (itemizing) {
+                               itemize(fname, file, ndx, statret, sxp,
+                                       ITEM_LOCAL_CHANGE | ITEM_XNAME_FOLLOWS,
+                                       0, "");
+                       }
+                       if (verbose > 1 && maybe_ATTRS_REPORT)
+                               rprintf(FCLIENT, "%s is uptodate\n", fname);
+                       file->flags |= FLAG_HLINK_DONE;
+                       return 0;
+               }
+               if (make_backups > 0) {
+                       if (!make_backup(fname))
+                               return -1;
+               } else if (robust_unlink(fname)) {
+                       rsyserr(FERROR, errno, "unlink %s failed",
+                               full_fname(fname));
+                       return -1;
+               }
+       }
+
+       if (hard_link_one(file, fname, oldname, 0)) {
+               if (itemizing) {
+                       itemize(fname, file, ndx, statret, sxp,
+                               ITEM_LOCAL_CHANGE | ITEM_XNAME_FOLLOWS, 0,
+                               realname);
+               }
+               if (code != FNONE && verbose)
+                       rprintf(code, "%s => %s\n", fname, realname);
+               return 0;
+       }
+       return -1;
+}
+
+/* Only called if FLAG_HLINKED is set and FLAG_HLINK_FIRST is not.  Returns:
+ * 0 = process the file, 1 = skip the file, -1 = error occurred. */
+int hard_link_check(struct file_struct *file, int ndx, const char *fname,
+                   int statret, statx *sxp, int itemizing,
+                   enum logcode code)
+{
+       STRUCT_STAT prev_st;
+       char prev_name[MAXPATHLEN], altbuf[MAXPATHLEN], *realname;
+       int alt_dest, prev_ndx = F_HL_PREV(file);
+       struct file_struct *prev_file = cur_flist->files[prev_ndx];
+
+       /* Is the previous link is not complete yet? */
+       if (!(prev_file->flags & FLAG_HLINK_DONE)) {
+               /* Is the previous link being transferred? */
+               if (prev_file->flags & FLAG_FILE_SENT) {
+                       /* Add ourselves to the list of files that will be
+                        * updated when the transfer completes, and mark
+                        * ourself as waiting for the transfer. */
+                       F_HL_PREV(file) = F_HL_PREV(prev_file);
+                       F_HL_PREV(prev_file) = ndx;
+                       file->flags |= FLAG_FILE_SENT;
+                       return 1;
+               }
+               return 0;
+       }
+
+       /* There is a finished file to link with! */
+       if (!(prev_file->flags & FLAG_HLINK_FIRST)) {
+               /* The previous previous will be marked with FIRST. */
+               prev_ndx = F_HL_PREV(prev_file);
+               prev_file = cur_flist->files[prev_ndx];
+               /* Update our previous pointer to point to the first. */
+               F_HL_PREV(file) = prev_ndx;
+       }
+       alt_dest = F_HL_PREV(prev_file); /* alternate value when DONE && FIRST */
+       if (alt_dest >= 0 && dry_run) {
+               pathjoin(prev_name, MAXPATHLEN, basis_dir[alt_dest],
+                        f_name(prev_file, NULL));
+               f_name(prev_file, altbuf);
+               realname = altbuf;
+       } else {
+               f_name(prev_file, prev_name);
+               realname = prev_name;
+       }
+
+       if (link_stat(prev_name, &prev_st, 0) < 0) {
+               rsyserr(FERROR, errno, "stat %s failed",
+                       full_fname(prev_name));
+               return -1;
+       }
+
+       if (statret < 0 && basis_dir[0] != NULL) {
+               /* If we match an alt-dest item, we don't output this as a change. */
+               char cmpbuf[MAXPATHLEN];
+               statx alt_sx;
+               int j = 0;
+#ifdef SUPPORT_ACLS
+               alt_sx.acc_acl = alt_sx.def_acl = NULL;
+#endif
+               do {
+                       pathjoin(cmpbuf, MAXPATHLEN, basis_dir[j], fname);
+                       if (link_stat(cmpbuf, &alt_sx.st, 0) < 0)
+                               continue;
+                       if (link_dest) {
+                               if (prev_st.st_dev != alt_sx.st.st_dev
+                                || prev_st.st_ino != alt_sx.st.st_ino)
+                                       continue;
+                               statret = 1;
+                               if (verbose < 2 || !stdout_format_has_i) {
+                                       itemizing = 0;
+                                       code = FNONE;
+                                       if (verbose > 1 && maybe_ATTRS_REPORT)
+                                               rprintf(FCLIENT, "%s is uptodate\n", fname);
+                               }
+                               break;
+                       }
+                       if (!unchanged_file(cmpbuf, file, &alt_sx.st))
+                               continue;
+                       statret = 1;
+                       if (unchanged_attrs(cmpbuf, file, &alt_sx))
+                               break;
+               } while (basis_dir[++j] != NULL);
+               if (statret == 1) {
+                       sxp->st = alt_sx.st;
+#ifdef SUPPORT_ACLS
+                       if (preserve_acls && !S_ISLNK(file->mode)) {
+                               if (!ACL_READY(*sxp))
+                                       get_acl(cmpbuf, sxp);
+                               else {
+                                       sxp->acc_acl = alt_sx.acc_acl;
+                                       sxp->def_acl = alt_sx.def_acl;
+                               }
+                       }
+#endif
+               }
+#ifdef SUPPORT_ACLS
+               else if (preserve_acls)
+                       free_acl(&alt_sx);
 #endif
+       }
+
+       if (maybe_hard_link(file, ndx, fname, statret, sxp, prev_name, &prev_st,
+                           realname, itemizing, code) < 0)
+               return -1;
+
+       if (remove_source_files == 1 && do_xfers)
+               send_msg_int(MSG_SUCCESS, ndx);
 
-  return 0;
+       return 1;
 }
 
+int hard_link_one(struct file_struct *file, const char *fname,
+                 const char *oldname, int terse)
+{
+       if (do_link(oldname, fname) < 0) {
+               enum logcode code;
+               if (terse) {
+                       if (!verbose)
+                               return -1;
+                       code = FINFO;
+               } else
+                       code = FERROR;
+               rsyserr(code, errno, "link %s => %s failed",
+                       full_fname(fname), oldname);
+               return 0;
+       }
+
+       file->flags |= FLAG_HLINK_DONE;
+
+       return 1;
+}
 
-/* create any hard links in the flist */
-void do_hard_links(struct file_list *flist)
+void finish_hard_link(struct file_struct *file, const char *fname,
+                     STRUCT_STAT *stp, int itemizing, enum logcode code,
+                     int alt_dest)
 {
-#if SUPPORT_HARD_LINKS
-  int i;
-  
-  if (!hlink_list) return;
-
-  for (i=1;i<hlink_count;i++) {
-    if (S_ISREG(hlink_list[i].mode) &&
-       S_ISREG(hlink_list[i-1].mode) &&
-       hlink_list[i].name && hlink_list[i-1].name &&
-       hlink_list[i].dev == hlink_list[i-1].dev &&
-       hlink_list[i].inode == hlink_list[i-1].inode) {
-      struct stat st1,st2;
-
-      if (link_stat(hlink_list[i-1].name,&st1) != 0) continue;
-      if (link_stat(hlink_list[i].name,&st2) != 0) {
-       if (!dry_run && link(hlink_list[i-1].name,hlink_list[i].name) != 0) {
-               if (verbose > 0)
-                       fprintf(FINFO,"link %s => %s : %s\n",
-                               hlink_list[i].name,
-                               hlink_list[i-1].name,strerror(errno));
-         continue;
-       }
-      } else {
-       if (st2.st_dev == st1.st_dev && st2.st_ino == st1.st_ino) continue;
-       
-       if (!dry_run && (unlink(hlink_list[i].name) != 0 ||
-                        link(hlink_list[i-1].name,hlink_list[i].name) != 0)) {
-               if (verbose > 0)
-                       fprintf(FINFO,"link %s => %s : %s\n",
-                               hlink_list[i].name,
-                               hlink_list[i-1].name,strerror(errno));
-         continue;
-       }
-      }
-      if (verbose > 0)
-             fprintf(FINFO,"%s => %s\n",
-                     hlink_list[i].name,hlink_list[i-1].name);
-    }  
-  }
+       statx prev_sx;
+       STRUCT_STAT st;
+       char alt_name[MAXPATHLEN], *prev_name;
+       const char *our_name;
+       int prev_statret, ndx, prev_ndx = F_HL_PREV(file);
+
+       if (stp == NULL && prev_ndx >= 0) {
+               if (link_stat(fname, &st, 0) < 0) {
+                       rsyserr(FERROR, errno, "stat %s failed",
+                               full_fname(fname));
+                       return;
+               }
+               stp = &st;
+       }
+
+       /* FIRST combined with DONE means we were the first to get done. */
+       file->flags |= FLAG_HLINK_FIRST | FLAG_HLINK_DONE;
+       F_HL_PREV(file) = alt_dest;
+       if (alt_dest >= 0 && dry_run) {
+               pathjoin(alt_name, MAXPATHLEN, basis_dir[alt_dest],
+                        f_name(file, NULL));
+               our_name = alt_name;
+       } else
+               our_name = fname;
+
+#ifdef SUPPORT_ACLS
+       prev_sx.acc_acl = prev_sx.def_acl = NULL;
+#endif
+
+       while ((ndx = prev_ndx) >= 0) {
+               int val;
+               file = cur_flist->files[ndx];
+               file->flags = (file->flags & ~FLAG_HLINK_FIRST) | FLAG_HLINK_DONE;
+               prev_ndx = F_HL_PREV(file);
+               prev_name = f_name(file, NULL);
+               prev_statret = link_stat(prev_name, &prev_sx.st, 0);
+               val = maybe_hard_link(file, ndx, prev_name, prev_statret, &prev_sx,
+                                     our_name, stp, fname, itemizing, code);
+#ifdef SUPPORT_ACLS
+               if (preserve_acls)
+                       free_acl(&prev_sx);
 #endif
+               if (val < 0)
+                       continue;
+               if (remove_source_files == 1 && do_xfers)
+                       send_msg_int(MSG_SUCCESS, ndx);
+       }
 }
+#endif