15376944042

Committed 01 Jun 2025 04:05PM UTC coverage: 58.697% (+0.6%) from 58.142%

Build # 15376944042

Build Type

Pull #700

github

Committed by

web-flow

Commit Message

Merge 49549753d into 0530f47a7

Pull Request Pull Request #700: Solve code comment inconsistencies and add missing validations

Run Details

0 of 2 new or added lines in 2 files covered. (0.0%)

2083 existing lines in 47 files now uncovered.

10306 of 17558 relevant lines covered (58.7%)

128.69 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.21

/facet-core/src/impls_alloc/arc.rs

use crate::{
    Def, Facet, KnownSmartPointer, PtrConst, PtrMut, PtrUninit, Shape, SmartPointerDef,
    SmartPointerFlags, SmartPointerVTable, TryBorrowInnerError, TryFromError, TryIntoInnerError,
    Type, UserType, ValueVTable, value_vtable,
};

unsafe impl<'a, T: Facet<'a>> Facet<'a> for alloc::sync::Arc<T> {
    const VTABLE: &'static ValueVTable = &const {
        // Define the functions for transparent conversion between Arc<T> and T
        unsafe fn try_from<'a, 'shape, 'src, 'dst, T: Facet<'a>>(
            src_ptr: PtrConst<'src>,
            src_shape: &'shape Shape<'shape>,
            dst: PtrUninit<'dst>,
        ) -> Result<PtrMut<'dst>, TryFromError<'shape>> {
            if src_shape.id != T::SHAPE.id {
                return Err(TryFromError::UnsupportedSourceShape {
                    src_shape,
                    expected: &[T::SHAPE],
                });
            }
            let t = unsafe { src_ptr.read::<T>() };
            let arc = alloc::sync::Arc::new(t);
            Ok(unsafe { dst.put(arc) })
        }

        unsafe fn try_into_inner<'a, 'src, 'dst, T: Facet<'a>>(
            src_ptr: PtrMut<'src>,
            dst: PtrUninit<'dst>,
        ) -> Result<PtrMut<'dst>, TryIntoInnerError> {
            use alloc::sync::Arc;

            // Read the Arc from the source pointer
            let arc = unsafe { src_ptr.read::<Arc<T>>() };

            // Try to unwrap the Arc to get exclusive ownership
            match Arc::try_unwrap(arc) {
                Ok(inner) => Ok(unsafe { dst.put(inner) }),
                Err(arc) => {
                    // Arc is shared, so we can't extract the inner value
                    core::mem::forget(arc);
                    Err(TryIntoInnerError::Unavailable)
                }
            }
        }

        unsafe fn try_borrow_inner<'a, 'src, T: Facet<'a>>(
            src_ptr: PtrConst<'src>,
        ) -> Result<PtrConst<'src>, TryBorrowInnerError> {
            let arc = unsafe { src_ptr.get::<alloc::sync::Arc<T>>() };
            Ok(PtrConst::new(&**arc))
        }

        let mut vtable = value_vtable!(alloc::sync::Arc<T>, |f, opts| {
            write!(f, "{}", Self::SHAPE.type_identifier)?;
            if let Some(opts) = opts.for_children() {
                write!(f, "<")?;
                (T::SHAPE.vtable.type_name)(f, opts)?;
                write!(f, ">")?;
            } else {
                write!(f, "<…>")?;
            }
            Ok(())
        });

        vtable.try_from = || Some(try_from::<T>);
        vtable.try_into_inner = || Some(try_into_inner::<T>);
        vtable.try_borrow_inner = || Some(try_borrow_inner::<T>);
        vtable
    };

    const SHAPE: &'static crate::Shape<'static> = &const {
        // Function to return inner type's shape
        fn inner_shape<'a, T: Facet<'a>>() -> &'static Shape<'static> {
            T::SHAPE
        }

        crate::Shape::builder_for_sized::<Self>()
            .type_identifier("Arc")
            .type_params(&[crate::TypeParam {
                name: "T",
                shape: || T::SHAPE,
            }])
            .ty(Type::User(UserType::Opaque))
            .def(Def::SmartPointer(
                SmartPointerDef::builder()
                    .pointee(|| T::SHAPE)
                    .flags(SmartPointerFlags::ATOMIC)
                    .known(KnownSmartPointer::Arc)
                    .weak(|| <alloc::sync::Weak<T> as Facet>::SHAPE)
                    .vtable(
                        &const {
                            SmartPointerVTable::builder()
                                .borrow_fn(|this| {
                                    let arc_ptr = unsafe { this.as_ptr::<alloc::sync::Arc<T>>() };
                                    let ptr = unsafe { alloc::sync::Arc::as_ptr(&*arc_ptr) };
                                    PtrConst::new(ptr)
                                })
                                .new_into_fn(|this, ptr| {
                                    let t = unsafe { ptr.read::<T>() };
                                    let arc = alloc::sync::Arc::new(t);
                                    unsafe { this.put(arc) }
                                })
                                .downgrade_into_fn(|strong, weak| unsafe {
                                    weak.put(alloc::sync::Arc::downgrade(strong.get::<Self>()))
                                })
                                .build()
                        },
                    )
                    .build(),
            ))
            .inner(inner_shape::<T>)
            .build()
    };
}

