#file #cp #coreutils #command-line-tool

libxcp

xcp is an experimental and incomplete clone of the Unix cp command. This library is the core functionality, including drivers.

6 releases (breaking)

0.21.1 Feb 23, 2024
0.21.0 Feb 9, 2024
0.20.0 Feb 6, 2024
0.19.0 Feb 2, 2024
0.1.0 Jan 24, 2024

#1138 in Filesystem

Download history 37/week @ 2024-01-18 180/week @ 2024-01-25 314/week @ 2024-02-01 215/week @ 2024-02-08 84/week @ 2024-02-15 329/week @ 2024-02-22 80/week @ 2024-02-29 50/week @ 2024-03-07 61/week @ 2024-03-14 37/week @ 2024-03-21 32/week @ 2024-03-28 28/week @ 2024-04-04 36/week @ 2024-04-11 19/week @ 2024-04-18

117 downloads per month
Used in xcp

GPL-3.0-only

99KB
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.

Crates.io doc.rs Github Actions CircleCI

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, unlike copy_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

~14–24MB
~420K SLoC