rendy_memory/mapping/mod.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
mod range;
pub(crate) mod write;
use {
crate::{memory::Memory, util::fits_usize},
gfx_hal::{device::Device as _, Backend},
std::{ops::Range, ptr::NonNull},
};
pub(crate) use self::range::{
mapped_fitting_range, mapped_slice, mapped_slice_mut, mapped_sub_range,
};
use self::write::{Write, WriteCoherent, WriteFlush};
/// Non-coherent marker.
#[derive(Clone, Copy, Debug)]
pub struct NonCoherent;
/// Coherent marker.
#[derive(Clone, Copy, Debug)]
pub struct Coherent;
/// Value that contains either coherent marker or non-coherent marker.
#[derive(Clone, Copy, Debug)]
pub struct MaybeCoherent(bool);
/// Represents range of the memory mapped to the host.
/// Provides methods for safer host access to the memory.
#[derive(Debug)]
pub struct MappedRange<'a, B: Backend, C = MaybeCoherent> {
/// Memory object that is mapped.
memory: &'a Memory<B>,
/// Pointer to range mapped memory.
ptr: NonNull<u8>,
/// Range of mapped memory.
range: Range<u64>,
/// Coherency marker
coherent: C,
}
impl<'a, B> MappedRange<'a, B>
where
B: Backend,
{
// /// Map range of memory.
// /// `range` is in memory object space.
// ///
// /// # Safety
// ///
// /// * Only one range for the given memory object can be mapped.
// /// * Memory object must be not mapped.
// /// * Memory object must be created with device specified.
// pub unsafe fn new(
// memory: &'a Memory<B>,
// device: &B::Device,
// range: Range<u64>,
// ) -> Result<Self, gfx_hal::device::MapError> {
// assert!(
// range.start < range.end,
// "Memory mapping region must have valid size"
// );
// assert!(
// fits_usize(range.end - range.start),
// "Range length must fit in usize"
// );
// assert!(memory.host_visible());
// let ptr = device.map_memory(memory.raw(), range.clone())?;
// assert!(
// (ptr as usize).wrapping_neg() >= (range.end - range.start) as usize,
// "Resulting pointer value + range length must fit in usize. Pointer: {:p}, range {:?}",
// ptr,
// range,
// );
// Ok(Self::from_raw(memory, NonNull::new_unchecked(ptr), range))
// }
/// Construct mapped range from raw mapping
///
/// # Safety
///
/// `memory` `range` must be mapped to host memory region pointer by `ptr`.
/// `range` is in memory object space.
/// `ptr` points to the `range.start` offset from memory origin.
pub unsafe fn from_raw(memory: &'a Memory<B>, ptr: NonNull<u8>, range: Range<u64>) -> Self {
assert!(
range.start < range.end,
"Memory mapping region must have valid size"
);
MappedRange {
ptr,
range,
memory,
coherent: MaybeCoherent(memory.host_coherent()),
}
}
/// Get pointer to beginning of memory region.
/// i.e. to `range().start` offset from memory origin.
pub fn ptr(&self) -> NonNull<u8> {
self.ptr
}
/// Get mapped range.
pub fn range(&self) -> Range<u64> {
self.range.clone()
}
/// Fetch readable slice of sub-range to be read.
/// Invalidating range if memory is not coherent.
/// `range.end - range.start` must be multiple of `size_of::()`.
/// `mapping offset + range.start` must be multiple of `align_of::()`.
///
/// # Safety
///
/// * Caller must ensure that device won't write to the memory region until the borrowing ends.
/// * `T` Must be plain-old-data type compatible with data in mapped region.
pub unsafe fn read<'b, T>(
&'b mut self,
device: &B::Device,
range: Range<u64>,
) -> Result<&'b [T], gfx_hal::device::MapError>
where
'a: 'b,
T: Copy,
{
assert!(
range.start < range.end,
"Memory mapping region must have valid size"
);
assert!(
fits_usize(range.end - range.start),
"Range length must fit in usize"
);
let (ptr, range) = mapped_sub_range(self.ptr, self.range.clone(), range)
.ok_or_else(|| gfx_hal::device::MapError::OutOfBounds)?;
let size = (range.end - range.start) as usize;
if self.coherent.0 {
device
.invalidate_mapped_memory_ranges(Some((self.memory.raw(), self.range.clone())))?;
}
let slice = mapped_slice::<T>(ptr, size);
Ok(slice)
}
/// Fetch writer to the sub-region.
/// This writer will flush data on drop if written at least once.
///
/// # Safety
///
/// * Caller must ensure that device won't write to or read from the memory region.
pub unsafe fn write<'b, T: 'b>(
&'b mut self,
device: &'b B::Device,
range: Range<u64>,
) -> Result<impl Write<T> + 'b, gfx_hal::device::MapError>
where
'a: 'b,
T: Copy,
{
assert!(
range.start < range.end,
"Memory mapping region must have valid size"
);
assert!(
fits_usize(range.end - range.start),
"Range length must fit in usize"
);
let (ptr, range) = mapped_sub_range(self.ptr, self.range.clone(), range)
.ok_or_else(|| gfx_hal::device::MapError::OutOfBounds)?;
let size = (range.end - range.start) as usize;
if !self.coherent.0 {
device
.invalidate_mapped_memory_ranges(Some((self.memory.raw(), self.range.clone())))?;
}
let slice = mapped_slice_mut::<T>(ptr, size);
let ref memory = self.memory;
Ok(WriteFlush {
slice,
flush: if !self.coherent.0 {
Some(move || {
device
.flush_mapped_memory_ranges(Some((memory.raw(), range)))
.expect("Should flush successfully");
})
} else {
None
},
})
}
/// Convert into mapped range with statically known coherency.
pub fn coherent(self) -> Result<MappedRange<'a, B, Coherent>, MappedRange<'a, B, NonCoherent>> {
if self.coherent.0 {
Ok(MappedRange {
memory: self.memory,
ptr: self.ptr,
range: self.range,
coherent: Coherent,
})
} else {
Err(MappedRange {
memory: self.memory,
ptr: self.ptr,
range: self.range,
coherent: NonCoherent,
})
}
}
}
impl<'a, B> From<MappedRange<'a, B, Coherent>> for MappedRange<'a, B>
where
B: Backend,
{
fn from(range: MappedRange<'a, B, Coherent>) -> Self {
MappedRange {
memory: range.memory,
ptr: range.ptr,
range: range.range,
coherent: MaybeCoherent(true),
}
}
}
impl<'a, B> From<MappedRange<'a, B, NonCoherent>> for MappedRange<'a, B>
where
B: Backend,
{
fn from(range: MappedRange<'a, B, NonCoherent>) -> Self {
MappedRange {
memory: range.memory,
ptr: range.ptr,
range: range.range,
coherent: MaybeCoherent(false),
}
}
}
impl<'a, B> MappedRange<'a, B, Coherent>
where
B: Backend,
{
/// Fetch writer to the sub-region.
///
/// # Safety
///
/// * Caller must ensure that device won't write to or read from the memory region.
pub unsafe fn write<'b, U: 'b>(
&'b mut self,
range: Range<u64>,
) -> Result<impl Write<U> + 'b, gfx_hal::device::MapError>
where
U: Copy,
{
assert!(
range.start < range.end,
"Memory mapping region must have valid size"
);
assert!(
fits_usize(range.end - range.start),
"Range length must fit in usize"
);
let (ptr, range) = mapped_sub_range(self.ptr, self.range.clone(), range)
.ok_or_else(|| gfx_hal::device::MapError::OutOfBounds)?;
let size = (range.end - range.start) as usize;
let slice = mapped_slice_mut::<U>(ptr, size);
Ok(WriteCoherent { slice })
}
}