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[MAX_BASIS_DIRS+1];
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);
73 if (DEBUG_GTE(HLINK, 3)) {
75 "[%s] created hashtable for dev %s\n",
76 who_am_i(), big_num(dev, 0));
82 return hashtable_find(tbl, ino, 1);
85 void idev_destroy(void)
89 for (i = 0; i < dev_tbl->size; i++) {
90 struct ht_int32_node *node = HT_NODE(dev_tbl, dev_tbl->nodes, i);
92 hashtable_destroy(node->data);
95 hashtable_destroy(dev_tbl);
98 static int hlink_compare_gnum(int *int1, int *int2)
100 struct file_struct *f1 = hlink_flist->sorted[*int1];
101 struct file_struct *f2 = hlink_flist->sorted[*int2];
102 int32 gnum1 = F_HL_GNUM(f1);
103 int32 gnum2 = F_HL_GNUM(f2);
106 return gnum1 > gnum2 ? 1 : -1;
108 return *int1 > *int2 ? 1 : -1;
111 static void match_gnums(int32 *ndx_list, int ndx_count)
114 struct file_struct *file, *file_next;
115 struct ht_int32_node *node = NULL;
116 int32 gnum, gnum_next;
118 qsort(ndx_list, ndx_count, sizeof ndx_list[0],
119 (int (*)()) hlink_compare_gnum);
121 for (from = 0; from < ndx_count; from++) {
122 file = hlink_flist->sorted[ndx_list[from]];
123 gnum = F_HL_GNUM(file);
125 node = hashtable_find(prior_hlinks, gnum, 1);
127 node->data = new_array0(char, 5);
128 assert(gnum >= hlink_flist->ndx_start);
129 file->flags |= FLAG_HLINK_FIRST;
131 } else if (CVAL(node->data, 0) == 0) {
132 struct file_list *flist;
133 prev = IVAL(node->data, 1);
134 flist = flist_for_ndx(prev);
136 flist->files[prev - flist->ndx_start]->flags &= ~FLAG_HLINK_LAST;
138 /* We skipped all prior files in this
139 * group, so mark this as a "first". */
140 file->flags |= FLAG_HLINK_FIRST;
146 file->flags |= FLAG_HLINK_FIRST;
149 for ( ; from < ndx_count-1; file = file_next, gnum = gnum_next, from++) { /*SHARED ITERATOR*/
150 file_next = hlink_flist->sorted[ndx_list[from+1]];
151 gnum_next = F_HL_GNUM(file_next);
152 if (gnum != gnum_next)
154 F_HL_PREV(file) = prev;
155 /* The linked list uses over-the-wire ndx values. */
159 prev = ndx_list[from] + hlink_flist->ndx_start;
161 if (prev < 0 && !inc_recurse) {
162 /* Disable hard-link bit and set DONE so that
163 * HLINK_BUMP()-dependent values are unaffected. */
164 file->flags &= ~(FLAG_HLINKED | FLAG_HLINK_FIRST);
165 file->flags |= FLAG_HLINK_DONE;
169 file->flags |= FLAG_HLINK_LAST;
170 F_HL_PREV(file) = prev;
171 if (inc_recurse && CVAL(node->data, 0) == 0) {
175 prev = ndx_list[from] + hlink_flist->ndx_start;
176 SIVAL(node->data, 1, prev);
181 /* Analyze the hard-links in the file-list by creating a list of all the
182 * items that have hlink data, sorting them, and matching up identical
183 * values into clusters. These will be a single linked list from last
184 * to first when we're done. */
185 void match_hard_links(struct file_list *flist)
187 if (!list_only && flist->used) {
188 int i, ndx_count = 0;
191 if (!(ndx_list = new_array(int32, flist->used)))
192 out_of_memory("match_hard_links");
194 for (i = 0; i < flist->used; i++) {
195 if (F_IS_HLINKED(flist->sorted[i]))
196 ndx_list[ndx_count++] = i;
202 match_gnums(ndx_list, ndx_count);
206 if (protocol_version < 30)
210 static int maybe_hard_link(struct file_struct *file, int ndx,
211 const char *fname, int statret, stat_x *sxp,
212 const char *oldname, STRUCT_STAT *old_stp,
213 const char *realname, int itemizing, enum logcode code)
216 if (sxp->st.st_dev == old_stp->st_dev
217 && sxp->st.st_ino == old_stp->st_ino) {
219 itemize(fname, file, ndx, statret, sxp,
220 ITEM_LOCAL_CHANGE | ITEM_XNAME_FOLLOWS,
223 if (INFO_GTE(NAME, 2) && maybe_ATTRS_REPORT)
224 rprintf(FCLIENT, "%s is uptodate\n", fname);
225 file->flags |= FLAG_HLINK_DONE;
228 if (make_backups > 0) {
229 if (!make_backup(fname))
231 } else if (robust_unlink(fname)) {
232 rsyserr(FERROR_XFER, errno, "unlink %s failed",
238 if (hard_link_one(file, fname, oldname, 0)) {
240 itemize(fname, file, ndx, statret, sxp,
241 ITEM_LOCAL_CHANGE | ITEM_XNAME_FOLLOWS, 0,
244 if (code != FNONE && INFO_GTE(NAME, 1))
245 rprintf(code, "%s => %s\n", fname, realname);
251 /* Figure out if a prior entry is still there or if we just have a
252 * cached name for it. */
253 static char *check_prior(struct file_struct *file, int gnum,
254 int *prev_ndx_p, struct file_list **flist_p)
256 struct file_struct *fp;
257 struct ht_int32_node *node;
258 int prev_ndx = F_HL_PREV(file);
261 struct file_list *flist;
263 || (flist = flist_for_ndx(prev_ndx)) == NULL)
265 fp = flist->files[prev_ndx - flist->ndx_start];
266 if (!(fp->flags & FLAG_SKIP_HLINK)) {
267 *prev_ndx_p = prev_ndx;
271 F_HL_PREV(file) = prev_ndx = F_HL_PREV(fp);
275 && (node = hashtable_find(prior_hlinks, gnum, 0)) != NULL) {
276 assert(node->data != NULL);
277 if (CVAL(node->data, 0) != 0) {
282 /* The prior file must have been skipped. */
283 F_HL_PREV(file) = -1;
291 /* Only called if FLAG_HLINKED is set and FLAG_HLINK_FIRST is not. Returns:
292 * 0 = process the file, 1 = skip the file, -1 = error occurred. */
293 int hard_link_check(struct file_struct *file, int ndx, const char *fname,
294 int statret, stat_x *sxp, int itemizing,
298 char namebuf[MAXPATHLEN], altbuf[MAXPATHLEN];
299 char *realname, *prev_name;
300 struct file_list *flist;
301 int gnum = inc_recurse ? F_HL_GNUM(file) : -1;
304 prev_name = realname = check_prior(file, gnum, &prev_ndx, &flist);
307 struct file_struct *prev_file;
310 /* The previous file was skipped, so this one is
311 * treated as if it were the first in its group. */
312 if (DEBUG_GTE(HLINK, 2)) {
313 rprintf(FINFO, "hlink for %d (%s,%d): virtual first\n",
314 ndx, f_name(file, NULL), gnum);
319 prev_file = flist->files[prev_ndx - flist->ndx_start];
321 /* Is the previous link not complete yet? */
322 if (!(prev_file->flags & FLAG_HLINK_DONE)) {
323 /* Is the previous link being transferred? */
324 if (prev_file->flags & FLAG_FILE_SENT) {
325 /* Add ourselves to the list of files that will
326 * be updated when the transfer completes, and
327 * mark ourself as waiting for the transfer. */
328 F_HL_PREV(file) = F_HL_PREV(prev_file);
329 F_HL_PREV(prev_file) = ndx;
330 file->flags |= FLAG_FILE_SENT;
331 cur_flist->in_progress++;
332 if (DEBUG_GTE(HLINK, 2)) {
333 rprintf(FINFO, "hlink for %d (%s,%d): waiting for %d\n",
334 ndx, f_name(file, NULL), gnum, F_HL_PREV(file));
338 if (DEBUG_GTE(HLINK, 2)) {
339 rprintf(FINFO, "hlink for %d (%s,%d): looking for a leader\n",
340 ndx, f_name(file, NULL), gnum);
345 /* There is a finished file to link with! */
346 if (!(prev_file->flags & FLAG_HLINK_FIRST)) {
347 /* The previous previous is FIRST when prev is not. */
348 prev_name = realname = check_prior(prev_file, gnum, &prev_ndx, &flist);
349 /* Update our previous pointer to point to the FIRST. */
350 F_HL_PREV(file) = prev_ndx;
356 assert(flist != NULL);
357 prev_file = flist->files[prev_ndx - flist->ndx_start];
358 /* F_HL_PREV() is alt_dest value when DONE && FIRST. */
359 alt_dest = F_HL_PREV(prev_file);
360 if (DEBUG_GTE(HLINK, 2)) {
361 rprintf(FINFO, "hlink for %d (%s,%d): found flist match (alt %d)\n",
362 ndx, f_name(file, NULL), gnum, alt_dest);
365 if (alt_dest >= 0 && dry_run) {
366 pathjoin(namebuf, MAXPATHLEN, basis_dir[alt_dest],
367 f_name(prev_file, NULL));
369 realname = f_name(prev_file, altbuf);
371 prev_name = f_name(prev_file, namebuf);
372 realname = prev_name;
377 if (DEBUG_GTE(HLINK, 2)) {
378 rprintf(FINFO, "hlink for %d (%s,%d): leader is %d (%s)\n",
379 ndx, f_name(file, NULL), gnum, prev_ndx, prev_name);
382 if (link_stat(prev_name, &prev_st, 0) < 0) {
383 rsyserr(FERROR_XFER, errno, "stat %s failed",
384 full_fname(prev_name));
388 if (statret < 0 && basis_dir[0] != NULL) {
389 /* If we match an alt-dest item, we don't output this as a change. */
390 char cmpbuf[MAXPATHLEN];
394 alt_sx.acc_acl = alt_sx.def_acl = NULL;
397 pathjoin(cmpbuf, MAXPATHLEN, basis_dir[j], fname);
398 if (link_stat(cmpbuf, &alt_sx.st, 0) < 0)
401 if (prev_st.st_dev != alt_sx.st.st_dev
402 || prev_st.st_ino != alt_sx.st.st_ino)
405 if (stdout_format_has_i == 0
406 || (!INFO_GTE(NAME, 2) && stdout_format_has_i < 2)) {
409 if (INFO_GTE(NAME, 2) && maybe_ATTRS_REPORT)
410 rprintf(FCLIENT, "%s is uptodate\n", fname);
414 if (!unchanged_file(cmpbuf, file, &alt_sx.st))
417 if (unchanged_attrs(cmpbuf, file, &alt_sx))
419 } while (basis_dir[++j] != NULL);
423 if (preserve_acls && !S_ISLNK(file->mode)) {
424 if (!ACL_READY(*sxp))
425 get_acl(cmpbuf, sxp);
427 sxp->acc_acl = alt_sx.acc_acl;
428 sxp->def_acl = alt_sx.def_acl;
434 else if (preserve_acls)
439 if (maybe_hard_link(file, ndx, fname, statret, sxp, prev_name, &prev_st,
440 realname, itemizing, code) < 0)
443 if (remove_source_files == 1 && do_xfers)
444 send_msg_int(MSG_SUCCESS, ndx);
449 int hard_link_one(struct file_struct *file, const char *fname,
450 const char *oldname, int terse)
452 if (do_link(oldname, fname) < 0) {
455 if (!INFO_GTE(NAME, 1))
460 rsyserr(code, errno, "link %s => %s failed",
461 full_fname(fname), oldname);
465 file->flags |= FLAG_HLINK_DONE;
470 void finish_hard_link(struct file_struct *file, const char *fname, int fin_ndx,
471 STRUCT_STAT *stp, int itemizing, enum logcode code,
476 char prev_name[MAXPATHLEN], alt_name[MAXPATHLEN];
477 const char *our_name;
478 struct file_list *flist;
479 int prev_statret, ndx, prev_ndx = F_HL_PREV(file);
481 if (stp == NULL && prev_ndx >= 0) {
482 if (link_stat(fname, &st, 0) < 0) {
483 rsyserr(FERROR_XFER, errno, "stat %s failed",
490 /* FIRST combined with DONE means we were the first to get done. */
491 file->flags |= FLAG_HLINK_FIRST | FLAG_HLINK_DONE;
492 F_HL_PREV(file) = alt_dest;
493 if (alt_dest >= 0 && dry_run) {
494 pathjoin(alt_name, MAXPATHLEN, basis_dir[alt_dest],
501 prev_sx.acc_acl = prev_sx.def_acl = NULL;
504 while ((ndx = prev_ndx) >= 0) {
506 flist = flist_for_ndx(ndx);
508 int start1 = first_flist ? first_flist->ndx_start : 0;
509 int start2 = first_flist ? first_flist->prev->ndx_start : 0;
510 int used = first_flist ? first_flist->prev->used : 0;
512 "File index not found: %d (%d - %d)\n",
513 ndx, start1 - 1, start2 + used - 1);
514 exit_cleanup(RERR_PROTOCOL);
516 file = flist->files[ndx - flist->ndx_start];
517 file->flags = (file->flags & ~FLAG_HLINK_FIRST) | FLAG_HLINK_DONE;
518 prev_ndx = F_HL_PREV(file);
519 F_HL_PREV(file) = fin_ndx;
520 prev_statret = link_stat(f_name(file, prev_name), &prev_sx.st, 0);
521 val = maybe_hard_link(file, ndx, prev_name, prev_statret, &prev_sx,
522 our_name, stp, fname, itemizing, code);
523 flist->in_progress--;
530 if (remove_source_files == 1 && do_xfers)
531 send_msg_int(MSG_SUCCESS, ndx);
535 int gnum = F_HL_GNUM(file);
536 struct ht_int32_node *node = hashtable_find(prior_hlinks, gnum, 0);
537 assert(node != NULL && node->data != NULL);
538 assert(CVAL(node->data, 0) == 0);
540 if (!(node->data = strdup(our_name)))
541 out_of_memory("finish_hard_link");
545 int skip_hard_link(struct file_struct *file, struct file_list **flist_p)
547 struct file_list *flist;
550 file->flags |= FLAG_SKIP_HLINK;
551 if (!(file->flags & FLAG_HLINK_LAST))
554 check_prior(file, F_HL_GNUM(file), &prev_ndx, &flist);
556 file = flist->files[prev_ndx - flist->ndx_start];
557 if (file->flags & (FLAG_HLINK_DONE|FLAG_FILE_SENT))
559 file->flags |= FLAG_HLINK_LAST;