From fb001183ad7dd33de51733a15ba4a31d9c482652 Mon Sep 17 00:00:00 2001 From: Pierre Chevalier Date: Tue, 16 Jan 2024 00:38:02 -0800 Subject: [PATCH] Update bitflags to 2.4 Summary: ## Motivation Since the latest compiler update, we are getting `clippy::bad_bit_mask` errors at the callsites of `bitflags!` macros where one of the variant is zero. [Upstream won't address it in the `1.x` branch](https://github.com/bitflags/bitflags/pull/373) and recommends upgrading to the `2.x` branch. We are very close to reaching **zero clippy lints** in [Mononoke and other servers](https://fburl.com/code/pd76yn5e), which would feel nice. ## Specific categories of changes (in case it helps with the code review) The change from `1.x` to `2.x` introduces a number of backward compatibility breakages which I had to workaround in our codebase. See [the release notes for 2.0](https://github.com/bitflags/bitflags/releases/tag/2.0.0) for the explanation for the manual fixes I had to perform at each call site. --- **Adding traits to derive:** ``` #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)] ``` > Generated flags types now derive fewer traits. If you need to maintain backwards compatibility, you can derive the following yourself: --- **Replacing read uses of `.bits` with `.bits()`** > You can now use the .bits() method instead of the old .bits. > The representation of generated flags types has changed from a struct with the single field bits to a newtype. --- **Replacing raw setting of `.bits` with `.from_bits_retain()`** Due to the point above, the representation of the type is not exposed anymore. From [the documentation](https://docs.rs/bitflags/latest/bitflags/example_generated/struct.Flags.html#method.from_bits_retain), `from_bits_retain` "convert from a bits value exactly", which matches the old behaviour --- **Replacing the unsafe `from_bits_unchecked` method with `from_bits_retain`** > The unsafe from_bits_unchecked method is now a safe from_bits_retain method. --- **Extracting some structs outside of the `bitflags!` macro** Apart from the derives that `bitflags` knows about, such as `serde`, `bitflags` now can't deal with custom derives in macros with the previous syntax. I followed the recommendation from [their documentation](https://docs.rs/bitflags/latest/bitflags/index.html#custom-derives) to declare the `struct` ahead of of the macro call and only declare the `impl` block inside the macro. --- **Changes to test output** This does not stand out in the release notes, but as of [this upstream PR](https://github.com/bitflags/bitflags/pull/297), the `Debug` output of generated bitflags has changed. This means any tests that rely on this (and of course, there are a few) needed updating. In particular, the `vespa` tests rely on that output in a non-obvious way. You might have to trust me (and CI) on these ones... Reviewed By: dtolnay Differential Revision: D49742979 fbshipit-source-id: c818c37af45f0964e8fdb7ec6173ad66bb982c00 --- ocamlrep_marshal/Cargo.toml | 2 +- ocamlrep_marshal/ser.rs | 1 + shim/third-party/rust/Cargo.toml | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/ocamlrep_marshal/Cargo.toml b/ocamlrep_marshal/Cargo.toml index 220039df..3c631e74 100644 --- a/ocamlrep_marshal/Cargo.toml +++ b/ocamlrep_marshal/Cargo.toml @@ -17,7 +17,7 @@ doctest = false crate-type = ["lib", "staticlib"] [dependencies] -bitflags = "1.3" +bitflags = "2.4" ocamlrep = { path = "../ocamlrep" } [build-dependencies] diff --git a/ocamlrep_marshal/ser.rs b/ocamlrep_marshal/ser.rs index 6ef2dc2b..0f0b8bf7 100644 --- a/ocamlrep_marshal/ser.rs +++ b/ocamlrep_marshal/ser.rs @@ -24,6 +24,7 @@ extern "C" { bitflags::bitflags! { /// Flags affecting marshaling + #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Clone, Copy)] pub struct ExternFlags: u8 { /// Flag to ignore sharing const NO_SHARING = 1; diff --git a/shim/third-party/rust/Cargo.toml b/shim/third-party/rust/Cargo.toml index 426c1595..57f993e4 100644 --- a/shim/third-party/rust/Cargo.toml +++ b/shim/third-party/rust/Cargo.toml @@ -15,7 +15,7 @@ path = "top/main.rs" [dependencies] anyhow = "1.0.75" -bitflags = "1.3" +bitflags = "2.4" bstr = { version = "1.4.0", features = ["serde", "std", "unicode"] } bumpalo = { version = "3.14.0", features = ["allocator_api", "collections"] } clap-3 = { package = "clap", version = "3.2.25", features = ["derive", "env", "regex", "unicode", "wrap_help"] }