unsafe impl<'a, T: Facet<'a>> Facet<'a> for alloc::sync::Weak<T> {
    const VTABLE: &'static ValueVTable = &const {
        value_vtable!(alloc::sync::Weak<T>, |f, opts| {
            write!(f, "{}", Self::SHAPE.type_identifier)?;
            if let Some(opts) = opts.for_children() {
                write!(f, "<")?;
                (T::SHAPE.vtable.type_name)(f, opts)?;
                write!(f, ">")?;
            } else {
                write!(f, "<…>")?;
            }
            Ok(())
        })
    };

    const SHAPE: &'static crate::Shape<'static> = &const {
        // Function to return inner type's shape
        fn inner_shape<'a, T: Facet<'a>>() -> &'static Shape<'static> {
            T::SHAPE
        }

        crate::Shape::builder_for_sized::<Self>()
            .type_identifier("Weak")
            .type_params(&[crate::TypeParam {
                name: "T",
                shape: || T::SHAPE,
            }])
            .ty(Type::User(UserType::Opaque))
            .def(Def::SmartPointer(
                SmartPointerDef::builder()
                    .pointee(|| T::SHAPE)
                    .flags(SmartPointerFlags::ATOMIC.union(SmartPointerFlags::WEAK))
                    .known(KnownSmartPointer::ArcWeak)
                    .strong(|| <alloc::sync::Arc<T> as Facet>::SHAPE)
                    .vtable(
                        &const {
                            SmartPointerVTable::builder()
                                .upgrade_into_fn(|weak, strong| unsafe {
                                    Some(strong.put(weak.get::<Self>().upgrade()?))
                                })
                                .build()
                        },
                    )
                    .build(),
            ))
            .inner(inner_shape::<T>)
            .build()
    };
}

#[cfg(test)]
mod tests {
    use alloc::string::String;
    use alloc::sync::{Arc, Weak as ArcWeak};

    use super::*;

    #[test]
    fn test_arc_type_params() {
        let [type_param_1] = <Arc<i32>>::SHAPE.type_params else {
            panic!("Arc<T> should only have 1 type param")
        };
        assert_eq!(type_param_1.shape(), i32::SHAPE);
    }

    #[test]
    fn test_arc_vtable_1_new_borrow_drop() -> eyre::Result<()> {
        facet_testhelpers::setup();

        let arc_shape = <Arc<String>>::SHAPE;
        let arc_def = arc_shape
            .def
            .into_smart_pointer()
            .expect("Arc<T> should have a smart pointer definition");

        // Allocate memory for the Arc
        let arc_uninit_ptr = arc_shape.allocate()?;

        // Get the function pointer for creating a new Arc from a value
        let new_into_fn = arc_def
            .vtable
            .new_into_fn
            .expect("Arc<T> should have new_into_fn");

        // Create the value and initialize the Arc
        let mut value = String::from("example");
        let arc_ptr = unsafe { new_into_fn(arc_uninit_ptr, PtrMut::new(&raw mut value)) };
        // The value now belongs to the Arc, prevent its drop
        core::mem::forget(value);

        // Get the function pointer for borrowing the inner value
        let borrow_fn = arc_def
            .vtable
            .borrow_fn
            .expect("Arc<T> should have borrow_fn");

        // Borrow the inner value and check it
        let borrowed_ptr = unsafe { borrow_fn(arc_ptr.as_const()) };
        // SAFETY: borrowed_ptr points to a valid String within the Arc
        assert_eq!(unsafe { borrowed_ptr.get::<String>() }, "example");

        // Get the function pointer for dropping the Arc
        let drop_fn = (arc_shape.vtable.drop_in_place)().expect("Arc<T> should have drop_in_place");

        // Drop the Arc in place
        // SAFETY: arc_ptr points to a valid Arc<String>
        unsafe { drop_fn(arc_ptr) };

        // Deallocate the memory
        // SAFETY: arc_ptr was allocated by arc_shape and is now dropped (but memory is still valid)
        unsafe { arc_shape.deallocate_mut(arc_ptr)? };

        Ok(())
    }

