Re: [PATCH 0/7] RFC: Accelerate xdiff and begin its rustification

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Ezekiel

Thanks for working on this

On 17/07/2025 21:32, Ezekiel Newren via GitGitGadget wrote:
This series accelerates xdiff by 5-19%.

It also introduces Rust as a hard dependency.

…and it doesn’t yet pass a couple of the github workflows; hints from
Windows experts, and opinions on ambiguous primitives would be appreciated
(see below).

This is just the beginning of many patches that I have to convert portions
of, maybe eventually all of, xdiff to Rust. While working on that
conversion, I found several ways to clarify the code, along with some
optimizations.

So...

This obviously raises the question of whether we are ready to accept a hard
dependency on Rust. Previous discussions on the mailing list and at Git
Merge 2024 have not answered that question. If not now, will we be willing
to accept such a hard dependency later? And what route do we want to take to
get there?

As far as git goes I think introducing a hard dependency on rust is fine. It is widely supported, the only issue I'm aware of is the lack of support on NonStop and I don't think it is reasonable for such a minority platform to hold the rest of the project to ransom. There is a question about the other users of the xdiff code though. libgit2 carries a copy as do other projects like neovim. I've cc'd the libgit2 maintainer and posted a link to this thread in neovim github [1]

I've left a few comments on the patches

Thanks

Phillip

[1] https://github.com/neovim/neovim/discussions/34987

About the optimizations in this series:

1. xdiff currently uses DJB2a for hashing (even though it is not explicitly named as such). This is an older hashing algorithm, and modern alternatives are superior. I chose xxhash because it’s faster, more collision resistant, and designed to be a standard. Other hash algorithms like aHash, MurMurHash, SipHash, and Fnv1a were considered, but my local testing made me feel like xxhash was the best choice for usage in xdiff.

2. In support of switching to xxhash, parsing and hashing were split into separate steps. And it turns out that memchr() is faster for parsing than character-by-character iteration.


About the workflow builds/tests that aren’t working with this series:

1. Windows fails to build. I don’t know which rust toolchain is even correct for this or if multiple are needed.  Example failed build: https://github.com/git/git/actions/runs/16353209191

2. I386/ubuntu:focal will build, but fails the tests. The kernel reports the bitness as 64 despite the container being 32. I believe the issue is that C uses ambiguous primitives (which differ in size between platforms). The new code should use unambiguous primitives from Rust (u32, u64, etc.) rather than perpetuating ambiguous primitive types.  Since the current xdiff API hardcodes the ambiguous types, though, those places will need to be migrated to unambiguous primitives. Much of the C code needs a slight refactor to be compatible with the Rust FFI and usually requires converting ambiguous to unambiguous types. What does this community think of this approach?


My brother (Elijah, cc’ed) has been guiding and reviewing my work here.

Ezekiel Newren (7):
   xdiff: introduce rust
   xdiff/xprepare: remove superfluous forward declarations
   xdiff: delete unnecessary fields from xrecord_t and xdfile_t
   xdiff: make fields of xrecord_t Rust friendly
   xdiff: separate parsing lines from hashing them
   xdiff: conditionally use Rust's implementation of xxhash
   github_workflows: install rust

  .github/workflows/main.yml |   1 +
  .gitignore                 |   1 +
  Makefile                   |  60 +++++++---
  build_rust.sh              |  59 ++++++++++
  ci/install-dependencies.sh |  14 +--
  ci/install-rust.sh         |  33 ++++++
  ci/lib.sh                  |   8 ++
  ci/make-test-artifacts.sh  |   7 ++
  ci/run-build-and-tests.sh  |  10 ++
  git-compat-util.h          |  17 +++
  meson.build                |  40 +++++--
  rust/Cargo.lock            |  21 ++++
  rust/Cargo.toml            |   6 +
  rust/interop/Cargo.toml    |  14 +++
  rust/interop/src/lib.rs    |   0
  rust/xdiff/Cargo.toml      |  16 +++
  rust/xdiff/src/lib.rs      |   7 ++
  xdiff/xdiffi.c             |   8 +-
  xdiff/xemit.c              |   2 +-
  xdiff/xmerge.c             |  14 +--
  xdiff/xpatience.c          |   2 +-
  xdiff/xprepare.c           | 226 ++++++++++++++++++-------------------
  xdiff/xtypes.h             |   9 +-
  xdiff/xutils.c             |   4 +-
  24 files changed, 414 insertions(+), 165 deletions(-)
  create mode 100755 build_rust.sh
  create mode 100644 ci/install-rust.sh
  create mode 100644 rust/Cargo.lock
  create mode 100644 rust/Cargo.toml
  create mode 100644 rust/interop/Cargo.toml
  create mode 100644 rust/interop/src/lib.rs
  create mode 100644 rust/xdiff/Cargo.toml
  create mode 100644 rust/xdiff/src/lib.rs


base-commit: 16bd9f20a403117f2e0d9bcda6c6e621d3763e77
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1980%2Fezekielnewren%2Fxdiff_rust_speedup-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1980/ezekielnewren/xdiff_rust_speedup-v1
Pull-Request: https://github.com/git/git/pull/1980





[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux