2 * Routines to support hard-linking.
4 * Copyright (C) 1996 Andrew Tridgell
5 * Copyright (C) 1996 Paul Mackerras
6 * Copyright (C) 2002 Martin Pool <mbp@samba.org>
7 * Copyright (C) 2004-2008 Wayne Davison
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, visit the http://fsf.org website.
28 extern int inc_recurse;
31 extern int preserve_acls;
32 extern int make_backups;
33 extern int protocol_version;
34 extern int remove_source_files;
35 extern int stdout_format_has_i;
36 extern int maybe_ATTRS_REPORT;
37 extern int unsort_ndx;
38 extern char *basis_dir[];
39 extern struct file_list *cur_flist, *first_flist;
41 #ifdef SUPPORT_HARD_LINKS
43 /* Starting with protocol 30, we use a simple hashtable on the sending side
44 * for hashing the st_dev and st_ino info. The receiving side gets told
45 * (via flags and a "group index") which items are hard-linked together, so
46 * we can avoid the pool of dev+inode data. For incremental recursion mode,
47 * the receiver will use a ndx hash to remember old pathnames. */
49 static struct hashtable *dev_tbl;
51 static struct hashtable *prior_hlinks;
53 static struct file_list *hlink_flist;
55 void init_hard_links(void)
57 if (am_sender || protocol_version < 30)
58 dev_tbl = hashtable_create(16, SIZEOF_INT64 == 8);
60 prior_hlinks = hashtable_create(1024, 0);
63 struct ht_int64_node *idev_find(int64 dev, int64 ino)
65 static struct ht_int64_node *dev_node = NULL;
66 struct hashtable *tbl;
68 if (!dev_node || dev_node->key != dev) {
69 /* We keep a separate hash table of inodes for every device. */
70 dev_node = hashtable_find(dev_tbl, dev, 1);
71 if (!(tbl = dev_node->data))
72 tbl = dev_node->data = hashtable_create(512, SIZEOF_INT64 == 8);
76 return hashtable_find(tbl, ino, 1);
79 void idev_destroy(void)
83 for (i = 0; i < dev_tbl->size; i++) {
84 struct ht_int32_node *node = HT_NODE(dev_tbl, dev_tbl->nodes, i);
86 hashtable_destroy(node->data);
89 hashtable_destroy(dev_tbl);
92 static int hlink_compare_gnum(int *int1, int *int2)
94 struct file_struct *f1 = hlink_flist->sorted[*int1];
95 struct file_struct *f2 = hlink_flist->sorted[*int2];
96 int32 gnum1 = F_HL_GNUM(f1);
97 int32 gnum2 = F_HL_GNUM(f2);
100 return gnum1 > gnum2 ? 1 : -1;
102 return *int1 > *int2 ? 1 : -1;
105 static void match_gnums(int32 *ndx_list, int ndx_count)
108 struct file_struct *file, *file_next;
109 struct ht_int32_node *node = NULL;
110 int32 gnum, gnum_next;
112 qsort(ndx_list, ndx_count, sizeof ndx_list[0],
113 (int (*)()) hlink_compare_gnum);
115 for (from = 0; from < ndx_count; from++) {
116 file = hlink_flist->sorted[ndx_list[from]];
117 gnum = F_HL_GNUM(file);
119 node = hashtable_find(prior_hlinks, gnum, 1);
121 node->data = new_array0(char, 5);
122 assert(gnum >= hlink_flist->ndx_start);
123 file->flags |= FLAG_HLINK_FIRST;
125 } else if (CVAL(node->data, 0) == 0) {
126 struct file_list *flist;
127 prev = IVAL(node->data, 1);
128 flist = flist_for_ndx(prev);
130 flist->files[prev - flist->ndx_start]->flags &= ~FLAG_HLINK_LAST;
132 /* We skipped all prior files in this
133 * group, so mark this as a "first". */
134 file->flags |= FLAG_HLINK_FIRST;
140 file->flags |= FLAG_HLINK_FIRST;
143 for ( ; from < ndx_count-1; file = file_next, gnum = gnum_next, from++) { /*SHARED ITERATOR*/
144 file_next = hlink_flist->sorted[ndx_list[from+1]];
145 gnum_next = F_HL_GNUM(file_next);
146 if (gnum != gnum_next)
148 F_HL_PREV(file) = prev;
149 /* The linked list uses over-the-wire ndx values. */
153 prev = ndx_list[from] + hlink_flist->ndx_start;
155 if (prev < 0 && !inc_recurse) {
156 /* Disable hard-link bit and set DONE so that
157 * HLINK_BUMP()-dependent values are unaffected. */
158 file->flags &= ~(FLAG_HLINKED | FLAG_HLINK_FIRST);
159 file->flags |= FLAG_HLINK_DONE;
163 file->flags |= FLAG_HLINK_LAST;
164 F_HL_PREV(file) = prev;
165 if (inc_recurse && CVAL(node->data, 0) == 0) {
169 prev = ndx_list[from] + hlink_flist->ndx_start;
170 SIVAL(node->data, 1, prev);
175 /* Analyze the hard-links in the file-list by creating a list of all the
176 * items that have hlink data, sorting them, and matching up identical
177 * values into clusters. These will be a single linked list from last
178 * to first when we're done. */
179 void match_hard_links(struct file_list *flist)
182 int i, ndx_count = 0;
185 if (!(ndx_list = new_array(int32, flist->used)))
186 out_of_memory("match_hard_links");
188 for (i = 0; i < flist->used; i++) {
189 if (F_IS_HLINKED(flist->sorted[i]))
190 ndx_list[ndx_count++] = i;
196 match_gnums(ndx_list, ndx_count);
200 if (protocol_version < 30)
204 static int maybe_hard_link(struct file_struct *file, int ndx,
205 const char *fname, int statret, stat_x *sxp,
206 const char *oldname, STRUCT_STAT *old_stp,
207 const char *realname, int itemizing, enum logcode code)
210 if (sxp->st.st_dev == old_stp->st_dev
211 && sxp->st.st_ino == old_stp->st_ino) {
213 itemize(fname, file, ndx, statret, sxp,
214 ITEM_LOCAL_CHANGE | ITEM_XNAME_FOLLOWS,
217 if (INFO_GTE(NAME, 2) && maybe_ATTRS_REPORT)
218 rprintf(FCLIENT, "%s is uptodate\n", fname);
219 file->flags |= FLAG_HLINK_DONE;
222 if (make_backups > 0) {
223 if (!make_backup(fname))
225 } else if (robust_unlink(fname)) {
226 rsyserr(FERROR_XFER, errno, "unlink %s failed",
232 if (hard_link_one(file, fname, oldname, 0)) {
234 itemize(fname, file, ndx, statret, sxp,
235 ITEM_LOCAL_CHANGE | ITEM_XNAME_FOLLOWS, 0,
238 if (code != FNONE && INFO_GTE(NAME, 1))
239 rprintf(code, "%s => %s\n", fname, realname);
245 /* Figure out if a prior entry is still there or if we just have a
246 * cached name for it. */
247 static char *check_prior(struct file_struct *file, int gnum,
248 int *prev_ndx_p, struct file_list **flist_p)
250 struct file_struct *fp;
251 struct ht_int32_node *node;
252 int prev_ndx = F_HL_PREV(file);
255 struct file_list *flist;
257 || (flist = flist_for_ndx(prev_ndx)) == NULL)
259 fp = flist->files[prev_ndx - flist->ndx_start];
260 if (!(fp->flags & FLAG_SKIP_HLINK)) {
261 *prev_ndx_p = prev_ndx;
265 F_HL_PREV(file) = prev_ndx = F_HL_PREV(fp);
269 && (node = hashtable_find(prior_hlinks, gnum, 0)) != NULL) {
270 assert(node->data != NULL);
271 if (CVAL(node->data, 0) != 0) {
276 /* The prior file must have been skipped. */
277 F_HL_PREV(file) = -1;
285 /* Only called if FLAG_HLINKED is set and FLAG_HLINK_FIRST is not. Returns:
286 * 0 = process the file, 1 = skip the file, -1 = error occurred. */
287 int hard_link_check(struct file_struct *file, int ndx, const char *fname,
288 int statret, stat_x *sxp, int itemizing,
292 char namebuf[MAXPATHLEN], altbuf[MAXPATHLEN];
293 char *realname, *prev_name;
294 struct file_list *flist;
295 int gnum = inc_recurse ? F_HL_GNUM(file) : -1;
298 prev_name = realname = check_prior(file, gnum, &prev_ndx, &flist);
301 struct file_struct *prev_file;
304 /* The previous file was skipped, so this one is
305 * treated as if it were the first in its group. */
309 prev_file = flist->files[prev_ndx - flist->ndx_start];
311 /* Is the previous link not complete yet? */
312 if (!(prev_file->flags & FLAG_HLINK_DONE)) {
313 /* Is the previous link being transferred? */
314 if (prev_file->flags & FLAG_FILE_SENT) {
315 /* Add ourselves to the list of files that will
316 * be updated when the transfer completes, and
317 * mark ourself as waiting for the transfer. */
318 F_HL_PREV(file) = F_HL_PREV(prev_file);
319 F_HL_PREV(prev_file) = ndx;
320 file->flags |= FLAG_FILE_SENT;
321 cur_flist->in_progress++;
327 /* There is a finished file to link with! */
328 if (!(prev_file->flags & FLAG_HLINK_FIRST)) {
329 /* The previous previous is FIRST when prev is not. */
330 prev_name = realname = check_prior(prev_file, gnum, &prev_ndx, &flist);
331 assert(prev_name != NULL || flist != NULL);
332 /* Update our previous pointer to point to the FIRST. */
333 F_HL_PREV(file) = prev_ndx;
339 prev_file = flist->files[prev_ndx - flist->ndx_start];
340 /* F_HL_PREV() is alt_dest value when DONE && FIRST. */
341 alt_dest = F_HL_PREV(prev_file);
343 if (alt_dest >= 0 && dry_run) {
344 pathjoin(namebuf, MAXPATHLEN, basis_dir[alt_dest],
345 f_name(prev_file, NULL));
347 realname = f_name(prev_file, altbuf);
349 prev_name = f_name(prev_file, namebuf);
350 realname = prev_name;
355 if (link_stat(prev_name, &prev_st, 0) < 0) {
356 rsyserr(FERROR_XFER, errno, "stat %s failed",
357 full_fname(prev_name));
361 if (statret < 0 && basis_dir[0] != NULL) {
362 /* If we match an alt-dest item, we don't output this as a change. */
363 char cmpbuf[MAXPATHLEN];
367 alt_sx.acc_acl = alt_sx.def_acl = NULL;
370 pathjoin(cmpbuf, MAXPATHLEN, basis_dir[j], fname);
371 if (link_stat(cmpbuf, &alt_sx.st, 0) < 0)
374 if (prev_st.st_dev != alt_sx.st.st_dev
375 || prev_st.st_ino != alt_sx.st.st_ino)
378 if (stdout_format_has_i == 0
379 || (!INFO_GTE(NAME, 2) && stdout_format_has_i < 2)) {
382 if (INFO_GTE(NAME, 2) && maybe_ATTRS_REPORT)
383 rprintf(FCLIENT, "%s is uptodate\n", fname);
387 if (!unchanged_file(cmpbuf, file, &alt_sx.st))
390 if (unchanged_attrs(cmpbuf, file, &alt_sx))
392 } while (basis_dir[++j] != NULL);
396 if (preserve_acls && !S_ISLNK(file->mode)) {
397 if (!ACL_READY(*sxp))
398 get_acl(cmpbuf, sxp);
400 sxp->acc_acl = alt_sx.acc_acl;
401 sxp->def_acl = alt_sx.def_acl;
407 else if (preserve_acls)
412 if (maybe_hard_link(file, ndx, fname, statret, sxp, prev_name, &prev_st,
413 realname, itemizing, code) < 0)
416 if (remove_source_files == 1 && do_xfers)
417 send_msg_int(MSG_SUCCESS, ndx);
422 int hard_link_one(struct file_struct *file, const char *fname,
423 const char *oldname, int terse)
425 if (do_link(oldname, fname) < 0) {
428 if (!INFO_GTE(NAME, 1))
433 rsyserr(code, errno, "link %s => %s failed",
434 full_fname(fname), oldname);
438 file->flags |= FLAG_HLINK_DONE;
443 void finish_hard_link(struct file_struct *file, const char *fname, int fin_ndx,
444 STRUCT_STAT *stp, int itemizing, enum logcode code,
449 char prev_name[MAXPATHLEN], alt_name[MAXPATHLEN];
450 const char *our_name;
451 struct file_list *flist;
452 int prev_statret, ndx, prev_ndx = F_HL_PREV(file);
454 if (stp == NULL && prev_ndx >= 0) {
455 if (link_stat(fname, &st, 0) < 0) {
456 rsyserr(FERROR_XFER, errno, "stat %s failed",
463 /* FIRST combined with DONE means we were the first to get done. */
464 file->flags |= FLAG_HLINK_FIRST | FLAG_HLINK_DONE;
465 F_HL_PREV(file) = alt_dest;
466 if (alt_dest >= 0 && dry_run) {
467 pathjoin(alt_name, MAXPATHLEN, basis_dir[alt_dest],
474 prev_sx.acc_acl = prev_sx.def_acl = NULL;
477 while ((ndx = prev_ndx) >= 0) {
479 flist = flist_for_ndx(ndx);
481 int start1 = first_flist ? first_flist->ndx_start : 0;
482 int start2 = first_flist ? first_flist->prev->ndx_start : 0;
483 int used = first_flist ? first_flist->prev->used : 0;
485 "File index not found: %d (%d - %d)\n",
486 ndx, start1 - 1, start2 + used - 1);
487 exit_cleanup(RERR_PROTOCOL);
489 file = flist->files[ndx - flist->ndx_start];
490 file->flags = (file->flags & ~FLAG_HLINK_FIRST) | FLAG_HLINK_DONE;
491 prev_ndx = F_HL_PREV(file);
492 F_HL_PREV(file) = fin_ndx;
493 prev_statret = link_stat(f_name(file, prev_name), &prev_sx.st, 0);
494 val = maybe_hard_link(file, ndx, prev_name, prev_statret, &prev_sx,
495 our_name, stp, fname, itemizing, code);
496 flist->in_progress--;
503 if (remove_source_files == 1 && do_xfers)
504 send_msg_int(MSG_SUCCESS, ndx);
508 int gnum = F_HL_GNUM(file);
509 struct ht_int32_node *node = hashtable_find(prior_hlinks, gnum, 0);
510 assert(node != NULL && node->data != NULL);
511 assert(CVAL(node->data, 0) == 0);
513 if (!(node->data = strdup(our_name)))
514 out_of_memory("finish_hard_link");
518 int skip_hard_link(struct file_struct *file, struct file_list **flist_p)
520 struct file_list *flist;
523 file->flags |= FLAG_SKIP_HLINK;
524 if (!(file->flags & FLAG_HLINK_LAST))
527 check_prior(file, F_HL_GNUM(file), &prev_ndx, &flist);
529 file = flist->files[prev_ndx - flist->ndx_start];
530 if (file->flags & (FLAG_HLINK_DONE|FLAG_FILE_SENT))
532 file->flags |= FLAG_HLINK_LAST;