    #[test]
    fn test_arc_vtable_2_downgrade_upgrade_drop() -> eyre::Result<()> {
        facet_testhelpers::setup();

        let arc_shape = <Arc<String>>::SHAPE;
        let arc_def = arc_shape
            .def
            .into_smart_pointer()
            .expect("Arc<T> should have a smart pointer definition");

        let weak_shape = <ArcWeak<String>>::SHAPE;
        let weak_def = weak_shape
            .def
            .into_smart_pointer()
            .expect("ArcWeak<T> should have a smart pointer definition");

        // 1. Create the first Arc (arc1)
        let arc1_uninit_ptr = arc_shape.allocate()?;
        let new_into_fn = arc_def.vtable.new_into_fn.unwrap();
        let mut value = String::from("example");
        let arc1_ptr = unsafe { new_into_fn(arc1_uninit_ptr, PtrMut::new(&raw mut value)) };
        core::mem::forget(value); // Value now owned by arc1

        // 2. Downgrade arc1 to create a weak pointer (weak1)
        let weak1_uninit_ptr = weak_shape.allocate()?;
        let downgrade_into_fn = arc_def.vtable.downgrade_into_fn.unwrap();
        // SAFETY: arc1_ptr points to a valid Arc, weak1_uninit_ptr is allocated for a Weak
        let weak1_ptr = unsafe { downgrade_into_fn(arc1_ptr, weak1_uninit_ptr) };

        // 3. Upgrade weak1 to create a second Arc (arc2)
        let arc2_uninit_ptr = arc_shape.allocate()?;
        let upgrade_into_fn = weak_def.vtable.upgrade_into_fn.unwrap();
        // SAFETY: weak1_ptr points to a valid Weak, arc2_uninit_ptr is allocated for an Arc.
        // Upgrade should succeed as arc1 still exists.
        let arc2_ptr = unsafe { upgrade_into_fn(weak1_ptr, arc2_uninit_ptr) }
            .expect("Upgrade should succeed while original Arc exists");

        // Check the content of the upgraded Arc
        let borrow_fn = arc_def.vtable.borrow_fn.unwrap();
        // SAFETY: arc2_ptr points to a valid Arc<String>
        let borrowed_ptr = unsafe { borrow_fn(arc2_ptr.as_const()) };
        // SAFETY: borrowed_ptr points to a valid String
        assert_eq!(unsafe { borrowed_ptr.get::<String>() }, "example");

        // 4. Drop everything and free memory
        let arc_drop_fn = (arc_shape.vtable.drop_in_place)().unwrap();
        let weak_drop_fn = (weak_shape.vtable.drop_in_place)().unwrap();

        unsafe {
            // Drop Arcs
            arc_drop_fn(arc1_ptr);
            arc_shape.deallocate_mut(arc1_ptr)?;
            arc_drop_fn(arc2_ptr);
            arc_shape.deallocate_mut(arc2_ptr)?;

            // Drop Weak
            weak_drop_fn(weak1_ptr);
            weak_shape.deallocate_mut(weak1_ptr)?;
        }

        Ok(())
    }

    #[test]
    fn test_arc_vtable_3_downgrade_drop_try_upgrade() -> eyre::Result<()> {
        facet_testhelpers::setup();

        let arc_shape = <Arc<String>>::SHAPE;
        let arc_def = arc_shape
            .def
            .into_smart_pointer()
            .expect("Arc<T> should have a smart pointer definition");

        let weak_shape = <ArcWeak<String>>::SHAPE;
        let weak_def = weak_shape
            .def
            .into_smart_pointer()
            .expect("ArcWeak<T> should have a smart pointer definition");

        // 1. Create the strong Arc (arc1)
        let arc1_uninit_ptr = arc_shape.allocate()?;
        let new_into_fn = arc_def.vtable.new_into_fn.unwrap();
        let mut value = String::from("example");
        let arc1_ptr = unsafe { new_into_fn(arc1_uninit_ptr, PtrMut::new(&raw mut value)) };
        core::mem::forget(value);

        // 2. Downgrade arc1 to create a weak pointer (weak1)
        let weak1_uninit_ptr = weak_shape.allocate()?;
        let downgrade_into_fn = arc_def.vtable.downgrade_into_fn.unwrap();
        // SAFETY: arc1_ptr is valid, weak1_uninit_ptr is allocated for Weak
        let weak1_ptr = unsafe { downgrade_into_fn(arc1_ptr, weak1_uninit_ptr) };

        // 3. Drop and free the strong pointer (arc1)
        let arc_drop_fn = (arc_shape.vtable.drop_in_place)().unwrap();
        unsafe {
            arc_drop_fn(arc1_ptr);
            arc_shape.deallocate_mut(arc1_ptr)?;
        }

        // 4. Attempt to upgrade the weak pointer (weak1)
        let upgrade_into_fn = weak_def.vtable.upgrade_into_fn.unwrap();
        let arc2_uninit_ptr = arc_shape.allocate()?;
        // SAFETY: weak1_ptr is valid (though points to dropped data), arc2_uninit_ptr is allocated for Arc
        let upgrade_result = unsafe { upgrade_into_fn(weak1_ptr, arc2_uninit_ptr) };

        // Assert that the upgrade failed
        assert!(
            upgrade_result.is_none(),
            "Upgrade should fail after the strong Arc is dropped"
        );

        // 5. Clean up: Deallocate the memory intended for the failed upgrade and drop/deallocate the weak pointer
        let weak_drop_fn = (weak_shape.vtable.drop_in_place)().unwrap();
        unsafe {
            // Deallocate the *uninitialized* memory allocated for the failed upgrade attempt
            arc_shape.deallocate_uninit(arc2_uninit_ptr)?;

            // Drop and deallocate the weak pointer
            weak_drop_fn(weak1_ptr);
            weak_shape.deallocate_mut(weak1_ptr)?;
        }

        Ok(())
    }

