2 Copyright (C) Andrew Tridgell 1996
3 Copyright (C) Paul Mackerras 1996
4 Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 * Generate and receive file lists
24 * @sa http://lists.samba.org/pipermail/rsync/2000-June/002351.html
37 extern int do_progress;
38 extern int always_checksum;
40 extern int ignore_errors;
41 extern int numeric_ids;
44 extern int filesfrom_fd;
45 extern int one_file_system;
46 extern int keep_dirlinks;
47 extern int preserve_links;
48 extern int preserve_hard_links;
49 extern int preserve_perms;
50 extern int preserve_devices;
51 extern int preserve_uid;
52 extern int preserve_gid;
53 extern int relative_paths;
54 extern int implied_dirs;
55 extern int copy_links;
56 extern int copy_unsafe_links;
57 extern int protocol_version;
58 extern int sanitize_paths;
59 extern int orig_umask;
60 extern struct stats stats;
61 extern struct file_list *the_file_list;
63 extern char curr_dir[MAXPATHLEN];
65 extern struct chmod_mode_struct *chmod_modes;
67 extern struct filter_list_struct filter_list;
68 extern struct filter_list_struct server_filter_list;
72 dev_t filesystem_dev; /* used to implement -x */
74 static char empty_sum[MD4_SUM_LENGTH];
75 static int flist_count_offset;
76 static unsigned int file_struct_len;
77 static struct file_list *sorting_flist;
79 static void clean_flist(struct file_list *flist, int strip_root, int no_dups);
80 static void output_flist(struct file_list *flist);
86 /* Figure out how big the file_struct is without trailing padding */
87 file_struct_len = offsetof(struct file_struct, flags) + sizeof f.flags;
88 checksum_len = protocol_version < 21 ? 2 : MD4_SUM_LENGTH;
91 static int show_filelist_p(void)
93 return verbose && xfer_dirs && !am_server;
96 static void start_filelist_progress(char *kind)
98 rprintf(FINFO, "%s ... ", kind);
99 if (verbose > 1 || do_progress)
100 rprintf(FINFO, "\n");
104 static void emit_filelist_progress(int count)
106 rprintf(FINFO, " %d files...\r", count);
109 static void maybe_emit_filelist_progress(int count)
111 if (do_progress && show_filelist_p() && (count % 100) == 0)
112 emit_filelist_progress(count);
115 static void finish_filelist_progress(const struct file_list *flist)
118 /* This overwrites the progress line */
119 rprintf(FINFO, "%d file%sto consider\n",
120 flist->count, flist->count == 1 ? " " : "s ");
122 rprintf(FINFO, "done\n");
125 void show_flist_stats(void)
130 static void list_file_entry(struct file_struct *f)
135 /* this can happen if duplicate names were removed */
139 permstring(perms, f->mode);
142 if (preserve_links && S_ISLNK(f->mode)) {
143 rprintf(FINFO, "%s %11.0f %s %s -> %s\n",
145 (double)f->length, timestring(f->modtime),
146 f_name(f), f->u.link);
150 rprintf(FINFO, "%s %11.0f %s %s\n",
152 (double)f->length, timestring(f->modtime),
158 * Stat either a symlink or its referent, depending on the settings of
159 * copy_links, copy_unsafe_links, etc.
161 * @retval -1 on error
163 * @retval 0 for success
165 * @post If @p path is a symlink, then @p linkbuf (of size @c
166 * MAXPATHLEN) contains the symlink target.
168 * @post @p buffer contains information about the link or the
169 * referrent as appropriate, if they exist.
171 static int readlink_stat(const char *path, STRUCT_STAT *buffer, char *linkbuf)
175 return do_stat(path, buffer);
176 if (link_stat(path, buffer, 0) < 0)
178 if (S_ISLNK(buffer->st_mode)) {
179 int l = readlink((char *)path, linkbuf, MAXPATHLEN - 1);
183 if (copy_unsafe_links && unsafe_symlink(linkbuf, path)) {
185 rprintf(FINFO,"copying unsafe symlink \"%s\" -> \"%s\"\n",
188 return do_stat(path, buffer);
193 return do_stat(path, buffer);
197 int link_stat(const char *path, STRUCT_STAT *buffer, int follow_dirlinks)
201 return do_stat(path, buffer);
202 if (do_lstat(path, buffer) < 0)
204 if (follow_dirlinks && S_ISLNK(buffer->st_mode)) {
206 if (do_stat(path, &st) == 0 && S_ISDIR(st.st_mode))
211 return do_stat(path, buffer);
215 /* This function is used to check if a file should be included/excluded
216 * from the list of files based on its name and type etc. The value of
217 * filter_level is set to either SERVER_FILTERS or ALL_FILTERS. */
218 static int is_excluded(char *fname, int is_dir, int filter_level)
220 #if 0 /* This currently never happens, so avoid a useless compare. */
221 if (filter_level == NO_FILTERS)
225 /* never exclude '.', even if somebody does --exclude '*' */
226 if (fname[0] == '.' && !fname[1])
228 /* Handle the -R version of the '.' dir. */
229 if (fname[0] == '/') {
230 int len = strlen(fname);
231 if (fname[len-1] == '.' && fname[len-2] == '/')
235 if (server_filter_list.head
236 && check_filter(&server_filter_list, fname, is_dir) < 0)
238 if (filter_level != ALL_FILTERS)
241 && check_filter(&filter_list, fname, is_dir) < 0)
246 static int to_wire_mode(mode_t mode)
249 if (S_ISLNK(mode) && (_S_IFLNK != 0120000))
250 return (mode & ~(_S_IFMT)) | 0120000;
255 static mode_t from_wire_mode(int mode)
257 if ((mode & (_S_IFMT)) == 0120000 && (_S_IFLNK != 0120000))
258 return (mode & ~(_S_IFMT)) | _S_IFLNK;
262 static void send_directory(int f, struct file_list *flist,
263 char *fbuf, int len);
265 static char *flist_dir;
266 static int flist_dir_len;
270 * Make sure @p flist is big enough to hold at least @p flist->count
273 void flist_expand(struct file_list *flist)
275 struct file_struct **new_ptr;
277 if (flist->count < flist->malloced)
280 if (flist->malloced < FLIST_START)
281 flist->malloced = FLIST_START;
282 else if (flist->malloced >= FLIST_LINEAR)
283 flist->malloced += FLIST_LINEAR;
285 flist->malloced *= 2;
288 * In case count jumped or we are starting the list
289 * with a known size just set it.
291 if (flist->malloced < flist->count)
292 flist->malloced = flist->count;
294 new_ptr = realloc_array(flist->files, struct file_struct *,
297 if (verbose >= 2 && flist->malloced != FLIST_START) {
298 rprintf(FINFO, "[%s] expand file_list to %.0f bytes, did%s move\n",
300 (double)sizeof flist->files[0] * flist->malloced,
301 (new_ptr == flist->files) ? " not" : "");
304 flist->files = new_ptr;
307 out_of_memory("flist_expand");
310 void send_file_entry(struct file_struct *file, int f, unsigned short base_flags)
312 unsigned short flags;
313 static time_t modtime;
317 static uint32 rdev_major;
320 static char lastname[MAXPATHLEN];
321 char fname[MAXPATHLEN];
329 modtime = 0, mode = 0;
330 dev = 0, rdev = makedev(0, 0);
337 io_write_phase = "send_file_entry";
339 f_name_to(file, fname);
343 if (file->mode == mode)
344 flags |= XMIT_SAME_MODE;
347 if (preserve_devices) {
348 if (protocol_version < 28) {
349 if (IS_DEVICE(mode)) {
350 if (file->u.rdev == rdev)
351 flags |= XMIT_SAME_RDEV_pre28;
355 rdev = makedev(0, 0);
356 } else if (IS_DEVICE(mode)) {
358 if ((uint32)major(rdev) == rdev_major)
359 flags |= XMIT_SAME_RDEV_MAJOR;
361 rdev_major = major(rdev);
362 if ((uint32)minor(rdev) <= 0xFFu)
363 flags |= XMIT_RDEV_MINOR_IS_SMALL;
366 if (file->uid == uid)
367 flags |= XMIT_SAME_UID;
370 if (file->gid == gid)
371 flags |= XMIT_SAME_GID;
374 if (file->modtime == modtime)
375 flags |= XMIT_SAME_TIME;
377 modtime = file->modtime;
379 #ifdef SUPPORT_HARD_LINKS
380 if (file->link_u.idev) {
381 if (file->F_DEV == dev) {
382 if (protocol_version >= 28)
383 flags |= XMIT_SAME_DEV;
386 flags |= XMIT_HAS_IDEV_DATA;
391 lastname[l1] && (fname[l1] == lastname[l1]) && (l1 < 255);
393 l2 = strlen(fname+l1);
396 flags |= XMIT_SAME_NAME;
398 flags |= XMIT_LONG_NAME;
400 /* We must make sure we don't send a zero flag byte or the
401 * other end will terminate the flist transfer. Note that
402 * the use of XMIT_TOP_DIR on a non-dir has no meaning, so
403 * it's harmless way to add a bit to the first flag byte. */
404 if (protocol_version >= 28) {
405 if (!flags && !S_ISDIR(mode))
406 flags |= XMIT_TOP_DIR;
407 if ((flags & 0xFF00) || !flags) {
408 flags |= XMIT_EXTENDED_FLAGS;
409 write_byte(f, flags);
410 write_byte(f, flags >> 8);
412 write_byte(f, flags);
415 flags |= S_ISDIR(mode) ? XMIT_LONG_NAME : XMIT_TOP_DIR;
416 write_byte(f, flags);
418 if (flags & XMIT_SAME_NAME)
420 if (flags & XMIT_LONG_NAME)
424 write_buf(f, fname + l1, l2);
426 write_longint(f, file->length);
427 if (!(flags & XMIT_SAME_TIME))
428 write_int(f, modtime);
429 if (!(flags & XMIT_SAME_MODE))
430 write_int(f, to_wire_mode(mode));
431 if (preserve_uid && !(flags & XMIT_SAME_UID)) {
436 if (preserve_gid && !(flags & XMIT_SAME_GID)) {
441 if (preserve_devices && IS_DEVICE(mode)) {
442 if (protocol_version < 28) {
443 if (!(flags & XMIT_SAME_RDEV_pre28))
444 write_int(f, (int)rdev);
446 if (!(flags & XMIT_SAME_RDEV_MAJOR))
447 write_int(f, major(rdev));
448 if (flags & XMIT_RDEV_MINOR_IS_SMALL)
449 write_byte(f, minor(rdev));
451 write_int(f, minor(rdev));
456 if (preserve_links && S_ISLNK(mode)) {
457 int len = strlen(file->u.link);
459 write_buf(f, file->u.link, len);
463 #ifdef SUPPORT_HARD_LINKS
464 if (flags & XMIT_HAS_IDEV_DATA) {
465 if (protocol_version < 26) {
466 /* 32-bit dev_t and ino_t */
468 write_int(f, file->F_INODE);
470 /* 64-bit dev_t and ino_t */
471 if (!(flags & XMIT_SAME_DEV))
472 write_longint(f, dev);
473 write_longint(f, file->F_INODE);
478 if (always_checksum && (S_ISREG(mode) || protocol_version < 28)) {
483 /* Prior to 28, we sent a useless set of nulls. */
486 write_buf(f, sum, checksum_len);
489 strlcpy(lastname, fname, MAXPATHLEN);
491 io_write_phase = "unknown";
494 static struct file_struct *receive_file_entry(struct file_list *flist,
495 unsigned short flags, int f)
497 static time_t modtime;
501 static uint32 rdev_major;
504 static char lastname[MAXPATHLEN], *lastdir;
505 static int lastdir_depth, lastdir_len = -1;
506 static unsigned int del_hier_name_len = 0;
507 static int in_del_hier = 0;
508 char thisname[MAXPATHLEN];
509 unsigned int l1 = 0, l2 = 0;
510 int alloc_len, basename_len, dirname_len, linkname_len, sum_len;
512 char *basename, *dirname, *bp;
513 struct file_struct *file;
516 modtime = 0, mode = 0;
517 dev = 0, rdev = makedev(0, 0);
526 if (flags & XMIT_SAME_NAME)
529 if (flags & XMIT_LONG_NAME)
534 if (l2 >= MAXPATHLEN - l1) {
536 "overflow: flags=0x%x l1=%d l2=%d lastname=%s\n",
537 flags, l1, l2, lastname);
538 overflow_exit("receive_file_entry");
541 strlcpy(thisname, lastname, l1 + 1);
542 read_sbuf(f, &thisname[l1], l2);
543 thisname[l1 + l2] = 0;
545 strlcpy(lastname, thisname, MAXPATHLEN);
547 clean_fname(thisname, 0);
550 sanitize_path(thisname, thisname, "", 0);
552 if ((basename = strrchr(thisname, '/')) != NULL) {
553 dirname_len = ++basename - thisname; /* counts future '\0' */
554 if (lastdir_len == dirname_len - 1
555 && strncmp(thisname, lastdir, lastdir_len) == 0) {
557 dirname_len = 0; /* indicates no copy is needed */
565 basename_len = strlen(basename) + 1; /* count the '\0' */
567 file_length = read_longint(f);
568 if (!(flags & XMIT_SAME_TIME))
569 modtime = (time_t)read_int(f);
570 if (!(flags & XMIT_SAME_MODE))
571 mode = from_wire_mode(read_int(f));
573 if (preserve_uid && !(flags & XMIT_SAME_UID))
574 uid = (uid_t)read_int(f);
575 if (preserve_gid && !(flags & XMIT_SAME_GID))
576 gid = (gid_t)read_int(f);
578 if (preserve_devices) {
579 if (protocol_version < 28) {
580 if (IS_DEVICE(mode)) {
581 if (!(flags & XMIT_SAME_RDEV_pre28))
582 rdev = (dev_t)read_int(f);
584 rdev = makedev(0, 0);
585 } else if (IS_DEVICE(mode)) {
587 if (!(flags & XMIT_SAME_RDEV_MAJOR))
588 rdev_major = read_int(f);
589 if (flags & XMIT_RDEV_MINOR_IS_SMALL)
590 rdev_minor = read_byte(f);
592 rdev_minor = read_int(f);
593 rdev = makedev(rdev_major, rdev_minor);
598 if (preserve_links && S_ISLNK(mode)) {
599 linkname_len = read_int(f) + 1; /* count the '\0' */
600 if (linkname_len <= 0 || linkname_len > MAXPATHLEN) {
601 rprintf(FERROR, "overflow: linkname_len=%d\n",
603 overflow_exit("receive_file_entry");
610 sum_len = always_checksum && S_ISREG(mode) ? MD4_SUM_LENGTH : 0;
612 alloc_len = file_struct_len + dirname_len + basename_len
613 + linkname_len + sum_len;
614 bp = pool_alloc(flist->file_pool, alloc_len, "receive_file_entry");
616 file = (struct file_struct *)bp;
617 memset(bp, 0, file_struct_len);
618 bp += file_struct_len;
621 file->modtime = modtime;
622 file->length = file_length;
628 file->dirname = lastdir = bp;
629 lastdir_len = dirname_len - 1;
630 memcpy(bp, dirname, dirname_len - 1);
633 lastdir_depth = count_dir_elements(lastdir);
634 file->dir.depth = lastdir_depth + 1;
635 } else if (dirname) {
636 file->dirname = dirname; /* we're reusing lastname */
637 file->dir.depth = lastdir_depth + 1;
642 if (basename_len == 1+1 && *basename == '.') /* +1 for '\0' */
644 if (flags & XMIT_TOP_DIR) {
645 in_del_hier = recurse;
646 del_hier_name_len = file->dir.depth == 0 ? 0 : l1 + l2;
647 if (relative_paths && del_hier_name_len > 2
648 && basename_len == 1+1 && *basename == '.')
649 del_hier_name_len -= 2;
650 file->flags |= FLAG_TOP_DIR | FLAG_DEL_HERE;
651 } else if (in_del_hier) {
652 if (!relative_paths || !del_hier_name_len
653 || (l1 >= del_hier_name_len
654 && thisname[del_hier_name_len] == '/'))
655 file->flags |= FLAG_DEL_HERE;
662 memcpy(bp, basename, basename_len);
665 if (preserve_devices && IS_DEVICE(mode))
671 read_sbuf(f, bp, linkname_len - 1);
673 sanitize_path(bp, bp, "", lastdir_depth);
678 #ifdef SUPPORT_HARD_LINKS
679 if (preserve_hard_links && protocol_version < 28 && S_ISREG(mode))
680 flags |= XMIT_HAS_IDEV_DATA;
681 if (flags & XMIT_HAS_IDEV_DATA) {
683 if (protocol_version < 26) {
687 if (!(flags & XMIT_SAME_DEV))
688 dev = read_longint(f);
689 inode = read_longint(f);
691 if (flist->hlink_pool) {
692 file->link_u.idev = pool_talloc(flist->hlink_pool,
693 struct idev, 1, "inode_table");
694 file->F_INODE = inode;
700 if (always_checksum && (sum_len || protocol_version < 28)) {
703 file->u.sum = sum = bp;
706 /* Prior to 28, we get a useless set of nulls. */
709 read_buf(f, sum, checksum_len);
712 if (!preserve_perms) {
713 /* set an appropriate set of permissions based on original
714 * permissions and umask. This emulates what GNU cp does */
715 file->mode &= ~orig_umask;
722 * Create a file_struct for a named file by reading its stat()
723 * information and performing extensive checks against global
726 * @return the new file, or NULL if there was an error or this file
727 * should be excluded.
729 * @todo There is a small optimization opportunity here to avoid
730 * stat()ing the file in some circumstances, which has a certain cost.
731 * We are called immediately after doing readdir(), and so we may
732 * already know the d_type of the file. We could for example avoid
733 * statting directories if we're not recursing, but this is not a very
734 * important case. Some systems may not have d_type.
736 struct file_struct *make_file(char *fname, struct file_list *flist,
739 static char *lastdir;
740 static int lastdir_len = -1;
741 struct file_struct *file;
743 char sum[SUM_LENGTH];
744 char thisname[MAXPATHLEN];
745 char linkname[MAXPATHLEN];
746 int alloc_len, basename_len, dirname_len, linkname_len, sum_len;
747 char *basename, *dirname, *bp;
748 unsigned short flags = 0;
750 if (!flist || !flist->count) /* Ignore lastdir when invalid. */
753 if (strlcpy(thisname, fname, sizeof thisname)
754 >= sizeof thisname - flist_dir_len) {
755 rprintf(FINFO, "skipping overly long name: %s\n", fname);
758 clean_fname(thisname, 0);
760 sanitize_path(thisname, thisname, "", 0);
762 memset(sum, 0, SUM_LENGTH);
764 if (readlink_stat(thisname, &st, linkname) != 0) {
765 int save_errno = errno;
766 /* See if file is excluded before reporting an error. */
767 if (filter_level != NO_FILTERS
768 && is_excluded(thisname, 0, filter_level))
770 if (save_errno == ENOENT) {
772 /* Avoid "vanished" error if symlink points nowhere. */
773 if (copy_links && do_lstat(thisname, &st) == 0
774 && S_ISLNK(st.st_mode)) {
775 io_error |= IOERR_GENERAL;
776 rprintf(FERROR, "symlink has no referent: %s\n",
777 full_fname(thisname));
781 enum logcode c = am_daemon && protocol_version < 28
783 io_error |= IOERR_VANISHED;
784 rprintf(c, "file has vanished: %s\n",
785 full_fname(thisname));
788 io_error |= IOERR_GENERAL;
789 rsyserr(FERROR, save_errno, "readlink %s failed",
790 full_fname(thisname));
795 /* backup.c calls us with filter_level set to NO_FILTERS. */
796 if (filter_level == NO_FILTERS)
799 if (S_ISDIR(st.st_mode) && !xfer_dirs) {
800 rprintf(FINFO, "skipping directory %s\n", thisname);
804 /* We only care about directories because we need to avoid recursing
805 * into a mount-point directory, not to avoid copying a symlinked
806 * file if -L (or similar) was specified. */
807 if (one_file_system && st.st_dev != filesystem_dev
808 && S_ISDIR(st.st_mode))
809 flags |= FLAG_MOUNT_POINT;
811 if (is_excluded(thisname, S_ISDIR(st.st_mode) != 0, filter_level))
814 if (lp_ignore_nonreadable(module_id)) {
816 if (!S_ISLNK(st.st_mode))
818 if (access(thisname, R_OK) != 0)
825 rprintf(FINFO, "[%s] make_file(%s,*,%d)\n",
826 who_am_i(), thisname, filter_level);
829 if ((basename = strrchr(thisname, '/')) != NULL) {
830 dirname_len = ++basename - thisname; /* counts future '\0' */
831 if (lastdir_len == dirname_len - 1
832 && strncmp(thisname, lastdir, lastdir_len) == 0) {
834 dirname_len = 0; /* indicates no copy is needed */
842 basename_len = strlen(basename) + 1; /* count the '\0' */
845 linkname_len = S_ISLNK(st.st_mode) ? strlen(linkname) + 1 : 0;
850 sum_len = always_checksum && am_sender && S_ISREG(st.st_mode)
851 ? MD4_SUM_LENGTH : 0;
853 alloc_len = file_struct_len + dirname_len + basename_len
854 + linkname_len + sum_len;
856 bp = pool_alloc(flist->file_pool, alloc_len,
857 "receive_file_entry");
859 if (!(bp = new_array(char, alloc_len)))
860 out_of_memory("receive_file_entry");
863 file = (struct file_struct *)bp;
864 memset(bp, 0, file_struct_len);
865 bp += file_struct_len;
868 file->modtime = st.st_mtime;
869 file->length = st.st_size;
870 if (chmod_modes && am_sender && (S_ISREG(st.st_mode) || S_ISDIR(st.st_mode)))
871 file->mode = tweak_mode(st.st_mode, chmod_modes);
873 file->mode = st.st_mode;
874 file->uid = st.st_uid;
875 file->gid = st.st_gid;
877 #ifdef SUPPORT_HARD_LINKS
878 if (flist && flist->hlink_pool) {
879 if (protocol_version < 28) {
880 if (S_ISREG(st.st_mode))
881 file->link_u.idev = pool_talloc(
882 flist->hlink_pool, struct idev, 1,
885 if (!S_ISDIR(st.st_mode) && st.st_nlink > 1)
886 file->link_u.idev = pool_talloc(
887 flist->hlink_pool, struct idev, 1,
891 if (file->link_u.idev) {
892 file->F_DEV = st.st_dev;
893 file->F_INODE = st.st_ino;
898 file->dirname = lastdir = bp;
899 lastdir_len = dirname_len - 1;
900 memcpy(bp, dirname, dirname_len - 1);
904 file->dirname = dirname;
907 memcpy(bp, basename, basename_len);
910 #ifdef HAVE_STRUCT_STAT_ST_RDEV
911 if (preserve_devices && IS_DEVICE(st.st_mode))
912 file->u.rdev = st.st_rdev;
918 memcpy(bp, linkname, linkname_len);
925 file_checksum(thisname, bp, st.st_size);
929 file->dir.root = flist_dir;
931 /* This code is only used by the receiver when it is building
932 * a list of files for a delete pass. */
933 if (keep_dirlinks && linkname_len && flist) {
935 int save_mode = file->mode;
936 file->mode = S_IFDIR; /* find a directory w/our name */
937 if (flist_find(the_file_list, file) >= 0
938 && do_stat(thisname, &st2) == 0 && S_ISDIR(st2.st_mode)) {
939 file->modtime = st2.st_mtime;
940 file->length = st2.st_size;
941 file->mode = st2.st_mode;
942 file->uid = st2.st_uid;
943 file->gid = st2.st_gid;
946 file->mode = save_mode;
949 if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode))
950 stats.total_size += st.st_size;
955 static struct file_struct *send_file_name(int f, struct file_list *flist,
956 char *fname, unsigned short base_flags)
958 struct file_struct *file;
960 file = make_file(fname, flist, f == -2 ? SERVER_FILTERS : ALL_FILTERS);
964 maybe_emit_filelist_progress(flist->count + flist_count_offset);
968 if (file->basename[0]) {
969 flist->files[flist->count++] = file;
970 send_file_entry(file, f, base_flags);
975 static void send_if_directory(int f, struct file_list *flist,
976 struct file_struct *file,
977 char *fbuf, unsigned int ol)
979 char is_dot_dir = fbuf[ol-1] == '.' && (ol == 1 || fbuf[ol-2] == '/');
981 if (S_ISDIR(file->mode)
982 && !(file->flags & FLAG_MOUNT_POINT) && f_name_to(file, fbuf)) {
984 unsigned int len = strlen(fbuf);
985 if (len > 1 && fbuf[len-1] == '/')
987 if (len >= MAXPATHLEN - 1) {
988 io_error |= IOERR_GENERAL;
989 rprintf(FERROR, "skipping long-named directory: %s\n",
993 save_filters = push_local_filters(fbuf, len);
994 send_directory(f, flist, fbuf, len);
995 pop_local_filters(save_filters);
1002 /* This function is normally called by the sender, but the receiving side also
1003 * calls it from get_dirlist() with f set to -1 so that we just construct the
1004 * file list in memory without sending it over the wire. Also, get_dirlist()
1005 * might call this with f set to -2, which also indicates that local filter
1006 * rules should be ignored. */
1007 static void send_directory(int f, struct file_list *flist,
1008 char *fbuf, int len)
1014 int start = flist->count;
1016 if (!(d = opendir(fbuf))) {
1017 io_error |= IOERR_GENERAL;
1018 rsyserr(FERROR, errno, "opendir %s failed", full_fname(fbuf));
1023 if (len != 1 || *fbuf != '/')
1026 remainder = MAXPATHLEN - (p - fbuf);
1028 for (errno = 0, di = readdir(d); di; errno = 0, di = readdir(d)) {
1029 char *dname = d_name(di);
1030 if (dname[0] == '.' && (dname[1] == '\0'
1031 || (dname[1] == '.' && dname[2] == '\0')))
1033 if (strlcpy(p, dname, remainder) >= remainder) {
1034 io_error |= IOERR_GENERAL;
1036 "cannot send long-named file %s\n",
1040 send_file_name(f, flist, fbuf, 0);
1046 io_error |= IOERR_GENERAL;
1047 rsyserr(FERROR, errno, "readdir(%s)", full_fname(fbuf));
1053 int i, end = flist->count - 1;
1054 for (i = start; i <= end; i++)
1055 send_if_directory(f, flist, flist->files[i], fbuf, len);
1059 struct file_list *send_file_list(int f, int argc, char *argv[])
1063 char *p, *dir, olddir[sizeof curr_dir];
1064 char lastpath[MAXPATHLEN] = "";
1065 struct file_list *flist;
1066 struct timeval start_tv, end_tv;
1070 if (show_filelist_p())
1071 start_filelist_progress("building file list");
1073 start_write = stats.total_written;
1074 gettimeofday(&start_tv, NULL);
1076 flist = flist_new(WITH_HLINK, "send_file_list");
1078 io_start_buffering_out();
1079 if (filesfrom_fd >= 0) {
1080 if (argv[0] && !push_dir(argv[0])) {
1081 rsyserr(FERROR, errno, "push_dir %s failed",
1082 full_fname(argv[0]));
1083 exit_cleanup(RERR_FILESELECT);
1089 char fbuf[MAXPATHLEN];
1094 if (read_filesfrom_line(filesfrom_fd, fbuf) == 0)
1096 sanitize_path(fbuf, fbuf, "", 0);
1100 strlcpy(fbuf, *argv++, MAXPATHLEN);
1102 sanitize_path(fbuf, fbuf, "", 0);
1106 if (!len || fbuf[len - 1] == '/') {
1107 if (len == 2 && fbuf[0] == '.') {
1108 /* Turn "./" into just "." rather than "./." */
1111 if (len + 1 >= MAXPATHLEN)
1112 overflow_exit("send_file_list");
1117 } else if (len > 1 && fbuf[len-1] == '.' && fbuf[len-2] == '.'
1118 && (len == 2 || fbuf[len-3] == '/')) {
1119 if (len + 2 >= MAXPATHLEN)
1120 overflow_exit("send_file_list");
1126 is_dot_dir = fbuf[len-1] == '.'
1127 && (len == 1 || fbuf[len-2] == '/');
1130 if (link_stat(fbuf, &st, keep_dirlinks) != 0) {
1131 io_error |= IOERR_GENERAL;
1132 rsyserr(FERROR, errno, "link_stat %s failed",
1137 if (S_ISDIR(st.st_mode) && !xfer_dirs) {
1138 rprintf(FINFO, "skipping directory %s\n", fbuf);
1145 if (!relative_paths) {
1146 p = strrchr(fbuf, '/');
1153 len -= p - fbuf + 1;
1157 } else if ((p = strstr(fbuf, "/./")) != NULL) {
1163 len -= p - fbuf + 3;
1174 static char *lastdir;
1175 static int lastdir_len;
1177 strlcpy(olddir, curr_dir, sizeof olddir);
1179 if (!push_dir(dir)) {
1180 io_error |= IOERR_GENERAL;
1181 rsyserr(FERROR, errno, "push_dir %s failed",
1186 if (lastdir && strcmp(lastdir, dir) == 0) {
1187 flist_dir = lastdir;
1188 flist_dir_len = lastdir_len;
1190 flist_dir = lastdir = strdup(dir);
1191 flist_dir_len = lastdir_len = strlen(dir);
1196 memmove(fbuf, fn, len + 1);
1198 if (implied_dirs && (p=strrchr(fbuf,'/')) && p != fbuf) {
1199 /* Send the implied directories at the start of the
1200 * source spec, so we get their permissions right. */
1201 char *lp = lastpath, *slash = fbuf;
1203 /* Skip any initial directories in our path that we
1204 * have in common with lastpath. */
1205 for (fn = fbuf; *fn && *lp == *fn; lp++, fn++) {
1210 if (fn != p || (*lp && *lp != '/')) {
1211 int save_copy_links = copy_links;
1212 int save_xfer_dirs = xfer_dirs;
1213 copy_links = copy_unsafe_links;
1215 while ((slash = strchr(slash+1, '/')) != 0) {
1217 send_file_name(f, flist, fbuf, 0);
1220 copy_links = save_copy_links;
1221 xfer_dirs = save_xfer_dirs;
1223 strlcpy(lastpath, fbuf, sizeof lastpath);
1228 if (one_file_system)
1229 filesystem_dev = st.st_dev;
1231 if (recurse || (xfer_dirs && is_dot_dir)) {
1232 struct file_struct *file;
1233 if ((file = send_file_name(f, flist, fbuf, XMIT_TOP_DIR)))
1234 send_if_directory(f, flist, file, fbuf, len);
1236 send_file_name(f, flist, fbuf, 0);
1241 if (!pop_dir(olddir)) {
1242 rsyserr(FERROR, errno, "pop_dir %s failed",
1243 full_fname(olddir));
1244 exit_cleanup(RERR_FILESELECT);
1249 gettimeofday(&end_tv, NULL);
1250 stats.flist_buildtime = (int64)(end_tv.tv_sec - start_tv.tv_sec) * 1000
1251 + (end_tv.tv_usec - start_tv.tv_usec) / 1000;
1252 if (stats.flist_buildtime == 0)
1253 stats.flist_buildtime = 1;
1256 send_file_entry(NULL, f, 0);
1258 if (show_filelist_p())
1259 finish_filelist_progress(flist);
1261 gettimeofday(&end_tv, NULL);
1262 stats.flist_xfertime = (int64)(end_tv.tv_sec - start_tv.tv_sec) * 1000
1263 + (end_tv.tv_usec - start_tv.tv_usec) / 1000;
1265 if (flist->hlink_pool) {
1266 pool_destroy(flist->hlink_pool);
1267 flist->hlink_pool = NULL;
1270 /* Sort the list without removing any duplicates. This allows the
1271 * receiving side to ask for any name they like, which gives us the
1272 * flexibility to change the way we unduplicate names in the future
1273 * without causing a compatibility problem with older versions. */
1274 clean_flist(flist, 0, 0);
1276 /* Now send the uid/gid list. This was introduced in
1277 * protocol version 15 */
1280 /* send the io_error flag */
1281 write_int(f, lp_ignore_errors(module_id) ? 0 : io_error);
1284 stats.flist_size = stats.total_written - start_write;
1285 stats.num_files = flist->count;
1288 output_flist(flist);
1291 rprintf(FINFO, "send_file_list done\n");
1296 struct file_list *recv_file_list(int f)
1298 struct file_list *flist;
1299 unsigned short flags;
1302 if (show_filelist_p())
1303 start_filelist_progress("receiving file list");
1305 start_read = stats.total_read;
1307 flist = flist_new(WITH_HLINK, "recv_file_list");
1310 flist->malloced = 1000;
1311 flist->files = new_array(struct file_struct *, flist->malloced);
1315 while ((flags = read_byte(f)) != 0) {
1316 struct file_struct *file;
1318 flist_expand(flist);
1320 if (protocol_version >= 28 && (flags & XMIT_EXTENDED_FLAGS))
1321 flags |= read_byte(f) << 8;
1322 file = receive_file_entry(flist, flags, f);
1324 if (S_ISREG(file->mode))
1325 stats.total_size += file->length;
1327 flist->files[flist->count++] = file;
1329 maybe_emit_filelist_progress(flist->count);
1332 rprintf(FINFO, "recv_file_name(%s)\n", f_name(file));
1334 receive_file_entry(NULL, 0, 0); /* Signal that we're done. */
1337 rprintf(FINFO, "received %d names\n", flist->count);
1339 if (show_filelist_p())
1340 finish_filelist_progress(flist);
1342 clean_flist(flist, relative_paths, 1);
1345 /* Now send the uid/gid list. This was introduced in
1346 * protocol version 15 */
1347 recv_uid_list(f, flist);
1349 /* Recv the io_error flag */
1350 if (lp_ignore_errors(module_id) || ignore_errors)
1353 io_error |= read_int(f);
1357 output_flist(flist);
1361 for (i = 0; i < flist->count; i++)
1362 list_file_entry(flist->files[i]);
1366 rprintf(FINFO, "recv_file_list done\n");
1368 stats.flist_size = stats.total_read - start_read;
1369 stats.num_files = flist->count;
1374 out_of_memory("recv_file_list");
1375 return NULL; /* not reached */
1378 static int file_compare(struct file_struct **file1, struct file_struct **file2)
1380 return f_name_cmp(*file1, *file2);
1383 /* Search for an identically-named item in the file list. Note that the
1384 * items must agree in their directory-ness, or no match is returned. */
1385 int flist_find(struct file_list *flist, struct file_struct *f)
1387 int low = flist->low, high = flist->high;
1388 int ret, mid, mid_up;
1390 while (low <= high) {
1391 mid = (low + high) / 2;
1392 for (mid_up = mid; !flist->files[mid_up]->basename; mid_up++) {}
1394 ret = f_name_cmp(flist->files[mid_up], f);
1398 if (protocol_version < 29
1399 && S_ISDIR(flist->files[mid_up]->mode)
1400 != S_ISDIR(f->mode))
1413 * Free up any resources a file_struct has allocated
1414 * and clear the file.
1416 void clear_file(int i, struct file_list *flist)
1418 if (flist->hlink_pool && flist->files[i]->link_u.idev)
1419 pool_free(flist->hlink_pool, 0, flist->files[i]->link_u.idev);
1420 memset(flist->files[i], 0, file_struct_len);
1424 * allocate a new file list
1426 struct file_list *flist_new(int with_hlink, char *msg)
1428 struct file_list *flist;
1430 flist = new(struct file_list);
1434 memset(flist, 0, sizeof (struct file_list));
1436 if (!(flist->file_pool = pool_create(FILE_EXTENT, 0,
1437 out_of_memory, POOL_INTERN)))
1440 #ifdef SUPPORT_HARD_LINKS
1441 if (with_hlink && preserve_hard_links) {
1442 if (!(flist->hlink_pool = pool_create(HLINK_EXTENT,
1443 sizeof (struct idev), out_of_memory, POOL_INTERN)))
1452 * free up all elements in a flist
1454 void flist_free(struct file_list *flist)
1456 pool_destroy(flist->file_pool);
1457 pool_destroy(flist->hlink_pool);
1463 * This routine ensures we don't have any duplicate names in our file list.
1464 * duplicate names can cause corruption because of the pipelining
1466 static void clean_flist(struct file_list *flist, int strip_root, int no_dups)
1472 if (flist->count == 0) {
1477 sorting_flist = flist;
1478 qsort(flist->files, flist->count,
1479 sizeof flist->files[0], (int (*)())file_compare);
1480 sorting_flist = NULL;
1482 for (i = no_dups? 0 : flist->count; i < flist->count; i++) {
1483 if (flist->files[i]->basename) {
1488 flist->low = prev_i;
1489 while (++i < flist->count) {
1491 struct file_struct *file = flist->files[i];
1493 if (!file->basename)
1495 if (f_name_cmp(file, flist->files[prev_i]) == 0)
1497 else if (protocol_version >= 29 && S_ISDIR(file->mode)) {
1498 int save_mode = file->mode;
1499 /* Make sure that this directory doesn't duplicate a
1500 * non-directory earlier in the list. */
1501 flist->high = prev_i;
1502 file->mode = S_IFREG;
1503 j = flist_find(flist, file);
1504 file->mode = save_mode;
1508 struct file_struct *fp = flist->files[j];
1510 /* If one is a dir and the other is not, we want to
1511 * keep the dir because it might have contents in the
1513 if (S_ISDIR(file->mode) != S_ISDIR(fp->mode)) {
1514 if (S_ISDIR(file->mode))
1520 if (verbose > 1 && !am_server) {
1522 "removing duplicate name %s from file list (%d)\n",
1523 f_name(file), drop);
1525 /* Make sure that if we unduplicate '.', that we don't
1526 * lose track of a user-specified top directory. */
1527 flist->files[keep]->flags |= flist->files[drop]->flags
1528 & (FLAG_TOP_DIR|FLAG_DEL_HERE);
1530 clear_file(drop, flist);
1533 if (flist->low == drop) {
1535 j < i && !flist->files[j]->basename;
1544 flist->high = no_dups ? prev_i : flist->count - 1;
1547 /* We need to strip off the leading slashes for relative
1548 * paths, but this must be done _after_ the sorting phase. */
1549 for (i = flist->low; i <= flist->high; i++) {
1550 struct file_struct *file = flist->files[i];
1554 if (*file->dirname == '/') {
1555 char *s = file->dirname + 1;
1556 while (*s == '/') s++;
1557 memmove(file->dirname, s, strlen(s) + 1);
1560 if (!*file->dirname)
1561 file->dirname = NULL;
1566 static void output_flist(struct file_list *flist)
1568 char uidbuf[16], gidbuf[16], depthbuf[16];
1569 struct file_struct *file;
1570 const char *who = who_am_i();
1573 for (i = 0; i < flist->count; i++) {
1574 file = flist->files[i];
1575 if ((am_root || am_sender) && preserve_uid)
1576 sprintf(uidbuf, " uid=%ld", (long)file->uid);
1579 if (preserve_gid && file->gid != GID_NONE)
1580 sprintf(gidbuf, " gid=%ld", (long)file->gid);
1584 sprintf(depthbuf, "%d", file->dir.depth);
1585 rprintf(FINFO, "[%s] i=%d %s %s%s%s%s mode=0%o len=%.0f%s%s flags=%x\n",
1586 who, i, am_sender ? NS(file->dir.root) : depthbuf,
1587 file->dirname ? file->dirname : "",
1588 file->dirname ? "/" : "", NS(file->basename),
1589 S_ISDIR(file->mode) ? "/" : "", (int)file->mode,
1590 (double)file->length, uidbuf, gidbuf, file->flags);
1594 enum fnc_state { s_DIR, s_SLASH, s_BASE, s_TRAILING };
1595 enum fnc_type { t_PATH, t_ITEM };
1597 /* Compare the names of two file_struct entities, similar to how strcmp()
1598 * would do if it were operating on the joined strings.
1600 * Some differences beginning with protocol_version 29: (1) directory names
1601 * are compared with an assumed trailing slash so that they compare in a
1602 * way that would cause them to sort immediately prior to any content they
1603 * may have; (2) a directory of any name compares after a non-directory of
1604 * any name at the same depth; (3) a directory with name "." compares prior
1605 * to anything else. These changes mean that a directory and a non-dir
1606 * with the same name will not compare as equal (protocol_version >= 29).
1608 * The dirname component can be an empty string, but the basename component
1609 * cannot (and never is in the current codebase). The basename component
1610 * may be NULL (for a removed item), in which case it is considered to be
1611 * after any existing item. */
1612 int f_name_cmp(struct file_struct *f1, struct file_struct *f2)
1615 const uchar *c1, *c2;
1616 enum fnc_state state1, state2;
1617 enum fnc_type type1, type2;
1618 enum fnc_type t_path = protocol_version >= 29 ? t_PATH : t_ITEM;
1620 if (!f1 || !f1->basename) {
1621 if (!f2 || !f2->basename)
1625 if (!f2 || !f2->basename)
1628 c1 = (uchar*)f1->dirname;
1629 c2 = (uchar*)f2->dirname;
1633 type1 = S_ISDIR(f1->mode) ? t_path : t_ITEM;
1634 c1 = (uchar*)f1->basename;
1635 if (type1 == t_PATH && *c1 == '.' && !c1[1]) {
1637 state1 = s_TRAILING;
1650 type2 = S_ISDIR(f2->mode) ? t_path : t_ITEM;
1651 c2 = (uchar*)f2->basename;
1652 if (type2 == t_PATH && *c2 == '.' && !c2[1]) {
1654 state2 = s_TRAILING;
1668 return type1 == t_PATH ? 1 : -1;
1671 if ((dif = (int)*c1++ - (int)*c2++) != 0)
1680 type1 = S_ISDIR(f1->mode) ? t_path : t_ITEM;
1681 c1 = (uchar*)f1->basename;
1682 if (type1 == t_PATH && *c1 == '.' && !c1[1]) {
1684 state1 = s_TRAILING;
1690 state1 = s_TRAILING;
1691 if (type1 == t_PATH) {
1700 if (*c2 && type1 != type2)
1701 return type1 == t_PATH ? 1 : -1;
1710 type2 = S_ISDIR(f2->mode) ? t_path : t_ITEM;
1711 c2 = (uchar*)f2->basename;
1712 if (type2 == t_PATH && *c2 == '.' && !c2[1]) {
1714 state2 = s_TRAILING;
1720 state2 = s_TRAILING;
1721 if (type2 == t_PATH) {
1733 return type1 == t_PATH ? 1 : -1;
1740 /* Return a copy of the full filename of a flist entry, using the indicated
1741 * buffer. No size-checking is done because we checked the size when creating
1742 * the file_struct entry.
1744 char *f_name_to(struct file_struct *f, char *fbuf)
1746 if (!f || !f->basename)
1750 int len = strlen(f->dirname);
1751 memcpy(fbuf, f->dirname, len);
1753 strcpy(fbuf + len + 1, f->basename);
1755 strcpy(fbuf, f->basename);
1760 /* Like f_name_to(), but we rotate through 5 static buffers of our own. */
1761 char *f_name(struct file_struct *f)
1763 static char names[5][MAXPATHLEN];
1764 static unsigned int n;
1766 n = (n + 1) % (sizeof names / sizeof names[0]);
1768 return f_name_to(f, names[n]);
1771 /* Do a non-recursive scan of the named directory, possibly ignoring all
1772 * exclude rules except for the daemon's. If "dlen" is >=0, it is the length
1773 * of the dirname string, and also indicates that "dirname" is a MAXPATHLEN
1774 * buffer (the functions we call will append names onto the end, but the old
1775 * dir value will be restored on exit). */
1776 struct file_list *get_dirlist(char *dirname, int dlen,
1777 int ignore_filter_rules)
1779 struct file_list *dirlist;
1780 char dirbuf[MAXPATHLEN];
1781 int save_recurse = recurse;
1784 dlen = strlcpy(dirbuf, dirname, MAXPATHLEN);
1785 if (dlen >= MAXPATHLEN)
1790 dirlist = flist_new(WITHOUT_HLINK, "get_dirlist");
1793 send_directory(ignore_filter_rules ? -2 : -1, dirlist, dirname, dlen);
1794 recurse = save_recurse;
1796 flist_count_offset += dirlist->count;
1798 clean_flist(dirlist, 0, 0);
1801 output_flist(dirlist);