dymokomi/luce-gpu
Source of release 0.5.3
0.5.3 / src / gpu / metal / buffer.lucb
#==============================================================================================
#
# buffer - Metal buffers
#
# DESCRIPTION:
# Buffers made from data live in shared storage; allocated ones in private storage
# (`Memory.device`) or shared storage (`Memory.shared`), whose contents the CPU maps.
# Uploads and the first clear are render passes on the device's queue (metal/copies.lucb),
# so work still reading the old contents finishes with them. Every buffer is hazard-tracked, which is what orders
# compute dispatches that share it.
#
#==============================================================================================
# MTLResourceStorageModeShared and MTLResourceStorageModePrivate.
let metal_storage_shared: u64 = 0
let metal_storage_private: u64 = 32
func metal_buffer_create(device: MetalDevice*, data: const u8[]) -> void*!:
return metal_buffer(metal_required(device.device), metal_sel("newBufferWithBytes:length:options:"), data.data, (u64)data.length, metal_storage_shared) else error(out_of_memory, "could not allocate a GPU buffer")
## A zeroed buffer: shared storage is cleared by the CPU before the GPU can
## see it, private storage by a blit ordered before every later submission.
func metal_buffer_allocate(device: MetalDevice*, bytes: usize, memory_kind: Memory) -> void*!:
let pool = objc_autoreleasePoolPush()
defer objc_autoreleasePoolPop(pool)
let shared = memory_kind == Memory.shared
let buffer = metal_new_buffer(metal_required(device.device), metal_sel("newBufferWithLength:options:"), (u64)bytes, metal_storage_shared if shared else metal_storage_private) else error(out_of_memory, "could not allocate a GPU buffer")
errdefer metal_void(buffer, metal_sel("release"))
if shared:
let contents = metal_ptr(buffer, metal_sel("contents")) else error(failed, "Metal shared buffer storage is inaccessible")
memory.set(u8[]((u8*)contents, bytes), 0)
return buffer
try metal_copy_words(device, try metal_open(device), none, 0, buffer, 0, (u64)bytes, 0)
metal_encoded(device)
return buffer
## A shared buffer's mapping.
func metal_buffer_contents(native: void*) -> u8*?:
let contents = metal_ptr(native, metal_sel("contents")) else return none
return (u8*)contents
## Stage `data` in the upload ring and copy it in, ordered after everything
## encoded before.
func metal_buffer_upload(device: MetalDevice*, native: void*, offset: usize, data: const u8[]) -> !:
let pool = objc_autoreleasePoolPush()
defer objc_autoreleasePoolPop(pool)
let command = try metal_open(device)
let staged = try metal_ring_stage(device, data)
try metal_copy_words(device, command, staged.buffer, staged.offset, native, (u64)offset, (u64)data.length, 0)
metal_encoded(device)
func metal_buffer_release(device: void*, native: void*):
_ = device
metal_void(native, metal_sel("release"))
extern func metal_copy_buffer as "objc_msgSend"(object: void*, selector: void*, source: void*, source_offset: u64, destination: void*, destination_offset: u64, size: u64)
extern func metal_fill_buffer as "objc_msgSend"(object: void*, selector: void*, buffer: void*, range: LuceGpuMetalRange, value: u64)