[WIP] Use ReadOnly in is_bit_valid #2873

joshlf · 2026-01-07T21:28:02Z

Makes progress on #2336

Latest Update: v54 — Compare vs v53

📚 Full Patch History

Links show the diff between the row version and the column version.

Version	v53	v52	v51	v50	v49	v48	v47	v46	v45	v44	v43	v42	v41	v40	v39	v38	v37	v36	v35	v34	v33	v32	v31	v30	v29	v28	v27	v26	v25	v24	v23	v22	v21	v20	v19	v18	v17	v16	v15	v14	v13	v12	v11	v10	v9	v8	v7	v6	v5	v4	v3	v2	v1	Base
v54	v53	v52	v51	v50	v49	v48	v47	v46	v45	v44	v43	v42	v41	v40	v39	v38	v37	v36	v35	v34	v33	v32	v31	v30	v29	v28	v27	v26	v25	v24	v23	v22	v21	v20	v19	v18	v17	v16	v15	v14	v13	v12	v11	v10	v9	v8	v7	v6	v5	v4	v3	v2	v1	Base
v53		v52																																																				Base
v52			v51																																																			Base
v51				v50																																																		Base
v50					v49																																																	Base
v49						v48																																																Base
v48							v47																																															Base
v47								v46																																														Base
v46									v45																																													Base
v45										v44																																												Base
v44											v43																																											Base
v43												v42																																										Base
v42													v41																																									Base
v41														v40																																								Base
v40															v39																																							Base
v39																v38																																						Base
v38																	v37																																					Base
v37																		v36																																				Base
v36																			v35																																			Base
v35																				v34																																		Base
v34																					v33																																	Base
v33																						v32																																Base
v32																							v31																															Base
v31																								v30																														Base
v30																									v29																													Base
v29																										v28																												Base
v28																											v27																											Base
v27																												v26																										Base
v26																													v25																									Base
v25																														v24																								Base
v24																															v23																							Base
v23																																v22																						Base
v22																																	v21																					Base
v21																																		v20																				Base
v20																																			v19																			Base
v19																																				v18																		Base
v18																																					v17																	Base
v17																																						v16																Base
v16																																							v15															Base
v15																																								v14														Base
v14																																									v13													Base
v13																																										v12												Base
v12																																											v11											Base
v11																																												v10										Base
v10																																													v9									Base
v9																																														v8								Base
v8																																															v7							Base
v7																																																v6						Base
v6																																																	v5					Base
v5																																																		v4				Base
v4																																																			v3			Base
v3																																																				v2		Base
v2																																																					v1	Base
v1																																																						Base

gemini-code-assist · 2026-01-07T21:28:30Z

Summary of Changes

Hello @joshlf, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant refactoring to consistently use ReadOnly views when performing bit validity checks across the codebase. By updating the Maybe type alias and modifying various macros and trait implementations, the change ensures that is_bit_valid functions operate on immutable data, enhancing type safety and correctness. This also streamlines the implementation of validity checks for types like UnsafeCell and atomic types, making the system more robust.

Highlights

is_bit_valid Refactoring: The is_bit_valid function for UnsafeCell<T> and within the impl_for_transmute_from! macro has been simplified to directly use candidate.transmute() instead of into_exclusive_or_pme() and get_mut().
Maybe Type Alias Update: The Maybe type alias, which defines the argument type for TryFromBytes::is_bit_valid, now uses ReadOnly<T> instead of T, ensuring that bit validity checks operate on immutable views.
Macro Enhancements for ReadOnly: The impl_size_eq! and unsafe_impl_for_transparent_wrapper! macros have been extended to correctly handle ReadOnly types, including new SizeEq implementations and casting mechanisms.
Atomic Type Trait Refinement: The macros for implementing traits for atomic types have been split into impl_layout_traits_for_atomics! and impl_validity_traits_for_atomics!, providing a clearer separation of concerns for layout and validity traits, and incorporating the new impl_size_eq! syntax.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a ReadOnly wrapper to the Maybe type alias, which is used in is_bit_valid checks. This is a significant safety improvement, as it enforces at the type level that these checks do not perform mutations. The changes correctly propagate this new approach through various macros and implementations, and the refactoring of some macros for better clarity is appreciated. My review focuses on cleaning up some leftover commented-out code from this refactoring effort.

