1 use super::{truncate_i32_to_i16, truncate_i32_to_i8}; 2 use crate::{ 3 prelude::*, 4 runtime::vm::{GcHeap, GcStore, VMGcRef}, 5 store::{AutoAssertNoGc, StoreOpaque}, 6 vm::{FuncRefTableId, SendSyncPtr}, 7 AnyRef, ExternRef, Func, HeapType, RootedGcRefImpl, StorageType, Val, ValType, 8 }; 9 use core::fmt; 10 use wasmtime_environ::{GcArrayLayout, VMGcKind}; 11 12 /// A `VMGcRef` that we know points to a `array`. 13 /// 14 /// Create a `VMArrayRef` via `VMGcRef::into_arrayref` and 15 /// `VMGcRef::as_arrayref`, or their untyped equivalents 16 /// `VMGcRef::into_arrayref_unchecked` and `VMGcRef::as_arrayref_unchecked`. 17 /// 18 /// Note: This is not a `TypedGcRef<_>` because each collector can have a 19 /// different concrete representation of `arrayref` that they allocate inside 20 /// their heaps. 21 #[derive(Debug, PartialEq, Eq, Hash)] 22 #[repr(transparent)] 23 pub struct VMArrayRef(VMGcRef); 24 25 impl fmt::Pointer for VMArrayRef { 26 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { 27 fmt::Pointer::fmt(&self.0, f) 28 } 29 } 30 31 impl From<VMArrayRef> for VMGcRef { 32 #[inline] 33 fn from(x: VMArrayRef) -> Self { 34 x.0 35 } 36 } 37 38 impl VMGcRef { 39 /// Is this `VMGcRef` pointing to a `array`? 40 pub fn is_arrayref(&self, gc_heap: &(impl GcHeap + ?Sized)) -> bool { 41 if self.is_i31() { 42 return false; 43 } 44 45 let header = gc_heap.header(&self); 46 header.kind().matches(VMGcKind::ArrayRef) 47 } 48 49 /// Create a new `VMArrayRef` from the given `gc_ref`. 50 /// 51 /// If this is not a GC reference to an `arrayref`, `Err(self)` is 52 /// returned. 53 pub fn into_arrayref(self, gc_heap: &(impl GcHeap + ?Sized)) -> Result<VMArrayRef, VMGcRef> { 54 if self.is_arrayref(gc_heap) { 55 Ok(self.into_arrayref_unchecked()) 56 } else { 57 Err(self) 58 } 59 } 60 61 /// Create a new `VMArrayRef` from `self` without actually checking that 62 /// `self` is an `arrayref`. 63 /// 64 /// This method does not check that `self` is actually an `arrayref`, but 65 /// it should be. Failure to uphold this invariant is memory safe but will 66 /// result in general incorrectness down the line such as panics or wrong 67 /// results. 68 #[inline] 69 pub fn into_arrayref_unchecked(self) -> VMArrayRef { 70 debug_assert!(!self.is_i31()); 71 VMArrayRef(self) 72 } 73 74 /// Get this GC reference as an `arrayref` reference, if it actually is an 75 /// `arrayref` reference. 76 pub fn as_arrayref(&self, gc_heap: &(impl GcHeap + ?Sized)) -> Option<&VMArrayRef> { 77 if self.is_arrayref(gc_heap) { 78 Some(self.as_arrayref_unchecked()) 79 } else { 80 None 81 } 82 } 83 84 /// Get this GC reference as an `arrayref` reference without checking if it 85 /// actually is an `arrayref` reference. 86 /// 87 /// Calling this method on a non-`arrayref` reference is memory safe, but 88 /// will lead to general incorrectness like panics and wrong results. 89 pub fn as_arrayref_unchecked(&self) -> &VMArrayRef { 90 debug_assert!(!self.is_i31()); 91 let ptr = self as *const VMGcRef; 92 let ret = unsafe { &*ptr.cast() }; 93 assert!(matches!(ret, VMArrayRef(VMGcRef { .. }))); 94 ret 95 } 96 } 97 98 impl VMArrayRef { 99 /// Get the underlying `VMGcRef`. 100 pub fn as_gc_ref(&self) -> &VMGcRef { 101 &self.0 102 } 103 104 /// Clone this `VMArrayRef`, running any GC barriers as necessary. 105 pub fn clone(&self, gc_store: &mut GcStore) -> Self { 106 Self(gc_store.clone_gc_ref(&self.0)) 107 } 108 109 /// Explicitly drop this `arrayref`, running GC drop barriers as necessary. 110 pub fn drop(self, gc_store: &mut GcStore) { 111 gc_store.drop_gc_ref(self.0); 112 } 113 114 /// Copy this `VMArrayRef` without running the GC's clone barriers. 115 /// 116 /// Prefer calling `clone(&mut GcStore)` instead! This is mostly an internal 117 /// escape hatch for collector implementations. 118 /// 119 /// Failure to run GC barriers when they would otherwise be necessary can 120 /// lead to leaks, panics, and wrong results. It cannot lead to memory 121 /// unsafety, however. 122 pub fn unchecked_copy(&self) -> Self { 123 Self(self.0.unchecked_copy()) 124 } 125 126 /// Get the length of this array. 127 pub fn len(&self, store: &StoreOpaque) -> u32 { 128 store.unwrap_gc_store().array_len(self) 129 } 130 131 /// Read an element of the given `StorageType` into a `Val`. 132 /// 133 /// `i8` and `i16` fields are zero-extended into `Val::I32(_)`s. 134 /// 135 /// Does not check that this array's elements are actually of type 136 /// `ty`. That is the caller's responsibility. Failure to do so is memory 137 /// safe, but will lead to general incorrectness such as panics and wrong 138 /// results. 139 /// 140 /// Panics on out-of-bounds accesses. 141 pub fn read_elem( 142 &self, 143 store: &mut AutoAssertNoGc, 144 layout: &GcArrayLayout, 145 ty: &StorageType, 146 index: u32, 147 ) -> Val { 148 let offset = layout.elem_offset(index); 149 let data = store.unwrap_gc_store_mut().gc_object_data(self.as_gc_ref()); 150 match ty { 151 StorageType::I8 => Val::I32(data.read_u8(offset).into()), 152 StorageType::I16 => Val::I32(data.read_u16(offset).into()), 153 StorageType::ValType(ValType::I32) => Val::I32(data.read_i32(offset)), 154 StorageType::ValType(ValType::I64) => Val::I64(data.read_i64(offset)), 155 StorageType::ValType(ValType::F32) => Val::F32(data.read_u32(offset)), 156 StorageType::ValType(ValType::F64) => Val::F64(data.read_u64(offset)), 157 StorageType::ValType(ValType::V128) => Val::V128(data.read_v128(offset)), 158 StorageType::ValType(ValType::Ref(r)) => match r.heap_type().top() { 159 HeapType::Extern => { 160 let raw = data.read_u32(offset); 161 Val::ExternRef(ExternRef::_from_raw(store, raw)) 162 } 163 HeapType::Any => { 164 let raw = data.read_u32(offset); 165 Val::AnyRef(AnyRef::_from_raw(store, raw)) 166 } 167 HeapType::Func => { 168 let func_ref_id = data.read_u32(offset); 169 let func_ref_id = FuncRefTableId::from_raw(func_ref_id); 170 let func_ref = store 171 .unwrap_gc_store() 172 .func_ref_table 173 .get_untyped(func_ref_id); 174 Val::FuncRef(unsafe { 175 Func::from_vm_func_ref( 176 store, 177 func_ref.map_or(core::ptr::null_mut(), |f| f.as_ptr()), 178 ) 179 }) 180 } 181 otherwise => unreachable!("not a top type: {otherwise:?}"), 182 }, 183 } 184 } 185 186 /// Write the given value into this array at the given offset. 187 /// 188 /// Returns an error if `val` is a GC reference that has since been 189 /// unrooted. 190 /// 191 /// Does not check that `val` matches `ty`, nor that the field is actually 192 /// of type `ty`. Checking those things is the caller's responsibility. 193 /// Failure to do so is memory safe, but will lead to general incorrectness 194 /// such as panics and wrong results. 195 /// 196 /// Panics on out-of-bounds accesses. 197 pub fn write_elem( 198 &self, 199 store: &mut AutoAssertNoGc, 200 layout: &GcArrayLayout, 201 ty: &StorageType, 202 index: u32, 203 val: Val, 204 ) -> Result<()> { 205 debug_assert!(val._matches_ty(&store, &ty.unpack())?); 206 207 let offset = layout.elem_offset(index); 208 let mut data = store.unwrap_gc_store_mut().gc_object_data(self.as_gc_ref()); 209 match val { 210 Val::I32(i) if ty.is_i8() => data.write_i8(offset, truncate_i32_to_i8(i)), 211 Val::I32(i) if ty.is_i16() => data.write_i16(offset, truncate_i32_to_i16(i)), 212 Val::I32(i) => data.write_i32(offset, i), 213 Val::I64(i) => data.write_i64(offset, i), 214 Val::F32(f) => data.write_u32(offset, f), 215 Val::F64(f) => data.write_u64(offset, f), 216 Val::V128(v) => data.write_v128(offset, v), 217 218 // For GC-managed references, we need to take care to run the 219 // appropriate barriers, even when we are writing null references 220 // into the array. 221 // 222 // POD-read the old value into a local copy, run the GC write 223 // barrier on that local copy, and then POD-write the updated 224 // value back into the array. This avoids transmuting the inner 225 // data, which would probably be fine, but this approach is 226 // Obviously Correct and should get us by for now. If LLVM isn't 227 // able to elide some of these unnecessary copies, and this 228 // method is ever hot enough, we can always come back and clean 229 // it up in the future. 230 Val::ExternRef(e) => { 231 let raw = data.read_u32(offset); 232 let mut gc_ref = VMGcRef::from_raw_u32(raw); 233 let e = match e { 234 Some(e) => Some(e.try_gc_ref(store)?.unchecked_copy()), 235 None => None, 236 }; 237 store.gc_store_mut()?.write_gc_ref(&mut gc_ref, e.as_ref()); 238 let mut data = store.gc_store_mut()?.gc_object_data(self.as_gc_ref()); 239 data.write_u32(offset, gc_ref.map_or(0, |r| r.as_raw_u32())); 240 } 241 Val::AnyRef(a) => { 242 let raw = data.read_u32(offset); 243 let mut gc_ref = VMGcRef::from_raw_u32(raw); 244 let a = match a { 245 Some(a) => Some(a.try_gc_ref(store)?.unchecked_copy()), 246 None => None, 247 }; 248 store.gc_store_mut()?.write_gc_ref(&mut gc_ref, a.as_ref()); 249 let mut data = store.gc_store_mut()?.gc_object_data(self.as_gc_ref()); 250 data.write_u32(offset, gc_ref.map_or(0, |r| r.as_raw_u32())); 251 } 252 253 Val::FuncRef(f) => { 254 let func_ref = match f { 255 Some(f) => Some(SendSyncPtr::new(f.vm_func_ref(store))), 256 None => None, 257 }; 258 let id = unsafe { store.gc_store_mut()?.func_ref_table.intern(func_ref) }; 259 store 260 .gc_store_mut()? 261 .gc_object_data(self.as_gc_ref()) 262 .write_u32(offset, id.into_raw()); 263 } 264 } 265 Ok(()) 266 } 267 268 /// Initialize an element in this arrayref that is currently uninitialized. 269 /// 270 /// The difference between this method and `write_elem` is that GC barriers 271 /// are handled differently. When overwriting an initialized element (aka 272 /// `write_elem`) we need to call the full write GC write barrier, which 273 /// logically drops the old GC reference and clones the new GC 274 /// reference. When we are initializing an element for the first time, there 275 /// is no old GC reference that is being overwritten and which we need to 276 /// drop, so we only need to clone the new GC reference. 277 /// 278 /// Calling this method on a arrayref that has already had the associated 279 /// element initialized will result in GC bugs. These are memory safe but 280 /// will lead to generally incorrect behavior such as panics, leaks, and 281 /// incorrect results. 282 /// 283 /// Does not check that `val` matches `ty`, nor that the field is actually 284 /// of type `ty`. Checking those things is the caller's responsibility. 285 /// Failure to do so is memory safe, but will lead to general incorrectness 286 /// such as panics and wrong results. 287 /// 288 /// Returns an error if `val` is a GC reference that has since been 289 /// unrooted. 290 /// 291 /// Panics on out-of-bounds accesses. 292 pub fn initialize_elem( 293 &self, 294 store: &mut AutoAssertNoGc, 295 layout: &GcArrayLayout, 296 ty: &StorageType, 297 index: u32, 298 val: Val, 299 ) -> Result<()> { 300 debug_assert!(val._matches_ty(&store, &ty.unpack())?); 301 let offset = layout.elem_offset(index); 302 match val { 303 Val::I32(i) if ty.is_i8() => store 304 .gc_store_mut()? 305 .gc_object_data(self.as_gc_ref()) 306 .write_i8(offset, truncate_i32_to_i8(i)), 307 Val::I32(i) if ty.is_i16() => store 308 .gc_store_mut()? 309 .gc_object_data(self.as_gc_ref()) 310 .write_i16(offset, truncate_i32_to_i16(i)), 311 Val::I32(i) => store 312 .gc_store_mut()? 313 .gc_object_data(self.as_gc_ref()) 314 .write_i32(offset, i), 315 Val::I64(i) => store 316 .gc_store_mut()? 317 .gc_object_data(self.as_gc_ref()) 318 .write_i64(offset, i), 319 Val::F32(f) => store 320 .gc_store_mut()? 321 .gc_object_data(self.as_gc_ref()) 322 .write_u32(offset, f), 323 Val::F64(f) => store 324 .gc_store_mut()? 325 .gc_object_data(self.as_gc_ref()) 326 .write_u64(offset, f), 327 Val::V128(v) => store 328 .gc_store_mut()? 329 .gc_object_data(self.as_gc_ref()) 330 .write_v128(offset, v), 331 332 // NB: We don't need to do a write barrier when initializing a 333 // field, because there is nothing being overwritten. Therefore, we 334 // just the clone barrier. 335 Val::ExternRef(x) => { 336 let x = match x { 337 None => 0, 338 Some(x) => x.try_clone_gc_ref(store)?.as_raw_u32(), 339 }; 340 store 341 .gc_store_mut()? 342 .gc_object_data(self.as_gc_ref()) 343 .write_u32(offset, x); 344 } 345 Val::AnyRef(x) => { 346 let x = match x { 347 None => 0, 348 Some(x) => x.try_clone_gc_ref(store)?.as_raw_u32(), 349 }; 350 store 351 .gc_store_mut()? 352 .gc_object_data(self.as_gc_ref()) 353 .write_u32(offset, x); 354 } 355 356 Val::FuncRef(f) => { 357 let func_ref = match f { 358 Some(f) => Some(SendSyncPtr::new(f.vm_func_ref(store))), 359 None => None, 360 }; 361 let id = unsafe { store.gc_store_mut()?.func_ref_table.intern(func_ref) }; 362 store 363 .gc_store_mut()? 364 .gc_object_data(self.as_gc_ref()) 365 .write_u32(offset, id.into_raw()); 366 } 367 } 368 Ok(()) 369 } 370 } 371