libgit2: Bump to v1.8.0 #1032

bnjmnt4n · 2024-03-02T14:33:37Z

This PR bumps libgit2 to v1.8.0, in preparation for #1031. I've bumped libgit2-sys to 0.17.0+1.8.0, but haven't touched the git2 version since I thought that's better left for the maintainers.

I haven't included any new Rust bindings for the new functions (e.g. git_commit_create_from_stage). Basically I've just done the bare minimum required to get the libgit2 v1.8.0 working.

API changes:

Remote:update_tips now accepts a RemoteUpdateFlags which is an integer consisting of bitfields instead of a boolean
FetchOptions: add report_unchanged method which updates the update_flags bitflag (similar to above)
PushOptions: add remote_push_options method to set remote push options
WorktreeAddOptions: add checkout_existing method to set the boolean checkout_existing option

References

https://github.com/libgit2/libgit2/blob/main/docs/changelog.md#v18

This commit changes the original `ssh` feature into two new ones: `ssh-libssh2` and `ssh-openssh`. By default, the `ssh-libssh2` feature is enabled for backwards compatibility. To use OpenSSH instead, the following listing in `Cargo.toml` can be used: git2-rs = { version = "...", default-features = false, features = ["https", "ssh-openssh"] } This commit is stacked on top of rust-lang#1032, and should only be merged after libgit2 v1.8.0 has been released. Closes rust-lang#1028.

bnjmnt4n · 2024-03-07T09:57:10Z

Looks like the current test failures are due to changes made in libgit2/libgit2#6743 👀

This commit changes the original `ssh` feature into two new ones: `ssh-libssh2` and `ssh-openssh`. By default, the `ssh-libssh2` feature is enabled for backwards compatibility. To use OpenSSH instead, the following listing in `Cargo.toml` can be used: git2-rs = { version = "...", default-features = false, features = ["https", "ssh-openssh"] } This commit is stacked on top of rust-lang#1032, and should only be merged after libgit2 v1.8.0 has been released. Closes rust-lang#1028.

bnjmnt4n · 2024-03-22T11:17:34Z

Looks like v1.8.0 is out! I will update the PR to bump the version.

See libgit2/libgit2#6439.

bnjmnt4n · 2024-03-22T13:28:38Z

