CopyOnWrite 0.1.7

The CopyOnWrite library provides a .NET layer on top of OS-specific logic that provides copy-on-write linking for files (a.k.a. CoW, file cloning, or reflinking). CoW linking provides the ability to copy a file without actually copying the original file's bytes from one disk location to another. The filesystem is in charge of ensuring that if the original file is modified or deleted, the CoW linked files remain unmodified by lazily copying the original file's bytes into each link. Unlike symlinks or hardlinks, writes to CoW links do not write through to the original file, as the filesystem breaks the link and copies in a lazy fashion. This enables scenarios like file caches where a single copy of a file held in a content-addressable or other store is safely linked to many locations in a filesystem with low I/O overhead.

This library allows a .NET developer to:

• Discover whether CoW links are allowed between two filesystem paths,
• Discover whether CoW links are allowed for a directory tree based at a specific root directory,
• Create CoW links,
• Find filesystem CoW link limits.

Discovery is important, as different operating systems and different filesystems available for those operating systems provide varying levels of CoW link support:

• Windows: The default NTFS filesystem does NOT support CoW, but the ReFS filesystem does.
• Linux: Btrfs, Xfs, Zfs support CoW while ext4 does not.
• Mac: AppleFS supports CoW by default.

When using this library you may need to create a wrapper that copies the file if CoW is not available.

Example

using Microsoft.CopyOnWrite;

ICopyOnWriteFilesystem cow = CopyOnWriteFilesystemFactory.GetInstance();
bool canCloneInCurrentDirectory = cow.CopyOnWriteLinkSupportedInDirectoryTree(Environment.CurrentDirectory);
if (canCloneInCurrentDirectory)
{
    cow.CloneFile(existingFile, cowLinkFilePath);
}

Release History

NuGet package:

• 0.1.7 April 2022: Perf improvement for Windows CoW link creation by reducing kernel round-trips
• 0.1.6 April 2022: Perf improvement for all Windows APIs
• 0.1.5 October 2021: Separate exception type for when link limit is exceeded. Mac and Linux throw NotSupportedException.
• 0.1.4 October 2021: Fix doc XML naming. Mac and Linux throw NotSupportedException.
• 0.1.3 October 2021: Bug fixes for Windows. Mac and Linux throw NotSupportedException.
• 0.1.2 October 2021: Performance fixes for Windows. Mac and Linux throw NotSupportedException.
• 0.1.1 October 2021: Bug fixes for Windows. Mac and Linux throw NotSupportedException.
• 0.1.0 July 2021: Windows ReFS support. Mac and Linux throw NotSupportedException.

Performance Comparisons

Windows

CoW links on ReFS take approximately constant time, saving time over file copies except at file size zero. The savings is proportional to the file size, with 16MB files at about 35X performance, 1MB at 3.2X, and small sizes at about 1.3X.

Detailed numbers for a VHD formatted empty with ReFS for each iteration, comparing System.IO.File.Copy() with CloneFile(), 25 copies/clones of a single source file per measurement. See CoWComparisons.cs. Machine was an 8/16-core M.2 SSD, Win10 21H1 Enterprise.

Same benchmark performed on a ReFS partition (no VHD) on an M.2 SSD:

Contributing

This project welcomes contributions and suggestions. See CONTRIBUTING.md.