Ticket #5082: add file cloning support for FreeBSD, macOS and Solaris

Signed-off-by: Phil Krylov <phil@krylov.eu>
Signed-off-by: Yury V. Zaytsev <yury@shurup.com>

Author: tuffnatty

configure.ac

@@ -380,12 +380,56 @@ case $host_os in
     AC_DEFINE([PTY_ZEROREAD], [1], [read(1) can return 0 for a non-closed fd])
 esac
 
-dnl Check linux/fs.h for FICLONE to support BTRFS's file clone operation
+dnl Check linux/fs.h for FICLONERANGE to support file clone operation
 case $host_os in
 linux*)
     AC_CHECK_HEADERS([linux/fs.h])
+    AC_MSG_CHECKING([for FICLONERANGE])
+    AC_EGREP_CPP([FICLONERANGE_IS_DEFINED],
+        [
+            #include <linux/fs.h>
+            #ifdef FICLONERANGE
+            FICLONERANGE_IS_DEFINED
+            #endif
+        ],
+        [
+            have_ficlonerange=yes
+            AC_DEFINE(HAVE_FICLONERANGE, 1, [Define if FICLONERANGE is supported on Linux])
+            AC_MSG_RESULT(yes)
+        ],
+        [
+            AC_MSG_RESULT(no)
+        ])
 esac
 
+dnl Check for copy_file_range(2) support (FreeBSD 13+)
+case $host_os in
+freebsd*)
+    AC_CHECK_FUNCS(copy_file_range)
+esac
+
+dnl Check for reflink(3C) support (Solaris 11.3+)
+case $host_os in
+solaris*)
+    AC_CHECK_FUNCS(reflink)
+esac
+
+dnl Check for clonefile(2) support (macOS 10.12+)
+case $host_os in
+darwin*)
+    AC_CHECK_HEADERS([sys/clonefile.h])
+esac
+
+if test "x$have_ficlonerange" = xyes || \
+   test "x$ac_cv_func_copy_file_range" = xyes; then
+    AC_DEFINE([HAVE_FILE_CLONING_BY_RANGE], [1], [Define if system can clone files by range])
+fi
+
+if test "x$ac_cv_header_sys_clonefile_h" = xyes || \
+   test "x$ac_cv_func_reflink" = xyes; then
+    AC_DEFINE([HAVE_FILE_CLONING_BY_PATH], [1], [Define if system can clone files by path])
+fi
+
 dnl Check if the OS is supported by the console saver.
 cons_saver=""
 case $host_os in

lib/global.c

@@ -46,8 +46,7 @@
 
 /*** global variables ****************************************************************************/
 
-mc_global_t mc_global =
-{
+mc_global_t mc_global = {
     .mc_version = MC_CURRENT_VERSION,
 
     .mc_run_mode = MC_RUN_FULL,
@@ -70,28 +69,26 @@ mc_global_t mc_global =
     .we_are_background = FALSE,
 #endif
 
-    .widget =
-    {
+    .widget = {
         .confirm_history_cleanup = TRUE,
         .show_all_if_ambiguous = FALSE,
-        .is_right = FALSE
+        .is_right = FALSE,
     },
 
     .shell = NULL,
 
-    .tty =
-    {
+    .tty = {
         .skin = NULL,
         .shadows = TRUE,
         .setup_color_string = NULL,
         .term_color_string = NULL,
         .color_terminal_string = NULL,
+
 #ifndef LINUX_CONS_SAVER_C
         .console_flag = '\0',
 #endif
 
         .use_subshell = SUBSHELL_USE,
-
 #ifdef ENABLE_SUBSHELL
         .subshell_pty = 0,
 #endif
@@ -102,14 +99,14 @@ mc_global_t mc_global =
         .disable_colors = FALSE,
         .ugly_line_drawing = FALSE,
         .old_mouse = FALSE,
-        .alternate_plus_minus = FALSE
+        .alternate_plus_minus = FALSE,
     },
 
-    .vfs =
-    {
+    .vfs = {
         .cd_symlinks = TRUE,
         .preallocate_space = FALSE,
-    }
+        .file_cloning = TRUE,
+    },
 
 };
 

lib/global.h

@@ -220,6 +220,8 @@ typedef struct
         // Preallocate space before file copying
         gboolean preallocate_space;
 
+        // Use COW file cloning on supported filesystems
+        gboolean file_cloning;
     } vfs;
 } mc_global_t;
 

lib/util.h

@@ -223,6 +223,9 @@ MC_MOCKABLE sighandler_t my_signal (int signum, sighandler_t handler);
 MC_MOCKABLE int my_sigaction (int signum, const struct sigaction *act, struct sigaction *oldact);
 MC_MOCKABLE pid_t my_fork (void);
 MC_MOCKABLE int my_execvp (const char *file, char *const argv[]);
+#ifdef HAVE_SYS_CLONEFILE_H
+MC_MOCKABLE int my_clonefile (const char *src, const char *dst, uint32_t flags);
+#endif
 MC_MOCKABLE char *my_get_current_dir (void);
 
 // Process spawning

lib/utilunix.c

@@ -56,6 +56,9 @@
 #include <sys/wait.h>
 #include <pwd.h>
 #include <grp.h>
+#ifdef HAVE_SYS_CLONEFILE_H
+#include <sys/clonefile.h>
+#endif
 
 #include "lib/global.h"
 
@@ -389,6 +392,19 @@ my_execvp (const char *file, char *const argv[])
     return execvp (file, argv);
 }
 
+#ifdef HAVE_SYS_CLONEFILE_H
+/* --------------------------------------------------------------------------------------------- */
+/**
+ * Wrapper for clonefile() system call on macOS.
+ */
+
+int
+my_clonefile (const char *src, const char *dst, uint32_t flags)
+{
+    return clonefile (src, dst, flags);
+}
+#endif
+
 /* --------------------------------------------------------------------------------------------- */
 /**
  * Wrapper for g_get_current_dir() library function.

lib/vfs/vfs.c

@@ -46,13 +46,15 @@
 #include <errno.h>
 #include <stdlib.h>
 
-#ifdef __linux__
-#ifdef HAVE_LINUX_FS_H
-#include <linux/fs.h>
-#endif
-#ifdef HAVE_SYS_IOCTL_H
-#include <sys/ioctl.h>
-#endif
+#ifdef HAVE_FICLONERANGE
+#include <linux/fs.h>   // FICLONERANGE
+#include <sys/ioctl.h>  // ioctl()
+#elif defined(HAVE_COPY_FILE_RANGE)
+#include <unistd.h>  // COPY_FILE_RANGE_CLONE
+#elif defined(HAVE_SYS_CLONEFILE_H)
+#include <sys/clonefile.h>  // CLONE_NOOWNERCOPY
+#elif defined(HAVE_REFLINK)
+#include <unistd.h>  // reflink()
 #endif
 
 #include "lib/global.h"
@@ -720,11 +722,12 @@ vfs_preallocate (int dest_vfs_fd, off_t src_fsize, off_t dest_fsize)
 int
 vfs_clone_file (int dest_vfs_fd, int src_vfs_fd)
 {
-#ifdef FICLONE
+#ifdef HAVE_FILE_CLONING_BY_RANGE
     void *dest_fd = NULL;
     void *src_fd = NULL;
     struct vfs_class *dest_class;
     struct vfs_class *src_class;
+    off_t in_offset, out_offset;
 
     dest_class = vfs_class_find_by_handle (dest_vfs_fd, &dest_fd);
     if ((dest_class->flags & VFSF_LOCAL) == 0)
@@ -750,7 +753,38 @@ vfs_clone_file (int dest_vfs_fd, int src_vfs_fd)
         return (-1);
     }
 
-    return ioctl (*(int *) dest_fd, FICLONE, *(int *) src_fd);
+    in_offset = mc_lseek (src_vfs_fd, 0, SEEK_CUR);
+    if (in_offset < 0)
+        return (-1);
+    out_offset = mc_lseek (dest_vfs_fd, 0, SEEK_CUR);
+    if (out_offset < 0)
+        return (-1);
+
+#if defined(FICLONERANGE)
+    {
+        struct file_clone_range fcr = {
+            .src_fd = *(int *) src_fd,
+            .src_offset = in_offset,
+            .src_length = 0,
+            .dest_offset = out_offset,
+        };
+
+        return ioctl (*(int *) dest_fd, FICLONERANGE, &fcr);
+    }
+#elif defined(COPY_FILE_RANGE_CLONE)
+    {
+        ssize_t result;
+
+        do
+        {
+            result = copy_file_range (*(int *) src_fd, &in_offset, *(int *) dest_fd, &out_offset,
+                                      SSIZE_MAX, COPY_FILE_RANGE_CLONE);
+        }
+        while (result > 0);
+        return result;
+    }
+#endif
+
 #else
     (void) dest_vfs_fd;
     (void) src_vfs_fd;
@@ -760,3 +794,40 @@ vfs_clone_file (int dest_vfs_fd, int src_vfs_fd)
 }
 
 /* --------------------------------------------------------------------------------------------- */