This should be ready for review. (I'm pretty new to Rust and the libgit2 / this codebase, please do let me know if there are better ways to do anything.)

The test failures on Windows are related to libgit2/libgit2#6743 as mentioned above—I'm not too sure how to handle these conventionally using Rust.

ehuss · 2024-03-23T19:47:17Z

libgit2-sys/lib.rs

@@ -391,7 +402,7 @@ pub struct git_fetch_options {
    pub version: c_int,
    pub callbacks: git_remote_callbacks,
    pub prune: git_fetch_prune_t,
-    pub update_fetchhead: c_int,
+    pub update_flags: c_uint,


Hm, I'm not really confident this is the correct way to handle packed bitflags. I had the understanding that Rust doesn't really support packed bitflags, at least in a compatible way with C, since it depends on the compiler. Do you have some more information on why this might be safe?

You're right, I wasn't familiar with C bitfields, I originally thought they were just a convenient way of specifying bit-flags which are handled in a similar way to bitmasks for unsigned ints. It does seem hard to support since their memory layout is compiler dependent. I was thinking since we know the number of bits set, assuming that bits are packed only either left-to-right or right-to-left, we could do something like update_flag.bits() | update_flag.bits().reverse_bits() when getting the unsigned int as a workaround? (This admittedly doesn't work if the memory layout is different.)

@ehuss whats the way to interact with c bitfields via FFI?

There is no official support for C bitfields in Rust: rust-lang/rfcs#314.

There's no good way to use bitfields from Rust's FFI, and that won't be fixed in a timeframe reasonable for updating this library, so I suggest hacking around it.

This field will have a correct size — the C header explicitly specifies it as unsigned int, so the risk of problems seems relatively low. In the worst case these options won't be set, but that's just an application-level nuisance, not memory corruption.

AFAIK C treats unused bits as padding, so update_flag.bits() | update_flag.bits().reverse_bits() should be safe.

If that's still too risky, then the correct way to deal with this would be to compile and link a C file that exports Rust-FFI-compatible getter and setter functions for these fields. Perhaps do that only when building the library from vendored source to avoid pains of with finding correct headers and ensuring they actually match .so lib's ABI?

Sorry, I haven't had much time lately. I've been intending to push a change that will use a C wrapper to get/set the fields, I just haven't gotten to it, yet. I don't feel comfortable trying to guess the layout from within Rust. @bnjmnt4n If you have time to give that a shot, that would be helpful. Otherwise, I'll try to look into it soonish.

@ehuss @bnjmnt4n The maintainer of libgit2 said he ~~can guarantee the ABI will use least significant bits~~ for the flags: libgit2/libgit2#6800

Status update: ethomson mentioned in libgit2/libgit2#6800 that they will look to see if there is some workaround for us.

ehuss · 2024-03-23T20:09:13Z

The test failures on Windows are related to libgit2/libgit2#6743 as mentioned above—I'm not too sure how to handle these conventionally using Rust.

Hm, that's awkward. I don't really understand why TempDir is returning short path. One option is to canonicalize both paths before comparing they are equal. Another option is to use same-file to check that the paths are the same. Canonicalize might be easier if it works.

…ialized properly

jirutka · 2024-04-03T10:40:41Z

FYI, this blocks the upgrade of libgit2 to 1.8.0 in Alpine Linux (!63296).

SS1823 · 2024-04-23T14:15:31Z

Is this PR still blocked?
this may fix actions/checkout#1689

bnjmnt4n mentioned this pull request Mar 2, 2024

libgit2: Add support for OpenSSH instead of libssh2 #1031

Open

bnjmnt4n force-pushed the libgit2-v1.8.0 branch from f4549ca to 7d0742e Compare March 17, 2024 09:27

osiewicz mentioned this pull request Mar 18, 2024

tree view is unusably slow on a large monorepo zed-industries/zed#8242

Open

1 task

bnjmnt4n added 8 commits March 22, 2024 19:30

libgit2: Bump to v1.8.0-alpha

81ac0cc

libgit2: Update struct representation for git_push_options

a14e56e

See libgit2/libgit2#6439.

libgit2: Update git_fetch_options and git_remote_update_tips

27385dd

libgit2: Other FFI changes

8285ea1

libgit2: Fix build with libssh2

4e29ee6

libgit2: Update for changes to commit APIs

748d67e

systest: Add errors.h header file

d65c7c2

libgit2: Bump to v1.8.0

5187c9e

bnjmnt4n force-pushed the libgit2-v1.8.0 branch from 7d0742e to 619fc02 Compare March 22, 2024 12:16

bnjmnt4n changed the title ~~libgit2: Bump to v1.8.0-alpha~~ libgit2: Bump to v1.8.0 Mar 22, 2024

libgit2: Account for further API changes

796004e

bnjmnt4n force-pushed the libgit2-v1.8.0 branch from 619fc02 to 67a64a1 Compare March 22, 2024 12:33

bnjmnt4n marked this pull request as draft March 22, 2024 12:41

bnjmnt4n added 2 commits March 22, 2024 20:49

Fix tests from changes in libgit2 v1.8

34dfbb1

libgit2-sys: Bump versions

3c4b106

bnjmnt4n force-pushed the libgit2-v1.8.0 branch from 67a64a1 to 3c4b106 Compare March 22, 2024 12:49

bnjmnt4n marked this pull request as ready for review March 22, 2024 13:24

ehuss reviewed Mar 23, 2024

View reviewed changes

Tests: Attempt to fix realpath failure on Windows

bb75668

bnjmnt4n force-pushed the libgit2-v1.8.0 branch from 44e8b35 to bb75668 Compare March 23, 2024 21:03

GitFetchOptions: Add hack to ensure update_flags bitfields are init…

3c105a7

…ialized properly

bnjmnt4n mentioned this pull request Mar 30, 2024

SSH: Use OpenSSH instead of libssh2 for authentication with Git hosts martinvonz/jj#3191

Draft

4 tasks

robinst mentioned this pull request Apr 9, 2024

Git v2.40.0 crashing with "could not read index: invalid data in index - calculated checksum does not match expected" arxanas/git-branchless#894

Open

cho-m mentioned this pull request Apr 11, 2024

libgit2 1.8.0 Homebrew/homebrew-core#166767

Open

ehuss mentioned this pull request Apr 13, 2024

The error caused by failed push_negotiation is strange: "config value 'pack.windowMemory' was not found" #1042

Open

ehuss mentioned this pull request Apr 24, 2024

Segmentation fault when cloning invalid URL #1046

Closed

Pi-Cla mentioned this pull request Apr 24, 2024

Support extensions.worktreeConfig tummychow/git-absorb#58

Open

kornelski approved these changes Apr 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

libgit2: Bump to v1.8.0 #1032

libgit2: Bump to v1.8.0 #1032

bnjmnt4n commented Mar 2, 2024 •

edited

bnjmnt4n commented Mar 7, 2024

bnjmnt4n commented Mar 22, 2024

bnjmnt4n commented Mar 22, 2024

ehuss Mar 23, 2024

bnjmnt4n Mar 23, 2024

extrawurst Mar 26, 2024

bnjmnt4n Mar 30, 2024

kornelski Apr 26, 2024

ehuss Apr 26, 2024

kornelski Apr 27, 2024 •

edited

ehuss May 1, 2024

ehuss commented Mar 23, 2024

jirutka commented Apr 3, 2024 •

edited

SS1823 commented Apr 23, 2024

libgit2: Bump to v1.8.0 #1032

Are you sure you want to change the base?

libgit2: Bump to v1.8.0 #1032

Conversation

bnjmnt4n commented Mar 2, 2024 • edited

References

bnjmnt4n commented Mar 7, 2024

bnjmnt4n commented Mar 22, 2024

bnjmnt4n commented Mar 22, 2024

ehuss Mar 23, 2024

Choose a reason for hiding this comment

bnjmnt4n Mar 23, 2024

Choose a reason for hiding this comment

extrawurst Mar 26, 2024

Choose a reason for hiding this comment

bnjmnt4n Mar 30, 2024

Choose a reason for hiding this comment

kornelski Apr 26, 2024

Choose a reason for hiding this comment

ehuss Apr 26, 2024

Choose a reason for hiding this comment

kornelski Apr 27, 2024 • edited

Choose a reason for hiding this comment

ehuss May 1, 2024

Choose a reason for hiding this comment

ehuss commented Mar 23, 2024

jirutka commented Apr 3, 2024 • edited

SS1823 commented Apr 23, 2024

bnjmnt4n commented Mar 2, 2024 •

edited

kornelski Apr 27, 2024 •

edited

jirutka commented Apr 3, 2024 •

edited