gemini-code-assist · 2026-01-07T21:29:41Z

src/impls.rs

+        // // The only way to implement this function is using an exclusive-aliased
+        // // pointer. `UnsafeCell`s cannot be read via shared-aliased pointers
+        // // (other than by using `unsafe` code, which we can't use since we can't
+        // // guarantee how our users are accessing or modifying the `UnsafeCell`).
+        // //
+        // // `is_bit_valid` is documented as panicking or failing to monomorphize
+        // // if called with a shared-aliased pointer on a type containing an
+        // // `UnsafeCell`. In practice, it will always be a monomorphization error.
+        // // Since `is_bit_valid` is `#[doc(hidden)]` and only called directly
+        // // from this crate, we only need to worry about our own code incorrectly
+        // // calling `UnsafeCell::is_bit_valid`. The post-monomorphization error
+        // // makes it easier to test that this is truly the case, and also means
+        // // that if we make a mistake, it will cause downstream code to fail to
+        // // compile, which will immediately surface the mistake and give us a
+        // // chance to fix it quickly.
+        // let c = candidate.into_exclusive_or_pme();
+
+        // // SAFETY: Since `UnsafeCell<T>` and `T` have the same layout and bit
+        // // validity, `UnsafeCell<T>` is bit-valid exactly when its wrapped `T`
+        // // is. Thus, this is a sound implementation of
+        // // `UnsafeCell::is_bit_valid`.
+        // T::is_bit_valid(c.get_mut())


This large block of commented-out code appears to be the old implementation. To improve readability and maintainability, it would be great to remove it before this pull request is merged.

gemini-code-assist · 2026-01-07T21:29:41Z

src/pointer/ptr.rs

+    // /// `Ptr<'a, T, (_, _, _)>` → `Ptr<'a, ReadOnly<T>, (_, _, _)>`
+    // impl<'a, T, I> Ptr<'a, T, I>
+    // where
+    //     T: ?Sized,
+    //     I: Invariants,
+    // {
+    //     /// TODO
+    //     pub(crate) fn into_read_only<R>(
+    //         self,
+    //     ) -> Ptr<'a, crate::ReadOnly<T>, (I::Aliasing, I::Alignment, I::Validity)>
+    //     where
+    //         T: Read<I::Aliasing, R>,
+    //     {
+    //         let ro = self.transmute::<_, _, (_, _)>();
+    //         unsafe { ro.assume_alignment() }
+    //     }
+    // }


This commented-out implementation of into_read_only seems to be unused. To keep the codebase clean, it would be best to remove it if it's not part of this change.

gemini-code-assist · 2026-01-07T21:29:41Z

src/util/macro_util.rs

    let ptr: Ptr<'_, Dst, _> = ptr.cast::<_, crate::pointer::cast::CastSized, _>();

-    if Dst::is_bit_valid(ptr.forget_aligned()) {
+    if Dst::is_bit_valid(ptr.transmute::<_, _, (_, (_, BecauseExclusive))>().forget_aligned()) {


The call to .forget_aligned() here seems redundant. The transmute() method on Ptr already returns a Ptr with Unaligned alignment, so forget_aligned() is a no-op in this context. Removing it would make the code slightly cleaner.

Suggested change

if Dst::is_bit_valid(ptr.transmute::<_, _, (_, (_, BecauseExclusive))>().forget_aligned()) {

if Dst::is_bit_valid(ptr.transmute::<_, _, (_, (_, BecauseExclusive))>()) {

gemini-code-assist · 2026-01-07T21:29:42Z

src/util/macros.rs

        fn is_bit_valid<A: crate::pointer::invariant::Reference>(candidate: Maybe<'_, Self, A>) -> bool {
-            let c: Maybe<'_, Self, crate::pointer::invariant::Exclusive> = candidate.into_exclusive_or_pme();
-            let c: Maybe<'_, $repr, _> = c.transmute::<_, _, (_, (_, BecauseExclusive))>();
+            // let c: Maybe<'_, Self, crate::pointer::invariant::Exclusive> = candidate.into_exclusive_or_pme();


This commented-out line can be removed to clean up the code.

gemini-code-assist · 2026-01-07T21:29:42Z

src/wrappers.rs

+// enum BecauseReadOnly {}
+
+// /// Denotes that `src: Ptr<Src, (A, _, SV)>` and `dst: Ptr<Self, (A, _, DV)>`,
+// /// referencing the same referent at the same time, cannot be used by safe code
+// /// to break library safety invariants of `Src` or `Self`.
+// ///
+// /// # Safety
+// ///
+// /// At least one of the following must hold:
+// /// - `Src: Read<A, _>` and `Self: Read<A, _>`
+// /// - `Self: InvariantsEq<Src>`, and, for some `V`:
+// ///   - `Dst: TransmuteFrom<Src, V, V>`
+// ///   - `Src: TransmuteFrom<Dst, V, V>`
+
+// // SAFETY: TODO
+// unsafe impl<T: ?Sized, A: Aliasing, V> MutationCompatible<T, A, V, V, BecauseReadOnly>
+//     for ReadOnly<T>
+// {
+// }


This block of commented-out code seems to be a work-in-progress idea. If it's not intended to be part of this pull request, it would be best to remove it to avoid cluttering the codebase.

codecov-commenter · 2026-01-08T14:23:59Z

Codecov Report

❌ Patch coverage is 94.59459% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.51%. Comparing base (1569756) to head (532249e).

Files with missing lines	Patch %	Lines
src/macros.rs	0.00%	2 Missing ⚠️
src/util/macros.rs	66.66%	2 Missing ⚠️

Additional details and impacted files

@@                              Coverage Diff                              @@
##           G17f9a0ab1a99ba2147dbc334934cb9e1f3709128    #2873      +/-   ##
=============================================================================
- Coverage                                      91.55%   91.51%   -0.04%     
=============================================================================
  Files                                             20       20              
  Lines                                           5906     5916      +10     
=============================================================================
+ Hits                                            5407     5414       +7     
- Misses                                           499      502       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Makes progress on #2336 gherrit-pr-id: G7691845b6b02e9f3d9578435d732bacfa6ca674f

This was referenced Jan 7, 2026

Rename SizeEq to SizeCompat, make it safe #2872

Open

Simplify MutationCompatible impls #2867

Closed

Introduce ReadOnly<T> which is unconditionally Immutable #2866

Open

gemini-code-assist bot reviewed Jan 7, 2026

View reviewed changes

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from 81ada6e to a353963 Compare January 7, 2026 23:08

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from ad978ce to ee75641 Compare January 7, 2026 23:08

joshlf mentioned this pull request Jan 7, 2026

[WIP][derive] Use ReadOnly in is_bit_valid #2874

Open

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch 3 times, most recently from 09a6d35 to 6ac888a Compare January 8, 2026 14:21

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from ee75641 to 6539cee Compare January 8, 2026 15:26

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from 6ac888a to 1b4834d Compare January 8, 2026 15:26

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from 6539cee to e2f1bc3 Compare January 8, 2026 15:36

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch 2 times, most recently from c83b71f to db5ec29 Compare January 8, 2026 15:58

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from e2f1bc3 to 45ff87c Compare January 8, 2026 15:58

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from db5ec29 to 845c5e7 Compare January 8, 2026 16:54

This was referenced Jan 8, 2026

[derive] Refactor is_bit_valid tests #2875

Closed

[derive] Allow TryFromBytes on non-Immutable unions #2876

Open

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from 45ff87c to d1f62db Compare January 8, 2026 19:34

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch 3 times, most recently from b6642a7 to d0f57ea Compare January 8, 2026 19:50

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from d1f62db to 65f15b8 Compare January 8, 2026 19:50

joshlf mentioned this pull request Jan 8, 2026

Simplify MutationCompatible impls #2877

Merged

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from 65f15b8 to 318b671 Compare January 9, 2026 00:00

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from d0f57ea to 6cbe1ca Compare January 9, 2026 00:00

joshlf mentioned this pull request Jan 9, 2026

[WIP] Remove MutationCompatible, Read #2878

Open

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from 5718b7a to 3c44f90 Compare January 16, 2026 22:33

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from 91e2600 to 054d5d4 Compare January 16, 2026 22:33

joshlf mentioned this pull request Jan 16, 2026

Simplify projection methods #2895

Merged

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from 3c44f90 to f6911ab Compare January 16, 2026 22:49

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch 2 times, most recently from af9e006 to c511655 Compare January 16, 2026 22:54

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch 2 times, most recently from 20452c3 to fdf2d74 Compare January 16, 2026 23:57

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from c511655 to ecb8b50 Compare January 16, 2026 23:57

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from fdf2d74 to fc38019 Compare January 17, 2026 00:48

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch 2 times, most recently from 0c1b442 to f02e8df Compare January 21, 2026 22:51

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch 2 times, most recently from c2d0307 to acc181c Compare January 22, 2026 22:33

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch 2 times, most recently from 187a61f to de2e502 Compare January 22, 2026 22:47

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch 2 times, most recently from d48bb99 to 2e0baa1 Compare January 22, 2026 22:54

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from de2e502 to 9f2289d Compare January 22, 2026 22:54

joshlf force-pushed the Gbe8d7edd150d80731c79815685c596ed88460ae7 branch from 2e0baa1 to 1262012 Compare January 23, 2026 18:57

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from 9f2289d to 129800e Compare January 23, 2026 18:57

joshlf changed the base branch from Gbe8d7edd150d80731c79815685c596ed88460ae7 to G17f9a0ab1a99ba2147dbc334934cb9e1f3709128 January 23, 2026 18:58

joshlf mentioned this pull request Jan 23, 2026

[WIP] Wrapped projections #2919

Open

joshlf force-pushed the G17f9a0ab1a99ba2147dbc334934cb9e1f3709128 branch from bd56d16 to f743f9b Compare January 23, 2026 19:03

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from 129800e to 6c1c181 Compare January 23, 2026 19:03

joshlf force-pushed the G17f9a0ab1a99ba2147dbc334934cb9e1f3709128 branch from f743f9b to 59c2a36 Compare January 23, 2026 19:21

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from 6c1c181 to 878bd6b Compare January 23, 2026 19:21

[WIP] Use ReadOnly in is_bit_valid

532249e

Makes progress on #2336 gherrit-pr-id: G7691845b6b02e9f3d9578435d732bacfa6ca674f

joshlf force-pushed the G7691845b6b02e9f3d9578435d732bacfa6ca674f branch from 878bd6b to 532249e Compare January 23, 2026 19:30

joshlf force-pushed the G17f9a0ab1a99ba2147dbc334934cb9e1f3709128 branch from 59c2a36 to 1569756 Compare January 23, 2026 19:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Use ReadOnly in is_bit_valid #2873

[WIP] Use ReadOnly in is_bit_valid #2873

joshlf commented Jan 7, 2026 •

edited

Loading

Uh oh!

gemini-code-assist bot commented Jan 7, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Jan 7, 2026

Uh oh!

gemini-code-assist bot Jan 7, 2026

Uh oh!

gemini-code-assist bot Jan 7, 2026

Uh oh!

gemini-code-assist bot Jan 7, 2026

Uh oh!

gemini-code-assist bot Jan 7, 2026

Uh oh!

codecov-commenter commented Jan 8, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	if Dst::is_bit_valid(ptr.transmute::<_, _, (_, (_, BecauseExclusive))>().forget_aligned()) {
	if Dst::is_bit_valid(ptr.transmute::<_, _, (_, (_, BecauseExclusive))>()) {

[WIP] Use ReadOnly in is_bit_valid #2873

Are you sure you want to change the base?

[WIP] Use ReadOnly in is_bit_valid #2873

Conversation

joshlf commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist bot commented Jan 7, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jan 7, 2026

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

joshlf commented Jan 7, 2026 •

edited

Loading

codecov-commenter commented Jan 8, 2026 •

edited

Loading