+
+int
+vfs_clone_file_by_path (const vfs_path_t *dest_vpath, const vfs_path_t *src_vpath,
+                        gboolean preserve_uidgid)
+{
+#ifdef HAVE_FILE_CLONING_BY_PATH
+    const char *src_path;
+    const char *dest_path;
+
+    if (!vfs_file_is_local (dest_vpath) || !vfs_file_is_local (src_vpath))
+    {
+        errno = ENOTSUP;
+        return (-1);
+    }
+
+    src_path = vfs_path_get_last_path_str (src_vpath);
+    dest_path = vfs_path_get_last_path_str (dest_vpath);
+
+#if defined(HAVE_SYS_CLONEFILE_H)
+#ifndef CLONE_NOOWNERCOPY  // macOS 10.13+
+#define CLONE_NOOWNERCOPY 0
+#endif
+    return my_clonefile (src_path, dest_path, preserve_uidgid ? 0 : CLONE_NOOWNERCOPY);
+#elif defined(HAVE_REFLINK)
+    return reflink (src_path, dest_path, preserve_uidgid);
+#endif
+
+#else
+    (void) dest_vpath;
+    (void) src_vpath;
+    (void) preserve_uidgid;
+    errno = ENOTSUP;
+    return (-1);
+#endif
+}
+
+/* --------------------------------------------------------------------------------------------- */

lib/vfs/vfs.h

@@ -303,6 +303,8 @@ char *vfs_get_cwd (void);
 int vfs_preallocate (int dest_desc, off_t src_fsize, off_t dest_fsize);
 
 int vfs_clone_file (int dest_vfs_fd, int src_vfs_fd);
+int vfs_clone_file_by_path (const vfs_path_t *dest_vpath, const vfs_path_t *src_vpath,
+                            gboolean preserve_uidgid);
 
 /**
  * Interface functions described in interface.c

src/filemanager/boxes.c

@@ -569,6 +569,7 @@ configure_box (void)
                     QUICK_CHECKBOX (_ ("Mkdi&r autoname"), &auto_fill_mkdir_name, NULL),
                     QUICK_CHECKBOX (_ ("&Preallocate space"), &mc_global.vfs.preallocate_space,
                                     NULL),
+                    QUICK_CHECKBOX (_ ("Use COW file cloning"), &mc_global.vfs.file_cloning, NULL),
                 QUICK_STOP_GROUPBOX,
                 QUICK_START_GROUPBOX (_ ("Esc key mode")),
                     QUICK_CHECKBOX (_ ("S&ingle press"), &old_esc_mode, &configure_old_esc_mode_id),
@@ -619,17 +620,22 @@ configure_box (void)
         g_snprintf (time_out, sizeof (time_out), "%d", old_esc_mode_timeout);
 
 #ifndef USE_INTERNAL_EDIT
-        quick_widgets[17].state = WST_DISABLED;
+        quick_widgets[18].state = WST_DISABLED;
 #endif
 
         if (!old_esc_mode)
-            quick_widgets[10].state = WST_DISABLED;
+            quick_widgets[11].state = WST_DISABLED;
 
 #ifndef HAVE_POSIX_FALLOCATE
         mc_global.vfs.preallocate_space = FALSE;
         quick_widgets[6].state = WST_DISABLED;
 #endif
 
+#if !defined(HAVE_FILE_CLONING_BY_RANGE) && !defined(HAVE_FILE_CLONING_BY_PATH)
+        mc_global.vfs.file_cloning = FALSE;
+        quick_widgets[7].state = WST_DISABLED;
+#endif
+
         if (quick_dialog (&qdlg) == B_ENTER)
         {
             if (time_out_new[0] == '\0')