Add some temp-name dot heuristics for OS X's sake.
[rsync/rsync.git] / receiver.c
index ee8e015..1819830 100644 (file)
@@ -24,6 +24,7 @@
 
 extern int dry_run;
 extern int do_xfers;
+extern int am_root;
 extern int am_server;
 extern int inc_recurse;
 extern int log_before_transfer;
@@ -44,10 +45,12 @@ extern int cleanup_got_literal;
 extern int remove_source_files;
 extern int append_mode;
 extern int sparse_files;
+extern int preallocate_files;
 extern int keep_partial;
 extern int checksum_len;
 extern int checksum_seed;
 extern int inplace;
+extern int allowed_lull;
 extern int delay_updates;
 extern mode_t orig_umask;
 extern struct stats stats;
@@ -56,7 +59,7 @@ extern char *partial_dir;
 extern char *basis_dir[MAX_BASIS_DIRS+1];
 extern char sender_file_sum[MAX_DIGEST_LEN];
 extern struct file_list *cur_flist, *first_flist, *dir_flist;
-extern struct filter_list_struct daemon_filter_list;
+extern filter_rule_list daemon_filter_list;
 
 static struct bitbag *delayed_bits = NULL;
 static int phase = 0, redoing = 0;
@@ -64,31 +67,36 @@ static flist_ndx_list batch_redo_list;
 /* We're either updating the basis file or an identical copy: */
 static int updating_basis_or_equiv;
 
-/*
- * get_tmpname() - create a tmp filename for a given filename
+#define TMPNAME_SUFFIX ".XXXXXX"
+#define TMPNAME_SUFFIX_LEN ((int)sizeof TMPNAME_SUFFIX - 1)
+#define MAX_UNIQUE_NUMBER 999999
+#define MAX_UNIQUE_LOOP 100
+
+/* get_tmpname() - create a tmp filename for a given filename
  *
- *   If a tmpdir is defined, use that as the directory to
- *   put it in.  Otherwise, the tmp filename is in the same
- *   directory as the given name.  Note that there may be no
- *   directory at all in the given name!
+ * If a tmpdir is defined, use that as the directory to put it in.  Otherwise,
+ * the tmp filename is in the same directory as the given name.  Note that
+ * there may be no directory at all in the given name!
  *
- *   The tmp filename is basically the given filename with a
- *   dot prepended, and .XXXXXX appended (for mkstemp() to
- *   put its unique gunk in).  Take care to not exceed
- *   either the MAXPATHLEN or NAME_MAX, esp. the last, as
- *   the basename basically becomes 8 chars longer. In that
- *   case, the original name is shortened sufficiently to
- *   make it all fit.
+ * The tmp filename is basically the given filename with a dot prepended, and
+ * .XXXXXX appended (for mkstemp() to put its unique gunk in).  We take care
+ * to not exceed either the MAXPATHLEN or NAME_MAX, especially the last, as
+ * the basename basically becomes 8 characters longer.  In such a case, the
+ * original name is shortened sufficiently to make it all fit.
  *
- *   Of course, there's no real reason for the tmp name to
- *   look like the original, except to satisfy us humans.
- *   As long as it's unique, rsync will work.
- */
-
-int get_tmpname(char *fnametmp, const char *fname)
+ * If the make_unique arg is True, the XXXXXX string is replaced with a unique
+ * string that doesn't exist at the time of the check.  This is intended to be
+ * used for creating hard links, symlinks, devices, and special files, since
+ * normal files should be handled by mkstemp() for safety.
+ *
+ * Of course, the only reason the file is based on the original name is to
+ * make it easier to figure out what purpose a temp file is serving when a
+ * transfer is in progress. */
+int get_tmpname(char *fnametmp, const char *fname, BOOL make_unique)
 {
-       int maxname, added, length = 0;
+       int maxname, length = 0;
        const char *f;
+       char *suf;
 
        if (tmpdir) {
                /* Note: this can't overflow, so the return value is safe */
@@ -105,22 +113,65 @@ int get_tmpname(char *fnametmp, const char *fname)
                }
        } else
                f = fname;
