std.os: take advantage of the freebsd's copy_file_range

Author: alichraghi

lib/std/c/freebsd.zig

@@ -1449,6 +1449,7 @@ pub const E = enum(u16) {
     CAPMODE = 94, // Not permitted in capability mode
     NOTRECOVERABLE = 95, // State not recoverable
     OWNERDEAD = 96, // Previous owner died
+    INTEGRITY = 97, // Integrity check failed
     _,
 };
 
@@ -1884,3 +1885,4 @@ pub const MFD = struct {
 };
 
 pub extern "c" fn memfd_create(name: [*:0]const u8, flags: c_uint) c_int;
+pub extern "c" fn copy_file_range(fd_in: fd_t, off_in: ?*off_t, fd_out: fd_t, off_out: ?*off_t, len: usize, flags: u32) usize;

lib/std/fs/file.zig

@@ -1235,8 +1235,7 @@ pub const File = struct {
 
     pub fn copyRange(in: File, in_offset: u64, out: File, out_offset: u64, len: u64) CopyRangeError!u64 {
         const adjusted_len = math.cast(usize, len) orelse math.maxInt(usize);
-        const result = try os.copy_file_range(in.handle, in_offset, out.handle, out_offset, adjusted_len, 0);
-        return result;
+        return os.copy_file_range(in.handle, in_offset, out.handle, out_offset, adjusted_len, 0);
     }
 
     /// Returns the number of bytes copied. If the number read is smaller than `buffer.len`, it

lib/std/os.zig

@@ -6256,6 +6256,8 @@ pub const CopyFileRangeError = error{
     Unseekable,
     PermissionDenied,
     SwapFile,
+    CorruptedData,
+    RangeOverlap,
 } || PReadError || PWriteError || UnexpectedError;
 
 var has_copy_file_range_syscall = std.atomic.Atomic(bool).init(true);
@@ -6281,44 +6283,68 @@ var has_copy_file_range_syscall = std.atomic.Atomic(bool).init(true);
 ///
 /// These systems support in-kernel data copying:
 /// * Linux 4.5 (cross-filesystem 5.3)
+/// * FreeBSD 13.0
 ///
 /// Other systems fall back to calling `pread` / `pwrite`.
 ///
-/// Maximum offsets on Linux are `math.maxInt(i64)`.
+/// Maximum offsets on Linux and FreeBSD are `math.maxInt(i64)`.
 pub fn copy_file_range(fd_in: fd_t, off_in: u64, fd_out: fd_t, off_out: u64, len: usize, flags: u32) CopyFileRangeError!usize {
-    const call_cfr = comptime if (builtin.os.tag == .wasi)
-        // WASI-libc doesn't have copy_file_range.
-        false
-    else if (builtin.link_libc)
-        std.c.versionCheck(.{ .major = 2, .minor = 27, .patch = 0 }).ok
-    else
-        builtin.os.isAtLeast(.linux, .{ .major = 4, .minor = 5 }) orelse true;
-
-    if (call_cfr and has_copy_file_range_syscall.load(.Monotonic)) {
-        var off_in_copy = @bitCast(i64, off_in);
-        var off_out_copy = @bitCast(i64, off_out);
-
-        const rc = system.copy_file_range(fd_in, &off_in_copy, fd_out, &off_out_copy, len, flags);
-        switch (system.getErrno(rc)) {
-            .SUCCESS => return @intCast(usize, rc),
-            .BADF => return error.FilesOpenedWithWrongFlags,
-            .FBIG => return error.FileTooBig,
-            .IO => return error.InputOutput,
-            .ISDIR => return error.IsDir,
-            .NOMEM => return error.OutOfMemory,
-            .NOSPC => return error.NoSpaceLeft,
-            .OVERFLOW => return error.Unseekable,
-            .PERM => return error.PermissionDenied,
-            .TXTBSY => return error.SwapFile,
-            // these may not be regular files, try fallback
-            .INVAL => {},
-            // support for cross-filesystem copy added in Linux 5.3, use fallback
-            .XDEV => {},
-            // syscall added in Linux 4.5, use fallback
-            .NOSYS => {
-                has_copy_file_range_syscall.store(false, .Monotonic);
+    // WASI-libc doesn't have copy_file_range.
+    if (builtin.os.tag != .wasi) {
+        switch (builtin.os.tag) {
+            .linux => {
+                if (std.c.versionCheck(.{ .major = 2, .minor = 27, .patch = 0 }).ok and
+                    builtin.os.isAtLeast(.linux, .{ .major = 4, .minor = 5 }) orelse true and
+                    has_copy_file_range_syscall.load(.Monotonic))
+                {
+                    var off_in_copy = @bitCast(i64, off_in);
+                    var off_out_copy = @bitCast(i64, off_out);
+
+                    const rc = system.copy_file_range(fd_in, &off_in_copy, fd_out, &off_out_copy, len, flags);
+                    switch (system.getErrno(rc)) {
+                        .SUCCESS => return @intCast(usize, rc),
+                        .BADF => return error.FilesOpenedWithWrongFlags,
+                        .FBIG => return error.FileTooBig,
+                        .IO => return error.InputOutput,
+                        .ISDIR => return error.IsDir,
+                        .NOMEM => return error.OutOfMemory,
+                        .NOSPC => return error.NoSpaceLeft,
+                        .OVERFLOW => return error.Unseekable,
+                        .PERM => return error.PermissionDenied,
+                        .TXTBSY => return error.SwapFile,
+                        // these may not be regular files, try fallback
+                        .INVAL => {},
+                        // support for cross-filesystem copy added in Linux 5.3, use fallback
+                        .XDEV => {},
+                        // syscall added in Linux 4.5, use fallback
+                        .NOSYS => {
+                            has_copy_file_range_syscall.store(false, .Monotonic);
+                        },
+                        else => |err| return unexpectedErrno(err),
+                    }
+                }
             },
-            else => |err| return unexpectedErrno(err),
+            .freebsd => {
+                if (builtin.os.isAtLeast(.freebsd, .{ .major = 13, .minor = 0 }) orelse true) {
+                    var off_in_copy = @bitCast(i64, off_in);
+                    var off_out_copy = @bitCast(i64, off_out);
+                    const rc = freebsd.copy_file_range(fd_in, &off_in_copy, fd_out, &off_out_copy, len, flags);
+                    switch (system.getErrno(rc)) {
+                        .SUCCESS => return @intCast(usize, rc),
+                        .BADF => return error.FilesOpenedWithWrongFlags,
+                        .FBIG => return error.FileTooBig,
+                        .INVAL => return error.RangeOverlap,
+                        .IO => return error.InputOutput,
+                        .INTEGRITY => return error.CorruptedData,
+                        .ISDIR => return error.IsDir,
+                        .NOSPC => return error.NoSpaceLeft,
+                        .INTR => unreachable,
+                        else => |err| return unexpectedErrno(err),
+                    }
+                }
+            },
+            // unsupported OS, use fallback
+            else => {},
         }
     }
 

src/link.zig

@@ -433,6 +433,8 @@ pub const File = struct {
         Unseekable,
         PermissionDenied,
         SwapFile,
+        CorruptedData,
+        RangeOverlap,
         SystemResources,
         OperationAborted,
         BrokenPipe,