    #[test]
    fn test_arc_vtable_4_try_from() -> eyre::Result<()> {
        facet_testhelpers::setup();

        // Get the shapes we'll be working with
        let string_shape = <String>::SHAPE;
        let arc_shape = <Arc<String>>::SHAPE;
        let arc_def = arc_shape
            .def
            .into_smart_pointer()
            .expect("Arc<T> should have a smart pointer definition");

        // 1. Create a String value
        let value = String::from("try_from test");
        let value_ptr = PtrConst::new(&value as *const String as *const u8);

        // 2. Allocate memory for the Arc<String>
        let arc_uninit_ptr = arc_shape.allocate()?;

        // 3. Get the try_from function from the Arc<String> shape's ValueVTable
        let try_from_fn = (arc_shape.vtable.try_from)().expect("Arc<T> should have try_from");

        // 4. Try to convert String to Arc<String>
        let arc_ptr = unsafe { try_from_fn(value_ptr, string_shape, arc_uninit_ptr) }
            .expect("try_from should succeed");
        core::mem::forget(value);

        // 5. Borrow the inner value and verify it's correct
        let borrow_fn = arc_def
            .vtable
            .borrow_fn
            .expect("Arc<T> should have borrow_fn");
        let borrowed_ptr = unsafe { borrow_fn(arc_ptr.as_const()) };

        // SAFETY: borrowed_ptr points to a valid String within the Arc
        assert_eq!(unsafe { borrowed_ptr.get::<String>() }, "try_from test");

        // 6. Clean up
        let drop_fn = (arc_shape.vtable.drop_in_place)().expect("Arc<T> should have drop_in_place");

        unsafe {
            drop_fn(arc_ptr);
            arc_shape.deallocate_mut(arc_ptr)?;
        }

        Ok(())
    }

    #[test]
    fn test_arc_vtable_5_try_into_inner() -> eyre::Result<()> {
        facet_testhelpers::setup();

        // Get the shapes we'll be working with
        let string_shape = <String>::SHAPE;
        let arc_shape = <Arc<String>>::SHAPE;
        let arc_def = arc_shape
            .def
            .into_smart_pointer()
            .expect("Arc<T> should have a smart pointer definition");

        // 1. Create an Arc<String>
        let arc_uninit_ptr = arc_shape.allocate()?;
        let new_into_fn = arc_def
            .vtable
            .new_into_fn
            .expect("Arc<T> should have new_into_fn");

        let mut value = String::from("try_into_inner test");
        let arc_ptr = unsafe { new_into_fn(arc_uninit_ptr, PtrMut::new(&raw mut value)) };
        core::mem::forget(value); // Value now owned by arc

        // 2. Allocate memory for the extracted String
        let string_uninit_ptr = string_shape.allocate()?;

        // 3. Get the try_into_inner function from the Arc<String>'s ValueVTable
        let try_into_inner_fn =
            (arc_shape.vtable.try_into_inner)().expect("Arc<T> Shape should have try_into_inner");

        // 4. Try to extract the String from the Arc<String>
        // This should succeed because we have exclusive access to the Arc (strong count = 1)
        let string_ptr = unsafe { try_into_inner_fn(arc_ptr, string_uninit_ptr) }
            .expect("try_into_inner should succeed with exclusive access");

        // 5. Verify the extracted String
        assert_eq!(
            unsafe { string_ptr.as_const().get::<String>() },
            "try_into_inner test"
        );

        // 6. Clean up
        let string_drop_fn =
            (string_shape.vtable.drop_in_place)().expect("String should have drop_in_place");

        unsafe {
            // The Arc should already be dropped by try_into_inner
            // But we still need to deallocate its memory
            arc_shape.deallocate_mut(arc_ptr)?;

            // Drop and deallocate the extracted String
            string_drop_fn(string_ptr);
            string_shape.deallocate_mut(string_ptr)?;
        }

        Ok(())
    }
}