+       if (*f == '.') /* avoid an extra leading dot for OS X's sake */
+               f++;
        fnametmp[length++] = '.';
 
        /* The maxname value is bufsize, and includes space for the '\0'.
-        * (Note that NAME_MAX get -8 for the leading '.' above.) */
-       maxname = MIN(MAXPATHLEN - 7 - length, NAME_MAX - 8);
+        * NAME_MAX needs an extra -1 for the name's leading dot. */
+       maxname = MIN(MAXPATHLEN - length - TMPNAME_SUFFIX_LEN,
+                     NAME_MAX - 1 - TMPNAME_SUFFIX_LEN);
 
-       if (maxname < 1) {
+       if (maxname < 0) {
                rprintf(FERROR_XFER, "temporary filename too long: %s\n", fname);
                fnametmp[0] = '\0';
                return 0;
        }
 
-       added = strlcpy(fnametmp + length, f, maxname);
-       if (added >= maxname)
-               added = maxname - 1;
-       memcpy(fnametmp + length + added, ".XXXXXX", 8);
+       if (maxname) {
+               int added = strlcpy(fnametmp + length, f, maxname);
+               if (added >= maxname)
+                       added = maxname - 1;
+               suf = fnametmp + length + added;
+
+               /* Trim any dangling high-bit chars if the first-trimmed char (if any) is
+                * also a high-bit char, just in case we cut into a multi-byte sequence.
+                * We are guaranteed to stop because of the leading '.' we added. */
+               if ((int)f[added] & 0x80) {
+                       while ((int)suf[-1] & 0x80)
+                               suf--;
+               }
+               /* trim one trailing dot before our suffix's dot */
+               if (suf[-1] == '.')
+                       suf--;
+       } else
+               suf = fnametmp + length - 1; /* overwrite the leading dot with suffix's dot */
+
+       if (make_unique) {
+               static unsigned counter_limit;
+               unsigned counter;
+
+               if (!counter_limit) {
+                       counter_limit = (unsigned)getpid() + MAX_UNIQUE_LOOP;
+                       if (counter_limit > MAX_UNIQUE_NUMBER || counter_limit < MAX_UNIQUE_LOOP)
+                               counter_limit = MAX_UNIQUE_LOOP;
+               }
+               counter = counter_limit - MAX_UNIQUE_LOOP;
+
+               /* This doesn't have to be very good because we don't need
+                * to worry about someone trying to guess the values:  all
+                * a conflict will do is cause a device, special file, hard
+                * link, or symlink to fail to be created.  Also: avoid
+                * using mktemp() due to gcc's annoying warning. */
+               while (1) {
+                       snprintf(suf, TMPNAME_SUFFIX_LEN+1, ".%d", counter);
+                       if (access(fnametmp, 0) < 0)
+                               break;
+                       if (++counter >= counter_limit)
+                               return 0;
+               }
+       } else
+               memcpy(suf, TMPNAME_SUFFIX, TMPNAME_SUFFIX_LEN+1);
 
        return 1;
 }
@@ -132,25 +183,35 @@ int get_tmpname(char *fnametmp, const char *fname)
 int open_tmpfile(char *fnametmp, const char *fname, struct file_struct *file)
 {
        int fd;
+       mode_t added_perms;
 
-       if (!get_tmpname(fnametmp, fname))
+       if (!get_tmpname(fnametmp, fname, False))
                return -1;
 
+       if (am_root < 0) {
+               /* For --fake-super, the file must be useable by the copying
+                * user, just like it would be for root. */
+               added_perms = S_IRUSR|S_IWUSR;
+       } else {
+               /* For a normal copy, we need to be able to tweak things like xattrs. */
+               added_perms = S_IWUSR;
+       }
+
        /* We initially set the perms without the setuid/setgid bits or group
         * access to ensure that there is no race condition.  They will be
         * correctly updated after the right owner and group info is set.
         * (Thanks to snabb@epipe.fi for pointing this out.) */
-       fd = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
+       fd = do_mkstemp(fnametmp, (file->mode|added_perms) & INITACCESSPERMS);
 
 #if 0
        /* In most cases parent directories will already exist because their
         * information should have been previously transferred, but that may
         * not be the case with -R */
        if (fd == -1 && relative_paths && errno == ENOENT
-           && create_directory_path(fnametmp) == 0) {
+        && make_path(fnametmp, MKP_SKIP_SLASH | MKP_DROP_NAME) == 0) {
                /* Get back to name with XXXXXX in it. */
-               get_tmpname(fnametmp, fname);
-               fd = do_mkstemp(fnametmp, file->mode & INITACCESSPERMS);
+               get_tmpname(fnametmp, fname, False);
+               fd = do_mkstemp(fnametmp, (file->mode|added_perms) & INITACCESSPERMS);
        }
 #endif
 
@@ -175,6 +236,22 @@ static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
        char *data;
        int32 i;
        char *map = NULL;
+#ifdef SUPPORT_PREALLOCATION
+#ifdef PREALLOCATE_NEEDS_TRUNCATE
+       OFF_T preallocated_len = 0;
+#endif
+
+       if (preallocate_files && fd != -1 && total_size > 0) {
+               /* Try to preallocate enough space for file's eventual length.  Can
+                * reduce fragmentation on filesystems like ext4, xfs, and NTFS. */
+               if (do_fallocate(fd, 0, total_size) == 0) {
+#ifdef PREALLOCATE_NEEDS_TRUNCATE
+                       preallocated_len = total_size;
+#endif
+               } else
+                       rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(fname));
+       }
+#endif
 
        read_sum_head(f_in, &sum);
 
