alex/ash
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

generator: Work around invariance for assigning mutable pointer of lifetimed slice (#841)

Browse source 
In essence this builder function needs to adhere to two rules:
1. No ref-after-free: the slice must outlive (uses of) the builder
   object;
2. No aliasing: the slice cannot be (im)mutably used while it is mutably
   borrowed within a live builder object.

These two rules have been tested and are satisfied by the given builder
implementation.  Without this change `timings` seems to be borrowing
itself, hence is not allowed to be used after it has been temporarily
mutably borrowed inside the builder, even after that builder was
dropped.  Thus defeating the purpose of this "getter" API via a struct.

Without the `.cast()`, because mutable raw pointers are invariant
(i.e. there is no subtyping relationship) the compiler complains about
requiring `self` to outlive `timings` instead, which does not satisfy
the two rules above.
This commit is contained in:
Marijn Suijten 2023-12-02 19:52:35 +01:00 committed by GitHub
parent 4e99de1cbb
commit e5b08732db
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
ash/src/vk/definitions.rs
View file

@ -52045,9 +52045,9 @@ unsafe impl<'a> TaggedStructure for GetLatencyMarkerInfoNV<'a> {
}
impl<'a> GetLatencyMarkerInfoNV<'a> {
#[inline]
pub fn timings(mut self, timings: &'a mut [LatencyTimingsFrameReportNV<'a>]) -> Self {
pub fn timings(mut self, timings: &'a mut [LatencyTimingsFrameReportNV<'_>]) -> Self {
self.timing_count = timings.len() as _;
self.p_timings = timings.as_mut_ptr();
self.p_timings = timings.as_mut_ptr().cast();
self
}
}

12
generator/src/lib.rs
View file

@ -1929,7 +1929,7 @@ fn derive_setters(
let deprecated = member.deprecated.as_ref().map(|d| quote!(#d #[allow(deprecated)]));
let param_ident = field.param_ident();
let type_lifetime = has_lifetimes
let mut type_lifetime = has_lifetimes
.contains(&name_to_tokens(&field.basetype))
.then(|| quote!(<'a>));
let param_ty_tokens = field.safe_type_tokens(quote!('a), type_lifetime.clone(), None);
@ -2018,14 +2018,20 @@ fn derive_setters(
// TODO: Improve in future when https://github.com/rust-lang/rust/issues/53667 is merged id:6
if field.reference.is_some() && matches!(field.array, Some(vkxml::ArrayType::Dynamic)) {
if let Some(ref array_size) = field.size {
let mut slice_param_ty_tokens = field.safe_type_tokens(quote!('a), type_lifetime.clone(), None);
let mut ptr = if field.is_const {
quote!(.as_ptr())
} else if let Some(tl) = &mut type_lifetime {
// Work around invariance with mutable pointers:
// https://github.com/ash-rs/ash/issues/837
// https://doc.rust-lang.org/nomicon/subtyping.html#variance
*tl = quote!(<'_>);
quote!(.as_mut_ptr().cast())
} else {
quote!(.as_mut_ptr())
};
let mut slice_param_ty_tokens = field.safe_type_tokens(quote!('a), type_lifetime.clone(), None);
// Interpret void array as byte array
if field.basetype == "void" && matches!(field.reference, Some(vkxml::ReferenceType::Pointer)) {
slice_param_ty_tokens = quote!([u8]);