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-2007 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 char *basis_dir[];
38 extern struct file_list *cur_flist;
43 #ifdef SUPPORT_HARD_LINKS
45 /* Starting with protocol 30, we use a simple hashtable on the sending side
46 * for hashing the st_dev and st_ino info. The receiving side gets told
47 * (via flags and a "group index") which items are hard-linked together, so
48 * we can avoid the pool of dev+inode data. For incremental recursion mode,
49 * the receiver will use a ndx hash to remember old pathnames. */
51 static struct hashtable *dev_tbl;
53 static struct hashtable *prior_hlinks;
55 static struct file_list *hlink_flist;
57 void init_hard_links(void)
59 if (am_sender || protocol_version < 30)
60 dev_tbl = hashtable_create(16, SIZEOF_INT64 == 8);
62 prior_hlinks = hashtable_create(1024, 0);
65 struct ht_int64_node *idev_find(int64 dev, int64 ino)
67 static struct ht_int64_node *dev_node = NULL;
68 struct hashtable *tbl;
70 if (!dev_node || dev_node->key != dev) {
71 /* We keep a separate hash table of inodes for every device. */
72 dev_node = hashtable_find(dev_tbl, dev, 1);
73 if (!(tbl = dev_node->data))
74 tbl = dev_node->data = hashtable_create(512, SIZEOF_INT64 == 8);
78 return hashtable_find(tbl, ino, 1);
81 void idev_destroy(void)
85 for (i = 0; i < dev_tbl->size; i++) {
86 struct ht_int32_node *node = HT_NODE(dev_tbl, dev_tbl->nodes, i);
88 hashtable_destroy(node->data);
91 hashtable_destroy(dev_tbl);
94 static int hlink_compare_gnum(int *int1, int *int2)
96 struct file_struct *f1 = hlink_flist->sorted[*int1];
97 struct file_struct *f2 = hlink_flist->sorted[*int2];
98 int32 gnum1 = F_HL_GNUM(f1);
99 int32 gnum2 = F_HL_GNUM(f2);
102 return gnum1 > gnum2 ? 1 : -1;
104 return *int1 > *int2 ? 1 : -1;
107 static void match_gnums(int32 *ndx_list, int ndx_count)
110 struct file_struct *file, *file_next;
111 struct ht_int32_node *node = NULL;
112 int32 gnum, gnum_next;
114 qsort(ndx_list, ndx_count, sizeof ndx_list[0],
115 (int (*)()) hlink_compare_gnum);
117 for (from = 0; from < ndx_count; from++) {
118 file = hlink_flist->sorted[ndx_list[from]];
119 gnum = F_HL_GNUM(file);
121 node = hashtable_find(prior_hlinks, gnum, 1);
123 node->data = new_array0(char, 5);
124 assert(gnum >= hlink_flist->ndx_start);
125 file->flags |= FLAG_HLINK_FIRST;
127 } else if (CVAL(node->data, 0) == 0) {
128 struct file_list *flist;
129 struct file_struct *fp;
130 prev = IVAL(node->data, 1);
131 flist = flist_for_ndx(prev);
132 assert(flist != NULL);
133 fp = flist->files[prev - flist->ndx_start];
134 fp->flags &= ~FLAG_HLINK_LAST;
138 file->flags |= FLAG_HLINK_FIRST;
141 for ( ; from < ndx_count-1; file = file_next, gnum = gnum_next, from++) { /*SHARED ITERATOR*/
142 file_next = hlink_flist->sorted[ndx_list[from+1]];
143 gnum_next = F_HL_GNUM(file_next);
144 if (gnum != gnum_next)
146 F_HL_PREV(file) = prev;
147 /* The linked list must use raw 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) {
171 prev = ndx_list[from] + hlink_flist->ndx_start;
172 SIVAL(node->data, 1, prev);
177 /* Analyze the hard-links in the file-list by creating a list of all the
178 * items that have hlink data, sorting them, and matching up identical
179 * values into clusters. These will be a single linked list from last
180 * to first when we're done. */
181 void match_hard_links(struct file_list *flist)
183 int i, ndx_count = 0;
186 if (!(ndx_list = new_array(int32, flist->used)))
187 out_of_memory("match_hard_links");
189 for (i = 0; i < flist->used; i++) {
190 if (F_IS_HLINKED(flist->sorted[i]))
191 ndx_list[ndx_count++] = i;
197 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 (verbose > 1 && 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, 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 && verbose)
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. Never called with a FLAG_HLINK_FIRST entry. */
247 static char *check_prior(int prev_ndx, int gnum, struct file_list **flist_p)
249 struct file_list *flist = flist_for_ndx(prev_ndx);
250 struct ht_int32_node *node;
257 node = hashtable_find(prior_hlinks, gnum, 0);
258 assert(node != NULL && node->data);
259 assert(CVAL(node->data, 0) != 0);
263 /* Only called if FLAG_HLINKED is set and FLAG_HLINK_FIRST is not. Returns:
264 * 0 = process the file, 1 = skip the file, -1 = error occurred. */
265 int hard_link_check(struct file_struct *file, int ndx, const char *fname,
266 int statret, stat_x *sxp, int itemizing,
270 char namebuf[MAXPATHLEN], altbuf[MAXPATHLEN];
271 char *realname, *prev_name;
272 struct file_list *flist;
273 int gnum = inc_recurse ? F_HL_GNUM(file) : -1;
274 int prev_ndx = F_HL_PREV(file);
276 prev_name = realname = check_prior(prev_ndx, gnum, &flist);
279 struct file_struct *prev_file = flist->files[prev_ndx - flist->ndx_start];
281 /* Is the previous link is not complete yet? */
282 if (!(prev_file->flags & FLAG_HLINK_DONE)) {
283 /* Is the previous link being transferred? */
284 if (prev_file->flags & FLAG_FILE_SENT) {
285 /* Add ourselves to the list of files that will be
286 * updated when the transfer completes, and mark
287 * ourself as waiting for the transfer. */
288 F_HL_PREV(file) = F_HL_PREV(prev_file);
289 F_HL_PREV(prev_file) = ndx;
290 file->flags |= FLAG_FILE_SENT;
291 cur_flist->in_progress++;
297 /* There is a finished file to link with! */
298 if (!(prev_file->flags & FLAG_HLINK_FIRST)) {
299 /* The previous previous is FIRST when prev is not. */
300 prev_ndx = F_HL_PREV(prev_file);
301 prev_name = realname = check_prior(prev_ndx, gnum, &flist);
302 /* Update our previous pointer to point to the FIRST. */
303 F_HL_PREV(file) = prev_ndx;
309 prev_file = flist->files[prev_ndx - flist->ndx_start];
310 /* F_HL_PREV() is alt_dest value when DONE && FIRST. */
311 alt_dest = F_HL_PREV(prev_file);
313 if (alt_dest >= 0 && dry_run) {
314 pathjoin(namebuf, MAXPATHLEN, basis_dir[alt_dest],
315 f_name(prev_file, NULL));
317 realname = f_name(prev_file, altbuf);
319 prev_name = f_name(prev_file, namebuf);
320 realname = prev_name;
325 if (link_stat(prev_name, &prev_st, 0) < 0) {
326 rsyserr(FERROR, errno, "stat %s failed",
327 full_fname(prev_name));
331 if (statret < 0 && basis_dir[0] != NULL) {
332 /* If we match an alt-dest item, we don't output this as a change. */
333 char cmpbuf[MAXPATHLEN];
337 alt_sx.acc_acl = alt_sx.def_acl = NULL;
340 pathjoin(cmpbuf, MAXPATHLEN, basis_dir[j], fname);
341 if (link_stat(cmpbuf, &alt_sx.st, 0) < 0)
344 if (prev_st.st_dev != alt_sx.st.st_dev
345 || prev_st.st_ino != alt_sx.st.st_ino)
348 if (stdout_format_has_i == 0
349 || (verbose < 2 && stdout_format_has_i < 2)) {
352 if (verbose > 1 && maybe_ATTRS_REPORT)
353 rprintf(FCLIENT, "%s is uptodate\n", fname);
357 if (!unchanged_file(cmpbuf, file, &alt_sx.st))
360 if (unchanged_attrs(cmpbuf, file, &alt_sx))
362 } while (basis_dir[++j] != NULL);
366 if (preserve_acls && !S_ISLNK(file->mode)) {
367 if (!ACL_READY(*sxp))
368 get_acl(cmpbuf, sxp);
370 sxp->acc_acl = alt_sx.acc_acl;
371 sxp->def_acl = alt_sx.def_acl;
377 else if (preserve_acls)
382 if (maybe_hard_link(file, ndx, fname, statret, sxp, prev_name, &prev_st,
383 realname, itemizing, code) < 0)
386 if (remove_source_files == 1 && do_xfers)
387 send_msg_int(MSG_SUCCESS, ndx);
392 int hard_link_one(struct file_struct *file, const char *fname,
393 const char *oldname, int terse)
395 if (do_link(oldname, fname) < 0) {
403 rsyserr(code, errno, "link %s => %s failed",
404 full_fname(fname), oldname);
408 file->flags |= FLAG_HLINK_DONE;
413 void finish_hard_link(struct file_struct *file, const char *fname, int fin_ndx,
414 STRUCT_STAT *stp, int itemizing, enum logcode code,
419 char alt_name[MAXPATHLEN], *prev_name;
420 const char *our_name;
421 struct file_list *flist;
422 int prev_statret, ndx, prev_ndx = F_HL_PREV(file);
424 if (stp == NULL && prev_ndx >= 0) {
425 if (link_stat(fname, &st, 0) < 0) {
426 rsyserr(FERROR, errno, "stat %s failed",
433 /* FIRST combined with DONE means we were the first to get done. */
434 file->flags |= FLAG_HLINK_FIRST | FLAG_HLINK_DONE;
435 F_HL_PREV(file) = alt_dest;
436 if (alt_dest >= 0 && dry_run) {
437 pathjoin(alt_name, MAXPATHLEN, basis_dir[alt_dest],
444 prev_sx.acc_acl = prev_sx.def_acl = NULL;
447 while ((ndx = prev_ndx) >= 0) {
449 flist = flist_for_ndx(ndx);
450 assert(flist != NULL);
451 file = flist->files[ndx - flist->ndx_start];
452 file->flags = (file->flags & ~FLAG_HLINK_FIRST) | FLAG_HLINK_DONE;
453 prev_ndx = F_HL_PREV(file);
454 F_HL_PREV(file) = fin_ndx;
455 prev_name = f_name(file, NULL);
456 prev_statret = link_stat(prev_name, &prev_sx.st, 0);
457 val = maybe_hard_link(file, ndx, prev_name, prev_statret, &prev_sx,
458 our_name, stp, fname, itemizing, code);
459 flist->in_progress--;
466 if (remove_source_files == 1 && do_xfers)
467 send_msg_int(MSG_SUCCESS, ndx);
471 int gnum = F_HL_GNUM(file);
472 struct ht_int32_node *node = hashtable_find(prior_hlinks, gnum, 0);
473 assert(node != NULL && node->data != NULL);
474 assert(CVAL(node->data, 0) == 0);
476 if (!(node->data = strdup(our_name)))
477 out_of_memory("finish_hard_link");