9 releases (breaking)
0.23.0 | Oct 28, 2024 |
---|---|
0.22.1 | Sep 2, 2024 |
0.22.0 | Jun 22, 2024 |
0.21.1 | Feb 23, 2024 |
0.1.0 | Jan 24, 2024 |
#669 in Filesystem
627 downloads per month
Used in xcp
100KB
2K
SLoC
libxcp: High-level file-copy engine
libxcp
is a high-level file-copy engine. It has a support for multi-threading,
fine-grained progress feedback, pluggable drivers, and .gitignore
filters.
libxcp
is the core functionality of the xcp
command-line utility.
Features
- On Linux it uses
copy_file_range
call to copy files. This is the most efficient method of file-copying under Linux; in particular it is filesystem-aware, and can massively speed-up copies on network mounts by performing the copy operations server-side. However, unlikecopy_file_range
sparse files are detected and handled appropriately. - Support for modern filesystem features such as reflinks.
- Optimised for 'modern' systems (i.e. multiple cores, copious RAM, and solid-state disks, especially ones connected into the main system bus, e.g. NVMe).
- Optional aggressive parallelism for systems with parallel IO. Quick experiments on a modern laptop suggest there may be benefits to parallel copies on NVMe disks. This is obviously highly system-dependent.
- Switchable 'drivers' to facilitate experimenting with alternative strategies
for copy optimisation. Currently 2 drivers are available:
- 'parfile': the previous hard-coded xcp copy method, which parallelises tree-walking and per-file copying. This is the default.
- 'parblock': An experimental driver that parallelises copying at the block level. This has the potential for performance improvements in some architectures, but increases complexity. Testing is welcome.
- Non-Linux Unix-like OSs (OS X, *BSD) are supported via fall-back operation (although sparse-files are not yet supported in this case).
- Optionally understands
.gitignore
files to limit the copied directories.
Testing
libxcp
itself doesn't have many tests; the top-level xcp
application however
has a full functional test suite, including fuzzed stress-tests. This should be
considered the test suite for now.
Dependencies
~16–25MB
~478K SLoC