Have configure check if fallocate() actually links, which works
authorWayne Davison <wayned@samba.org>
Tue, 29 Dec 2009 18:57:13 +0000 (10:57 -0800)
committerWayne Davison <wayned@samba.org>
Tue, 29 Dec 2009 19:05:42 +0000 (11:05 -0800)
around a glibc bug for a missing fallocate64() call.  Added detection
and support for fallocate()'s FALLOC_FL_KEEP_SIZE.

preallocate.diff

index 12a033e4c3f394f74dd745cce8990b973445e182..a5efade0674ab87163a905db4279a61a82d37a25 100644 (file)
@@ -21,15 +21,14 @@ diff --git a/compat.c b/compat.c
  extern int append_mode;
  extern int fuzzy_basis;
  extern int read_batch;
-@@ -189,6 +190,15 @@ void setup_protocol(int f_out,int f_in)
+@@ -189,6 +190,14 @@ void setup_protocol(int f_out,int f_in)
        if (read_batch)
                check_batch_flags();
  
 +#ifndef SUPPORT_PREALLOCATION
 +      if (preallocate_files && !am_sender) {
-+              rprintf(FERROR,
-+                      "preallocation is not supported on this %s\n",
-+                      am_server ? "server" : "client");
++              rprintf(FERROR, "preallocation is not supported on this %s\n",
++                      am_server ? "Server" : "Client");
 +              exit_cleanup(RERR_SYNTAX);
 +      }
 +#endif
@@ -44,20 +43,29 @@ diff --git a/configure.in b/configure.in
      memmove lchown vsnprintf snprintf vasprintf asprintf setsid strpbrk \
      strlcat strlcpy strtol mallinfo getgroups setgroups geteuid getegid \
      setlocale setmode open64 lseek64 mkstemp64 mtrace va_copy __va_copy \
-+    fallocate posix_fallocate \
++    posix_fallocate \
      seteuid strerror putenv iconv_open locale_charset nl_langinfo getxattr \
      extattr_get_link sigaction sigprocmask setattrlist)
  
-@@ -578,6 +579,33 @@ if test x"$ac_cv_func_iconv_open" != x"yes"; then
+@@ -578,6 +579,42 @@ if test x"$ac_cv_func_iconv_open" != x"yes"; then
      AC_CHECK_FUNC(libiconv_open, [ac_cv_func_iconv_open=yes; AC_DEFINE(HAVE_ICONV_OPEN, 1)])
  fi
  
 +dnl Preallocation stuff (also fallocate, posix_fallocate function tests above):
 +
++AC_CACHE_CHECK([for useable fallocate],rsync_cv_have_fallocate,[
++AC_TRY_LINK([#include <fcntl.h>
++#include <sys/types.h>],
++[fallocate(0, 0, 0, 0);],
++rsync_cv_have_fallocate=yes,rsync_cv_have_fallocate=no)])
++if test x"$rsync_cv_have_fallocate" = x"yes"; then
++    AC_DEFINE(HAVE_FALLOCATE, 1, [Define to 1 if you have the fallocate function and it compiles and links without error])
++fi
++
 +AC_CACHE_CHECK([for SYS_fallocate],rsync_cv_have_sys_fallocate,[
 +AC_TRY_COMPILE([#include <sys/syscall.h>
 +#include <sys/types.h>],
-+[syscall(SYS_fallocate, 0, 0, (loff_t) 0, (loff_t) 0);],
++[syscall(SYS_fallocate, 0, 0, (loff_t)0, (loff_t)0);],
 +rsync_cv_have_sys_fallocate=yes,rsync_cv_have_sys_fallocate=no)])
 +if test x"$rsync_cv_have_sys_fallocate" = x"yes"; then
 +    AC_DEFINE(HAVE_SYS_FALLOCATE, 1, [Define to 1 if you have the SYS_fallocate syscall number])
@@ -122,17 +130,19 @@ diff --git a/options.c b/options.c
  
  #ifdef MAINTAINER_MODE
        rprintf(f, "Panic Action: \"%s\"\n", get_panic_action());
-@@ -358,6 +363,9 @@ void usage(enum logcode F)
+@@ -358,6 +363,11 @@ void usage(enum logcode F)
    rprintf(F,"     --fake-super            store/recover privileged attrs using xattrs\n");
  #endif
    rprintf(F," -S, --sparse                handle sparse files efficiently\n");
 +#ifdef SUPPORT_PREALLOCATION
 +  rprintf(F,"     --preallocate           allocate dest files before writing them\n");
++#else
++  rprintf(F,"     --preallocate           pre-allocate dest files on remote receiver\n");
 +#endif
    rprintf(F," -n, --dry-run               perform a trial run with no changes made\n");
    rprintf(F," -W, --whole-file            copy files whole (without delta-xfer algorithm)\n");
    rprintf(F," -x, --one-file-system       don't cross filesystem boundaries\n");
-@@ -542,6 +550,7 @@ static struct poptOption long_options[] = {
+@@ -542,6 +552,7 @@ static struct poptOption long_options[] = {
    {"sparse",          'S', POPT_ARG_VAL,    &sparse_files, 1, 0, 0 },
    {"no-sparse",        0,  POPT_ARG_VAL,    &sparse_files, 0, 0, 0 },
    {"no-S",             0,  POPT_ARG_VAL,    &sparse_files, 0, 0, 0 },
@@ -140,7 +150,7 @@ diff --git a/options.c b/options.c
    {"inplace",          0,  POPT_ARG_VAL,    &inplace, 1, 0, 0 },
    {"no-inplace",       0,  POPT_ARG_VAL,    &inplace, 0, 0, 0 },
    {"append",           0,  POPT_ARG_NONE,   0, OPT_APPEND, 0, 0 },
-@@ -2069,6 +2078,9 @@ void server_options(char **args, int *argc_p)
+@@ -2069,6 +2080,9 @@ void server_options(char **args, int *argc_p)
        else if (remove_source_files)
                args[ac++] = "--remove-sent-files";
  
@@ -161,54 +171,66 @@ diff --git a/receiver.c b/receiver.c
  extern int keep_partial;
  extern int checksum_seed;
  extern int inplace;
-@@ -175,6 +176,18 @@ static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
+@@ -175,6 +176,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) {
-+              /* Preallocate enough space for file's eventual length if
-+               * possible; seems to reduce fragmentation on Windows. */
-+              if (do_fallocate(fd, 0, 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;
-+              else
++#endif
++              } else
 +                      rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(fname));
 +      }
 +#endif
  
        read_sum_head(f_in, &sum);
  
-@@ -285,7 +298,15 @@ static int receive_data(int f_in, char *fname_r, int fd_r, OFF_T size_r,
+@@ -285,8 +302,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 (fd != -1
-+#ifdef SUPPORT_PREALLOCATION
-+       && (inplace || preallocated_len > offset)
-+#else
-+       && inplace
++      if ((inplace
++#ifdef PREALLOCATE_NEEDS_TRUNCATE
++        || preallocated_len > offset
 +#endif
-        && ftruncate(fd, offset) < 0) {
++        ) && fd != -1 && ftruncate(fd, offset) < 0) {
                rsyserr(FERROR_XFER, errno, "ftruncate failed on %s",
                        full_fname(fname));
+       }
 diff --git a/rsync.h b/rsync.h
 --- a/rsync.h
 +++ b/rsync.h
-@@ -615,6 +615,13 @@ struct ht_int64_node {
+@@ -615,6 +615,21 @@ struct ht_int64_node {
  #define ACLS_NEED_MASK 1
  #endif
  
-+#if defined HAVE_FTRUNCATE \
-+    && (defined HAVE_FALLOCATE \
-+     || defined HAVE_SYS_FALLOCATE \
-+     || defined HAVE_EFFICIENT_POSIX_FALLOCATE)
++#if defined HAVE_FALLOCATE || HAVE_SYS_FALLOCATE
++#include <linux/falloc.h>
++#ifdef FALLOC_FL_KEEP_SIZE
++#define SUPPORT_PREALLOCATION 1
++#elif defined HAVE_FTRUNCATE
++#define SUPPORT_PREALLOCATION 1
++#define PREALLOCATE_NEEDS_TRUNCATE 1
++#endif
++#else /* !fallocate */
++#if defined HAVE_EFFICIENT_POSIX_FALLOCATE && defined HAVE_FTRUNCATE
 +#define SUPPORT_PREALLOCATION 1
++#define PREALLOCATE_NEEDS_TRUNCATE 1
++#endif
 +#endif
 +
  union file_extras {
@@ -225,21 +247,20 @@ diff --git a/rsync.yo b/rsync.yo
   -n, --dry-run               perform a trial run with no changes made
   -W, --whole-file            copy files whole (w/o delta-xfer algorithm)
   -x, --one-file-system       don't cross filesystem boundaries
-@@ -1060,6 +1061,18 @@ NOTE: Don't use this option when the destination is a Solaris "tmpfs"
+@@ -1060,6 +1061,17 @@ NOTE: Don't use this option when the destination is a Solaris "tmpfs"
  filesystem. It seems to have problems seeking over null regions,
  and ends up corrupting the files.
  
 +dit(bf(--preallocate)) This tells the receiver to allocate each destination
 +file to its eventual size before writing data to the file.  Rsync will only use
-+the real filesystem-level preallocation support provided by bf(fallocate)(2) or
-+Cygwin's bf(posix_fallocate)(3), not the slow glibc implementation that writes
-+a zero byte into each block.  If the receiver is remote, this nonstandard
-+option only works if the receiver also has the preallocation patch.
++the real filesystem-level preallocation support provided by Linux's
++bf(fallocate)(2) system call or Cygwin's bf(posix_fallocate)(3), not the slow
++glibc implementation that writes a zero byte into each block.
 +
-+Without this option on MS Windows, very large destination files tend to be
-+broken into thousands of fragments; advising Windows ahead of time of the
-+eventual file size using this option usually reduces the number of
-+fragments to one.  The usefulness of this option on Linux is yet to be tested.
++Without this option, larger files may not be entirely contiguous on the
++filesystem, but with this option rsync will probably copy more slowly.  If the
++destination is not an extent-supporting filesystem (such as ext4, xfs, NTFS,
++etc.), this option may have no positive effect at all.
 +
  dit(bf(-n, --dry-run)) This makes rsync perform a trial run that doesn't
  make any changes (and produces mostly the same output as a real run).  It
@@ -258,7 +279,7 @@ diff --git a/syscall.c b/syscall.c
  extern int dry_run;
  extern int am_root;
  extern int read_only;
-@@ -282,3 +286,21 @@ OFF_T do_lseek(int fd, OFF_T offset, int whence)
+@@ -282,3 +286,25 @@ OFF_T do_lseek(int fd, OFF_T offset, int whence)
        return lseek(fd, offset, whence);
  #endif
  }
@@ -266,17 +287,21 @@ diff --git a/syscall.c b/syscall.c
 +#ifdef SUPPORT_PREALLOCATION
 +int do_fallocate(int fd, OFF_T offset, OFF_T length)
 +{
++#ifdef FALLOC_FL_KEEP_SIZE
++#define DO_FALLOC_OPTIONS FALLOC_FL_KEEP_SIZE
++#else
++#define DO_FALLOC_OPTIONS 0
++#endif
 +      RETURN_ERROR_IF(dry_run, 0);
 +      RETURN_ERROR_IF_RO_OR_LO;
-+      /* TODO: Use FALLOC_FL_KEEP_SIZE to avoid the need to truncate. */
 +#if defined HAVE_FALLOCATE
-+      return fallocate(fd, 0, offset, length);
++      return fallocate(fd, DO_FALLOC_OPTIONS, offset, length);
 +#elif defined HAVE_SYS_FALLOCATE
-+      return syscall(SYS_fallocate, fd, 0, (loff_t) offset, (loff_t) length);
++      return syscall(SYS_fallocate, fd, DO_FALLOC_OPTIONS, (loff_t)offset, (loff_t)length);
 +#elif defined HAVE_EFFICIENT_POSIX_FALLOCATE
 +      return posix_fallocate(fd, offset, length);
 +#else
-+#error coding error in SUPPORT_PREALLOCATION
++#error Coding error in SUPPORT_PREALLOCATION logic.
 +#endif
 +}
 +#endif
@@ -302,57 +327,64 @@ diff --git a/util.c b/util.c
  extern int module_id;
  extern int modify_window;
  extern int relative_paths;
-@@ -276,6 +277,10 @@ int copy_file(const char *source, const char *dest, int ofd,
+@@ -276,6 +277,9 @@ int copy_file(const char *source, const char *dest, int ofd,
        int ifd;
        char buf[1024 * 8];
        int len;   /* Number of bytes read into `buf'. */
-+#ifdef SUPPORT_PREALLOCATION
-+      OFF_T preallocated_len = 0;
-+      OFF_T offset = 0;
++#ifdef PREALLOCATE_NEEDS_TRUNCATE
++      OFF_T preallocated_len = 0, offset = 0;
 +#endif
  
        if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
                int save_errno = errno;
-@@ -309,7 +314,27 @@ int copy_file(const char *source, const char *dest, int ofd,
+@@ -309,6 +313,25 @@ int copy_file(const char *source, const char *dest, int ofd,
                }
        }
  
 +#ifdef SUPPORT_PREALLOCATION
 +      if (preallocate_files) {
-+              /* Preallocate enough space for file's eventual length if
-+               * possible; seems to reduce fragmentation on Windows. */
 +              STRUCT_STAT srcst;
-+              if (do_fstat(ifd, &srcst) == 0) {
-+                      if (srcst.st_size > 0) {
-+                              if (do_fallocate(ofd, 0, srcst.st_size) == 0)
-+                                      preallocated_len = srcst.st_size;
-+                              else
-+                                      rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(dest));
-+                      }
-+              } else
++
++              /* Try to preallocate enough space for file's eventual length.  Can
++               * reduce fragmentation on filesystems like ext4, xfs, and NTFS. */
++              if (do_fstat(ifd, &srcst) < 0)
 +                      rsyserr(FWARNING, errno, "fstat %s", full_fname(source));
++              else if (srcst.st_size > 0) {
++                      if (do_fallocate(ofd, 0, srcst.st_size) == 0) {
++#ifdef PREALLOCATE_NEEDS_TRUNCATE
++                              preallocated_len = srcst.st_size;
++#endif
++                      } else
++                              rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(dest));
++              }
 +      }
 +#endif
 +
        while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
-+#ifdef SUPPORT_PREALLOCATION
-+              offset += len;
-+#endif
                if (full_write(ofd, buf, len) < 0) {
                        int save_errno = errno;
-                       rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
-@@ -334,6 +359,16 @@ int copy_file(const char *source, const char *dest, int ofd,
+@@ -318,6 +341,9 @@ int copy_file(const char *source, const char *dest, int ofd,
+                       errno = save_errno;
+                       return -1;
+               }
++#ifdef PREALLOCATE_NEEDS_TRUNCATE
++              offset += len;
++#endif
+       }
+       if (len < 0) {
+@@ -334,6 +360,16 @@ int copy_file(const char *source, const char *dest, int ofd,
                        full_fname(source));
        }
  
-+#ifdef SUPPORT_PREALLOCATION
++#ifdef PREALLOCATE_NEEDS_TRUNCATE
 +      /* Source file might have shrunk since we fstatted it.
 +       * Cut off any extra preallocated zeros from dest file. */
-+      if (preallocated_len > offset)
-+              if (ftruncate(ofd, offset) < 0)
-+                      /* If we fail to truncate, the dest file may be wrong, so we
-+                       * must trigger the "partial transfer" error. */
-+                      rsyserr(FERROR_XFER, errno, "ftruncate %s", full_fname(dest));
++      if (offset < preallocated_len && ftruncate(ofd, offset) < 0) {
++              /* If we fail to truncate, the dest file may be wrong, so we
++               * must trigger the "partial transfer" error. */
++              rsyserr(FERROR_XFER, errno, "ftruncate %s", full_fname(dest));
++      }
 +#endif
 +
        if (close(ofd) < 0) {