1	use crate::{
2	Def, Facet, KnownSmartPointer, PtrConst, PtrMut, PtrUninit, Shape, SmartPointerDef,
3	SmartPointerFlags, SmartPointerVTable, TryBorrowInnerError, TryFromError, TryIntoInnerError,
4	Type, UserType, ValueVTable, value_vtable,
5	};
6
7	unsafe impl<'a, T: Facet<'a>> Facet<'a> for alloc::sync::Arc<T> {
8	const VTABLE: &'static ValueVTable = &const {
9	// Define the functions for transparent conversion between Arc<T> and T
10	unsafe fn try_from<'a, 'shape, 'src, 'dst, T: Facet<'a>>(	1✔
11	src_ptr: PtrConst<'src>,	1✔
12	src_shape: &'shape Shape<'shape>,	1✔
13	dst: PtrUninit<'dst>,	1✔
14	) -> Result<PtrMut<'dst>, TryFromError<'shape>> {	1✔
15	if src_shape.id != T::SHAPE.id {	1✔
UNCOV 16	return Err(TryFromError::UnsupportedSourceShape {	×
UNCOV 17	src_shape,	×
18	expected: &[T::SHAPE],	×
19	});	×
20	}	1✔
21	let t = unsafe { src_ptr.read::<T>() };	1✔
22	let arc = alloc::sync::Arc::new(t);	1✔
23	Ok(unsafe { dst.put(arc) })	1✔
24	}	1✔
25
26	unsafe fn try_into_inner<'a, 'src, 'dst, T: Facet<'a>>(	1✔
27	src_ptr: PtrMut<'src>,	1✔
28	dst: PtrUninit<'dst>,	1✔
29	) -> Result<PtrMut<'dst>, TryIntoInnerError> {	1✔
30	use alloc::sync::Arc;
31
32	// Read the Arc from the source pointer
33	let arc = unsafe { src_ptr.read::<Arc<T>>() };	1✔
34
35	// Try to unwrap the Arc to get exclusive ownership
36	match Arc::try_unwrap(arc) {	1✔
37	Ok(inner) => Ok(unsafe { dst.put(inner) }),	1✔
UNCOV 38	Err(arc) => {	×
39	// Arc is shared, so we can't extract the inner value
UNCOV 40	core::mem::forget(arc);	×
UNCOV 41	Err(TryIntoInnerError::Unavailable)	×
42	}
43	}
44	}	1✔
45
UNCOV 46	unsafe fn try_borrow_inner<'a, 'src, T: Facet<'a>>(	×
UNCOV 47	src_ptr: PtrConst<'src>,	×
UNCOV 48	) -> Result<PtrConst<'src>, TryBorrowInnerError> {	×
UNCOV 49	let arc = unsafe { src_ptr.get::<alloc::sync::Arc<T>>() };	×
UNCOV 50	Ok(PtrConst::new(&**arc))	×
UNCOV 51	}	×
52
53	let mut vtable = value_vtable!(alloc::sync::Arc<T>, \|f, opts\| {	12✔
54	write!(f, "{}", Self::SHAPE.type_identifier)?;	12✔
55	if let Some(opts) = opts.for_children() {	12✔
56	write!(f, "<")?;	12✔
57	(T::SHAPE.vtable.type_name)(f, opts)?;	12✔
58	write!(f, ">")?;	12✔
59	} else {
UNCOV 60	write!(f, "<…>")?;	×
61	}
62	Ok(())	12✔
63	});	12✔
64
65	vtable.try_from = \|\| Some(try_from::<T>);	1✔
66	vtable.try_into_inner = \|\| Some(try_into_inner::<T>);	1✔
UNCOV 67	vtable.try_borrow_inner = \|\| Some(try_borrow_inner::<T>);	×
68	vtable
69	};
70
71	const SHAPE: &'static crate::Shape<'static> = &const {
72	// Function to return inner type's shape
UNCOV 73	fn inner_shape<'a, T: Facet<'a>>() -> &'static Shape<'static> {	×
UNCOV 74	T::SHAPE	×
UNCOV 75	}	×
76
77	crate::Shape::builder_for_sized::<Self>()
78	.type_identifier("Arc")
79	.type_params(&[crate::TypeParam {
80	name: "T",
81	shape: \|\| T::SHAPE,
82	}])
83	.ty(Type::User(UserType::Opaque))
84	.def(Def::SmartPointer(
85	SmartPointerDef::builder()
86	.pointee(\|\| T::SHAPE)
87	.flags(SmartPointerFlags::ATOMIC)
88	.known(KnownSmartPointer::Arc)
89	.weak(\|\| <alloc::sync::Weak<T> as Facet>::SHAPE)
90	.vtable(
91	&const {
92	SmartPointerVTable::builder()
93	.borrow_fn(\|this\| {	3✔
94	let arc_ptr = unsafe { this.as_ptr::<alloc::sync::Arc<T>>() };	3✔
95	let ptr = unsafe { alloc::sync::Arc::as_ptr(&*arc_ptr) };	3✔
96	PtrConst::new(ptr)	3✔
97	})	3✔
98	.new_into_fn(\|this, ptr\| {	10✔
99	let t = unsafe { ptr.read::<T>() };	10✔
100	let arc = alloc::sync::Arc::new(t);	10✔
101	unsafe { this.put(arc) }	10✔
102	})	10✔
103	.downgrade_into_fn(\|strong, weak\| unsafe {
104	weak.put(alloc::sync::Arc::downgrade(strong.get::<Self>()))	2✔
105	})	2✔
106	.build()
107	},
108	)
109	.build(),
110	))
111	.inner(inner_shape::<T>)
112	.build()
113	};
114	}
115
116	unsafe impl<'a, T: Facet<'a>> Facet<'a> for alloc::sync::Weak<T> {
117	const VTABLE: &'static ValueVTable = &const {
UNCOV 118	value_vtable!(alloc::sync::Weak<T>, \|f, opts\| {	×
UNCOV 119	write!(f, "{}", Self::SHAPE.type_identifier)?;	×
UNCOV 120	if let Some(opts) = opts.for_children() {	×
UNCOV 121	write!(f, "<")?;	×
UNCOV 122	(T::SHAPE.vtable.type_name)(f, opts)?;	×
UNCOV 123	write!(f, ">")?;	×
124	} else {
UNCOV 125	write!(f, "<…>")?;	×
126	}
127	Ok(())	×
128	})	×
129	};
130
131	const SHAPE: &'static crate::Shape<'static> = &const {
132	// Function to return inner type's shape
133	fn inner_shape<'a, T: Facet<'a>>() -> &'static Shape<'static> {	×
134	T::SHAPE	×
135	}	×
136
137	crate::Shape::builder_for_sized::<Self>()
138	.type_identifier("Weak")
139	.type_params(&[crate::TypeParam {
140	name: "T",
141	shape: \|\| T::SHAPE,
142	}])
143	.ty(Type::User(UserType::Opaque))
144	.def(Def::SmartPointer(
145	SmartPointerDef::builder()
146	.pointee(\|\| T::SHAPE)
147	.flags(SmartPointerFlags::ATOMIC.union(SmartPointerFlags::WEAK))
148	.known(KnownSmartPointer::ArcWeak)
149	.strong(\|\| <alloc::sync::Arc<T> as Facet>::SHAPE)
150	.vtable(
151	&const {
152	SmartPointerVTable::builder()
153	.upgrade_into_fn(\|weak, strong\| unsafe {
154	Some(strong.put(weak.get::<Self>().upgrade()?))	2✔
155	})	2✔
156	.build()
157	},
158	)
159	.build(),
160	))
161	.inner(inner_shape::<T>)
162	.build()
163	};
164	}
165
166	#[cfg(test)]
167	mod tests {
168	use alloc::string::String;
169	use alloc::sync::{Arc, Weak as ArcWeak};
170
171	use super::*;
172
173	#[test]
174	fn test_arc_type_params() {	1✔
175	let [type_param_1] = <Arc<i32>>::SHAPE.type_params else {	1✔
UNCOV 176	panic!("Arc<T> should only have 1 type param")	×
177	};
178	assert_eq!(type_param_1.shape(), i32::SHAPE);	1✔
179	}	1✔
180
181	#[test]
182	fn test_arc_vtable_1_new_borrow_drop() -> eyre::Result<()> {	1✔
183	facet_testhelpers::setup();	1✔
184
185	let arc_shape = <Arc<String>>::SHAPE;	1✔
186	let arc_def = arc_shape	1✔
187	.def	1✔
188	.into_smart_pointer()	1✔
189	.expect("Arc<T> should have a smart pointer definition");	1✔
190
191	// Allocate memory for the Arc
192	let arc_uninit_ptr = arc_shape.allocate()?;	1✔
193
194	// Get the function pointer for creating a new Arc from a value
195	let new_into_fn = arc_def	1✔
196	.vtable	1✔
197	.new_into_fn	1✔
198	.expect("Arc<T> should have new_into_fn");	1✔
199
200	// Create the value and initialize the Arc
201	let mut value = String::from("example");	1✔
202	let arc_ptr = unsafe { new_into_fn(arc_uninit_ptr, PtrMut::new(&raw mut value)) };	1✔
203	// The value now belongs to the Arc, prevent its drop
204	core::mem::forget(value);	1✔
205
206	// Get the function pointer for borrowing the inner value
207	let borrow_fn = arc_def	1✔
208	.vtable	1✔
209	.borrow_fn	1✔
210	.expect("Arc<T> should have borrow_fn");	1✔
211
212	// Borrow the inner value and check it
213	let borrowed_ptr = unsafe { borrow_fn(arc_ptr.as_const()) };	1✔
214	// SAFETY: borrowed_ptr points to a valid String within the Arc
215	assert_eq!(unsafe { borrowed_ptr.get::<String>() }, "example");	1✔
216
217	// Get the function pointer for dropping the Arc
218	let drop_fn = (arc_shape.vtable.drop_in_place)().expect("Arc<T> should have drop_in_place");	1✔
219
220	// Drop the Arc in place
221	// SAFETY: arc_ptr points to a valid Arc<String>
222	unsafe { drop_fn(arc_ptr) };	1✔
223
224	// Deallocate the memory
225	// SAFETY: arc_ptr was allocated by arc_shape and is now dropped (but memory is still valid)
226	unsafe { arc_shape.deallocate_mut(arc_ptr)? };	1✔
227
228	Ok(())	1✔
229	}	1✔
230
231	#[test]
232	fn test_arc_vtable_2_downgrade_upgrade_drop() -> eyre::Result<()> {	1✔
233	facet_testhelpers::setup();	1✔
234
235	let arc_shape = <Arc<String>>::SHAPE;	1✔
236	let arc_def = arc_shape	1✔
237	.def	1✔
238	.into_smart_pointer()	1✔
239	.expect("Arc<T> should have a smart pointer definition");	1✔
240
241	let weak_shape = <ArcWeak<String>>::SHAPE;	1✔
242	let weak_def = weak_shape	1✔
243	.def	1✔
244	.into_smart_pointer()	1✔
245	.expect("ArcWeak<T> should have a smart pointer definition");	1✔
246
247	// 1. Create the first Arc (arc1)
248	let arc1_uninit_ptr = arc_shape.allocate()?;	1✔
249	let new_into_fn = arc_def.vtable.new_into_fn.unwrap();	1✔
250	let mut value = String::from("example");	1✔
251	let arc1_ptr = unsafe { new_into_fn(arc1_uninit_ptr, PtrMut::new(&raw mut value)) };	1✔
252	core::mem::forget(value); // Value now owned by arc1	1✔
253
254	// 2. Downgrade arc1 to create a weak pointer (weak1)
255	let weak1_uninit_ptr = weak_shape.allocate()?;	1✔
256	let downgrade_into_fn = arc_def.vtable.downgrade_into_fn.unwrap();	1✔
257	// SAFETY: arc1_ptr points to a valid Arc, weak1_uninit_ptr is allocated for a Weak
258	let weak1_ptr = unsafe { downgrade_into_fn(arc1_ptr, weak1_uninit_ptr) };	1✔
259
260	// 3. Upgrade weak1 to create a second Arc (arc2)
261	let arc2_uninit_ptr = arc_shape.allocate()?;	1✔
262	let upgrade_into_fn = weak_def.vtable.upgrade_into_fn.unwrap();	1✔
263	// SAFETY: weak1_ptr points to a valid Weak, arc2_uninit_ptr is allocated for an Arc.
264	// Upgrade should succeed as arc1 still exists.
265	let arc2_ptr = unsafe { upgrade_into_fn(weak1_ptr, arc2_uninit_ptr) }	1✔
266	.expect("Upgrade should succeed while original Arc exists");	1✔
267
268	// Check the content of the upgraded Arc
269	let borrow_fn = arc_def.vtable.borrow_fn.unwrap();	1✔
270	// SAFETY: arc2_ptr points to a valid Arc<String>
271	let borrowed_ptr = unsafe { borrow_fn(arc2_ptr.as_const()) };	1✔
272	// SAFETY: borrowed_ptr points to a valid String
273	assert_eq!(unsafe { borrowed_ptr.get::<String>() }, "example");	1✔
274
275	// 4. Drop everything and free memory
276	let arc_drop_fn = (arc_shape.vtable.drop_in_place)().unwrap();	1✔
277	let weak_drop_fn = (weak_shape.vtable.drop_in_place)().unwrap();	1✔
278
279	unsafe {
280	// Drop Arcs
281	arc_drop_fn(arc1_ptr);	1✔
282	arc_shape.deallocate_mut(arc1_ptr)?;	1✔
283	arc_drop_fn(arc2_ptr);	1✔
284	arc_shape.deallocate_mut(arc2_ptr)?;	1✔
285
286	// Drop Weak
287	weak_drop_fn(weak1_ptr);	1✔
288	weak_shape.deallocate_mut(weak1_ptr)?;	1✔
289	}
290
291	Ok(())	1✔
292	}	1✔
293
294	#[test]
295	fn test_arc_vtable_3_downgrade_drop_try_upgrade() -> eyre::Result<()> {	1✔
296	facet_testhelpers::setup();	1✔
297
298	let arc_shape = <Arc<String>>::SHAPE;	1✔
299	let arc_def = arc_shape	1✔
300	.def	1✔
301	.into_smart_pointer()	1✔
302	.expect("Arc<T> should have a smart pointer definition");	1✔
303
304	let weak_shape = <ArcWeak<String>>::SHAPE;	1✔
305	let weak_def = weak_shape	1✔
306	.def	1✔
307	.into_smart_pointer()	1✔
308	.expect("ArcWeak<T> should have a smart pointer definition");	1✔
309
310	// 1. Create the strong Arc (arc1)
311	let arc1_uninit_ptr = arc_shape.allocate()?;	1✔
312	let new_into_fn = arc_def.vtable.new_into_fn.unwrap();	1✔
313	let mut value = String::from("example");	1✔
314	let arc1_ptr = unsafe { new_into_fn(arc1_uninit_ptr, PtrMut::new(&raw mut value)) };	1✔
315	core::mem::forget(value);	1✔
316
317	// 2. Downgrade arc1 to create a weak pointer (weak1)
318	let weak1_uninit_ptr = weak_shape.allocate()?;	1✔
319	let downgrade_into_fn = arc_def.vtable.downgrade_into_fn.unwrap();	1✔
320	// SAFETY: arc1_ptr is valid, weak1_uninit_ptr is allocated for Weak
321	let weak1_ptr = unsafe { downgrade_into_fn(arc1_ptr, weak1_uninit_ptr) };	1✔
322
323	// 3. Drop and free the strong pointer (arc1)
324	let arc_drop_fn = (arc_shape.vtable.drop_in_place)().unwrap();	1✔
325	unsafe {
326	arc_drop_fn(arc1_ptr);	1✔
327	arc_shape.deallocate_mut(arc1_ptr)?;	1✔
328	}
329
330	// 4. Attempt to upgrade the weak pointer (weak1)
331	let upgrade_into_fn = weak_def.vtable.upgrade_into_fn.unwrap();	1✔
332	let arc2_uninit_ptr = arc_shape.allocate()?;	1✔
333	// SAFETY: weak1_ptr is valid (though points to dropped data), arc2_uninit_ptr is allocated for Arc
334	let upgrade_result = unsafe { upgrade_into_fn(weak1_ptr, arc2_uninit_ptr) };	1✔
335
336	// Assert that the upgrade failed
337	assert!(	1✔
338	upgrade_result.is_none(),	1✔
UNCOV 339	"Upgrade should fail after the strong Arc is dropped"	×
340	);
341
342	// 5. Clean up: Deallocate the memory intended for the failed upgrade and drop/deallocate the weak pointer
343	let weak_drop_fn = (weak_shape.vtable.drop_in_place)().unwrap();	1✔
344	unsafe {
345	// Deallocate the uninitialized memory allocated for the failed upgrade attempt
346	arc_shape.deallocate_uninit(arc2_uninit_ptr)?;	1✔
347
348	// Drop and deallocate the weak pointer
349	weak_drop_fn(weak1_ptr);	1✔
350	weak_shape.deallocate_mut(weak1_ptr)?;	1✔
351	}
352
353	Ok(())	1✔
354	}	1✔
355
356	#[test]
357	fn test_arc_vtable_4_try_from() -> eyre::Result<()> {	1✔
358	facet_testhelpers::setup();	1✔
359
360	// Get the shapes we'll be working with
361	let string_shape = <String>::SHAPE;	1✔
362	let arc_shape = <Arc<String>>::SHAPE;	1✔
363	let arc_def = arc_shape	1✔
364	.def	1✔
365	.into_smart_pointer()	1✔
366	.expect("Arc<T> should have a smart pointer definition");	1✔
367
368	// 1. Create a String value
369	let value = String::from("try_from test");	1✔
370	let value_ptr = PtrConst::new(&value as const String as const u8);	1✔
371
372	// 2. Allocate memory for the Arc<String>
373	let arc_uninit_ptr = arc_shape.allocate()?;	1✔
374
375	// 3. Get the try_from function from the Arc<String> shape's ValueVTable
376	let try_from_fn = (arc_shape.vtable.try_from)().expect("Arc<T> should have try_from");	1✔
377
378	// 4. Try to convert String to Arc<String>
379	let arc_ptr = unsafe { try_from_fn(value_ptr, string_shape, arc_uninit_ptr) }	1✔
380	.expect("try_from should succeed");	1✔
381	core::mem::forget(value);	1✔
382
383	// 5. Borrow the inner value and verify it's correct
384	let borrow_fn = arc_def	1✔
385	.vtable	1✔
386	.borrow_fn	1✔
387	.expect("Arc<T> should have borrow_fn");	1✔
388	let borrowed_ptr = unsafe { borrow_fn(arc_ptr.as_const()) };	1✔
389
390	// SAFETY: borrowed_ptr points to a valid String within the Arc
391	assert_eq!(unsafe { borrowed_ptr.get::<String>() }, "try_from test");	1✔
392
393	// 6. Clean up
394	let drop_fn = (arc_shape.vtable.drop_in_place)().expect("Arc<T> should have drop_in_place");	1✔
395
396	unsafe {
397	drop_fn(arc_ptr);	1✔
398	arc_shape.deallocate_mut(arc_ptr)?;	1✔
399	}
400
401	Ok(())	1✔
402	}	1✔
403
404	#[test]
405	fn test_arc_vtable_5_try_into_inner() -> eyre::Result<()> {	1✔
406	facet_testhelpers::setup();	1✔
407
408	// Get the shapes we'll be working with
409	let string_shape = <String>::SHAPE;	1✔
410	let arc_shape = <Arc<String>>::SHAPE;	1✔
411	let arc_def = arc_shape	1✔
412	.def	1✔
413	.into_smart_pointer()	1✔
414	.expect("Arc<T> should have a smart pointer definition");	1✔
415
416	// 1. Create an Arc<String>
417	let arc_uninit_ptr = arc_shape.allocate()?;	1✔
418	let new_into_fn = arc_def	1✔
419	.vtable	1✔
420	.new_into_fn	1✔
421	.expect("Arc<T> should have new_into_fn");	1✔
422
423	let mut value = String::from("try_into_inner test");	1✔
424	let arc_ptr = unsafe { new_into_fn(arc_uninit_ptr, PtrMut::new(&raw mut value)) };	1✔
425	core::mem::forget(value); // Value now owned by arc	1✔
426
427	// 2. Allocate memory for the extracted String
428	let string_uninit_ptr = string_shape.allocate()?;	1✔
429
430	// 3. Get the try_into_inner function from the Arc<String>'s ValueVTable
431	let try_into_inner_fn =	1✔
432	(arc_shape.vtable.try_into_inner)().expect("Arc<T> Shape should have try_into_inner");	1✔
433
434	// 4. Try to extract the String from the Arc<String>
435	// This should succeed because we have exclusive access to the Arc (strong count = 1)
436	let string_ptr = unsafe { try_into_inner_fn(arc_ptr, string_uninit_ptr) }	1✔
437	.expect("try_into_inner should succeed with exclusive access");	1✔
438
439	// 5. Verify the extracted String
440	assert_eq!(	1✔
441	unsafe { string_ptr.as_const().get::<String>() },	1✔
442	"try_into_inner test"
443	);
444
445	// 6. Clean up
446	let string_drop_fn =	1✔
447	(string_shape.vtable.drop_in_place)().expect("String should have drop_in_place");	1✔
448
449	unsafe {
450	// The Arc should already be dropped by try_into_inner
451	// But we still need to deallocate its memory
452	arc_shape.deallocate_mut(arc_ptr)?;	1✔
453
454	// Drop and deallocate the extracted String
455	string_drop_fn(string_ptr);	1✔
456	string_shape.deallocate_mut(string_ptr)?;	1✔
457	}
458
459	Ok(())	1✔
460	}	1✔
461	}

facet-rs / facet / 15376944042

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous