xref: /linux/rust/zerocopy/src/impls.rs (revision c37398010a05055e78cf0c75defb90df06c4e999)
1*c3739801SMiguel Ojeda // Copyright 2024 The Fuchsia Authors
2*c3739801SMiguel Ojeda //
3*c3739801SMiguel Ojeda // Licensed under the 2-Clause BSD License <LICENSE-BSD or
4*c3739801SMiguel Ojeda // https://opensource.org/license/bsd-2-clause>, Apache License, Version 2.0
5*c3739801SMiguel Ojeda // <LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0>, or the MIT
6*c3739801SMiguel Ojeda // license <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your option.
7*c3739801SMiguel Ojeda // This file may not be copied, modified, or distributed except according to
8*c3739801SMiguel Ojeda // those terms.
9*c3739801SMiguel Ojeda 
10*c3739801SMiguel Ojeda use core::{
11*c3739801SMiguel Ojeda     cell::{Cell, UnsafeCell},
12*c3739801SMiguel Ojeda     mem::MaybeUninit as CoreMaybeUninit,
13*c3739801SMiguel Ojeda     ptr::NonNull,
14*c3739801SMiguel Ojeda };
15*c3739801SMiguel Ojeda 
16*c3739801SMiguel Ojeda use super::*;
17*c3739801SMiguel Ojeda use crate::pointer::cast::{CastSizedExact, CastUnsized};
18*c3739801SMiguel Ojeda 
19*c3739801SMiguel Ojeda // SAFETY: Per the reference [1], "the unit tuple (`()`) ... is guaranteed as a
20*c3739801SMiguel Ojeda // zero-sized type to have a size of 0 and an alignment of 1."
21*c3739801SMiguel Ojeda // - `Immutable`: `()` self-evidently does not contain any `UnsafeCell`s.
22*c3739801SMiguel Ojeda // - `TryFromBytes` (with no validator), `FromZeros`, `FromBytes`: There is only
23*c3739801SMiguel Ojeda //   one possible sequence of 0 bytes, and `()` is inhabited.
24*c3739801SMiguel Ojeda // - `IntoBytes`: Since `()` has size 0, it contains no padding bytes.
25*c3739801SMiguel Ojeda // - `Unaligned`: `()` has alignment 1.
26*c3739801SMiguel Ojeda //
27*c3739801SMiguel Ojeda // [1] https://doc.rust-lang.org/1.81.0/reference/type-layout.html#tuple-layout
28*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
29*c3739801SMiguel Ojeda const _: () = unsafe {
30*c3739801SMiguel Ojeda     unsafe_impl!((): Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
31*c3739801SMiguel Ojeda     assert_unaligned!(());
32*c3739801SMiguel Ojeda };
33*c3739801SMiguel Ojeda 
34*c3739801SMiguel Ojeda // SAFETY:
35*c3739801SMiguel Ojeda // - `Immutable`: These types self-evidently do not contain any `UnsafeCell`s.
36*c3739801SMiguel Ojeda // - `TryFromBytes` (with no validator), `FromZeros`, `FromBytes`: all bit
37*c3739801SMiguel Ojeda //   patterns are valid for numeric types [1]
38*c3739801SMiguel Ojeda // - `IntoBytes`: numeric types have no padding bytes [1]
39*c3739801SMiguel Ojeda // - `Unaligned` (`u8` and `i8` only): The reference [2] specifies the size of
40*c3739801SMiguel Ojeda //   `u8` and `i8` as 1 byte. We also know that:
41*c3739801SMiguel Ojeda //   - Alignment is >= 1 [3]
42*c3739801SMiguel Ojeda //   - Size is an integer multiple of alignment [4]
43*c3739801SMiguel Ojeda //   - The only value >= 1 for which 1 is an integer multiple is 1 Therefore,
44*c3739801SMiguel Ojeda //   the only possible alignment for `u8` and `i8` is 1.
45*c3739801SMiguel Ojeda //
46*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/reference/types/numeric.html#bit-validity:
47*c3739801SMiguel Ojeda //
48*c3739801SMiguel Ojeda //     For every numeric type, `T`, the bit validity of `T` is equivalent to
49*c3739801SMiguel Ojeda //     the bit validity of `[u8; size_of::<T>()]`. An uninitialized byte is
50*c3739801SMiguel Ojeda //     not a valid `u8`.
51*c3739801SMiguel Ojeda //
52*c3739801SMiguel Ojeda // [2] https://doc.rust-lang.org/1.81.0/reference/type-layout.html#primitive-data-layout
53*c3739801SMiguel Ojeda //
54*c3739801SMiguel Ojeda // [3] Per https://doc.rust-lang.org/1.81.0/reference/type-layout.html#size-and-alignment:
55*c3739801SMiguel Ojeda //
56*c3739801SMiguel Ojeda //     Alignment is measured in bytes, and must be at least 1.
57*c3739801SMiguel Ojeda //
58*c3739801SMiguel Ojeda // [4] Per https://doc.rust-lang.org/1.81.0/reference/type-layout.html#size-and-alignment:
59*c3739801SMiguel Ojeda //
60*c3739801SMiguel Ojeda //     The size of a value is always a multiple of its alignment.
61*c3739801SMiguel Ojeda //
62*c3739801SMiguel Ojeda // FIXME(#278): Once we've updated the trait docs to refer to `u8`s rather than
63*c3739801SMiguel Ojeda // bits or bytes, update this comment, especially the reference to [1].
64*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
65*c3739801SMiguel Ojeda const _: () = unsafe {
66*c3739801SMiguel Ojeda     unsafe_impl!(u8: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
67*c3739801SMiguel Ojeda     unsafe_impl!(i8: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
68*c3739801SMiguel Ojeda     assert_unaligned!(u8, i8);
69*c3739801SMiguel Ojeda     unsafe_impl!(u16: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
70*c3739801SMiguel Ojeda     unsafe_impl!(i16: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
71*c3739801SMiguel Ojeda     unsafe_impl!(u32: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
72*c3739801SMiguel Ojeda     unsafe_impl!(i32: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
73*c3739801SMiguel Ojeda     unsafe_impl!(u64: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
74*c3739801SMiguel Ojeda     unsafe_impl!(i64: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
75*c3739801SMiguel Ojeda     unsafe_impl!(u128: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
76*c3739801SMiguel Ojeda     unsafe_impl!(i128: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
77*c3739801SMiguel Ojeda     unsafe_impl!(usize: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
78*c3739801SMiguel Ojeda     unsafe_impl!(isize: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
79*c3739801SMiguel Ojeda     unsafe_impl!(f32: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
80*c3739801SMiguel Ojeda     unsafe_impl!(f64: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
81*c3739801SMiguel Ojeda     #[cfg(feature = "float-nightly")]
82*c3739801SMiguel Ojeda     unsafe_impl!(#[cfg_attr(doc_cfg, doc(cfg(feature = "float-nightly")))] f16: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
83*c3739801SMiguel Ojeda     #[cfg(feature = "float-nightly")]
84*c3739801SMiguel Ojeda     unsafe_impl!(#[cfg_attr(doc_cfg, doc(cfg(feature = "float-nightly")))] f128: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes);
85*c3739801SMiguel Ojeda };
86*c3739801SMiguel Ojeda 
87*c3739801SMiguel Ojeda // SAFETY:
88*c3739801SMiguel Ojeda // - `Immutable`: `bool` self-evidently does not contain any `UnsafeCell`s.
89*c3739801SMiguel Ojeda // - `FromZeros`: Valid since "[t]he value false has the bit pattern 0x00" [1].
90*c3739801SMiguel Ojeda // - `IntoBytes`: Since "the boolean type has a size and alignment of 1 each"
91*c3739801SMiguel Ojeda //   and "The value false has the bit pattern 0x00 and the value true has the
92*c3739801SMiguel Ojeda //   bit pattern 0x01" [1]. Thus, the only byte of the bool is always
93*c3739801SMiguel Ojeda //   initialized.
94*c3739801SMiguel Ojeda // - `Unaligned`: Per the reference [1], "[a]n object with the boolean type has
95*c3739801SMiguel Ojeda //   a size and alignment of 1 each."
96*c3739801SMiguel Ojeda //
97*c3739801SMiguel Ojeda // [1] https://doc.rust-lang.org/1.81.0/reference/types/boolean.html
98*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
99*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(bool: Immutable, FromZeros, IntoBytes, Unaligned) };
100*c3739801SMiguel Ojeda assert_unaligned!(bool);
101*c3739801SMiguel Ojeda 
102*c3739801SMiguel Ojeda // SAFETY: The impl must only return `true` for its argument if the original
103*c3739801SMiguel Ojeda // `Maybe<bool>` refers to a valid `bool`. We only return true if the `u8` value
104*c3739801SMiguel Ojeda // is 0 or 1, and both of these are valid values for `bool` [1].
105*c3739801SMiguel Ojeda //
106*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/reference/types/boolean.html:
107*c3739801SMiguel Ojeda //
108*c3739801SMiguel Ojeda //   The value false has the bit pattern 0x00 and the value true has the bit
109*c3739801SMiguel Ojeda //   pattern 0x01.
110*c3739801SMiguel Ojeda const _: () = unsafe {
111*c3739801SMiguel Ojeda     unsafe_impl!(=> TryFromBytes for bool; |byte| {
112*c3739801SMiguel Ojeda         let byte = byte.transmute_with::<u8, invariant::Valid, CastSizedExact, BecauseImmutable>();
113*c3739801SMiguel Ojeda         *byte.unaligned_as_ref() < 2
114*c3739801SMiguel Ojeda     })
115*c3739801SMiguel Ojeda };
116*c3739801SMiguel Ojeda 
117*c3739801SMiguel Ojeda // SAFETY:
118*c3739801SMiguel Ojeda // - `Immutable`: `char` self-evidently does not contain any `UnsafeCell`s.
119*c3739801SMiguel Ojeda // - `FromZeros`: Per reference [1], "[a] value of type char is a Unicode scalar
120*c3739801SMiguel Ojeda //   value (i.e. a code point that is not a surrogate), represented as a 32-bit
121*c3739801SMiguel Ojeda //   unsigned word in the 0x0000 to 0xD7FF or 0xE000 to 0x10FFFF range" which
122*c3739801SMiguel Ojeda //   contains 0x0000.
123*c3739801SMiguel Ojeda // - `IntoBytes`: `char` is per reference [1] "represented as a 32-bit unsigned
124*c3739801SMiguel Ojeda //   word" (`u32`) which is `IntoBytes`. Note that unlike `u32`, not all bit
125*c3739801SMiguel Ojeda //   patterns are valid for `char`.
126*c3739801SMiguel Ojeda //
127*c3739801SMiguel Ojeda // [1] https://doc.rust-lang.org/1.81.0/reference/types/textual.html
128*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
129*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(char: Immutable, FromZeros, IntoBytes) };
130*c3739801SMiguel Ojeda 
131*c3739801SMiguel Ojeda // SAFETY: The impl must only return `true` for its argument if the original
132*c3739801SMiguel Ojeda // `Maybe<char>` refers to a valid `char`. `char::from_u32` guarantees that it
133*c3739801SMiguel Ojeda // returns `None` if its input is not a valid `char` [1].
134*c3739801SMiguel Ojeda //
135*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/core/primitive.char.html#method.from_u32:
136*c3739801SMiguel Ojeda //
137*c3739801SMiguel Ojeda //   `from_u32()` will return `None` if the input is not a valid value for a
138*c3739801SMiguel Ojeda //   `char`.
139*c3739801SMiguel Ojeda const _: () = unsafe {
140*c3739801SMiguel Ojeda     unsafe_impl!(=> TryFromBytes for char; |c| {
141*c3739801SMiguel Ojeda         let c = c.transmute_with::<Unalign<u32>, invariant::Valid, CastSizedExact, BecauseImmutable>();
142*c3739801SMiguel Ojeda         let c = c.read().into_inner();
143*c3739801SMiguel Ojeda         char::from_u32(c).is_some()
144*c3739801SMiguel Ojeda     });
145*c3739801SMiguel Ojeda };
146*c3739801SMiguel Ojeda 
147*c3739801SMiguel Ojeda // SAFETY: Per the Reference [1], `str` has the same layout as `[u8]`.
148*c3739801SMiguel Ojeda // - `Immutable`: `[u8]` does not contain any `UnsafeCell`s.
149*c3739801SMiguel Ojeda // - `FromZeros`, `IntoBytes`, `Unaligned`: `[u8]` is `FromZeros`, `IntoBytes`,
150*c3739801SMiguel Ojeda //   and `Unaligned`.
151*c3739801SMiguel Ojeda //
152*c3739801SMiguel Ojeda // Note that we don't `assert_unaligned!(str)` because `assert_unaligned!` uses
153*c3739801SMiguel Ojeda // `align_of`, which only works for `Sized` types.
154*c3739801SMiguel Ojeda //
155*c3739801SMiguel Ojeda // FIXME(#429): Improve safety proof for `FromZeros` and `IntoBytes`; having the same
156*c3739801SMiguel Ojeda // layout as `[u8]` isn't sufficient.
157*c3739801SMiguel Ojeda //
158*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/reference/type-layout.html#str-layout:
159*c3739801SMiguel Ojeda //
160*c3739801SMiguel Ojeda //   String slices are a UTF-8 representation of characters that have the same
161*c3739801SMiguel Ojeda //   layout as slices of type `[u8]`.
162*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
163*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(str: Immutable, FromZeros, IntoBytes, Unaligned) };
164*c3739801SMiguel Ojeda 
165*c3739801SMiguel Ojeda // SAFETY: The impl must only return `true` for its argument if the original
166*c3739801SMiguel Ojeda // `Maybe<str>` refers to a valid `str`. `str::from_utf8` guarantees that it
167*c3739801SMiguel Ojeda // returns `Err` if its input is not a valid `str` [1].
168*c3739801SMiguel Ojeda //
169*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/core/str/fn.from_utf8.html#errors:
170*c3739801SMiguel Ojeda //
171*c3739801SMiguel Ojeda //   Returns `Err` if the slice is not UTF-8.
172*c3739801SMiguel Ojeda const _: () = unsafe {
173*c3739801SMiguel Ojeda     unsafe_impl!(=> TryFromBytes for str; |c| {
174*c3739801SMiguel Ojeda         let c = c.transmute_with::<[u8], invariant::Valid, CastUnsized, BecauseImmutable>();
175*c3739801SMiguel Ojeda         let c = c.unaligned_as_ref();
176*c3739801SMiguel Ojeda         core::str::from_utf8(c).is_ok()
177*c3739801SMiguel Ojeda     })
178*c3739801SMiguel Ojeda };
179*c3739801SMiguel Ojeda 
180*c3739801SMiguel Ojeda macro_rules! unsafe_impl_try_from_bytes_for_nonzero {
181*c3739801SMiguel Ojeda     ($($nonzero:ident[$prim:ty]),*) => {
182*c3739801SMiguel Ojeda         $(
183*c3739801SMiguel Ojeda             unsafe_impl!(=> TryFromBytes for $nonzero; |n| {
184*c3739801SMiguel Ojeda                 let n = n.transmute_with::<Unalign<$prim>, invariant::Valid, CastSizedExact, BecauseImmutable>();
185*c3739801SMiguel Ojeda                 $nonzero::new(n.read().into_inner()).is_some()
186*c3739801SMiguel Ojeda             });
187*c3739801SMiguel Ojeda         )*
188*c3739801SMiguel Ojeda     }
189*c3739801SMiguel Ojeda }
190*c3739801SMiguel Ojeda 
191*c3739801SMiguel Ojeda // `NonZeroXxx` is `IntoBytes`, but not `FromZeros` or `FromBytes`.
192*c3739801SMiguel Ojeda //
193*c3739801SMiguel Ojeda // SAFETY:
194*c3739801SMiguel Ojeda // - `IntoBytes`: `NonZeroXxx` has the same layout as its associated primitive.
195*c3739801SMiguel Ojeda //    Since it is the same size, this guarantees it has no padding - integers
196*c3739801SMiguel Ojeda //    have no padding, and there's no room for padding if it can represent all
197*c3739801SMiguel Ojeda //    of the same values except 0.
198*c3739801SMiguel Ojeda // - `Unaligned`: `NonZeroU8` and `NonZeroI8` document that `Option<NonZeroU8>`
199*c3739801SMiguel Ojeda //   and `Option<NonZeroI8>` both have size 1. [1] [2] This is worded in a way
200*c3739801SMiguel Ojeda //   that makes it unclear whether it's meant as a guarantee, but given the
201*c3739801SMiguel Ojeda //   purpose of those types, it's virtually unthinkable that that would ever
202*c3739801SMiguel Ojeda //   change. `Option` cannot be smaller than its contained type, which implies
203*c3739801SMiguel Ojeda //   that, and `NonZeroX8` are of size 1 or 0. `NonZeroX8` can represent
204*c3739801SMiguel Ojeda //   multiple states, so they cannot be 0 bytes, which means that they must be 1
205*c3739801SMiguel Ojeda //   byte. The only valid alignment for a 1-byte type is 1.
206*c3739801SMiguel Ojeda //
207*c3739801SMiguel Ojeda // FIXME(#429):
208*c3739801SMiguel Ojeda // - Add quotes from documentation.
209*c3739801SMiguel Ojeda // - Add safety comment for `Immutable`. How can we prove that `NonZeroXxx`
210*c3739801SMiguel Ojeda //   doesn't contain any `UnsafeCell`s? It's obviously true, but it's not clear
211*c3739801SMiguel Ojeda //   how we'd prove it short of adding text to the stdlib docs that says so
212*c3739801SMiguel Ojeda //   explicitly, which likely wouldn't be accepted.
213*c3739801SMiguel Ojeda //
214*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/std/num/type.NonZeroU8.html:
215*c3739801SMiguel Ojeda //
216*c3739801SMiguel Ojeda //     `NonZeroU8` is guaranteed to have the same layout and bit validity as `u8` with
217*c3739801SMiguel Ojeda //     the exception that 0 is not a valid instance.
218*c3739801SMiguel Ojeda //
219*c3739801SMiguel Ojeda // [2] Per https://doc.rust-lang.org/1.81.0/std/num/type.NonZeroI8.html:
220*c3739801SMiguel Ojeda //
221*c3739801SMiguel Ojeda //     `NonZeroI8` is guaranteed to have the same layout and bit validity as `i8` with
222*c3739801SMiguel Ojeda //     the exception that 0 is not a valid instance.
223*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
224*c3739801SMiguel Ojeda const _: () = unsafe {
225*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroU8: Immutable, IntoBytes, Unaligned);
226*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroI8: Immutable, IntoBytes, Unaligned);
227*c3739801SMiguel Ojeda     assert_unaligned!(NonZeroU8, NonZeroI8);
228*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroU16: Immutable, IntoBytes);
229*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroI16: Immutable, IntoBytes);
230*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroU32: Immutable, IntoBytes);
231*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroI32: Immutable, IntoBytes);
232*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroU64: Immutable, IntoBytes);
233*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroI64: Immutable, IntoBytes);
234*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroU128: Immutable, IntoBytes);
235*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroI128: Immutable, IntoBytes);
236*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroUsize: Immutable, IntoBytes);
237*c3739801SMiguel Ojeda     unsafe_impl!(NonZeroIsize: Immutable, IntoBytes);
238*c3739801SMiguel Ojeda     unsafe_impl_try_from_bytes_for_nonzero!(
239*c3739801SMiguel Ojeda         NonZeroU8[u8],
240*c3739801SMiguel Ojeda         NonZeroI8[i8],
241*c3739801SMiguel Ojeda         NonZeroU16[u16],
242*c3739801SMiguel Ojeda         NonZeroI16[i16],
243*c3739801SMiguel Ojeda         NonZeroU32[u32],
244*c3739801SMiguel Ojeda         NonZeroI32[i32],
245*c3739801SMiguel Ojeda         NonZeroU64[u64],
246*c3739801SMiguel Ojeda         NonZeroI64[i64],
247*c3739801SMiguel Ojeda         NonZeroU128[u128],
248*c3739801SMiguel Ojeda         NonZeroI128[i128],
249*c3739801SMiguel Ojeda         NonZeroUsize[usize],
250*c3739801SMiguel Ojeda         NonZeroIsize[isize]
251*c3739801SMiguel Ojeda     );
252*c3739801SMiguel Ojeda };
253*c3739801SMiguel Ojeda 
254*c3739801SMiguel Ojeda // SAFETY:
255*c3739801SMiguel Ojeda // - `TryFromBytes` (with no validator), `FromZeros`, `FromBytes`, `IntoBytes`:
256*c3739801SMiguel Ojeda //   The Rust compiler reuses `0` value to represent `None`, so
257*c3739801SMiguel Ojeda //   `size_of::<Option<NonZeroXxx>>() == size_of::<xxx>()`; see `NonZeroXxx`
258*c3739801SMiguel Ojeda //   documentation.
259*c3739801SMiguel Ojeda // - `Unaligned`: `NonZeroU8` and `NonZeroI8` document that `Option<NonZeroU8>`
260*c3739801SMiguel Ojeda //   and `Option<NonZeroI8>` both have size 1. [1] [2] This is worded in a way
261*c3739801SMiguel Ojeda //   that makes it unclear whether it's meant as a guarantee, but given the
262*c3739801SMiguel Ojeda //   purpose of those types, it's virtually unthinkable that that would ever
263*c3739801SMiguel Ojeda //   change. The only valid alignment for a 1-byte type is 1.
264*c3739801SMiguel Ojeda //
265*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/std/num/type.NonZeroU8.html:
266*c3739801SMiguel Ojeda //
267*c3739801SMiguel Ojeda //     `Option<NonZeroU8>` is guaranteed to be compatible with `u8`, including in FFI.
268*c3739801SMiguel Ojeda //
269*c3739801SMiguel Ojeda //     Thanks to the null pointer optimization, `NonZeroU8` and `Option<NonZeroU8>`
270*c3739801SMiguel Ojeda //     are guaranteed to have the same size and alignment:
271*c3739801SMiguel Ojeda //
272*c3739801SMiguel Ojeda // [2] Per https://doc.rust-lang.org/1.81.0/std/num/type.NonZeroI8.html:
273*c3739801SMiguel Ojeda //
274*c3739801SMiguel Ojeda //     `Option<NonZeroI8>` is guaranteed to be compatible with `i8`, including in FFI.
275*c3739801SMiguel Ojeda //
276*c3739801SMiguel Ojeda //     Thanks to the null pointer optimization, `NonZeroI8` and `Option<NonZeroI8>`
277*c3739801SMiguel Ojeda //     are guaranteed to have the same size and alignment:
278*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
279*c3739801SMiguel Ojeda const _: () = unsafe {
280*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroU8>: TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
281*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroI8>: TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
282*c3739801SMiguel Ojeda     assert_unaligned!(Option<NonZeroU8>, Option<NonZeroI8>);
283*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroU16>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
284*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroI16>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
285*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroU32>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
286*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroI32>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
287*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroU64>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
288*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroI64>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
289*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroU128>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
290*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroI128>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
291*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroUsize>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
292*c3739801SMiguel Ojeda     unsafe_impl!(Option<NonZeroIsize>: TryFromBytes, FromZeros, FromBytes, IntoBytes);
293*c3739801SMiguel Ojeda };
294*c3739801SMiguel Ojeda 
295*c3739801SMiguel Ojeda // SAFETY: While it's not fully documented, the consensus is that `Box<T>` does
296*c3739801SMiguel Ojeda // not contain any `UnsafeCell`s for `T: Sized` [1]. This is not a complete
297*c3739801SMiguel Ojeda // proof, but we are accepting this as a known risk per #1358.
298*c3739801SMiguel Ojeda //
299*c3739801SMiguel Ojeda // [1] https://github.com/rust-lang/unsafe-code-guidelines/issues/492
300*c3739801SMiguel Ojeda #[cfg(feature = "alloc")]
301*c3739801SMiguel Ojeda const _: () = unsafe {
302*c3739801SMiguel Ojeda     unsafe_impl!(
303*c3739801SMiguel Ojeda         #[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
304*c3739801SMiguel Ojeda         T: Sized => Immutable for Box<T>
305*c3739801SMiguel Ojeda     )
306*c3739801SMiguel Ojeda };
307*c3739801SMiguel Ojeda 
308*c3739801SMiguel Ojeda // SAFETY: The following types can be transmuted from `[0u8; size_of::<T>()]`. [1]
309*c3739801SMiguel Ojeda //
310*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.89.0/core/option/index.html#representation:
311*c3739801SMiguel Ojeda //
312*c3739801SMiguel Ojeda //   Rust guarantees to optimize the following types `T` such that [`Option<T>`]
313*c3739801SMiguel Ojeda //   has the same size and alignment as `T`. In some of these cases, Rust
314*c3739801SMiguel Ojeda //   further guarantees that `transmute::<_, Option<T>>([0u8; size_of::<T>()])`
315*c3739801SMiguel Ojeda //   is sound and produces `Option::<T>::None`. These cases are identified by
316*c3739801SMiguel Ojeda //   the second column:
317*c3739801SMiguel Ojeda //
318*c3739801SMiguel Ojeda //   | `T`                               | `transmute::<_, Option<T>>([0u8; size_of::<T>()])` sound? |
319*c3739801SMiguel Ojeda //   |-----------------------------------|-----------------------------------------------------------|
320*c3739801SMiguel Ojeda //   | [`Box<U>`]                        | when `U: Sized`                                           |
321*c3739801SMiguel Ojeda //   | `&U`                              | when `U: Sized`                                           |
322*c3739801SMiguel Ojeda //   | `&mut U`                          | when `U: Sized`                                           |
323*c3739801SMiguel Ojeda //   | [`ptr::NonNull<U>`]               | when `U: Sized`                                           |
324*c3739801SMiguel Ojeda //   | `fn`, `extern "C" fn`[^extern_fn] | always                                                    |
325*c3739801SMiguel Ojeda //
326*c3739801SMiguel Ojeda //   [^extern_fn]: this remains true for `unsafe` variants, any argument/return
327*c3739801SMiguel Ojeda //     types, and any other ABI: `[unsafe] extern "abi" fn` (_e.g._, `extern
328*c3739801SMiguel Ojeda //     "system" fn`)
329*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
330*c3739801SMiguel Ojeda const _: () = unsafe {
331*c3739801SMiguel Ojeda     #[cfg(feature = "alloc")]
332*c3739801SMiguel Ojeda     unsafe_impl!(
333*c3739801SMiguel Ojeda         #[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
334*c3739801SMiguel Ojeda         T => TryFromBytes for Option<Box<T>>; |c| pointer::is_zeroed(c)
335*c3739801SMiguel Ojeda     );
336*c3739801SMiguel Ojeda     #[cfg(feature = "alloc")]
337*c3739801SMiguel Ojeda     unsafe_impl!(
338*c3739801SMiguel Ojeda         #[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
339*c3739801SMiguel Ojeda         T => FromZeros for Option<Box<T>>
340*c3739801SMiguel Ojeda     );
341*c3739801SMiguel Ojeda     unsafe_impl!(
342*c3739801SMiguel Ojeda         T => TryFromBytes for Option<&'_ T>; |c| pointer::is_zeroed(c)
343*c3739801SMiguel Ojeda     );
344*c3739801SMiguel Ojeda     unsafe_impl!(T => FromZeros for Option<&'_ T>);
345*c3739801SMiguel Ojeda     unsafe_impl!(
346*c3739801SMiguel Ojeda             T => TryFromBytes for Option<&'_ mut T>; |c| pointer::is_zeroed(c)
347*c3739801SMiguel Ojeda     );
348*c3739801SMiguel Ojeda     unsafe_impl!(T => FromZeros for Option<&'_ mut T>);
349*c3739801SMiguel Ojeda     unsafe_impl!(
350*c3739801SMiguel Ojeda         T => TryFromBytes for Option<NonNull<T>>; |c| pointer::is_zeroed(c)
351*c3739801SMiguel Ojeda     );
352*c3739801SMiguel Ojeda     unsafe_impl!(T => FromZeros for Option<NonNull<T>>);
353*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(A, B, C, D, E, F, G, H, I, J, K, L -> M => FromZeros for opt_fn!(...));
354*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(
355*c3739801SMiguel Ojeda         A, B, C, D, E, F, G, H, I, J, K, L -> M => TryFromBytes for opt_fn!(...);
356*c3739801SMiguel Ojeda         |c| pointer::is_zeroed(c)
357*c3739801SMiguel Ojeda     );
358*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(A, B, C, D, E, F, G, H, I, J, K, L -> M => FromZeros for opt_unsafe_fn!(...));
359*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(
360*c3739801SMiguel Ojeda         A, B, C, D, E, F, G, H, I, J, K, L -> M => TryFromBytes for opt_unsafe_fn!(...);
361*c3739801SMiguel Ojeda         |c| pointer::is_zeroed(c)
362*c3739801SMiguel Ojeda     );
363*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(A, B, C, D, E, F, G, H, I, J, K, L -> M => FromZeros for opt_extern_c_fn!(...));
364*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(
365*c3739801SMiguel Ojeda         A, B, C, D, E, F, G, H, I, J, K, L -> M => TryFromBytes for opt_extern_c_fn!(...);
366*c3739801SMiguel Ojeda         |c| pointer::is_zeroed(c)
367*c3739801SMiguel Ojeda     );
368*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(A, B, C, D, E, F, G, H, I, J, K, L -> M => FromZeros for opt_unsafe_extern_c_fn!(...));
369*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(
370*c3739801SMiguel Ojeda         A, B, C, D, E, F, G, H, I, J, K, L -> M => TryFromBytes for opt_unsafe_extern_c_fn!(...);
371*c3739801SMiguel Ojeda         |c| pointer::is_zeroed(c)
372*c3739801SMiguel Ojeda     );
373*c3739801SMiguel Ojeda };
374*c3739801SMiguel Ojeda 
375*c3739801SMiguel Ojeda // SAFETY: `[unsafe] [extern "C"] fn()` self-evidently do not contain
376*c3739801SMiguel Ojeda // `UnsafeCell`s. This is not a proof, but we are accepting this as a known risk
377*c3739801SMiguel Ojeda // per #1358.
378*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
379*c3739801SMiguel Ojeda const _: () = unsafe {
380*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(A, B, C, D, E, F, G, H, I, J, K, L -> M => Immutable for opt_fn!(...));
381*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(A, B, C, D, E, F, G, H, I, J, K, L -> M => Immutable for opt_unsafe_fn!(...));
382*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(A, B, C, D, E, F, G, H, I, J, K, L -> M => Immutable for opt_extern_c_fn!(...));
383*c3739801SMiguel Ojeda     unsafe_impl_for_power_set!(A, B, C, D, E, F, G, H, I, J, K, L -> M => Immutable for opt_unsafe_extern_c_fn!(...));
384*c3739801SMiguel Ojeda };
385*c3739801SMiguel Ojeda 
386*c3739801SMiguel Ojeda #[cfg(all(
387*c3739801SMiguel Ojeda     not(no_zerocopy_target_has_atomics_1_60_0),
388*c3739801SMiguel Ojeda     any(
389*c3739801SMiguel Ojeda         target_has_atomic = "8",
390*c3739801SMiguel Ojeda         target_has_atomic = "16",
391*c3739801SMiguel Ojeda         target_has_atomic = "32",
392*c3739801SMiguel Ojeda         target_has_atomic = "64",
393*c3739801SMiguel Ojeda         target_has_atomic = "ptr"
394*c3739801SMiguel Ojeda     )
395*c3739801SMiguel Ojeda ))]
396*c3739801SMiguel Ojeda #[cfg_attr(doc_cfg, doc(cfg(rust = "1.60.0")))]
397*c3739801SMiguel Ojeda mod atomics {
398*c3739801SMiguel Ojeda     use super::*;
399*c3739801SMiguel Ojeda 
400*c3739801SMiguel Ojeda     macro_rules! impl_traits_for_atomics {
401*c3739801SMiguel Ojeda         ($($atomics:tt [$primitives:ty]),* $(,)?) => {
402*c3739801SMiguel Ojeda             $(
403*c3739801SMiguel Ojeda                 impl_known_layout!($atomics);
404*c3739801SMiguel Ojeda                 impl_for_transmute_from!(=> FromZeros for $atomics [$primitives]);
405*c3739801SMiguel Ojeda                 impl_for_transmute_from!(=> FromBytes for $atomics [$primitives]);
406*c3739801SMiguel Ojeda                 impl_for_transmute_from!(=> TryFromBytes for $atomics [$primitives]);
407*c3739801SMiguel Ojeda                 impl_for_transmute_from!(=> IntoBytes for $atomics [$primitives]);
408*c3739801SMiguel Ojeda             )*
409*c3739801SMiguel Ojeda         };
410*c3739801SMiguel Ojeda     }
411*c3739801SMiguel Ojeda 
412*c3739801SMiguel Ojeda     /// Implements `TransmuteFrom` for `$atomic`, `$prim`, and
413*c3739801SMiguel Ojeda     /// `UnsafeCell<$prim>`.
414*c3739801SMiguel Ojeda     ///
415*c3739801SMiguel Ojeda     /// # Safety
416*c3739801SMiguel Ojeda     ///
417*c3739801SMiguel Ojeda     /// `$atomic` must have the same size and bit validity as `$prim`.
418*c3739801SMiguel Ojeda     macro_rules! unsafe_impl_transmute_from_for_atomic {
419*c3739801SMiguel Ojeda         ($($($tyvar:ident)? => $atomic:ty [$prim:ty]),*) => {{
420*c3739801SMiguel Ojeda             crate::util::macros::__unsafe();
421*c3739801SMiguel Ojeda 
422*c3739801SMiguel Ojeda             use crate::pointer::{SizeEq, TransmuteFrom, invariant::Valid};
423*c3739801SMiguel Ojeda 
424*c3739801SMiguel Ojeda             $(
425*c3739801SMiguel Ojeda                 // SAFETY: The caller promised that `$atomic` and `$prim` have
426*c3739801SMiguel Ojeda                 // the same size and bit validity.
427*c3739801SMiguel Ojeda                 unsafe impl<$($tyvar)?> TransmuteFrom<$atomic, Valid, Valid> for $prim {}
428*c3739801SMiguel Ojeda                 // SAFETY: The caller promised that `$atomic` and `$prim` have
429*c3739801SMiguel Ojeda                 // the same size and bit validity.
430*c3739801SMiguel Ojeda                 unsafe impl<$($tyvar)?> TransmuteFrom<$prim, Valid, Valid> for $atomic {}
431*c3739801SMiguel Ojeda 
432*c3739801SMiguel Ojeda                 impl<$($tyvar)?> SizeEq<ReadOnly<$atomic>> for ReadOnly<$prim> {
433*c3739801SMiguel Ojeda                     type CastFrom = $crate::pointer::cast::CastSizedExact;
434*c3739801SMiguel Ojeda                 }
435*c3739801SMiguel Ojeda 
436*c3739801SMiguel Ojeda                 // SAFETY: The caller promised that `$atomic` and `$prim` have
437*c3739801SMiguel Ojeda                 // the same bit validity. `UnsafeCell<T>` has the same bit
438*c3739801SMiguel Ojeda                 // validity as `T` [1].
439*c3739801SMiguel Ojeda                 //
440*c3739801SMiguel Ojeda                 // [1] Per https://doc.rust-lang.org/1.85.0/std/cell/struct.UnsafeCell.html#memory-layout:
441*c3739801SMiguel Ojeda                 //
442*c3739801SMiguel Ojeda                 //   `UnsafeCell<T>` has the same in-memory representation as
443*c3739801SMiguel Ojeda                 //   its inner type `T`. A consequence of this guarantee is that
444*c3739801SMiguel Ojeda                 //   it is possible to convert between `T` and `UnsafeCell<T>`.
445*c3739801SMiguel Ojeda                 unsafe impl<$($tyvar)?> TransmuteFrom<$atomic, Valid, Valid> for core::cell::UnsafeCell<$prim> {}
446*c3739801SMiguel Ojeda                 // SAFETY: See previous safety comment.
447*c3739801SMiguel Ojeda                 unsafe impl<$($tyvar)?> TransmuteFrom<core::cell::UnsafeCell<$prim>, Valid, Valid> for $atomic {}
448*c3739801SMiguel Ojeda             )*
449*c3739801SMiguel Ojeda         }};
450*c3739801SMiguel Ojeda     }
451*c3739801SMiguel Ojeda 
452*c3739801SMiguel Ojeda     #[cfg(target_has_atomic = "8")]
453*c3739801SMiguel Ojeda     #[cfg_attr(doc_cfg, doc(cfg(target_has_atomic = "8")))]
454*c3739801SMiguel Ojeda     mod atomic_8 {
455*c3739801SMiguel Ojeda         use core::sync::atomic::{AtomicBool, AtomicI8, AtomicU8};
456*c3739801SMiguel Ojeda 
457*c3739801SMiguel Ojeda         use super::*;
458*c3739801SMiguel Ojeda 
459*c3739801SMiguel Ojeda         impl_traits_for_atomics!(AtomicU8[u8], AtomicI8[i8]);
460*c3739801SMiguel Ojeda 
461*c3739801SMiguel Ojeda         impl_known_layout!(AtomicBool);
462*c3739801SMiguel Ojeda         impl_for_transmute_from!(=> FromZeros for AtomicBool [bool]);
463*c3739801SMiguel Ojeda         impl_for_transmute_from!(=> TryFromBytes for AtomicBool [bool]);
464*c3739801SMiguel Ojeda         impl_for_transmute_from!(=> IntoBytes for AtomicBool [bool]);
465*c3739801SMiguel Ojeda 
466*c3739801SMiguel Ojeda         // SAFETY: Per [1], `AtomicBool`, `AtomicU8`, and `AtomicI8` have the
467*c3739801SMiguel Ojeda         // same size as `bool`, `u8`, and `i8` respectively. Since a type's
468*c3739801SMiguel Ojeda         // alignment cannot be smaller than 1 [2], and since its alignment
469*c3739801SMiguel Ojeda         // cannot be greater than its size [3], the only possible value for the
470*c3739801SMiguel Ojeda         // alignment is 1. Thus, it is sound to implement `Unaligned`.
471*c3739801SMiguel Ojeda         //
472*c3739801SMiguel Ojeda         // [1] Per (for example) https://doc.rust-lang.org/1.81.0/std/sync/atomic/struct.AtomicU8.html:
473*c3739801SMiguel Ojeda         //
474*c3739801SMiguel Ojeda         //   This type has the same size, alignment, and bit validity as the
475*c3739801SMiguel Ojeda         //   underlying integer type
476*c3739801SMiguel Ojeda         //
477*c3739801SMiguel Ojeda         // [2] Per https://doc.rust-lang.org/1.81.0/reference/type-layout.html#size-and-alignment:
478*c3739801SMiguel Ojeda         //
479*c3739801SMiguel Ojeda         //     Alignment is measured in bytes, and must be at least 1.
480*c3739801SMiguel Ojeda         //
481*c3739801SMiguel Ojeda         // [3] Per https://doc.rust-lang.org/1.81.0/reference/type-layout.html#size-and-alignment:
482*c3739801SMiguel Ojeda         //
483*c3739801SMiguel Ojeda         //     The size of a value is always a multiple of its alignment.
484*c3739801SMiguel Ojeda         #[allow(clippy::multiple_unsafe_ops_per_block)]
485*c3739801SMiguel Ojeda         const _: () = unsafe {
486*c3739801SMiguel Ojeda             unsafe_impl!(AtomicBool: Unaligned);
487*c3739801SMiguel Ojeda             unsafe_impl!(AtomicU8: Unaligned);
488*c3739801SMiguel Ojeda             unsafe_impl!(AtomicI8: Unaligned);
489*c3739801SMiguel Ojeda             assert_unaligned!(AtomicBool, AtomicU8, AtomicI8);
490*c3739801SMiguel Ojeda         };
491*c3739801SMiguel Ojeda 
492*c3739801SMiguel Ojeda         // SAFETY: `AtomicU8`, `AtomicI8`, and `AtomicBool` have the same size
493*c3739801SMiguel Ojeda         // and bit validity as `u8`, `i8`, and `bool` respectively [1][2][3].
494*c3739801SMiguel Ojeda         //
495*c3739801SMiguel Ojeda         // [1] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicU8.html:
496*c3739801SMiguel Ojeda         //
497*c3739801SMiguel Ojeda         //   This type has the same size, alignment, and bit validity as the
498*c3739801SMiguel Ojeda         //   underlying integer type, `u8`.
499*c3739801SMiguel Ojeda         //
500*c3739801SMiguel Ojeda         // [2] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicI8.html:
501*c3739801SMiguel Ojeda         //
502*c3739801SMiguel Ojeda         //   This type has the same size, alignment, and bit validity as the
503*c3739801SMiguel Ojeda         //   underlying integer type, `i8`.
504*c3739801SMiguel Ojeda         //
505*c3739801SMiguel Ojeda         // [3] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicBool.html:
506*c3739801SMiguel Ojeda         //
507*c3739801SMiguel Ojeda         //   This type has the same size, alignment, and bit validity a `bool`.
508*c3739801SMiguel Ojeda         #[allow(clippy::multiple_unsafe_ops_per_block)]
509*c3739801SMiguel Ojeda         const _: () = unsafe {
510*c3739801SMiguel Ojeda             unsafe_impl_transmute_from_for_atomic!(
511*c3739801SMiguel Ojeda                 => AtomicU8 [u8],
512*c3739801SMiguel Ojeda                 => AtomicI8 [i8],
513*c3739801SMiguel Ojeda                 => AtomicBool [bool]
514*c3739801SMiguel Ojeda             )
515*c3739801SMiguel Ojeda         };
516*c3739801SMiguel Ojeda     }
517*c3739801SMiguel Ojeda 
518*c3739801SMiguel Ojeda     #[cfg(target_has_atomic = "16")]
519*c3739801SMiguel Ojeda     #[cfg_attr(doc_cfg, doc(cfg(target_has_atomic = "16")))]
520*c3739801SMiguel Ojeda     mod atomic_16 {
521*c3739801SMiguel Ojeda         use core::sync::atomic::{AtomicI16, AtomicU16};
522*c3739801SMiguel Ojeda 
523*c3739801SMiguel Ojeda         use super::*;
524*c3739801SMiguel Ojeda 
525*c3739801SMiguel Ojeda         impl_traits_for_atomics!(AtomicU16[u16], AtomicI16[i16]);
526*c3739801SMiguel Ojeda 
527*c3739801SMiguel Ojeda         // SAFETY: `AtomicU16` and `AtomicI16` have the same size and bit
528*c3739801SMiguel Ojeda         // validity as `u16` and `i16` respectively [1][2].
529*c3739801SMiguel Ojeda         //
530*c3739801SMiguel Ojeda         // [1] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicU16.html:
531*c3739801SMiguel Ojeda         //
532*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as the underlying
533*c3739801SMiguel Ojeda         //   integer type, `u16`.
534*c3739801SMiguel Ojeda         //
535*c3739801SMiguel Ojeda         // [2] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicI16.html:
536*c3739801SMiguel Ojeda         //
537*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as the underlying
538*c3739801SMiguel Ojeda         //   integer type, `i16`.
539*c3739801SMiguel Ojeda         #[allow(clippy::multiple_unsafe_ops_per_block)]
540*c3739801SMiguel Ojeda         const _: () = unsafe {
541*c3739801SMiguel Ojeda             unsafe_impl_transmute_from_for_atomic!(=> AtomicU16 [u16], => AtomicI16 [i16])
542*c3739801SMiguel Ojeda         };
543*c3739801SMiguel Ojeda     }
544*c3739801SMiguel Ojeda 
545*c3739801SMiguel Ojeda     #[cfg(target_has_atomic = "32")]
546*c3739801SMiguel Ojeda     #[cfg_attr(doc_cfg, doc(cfg(target_has_atomic = "32")))]
547*c3739801SMiguel Ojeda     mod atomic_32 {
548*c3739801SMiguel Ojeda         use core::sync::atomic::{AtomicI32, AtomicU32};
549*c3739801SMiguel Ojeda 
550*c3739801SMiguel Ojeda         use super::*;
551*c3739801SMiguel Ojeda 
552*c3739801SMiguel Ojeda         impl_traits_for_atomics!(AtomicU32[u32], AtomicI32[i32]);
553*c3739801SMiguel Ojeda 
554*c3739801SMiguel Ojeda         // SAFETY: `AtomicU32` and `AtomicI32` have the same size and bit
555*c3739801SMiguel Ojeda         // validity as `u32` and `i32` respectively [1][2].
556*c3739801SMiguel Ojeda         //
557*c3739801SMiguel Ojeda         // [1] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicU32.html:
558*c3739801SMiguel Ojeda         //
559*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as the underlying
560*c3739801SMiguel Ojeda         //   integer type, `u32`.
561*c3739801SMiguel Ojeda         //
562*c3739801SMiguel Ojeda         // [2] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicI32.html:
563*c3739801SMiguel Ojeda         //
564*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as the underlying
565*c3739801SMiguel Ojeda         //   integer type, `i32`.
566*c3739801SMiguel Ojeda         #[allow(clippy::multiple_unsafe_ops_per_block)]
567*c3739801SMiguel Ojeda         const _: () = unsafe {
568*c3739801SMiguel Ojeda             unsafe_impl_transmute_from_for_atomic!(=> AtomicU32 [u32], => AtomicI32 [i32])
569*c3739801SMiguel Ojeda         };
570*c3739801SMiguel Ojeda     }
571*c3739801SMiguel Ojeda 
572*c3739801SMiguel Ojeda     #[cfg(target_has_atomic = "64")]
573*c3739801SMiguel Ojeda     #[cfg_attr(doc_cfg, doc(cfg(target_has_atomic = "64")))]
574*c3739801SMiguel Ojeda     mod atomic_64 {
575*c3739801SMiguel Ojeda         use core::sync::atomic::{AtomicI64, AtomicU64};
576*c3739801SMiguel Ojeda 
577*c3739801SMiguel Ojeda         use super::*;
578*c3739801SMiguel Ojeda 
579*c3739801SMiguel Ojeda         impl_traits_for_atomics!(AtomicU64[u64], AtomicI64[i64]);
580*c3739801SMiguel Ojeda 
581*c3739801SMiguel Ojeda         // SAFETY: `AtomicU64` and `AtomicI64` have the same size and bit
582*c3739801SMiguel Ojeda         // validity as `u64` and `i64` respectively [1][2].
583*c3739801SMiguel Ojeda         //
584*c3739801SMiguel Ojeda         // [1] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicU64.html:
585*c3739801SMiguel Ojeda         //
586*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as the underlying
587*c3739801SMiguel Ojeda         //   integer type, `u64`.
588*c3739801SMiguel Ojeda         //
589*c3739801SMiguel Ojeda         // [2] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicI64.html:
590*c3739801SMiguel Ojeda         //
591*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as the underlying
592*c3739801SMiguel Ojeda         //   integer type, `i64`.
593*c3739801SMiguel Ojeda         #[allow(clippy::multiple_unsafe_ops_per_block)]
594*c3739801SMiguel Ojeda         const _: () = unsafe {
595*c3739801SMiguel Ojeda             unsafe_impl_transmute_from_for_atomic!(=> AtomicU64 [u64], => AtomicI64 [i64])
596*c3739801SMiguel Ojeda         };
597*c3739801SMiguel Ojeda     }
598*c3739801SMiguel Ojeda 
599*c3739801SMiguel Ojeda     #[cfg(target_has_atomic = "ptr")]
600*c3739801SMiguel Ojeda     #[cfg_attr(doc_cfg, doc(cfg(target_has_atomic = "ptr")))]
601*c3739801SMiguel Ojeda     mod atomic_ptr {
602*c3739801SMiguel Ojeda         use core::sync::atomic::{AtomicIsize, AtomicPtr, AtomicUsize};
603*c3739801SMiguel Ojeda 
604*c3739801SMiguel Ojeda         use super::*;
605*c3739801SMiguel Ojeda 
606*c3739801SMiguel Ojeda         impl_traits_for_atomics!(AtomicUsize[usize], AtomicIsize[isize]);
607*c3739801SMiguel Ojeda 
608*c3739801SMiguel Ojeda         // FIXME(#170): Implement `FromBytes` and `IntoBytes` once we implement
609*c3739801SMiguel Ojeda         // those traits for `*mut T`.
610*c3739801SMiguel Ojeda         impl_known_layout!(T => AtomicPtr<T>);
611*c3739801SMiguel Ojeda         impl_for_transmute_from!(T => TryFromBytes for AtomicPtr<T> [*mut T]);
612*c3739801SMiguel Ojeda         impl_for_transmute_from!(T => FromZeros for AtomicPtr<T> [*mut T]);
613*c3739801SMiguel Ojeda 
614*c3739801SMiguel Ojeda         // SAFETY: `AtomicUsize` and `AtomicIsize` have the same size and bit
615*c3739801SMiguel Ojeda         // validity as `usize` and `isize` respectively [1][2].
616*c3739801SMiguel Ojeda         //
617*c3739801SMiguel Ojeda         // [1] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicUsize.html:
618*c3739801SMiguel Ojeda         //
619*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as the underlying
620*c3739801SMiguel Ojeda         //   integer type, `usize`.
621*c3739801SMiguel Ojeda         //
622*c3739801SMiguel Ojeda         // [2] Per https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicIsize.html:
623*c3739801SMiguel Ojeda         //
624*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as the underlying
625*c3739801SMiguel Ojeda         //   integer type, `isize`.
626*c3739801SMiguel Ojeda         #[allow(clippy::multiple_unsafe_ops_per_block)]
627*c3739801SMiguel Ojeda         const _: () = unsafe {
628*c3739801SMiguel Ojeda             unsafe_impl_transmute_from_for_atomic!(=> AtomicUsize [usize], => AtomicIsize [isize])
629*c3739801SMiguel Ojeda         };
630*c3739801SMiguel Ojeda 
631*c3739801SMiguel Ojeda         // SAFETY: Per
632*c3739801SMiguel Ojeda         // https://doc.rust-lang.org/1.85.0/std/sync/atomic/struct.AtomicPtr.html:
633*c3739801SMiguel Ojeda         //
634*c3739801SMiguel Ojeda         //   This type has the same size and bit validity as a `*mut T`.
635*c3739801SMiguel Ojeda         #[allow(clippy::multiple_unsafe_ops_per_block)]
636*c3739801SMiguel Ojeda         const _: () = unsafe { unsafe_impl_transmute_from_for_atomic!(T => AtomicPtr<T> [*mut T]) };
637*c3739801SMiguel Ojeda     }
638*c3739801SMiguel Ojeda }
639*c3739801SMiguel Ojeda 
640*c3739801SMiguel Ojeda // SAFETY: Per reference [1]: "For all T, the following are guaranteed:
641*c3739801SMiguel Ojeda // size_of::<PhantomData<T>>() == 0 align_of::<PhantomData<T>>() == 1". This
642*c3739801SMiguel Ojeda // gives:
643*c3739801SMiguel Ojeda // - `Immutable`: `PhantomData` has no fields.
644*c3739801SMiguel Ojeda // - `TryFromBytes` (with no validator), `FromZeros`, `FromBytes`: There is only
645*c3739801SMiguel Ojeda //   one possible sequence of 0 bytes, and `PhantomData` is inhabited.
646*c3739801SMiguel Ojeda // - `IntoBytes`: Since `PhantomData` has size 0, it contains no padding bytes.
647*c3739801SMiguel Ojeda // - `Unaligned`: Per the preceding reference, `PhantomData` has alignment 1.
648*c3739801SMiguel Ojeda //
649*c3739801SMiguel Ojeda // [1] https://doc.rust-lang.org/1.81.0/std/marker/struct.PhantomData.html#layout-1
650*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
651*c3739801SMiguel Ojeda const _: () = unsafe {
652*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => Immutable for PhantomData<T>);
653*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => TryFromBytes for PhantomData<T>);
654*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => FromZeros for PhantomData<T>);
655*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => FromBytes for PhantomData<T>);
656*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => IntoBytes for PhantomData<T>);
657*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => Unaligned for PhantomData<T>);
658*c3739801SMiguel Ojeda     assert_unaligned!(PhantomData<()>, PhantomData<u8>, PhantomData<u64>);
659*c3739801SMiguel Ojeda };
660*c3739801SMiguel Ojeda 
661*c3739801SMiguel Ojeda impl_for_transmute_from!(T: TryFromBytes => TryFromBytes for Wrapping<T>[T]);
662*c3739801SMiguel Ojeda impl_for_transmute_from!(T: FromZeros => FromZeros for Wrapping<T>[T]);
663*c3739801SMiguel Ojeda impl_for_transmute_from!(T: FromBytes => FromBytes for Wrapping<T>[T]);
664*c3739801SMiguel Ojeda impl_for_transmute_from!(T: IntoBytes => IntoBytes for Wrapping<T>[T]);
665*c3739801SMiguel Ojeda assert_unaligned!(Wrapping<()>, Wrapping<u8>);
666*c3739801SMiguel Ojeda 
667*c3739801SMiguel Ojeda // SAFETY: Per [1], `Wrapping<T>` has the same layout as `T`. Since its single
668*c3739801SMiguel Ojeda // field (of type `T`) is public, it would be a breaking change to add or remove
669*c3739801SMiguel Ojeda // fields. Thus, we know that `Wrapping<T>` contains a `T` (as opposed to just
670*c3739801SMiguel Ojeda // having the same size and alignment as `T`) with no pre- or post-padding.
671*c3739801SMiguel Ojeda // Thus, `Wrapping<T>` must have `UnsafeCell`s covering the same byte ranges as
672*c3739801SMiguel Ojeda // `Inner = T`.
673*c3739801SMiguel Ojeda //
674*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/std/num/struct.Wrapping.html#layout-1:
675*c3739801SMiguel Ojeda //
676*c3739801SMiguel Ojeda //   `Wrapping<T>` is guaranteed to have the same layout and ABI as `T`
677*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: Immutable => Immutable for Wrapping<T>) };
678*c3739801SMiguel Ojeda 
679*c3739801SMiguel Ojeda // SAFETY: Per [1] in the preceding safety comment, `Wrapping<T>` has the same
680*c3739801SMiguel Ojeda // alignment as `T`.
681*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: Unaligned => Unaligned for Wrapping<T>) };
682*c3739801SMiguel Ojeda 
683*c3739801SMiguel Ojeda // SAFETY: `TryFromBytes` (with no validator), `FromZeros`, `FromBytes`:
684*c3739801SMiguel Ojeda // `MaybeUninit<T>` has no restrictions on its contents.
685*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
686*c3739801SMiguel Ojeda const _: () = unsafe {
687*c3739801SMiguel Ojeda     unsafe_impl!(T => TryFromBytes for CoreMaybeUninit<T>);
688*c3739801SMiguel Ojeda     unsafe_impl!(T => FromZeros for CoreMaybeUninit<T>);
689*c3739801SMiguel Ojeda     unsafe_impl!(T => FromBytes for CoreMaybeUninit<T>);
690*c3739801SMiguel Ojeda };
691*c3739801SMiguel Ojeda 
692*c3739801SMiguel Ojeda // SAFETY: `MaybeUninit<T>` has `UnsafeCell`s covering the same byte ranges as
693*c3739801SMiguel Ojeda // `Inner = T`. This is not explicitly documented, but it can be inferred. Per
694*c3739801SMiguel Ojeda // [1], `MaybeUninit<T>` has the same size as `T`. Further, note the signature
695*c3739801SMiguel Ojeda // of `MaybeUninit::assume_init_ref` [2]:
696*c3739801SMiguel Ojeda //
697*c3739801SMiguel Ojeda //   pub unsafe fn assume_init_ref(&self) -> &T
698*c3739801SMiguel Ojeda //
699*c3739801SMiguel Ojeda // If the argument `&MaybeUninit<T>` and the returned `&T` had `UnsafeCell`s at
700*c3739801SMiguel Ojeda // different offsets, this would be unsound. Its existence is proof that this is
701*c3739801SMiguel Ojeda // not the case.
702*c3739801SMiguel Ojeda //
703*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/std/mem/union.MaybeUninit.html#layout-1:
704*c3739801SMiguel Ojeda //
705*c3739801SMiguel Ojeda // `MaybeUninit<T>` is guaranteed to have the same size, alignment, and ABI as
706*c3739801SMiguel Ojeda // `T`.
707*c3739801SMiguel Ojeda //
708*c3739801SMiguel Ojeda // [2] https://doc.rust-lang.org/1.81.0/std/mem/union.MaybeUninit.html#method.assume_init_ref
709*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: Immutable => Immutable for CoreMaybeUninit<T>) };
710*c3739801SMiguel Ojeda 
711*c3739801SMiguel Ojeda // SAFETY: Per [1] in the preceding safety comment, `MaybeUninit<T>` has the
712*c3739801SMiguel Ojeda // same alignment as `T`.
713*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: Unaligned => Unaligned for CoreMaybeUninit<T>) };
714*c3739801SMiguel Ojeda assert_unaligned!(CoreMaybeUninit<()>, CoreMaybeUninit<u8>);
715*c3739801SMiguel Ojeda 
716*c3739801SMiguel Ojeda // SAFETY: `ManuallyDrop<T>` has the same layout as `T` [1]. This strongly
717*c3739801SMiguel Ojeda // implies, but does not guarantee, that it contains `UnsafeCell`s covering the
718*c3739801SMiguel Ojeda // same byte ranges as in `T`. However, it also implements `Defer<Target = T>`
719*c3739801SMiguel Ojeda // [2], which provides the ability to convert `&ManuallyDrop<T> -> &T`. This,
720*c3739801SMiguel Ojeda // combined with having the same size as `T`, implies that `ManuallyDrop<T>`
721*c3739801SMiguel Ojeda // exactly contains a `T` with the same fields and `UnsafeCell`s covering the
722*c3739801SMiguel Ojeda // same byte ranges, or else the `Deref` impl would permit safe code to obtain
723*c3739801SMiguel Ojeda // different shared references to the same region of memory with different
724*c3739801SMiguel Ojeda // `UnsafeCell` coverage, which would in turn permit interior mutation that
725*c3739801SMiguel Ojeda // would violate the invariants of a shared reference.
726*c3739801SMiguel Ojeda //
727*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.85.0/std/mem/struct.ManuallyDrop.html:
728*c3739801SMiguel Ojeda //
729*c3739801SMiguel Ojeda //   `ManuallyDrop<T>` is guaranteed to have the same layout and bit validity as
730*c3739801SMiguel Ojeda //   `T`
731*c3739801SMiguel Ojeda //
732*c3739801SMiguel Ojeda // [2] https://doc.rust-lang.org/1.85.0/std/mem/struct.ManuallyDrop.html#impl-Deref-for-ManuallyDrop%3CT%3E
733*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: ?Sized + Immutable => Immutable for ManuallyDrop<T>) };
734*c3739801SMiguel Ojeda 
735*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + TryFromBytes => TryFromBytes for ManuallyDrop<T>[T]);
736*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + FromZeros => FromZeros for ManuallyDrop<T>[T]);
737*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + FromBytes => FromBytes for ManuallyDrop<T>[T]);
738*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + IntoBytes => IntoBytes for ManuallyDrop<T>[T]);
739*c3739801SMiguel Ojeda // SAFETY: `ManuallyDrop<T>` has the same layout as `T` [1], and thus has the
740*c3739801SMiguel Ojeda // same alignment as `T`.
741*c3739801SMiguel Ojeda //
742*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/std/mem/struct.ManuallyDrop.html:
743*c3739801SMiguel Ojeda //
744*c3739801SMiguel Ojeda //   `ManuallyDrop<T>` is guaranteed to have the same layout and bit validity as
745*c3739801SMiguel Ojeda //   `T`
746*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: ?Sized + Unaligned => Unaligned for ManuallyDrop<T>) };
747*c3739801SMiguel Ojeda assert_unaligned!(ManuallyDrop<()>, ManuallyDrop<u8>);
748*c3739801SMiguel Ojeda 
749*c3739801SMiguel Ojeda const _: () = {
750*c3739801SMiguel Ojeda     #[allow(
751*c3739801SMiguel Ojeda         non_camel_case_types,
752*c3739801SMiguel Ojeda         missing_copy_implementations,
753*c3739801SMiguel Ojeda         missing_debug_implementations,
754*c3739801SMiguel Ojeda         missing_docs
755*c3739801SMiguel Ojeda     )]
756*c3739801SMiguel Ojeda     pub enum value {}
757*c3739801SMiguel Ojeda 
758*c3739801SMiguel Ojeda     // SAFETY: See safety comment on `ProjectToTag`.
759*c3739801SMiguel Ojeda     unsafe impl<T: ?Sized> HasTag for ManuallyDrop<T> {
760*c3739801SMiguel Ojeda         #[inline]
761*c3739801SMiguel Ojeda         fn only_derive_is_allowed_to_implement_this_trait()
762*c3739801SMiguel Ojeda         where
763*c3739801SMiguel Ojeda             Self: Sized,
764*c3739801SMiguel Ojeda         {
765*c3739801SMiguel Ojeda         }
766*c3739801SMiguel Ojeda 
767*c3739801SMiguel Ojeda         type Tag = ();
768*c3739801SMiguel Ojeda 
769*c3739801SMiguel Ojeda         // SAFETY: It is trivially sound to project any pointer to a pointer to
770*c3739801SMiguel Ojeda         // a type of size zero and alignment 1 (which `()` is [1]). Such a
771*c3739801SMiguel Ojeda         // pointer will trivially satisfy its aliasing and validity requirements
772*c3739801SMiguel Ojeda         // (since it has a zero-sized referent), and its alignment requirement
773*c3739801SMiguel Ojeda         // (since it is aligned to 1).
774*c3739801SMiguel Ojeda         //
775*c3739801SMiguel Ojeda         // [1] Per https://doc.rust-lang.org/1.92.0/reference/type-layout.html#r-layout.tuple.unit:
776*c3739801SMiguel Ojeda         //
777*c3739801SMiguel Ojeda         //     [T]he unit tuple (`()`)... is guaranteed as a zero-sized type to
778*c3739801SMiguel Ojeda         //     have a size of 0 and an alignment of 1.
779*c3739801SMiguel Ojeda         type ProjectToTag = crate::pointer::cast::CastToUnit;
780*c3739801SMiguel Ojeda     }
781*c3739801SMiguel Ojeda 
782*c3739801SMiguel Ojeda     // SAFETY: `ManuallyDrop<T>` has a field of type `T` at offset `0` without
783*c3739801SMiguel Ojeda     // any safety invariants beyond those of `T`.  Its existence is not
784*c3739801SMiguel Ojeda     // explicitly documented, but it can be inferred; per [1] `ManuallyDrop<T>`
785*c3739801SMiguel Ojeda     // has the same size and bit validity as `T`. This field is not literally
786*c3739801SMiguel Ojeda     // public, but is effectively so; the field can be transparently:
787*c3739801SMiguel Ojeda     //
788*c3739801SMiguel Ojeda     //  - initialized via `ManuallyDrop::new`
789*c3739801SMiguel Ojeda     //  - moved via `ManuallyDrop::into_inner`
790*c3739801SMiguel Ojeda     //  - referenced via `ManuallyDrop::deref`
791*c3739801SMiguel Ojeda     //  - exclusively referenced via `ManuallyDrop::deref_mut`
792*c3739801SMiguel Ojeda     //
793*c3739801SMiguel Ojeda     // We call this field `value`, both because that is both the name of this
794*c3739801SMiguel Ojeda     // private field, and because it is the name it is referred to in the public
795*c3739801SMiguel Ojeda     // documentation of `ManuallyDrop::new`, `ManuallyDrop::into_inner`,
796*c3739801SMiguel Ojeda     // `ManuallyDrop::take` and `ManuallyDrop::drop`.
797*c3739801SMiguel Ojeda     unsafe impl<T: ?Sized>
798*c3739801SMiguel Ojeda         HasField<value, { crate::STRUCT_VARIANT_ID }, { crate::ident_id!(value) }>
799*c3739801SMiguel Ojeda         for ManuallyDrop<T>
800*c3739801SMiguel Ojeda     {
801*c3739801SMiguel Ojeda         #[inline]
802*c3739801SMiguel Ojeda         fn only_derive_is_allowed_to_implement_this_trait()
803*c3739801SMiguel Ojeda         where
804*c3739801SMiguel Ojeda             Self: Sized,
805*c3739801SMiguel Ojeda         {
806*c3739801SMiguel Ojeda         }
807*c3739801SMiguel Ojeda 
808*c3739801SMiguel Ojeda         type Type = T;
809*c3739801SMiguel Ojeda 
810*c3739801SMiguel Ojeda         #[inline(always)]
811*c3739801SMiguel Ojeda         fn project(slf: PtrInner<'_, Self>) -> *mut T {
812*c3739801SMiguel Ojeda             // SAFETY: `ManuallyDrop<T>` has the same layout and bit validity as
813*c3739801SMiguel Ojeda             // `T` [1].
814*c3739801SMiguel Ojeda             //
815*c3739801SMiguel Ojeda             // [1] Per https://doc.rust-lang.org/1.85.0/std/mem/struct.ManuallyDrop.html:
816*c3739801SMiguel Ojeda             //
817*c3739801SMiguel Ojeda             //   `ManuallyDrop<T>` is guaranteed to have the same layout and bit
818*c3739801SMiguel Ojeda             //   validity as `T`
819*c3739801SMiguel Ojeda             #[allow(clippy::as_conversions)]
820*c3739801SMiguel Ojeda             return slf.as_ptr() as *mut T;
821*c3739801SMiguel Ojeda         }
822*c3739801SMiguel Ojeda     }
823*c3739801SMiguel Ojeda };
824*c3739801SMiguel Ojeda 
825*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + TryFromBytes => TryFromBytes for Cell<T>[T]);
826*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + FromZeros => FromZeros for Cell<T>[T]);
827*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + FromBytes => FromBytes for Cell<T>[T]);
828*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + IntoBytes => IntoBytes for Cell<T>[T]);
829*c3739801SMiguel Ojeda // SAFETY: `Cell<T>` has the same in-memory representation as `T` [1], and thus
830*c3739801SMiguel Ojeda // has the same alignment as `T`.
831*c3739801SMiguel Ojeda //
832*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/core/cell/struct.Cell.html#memory-layout:
833*c3739801SMiguel Ojeda //
834*c3739801SMiguel Ojeda //   `Cell<T>` has the same in-memory representation as its inner type `T`.
835*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: ?Sized + Unaligned => Unaligned for Cell<T>) };
836*c3739801SMiguel Ojeda 
837*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + FromZeros => FromZeros for UnsafeCell<T>[T]);
838*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + FromBytes => FromBytes for UnsafeCell<T>[T]);
839*c3739801SMiguel Ojeda impl_for_transmute_from!(T: ?Sized + IntoBytes => IntoBytes for UnsafeCell<T>[T]);
840*c3739801SMiguel Ojeda // SAFETY: `UnsafeCell<T>` has the same in-memory representation as `T` [1], and
841*c3739801SMiguel Ojeda // thus has the same alignment as `T`.
842*c3739801SMiguel Ojeda //
843*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/core/cell/struct.UnsafeCell.html#memory-layout:
844*c3739801SMiguel Ojeda //
845*c3739801SMiguel Ojeda //   `UnsafeCell<T>` has the same in-memory representation as its inner type
846*c3739801SMiguel Ojeda //   `T`.
847*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: ?Sized + Unaligned => Unaligned for UnsafeCell<T>) };
848*c3739801SMiguel Ojeda assert_unaligned!(UnsafeCell<()>, UnsafeCell<u8>);
849*c3739801SMiguel Ojeda 
850*c3739801SMiguel Ojeda // SAFETY: See safety comment in `is_bit_valid` impl.
851*c3739801SMiguel Ojeda unsafe impl<T: TryFromBytes + ?Sized> TryFromBytes for UnsafeCell<T> {
852*c3739801SMiguel Ojeda     #[allow(clippy::missing_inline_in_public_items)]
853*c3739801SMiguel Ojeda     fn only_derive_is_allowed_to_implement_this_trait()
854*c3739801SMiguel Ojeda     where
855*c3739801SMiguel Ojeda         Self: Sized,
856*c3739801SMiguel Ojeda     {
857*c3739801SMiguel Ojeda     }
858*c3739801SMiguel Ojeda 
859*c3739801SMiguel Ojeda     #[inline(always)]
860*c3739801SMiguel Ojeda     fn is_bit_valid<A>(candidate: Maybe<'_, Self, A>) -> bool
861*c3739801SMiguel Ojeda     where
862*c3739801SMiguel Ojeda         A: invariant::Alignment,
863*c3739801SMiguel Ojeda     {
864*c3739801SMiguel Ojeda         T::is_bit_valid(candidate.transmute::<_, _, BecauseImmutable>())
865*c3739801SMiguel Ojeda     }
866*c3739801SMiguel Ojeda }
867*c3739801SMiguel Ojeda 
868*c3739801SMiguel Ojeda // SAFETY: Per the reference [1]:
869*c3739801SMiguel Ojeda //
870*c3739801SMiguel Ojeda //   An array of `[T; N]` has a size of `size_of::<T>() * N` and the same
871*c3739801SMiguel Ojeda //   alignment of `T`. Arrays are laid out so that the zero-based `nth` element
872*c3739801SMiguel Ojeda //   of the array is offset from the start of the array by `n * size_of::<T>()`
873*c3739801SMiguel Ojeda //   bytes.
874*c3739801SMiguel Ojeda //
875*c3739801SMiguel Ojeda //   ...
876*c3739801SMiguel Ojeda //
877*c3739801SMiguel Ojeda //   Slices have the same layout as the section of the array they slice.
878*c3739801SMiguel Ojeda //
879*c3739801SMiguel Ojeda // In other words, the layout of a `[T]` or `[T; N]` is a sequence of `T`s laid
880*c3739801SMiguel Ojeda // out back-to-back with no bytes in between. Therefore, `[T]` or `[T; N]` are
881*c3739801SMiguel Ojeda // `Immutable`, `TryFromBytes`, `FromZeros`, `FromBytes`, and `IntoBytes` if `T`
882*c3739801SMiguel Ojeda // is (respectively). Furthermore, since an array/slice has "the same alignment
883*c3739801SMiguel Ojeda // of `T`", `[T]` and `[T; N]` are `Unaligned` if `T` is.
884*c3739801SMiguel Ojeda //
885*c3739801SMiguel Ojeda // Note that we don't `assert_unaligned!` for slice types because
886*c3739801SMiguel Ojeda // `assert_unaligned!` uses `align_of`, which only works for `Sized` types.
887*c3739801SMiguel Ojeda //
888*c3739801SMiguel Ojeda // [1] https://doc.rust-lang.org/1.81.0/reference/type-layout.html#array-layout
889*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
890*c3739801SMiguel Ojeda const _: () = unsafe {
891*c3739801SMiguel Ojeda     unsafe_impl!(const N: usize, T: Immutable => Immutable for [T; N]);
892*c3739801SMiguel Ojeda     unsafe_impl!(const N: usize, T: TryFromBytes => TryFromBytes for [T; N]; |c| {
893*c3739801SMiguel Ojeda         let c: Ptr<'_, [ReadOnly<T>; N], _> = c.cast::<_, crate::pointer::cast::CastSized, _>();
894*c3739801SMiguel Ojeda         let c: Ptr<'_, [ReadOnly<T>], _> = c.as_slice();
895*c3739801SMiguel Ojeda         let c: Ptr<'_, ReadOnly<[T]>, _> = c.cast::<_, crate::pointer::cast::CastUnsized, _>();
896*c3739801SMiguel Ojeda 
897*c3739801SMiguel Ojeda         // Note that this call may panic, but it would still be sound even if it
898*c3739801SMiguel Ojeda         // did. `is_bit_valid` does not promise that it will not panic (in fact,
899*c3739801SMiguel Ojeda         // it explicitly warns that it's a possibility), and we have not
900*c3739801SMiguel Ojeda         // violated any safety invariants that we must fix before returning.
901*c3739801SMiguel Ojeda         <[T] as TryFromBytes>::is_bit_valid(c)
902*c3739801SMiguel Ojeda     });
903*c3739801SMiguel Ojeda     unsafe_impl!(const N: usize, T: FromZeros => FromZeros for [T; N]);
904*c3739801SMiguel Ojeda     unsafe_impl!(const N: usize, T: FromBytes => FromBytes for [T; N]);
905*c3739801SMiguel Ojeda     unsafe_impl!(const N: usize, T: IntoBytes => IntoBytes for [T; N]);
906*c3739801SMiguel Ojeda     unsafe_impl!(const N: usize, T: Unaligned => Unaligned for [T; N]);
907*c3739801SMiguel Ojeda     assert_unaligned!([(); 0], [(); 1], [u8; 0], [u8; 1]);
908*c3739801SMiguel Ojeda     unsafe_impl!(T: Immutable => Immutable for [T]);
909*c3739801SMiguel Ojeda     unsafe_impl!(T: TryFromBytes => TryFromBytes for [T]; |c| {
910*c3739801SMiguel Ojeda         let c: Ptr<'_, [ReadOnly<T>], _> = c.cast::<_, crate::pointer::cast::CastUnsized, _>();
911*c3739801SMiguel Ojeda 
912*c3739801SMiguel Ojeda         // SAFETY: Per the reference [1]:
913*c3739801SMiguel Ojeda         //
914*c3739801SMiguel Ojeda         //   An array of `[T; N]` has a size of `size_of::<T>() * N` and the
915*c3739801SMiguel Ojeda         //   same alignment of `T`. Arrays are laid out so that the zero-based
916*c3739801SMiguel Ojeda         //   `nth` element of the array is offset from the start of the array by
917*c3739801SMiguel Ojeda         //   `n * size_of::<T>()` bytes.
918*c3739801SMiguel Ojeda         //
919*c3739801SMiguel Ojeda         //   ...
920*c3739801SMiguel Ojeda         //
921*c3739801SMiguel Ojeda         //   Slices have the same layout as the section of the array they slice.
922*c3739801SMiguel Ojeda         //
923*c3739801SMiguel Ojeda         // In other words, the layout of a `[T] is a sequence of `T`s laid out
924*c3739801SMiguel Ojeda         // back-to-back with no bytes in between. If all elements in `candidate`
925*c3739801SMiguel Ojeda         // are `is_bit_valid`, so too is `candidate`.
926*c3739801SMiguel Ojeda         //
927*c3739801SMiguel Ojeda         // Note that any of the below calls may panic, but it would still be
928*c3739801SMiguel Ojeda         // sound even if it did. `is_bit_valid` does not promise that it will
929*c3739801SMiguel Ojeda         // not panic (in fact, it explicitly warns that it's a possibility), and
930*c3739801SMiguel Ojeda         // we have not violated any safety invariants that we must fix before
931*c3739801SMiguel Ojeda         // returning.
932*c3739801SMiguel Ojeda         c.iter().all(<T as TryFromBytes>::is_bit_valid)
933*c3739801SMiguel Ojeda     });
934*c3739801SMiguel Ojeda     unsafe_impl!(T: FromZeros => FromZeros for [T]);
935*c3739801SMiguel Ojeda     unsafe_impl!(T: FromBytes => FromBytes for [T]);
936*c3739801SMiguel Ojeda     unsafe_impl!(T: IntoBytes => IntoBytes for [T]);
937*c3739801SMiguel Ojeda     unsafe_impl!(T: Unaligned => Unaligned for [T]);
938*c3739801SMiguel Ojeda };
939*c3739801SMiguel Ojeda 
940*c3739801SMiguel Ojeda // SAFETY:
941*c3739801SMiguel Ojeda // - `Immutable`: Raw pointers do not contain any `UnsafeCell`s.
942*c3739801SMiguel Ojeda // - `FromZeros`: For thin pointers (note that `T: Sized`), the zero pointer is
943*c3739801SMiguel Ojeda //   considered "null". [1] No operations which require provenance are legal on
944*c3739801SMiguel Ojeda //   null pointers, so this is not a footgun.
945*c3739801SMiguel Ojeda // - `TryFromBytes`: By the same reasoning as for `FromZeroes`, we can implement
946*c3739801SMiguel Ojeda //   `TryFromBytes` for thin pointers provided that
947*c3739801SMiguel Ojeda //   [`TryFromByte::is_bit_valid`] only produces `true` for zeroed bytes.
948*c3739801SMiguel Ojeda //
949*c3739801SMiguel Ojeda // NOTE(#170): Implementing `FromBytes` and `IntoBytes` for raw pointers would
950*c3739801SMiguel Ojeda // be sound, but carries provenance footguns. We want to support `FromBytes` and
951*c3739801SMiguel Ojeda // `IntoBytes` for raw pointers eventually, but we are holding off until we can
952*c3739801SMiguel Ojeda // figure out how to address those footguns.
953*c3739801SMiguel Ojeda //
954*c3739801SMiguel Ojeda // [1] Per https://doc.rust-lang.org/1.81.0/std/ptr/fn.null.html:
955*c3739801SMiguel Ojeda //
956*c3739801SMiguel Ojeda //   Creates a null raw pointer.
957*c3739801SMiguel Ojeda //
958*c3739801SMiguel Ojeda //   This function is equivalent to zero-initializing the pointer:
959*c3739801SMiguel Ojeda //   `MaybeUninit::<*const T>::zeroed().assume_init()`.
960*c3739801SMiguel Ojeda //
961*c3739801SMiguel Ojeda //   The resulting pointer has the address 0.
962*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
963*c3739801SMiguel Ojeda const _: () = unsafe {
964*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => Immutable for *const T);
965*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => Immutable for *mut T);
966*c3739801SMiguel Ojeda     unsafe_impl!(T => TryFromBytes for *const T; |c| pointer::is_zeroed(c));
967*c3739801SMiguel Ojeda     unsafe_impl!(T => FromZeros for *const T);
968*c3739801SMiguel Ojeda     unsafe_impl!(T => TryFromBytes for *mut T; |c| pointer::is_zeroed(c));
969*c3739801SMiguel Ojeda     unsafe_impl!(T => FromZeros for *mut T);
970*c3739801SMiguel Ojeda };
971*c3739801SMiguel Ojeda 
972*c3739801SMiguel Ojeda // SAFETY: `NonNull<T>` self-evidently does not contain `UnsafeCell`s. This is
973*c3739801SMiguel Ojeda // not a proof, but we are accepting this as a known risk per #1358.
974*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: ?Sized => Immutable for NonNull<T>) };
975*c3739801SMiguel Ojeda 
976*c3739801SMiguel Ojeda // SAFETY: Reference types do not contain any `UnsafeCell`s.
977*c3739801SMiguel Ojeda #[allow(clippy::multiple_unsafe_ops_per_block)]
978*c3739801SMiguel Ojeda const _: () = unsafe {
979*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => Immutable for &'_ T);
980*c3739801SMiguel Ojeda     unsafe_impl!(T: ?Sized => Immutable for &'_ mut T);
981*c3739801SMiguel Ojeda };
982*c3739801SMiguel Ojeda 
983*c3739801SMiguel Ojeda // SAFETY: `Option` is not `#[non_exhaustive]` [1], which means that the types
984*c3739801SMiguel Ojeda // in its variants cannot change, and no new variants can be added. `Option<T>`
985*c3739801SMiguel Ojeda // does not contain any `UnsafeCell`s outside of `T`. [1]
986*c3739801SMiguel Ojeda //
987*c3739801SMiguel Ojeda // [1] https://doc.rust-lang.org/core/option/enum.Option.html
988*c3739801SMiguel Ojeda const _: () = unsafe { unsafe_impl!(T: Immutable => Immutable for Option<T>) };
989*c3739801SMiguel Ojeda 
990*c3739801SMiguel Ojeda mod tuples {
991*c3739801SMiguel Ojeda     use super::*;
992*c3739801SMiguel Ojeda 
993*c3739801SMiguel Ojeda     /// Generates various trait implementations for tuples.
994*c3739801SMiguel Ojeda     ///
995*c3739801SMiguel Ojeda     /// # Safety
996*c3739801SMiguel Ojeda     ///
997*c3739801SMiguel Ojeda     /// `impl_tuple!` should be provided name-number pairs, where each number is
998*c3739801SMiguel Ojeda     /// the ordinal of the preceding type name.
999*c3739801SMiguel Ojeda     macro_rules! impl_tuple {
1000*c3739801SMiguel Ojeda         // Entry point.
1001*c3739801SMiguel Ojeda         ($($T:ident $I:tt),+ $(,)?) => {
1002*c3739801SMiguel Ojeda             crate::util::macros::__unsafe();
1003*c3739801SMiguel Ojeda             impl_tuple!(@all [] [$($T $I)+]);
1004*c3739801SMiguel Ojeda         };
1005*c3739801SMiguel Ojeda 
1006*c3739801SMiguel Ojeda         // Build up the set of tuple types (i.e., `(A,)`, `(A, B)`, `(A, B, C)`,
1007*c3739801SMiguel Ojeda         // etc.) Trait implementations that do not depend on field index may be
1008*c3739801SMiguel Ojeda         // added to this branch.
1009*c3739801SMiguel Ojeda         (@all [$($head_T:ident $head_I:tt)*] [$next_T:ident $next_I:tt $($tail:tt)*]) => {
1010*c3739801SMiguel Ojeda             // SAFETY: If all fields of the tuple `Self` are `Immutable`, so too is `Self`.
1011*c3739801SMiguel Ojeda             unsafe_impl!($($head_T: Immutable,)* $next_T: Immutable => Immutable for ($($head_T,)* $next_T,));
1012*c3739801SMiguel Ojeda 
1013*c3739801SMiguel Ojeda             // SAFETY: If all fields in `c` are `is_bit_valid`, so too is `c`.
1014*c3739801SMiguel Ojeda             unsafe_impl!($($head_T: TryFromBytes,)* $next_T: TryFromBytes => TryFromBytes for ($($head_T,)* $next_T,); |c| {
1015*c3739801SMiguel Ojeda                 let mut c = c;
1016*c3739801SMiguel Ojeda                 $(TryFromBytes::is_bit_valid(into_inner!(c.reborrow().project::<_, { crate::STRUCT_VARIANT_ID }, { crate::ident_id!($head_I) }>())) &&)*
1017*c3739801SMiguel Ojeda                     TryFromBytes::is_bit_valid(into_inner!(c.reborrow().project::<_, { crate::STRUCT_VARIANT_ID }, { crate::ident_id!($next_I) }>()))
1018*c3739801SMiguel Ojeda             });
1019*c3739801SMiguel Ojeda 
1020*c3739801SMiguel Ojeda             // SAFETY: If all fields in `Self` are `FromZeros`, so too is `Self`.
1021*c3739801SMiguel Ojeda             unsafe_impl!($($head_T: FromZeros,)* $next_T: FromZeros => FromZeros for ($($head_T,)* $next_T,));
1022*c3739801SMiguel Ojeda 
1023*c3739801SMiguel Ojeda             // SAFETY: If all fields in `Self` are `FromBytes`, so too is `Self`.
1024*c3739801SMiguel Ojeda             unsafe_impl!($($head_T: FromBytes,)* $next_T: FromBytes => FromBytes for ($($head_T,)* $next_T,));
1025*c3739801SMiguel Ojeda 
1026*c3739801SMiguel Ojeda             // SAFETY: See safety comment on `ProjectToTag`.
1027*c3739801SMiguel Ojeda             unsafe impl<$($head_T,)* $next_T> crate::HasTag for ($($head_T,)* $next_T,) {
1028*c3739801SMiguel Ojeda                 #[inline]
1029*c3739801SMiguel Ojeda                 fn only_derive_is_allowed_to_implement_this_trait()
1030*c3739801SMiguel Ojeda                 where
1031*c3739801SMiguel Ojeda                     Self: Sized
1032*c3739801SMiguel Ojeda                 {}
1033*c3739801SMiguel Ojeda 
1034*c3739801SMiguel Ojeda                 type Tag = ();
1035*c3739801SMiguel Ojeda 
1036*c3739801SMiguel Ojeda                 // SAFETY: It is trivially sound to project any pointer to a
1037*c3739801SMiguel Ojeda                 // pointer to a type of size zero and alignment 1 (which `()` is
1038*c3739801SMiguel Ojeda                 // [1]). Such a pointer will trivially satisfy its aliasing and
1039*c3739801SMiguel Ojeda                 // validity requirements (since it has a zero-sized referent),
1040*c3739801SMiguel Ojeda                 // and its alignment requirement (since it is aligned to 1).
1041*c3739801SMiguel Ojeda                 //
1042*c3739801SMiguel Ojeda                 // [1] Per https://doc.rust-lang.org/1.92.0/reference/type-layout.html#r-layout.tuple.unit:
1043*c3739801SMiguel Ojeda                 //
1044*c3739801SMiguel Ojeda                 //     [T]he unit tuple (`()`)... is guaranteed as a zero-sized
1045*c3739801SMiguel Ojeda                 //     type to have a size of 0 and an alignment of 1.
1046*c3739801SMiguel Ojeda                 type ProjectToTag = crate::pointer::cast::CastToUnit;
1047*c3739801SMiguel Ojeda             }
1048*c3739801SMiguel Ojeda 
1049*c3739801SMiguel Ojeda             // Generate impls that depend on tuple index.
1050*c3739801SMiguel Ojeda             impl_tuple!(@variants
1051*c3739801SMiguel Ojeda                 [$($head_T $head_I)* $next_T $next_I]
1052*c3739801SMiguel Ojeda                 []
1053*c3739801SMiguel Ojeda                 [$($head_T $head_I)* $next_T $next_I]
1054*c3739801SMiguel Ojeda             );
1055*c3739801SMiguel Ojeda 
1056*c3739801SMiguel Ojeda             // Recurse to next tuple size
1057*c3739801SMiguel Ojeda             impl_tuple!(@all [$($head_T $head_I)* $next_T $next_I] [$($tail)*]);
1058*c3739801SMiguel Ojeda         };
1059*c3739801SMiguel Ojeda         (@all [$($head_T:ident $head_I:tt)*] []) => {};
1060*c3739801SMiguel Ojeda 
1061*c3739801SMiguel Ojeda         // Emit trait implementations that depend on field index.
1062*c3739801SMiguel Ojeda         (@variants
1063*c3739801SMiguel Ojeda             // The full tuple definition in type–index pairs.
1064*c3739801SMiguel Ojeda             [$($AllT:ident $AllI:tt)+]
1065*c3739801SMiguel Ojeda             // Types before the current index.
1066*c3739801SMiguel Ojeda             [$($BeforeT:ident)*]
1067*c3739801SMiguel Ojeda             // The types and indices at and after the current index.
1068*c3739801SMiguel Ojeda             [$CurrT:ident $CurrI:tt $($AfterT:ident $AfterI:tt)*]
1069*c3739801SMiguel Ojeda         ) => {
1070*c3739801SMiguel Ojeda             // SAFETY:
1071*c3739801SMiguel Ojeda             // - `Self` is a struct (albeit anonymous), so `VARIANT_ID` is
1072*c3739801SMiguel Ojeda             //   `STRUCT_VARIANT_ID`.
1073*c3739801SMiguel Ojeda             // - `$CurrI` is the field at index `$CurrI`, so `FIELD_ID` is
1074*c3739801SMiguel Ojeda             //   `zerocopy::ident_id!($CurrI)`
1075*c3739801SMiguel Ojeda             // - `()` has the same visibility as the `.$CurrI` field (ie, `.0`,
1076*c3739801SMiguel Ojeda             //   `.1`, etc)
1077*c3739801SMiguel Ojeda             // - `Type` has the same type as `$CurrI`; i.e., `$CurrT`.
1078*c3739801SMiguel Ojeda             unsafe impl<$($AllT),+> crate::HasField<
1079*c3739801SMiguel Ojeda                 (),
1080*c3739801SMiguel Ojeda                 { crate::STRUCT_VARIANT_ID },
1081*c3739801SMiguel Ojeda                 { crate::ident_id!($CurrI)}
1082*c3739801SMiguel Ojeda             > for ($($AllT,)+) {
1083*c3739801SMiguel Ojeda                 #[inline]
1084*c3739801SMiguel Ojeda                 fn only_derive_is_allowed_to_implement_this_trait()
1085*c3739801SMiguel Ojeda                 where
1086*c3739801SMiguel Ojeda                     Self: Sized
1087*c3739801SMiguel Ojeda                 {}
1088*c3739801SMiguel Ojeda 
1089*c3739801SMiguel Ojeda                 type Type = $CurrT;
1090*c3739801SMiguel Ojeda 
1091*c3739801SMiguel Ojeda                 #[inline(always)]
1092*c3739801SMiguel Ojeda                 fn project(slf: crate::PtrInner<'_, Self>) -> *mut Self::Type {
1093*c3739801SMiguel Ojeda                     let slf = slf.as_non_null().as_ptr();
1094*c3739801SMiguel Ojeda                     // SAFETY: `PtrInner` promises it references either a zero-sized
1095*c3739801SMiguel Ojeda                     // byte range, or else will reference a byte range that is
1096*c3739801SMiguel Ojeda                     // entirely contained within an allocated object. In either
1097*c3739801SMiguel Ojeda                     // case, this guarantees that `(*slf).$CurrI` is in-bounds of
1098*c3739801SMiguel Ojeda                     // `slf`.
1099*c3739801SMiguel Ojeda                     unsafe { core::ptr::addr_of_mut!((*slf).$CurrI) }
1100*c3739801SMiguel Ojeda                 }
1101*c3739801SMiguel Ojeda             }
1102*c3739801SMiguel Ojeda 
1103*c3739801SMiguel Ojeda             // SAFETY: See comments on items.
1104*c3739801SMiguel Ojeda             unsafe impl<Aliasing, Alignment, $($AllT),+> crate::ProjectField<
1105*c3739801SMiguel Ojeda                 (),
1106*c3739801SMiguel Ojeda                 (Aliasing, Alignment, crate::invariant::Uninit),
1107*c3739801SMiguel Ojeda                 { crate::STRUCT_VARIANT_ID },
1108*c3739801SMiguel Ojeda                 { crate::ident_id!($CurrI)}
1109*c3739801SMiguel Ojeda             > for ($($AllT,)+)
1110*c3739801SMiguel Ojeda             where
1111*c3739801SMiguel Ojeda                 Aliasing: crate::invariant::Aliasing,
1112*c3739801SMiguel Ojeda                 Alignment: crate::invariant::Alignment,
1113*c3739801SMiguel Ojeda             {
1114*c3739801SMiguel Ojeda                 #[inline]
1115*c3739801SMiguel Ojeda                 fn only_derive_is_allowed_to_implement_this_trait()
1116*c3739801SMiguel Ojeda                 where
1117*c3739801SMiguel Ojeda                     Self: Sized
1118*c3739801SMiguel Ojeda                 {}
1119*c3739801SMiguel Ojeda 
1120*c3739801SMiguel Ojeda                 // SAFETY: Tuples are product types whose fields are
1121*c3739801SMiguel Ojeda                 // well-aligned, so projection preserves both the alignment and
1122*c3739801SMiguel Ojeda                 // validity invariants of the outer pointer.
1123*c3739801SMiguel Ojeda                 type Invariants = (Aliasing, Alignment, crate::invariant::Uninit);
1124*c3739801SMiguel Ojeda 
1125*c3739801SMiguel Ojeda                 // SAFETY: Tuples are product types and so projection is infallible;
1126*c3739801SMiguel Ojeda                 type Error = core::convert::Infallible;
1127*c3739801SMiguel Ojeda             }
1128*c3739801SMiguel Ojeda 
1129*c3739801SMiguel Ojeda             // SAFETY: See comments on items.
1130*c3739801SMiguel Ojeda             unsafe impl<Aliasing, Alignment, $($AllT),+> crate::ProjectField<
1131*c3739801SMiguel Ojeda                 (),
1132*c3739801SMiguel Ojeda                 (Aliasing, Alignment, crate::invariant::Initialized),
1133*c3739801SMiguel Ojeda                 { crate::STRUCT_VARIANT_ID },
1134*c3739801SMiguel Ojeda                 { crate::ident_id!($CurrI)}
1135*c3739801SMiguel Ojeda             > for ($($AllT,)+)
1136*c3739801SMiguel Ojeda             where
1137*c3739801SMiguel Ojeda                 Aliasing: crate::invariant::Aliasing,
1138*c3739801SMiguel Ojeda                 Alignment: crate::invariant::Alignment,
1139*c3739801SMiguel Ojeda             {
1140*c3739801SMiguel Ojeda                 #[inline]
1141*c3739801SMiguel Ojeda                 fn only_derive_is_allowed_to_implement_this_trait()
1142*c3739801SMiguel Ojeda                 where
1143*c3739801SMiguel Ojeda                     Self: Sized
1144*c3739801SMiguel Ojeda                 {}
1145*c3739801SMiguel Ojeda 
1146*c3739801SMiguel Ojeda                 // SAFETY: Tuples are product types whose fields are
1147*c3739801SMiguel Ojeda                 // well-aligned, so projection preserves both the alignment and
1148*c3739801SMiguel Ojeda                 // validity invariants of the outer pointer.
1149*c3739801SMiguel Ojeda                 type Invariants = (Aliasing, Alignment, crate::invariant::Initialized);
1150*c3739801SMiguel Ojeda 
1151*c3739801SMiguel Ojeda                 // SAFETY: Tuples are product types and so projection is infallible;
1152*c3739801SMiguel Ojeda                 type Error = core::convert::Infallible;
1153*c3739801SMiguel Ojeda             }
1154*c3739801SMiguel Ojeda 
1155*c3739801SMiguel Ojeda             // SAFETY: See comments on items.
1156*c3739801SMiguel Ojeda             unsafe impl<Aliasing, Alignment, $($AllT),+> crate::ProjectField<
1157*c3739801SMiguel Ojeda                 (),
1158*c3739801SMiguel Ojeda                 (Aliasing, Alignment, crate::invariant::Valid),
1159*c3739801SMiguel Ojeda                 { crate::STRUCT_VARIANT_ID },
1160*c3739801SMiguel Ojeda                 { crate::ident_id!($CurrI)}
1161*c3739801SMiguel Ojeda             > for ($($AllT,)+)
1162*c3739801SMiguel Ojeda             where
1163*c3739801SMiguel Ojeda                 Aliasing: crate::invariant::Aliasing,
1164*c3739801SMiguel Ojeda                 Alignment: crate::invariant::Alignment,
1165*c3739801SMiguel Ojeda             {
1166*c3739801SMiguel Ojeda                 #[inline]
1167*c3739801SMiguel Ojeda                 fn only_derive_is_allowed_to_implement_this_trait()
1168*c3739801SMiguel Ojeda                 where
1169*c3739801SMiguel Ojeda                     Self: Sized
1170*c3739801SMiguel Ojeda                 {}
1171*c3739801SMiguel Ojeda 
1172*c3739801SMiguel Ojeda                 // SAFETY: Tuples are product types whose fields are
1173*c3739801SMiguel Ojeda                 // well-aligned, so projection preserves both the alignment and
1174*c3739801SMiguel Ojeda                 // validity invariants of the outer pointer.
1175*c3739801SMiguel Ojeda                 type Invariants = (Aliasing, Alignment, crate::invariant::Valid);
1176*c3739801SMiguel Ojeda 
1177*c3739801SMiguel Ojeda                 // SAFETY: Tuples are product types and so projection is infallible;
1178*c3739801SMiguel Ojeda                 type Error = core::convert::Infallible;
1179*c3739801SMiguel Ojeda             }
1180*c3739801SMiguel Ojeda 
1181*c3739801SMiguel Ojeda             // Recurse to the next index.
1182*c3739801SMiguel Ojeda             impl_tuple!(@variants [$($AllT $AllI)+] [$($BeforeT)* $CurrT] [$($AfterT $AfterI)*]);
1183*c3739801SMiguel Ojeda         };
1184*c3739801SMiguel Ojeda         (@variants [$($AllT:ident $AllI:tt)+] [$($BeforeT:ident)*] []) => {};
1185*c3739801SMiguel Ojeda     }
1186*c3739801SMiguel Ojeda 
1187*c3739801SMiguel Ojeda     // SAFETY: `impl_tuple` is provided name-number pairs, where number is the
1188*c3739801SMiguel Ojeda     // ordinal of the name.
1189*c3739801SMiguel Ojeda     #[allow(clippy::multiple_unsafe_ops_per_block)]
1190*c3739801SMiguel Ojeda     const _: () = unsafe {
1191*c3739801SMiguel Ojeda         impl_tuple! {
1192*c3739801SMiguel Ojeda             A 0,
1193*c3739801SMiguel Ojeda             B 1,
1194*c3739801SMiguel Ojeda             C 2,
1195*c3739801SMiguel Ojeda             D 3,
1196*c3739801SMiguel Ojeda             E 4,
1197*c3739801SMiguel Ojeda             F 5,
1198*c3739801SMiguel Ojeda             G 6,
1199*c3739801SMiguel Ojeda             H 7,
1200*c3739801SMiguel Ojeda             I 8,
1201*c3739801SMiguel Ojeda             J 9,
1202*c3739801SMiguel Ojeda             K 10,
1203*c3739801SMiguel Ojeda             L 11,
1204*c3739801SMiguel Ojeda             M 12,
1205*c3739801SMiguel Ojeda             N 13,
1206*c3739801SMiguel Ojeda             O 14,
1207*c3739801SMiguel Ojeda             P 15,
1208*c3739801SMiguel Ojeda             Q 16,
1209*c3739801SMiguel Ojeda             R 17,
1210*c3739801SMiguel Ojeda             S 18,
1211*c3739801SMiguel Ojeda             T 19,
1212*c3739801SMiguel Ojeda             U 20,
1213*c3739801SMiguel Ojeda             V 21,
1214*c3739801SMiguel Ojeda             W 22,
1215*c3739801SMiguel Ojeda             X 23,
1216*c3739801SMiguel Ojeda             Y 24,
1217*c3739801SMiguel Ojeda             Z 25,
1218*c3739801SMiguel Ojeda         };
1219*c3739801SMiguel Ojeda     };
1220*c3739801SMiguel Ojeda }
1221*c3739801SMiguel Ojeda 
1222*c3739801SMiguel Ojeda // SIMD support
1223*c3739801SMiguel Ojeda //
1224*c3739801SMiguel Ojeda // Per the Unsafe Code Guidelines Reference [1]:
1225*c3739801SMiguel Ojeda //
1226*c3739801SMiguel Ojeda //   Packed SIMD vector types are `repr(simd)` homogeneous tuple-structs
1227*c3739801SMiguel Ojeda //   containing `N` elements of type `T` where `N` is a power-of-two and the
1228*c3739801SMiguel Ojeda //   size and alignment requirements of `T` are equal:
1229*c3739801SMiguel Ojeda //
1230*c3739801SMiguel Ojeda //   ```rust
1231*c3739801SMiguel Ojeda //   #[repr(simd)]
1232*c3739801SMiguel Ojeda //   struct Vector<T, N>(T_0, ..., T_(N - 1));
1233*c3739801SMiguel Ojeda //   ```
1234*c3739801SMiguel Ojeda //
1235*c3739801SMiguel Ojeda //   ...
1236*c3739801SMiguel Ojeda //
1237*c3739801SMiguel Ojeda //   The size of `Vector` is `N * size_of::<T>()` and its alignment is an
1238*c3739801SMiguel Ojeda //   implementation-defined function of `T` and `N` greater than or equal to
1239*c3739801SMiguel Ojeda //   `align_of::<T>()`.
1240*c3739801SMiguel Ojeda //
1241*c3739801SMiguel Ojeda //   ...
1242*c3739801SMiguel Ojeda //
1243*c3739801SMiguel Ojeda //   Vector elements are laid out in source field order, enabling random access
1244*c3739801SMiguel Ojeda //   to vector elements by reinterpreting the vector as an array:
1245*c3739801SMiguel Ojeda //
1246*c3739801SMiguel Ojeda //   ```rust
1247*c3739801SMiguel Ojeda //   union U {
1248*c3739801SMiguel Ojeda //      vec: Vector<T, N>,
1249*c3739801SMiguel Ojeda //      arr: [T; N]
1250*c3739801SMiguel Ojeda //   }
1251*c3739801SMiguel Ojeda //
1252*c3739801SMiguel Ojeda //   assert_eq!(size_of::<Vector<T, N>>(), size_of::<[T; N]>());
1253*c3739801SMiguel Ojeda //   assert!(align_of::<Vector<T, N>>() >= align_of::<[T; N]>());
1254*c3739801SMiguel Ojeda //
1255*c3739801SMiguel Ojeda //   unsafe {
1256*c3739801SMiguel Ojeda //     let u = U { vec: Vector<T, N>(t_0, ..., t_(N - 1)) };
1257*c3739801SMiguel Ojeda //
1258*c3739801SMiguel Ojeda //     assert_eq!(u.vec.0, u.arr[0]);
1259*c3739801SMiguel Ojeda //     // ...
1260*c3739801SMiguel Ojeda //     assert_eq!(u.vec.(N - 1), u.arr[N - 1]);
1261*c3739801SMiguel Ojeda //   }
1262*c3739801SMiguel Ojeda //   ```
1263*c3739801SMiguel Ojeda //
1264*c3739801SMiguel Ojeda // Given this background, we can observe that:
1265*c3739801SMiguel Ojeda // - The size and bit pattern requirements of a SIMD type are equivalent to the
1266*c3739801SMiguel Ojeda //   equivalent array type. Thus, for any SIMD type whose primitive `T` is
1267*c3739801SMiguel Ojeda //   `Immutable`, `TryFromBytes`, `FromZeros`, `FromBytes`, or `IntoBytes`, that
1268*c3739801SMiguel Ojeda //   SIMD type is also `Immutable`, `TryFromBytes`, `FromZeros`, `FromBytes`, or
1269*c3739801SMiguel Ojeda //   `IntoBytes` respectively.
1270*c3739801SMiguel Ojeda // - Since no upper bound is placed on the alignment, no SIMD type can be
1271*c3739801SMiguel Ojeda //   guaranteed to be `Unaligned`.
1272*c3739801SMiguel Ojeda //
1273*c3739801SMiguel Ojeda // Also per [1]:
1274*c3739801SMiguel Ojeda //
1275*c3739801SMiguel Ojeda //   This chapter represents the consensus from issue #38. The statements in
1276*c3739801SMiguel Ojeda //   here are not (yet) "guaranteed" not to change until an RFC ratifies them.
1277*c3739801SMiguel Ojeda //
1278*c3739801SMiguel Ojeda // See issue #38 [2]. While this behavior is not technically guaranteed, the
1279*c3739801SMiguel Ojeda // likelihood that the behavior will change such that SIMD types are no longer
1280*c3739801SMiguel Ojeda // `TryFromBytes`, `FromZeros`, `FromBytes`, or `IntoBytes` is next to zero, as
1281*c3739801SMiguel Ojeda // that would defeat the entire purpose of SIMD types. Nonetheless, we put this
1282*c3739801SMiguel Ojeda // behavior behind the `simd` Cargo feature, which requires consumers to opt
1283*c3739801SMiguel Ojeda // into this stability hazard.
1284*c3739801SMiguel Ojeda //
1285*c3739801SMiguel Ojeda // [1] https://rust-lang.github.io/unsafe-code-guidelines/layout/packed-simd-vectors.html
1286*c3739801SMiguel Ojeda // [2] https://github.com/rust-lang/unsafe-code-guidelines/issues/38
1287*c3739801SMiguel Ojeda #[cfg(feature = "simd")]
1288*c3739801SMiguel Ojeda #[cfg_attr(doc_cfg, doc(cfg(feature = "simd")))]
1289*c3739801SMiguel Ojeda mod simd {
1290*c3739801SMiguel Ojeda     /// Defines a module which implements `TryFromBytes`, `FromZeros`,
1291*c3739801SMiguel Ojeda     /// `FromBytes`, and `IntoBytes` for a set of types from a module in
1292*c3739801SMiguel Ojeda     /// `core::arch`.
1293*c3739801SMiguel Ojeda     ///
1294*c3739801SMiguel Ojeda     /// `$arch` is both the name of the defined module and the name of the
1295*c3739801SMiguel Ojeda     /// module in `core::arch`, and `$typ` is the list of items from that module
1296*c3739801SMiguel Ojeda     /// to implement `FromZeros`, `FromBytes`, and `IntoBytes` for.
1297*c3739801SMiguel Ojeda     #[allow(unused_macros)] // `allow(unused_macros)` is needed because some
1298*c3739801SMiguel Ojeda                             // target/feature combinations don't emit any impls
1299*c3739801SMiguel Ojeda                             // and thus don't use this macro.
1300*c3739801SMiguel Ojeda     macro_rules! simd_arch_mod {
1301*c3739801SMiguel Ojeda         ($(#[cfg $cfg:tt])* $(#[cfg_attr $cfg_attr:tt])? $arch:ident, $mod:ident, $($typ:ident),*) => {
1302*c3739801SMiguel Ojeda             $(#[cfg $cfg])*
1303*c3739801SMiguel Ojeda             #[cfg_attr(doc_cfg, doc(cfg $($cfg)*))]
1304*c3739801SMiguel Ojeda             $(#[cfg_attr $cfg_attr])?
1305*c3739801SMiguel Ojeda             mod $mod {
1306*c3739801SMiguel Ojeda                 use core::arch::$arch::{$($typ),*};
1307*c3739801SMiguel Ojeda 
1308*c3739801SMiguel Ojeda                 use crate::*;
1309*c3739801SMiguel Ojeda                 impl_known_layout!($($typ),*);
1310*c3739801SMiguel Ojeda                 // SAFETY: See comment on module definition for justification.
1311*c3739801SMiguel Ojeda                 #[allow(clippy::multiple_unsafe_ops_per_block)]
1312*c3739801SMiguel Ojeda                 const _: () = unsafe {
1313*c3739801SMiguel Ojeda                     $( unsafe_impl!($typ: Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes); )*
1314*c3739801SMiguel Ojeda                 };
1315*c3739801SMiguel Ojeda             }
1316*c3739801SMiguel Ojeda         };
1317*c3739801SMiguel Ojeda     }
1318*c3739801SMiguel Ojeda 
1319*c3739801SMiguel Ojeda     #[rustfmt::skip]
1320*c3739801SMiguel Ojeda     const _: () = {
1321*c3739801SMiguel Ojeda         simd_arch_mod!(
1322*c3739801SMiguel Ojeda             #[cfg(target_arch = "x86")]
1323*c3739801SMiguel Ojeda             x86, x86, __m128, __m128d, __m128i, __m256, __m256d, __m256i
1324*c3739801SMiguel Ojeda         );
1325*c3739801SMiguel Ojeda         #[cfg(not(no_zerocopy_simd_x86_avx12_1_89_0))]
1326*c3739801SMiguel Ojeda         simd_arch_mod!(
1327*c3739801SMiguel Ojeda             #[cfg(target_arch = "x86")]
1328*c3739801SMiguel Ojeda             #[cfg_attr(doc_cfg, doc(cfg(rust = "1.89.0")))]
1329*c3739801SMiguel Ojeda             x86, x86_nightly, __m512bh, __m512, __m512d, __m512i
1330*c3739801SMiguel Ojeda         );
1331*c3739801SMiguel Ojeda         simd_arch_mod!(
1332*c3739801SMiguel Ojeda             #[cfg(target_arch = "x86_64")]
1333*c3739801SMiguel Ojeda             x86_64, x86_64, __m128, __m128d, __m128i, __m256, __m256d, __m256i
1334*c3739801SMiguel Ojeda         );
1335*c3739801SMiguel Ojeda         #[cfg(not(no_zerocopy_simd_x86_avx12_1_89_0))]
1336*c3739801SMiguel Ojeda         simd_arch_mod!(
1337*c3739801SMiguel Ojeda             #[cfg(target_arch = "x86_64")]
1338*c3739801SMiguel Ojeda             #[cfg_attr(doc_cfg, doc(cfg(rust = "1.89.0")))]
1339*c3739801SMiguel Ojeda             x86_64, x86_64_nightly, __m512bh, __m512, __m512d, __m512i
1340*c3739801SMiguel Ojeda         );
1341*c3739801SMiguel Ojeda         simd_arch_mod!(
1342*c3739801SMiguel Ojeda             #[cfg(target_arch = "wasm32")]
1343*c3739801SMiguel Ojeda             wasm32, wasm32, v128
1344*c3739801SMiguel Ojeda         );
1345*c3739801SMiguel Ojeda         simd_arch_mod!(
1346*c3739801SMiguel Ojeda             #[cfg(all(feature = "simd-nightly", target_arch = "powerpc"))]
1347*c3739801SMiguel Ojeda             powerpc, powerpc, vector_bool_long, vector_double, vector_signed_long, vector_unsigned_long
1348*c3739801SMiguel Ojeda         );
1349*c3739801SMiguel Ojeda         simd_arch_mod!(
1350*c3739801SMiguel Ojeda             #[cfg(all(feature = "simd-nightly", target_arch = "powerpc64"))]
1351*c3739801SMiguel Ojeda             powerpc64, powerpc64, vector_bool_long, vector_double, vector_signed_long, vector_unsigned_long
1352*c3739801SMiguel Ojeda         );
1353*c3739801SMiguel Ojeda         // NOTE: NEON intrinsics were broken on big-endian platforms from their stabilization up to
1354*c3739801SMiguel Ojeda         // Rust 1.87. (Context in https://github.com/rust-lang/stdarch/issues/1484). Support is
1355*c3739801SMiguel Ojeda         // split in two different version ranges on top of the base configuration, requiring either
1356*c3739801SMiguel Ojeda         // little endian or the more recent version to be detected as well.
1357*c3739801SMiguel Ojeda         #[cfg(not(no_zerocopy_aarch64_simd_1_59_0))]
1358*c3739801SMiguel Ojeda         simd_arch_mod!(
1359*c3739801SMiguel Ojeda             #[cfg(all(
1360*c3739801SMiguel Ojeda                 target_arch = "aarch64",
1361*c3739801SMiguel Ojeda                 any(
1362*c3739801SMiguel Ojeda                     target_endian = "little",
1363*c3739801SMiguel Ojeda                     not(no_zerocopy_aarch64_simd_be_1_87_0)
1364*c3739801SMiguel Ojeda                 )
1365*c3739801SMiguel Ojeda             ))]
1366*c3739801SMiguel Ojeda             #[cfg_attr(
1367*c3739801SMiguel Ojeda                 doc_cfg,
1368*c3739801SMiguel Ojeda                 doc(cfg(all(target_arch = "aarch64", any(
1369*c3739801SMiguel Ojeda                     all(rust = "1.59.0", target_endian = "little"),
1370*c3739801SMiguel Ojeda                     rust = "1.87.0",
1371*c3739801SMiguel Ojeda                 ))))
1372*c3739801SMiguel Ojeda             )]
1373*c3739801SMiguel Ojeda             aarch64, aarch64, float32x2_t, float32x4_t, float64x1_t, float64x2_t, int8x8_t, int8x8x2_t,
1374*c3739801SMiguel Ojeda             int8x8x3_t, int8x8x4_t, int8x16_t, int8x16x2_t, int8x16x3_t, int8x16x4_t, int16x4_t,
1375*c3739801SMiguel Ojeda             int16x8_t, int32x2_t, int32x4_t, int64x1_t, int64x2_t, poly8x8_t, poly8x8x2_t, poly8x8x3_t,
1376*c3739801SMiguel Ojeda             poly8x8x4_t, poly8x16_t, poly8x16x2_t, poly8x16x3_t, poly8x16x4_t, poly16x4_t, poly16x8_t,
1377*c3739801SMiguel Ojeda             poly64x1_t, poly64x2_t, uint8x8_t, uint8x8x2_t, uint8x8x3_t, uint8x8x4_t, uint8x16_t,
1378*c3739801SMiguel Ojeda             uint8x16x2_t, uint8x16x3_t, uint8x16x4_t, uint16x4_t, uint16x4x2_t, uint16x4x3_t,
1379*c3739801SMiguel Ojeda             uint16x4x4_t, uint16x8_t, uint32x2_t, uint32x4_t, uint64x1_t, uint64x2_t
1380*c3739801SMiguel Ojeda         );
1381*c3739801SMiguel Ojeda     };
1382*c3739801SMiguel Ojeda }
1383*c3739801SMiguel Ojeda 
1384*c3739801SMiguel Ojeda #[cfg(test)]
1385*c3739801SMiguel Ojeda mod tests {
1386*c3739801SMiguel Ojeda     use super::*;
1387*c3739801SMiguel Ojeda 
1388*c3739801SMiguel Ojeda     #[test]
1389*c3739801SMiguel Ojeda     fn test_impls() {
1390*c3739801SMiguel Ojeda         // A type that can supply test cases for testing
1391*c3739801SMiguel Ojeda         // `TryFromBytes::is_bit_valid`. All types passed to `assert_impls!`
1392*c3739801SMiguel Ojeda         // must implement this trait; that macro uses it to generate runtime
1393*c3739801SMiguel Ojeda         // tests for `TryFromBytes` impls.
1394*c3739801SMiguel Ojeda         //
1395*c3739801SMiguel Ojeda         // All `T: FromBytes` types are provided with a blanket impl. Other
1396*c3739801SMiguel Ojeda         // types must implement `TryFromBytesTestable` directly (ie using
1397*c3739801SMiguel Ojeda         // `impl_try_from_bytes_testable!`).
1398*c3739801SMiguel Ojeda         trait TryFromBytesTestable {
1399*c3739801SMiguel Ojeda             fn with_passing_test_cases<F: Fn(Box<ReadOnly<Self>>)>(f: F);
1400*c3739801SMiguel Ojeda             fn with_failing_test_cases<F: Fn(&mut [u8])>(f: F);
1401*c3739801SMiguel Ojeda         }
1402*c3739801SMiguel Ojeda 
1403*c3739801SMiguel Ojeda         impl<T: FromBytes> TryFromBytesTestable for T {
1404*c3739801SMiguel Ojeda             fn with_passing_test_cases<F: Fn(Box<ReadOnly<Self>>)>(f: F) {
1405*c3739801SMiguel Ojeda                 // Test with a zeroed value.
1406*c3739801SMiguel Ojeda                 f(ReadOnly::<Self>::new_box_zeroed().unwrap());
1407*c3739801SMiguel Ojeda 
1408*c3739801SMiguel Ojeda                 let ffs = {
1409*c3739801SMiguel Ojeda                     let mut t = ReadOnly::new(Self::new_zeroed());
1410*c3739801SMiguel Ojeda                     let ptr: *mut T = ReadOnly::as_mut(&mut t);
1411*c3739801SMiguel Ojeda                     // SAFETY: `T: FromBytes`
1412*c3739801SMiguel Ojeda                     unsafe { ptr::write_bytes(ptr.cast::<u8>(), 0xFF, mem::size_of::<T>()) };
1413*c3739801SMiguel Ojeda                     t
1414*c3739801SMiguel Ojeda                 };
1415*c3739801SMiguel Ojeda 
1416*c3739801SMiguel Ojeda                 // Test with a value initialized with 0xFF.
1417*c3739801SMiguel Ojeda                 f(Box::new(ffs));
1418*c3739801SMiguel Ojeda             }
1419*c3739801SMiguel Ojeda 
1420*c3739801SMiguel Ojeda             fn with_failing_test_cases<F: Fn(&mut [u8])>(_f: F) {}
1421*c3739801SMiguel Ojeda         }
1422*c3739801SMiguel Ojeda 
1423*c3739801SMiguel Ojeda         macro_rules! impl_try_from_bytes_testable_for_null_pointer_optimization {
1424*c3739801SMiguel Ojeda             ($($tys:ty),*) => {
1425*c3739801SMiguel Ojeda                 $(
1426*c3739801SMiguel Ojeda                     impl TryFromBytesTestable for Option<$tys> {
1427*c3739801SMiguel Ojeda                         fn with_passing_test_cases<F: Fn(Box<ReadOnly<Self>>)>(f: F) {
1428*c3739801SMiguel Ojeda                             // Test with a zeroed value.
1429*c3739801SMiguel Ojeda                             f(Box::new(ReadOnly::new(None)));
1430*c3739801SMiguel Ojeda                         }
1431*c3739801SMiguel Ojeda 
1432*c3739801SMiguel Ojeda                         fn with_failing_test_cases<F: Fn(&mut [u8])>(f: F) {
1433*c3739801SMiguel Ojeda                             for pos in 0..mem::size_of::<Self>() {
1434*c3739801SMiguel Ojeda                                 let mut bytes = [0u8; mem::size_of::<Self>()];
1435*c3739801SMiguel Ojeda                                 bytes[pos] = 0x01;
1436*c3739801SMiguel Ojeda                                 f(&mut bytes[..]);
1437*c3739801SMiguel Ojeda                             }
1438*c3739801SMiguel Ojeda                         }
1439*c3739801SMiguel Ojeda                     }
1440*c3739801SMiguel Ojeda                 )*
1441*c3739801SMiguel Ojeda             };
1442*c3739801SMiguel Ojeda         }
1443*c3739801SMiguel Ojeda 
1444*c3739801SMiguel Ojeda         // Implements `TryFromBytesTestable`.
1445*c3739801SMiguel Ojeda         macro_rules! impl_try_from_bytes_testable {
1446*c3739801SMiguel Ojeda             // Base case for recursion (when the list of types has run out).
1447*c3739801SMiguel Ojeda             (=> @success $($success_case:expr),* $(, @failure $($failure_case:expr),*)?) => {};
1448*c3739801SMiguel Ojeda             // Implements for type(s) with no type parameters.
1449*c3739801SMiguel Ojeda             ($ty:ty $(,$tys:ty)* => @success $($success_case:expr),* $(, @failure $($failure_case:expr),*)?) => {
1450*c3739801SMiguel Ojeda                 impl TryFromBytesTestable for $ty {
1451*c3739801SMiguel Ojeda                     impl_try_from_bytes_testable!(
1452*c3739801SMiguel Ojeda                         @methods     @success $($success_case),*
1453*c3739801SMiguel Ojeda                                  $(, @failure $($failure_case),*)?
1454*c3739801SMiguel Ojeda                     );
1455*c3739801SMiguel Ojeda                 }
1456*c3739801SMiguel Ojeda                 impl_try_from_bytes_testable!($($tys),* => @success $($success_case),* $(, @failure $($failure_case),*)?);
1457*c3739801SMiguel Ojeda             };
1458*c3739801SMiguel Ojeda             // Implements for multiple types with no type parameters.
1459*c3739801SMiguel Ojeda             ($($($ty:ty),* => @success $($success_case:expr), * $(, @failure $($failure_case:expr),*)?;)*) => {
1460*c3739801SMiguel Ojeda                 $(
1461*c3739801SMiguel Ojeda                     impl_try_from_bytes_testable!($($ty),* => @success $($success_case),* $(, @failure $($failure_case),*)*);
1462*c3739801SMiguel Ojeda                 )*
1463*c3739801SMiguel Ojeda             };
1464*c3739801SMiguel Ojeda             // Implements only the methods; caller must invoke this from inside
1465*c3739801SMiguel Ojeda             // an impl block.
1466*c3739801SMiguel Ojeda             (@methods @success $($success_case:expr),* $(, @failure $($failure_case:expr),*)?) => {
1467*c3739801SMiguel Ojeda                 fn with_passing_test_cases<F: Fn(Box<ReadOnly<Self>>)>(_f: F) {
1468*c3739801SMiguel Ojeda                     $(
1469*c3739801SMiguel Ojeda                         let bx = Box::<Self>::from($success_case);
1470*c3739801SMiguel Ojeda                         let ro: Box<ReadOnly<_>> = {
1471*c3739801SMiguel Ojeda                             let raw = Box::into_raw(bx);
1472*c3739801SMiguel Ojeda                             // SAFETY: `ReadOnly<T>` has the same layout and bit
1473*c3739801SMiguel Ojeda                             // validity as `T`.
1474*c3739801SMiguel Ojeda                             #[allow(clippy::as_conversions)]
1475*c3739801SMiguel Ojeda                             unsafe { Box::from_raw(raw as *mut _) }
1476*c3739801SMiguel Ojeda                         };
1477*c3739801SMiguel Ojeda                         _f(ro);
1478*c3739801SMiguel Ojeda                     )*
1479*c3739801SMiguel Ojeda                 }
1480*c3739801SMiguel Ojeda 
1481*c3739801SMiguel Ojeda                 fn with_failing_test_cases<F: Fn(&mut [u8])>(_f: F) {
1482*c3739801SMiguel Ojeda                     $($(
1483*c3739801SMiguel Ojeda                         let mut case = $failure_case;
1484*c3739801SMiguel Ojeda                         _f(case.as_mut_bytes());
1485*c3739801SMiguel Ojeda                     )*)?
1486*c3739801SMiguel Ojeda                 }
1487*c3739801SMiguel Ojeda             };
1488*c3739801SMiguel Ojeda         }
1489*c3739801SMiguel Ojeda 
1490*c3739801SMiguel Ojeda         impl_try_from_bytes_testable_for_null_pointer_optimization!(
1491*c3739801SMiguel Ojeda             Box<UnsafeCell<NotZerocopy>>,
1492*c3739801SMiguel Ojeda             &'static UnsafeCell<NotZerocopy>,
1493*c3739801SMiguel Ojeda             &'static mut UnsafeCell<NotZerocopy>,
1494*c3739801SMiguel Ojeda             NonNull<UnsafeCell<NotZerocopy>>,
1495*c3739801SMiguel Ojeda             fn(),
1496*c3739801SMiguel Ojeda             FnManyArgs,
1497*c3739801SMiguel Ojeda             extern "C" fn(),
1498*c3739801SMiguel Ojeda             ECFnManyArgs
1499*c3739801SMiguel Ojeda         );
1500*c3739801SMiguel Ojeda 
1501*c3739801SMiguel Ojeda         macro_rules! bx {
1502*c3739801SMiguel Ojeda             ($e:expr) => {
1503*c3739801SMiguel Ojeda                 Box::new($e)
1504*c3739801SMiguel Ojeda             };
1505*c3739801SMiguel Ojeda         }
1506*c3739801SMiguel Ojeda 
1507*c3739801SMiguel Ojeda         // Note that these impls are only for types which are not `FromBytes`.
1508*c3739801SMiguel Ojeda         // `FromBytes` types are covered by a preceding blanket impl.
1509*c3739801SMiguel Ojeda         impl_try_from_bytes_testable!(
1510*c3739801SMiguel Ojeda             bool => @success true, false,
1511*c3739801SMiguel Ojeda                     @failure 2u8, 3u8, 0xFFu8;
1512*c3739801SMiguel Ojeda             char => @success '\u{0}', '\u{D7FF}', '\u{E000}', '\u{10FFFF}',
1513*c3739801SMiguel Ojeda                     @failure 0xD800u32, 0xDFFFu32, 0x110000u32;
1514*c3739801SMiguel Ojeda             str  => @success "", "hello", "❤️����������",
1515*c3739801SMiguel Ojeda                     @failure [0, 159, 146, 150];
1516*c3739801SMiguel Ojeda             [u8] => @success vec![].into_boxed_slice(), vec![0, 1, 2].into_boxed_slice();
1517*c3739801SMiguel Ojeda             NonZeroU8, NonZeroI8, NonZeroU16, NonZeroI16, NonZeroU32,
1518*c3739801SMiguel Ojeda             NonZeroI32, NonZeroU64, NonZeroI64, NonZeroU128, NonZeroI128,
1519*c3739801SMiguel Ojeda             NonZeroUsize, NonZeroIsize
1520*c3739801SMiguel Ojeda                 => @success Self::new(1).unwrap(),
1521*c3739801SMiguel Ojeda                    // Doing this instead of `0` ensures that we always satisfy
1522*c3739801SMiguel Ojeda                    // the size and alignment requirements of `Self` (whereas `0`
1523*c3739801SMiguel Ojeda                    // may be any integer type with a different size or alignment
1524*c3739801SMiguel Ojeda                    // than some `NonZeroXxx` types).
1525*c3739801SMiguel Ojeda                    @failure Option::<Self>::None;
1526*c3739801SMiguel Ojeda             [bool; 0] => @success [];
1527*c3739801SMiguel Ojeda             [bool; 1]
1528*c3739801SMiguel Ojeda                 => @success [true], [false],
1529*c3739801SMiguel Ojeda                    @failure [2u8], [3u8], [0xFFu8];
1530*c3739801SMiguel Ojeda             [bool]
1531*c3739801SMiguel Ojeda                 => @success vec![true, false].into_boxed_slice(), vec![false, true].into_boxed_slice(),
1532*c3739801SMiguel Ojeda                     @failure [2u8], [3u8], [0xFFu8], [0u8, 1u8, 2u8];
1533*c3739801SMiguel Ojeda             Unalign<bool>
1534*c3739801SMiguel Ojeda                 => @success Unalign::new(false), Unalign::new(true),
1535*c3739801SMiguel Ojeda                    @failure 2u8, 0xFFu8;
1536*c3739801SMiguel Ojeda             ManuallyDrop<bool>
1537*c3739801SMiguel Ojeda                 => @success ManuallyDrop::new(false), ManuallyDrop::new(true),
1538*c3739801SMiguel Ojeda                    @failure 2u8, 0xFFu8;
1539*c3739801SMiguel Ojeda             ManuallyDrop<[u8]>
1540*c3739801SMiguel Ojeda                 => @success bx!(ManuallyDrop::new([])), bx!(ManuallyDrop::new([0u8])), bx!(ManuallyDrop::new([0u8, 1u8]));
1541*c3739801SMiguel Ojeda             ManuallyDrop<[bool]>
1542*c3739801SMiguel Ojeda                 => @success bx!(ManuallyDrop::new([])), bx!(ManuallyDrop::new([false])), bx!(ManuallyDrop::new([false, true])),
1543*c3739801SMiguel Ojeda                    @failure [2u8], [3u8], [0xFFu8], [0u8, 1u8, 2u8];
1544*c3739801SMiguel Ojeda             ManuallyDrop<[UnsafeCell<u8>]>
1545*c3739801SMiguel Ojeda                 => @success bx!(ManuallyDrop::new([UnsafeCell::new(0)])), bx!(ManuallyDrop::new([UnsafeCell::new(0), UnsafeCell::new(1)]));
1546*c3739801SMiguel Ojeda             ManuallyDrop<[UnsafeCell<bool>]>
1547*c3739801SMiguel Ojeda                 => @success bx!(ManuallyDrop::new([UnsafeCell::new(false)])), bx!(ManuallyDrop::new([UnsafeCell::new(false), UnsafeCell::new(true)])),
1548*c3739801SMiguel Ojeda                 @failure [2u8], [3u8], [0xFFu8], [0u8, 1u8, 2u8];
1549*c3739801SMiguel Ojeda             Wrapping<bool>
1550*c3739801SMiguel Ojeda                 => @success Wrapping(false), Wrapping(true),
1551*c3739801SMiguel Ojeda                     @failure 2u8, 0xFFu8;
1552*c3739801SMiguel Ojeda             *const NotZerocopy
1553*c3739801SMiguel Ojeda                 => @success ptr::null::<NotZerocopy>(),
1554*c3739801SMiguel Ojeda                    @failure [0x01; mem::size_of::<*const NotZerocopy>()];
1555*c3739801SMiguel Ojeda             *mut NotZerocopy
1556*c3739801SMiguel Ojeda                 => @success ptr::null_mut::<NotZerocopy>(),
1557*c3739801SMiguel Ojeda                    @failure [0x01; mem::size_of::<*mut NotZerocopy>()];
1558*c3739801SMiguel Ojeda         );
1559*c3739801SMiguel Ojeda 
1560*c3739801SMiguel Ojeda         // Use the trick described in [1] to allow us to call methods
1561*c3739801SMiguel Ojeda         // conditional on certain trait bounds.
1562*c3739801SMiguel Ojeda         //
1563*c3739801SMiguel Ojeda         // In all of these cases, methods return `Option<R>`, where `R` is the
1564*c3739801SMiguel Ojeda         // return type of the method we're conditionally calling. The "real"
1565*c3739801SMiguel Ojeda         // implementations (the ones defined in traits using `&self`) return
1566*c3739801SMiguel Ojeda         // `Some`, and the default implementations (the ones defined as inherent
1567*c3739801SMiguel Ojeda         // methods using `&mut self`) return `None`.
1568*c3739801SMiguel Ojeda         //
1569*c3739801SMiguel Ojeda         // [1] https://github.com/dtolnay/case-studies/blob/master/autoref-specialization/README.md
1570*c3739801SMiguel Ojeda         mod autoref_trick {
1571*c3739801SMiguel Ojeda             use super::*;
1572*c3739801SMiguel Ojeda 
1573*c3739801SMiguel Ojeda             pub(super) struct AutorefWrapper<T: ?Sized>(pub(super) PhantomData<T>);
1574*c3739801SMiguel Ojeda 
1575*c3739801SMiguel Ojeda             pub(super) trait TestIsBitValidShared<T: ?Sized> {
1576*c3739801SMiguel Ojeda                 #[allow(clippy::needless_lifetimes)]
1577*c3739801SMiguel Ojeda                 fn test_is_bit_valid_shared<'ptr>(&self, candidate: Maybe<'ptr, T>)
1578*c3739801SMiguel Ojeda                     -> Option<bool>;
1579*c3739801SMiguel Ojeda             }
1580*c3739801SMiguel Ojeda 
1581*c3739801SMiguel Ojeda             impl<T: TryFromBytes + Immutable + ?Sized> TestIsBitValidShared<T> for AutorefWrapper<T> {
1582*c3739801SMiguel Ojeda                 #[allow(clippy::needless_lifetimes)]
1583*c3739801SMiguel Ojeda                 fn test_is_bit_valid_shared<'ptr>(
1584*c3739801SMiguel Ojeda                     &self,
1585*c3739801SMiguel Ojeda                     candidate: Maybe<'ptr, T>,
1586*c3739801SMiguel Ojeda                 ) -> Option<bool> {
1587*c3739801SMiguel Ojeda                     Some(T::is_bit_valid(candidate))
1588*c3739801SMiguel Ojeda                 }
1589*c3739801SMiguel Ojeda             }
1590*c3739801SMiguel Ojeda 
1591*c3739801SMiguel Ojeda             pub(super) trait TestTryFromRef<T: ?Sized> {
1592*c3739801SMiguel Ojeda                 #[allow(clippy::needless_lifetimes)]
1593*c3739801SMiguel Ojeda                 fn test_try_from_ref<'bytes>(
1594*c3739801SMiguel Ojeda                     &self,
1595*c3739801SMiguel Ojeda                     bytes: &'bytes [u8],
1596*c3739801SMiguel Ojeda                 ) -> Option<Option<&'bytes T>>;
1597*c3739801SMiguel Ojeda             }
1598*c3739801SMiguel Ojeda 
1599*c3739801SMiguel Ojeda             impl<T: TryFromBytes + Immutable + KnownLayout + ?Sized> TestTryFromRef<T> for AutorefWrapper<T> {
1600*c3739801SMiguel Ojeda                 #[allow(clippy::needless_lifetimes)]
1601*c3739801SMiguel Ojeda                 fn test_try_from_ref<'bytes>(
1602*c3739801SMiguel Ojeda                     &self,
1603*c3739801SMiguel Ojeda                     bytes: &'bytes [u8],
1604*c3739801SMiguel Ojeda                 ) -> Option<Option<&'bytes T>> {
1605*c3739801SMiguel Ojeda                     Some(T::try_ref_from_bytes(bytes).ok())
1606*c3739801SMiguel Ojeda                 }
1607*c3739801SMiguel Ojeda             }
1608*c3739801SMiguel Ojeda 
1609*c3739801SMiguel Ojeda             pub(super) trait TestTryFromMut<T: ?Sized> {
1610*c3739801SMiguel Ojeda                 #[allow(clippy::needless_lifetimes)]
1611*c3739801SMiguel Ojeda                 fn test_try_from_mut<'bytes>(
1612*c3739801SMiguel Ojeda                     &self,
1613*c3739801SMiguel Ojeda                     bytes: &'bytes mut [u8],
1614*c3739801SMiguel Ojeda                 ) -> Option<Option<&'bytes mut T>>;
1615*c3739801SMiguel Ojeda             }
1616*c3739801SMiguel Ojeda 
1617*c3739801SMiguel Ojeda             impl<T: TryFromBytes + IntoBytes + KnownLayout + ?Sized> TestTryFromMut<T> for AutorefWrapper<T> {
1618*c3739801SMiguel Ojeda                 #[allow(clippy::needless_lifetimes)]
1619*c3739801SMiguel Ojeda                 fn test_try_from_mut<'bytes>(
1620*c3739801SMiguel Ojeda                     &self,
1621*c3739801SMiguel Ojeda                     bytes: &'bytes mut [u8],
1622*c3739801SMiguel Ojeda                 ) -> Option<Option<&'bytes mut T>> {
1623*c3739801SMiguel Ojeda                     Some(T::try_mut_from_bytes(bytes).ok())
1624*c3739801SMiguel Ojeda                 }
1625*c3739801SMiguel Ojeda             }
1626*c3739801SMiguel Ojeda 
1627*c3739801SMiguel Ojeda             pub(super) trait TestTryReadFrom<T> {
1628*c3739801SMiguel Ojeda                 fn test_try_read_from(&self, bytes: &[u8]) -> Option<Option<T>>;
1629*c3739801SMiguel Ojeda             }
1630*c3739801SMiguel Ojeda 
1631*c3739801SMiguel Ojeda             impl<T: TryFromBytes> TestTryReadFrom<T> for AutorefWrapper<T> {
1632*c3739801SMiguel Ojeda                 fn test_try_read_from(&self, bytes: &[u8]) -> Option<Option<T>> {
1633*c3739801SMiguel Ojeda                     Some(T::try_read_from_bytes(bytes).ok())
1634*c3739801SMiguel Ojeda                 }
1635*c3739801SMiguel Ojeda             }
1636*c3739801SMiguel Ojeda 
1637*c3739801SMiguel Ojeda             pub(super) trait TestAsBytes<T: ?Sized> {
1638*c3739801SMiguel Ojeda                 #[allow(clippy::needless_lifetimes)]
1639*c3739801SMiguel Ojeda                 fn test_as_bytes<'slf, 't>(&'slf self, t: &'t ReadOnly<T>) -> Option<&'t [u8]>;
1640*c3739801SMiguel Ojeda             }
1641*c3739801SMiguel Ojeda 
1642*c3739801SMiguel Ojeda             impl<T: IntoBytes + Immutable + ?Sized> TestAsBytes<T> for AutorefWrapper<T> {
1643*c3739801SMiguel Ojeda                 #[allow(clippy::needless_lifetimes)]
1644*c3739801SMiguel Ojeda                 fn test_as_bytes<'slf, 't>(&'slf self, t: &'t ReadOnly<T>) -> Option<&'t [u8]> {
1645*c3739801SMiguel Ojeda                     Some(t.as_bytes())
1646*c3739801SMiguel Ojeda                 }
1647*c3739801SMiguel Ojeda             }
1648*c3739801SMiguel Ojeda         }
1649*c3739801SMiguel Ojeda 
1650*c3739801SMiguel Ojeda         use autoref_trick::*;
1651*c3739801SMiguel Ojeda 
1652*c3739801SMiguel Ojeda         // Asserts that `$ty` is one of a list of types which are allowed to not
1653*c3739801SMiguel Ojeda         // provide a "real" implementation for `$fn_name`. Since the
1654*c3739801SMiguel Ojeda         // `autoref_trick` machinery fails silently, this allows us to ensure
1655*c3739801SMiguel Ojeda         // that the "default" impls are only being used for types which we
1656*c3739801SMiguel Ojeda         // expect.
1657*c3739801SMiguel Ojeda         //
1658*c3739801SMiguel Ojeda         // Note that, since this is a runtime test, it is possible to have an
1659*c3739801SMiguel Ojeda         // allowlist which is too restrictive if the function in question is
1660*c3739801SMiguel Ojeda         // never called for a particular type. For example, if `as_bytes` is not
1661*c3739801SMiguel Ojeda         // supported for a particular type, and so `test_as_bytes` returns
1662*c3739801SMiguel Ojeda         // `None`, methods such as `test_try_from_ref` may never be called for
1663*c3739801SMiguel Ojeda         // that type. As a result, it's possible that, for example, adding
1664*c3739801SMiguel Ojeda         // `as_bytes` support for a type would cause other allowlist assertions
1665*c3739801SMiguel Ojeda         // to fail. This means that allowlist assertion failures should not
1666*c3739801SMiguel Ojeda         // automatically be taken as a sign of a bug.
1667*c3739801SMiguel Ojeda         macro_rules! assert_on_allowlist {
1668*c3739801SMiguel Ojeda             ($fn_name:ident($ty:ty) $(: $($tys:ty),*)?) => {{
1669*c3739801SMiguel Ojeda                 use core::any::TypeId;
1670*c3739801SMiguel Ojeda 
1671*c3739801SMiguel Ojeda                 let allowlist: &[TypeId] = &[ $($(TypeId::of::<$tys>()),*)? ];
1672*c3739801SMiguel Ojeda                 let allowlist_names: &[&str] = &[ $($(stringify!($tys)),*)? ];
1673*c3739801SMiguel Ojeda 
1674*c3739801SMiguel Ojeda                 let id = TypeId::of::<$ty>();
1675*c3739801SMiguel Ojeda                 assert!(allowlist.contains(&id), "{} is not on allowlist for {}: {:?}", stringify!($ty), stringify!($fn_name), allowlist_names);
1676*c3739801SMiguel Ojeda             }};
1677*c3739801SMiguel Ojeda         }
1678*c3739801SMiguel Ojeda 
1679*c3739801SMiguel Ojeda         // Asserts that `$ty` implements any `$trait` and doesn't implement any
1680*c3739801SMiguel Ojeda         // `!$trait`. Note that all `$trait`s must come before any `!$trait`s.
1681*c3739801SMiguel Ojeda         //
1682*c3739801SMiguel Ojeda         // For `T: TryFromBytes`, uses `TryFromBytesTestable` to test success
1683*c3739801SMiguel Ojeda         // and failure cases.
1684*c3739801SMiguel Ojeda         macro_rules! assert_impls {
1685*c3739801SMiguel Ojeda             ($ty:ty: TryFromBytes) => {
1686*c3739801SMiguel Ojeda                 // "Default" implementations that match the "real"
1687*c3739801SMiguel Ojeda                 // implementations defined in the `autoref_trick` module above.
1688*c3739801SMiguel Ojeda                 #[allow(unused, non_local_definitions)]
1689*c3739801SMiguel Ojeda                 impl AutorefWrapper<$ty> {
1690*c3739801SMiguel Ojeda                     #[allow(clippy::needless_lifetimes)]
1691*c3739801SMiguel Ojeda                     fn test_is_bit_valid_shared<'ptr>(
1692*c3739801SMiguel Ojeda                         &mut self,
1693*c3739801SMiguel Ojeda                         candidate: Maybe<'ptr, $ty>,
1694*c3739801SMiguel Ojeda                     ) -> Option<bool> {
1695*c3739801SMiguel Ojeda                         assert_on_allowlist!(
1696*c3739801SMiguel Ojeda                             test_is_bit_valid_shared($ty):
1697*c3739801SMiguel Ojeda                             ManuallyDrop<UnsafeCell<()>>,
1698*c3739801SMiguel Ojeda                             ManuallyDrop<[UnsafeCell<u8>]>,
1699*c3739801SMiguel Ojeda                             ManuallyDrop<[UnsafeCell<bool>]>,
1700*c3739801SMiguel Ojeda                             CoreMaybeUninit<NotZerocopy>,
1701*c3739801SMiguel Ojeda                             CoreMaybeUninit<UnsafeCell<()>>,
1702*c3739801SMiguel Ojeda                             Wrapping<UnsafeCell<()>>
1703*c3739801SMiguel Ojeda                         );
1704*c3739801SMiguel Ojeda 
1705*c3739801SMiguel Ojeda                         None
1706*c3739801SMiguel Ojeda                     }
1707*c3739801SMiguel Ojeda 
1708*c3739801SMiguel Ojeda                     #[allow(clippy::needless_lifetimes)]
1709*c3739801SMiguel Ojeda                     fn test_try_from_ref<'bytes>(&mut self, _bytes: &'bytes [u8]) -> Option<Option<&'bytes $ty>> {
1710*c3739801SMiguel Ojeda                         assert_on_allowlist!(
1711*c3739801SMiguel Ojeda                             test_try_from_ref($ty):
1712*c3739801SMiguel Ojeda                             ManuallyDrop<[UnsafeCell<bool>]>
1713*c3739801SMiguel Ojeda                         );
1714*c3739801SMiguel Ojeda 
1715*c3739801SMiguel Ojeda                         None
1716*c3739801SMiguel Ojeda                     }
1717*c3739801SMiguel Ojeda 
1718*c3739801SMiguel Ojeda                     #[allow(clippy::needless_lifetimes)]
1719*c3739801SMiguel Ojeda                     fn test_try_from_mut<'bytes>(&mut self, _bytes: &'bytes mut [u8]) -> Option<Option<&'bytes mut $ty>> {
1720*c3739801SMiguel Ojeda                         assert_on_allowlist!(
1721*c3739801SMiguel Ojeda                             test_try_from_mut($ty):
1722*c3739801SMiguel Ojeda                             Option<Box<UnsafeCell<NotZerocopy>>>,
1723*c3739801SMiguel Ojeda                             Option<&'static UnsafeCell<NotZerocopy>>,
1724*c3739801SMiguel Ojeda                             Option<&'static mut UnsafeCell<NotZerocopy>>,
1725*c3739801SMiguel Ojeda                             Option<NonNull<UnsafeCell<NotZerocopy>>>,
1726*c3739801SMiguel Ojeda                             Option<fn()>,
1727*c3739801SMiguel Ojeda                             Option<FnManyArgs>,
1728*c3739801SMiguel Ojeda                             Option<extern "C" fn()>,
1729*c3739801SMiguel Ojeda                             Option<ECFnManyArgs>,
1730*c3739801SMiguel Ojeda                             *const NotZerocopy,
1731*c3739801SMiguel Ojeda                             *mut NotZerocopy
1732*c3739801SMiguel Ojeda                         );
1733*c3739801SMiguel Ojeda 
1734*c3739801SMiguel Ojeda                         None
1735*c3739801SMiguel Ojeda                     }
1736*c3739801SMiguel Ojeda 
1737*c3739801SMiguel Ojeda                     fn test_try_read_from(&mut self, _bytes: &[u8]) -> Option<Option<&$ty>> {
1738*c3739801SMiguel Ojeda                         assert_on_allowlist!(
1739*c3739801SMiguel Ojeda                             test_try_read_from($ty):
1740*c3739801SMiguel Ojeda                             str,
1741*c3739801SMiguel Ojeda                             ManuallyDrop<[u8]>,
1742*c3739801SMiguel Ojeda                             ManuallyDrop<[bool]>,
1743*c3739801SMiguel Ojeda                             ManuallyDrop<[UnsafeCell<bool>]>,
1744*c3739801SMiguel Ojeda                             [u8],
1745*c3739801SMiguel Ojeda                             [bool]
1746*c3739801SMiguel Ojeda                         );
1747*c3739801SMiguel Ojeda 
1748*c3739801SMiguel Ojeda                         None
1749*c3739801SMiguel Ojeda                     }
1750*c3739801SMiguel Ojeda 
1751*c3739801SMiguel Ojeda                     fn test_as_bytes(&mut self, _t: &ReadOnly<$ty>) -> Option<&[u8]> {
1752*c3739801SMiguel Ojeda                         assert_on_allowlist!(
1753*c3739801SMiguel Ojeda                             test_as_bytes($ty):
1754*c3739801SMiguel Ojeda                             Option<&'static UnsafeCell<NotZerocopy>>,
1755*c3739801SMiguel Ojeda                             Option<&'static mut UnsafeCell<NotZerocopy>>,
1756*c3739801SMiguel Ojeda                             Option<NonNull<UnsafeCell<NotZerocopy>>>,
1757*c3739801SMiguel Ojeda                             Option<Box<UnsafeCell<NotZerocopy>>>,
1758*c3739801SMiguel Ojeda                             Option<fn()>,
1759*c3739801SMiguel Ojeda                             Option<FnManyArgs>,
1760*c3739801SMiguel Ojeda                             Option<extern "C" fn()>,
1761*c3739801SMiguel Ojeda                             Option<ECFnManyArgs>,
1762*c3739801SMiguel Ojeda                             CoreMaybeUninit<u8>,
1763*c3739801SMiguel Ojeda                             CoreMaybeUninit<NotZerocopy>,
1764*c3739801SMiguel Ojeda                             CoreMaybeUninit<UnsafeCell<()>>,
1765*c3739801SMiguel Ojeda                             ManuallyDrop<UnsafeCell<()>>,
1766*c3739801SMiguel Ojeda                             ManuallyDrop<[UnsafeCell<u8>]>,
1767*c3739801SMiguel Ojeda                             ManuallyDrop<[UnsafeCell<bool>]>,
1768*c3739801SMiguel Ojeda                             Wrapping<UnsafeCell<()>>,
1769*c3739801SMiguel Ojeda                             *const NotZerocopy,
1770*c3739801SMiguel Ojeda                             *mut NotZerocopy
1771*c3739801SMiguel Ojeda                         );
1772*c3739801SMiguel Ojeda 
1773*c3739801SMiguel Ojeda                         None
1774*c3739801SMiguel Ojeda                     }
1775*c3739801SMiguel Ojeda                 }
1776*c3739801SMiguel Ojeda 
1777*c3739801SMiguel Ojeda                 <$ty as TryFromBytesTestable>::with_passing_test_cases(|mut val| {
1778*c3739801SMiguel Ojeda                     // FIXME(#494): These tests only get exercised for types
1779*c3739801SMiguel Ojeda                     // which are `IntoBytes`. Once we implement #494, we should
1780*c3739801SMiguel Ojeda                     // be able to support non-`IntoBytes` types by zeroing
1781*c3739801SMiguel Ojeda                     // padding.
1782*c3739801SMiguel Ojeda 
1783*c3739801SMiguel Ojeda                     // We define `w` and `ww` since, in the case of the inherent
1784*c3739801SMiguel Ojeda                     // methods, Rust thinks they're both borrowed mutably at the
1785*c3739801SMiguel Ojeda                     // same time (given how we use them below). If we just
1786*c3739801SMiguel Ojeda                     // defined a single `w` and used it for multiple operations,
1787*c3739801SMiguel Ojeda                     // this would conflict.
1788*c3739801SMiguel Ojeda                     //
1789*c3739801SMiguel Ojeda                     // We `#[allow(unused_mut]` for the cases where the "real"
1790*c3739801SMiguel Ojeda                     // impls are used, which take `&self`.
1791*c3739801SMiguel Ojeda                     #[allow(unused_mut)]
1792*c3739801SMiguel Ojeda                     let (mut w, mut ww) = (AutorefWrapper::<$ty>(PhantomData), AutorefWrapper::<$ty>(PhantomData));
1793*c3739801SMiguel Ojeda 
1794*c3739801SMiguel Ojeda                     let c = Ptr::from_ref(&*val);
1795*c3739801SMiguel Ojeda                     let c = c.forget_aligned();
1796*c3739801SMiguel Ojeda                     // SAFETY: FIXME(#899): This is unsound. `$ty` is not
1797*c3739801SMiguel Ojeda                     // necessarily `IntoBytes`, but that's the corner we've
1798*c3739801SMiguel Ojeda                     // backed ourselves into by using `Ptr::from_ref`.
1799*c3739801SMiguel Ojeda                     let c = unsafe { c.assume_initialized() };
1800*c3739801SMiguel Ojeda                     let res = w.test_is_bit_valid_shared(c);
1801*c3739801SMiguel Ojeda                     if let Some(res) = res {
1802*c3739801SMiguel Ojeda                         assert!(res, "{}::is_bit_valid (shared `Ptr`): got false, expected true", stringify!($ty));
1803*c3739801SMiguel Ojeda                     }
1804*c3739801SMiguel Ojeda 
1805*c3739801SMiguel Ojeda                     let c = Ptr::from_mut(&mut *val);
1806*c3739801SMiguel Ojeda                     let c = c.forget_aligned();
1807*c3739801SMiguel Ojeda                     // SAFETY: FIXME(#899): This is unsound. `$ty` is not
1808*c3739801SMiguel Ojeda                     // necessarily `IntoBytes`, but that's the corner we've
1809*c3739801SMiguel Ojeda                     // backed ourselves into by using `Ptr::from_ref`.
1810*c3739801SMiguel Ojeda                     let mut c = unsafe { c.assume_initialized() };
1811*c3739801SMiguel Ojeda                     let res = <$ty as TryFromBytes>::is_bit_valid(c.reborrow_shared());
1812*c3739801SMiguel Ojeda                     assert!(res, "{}::is_bit_valid (exclusive `Ptr`): got false, expected true", stringify!($ty));
1813*c3739801SMiguel Ojeda 
1814*c3739801SMiguel Ojeda                     // `bytes` is `Some(val.as_bytes())` if `$ty: IntoBytes +
1815*c3739801SMiguel Ojeda                     // Immutable` and `None` otherwise.
1816*c3739801SMiguel Ojeda                     let bytes = w.test_as_bytes(&*val);
1817*c3739801SMiguel Ojeda 
1818*c3739801SMiguel Ojeda                     // The inner closure returns
1819*c3739801SMiguel Ojeda                     // `Some($ty::try_ref_from_bytes(bytes))` if `$ty:
1820*c3739801SMiguel Ojeda                     // Immutable` and `None` otherwise.
1821*c3739801SMiguel Ojeda                     let res = bytes.and_then(|bytes| ww.test_try_from_ref(bytes));
1822*c3739801SMiguel Ojeda                     if let Some(res) = res {
1823*c3739801SMiguel Ojeda                         assert!(res.is_some(), "{}::try_ref_from_bytes: got `None`, expected `Some`", stringify!($ty));
1824*c3739801SMiguel Ojeda                     }
1825*c3739801SMiguel Ojeda 
1826*c3739801SMiguel Ojeda                     if let Some(bytes) = bytes {
1827*c3739801SMiguel Ojeda                         // We need to get a mutable byte slice, and so we clone
1828*c3739801SMiguel Ojeda                         // into a `Vec`. However, we also need these bytes to
1829*c3739801SMiguel Ojeda                         // satisfy `$ty`'s alignment requirement, which isn't
1830*c3739801SMiguel Ojeda                         // guaranteed for `Vec<u8>`. In order to get around
1831*c3739801SMiguel Ojeda                         // this, we create a `Vec` which is twice as long as we
1832*c3739801SMiguel Ojeda                         // need. There is guaranteed to be an aligned byte range
1833*c3739801SMiguel Ojeda                         // of size `size_of_val(val)` within that range.
1834*c3739801SMiguel Ojeda                         let val = &*val;
1835*c3739801SMiguel Ojeda                         let size = mem::size_of_val(val);
1836*c3739801SMiguel Ojeda                         let align = mem::align_of_val(val);
1837*c3739801SMiguel Ojeda 
1838*c3739801SMiguel Ojeda                         let mut vec = bytes.to_vec();
1839*c3739801SMiguel Ojeda                         vec.extend(bytes);
1840*c3739801SMiguel Ojeda                         let slc = vec.as_slice();
1841*c3739801SMiguel Ojeda                         let offset = slc.as_ptr().align_offset(align);
1842*c3739801SMiguel Ojeda                         let bytes_mut = &mut vec.as_mut_slice()[offset..offset+size];
1843*c3739801SMiguel Ojeda                         bytes_mut.copy_from_slice(bytes);
1844*c3739801SMiguel Ojeda 
1845*c3739801SMiguel Ojeda                         let res = ww.test_try_from_mut(bytes_mut);
1846*c3739801SMiguel Ojeda                         if let Some(res) = res {
1847*c3739801SMiguel Ojeda                             assert!(res.is_some(), "{}::try_mut_from_bytes: got `None`, expected `Some`", stringify!($ty));
1848*c3739801SMiguel Ojeda                         }
1849*c3739801SMiguel Ojeda                     }
1850*c3739801SMiguel Ojeda 
1851*c3739801SMiguel Ojeda                     let res = bytes.and_then(|bytes| ww.test_try_read_from(bytes));
1852*c3739801SMiguel Ojeda                     if let Some(res) = res {
1853*c3739801SMiguel Ojeda                         assert!(res.is_some(), "{}::try_read_from_bytes: got `None`, expected `Some`", stringify!($ty));
1854*c3739801SMiguel Ojeda                     }
1855*c3739801SMiguel Ojeda                 });
1856*c3739801SMiguel Ojeda                 #[allow(clippy::as_conversions)]
1857*c3739801SMiguel Ojeda                 <$ty as TryFromBytesTestable>::with_failing_test_cases(|c| {
1858*c3739801SMiguel Ojeda                     #[allow(unused_mut)] // For cases where the "real" impls are used, which take `&self`.
1859*c3739801SMiguel Ojeda                     let mut w = AutorefWrapper::<$ty>(PhantomData);
1860*c3739801SMiguel Ojeda 
1861*c3739801SMiguel Ojeda                     // This is `Some($ty::try_ref_from_bytes(c))` if `$ty:
1862*c3739801SMiguel Ojeda                     // Immutable` and `None` otherwise.
1863*c3739801SMiguel Ojeda                     let res = w.test_try_from_ref(c);
1864*c3739801SMiguel Ojeda                     if let Some(res) = res {
1865*c3739801SMiguel Ojeda                         assert!(res.is_none(), "{}::try_ref_from_bytes({:?}): got Some, expected None", stringify!($ty), c);
1866*c3739801SMiguel Ojeda                     }
1867*c3739801SMiguel Ojeda 
1868*c3739801SMiguel Ojeda                     let res = w.test_try_from_mut(c);
1869*c3739801SMiguel Ojeda                     if let Some(res) = res {
1870*c3739801SMiguel Ojeda                         assert!(res.is_none(), "{}::try_mut_from_bytes({:?}): got Some, expected None", stringify!($ty), c);
1871*c3739801SMiguel Ojeda                     }
1872*c3739801SMiguel Ojeda 
1873*c3739801SMiguel Ojeda 
1874*c3739801SMiguel Ojeda                     let res = w.test_try_read_from(c);
1875*c3739801SMiguel Ojeda                     if let Some(res) = res {
1876*c3739801SMiguel Ojeda                         assert!(res.is_none(), "{}::try_read_from_bytes({:?}): got Some, expected None", stringify!($ty), c);
1877*c3739801SMiguel Ojeda                     }
1878*c3739801SMiguel Ojeda                 });
1879*c3739801SMiguel Ojeda 
1880*c3739801SMiguel Ojeda                 #[allow(dead_code)]
1881*c3739801SMiguel Ojeda                 const _: () = { static_assertions::assert_impl_all!($ty: TryFromBytes); };
1882*c3739801SMiguel Ojeda             };
1883*c3739801SMiguel Ojeda             ($ty:ty: $trait:ident) => {
1884*c3739801SMiguel Ojeda                 #[allow(dead_code)]
1885*c3739801SMiguel Ojeda                 const _: () = { static_assertions::assert_impl_all!($ty: $trait); };
1886*c3739801SMiguel Ojeda             };
1887*c3739801SMiguel Ojeda             ($ty:ty: !$trait:ident) => {
1888*c3739801SMiguel Ojeda                 #[allow(dead_code)]
1889*c3739801SMiguel Ojeda                 const _: () = { static_assertions::assert_not_impl_any!($ty: $trait); };
1890*c3739801SMiguel Ojeda             };
1891*c3739801SMiguel Ojeda             ($ty:ty: $($trait:ident),* $(,)? $(!$negative_trait:ident),*) => {
1892*c3739801SMiguel Ojeda                 $(
1893*c3739801SMiguel Ojeda                     assert_impls!($ty: $trait);
1894*c3739801SMiguel Ojeda                 )*
1895*c3739801SMiguel Ojeda 
1896*c3739801SMiguel Ojeda                 $(
1897*c3739801SMiguel Ojeda                     assert_impls!($ty: !$negative_trait);
1898*c3739801SMiguel Ojeda                 )*
1899*c3739801SMiguel Ojeda             };
1900*c3739801SMiguel Ojeda         }
1901*c3739801SMiguel Ojeda 
1902*c3739801SMiguel Ojeda         // NOTE: The negative impl assertions here are not necessarily
1903*c3739801SMiguel Ojeda         // prescriptive. They merely serve as change detectors to make sure
1904*c3739801SMiguel Ojeda         // we're aware of what trait impls are getting added with a given
1905*c3739801SMiguel Ojeda         // change. Of course, some impls would be invalid (e.g., `bool:
1906*c3739801SMiguel Ojeda         // FromBytes`), and so this change detection is very important.
1907*c3739801SMiguel Ojeda 
1908*c3739801SMiguel Ojeda         assert_impls!(
1909*c3739801SMiguel Ojeda             (): KnownLayout,
1910*c3739801SMiguel Ojeda             Immutable,
1911*c3739801SMiguel Ojeda             TryFromBytes,
1912*c3739801SMiguel Ojeda             FromZeros,
1913*c3739801SMiguel Ojeda             FromBytes,
1914*c3739801SMiguel Ojeda             IntoBytes,
1915*c3739801SMiguel Ojeda             Unaligned
1916*c3739801SMiguel Ojeda         );
1917*c3739801SMiguel Ojeda         assert_impls!(
1918*c3739801SMiguel Ojeda             u8: KnownLayout,
1919*c3739801SMiguel Ojeda             Immutable,
1920*c3739801SMiguel Ojeda             TryFromBytes,
1921*c3739801SMiguel Ojeda             FromZeros,
1922*c3739801SMiguel Ojeda             FromBytes,
1923*c3739801SMiguel Ojeda             IntoBytes,
1924*c3739801SMiguel Ojeda             Unaligned
1925*c3739801SMiguel Ojeda         );
1926*c3739801SMiguel Ojeda         assert_impls!(
1927*c3739801SMiguel Ojeda             i8: KnownLayout,
1928*c3739801SMiguel Ojeda             Immutable,
1929*c3739801SMiguel Ojeda             TryFromBytes,
1930*c3739801SMiguel Ojeda             FromZeros,
1931*c3739801SMiguel Ojeda             FromBytes,
1932*c3739801SMiguel Ojeda             IntoBytes,
1933*c3739801SMiguel Ojeda             Unaligned
1934*c3739801SMiguel Ojeda         );
1935*c3739801SMiguel Ojeda         assert_impls!(
1936*c3739801SMiguel Ojeda             u16: KnownLayout,
1937*c3739801SMiguel Ojeda             Immutable,
1938*c3739801SMiguel Ojeda             TryFromBytes,
1939*c3739801SMiguel Ojeda             FromZeros,
1940*c3739801SMiguel Ojeda             FromBytes,
1941*c3739801SMiguel Ojeda             IntoBytes,
1942*c3739801SMiguel Ojeda             !Unaligned
1943*c3739801SMiguel Ojeda         );
1944*c3739801SMiguel Ojeda         assert_impls!(
1945*c3739801SMiguel Ojeda             i16: KnownLayout,
1946*c3739801SMiguel Ojeda             Immutable,
1947*c3739801SMiguel Ojeda             TryFromBytes,
1948*c3739801SMiguel Ojeda             FromZeros,
1949*c3739801SMiguel Ojeda             FromBytes,
1950*c3739801SMiguel Ojeda             IntoBytes,
1951*c3739801SMiguel Ojeda             !Unaligned
1952*c3739801SMiguel Ojeda         );
1953*c3739801SMiguel Ojeda         assert_impls!(
1954*c3739801SMiguel Ojeda             u32: KnownLayout,
1955*c3739801SMiguel Ojeda             Immutable,
1956*c3739801SMiguel Ojeda             TryFromBytes,
1957*c3739801SMiguel Ojeda             FromZeros,
1958*c3739801SMiguel Ojeda             FromBytes,
1959*c3739801SMiguel Ojeda             IntoBytes,
1960*c3739801SMiguel Ojeda             !Unaligned
1961*c3739801SMiguel Ojeda         );
1962*c3739801SMiguel Ojeda         assert_impls!(
1963*c3739801SMiguel Ojeda             i32: KnownLayout,
1964*c3739801SMiguel Ojeda             Immutable,
1965*c3739801SMiguel Ojeda             TryFromBytes,
1966*c3739801SMiguel Ojeda             FromZeros,
1967*c3739801SMiguel Ojeda             FromBytes,
1968*c3739801SMiguel Ojeda             IntoBytes,
1969*c3739801SMiguel Ojeda             !Unaligned
1970*c3739801SMiguel Ojeda         );
1971*c3739801SMiguel Ojeda         assert_impls!(
1972*c3739801SMiguel Ojeda             u64: KnownLayout,
1973*c3739801SMiguel Ojeda             Immutable,
1974*c3739801SMiguel Ojeda             TryFromBytes,
1975*c3739801SMiguel Ojeda             FromZeros,
1976*c3739801SMiguel Ojeda             FromBytes,
1977*c3739801SMiguel Ojeda             IntoBytes,
1978*c3739801SMiguel Ojeda             !Unaligned
1979*c3739801SMiguel Ojeda         );
1980*c3739801SMiguel Ojeda         assert_impls!(
1981*c3739801SMiguel Ojeda             i64: KnownLayout,
1982*c3739801SMiguel Ojeda             Immutable,
1983*c3739801SMiguel Ojeda             TryFromBytes,
1984*c3739801SMiguel Ojeda             FromZeros,
1985*c3739801SMiguel Ojeda             FromBytes,
1986*c3739801SMiguel Ojeda             IntoBytes,
1987*c3739801SMiguel Ojeda             !Unaligned
1988*c3739801SMiguel Ojeda         );
1989*c3739801SMiguel Ojeda         assert_impls!(
1990*c3739801SMiguel Ojeda             u128: KnownLayout,
1991*c3739801SMiguel Ojeda             Immutable,
1992*c3739801SMiguel Ojeda             TryFromBytes,
1993*c3739801SMiguel Ojeda             FromZeros,
1994*c3739801SMiguel Ojeda             FromBytes,
1995*c3739801SMiguel Ojeda             IntoBytes,
1996*c3739801SMiguel Ojeda             !Unaligned
1997*c3739801SMiguel Ojeda         );
1998*c3739801SMiguel Ojeda         assert_impls!(
1999*c3739801SMiguel Ojeda             i128: KnownLayout,
2000*c3739801SMiguel Ojeda             Immutable,
2001*c3739801SMiguel Ojeda             TryFromBytes,
2002*c3739801SMiguel Ojeda             FromZeros,
2003*c3739801SMiguel Ojeda             FromBytes,
2004*c3739801SMiguel Ojeda             IntoBytes,
2005*c3739801SMiguel Ojeda             !Unaligned
2006*c3739801SMiguel Ojeda         );
2007*c3739801SMiguel Ojeda         assert_impls!(
2008*c3739801SMiguel Ojeda             usize: KnownLayout,
2009*c3739801SMiguel Ojeda             Immutable,
2010*c3739801SMiguel Ojeda             TryFromBytes,
2011*c3739801SMiguel Ojeda             FromZeros,
2012*c3739801SMiguel Ojeda             FromBytes,
2013*c3739801SMiguel Ojeda             IntoBytes,
2014*c3739801SMiguel Ojeda             !Unaligned
2015*c3739801SMiguel Ojeda         );
2016*c3739801SMiguel Ojeda         assert_impls!(
2017*c3739801SMiguel Ojeda             isize: KnownLayout,
2018*c3739801SMiguel Ojeda             Immutable,
2019*c3739801SMiguel Ojeda             TryFromBytes,
2020*c3739801SMiguel Ojeda             FromZeros,
2021*c3739801SMiguel Ojeda             FromBytes,
2022*c3739801SMiguel Ojeda             IntoBytes,
2023*c3739801SMiguel Ojeda             !Unaligned
2024*c3739801SMiguel Ojeda         );
2025*c3739801SMiguel Ojeda         #[cfg(feature = "float-nightly")]
2026*c3739801SMiguel Ojeda         assert_impls!(
2027*c3739801SMiguel Ojeda             f16: KnownLayout,
2028*c3739801SMiguel Ojeda             Immutable,
2029*c3739801SMiguel Ojeda             TryFromBytes,
2030*c3739801SMiguel Ojeda             FromZeros,
2031*c3739801SMiguel Ojeda             FromBytes,
2032*c3739801SMiguel Ojeda             IntoBytes,
2033*c3739801SMiguel Ojeda             !Unaligned
2034*c3739801SMiguel Ojeda         );
2035*c3739801SMiguel Ojeda         assert_impls!(
2036*c3739801SMiguel Ojeda             f32: KnownLayout,
2037*c3739801SMiguel Ojeda             Immutable,
2038*c3739801SMiguel Ojeda             TryFromBytes,
2039*c3739801SMiguel Ojeda             FromZeros,
2040*c3739801SMiguel Ojeda             FromBytes,
2041*c3739801SMiguel Ojeda             IntoBytes,
2042*c3739801SMiguel Ojeda             !Unaligned
2043*c3739801SMiguel Ojeda         );
2044*c3739801SMiguel Ojeda         assert_impls!(
2045*c3739801SMiguel Ojeda             f64: KnownLayout,
2046*c3739801SMiguel Ojeda             Immutable,
2047*c3739801SMiguel Ojeda             TryFromBytes,
2048*c3739801SMiguel Ojeda             FromZeros,
2049*c3739801SMiguel Ojeda             FromBytes,
2050*c3739801SMiguel Ojeda             IntoBytes,
2051*c3739801SMiguel Ojeda             !Unaligned
2052*c3739801SMiguel Ojeda         );
2053*c3739801SMiguel Ojeda         #[cfg(feature = "float-nightly")]
2054*c3739801SMiguel Ojeda         assert_impls!(
2055*c3739801SMiguel Ojeda             f128: KnownLayout,
2056*c3739801SMiguel Ojeda             Immutable,
2057*c3739801SMiguel Ojeda             TryFromBytes,
2058*c3739801SMiguel Ojeda             FromZeros,
2059*c3739801SMiguel Ojeda             FromBytes,
2060*c3739801SMiguel Ojeda             IntoBytes,
2061*c3739801SMiguel Ojeda             !Unaligned
2062*c3739801SMiguel Ojeda         );
2063*c3739801SMiguel Ojeda         assert_impls!(
2064*c3739801SMiguel Ojeda             bool: KnownLayout,
2065*c3739801SMiguel Ojeda             Immutable,
2066*c3739801SMiguel Ojeda             TryFromBytes,
2067*c3739801SMiguel Ojeda             FromZeros,
2068*c3739801SMiguel Ojeda             IntoBytes,
2069*c3739801SMiguel Ojeda             Unaligned,
2070*c3739801SMiguel Ojeda             !FromBytes
2071*c3739801SMiguel Ojeda         );
2072*c3739801SMiguel Ojeda         assert_impls!(
2073*c3739801SMiguel Ojeda             char: KnownLayout,
2074*c3739801SMiguel Ojeda             Immutable,
2075*c3739801SMiguel Ojeda             TryFromBytes,
2076*c3739801SMiguel Ojeda             FromZeros,
2077*c3739801SMiguel Ojeda             IntoBytes,
2078*c3739801SMiguel Ojeda             !FromBytes,
2079*c3739801SMiguel Ojeda             !Unaligned
2080*c3739801SMiguel Ojeda         );
2081*c3739801SMiguel Ojeda         assert_impls!(
2082*c3739801SMiguel Ojeda             str: KnownLayout,
2083*c3739801SMiguel Ojeda             Immutable,
2084*c3739801SMiguel Ojeda             TryFromBytes,
2085*c3739801SMiguel Ojeda             FromZeros,
2086*c3739801SMiguel Ojeda             IntoBytes,
2087*c3739801SMiguel Ojeda             Unaligned,
2088*c3739801SMiguel Ojeda             !FromBytes
2089*c3739801SMiguel Ojeda         );
2090*c3739801SMiguel Ojeda 
2091*c3739801SMiguel Ojeda         assert_impls!(
2092*c3739801SMiguel Ojeda             NonZeroU8: KnownLayout,
2093*c3739801SMiguel Ojeda             Immutable,
2094*c3739801SMiguel Ojeda             TryFromBytes,
2095*c3739801SMiguel Ojeda             IntoBytes,
2096*c3739801SMiguel Ojeda             Unaligned,
2097*c3739801SMiguel Ojeda             !FromZeros,
2098*c3739801SMiguel Ojeda             !FromBytes
2099*c3739801SMiguel Ojeda         );
2100*c3739801SMiguel Ojeda         assert_impls!(
2101*c3739801SMiguel Ojeda             NonZeroI8: KnownLayout,
2102*c3739801SMiguel Ojeda             Immutable,
2103*c3739801SMiguel Ojeda             TryFromBytes,
2104*c3739801SMiguel Ojeda             IntoBytes,
2105*c3739801SMiguel Ojeda             Unaligned,
2106*c3739801SMiguel Ojeda             !FromZeros,
2107*c3739801SMiguel Ojeda             !FromBytes
2108*c3739801SMiguel Ojeda         );
2109*c3739801SMiguel Ojeda         assert_impls!(
2110*c3739801SMiguel Ojeda             NonZeroU16: KnownLayout,
2111*c3739801SMiguel Ojeda             Immutable,
2112*c3739801SMiguel Ojeda             TryFromBytes,
2113*c3739801SMiguel Ojeda             IntoBytes,
2114*c3739801SMiguel Ojeda             !FromBytes,
2115*c3739801SMiguel Ojeda             !Unaligned
2116*c3739801SMiguel Ojeda         );
2117*c3739801SMiguel Ojeda         assert_impls!(
2118*c3739801SMiguel Ojeda             NonZeroI16: KnownLayout,
2119*c3739801SMiguel Ojeda             Immutable,
2120*c3739801SMiguel Ojeda             TryFromBytes,
2121*c3739801SMiguel Ojeda             IntoBytes,
2122*c3739801SMiguel Ojeda             !FromBytes,
2123*c3739801SMiguel Ojeda             !Unaligned
2124*c3739801SMiguel Ojeda         );
2125*c3739801SMiguel Ojeda         assert_impls!(
2126*c3739801SMiguel Ojeda             NonZeroU32: KnownLayout,
2127*c3739801SMiguel Ojeda             Immutable,
2128*c3739801SMiguel Ojeda             TryFromBytes,
2129*c3739801SMiguel Ojeda             IntoBytes,
2130*c3739801SMiguel Ojeda             !FromBytes,
2131*c3739801SMiguel Ojeda             !Unaligned
2132*c3739801SMiguel Ojeda         );
2133*c3739801SMiguel Ojeda         assert_impls!(
2134*c3739801SMiguel Ojeda             NonZeroI32: KnownLayout,
2135*c3739801SMiguel Ojeda             Immutable,
2136*c3739801SMiguel Ojeda             TryFromBytes,
2137*c3739801SMiguel Ojeda             IntoBytes,
2138*c3739801SMiguel Ojeda             !FromBytes,
2139*c3739801SMiguel Ojeda             !Unaligned
2140*c3739801SMiguel Ojeda         );
2141*c3739801SMiguel Ojeda         assert_impls!(
2142*c3739801SMiguel Ojeda             NonZeroU64: KnownLayout,
2143*c3739801SMiguel Ojeda             Immutable,
2144*c3739801SMiguel Ojeda             TryFromBytes,
2145*c3739801SMiguel Ojeda             IntoBytes,
2146*c3739801SMiguel Ojeda             !FromBytes,
2147*c3739801SMiguel Ojeda             !Unaligned
2148*c3739801SMiguel Ojeda         );
2149*c3739801SMiguel Ojeda         assert_impls!(
2150*c3739801SMiguel Ojeda             NonZeroI64: KnownLayout,
2151*c3739801SMiguel Ojeda             Immutable,
2152*c3739801SMiguel Ojeda             TryFromBytes,
2153*c3739801SMiguel Ojeda             IntoBytes,
2154*c3739801SMiguel Ojeda             !FromBytes,
2155*c3739801SMiguel Ojeda             !Unaligned
2156*c3739801SMiguel Ojeda         );
2157*c3739801SMiguel Ojeda         assert_impls!(
2158*c3739801SMiguel Ojeda             NonZeroU128: KnownLayout,
2159*c3739801SMiguel Ojeda             Immutable,
2160*c3739801SMiguel Ojeda             TryFromBytes,
2161*c3739801SMiguel Ojeda             IntoBytes,
2162*c3739801SMiguel Ojeda             !FromBytes,
2163*c3739801SMiguel Ojeda             !Unaligned
2164*c3739801SMiguel Ojeda         );
2165*c3739801SMiguel Ojeda         assert_impls!(
2166*c3739801SMiguel Ojeda             NonZeroI128: KnownLayout,
2167*c3739801SMiguel Ojeda             Immutable,
2168*c3739801SMiguel Ojeda             TryFromBytes,
2169*c3739801SMiguel Ojeda             IntoBytes,
2170*c3739801SMiguel Ojeda             !FromBytes,
2171*c3739801SMiguel Ojeda             !Unaligned
2172*c3739801SMiguel Ojeda         );
2173*c3739801SMiguel Ojeda         assert_impls!(
2174*c3739801SMiguel Ojeda             NonZeroUsize: KnownLayout,
2175*c3739801SMiguel Ojeda             Immutable,
2176*c3739801SMiguel Ojeda             TryFromBytes,
2177*c3739801SMiguel Ojeda             IntoBytes,
2178*c3739801SMiguel Ojeda             !FromBytes,
2179*c3739801SMiguel Ojeda             !Unaligned
2180*c3739801SMiguel Ojeda         );
2181*c3739801SMiguel Ojeda         assert_impls!(
2182*c3739801SMiguel Ojeda             NonZeroIsize: KnownLayout,
2183*c3739801SMiguel Ojeda             Immutable,
2184*c3739801SMiguel Ojeda             TryFromBytes,
2185*c3739801SMiguel Ojeda             IntoBytes,
2186*c3739801SMiguel Ojeda             !FromBytes,
2187*c3739801SMiguel Ojeda             !Unaligned
2188*c3739801SMiguel Ojeda         );
2189*c3739801SMiguel Ojeda 
2190*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroU8>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2191*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroI8>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2192*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroU16>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2193*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroI16>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2194*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroU32>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2195*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroI32>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2196*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroU64>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2197*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroI64>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2198*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroU128>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2199*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroI128>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2200*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroUsize>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2201*c3739801SMiguel Ojeda         assert_impls!(Option<NonZeroIsize>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned);
2202*c3739801SMiguel Ojeda 
2203*c3739801SMiguel Ojeda         // Implements none of the ZC traits.
2204*c3739801SMiguel Ojeda         struct NotZerocopy;
2205*c3739801SMiguel Ojeda 
2206*c3739801SMiguel Ojeda         #[rustfmt::skip]
2207*c3739801SMiguel Ojeda         type FnManyArgs = fn(
2208*c3739801SMiguel Ojeda             NotZerocopy, u8, u8, u8, u8, u8, u8, u8, u8, u8, u8, u8,
2209*c3739801SMiguel Ojeda         ) -> (NotZerocopy, NotZerocopy);
2210*c3739801SMiguel Ojeda 
2211*c3739801SMiguel Ojeda         // Allowed, because we're not actually using this type for FFI.
2212*c3739801SMiguel Ojeda         #[allow(improper_ctypes_definitions)]
2213*c3739801SMiguel Ojeda         #[rustfmt::skip]
2214*c3739801SMiguel Ojeda         type ECFnManyArgs = extern "C" fn(
2215*c3739801SMiguel Ojeda             NotZerocopy, u8, u8, u8, u8, u8, u8, u8, u8, u8, u8, u8,
2216*c3739801SMiguel Ojeda         ) -> (NotZerocopy, NotZerocopy);
2217*c3739801SMiguel Ojeda 
2218*c3739801SMiguel Ojeda         #[cfg(feature = "alloc")]
2219*c3739801SMiguel Ojeda         assert_impls!(Option<Box<UnsafeCell<NotZerocopy>>>: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2220*c3739801SMiguel Ojeda         assert_impls!(Option<Box<[UnsafeCell<NotZerocopy>]>>: KnownLayout, !Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2221*c3739801SMiguel Ojeda         assert_impls!(Option<&'static UnsafeCell<NotZerocopy>>: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2222*c3739801SMiguel Ojeda         assert_impls!(Option<&'static [UnsafeCell<NotZerocopy>]>: KnownLayout, Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2223*c3739801SMiguel Ojeda         assert_impls!(Option<&'static mut UnsafeCell<NotZerocopy>>: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2224*c3739801SMiguel Ojeda         assert_impls!(Option<&'static mut [UnsafeCell<NotZerocopy>]>: KnownLayout, Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2225*c3739801SMiguel Ojeda         assert_impls!(Option<NonNull<UnsafeCell<NotZerocopy>>>: KnownLayout, TryFromBytes, FromZeros, Immutable, !FromBytes, !IntoBytes, !Unaligned);
2226*c3739801SMiguel Ojeda         assert_impls!(Option<NonNull<[UnsafeCell<NotZerocopy>]>>: KnownLayout, Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2227*c3739801SMiguel Ojeda         assert_impls!(Option<fn()>: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2228*c3739801SMiguel Ojeda         assert_impls!(Option<FnManyArgs>: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2229*c3739801SMiguel Ojeda         assert_impls!(Option<extern "C" fn()>: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2230*c3739801SMiguel Ojeda         assert_impls!(Option<ECFnManyArgs>: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2231*c3739801SMiguel Ojeda 
2232*c3739801SMiguel Ojeda         assert_impls!(PhantomData<NotZerocopy>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2233*c3739801SMiguel Ojeda         assert_impls!(PhantomData<UnsafeCell<()>>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2234*c3739801SMiguel Ojeda         assert_impls!(PhantomData<[u8]>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2235*c3739801SMiguel Ojeda 
2236*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<u8>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2237*c3739801SMiguel Ojeda         // This test is important because it allows us to test our hand-rolled
2238*c3739801SMiguel Ojeda         // implementation of `<ManuallyDrop<T> as TryFromBytes>::is_bit_valid`.
2239*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<bool>: KnownLayout, Immutable, TryFromBytes, FromZeros, IntoBytes, Unaligned, !FromBytes);
2240*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<[u8]>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2241*c3739801SMiguel Ojeda         // This test is important because it allows us to test our hand-rolled
2242*c3739801SMiguel Ojeda         // implementation of `<ManuallyDrop<T> as TryFromBytes>::is_bit_valid`.
2243*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<[bool]>: KnownLayout, Immutable, TryFromBytes, FromZeros, IntoBytes, Unaligned, !FromBytes);
2244*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<NotZerocopy>: !Immutable, !TryFromBytes, !KnownLayout, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2245*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<[NotZerocopy]>: KnownLayout, !Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2246*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<UnsafeCell<()>>: KnownLayout, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned, !Immutable);
2247*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<[UnsafeCell<u8>]>: KnownLayout, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned, !Immutable);
2248*c3739801SMiguel Ojeda         assert_impls!(ManuallyDrop<[UnsafeCell<bool>]>: KnownLayout, TryFromBytes, FromZeros, IntoBytes, Unaligned, !Immutable, !FromBytes);
2249*c3739801SMiguel Ojeda 
2250*c3739801SMiguel Ojeda         assert_impls!(CoreMaybeUninit<u8>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, Unaligned, !IntoBytes);
2251*c3739801SMiguel Ojeda         assert_impls!(CoreMaybeUninit<NotZerocopy>: KnownLayout, TryFromBytes, FromZeros, FromBytes, !Immutable, !IntoBytes, !Unaligned);
2252*c3739801SMiguel Ojeda         assert_impls!(CoreMaybeUninit<UnsafeCell<()>>: KnownLayout, TryFromBytes, FromZeros, FromBytes, Unaligned, !Immutable, !IntoBytes);
2253*c3739801SMiguel Ojeda 
2254*c3739801SMiguel Ojeda         assert_impls!(Wrapping<u8>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2255*c3739801SMiguel Ojeda         // This test is important because it allows us to test our hand-rolled
2256*c3739801SMiguel Ojeda         // implementation of `<Wrapping<T> as TryFromBytes>::is_bit_valid`.
2257*c3739801SMiguel Ojeda         assert_impls!(Wrapping<bool>: KnownLayout, Immutable, TryFromBytes, FromZeros, IntoBytes, Unaligned, !FromBytes);
2258*c3739801SMiguel Ojeda         assert_impls!(Wrapping<NotZerocopy>: KnownLayout, !Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2259*c3739801SMiguel Ojeda         assert_impls!(Wrapping<UnsafeCell<()>>: KnownLayout, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned, !Immutable);
2260*c3739801SMiguel Ojeda 
2261*c3739801SMiguel Ojeda         assert_impls!(Unalign<u8>: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, Unaligned);
2262*c3739801SMiguel Ojeda         // This test is important because it allows us to test our hand-rolled
2263*c3739801SMiguel Ojeda         // implementation of `<Unalign<T> as TryFromBytes>::is_bit_valid`.
2264*c3739801SMiguel Ojeda         assert_impls!(Unalign<bool>: KnownLayout, Immutable, TryFromBytes, FromZeros, IntoBytes, Unaligned, !FromBytes);
2265*c3739801SMiguel Ojeda         assert_impls!(Unalign<NotZerocopy>: KnownLayout, Unaligned, !Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes);
2266*c3739801SMiguel Ojeda 
2267*c3739801SMiguel Ojeda         assert_impls!(
2268*c3739801SMiguel Ojeda             [u8]: KnownLayout,
2269*c3739801SMiguel Ojeda             Immutable,
2270*c3739801SMiguel Ojeda             TryFromBytes,
2271*c3739801SMiguel Ojeda             FromZeros,
2272*c3739801SMiguel Ojeda             FromBytes,
2273*c3739801SMiguel Ojeda             IntoBytes,
2274*c3739801SMiguel Ojeda             Unaligned
2275*c3739801SMiguel Ojeda         );
2276*c3739801SMiguel Ojeda         assert_impls!(
2277*c3739801SMiguel Ojeda             [bool]: KnownLayout,
2278*c3739801SMiguel Ojeda             Immutable,
2279*c3739801SMiguel Ojeda             TryFromBytes,
2280*c3739801SMiguel Ojeda             FromZeros,
2281*c3739801SMiguel Ojeda             IntoBytes,
2282*c3739801SMiguel Ojeda             Unaligned,
2283*c3739801SMiguel Ojeda             !FromBytes
2284*c3739801SMiguel Ojeda         );
2285*c3739801SMiguel Ojeda         assert_impls!([NotZerocopy]: KnownLayout, !Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2286*c3739801SMiguel Ojeda         assert_impls!(
2287*c3739801SMiguel Ojeda             [u8; 0]: KnownLayout,
2288*c3739801SMiguel Ojeda             Immutable,
2289*c3739801SMiguel Ojeda             TryFromBytes,
2290*c3739801SMiguel Ojeda             FromZeros,
2291*c3739801SMiguel Ojeda             FromBytes,
2292*c3739801SMiguel Ojeda             IntoBytes,
2293*c3739801SMiguel Ojeda             Unaligned,
2294*c3739801SMiguel Ojeda         );
2295*c3739801SMiguel Ojeda         assert_impls!(
2296*c3739801SMiguel Ojeda             [NotZerocopy; 0]: KnownLayout,
2297*c3739801SMiguel Ojeda             !Immutable,
2298*c3739801SMiguel Ojeda             !TryFromBytes,
2299*c3739801SMiguel Ojeda             !FromZeros,
2300*c3739801SMiguel Ojeda             !FromBytes,
2301*c3739801SMiguel Ojeda             !IntoBytes,
2302*c3739801SMiguel Ojeda             !Unaligned
2303*c3739801SMiguel Ojeda         );
2304*c3739801SMiguel Ojeda         assert_impls!(
2305*c3739801SMiguel Ojeda             [u8; 1]: KnownLayout,
2306*c3739801SMiguel Ojeda             Immutable,
2307*c3739801SMiguel Ojeda             TryFromBytes,
2308*c3739801SMiguel Ojeda             FromZeros,
2309*c3739801SMiguel Ojeda             FromBytes,
2310*c3739801SMiguel Ojeda             IntoBytes,
2311*c3739801SMiguel Ojeda             Unaligned,
2312*c3739801SMiguel Ojeda         );
2313*c3739801SMiguel Ojeda         assert_impls!(
2314*c3739801SMiguel Ojeda             [NotZerocopy; 1]: KnownLayout,
2315*c3739801SMiguel Ojeda             !Immutable,
2316*c3739801SMiguel Ojeda             !TryFromBytes,
2317*c3739801SMiguel Ojeda             !FromZeros,
2318*c3739801SMiguel Ojeda             !FromBytes,
2319*c3739801SMiguel Ojeda             !IntoBytes,
2320*c3739801SMiguel Ojeda             !Unaligned
2321*c3739801SMiguel Ojeda         );
2322*c3739801SMiguel Ojeda 
2323*c3739801SMiguel Ojeda         assert_impls!(*const NotZerocopy: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2324*c3739801SMiguel Ojeda         assert_impls!(*mut NotZerocopy: KnownLayout, Immutable, TryFromBytes, FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2325*c3739801SMiguel Ojeda         assert_impls!(*const [NotZerocopy]: KnownLayout, Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2326*c3739801SMiguel Ojeda         assert_impls!(*mut [NotZerocopy]: KnownLayout, Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2327*c3739801SMiguel Ojeda         assert_impls!(*const dyn Debug: KnownLayout, Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2328*c3739801SMiguel Ojeda         assert_impls!(*mut dyn Debug: KnownLayout, Immutable, !TryFromBytes, !FromZeros, !FromBytes, !IntoBytes, !Unaligned);
2329*c3739801SMiguel Ojeda 
2330*c3739801SMiguel Ojeda         #[cfg(feature = "simd")]
2331*c3739801SMiguel Ojeda         {
2332*c3739801SMiguel Ojeda             #[allow(unused_macros)]
2333*c3739801SMiguel Ojeda             macro_rules! test_simd_arch_mod {
2334*c3739801SMiguel Ojeda                 ($arch:ident, $($typ:ident),*) => {
2335*c3739801SMiguel Ojeda                     {
2336*c3739801SMiguel Ojeda                         use core::arch::$arch::{$($typ),*};
2337*c3739801SMiguel Ojeda                         use crate::*;
2338*c3739801SMiguel Ojeda                         $( assert_impls!($typ: KnownLayout, Immutable, TryFromBytes, FromZeros, FromBytes, IntoBytes, !Unaligned); )*
2339*c3739801SMiguel Ojeda                     }
2340*c3739801SMiguel Ojeda                 };
2341*c3739801SMiguel Ojeda             }
2342*c3739801SMiguel Ojeda             #[cfg(target_arch = "x86")]
2343*c3739801SMiguel Ojeda             test_simd_arch_mod!(x86, __m128, __m128d, __m128i, __m256, __m256d, __m256i);
2344*c3739801SMiguel Ojeda 
2345*c3739801SMiguel Ojeda             #[cfg(all(not(no_zerocopy_simd_x86_avx12_1_89_0), target_arch = "x86"))]
2346*c3739801SMiguel Ojeda             test_simd_arch_mod!(x86, __m512bh, __m512, __m512d, __m512i);
2347*c3739801SMiguel Ojeda 
2348*c3739801SMiguel Ojeda             #[cfg(target_arch = "x86_64")]
2349*c3739801SMiguel Ojeda             test_simd_arch_mod!(x86_64, __m128, __m128d, __m128i, __m256, __m256d, __m256i);
2350*c3739801SMiguel Ojeda 
2351*c3739801SMiguel Ojeda             #[cfg(all(not(no_zerocopy_simd_x86_avx12_1_89_0), target_arch = "x86_64"))]
2352*c3739801SMiguel Ojeda             test_simd_arch_mod!(x86_64, __m512bh, __m512, __m512d, __m512i);
2353*c3739801SMiguel Ojeda 
2354*c3739801SMiguel Ojeda             #[cfg(target_arch = "wasm32")]
2355*c3739801SMiguel Ojeda             test_simd_arch_mod!(wasm32, v128);
2356*c3739801SMiguel Ojeda 
2357*c3739801SMiguel Ojeda             #[cfg(all(feature = "simd-nightly", target_arch = "powerpc"))]
2358*c3739801SMiguel Ojeda             test_simd_arch_mod!(
2359*c3739801SMiguel Ojeda                 powerpc,
2360*c3739801SMiguel Ojeda                 vector_bool_long,
2361*c3739801SMiguel Ojeda                 vector_double,
2362*c3739801SMiguel Ojeda                 vector_signed_long,
2363*c3739801SMiguel Ojeda                 vector_unsigned_long
2364*c3739801SMiguel Ojeda             );
2365*c3739801SMiguel Ojeda 
2366*c3739801SMiguel Ojeda             #[cfg(all(feature = "simd-nightly", target_arch = "powerpc64"))]
2367*c3739801SMiguel Ojeda             test_simd_arch_mod!(
2368*c3739801SMiguel Ojeda                 powerpc64,
2369*c3739801SMiguel Ojeda                 vector_bool_long,
2370*c3739801SMiguel Ojeda                 vector_double,
2371*c3739801SMiguel Ojeda                 vector_signed_long,
2372*c3739801SMiguel Ojeda                 vector_unsigned_long
2373*c3739801SMiguel Ojeda             );
2374*c3739801SMiguel Ojeda             #[cfg(all(target_arch = "aarch64", not(no_zerocopy_aarch64_simd_1_59_0)))]
2375*c3739801SMiguel Ojeda             #[rustfmt::skip]
2376*c3739801SMiguel Ojeda             test_simd_arch_mod!(
2377*c3739801SMiguel Ojeda                 aarch64, float32x2_t, float32x4_t, float64x1_t, float64x2_t, int8x8_t, int8x8x2_t,
2378*c3739801SMiguel Ojeda                 int8x8x3_t, int8x8x4_t, int8x16_t, int8x16x2_t, int8x16x3_t, int8x16x4_t, int16x4_t,
2379*c3739801SMiguel Ojeda                 int16x8_t, int32x2_t, int32x4_t, int64x1_t, int64x2_t, poly8x8_t, poly8x8x2_t, poly8x8x3_t,
2380*c3739801SMiguel Ojeda                 poly8x8x4_t, poly8x16_t, poly8x16x2_t, poly8x16x3_t, poly8x16x4_t, poly16x4_t, poly16x8_t,
2381*c3739801SMiguel Ojeda                 poly64x1_t, poly64x2_t, uint8x8_t, uint8x8x2_t, uint8x8x3_t, uint8x8x4_t, uint8x16_t,
2382*c3739801SMiguel Ojeda                 uint8x16x2_t, uint8x16x3_t, uint8x16x4_t, uint16x4_t, uint16x4x2_t, uint16x4x3_t,
2383*c3739801SMiguel Ojeda                 uint16x4x4_t, uint16x8_t, uint32x2_t, uint32x4_t, uint64x1_t, uint64x2_t
2384*c3739801SMiguel Ojeda             );
2385*c3739801SMiguel Ojeda         }
2386*c3739801SMiguel Ojeda     }
2387*c3739801SMiguel Ojeda }
2388