@@ -195,7 +272,7 @@ static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
                sum.flength = (OFF_T)sum.count * sum.blength;
                if (sum.remainder)
                        sum.flength -= sum.blength - sum.remainder;
-               if (append_mode == 2) {
+               if (append_mode == 2 && mapbuf) {
                        for (j = CHUNK_SIZE; j < sum.flength; j += CHUNK_SIZE) {
                                if (INFO_GTE(PROGRESS, 1))
                                        show_progress(offset, total_size);
@@ -222,6 +299,9 @@ static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
                if (INFO_GTE(PROGRESS, 1))
                        show_progress(offset, total_size);
 
+               if (allowed_lull)
+                       maybe_send_keepalive(time(NULL), MSK_ALLOW_FLUSH | MSK_ACTIVE_RECEIVER);
+
                if (i > 0) {
                        if (DEBUG_GTE(DELTASUM, 3)) {
                                rprintf(FINFO,"data recv %d at %s\n",
@@ -249,8 +329,9 @@ static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
 
                if (DEBUG_GTE(DELTASUM, 3)) {
                        rprintf(FINFO,
-                               "chunk[%d] of size %ld at %s offset=%s\n",
-                               i, (long)len, big_num(offset2), big_num(offset));
+                               "chunk[%d] of size %ld at %s offset=%s%s\n",
+                               i, (long)len, big_num(offset2), big_num(offset),
+                               updating_basis_or_equiv && offset == offset2 ? " (seek)" : "");
                }
 
                if (mapbuf) {
@@ -285,8 +366,14 @@ static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
                goto report_write_error;
 
 #ifdef HAVE_FTRUNCATE
-       if (inplace && fd != -1
-        && ftruncate(fd, offset) < 0) {
+       /* inplace: New data could be shorter than old data.
+        * preallocate_files: total_size could have been an overestimate.
+        *     Cut off any extra preallocated zeros from dest file. */
+       if ((inplace
+#ifdef PREALLOCATE_NEEDS_TRUNCATE
+         || preallocated_len > offset
+#endif
+         ) && fd != -1 && do_ftruncate(fd, offset) < 0) {
                rsyserr(FERROR_XFER, errno, "ftruncate failed on %s",
                        full_fname(fname));
        }
@@ -295,7 +382,7 @@ static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
        if (INFO_GTE(PROGRESS, 1))
                end_progress(total_size);
 
-       if (fd != -1 && offset > 0 && sparse_end(fd) != 0) {
+       if (fd != -1 && offset > 0 && sparse_end(fd, offset) != 0) {
            report_write_error:
                rsyserr(FERROR_XFER, errno, "write failed on %s",
                        full_fname(fname));
@@ -393,6 +480,9 @@ static int gen_wants_ndx(int desired_ndx, int flist_num)
        if (got_eof)
                return 0;
 
+       /* TODO: integrate gen-reading I/O into perform_io() so this is not needed? */
+       io_flush(FULL_FLUSH);
+
        while (next_ndx < desired_ndx) {
                if (inc_recurse && flist_num <= done_cnt)
                        return 0;
@@ -420,7 +510,7 @@ static int gen_wants_ndx(int desired_ndx, int flist_num)
  * main routine for receiver process.
  *
  * Receiver process runs on the same host as the generator process. */
-int recv_files(int f_in, char *local_name)
+int recv_files(int f_in, int f_out, char *local_name)
 {
        int fd1,fd2;
        STRUCT_STAT st;
@@ -432,7 +522,6 @@ int recv_files(int f_in, char *local_name)
        char fnamecmpbuf[MAXPATHLEN];
        uchar fnamecmp_type;
        struct file_struct *file;
-       struct stats initial_stats;
        int itemizing = am_server ? logfile_format_has_i : stdout_format_has_i;
        enum logcode log_code = log_before_transfer ? FLOG : FINFO;
        int max_phase = protocol_version >= 29 ? 2 : 1;
@@ -452,7 +541,7 @@ int recv_files(int f_in, char *local_name)
                cleanup_disable();
 
                /* This call also sets cur_flist. */
-               ndx = read_ndx_and_attrs(f_in, &iflags, &fnamecmp_type,
+               ndx = read_ndx_and_attrs(f_in, f_out, &iflags, &fnamecmp_type,
                                         xname, &xlen);
                if (ndx == NDX_DONE) {
                        if (!am_server && INFO_GTE(PROGRESS, 2) && cur_flist) {
@@ -477,7 +566,7 @@ int recv_files(int f_in, char *local_name)
                                rprintf(FINFO, "recv_files phase=%d\n", phase);
                        if (phase == 2 && delay_updates)
                                handle_delayed_updates(local_name);
-                       send_msg(MSG_DONE, "", 0, 0);
+                       write_int(f_out, NDX_DONE);
                        continue;
                }
 
@@ -491,14 +580,16 @@ int recv_files(int f_in, char *local_name)
                        rprintf(FINFO, "recv_files(%s)\n", fname);
 
 #ifdef SUPPORT_XATTRS
-               if (iflags & ITEM_REPORT_XATTR && !dry_run)
+               if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && do_xfers
+                && (protocol_version < 31 || !BITS_SET(iflags, ITEM_XNAME_FOLLOWS|ITEM_LOCAL_CHANGE)))
                        recv_xattr_request(file, f_in);
 #endif
 
                if (!(iflags & ITEM_TRANSFER)) {
                        maybe_log_item(file, iflags, itemizing, xname);
 #ifdef SUPPORT_XATTRS
-                       if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && !dry_run)
+                       if (preserve_xattrs && iflags & ITEM_REPORT_XATTR && do_xfers
+                        && !BITS_SET(iflags, ITEM_XNAME_FOLLOWS|ITEM_LOCAL_CHANGE))
                                set_file_attrs(fname, file, NULL, fname, 0);
 #endif
                        if (iflags & ITEM_IS_NEW) {
@@ -577,14 +668,17 @@ int recv_files(int f_in, char *local_name)
                        }
                }
 
+               if (!log_before_transfer)
+                       remember_initial_stats();
+
                if (!do_xfers) { /* log the transfer */
-                       log_item(FCLIENT, file, &stats, iflags, NULL);
+                       log_item(FCLIENT, file, iflags, NULL);
                        if (read_batch)
                                discard_receive_data(f_in, F_LENGTH(file));
                        continue;
                }
                if (write_batch < 0) {
-                       log_item(FCLIENT, file, &stats, iflags, NULL);
+                       log_item(FCLIENT, file, iflags, NULL);
                        if (!am_server)
                                discard_receive_data(f_in, F_LENGTH(file));
                        continue;
@@ -642,8 +736,6 @@ int recv_files(int f_in, char *local_name)
                                fnamecmp = fname;
                }
 
-               initial_stats = stats;
-
                /* open the file */
                fd1 = do_open(fnamecmp, O_RDONLY, 0);
 
@@ -738,7 +830,7 @@ int recv_files(int f_in, char *local_name)
 
                /* log the transfer */
                if (log_before_transfer)
-                       log_item(FCLIENT, file, &initial_stats, iflags, NULL);
+                       log_item(FCLIENT, file, iflags, NULL);
                else if (!am_server && INFO_GTE(NAME, 1) && INFO_EQ(PROGRESS, 1))
                        rprintf(FINFO, "%s\n", fname);
 
@@ -746,7 +838,7 @@ int recv_files(int f_in, char *local_name)
                recv_ok = receive_data(f_in, fnamecmp, fd1, st.st_size,
                                       fname, fd2, F_LENGTH(file));
 
-               log_item(log_code, file, &initial_stats, iflags, NULL);
+               log_item(log_code, file, iflags, NULL);
 
                if (fd1 != -1)
                        close(fd1);